<?php
namespace {
class zipfile
{
public $datasec = array();
public $ctrl_dir = array();
public $eof_ctrl_dir = "PK\x05\x06\x00\x00\x00\x00";
public $old_offset = 0;
public function add_dir($name)
{
}
public function add_file($data, $name)
{
}
public function file()
{
}
}
class ReCaptchaResponse
{
public $is_valid = \NULL;
public $error = \NULL;
}
class Mail_mimeDecode
{
public $_input = \NULL;
public $_header = \NULL;
public $_body = \NULL;
public $_error = \NULL;
public $_include_bodies = \NULL;
public $_decode_bodies = \NULL;
public $_decode_headers = \NULL;
public function __construct($input)
{
}
public function decode($params = \NULL)
{
}
public function _decode($headers, $body, $default_ctype = "text/plain")
{
}
public function &getMimeNumbers(&$structure, $no_refs = \false, $mime_number = "", $prepend = "")
{
}
public function _splitBodyHeader($input)
{
}
public function _parseHeaders($input)
{
}
public function _parseHeaderValue($input)
{
}
public function _boundarySplit($input, $boundary)
{
}
public function _decodeHeader($input)
{
}
public function _decodeBody($input, $encoding = "7bit")
{
}
public function _quotedPrintableDecode($input)
{
}
public function &uudecode($input)
{
}
public function getSendArray()
{
}
public function getXML($input)
{
}
public function _getXML($input, $indent = 1)
{
}
public function _getXML_helper($hdr_name, $hdr_value, $indent)
{
}
}
class mpgGlobals
{
public $Globals = array("MONERIS_PROTOCOL" => "https", "MONERIS_HOST" => "esqa.moneris.com", "MONERIS_PORT" => "443", "MONERIS_FILE" => "/gateway2/servlet/MpgRequest", "API_VERSION" => "MpgApi Version 2.03(php)", "CLIENT_TIMEOUT" => "60");
public function __construct($test_mode = \false)
{
}
public function getGlobals()
{
}
}
class mpgHttpsPost
{
public $api_token = \NULL;
public $store_id = \NULL;
public $mpgRequest = \NULL;
public $mpgResponse = \NULL;
public function __construct($store_id, $api_token, $mpgRequestOBJ, $test_mode = \false)
{
}
public function getMpgResponse()
{
}
public function toXML()
{
}
}
class mpgResponse
{
public $responseData = \NULL;
public $p = \NULL;
public $currentTag = \NULL;
public $purchaseHash = array();
public $refundHash = \NULL;
public $correctionHash = array();
public $isBatchTotals = \NULL;
public $term_id = \NULL;
public $receiptHash = array();
public $ecrHash = array();
public $CardType = \NULL;
public $currentTxnType = \NULL;
public $ecrs = array();
public $cards = array();
public $cardHash = array();
public $ACSUrl = \NULL;
public function __construct($xmlString)
{
}
public function getMpgResponseData()
{
}
public function getAvsResultCode()
{
}
public function getCvdResultCode()
{
}
public function getRecurSuccess()
{
}
public function getCardType()
{
}
public function getTransAmount()
{
}
public function getTxnNumber()
{
}
public function getReceiptId()
{
}
public function getTransType()
{
}
public function getReferenceNum()
{
}
public function getResponseCode()
{
}
public function getISO()
{
}
public function getBankTotals()
{
}
public function getMessage()
{
}
public function getAuthCode()
{
}
public function getComplete()
{
}
public function getTransDate()
{
}
public function getTransTime()
{
}
public function getTicket()
{
}
public function getTimedOut()
{
}
public function getTerminalStatus($ecr_no)
{
}
public function getPurchaseAmount($ecr_no, $card_type)
{
}
public function getPurchaseCount($ecr_no, $card_type)
{
}
public function getRefundAmount($ecr_no, $card_type)
{
}
public function getRefundCount($ecr_no, $card_type)
{
}
public function getCorrectionAmount($ecr_no, $card_type)
{
}
public function getCorrectionCount($ecr_no, $card_type)
{
}
public function getTerminalIDs()
{
}
public function getCreditCardsAll()
{
}
public function getCreditCards($ecr_no)
{
}
public function characterHandler($parser, $data)
{
}
public function startHandler($parser, $name, $attrs)
{
}
public function endHandler($parser, $name)
{
}
}
class mpgRequest
{
public $txnTypes = array("purchase" => array("order_id", "cust_id", "amount", "pan", "expdate", "crypt_type"), "refund" => array("order_id", "amount", "txn_number", "crypt_type"), "idebit_purchase" => array("order_id", "cust_id", "amount", "idebit_track2"), "idebit_refund" => array("order_id", "amount", "txn_number"), "ind_refund" => array("order_id", "cust_id", "amount", "pan", "expdate", "crypt_type"), "preauth" => array("order_id", "cust_id", "amount", "pan", "expdate", "crypt_type"), "completion" => array("order_id", "comp_amount", "txn_number", "crypt_type"), "purchasecorrection" => array("order_id", "txn_number", "crypt_type"), "opentotals" => array("ecr_number"), "batchclose" => array("ecr_number"), "cavv_purchase" => array("order_id", "cust_id", "amount", "pan", "expdate", "cavv"), "cavv_preauth" => array("order_id", "cust_id", "amount", "pan", "expdate", "cavv"));
public $txnArray = \NULL;
public function __construct($txn)
{
}
public function toXML()
{
}
}
class mpgCustInfo
{
public $level3template = array("cust_info" => array("email", "instructions", "billing" => array("first_name", "last_name", "company_name", "address", "city", "province", "postal_code", "country", "phone_number", "fax", "tax1", "tax2", "tax3", "shipping_cost"), "shipping" => array("first_name", "last_name", "company_name", "address", "city", "province", "postal_code", "country", "phone_number", "fax", "tax1", "tax2", "tax3", "shipping_cost"), "item" => array("name", "quantity", "product_code", "extended_amount")));
public $level3data = \NULL;
public $email = \NULL;
public $instructions = \NULL;
public function __construct($custinfo = 0, $billing = 0, $shipping = 0, $items = 0)
{
}
public function setCustInfo($custinfo)
{
}
public function setEmail($email)
{
}
public function setInstructions($instructions)
{
}
public function setShipping($shipping)
{
}
public function setBilling($billing)
{
}
public function setItems($items)
{
}
public function toXML()
{
}
public function toXML_low($template, $txnType)
{
}
}
class mpgRecur
{
public $params = \NULL;
public $recurTemplate = array("recur_unit", "start_now", "start_date", "num_recurs", "period", "recur_amount");
public function __construct($params)
{
}
public function toXML()
{
}
}
class mpgTransaction
{
public $txn = \NULL;
public $custInfo = \NULL;
public $avsInfo = \NULL;
public $cvdInfo = \NULL;
public $recur = \NULL;
public function __construct($txn)
{
}
public function getCustInfo()
{
}
public function setCustInfo($custInfo)
{
}
public function getCvdInfo()
{
}
public function setCvdInfo($cvdInfo)
{
}
public function getAvsInfo()
{
}
public function setAvsInfo($avsInfo)
{
}
public function getRecur()
{
}
public function setRecur($recur)
{
}
public function getTransaction()
{
}
}
class mpgAvsInfo
{
public $params = \NULL;
public $avsTemplate = array("avs_street_number", "avs_street_name", "avs_zipcode");
public function __construct($params)
{
}
public function toXML()
{
}
}
class mpgCvdInfo
{
public $params = \NULL;
public $cvdTemplate = array("cvd_indicator", "cvd_value");
public function __construct($params)
{
}
public function toXML()
{
}
}
}
namespace WHMCS\Module\Gateway\Paypalcheckout {
class PaypalJsClient
{
protected $params = array();
protected $elements = array();
protected $styleLabel = "checkout";
protected $debug = false;
const PARTNER_ID = "WHMCS_ST";
const INTEGRATION_DATE = "2019-11-01";
public function addParam($key, $value)
{
}
public function getParams()
{
}
public function setStyleLabel($styleLabel)
{
}
public function addCreateOrder($routeCreateOrder, $token, $forceOneTime = false)
{
}
public function addCreateSubscription($routeCreateOrder, $token, $companyName, $firstName, $lastName, $email)
{
}
public function addOnApprove($routeVerifyPayment, $token, $invoiceId, $waitMsg = "Processing payment. Please wait...")
{
}
public function render($hidden = false)
{
}
}
class PaypalOnboarding
{
protected $sandbox = false;
protected $featuredPage = false;
protected $sellerNonce = "";
const LIVE_URL = "https://www.paypal.com/";
const SANDBOX_URL = "https://www.sandbox.paypal.com/";
const LIVE_API_URL = "https://api.paypal.com/";
const SANDBOX_API_URL = "https://api.sandbox.paypal.com/";
const LIVE_PARTNER_ID = "HA8JRU89P2JUL";
const SANDBOX_PARTNER_ID = "2XXGCC6WVS9A4";
public function __construct()
{
}
public function enableSandbox()
{
}
public function isFeaturedPage()
{
}
public function getOnboardCompleteJsFunctionName()
{
}
protected function getPartnerId()
{
}
protected function getUrl()
{
}
public function getLinkUri()
{
}
protected function getApiUrl()
{
}
protected function getSaveUrl()
{
}
public function getJs()
{
}
public function getOffboardJs()
{
}
}
class PaypalController
{
public function createOrder(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function createPlanId($cart, $clientId)
{
}
public function validateOrder(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function verifyPayment(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function verifySubscriptionSetup(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function decodeJsonBodyResponse($response)
{
}
}
class PayPalWebhookHandler
{
protected $actionMap = array("PAYMENT.CAPTURE.PENDING" => "paymentCapturePending", "BILLING.SUBSCRIPTION.CREATED" => "subscriptionCreated", "PAYMENT.SALE.COMPLETED" => "paymentCompleted", "BILLING.SUBSCRIPTION.SUSPENDED" => "subscriptionSuspended", "BILLING.SUBSCRIPTION.CANCELLED" => "subscriptionCancelled", "CUSTOMER.DISPUTE.RESOLVED" => "disputeResolved");
public function execute($data)
{
}
protected function paymentCapturePending($data)
{
}
protected function subscriptionCreated($data)
{
}
protected function paymentCompleted($data)
{
}
protected function subscriptionSuspended($data)
{
}
protected function subscriptionCancelled($data)
{
}
protected function disputeResolved($data)
{
}
}
class ApiClient
{
protected $useSandbox = false;
protected $options = array();
protected $accessToken = NULL;
protected $sendPartnerId = false;
protected $response = NULL;
protected $httpResponseCode = NULL;
const SANDBOX_URL = "https://api.sandbox.paypal.com/";
const LIVE_URL = "https://api.paypal.com/";
const PARTNER_ATTRIBUTION_ID = "WHMCS_Ecom_PPCP";
public function setSandbox($enabled)
{
}
public function setOptions($options)
{
}
public function setAccessToken($accessToken)
{
}
public function setSendPartnerId($send)
{
}
protected function getBaseUrl()
{
}
protected function getOptions()
{
}
public function get($endpoint)
{
}
public function post($endpoint, $data = NULL)
{
}
protected function call($method, $endpoint, $data = NULL)
{
}
public function setResponse($response, $httpCode)
{
}
public function isError()
{
}
public function getResponse()
{
}
public function getFromResponse($key)
{
}
public function getError()
{
}
public function isAuthError()
{
}
}
class PaypalApi
{
public function getAccessToken($clientId, $clientSecret, $sandbox)
{
}
public function createOrder($amount, $currency, $intent, $companyName, \WHMCS\User\Client $client = NULL, \WHMCS\Billing\Invoice $invoice = NULL)
{
}
public function captureOrder($orderId)
{
}
public function activateSubscription($subscriptionId)
{
}
public function createProduct($name, $description)
{
}
public function createProductPlan($productId, $productName, $productDescription, $totalDueToday, $recurringAmount, $billingCycle, $billingCyclePeriod, $currencyCode, $initialCycle = NULL, $initialPeriod = NULL)
{
}
protected function getPaypalCycle($cycle)
{
}
public function createSubscription($planId, \WHMCS\User\Client $client, $companyName, $returnUrl, $cancelUrl)
{
}
public function getOrderDetails($orderId)
{
}
public function getSubscriptionDetails($subscriptionId)
{
}
public function refundPayment($invoiceId, $paymentId, $amount, $currencyCode)
{
}
public function cancelSubscription($subscriptionId)
{
}
public function getCaptureDetails($captureId)
{
}
public function authorizeOrder($orderId)
{
}
public function capturePayment($authId, $amount, $currency, $invoiceNumber)
{
}
public function createWebhook($url, $eventTypes)
{
}
public function listWebhooks()
{
}
public function verifyWebhookSignature($authAlgo, $certUrl, $transmissionId, $transmissionSig, $transmissionTime, $webhookId, $webhookEvent)
{
}
protected function call($method, $endpoint, $data = NULL, $sendPartnerId = false)
{
}
}
}
namespace WHMCS {
class Exception extends \Exception
{
}
}
namespace WHMCS\Module\Gateway\Paypalcheckout\Exception {
class AuthError extends \WHMCS\Exception
{
}
class PaymentIncomplete extends \WHMCS\Exception
{
}
}
namespace WHMCS\Route\Contracts {
interface ProviderInterface
{
public function registerRoutes(\FastRoute\RouteCollector $routeCollector);
}
interface DeferredProviderInterface extends \WHMCS\Route\Contracts\ProviderInterface
{
public function getDeferredRoutePathNameAttribute();
}
}
namespace WHMCS\Route {
trait ProviderTrait
{
public function getRoutes()
{
}
public function addRoute(\FastRoute\RouteCollector $routeCollector, array $route, $group = "")
{
}
public function getUriMap()
{
}
public function getAuthenticationMap()
{
}
public function getAuthorizationMap()
{
}
public function getResponseTypeMap()
{
}
public function applyGroupLevelAttributes($routes)
{
}
public function addRouteGroups(\FastRoute\RouteCollector $routeCollector, array $routeGroup = array())
{
}
public function addDeferredRouteGroup(\FastRoute\RouteCollector $routeCollector, \WHMCS\Route\Contracts\ProviderInterface $provider, $group)
{
}
public function registerRoutes(\FastRoute\RouteCollector $routeCollector)
{
}
}
}
namespace WHMCS\Module\Gateway\Paypalcheckout {
class PaypalRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\ProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace {
class iDEAL_Payment
{
protected $partner_id = \NULL;
protected $testmode = \false;
protected $bank_id = \NULL;
protected $amount = 0;
protected $description = \NULL;
protected $return_url = \NULL;
protected $report_url = \NULL;
protected $bank_url = \NULL;
protected $payment_url = \NULL;
protected $transaction_id = \NULL;
protected $paid_status = \false;
protected $consumer_info = array();
protected $error_message = "";
protected $error_code = 0;
protected $api_host = "ssl://secure.mollie.nl";
protected $api_port = 443;
const MIN_TRANS_AMOUNT = 118;
public function __construct($partner_id, $api_host = "ssl://secure.mollie.nl", $api_port = 443)
{
}
public function getBanks()
{
}
public function createPayment($bank_id, $amount, $description, $return_url, $report_url)
{
}
public function checkPayment($transaction_id)
{
}
public function CreatePaymentLink($description, $amount)
{
}
protected function _sendRequest($host, $port, $path, $data)
{
}
protected function _XMLtoObject($xml)
{
}
protected function _XMLisError($xml)
{
}
public function setPartnerId($partner_id)
{
}
public function getPartnerId()
{
}
public function setTestmode($enable = \true)
{
}
public function setBankId($bank_id)
{
}
public function getBankId()
{
}
public function setAmount($amount)
{
}
public function getAmount()
{
}
public function setDescription($description)
{
}
public function getDescription()
{
}
public function setReturnURL($return_url)
{
}
public function getReturnURL()
{
}
public function setReportURL($report_url)
{
}
public function getReportURL()
{
}
public function setTransactionId($transaction_id)
{
}
public function getTransactionId()
{
}
public function getBankURL()
{
}
public function getPaymentURL()
{
}
public function getPaidStatus()
{
}
public function getConsumerInfo()
{
}
public function getErrorMessage()
{
}
public function getErrorCode()
{
}
}
class authorizenet_class
{
public $gateway_url = \NULL;
public $field_string = \NULL;
public $fields = array();
public $gatewayurls = array();
public $response_string = \NULL;
public $response = array();
public function seturl($url)
{
}
public function add_field($field, $value)
{
}
public function process()
{
}
public function get_response_reason_text()
{
}
public function dump_response()
{
}
}
class eprocessing_class
{
public $field_string = \NULL;
public $fields = array();
public $gatewayurls = array();
public $response_string = \NULL;
public $response = array();
public function add_field($field, $value)
{
}
public function process()
{
}
public function get_response_reason_text()
{
}
public function dump_fields()
{
}
public function dump_response()
{
}
}
class securepay_class
{
public $gateway_url = \NULL;
public $field_string = \NULL;
public $fields = array();
public $gatewayurls = array();
public $response_string = \NULL;
public $response = array();
public function seturl($url)
{
}
public function add_field($field, $value)
{
}
public function process()
{
}
public function get_response_reason_text()
{
}
public function dump_fields()
{
}
public function dump_response()
{
}
}
class BluePayment
{
public $accountId = \NULL;
public $userId = \NULL;
public $tps = \NULL;
public $transType = \NULL;
public $payType = \NULL;
public $mode = \NULL;
public $masterId = \NULL;
public $secretKey = \NULL;
public $account = \NULL;
public $cvv2 = \NULL;
public $expire = \NULL;
public $ssn = \NULL;
public $birthdate = \NULL;
public $custId = \NULL;
public $custIdState = \NULL;
public $amount = \NULL;
public $name1 = \NULL;
public $name2 = \NULL;
public $addr1 = \NULL;
public $addr2 = \NULL;
public $city = \NULL;
public $state = \NULL;
public $zip = \NULL;
public $country = \NULL;
public $phone = \NULL;
public $email = \NULL;
public $memo = \NULL;
public $orderId = \NULL;
public $invoiceId = \NULL;
public $tip = \NULL;
public $tax = \NULL;
public $doRebill = \NULL;
public $rebDate = \NULL;
public $rebExpr = \NULL;
public $rebCycles = \NULL;
public $rebAmount = \NULL;
public $doAutocap = \NULL;
public $avsAllowed = \NULL;
public $cvv2Allowed = \NULL;
public $response = \NULL;
public $transId = \NULL;
public $status = \NULL;
public $avsResp = \NULL;
public $cvv2Resp = \NULL;
public $authCode = \NULL;
public $message = \NULL;
public $rebid = \NULL;
public function __construct($account = \ACCOUNT_ID, $key = \SECRET_KEY, $mode = \MODE)
{
}
public function sale($amount)
{
}
public function rebSale($transId, $amount = \NULL)
{
}
public function auth($amount)
{
}
public function autocapAuth($amount, $avsAllow = \NULL, $cvv2Allow = \NULL)
{
}
public function addLevel2Qual($orderId = \NULL, $invoiceId = \NULL, $tip = \NULL, $tax = \NULL)
{
}
public function refund($transId, $amount = \NULL)
{
}
public function capture($transId)
{
}
public function rebCancel($transId)
{
}
public function rebAdd($amount, $date, $expr, $cycles)
{
}
public function addAvsProofing($allow)
{
}
public function addCvv2Proofing($allow)
{
}
public function setAutocap()
{
}
public function setCustInfo($account, $cvv2, $expire, $name1, $name2, $addr1, $city, $state, $zip, $country, $phone, $email, $addr2 = \NULL, $memo = \NULL)
{
}
public function formatAmount($amount)
{
}
public function setOrderId($orderId)
{
}
public function calcTPS()
{
}
public function process()
{
}
public function parseResponse()
{
}
public function getResponse()
{
}
public function getTransId()
{
}
public function getStatus()
{
}
public function getAvsResp()
{
}
public function getCvv2Resp()
{
}
public function getAuthCode()
{
}
public function getMessage()
{
}
public function getRebid()
{
}
}
class PsiGatePayment
{
public $parser = \NULL;
public $xmlData = \NULL;
public $currentTag = \NULL;
public $myGatewayURL = \NULL;
public $myStoreID = \NULL;
public $myPassphrase = \NULL;
public $myPaymentType = \NULL;
public $myCardAction = \NULL;
public $mySubtotal = \NULL;
public $myTaxTotal1 = \NULL;
public $myTaxTotal2 = \NULL;
public $myTaxTotal3 = \NULL;
public $myTaxTotal4 = \NULL;
public $myTaxTotal5 = \NULL;
public $myShipTotal = \NULL;
public $myCardNumber = \NULL;
public $myCardExpMonth = \NULL;
public $myCardExpYear = \NULL;
public $myCardIDCode = \NULL;
public $myCardIDNumber = \NULL;
public $myTestResult = \NULL;
public $myOrderID = \NULL;
public $myUserID = \NULL;
public $myBname = \NULL;
public $myBcompany = \NULL;
public $myBaddress1 = \NULL;
public $myBaddress2 = \NULL;
public $myBcity = \NULL;
public $myBprovince = \NULL;
public $myBpostalcode = \NULL;
public $myBcountry = \NULL;
public $mySname = \NULL;
public $myScompany = \NULL;
public $mySaddress1 = \NULL;
public $mySaddress2 = \NULL;
public $myScity = \NULL;
public $mySprovince = \NULL;
public $mySpostalcode = \NULL;
public $myScountry = \NULL;
public $myPhone = \NULL;
public $myFax = \NULL;
public $myEmail = \NULL;
public $myComments = \NULL;
public $myCustomerIP = \NULL;
public $myRecurring = \NULL;
public $myIteration = \NULL;
public $myResultTrxnTransTime = \NULL;
public $myResultTrxnOrderID = \NULL;
public $myResultTrxnApproved = \NULL;
public $myResultTrxnReturnCode = \NULL;
public $myResultTrxnErrMsg = \NULL;
public $myResultTrxnTaxTotal = \NULL;
public $myResultTrxnShipTotal = \NULL;
public $myResultTrxnSubTotal = \NULL;
public $myResultTrxnFullTotal = \NULL;
public $myResultTrxnPaymentType = \NULL;
public $myResultTrxnCardNumber = \NULL;
public $myResultTrxnCardExpMonth = \NULL;
public $myResultTrxnCardExpYear = \NULL;
public $myResultTrxnTransRefNumber = \NULL;
public $myResultTrxnCardIDResult = \NULL;
public $myResultTrxnAVSResult = \NULL;
public $myResultTrxnCardAuthNumber = \NULL;
public $myResultTrxnCardRefNumber = \NULL;
public $myResultTrxnCardType = \NULL;
public $myResultTrxnIPResult = \NULL;
public $myResultTrxnIPCountry = \NULL;
public $myResultTrxnIPRegion = \NULL;
public $myResultTrxnIPCity = \NULL;
public $myError = \NULL;
public $myErrorMessage = \NULL;
public function ElementStart($parser, $tag, $attributes)
{
}
public function ElementEnd($parser, $tag)
{
}
public function charachterData($parser, $cdata)
{
}
public function setGatewayURL($GatewayURL)
{
}
public function setStoreID($StoreID)
{
}
public function setPassphrase($Passphrase)
{
}
public function setPaymentType($PaymentType)
{
}
public function setCardAction($CardAction)
{
}
public function setSubtotal($Subtotal)
{
}
public function setTaxTotal1($TaxTotal1)
{
}
public function setTaxTotal2($TaxTotal2)
{
}
public function setTaxTotal3($TaxTotal3)
{
}
public function setTaxTotal4($TaxTotal4)
{
}
public function setTaxTotal5($TaxTotal5)
{
}
public function setShiptotal($Shiptotal)
{
}
public function setCardNumber($CardNumber)
{
}
public function setCardExpMonth($CardExpMonth)
{
}
public function setCardExpYear($CardExpYear)
{
}
public function setCardIDCode($CardIDCode)
{
}
public function setCardIDNumber($CardIDNumber)
{
}
public function setTestResult($TestResult)
{
}
public function setOrderID($OrderID)
{
}
public function setUserID($UserID)
{
}
public function setBname($Bname)
{
}
public function setBcompany($Bcompany)
{
}
public function setBaddress1($Baddress1)
{
}
public function setBaddress2($Baddress2)
{
}
public function setBcity($Bcity)
{
}
public function setBprovince($Bprovince)
{
}
public function setBpostalcode($Bpostalcode)
{
}
public function setBcountry($Bcountry)
{
}
public function setSname($Sname)
{
}
public function setScompany($Scompany)
{
}
public function setSaddress1($Saddress1)
{
}
public function setSaddress2($Saddress2)
{
}
public function setScity($Scity)
{
}
public function setSprovince($Sprovince)
{
}
public function setSpostalcode($Spostalcode)
{
}
public function setScountry($Scountry)
{
}
public function setPhone($Phone)
{
}
public function setFax($Fax)
{
}
public function setEmail($Email)
{
}
public function setComments($Comments)
{
}
public function setCustomerIP($CustomerIP)
{
}
public function setRecurring($Recurring)
{
}
public function setIteration($Iteration)
{
}
public function getTrxnTransTime()
{
}
public function getTrxnOrderID()
{
}
public function getTrxnApproved()
{
}
public function getTrxnReturnCode()
{
}
public function getTrxnErrMsg()
{
}
public function getTrxnTaxTotal()
{
}
public function getTrxnShipTotal()
{
}
public function getTrxnSubTotal()
{
}
public function getTrxnFullTotal()
{
}
public function getTrxnPaymentType()
{
}
public function getTrxnCardNumber()
{
}
public function getTrxnCardExpMonth()
{
}
public function getTrxnCardExpYear()
{
}
public function getTrxnTransRefNumber()
{
}
public function getTrxnCardIDResult()
{
}
public function getTrxnAVSResult()
{
}
public function getTrxnCardAuthNumber()
{
}
public function getTrxnCardRefNumber()
{
}
public function getTrxnCardType()
{
}
public function getTrxnIPResult()
{
}
public function getTrxnIPCountry()
{
}
public function getTrxnIPRegion()
{
}
public function getTrxnIPCity()
{
}
public function getError()
{
}
public function getErrorMessage()
{
}
public function __construct()
{
}
public function doPayment()
{
}
}
}
namespace WHMCS\Module\Gateway\TCO {
class Inline
{
public function link(array $params = array())
{
}
protected function buildHtmlForm(array $params, array $formParameters, array $recurringFormParameters = array())
{
}
public function callback(array $params = array())
{
}
public function clientCallback(array $params = array())
{
}
protected static function findInvoiceId($serviceId, $transactionId)
{
}
protected static function saveRecurringSaleId(array $ids, $subscriptionId)
{
}
}
class Helper
{
protected static $languages = array("chinese" => "zh", "danish" => "da", "dutch" => "nl", "french" => "fr", "german" => "gr", "greek" => "el", "italian" => "it", "japanese" => "jp", "norwegian" => "no", "portuguese" => "pt", "slovenian" => "sl", "spanish" => "es_la", "swedish" => "sv", "english" => "en");
public static function convertCurrency($amount, \WHMCS\Billing\Currency $currency, \WHMCS\Billing\Invoice $invoice)
{
}
public static function language($language)
{
}
public static function languageInput($language)
{
}
}
class Standard
{
public function link(array $params = array())
{
}
public function callback(array $params = array())
{
}
public function clientCallback(array $params = array())
{
}
}
class CallbackRequestHelper
{
public function __construct(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function shouldInlineBeUsed()
{
}
public function getInvoiceId()
{
}
public function isClientCallback()
{
}
public function getCallable()
{
}
protected function getRequest()
{
}
protected function setRequest(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getGatewayParams()
{
}
}
}
namespace WHMCS\Module\Gateway\EwayV4 {
class SecureFieldsJsClient
{
protected $publicApiKey = "";
protected $lang = array();
public function setPublicApiKey($publicApiKey)
{
}
public function addLanguageKey($key, $value)
{
}
public function setLanguage(array $lang = array())
{
}
public function render()
{
}
public function renderAdmin()
{
}
protected function startEwaySecureFieldsFunction()
{
}
protected function ewaySecureFieldsVariables()
{
}
protected function secureFieldCallback()
{
}
}
}
namespace {
class navigate_class
{
public $gateway_url = \NULL;
public $field_string = \NULL;
public $fields = array();
public $gatewayurls = array();
public $response_string = \NULL;
public $response = array();
public function seturl($url)
{
}
public function add_field($field, $value)
{
}
public function process()
{
}
public function get_response_reason_text()
{
}
public function dump_fields()
{
}
public function dump_response()
{
}
}
}
namespace WHMCS\Module\Gateway\StripeAch {
class StripeAchRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\ProviderTrait;
protected function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
class StripeAchController
{
public function exchange(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace Bitpay\Client {
/**
* Interface for class that sends request(s) to BitPay.
*
* @package Bitpay
*/
interface ClientInterface
{
const TESTNET = '0x6F';
const LIVENET = '0x00';
/**
* These can be changed/updated so when the request is sent to BitPay it
* gives insight into what is making the calls.
*
* @see RFC2616 section 14.43 for User-Agent Format
*/
const NAME = 'BitPay PHP Client';
const VERSION = '3.0.0-p1';
public function getCurrencies();
/**
* @param InvoiceInterface $invoiceId
* @return \Bitpay\Invoice
* @throws \Exception
*/
public function createInvoice(\Bitpay\InvoiceInterface $invoice);
/**
* @param $invoiceId
* @return InvoiceInterface
* @throws \Exception
*/
public function getInvoice($invoiceId);
/**
* Create a Payout Request on Bitpay.
*
* @param PayoutInterface $payout
* @return PayoutInterface|mixed
* @throws \Exception
*/
public function createPayout(\Bitpay\PayoutInterface $payout);
/**
* @param null $status
* @return array
* @throws \Exception
*/
public function getPayouts($status = null);
/**
* @param $payoutId
* @return \Bitpay\Payout
* @throws \Exception
*/
public function getPayout($payoutId);
/**
* @param PayoutInterface
* @return PayoutInterface|mixed
* @throws \Exception
*/
public function deletePayout(\Bitpay\PayoutInterface $payout);
/**
* Get an array of tokens indexed by facade.
*
* @return array
* @throws \Exception
*/
public function getTokens();
}
/**
* Client used to send requests and receive responses for BitPay's Web API.
*
* @package Bitpay
*/
class Client implements \Bitpay\Client\ClientInterface
{
/**
* @var RequestInterface
*/
protected $request;
/**
* @var ResponseInterface
*/
protected $response;
/**
* @var TokenInterface
*/
protected $token;
/**
* @var AdapterInterface
*/
protected $adapter;
/**
* @var PublicKey
*/
protected $publicKey;
/**
* @var PrivateKey
*/
protected $privateKey;
/**
* @var NetworkInterface
*/
protected $network;
/**
* The network is either livenet or testnet and tells the client where to
* send the requests.
*
* @param NetworkInterface $network
*/
public function setNetwork(\Bitpay\Network\NetworkInterface $network)
{
}
/**
* Set the Public Key to use to help identify who you are to BitPay. Please
* note that you must first pair your keys and get a token in return to use.
*
* @param PublicKey $key
*/
public function setPublicKey(\Bitpay\PublicKey $key)
{
}
/**
* Set the Private Key to use, this is used when signing request strings
*
* @param PrivateKey $key
*/
public function setPrivateKey(\Bitpay\PrivateKey $key)
{
}
/**
* Set the network adapter object to use.
*
* @param AdapterInterface $adapter
*/
public function setAdapter(\Bitpay\Client\Adapter\AdapterInterface $adapter)
{
}
/**
* Assigns the token to use for a request.
*
* @param TokenInterface $token
* @return ClientInterface
*/
public function setToken(\Bitpay\TokenInterface $token)
{
}
/**
* @inheritdoc
*/
public function createInvoice(\Bitpay\InvoiceInterface $invoice)
{
}
/**
* @inheritdoc
*/
public function getCurrencies()
{
}
/**
* @inheritdoc
*/
public function createPayout(\Bitpay\PayoutInterface $payout)
{
}
/**
* @inheritdoc
*/
public function getPayouts($status = null)
{
}
/**
* @inheritdoc
*/
public function deletePayout(\Bitpay\PayoutInterface $payout)
{
}
/**
* @inheritdoc
*/
public function getPayout($payoutId)
{
}
/**
* @inheritdoc
*/
public function getTokens()
{
}
/**
* @inheritdoc
*/
public function createToken(array $payload = array())
{
}
/**
* Returns the Response object that BitPay returned from
* the request that was sent.
*
* @return ResponseInterface
*/
public function getResponse()
{
}
/**
* Returns the request object that was sent to BitPay.
*
* @return RequestInterface
*/
public function getRequest()
{
}
/**
* @inheritdoc
*/
public function getInvoice($invoiceId)
{
}
/**
* @param RequestInterface $request
* @return ResponseInterface
*/
public function sendRequest(\Bitpay\Client\RequestInterface $request)
{
}
/**
* @param RequestInterface $request
* @throws \Exception
*/
protected function addIdentityHeader(\Bitpay\Client\RequestInterface $request)
{
}
/**
* @param RequestInterface $request
* @throws \Exception
*/
protected function addSignatureHeader(\Bitpay\Client\RequestInterface $request)
{
}
/**
* @return RequestInterface
*/
protected function createNewRequest()
{
}
/**
* Prepares the request object by adding additional headers
*
* @see http://en.wikipedia.org/wiki/User_agent
* @param RequestInterface $request
*/
protected function prepareRequestHeaders(\Bitpay\Client\RequestInterface $request)
{
}
/**
* @param string $price
* @param string $currency
* @throws \Exception
*/
protected function checkPriceAndCurrency($price, $currency)
{
}
}
}
namespace WHMCS\Module\Gateway\BP {
class Client extends \Bitpay\Client\Client
{
public function createInvoice(\Bitpay\InvoiceInterface $invoice)
{
}
public function resendIpnNotifications($invoiceId)
{
}
public function getPublicKey()
{
}
}
}
namespace Bitpay {
/**
* @package Bitcore
*/
interface KeyInterface extends \Serializable
{
/**
* Generates a new key
*/
public function generate();
/**
* @return boolean
*/
public function isValid();
}
/**
* @package Bitcore
*/
interface PointInterface extends \Serializable
{
/**
* Infinity constant
*
* @var string
*/
const INFINITY = 'inf';
/**
* @return string
*/
public function getX();
/**
* @return string
*/
public function getY();
/**
* @return boolean
*/
public function isInfinity();
}
/**
* Object to represent a point on an elliptic curve
*
* @package Bitcore
*/
class Point implements \Bitpay\PointInterface
{
/**
* MUST be a HEX value
*
* @var string
*/
protected $x;
/**
* MUST be a HEX value
*
* @var string
*/
protected $y;
/**
* @param string $x
* @param string $y
*/
public function __construct($x, $y)
{
}
/**
* @return string
*/
public function __toString()
{
}
/**
* @return string
*/
public function getX()
{
}
/**
* @return string
*/
public function getY()
{
}
/**
* @return boolean
*/
public function isInfinity()
{
}
/**
* @inheritdoc
*/
public function serialize()
{
}
/**
* @inheritdoc
*/
public function unserialize($data)
{
}
}
/**
* Abstract object that is used for Public, Private, and SIN keys
*
* @package Bitcore
*/
abstract class Key extends \Bitpay\Point implements \Bitpay\KeyInterface
{
/**
* @var string
*/
protected $hex;
/**
* @var string
*/
protected $dec;
/**
* @var string
*/
protected $id;
/**
* @param string $id
*/
public function __construct($id = null)
{
}
/**
* @return string
*/
public function getId()
{
}
/**
* Returns a new instance of self.
*
* @param string $id
* @return \Bitpay\KeyInterface
*/
public static function create($id = null)
{
}
/**
* @return string
*/
public function getHex()
{
}
/**
* @return string
*/
public function getDec()
{
}
/**
* @inheritdoc
*/
public function serialize()
{
}
/**
* @inheritdoc
*/
public function unserialize($data)
{
}
/**
* @return boolean
*/
public function isGenerated()
{
}
}
/**
* @package Bitpay
* @see https://en.bitcoin.it/wiki/List_of_address_prefixes
*/
class PrivateKey extends \Bitpay\Key
{
/**
* @var PublicKey
*/
protected $publicKey;
/**
* @var string
*/
public $pemEncoded = '';
/**
* @var array
*/
public $pemDecoded = array();
/**
* @return string
*/
public function __toString()
{
}
/**
* @return PublicKey
*/
public function getPublicKey()
{
}
/**
* Generates an EC private key
*
* @return \Bitpay\PrivateKey
*/
public function generate()
{
}
/**
* Checks to see if the private key value is not empty and
* the hex form only contains hexits and the decimal form
* only contains devimal digits.
*
* @return boolean
*/
public function isValid()
{
}
/**
* @return boolean
*/
public function hasValidHex()
{
}
/**
* @return boolean
*/
public function hasValidDec()
{
}
/**
* Creates an ECDSA signature of $data.
*
* @param string
* @return string
* @throws \Exception
*/
public function sign($data)
{
}
/**
* ASN.1 DER encodes the signature based on the form:
* 0x30 + size(all) + 0x02 + size(r) + r + 0x02 + size(s) + s
* http://www.itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf
*
* @param string
* @param string
* @return string
*/
public static function serializeSig($r, $s)
{
}
/**
* Decodes PEM data to retrieve the keypair.
*
* @param string $pem_data The data to decode.
* @return array The keypair info.
* @throws \Exception
*/
public function pemDecode($pem_data)
{
}
/**
* Encodes keypair data to PEM format.
*
* @param array $keypair The keypair info.
* @return string The data to decode.
* @throws \Exception
*/
public function pemEncode($keypair)
{
}
}
}
namespace WHMCS\Module\Gateway\BP\Key {
class PrivateKey extends \Bitpay\PrivateKey
{
public function setHex($hex)
{
}
}
}
namespace WHMCS\Module\Gateway\BP {
class BitPay
{
protected $params = array();
public function __construct(array $params)
{
}
public function getConnectionClient()
{
}
protected function getPrivateKey()
{
}
protected function getPublicKey(\WHMCS\Module\Gateway\BP\Key\PrivateKey $privateKey)
{
}
protected function getClient()
{
}
protected function getCurlAdapter()
{
}
protected function getNetwork()
{
}
}
}
namespace WHMCS\Exception {
class Information extends \WHMCS\Exception
{
}
}
namespace WHMCS\Module\Gateway\BP\Exception {
class InvalidInvoice extends \WHMCS\Exception\Information
{
}
}
namespace WHMCS\Module\Gateway\GoCardless {
class Client
{
protected $sandboxMode = false;
protected $accessToken = "";
const URLS = array("sandbox" => "https://api-sandbox.gocardless.com/", "live" => "https://api.gocardless.com/");
const API_VERSION = "2015-07-06";
public function __construct($accessToken)
{
}
public static function factory($accessToken)
{
}
protected function getUrl()
{
}
protected function isSandbox()
{
}
protected function getUserAgent()
{
}
protected function setSandboxMode($sandbox)
{
}
protected function setAccessToken($accessToken)
{
}
protected function getAccessToken()
{
}
protected function getDefaultOptions()
{
}
}
class Resources
{
const RESOURCES = array("mandates" => "\\WHMCS\\Module\\Gateway\\GoCardless\\Resources\\Mandates", "payments" => "\\WHMCS\\Module\\Gateway\\GoCardless\\Resources\\Payments");
}
}
namespace WHMCS\Module\Gateway\GoCardless\Api {
class Client
{
protected $client = NULL;
protected $options = array();
const API_VERSION = "2015-07-06";
public function __construct(array $options)
{
}
protected function getClient()
{
}
public function get($path, $params = array())
{
}
public function put($path, $params)
{
}
public function post($path, $params)
{
}
protected function handleErrors($response)
{
}
protected function castBooleanValuesToStrings($query)
{
}
}
class Response
{
public $headers = NULL;
public $status_code = NULL;
public $body = NULL;
public function __construct($response)
{
}
}
}
namespace WHMCS\Module\Gateway\GoCardless {
class GoCardless
{
const SUPPORTED_CURRENCIES = array("AUD", "CAD", "DKK", "EUR", "GBP", "NZD", "SEK", "USD");
const SCHEMES = array("AUD" => "becs", "CAD" => "pad", "DKK" => "betalingsservice", "EUR" => "sepa", "GBP" => "bacs", "NZD" => "becs_nz", "SEK" => "autogiro", "USD" => "ach");
const SCHEME_NAMES = array("becs" => "BECS", "pad" => "PAD", "betalingsservice" => "Betalingsservice", "sepa" => "SEPA", "bacs" => "BACS", "becs_nz" => "BECS NZ", "autogiro" => "Autogiro", "ach" => "ACH");
}
}
namespace WHMCS\Module\Gateway\GoCardless\Exception {
class ApiException extends \Exception
{
}
class MalformedResponseException extends \Exception
{
}
}
namespace WHMCS\Module\Gateway\GoCardless\Resources {
class AbstractResource
{
protected $params = array();
protected $client = NULL;
public function __construct(array $gatewayParams)
{
}
}
class Mandates extends \WHMCS\Module\Gateway\GoCardless\Resources\AbstractResource
{
const STATUSES = array("pending_customer_approval" => "Pending Customer Approval", "pending_submission" => "Pending Submission", "submitted" => "Submitted", "active" => "Active", "failed" => "Failed", "cancelled" => "Cancelled", "expired" => "Expired");
public function cancelled(array $event)
{
}
public function created(array $event)
{
}
public function failed(array $event)
{
}
public function reinstated(array $event)
{
}
public function replaced(array $event)
{
}
public function defaultAction(array $event)
{
}
protected function getClientFromMandate($mandateId)
{
}
}
class Payments extends \WHMCS\Module\Gateway\GoCardless\Resources\AbstractResource
{
const CANCELLED_STATES = array("cancelled", "customer_approval_denied", "failed", "charged_back", "paid_out");
public function confirmed(array $event)
{
}
public function failed(array $event)
{
}
public function charged_back(array $event)
{
}
public function cancelled(array $event)
{
}
public function defaultAction(array $event)
{
}
}
}
namespace WHMCS\Module\Gateway\CCAvenue {
class CCAvenue
{
protected $key = NULL;
protected $crypt = NULL;
public static function factory($key)
{
}
public function encrypt($plainText)
{
}
public function decrypt($encryptedText)
{
}
}
}
namespace {
class lphp
{
public $debugging = \NULL;
public $debugstr = \NULL;
public function process($data)
{
}
public function curl_process($data)
{
}
public function decodeXML($xmlstg)
{
}
public function buildXML($pdata)
{
}
}
class merchantpartners_class
{
public $gateway_url = \NULL;
public $field_string = \NULL;
public $fields = array();
public $gatewayurls = array();
public $response_string = \NULL;
public $response = array();
public function seturl($url)
{
}
public function add_field($field, $value)
{
}
public function process()
{
}
public function get_response_reason_text()
{
}
public function dump_fields()
{
}
public function dump_response()
{
}
}
class monerisvault_mpgHttpsPost
{
public $environment = \NULL;
public $api_token = \NULL;
public $store_id = \NULL;
public $monerisvault_mpgRequest = \NULL;
public $monerisvault_mpgResponse = \NULL;
public function __construct($environment, $storeid, $apitoken, $monerisvault_mpgRequestOBJ)
{
}
public function getmonerisvault_mpgResponse()
{
}
public function toXML()
{
}
}
class monerisvault_mpgResponse
{
public $responseData = \NULL;
public $p = \NULL;
public $currentTag = \NULL;
public $purchaseHash = array();
public $refundHash = \NULL;
public $correctionHash = array();
public $isBatchTotals = \NULL;
public $term_id = \NULL;
public $receiptHash = array();
public $ecrHash = array();
public $CardType = \NULL;
public $currentTxnType = \NULL;
public $ecrs = array();
public $cards = array();
public $cardHash = array();
public $resolveData = \NULL;
public $resolveDataHash = \NULL;
public $data_key = "";
public $DataKeys = array();
public $ACSUrl = \NULL;
public function __construct($xmlString)
{
}
public function getmonerisvault_mpgResponseData()
{
}
public function getRecurSuccess()
{
}
public function getAvsResultCode()
{
}
public function getCvdResultCode()
{
}
public function getCardType()
{
}
public function getTransAmount()
{
}
public function getTxnNumber()
{
}
public function getReceiptId()
{
}
public function getTransType()
{
}
public function getReferenceNum()
{
}
public function getResponseCode()
{
}
public function getISO()
{
}
public function getBankTotals()
{
}
public function getMessage()
{
}
public function getAuthCode()
{
}
public function getComplete()
{
}
public function getTransDate()
{
}
public function getTransTime()
{
}
public function getTicket()
{
}
public function getTimedOut()
{
}
public function getCorporateCard()
{
}
public function getRecurUpdateSuccess()
{
}
public function getNextRecurDate()
{
}
public function getRecurEndDate()
{
}
public function getDataKey()
{
}
public function getResSuccess()
{
}
public function getPaymentType()
{
}
public function getResolveData()
{
}
public function setResolveData($data_key)
{
}
public function getResolveDataHash()
{
}
public function getDataKeys()
{
}
public function getResDataDataKey()
{
}
public function getResDataPaymentType()
{
}
public function getResDataCustId()
{
}
public function getResDataPhone()
{
}
public function getResDataEmail()
{
}
public function getResDataNote()
{
}
public function getResDataPan()
{
}
public function getResDataMaskedPan()
{
}
public function getResDataExpDate()
{
}
public function getResDataAvsStreetNumber()
{
}
public function getResDataAvsStreetName()
{
}
public function getResDataAvsZipcode()
{
}
public function getResDataCryptType()
{
}
public function getTerminalStatus($ecr_no)
{
}
public function getPurchaseAmount($ecr_no, $card_type)
{
}
public function getPurchaseCount($ecr_no, $card_type)
{
}
public function getRefundAmount($ecr_no, $card_type)
{
}
public function getRefundCount($ecr_no, $card_type)
{
}
public function getCorrectionAmount($ecr_no, $card_type)
{
}
public function getCorrectionCount($ecr_no, $card_type)
{
}
public function getTerminalIDs()
{
}
public function getCreditCardsAll()
{
}
public function getCreditCards($ecr)
{
}
public function characterHandler($parser, $data)
{
}
public function startHandler($parser, $name, $attrs)
{
}
public function endHandler($parser, $name)
{
}
}
class monerisvault_mpgRequest
{
public $txnTypes = array("purchase" => array("order_id", "cust_id", "amount", "pan", "expdate", "crypt_type"), "refund" => array("order_id", "amount", "txn_number", "crypt_type"), "idebit_purchase" => array("order_id", "cust_id", "amount", "idebit_track2"), "idebit_refund" => array("order_id", "amount", "txn_number"), "ind_refund" => array("order_id", "cust_id", "amount", "pan", "expdate", "crypt_type"), "preauth" => array("order_id", "cust_id", "amount", "pan", "expdate", "crypt_type"), "completion" => array("order_id", "comp_amount", "txn_number", "crypt_type"), "purchasecorrection" => array("order_id", "txn_number", "crypt_type"), "opentotals" => array("ecr_number"), "batchclose" => array("ecr_number"), "cavv_purchase" => array("order_id", "cust_id", "amount", "pan", "expdate", "cavv"), "cavv_preauth" => array("order_id", "cust_id", "amount", "pan", "expdate", "cavv"), "recur_update" => array("order_id", "cust_id", "pan", "expdate", "recur_amount", "add_num_recurs", "total_num_recurs", "hold", "terminate"), "res_add_cc" => array("cust_id", "phone", "email", "note", "pan", "expdate", "crypt_type"), "res_update_cc" => array("data_key", "cust_id", "phone", "email", "note", "pan", "expdate", "crypt_type"), "res_delete" => array("data_key"), "res_lookup_full" => array("data_key"), "res_lookup_masked" => array("data_key"), "res_get_expiring" => array(), "res_purchase_cc" => array("data_key", "order_id", "cust_id", "amount", "crypt_type"), "res_preauth_cc" => array("data_key", "order_id", "cust_id", "amount", "crypt_type"), "res_ind_refund_cc" => array("data_key", "order_id", "cust_id", "amount", "crypt_type"), "res_iscorporatecard" => array("data_key"));
public $txnArray = \NULL;
public function __construct($txn)
{
}
public function getTransactionType()
{
}
public function toXML()
{
}
}
class monerisvault_mpgCustInfo
{
public $level3template = array("cust_info" => array("email", "instructions", "billing" => array("first_name", "last_name", "company_name", "address", "city", "province", "postal_code", "country", "phone_number", "fax", "tax1", "tax2", "tax3", "shipping_cost"), "shipping" => array("first_name", "last_name", "company_name", "address", "city", "province", "postal_code", "country", "phone_number", "fax", "tax1", "tax2", "tax3", "shipping_cost"), "item" => array("name", "quantity", "product_code", "extended_amount")));
public $level3data = \NULL;
public $email = \NULL;
public $instructions = \NULL;
public function __construct($custinfo = 0, $billing = 0, $shipping = 0, $items = 0)
{
}
public function setCustInfo($custinfo)
{
}
public function setEmail($email)
{
}
public function setInstructions($instructions)
{
}
public function setShipping($shipping)
{
}
public function setBilling($billing)
{
}
public function setItems($items)
{
}
public function toXML()
{
}
public function toXML_low($template, $txnType)
{
}
}
class monerisvault_mpgRecur
{
public $params = \NULL;
public $recurTemplate = array("recur_unit", "start_now", "start_date", "num_recurs", "period", "recur_amount");
public function __construct($params)
{
}
public function toXML()
{
}
}
class monerisvault_mpgAvsInfo
{
public $params = \NULL;
public $avsTemplate = array("avs_street_number", "avs_street_name", "avs_zipcode");
public function __construct($params)
{
}
public function toXML()
{
}
}
class monerisvault_mpgCvdInfo
{
public $params = \NULL;
public $cvdTemplate = array("cvd_indicator", "cvd_value");
public function __construct($params)
{
}
public function toXML()
{
}
}
class monerisvault_mpgTransaction
{
public $txn = \NULL;
public $custInfo = \NULL;
public $recur = \NULL;
public function __construct($txn)
{
}
public function getCustInfo()
{
}
public function setCustInfo($custInfo)
{
}
public function getRecur()
{
}
public function setRecur($recur)
{
}
public function getTransaction()
{
}
public function getCvdInfo()
{
}
public function setCvdInfo($cvd)
{
}
public function getAvsInfo()
{
}
public function setAvsInfo($avs)
{
}
}
}
namespace net\authorize\util {
/**
* A class to send a request to the XML API.
*
* @package AuthorizeNet
* @subpackage net\authorize\util
*/
class HttpClient
{
public $VERIFY_PEER = true;
/**
* Constructor.
*
*/
public function __construct()
{
}
/**
* Set a log file.
*
* @param string $endPoint end point to hit from \net\authorize\api\constants\ANetEnvironment
*/
public function setPostUrl($endPoint = \net\authorize\api\constants\ANetEnvironment::CUSTOM)
{
}
/**
* @return string
*/
public function _getPostUrl()
{
}
/**
* Set a log file.
*
* @param string $filepath Path to log file.
*/
public function setLogFile($filepath)
{
}
/**
* Posts the request to AuthorizeNet endpoint using Curl & returns response.
*
* @param string $xmlRequest
* @return string $xmlResponse The response.
*/
public function _sendRequest($xmlRequest)
{
}
}
}
namespace WHMCS\Module\Gateway\AcceptJs {
class AcceptJsHttpClient extends \net\authorize\util\HttpClient
{
protected $verifyHost = 2;
protected $verifyPeer = true;
public function __construct()
{
}
public function setVerifyHost($value = 2)
{
}
public function setVerifyPeer($value = true)
{
}
public function _sendRequest($xmlRequest)
{
}
}
}
namespace net\authorize\api\controller\base {
interface IApiOperation
{
/**
* @return \net\authorize\api\contract\v1\ANetApiResponseType
*/
public function getApiResponse();
/**
* @return \net\authorize\api\contract\v1\ANetApiResponseType
*/
public function executeWithApiResponse($endPoint = null);
/**
* @return void
*/
public function execute($endPoint = null);
/*
//TS GetApiResponse();
AuthorizeNet.Api.Contracts.V1.ANetApiResponse GetErrorResponse();
//TS ExecuteWithApiResponse(AuthorizeNet.Environment environment = null);
//void Execute(AuthorizeNet.Environment environment = null);
AuthorizeNet.Api.Contracts.V1.messageTypeEnum GetResultCode();
List<string> GetResults();
*/
}
abstract class ApiOperationBase implements \net\authorize\api\controller\base\IApiOperation
{
/**
* @var \JMS\Serializer\Serializer;
*/
public $serializer = null;
/**
* @var \net\authorize\util\HttpClient;
*/
public $httpClient = null;
/**
* Constructor.
*
* @param \net\authorize\api\contract\v1\AnetApiRequestType $request ApiRequest to send
* @param string $responseType response type expected
* @throws InvalidArgumentException if invalid request
*/
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request, $responseType)
{
}
/**
* Retrieves response
* @return \net\authorize\api\contract\v1\AnetApiResponseType
*/
public function getApiResponse()
{
}
/**
* Sends request and retrieves response
* @return \net\authorize\api\contract\v1\AnetApiResponseType
*/
public function executeWithApiResponse($endPoint = \net\authorize\api\constants\ANetEnvironment::CUSTOM)
{
}
public function execute($endPoint = \net\authorize\api\constants\ANetEnvironment::CUSTOM)
{
}
protected function beforeExecute()
{
}
protected function afterExecute()
{
}
protected function validateRequest()
{
}
//need to make this abstract
protected function now()
{
}
}
}
namespace net\authorize\api\controller {
class AuthenticateTestController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
}
namespace WHMCS\Module\Gateway\AcceptJs {
class AcceptJsAuthenticateTestController extends \net\authorize\api\controller\AuthenticateTestController
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
}
}
namespace {
class planetauthorize_class
{
public $gateway_url = \NULL;
public $field_string = \NULL;
public $fields = array();
public $gatewayurls = array();
public $response_string = \NULL;
public $response = array();
public function seturl($url)
{
}
public function add_field($field, $value)
{
}
public function process()
{
}
public function get_response_reason_text()
{
}
public function dump_response()
{
}
}
}
namespace WHMCS\Module\Gateway\Stripe {
class StripeRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\ProviderTrait;
protected function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
class Constant
{
public static $apiVersion = "2019-03-14";
public static $appName = "WHMCS";
public static $appUrl = "https://www.whmcs.com";
public static $appPartnerId = "pp_partner_EzZDHkkVgTrj6n";
}
class StripeController
{
public function intent(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function setupIntent(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function add(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function adminAdd(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function addProcess(\WHMCS\Http\Message\ServerRequest $request, $sessionUserId = false)
{
}
}
}
namespace WHMCS\Route {
trait AdminProviderTrait
{
use \WHMCS\Route\ProviderTrait;
protected function enforceAdminAuthentication(array $routeCollection)
{
}
public function mutateAdminRoutesForCustomDirectory(array $adminRoutes = array())
{
}
public function registerRoutes(\FastRoute\RouteCollector $routeCollector)
{
}
}
}
namespace WHMCS\Module\Gateway\Stripe\Admin {
class StripeRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
protected function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Module {
abstract class AbstractWidget
{
protected $title = NULL;
protected $description = NULL;
protected $columns = 1;
protected $weight = 100;
protected $wrapper = true;
protected $cache = false;
protected $cachePerUser = false;
protected $cacheExpiry = 3600;
protected $requiredPermission = "";
protected $draggable = true;
protected $adminUser = NULL;
public function getId()
{
}
public function getTitle()
{
}
public function getDescription()
{
}
public function getColumnSize()
{
}
public function getWeight()
{
}
public function showWrapper()
{
}
public function isCachable()
{
}
public function isCachedPerUser()
{
}
public function getCacheExpiry()
{
}
public function getRequiredPermission()
{
}
public abstract function getData();
public abstract function generateOutput($data);
protected function fetchData($forceRefresh = false)
{
}
public function sanitizeData($data)
{
}
public function render($forceRefresh = false)
{
}
public function isDraggable()
{
}
}
}
namespace WHMCS\Module\Widget {
/**
* MarketConnect Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class MarketConnect extends \WHMCS\Module\AbstractWidget
{
protected $title = 'MarketConnect';
protected $description = 'An overview of MarketConnect.';
protected $weight = 45;
protected $cache = true;
protected $cacheExpiry = 6 * 60;
protected $requiredPermission = 'View MarketConnect Balance';
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* Automation Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class Automation extends \WHMCS\Module\AbstractWidget
{
protected $title = 'Automation Overview';
protected $description = 'An overview of system automation.';
protected $weight = 20;
protected $cache = true;
protected $requiredPermission = 'Configure Automation Settings';
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* Abstract Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class Support extends \WHMCS\Module\AbstractWidget
{
protected $title = 'Support';
protected $description = 'An overview of support.';
protected $weight = 30;
protected $cache = true;
protected $cacheExpiry = 120;
protected $cachePerUser = true;
protected $requiredPermission = 'List Support Tickets';
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* Badges Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class Badges extends \WHMCS\Module\AbstractWidget
{
protected $title = 'Badges';
protected $description = '';
protected $columns = 3;
protected $weight = 0;
protected $wrapper = false;
protected $cache = true;
protected $cacheExpiry = 120;
protected $draggable = false;
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* Staff Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class Staff extends \WHMCS\Module\AbstractWidget
{
protected $title = 'Staff Online';
protected $description = 'An overview of staff.';
protected $weight = 50;
protected $cache = true;
protected $cacheExpiry = 60;
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* NetworkStatus Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class NetworkStatus extends \WHMCS\Module\AbstractWidget
{
protected $title = 'Network Status';
protected $description = 'An overview of Network Status.';
protected $weight = 80;
protected $cache = true;
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* Client Activity Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class ClientActivity extends \WHMCS\Module\AbstractWidget
{
protected $title = 'Client Activity';
protected $description = 'Recent online clients.';
protected $weight = 70;
protected $cache = true;
protected $cacheExpiry = 300;
protected $requiredPermission = 'List Clients';
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* ToDo Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class ToDo extends \WHMCS\Module\AbstractWidget
{
protected $title = 'To-Do List';
protected $description = '';
protected $weight = 60;
protected $cache = false;
protected $requiredPermission = 'To-Do List';
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* Billing Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class Billing extends \WHMCS\Module\AbstractWidget
{
protected $title = 'Billing';
protected $description = 'An overview of billing.';
protected $weight = 40;
protected $cache = true;
protected $requiredPermission = 'View Income Totals';
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* System Overview Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class Overview extends \WHMCS\Module\AbstractWidget
{
protected $title = 'System Overview';
protected $description = 'An overview of orders and income.';
protected $columns = 2;
protected $weight = 10;
protected $requiredPermission = 'View Income Totals';
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* Health Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class Health extends \WHMCS\Module\AbstractWidget
{
protected $title = 'System Health';
protected $description = 'An overview of System Health.';
protected $weight = 90;
protected $cache = true;
protected $requiredPermission = 'Health and Updates';
public function getData()
{
}
public function generateOutput($data)
{
}
}
/**
* Activity Widget.
*
* @copyright Copyright (c) WHMCS Limited 2005-2018
* @license https://www.whmcs.com/license/ WHMCS Eula
*/
class Activity extends \WHMCS\Module\AbstractWidget
{
protected $title = 'Activity';
protected $description = 'Recent system activity.';
protected $weight = 100;
protected $cache = true;
protected $requiredPermission = 'View Activity Log';
public function getData()
{
}
public function generateOutput($data)
{
}
}
}
namespace {
class HeartInternet_API
{
public $namespace = "urn:ietf:params:xml:ns:epp-1.0";
public function connect($test_mode = \false)
{
}
public function getResponse()
{
}
public function sendMessage($output, $no_parsing = \false)
{
}
public function logIn($userid, $password, $objects, $extensions)
{
}
public function buildXML($content)
{
}
public function disconnect()
{
}
}
class Services_JSON_Error extends \PEAR_Error
{
public function __construct($message = "unknown error", $code = \NULL, $mode = \NULL, $options = \NULL, $userinfo = \NULL)
{
}
}
class Services_JSON
{
public function __construct($use = 0)
{
}
public function utf162utf8($utf16)
{
}
public function utf82utf16($utf8)
{
}
public function encode($var)
{
}
public function name_value($name, $value)
{
}
public function reduce_string($str)
{
}
public function decode($str)
{
}
public function isError($data, $code = \NULL)
{
}
}
class IXR_Value
{
public $data = \NULL;
public $type = \NULL;
public function IXR_Value($data, $type = \false)
{
}
public function calculateType()
{
}
public function getXml()
{
}
public function isStruct($array)
{
}
}
class IXR_Message
{
public $message = \NULL;
public $messageType = \NULL;
public $faultCode = \NULL;
public $faultString = \NULL;
public $methodName = \NULL;
public $params = \NULL;
public $_arraystructs = array();
public $_arraystructstypes = array();
public $_currentStructName = array();
public $_param = \NULL;
public $_value = \NULL;
public $_currentTag = \NULL;
public $_currentTagContents = \NULL;
public $_parser = \NULL;
public function IXR_Message($message)
{
}
public function parse()
{
}
public function tag_open($parser, $tag, $attr)
{
}
public function cdata($parser, $cdata)
{
}
public function tag_close($parser, $tag)
{
}
}
class IXR_Server
{
public $data = \NULL;
public $callbacks = array();
public $message = \NULL;
public $capabilities = \NULL;
public function IXR_Server($callbacks = \false, $data = \false)
{
}
public function serve($data = \false)
{
}
public function call($methodname, $args)
{
}
public function error($error, $message = \false)
{
}
public function output($xml)
{
}
public function hasMethod($method)
{
}
public function setCapabilities()
{
}
public function getCapabilities($args)
{
}
public function setCallbacks()
{
}
public function listMethods($args)
{
}
public function multiCall($methodcalls)
{
}
}
class IXR_Request
{
public $method = \NULL;
public $args = \NULL;
public $xml = \NULL;
public function IXR_Request($method, $args)
{
}
public function getLength()
{
}
public function getXml()
{
}
}
class IXR_Client
{
public $server = \NULL;
public $port = \NULL;
public $path = \NULL;
public $useragent = \NULL;
public $response = \NULL;
public $message = \false;
public $debug = \false;
public $error = \false;
public function IXR_Client($server, $path = \false, $port = 80)
{
}
public function query()
{
}
public function getResponse()
{
}
public function isError()
{
}
public function getErrorCode()
{
}
public function getErrorMessage()
{
}
}
class IXR_Error
{
public $code = \NULL;
public $message = \NULL;
public function IXR_Error($code, $message)
{
}
public function getXml()
{
}
}
class IXR_Date
{
public $year = \NULL;
public $month = \NULL;
public $day = \NULL;
public $hour = \NULL;
public $minute = \NULL;
public $second = \NULL;
public function IXR_Date($time)
{
}
public function parseTimestamp($timestamp)
{
}
public function parseIso($iso)
{
}
public function getIso()
{
}
public function getXml()
{
}
public function getTimestamp()
{
}
}
class IXR_Base64
{
public $data = \NULL;
public function IXR_Base64($data)
{
}
public function getXml()
{
}
}
class IXR_IntrospectionServer extends \IXR_Server
{
public $signatures = \NULL;
public $help = \NULL;
public function IXR_IntrospectionServer()
{
}
public function addCallback($method, $callback, $args, $help)
{
}
public function call($methodname, $args)
{
}
public function methodSignature($method)
{
}
public function methodHelp($method)
{
}
}
class IXR_ClientMulticall extends \IXR_Client
{
public $calls = array();
public function IXR_ClientMulticall($server, $path = \false, $port = 80)
{
}
public function addCall()
{
}
public function query()
{
}
}
}
namespace OAuth2\Controller {
/**
* This controller is called when a token is being requested.
* it is called to handle all grant types the application supports.
* It also validates the client's credentials
*
* ex:
* > $tokenController->handleTokenRequest(OAuth2\Request::createFromGlobals(), $response = new OAuth2\Response());
* > $response->send();
*
*/
interface TokenControllerInterface
{
/**
* handleTokenRequest
*
* @param $request
* OAuth2\RequestInterface - The current http request
* @param $response
* OAuth2\ResponseInterface - An instance of OAuth2\ResponseInterface to contain the response data
*
*/
public function handleTokenRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response);
public function grantAccessToken(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response);
}
/**
* This controller is called when a "resource" is requested.
* call verifyResourceRequest in order to determine if the request
* contains a valid token.
*
* ex:
* > if (!$resourceController->verifyResourceRequest(OAuth2\Request::createFromGlobals(), $response = new OAuth2\Response())) {
* > $response->send(); // authorization failed
* > die();
* > }
* > return json_encode($resource); // valid token! Send the stuff!
*
*/
interface ResourceControllerInterface
{
public function verifyResourceRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response, $scope = null);
public function getAccessTokenData(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response);
}
}
namespace WHMCS\ApplicationLink\Server {
interface ApplicationLinkServerInterface extends \OAuth2\Controller\TokenControllerInterface, \OAuth2\Controller\ResourceControllerInterface
{
public function postAccessTokenResponseAction(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response);
}
}
namespace OAuth2\Controller {
/**
* This controller is called when a user should be authorized
* by an authorization server. As OAuth2 does not handle
* authorization directly, this controller ensures the request is valid, but
* requires the application to determine the value of $is_authorized
*
* ex:
* > $user_id = $this->somehowDetermineUserId();
* > $is_authorized = $this->somehowDetermineUserAuthorization();
* > $response = new OAuth2\Response();
* > $authorizeController->handleAuthorizeRequest(
* > OAuth2\Request::createFromGlobals(),
* > $response,
* > $is_authorized,
* > $user_id);
* > $response->send();
*
*/
interface AuthorizeControllerInterface
{
/**
* List of possible authentication response types.
* The "authorization_code" mechanism exclusively supports 'code'
* and the "implicit" mechanism exclusively supports 'token'.
*
* @var string
* @see http://tools.ietf.org/html/rfc6749#section-4.1.1
* @see http://tools.ietf.org/html/rfc6749#section-4.2.1
*/
const RESPONSE_TYPE_AUTHORIZATION_CODE = 'code';
const RESPONSE_TYPE_ACCESS_TOKEN = 'token';
public function handleAuthorizeRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response, $is_authorized, $user_id = null);
public function validateAuthorizeRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response);
}
}
namespace OAuth2\OpenID\Controller {
/**
* This controller is called when the user claims for OpenID Connect's
* UserInfo endpoint should be returned.
*
* ex:
* > $response = new OAuth2\Response();
* > $userInfoController->handleUserInfoRequest(
* > OAuth2\Request::createFromGlobals(),
* > $response;
* > $response->send();
*
*/
interface UserInfoControllerInterface
{
public function handleUserInfoRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response);
}
}
namespace OAuth2 {
/**
* Server class for OAuth2
* This class serves as a convience class which wraps the other Controller classes
*
* @see OAuth2\Controller\ResourceController
* @see OAuth2\Controller\AuthorizeController
* @see OAuth2\Controller\TokenController
*/
class Server implements \OAuth2\Controller\ResourceControllerInterface, \OAuth2\Controller\AuthorizeControllerInterface, \OAuth2\Controller\TokenControllerInterface, \OAuth2\OpenID\Controller\UserInfoControllerInterface
{
// misc properties
protected $response;
protected $config;
protected $storages;
// servers
protected $authorizeController;
protected $tokenController;
protected $resourceController;
protected $userInfoController;
// config classes
protected $grantTypes;
protected $responseTypes;
protected $tokenType;
protected $scopeUtil;
protected $clientAssertionType;
protected $storageMap = array('access_token' => 'OAuth2\\Storage\\AccessTokenInterface', 'authorization_code' => 'OAuth2\\Storage\\AuthorizationCodeInterface', 'client_credentials' => 'OAuth2\\Storage\\ClientCredentialsInterface', 'client' => 'OAuth2\\Storage\\ClientInterface', 'refresh_token' => 'OAuth2\\Storage\\RefreshTokenInterface', 'user_credentials' => 'OAuth2\\Storage\\UserCredentialsInterface', 'user_claims' => 'OAuth2\\OpenID\\Storage\\UserClaimsInterface', 'public_key' => 'OAuth2\\Storage\\PublicKeyInterface', 'jwt_bearer' => 'OAuth2\\Storage\\JWTBearerInterface', 'scope' => 'OAuth2\\Storage\\ScopeInterface');
protected $responseTypeMap = array('token' => 'OAuth2\\ResponseType\\AccessTokenInterface', 'code' => 'OAuth2\\ResponseType\\AuthorizationCodeInterface', 'id_token' => 'OAuth2\\OpenID\\ResponseType\\IdTokenInterface', 'id_token token' => 'OAuth2\\OpenID\\ResponseType\\IdTokenTokenInterface', 'code id_token' => 'OAuth2\\OpenID\\ResponseType\\CodeIdTokenInterface');
/**
* @param mixed $storage (array or OAuth2\Storage) - single object or array of objects implementing the
* required storage types (ClientCredentialsInterface and AccessTokenInterface as a minimum)
* @param array $config specify a different token lifetime, token header name, etc
* @param array $grantTypes An array of OAuth2\GrantType\GrantTypeInterface to use for granting access tokens
* @param array $responseTypes Response types to use. array keys should be "code" and and "token" for
* Access Token and Authorization Code response types
* @param OAuth2\TokenType\TokenTypeInterface $tokenType The token type object to use. Valid token types are "bearer" and "mac"
* @param OAuth2\ScopeInterface $scopeUtil The scope utility class to use to validate scope
* @param OAuth2\ClientAssertionType\ClientAssertionTypeInterface $clientAssertionType The method in which to verify the client identity. Default is HttpBasic
*
* @ingroup oauth2_section_7
*/
public function __construct($storage = array(), array $config = array(), array $grantTypes = array(), array $responseTypes = array(), \OAuth2\TokenType\TokenTypeInterface $tokenType = null, \OAuth2\ScopeInterface $scopeUtil = null, \OAuth2\ClientAssertionType\ClientAssertionTypeInterface $clientAssertionType = null)
{
}
public function getAuthorizeController()
{
}
public function getTokenController()
{
}
public function getResourceController()
{
}
public function getUserInfoController()
{
}
/**
* every getter deserves a setter
*/
public function setAuthorizeController(\OAuth2\Controller\AuthorizeControllerInterface $authorizeController)
{
}
/**
* every getter deserves a setter
*/
public function setTokenController(\OAuth2\Controller\TokenControllerInterface $tokenController)
{
}
/**
* every getter deserves a setter
*/
public function setResourceController(\OAuth2\Controller\ResourceControllerInterface $resourceController)
{
}
/**
* every getter deserves a setter
*/
public function setUserInfoController(\OAuth2\OpenID\Controller\UserInfoControllerInterface $userInfoController)
{
}
/**
* Return claims about the authenticated end-user.
* This would be called from the "/UserInfo" endpoint as defined in the spec.
*
* @param $request - OAuth2\RequestInterface
* Request object to grant access token
*
* @param $response - OAuth2\ResponseInterface
* Response object containing error messages (failure) or user claims (success)
*
* @throws InvalidArgumentException
* @throws LogicException
*
* @see http://openid.net/specs/openid-connect-core-1_0.html#UserInfo
*/
public function handleUserInfoRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response = null)
{
}
/**
* Grant or deny a requested access token.
* This would be called from the "/token" endpoint as defined in the spec.
* Obviously, you can call your endpoint whatever you want.
*
* @param $request - OAuth2\RequestInterface
* Request object to grant access token
*
* @param $response - OAuth2\ResponseInterface
* Response object containing error messages (failure) or access token (success)
*
* @throws InvalidArgumentException
* @throws LogicException
*
* @see http://tools.ietf.org/html/rfc6749#section-4
* @see http://tools.ietf.org/html/rfc6749#section-10.6
* @see http://tools.ietf.org/html/rfc6749#section-4.1.3
*
* @ingroup oauth2_section_4
*/
public function handleTokenRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response = null)
{
}
public function grantAccessToken(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response = null)
{
}
/**
* Handle a revoke token request
* This would be called from the "/revoke" endpoint as defined in the draft Token Revocation spec
*
* @see https://tools.ietf.org/html/rfc7009#section-2
*
* @param RequestInterface $request
* @param ResponseInterface $response
* @return Response|ResponseInterface
*/
public function handleRevokeRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response = null)
{
}
/**
* Redirect the user appropriately after approval.
*
* After the user has approved or denied the resource request the
* authorization server should call this function to redirect the user
* appropriately.
*
* @param $request
* The request should have the follow parameters set in the querystring:
* - response_type: The requested response: an access token, an
* authorization code, or both.
* - client_id: The client identifier as described in Section 2.
* - redirect_uri: An absolute URI to which the authorization server
* will redirect the user-agent to when the end-user authorization
* step is completed.
* - scope: (optional) The scope of the resource request expressed as a
* list of space-delimited strings.
* - state: (optional) An opaque value used by the client to maintain
* state between the request and callback.
* @param $is_authorized
* TRUE or FALSE depending on whether the user authorized the access.
* @param $user_id
* Identifier of user who authorized the client
*
* @see http://tools.ietf.org/html/rfc6749#section-4
*
* @ingroup oauth2_section_4
*/
public function handleAuthorizeRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response, $is_authorized, $user_id = null)
{
}
/**
* Pull the authorization request data out of the HTTP request.
* - The redirect_uri is OPTIONAL as per draft 20. But your implementation can enforce it
* by setting $config['enforce_redirect'] to true.
* - The state is OPTIONAL but recommended to enforce CSRF. Draft 21 states, however, that
* CSRF protection is MANDATORY. You can enforce this by setting the $config['enforce_state'] to true.
*
* The draft specifies that the parameters should be retrieved from GET, override the Response
* object to change this
*
* @return
* The authorization parameters so the authorization server can prompt
* the user for approval if valid.
*
* @see http://tools.ietf.org/html/rfc6749#section-4.1.1
* @see http://tools.ietf.org/html/rfc6749#section-10.12
*
* @ingroup oauth2_section_3
*/
public function validateAuthorizeRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response = null)
{
}
public function verifyResourceRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response = null, $scope = null)
{
}
public function getAccessTokenData(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response = null)
{
}
public function addGrantType(\OAuth2\GrantType\GrantTypeInterface $grantType, $identifier = null)
{
}
/**
* Set a storage object for the server
*
* @param $storage
* An object implementing one of the Storage interfaces
* @param $key
* If null, the storage is set to the key of each storage interface it implements
*
* @see storageMap
*/
public function addStorage($storage, $key = null)
{
}
public function addResponseType(\OAuth2\ResponseType\ResponseTypeInterface $responseType, $key = null)
{
}
public function getScopeUtil()
{
}
/**
* every getter deserves a setter
*/
public function setScopeUtil($scopeUtil)
{
}
protected function createDefaultAuthorizeController()
{
}
protected function createDefaultTokenController()
{
}
protected function createDefaultResourceController()
{
}
protected function createDefaultUserInfoController()
{
}
protected function getDefaultTokenType()
{
}
protected function getDefaultResponseTypes()
{
}
protected function getDefaultGrantTypes()
{
}
protected function getAccessTokenResponseType()
{
}
protected function getIdTokenResponseType()
{
}
protected function getIdTokenTokenResponseType()
{
}
/**
* For Resource Controller
*/
protected function createDefaultJwtAccessTokenStorage()
{
}
/**
* For Authorize and Token Controllers
*/
protected function createDefaultJwtAccessTokenResponseType()
{
}
protected function createDefaultAccessTokenResponseType()
{
}
protected function createDefaultIdTokenResponseType()
{
}
protected function createDefaultIdTokenTokenResponseType()
{
}
protected function validateOpenIdConnect()
{
}
protected function normalizeResponseType($name)
{
}
public function getResponse()
{
}
public function getStorages()
{
}
public function getStorage($name)
{
}
public function getGrantTypes()
{
}
public function getGrantType($name)
{
}
public function getResponseTypes()
{
}
public function getResponseType($name)
{
}
public function getTokenType()
{
}
public function getClientAssertionType()
{
}
public function setConfig($name, $value)
{
}
public function getConfig($name, $default = null)
{
}
}
}
namespace WHMCS\ApplicationLink\Server {
class Server extends \OAuth2\Server implements \WHMCS\ApplicationLink\Server\ApplicationLinkServerInterface
{
public function getAccessToken(\OAuth2\HttpFoundationBridge\Request $request)
{
}
protected function findAccessToken($accessToken)
{
}
public function postAccessTokenResponseAction(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
public function getModuleApplicationLinkServer(\OAuth2\HttpFoundationBridge\Request $request)
{
}
public function handleSingleSignOnRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response, $requestedScope = "")
{
}
protected function authenticateTokenUser(\OAuth2\RequestInterface $request, \WHMCS\ApplicationLink\AccessToken $token)
{
}
public function getDiscoveryDocument()
{
}
public function getJwks()
{
}
public function base64urlEncode($data)
{
}
public function base64urlDecode($data)
{
}
public static function getIssuer()
{
}
protected function createDefaultIdTokenResponseType()
{
}
public function hasUserAuthorizedRequestedScopes(\WHMCS\User\Client $user)
{
}
public function updateUserAuthorizedScopes(\WHMCS\User\Client $user, array $scopes = array())
{
}
public static function storeRequest(\OAuth2\HttpFoundationBridge\Request $request)
{
}
public static function retrieveRequest($requestHash, $deleteAfterFetch = true)
{
}
public function pruneExpiredAccessTokens()
{
}
}
}
namespace Cpanel\ApplicationLink {
class Server extends \WHMCS\ApplicationLink\Server\Server
{
public function handleTokenRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response = NULL)
{
}
protected function preProcessHandleTokenRequest(\OAuth2\HttpFoundationBridge\Request $request, \OAuth2\HttpFoundationBridge\Response $response = NULL)
{
}
protected function postProcessHandleTokenRequest(\OAuth2\ResponseInterface $response)
{
}
public function postAccessTokenResponseAction(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
}
}
namespace {
abstract class CCBaseAPIClient
{
public $debug = \false;
public $encoding = "UTF-8";
public $debugconsole = \false;
public $raw_response = "";
public $raw_request = "";
public $remote_version = \false;
public $message = "";
public $data = \NULL;
public $success = \false;
public $error = "";
protected $classname = "";
protected $methodname = "";
protected $ccurl = "";
protected $http_request_error = "";
public function call()
{
}
public function __call($name, $args)
{
}
protected function build_request_packet($methodname, $payload)
{
}
protected function http_request($url, $postdata)
{
}
public function handle_http_error($errno, $errstr, $errfile, $errline)
{
}
protected function http_request_php($url, $postdata)
{
}
protected function http_request_httpretriever($url, $postdata)
{
}
protected function cc_initialize($ccurl)
{
}
protected abstract function build_argument_payload($functionargs);
protected function build_argument_xml($args)
{
}
protected function parse_data($data)
{
}
protected function parse_response_packet($packet)
{
}
protected function api_request($packet)
{
}
protected function set_error($msg)
{
}
protected function _call($name, $args)
{
}
}
class CCServerAPIClient extends \CCBaseAPIClient
{
protected $classname = "server";
public function __construct($ccurl)
{
}
protected function build_argument_payload($functionargs)
{
}
}
class CCSystemAPIClient extends \CCBaseAPIClient
{
protected $classname = "system";
public function __construct($ccurl)
{
}
public function build_argument_payload($functionargs)
{
}
}
class CCAPIXML
{
public function parse($xml)
{
}
public static function xmlentities($string)
{
}
public static function xml_entity_decode($string)
{
}
}
abstract class Plesk_Manager_Base
{
public function __call($name, $args)
{
}
public function getVersion()
{
}
public function createTableForAccountStorage()
{
}
protected function _checkErrors($result)
{
}
}
class Plesk_Manager_V1000 extends \Plesk_Manager_Base
{
protected function _getSupportedApiVersions()
{
}
protected function _getSharedIpv4($params)
{
}
protected function _getSharedIpv6($params)
{
}
protected function _getFreeDedicatedIpv4()
{
}
protected function _getFreeDedicatedIpv6()
{
}
protected function _setAccountPassword($params)
{
}
protected function _getIp($params, $version = \Plesk_Object_Ip::IPV4)
{
}
protected function _setWebspaceStatus($params)
{
}
protected function _deleteWebspace($params)
{
}
protected function _setWebspacePassword($params)
{
}
protected function _getClientAreaForm($params)
{
}
protected function _getFreeDedicatedIp($version = \Plesk_Object_Ip::IPV4)
{
}
protected function _getIpList($type = \Plesk_Object_Ip::SHARED, $version = \NULL)
{
}
protected function _isIpv6($ip)
{
}
protected function _getCustomerExternalId($params)
{
}
protected function _getAccountInfo($params, $panelExternalId = \NULL)
{
}
protected function _addAccount($params)
{
}
protected function _getAddAccountParams($params)
{
}
protected function _addIpToIpPool($accountId, $params)
{
}
protected function _addWebspace($params)
{
}
protected function _getWebspacesUsage($params)
{
}
protected function _getWebspacesByOwnerId($ownerId)
{
}
protected function _getIps($params)
{
}
protected function _changeSubscriptionIp($params)
{
}
protected function _checkRestrictions($params)
{
}
protected function _getServicePlans()
{
}
protected function _listAccounts(array $params)
{
}
protected function _getCustomers(array $params)
{
}
protected function _getCustomersByOwner(array $params)
{
}
protected function _getResellers(array $params)
{
}
protected function _getResellerByLogin(array $params)
{
}
protected function _getServerData(array $params)
{
}
}
class Plesk_Manager_V1630 extends \Plesk_Manager_V1000
{
protected function _getResellerPlans()
{
}
protected function _getAccountInfo($params, $panelExternalId = \NULL)
{
}
protected function _getAddAccountParams($params)
{
}
protected function _addAccount($params)
{
}
protected function _addWebspace($params)
{
}
protected function _setResellerStatus($params)
{
}
protected function _deleteReseller($params)
{
}
protected function _setAccountPassword($params)
{
}
protected function _deleteWebspace($params)
{
}
protected function _switchSubscription($params)
{
}
protected function _processAddons($params)
{
}
protected function _getWebspacesUsage($params)
{
}
protected function _getResellersUsage($params)
{
}
protected function _addIpToIpPool($accountId, $params)
{
}
protected function _getWebspacesByOwnerId($ownerId)
{
}
protected function _getCustomerExternalId($params)
{
}
protected function _changeSubscriptionIp($params)
{
}
protected function _getLimits(\SimpleXMLElement $limits)
{
}
protected function _getServicePlans()
{
}
protected function _generateCSR($params)
{
}
protected function _installSsl($params)
{
}
protected function _getMxRecords($params)
{
}
protected function _deleteMxRecords($params)
{
}
protected function _addMxRecords($params)
{
}
protected function _listAccounts(array $params)
{
}
protected function _getCustomers(array $params)
{
}
protected function _getCustomersByOwner(array $params)
{
}
protected function _getResellers(array $params)
{
}
protected function _getResellerByLogin(array $params)
{
}
protected function _getServerData(array $params)
{
}
}
class Plesk_Manager_V1632 extends \Plesk_Manager_V1630
{
protected function _processAddons($params)
{
}
protected function _addWebspace($params)
{
}
protected function _getSharedIpv4($params)
{
}
protected function _getSharedIpv6($params)
{
}
protected function _getFreeDedicatedIpv4()
{
}
protected function _getFreeDedicatedIpv6()
{
}
protected function _getIpList($type = \Plesk_Object_Ip::SHARED, $version = \NULL)
{
}
protected function _getFreeDedicatedIp($version = \Plesk_Object_Ip::IPV4)
{
}
protected function _getWebspacesUsage($params)
{
}
protected function _changeSubscriptionIp($params)
{
}
protected function _listAccounts(array $params)
{
}
}
class Plesk_Manager_V1635 extends \Plesk_Manager_V1632
{
protected function _createSession($params)
{
}
protected function _getClientAreaForm($params)
{
}
}
class Plesk_Manager_V1640 extends \Plesk_Manager_V1635
{
protected function _getWebspacesUsage($params)
{
}
}
class Plesk_Manager_V1660 extends \Plesk_Manager_V1640
{
protected function _getAddAccountParams($params)
{
}
protected function _addAccount($params)
{
}
}
class Plesk_Manager_V1670 extends \Plesk_Manager_V1660
{
protected function _generateCSR($params)
{
}
protected function _installSsl($params)
{
}
}
class Plesk_Object_Ip
{
const SHARED = "shared";
const DEDICATED = "exclusive";
const IPV4 = "ipv4";
const IPV6 = "ipv6";
const ADDON_NAME_IPV4 = "Dedicated IPv4";
const ADDON_NAME_IPV6 = "Dedicated IPv6";
}
class Plesk_Object_ResellerPlan
{
public $id = \NULL;
public $name = \NULL;
public function __construct($id, $name)
{
}
}
class Plesk_Object_Webspace
{
const STATUS_ACTIVE = 0;
const TYPE_VRT_HST = "vrt_hst";
}
class Plesk_Object_Customer
{
const STATUS_ACTIVE = 0;
const STATUS_SUSPENDED_BY_ADMIN = 16;
const STATUS_SUSPENDED_BY_RESELLER = 32;
const TYPE_CLIENT = "hostingaccount";
const TYPE_RESELLER = "reselleraccount";
const EXTERNAL_ID_PREFIX = "whmcs_plesk_";
public static function getCustomerExternalId($params)
{
}
}
class Plesk_Object_Addon
{
const ADDON_PREFIX = "Plesk ";
}
class Plesk_Config
{
public static function get()
{
}
public static function getDefaults()
{
}
}
class Plesk_Utils
{
public static function getAccountsCount($userId)
{
}
}
class Plesk_Loader
{
public static function init($params)
{
}
public static function autoload($className)
{
}
}
class Plesk_Api
{
protected $_login = \NULL;
protected $_password = \NULL;
protected $_hostname = \NULL;
protected $_port = \NULL;
protected $_isSecure = \NULL;
const STATUS_OK = "ok";
const STATUS_ERROR = "error";
const ERROR_AUTHENTICATION_FAILED = 1001;
const ERROR_AGENT_INITIALIZATION_FAILED = 1003;
const ERROR_OBJECT_NOT_FOUND = 1013;
const ERROR_PARSING_XML = 1014;
const ERROR_OPERATION_FAILED = 1023;
public function __construct($login, $password, $hostname, $port, $isSecure)
{
}
public function __call($name, $args)
{
}
public function isAdmin()
{
}
protected function request($command, $params)
{
}
}
class Plesk_Registry
{
public static function getInstance()
{
}
public function __get($name)
{
}
public function __set($name, $value)
{
}
public function __isset($name)
{
}
}
class Plesk_Translate
{
public function __construct()
{
}
public function translate($msg, $placeholders = array())
{
}
}
class VPSNET
{
protected $_apiUrl = "https://api.vps.net";
protected $_apiUserAgent = "VPSNET_API_10_JSON/PHP";
public $last_errors = \NULL;
public function __destruct()
{
}
public function isAuthenticationInfoSet()
{
}
public static function getInstance($username = "", $_auth_api_key = "", $proxy = "")
{
}
public function __clone()
{
}
public function setAPIResource($resource, $append_api_version = \true, $queryString = "")
{
}
public function sendGETRequest()
{
}
public function sendPOSTRequest($data = \NULL, $encodeasjson = \true)
{
}
public function sendPUTRequest($data)
{
}
public function sendDELETERequest()
{
}
protected function sendRequest($data = \NULL)
{
}
public function getNodes($consumer_id = 0)
{
}
public function getIPAddresses($consumer_id = 0)
{
}
public function getVirtualMachines($consumer_id = 0)
{
}
public function getAvailableCloudsAndTemplates()
{
}
public function addInternalIPAddresses($quantity, $consumer_id = 0)
{
}
public function addExternalIPAddresses($quantity, $cloud_id, $consumer_id = 0)
{
}
public function createVirtualMachine($virtualmachine)
{
}
public function addNodes($quantity, $consumer_id = 0)
{
}
public function _castObjectToClass($classname, $object)
{
}
}
class Node
{
public $virtual_machine_id = 0;
public $id = 0;
public $consumer_id = 0;
public $deleted = 0;
public function __construct($id = 0, $virtual_machine_id = 0)
{
}
public function remove()
{
}
}
class IPAddress
{
public $id = 0;
public $netmask = "";
public $network = "";
public $cloud_id = 0;
public $ip_address = "";
public $consumer_id = 0;
public $deleted = \false;
public function isInternal()
{
}
public function isExternal()
{
}
public function remove()
{
}
}
class Backup
{
public $virtual_machine_id = 0;
public $id = 0;
public $label = "";
public $auto_backup_type = \NULL;
public $deleted = \false;
public function __construct($id = 0, $virtual_machine_id = 0)
{
}
public function restore()
{
}
public function remove()
{
}
}
class UpgradeSchedule
{
public $id = 0;
public $label = "";
public $extra_slices = 0;
public $temporary = \false;
public $run_at = \NULL;
public $days = \NULL;
public function __construct($label, $extra_slices, $run_at, $days = 0)
{
}
}
class VirtualMachine
{
public $label = "";
public $hostname = "";
public $domain_name = "";
public $slices_count = 0;
public $slices_required = 0;
public $backups_enabled = 0;
public $rsync_backups_enabled = 0;
public $r1_soft_backups_enabled = 0;
public $system_template_id = 0;
public $cloud_id = 0;
public $id = \NULL;
public $consumer_id = 0;
public $created_at = \NULL;
public $updated_at = \NULL;
public $password = "";
public $backups = array();
public $upgrade_schedules = array();
public $deleted = \false;
public function __construct($label = "", $hostname = "", $slices_required = "", $backups_enabled = "", $cloud_id = "", $system_template_id = "", $consumer_id = 0)
{
}
public function powerOn()
{
}
public function powerOff()
{
}
public function shutdown()
{
}
public function reboot()
{
}
public function createBackup($label)
{
}
public function createTemporaryUpgradeSchedule($label, $extra_slices, $run_at, $days)
{
}
public function showNetworkGraph($period)
{
}
public function showCPUGraph($period)
{
}
protected function showGraph($period, $type)
{
}
public function showConsole()
{
}
public function loadBackups()
{
}
public function loadFully()
{
}
public function update()
{
}
public function remove()
{
}
}
}
namespace WHMCS\Module\Contracts {
interface NotificationModuleInterface
{
public function settings();
public function isActive();
public function getName();
public function getDisplayName();
public function getLogoPath();
public function testConnection($settings);
public function notificationSettings();
public function getDynamicField($fieldName, $settings);
public function sendNotification(\WHMCS\Notification\Contracts\NotificationInterface $notification, $moduleSettings, $notificationSettings);
}
}
namespace WHMCS\Module\Notification {
trait DescriptionTrait
{
protected $displayName = "";
protected $logoFileName = "";
public function isActive()
{
}
public function getName()
{
}
public function getDisplayName()
{
}
public function setDisplayName($displayName)
{
}
public function getLogoFileName()
{
}
public function setLogoFileName($logoFileName)
{
}
public function getLogoPath()
{
}
}
}
namespace WHMCS\Module\Notification\Email {
/**
* Notification module for delivering notifications via email
*
* All notification modules must implement NotificationModuleInterface
*
* @copyright Copyright (c) WHMCS Limited 2005-2020
* @license http://www.whmcs.com/license/ WHMCS Eula
*/
class Email implements \WHMCS\Module\Contracts\NotificationModuleInterface
{
use \WHMCS\Module\Notification\DescriptionTrait;
/**
* Constructor
*
* Any instance of a notification module should have the display name and
* logo filename at the ready. Therefore it is recommend to ensure these
* values are set during object instantiation.
*
* The Email notification module utilizes the DescriptionTrait which
* provides methods to fulfill this requirement.
*
* @see \WHMCS\Module\Notification\DescriptionTrait::setDisplayName()
* @see \WHMCS\Module\Notification\DescriptionTrait::setLogoFileName()
*/
public function __construct()
{
}
/**
* Settings required for module configuration
*
* The method should provide a description of common settings required
* for the notification module to function.
*
* For example, if the module connects to a remote messaging service this
* might be username and password or OAuth token fields required to
* authenticate to that service.
*
* This is used to build a form in the UI. The values submitted by the
* admin based on the form will be validated prior to save.
* @see testConnection()
*
* The return value should be an array structured like other WHMCS modules.
* @link https://developers.whmcs.com/payment-gateways/configuration/
*
* For the Email notification module, the module settings are the sender
* name and email. Every email notification will use these values.
* Other email values, like recipients are defined on a per notification
* basis.
* @see notifictionSettings()
*
* EX.
* return [
* 'api_username' => [
* 'FriendlyName' => 'API Username',
* 'Type' => 'text',
* 'Description' => 'Required username to authenticate with message service',
* ],
* 'api_password' => [
* 'FriendlyName' => 'API Password',
* 'Type' => 'password',
* 'Description' => 'Required password to authenticate with message service',
* ],
* ];
*
* @return array
*/
public function settings()
{
}
/**
* Validate settings for notification module
*
* This method will be invoked prior to saving any settings via the UI.
*
* Leverage this method to verify authentication and/or authorization when
* the notification service requires a remote connection.
*
* For the Email notification module, connectivity details are already
* defined by the WHMCS core system, and there are no settings which
* require further validation, so this method will always return TRUE.
*
* @param array $settings
*
* @return boolean
*/
public function testConnection($settings)
{
}
/**
* The individual customisable settings for a notification.
*
* EX.
* ['channel' => [
* 'FriendlyName' => 'Channel',
* 'Type' => 'dynamic',
* 'Description' => 'Select the desired channel for notification delivery.',
* 'Required' => true,
* ],
* ]
*
* The "Type" of a setting can be text, textarea, yesno, system and dynamic
*
* @see getDynamicField for how to obtain dynamic values
*
* For the Email notification module, the notification should be configured
* to use a email template and one or more recipients.
*
* @return array
*/
public function notificationSettings()
{
}
/**
* The option values available for a 'dynamic' Type notification setting
*
* @see notificationSettings()
*
* EX.
* if ($fieldName == 'channel') {
* return [ 'values' => [
* ['id' => 1, 'name' => 'Tech Support', 'description' => 'Channel ID',],
* ['id' => 2, 'name' => 'Customer Service', 'description' => 'Channel ID',],
* ],];
* } elseif ($fieldName == 'botname') {
* $restClient = $this->factoryHttpClient($settings);
* $operators = $restClient->get('/operators');
* return ['values' => $operators->toArray()];
* }
*
* For the Email notification module, a list of possible email templates is
* aggregated.
*
* @param string $fieldName Notification setting field name
* @param array $settings Settings for the module
*
* @return array
*/
public function getDynamicField($fieldName, $settings)
{
}
/**
* Deliver notification
*
* This method is invoked when rule criteria are met.
*
* In this method, you should craft an appropriately formatted message and
* transmit it to the messaging service.
*
* For the Email notification module, an email template instance is created
* along with a collection of merge field data (aggregated from all three
* method arguments respectively). Those items are provided to the local
* API 'sendmail' action, where an email message is generated and delivered.
*
* @param NotificationInterface $notification A notification to send
* @param array $moduleSettings Configured settings of the notification module
* @param array $notificationSettings Configured notification settings set by the triggered rule
*
* @throws Exception on error of sending email
*/
public function sendNotification(\WHMCS\Notification\Contracts\NotificationInterface $notification, $moduleSettings, $notificationSettings)
{
}
}
}
namespace WHMCS\Module\Notification\Hipchat {
class Hipchat implements \WHMCS\Module\Contracts\NotificationModuleInterface
{
use \WHMCS\Module\Notification\DescriptionTrait;
const HOSTED_API_URL = "https://api.hipchat.com/v2/";
public function __construct()
{
}
public function settings()
{
}
public function testConnection($settings)
{
}
public function notificationSettings()
{
}
public function getDynamicField($fieldName, $settings)
{
}
public function sendNotification(\WHMCS\Notification\Contracts\NotificationInterface $notification, $moduleSettings, $notificationSettings)
{
}
protected function call($settings, $uri, $postdata = NULL)
{
}
}
class CardAttribute
{
public $value = NULL;
public $label = NULL;
public $url = NULL;
public $style = NULL;
public $icon = NULL;
public $icon2 = NULL;
public function value($value)
{
}
public function label($label)
{
}
public function url($url)
{
}
public function style($style)
{
}
public function icon($icon, $icon2 = NULL)
{
}
public function toArray()
{
}
}
class Card
{
public $id = NULL;
public $title = "";
public $style = "application";
public $content = "";
public $format = "html";
public $cardFormat = NULL;
public $url = "";
public $activity = NULL;
public $activityIcon = NULL;
public $activityIcon2 = NULL;
public $icon = NULL;
public $icon2 = NULL;
public $attributes = array();
public function __construct()
{
}
public function title($title)
{
}
public function id($id)
{
}
public function style($style)
{
}
public function message($content = "")
{
}
public function cardFormat($cardFormat)
{
}
public function url($url)
{
}
public function activity($html, $icon = NULL, $icon2 = NULL)
{
}
public function icon($icon, $icon2 = NULL)
{
}
public function addAttribute(\WHMCS\Module\Notification\Hipchat\CardAttribute $attribute)
{
}
public function toArray()
{
}
}
class Message
{
public $format = "html";
public $notify = false;
public $level = "info";
public $color = "gray";
public $from = "";
public $content = "";
public $card = NULL;
public function from($from)
{
}
public function message($content = "")
{
}
public function notify($notify = true)
{
}
public function color($color)
{
}
public function card($card)
{
}
public function toArray()
{
}
}
}
namespace WHMCS\Module\Notification\Slack {
class Field
{
public $title = "";
public $value = "";
public $short = false;
public function title($title)
{
}
public function value($value)
{
}
public function short()
{
}
public function toArray()
{
}
}
class Attachment
{
public $fallback = "";
public $color = "";
public $pretext = "";
public $title = "";
public $title_link = "";
public $text = "";
public $fields = NULL;
public $footer = "";
public $footer_icon = "";
public function fallback($fallback)
{
}
public function color($color)
{
}
public function pretext($pretext)
{
}
public function title($title)
{
}
public function title_link($title_link)
{
}
public function text($text)
{
}
public function footer($footer)
{
}
public function footer_icon($footer_icon)
{
}
public function addField(\WHMCS\Module\Notification\Slack\Field $field)
{
}
public function toArray()
{
}
}
class Message
{
public $channel = "";
public $text = "";
public $asUser = true;
public $username = "";
public $attachment = NULL;
public function channel($channel)
{
}
public function text($text)
{
}
public function username($username)
{
}
public function attachment($attachment)
{
}
public function toArray()
{
}
}
class Slack implements \WHMCS\Module\Contracts\NotificationModuleInterface
{
use \WHMCS\Module\Notification\DescriptionTrait;
const API_URL = "https://slack.com/api/";
public function __construct()
{
}
public function settings()
{
}
public function testConnection($settings)
{
}
public function notificationSettings()
{
}
public function getDynamicField($fieldName, $settings)
{
}
public function sendNotification(\WHMCS\Notification\Contracts\NotificationInterface $notification, $moduleSettings, $notificationSettings)
{
}
protected function call(array $settings, $uri, array $postdata = array(), $throwOnError = true)
{
}
public function postRuleSave(array $moduleConfiguration, array $providerConfig)
{
}
}
}
namespace {
class twitterIntents
{
public function __construct($username = "", \WHMCS\Version\SemanticVersion $version)
{
}
protected function doDependencyCheck()
{
}
public function getTweets()
{
}
protected function tidyHTML($html)
{
}
protected function scrapePage()
{
}
protected function findClassNodes($xpath, $tag, $classname = "", $attributes = "")
{
}
protected function getCachedTweets()
{
}
protected function cacheTweets($tweets = array())
{
}
}
}
namespace WHMCS\Module\Addon\ProjectManagement {
class Router
{
protected $routes = array("watch" => "project@watch", "unwatch" => "project@unwatch", "saveProject" => "project@saveProject", "clientSearch" => "project@clientSearch", "duplicateProject" => "project@duplicateProject", "deletefile" => "files@delete", "uploadfile" => "files@upload", "addInvoice" => "invoices@associate", "createInvoice" => "invoices@create", "searchInvoices" => "invoices@search", "unlinkInvoice" => "invoices@unlink", "addmessage" => "messages@add", "deletemsg" => "messages@delete", "uploadFileForMessage" => "messages@uploadFile", "addtask" => "tasks@add", "assigntask" => "tasks@assign", "deletetask" => "tasks@delete", "deleteTaskTemplate" => "tasks@deleteTaskTemplate", "gettaskinfo" => "tasks@getSingle", "importTasks" => "tasks@import", "saveTaskList" => "tasks@saveList", "selectTaskList" => "tasks@select", "taskedit" => "tasks@edit", "taskduedate" => "tasks@setDueDate", "taskSearch" => "tasks@search", "tasksort" => "tasks@saveOrder", "taskstatustoggle" => "tasks@toggleStatus", "addticket" => "tickets@associate", "openticket" => "tickets@open", "parseMarkdown" => "tickets@parseMarkdown", "searchTickets" => "tickets@search", "unlinkTicket" => "tickets@unlink", "taskTimeAdd" => "timers@add", "deleteTimer" => "timers@delete", "endtimer" => "timers@end", "gettimerinfo" => "timers@getSingle", "invoiceItems" => "timers@invoiceItems", "prepareInvoiceTimers" => "timers@prepareInvoiceTimers", "starttimer" => "timers@start", "updateTimer" => "timers@update", "notify" => "notify@staff", "sendEmail" => "notify@sendEmail");
public function dispatch($action, $project = NULL)
{
}
}
abstract class BaseProjectEntity
{
public $project = NULL;
public function __construct(\WHMCS\Module\Addon\ProjectManagement\Project $project)
{
}
public function project()
{
}
}
class Timers extends \WHMCS\Module\Addon\ProjectManagement\BaseProjectEntity
{
public function get($timerId = NULL)
{
}
public function getSingle($timerId = NULL)
{
}
public function getOpenTimerId()
{
}
protected function endExistingTimers($taskId = 0)
{
}
public function start()
{
}
public function end()
{
}
public function getStats()
{
}
public function update()
{
}
public function invoiceItems()
{
}
public function add()
{
}
public function delete()
{
}
public function prepareInvoiceTimers()
{
}
public function getTaskTimes()
{
}
public function formatTimerSecondsToReadableTime($timer)
{
}
protected function secondsToHours($secs, $padHours = false)
{
}
}
class Tickets extends \WHMCS\Module\Addon\ProjectManagement\BaseProjectEntity
{
protected $statusColours = array();
protected function getTicketByMask($ticketMask)
{
}
public function get()
{
}
public function associate()
{
}
public function getDepartments()
{
}
public function parseMarkdown()
{
}
public function open()
{
}
public function search()
{
}
public function unlink()
{
}
protected function getStatusColour($status)
{
}
protected function getContrastYIQ($hexColour)
{
}
public function ticketLinks(array $ticketIds)
{
}
}
class Files extends \WHMCS\Module\Addon\ProjectManagement\BaseProjectEntity
{
public function get($messageId = 0)
{
}
public function upload()
{
}
public function delete(\WHMCS\Module\Addon\ProjectManagement\Models\ProjectFile $specificFile = NULL)
{
}
protected function formatFileSize($val, $digits = 3)
{
}
protected function isAnImage($mimeType)
{
}
protected function isBrowserViewable($mimeType)
{
}
public function formatFilenameForDisplay($filename)
{
}
protected function checkAndCreateDirectoryIndexes()
{
}
}
class Exception extends \WHMCS\Exception
{
}
class Widget extends \WHMCS\Module\AbstractWidget
{
protected $title = "Project Management";
protected $description = "Project Management Activity.";
protected $weight = 100;
protected $cache = true;
protected $cachePerUser = true;
protected $requiredPermission = "Addon Modules";
protected $columns = 2;
public function getId()
{
}
public function getData()
{
}
public function generateOutput($data)
{
}
}
class Invoices extends \WHMCS\Module\Addon\ProjectManagement\BaseProjectEntity
{
public function get()
{
}
public function search()
{
}
public function associate()
{
}
public function create()
{
}
public function unlink()
{
}
protected function getInvoiceById($invoiceId)
{
}
public function getSingleInvoiceById($invoiceId)
{
}
public function invoiceLinks(array $invoiceIds)
{
}
}
class Helper
{
public static function getCurrentAdminId()
{
}
public static function getAdmins()
{
}
public static function timeToHuman($sec)
{
}
public static function timeToReadable($sec)
{
}
public static function daysUntilDate($date)
{
}
public static function getFriendlyDaysToGo($date, $lang)
{
}
public static function getFriendlyMbValue($size)
{
}
public static function getClientLink($userId)
{
}
}
class Messages extends \WHMCS\Module\Addon\ProjectManagement\BaseProjectEntity
{
public function get($messageId = 0)
{
}
public function add()
{
}
public function delete()
{
}
public function uploadFile()
{
}
}
}
namespace WHMCS\Model\Contracts {
interface ModelInterface
{
}
}
namespace Illuminate\Contracts\Support {
interface Arrayable
{
/**
* Get the instance as an array.
*
* @return array
*/
public function toArray();
}
interface Jsonable
{
/**
* Convert the object to its JSON representation.
*
* @param int $options
* @return string
*/
public function toJson($options = 0);
}
}
namespace Illuminate\Contracts\Queue {
interface QueueableEntity
{
/**
* Get the queueable identity for the entity.
*
* @return mixed
*/
public function getQueueableId();
}
}
namespace Illuminate\Contracts\Routing {
interface UrlRoutable
{
/**
* Get the value of the model's route key.
*
* @return mixed
*/
public function getRouteKey();
/**
* Get the route key for the model.
*
* @return string
*/
public function getRouteKeyName();
}
}
namespace Illuminate\Database\Eloquent {
abstract class Model implements \ArrayAccess, \Illuminate\Contracts\Support\Arrayable, \Illuminate\Contracts\Support\Jsonable, \JsonSerializable, \Illuminate\Contracts\Queue\QueueableEntity, \Illuminate\Contracts\Routing\UrlRoutable
{
/**
* The connection name for the model.
*
* @var string
*/
protected $connection;
/**
* The table associated with the model.
*
* @var string
*/
protected $table;
/**
* The primary key for the model.
*
* @var string
*/
protected $primaryKey = 'id';
/**
* The number of models to return for pagination.
*
* @var int
*/
protected $perPage = 15;
/**
* Indicates if the IDs are auto-incrementing.
*
* @var bool
*/
public $incrementing = true;
/**
* Indicates if the model should be timestamped.
*
* @var bool
*/
public $timestamps = true;
/**
* The model's attributes.
*
* @var array
*/
protected $attributes = [];
/**
* The model attribute's original state.
*
* @var array
*/
protected $original = [];
/**
* The loaded relationships for the model.
*
* @var array
*/
protected $relations = [];
/**
* The attributes that should be hidden for arrays.
*
* @var array
*/
protected $hidden = [];
/**
* The attributes that should be visible in arrays.
*
* @var array
*/
protected $visible = [];
/**
* The accessors to append to the model's array form.
*
* @var array
*/
protected $appends = [];
/**
* The attributes that are mass assignable.
*
* @var array
*/
protected $fillable = [];
/**
* The attributes that aren't mass assignable.
*
* @var array
*/
protected $guarded = ['*'];
/**
* The attributes that should be mutated to dates.
*
* @var array
*/
protected $dates = [];
/**
* The storage format of the model's date columns.
*
* @var string
*/
protected $dateFormat;
/**
* The attributes that should be cast to native types.
*
* @var array
*/
protected $casts = [];
/**
* The relationships that should be touched on save.
*
* @var array
*/
protected $touches = [];
/**
* User exposed observable events.
*
* @var array
*/
protected $observables = [];
/**
* The relations to eager load on every query.
*
* @var array
*/
protected $with = [];
/**
* The class name to be used in polymorphic relations.
*
* @var string
*/
protected $morphClass;
/**
* Indicates if the model exists.
*
* @var bool
*/
public $exists = false;
/**
* Indicates if the model was inserted during the current request lifecycle.
*
* @var bool
*/
public $wasRecentlyCreated = false;
/**
* Indicates whether attributes are snake cased on arrays.
*
* @var bool
*/
public static $snakeAttributes = true;
/**
* The connection resolver instance.
*
* @var \Illuminate\Database\ConnectionResolverInterface
*/
protected static $resolver;
/**
* The event dispatcher instance.
*
* @var \Illuminate\Contracts\Events\Dispatcher
*/
protected static $dispatcher;
/**
* The array of booted models.
*
* @var array
*/
protected static $booted = [];
/**
* The array of global scopes on the model.
*
* @var array
*/
protected static $globalScopes = [];
/**
* Indicates if all mass assignment is enabled.
*
* @var bool
*/
protected static $unguarded = false;
/**
* The cache of the mutated attributes for each class.
*
* @var array
*/
protected static $mutatorCache = [];
/**
* The many to many relationship methods.
*
* @var array
*/
public static $manyMethods = ['belongsToMany', 'morphToMany', 'morphedByMany'];
/**
* The name of the "created at" column.
*
* @var string
*/
const CREATED_AT = 'created_at';
/**
* The name of the "updated at" column.
*
* @var string
*/
const UPDATED_AT = 'updated_at';
/**
* Create a new Eloquent model instance.
*
* @param array $attributes
* @return void
*/
public function __construct(array $attributes = [])
{
}
/**
* Check if the model needs to be booted and if so, do it.
*
* @return void
*/
protected function bootIfNotBooted()
{
}
/**
* The "booting" method of the model.
*
* @return void
*/
protected static function boot()
{
}
/**
* Boot all of the bootable traits on the model.
*
* @return void
*/
protected static function bootTraits()
{
}
/**
* Clear the list of booted models so they will be re-booted.
*
* @return void
*/
public static function clearBootedModels()
{
}
/**
* Register a new global scope on the model.
*
* @param \Illuminate\Database\Eloquent\Scope|\Closure|string $scope
* @param \Closure|null $implementation
* @return mixed
*
* @throws \InvalidArgumentException
*/
public static function addGlobalScope($scope, \Closure $implementation = null)
{
}
/**
* Determine if a model has a global scope.
*
* @param \Illuminate\Database\Eloquent\Scope|string $scope
* @return bool
*/
public static function hasGlobalScope($scope)
{
}
/**
* Get a global scope registered with the model.
*
* @param \Illuminate\Database\Eloquent\Scope|string $scope
* @return \Illuminate\Database\Eloquent\Scope|\Closure|null
*/
public static function getGlobalScope($scope)
{
}
/**
* Get the global scopes for this class instance.
*
* @return array
*/
public function getGlobalScopes()
{
}
/**
* Register an observer with the Model.
*
* @param object|string $class
* @param int $priority
* @return void
*/
public static function observe($class, $priority = 0)
{
}
/**
* Fill the model with an array of attributes.
*
* @param array $attributes
* @return $this
*
* @throws \Illuminate\Database\Eloquent\MassAssignmentException
*/
public function fill(array $attributes)
{
}
/**
* Fill the model with an array of attributes. Force mass assignment.
*
* @param array $attributes
* @return $this
*/
public function forceFill(array $attributes)
{
}
/**
* Get the fillable attributes of a given array.
*
* @param array $attributes
* @return array
*/
protected function fillableFromArray(array $attributes)
{
}
/**
* Create a new instance of the given model.
*
* @param array $attributes
* @param bool $exists
* @return static
*/
public function newInstance($attributes = [], $exists = false)
{
}
/**
* Create a new model instance that is existing.
*
* @param array $attributes
* @param string|null $connection
* @return static
*/
public function newFromBuilder($attributes = [], $connection = null)
{
}
/**
* Create a collection of models from plain arrays.
*
* @param array $items
* @param string|null $connection
* @return \Illuminate\Database\Eloquent\Collection
*/
public static function hydrate(array $items, $connection = null)
{
}
/**
* Create a collection of models from a raw query.
*
* @param string $query
* @param array $bindings
* @param string|null $connection
* @return \Illuminate\Database\Eloquent\Collection
*/
public static function hydrateRaw($query, $bindings = [], $connection = null)
{
}
/**
* Save a new model and return the instance.
*
* @param array $attributes
* @return static
*/
public static function create(array $attributes = [])
{
}
/**
* Save a new model and return the instance. Allow mass-assignment.
*
* @param array $attributes
* @return static
*/
public static function forceCreate(array $attributes)
{
}
/**
* Begin querying the model.
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public static function query()
{
}
/**
* Begin querying the model on a given connection.
*
* @param string|null $connection
* @return \Illuminate\Database\Eloquent\Builder
*/
public static function on($connection = null)
{
}
/**
* Begin querying the model on the write connection.
*
* @return \Illuminate\Database\Query\Builder
*/
public static function onWriteConnection()
{
}
/**
* Get all of the models from the database.
*
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Collection|static[]
*/
public static function all($columns = ['*'])
{
}
/**
* Reload a fresh model instance from the database.
*
* @param array|string $with
* @return $this|null
*/
public function fresh($with = [])
{
}
/**
* Eager load relations on the model.
*
* @param array|string $relations
* @return $this
*/
public function load($relations)
{
}
/**
* Begin querying a model with eager loading.
*
* @param array|string $relations
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public static function with($relations)
{
}
/**
* Append attributes to query when building a query.
*
* @param array|string $attributes
* @return $this
*/
public function append($attributes)
{
}
/**
* Define a one-to-one relationship.
*
* @param string $related
* @param string $foreignKey
* @param string $localKey
* @return \Illuminate\Database\Eloquent\Relations\HasOne
*/
public function hasOne($related, $foreignKey = null, $localKey = null)
{
}
/**
* Define a polymorphic one-to-one relationship.
*
* @param string $related
* @param string $name
* @param string $type
* @param string $id
* @param string $localKey
* @return \Illuminate\Database\Eloquent\Relations\MorphOne
*/
public function morphOne($related, $name, $type = null, $id = null, $localKey = null)
{
}
/**
* Define an inverse one-to-one or many relationship.
*
* @param string $related
* @param string $foreignKey
* @param string $otherKey
* @param string $relation
* @return \Illuminate\Database\Eloquent\Relations\BelongsTo
*/
public function belongsTo($related, $foreignKey = null, $otherKey = null, $relation = null)
{
}
/**
* Define a polymorphic, inverse one-to-one or many relationship.
*
* @param string $name
* @param string $type
* @param string $id
* @return \Illuminate\Database\Eloquent\Relations\MorphTo
*/
public function morphTo($name = null, $type = null, $id = null)
{
}
/**
* Retrieve the fully qualified class name from a slug.
*
* @param string $class
* @return string
*/
public function getActualClassNameForMorph($class)
{
}
/**
* Define a one-to-many relationship.
*
* @param string $related
* @param string $foreignKey
* @param string $localKey
* @return \Illuminate\Database\Eloquent\Relations\HasMany
*/
public function hasMany($related, $foreignKey = null, $localKey = null)
{
}
/**
* Define a has-many-through relationship.
*
* @param string $related
* @param string $through
* @param string|null $firstKey
* @param string|null $secondKey
* @param string|null $localKey
* @return \Illuminate\Database\Eloquent\Relations\HasManyThrough
*/
public function hasManyThrough($related, $through, $firstKey = null, $secondKey = null, $localKey = null)
{
}
/**
* Define a polymorphic one-to-many relationship.
*
* @param string $related
* @param string $name
* @param string $type
* @param string $id
* @param string $localKey
* @return \Illuminate\Database\Eloquent\Relations\MorphMany
*/
public function morphMany($related, $name, $type = null, $id = null, $localKey = null)
{
}
/**
* Define a many-to-many relationship.
*
* @param string $related
* @param string $table
* @param string $foreignKey
* @param string $otherKey
* @param string $relation
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function belongsToMany($related, $table = null, $foreignKey = null, $otherKey = null, $relation = null)
{
}
/**
* Define a polymorphic many-to-many relationship.
*
* @param string $related
* @param string $name
* @param string $table
* @param string $foreignKey
* @param string $otherKey
* @param bool $inverse
* @return \Illuminate\Database\Eloquent\Relations\MorphToMany
*/
public function morphToMany($related, $name, $table = null, $foreignKey = null, $otherKey = null, $inverse = false)
{
}
/**
* Define a polymorphic, inverse many-to-many relationship.
*
* @param string $related
* @param string $name
* @param string $table
* @param string $foreignKey
* @param string $otherKey
* @return \Illuminate\Database\Eloquent\Relations\MorphToMany
*/
public function morphedByMany($related, $name, $table = null, $foreignKey = null, $otherKey = null)
{
}
/**
* Get the relationship name of the belongs to many.
*
* @return string
*/
protected function getBelongsToManyCaller()
{
}
/**
* Get the joining table name for a many-to-many relation.
*
* @param string $related
* @return string
*/
public function joiningTable($related)
{
}
/**
* Destroy the models for the given IDs.
*
* @param array|int $ids
* @return int
*/
public static function destroy($ids)
{
}
/**
* Delete the model from the database.
*
* @return bool|null
*
* @throws \Exception
*/
public function delete()
{
}
/**
* Force a hard delete on a soft deleted model.
*
* This method protects developers from running forceDelete when trait is missing.
*
* @return bool|null
*/
public function forceDelete()
{
}
/**
* Perform the actual delete query on this model instance.
*
* @return void
*/
protected function performDeleteOnModel()
{
}
/**
* Register a saving model event with the dispatcher.
*
* @param \Closure|string $callback
* @param int $priority
* @return void
*/
public static function saving($callback, $priority = 0)
{
}
/**
* Register a saved model event with the dispatcher.
*
* @param \Closure|string $callback
* @param int $priority
* @return void
*/
public static function saved($callback, $priority = 0)
{
}
/**
* Register an updating model event with the dispatcher.
*
* @param \Closure|string $callback
* @param int $priority
* @return void
*/
public static function updating($callback, $priority = 0)
{
}
/**
* Register an updated model event with the dispatcher.
*
* @param \Closure|string $callback
* @param int $priority
* @return void
*/
public static function updated($callback, $priority = 0)
{
}
/**
* Register a creating model event with the dispatcher.
*
* @param \Closure|string $callback
* @param int $priority
* @return void
*/
public static function creating($callback, $priority = 0)
{
}
/**
* Register a created model event with the dispatcher.
*
* @param \Closure|string $callback
* @param int $priority
* @return void
*/
public static function created($callback, $priority = 0)
{
}
/**
* Register a deleting model event with the dispatcher.
*
* @param \Closure|string $callback
* @param int $priority
* @return void
*/
public static function deleting($callback, $priority = 0)
{
}
/**
* Register a deleted model event with the dispatcher.
*
* @param \Closure|string $callback
* @param int $priority
* @return void
*/
public static function deleted($callback, $priority = 0)
{
}
/**
* Remove all of the event listeners for the model.
*
* @return void
*/
public static function flushEventListeners()
{
}
/**
* Register a model event with the dispatcher.
*
* @param string $event
* @param \Closure|string $callback
* @param int $priority
* @return void
*/
protected static function registerModelEvent($event, $callback, $priority = 0)
{
}
/**
* Get the observable event names.
*
* @return array
*/
public function getObservableEvents()
{
}
/**
* Set the observable event names.
*
* @param array $observables
* @return $this
*/
public function setObservableEvents(array $observables)
{
}
/**
* Add an observable event name.
*
* @param array|mixed $observables
* @return void
*/
public function addObservableEvents($observables)
{
}
/**
* Remove an observable event name.
*
* @param array|mixed $observables
* @return void
*/
public function removeObservableEvents($observables)
{
}
/**
* Increment a column's value by a given amount.
*
* @param string $column
* @param int $amount
* @param array $extra
* @return int
*/
protected function increment($column, $amount = 1, array $extra = [])
{
}
/**
* Decrement a column's value by a given amount.
*
* @param string $column
* @param int $amount
* @param array $extra
* @return int
*/
protected function decrement($column, $amount = 1, array $extra = [])
{
}
/**
* Run the increment or decrement method on the model.
*
* @param string $column
* @param int $amount
* @param array $extra
* @param string $method
* @return int
*/
protected function incrementOrDecrement($column, $amount, $extra, $method)
{
}
/**
* Increment the underlying attribute value and sync with original.
*
* @param string $column
* @param int $amount
* @param string $method
* @return void
*/
protected function incrementOrDecrementAttributeValue($column, $amount, $method)
{
}
/**
* Update the model in the database.
*
* @param array $attributes
* @param array $options
* @return bool|int
*/
public function update(array $attributes = [], array $options = [])
{
}
/**
* Save the model and all of its relationships.
*
* @return bool
*/
public function push()
{
}
/**
* Save the model to the database.
*
* @param array $options
* @return bool
*/
public function save(array $options = [])
{
}
/**
* Save the model to the database using transaction.
*
* @param array $options
* @return bool
*
* @throws \Throwable
*/
public function saveOrFail(array $options = [])
{
}
/**
* Finish processing on a successful save operation.
*
* @param array $options
* @return void
*/
protected function finishSave(array $options)
{
}
/**
* Perform a model update operation.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param array $options
* @return bool
*/
protected function performUpdate(\Illuminate\Database\Eloquent\Builder $query, array $options = [])
{
}
/**
* Perform a model insert operation.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param array $options
* @return bool
*/
protected function performInsert(\Illuminate\Database\Eloquent\Builder $query, array $options = [])
{
}
/**
* Insert the given attributes and set the ID on the model.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param array $attributes
* @return void
*/
protected function insertAndSetId(\Illuminate\Database\Eloquent\Builder $query, $attributes)
{
}
/**
* Touch the owning relations of the model.
*
* @return void
*/
public function touchOwners()
{
}
/**
* Determine if the model touches a given relation.
*
* @param string $relation
* @return bool
*/
public function touches($relation)
{
}
/**
* Fire the given event for the model.
*
* @param string $event
* @param bool $halt
* @return mixed
*/
protected function fireModelEvent($event, $halt = true)
{
}
/**
* Set the keys for a save update query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @return \Illuminate\Database\Eloquent\Builder
*/
protected function setKeysForSaveQuery(\Illuminate\Database\Eloquent\Builder $query)
{
}
/**
* Get the primary key value for a save query.
*
* @return mixed
*/
protected function getKeyForSaveQuery()
{
}
/**
* Update the model's update timestamp.
*
* @return bool
*/
public function touch()
{
}
/**
* Update the creation and update timestamps.
*
* @return void
*/
protected function updateTimestamps()
{
}
/**
* Set the value of the "created at" attribute.
*
* @param mixed $value
* @return $this
*/
public function setCreatedAt($value)
{
}
/**
* Set the value of the "updated at" attribute.
*
* @param mixed $value
* @return $this
*/
public function setUpdatedAt($value)
{
}
/**
* Get the name of the "created at" column.
*
* @return string
*/
public function getCreatedAtColumn()
{
}
/**
* Get the name of the "updated at" column.
*
* @return string
*/
public function getUpdatedAtColumn()
{
}
/**
* Get a fresh timestamp for the model.
*
* @return \Carbon\Carbon
*/
public function freshTimestamp()
{
}
/**
* Get a fresh timestamp for the model.
*
* @return string
*/
public function freshTimestampString()
{
}
/**
* Get a new query builder for the model's table.
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function newQuery()
{
}
/**
* Get a new query instance without a given scope.
*
* @param \Illuminate\Database\Eloquent\Scope|string $scope
* @return \Illuminate\Database\Eloquent\Builder
*/
public function newQueryWithoutScope($scope)
{
}
/**
* Get a new query builder that doesn't have any global scopes.
*
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function newQueryWithoutScopes()
{
}
/**
* Create a new Eloquent query builder for the model.
*
* @param \Illuminate\Database\Query\Builder $query
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function newEloquentBuilder($query)
{
}
/**
* Get a new query builder instance for the connection.
*
* @return \Illuminate\Database\Query\Builder
*/
protected function newBaseQueryBuilder()
{
}
/**
* Create a new Eloquent Collection instance.
*
* @param array $models
* @return \Illuminate\Database\Eloquent\Collection
*/
public function newCollection(array $models = [])
{
}
/**
* Create a new pivot model instance.
*
* @param \Illuminate\Database\Eloquent\Model $parent
* @param array $attributes
* @param string $table
* @param bool $exists
* @return \Illuminate\Database\Eloquent\Relations\Pivot
*/
public function newPivot(\Illuminate\Database\Eloquent\Model $parent, array $attributes, $table, $exists)
{
}
/**
* Get the table associated with the model.
*
* @return string
*/
public function getTable()
{
}
/**
* Set the table associated with the model.
*
* @param string $table
* @return $this
*/
public function setTable($table)
{
}
/**
* Get the value of the model's primary key.
*
* @return mixed
*/
public function getKey()
{
}
/**
* Get the queueable identity for the entity.
*
* @return mixed
*/
public function getQueueableId()
{
}
/**
* Get the primary key for the model.
*
* @return string
*/
public function getKeyName()
{
}
/**
* Set the primary key for the model.
*
* @param string $key
* @return $this
*/
public function setKeyName($key)
{
}
/**
* Get the table qualified key name.
*
* @return string
*/
public function getQualifiedKeyName()
{
}
/**
* Get the value of the model's route key.
*
* @return mixed
*/
public function getRouteKey()
{
}
/**
* Get the route key for the model.
*
* @return string
*/
public function getRouteKeyName()
{
}
/**
* Determine if the model uses timestamps.
*
* @return bool
*/
public function usesTimestamps()
{
}
/**
* Get the polymorphic relationship columns.
*
* @param string $name
* @param string $type
* @param string $id
* @return array
*/
protected function getMorphs($name, $type, $id)
{
}
/**
* Get the class name for polymorphic relations.
*
* @return string
*/
public function getMorphClass()
{
}
/**
* Get the number of models to return per page.
*
* @return int
*/
public function getPerPage()
{
}
/**
* Set the number of models to return per page.
*
* @param int $perPage
* @return $this
*/
public function setPerPage($perPage)
{
}
/**
* Get the default foreign key name for the model.
*
* @return string
*/
public function getForeignKey()
{
}
/**
* Get the hidden attributes for the model.
*
* @return array
*/
public function getHidden()
{
}
/**
* Set the hidden attributes for the model.
*
* @param array $hidden
* @return $this
*/
public function setHidden(array $hidden)
{
}
/**
* Add hidden attributes for the model.
*
* @param array|string|null $attributes
* @return void
*/
public function addHidden($attributes = null)
{
}
/**
* Make the given, typically hidden, attributes visible.
*
* @param array|string $attributes
* @return $this
*/
public function makeVisible($attributes)
{
}
/**
* Make the given, typically hidden, attributes visible.
*
* @param array|string $attributes
* @return $this
*
* @deprecated since version 5.2. Use the "makeVisible" method directly.
*/
public function withHidden($attributes)
{
}
/**
* Get the visible attributes for the model.
*
* @return array
*/
public function getVisible()
{
}
/**
* Set the visible attributes for the model.
*
* @param array $visible
* @return $this
*/
public function setVisible(array $visible)
{
}
/**
* Add visible attributes for the model.
*
* @param array|string|null $attributes
* @return void
*/
public function addVisible($attributes = null)
{
}
/**
* Set the accessors to append to model arrays.
*
* @param array $appends
* @return $this
*/
public function setAppends(array $appends)
{
}
/**
* Get the fillable attributes for the model.
*
* @return array
*/
public function getFillable()
{
}
/**
* Set the fillable attributes for the model.
*
* @param array $fillable
* @return $this
*/
public function fillable(array $fillable)
{
}
/**
* Get the guarded attributes for the model.
*
* @return array
*/
public function getGuarded()
{
}
/**
* Set the guarded attributes for the model.
*
* @param array $guarded
* @return $this
*/
public function guard(array $guarded)
{
}
/**
* Disable all mass assignable restrictions.
*
* @param bool $state
* @return void
*/
public static function unguard($state = true)
{
}
/**
* Enable the mass assignment restrictions.
*
* @return void
*/
public static function reguard()
{
}
/**
* Determine if current state is "unguarded".
*
* @return bool
*/
public static function isUnguarded()
{
}
/**
* Run the given callable while being unguarded.
*
* @param callable $callback
* @return mixed
*/
public static function unguarded(callable $callback)
{
}
/**
* Determine if the given attribute may be mass assigned.
*
* @param string $key
* @return bool
*/
public function isFillable($key)
{
}
/**
* Determine if the given key is guarded.
*
* @param string $key
* @return bool
*/
public function isGuarded($key)
{
}
/**
* Determine if the model is totally guarded.
*
* @return bool
*/
public function totallyGuarded()
{
}
/**
* Remove the table name from a given key.
*
* @param string $key
* @return string
*/
protected function removeTableFromKey($key)
{
}
/**
* Get the relationships that are touched on save.
*
* @return array
*/
public function getTouchedRelations()
{
}
/**
* Set the relationships that are touched on save.
*
* @param array $touches
* @return $this
*/
public function setTouchedRelations(array $touches)
{
}
/**
* Get the value indicating whether the IDs are incrementing.
*
* @return bool
*/
public function getIncrementing()
{
}
/**
* Set whether IDs are incrementing.
*
* @param bool $value
* @return $this
*/
public function setIncrementing($value)
{
}
/**
* Convert the model instance to JSON.
*
* @param int $options
* @return string
*/
public function toJson($options = 0)
{
}
/**
* Convert the object into something JSON serializable.
*
* @return array
*/
public function jsonSerialize()
{
}
/**
* Convert the model instance to an array.
*
* @return array
*/
public function toArray()
{
}
/**
* Convert the model's attributes to an array.
*
* @return array
*/
public function attributesToArray()
{
}
/**
* Get an attribute array of all arrayable attributes.
*
* @return array
*/
protected function getArrayableAttributes()
{
}
/**
* Get all of the appendable values that are arrayable.
*
* @return array
*/
protected function getArrayableAppends()
{
}
/**
* Get the model's relationships in array form.
*
* @return array
*/
public function relationsToArray()
{
}
/**
* Get an attribute array of all arrayable relations.
*
* @return array
*/
protected function getArrayableRelations()
{
}
/**
* Get an attribute array of all arrayable values.
*
* @param array $values
* @return array
*/
protected function getArrayableItems(array $values)
{
}
/**
* Get an attribute from the model.
*
* @param string $key
* @return mixed
*/
public function getAttribute($key)
{
}
/**
* Get a plain attribute (not a relationship).
*
* @param string $key
* @return mixed
*/
public function getAttributeValue($key)
{
}
/**
* Get a relationship.
*
* @param string $key
* @return mixed
*/
public function getRelationValue($key)
{
}
/**
* Get an attribute from the $attributes array.
*
* @param string $key
* @return mixed
*/
protected function getAttributeFromArray($key)
{
}
/**
* Get a relationship value from a method.
*
* @param string $method
* @return mixed
*
* @throws \LogicException
*/
protected function getRelationshipFromMethod($method)
{
}
/**
* Determine if a get mutator exists for an attribute.
*
* @param string $key
* @return bool
*/
public function hasGetMutator($key)
{
}
/**
* Get the value of an attribute using its mutator.
*
* @param string $key
* @param mixed $value
* @return mixed
*/
protected function mutateAttribute($key, $value)
{
}
/**
* Get the value of an attribute using its mutator for array conversion.
*
* @param string $key
* @param mixed $value
* @return mixed
*/
protected function mutateAttributeForArray($key, $value)
{
}
/**
* Determine whether an attribute should be cast to a native type.
*
* @param string $key
* @param array|string|null $types
* @return bool
*/
public function hasCast($key, $types = null)
{
}
/**
* Get the casts array.
*
* @return array
*/
public function getCasts()
{
}
/**
* Determine whether a value is Date / DateTime castable for inbound manipulation.
*
* @param string $key
* @return bool
*/
protected function isDateCastable($key)
{
}
/**
* Determine whether a value is JSON castable for inbound manipulation.
*
* @param string $key
* @return bool
*/
protected function isJsonCastable($key)
{
}
/**
* Get the type of cast for a model attribute.
*
* @param string $key
* @return string
*/
protected function getCastType($key)
{
}
/**
* Cast an attribute to a native PHP type.
*
* @param string $key
* @param mixed $value
* @return mixed
*/
protected function castAttribute($key, $value)
{
}
/**
* Set a given attribute on the model.
*
* @param string $key
* @param mixed $value
* @return $this
*/
public function setAttribute($key, $value)
{
}
/**
* Determine if a set mutator exists for an attribute.
*
* @param string $key
* @return bool
*/
public function hasSetMutator($key)
{
}
/**
* Get the attributes that should be converted to dates.
*
* @return array
*/
public function getDates()
{
}
/**
* Convert a DateTime to a storable string.
*
* @param \DateTime|int $value
* @return string
*/
public function fromDateTime($value)
{
}
/**
* Return a timestamp as DateTime object.
*
* @param mixed $value
* @return \Carbon\Carbon
*/
protected function asDateTime($value)
{
}
/**
* Return a timestamp as unix timestamp.
*
* @param mixed $value
* @return int
*/
protected function asTimeStamp($value)
{
}
/**
* Prepare a date for array / JSON serialization.
*
* @param \DateTime $date
* @return string
*/
protected function serializeDate(\DateTime $date)
{
}
/**
* Get the format for database stored dates.
*
* @return string
*/
protected function getDateFormat()
{
}
/**
* Set the date format used by the model.
*
* @param string $format
* @return $this
*/
public function setDateFormat($format)
{
}
/**
* Encode the given value as JSON.
*
* @param mixed $value
* @return string
*/
protected function asJson($value)
{
}
/**
* Decode the given JSON back into an array or object.
*
* @param string $value
* @param bool $asObject
* @return mixed
*/
public function fromJson($value, $asObject = false)
{
}
/**
* Clone the model into a new, non-existing instance.
*
* @param array|null $except
* @return \Illuminate\Database\Eloquent\Model
*/
public function replicate(array $except = null)
{
}
/**
* Get all of the current attributes on the model.
*
* @return array
*/
public function getAttributes()
{
}
/**
* Set the array of model attributes. No checking is done.
*
* @param array $attributes
* @param bool $sync
* @return $this
*/
public function setRawAttributes(array $attributes, $sync = false)
{
}
/**
* Get the model's original attribute values.
*
* @param string|null $key
* @param mixed $default
* @return mixed|array
*/
public function getOriginal($key = null, $default = null)
{
}
/**
* Sync the original attributes with the current.
*
* @return $this
*/
public function syncOriginal()
{
}
/**
* Sync a single original attribute with its current value.
*
* @param string $attribute
* @return $this
*/
public function syncOriginalAttribute($attribute)
{
}
/**
* Determine if the model or given attribute(s) have been modified.
*
* @param array|string|null $attributes
* @return bool
*/
public function isDirty($attributes = null)
{
}
/**
* Get the attributes that have been changed since last sync.
*
* @return array
*/
public function getDirty()
{
}
/**
* Determine if the new and old values for a given key are numerically equivalent.
*
* @param string $key
* @return bool
*/
protected function originalIsNumericallyEquivalent($key)
{
}
/**
* Get all the loaded relations for the instance.
*
* @return array
*/
public function getRelations()
{
}
/**
* Get a specified relationship.
*
* @param string $relation
* @return mixed
*/
public function getRelation($relation)
{
}
/**
* Determine if the given relation is loaded.
*
* @param string $key
* @return bool
*/
public function relationLoaded($key)
{
}
/**
* Set the specific relationship in the model.
*
* @param string $relation
* @param mixed $value
* @return $this
*/
public function setRelation($relation, $value)
{
}
/**
* Set the entire relations array on the model.
*
* @param array $relations
* @return $this
*/
public function setRelations(array $relations)
{
}
/**
* Get the database connection for the model.
*
* @return \Illuminate\Database\Connection
*/
public function getConnection()
{
}
/**
* Get the current connection name for the model.
*
* @return string
*/
public function getConnectionName()
{
}
/**
* Set the connection associated with the model.
*
* @param string $name
* @return $this
*/
public function setConnection($name)
{
}
/**
* Resolve a connection instance.
*
* @param string|null $connection
* @return \Illuminate\Database\Connection
*/
public static function resolveConnection($connection = null)
{
}
/**
* Get the connection resolver instance.
*
* @return \Illuminate\Database\ConnectionResolverInterface
*/
public static function getConnectionResolver()
{
}
/**
* Set the connection resolver instance.
*
* @param \Illuminate\Database\ConnectionResolverInterface $resolver
* @return void
*/
public static function setConnectionResolver(\Illuminate\Database\ConnectionResolverInterface $resolver)
{
}
/**
* Unset the connection resolver for models.
*
* @return void
*/
public static function unsetConnectionResolver()
{
}
/**
* Get the event dispatcher instance.
*
* @return \Illuminate\Contracts\Events\Dispatcher
*/
public static function getEventDispatcher()
{
}
/**
* Set the event dispatcher instance.
*
* @param \Illuminate\Contracts\Events\Dispatcher $dispatcher
* @return void
*/
public static function setEventDispatcher(\Illuminate\Contracts\Events\Dispatcher $dispatcher)
{
}
/**
* Unset the event dispatcher for models.
*
* @return void
*/
public static function unsetEventDispatcher()
{
}
/**
* Get the mutated attributes for a given instance.
*
* @return array
*/
public function getMutatedAttributes()
{
}
/**
* Extract and cache all the mutated attributes of a class.
*
* @param string $class
* @return void
*/
public static function cacheMutatedAttributes($class)
{
}
/**
* Dynamically retrieve attributes on the model.
*
* @param string $key
* @return mixed
*/
public function __get($key)
{
}
/**
* Dynamically set attributes on the model.
*
* @param string $key
* @param mixed $value
* @return void
*/
public function __set($key, $value)
{
}
/**
* Determine if the given attribute exists.
*
* @param mixed $offset
* @return bool
*/
public function offsetExists($offset)
{
}
/**
* Get the value for a given offset.
*
* @param mixed $offset
* @return mixed
*/
public function offsetGet($offset)
{
}
/**
* Set the value for a given offset.
*
* @param mixed $offset
* @param mixed $value
* @return void
*/
public function offsetSet($offset, $value)
{
}
/**
* Unset the value for a given offset.
*
* @param mixed $offset
* @return void
*/
public function offsetUnset($offset)
{
}
/**
* Determine if an attribute or relation exists on the model.
*
* @param string $key
* @return bool
*/
public function __isset($key)
{
}
/**
* Unset an attribute on the model.
*
* @param string $key
* @return void
*/
public function __unset($key)
{
}
/**
* Handle dynamic method calls into the model.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public function __call($method, $parameters)
{
}
/**
* Handle dynamic static method calls into the method.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public static function __callStatic($method, $parameters)
{
}
/**
* Convert the model to its string representation.
*
* @return string
*/
public function __toString()
{
}
/**
* When a model is being unserialized, check if it needs to be booted.
*
* @return void
*/
public function __wakeup()
{
}
}
}
namespace WHMCS\Model {
class AbstractModel extends \Illuminate\Database\Eloquent\Model implements \WHMCS\Model\Contracts\ModelInterface
{
public $unique = array();
public $guardedForUpdate = array();
protected $columnMap = array();
protected $booleans = array();
protected $strings = array();
protected $ints = array();
protected $semanticVersions = array();
protected $commaSeparated = array();
protected $characterSeparated = array();
protected static $tableColumnCache = array();
protected $rules = array();
protected $errors = NULL;
protected $customValidationMessages = array();
public static function boot()
{
}
public function clearColumnCache()
{
}
protected function hasColumn($column)
{
}
public function getAttribute($key)
{
}
public function isAttributeSet($key)
{
}
public function setAttribute($key, $value)
{
}
public function getRawAttribute($key = NULL, $default = NULL)
{
}
public function fromBoolean($value)
{
}
public function fromString($value)
{
}
public function fromInt($value)
{
}
public function asBoolean($value)
{
}
public function asArrayFromCharacterSeparatedValue($data = "", $character = ",")
{
}
public function fromArrayToCharacterSeparatedValue(array $list = array(), $character = ",")
{
}
public function fromSemanticVersion(\WHMCS\Version\SemanticVersion $version)
{
}
public function asSemanticVersion($version)
{
}
public static function convertBoolean($value)
{
}
public static function convertBooleanColumn($column)
{
}
public static function convertUnixTimestampIntegerToTimestampColumn($column)
{
}
protected function isBooleanColumn($column)
{
}
protected function isSemanticVersionColumn($column)
{
}
protected function isCommaSeparatedColumn($column)
{
}
protected function decryptValue($cipherText, $key)
{
}
protected function encryptValue($text, $key)
{
}
protected function aesEncryptValue($text, $key)
{
}
protected function aesDecryptValue($text, $key)
{
}
protected function serializeDate(\DateTime $date)
{
}
protected function decrypt($value)
{
}
protected function encrypt($value)
{
}
protected function asDateTime($value)
{
}
public function fromDateTime($value)
{
}
public function toArrayUsingColumnMapNames()
{
}
public function validate()
{
}
public function setCustomValidationMessages(array $messages)
{
}
public function errors()
{
}
public function getCustomFieldValuesAttribute()
{
}
protected function getCustomFieldType()
{
}
protected function getCustomFieldRelId()
{
}
}
}
namespace WHMCS\Billing {
class Invoice extends \WHMCS\Model\AbstractModel
{
protected $table = "tblinvoices";
protected $dates = array("date", "dateCreated", "duedate", "dateDue", "datepaid", "datePaid", "lastCaptureAttempt", "dateRefunded", "dateCancelled");
protected $columnMap = array("clientId" => "userid", "invoiceNumber" => "invoicenum", "dateCreated" => "date", "dateDue" => "duedate", "datePaid" => "datepaid", "tax1" => "tax", "taxRate1" => "taxrate", "paymentGateway" => "paymentmethod", "adminNotes" => "notes", "lineItems" => "items", "dateRefunded" => "date_refunded", "dateCancelled" => "date_cancelled");
protected $appends = array("balance", "paymentGatewayName", "amountPaid");
const STATUS_CANCELLED = "Cancelled";
const STATUS_COLLECTIONS = "Collections";
const STATUS_DRAFT = "Draft";
const STATUS_PAID = "Paid";
const STATUS_PAYMENT_PENDING = "Payment Pending";
const STATUS_REFUNDED = "Refunded";
const STATUS_UNPAID = "Unpaid";
public static function boot()
{
}
public function getViewInvoiceUrl($additionalQueryStringParams = NULL)
{
}
public function getInvoiceNumber()
{
}
public function getCurrency()
{
}
public function getCurrencyCodeAttribute()
{
}
public function client()
{
}
public function transactions()
{
}
public function items()
{
}
public function snapshot()
{
}
public function order()
{
}
public function scopeUnpaid(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeOverdue(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopePaid(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeCancelled(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeRefunded(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeCollections(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopePaymentPending(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeUnpaidOrPaymentPending(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeMassPay(\Illuminate\Database\Eloquent\Builder $query, $isMassPay = true)
{
}
public function scopeWithLastCaptureAttempt(\Illuminate\Database\Eloquent\Builder $query, \WHMCS\Carbon $date)
{
}
public function getBalanceAttribute()
{
}
public function getPaymentGatewayNameAttribute()
{
}
public function getAmountPaidAttribute()
{
}
public function addPayment($amount, $transactionId = "", $fees = 0, $gateway = "", $noEmail = false, \WHMCS\Carbon $date = NULL)
{
}
public function addPaymentIfNotExists($amount, $transactionId = "", $fees = 0, $gateway = "", $noEmail = false, \WHMCS\Carbon $date = NULL)
{
}
public function getBillingValues()
{
}
public function shouldRenewRun($relatedId, $registrationDate, $type = "Hosting")
{
}
public function vat()
{
}
public static function newInvoice($clientId, $gateway = NULL, $taxRate1 = NULL, $taxRate2 = NULL)
{
}
public function setStatusUnpaid()
{
}
public function setStatusPending()
{
}
public function setStatusRefunded()
{
}
public function data()
{
}
public function transactionHistory()
{
}
public function payMethod()
{
}
public function getPayMethodRemoteToken()
{
}
public function setPayMethodRemoteToken($remoteToken)
{
}
public function deletePayMethod()
{
}
public function convertLocalCardToRemote($remoteToken)
{
}
public function convertLocalBankAccountToRemote($remoteToken)
{
}
public function saveRemoteCard($cardLastFour, $cardType, $expiryDate, $remoteToken)
{
}
public function saveRemoteBankAccount($bankName, $remoteToken)
{
}
public function cart()
{
}
public function runCreationHooks($source)
{
}
public function getSubscriptionIds($paymentMethods = NULL)
{
}
public function saveSubscriptionId($subscriptionId)
{
}
public function scopeSubscriptionId(\Illuminate\Database\Eloquent\Builder $query, $subscriptionId)
{
}
public function getLink()
{
}
public function setPaymentMethod($gatewayName)
{
}
public function setPayMethodId($payMethodId)
{
}
public function clearPayMethodId()
{
}
}
}
namespace WHMCS\Module\Addon\ProjectManagement\Models {
class WHMCSInvoice extends \WHMCS\Billing\Invoice
{
protected $appends = array("balance");
}
class ProjectFile extends \WHMCS\Model\AbstractModel
{
protected $table = "mod_project_management_files";
public function createTable($drop = false)
{
}
public function dropTable()
{
}
}
}
namespace WHMCS\Module\Addon\ProjectManagement\Models\Task {
class Template extends \WHMCS\Model\AbstractModel
{
protected $table = "mod_projecttasktpls";
public $timestamps = false;
protected $fillable = array("name", "tasks");
protected $casts = array("tasks" => "array");
public function createTable($drop = false)
{
}
public function dropTable()
{
}
}
}
namespace WHMCS\Module\Addon\ProjectManagement {
class Notify extends \WHMCS\Module\Addon\ProjectManagement\BaseProjectEntity
{
protected function getProjectRelatedAdmins()
{
}
public function staff(array $projectChanges, $isNewProject = false)
{
}
public function sendEmail()
{
}
}
class Project
{
public $id = NULL;
public $client = NULL;
protected $commaSeparatedValues = array("ticketids", "invoiceids", "watchers");
protected $dateValues = array("created", "duedate", "lastmodified");
protected $language = array();
public function __construct($projectId, array $language = array())
{
}
public static function create($vars)
{
}
public function save()
{
}
public function files()
{
}
public function messages()
{
}
public function tasks()
{
}
public function tickets()
{
}
public function timers()
{
}
public function log()
{
}
public function invoices()
{
}
public function watch()
{
}
public function unwatch()
{
}
public function isWatcher()
{
}
public function notify()
{
}
public function saveProject()
{
}
public function permissions()
{
}
public function duplicateProject()
{
}
public function getLanguage()
{
}
}
class Permission
{
protected $permissions = array("Create New Projects", "View All Projects", "13" => "View Only Assigned Projects", "2" => "Edit Project Details", "3" => "Update Status", "4" => "Create Tasks", "5" => "Edit Tasks", "6" => "Delete Tasks", "7" => "Bill Tasks", "8" => "Associate Tickets", "9" => "Post Messages", "10" => "View Reports", "11" => "Delete Messages", "12" => "Delete Projects", "View Recent Activity");
protected function isMasterAdmin($roleId = 0, $adminId = 0)
{
}
public function check($permissionName)
{
}
public static function getPermissionList()
{
}
}
class Log extends \WHMCS\Module\Addon\ProjectManagement\BaseProjectEntity
{
protected function formatLogTime($date)
{
}
public function get()
{
}
public function add($message)
{
}
}
class Tasks extends \WHMCS\Module\Addon\ProjectManagement\BaseProjectEntity
{
protected function get($taskId = NULL)
{
}
public function listall()
{
}
public function getSingle($taskId = NULL)
{
}
public function getTaskSummary()
{
}
public function add()
{
}
public function delete()
{
}
public function toggleStatus()
{
}
public function assign()
{
}
public function setDueDate()
{
}
public function edit()
{
}
public function search()
{
}
public function select()
{
}
public function import()
{
}
public function saveList()
{
}
public function deleteTaskTemplate()
{
}
public function saveOrder()
{
}
}
}
namespace WHMCS\Module\Addon\Mailchimp {
class Dispatcher
{
public function dispatch($action, $parameters)
{
}
public function renderView($action, $parameters)
{
}
}
class SettingsHelper
{
public $vars = array();
public function __construct($vars)
{
}
public function request($key)
{
}
public function get($key)
{
}
public function set($key, $value)
{
}
}
class Api
{
protected $apiKey = NULL;
protected $dc = NULL;
protected $testmode = false;
public function setApiKey($apiKey)
{
}
public function info()
{
}
public function getLists()
{
}
public function createList($name, $fromEmail, $fromName, $permissionReminder, $contactCompany, $contactAddr1, $contactCity, $contactState, $contactZip, $contactCountry)
{
}
public function getStores()
{
}
public function deleteStore()
{
}
public function getWhmcsStoreListId()
{
}
public function createStore($listId, $currencyCode, $currencyPrefix)
{
}
public function getProducts()
{
}
public function createProduct($type, $productId, $group, $title, $description, $url, $pricing, $qty)
{
}
public function updateProduct($type, $productId, $group, $title, $description, $url, $pricing, $qty)
{
}
public function updateCustomer($id, $email, $optInStatus, $company, $firstName, $lastName, $orderCount, $totalSpent, $address1, $address2, $city, $state, $postcode, $country, $countryCode, \Illuminate\Support\Collection $settings)
{
}
public function createOrder($orderId, $customer, $currencyCode, $discountTotal, $taxTotal, $total, $lineItems)
{
}
public function updateOrder($orderId, $isPaid = false, $isShipped = false, $isCancelled = false, $isRefunded = false)
{
}
public function deleteOrder($orderId)
{
}
public function createCart($cartId, $customer, $currencyCode, $total, $lineItems)
{
}
public function deleteCart($cartId)
{
}
protected function getCustomerId($userId)
{
}
protected function getOrderId($orderId)
{
}
protected function formatLineItems($lineItems, $prefix)
{
}
protected function getApiUrl()
{
}
protected function getApiKey()
{
}
protected function get($action)
{
}
protected function post($action, $data)
{
}
protected function patch($action, $data)
{
}
protected function put($action, $data)
{
}
protected function delete($action)
{
}
protected function call($method, $action, $data)
{
}
protected function processResponse($response)
{
}
public function enableTestMode()
{
}
}
}
namespace WHMCS\Module\Addon\Mailchimp\Exceptions {
class ApiException extends \WHMCS\Exception
{
}
class InvalidApiKey extends \WHMCS\Exception
{
}
}
namespace WHMCS\Module\Addon\Mailchimp {
class Controller
{
protected $api = NULL;
public function __construct()
{
}
public function index($vars)
{
}
public function settings($vars, $saveSuccess = false, $errorMsg = "")
{
}
public function savesettings($vars)
{
}
public function setup($vars)
{
}
protected function apikeyinput($vars, $errorMsg = NULL)
{
}
public function validateapikey($vars)
{
}
protected function showlistchoice($vars, $errorMsg = NULL)
{
}
public function validateprimarylist($vars)
{
}
public function sync($vars)
{
}
public function runsync($vars)
{
}
public function disconnect($vars)
{
}
public function disconnectconfirm($vars)
{
}
}
}
namespace WHMCS\Module\Fraud {
interface ModuleInterface
{
public function validateRules(array $params, \WHMCS\Module\Fraud\ResponseInterface $response);
public function formatResponse(\WHMCS\Module\Fraud\ResponseInterface $response);
}
class AbstractModule
{
protected $fieldMapping = array();
protected $meteredFields = array();
protected $booleanFields = array();
}
}
namespace WHMCS\Module\Fraud\FraudLabs {
class FraudLabs extends \WHMCS\Module\Fraud\AbstractModule implements \WHMCS\Module\Fraud\ModuleInterface
{
protected $fieldMapping = array("ip" => array("ip_country", "is_country_match", "ip_region", "ip_city", "ip_continent", "ip_latitude", "ip_longitude", "ip_timezone", "ip_domain", "ip_isp_name", "ip_usage_type", "is_proxy_ip_address", "is_ip_blacklist"), "billing" => array("is_high_risk_country", "is_phone_blacklist", "is_export_controlled_country", "user_order_id"), "email" => array("is_free_email", "is_disposable_email", "is_new_domain_name", "is_domain_exists", "is_email_blacklist"), "general" => array("fraudlabspro_id", "fraudlabspro_distribution", "fraudlabspro_status", "fraudlabspro_version", "fraudlabspro_credits"));
protected $meteredFields = array("fraudlabspro_distribution");
protected $booleanFields = array("is_country_match", "is_high_risk_country", "is_free_email", "is_disposable_email", "is_new_domain_name", "is_domain_exists", "is_proxy_ip_address", "is_ip_blacklist", "is_email_blacklist", "is_phone_blacklist", "is_export_controlled_country");
public function validateRules(array $params, \WHMCS\Module\Fraud\ResponseInterface $response)
{
}
public function formatResponse(\WHMCS\Module\Fraud\ResponseInterface $response)
{
}
protected function generateHtmlOutput(\WHMCS\Module\Fraud\FraudLabs\Response $response, array $panels)
{
}
public static function hash($string)
{
}
}
}
namespace WHMCS\Module\Fraud {
interface RequestInterface
{
public function setLicenseKey($licenseKey);
public function call($data);
}
class AbstractRequest
{
protected $licenseKey = NULL;
protected function log($action, $request, $response, $processedResponse)
{
}
protected function getClient()
{
}
}
}
namespace WHMCS\Module\Fraud\FraudLabs {
class Request extends \WHMCS\Module\Fraud\AbstractRequest implements \WHMCS\Module\Fraud\RequestInterface
{
const URL = "https://api.fraudlabspro.com/v1/order/screen";
public function setLicenseKey($licenseKey)
{
}
public function call($data)
{
}
protected function getApiEndpointUrl()
{
}
}
}
namespace WHMCS\Module\Fraud {
interface ResponseInterface
{
public function __construct($jsonData, $httpCode);
public function isSuccessful();
public function getHttpCode();
public function isEmpty();
public function get($key);
public function toArray();
public function toJson();
}
class AbstractResponse
{
protected $data = NULL;
protected $httpCode = 200;
public function __construct($jsonData, $httpCode = NULL)
{
}
protected function parseResponseJson($jsonData)
{
}
public function isSuccessful()
{
}
public function getHttpCode()
{
}
public function isEmpty()
{
}
public function get($key)
{
}
public function toArray()
{
}
public function toJson()
{
}
}
}
namespace WHMCS\Module\Fraud\FraudLabs {
class Response extends \WHMCS\Module\Fraud\AbstractResponse implements \WHMCS\Module\Fraud\ResponseInterface
{
protected $failureErrorCodes = array(101, 102, 103, 104, 203, 204, 210, 211);
public function isSuccessful()
{
}
}
}
namespace WHMCS\Module\Fraud\MaxMind {
class Payment extends \WHMCS\Model\AbstractModel
{
protected $table = "mod_maxmind_payment";
protected $fillable = array("processor", "whmcs_module");
public function createTable($drop = false)
{
}
protected function getDefaultTableData()
{
}
public static function getPaymentModule($paymentModule)
{
}
}
class Maxmind extends \WHMCS\Module\Fraud\AbstractModule implements \WHMCS\Module\Fraud\ModuleInterface
{
protected $fieldMapping = array("ip" => array("ip_address.city.names.en", "ip_address.city.confidence", "ip_address.subdivisions.0.iso_code", "ip_address.subdivisions.0.names.en", "ip_address.subdivisions.0.confidence", "ip_address.continent.code", "ip_address.continent.names.en", "ip_address.country.confidence", "ip_address.country.iso_code", "ip_address.country.names.en", "ip_address.location.accuracy_radius", "ip_address.location.latitude", "ip_address.location.longitude", "ip_address.location.time_zone", "ip_address.traits.user_type", "ip_address.traits.autonomous_system_number", "ip_address.traits.autonomous_system_organization", "ip_address.traits.isp", "ip_address.traits.is_anonymous", "ip_address.traits.is_anonymous_vpn"), "subscores" => array("subscores.billing_address", "subscores.billing_address_distance_to_ip_location", "subscores.browser", "subscores.country", "subscores.country_mismatch", "subscores.email_address", "subscores.email_domain", "subscores.order_amount", "subscores.phone_number", "subscores.time_of_day"), "billing" => array("billing_address.latitude", "billing_address.longitude", "billing_address.distance_to_ip_location", "billing_address.is_in_ip_country"), "credit_card" => array("credit_card.issuer.name", "credit_card.issuer.phone_number", "credit_card.brand", "credit_card.country", "credit_card.is_issued_in_billing_address_country", "credit_card.is_prepaid", "credit_card.is_virtual", "credit_card.type"), "email" => array("email.first_seen", "email.is_free", "email.is_high_risk"), "general" => array("id", "funds_remaining", "queries_remaining"));
protected $meteredFields = array("ip_address.city.confidence", "ip_address.country.confidence", "ip_address.subdivisions.0.confidence", "subscores.billing_address", "subscores.billing_address_distance_to_ip_location", "subscores.browser", "subscores.country", "subscores.country_mismatch", "subscores.email_address", "subscores.email_domain", "subscores.order_amount", "subscores.phone_number", "subscores.time_of_day");
protected $booleanFields = array("email.is_free", "email.is_high_risk", "billing_address.is_in_ip_country", "ip_address.traits.is_anonymous", "ip_address.traits.is_anonymous_vpn", "credit_card.is_issued_in_billing_address_country", "credit_card.is_prepaid", "credit_card.is_virtual");
public function validateRules(array $params, \WHMCS\Module\Fraud\ResponseInterface $response)
{
}
public function formatResponse(\WHMCS\Module\Fraud\ResponseInterface $response)
{
}
protected function generateHtmlOutput(\WHMCS\Module\Fraud\MaxMind\Response $response, array $panels)
{
}
public function legacyResultsFormatHandler($results)
{
}
}
class Request extends \WHMCS\Module\Fraud\AbstractRequest implements \WHMCS\Module\Fraud\RequestInterface
{
protected $accountId = NULL;
protected $licenseKey = NULL;
protected $serviceType = NULL;
const URL = "https://minfraud.maxmind.com/minfraud/v2.0/";
public function setAccountId($accountId)
{
}
public function setLicenseKey($licenseKey)
{
}
public function setServiceType($serviceType)
{
}
public function call($data)
{
}
protected function getApiEndpointUrl()
{
}
}
class Response extends \WHMCS\Module\Fraud\AbstractResponse implements \WHMCS\Module\Fraud\ResponseInterface
{
}
}
namespace {
class HeartInternetReg_API
{
public $namespace = "urn:ietf:params:xml:ns:epp-1.0";
public function connect($test_mode = \false)
{
}
public function getResponse()
{
}
public function sendMessage($output, $no_parsing = \false)
{
}
public function logIn($userid, $password, $objects, $extensions)
{
}
public function buildXML($content)
{
}
public function disconnect()
{
}
}
class OPS extends \PEAR
{
var $_OPS_VERSION = '0.9';
var $_OPT = '';
var $_SPACER = ' ';
/* indent character */
var $_CRLF = "\n";
var $_MSGTYPE_STD = 'standard';
var $_SESSID;
var $_MSGCNT;
var $CRLF = "\r\n";
var $_log = array();
var $_data;
var $_pointers;
var $_last_was_data_block;
/**
* Class constructor
*
* Initialize variables, logs, etc.
*
* @param array allows for setting various options (right now, just whether
* to use compression or not on the generated XML)
*/
function OPS($args = \false)
{
}
/**
* Writes a message to a socket (buffered IO)
*
* @param int socket handle
*
* @param string message to write
*
*/
function writeData(&$fh, $msg)
{
}
/**
* Encodes and writes a message to a socket
*
* @param int socket handle
*
* @param string message to encode and write
*
*/
function writeMessage(&$fh, $hr)
{
}
/**
* Reads data from a socket
*
* @param int socket handle
*
* @param int timeout for read
*
* @return mixed buffer with data, or an error for a short read
*
*/
function readData(&$fh, $timeout = 5)
{
}
/**
* Reads and decodes data from a socket
*
* @param int socket handle
*
* @param int timeout for read
*
* @return mixed associative array of data, or an error
*
*/
function readMessage(&$fh, $timeout = 5)
{
}
/**
* Checks a socket for timeout or EOF
*
* @param int socket handle
*
* @return boolean true if the socket has timed out or is EOF
*
*/
function socketStatus(&$fh)
{
}
/**
* Internal method to generate error codes hashes
*
* @param int error code
*
* @param string error message
*
* @return array error hash
*
*/
function _opsError($err_code, $err_text)
{
}
#
# DECODING METHODS
# Converts XML OPS messages into PHP data
#
/**
* Accepts an OPS protocol message or an file handle
* and decodes the data into a PHP array
*
* @param string OPS message
*
* @return mixed PHP array, or error
*
*/
function decode($in)
{
}
/**
* XML Parser that converts an OPS protocol message into a PHP array
*
* @param string OPS message
*
* @return mixed PHP array, or error
*
*/
function XML2PHP($msg)
{
}
#
# ENCODING METHODS
# Converts PHP data into XML OPS messages
#
/**
* Converts a PHP array into an OPS message
*
* @param array PHP array
*
* @return string OPS XML message
*
*/
function encode($array)
{
}
/**
* Converts a PHP array into an OPS data_block tag
*
* @param array PHP array
*
* @return string OPS data_block tag
*
*/
function PHP2XML($data)
{
}
/**
* Recursivly converts PHP data into XML
*
* @param mixed PHP array or data
*
* @param int ident level
*
* @return string XML string
*
*/
function _convertData(&$array, $indent = 0)
{
}
/**
* Quotes special XML characters
*
* @param string string to quote
*
* @return string quoted string
*
*/
function _quoteXMLChars($string)
{
}
/**
* Determines if an array is associative or not, since PHP
* doesn't really distinguish between the two, but Perl/OPS does
*
* @param array array to check
*
* @return boolean true if the array is associative
*
*/
function _is_assoc(&$array)
{
}
/**
* Internal loggging method
*
* @param string which log to log to
*
* @param string type of log message ('r'ead, 'w'rite, 'i'nfo or 'e'rror)
*
* @param int message
*
*/
function _log($log, $type, $msg)
{
}
/**
* Show internal log
*
* @param string which log to log show, 'raw' or 'xml'
*
* @param string format to display: 'html' (default) or 'raw'
*
*/
function showLog($log, $format = 'html')
{
}
}
class openSRS_base extends \PEAR
{
var $USERNAME = '';
var $HRS_USERNAME = '';
var $PRIVATE_KEY = '';
var $TEST_PRIVATE_KEY = '';
var $LIVE_PRIVATE_KEY = '';
var $HRS_PRIVATE_KEY = '';
var $VERSION = 'XML:0.1';
var $base_class_version = '2.8.0';
var $environment = 'LIVE';
/* 'TEST' or 'LIVE' or 'HRS' */
var $protocol = 'XCP';
/* 'XCP' or 'TPP' */
var $LIVE_host = 'rr-n1-tor.opensrs.net';
var $LIVE_port = 55000;
var $LIVE_sslport = 55443;
var $TEST_host = 'horizon.opensrs.net';
var $TEST_port = 55000;
var $TEST_sslport = 55443;
var $HRS_host;
var $HRS_port;
var $HRS_sslport;
var $REMOTE_HOST;
var $REMOTE_PORT;
var $connect_timeout = 20;
/* seconds */
var $read_timeout = 20;
/* seconds */
var $log = array();
var $CRLF = "\r\n";
var $_socket = \false;
var $_socket_error_num = \false;
var $_socket_error_msg = \false;
var $_session_key = \false;
var $_authenticated = \false;
var $_OPS;
var $_CBC;
var $lookup_all_tlds = \false;
var $_CRYPT;
var $_iv;
var $crypt_type = 'SSL';
/* 'DES' or 'BLOWFISH' or 'SSL' */
var $crypt_mode = 'CBC';
/* only 'CBC' */
var $crypt_rand_source = \MCRYPT_DEV_URANDOM;
/* or MCRYPT_DEV_RANDOM or MCRYPT_RAND */
var $affiliate_id;
var $PERMISSIONS = array('f_modify_owner' => 1, 'f_modify_admin' => 2, 'f_modify_billing' => 4, 'f_modify_tech' => 8, 'f_modify_nameservers' => 16);
var $REG_PERIODS = array(1 => '1 Year', 2 => '2 Years', 3 => '3 Years', 4 => '4 Years', 5 => '5 Years', 6 => '6 Years', 7 => '7 Years', 8 => '8 Years', 9 => '9 Years', 10 => '10 Years');
var $UK_REG_PERIODS = array(2 => '2 Years');
var $TV_REG_PERIODS = array(1 => '1 Year', 2 => '2 Years', 3 => '3 Years', 5 => '5 Years', 10 => '10 Years');
var $TRANSFER_PERIODS = array(1 => '1 Year');
var $OPENSRS_TLDS_REGEX = '(\\.ca|\\.(bc|ab|sk|mb|on|qc|nb|ns|pe|nf|nt|nv|yk)\\.ca|\\.com|\\.net|\\.org|\\.co\\.uk|\\.org\\.uk|\\.tv|\\.vc|\\.cc|\\.info|\\.biz|\\.name|\\.us)';
var $CA_LEGAL_TYPES = array('ABO' => 'Aboriginal', 'ASS' => 'Association', 'CCO' => 'Canadian Corporation', 'CCT' => 'Canadian Citizen', 'EDU' => 'Educational Institute', 'GOV' => 'Government', 'HOP' => 'Hospital', 'INB' => 'Indian Band', 'LAM' => 'Library, Archive or Museum', 'LGR' => 'Legal Respresentative', 'MAJ' => 'Her Majesty the Queen', 'OMK' => 'Protected by Trade-marks Act', 'PLT' => 'Political Party', 'PRT' => 'Partnership', 'RES' => 'Permanent Resident', 'TDM' => 'Trade-mark Owner', 'TRD' => 'Trade Union', 'TRS' => 'Trust');
var $CA_LANGUAGE_TYPES = array('EN' => 'English', 'FR' => 'French');
var $CA_NATIONALITIES = array('CND' => 'Canadian citizen', 'OTH' => 'Foreign citizenship', 'RES' => 'Canadian permanent resident');
var $OPENSRS_ACTIONS = array('get_domain' => \true, 'get_userinfo' => \true, 'modify_domain' => \true, 'renew_domain' => \true, 'register_domain' => \true, 'get_nameserver' => \true, 'create_nameserver' => \true, 'modify_nameserver' => \true, 'delete_nameserver' => \true, 'get_subuser' => \true, 'add_subuser' => \true, 'modify_subuser' => \true, 'delete_subuser' => \true, 'change_password' => \true, 'change_ownership' => \true, 'set_cookie' => \true, 'delete_cookie' => \true, 'update_cookie' => \true, 'sw_register_domain' => \true, 'bulk_transfer_domain' => \true, 'register_domain' => \true, 'lookup_domain' => \true, 'get_price_domain' => \true, 'check_transfer_domain' => \true, 'quit_session' => \true, 'buy_webcert' => \true, 'refund_webcert' => \true, 'query_webcert' => \true, 'cprefget_webcert' => \true, 'cprefset_webcert' => \true, 'cancel_pending_webcert' => \true, 'update_webcert' => \true);
#
# BASIC PUBLIC FUNCTIONS
#
/**
* Class constructor
*
* Initialize variables, logs, etc.
*
* @param string Which environment to use (LIVE or TEST or HRS)
* @param string Which protocol to use (XCP or TPP)
*
*/
function openSRS_base($environment = \NULL, $protocol = \NULL, $regusername = \NULL, $regprivatekey = \NULL)
{
}
#
# setProtocol()
# Switch between XCP and TPP
#
function setProtocol($proto)
{
}
#
# logout()
# Send a 'quit' command to the server
#
function logout()
{
}
#
# send_cmd()
# Send a command to the server
#
function send_cmd($request)
{
}
#
# validate()
# Check data for validity
#
function validate($data, $params = array())
{
}
#
# version()
# return base class version
#
function version()
{
}
#
# PRIVATE FUNCTIONS
#
#
# init_socket()
# Initialize a socket connection to the OpenSRS server
#
function init_socket()
{
}
#
# authenticate()
# Authenticate the connection with the username/private key
#
function authenticate($username = \false, $private_key = \false)
{
}
#
# lookup_domain()
# Special case for domain lookups
#
#
# NOTE: I have changed the error codes returned by this function.
# Instead of having all syntax errors return a 400 code, they return
# codes in the range 490 to 499 range, depending on the type of error.
# This makes it much easier to determine what *kind* of lookup error
# happened, by having *us* parse through response_text for various strings.
#
# 490 No domain given
# 491 TLD not supported
# 492 Domain name too long
# 493 Invalid characters
# 499 Other error
#
# Syntax errors coming back from the server will likely still have error
# code 400. Oh well.
#
function lookup_domain($lookupData)
{
}
#
# close_socket()
# Close the socket connection
#
function close_socket()
{
}
#
# read_data()
# Reads a response from the server
#
function read_data($args = array())
{
}
#
# send_data()
# Sends request to the server
#
function send_data($message, $args = array())
{
}
#
# check_email_syntax()
# Regex check for valid email
#
function check_email_syntax($email)
{
}
#
# check_domain_syntax()
# Regex check for valid domain
#
function check_domain_syntax($domain)
{
}
#
# prune_private_keys()
# Recursively remove keys that start with 'p_' from an array
#
function prune_private_keys(&$data)
{
}
#
# getRelatedTLDs()
#
function getRelatedTLDs($tld)
{
}
#
# _log()
# Internal logging method
#
function _log($type, $data)
{
}
#
# showlog()
# output the debugging log
#
function showlog()
{
}
/**
* Writes a message to a socket (buffered IO)
*
* @param int socket handle
*
* @param string message to write
*
*/
function writeData(&$fh, $msg)
{
}
/**
* Reads header data
*
* @param int socket handle
*
* @param int timeout for read
*
* @return hash hash containing header key/value pairs
*
*/
function readHeader($fh, $timeout = 5)
{
}
/**
* Reads data from a socket
*
* @param int socket handle
*
* @param int timeout for read
*
* @return mixed buffer with data, or an error for a short read
*
*/
function readData(&$fh, $timeout = 5)
{
}
}
class Transip_Db
{
public $name = \NULL;
public $username = \NULL;
public $maxDiskUsage = \NULL;
public function __construct($name, $username = "", $maxDiskUsage = 100)
{
}
}
class Transip_WebHost
{
public $domainName = \NULL;
public $cronjobs = \NULL;
public $mailBoxes = \NULL;
public $dbs = \NULL;
public $mailForwards = \NULL;
public $subDomains = \NULL;
}
class Transip_Cronjob
{
public $name = \NULL;
public $url = \NULL;
public $email = \NULL;
public $minuteTrigger = \NULL;
public $hourTrigger = \NULL;
public $dayTrigger = \NULL;
public $monthTrigger = \NULL;
public $weekdayTrigger = \NULL;
public function __construct($name, $url, $email, $minuteTrigger, $hourTrigger, $dayTrigger, $monthTrigger, $weekdayTrigger)
{
}
}
class Transip_Nameserver
{
public $hostname = "";
public $ipv4 = "";
public $ipv6 = "";
public function __construct($hostname, $ipv4 = "", $ipv6 = "")
{
}
}
class Transip_ApiSettings
{
public static $mode = "readwrite";
public static $endpoint = "api.transip.nl";
public static $login = "";
public static $privateKey = "";
}
class Transip_DomainAction
{
public $name = \NULL;
public $hasFailed = \NULL;
public $message = \NULL;
}
class Transip_Domain
{
public $name = "";
public $nameservers = array();
public $contacts = array();
public $dnsEntries = array();
public $branding = \NULL;
public $authCode = "";
public $isLocked = \false;
public $registrationDate = "";
public $renewalDate = "";
public function __construct($name, $nameservers = array(), $contacts = array(), $dnsEntries = array(), $branding = \NULL)
{
}
}
class Transip_DomainBranding
{
public $companyName = \NULL;
public $supportEmail = \NULL;
public $companyUrl = \NULL;
public $termsOfUsageUrl = \NULL;
public $bannerLine1 = \NULL;
public $bannerLine2 = \NULL;
public $bannerLine3 = \NULL;
}
class Transip_MailBox
{
public $address = \NULL;
public $spamCheckerStrength = \NULL;
public $maxDiskUsage = \NULL;
public $hasVacationReply = \NULL;
public $vacationReplySubject = \NULL;
public $vacationReplyMessage = \NULL;
const SPAMCHECKER_STRENGTH_AVERAGE = "AVERAGE";
const SPAMCHECKER_STRENGTH_OFF = "OFF";
const SPAMCHECKER_STRENGTH_LOW = "LOW";
const SPAMCHECKER_STRENGTH_HIGH = "HIGH";
public function __construct($address, $spamCheckerStrength = "AVERAGE", $maxDiskUsage = 20, $hasVacationReply = \false, $vacationReplySubject = "", $vacationReplyMessage = "")
{
}
}
class Transip_DnsEntry
{
public $name = \NULL;
public $expire = \NULL;
public $type = \NULL;
public $content = \NULL;
const TYPE_A = "A";
const TYPE_AAAA = "AAAA";
const TYPE_CNAME = "CNAME";
const TYPE_MX = "MX";
const TYPE_NS = "NS";
const TYPE_TXT = "TXT";
const TYPE_SRV = "SRV";
public function __construct($name, $expire, $type, $content)
{
}
}
class Transip_SubDomain
{
public $name = \NULL;
public function __construct($name)
{
}
}
class Transip_WhoisContact
{
public static $possibleCompanyTypes = array("BV" => "BV - Besloten Vennootschap", "BVI/O" => "BV i.o. - BV in oprichting", "COOP" => "Cooperatie", "CV" => "CV - Commanditaire Vennootschap", "EENMANSZAAK" => "Eenmanszaak", "KERK" => "Kerkgenootschap", "NV" => "NV - Naamloze Vennootschap", "OWM" => "Onderlinge Waarborg Maatschappij", "REDR" => "Rederij", "STICHTING" => "Stichting", "VERENIGING" => "Vereniging", "VOF" => "VoF - Vennootschap onder firma", "BEG" => "Buitenlandse EG vennootschap", "BRO" => "Buitenlandse rechtsvorm/onderneming", "EESV" => "Europees Economisch Samenwerkingsverband", "ANDERS" => "Anders", "" => "Geen");
public static $possibleCountryCodes = array("af" => "Afghanistan", "al" => "Albania", "dz" => "Algeria", "as" => "American Samoa", "ad" => "Andorra", "ao" => "Angola", "ai" => "Anguilla", "aq" => "Antarctica", "ag" => "Antigua and Barbuda", "ar" => "Argentina", "am" => "Armenia", "aw" => "Aruba", "au" => "Australia", "at" => "Austria", "az" => "Azerbaijan", "bs" => "Bahamas", "bh" => "Bahrain", "bd" => "Bangladesh", "bb" => "Barbados", "by" => "Belarus", "be" => "Belgium", "bz" => "Belize", "bj" => "Benin", "bm" => "Bermuda", "bt" => "Bhutan", "bo" => "Bolivia", "ba" => "Bosnia and Herzegovina", "bw" => "Botswana", "bv" => "Bouvet Island", "br" => "Brazil", "io" => "British Indian Ocean Territory", "bn" => "Brunei Darussalem", "bg" => "Bulgaria", "bf" => "Burkina Faso", "bi" => "Burundi", "kh" => "Cambodia", "cm" => "Cameroon", "ca" => "Canada", "cv" => "Cape Verde", "ky" => "Cayman Islands", "cf" => "Central African Republic", "td" => "Chad", "cl" => "Chile", "cn" => "China", "cx" => "Christmas Island", "cc" => "Cocos (Keeling) Islands", "co" => "Colombia", "km" => "Comoros", "cg" => "Congo", "cd" => "Congo, the Democratic Republic of the", "ck" => "Cook Islands", "cr" => "Costa Rica", "hr" => "Croatia", "cu" => "Cuba", "cy" => "Cyprus", "cz" => "Czech Republic", "ci" => "Côte d'Ivoire", "dk" => "Denmark", "dj" => "Djibouti", "dm" => "Dominica", "do" => "Dominican Republic", "ec" => "Ecuador", "eg" => "Egypt", "sv" => "El Salvador", "gq" => "Equatorial Guinea", "er" => "Eritrea", "ee" => "Estonia", "et" => "Ethiopia", "fk" => "Falkland Islands (Malvinas)", "fo" => "Faroe Islands", "fj" => "Fiji", "fi" => "Finland", "fr" => "France", "gf" => "French Guiana", "pf" => "French Polynesia", "tf" => "French Southern Territories", "ga" => "Gabon", "gm" => "Gambia", "ge" => "Georgia", "de" => "Germany", "gh" => "Ghana", "gi" => "Gibraltar", "gr" => "Greece", "gl" => "Greenland", "gd" => "Grenada", "gp" => "Guadeloupe", "gu" => "Guam", "gt" => "Guatemala", "gg" => "Guernsey", "gn" => "Guinea", "gw" => "Guinea-Bissau", "gy" => "Guyana", "ht" => "Haiti", "hm" => "Heard Island and McDonald Islands", "va" => "Holy See (Vatican City State)", "hn" => "Honduras", "hk" => "Hong Kong", "hu" => "Hungary", "is" => "Iceland", "in" => "India", "id" => "Indonesia", "ir" => "Iran, Islamic Republic of", "iq" => "Iraq", "ie" => "Ireland", "im" => "Isle of Man", "il" => "Israel", "it" => "Italy", "jm" => "Jamaica", "jp" => "Japan", "je" => "Jersey", "jo" => "Jordan", "kz" => "Kazakhstan", "ke" => "Kenya", "ki" => "Kiribati", "kp" => "Korea, Democratic People's Republic of", "kr" => "Korea, Republic of", "kw" => "Kuwait", "kg" => "Kyrgyzstan", "la" => "Lao People's Democratic Republic", "lv" => "Latvia", "lb" => "Lebanon", "ls" => "Lesotho", "lr" => "Liberia", "ly" => "Libyan Arab Jamahiriya", "li" => "Liechtenstein", "lt" => "Lithuania", "lu" => "Luxembourg", "mo" => "Macao", "mk" => "Macedonia, the former Yugoslav Republic of", "mg" => "Madagascar", "mw" => "Malawi", "my" => "Malaysia", "mv" => "Maldives", "ml" => "Mali", "mt" => "Malta", "mh" => "Marshall Islands", "mq" => "Martinique", "mr" => "Mauritania", "mu" => "Mauritius", "yt" => "Mayotte", "mx" => "Mexico", "fm" => "Micronesia, Federated States of", "md" => "Moldova", "mc" => "Monaco", "mn" => "Mongolia", "me" => "Montenegro", "ms" => "Montserrat", "ma" => "Morocco", "mz" => "Mozambique", "mm" => "Myanmar", "na" => "Namibia", "nr" => "Nauru", "np" => "Nepal", "nl" => "Netherlands", "an" => "Netherlands Antilles", "nc" => "New Caledonia", "nz" => "New Zealand", "ni" => "Nicaragua", "ne" => "Niger", "ng" => "Nigeria", "nu" => "Niue", "nf" => "Norfolk Island", "mp" => "Northern Mariana Islands", "no" => "Norway", "om" => "Oman", "pk" => "Pakistan", "pw" => "Palau", "ps" => "Palestinian Territory, Occupied", "pa" => "Panama", "pg" => "Papua New Guinea", "py" => "Paraguay", "pe" => "Peru", "ph" => "Philippines", "pn" => "Pitcairn", "pl" => "Poland", "pt" => "Portugal", "pr" => "Puerto Rico", "qa" => "Qatar", "ro" => "Romania", "ru" => "Russian Federation", "rw" => "Rwanda", "re" => "Réunion", "bl" => "Saint Barthélemy", "sh" => "Saint Helena", "kn" => "Saint Kitts and Nevis", "lc" => "Saint Lucia", "mf" => "Saint Martin (French part)", "pm" => "Saint Pierre and Miquelon", "vc" => "Saint Vincent and the Grenadines", "ws" => "Samoa", "sm" => "San Marino", "st" => "Sao Tome and Principe", "sa" => "Saudi Arabia", "sn" => "Senegal", "rs" => "Serbia", "sc" => "Seychelles", "sl" => "Sierra Leone", "sg" => "Singapore", "sk" => "Slovakia", "si" => "Slovenia", "sb" => "Solomon Islands", "so" => "Somalia", "za" => "South Africa", "gs" => "South Georgia and the South Sandwich Islands", "es" => "Spain", "lk" => "Sri Lanka", "sd" => "Sudan", "sr" => "Suriname", "sj" => "Svalbard and Jan Mayen", "sz" => "Swaziland", "se" => "Sweden", "ch" => "Switzerland", "sy" => "Syrian Arab Republic", "tw" => "Taiwan, Province of China", "tj" => "Tajikistan", "tz" => "Tanzania, United Republic of", "th" => "Thailand", "tl" => "Timor-Leste", "tg" => "Togo", "tk" => "Tokelau", "to" => "Tonga", "tt" => "Trinidad and Tobago", "tn" => "Tunisia", "tr" => "Turkey", "tm" => "Turkmenistan", "tc" => "Turks and Caicos Islands", "tv" => "Tuvalu", "ug" => "Uganda", "ua" => "Ukraine", "ae" => "United Arab Emirates", "gb" => "United Kingdom", "us" => "United States", "um" => "United States Minor Outlying Islands", "uy" => "Uruguay", "uz" => "Uzbekistan", "vu" => "Vanuatu", "ve" => "Venezuela", "vn" => "Viet Nam", "vg" => "Virgin Islands, British", "vi" => "Virgin Islands, U.S.", "wf" => "Wallis and Futuna", "eh" => "Western Sahara", "ye" => "Yemen", "zm" => "Zambia", "zw" => "Zimbabwe", "ax" => "Åland Islands");
public $type = \NULL;
public $firstName = \NULL;
public $middleName = \NULL;
public $lastName = \NULL;
public $companyName = \NULL;
public $companyKvk = \NULL;
public $companyType = \NULL;
public $street = \NULL;
public $number = \NULL;
public $postalCode = \NULL;
public $city = \NULL;
public $phoneNumber = \NULL;
public $faxNumber = \NULL;
public $email = \NULL;
public $country = \NULL;
const TYPE_REGISTRANT = "registrant";
const TYPE_ADMINISTRATIVE = "administrative";
const TYPE_TECHNICAL = "technical";
}
class Transip_DataCenterVisitor
{
public $name = \NULL;
public $reservationNumber = \NULL;
public $accessCode = \NULL;
public $hasBeenRegisteredBefore = \NULL;
}
class Transip_ForwardService
{
protected static $_soapClient = \NULL;
const SERVICE = "ForwardService";
const CANCELLATIONTIME_END = "end";
const CANCELLATIONTIME_IMMEDIATELY = "immediately";
public static function _getSoapClient($parameters = array())
{
}
protected static function _sign($parameters)
{
}
protected static function _sha512Asn1($data)
{
}
protected static function _encodeParameters($parameters, $keyPrefix = \NULL)
{
}
protected static function _urlencode($string)
{
}
public static function getForwardDomainNames()
{
}
public static function getInfo($forwardDomainName)
{
}
public static function order($forward)
{
}
public static function cancel($forwardDomainName, $endTime)
{
}
public static function modify($forward)
{
}
}
class Transip_MailForward
{
public $name = \NULL;
public $targetAddress = \NULL;
public function __construct($name, $targetAddress)
{
}
}
class Transip_DomainService
{
protected static $_soapClient = \NULL;
const SERVICE = "DomainService";
const AVAILABILITY_INYOURACCOUNT = "inyouraccount";
const AVAILABILITY_UNAVAILABLE = "unavailable";
const AVAILABILITY_NOTFREE = "notfree";
const AVAILABILITY_FREE = "free";
const CANCELLATIONTIME_END = "end";
const CANCELLATIONTIME_IMMEDIATELY = "immediately";
public static function _getSoapClient($parameters = array())
{
}
protected static function _sign($parameters)
{
}
protected static function _sha512Asn1($data)
{
}
protected static function _encodeParameters($parameters, $keyPrefix = \NULL)
{
}
protected static function _urlencode($string)
{
}
public static function batchCheckAvailability($domainNames)
{
}
public static function checkAvailability($domainName)
{
}
public static function getWhois($domainName)
{
}
public static function getDomainNames()
{
}
public static function getInfo($domainName)
{
}
public static function batchGetInfo($domainNames)
{
}
public static function getAuthCode($domainName)
{
}
public static function getIsLocked($domainName)
{
}
public static function register($domain)
{
}
public static function cancel($domainName, $endTime)
{
}
public static function transferWithOwnerChange($domain, $authCode)
{
}
public static function transferWithoutOwnerChange($domain, $authCode)
{
}
public static function setNameservers($domainName, $nameservers)
{
}
public static function setLock($domainName)
{
}
public static function unsetLock($domainName)
{
}
public static function setDnsEntries($domainName, $dnsEntries)
{
}
public static function setOwner($domainName, $registrantWhoisContact)
{
}
public static function setContacts($domainName, $contacts)
{
}
public static function getAllTldInfos()
{
}
public static function getTldInfo($tldName)
{
}
public static function getCurrentDomainAction($domainName)
{
}
public static function retryCurrentDomainActionWithNewData($domain)
{
}
public static function retryTransferWithDifferentAuthCode($domain, $newAuthCode)
{
}
public static function cancelDomainAction($domain)
{
}
}
class Transip_ColocationService
{
protected static $_soapClient = \NULL;
const SERVICE = "ColocationService";
public static function _getSoapClient($parameters = array())
{
}
protected static function _sign($parameters)
{
}
protected static function _sha512Asn1($data)
{
}
protected static function _encodeParameters($parameters, $keyPrefix = \NULL)
{
}
protected static function _urlencode($string)
{
}
public static function requestAccess($when, $duration, $visitors, $phoneNumber)
{
}
public static function requestRemoteHands($coloName, $contactName, $phoneNumber, $expectedDuration, $instructions)
{
}
public static function getColoNames()
{
}
public static function getIpAddresses($coloName)
{
}
public static function getIpRanges($coloName)
{
}
public static function createIpAddress($ipAddress, $reverseDns)
{
}
public static function deleteIpAddress($ipAddress)
{
}
public static function getReverseDns($ipAddress)
{
}
public static function setReverseDns($ipAddress, $reverseDns)
{
}
}
class Transip_WebhostingPackage
{
public $name = \NULL;
public $description = \NULL;
public $price = \NULL;
public $renewalPrice = \NULL;
}
class Transip_WebhostingService
{
protected static $_soapClient = \NULL;
const SERVICE = "WebhostingService";
const CANCELLATIONTIME_END = "end";
const CANCELLATIONTIME_IMMEDIATELY = "immediately";
public static function _getSoapClient($parameters = array())
{
}
protected static function _sign($parameters)
{
}
protected static function _sha512Asn1($data)
{
}
protected static function _encodeParameters($parameters, $keyPrefix = \NULL)
{
}
protected static function _urlencode($string)
{
}
public static function getWebhostingDomainNames()
{
}
public static function getAvailablePackages()
{
}
public static function getInfo($domainName)
{
}
public static function order($domainName, $webhostingPackage)
{
}
public static function getAvailableUpgrades($domainName)
{
}
public static function upgrade($domainName, $newWebhostingPackage)
{
}
public static function cancel($domainName, $endTime)
{
}
public static function setFtpPassword($domainName, $newPassword)
{
}
public static function createCronjob($domainName, $cronjob)
{
}
public static function deleteCronjob($domainName, $cronjob)
{
}
public static function createMailBox($domainName, $mailBox)
{
}
public static function modifyMailBox($domainName, $mailBox)
{
}
public static function setMailBoxPassword($domainName, $mailBox, $newPassword)
{
}
public static function deleteMailBox($domainName, $mailBox)
{
}
public static function createMailForward($domainName, $mailForward)
{
}
public static function modifyMailForward($domainName, $mailForward)
{
}
public static function deleteMailForward($domainName, $mailForward)
{
}
public static function createDatabase($domainName, $db)
{
}
public static function modifyDatabase($domainName, $db)
{
}
public static function setDatabasePassword($domainName, $db, $newPassword)
{
}
public static function deleteDatabase($domainName, $db)
{
}
public static function createSubdomain($domainName, $subDomain)
{
}
public static function deleteSubdomain($domainName, $subDomain)
{
}
}
class Transip_DomainCheckResult
{
public $domainName = \NULL;
public $status = \NULL;
}
class Transip_Tld
{
public $name = \NULL;
public $price = \NULL;
public $renewalPrice = \NULL;
public $capabilities = \NULL;
public $registrationPeriodLength = \NULL;
public $cancelTimeFrame = \NULL;
const CAPABILITY_REQUIRESAUTHCODE = "requiresAuthCode";
const CAPABILITY_CANREGISTER = "canRegister";
const CAPABILITY_CANTRANSFERWITHOWNERCHANGE = "canTransferWithOwnerChange";
const CAPABILITY_CANTRANSFERWITHOUTOWNERCHANGE = "canTransferWithoutOwnerChange";
const CAPABILITY_CANSETLOCK = "canSetLock";
const CAPABILITY_CANSETOWNER = "canSetOwner";
const CAPABILITY_CANSETCONTACTS = "canSetContacts";
const CAPABILITY_CANSETNAMESERVERS = "canSetNameservers";
}
class Transip_Forward
{
public $domainName = \NULL;
public $forwardTo = \NULL;
public $forwardMethod = \NULL;
public $frameTitle = \NULL;
public $frameIcon = \NULL;
public $forwardEverything = \NULL;
public $forwardSubdomains = \NULL;
public $forwardEmailTo = \NULL;
const FORWARDMETHOD_DIRECT = "direct";
const FORWARDMETHOD_FRAME = "frame";
public function __construct($domainName, $forwardTo, $forwardMethod = "direct", $frameTitle = "", $frameIcon = "", $forwardEveryThing = \true, $forwardSubdomains = "", $forwardEmailTo = "")
{
}
}
class WHMCS_Nominet
{
public function __construct()
{
}
public static function init($params)
{
}
public function getLastError()
{
}
public function setError($errmsg)
{
}
public function getParam($key)
{
}
public function getDomain()
{
}
public function connect()
{
}
public function getResponse()
{
}
public function getResponseArray()
{
}
public function getResultCode()
{
}
public function isErrorCode()
{
}
public function getErrorDesc()
{
}
public function call($xml)
{
}
public function login()
{
}
public function connectAndLogin()
{
}
public function escapeParam($param)
{
}
}
}
namespace WHMCS\Module\Registrar\GoDaddy {
class Client
{
protected $apiKey = "";
protected $apiSecret = "";
protected $sandboxMode = false;
protected $apiVersion = 1;
const URLS = array("sandbox" => "https://api.ote-godaddy.com/v", "live" => "https://api.godaddy.com/v");
const DATE_FORMAT = "Y-m-d\\TH:i:s.u\\Z";
public function __construct($apiKey, $apiSecret, $sandbox = false)
{
}
public static function factory($apiKey, $apiSecret, $sandbox = false)
{
}
protected function getApiKey()
{
}
public function setApiKey($apiKey)
{
}
protected function getApiSecret()
{
}
public function setApiSecret($apiSecret)
{
}
public function isSandboxMode()
{
}
public function setSandboxMode($sandboxMode)
{
}
protected function getUrl()
{
}
protected function getAuth()
{
}
protected function getDefaultOptions()
{
}
public function setApiVersion($version = 1)
{
}
}
}
namespace WHMCS\Module\Registrar\GoDaddy\Api {
class Client
{
protected $client = NULL;
protected $options = array();
public function __construct(array $options)
{
}
protected function getClient()
{
}
public function get($path, $params = array())
{
}
public function put($path, $params)
{
}
public function post($path, $params)
{
}
public function patch($path, $params)
{
}
public function delete($path, $params)
{
}
protected function handleErrors($response, $emptyJsonOk = false)
{
}
protected function castBooleanValuesToStrings($query)
{
}
}
class Response
{
public $headers = NULL;
public $status_code = NULL;
public $body = NULL;
public function __construct(\GuzzleHttp\Message\ResponseInterface $response)
{
}
}
}
namespace WHMCS\Module\Registrar\GoDaddy {
class Shopper
{
public static function findShopperId($userId, array $params)
{
}
public static function create(array $params)
{
}
}
}
namespace WHMCS\Module\Registrar\GoDaddy\Exception {
class ApiException extends \WHMCS\Exception
{
}
class MalformedResponseException extends \WHMCS\Exception
{
}
}
namespace {
class NamecheapRegistrarApi
{
public static $url = "https://api.namecheap.com/xml.response";
public static $testUrl = "https://api.sandbox.namecheap.com/xml.response";
public function __construct($apiUser, $apiKey, $testMode = \true)
{
}
/**
* getLastUrl
* @return string
*/
public function getLastUrl()
{
}
/**
* getLastParams
* @return string
*/
public function getLastParams()
{
}
/**
* getLastResponse
* @return string
*/
public function getLastResponse()
{
}
/**
* Parse the response into an array.
*
* @throws NamecheapRegistrarApiException
*
* @param string $response
*
* @return array
*/
public function parseResponse($response)
{
}
/**
* Send the request to the API
*
* @throws NamecheapRegistrarApiException
*
* @param string $command
* @param array $params
*
* @return string
*/
public function request($command, array $params)
{
}
/**
* setTestMode
* @param boolean $flag
*/
public function setTestMode($flag)
{
}
public function parseResultSyncHelper($items, $domainNameKey = "DomainName")
{
}
}
class NamecheapRegistrarApiException extends \Exception
{
}
class NamecheapRegistrarIDNA
{
public function __construct($sld, $tld)
{
}
public function getIdnCode($param)
{
}
public function sldWasEncoded()
{
}
public function getEncodedSld()
{
}
public function getCodeOptions()
{
}
public function getTldList()
{
}
}
class Net_IDNA2
{
// }}}
// {{{ constructor
/**
* Constructor
*
* @param array $options Options to initialise the object with
*
* @access public
* @see setParams()
*/
public function __construct($options = \null)
{
}
// }}}
/**
* Sets a new option value. Available options and values:
*
* [utf8 - Use either UTF-8 or ISO-8859-1 as input (true for UTF-8, false
* otherwise); The output is always UTF-8]
* [overlong - Unicode does not allow unnecessarily long encodings of chars,
* to allow this, set this parameter to true, else to false;
* default is false.]
* [strict - true: strict mode, good for registration purposes - Causes errors
* on failures; false: loose mode, ideal for "wildlife" applications
* by silently ignoring errors and returning the original input instead]
*
* @throws InvalidArgumentException
*
* @param string|array $option Parameter to set (string: single parameter; array of Parameter => Value pairs)
* @param boolean $value Value to use (if parameter 1 is a string)
*
* @return boolean true on success, false otherwise
* @access public
*/
public function setParams($option, $value = \false)
{
}
/**
* Encode a given UTF-8 domain name.
*
* @param string $decoded Domain name (UTF-8 or UCS-4)
* @param boolean $one_time_encoding Desired input encoding, see {@link set_parameter}
* If not given will use default-encoding
*
* @return string Encoded Domain name (ACE string)
* @return mixed processed string
* @throws InvalidArgumentException
* @access public
*/
public function encode($decoded, $one_time_encoding = \false)
{
}
/**
* Decode a given ACE domain name.
*
* @param string $input Domain name (ACE string)
* @param bool $one_time_encoding Desired output encoding, see {@link set_parameter}
*
* @return array|string Decoded Domain name (UTF-8 or UCS-4)
* @throws InvalidArgumentException
* @access public
*/
public function decode($input, $one_time_encoding = \false)
{
}
// }}}}
// {{{ factory
/**
* Attempts to return a concrete IDNA instance for either php4 or php5.
*
* @param array $params Set of paramaters
*
* @return Net_IDNA2
* @access public
*/
function getInstance($params = array())
{
}
// }}}
// {{{ singleton
/**
* Attempts to return a concrete IDNA instance for either php4 or php5,
* only creating a new instance if no IDNA instance with the same
* parameters currently exists.
*
* @param array $params Set of paramaters
*
* @return object Net_IDNA2
* @access public
*/
function singleton($params = array())
{
}
// }}}
}
}
namespace WHMCS\Module\Registrar\Enom {
class ApiInterface
{
protected $PostString = "";
protected $RawData = "";
public $Values = array();
public function NewRequest()
{
}
protected function AddError($error)
{
}
protected function ParseResponse($buffer)
{
}
public function AddParam($Name, $Value)
{
}
public function DoTransaction(array $params, $processResponse = true)
{
}
protected function getActionFromQuery($query)
{
}
public function parseXMLResponseToArray($priority = "value")
{
}
protected function doParseXMLToArray($contents, $get_attributes = 1, $priority = "value")
{
}
}
}
namespace {
abstract class TPPW_API
{
protected $url = \NULL;
protected $params = \NULL;
protected static $sessionId = \false;
protected function __construct($script, $params)
{
}
protected function getPostParams($object, $action)
{
}
protected function execute($postParams, $existingSession = \true)
{
}
protected function getDomain()
{
}
protected function getTLD()
{
}
protected function getClientId()
{
}
}
class TPPW_AuthAPI extends \TPPW_API
{
public function __construct($params)
{
}
public function authenticate($accountNo, $userId, $password)
{
}
}
class TPPW_QueryAPI extends \TPPW_API
{
public static $domainWhois = \false;
public function __construct($params)
{
}
public function domainWhois()
{
}
public function domainSync($domains = \NULL)
{
}
public function domainPassword($domains)
{
}
public function accountInfo()
{
}
public function orderStatus($workflow = \true)
{
}
public function checkTransferability()
{
}
}
class TPPW_ResourceAPI extends \TPPW_API
{
public function __construct($params)
{
}
public function domainAdd()
{
}
public function domainUpgrade()
{
}
public function domainSuspendProduct()
{
}
public function domainUnSuspendProduct()
{
}
public function domainCancelProduct()
{
}
}
class TPPW_OrderAPI extends \TPPW_API
{
public function __construct($params)
{
}
public function domainRegister()
{
}
public function domainRenewal()
{
}
public function domainTransfer()
{
}
public function domainDelegation()
{
}
public function domainLock()
{
}
public function hostCreate()
{
}
public function hostUpdate()
{
}
public function hostRemove()
{
}
public function contactsUpdate()
{
}
}
class TPPW_APIResult
{
public function __construct($response)
{
}
public function getResponse()
{
}
public function isSuccess()
{
}
public function getParams($prefix)
{
}
public function get($key)
{
}
public function getArray($key)
{
}
public function getModuleResults()
{
}
public function getModuleError()
{
}
public function getModuleErrorCode()
{
}
}
class TPPW_APIUtils
{
public static $BRAND_NAME = "TPP Wholesale";
public static $MODULE_NAME = "tppwregistrar";
public static $API_IP = "114.141.204.99";
public static $API_HOST = "theconsole.tppwholesale.com.au";
public static $API_PATH = "/api/";
public static $URL_SUPPORT = "http://www.tppwholesale.com.au/support/category/getting-started/whmcs";
public static $API_COMMON_PARAMS = array("Requester" => "WHMCS", "Version" => "2.4", "Type" => "Domains");
public static $ERROR_UNKNOWN = "Unknown error occurred";
public static $ERROR_CODES = array("100" => "Missing parameters", "102" => "Authentication failed", "105" => "Request is coming from incorrect IP address", "202" => "Invalid API Type", "203" => "API call has not been implemented yet", "301" => "Invalid order ID", "302" => "Domain name is either invalid or not supplied", "303" => "Domain prices are not setted up", "304" => "Domain registration failed", "305" => "Domain renewal failed", "306" => "Domain transfer failed", "307" => "Incorrect auth code provided", "309" => "Invalid domain extension", "311" => "Domain does not exist in your reseller account", "312" => "Invalid username/password", "313" => "Account does not exist in your reseller profile", "401" => "Failed to connect to registry, please retry", "500" => "Prepaid account does not have enough funds to cover the cost of this order", "501" => "Invalid credit card type", "502" => "Invalid credit card number", "503" => "Invalid credit card expiry date", "505" => "Credit card transaction failed", "600" => "Failed to create/update contact", "601" => "Failed to create order", "602" => "Invalid hosts supplied", "603" => "Invalid eligibility fields supplied", "604" => "Invalid IP Address", "610" => "Failed to connect to registry, please retry", "611" => "Domain renewal/transfer failed", "612" => "Locking is not available for this domain", "614" => "Failed to lock/unlock domain", "615" => "Domain delegation failed", "700" => "Invalid Product", "701" => "Domain already exists", "888" => "Order is still being processed. Current Status", "889" => "No OrderID for this domain name was found");
public static $CONTACT_TYPES = array("Owner" => "Registrant", "Administration" => "Admin", "Technical" => "Tech", "Billing" => "Billing");
public static $CHECK_PERIOD_BEFORE_XFER = array("com.au", "net.au", "org.au", "asn.au", "id.au");
public static $CONTACT_FIELDS = array("FirstName" => "firstname", "LastName" => "lastname", "Address1" => "address1", "Address2" => "address2", "City" => "city", "Region" => "state", "PostalCode" => "postcode", "CountryCode" => "country", "Email" => "email", "PhoneNumber" => "phonenumber");
public static $TRANSFORM_CONTACT_FIELDS = array("First Name" => "FirstName", "Last Name" => "LastName", "Address 1" => "Address1", "Address 2" => "Address2", "Postcode" => "PostalCode", "Country" => "CountryCode", "Phone Number" => "PhoneNumber", "Organisation Name" => "OrganisationName", "Email Address" => "Email");
public static $ASIA_LEGAL_TYPES = array("naturalPerson" => "naturalPerson", "corporation" => "corporation", "cooperative" => "cooperative", "partnership" => "partnership", "government" => "government", "politicalParty" => "politicalParty", "society" => "society", "institution" => "institution");
public static $ASIA_IDENTITY_FORMS = array("passport" => "passport", "politicalPartyRegistry" => "politicalPartyRegistry", "societyRegistry" => "societiesRegistry", "legislation" => "legislation", "certificate" => "certificate");
public static $ELIGIBILITY_ID_TYPES = array("ACN" => 1, "ACT BN" => 2, "NSW BN" => 3, "NT BN" => 4, "QLD BN" => 5, "SA BN" => 6, "TAS BN" => 7, "VIC BN" => 8, "WA BN" => 9, "Trademark" => 10, "Other" => 11, "ABN" => 12, "Australian Company Number (ACN)" => 1, "ACT Business Number" => 2, "NSW Business Number" => 3, "NT Business Number" => 4, "QLD Business Number" => 5, "SA Business Number" => 6, "TAS Business Number" => 7, "VIC Business Number" => 8, "WA Business Number" => 9, "Trademark (TM)" => 10, "Other - Used to record an Incorporated Association number" => 11, "Australian Business Number (ABN)" => 12, "Business Registration Number" => 11);
public static $ELIGIBILITY_TYPES = array("Charity" => 1, "Citizen/Resident" => 2, "Club" => 3, "Commercial Statutory Body" => 4, "Company" => 5, "Incorporated Association" => 6, "Industry Body" => 8, "Non-profit Organisation" => 9, "Other" => 10, "Partnership" => 11, "Pending TM Owner" => 12, "Political Party" => 13, "Registered Business" => 14, "Religious/Church Group" => 15, "Sole Trader" => 16, "Trade Union" => 17, "Trademark Owner" => 18, "Child Care Centre" => 19, "Government School" => 20, "Higher Education Institution" => 21, "National Body" => 22, "Non-Government School" => 23, "Pre-school" => 24, "Research Organisation" => 25, "Training Organisation" => 26);
public static $ELIGIBILITY_REASONS = array("Domain name is an Exact Match Abbreviation or Acronym of your Entity or Trading Name." => 1, "Close and substantial connection between the domain name and the operations of your Entity." => 2);
public static function getValue($array, $key, $defaultValue)
{
}
public static function getValueConverted($array, $key, $valueMap, $defaultValue = \false)
{
}
public static function getWorkflowID($domainID)
{
}
public static function setWorkflowID($domainID, $wfID)
{
}
}
}
namespace M101Domain {
class DomainFields
{
public static $m101domain_fieldconfig = NULL;
public static function init()
{
}
}
class Domain
{
public $name = NULL;
public $status = array();
public $registrant = NULL;
public $contacts = array();
public $ns = array();
public $cr_date = NULL;
public $up_date = NULL;
public $ex_date = NULL;
public $key = NULL;
protected $lockedStatuses = array("clientTransferProhibited", "clientHold", "serverTransferProhibited", "serverHold");
public function isLocked()
{
}
}
class Host
{
public $name = NULL;
public $v4 = array();
public $v6 = array();
public $cr_date = NULL;
public $cr_id = NULL;
}
class Contact
{
public $handle = NULL;
public $first_name = NULL;
public $last_name = NULL;
public $company = NULL;
public $address1 = NULL;
public $address2 = NULL;
public $address3 = NULL;
public $city = NULL;
public $state = NULL;
public $postal = NULL;
public $country = NULL;
public $email = NULL;
public $phone = NULL;
public $phone_ext = NULL;
public $fax = NULL;
public $fax_ext = NULL;
public static $labels = array("first_name" => "First Name", "last_name" => "Last Name", "company" => "Company", "address1" => "Address 1", "address2" => "Address 2", "address3" => "Address 3", "city" => "City", "state" => "State or Province", "postal" => "Postal Code", "country" => "Country Code", "email" => "Email Address", "phone" => "Phone", "phone_ext" => "Phone Ext", "fax" => "Fax", "fax_ext" => "Fax Extension");
public function normalize()
{
}
}
}
namespace M101Domain\Exception {
class Error extends \Exception
{
}
}
namespace M101Domain {
class Result
{
public $error_code = NULL;
public $error_message = NULL;
public $reason = array();
public $resData = NULL;
public $extension = NULL;
public $xml = NULL;
}
class Cache
{
public static $cache = array();
}
}
namespace {
class ComposerAutoloaderInit323f23780403defe5009107249f44a2f
{
public static function loadClassLoader($class)
{
}
public static function getLoader()
{
}
}
}
namespace Yubico\Auth {
/**
* Class for verifying Yubico One-Time-Passcodes
*
* @category Auth
* @package Auth_Yubico
* @author Simon Josefsson <simon@yubico.com>, Olov Danielson <olov@yubico.com>
* @copyright 2007-2015 Yubico AB
* @license https://opensource.org/licenses/bsd-license.php New BSD License
* @version 2.0
* @link https://www.yubico.com/
*
* Updated by WHMCS:
* [2018-12-21]
* * Include copy of BSD license as provided in source library's COPYING file
* * Format code for PSR-1 & PSR-2 conformity
* * Rename, relocate, and namespace class for PSR-4 compatibility
* * Remove reliance on PEAR; never returns a PEAR_ERROR instance
* * Always throw exceptions for errors or failed verification
* * Update class docblock (namely usage example; leave @ annotations as-is for now)
* * Correct method docblock annotations; remove "@access" annotations
* * Remove legacy constructor arg for HTTPS
*
* Class for verifying Yubico One-Time-Passcodes
*
* @example
* <code>
* require_once 'Auth/Yubico.php';
* $otp = "ccbbddeertkrctjkkcglfndnlihhnvekchkcctif";
*
* # Generate a new id+key from https://api.yubico.com/get-api-key/
* $yubi = new \Yubico\Auth\Otp('42', 'FOOBAR=');
* try {
* $auth = $yubi->verify($otp);
* print "<p>You are authenticated!";
* } catch (\Exception $e) {
* print "<p>Authentication failed: " . $e->getMessage();
* print "<p>Debug output from server: " . $yubi->getLastResponse();
* }
* </code>
*/
class Otp
{
/**
* Status response values
*
* @link https://developers.yubico.com/OTP/Specifications/OTP_validation_protocol.html
*/
const STATUS_REPLAYED_OTP = 'REPLAYED_OTP';
const STATUS_OK = 'OK';
const STATUS_BAD_OTP = 'BAD_OTP';
const STATUS_BAD_SIGNATURE = 'BAD_SIGNATURE';
const STATUS_MISSING_PARAMETER = 'MISSING_PARAMETER';
const STATUS_NO_SUCH_CLIENT = 'NO_SUCH_CLIENT';
const STATUS_OPERATION_NOT_ALLOWED = 'OPERATION_NOT_ALLOWED';
const STATUS_BACKEND_ERROR = 'BACKEND_ERROR';
const STATUS_NOT_ENOUGH_ANSWERS = 'NOT_ENOUGH_ANSWERS';
const STATUS_REPLAYED_REQUEST = 'REPLAYED_REQUEST';
/**
* Constructor
*
* Sets up the object
* @param string $id The client identity
* @param string $key The client MAC key (optional)
* @param boolean $httpsverify Flag whether to use verify HTTPS
* server certificates (optional,
* default true)
*/
public function __construct($id, $key = '', $httpsverify = true)
{
}
/**
* @param string $message
* @return mixed
*/
protected function raiseError($message)
{
}
/**
* Specify to use a different URL part for verification.
* The default is "api.yubico.com/wsapi/verify".
*
* @param string $url New server URL part to use
*/
public function setURLpart($url)
{
}
/**
* Get next URL part from list to use for validation.
*
* @return mixed string with URL part of false if no more URLs in list
*/
public function getNextURLpart()
{
}
/**
* Resets index to URL list
*/
public function URLreset()
{
}
/**
* Add another URLpart.
*
* @param string $URLpart
*/
public function addURLpart($URLpart)
{
}
/**
* Return the last query sent to the server, if any.
*
* @return string Request to server
*/
public function getLastQuery()
{
}
/**
* Return the last data received from the server, if any.
*
* @return string Output from server
*/
public function getLastResponse()
{
}
/**
* Parse input string into password, yubikey prefix,
* ciphertext, and OTP.
*
* @param string Input string to parse
* @param string Optional delimiter re-class, default is '[:]'
* @return array|false Keyed array with fields
*/
public static function parsePasswordOTP($str, $delim = '[:]')
{
}
/**
* Parse parameters from last response
*
* example: getParameters("timestamp", "sessioncounter", "sessionuse");
*
* @param array @parameters Array with strings representing
* parameters to parse
* @return array parameter array from last response
*/
public function getParameters($parameters)
{
}
/**
* Verify Yubico OTP against multiple URLs
* Protocol specification 2.0 is used to construct validation requests
*
* @param string $token Yubico OTP
* @param int $use_timestamp 1=>send request with ×tamp=1 to
* get timestamp and session information
* in the response
* @param boolean $wait_for_all If true, wait until all
* servers responds (for debugging)
* @param string $sl Sync level in percentage between 0
* and 100 or "fast" or "secure".
* @param int $timeout Max number of seconds to wait
* for responses
* @return mixed PEAR error on error, true otherwise
*/
public function verify($token, $use_timestamp = null, $wait_for_all = false, $sl = null, $timeout = null)
{
}
}
}
namespace {
class MyOauth
{
public $twoFactorAuthentication = \NULL;
public function setTokenData($token)
{
}
public function getData($username)
{
}
public function putData($username, $data)
{
}
public function getUsers()
{
}
}
abstract class GoogleAuthenticator
{
public function __construct($totpskew = 1, $hotpskew = 10, $hotphuntvalue = 200000)
{
}
public abstract function getData($username);
public abstract function putData($username, $data);
public abstract function getUsers();
public function createEmptyData()
{
}
public function internalGetData($username)
{
}
public function internalPutData($username, $data)
{
}
public function setTokenType($username, $tokentype)
{
}
public function setUser($username, $ttype = "HOTP", $key = "", $hexkey = "")
{
}
public function hasToken($username)
{
}
public function setUserKey($username, $key)
{
}
public function deleteUser($username)
{
}
public function authenticateUser($username, $code)
{
}
public function resyncCode($username, $code1, $code2)
{
}
public function getErrorText()
{
}
public function createURL($user)
{
}
public function createBase32Key()
{
}
public function getKey($username)
{
}
public function getTokenType($username)
{
}
public function helperb322hex($b32)
{
}
public function helperhex2b32($hex)
{
}
public function oath_hotp($key, $counter)
{
}
public function oath_truncate($hash, $length = 6)
{
}
}
class qrstr
{
public static function set(&$srctab, $x, $y, $repl, $replLen = \false)
{
}
}
// maximum allowed png image width (in pixels), tune to make sure GD and PHP can handle such big images
//---- qrtools.php -----------------------------
/*
* PHP QR Code encoder
*
* Toolset, handy and debug utilites.
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
class QRtools
{
//----------------------------------------------------------------------
public static function binarize($frame)
{
}
//----------------------------------------------------------------------
public static function tcpdfBarcodeArray($code, $mode = 'QR,L', $tcPdfVersion = '4.5.037')
{
}
//----------------------------------------------------------------------
public static function clearCache()
{
}
//----------------------------------------------------------------------
public static function buildCache()
{
}
//----------------------------------------------------------------------
public static function log($outfile, $err)
{
}
//----------------------------------------------------------------------
public static function dumpMask($frame)
{
}
//----------------------------------------------------------------------
public static function markTime($markerId)
{
}
//----------------------------------------------------------------------
public static function timeBenchmark()
{
}
}
class QRspec
{
public static $capacity = array(
array(0, 0, 0, array(0, 0, 0, 0)),
array(21, 26, 0, array(7, 10, 13, 17)),
// 1
array(25, 44, 7, array(10, 16, 22, 28)),
array(29, 70, 7, array(15, 26, 36, 44)),
array(33, 100, 7, array(20, 36, 52, 64)),
array(37, 134, 7, array(26, 48, 72, 88)),
// 5
array(41, 172, 7, array(36, 64, 96, 112)),
array(45, 196, 0, array(40, 72, 108, 130)),
array(49, 242, 0, array(48, 88, 132, 156)),
array(53, 292, 0, array(60, 110, 160, 192)),
array(57, 346, 0, array(72, 130, 192, 224)),
//10
array(61, 404, 0, array(80, 150, 224, 264)),
array(65, 466, 0, array(96, 176, 260, 308)),
array(69, 532, 0, array(104, 198, 288, 352)),
array(73, 581, 3, array(120, 216, 320, 384)),
array(77, 655, 3, array(132, 240, 360, 432)),
//15
array(81, 733, 3, array(144, 280, 408, 480)),
array(85, 815, 3, array(168, 308, 448, 532)),
array(89, 901, 3, array(180, 338, 504, 588)),
array(93, 991, 3, array(196, 364, 546, 650)),
array(97, 1085, 3, array(224, 416, 600, 700)),
//20
array(101, 1156, 4, array(224, 442, 644, 750)),
array(105, 1258, 4, array(252, 476, 690, 816)),
array(109, 1364, 4, array(270, 504, 750, 900)),
array(113, 1474, 4, array(300, 560, 810, 960)),
array(117, 1588, 4, array(312, 588, 870, 1050)),
//25
array(121, 1706, 4, array(336, 644, 952, 1110)),
array(125, 1828, 4, array(360, 700, 1020, 1200)),
array(129, 1921, 3, array(390, 728, 1050, 1260)),
array(133, 2051, 3, array(420, 784, 1140, 1350)),
array(137, 2185, 3, array(450, 812, 1200, 1440)),
//30
array(141, 2323, 3, array(480, 868, 1290, 1530)),
array(145, 2465, 3, array(510, 924, 1350, 1620)),
array(149, 2611, 3, array(540, 980, 1440, 1710)),
array(153, 2761, 3, array(570, 1036, 1530, 1800)),
array(157, 2876, 0, array(570, 1064, 1590, 1890)),
//35
array(161, 3034, 0, array(600, 1120, 1680, 1980)),
array(165, 3196, 0, array(630, 1204, 1770, 2100)),
array(169, 3362, 0, array(660, 1260, 1860, 2220)),
array(173, 3532, 0, array(720, 1316, 1950, 2310)),
array(177, 3706, 0, array(750, 1372, 2040, 2430)),
);
//----------------------------------------------------------------------
public static function getDataLength($version, $level)
{
}
//----------------------------------------------------------------------
public static function getECCLength($version, $level)
{
}
//----------------------------------------------------------------------
public static function getWidth($version)
{
}
//----------------------------------------------------------------------
public static function getRemainder($version)
{
}
//----------------------------------------------------------------------
public static function getMinimumVersion($size, $level)
{
}
//######################################################################
public static $lengthTableBits = array(array(10, 12, 14), array(9, 11, 13), array(8, 16, 16), array(8, 10, 12));
//----------------------------------------------------------------------
public static function lengthIndicator($mode, $version)
{
}
//----------------------------------------------------------------------
public static function maximumWords($mode, $version)
{
}
// Error correction code -----------------------------------------------
// Table of the error correction code (Reed-Solomon block)
// See Table 12-16 (pp.30-36), JIS X0510:2004.
public static $eccTable = array(
array(array(0, 0), array(0, 0), array(0, 0), array(0, 0)),
array(array(1, 0), array(1, 0), array(1, 0), array(1, 0)),
// 1
array(array(1, 0), array(1, 0), array(1, 0), array(1, 0)),
array(array(1, 0), array(1, 0), array(2, 0), array(2, 0)),
array(array(1, 0), array(2, 0), array(2, 0), array(4, 0)),
array(array(1, 0), array(2, 0), array(2, 2), array(2, 2)),
// 5
array(array(2, 0), array(4, 0), array(4, 0), array(4, 0)),
array(array(2, 0), array(4, 0), array(2, 4), array(4, 1)),
array(array(2, 0), array(2, 2), array(4, 2), array(4, 2)),
array(array(2, 0), array(3, 2), array(4, 4), array(4, 4)),
array(array(2, 2), array(4, 1), array(6, 2), array(6, 2)),
//10
array(array(4, 0), array(1, 4), array(4, 4), array(3, 8)),
array(array(2, 2), array(6, 2), array(4, 6), array(7, 4)),
array(array(4, 0), array(8, 1), array(8, 4), array(12, 4)),
array(array(3, 1), array(4, 5), array(11, 5), array(11, 5)),
array(array(5, 1), array(5, 5), array(5, 7), array(11, 7)),
//15
array(array(5, 1), array(7, 3), array(15, 2), array(3, 13)),
array(array(1, 5), array(10, 1), array(1, 15), array(2, 17)),
array(array(5, 1), array(9, 4), array(17, 1), array(2, 19)),
array(array(3, 4), array(3, 11), array(17, 4), array(9, 16)),
array(array(3, 5), array(3, 13), array(15, 5), array(15, 10)),
//20
array(array(4, 4), array(17, 0), array(17, 6), array(19, 6)),
array(array(2, 7), array(17, 0), array(7, 16), array(34, 0)),
array(array(4, 5), array(4, 14), array(11, 14), array(16, 14)),
array(array(6, 4), array(6, 14), array(11, 16), array(30, 2)),
array(array(8, 4), array(8, 13), array(7, 22), array(22, 13)),
//25
array(array(10, 2), array(19, 4), array(28, 6), array(33, 4)),
array(array(8, 4), array(22, 3), array(8, 26), array(12, 28)),
array(array(3, 10), array(3, 23), array(4, 31), array(11, 31)),
array(array(7, 7), array(21, 7), array(1, 37), array(19, 26)),
array(array(5, 10), array(19, 10), array(15, 25), array(23, 25)),
//30
array(array(13, 3), array(2, 29), array(42, 1), array(23, 28)),
array(array(17, 0), array(10, 23), array(10, 35), array(19, 35)),
array(array(17, 1), array(14, 21), array(29, 19), array(11, 46)),
array(array(13, 6), array(14, 23), array(44, 7), array(59, 1)),
array(array(12, 7), array(12, 26), array(39, 14), array(22, 41)),
//35
array(array(6, 14), array(6, 34), array(46, 10), array(2, 64)),
array(array(17, 4), array(29, 14), array(49, 10), array(24, 46)),
array(array(4, 18), array(13, 32), array(48, 14), array(42, 32)),
array(array(20, 4), array(40, 7), array(43, 22), array(10, 67)),
array(array(19, 6), array(18, 31), array(34, 34), array(20, 61)),
);
//----------------------------------------------------------------------
// CACHEABLE!!!
public static function getEccSpec($version, $level, array &$spec)
{
}
// Alignment pattern ---------------------------------------------------
// Positions of alignment patterns.
// This array includes only the second and the third position of the
// alignment patterns. Rest of them can be calculated from the distance
// between them.
// See Table 1 in Appendix E (pp.71) of JIS X0510:2004.
public static $alignmentPattern = array(
array(0, 0),
array(0, 0),
array(18, 0),
array(22, 0),
array(26, 0),
array(30, 0),
// 1- 5
array(34, 0),
array(22, 38),
array(24, 42),
array(26, 46),
array(28, 50),
// 6-10
array(30, 54),
array(32, 58),
array(34, 62),
array(26, 46),
array(26, 48),
//11-15
array(26, 50),
array(30, 54),
array(30, 56),
array(30, 58),
array(34, 62),
//16-20
array(28, 50),
array(26, 50),
array(30, 54),
array(28, 54),
array(32, 58),
//21-25
array(30, 58),
array(34, 62),
array(26, 50),
array(30, 54),
array(26, 52),
//26-30
array(30, 56),
array(34, 60),
array(30, 58),
array(34, 62),
array(30, 54),
//31-35
array(24, 50),
array(28, 54),
array(32, 58),
array(26, 54),
array(30, 58),
);
/** --------------------------------------------------------------------
* Put an alignment marker.
* @param frame
* @param width
* @param ox,oy center coordinate of the pattern
*/
public static function putAlignmentMarker(array &$frame, $ox, $oy)
{
}
//----------------------------------------------------------------------
public static function putAlignmentPattern($version, &$frame, $width)
{
}
// Version information pattern -----------------------------------------
// Version information pattern (BCH coded).
// See Table 1 in Appendix D (pp.68) of JIS X0510:2004.
// size: [QRSPEC_VERSION_MAX - 6]
public static $versionPattern = array(0x7c94, 0x85bc, 0x9a99, 0xa4d3, 0xbbf6, 0xc762, 0xd847, 0xe60d, 0xf928, 0x10b78, 0x1145d, 0x12a17, 0x13532, 0x149a6, 0x15683, 0x168c9, 0x177ec, 0x18ec4, 0x191e1, 0x1afab, 0x1b08e, 0x1cc1a, 0x1d33f, 0x1ed75, 0x1f250, 0x209d5, 0x216f0, 0x228ba, 0x2379f, 0x24b0b, 0x2542e, 0x26a64, 0x27541, 0x28c69);
//----------------------------------------------------------------------
public static function getVersionPattern($version)
{
}
// Format information --------------------------------------------------
// See calcFormatInfo in tests/test_qrspec.c (orginal qrencode c lib)
public static $formatInfo = array(array(0x77c4, 0x72f3, 0x7daa, 0x789d, 0x662f, 0x6318, 0x6c41, 0x6976), array(0x5412, 0x5125, 0x5e7c, 0x5b4b, 0x45f9, 0x40ce, 0x4f97, 0x4aa0), array(0x355f, 0x3068, 0x3f31, 0x3a06, 0x24b4, 0x2183, 0x2eda, 0x2bed), array(0x1689, 0x13be, 0x1ce7, 0x19d0, 0x762, 0x255, 0xd0c, 0x83b));
public static function getFormatInfo($mask, $level)
{
}
// Frame ---------------------------------------------------------------
// Cache of initial frames.
public static $frames = array();
/** --------------------------------------------------------------------
* Put a finder pattern.
* @param frame
* @param width
* @param ox,oy upper-left coordinate of the pattern
*/
public static function putFinderPattern(&$frame, $ox, $oy)
{
}
//----------------------------------------------------------------------
public static function createFrame($version)
{
}
//----------------------------------------------------------------------
public static function debug($frame, $binary_mode = \false)
{
}
//----------------------------------------------------------------------
public static function serial($frame)
{
}
//----------------------------------------------------------------------
public static function unserial($code)
{
}
//----------------------------------------------------------------------
public static function newFrame($version)
{
}
//----------------------------------------------------------------------
public static function rsBlockNum($spec)
{
}
public static function rsBlockNum1($spec)
{
}
public static function rsDataCodes1($spec)
{
}
public static function rsEccCodes1($spec)
{
}
public static function rsBlockNum2($spec)
{
}
public static function rsDataCodes2($spec)
{
}
public static function rsEccCodes2($spec)
{
}
public static function rsDataLength($spec)
{
}
public static function rsEccLength($spec)
{
}
}
class QRimage
{
//----------------------------------------------------------------------
public static function png($frame, $filename = \false, $pixelPerPoint = 4, $outerFrame = 4, $saveandprint = \FALSE)
{
}
//----------------------------------------------------------------------
public static function jpg($frame, $filename = \false, $pixelPerPoint = 8, $outerFrame = 4, $q = 85)
{
}
}
class QRinputItem
{
public $mode;
public $size;
public $data;
public $bstream;
public function __construct($mode, $size, $data, $bstream = \null)
{
}
//----------------------------------------------------------------------
public function encodeModeNum($version)
{
}
//----------------------------------------------------------------------
public function encodeModeAn($version)
{
}
//----------------------------------------------------------------------
public function encodeMode8($version)
{
}
//----------------------------------------------------------------------
public function encodeModeKanji($version)
{
}
//----------------------------------------------------------------------
public function encodeModeStructure()
{
}
//----------------------------------------------------------------------
public function estimateBitStreamSizeOfEntry($version)
{
}
//----------------------------------------------------------------------
public function encodeBitStream($version)
{
}
}
//##########################################################################
class QRinput
{
public $items;
//----------------------------------------------------------------------
public function __construct($version = 0, $level = \QR_ECLEVEL_L)
{
}
//----------------------------------------------------------------------
public function getVersion()
{
}
//----------------------------------------------------------------------
public function setVersion($version)
{
}
//----------------------------------------------------------------------
public function getErrorCorrectionLevel()
{
}
//----------------------------------------------------------------------
public function setErrorCorrectionLevel($level)
{
}
//----------------------------------------------------------------------
public function appendEntry(\QRinputItem $entry)
{
}
//----------------------------------------------------------------------
public function append($mode, $size, $data)
{
}
//----------------------------------------------------------------------
public function insertStructuredAppendHeader($size, $index, $parity)
{
}
//----------------------------------------------------------------------
public function calcParity()
{
}
//----------------------------------------------------------------------
public static function checkModeNum($size, $data)
{
}
//----------------------------------------------------------------------
public static function estimateBitsModeNum($size)
{
}
//----------------------------------------------------------------------
public static $anTable = array(-1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, 36, -1, -1, -1, 37, 38, -1, -1, -1, -1, 39, 40, -1, 41, 42, 43, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 44, -1, -1, -1, -1, -1, -1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1, -1);
//----------------------------------------------------------------------
public static function lookAnTable($c)
{
}
//----------------------------------------------------------------------
public static function checkModeAn($size, $data)
{
}
//----------------------------------------------------------------------
public static function estimateBitsModeAn($size)
{
}
//----------------------------------------------------------------------
public static function estimateBitsMode8($size)
{
}
//----------------------------------------------------------------------
public static function estimateBitsModeKanji($size)
{
}
//----------------------------------------------------------------------
public static function checkModeKanji($size, $data)
{
}
/***********************************************************************
* Validation
**********************************************************************/
public static function check($mode, $size, $data)
{
}
//----------------------------------------------------------------------
public function estimateBitStreamSize($version)
{
}
//----------------------------------------------------------------------
public function estimateVersion()
{
}
//----------------------------------------------------------------------
public static function lengthOfCode($mode, $version, $bits)
{
}
//----------------------------------------------------------------------
public function createBitStream()
{
}
//----------------------------------------------------------------------
public function convertData()
{
}
//----------------------------------------------------------------------
public function appendPaddingBit(&$bstream)
{
}
//----------------------------------------------------------------------
public function mergeBitStream()
{
}
//----------------------------------------------------------------------
public function getBitStream()
{
}
//----------------------------------------------------------------------
public function getByteStream()
{
}
}
//---- qrbitstream.php -----------------------------
/*
* PHP QR Code encoder
*
* Bitstream class
*
* Based on libqrencode C library distributed under LGPL 2.1
* Copyright (C) 2006, 2007, 2008, 2009 Kentaro Fukuchi <fukuchi@megaui.net>
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
class QRbitstream
{
public $data = array();
//----------------------------------------------------------------------
public function size()
{
}
//----------------------------------------------------------------------
public function allocate($setLength)
{
}
//----------------------------------------------------------------------
public static function newFromNum($bits, $num)
{
}
//----------------------------------------------------------------------
public static function newFromBytes($size, $data)
{
}
//----------------------------------------------------------------------
public function append(\QRbitstream $arg)
{
}
//----------------------------------------------------------------------
public function appendNum($bits, $num)
{
}
//----------------------------------------------------------------------
public function appendBytes($size, $data)
{
}
//----------------------------------------------------------------------
public function toByte()
{
}
}
//---- qrsplit.php -----------------------------
/*
* PHP QR Code encoder
*
* Input splitting classes
*
* Based on libqrencode C library distributed under LGPL 2.1
* Copyright (C) 2006, 2007, 2008, 2009 Kentaro Fukuchi <fukuchi@megaui.net>
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* The following data / specifications are taken from
* "Two dimensional symbol -- QR-code -- Basic Specification" (JIS X0510:2004)
* or
* "Automatic identification and data capture techniques --
* QR Code 2005 bar code symbology specification" (ISO/IEC 18004:2006)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
class QRsplit
{
public $dataStr = '';
public $input;
public $modeHint;
//----------------------------------------------------------------------
public function __construct($dataStr, $input, $modeHint)
{
}
//----------------------------------------------------------------------
public static function isdigitat($str, $pos)
{
}
//----------------------------------------------------------------------
public static function isalnumat($str, $pos)
{
}
//----------------------------------------------------------------------
public function identifyMode($pos)
{
}
//----------------------------------------------------------------------
public function eatNum()
{
}
//----------------------------------------------------------------------
public function eatAn()
{
}
//----------------------------------------------------------------------
public function eatKanji()
{
}
//----------------------------------------------------------------------
public function eat8()
{
}
//----------------------------------------------------------------------
public function splitString()
{
}
//----------------------------------------------------------------------
public function toUpper()
{
}
//----------------------------------------------------------------------
public static function splitStringToQRinput($string, \QRinput $input, $modeHint, $casesensitive = \true)
{
}
}
//---- qrrscode.php -----------------------------
/*
* PHP QR Code encoder
*
* Reed-Solomon error correction support
*
* Copyright (C) 2002, 2003, 2004, 2006 Phil Karn, KA9Q
* (libfec is released under the GNU Lesser General Public License.)
*
* Based on libqrencode C library distributed under LGPL 2.1
* Copyright (C) 2006, 2007, 2008, 2009 Kentaro Fukuchi <fukuchi@megaui.net>
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
class QRrsItem
{
public $mm;
// Bits per symbol
public $nn;
// Symbols per block (= (1<<mm)-1)
public $alpha_to = array();
// log lookup table
public $index_of = array();
// Antilog lookup table
public $genpoly = array();
// Generator polynomial
public $nroots;
// Number of generator roots = number of parity symbols
public $fcr;
// First consecutive root, index form
public $prim;
// Primitive element, index form
public $iprim;
// prim-th root of 1, index form
public $pad;
// Padding bytes in shortened block
public $gfpoly;
//----------------------------------------------------------------------
public function modnn($x)
{
}
//----------------------------------------------------------------------
public static function init_rs_char($symsize, $gfpoly, $fcr, $prim, $nroots, $pad)
{
}
//----------------------------------------------------------------------
public function encode_rs_char($data, &$parity)
{
}
}
//##########################################################################
class QRrs
{
public static $items = array();
//----------------------------------------------------------------------
public static function init_rs($symsize, $gfpoly, $fcr, $prim, $nroots, $pad)
{
}
}
class QRmask
{
public $runLength = array();
//----------------------------------------------------------------------
public function __construct()
{
}
//----------------------------------------------------------------------
public function writeFormatInformation($width, &$frame, $mask, $level)
{
}
//----------------------------------------------------------------------
public function mask0($x, $y)
{
}
public function mask1($x, $y)
{
}
public function mask2($x, $y)
{
}
public function mask3($x, $y)
{
}
public function mask4($x, $y)
{
}
public function mask5($x, $y)
{
}
public function mask6($x, $y)
{
}
public function mask7($x, $y)
{
}
//----------------------------------------------------------------------
public static function serial($bitFrame)
{
}
//----------------------------------------------------------------------
public static function unserial($code)
{
}
//----------------------------------------------------------------------
public function makeMaskNo($maskNo, $width, $s, &$d, $maskGenOnly = \false)
{
}
//----------------------------------------------------------------------
public function makeMask($width, $frame, $maskNo, $level)
{
}
//----------------------------------------------------------------------
public function calcN1N3($length)
{
}
//----------------------------------------------------------------------
public function evaluateSymbol($width, $frame)
{
}
//----------------------------------------------------------------------
public function mask($width, $frame, $level)
{
}
//----------------------------------------------------------------------
}
//---- qrencode.php -----------------------------
/*
* PHP QR Code encoder
*
* Main encoder classes.
*
* Based on libqrencode C library distributed under LGPL 2.1
* Copyright (C) 2006, 2007, 2008, 2009 Kentaro Fukuchi <fukuchi@megaui.net>
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
class QRrsblock
{
public $dataLength;
public $data = array();
public $eccLength;
public $ecc = array();
public function __construct($dl, $data, $el, &$ecc, \QRrsItem $rs)
{
}
}
//##########################################################################
class QRrawcode
{
public $version;
public $datacode = array();
public $ecccode = array();
public $blocks;
public $rsblocks = array();
//of RSblock
public $count;
public $dataLength;
public $eccLength;
public $b1;
//----------------------------------------------------------------------
public function __construct(\QRinput $input)
{
}
//----------------------------------------------------------------------
public function init(array $spec)
{
}
//----------------------------------------------------------------------
public function getCode()
{
}
}
//##########################################################################
class QRcode
{
public $version;
public $width;
public $data;
//----------------------------------------------------------------------
public function encodeMask(\QRinput $input, $mask)
{
}
//----------------------------------------------------------------------
public function encodeInput(\QRinput $input)
{
}
//----------------------------------------------------------------------
public function encodeString8bit($string, $version, $level)
{
}
//----------------------------------------------------------------------
public function encodeString($string, $version, $level, $hint, $casesensitive)
{
}
//----------------------------------------------------------------------
public static function png($text, $outfile = \false, $level = \QR_ECLEVEL_L, $size = 3, $margin = 4, $saveandprint = \false)
{
}
//----------------------------------------------------------------------
public static function text($text, $outfile = \false, $level = \QR_ECLEVEL_L, $size = 3, $margin = 4)
{
}
//----------------------------------------------------------------------
public static function raw($text, $outfile = \false, $level = \QR_ECLEVEL_L, $size = 3, $margin = 4)
{
}
}
//##########################################################################
class FrameFiller
{
public $width;
public $frame;
public $x;
public $y;
public $dir;
public $bit;
//----------------------------------------------------------------------
public function __construct($width, &$frame)
{
}
//----------------------------------------------------------------------
public function setFrameAt($at, $val)
{
}
//----------------------------------------------------------------------
public function getFrameAt($at)
{
}
//----------------------------------------------------------------------
public function next()
{
}
}
//##########################################################################
class QRencode
{
public $casesensitive = \true;
public $eightbit = \false;
public $version = 0;
public $size = 3;
public $margin = 4;
public $structured = 0;
// not supported yet
public $level = \QR_ECLEVEL_L;
public $hint = \QR_MODE_8;
//----------------------------------------------------------------------
public static function factory($level = \QR_ECLEVEL_L, $size = 3, $margin = 4)
{
}
//----------------------------------------------------------------------
public function encodeRAW($intext, $outfile = \false)
{
}
//----------------------------------------------------------------------
public function encode($intext, $outfile = \false)
{
}
//----------------------------------------------------------------------
public function encodePNG($intext, $outfile = \false, $saveandprint = \false)
{
}
}
}
namespace Carbon {
/**
* A simple API extension for DateInterval.
* The implemenation provides helpers to handle weeks but only days are saved.
* Weeks are calculated based on the total days of the current instance.
*
* @property int $years Total years of the current interval.
* @property int $months Total months of the current interval.
* @property int $weeks Total weeks of the current interval calculated from the days.
* @property int $dayz Total days of the current interval (weeks * 7 + days).
* @property int $hours Total hours of the current interval.
* @property int $minutes Total minutes of the current interval.
* @property int $seconds Total seconds of the current interval.
*
* @property-read integer $dayzExcludeWeeks Total days remaining in the final week of the current instance (days % 7).
* @property-read integer $daysExcludeWeeks alias of dayzExcludeWeeks
*
* @method static CarbonInterval years($years = 1) Create instance specifying a number of years.
* @method static CarbonInterval year($years = 1) Alias for years()
* @method static CarbonInterval months($months = 1) Create instance specifying a number of months.
* @method static CarbonInterval month($months = 1) Alias for months()
* @method static CarbonInterval weeks($weeks = 1) Create instance specifying a number of weeks.
* @method static CarbonInterval week($weeks = 1) Alias for weeks()
* @method static CarbonInterval days($days = 1) Create instance specifying a number of days.
* @method static CarbonInterval dayz($days = 1) Alias for days()
* @method static CarbonInterval day($days = 1) Alias for days()
* @method static CarbonInterval hours($hours = 1) Create instance specifying a number of hours.
* @method static CarbonInterval hour($hours = 1) Alias for hours()
* @method static CarbonInterval minutes($minutes = 1) Create instance specifying a number of minutes.
* @method static CarbonInterval minute($minutes = 1) Alias for minutes()
* @method static CarbonInterval seconds($seconds = 1) Create instance specifying a number of seconds.
* @method static CarbonInterval second($seconds = 1) Alias for seconds()
* @method CarbonInterval years() years($years = 1) Set the years portion of the current interval.
* @method CarbonInterval year() year($years = 1) Alias for years().
* @method CarbonInterval months() months($months = 1) Set the months portion of the current interval.
* @method CarbonInterval month() month($months = 1) Alias for months().
* @method CarbonInterval weeks() weeks($weeks = 1) Set the weeks portion of the current interval. Will overwrite dayz value.
* @method CarbonInterval week() week($weeks = 1) Alias for weeks().
* @method CarbonInterval days() days($days = 1) Set the days portion of the current interval.
* @method CarbonInterval dayz() dayz($days = 1) Alias for days().
* @method CarbonInterval day() day($days = 1) Alias for days().
* @method CarbonInterval hours() hours($hours = 1) Set the hours portion of the current interval.
* @method CarbonInterval hour() hour($hours = 1) Alias for hours().
* @method CarbonInterval minutes() minutes($minutes = 1) Set the minutes portion of the current interval.
* @method CarbonInterval minute() minute($minutes = 1) Alias for minutes().
* @method CarbonInterval seconds() seconds($seconds = 1) Set the seconds portion of the current interval.
* @method CarbonInterval second() second($seconds = 1) Alias for seconds().
*/
class CarbonInterval extends \DateInterval
{
/**
* Interval spec period designators
*/
const PERIOD_PREFIX = 'P';
const PERIOD_YEARS = 'Y';
const PERIOD_MONTHS = 'M';
const PERIOD_DAYS = 'D';
const PERIOD_TIME_PREFIX = 'T';
const PERIOD_HOURS = 'H';
const PERIOD_MINUTES = 'M';
const PERIOD_SECONDS = 'S';
/**
* A translator to ... er ... translate stuff
*
* @var TranslatorInterface
*/
protected static $translator;
/**
* Before PHP 5.4.20/5.5.4 instead of FALSE days will be set to -99999 when the interval instance
* was created by DateTime:diff().
*/
const PHP_DAYS_FALSE = -99999;
///////////////////////////////////////////////////////////////////
//////////////////////////// CONSTRUCTORS /////////////////////////
///////////////////////////////////////////////////////////////////
/**
* Create a new CarbonInterval instance.
*
* @param int $years
* @param int $months
* @param int $weeks
* @param int $days
* @param int $hours
* @param int $minutes
* @param int $seconds
*/
public function __construct($years = 1, $months = null, $weeks = null, $days = null, $hours = null, $minutes = null, $seconds = null)
{
}
/**
* Create a new CarbonInterval instance from specific values.
* This is an alias for the constructor that allows better fluent
* syntax as it allows you to do CarbonInterval::create(1)->fn() rather than
* (new CarbonInterval(1))->fn().
*
* @param int $years
* @param int $months
* @param int $weeks
* @param int $days
* @param int $hours
* @param int $minutes
* @param int $seconds
*
* @return static
*/
public static function create($years = 1, $months = null, $weeks = null, $days = null, $hours = null, $minutes = null, $seconds = null)
{
}
/**
* Provide static helpers to create instances. Allows CarbonInterval::years(3).
*
* Note: This is done using the magic method to allow static and instance methods to
* have the same names.
*
* @param string $name
* @param array $args
*
* @return static
*/
public static function __callStatic($name, $args)
{
}
/**
* Create a CarbonInterval instance from a DateInterval one. Can not instance
* DateInterval objects created from DateTime::diff() as you can't externally
* set the $days field.
*
* @param DateInterval $di
*
* @throws InvalidArgumentException
*
* @return static
*/
public static function instance(\DateInterval $di)
{
}
///////////////////////////////////////////////////////////////////
/////////////////////// LOCALIZATION //////////////////////////////
///////////////////////////////////////////////////////////////////
/**
* Intialize the translator instance if necessary.
*
* @return TranslatorInterface
*/
protected static function translator()
{
}
/**
* Get the translator instance in use
*
* @return TranslatorInterface
*/
public static function getTranslator()
{
}
/**
* Set the translator instance to use
*
* @param TranslatorInterface $translator
*/
public static function setTranslator(\Symfony\Component\Translation\TranslatorInterface $translator)
{
}
/**
* Get the current translator locale
*
* @return string
*/
public static function getLocale()
{
}
/**
* Set the current translator locale
*
* @param string $locale
*/
public static function setLocale($locale)
{
}
///////////////////////////////////////////////////////////////////
///////////////////////// GETTERS AND SETTERS /////////////////////
///////////////////////////////////////////////////////////////////
/**
* Get a part of the CarbonInterval object
*
* @param string $name
*
* @throws InvalidArgumentException
*
* @return int
*/
public function __get($name)
{
}
/**
* Set a part of the CarbonInterval object
*
* @param string $name
* @param int $val
*
* @throws InvalidArgumentException
*/
public function __set($name, $val)
{
}
/**
* Allow setting of weeks and days to be cumulative.
*
* @param int $weeks Number of weeks to set
* @param int $days Number of days to set
*
* @return static
*/
public function weeksAndDays($weeks, $days)
{
}
/**
* Allow fluent calls on the setters... CarbonInterval::years(3)->months(5)->day().
*
* Note: This is done using the magic method to allow static and instance methods to
* have the same names.
*
* @param string $name
* @param array $args
*
* @return static
*/
public function __call($name, $args)
{
}
/**
* Get the current interval in a human readable format in the current locale.
*
* @return string
*/
public function forHumans()
{
}
/**
* Format the instance as a string using the forHumans() function.
*
* @return string
*/
public function __toString()
{
}
/**
* Add the passed interval to the current instance
*
* @param DateInterval $interval
*
* @return static
*/
public function add(\DateInterval $interval)
{
}
}
/**
* A simple API extension for DateTime
*
* @property int $year
* @property int $yearIso
* @property int $month
* @property int $day
* @property int $hour
* @property int $minute
* @property int $second
* @property int $timestamp seconds since the Unix Epoch
* @property DateTimeZone $timezone the current timezone
* @property DateTimeZone $tz alias of timezone
* @property-read integer $micro
* @property-read integer $dayOfWeek 0 (for Sunday) through 6 (for Saturday)
* @property-read integer $dayOfYear 0 through 365
* @property-read integer $weekOfMonth 1 through 5
* @property-read integer $weekOfYear ISO-8601 week number of year, weeks starting on Monday
* @property-read integer $daysInMonth number of days in the given month
* @property-read integer $age does a diffInYears() with default parameters
* @property-read integer $quarter the quarter of this instance, 1 - 4
* @property-read integer $offset the timezone offset in seconds from UTC
* @property-read integer $offsetHours the timezone offset in hours from UTC
* @property-read boolean $dst daylight savings time indicator, true if DST, false otherwise
* @property-read boolean $local checks if the timezone is local, true if local, false otherwise
* @property-read boolean $utc checks if the timezone is UTC, true if UTC, false otherwise
* @property-read string $timezoneName
* @property-read string $tzName
*/
class Carbon extends \DateTime
{
/**
* The day constants
*/
const SUNDAY = 0;
const MONDAY = 1;
const TUESDAY = 2;
const WEDNESDAY = 3;
const THURSDAY = 4;
const FRIDAY = 5;
const SATURDAY = 6;
/**
* Names of days of the week.
*
* @var array
*/
protected static $days = array(self::SUNDAY => 'Sunday', self::MONDAY => 'Monday', self::TUESDAY => 'Tuesday', self::WEDNESDAY => 'Wednesday', self::THURSDAY => 'Thursday', self::FRIDAY => 'Friday', self::SATURDAY => 'Saturday');
/**
* Terms used to detect if a time passed is a relative date for testing purposes
*
* @var array
*/
protected static $relativeKeywords = array('this', 'next', 'last', 'tomorrow', 'yesterday', '+', '-', 'first', 'last', 'ago');
/**
* Number of X in Y
*/
const YEARS_PER_CENTURY = 100;
const YEARS_PER_DECADE = 10;
const MONTHS_PER_YEAR = 12;
const WEEKS_PER_YEAR = 52;
const DAYS_PER_WEEK = 7;
const HOURS_PER_DAY = 24;
const MINUTES_PER_HOUR = 60;
const SECONDS_PER_MINUTE = 60;
/**
* Default format to use for __toString method when type juggling occurs.
*
* @var string
*/
const DEFAULT_TO_STRING_FORMAT = 'Y-m-d H:i:s';
/**
* Format to use for __toString method when type juggling occurs.
*
* @var string
*/
protected static $toStringFormat = self::DEFAULT_TO_STRING_FORMAT;
/**
* First day of week
*
* @var int
*/
protected static $weekStartsAt = self::MONDAY;
/**
* Last day of week
*
* @var int
*/
protected static $weekEndsAt = self::SUNDAY;
/**
* Days of weekend
*
* @var array
*/
protected static $weekendDays = array(self::SATURDAY, self::SUNDAY);
/**
* A test Carbon instance to be returned when now instances are created
*
* @var Carbon
*/
protected static $testNow;
/**
* A translator to ... er ... translate stuff
*
* @var TranslatorInterface
*/
protected static $translator;
/**
* Creates a DateTimeZone from a string or a DateTimeZone
*
* @param DateTimeZone|string|null $object
*
* @throws InvalidArgumentException
*
* @return DateTimeZone
*/
protected static function safeCreateDateTimeZone($object)
{
}
///////////////////////////////////////////////////////////////////
//////////////////////////// CONSTRUCTORS /////////////////////////
///////////////////////////////////////////////////////////////////
/**
* Create a new Carbon instance.
*
* Please see the testing aids section (specifically static::setTestNow())
* for more on the possibility of this constructor returning a test instance.
*
* @param string|null $time
* @param DateTimeZone|string|null $tz
*/
public function __construct($time = null, $tz = null)
{
}
/**
* Create a Carbon instance from a DateTime one
*
* @param DateTime $dt
*
* @return static
*/
public static function instance(\DateTime $dt)
{
}
/**
* Create a carbon instance from a string. This is an alias for the
* constructor that allows better fluent syntax as it allows you to do
* Carbon::parse('Monday next week')->fn() rather than
* (new Carbon('Monday next week'))->fn()
*
* @param string|null $time
* @param DateTimeZone|string|null $tz
*
* @return static
*/
public static function parse($time = null, $tz = null)
{
}
/**
* Get a Carbon instance for the current date and time
*
* @param DateTimeZone|string|null $tz
*
* @return static
*/
public static function now($tz = null)
{
}
/**
* Create a Carbon instance for today
*
* @param DateTimeZone|string|null $tz
*
* @return static
*/
public static function today($tz = null)
{
}
/**
* Create a Carbon instance for tomorrow
*
* @param DateTimeZone|string|null $tz
*
* @return static
*/
public static function tomorrow($tz = null)
{
}
/**
* Create a Carbon instance for yesterday
*
* @param DateTimeZone|string|null $tz
*
* @return static
*/
public static function yesterday($tz = null)
{
}
/**
* Create a Carbon instance for the greatest supported date.
*
* @return Carbon
*/
public static function maxValue()
{
}
/**
* Create a Carbon instance for the lowest supported date.
*
* @return Carbon
*/
public static function minValue()
{
}
/**
* Create a new Carbon instance from a specific date and time.
*
* If any of $year, $month or $day are set to null their now() values
* will be used.
*
* If $hour is null it will be set to its now() value and the default values
* for $minute and $second will be their now() values.
* If $hour is not null then the default values for $minute and $second
* will be 0.
*
* @param int|null $year
* @param int|null $month
* @param int|null $day
* @param int|null $hour
* @param int|null $minute
* @param int|null $second
* @param DateTimeZone|string|null $tz
*
* @return static
*/
public static function create($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $tz = null)
{
}
/**
* Create a Carbon instance from just a date. The time portion is set to now.
*
* @param int|null $year
* @param int|null $month
* @param int|null $day
* @param DateTimeZone|string|null $tz
*
* @return static
*/
public static function createFromDate($year = null, $month = null, $day = null, $tz = null)
{
}
/**
* Create a Carbon instance from just a time. The date portion is set to today.
*
* @param int|null $hour
* @param int|null $minute
* @param int|null $second
* @param DateTimeZone|string|null $tz
*
* @return static
*/
public static function createFromTime($hour = null, $minute = null, $second = null, $tz = null)
{
}
/**
* Create a Carbon instance from a specific format
*
* @param string $format
* @param string $time
* @param DateTimeZone|string|null $tz
*
* @throws InvalidArgumentException
*
* @return static
*/
public static function createFromFormat($format, $time, $tz = null)
{
}
/**
* Create a Carbon instance from a timestamp
*
* @param int $timestamp
* @param DateTimeZone|string|null $tz
*
* @return static
*/
public static function createFromTimestamp($timestamp, $tz = null)
{
}
/**
* Create a Carbon instance from an UTC timestamp
*
* @param int $timestamp
*
* @return static
*/
public static function createFromTimestampUTC($timestamp)
{
}
/**
* Get a copy of the instance
*
* @return static
*/
public function copy()
{
}
///////////////////////////////////////////////////////////////////
///////////////////////// GETTERS AND SETTERS /////////////////////
///////////////////////////////////////////////////////////////////
/**
* Get a part of the Carbon object
*
* @param string $name
*
* @throws InvalidArgumentException
*
* @return string|int|DateTimeZone
*/
public function __get($name)
{
}
/**
* Check if an attribute exists on the object
*
* @param string $name
*
* @return bool
*/
public function __isset($name)
{
}
/**
* Set a part of the Carbon object
*
* @param string $name
* @param string|int|DateTimeZone $value
*
* @throws InvalidArgumentException
*/
public function __set($name, $value)
{
}
/**
* Set the instance's year
*
* @param int $value
*
* @return static
*/
public function year($value)
{
}
/**
* Set the instance's month
*
* @param int $value
*
* @return static
*/
public function month($value)
{
}
/**
* Set the instance's day
*
* @param int $value
*
* @return static
*/
public function day($value)
{
}
/**
* Set the instance's hour
*
* @param int $value
*
* @return static
*/
public function hour($value)
{
}
/**
* Set the instance's minute
*
* @param int $value
*
* @return static
*/
public function minute($value)
{
}
/**
* Set the instance's second
*
* @param int $value
*
* @return static
*/
public function second($value)
{
}
/**
* Set the date and time all together
*
* @param int $year
* @param int $month
* @param int $day
* @param int $hour
* @param int $minute
* @param int $second
*
* @return static
*/
public function setDateTime($year, $month, $day, $hour, $minute, $second = 0)
{
}
/**
* Set the time by time string
*
* @param string $time
*
* @return static
*/
public function setTimeFromTimeString($time)
{
}
/**
* Set the instance's timestamp
*
* @param int $value
*
* @return static
*/
public function timestamp($value)
{
}
/**
* Alias for setTimezone()
*
* @param DateTimeZone|string $value
*
* @return static
*/
public function timezone($value)
{
}
/**
* Alias for setTimezone()
*
* @param DateTimeZone|string $value
*
* @return static
*/
public function tz($value)
{
}
/**
* Set the instance's timezone from a string or object
*
* @param DateTimeZone|string $value
*
* @return static
*/
public function setTimezone($value)
{
}
///////////////////////////////////////////////////////////////////
/////////////////////// WEEK SPECIAL DAYS /////////////////////////
///////////////////////////////////////////////////////////////////
/**
* Get the first day of week
*
* @return int
*/
public static function getWeekStartsAt()
{
}
/**
* Set the first day of week
*
* @param int
*/
public static function setWeekStartsAt($day)
{
}
/**
* Get the last day of week
*
* @return int
*/
public static function getWeekEndsAt()
{
}
/**
* Set the first day of week
*
* @param int
*/
public static function setWeekEndsAt($day)
{
}
/**
* Get weekend days
*
* @return array
*/
public static function getWeekendDays()
{
}
/**
* Set weekend days
*
* @param array
*/
public static function setWeekendDays($days)
{
}
///////////////////////////////////////////////////////////////////
///////////////////////// TESTING AIDS ////////////////////////////
///////////////////////////////////////////////////////////////////
/**
* Set a Carbon instance (real or mock) to be returned when a "now"
* instance is created. The provided instance will be returned
* specifically under the following conditions:
* - A call to the static now() method, ex. Carbon::now()
* - When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null)
* - When the string "now" is passed to the constructor or parse(), ex. new Carbon('now')
*
* Note the timezone parameter was left out of the examples above and
* has no affect as the mock value will be returned regardless of its value.
*
* To clear the test instance call this method using the default
* parameter of null.
*
* @param Carbon|null $testNow
*/
public static function setTestNow(\Carbon\Carbon $testNow = null)
{
}
/**
* Get the Carbon instance (real or mock) to be returned when a "now"
* instance is created.
*
* @return static the current instance used for testing
*/
public static function getTestNow()
{
}
/**
* Determine if there is a valid test instance set. A valid test instance
* is anything that is not null.
*
* @return bool true if there is a test instance, otherwise false
*/
public static function hasTestNow()
{
}
/**
* Determine if there is a relative keyword in the time string, this is to
* create dates relative to now for test instances. e.g.: next tuesday
*
* @param string $time
*
* @return bool true if there is a keyword, otherwise false
*/
public static function hasRelativeKeywords($time)
{
}
///////////////////////////////////////////////////////////////////
/////////////////////// LOCALIZATION //////////////////////////////
///////////////////////////////////////////////////////////////////
/**
* Intialize the translator instance if necessary.
*
* @return TranslatorInterface
*/
protected static function translator()
{
}
/**
* Get the translator instance in use
*
* @return TranslatorInterface
*/
public static function getTranslator()
{
}
/**
* Set the translator instance to use
*
* @param TranslatorInterface $translator
*/
public static function setTranslator(\Symfony\Component\Translation\TranslatorInterface $translator)
{
}
/**
* Get the current translator locale
*
* @return string
*/
public static function getLocale()
{
}
/**
* Set the current translator locale
*
* @param string $locale
*/
public static function setLocale($locale)
{
}
///////////////////////////////////////////////////////////////////
/////////////////////// STRING FORMATTING /////////////////////////
///////////////////////////////////////////////////////////////////
/**
* Format the instance with the current locale. You can set the current
* locale using setlocale() http://php.net/setlocale.
*
* @param string $format
*
* @return string
*/
public function formatLocalized($format)
{
}
/**
* Reset the format used to the default when type juggling a Carbon instance to a string
*/
public static function resetToStringFormat()
{
}
/**
* Set the default format used when type juggling a Carbon instance to a string
*
* @param string $format
*/
public static function setToStringFormat($format)
{
}
/**
* Format the instance as a string using the set format
*
* @return string
*/
public function __toString()
{
}
/**
* Format the instance as date
*
* @return string
*/
public function toDateString()
{
}
/**
* Format the instance as a readable date
*
* @return string
*/
public function toFormattedDateString()
{
}
/**
* Format the instance as time
*
* @return string
*/
public function toTimeString()
{
}
/**
* Format the instance as date and time
*
* @return string
*/
public function toDateTimeString()
{
}
/**
* Format the instance with day, date and time
*
* @return string
*/
public function toDayDateTimeString()
{
}
/**
* Format the instance as ATOM
*
* @return string
*/
public function toAtomString()
{
}
/**
* Format the instance as COOKIE
*
* @return string
*/
public function toCookieString()
{
}
/**
* Format the instance as ISO8601
*
* @return string
*/
public function toIso8601String()
{
}
/**
* Format the instance as RFC822
*
* @return string
*/
public function toRfc822String()
{
}
/**
* Format the instance as RFC850
*
* @return string
*/
public function toRfc850String()
{
}
/**
* Format the instance as RFC1036
*
* @return string
*/
public function toRfc1036String()
{
}
/**
* Format the instance as RFC1123
*
* @return string
*/
public function toRfc1123String()
{
}
/**
* Format the instance as RFC2822
*
* @return string
*/
public function toRfc2822String()
{
}
/**
* Format the instance as RFC3339
*
* @return string
*/
public function toRfc3339String()
{
}
/**
* Format the instance as RSS
*
* @return string
*/
public function toRssString()
{
}
/**
* Format the instance as W3C
*
* @return string
*/
public function toW3cString()
{
}
///////////////////////////////////////////////////////////////////
////////////////////////// COMPARISONS ////////////////////////////
///////////////////////////////////////////////////////////////////
/**
* Determines if the instance is equal to another
*
* @param Carbon $dt
*
* @return bool
*/
public function eq(\Carbon\Carbon $dt)
{
}
/**
* Determines if the instance is not equal to another
*
* @param Carbon $dt
*
* @return bool
*/
public function ne(\Carbon\Carbon $dt)
{
}
/**
* Determines if the instance is greater (after) than another
*
* @param Carbon $dt
*
* @return bool
*/
public function gt(\Carbon\Carbon $dt)
{
}
/**
* Determines if the instance is greater (after) than or equal to another
*
* @param Carbon $dt
*
* @return bool
*/
public function gte(\Carbon\Carbon $dt)
{
}
/**
* Determines if the instance is less (before) than another
*
* @param Carbon $dt
*
* @return bool
*/
public function lt(\Carbon\Carbon $dt)
{
}
/**
* Determines if the instance is less (before) or equal to another
*
* @param Carbon $dt
*
* @return bool
*/
public function lte(\Carbon\Carbon $dt)
{
}
/**
* Determines if the instance is between two others
*
* @param Carbon $dt1
* @param Carbon $dt2
* @param bool $equal Indicates if a > and < comparison should be used or <= or >=
*
* @return bool
*/
public function between(\Carbon\Carbon $dt1, \Carbon\Carbon $dt2, $equal = true)
{
}
/**
* Get the closest date from the instance.
*
* @param Carbon $dt1
* @param Carbon $dt2
*
* @return static
*/
public function closest(\Carbon\Carbon $dt1, \Carbon\Carbon $dt2)
{
}
/**
* Get the farthest date from the instance.
*
* @param Carbon $dt1
* @param Carbon $dt2
*
* @return static
*/
public function farthest(\Carbon\Carbon $dt1, \Carbon\Carbon $dt2)
{
}
/**
* Get the minimum instance between a given instance (default now) and the current instance.
*
* @param Carbon|null $dt
*
* @return static
*/
public function min(\Carbon\Carbon $dt = null)
{
}
/**
* Get the maximum instance between a given instance (default now) and the current instance.
*
* @param Carbon|null $dt
*
* @return static
*/
public function max(\Carbon\Carbon $dt = null)
{
}
/**
* Determines if the instance is a weekday
*
* @return bool
*/
public function isWeekday()
{
}
/**
* Determines if the instance is a weekend day
*
* @return bool
*/
public function isWeekend()
{
}
/**
* Determines if the instance is yesterday
*
* @return bool
*/
public function isYesterday()
{
}
/**
* Determines if the instance is today
*
* @return bool
*/
public function isToday()
{
}
/**
* Determines if the instance is tomorrow
*
* @return bool
*/
public function isTomorrow()
{
}
/**
* Determines if the instance is in the future, ie. greater (after) than now
*
* @return bool
*/
public function isFuture()
{
}
/**
* Determines if the instance is in the past, ie. less (before) than now
*
* @return bool
*/
public function isPast()
{
}
/**
* Determines if the instance is a leap year
*
* @return bool
*/
public function isLeapYear()
{
}
/**
* Checks if the passed in date is the same day as the instance current day.
*
* @param Carbon $dt
*
* @return bool
*/
public function isSameDay(\Carbon\Carbon $dt)
{
}
/**
* Checks if this day is a Sunday.
*
* @return bool
*/
public function isSunday()
{
}
/**
* Checks if this day is a Monday.
*
* @return bool
*/
public function isMonday()
{
}
/**
* Checks if this day is a Tuesday.
*
* @return bool
*/
public function isTuesday()
{
}
/**
* Checks if this day is a Wednesday.
*
* @return bool
*/
public function isWednesday()
{
}
/**
* Checks if this day is a Thursday.
*
* @return bool
*/
public function isThursday()
{
}
/**
* Checks if this day is a Friday.
*
* @return bool
*/
public function isFriday()
{
}
/**
* Checks if this day is a Saturday.
*
* @return bool
*/
public function isSaturday()
{
}
///////////////////////////////////////////////////////////////////
/////////////////// ADDITIONS AND SUBTRACTIONS ////////////////////
///////////////////////////////////////////////////////////////////
/**
* Add years to the instance. Positive $value travel forward while
* negative $value travel into the past.
*
* @param int $value
*
* @return static
*/
public function addYears($value)
{
}
/**
* Add a year to the instance
*
* @param int $value
*
* @return static
*/
public function addYear($value = 1)
{
}
/**
* Remove a year from the instance
*
* @param int $value
*
* @return static
*/
public function subYear($value = 1)
{
}
/**
* Remove years from the instance.
*
* @param int $value
*
* @return static
*/
public function subYears($value)
{
}
/**
* Add months to the instance. Positive $value travels forward while
* negative $value travels into the past.
*
* @param int $value
*
* @return static
*/
public function addMonths($value)
{
}
/**
* Add a month to the instance
*
* @param int $value
*
* @return static
*/
public function addMonth($value = 1)
{
}
/**
* Remove a month from the instance
*
* @param int $value
*
* @return static
*/
public function subMonth($value = 1)
{
}
/**
* Remove months from the instance
*
* @param int $value
*
* @return static
*/
public function subMonths($value)
{
}
/**
* Add months without overflowing to the instance. Positive $value
* travels forward while negative $value travels into the past.
*
* @param int $value
*
* @return static
*/
public function addMonthsNoOverflow($value)
{
}
/**
* Add a month with no overflow to the instance
*
* @param int $value
*
* @return static
*/
public function addMonthNoOverflow($value = 1)
{
}
/**
* Remove a month with no overflow from the instance
*
* @param int $value
*
* @return static
*/
public function subMonthNoOverflow($value = 1)
{
}
/**
* Remove months with no overflow from the instance
*
* @param int $value
*
* @return static
*/
public function subMonthsNoOverflow($value)
{
}
/**
* Add days to the instance. Positive $value travels forward while
* negative $value travels into the past.
*
* @param int $value
*
* @return static
*/
public function addDays($value)
{
}
/**
* Add a day to the instance
*
* @param int $value
*
* @return static
*/
public function addDay($value = 1)
{
}
/**
* Remove a day from the instance
*
* @param int $value
*
* @return static
*/
public function subDay($value = 1)
{
}
/**
* Remove days from the instance
*
* @param int $value
*
* @return static
*/
public function subDays($value)
{
}
/**
* Add weekdays to the instance. Positive $value travels forward while
* negative $value travels into the past.
*
* @param int $value
*
* @return static
*/
public function addWeekdays($value)
{
}
/**
* Add a weekday to the instance
*
* @param int $value
*
* @return static
*/
public function addWeekday($value = 1)
{
}
/**
* Remove a weekday from the instance
*
* @param int $value
*
* @return static
*/
public function subWeekday($value = 1)
{
}
/**
* Remove weekdays from the instance
*
* @param int $value
*
* @return static
*/
public function subWeekdays($value)
{
}
/**
* Add weeks to the instance. Positive $value travels forward while
* negative $value travels into the past.
*
* @param int $value
*
* @return static
*/
public function addWeeks($value)
{
}
/**
* Add a week to the instance
*
* @param int $value
*
* @return static
*/
public function addWeek($value = 1)
{
}
/**
* Remove a week from the instance
*
* @param int $value
*
* @return static
*/
public function subWeek($value = 1)
{
}
/**
* Remove weeks to the instance
*
* @param int $value
*
* @return static
*/
public function subWeeks($value)
{
}
/**
* Add hours to the instance. Positive $value travels forward while
* negative $value travels into the past.
*
* @param int $value
*
* @return static
*/
public function addHours($value)
{
}
/**
* Add an hour to the instance
*
* @param int $value
*
* @return static
*/
public function addHour($value = 1)
{
}
/**
* Remove an hour from the instance
*
* @param int $value
*
* @return static
*/
public function subHour($value = 1)
{
}
/**
* Remove hours from the instance
*
* @param int $value
*
* @return static
*/
public function subHours($value)
{
}
/**
* Add minutes to the instance. Positive $value travels forward while
* negative $value travels into the past.
*
* @param int $value
*
* @return static
*/
public function addMinutes($value)
{
}
/**
* Add a minute to the instance
*
* @param int $value
*
* @return static
*/
public function addMinute($value = 1)
{
}
/**
* Remove a minute from the instance
*
* @param int $value
*
* @return static
*/
public function subMinute($value = 1)
{
}
/**
* Remove minutes from the instance
*
* @param int $value
*
* @return static
*/
public function subMinutes($value)
{
}
/**
* Add seconds to the instance. Positive $value travels forward while
* negative $value travels into the past.
*
* @param int $value
*
* @return static
*/
public function addSeconds($value)
{
}
/**
* Add a second to the instance
*
* @param int $value
*
* @return static
*/
public function addSecond($value = 1)
{
}
/**
* Remove a second from the instance
*
* @param int $value
*
* @return static
*/
public function subSecond($value = 1)
{
}
/**
* Remove seconds from the instance
*
* @param int $value
*
* @return static
*/
public function subSeconds($value)
{
}
///////////////////////////////////////////////////////////////////
/////////////////////////// DIFFERENCES ///////////////////////////
///////////////////////////////////////////////////////////////////
/**
* Get the difference in years
*
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInYears(\Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference in months
*
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInMonths(\Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference in weeks
*
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInWeeks(\Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference in days
*
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInDays(\Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference in days using a filter closure
*
* @param Closure $callback
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInDaysFiltered(\Closure $callback, \Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference in hours using a filter closure
*
* @param Closure $callback
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInHoursFiltered(\Closure $callback, \Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference by the given interval using a filter closure
*
* @param CarbonInterval $ci An interval to traverse by
* @param Closure $callback
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffFiltered(\Carbon\CarbonInterval $ci, \Closure $callback, \Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference in weekdays
*
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInWeekdays(\Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference in weekend days using a filter
*
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInWeekendDays(\Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference in hours
*
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInHours(\Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference in minutes
*
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInMinutes(\Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* Get the difference in seconds
*
* @param Carbon|null $dt
* @param bool $abs Get the absolute of the difference
*
* @return int
*/
public function diffInSeconds(\Carbon\Carbon $dt = null, $abs = true)
{
}
/**
* The number of seconds since midnight.
*
* @return int
*/
public function secondsSinceMidnight()
{
}
/**
* The number of seconds until 23:23:59.
*
* @return int
*/
public function secondsUntilEndOfDay()
{
}
/**
* Get the difference in a human readable format in the current locale.
*
* When comparing a value in the past to default now:
* 1 hour ago
* 5 months ago
*
* When comparing a value in the future to default now:
* 1 hour from now
* 5 months from now
*
* When comparing a value in the past to another value:
* 1 hour before
* 5 months before
*
* When comparing a value in the future to another value:
* 1 hour after
* 5 months after
*
* @param Carbon|null $other
* @param bool $absolute removes time difference modifiers ago, after, etc
*
* @return string
*/
public function diffForHumans(\Carbon\Carbon $other = null, $absolute = false)
{
}
///////////////////////////////////////////////////////////////////
//////////////////////////// MODIFIERS ////////////////////////////
///////////////////////////////////////////////////////////////////
/**
* Resets the time to 00:00:00
*
* @return static
*/
public function startOfDay()
{
}
/**
* Resets the time to 23:59:59
*
* @return static
*/
public function endOfDay()
{
}
/**
* Resets the date to the first day of the month and the time to 00:00:00
*
* @return static
*/
public function startOfMonth()
{
}
/**
* Resets the date to end of the month and time to 23:59:59
*
* @return static
*/
public function endOfMonth()
{
}
/**
* Resets the date to the first day of the year and the time to 00:00:00
*
* @return static
*/
public function startOfYear()
{
}
/**
* Resets the date to end of the year and time to 23:59:59
*
* @return static
*/
public function endOfYear()
{
}
/**
* Resets the date to the first day of the decade and the time to 00:00:00
*
* @return static
*/
public function startOfDecade()
{
}
/**
* Resets the date to end of the decade and time to 23:59:59
*
* @return static
*/
public function endOfDecade()
{
}
/**
* Resets the date to the first day of the century and the time to 00:00:00
*
* @return static
*/
public function startOfCentury()
{
}
/**
* Resets the date to end of the century and time to 23:59:59
*
* @return static
*/
public function endOfCentury()
{
}
/**
* Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00
*
* @return static
*/
public function startOfWeek()
{
}
/**
* Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59
*
* @return static
*/
public function endOfWeek()
{
}
/**
* Modify to the next occurrence of a given day of the week.
* If no dayOfWeek is provided, modify to the next occurrence
* of the current day of the week. Use the supplied consts
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek
*
* @return static
*/
public function next($dayOfWeek = null)
{
}
/**
* Modify to the previous occurrence of a given day of the week.
* If no dayOfWeek is provided, modify to the previous occurrence
* of the current day of the week. Use the supplied consts
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek
*
* @return static
*/
public function previous($dayOfWeek = null)
{
}
/**
* Modify to the first occurrence of a given day of the week
* in the current month. If no dayOfWeek is provided, modify to the
* first day of the current month. Use the supplied consts
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek
*
* @return static
*/
public function firstOfMonth($dayOfWeek = null)
{
}
/**
* Modify to the last occurrence of a given day of the week
* in the current month. If no dayOfWeek is provided, modify to the
* last day of the current month. Use the supplied consts
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek
*
* @return static
*/
public function lastOfMonth($dayOfWeek = null)
{
}
/**
* Modify to the given occurrence of a given day of the week
* in the current month. If the calculated occurrence is outside the scope
* of the current month, then return false and no modifications are made.
* Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int $nth
* @param int $dayOfWeek
*
* @return mixed
*/
public function nthOfMonth($nth, $dayOfWeek)
{
}
/**
* Modify to the first occurrence of a given day of the week
* in the current quarter. If no dayOfWeek is provided, modify to the
* first day of the current quarter. Use the supplied consts
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek
*
* @return static
*/
public function firstOfQuarter($dayOfWeek = null)
{
}
/**
* Modify to the last occurrence of a given day of the week
* in the current quarter. If no dayOfWeek is provided, modify to the
* last day of the current quarter. Use the supplied consts
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek
*
* @return static
*/
public function lastOfQuarter($dayOfWeek = null)
{
}
/**
* Modify to the given occurrence of a given day of the week
* in the current quarter. If the calculated occurrence is outside the scope
* of the current quarter, then return false and no modifications are made.
* Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int $nth
* @param int $dayOfWeek
*
* @return mixed
*/
public function nthOfQuarter($nth, $dayOfWeek)
{
}
/**
* Modify to the first occurrence of a given day of the week
* in the current year. If no dayOfWeek is provided, modify to the
* first day of the current year. Use the supplied consts
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek
*
* @return static
*/
public function firstOfYear($dayOfWeek = null)
{
}
/**
* Modify to the last occurrence of a given day of the week
* in the current year. If no dayOfWeek is provided, modify to the
* last day of the current year. Use the supplied consts
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek
*
* @return static
*/
public function lastOfYear($dayOfWeek = null)
{
}
/**
* Modify to the given occurrence of a given day of the week
* in the current year. If the calculated occurrence is outside the scope
* of the current year, then return false and no modifications are made.
* Use the supplied consts to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int $nth
* @param int $dayOfWeek
*
* @return mixed
*/
public function nthOfYear($nth, $dayOfWeek)
{
}
/**
* Modify the current instance to the average of a given instance (default now) and the current instance.
*
* @param Carbon|null $dt
*
* @return static
*/
public function average(\Carbon\Carbon $dt = null)
{
}
/**
* Check if its the birthday. Compares the date/month values of the two dates.
*
* @param Carbon|null $dt The instance to compare with or null to use current day.
*
* @return bool
*/
public function isBirthday(\Carbon\Carbon $dt = null)
{
}
}
}
namespace phpseclib\Net\SFTP {
/**
* SFTP Stream Wrapper
*
* @package SFTP
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class Stream
{
/**
* SFTP instances
*
* Rather than re-create the connection we re-use instances if possible
*
* @var array
*/
static $instances;
/**
* SFTP instance
*
* @var object
* @access private
*/
var $sftp;
/**
* Path
*
* @var string
* @access private
*/
var $path;
/**
* Mode
*
* @var string
* @access private
*/
var $mode;
/**
* Position
*
* @var int
* @access private
*/
var $pos;
/**
* Size
*
* @var int
* @access private
*/
var $size;
/**
* Directory entries
*
* @var array
* @access private
*/
var $entries;
/**
* EOF flag
*
* @var bool
* @access private
*/
var $eof;
/**
* Context resource
*
* Technically this needs to be publically accessible so PHP can set it directly
*
* @var resource
* @access public
*/
var $context;
/**
* Notification callback function
*
* @var callable
* @access public
*/
var $notification;
/**
* Registers this class as a URL wrapper.
*
* @param string $protocol The wrapper name to be registered.
* @return bool True on success, false otherwise.
* @access public
*/
static function register($protocol = 'sftp')
{
}
/**
* The Constructor
*
* @access public
*/
function __construct()
{
}
/**
* Path Parser
*
* Extract a path from a URI and actually connect to an SSH server if appropriate
*
* If "notification" is set as a context parameter the message code for successful login is
* NET_SSH2_MSG_USERAUTH_SUCCESS. For a failed login it's NET_SSH2_MSG_USERAUTH_FAILURE.
*
* @param string $path
* @return string
* @access private
*/
function _parse_path($path)
{
}
/**
* Opens file or URL
*
* @param string $path
* @param string $mode
* @param int $options
* @param string $opened_path
* @return bool
* @access public
*/
function _stream_open($path, $mode, $options, &$opened_path)
{
}
/**
* Read from stream
*
* @param int $count
* @return mixed
* @access public
*/
function _stream_read($count)
{
}
/**
* Write to stream
*
* @param string $data
* @return mixed
* @access public
*/
function _stream_write($data)
{
}
/**
* Retrieve the current position of a stream
*
* @return int
* @access public
*/
function _stream_tell()
{
}
/**
* Tests for end-of-file on a file pointer
*
* In my testing there are four classes functions that normally effect the pointer:
* fseek, fputs / fwrite, fgets / fread and ftruncate.
*
* Only fgets / fread, however, results in feof() returning true. do fputs($fp, 'aaa') on a blank file and feof()
* will return false. do fread($fp, 1) and feof() will then return true. do fseek($fp, 10) on ablank file and feof()
* will return false. do fread($fp, 1) and feof() will then return true.
*
* @return bool
* @access public
*/
function _stream_eof()
{
}
/**
* Seeks to specific location in a stream
*
* @param int $offset
* @param int $whence
* @return bool
* @access public
*/
function _stream_seek($offset, $whence)
{
}
/**
* Change stream options
*
* @param string $path
* @param int $option
* @param mixed $var
* @return bool
* @access public
*/
function _stream_metadata($path, $option, $var)
{
}
/**
* Retrieve the underlaying resource
*
* @param int $cast_as
* @return resource
* @access public
*/
function _stream_cast($cast_as)
{
}
/**
* Advisory file locking
*
* @param int $operation
* @return bool
* @access public
*/
function _stream_lock($operation)
{
}
/**
* Renames a file or directory
*
* Attempts to rename oldname to newname, moving it between directories if necessary.
* If newname exists, it will be overwritten. This is a departure from what \phpseclib\Net\SFTP
* does.
*
* @param string $path_from
* @param string $path_to
* @return bool
* @access public
*/
function _rename($path_from, $path_to)
{
}
/**
* Open directory handle
*
* The only $options is "whether or not to enforce safe_mode (0x04)". Since safe mode was deprecated in 5.3 and
* removed in 5.4 I'm just going to ignore it.
*
* Also, nlist() is the best that this function is realistically going to be able to do. When an SFTP client
* sends a SSH_FXP_READDIR packet you don't generally get info on just one file but on multiple files. Quoting
* the SFTP specs:
*
* The SSH_FXP_NAME response has the following format:
*
* uint32 id
* uint32 count
* repeats count times:
* string filename
* string longname
* ATTRS attrs
*
* @param string $path
* @param int $options
* @return bool
* @access public
*/
function _dir_opendir($path, $options)
{
}
/**
* Read entry from directory handle
*
* @return mixed
* @access public
*/
function _dir_readdir()
{
}
/**
* Rewind directory handle
*
* @return bool
* @access public
*/
function _dir_rewinddir()
{
}
/**
* Close directory handle
*
* @return bool
* @access public
*/
function _dir_closedir()
{
}
/**
* Create a directory
*
* Only valid $options is STREAM_MKDIR_RECURSIVE
*
* @param string $path
* @param int $mode
* @param int $options
* @return bool
* @access public
*/
function _mkdir($path, $mode, $options)
{
}
/**
* Removes a directory
*
* Only valid $options is STREAM_MKDIR_RECURSIVE per <http://php.net/streamwrapper.rmdir>, however,
* <http://php.net/rmdir> does not have a $recursive parameter as mkdir() does so I don't know how
* STREAM_MKDIR_RECURSIVE is supposed to be set. Also, when I try it out with rmdir() I get 8 as
* $options. What does 8 correspond to?
*
* @param string $path
* @param int $mode
* @param int $options
* @return bool
* @access public
*/
function _rmdir($path, $options)
{
}
/**
* Flushes the output
*
* See <http://php.net/fflush>. Always returns true because \phpseclib\Net\SFTP doesn't cache stuff before writing
*
* @return bool
* @access public
*/
function _stream_flush()
{
}
/**
* Retrieve information about a file resource
*
* @return mixed
* @access public
*/
function _stream_stat()
{
}
/**
* Delete a file
*
* @param string $path
* @return bool
* @access public
*/
function _unlink($path)
{
}
/**
* Retrieve information about a file
*
* Ignores the STREAM_URL_STAT_QUIET flag because the entirety of \phpseclib\Net\SFTP\Stream is quiet by default
* might be worthwhile to reconstruct bits 12-16 (ie. the file type) if mode doesn't have them but we'll
* cross that bridge when and if it's reached
*
* @param string $path
* @param int $flags
* @return mixed
* @access public
*/
function _url_stat($path, $flags)
{
}
/**
* Truncate stream
*
* @param int $new_size
* @return bool
* @access public
*/
function _stream_truncate($new_size)
{
}
/**
* Change stream options
*
* STREAM_OPTION_WRITE_BUFFER isn't supported for the same reason stream_flush isn't.
* The other two aren't supported because of limitations in \phpseclib\Net\SFTP.
*
* @param int $option
* @param int $arg1
* @param int $arg2
* @return bool
* @access public
*/
function _stream_set_option($option, $arg1, $arg2)
{
}
/**
* Close an resource
*
* @access public
*/
function _stream_close()
{
}
/**
* __call Magic Method
*
* When you're utilizing an SFTP stream you're not calling the methods in this class directly - PHP is calling them for you.
* Which kinda begs the question... what methods is PHP calling and what parameters is it passing to them? This function
* lets you figure that out.
*
* If NET_SFTP_STREAM_LOGGING is defined all calls will be output on the screen and then (regardless of whether or not
* NET_SFTP_STREAM_LOGGING is enabled) the parameters will be passed through to the appropriate method.
*
* @param string
* @param array
* @return mixed
* @access public
*/
function __call($name, $arguments)
{
}
}
}
namespace phpseclib\Net {
/**
* Pure-PHP implementation of SSHv2.
*
* @package SSH2
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class SSH2
{
/**#@+
* Execution Bitmap Masks
*
* @see \phpseclib\Net\SSH2::bitmap
* @access private
*/
const MASK_CONSTRUCTOR = 0x1;
const MASK_CONNECTED = 0x2;
const MASK_LOGIN_REQ = 0x4;
const MASK_LOGIN = 0x8;
const MASK_SHELL = 0x10;
const MASK_WINDOW_ADJUST = 0x20;
/**#@-*/
/**#@+
* Channel constants
*
* RFC4254 refers not to client and server channels but rather to sender and recipient channels. we don't refer
* to them in that way because RFC4254 toggles the meaning. the client sends a SSH_MSG_CHANNEL_OPEN message with
* a sender channel and the server sends a SSH_MSG_CHANNEL_OPEN_CONFIRMATION in response, with a sender and a
* recepient channel. at first glance, you might conclude that SSH_MSG_CHANNEL_OPEN_CONFIRMATION's sender channel
* would be the same thing as SSH_MSG_CHANNEL_OPEN's sender channel, but it's not, per this snipet:
* The 'recipient channel' is the channel number given in the original
* open request, and 'sender channel' is the channel number allocated by
* the other side.
*
* @see \phpseclib\Net\SSH2::_send_channel_packet()
* @see \phpseclib\Net\SSH2::_get_channel_packet()
* @access private
*/
const CHANNEL_EXEC = 1;
// PuTTy uses 0x100
const CHANNEL_SHELL = 2;
const CHANNEL_SUBSYSTEM = 3;
const CHANNEL_AGENT_FORWARD = 4;
/**#@-*/
/**#@+
* @access public
* @see \phpseclib\Net\SSH2::getLog()
*/
/**
* Returns the message numbers
*/
const LOG_SIMPLE = 1;
/**
* Returns the message content
*/
const LOG_COMPLEX = 2;
/**
* Outputs the content real-time
*/
const LOG_REALTIME = 3;
/**
* Dumps the content real-time to a file
*/
const LOG_REALTIME_FILE = 4;
/**
* Make sure that the log never gets larger than this
*/
const LOG_MAX_SIZE = 1048576;
// 1024 * 1024
/**#@-*/
/**#@+
* @access public
* @see \phpseclib\Net\SSH2::read()
*/
/**
* Returns when a string matching $expect exactly is found
*/
const READ_SIMPLE = 1;
/**
* Returns when a string matching the regular expression $expect is found
*/
const READ_REGEX = 2;
/**
* Returns when a string matching the regular expression $expect is found
*/
const READ_NEXT = 3;
/**#@-*/
/**
* The SSH identifier
*
* @var string
* @access private
*/
var $identifier;
/**
* The Socket Object
*
* @var object
* @access private
*/
var $fsock;
/**
* Execution Bitmap
*
* The bits that are set represent functions that have been called already. This is used to determine
* if a requisite function has been successfully executed. If not, an error should be thrown.
*
* @var int
* @access private
*/
var $bitmap = 0;
/**
* Error information
*
* @see self::getErrors()
* @see self::getLastError()
* @var string
* @access private
*/
var $errors = array();
/**
* Server Identifier
*
* @see self::getServerIdentification()
* @var array|false
* @access private
*/
var $server_identifier = false;
/**
* Key Exchange Algorithms
*
* @see self::getKexAlgorithims()
* @var array|false
* @access private
*/
var $kex_algorithms = false;
/**
* Minimum Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods
*
* @see self::_key_exchange()
* @var int
* @access private
*/
var $kex_dh_group_size_min = 1536;
/**
* Preferred Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods
*
* @see self::_key_exchange()
* @var int
* @access private
*/
var $kex_dh_group_size_preferred = 2048;
/**
* Maximum Diffie-Hellman Group Bit Size in RFC 4419 Key Exchange Methods
*
* @see self::_key_exchange()
* @var int
* @access private
*/
var $kex_dh_group_size_max = 4096;
/**
* Server Host Key Algorithms
*
* @see self::getServerHostKeyAlgorithms()
* @var array|false
* @access private
*/
var $server_host_key_algorithms = false;
/**
* Encryption Algorithms: Client to Server
*
* @see self::getEncryptionAlgorithmsClient2Server()
* @var array|false
* @access private
*/
var $encryption_algorithms_client_to_server = false;
/**
* Encryption Algorithms: Server to Client
*
* @see self::getEncryptionAlgorithmsServer2Client()
* @var array|false
* @access private
*/
var $encryption_algorithms_server_to_client = false;
/**
* MAC Algorithms: Client to Server
*
* @see self::getMACAlgorithmsClient2Server()
* @var array|false
* @access private
*/
var $mac_algorithms_client_to_server = false;
/**
* MAC Algorithms: Server to Client
*
* @see self::getMACAlgorithmsServer2Client()
* @var array|false
* @access private
*/
var $mac_algorithms_server_to_client = false;
/**
* Compression Algorithms: Client to Server
*
* @see self::getCompressionAlgorithmsClient2Server()
* @var array|false
* @access private
*/
var $compression_algorithms_client_to_server = false;
/**
* Compression Algorithms: Server to Client
*
* @see self::getCompressionAlgorithmsServer2Client()
* @var array|false
* @access private
*/
var $compression_algorithms_server_to_client = false;
/**
* Languages: Server to Client
*
* @see self::getLanguagesServer2Client()
* @var array|false
* @access private
*/
var $languages_server_to_client = false;
/**
* Languages: Client to Server
*
* @see self::getLanguagesClient2Server()
* @var array|false
* @access private
*/
var $languages_client_to_server = false;
/**
* Block Size for Server to Client Encryption
*
* "Note that the length of the concatenation of 'packet_length',
* 'padding_length', 'payload', and 'random padding' MUST be a multiple
* of the cipher block size or 8, whichever is larger. This constraint
* MUST be enforced, even when using stream ciphers."
*
* -- http://tools.ietf.org/html/rfc4253#section-6
*
* @see self::__construct()
* @see self::_send_binary_packet()
* @var int
* @access private
*/
var $encrypt_block_size = 8;
/**
* Block Size for Client to Server Encryption
*
* @see self::__construct()
* @see self::_get_binary_packet()
* @var int
* @access private
*/
var $decrypt_block_size = 8;
/**
* Server to Client Encryption Object
*
* @see self::_get_binary_packet()
* @var object
* @access private
*/
var $decrypt = false;
/**
* Client to Server Encryption Object
*
* @see self::_send_binary_packet()
* @var object
* @access private
*/
var $encrypt = false;
/**
* Client to Server HMAC Object
*
* @see self::_send_binary_packet()
* @var object
* @access private
*/
var $hmac_create = false;
/**
* Server to Client HMAC Object
*
* @see self::_get_binary_packet()
* @var object
* @access private
*/
var $hmac_check = false;
/**
* Size of server to client HMAC
*
* We need to know how big the HMAC will be for the server to client direction so that we know how many bytes to read.
* For the client to server side, the HMAC object will make the HMAC as long as it needs to be. All we need to do is
* append it.
*
* @see self::_get_binary_packet()
* @var int
* @access private
*/
var $hmac_size = false;
/**
* Server Public Host Key
*
* @see self::getServerPublicHostKey()
* @var string
* @access private
*/
var $server_public_host_key;
/**
* Session identifier
*
* "The exchange hash H from the first key exchange is additionally
* used as the session identifier, which is a unique identifier for
* this connection."
*
* -- http://tools.ietf.org/html/rfc4253#section-7.2
*
* @see self::_key_exchange()
* @var string
* @access private
*/
var $session_id = false;
/**
* Exchange hash
*
* The current exchange hash
*
* @see self::_key_exchange()
* @var string
* @access private
*/
var $exchange_hash = false;
/**
* Message Numbers
*
* @see self::__construct()
* @var array
* @access private
*/
var $message_numbers = array();
/**
* Disconnection Message 'reason codes' defined in RFC4253
*
* @see self::__construct()
* @var array
* @access private
*/
var $disconnect_reasons = array();
/**
* SSH_MSG_CHANNEL_OPEN_FAILURE 'reason codes', defined in RFC4254
*
* @see self::__construct()
* @var array
* @access private
*/
var $channel_open_failure_reasons = array();
/**
* Terminal Modes
*
* @link http://tools.ietf.org/html/rfc4254#section-8
* @see self::__construct()
* @var array
* @access private
*/
var $terminal_modes = array();
/**
* SSH_MSG_CHANNEL_EXTENDED_DATA's data_type_codes
*
* @link http://tools.ietf.org/html/rfc4254#section-5.2
* @see self::__construct()
* @var array
* @access private
*/
var $channel_extended_data_type_codes = array();
/**
* Send Sequence Number
*
* See 'Section 6.4. Data Integrity' of rfc4253 for more info.
*
* @see self::_send_binary_packet()
* @var int
* @access private
*/
var $send_seq_no = 0;
/**
* Get Sequence Number
*
* See 'Section 6.4. Data Integrity' of rfc4253 for more info.
*
* @see self::_get_binary_packet()
* @var int
* @access private
*/
var $get_seq_no = 0;
/**
* Server Channels
*
* Maps client channels to server channels
*
* @see self::_get_channel_packet()
* @see self::exec()
* @var array
* @access private
*/
var $server_channels = array();
/**
* Channel Buffers
*
* If a client requests a packet from one channel but receives two packets from another those packets should
* be placed in a buffer
*
* @see self::_get_channel_packet()
* @see self::exec()
* @var array
* @access private
*/
var $channel_buffers = array();
/**
* Channel Status
*
* Contains the type of the last sent message
*
* @see self::_get_channel_packet()
* @var array
* @access private
*/
var $channel_status = array();
/**
* Packet Size
*
* Maximum packet size indexed by channel
*
* @see self::_send_channel_packet()
* @var array
* @access private
*/
var $packet_size_client_to_server = array();
/**
* Message Number Log
*
* @see self::getLog()
* @var array
* @access private
*/
var $message_number_log = array();
/**
* Message Log
*
* @see self::getLog()
* @var array
* @access private
*/
var $message_log = array();
/**
* The Window Size
*
* Bytes the other party can send before it must wait for the window to be adjusted (0x7FFFFFFF = 2GB)
*
* @var int
* @see self::_send_channel_packet()
* @see self::exec()
* @access private
*/
var $window_size = 0x7fffffff;
/**
* Window size, server to client
*
* Window size indexed by channel
*
* @see self::_send_channel_packet()
* @var array
* @access private
*/
var $window_size_server_to_client = array();
/**
* Window size, client to server
*
* Window size indexed by channel
*
* @see self::_get_channel_packet()
* @var array
* @access private
*/
var $window_size_client_to_server = array();
/**
* Server signature
*
* Verified against $this->session_id
*
* @see self::getServerPublicHostKey()
* @var string
* @access private
*/
var $signature = '';
/**
* Server signature format
*
* ssh-rsa or ssh-dss.
*
* @see self::getServerPublicHostKey()
* @var string
* @access private
*/
var $signature_format = '';
/**
* Interactive Buffer
*
* @see self::read()
* @var array
* @access private
*/
var $interactiveBuffer = '';
/**
* Current log size
*
* Should never exceed self::LOG_MAX_SIZE
*
* @see self::_send_binary_packet()
* @see self::_get_binary_packet()
* @var int
* @access private
*/
var $log_size;
/**
* Timeout
*
* @see self::setTimeout()
* @access private
*/
var $timeout;
/**
* Current Timeout
*
* @see self::_get_channel_packet()
* @access private
*/
var $curTimeout;
/**
* Real-time log file pointer
*
* @see self::_append_log()
* @var resource
* @access private
*/
var $realtime_log_file;
/**
* Real-time log file size
*
* @see self::_append_log()
* @var int
* @access private
*/
var $realtime_log_size;
/**
* Has the signature been validated?
*
* @see self::getServerPublicHostKey()
* @var bool
* @access private
*/
var $signature_validated = false;
/**
* Real-time log file wrap boolean
*
* @see self::_append_log()
* @access private
*/
var $realtime_log_wrap;
/**
* Flag to suppress stderr from output
*
* @see self::enableQuietMode()
* @access private
*/
var $quiet_mode = false;
/**
* Time of first network activity
*
* @var int
* @access private
*/
var $last_packet;
/**
* Exit status returned from ssh if any
*
* @var int
* @access private
*/
var $exit_status;
/**
* Flag to request a PTY when using exec()
*
* @var bool
* @see self::enablePTY()
* @access private
*/
var $request_pty = false;
/**
* Flag set while exec() is running when using enablePTY()
*
* @var bool
* @access private
*/
var $in_request_pty_exec = false;
/**
* Flag set after startSubsystem() is called
*
* @var bool
* @access private
*/
var $in_subsystem;
/**
* Contents of stdError
*
* @var string
* @access private
*/
var $stdErrorLog;
/**
* The Last Interactive Response
*
* @see self::_keyboard_interactive_process()
* @var string
* @access private
*/
var $last_interactive_response = '';
/**
* Keyboard Interactive Request / Responses
*
* @see self::_keyboard_interactive_process()
* @var array
* @access private
*/
var $keyboard_requests_responses = array();
/**
* Banner Message
*
* Quoting from the RFC, "in some jurisdictions, sending a warning message before
* authentication may be relevant for getting legal protection."
*
* @see self::_filter()
* @see self::getBannerMessage()
* @var string
* @access private
*/
var $banner_message = '';
/**
* Did read() timeout or return normally?
*
* @see self::isTimeout()
* @var bool
* @access private
*/
var $is_timeout = false;
/**
* Log Boundary
*
* @see self::_format_log()
* @var string
* @access private
*/
var $log_boundary = ':';
/**
* Log Long Width
*
* @see self::_format_log()
* @var int
* @access private
*/
var $log_long_width = 65;
/**
* Log Short Width
*
* @see self::_format_log()
* @var int
* @access private
*/
var $log_short_width = 16;
/**
* Hostname
*
* @see self::__construct()
* @see self::_connect()
* @var string
* @access private
*/
var $host;
/**
* Port Number
*
* @see self::__construct()
* @see self::_connect()
* @var int
* @access private
*/
var $port;
/**
* Number of columns for terminal window size
*
* @see self::getWindowColumns()
* @see self::setWindowColumns()
* @see self::setWindowSize()
* @var int
* @access private
*/
var $windowColumns = 80;
/**
* Number of columns for terminal window size
*
* @see self::getWindowRows()
* @see self::setWindowRows()
* @see self::setWindowSize()
* @var int
* @access private
*/
var $windowRows = 24;
/**
* Crypto Engine
*
* @see self::setCryptoEngine()
* @see self::_key_exchange()
* @var int
* @access private
*/
var $crypto_engine = false;
/**
* A System_SSH_Agent for use in the SSH2 Agent Forwarding scenario
*
* @var System_SSH_Agent
* @access private
*/
var $agent;
/**
* Send the identification string first?
*
* @var bool
* @access private
*/
var $send_id_string_first = true;
/**
* Send the key exchange initiation packet first?
*
* @var bool
* @access private
*/
var $send_kex_first = true;
/**
* Some versions of OpenSSH incorrectly calculate the key size
*
* @var bool
* @access private
*/
var $bad_key_size_fix = false;
/**
* The selected decryption algorithm
*
* @var string
* @access private
*/
var $decrypt_algorithm = '';
/**
* Should we try to re-connect to re-establish keys?
*
* @var bool
* @access private
*/
var $retry_connect = false;
/**
* Binary Packet Buffer
*
* @var string|false
* @access private
*/
var $binary_packet_buffer = false;
/**
* Default Constructor.
*
* $host can either be a string, representing the host, or a stream resource.
*
* @param mixed $host
* @param int $port
* @param int $timeout
* @see self::login()
* @return \phpseclib\Net\SSH2
* @access public
*/
function __construct($host, $port = 22, $timeout = 10)
{
}
/**
* Set Crypto Engine Mode
*
* Possible $engine values:
* CRYPT_MODE_INTERNAL, CRYPT_MODE_MCRYPT
*
* @param int $engine
* @access public
*/
function setCryptoEngine($engine)
{
}
/**
* Send Identification String First
*
* https://tools.ietf.org/html/rfc4253#section-4.2 says "when the connection has been established,
* both sides MUST send an identification string". It does not say which side sends it first. In
* theory it shouldn't matter but it is a fact of life that some SSH servers are simply buggy
*
* @access public
*/
function sendIdentificationStringFirst()
{
}
/**
* Send Identification String Last
*
* https://tools.ietf.org/html/rfc4253#section-4.2 says "when the connection has been established,
* both sides MUST send an identification string". It does not say which side sends it first. In
* theory it shouldn't matter but it is a fact of life that some SSH servers are simply buggy
*
* @access public
*/
function sendIdentificationStringLast()
{
}
/**
* Send SSH_MSG_KEXINIT First
*
* https://tools.ietf.org/html/rfc4253#section-7.1 says "key exchange begins by each sending
* sending the [SSH_MSG_KEXINIT] packet". It does not say which side sends it first. In theory
* it shouldn't matter but it is a fact of life that some SSH servers are simply buggy
*
* @access public
*/
function sendKEXINITFirst()
{
}
/**
* Send SSH_MSG_KEXINIT Last
*
* https://tools.ietf.org/html/rfc4253#section-7.1 says "key exchange begins by each sending
* sending the [SSH_MSG_KEXINIT] packet". It does not say which side sends it first. In theory
* it shouldn't matter but it is a fact of life that some SSH servers are simply buggy
*
* @access public
*/
function sendKEXINITLast()
{
}
/**
* Connect to an SSHv2 server
*
* @return bool
* @access private
*/
function _connect()
{
}
/**
* Generates the SSH identifier
*
* You should overwrite this method in your own class if you want to use another identifier
*
* @access protected
* @return string
*/
function _generate_identifier()
{
}
/**
* Key Exchange
*
* @param string $kexinit_payload_server optional
* @access private
*/
function _key_exchange($kexinit_payload_server = false)
{
}
/**
* Maps an encryption algorithm name to the number of key bytes.
*
* @param string $algorithm Name of the encryption algorithm
* @return int|null Number of bytes as an integer or null for unknown
* @access private
*/
function _encryption_algorithm_to_key_size($algorithm)
{
}
/**
* Maps an encryption algorithm name to an instance of a subclass of
* \phpseclib\Crypt\Base.
*
* @param string $algorithm Name of the encryption algorithm
* @return mixed Instance of \phpseclib\Crypt\Base or null for unknown
* @access private
*/
function _encryption_algorithm_to_crypt_instance($algorithm)
{
}
/*
* Tests whether or not proposed algorithm has a potential for issues
*
* @link https://www.chiark.greenend.org.uk/~sgtatham/putty/wishlist/ssh2-aesctr-openssh.html
* @link https://bugzilla.mindrot.org/show_bug.cgi?id=1291
* @param string $algorithm Name of the encryption algorithm
* @return bool
* @access private
*/
function _bad_algorithm_candidate($algorithm)
{
}
/**
* Login
*
* The $password parameter can be a plaintext password, a \phpseclib\Crypt\RSA object or an array
*
* @param string $username
* @param mixed $password
* @param mixed $...
* @return bool
* @see self::_login()
* @access public
*/
function login($username)
{
}
/**
* Login Helper
*
* @param string $username
* @param mixed $password
* @param mixed $...
* @return bool
* @see self::_login_helper()
* @access private
*/
function _login($username)
{
}
/**
* Login Helper
*
* @param string $username
* @param string $password
* @return bool
* @access private
* @internal It might be worthwhile, at some point, to protect against {@link http://tools.ietf.org/html/rfc4251#section-9.3.9 traffic analysis}
* by sending dummy SSH_MSG_IGNORE messages.
*/
function _login_helper($username, $password = null)
{
}
/**
* Login via keyboard-interactive authentication
*
* See {@link http://tools.ietf.org/html/rfc4256 RFC4256} for details. This is not a full-featured keyboard-interactive authenticator.
*
* @param string $username
* @param string $password
* @return bool
* @access private
*/
function _keyboard_interactive_login($username, $password)
{
}
/**
* Handle the keyboard-interactive requests / responses.
*
* @param string $responses...
* @return bool
* @access private
*/
function _keyboard_interactive_process()
{
}
/**
* Login with an ssh-agent provided key
*
* @param string $username
* @param \phpseclib\System\SSH\Agent $agent
* @return bool
* @access private
*/
function _ssh_agent_login($username, $agent)
{
}
/**
* Login with an RSA private key
*
* @param string $username
* @param \phpseclib\Crypt\RSA $password
* @return bool
* @access private
* @internal It might be worthwhile, at some point, to protect against {@link http://tools.ietf.org/html/rfc4251#section-9.3.9 traffic analysis}
* by sending dummy SSH_MSG_IGNORE messages.
*/
function _privatekey_login($username, $privatekey)
{
}
/**
* Set Timeout
*
* $ssh->exec('ping 127.0.0.1'); on a Linux host will never return and will run indefinitely. setTimeout() makes it so it'll timeout.
* Setting $timeout to false or 0 will mean there is no timeout.
*
* @param mixed $timeout
* @access public
*/
function setTimeout($timeout)
{
}
/**
* Get the output from stdError
*
* @access public
*/
function getStdError()
{
}
/**
* Execute Command
*
* If $callback is set to false then \phpseclib\Net\SSH2::_get_channel_packet(self::CHANNEL_EXEC) will need to be called manually.
* In all likelihood, this is not a feature you want to be taking advantage of.
*
* @param string $command
* @param Callback $callback
* @return string
* @access public
*/
function exec($command, $callback = null)
{
}
/**
* Creates an interactive shell
*
* @see self::read()
* @see self::write()
* @return bool
* @access private
*/
function _initShell()
{
}
/**
* Return the channel to be used with read() / write()
*
* @see self::read()
* @see self::write()
* @return int
* @access public
*/
function _get_interactive_channel()
{
}
/**
* Return an available open channel
*
* @return int
* @access public
*/
function _get_open_channel()
{
}
/**
* Returns the output of an interactive shell
*
* Returns when there's a match for $expect, which can take the form of a string literal or,
* if $mode == self::READ_REGEX, a regular expression.
*
* @see self::write()
* @param string $expect
* @param int $mode
* @return string
* @access public
*/
function read($expect = '', $mode = self::READ_SIMPLE)
{
}
/**
* Inputs a command into an interactive shell.
*
* @see self::read()
* @param string $cmd
* @return bool
* @access public
*/
function write($cmd)
{
}
/**
* Start a subsystem.
*
* Right now only one subsystem at a time is supported. To support multiple subsystem's stopSubsystem() could accept
* a string that contained the name of the subsystem, but at that point, only one subsystem of each type could be opened.
* To support multiple subsystem's of the same name maybe it'd be best if startSubsystem() generated a new channel id and
* returns that and then that that was passed into stopSubsystem() but that'll be saved for a future date and implemented
* if there's sufficient demand for such a feature.
*
* @see self::stopSubsystem()
* @param string $subsystem
* @return bool
* @access public
*/
function startSubsystem($subsystem)
{
}
/**
* Stops a subsystem.
*
* @see self::startSubsystem()
* @return bool
* @access public
*/
function stopSubsystem()
{
}
/**
* Closes a channel
*
* If read() timed out you might want to just close the channel and have it auto-restart on the next read() call
*
* @access public
*/
function reset()
{
}
/**
* Is timeout?
*
* Did exec() or read() return because they timed out or because they encountered the end?
*
* @access public
*/
function isTimeout()
{
}
/**
* Disconnect
*
* @access public
*/
function disconnect()
{
}
/**
* Destructor.
*
* Will be called, automatically, if you're supporting just PHP5. If you're supporting PHP4, you'll need to call
* disconnect().
*
* @access public
*/
function __destruct()
{
}
/**
* Is the connection still active?
*
* @return bool
* @access public
*/
function isConnected()
{
}
/**
* Have you successfully been logged in?
*
* @return bool
* @access public
*/
function isAuthenticated()
{
}
/**
* Resets a connection for re-use
*
* @param int $reason
* @access private
*/
function _reset_connection($reason)
{
}
/**
* Gets Binary Packets
*
* See '6. Binary Packet Protocol' of rfc4253 for more info.
*
* @see self::_send_binary_packet()
* @return string
* @access private
*/
function _get_binary_packet($skip_channel_filter = false)
{
}
/**
* Filter Binary Packets
*
* Because some binary packets need to be ignored...
*
* @see self::_get_binary_packet()
* @return string
* @access private
*/
function _filter($payload, $skip_channel_filter)
{
}
/**
* Enable Quiet Mode
*
* Suppress stderr from output
*
* @access public
*/
function enableQuietMode()
{
}
/**
* Disable Quiet Mode
*
* Show stderr in output
*
* @access public
*/
function disableQuietMode()
{
}
/**
* Returns whether Quiet Mode is enabled or not
*
* @see self::enableQuietMode()
* @see self::disableQuietMode()
* @access public
* @return bool
*/
function isQuietModeEnabled()
{
}
/**
* Enable request-pty when using exec()
*
* @access public
*/
function enablePTY()
{
}
/**
* Disable request-pty when using exec()
*
* @access public
*/
function disablePTY()
{
}
/**
* Returns whether request-pty is enabled or not
*
* @see self::enablePTY()
* @see self::disablePTY()
* @access public
* @return bool
*/
function isPTYEnabled()
{
}
/**
* Gets channel data
*
* Returns the data as a string if it's available and false if not.
*
* @param $client_channel
* @return mixed
* @access private
*/
function _get_channel_packet($client_channel, $skip_extended = false)
{
}
/**
* Sends Binary Packets
*
* See '6. Binary Packet Protocol' of rfc4253 for more info.
*
* @param string $data
* @param string $logged
* @see self::_get_binary_packet()
* @return bool
* @access private
*/
function _send_binary_packet($data, $logged = null)
{
}
/**
* Logs data packets
*
* Makes sure that only the last 1MB worth of packets will be logged
*
* @param string $data
* @access private
*/
function _append_log($message_number, $message)
{
}
/**
* Sends channel data
*
* Spans multiple SSH_MSG_CHANNEL_DATAs if appropriate
*
* @param int $client_channel
* @param string $data
* @return bool
* @access private
*/
function _send_channel_packet($client_channel, $data)
{
}
/**
* Closes and flushes a channel
*
* \phpseclib\Net\SSH2 doesn't properly close most channels. For exec() channels are normally closed by the server
* and for SFTP channels are presumably closed when the client disconnects. This functions is intended
* for SCP more than anything.
*
* @param int $client_channel
* @param bool $want_reply
* @return bool
* @access private
*/
function _close_channel($client_channel, $want_reply = false)
{
}
/**
* Disconnect
*
* @param int $reason
* @return bool
* @access private
*/
function _disconnect($reason)
{
}
/**
* String Shift
*
* Inspired by array_shift
*
* @param string $string
* @param int $index
* @return string
* @access private
*/
function _string_shift(&$string, $index = 1)
{
}
/**
* Define Array
*
* Takes any number of arrays whose indices are integers and whose values are strings and defines a bunch of
* named constants from it, using the value as the name of the constant and the index as the value of the constant.
* If any of the constants that would be defined already exists, none of the constants will be defined.
*
* @param array $array
* @access private
*/
function _define_array()
{
}
/**
* Returns a log of the packets that have been sent and received.
*
* Returns a string if NET_SSH2_LOGGING == self::LOG_COMPLEX, an array if NET_SSH2_LOGGING == self::LOG_SIMPLE and false if !defined('NET_SSH2_LOGGING')
*
* @access public
* @return array|false|string
*/
function getLog()
{
}
/**
* Formats a log for printing
*
* @param array $message_log
* @param array $message_number_log
* @access private
* @return string
*/
function _format_log($message_log, $message_number_log)
{
}
/**
* Helper function for _format_log
*
* For use with preg_replace_callback()
*
* @param array $matches
* @access private
* @return string
*/
function _format_log_helper($matches)
{
}
/**
* Helper function for agent->_on_channel_open()
*
* Used when channels are created to inform agent
* of said channel opening. Must be called after
* channel open confirmation received
*
* @access private
*/
function _on_channel_open()
{
}
/**
* Returns the first value of the intersection of two arrays or false if
* the intersection is empty. The order is defined by the first parameter.
*
* @param array $array1
* @param array $array2
* @return mixed False if intersection is empty, else intersected value.
* @access private
*/
function _array_intersect_first($array1, $array2)
{
}
/**
* Returns all errors
*
* @return string[]
* @access public
*/
function getErrors()
{
}
/**
* Returns the last error
*
* @return string
* @access public
*/
function getLastError()
{
}
/**
* Return the server identification.
*
* @return string
* @access public
*/
function getServerIdentification()
{
}
/**
* Return a list of the key exchange algorithms the server supports.
*
* @return array
* @access public
*/
function getKexAlgorithms()
{
}
/**
* Return a list of the host key (public key) algorithms the server supports.
*
* @return array
* @access public
*/
function getServerHostKeyAlgorithms()
{
}
/**
* Return a list of the (symmetric key) encryption algorithms the server supports, when receiving stuff from the client.
*
* @return array
* @access public
*/
function getEncryptionAlgorithmsClient2Server()
{
}
/**
* Return a list of the (symmetric key) encryption algorithms the server supports, when sending stuff to the client.
*
* @return array
* @access public
*/
function getEncryptionAlgorithmsServer2Client()
{
}
/**
* Return a list of the MAC algorithms the server supports, when receiving stuff from the client.
*
* @return array
* @access public
*/
function getMACAlgorithmsClient2Server()
{
}
/**
* Return a list of the MAC algorithms the server supports, when sending stuff to the client.
*
* @return array
* @access public
*/
function getMACAlgorithmsServer2Client()
{
}
/**
* Return a list of the compression algorithms the server supports, when receiving stuff from the client.
*
* @return array
* @access public
*/
function getCompressionAlgorithmsClient2Server()
{
}
/**
* Return a list of the compression algorithms the server supports, when sending stuff to the client.
*
* @return array
* @access public
*/
function getCompressionAlgorithmsServer2Client()
{
}
/**
* Return a list of the languages the server supports, when sending stuff to the client.
*
* @return array
* @access public
*/
function getLanguagesServer2Client()
{
}
/**
* Return a list of the languages the server supports, when receiving stuff from the client.
*
* @return array
* @access public
*/
function getLanguagesClient2Server()
{
}
/**
* Returns the banner message.
*
* Quoting from the RFC, "in some jurisdictions, sending a warning message before
* authentication may be relevant for getting legal protection."
*
* @return string
* @access public
*/
function getBannerMessage()
{
}
/**
* Returns the server public host key.
*
* Caching this the first time you connect to a server and checking the result on subsequent connections
* is recommended. Returns false if the server signature is not signed correctly with the public host key.
*
* @return mixed
* @access public
*/
function getServerPublicHostKey()
{
}
/**
* Returns the exit status of an SSH command or false.
*
* @return false|int
* @access public
*/
function getExitStatus()
{
}
/**
* Returns the number of columns for the terminal window size.
*
* @return int
* @access public
*/
function getWindowColumns()
{
}
/**
* Returns the number of rows for the terminal window size.
*
* @return int
* @access public
*/
function getWindowRows()
{
}
/**
* Sets the number of columns for the terminal window size.
*
* @param int $value
* @access public
*/
function setWindowColumns($value)
{
}
/**
* Sets the number of rows for the terminal window size.
*
* @param int $value
* @access public
*/
function setWindowRows($value)
{
}
/**
* Sets the number of columns and rows for the terminal window size.
*
* @param int $columns
* @param int $rows
* @access public
*/
function setWindowSize($columns = 80, $rows = 24)
{
}
}
/**
* Pure-PHP implementations of SFTP.
*
* @package SFTP
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class SFTP extends \phpseclib\Net\SSH2
{
/**
* SFTP channel constant
*
* \phpseclib\Net\SSH2::exec() uses 0 and \phpseclib\Net\SSH2::read() / \phpseclib\Net\SSH2::write() use 1.
*
* @see \phpseclib\Net\SSH2::_send_channel_packet()
* @see \phpseclib\Net\SSH2::_get_channel_packet()
* @access private
*/
const CHANNEL = 0x100;
/**#@+
* @access public
* @see \phpseclib\Net\SFTP::put()
*/
/**
* Reads data from a local file.
*/
const SOURCE_LOCAL_FILE = 1;
/**
* Reads data from a string.
*/
// this value isn't really used anymore but i'm keeping it reserved for historical reasons
const SOURCE_STRING = 2;
/**
* Reads data from callback:
* function callback($length) returns string to proceed, null for EOF
*/
const SOURCE_CALLBACK = 16;
/**
* Resumes an upload
*/
const RESUME = 4;
/**
* Append a local file to an already existing remote file
*/
const RESUME_START = 8;
/**#@-*/
/**
* Packet Types
*
* @see self::__construct()
* @var array
* @access private
*/
var $packet_types = array();
/**
* Status Codes
*
* @see self::__construct()
* @var array
* @access private
*/
var $status_codes = array();
/**
* The Request ID
*
* The request ID exists in the off chance that a packet is sent out-of-order. Of course, this library doesn't support
* concurrent actions, so it's somewhat academic, here.
*
* @var int
* @see self::_send_sftp_packet()
* @access private
*/
var $request_id = false;
/**
* The Packet Type
*
* The request ID exists in the off chance that a packet is sent out-of-order. Of course, this library doesn't support
* concurrent actions, so it's somewhat academic, here.
*
* @var int
* @see self::_get_sftp_packet()
* @access private
*/
var $packet_type = -1;
/**
* Packet Buffer
*
* @var string
* @see self::_get_sftp_packet()
* @access private
*/
var $packet_buffer = '';
/**
* Extensions supported by the server
*
* @var array
* @see self::_initChannel()
* @access private
*/
var $extensions = array();
/**
* Server SFTP version
*
* @var int
* @see self::_initChannel()
* @access private
*/
var $version;
/**
* Current working directory
*
* @var string
* @see self::realpath()
* @see self::chdir()
* @access private
*/
var $pwd = false;
/**
* Packet Type Log
*
* @see self::getLog()
* @var array
* @access private
*/
var $packet_type_log = array();
/**
* Packet Log
*
* @see self::getLog()
* @var array
* @access private
*/
var $packet_log = array();
/**
* Error information
*
* @see self::getSFTPErrors()
* @see self::getLastSFTPError()
* @var array
* @access private
*/
var $sftp_errors = array();
/**
* Stat Cache
*
* Rather than always having to open a directory and close it immediately there after to see if a file is a directory
* we'll cache the results.
*
* @see self::_update_stat_cache()
* @see self::_remove_from_stat_cache()
* @see self::_query_stat_cache()
* @var array
* @access private
*/
var $stat_cache = array();
/**
* Max SFTP Packet Size
*
* @see self::__construct()
* @see self::get()
* @var array
* @access private
*/
var $max_sftp_packet;
/**
* Stat Cache Flag
*
* @see self::disableStatCache()
* @see self::enableStatCache()
* @var bool
* @access private
*/
var $use_stat_cache = true;
/**
* Sort Options
*
* @see self::_comparator()
* @see self::setListOrder()
* @var array
* @access private
*/
var $sortOptions = array();
/**
* Canonicalization Flag
*
* Determines whether or not paths should be canonicalized before being
* passed on to the remote server.
*
* @see self::enablePathCanonicalization()
* @see self::disablePathCanonicalization()
* @see self::realpath()
* @var bool
* @access private
*/
var $canonicalize_paths = true;
/**
* Default Constructor.
*
* Connects to an SFTP server
*
* @param string $host
* @param int $port
* @param int $timeout
* @return \phpseclib\Net\SFTP
* @access public
*/
function __construct($host, $port = 22, $timeout = 10)
{
}
/**
* Login
*
* @param string $username
* @param string $password
* @return bool
* @access public
*/
function login($username)
{
}
/**
* Disable the stat cache
*
* @access public
*/
function disableStatCache()
{
}
/**
* Enable the stat cache
*
* @access public
*/
function enableStatCache()
{
}
/**
* Clear the stat cache
*
* @access public
*/
function clearStatCache()
{
}
/**
* Enable path canonicalization
*
* @access public
*/
function enablePathCanonicalization()
{
}
/**
* Enable path canonicalization
*
* @access public
*/
function disablePathCanonicalization()
{
}
/**
* Returns the current directory name
*
* @return mixed
* @access public
*/
function pwd()
{
}
/**
* Logs errors
*
* @param string $response
* @param int $status
* @access public
*/
function _logError($response, $status = -1)
{
}
/**
* Returns canonicalized absolute pathname
*
* realpath() expands all symbolic links and resolves references to '/./', '/../' and extra '/' characters in the input
* path and returns the canonicalized absolute pathname.
*
* @param string $path
* @return mixed
* @access public
*/
function realpath($path)
{
}
/**
* Canonicalize the Server-Side Path Name
*
* SFTP doesn't provide a mechanism by which the current working directory can be changed, so we'll emulate it. Returns
* the absolute (canonicalized) path.
*
* If canonicalize_paths has been disabled using disablePathCanonicalization(), $path is returned as-is.
*
* @see self::chdir()
* @see self::disablePathCanonicalization()
* @param string $path
* @return mixed
* @access private
*/
function _realpath($path)
{
}
/**
* Changes the current directory
*
* @param string $dir
* @return bool
* @access public
*/
function chdir($dir)
{
}
/**
* Returns a list of files in the given directory
*
* @param string $dir
* @param bool $recursive
* @return mixed
* @access public
*/
function nlist($dir = '.', $recursive = false)
{
}
/**
* Helper method for nlist
*
* @param string $dir
* @param bool $recursive
* @param string $relativeDir
* @return mixed
* @access private
*/
function _nlist_helper($dir, $recursive, $relativeDir)
{
}
/**
* Returns a detailed list of files in the given directory
*
* @param string $dir
* @param bool $recursive
* @return mixed
* @access public
*/
function rawlist($dir = '.', $recursive = false)
{
}
/**
* Reads a list, be it detailed or not, of files in the given directory
*
* @param string $dir
* @param bool $raw
* @return mixed
* @access private
*/
function _list($dir, $raw = true)
{
}
/**
* Compares two rawlist entries using parameters set by setListOrder()
*
* Intended for use with uasort()
*
* @param array $a
* @param array $b
* @return int
* @access private
*/
function _comparator($a, $b)
{
}
/**
* Defines how nlist() and rawlist() will be sorted - if at all.
*
* If sorting is enabled directories and files will be sorted independently with
* directories appearing before files in the resultant array that is returned.
*
* Any parameter returned by stat is a valid sort parameter for this function.
* Filename comparisons are case insensitive.
*
* Examples:
*
* $sftp->setListOrder('filename', SORT_ASC);
* $sftp->setListOrder('size', SORT_DESC, 'filename', SORT_ASC);
* $sftp->setListOrder(true);
* Separates directories from files but doesn't do any sorting beyond that
* $sftp->setListOrder();
* Don't do any sort of sorting
*
* @access public
*/
function setListOrder()
{
}
/**
* Returns the file size, in bytes, or false, on failure
*
* Files larger than 4GB will show up as being exactly 4GB.
*
* @param string $filename
* @return mixed
* @access public
*/
function size($filename)
{
}
/**
* Save files / directories to cache
*
* @param string $path
* @param mixed $value
* @access private
*/
function _update_stat_cache($path, $value)
{
}
/**
* Remove files / directories from cache
*
* @param string $path
* @return bool
* @access private
*/
function _remove_from_stat_cache($path)
{
}
/**
* Checks cache for path
*
* Mainly used by file_exists
*
* @param string $dir
* @return mixed
* @access private
*/
function _query_stat_cache($path)
{
}
/**
* Returns general information about a file.
*
* Returns an array on success and false otherwise.
*
* @param string $filename
* @return mixed
* @access public
*/
function stat($filename)
{
}
/**
* Returns general information about a file or symbolic link.
*
* Returns an array on success and false otherwise.
*
* @param string $filename
* @return mixed
* @access public
*/
function lstat($filename)
{
}
/**
* Returns general information about a file or symbolic link
*
* Determines information without calling \phpseclib\Net\SFTP::realpath().
* The second parameter can be either NET_SFTP_STAT or NET_SFTP_LSTAT.
*
* @param string $filename
* @param int $type
* @return mixed
* @access private
*/
function _stat($filename, $type)
{
}
/**
* Truncates a file to a given length
*
* @param string $filename
* @param int $new_size
* @return bool
* @access public
*/
function truncate($filename, $new_size)
{
}
/**
* Sets access and modification time of file.
*
* If the file does not exist, it will be created.
*
* @param string $filename
* @param int $time
* @param int $atime
* @return bool
* @access public
*/
function touch($filename, $time = null, $atime = null)
{
}
/**
* Changes file or directory owner
*
* Returns true on success or false on error.
*
* @param string $filename
* @param int $uid
* @param bool $recursive
* @return bool
* @access public
*/
function chown($filename, $uid, $recursive = false)
{
}
/**
* Changes file or directory group
*
* Returns true on success or false on error.
*
* @param string $filename
* @param int $gid
* @param bool $recursive
* @return bool
* @access public
*/
function chgrp($filename, $gid, $recursive = false)
{
}
/**
* Set permissions on a file.
*
* Returns the new file permissions on success or false on error.
* If $recursive is true than this just returns true or false.
*
* @param int $mode
* @param string $filename
* @param bool $recursive
* @return mixed
* @access public
*/
function chmod($mode, $filename, $recursive = false)
{
}
/**
* Sets information about a file
*
* @param string $filename
* @param string $attr
* @param bool $recursive
* @return bool
* @access private
*/
function _setstat($filename, $attr, $recursive)
{
}
/**
* Recursively sets information on directories on the SFTP server
*
* Minimizes directory lookups and SSH_FXP_STATUS requests for speed.
*
* @param string $path
* @param string $attr
* @param int $i
* @return bool
* @access private
*/
function _setstat_recursive($path, $attr, &$i)
{
}
/**
* Return the target of a symbolic link
*
* @param string $link
* @return mixed
* @access public
*/
function readlink($link)
{
}
/**
* Create a symlink
*
* symlink() creates a symbolic link to the existing target with the specified name link.
*
* @param string $target
* @param string $link
* @return bool
* @access public
*/
function symlink($target, $link)
{
}
/**
* Creates a directory.
*
* @param string $dir
* @return bool
* @access public
*/
function mkdir($dir, $mode = -1, $recursive = false)
{
}
/**
* Helper function for directory creation
*
* @param string $dir
* @return bool
* @access private
*/
function _mkdir_helper($dir, $attr)
{
}
/**
* Removes a directory.
*
* @param string $dir
* @return bool
* @access public
*/
function rmdir($dir)
{
}
/**
* Uploads a file to the SFTP server.
*
* By default, \phpseclib\Net\SFTP::put() does not read from the local filesystem. $data is dumped directly into $remote_file.
* So, for example, if you set $data to 'filename.ext' and then do \phpseclib\Net\SFTP::get(), you will get a file, twelve bytes
* long, containing 'filename.ext' as its contents.
*
* Setting $mode to self::SOURCE_LOCAL_FILE will change the above behavior. With self::SOURCE_LOCAL_FILE, $remote_file will
* contain as many bytes as filename.ext does on your local filesystem. If your filename.ext is 1MB then that is how
* large $remote_file will be, as well.
*
* Setting $mode to self::SOURCE_CALLBACK will use $data as callback function, which gets only one parameter -- number of bytes to return, and returns a string if there is some data or null if there is no more data
*
* If $data is a resource then it'll be used as a resource instead.
*
* Currently, only binary mode is supported. As such, if the line endings need to be adjusted, you will need to take
* care of that, yourself.
*
* $mode can take an additional two parameters - self::RESUME and self::RESUME_START. These are bitwise AND'd with
* $mode. So if you want to resume upload of a 300mb file on the local file system you'd set $mode to the following:
*
* self::SOURCE_LOCAL_FILE | self::RESUME
*
* If you wanted to simply append the full contents of a local file to the full contents of a remote file you'd replace
* self::RESUME with self::RESUME_START.
*
* If $mode & (self::RESUME | self::RESUME_START) then self::RESUME_START will be assumed.
*
* $start and $local_start give you more fine grained control over this process and take precident over self::RESUME
* when they're non-negative. ie. $start could let you write at the end of a file (like self::RESUME) or in the middle
* of one. $local_start could let you start your reading from the end of a file (like self::RESUME_START) or in the
* middle of one.
*
* Setting $local_start to > 0 or $mode | self::RESUME_START doesn't do anything unless $mode | self::SOURCE_LOCAL_FILE.
*
* @param string $remote_file
* @param string|resource $data
* @param int $mode
* @param int $start
* @param int $local_start
* @param callable|null $progressCallback
* @return bool
* @access public
* @internal ASCII mode for SFTPv4/5/6 can be supported by adding a new function - \phpseclib\Net\SFTP::setMode().
*/
function put($remote_file, $data, $mode = self::SOURCE_STRING, $start = -1, $local_start = -1, $progressCallback = null)
{
}
/**
* Reads multiple successive SSH_FXP_WRITE responses
*
* Sending an SSH_FXP_WRITE packet and immediately reading its response isn't as efficient as blindly sending out $i
* SSH_FXP_WRITEs, in succession, and then reading $i responses.
*
* @param int $i
* @return bool
* @access private
*/
function _read_put_responses($i)
{
}
/**
* Close handle
*
* @param string $handle
* @return bool
* @access private
*/
function _close_handle($handle)
{
}
/**
* Downloads a file from the SFTP server.
*
* Returns a string containing the contents of $remote_file if $local_file is left undefined or a boolean false if
* the operation was unsuccessful. If $local_file is defined, returns true or false depending on the success of the
* operation.
*
* $offset and $length can be used to download files in chunks.
*
* @param string $remote_file
* @param string $local_file
* @param int $offset
* @param int $length
* @return mixed
* @access public
*/
function get($remote_file, $local_file = false, $offset = 0, $length = -1)
{
}
/**
* Deletes a file on the SFTP server.
*
* @param string $path
* @param bool $recursive
* @return bool
* @access public
*/
function delete($path, $recursive = true)
{
}
/**
* Recursively deletes directories on the SFTP server
*
* Minimizes directory lookups and SSH_FXP_STATUS requests for speed.
*
* @param string $path
* @param int $i
* @return bool
* @access private
*/
function _delete_recursive($path, &$i)
{
}
/**
* Checks whether a file or directory exists
*
* @param string $path
* @return bool
* @access public
*/
function file_exists($path)
{
}
/**
* Tells whether the filename is a directory
*
* @param string $path
* @return bool
* @access public
*/
function is_dir($path)
{
}
/**
* Tells whether the filename is a regular file
*
* @param string $path
* @return bool
* @access public
*/
function is_file($path)
{
}
/**
* Tells whether the filename is a symbolic link
*
* @param string $path
* @return bool
* @access public
*/
function is_link($path)
{
}
/**
* Tells whether a file exists and is readable
*
* @param string $path
* @return bool
* @access public
*/
function is_readable($path)
{
}
/**
* Tells whether the filename is writable
*
* @param string $path
* @return bool
* @access public
*/
function is_writable($path)
{
}
/**
* Tells whether the filename is writeable
*
* Alias of is_writable
*
* @param string $path
* @return bool
* @access public
*/
function is_writeable($path)
{
}
/**
* Gets last access time of file
*
* @param string $path
* @return mixed
* @access public
*/
function fileatime($path)
{
}
/**
* Gets file modification time
*
* @param string $path
* @return mixed
* @access public
*/
function filemtime($path)
{
}
/**
* Gets file permissions
*
* @param string $path
* @return mixed
* @access public
*/
function fileperms($path)
{
}
/**
* Gets file owner
*
* @param string $path
* @return mixed
* @access public
*/
function fileowner($path)
{
}
/**
* Gets file group
*
* @param string $path
* @return mixed
* @access public
*/
function filegroup($path)
{
}
/**
* Gets file size
*
* @param string $path
* @return mixed
* @access public
*/
function filesize($path)
{
}
/**
* Gets file type
*
* @param string $path
* @return mixed
* @access public
*/
function filetype($path)
{
}
/**
* Return a stat properity
*
* Uses cache if appropriate.
*
* @param string $path
* @param string $prop
* @return mixed
* @access private
*/
function _get_stat_cache_prop($path, $prop)
{
}
/**
* Return an lstat properity
*
* Uses cache if appropriate.
*
* @param string $path
* @param string $prop
* @return mixed
* @access private
*/
function _get_lstat_cache_prop($path, $prop)
{
}
/**
* Return a stat or lstat properity
*
* Uses cache if appropriate.
*
* @param string $path
* @param string $prop
* @return mixed
* @access private
*/
function _get_xstat_cache_prop($path, $prop, $type)
{
}
/**
* Renames a file or a directory on the SFTP server
*
* @param string $oldname
* @param string $newname
* @return bool
* @access public
*/
function rename($oldname, $newname)
{
}
/**
* Parse Attributes
*
* See '7. File Attributes' of draft-ietf-secsh-filexfer-13 for more info.
*
* @param string $response
* @return array
* @access private
*/
function _parseAttributes(&$response)
{
}
/**
* Attempt to identify the file type
*
* Quoting the SFTP RFC, "Implementations MUST NOT send bits that are not defined" but they seem to anyway
*
* @param int $mode
* @return int
* @access private
*/
function _parseMode($mode)
{
}
/**
* Parse Longname
*
* SFTPv3 doesn't provide any easy way of identifying a file type. You could try to open
* a file as a directory and see if an error is returned or you could try to parse the
* SFTPv3-specific longname field of the SSH_FXP_NAME packet. That's what this function does.
* The result is returned using the
* {@link http://tools.ietf.org/html/draft-ietf-secsh-filexfer-04#section-5.2 SFTPv4 type constants}.
*
* If the longname is in an unrecognized format bool(false) is returned.
*
* @param string $longname
* @return mixed
* @access private
*/
function _parseLongname($longname)
{
}
/**
* Sends SFTP Packets
*
* See '6. General Packet Format' of draft-ietf-secsh-filexfer-13 for more info.
*
* @param int $type
* @param string $data
* @see self::_get_sftp_packet()
* @see self::_send_channel_packet()
* @return bool
* @access private
*/
function _send_sftp_packet($type, $data)
{
}
/**
* Receives SFTP Packets
*
* See '6. General Packet Format' of draft-ietf-secsh-filexfer-13 for more info.
*
* Incidentally, the number of SSH_MSG_CHANNEL_DATA messages has no bearing on the number of SFTP packets present.
* There can be one SSH_MSG_CHANNEL_DATA messages containing two SFTP packets or there can be two SSH_MSG_CHANNEL_DATA
* messages containing one SFTP packet.
*
* @see self::_send_sftp_packet()
* @return string
* @access private
*/
function _get_sftp_packet()
{
}
/**
* Returns a log of the packets that have been sent and received.
*
* Returns a string if NET_SFTP_LOGGING == NET_SFTP_LOG_COMPLEX, an array if NET_SFTP_LOGGING == NET_SFTP_LOG_SIMPLE and false if !defined('NET_SFTP_LOGGING')
*
* @access public
* @return string or Array
*/
function getSFTPLog()
{
}
/**
* Returns all errors
*
* @return array
* @access public
*/
function getSFTPErrors()
{
}
/**
* Returns the last error
*
* @return string
* @access public
*/
function getLastSFTPError()
{
}
/**
* Get supported SFTP versions
*
* @return array
* @access public
*/
function getSupportedVersions()
{
}
/**
* Disconnect
*
* @param int $reason
* @return bool
* @access private
*/
function _disconnect($reason)
{
}
}
/**
* Pure-PHP implementations of SCP.
*
* @package SCP
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class SCP
{
/**#@+
* @access public
* @see \phpseclib\Net\SCP::put()
*/
/**
* Reads data from a local file.
*/
const SOURCE_LOCAL_FILE = 1;
/**
* Reads data from a string.
*/
const SOURCE_STRING = 2;
/**#@-*/
/**#@+
* @access private
* @see \phpseclib\Net\SCP::_send()
* @see \phpseclib\Net\SCP::_receive()
*/
/**
* SSH1 is being used.
*/
const MODE_SSH1 = 1;
/**
* SSH2 is being used.
*/
const MODE_SSH2 = 2;
/**#@-*/
/**
* SSH Object
*
* @var object
* @access private
*/
var $ssh;
/**
* Packet Size
*
* @var int
* @access private
*/
var $packet_size;
/**
* Mode
*
* @var int
* @access private
*/
var $mode;
/**
* Default Constructor.
*
* Connects to an SSH server
*
* @param \phpseclib\Net\SSH1|\phpseclib\Net\SSH2 $ssh
* @return \phpseclib\Net\SCP
* @access public
*/
function __construct($ssh)
{
}
/**
* Uploads a file to the SCP server.
*
* By default, \phpseclib\Net\SCP::put() does not read from the local filesystem. $data is dumped directly into $remote_file.
* So, for example, if you set $data to 'filename.ext' and then do \phpseclib\Net\SCP::get(), you will get a file, twelve bytes
* long, containing 'filename.ext' as its contents.
*
* Setting $mode to self::SOURCE_LOCAL_FILE will change the above behavior. With self::SOURCE_LOCAL_FILE, $remote_file will
* contain as many bytes as filename.ext does on your local filesystem. If your filename.ext is 1MB then that is how
* large $remote_file will be, as well.
*
* Currently, only binary mode is supported. As such, if the line endings need to be adjusted, you will need to take
* care of that, yourself.
*
* @param string $remote_file
* @param string $data
* @param int $mode
* @param callable $callback
* @return bool
* @access public
*/
function put($remote_file, $data, $mode = self::SOURCE_STRING, $callback = null)
{
}
/**
* Downloads a file from the SCP server.
*
* Returns a string containing the contents of $remote_file if $local_file is left undefined or a boolean false if
* the operation was unsuccessful. If $local_file is defined, returns true or false depending on the success of the
* operation
*
* @param string $remote_file
* @param string $local_file
* @return mixed
* @access public
*/
function get($remote_file, $local_file = false)
{
}
/**
* Sends a packet to an SSH server
*
* @param string $data
* @access private
*/
function _send($data)
{
}
/**
* Receives a packet from an SSH server
*
* @return string
* @access private
*/
function _receive()
{
}
/**
* Closes the connection to an SSH server
*
* @access private
*/
function _close()
{
}
}
/**
* Pure-PHP implementation of SSHv1.
*
* @package SSH1
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class SSH1
{
/**#@+
* Encryption Methods
*
* @see \phpseclib\Net\SSH1::getSupportedCiphers()
* @access public
*/
/**
* No encryption
*
* Not supported.
*/
const CIPHER_NONE = 0;
/**
* IDEA in CFB mode
*
* Not supported.
*/
const CIPHER_IDEA = 1;
/**
* DES in CBC mode
*/
const CIPHER_DES = 2;
/**
* Triple-DES in CBC mode
*
* All implementations are required to support this
*/
const CIPHER_3DES = 3;
/**
* TRI's Simple Stream encryption CBC
*
* Not supported nor is it defined in the official SSH1 specs. OpenSSH, however, does define it (see cipher.h),
* although it doesn't use it (see cipher.c)
*/
const CIPHER_BROKEN_TSS = 4;
/**
* RC4
*
* Not supported.
*
* @internal According to the SSH1 specs:
*
* "The first 16 bytes of the session key are used as the key for
* the server to client direction. The remaining 16 bytes are used
* as the key for the client to server direction. This gives
* independent 128-bit keys for each direction."
*
* This library currently only supports encryption when the same key is being used for both directions. This is
* because there's only one $crypto object. Two could be added ($encrypt and $decrypt, perhaps).
*/
const CIPHER_RC4 = 5;
/**
* Blowfish
*
* Not supported nor is it defined in the official SSH1 specs. OpenSSH, however, defines it (see cipher.h) and
* uses it (see cipher.c)
*/
const CIPHER_BLOWFISH = 6;
/**#@-*/
/**#@+
* Authentication Methods
*
* @see \phpseclib\Net\SSH1::getSupportedAuthentications()
* @access public
*/
/**
* .rhosts or /etc/hosts.equiv
*/
const AUTH_RHOSTS = 1;
/**
* pure RSA authentication
*/
const AUTH_RSA = 2;
/**
* password authentication
*
* This is the only method that is supported by this library.
*/
const AUTH_PASSWORD = 3;
/**
* .rhosts with RSA host authentication
*/
const AUTH_RHOSTS_RSA = 4;
/**#@-*/
/**#@+
* Terminal Modes
*
* @link http://3sp.com/content/developer/maverick-net/docs/Maverick.SSH.PseudoTerminalModesMembers.html
* @access private
*/
const TTY_OP_END = 0;
/**#@-*/
/**
* The Response Type
*
* @see \phpseclib\Net\SSH1::_get_binary_packet()
* @access private
*/
const RESPONSE_TYPE = 1;
/**
* The Response Data
*
* @see \phpseclib\Net\SSH1::_get_binary_packet()
* @access private
*/
const RESPONSE_DATA = 2;
/**#@+
* Execution Bitmap Masks
*
* @see \phpseclib\Net\SSH1::bitmap
* @access private
*/
const MASK_CONSTRUCTOR = 0x1;
const MASK_CONNECTED = 0x2;
const MASK_LOGIN = 0x4;
const MASK_SHELL = 0x8;
/**#@-*/
/**#@+
* @access public
* @see \phpseclib\Net\SSH1::getLog()
*/
/**
* Returns the message numbers
*/
const LOG_SIMPLE = 1;
/**
* Returns the message content
*/
const LOG_COMPLEX = 2;
/**
* Outputs the content real-time
*/
const LOG_REALTIME = 3;
/**
* Dumps the content real-time to a file
*/
const LOG_REALTIME_FILE = 4;
/**#@-*/
/**#@+
* @access public
* @see \phpseclib\Net\SSH1::read()
*/
/**
* Returns when a string matching $expect exactly is found
*/
const READ_SIMPLE = 1;
/**
* Returns when a string matching the regular expression $expect is found
*/
const READ_REGEX = 2;
/**#@-*/
/**
* The SSH identifier
*
* @var string
* @access private
*/
var $identifier = 'SSH-1.5-phpseclib';
/**
* The Socket Object
*
* @var object
* @access private
*/
var $fsock;
/**
* The cryptography object
*
* @var object
* @access private
*/
var $crypto = false;
/**
* Execution Bitmap
*
* The bits that are set represent functions that have been called already. This is used to determine
* if a requisite function has been successfully executed. If not, an error should be thrown.
*
* @var int
* @access private
*/
var $bitmap = 0;
/**
* The Server Key Public Exponent
*
* Logged for debug purposes
*
* @see self::getServerKeyPublicExponent()
* @var string
* @access private
*/
var $server_key_public_exponent;
/**
* The Server Key Public Modulus
*
* Logged for debug purposes
*
* @see self::getServerKeyPublicModulus()
* @var string
* @access private
*/
var $server_key_public_modulus;
/**
* The Host Key Public Exponent
*
* Logged for debug purposes
*
* @see self::getHostKeyPublicExponent()
* @var string
* @access private
*/
var $host_key_public_exponent;
/**
* The Host Key Public Modulus
*
* Logged for debug purposes
*
* @see self::getHostKeyPublicModulus()
* @var string
* @access private
*/
var $host_key_public_modulus;
/**
* Supported Ciphers
*
* Logged for debug purposes
*
* @see self::getSupportedCiphers()
* @var array
* @access private
*/
var $supported_ciphers = array(self::CIPHER_NONE => 'No encryption', self::CIPHER_IDEA => 'IDEA in CFB mode', self::CIPHER_DES => 'DES in CBC mode', self::CIPHER_3DES => 'Triple-DES in CBC mode', self::CIPHER_BROKEN_TSS => 'TRI\'s Simple Stream encryption CBC', self::CIPHER_RC4 => 'RC4', self::CIPHER_BLOWFISH => 'Blowfish');
/**
* Supported Authentications
*
* Logged for debug purposes
*
* @see self::getSupportedAuthentications()
* @var array
* @access private
*/
var $supported_authentications = array(self::AUTH_RHOSTS => '.rhosts or /etc/hosts.equiv', self::AUTH_RSA => 'pure RSA authentication', self::AUTH_PASSWORD => 'password authentication', self::AUTH_RHOSTS_RSA => '.rhosts with RSA host authentication');
/**
* Server Identification
*
* @see self::getServerIdentification()
* @var string
* @access private
*/
var $server_identification = '';
/**
* Protocol Flags
*
* @see self::__construct()
* @var array
* @access private
*/
var $protocol_flags = array();
/**
* Protocol Flag Log
*
* @see self::getLog()
* @var array
* @access private
*/
var $protocol_flag_log = array();
/**
* Message Log
*
* @see self::getLog()
* @var array
* @access private
*/
var $message_log = array();
/**
* Real-time log file pointer
*
* @see self::_append_log()
* @var resource
* @access private
*/
var $realtime_log_file;
/**
* Real-time log file size
*
* @see self::_append_log()
* @var int
* @access private
*/
var $realtime_log_size;
/**
* Real-time log file wrap boolean
*
* @see self::_append_log()
* @var bool
* @access private
*/
var $realtime_log_wrap;
/**
* Interactive Buffer
*
* @see self::read()
* @var array
* @access private
*/
var $interactiveBuffer = '';
/**
* Timeout
*
* @see self::setTimeout()
* @access private
*/
var $timeout;
/**
* Current Timeout
*
* @see self::_get_channel_packet()
* @access private
*/
var $curTimeout;
/**
* Log Boundary
*
* @see self::_format_log()
* @access private
*/
var $log_boundary = ':';
/**
* Log Long Width
*
* @see self::_format_log()
* @access private
*/
var $log_long_width = 65;
/**
* Log Short Width
*
* @see self::_format_log()
* @access private
*/
var $log_short_width = 16;
/**
* Hostname
*
* @see self::__construct()
* @see self::_connect()
* @var string
* @access private
*/
var $host;
/**
* Port Number
*
* @see self::__construct()
* @see self::_connect()
* @var int
* @access private
*/
var $port;
/**
* Timeout for initial connection
*
* Set by the constructor call. Calling setTimeout() is optional. If it's not called functions like
* exec() won't timeout unless some PHP setting forces it too. The timeout specified in the constructor,
* however, is non-optional. There will be a timeout, whether or not you set it. If you don't it'll be
* 10 seconds. It is used by fsockopen() in that function.
*
* @see self::__construct()
* @see self::_connect()
* @var int
* @access private
*/
var $connectionTimeout;
/**
* Default cipher
*
* @see self::__construct()
* @see self::_connect()
* @var int
* @access private
*/
var $cipher;
/**
* Default Constructor.
*
* Connects to an SSHv1 server
*
* @param string $host
* @param int $port
* @param int $timeout
* @param int $cipher
* @return \phpseclib\Net\SSH1
* @access public
*/
function __construct($host, $port = 22, $timeout = 10, $cipher = self::CIPHER_3DES)
{
}
/**
* Connect to an SSHv1 server
*
* @return bool
* @access private
*/
function _connect()
{
}
/**
* Login
*
* @param string $username
* @param string $password
* @return bool
* @access public
*/
function login($username, $password = '')
{
}
/**
* Set Timeout
*
* $ssh->exec('ping 127.0.0.1'); on a Linux host will never return and will run indefinitely. setTimeout() makes it so it'll timeout.
* Setting $timeout to false or 0 will mean there is no timeout.
*
* @param mixed $timeout
*/
function setTimeout($timeout)
{
}
/**
* Executes a command on a non-interactive shell, returns the output, and quits.
*
* An SSH1 server will close the connection after a command has been executed on a non-interactive shell. SSH2
* servers don't, however, this isn't an SSH2 client. The way this works, on the server, is by initiating a
* shell with the -s option, as discussed in the following links:
*
* {@link http://www.faqs.org/docs/bashman/bashref_65.html http://www.faqs.org/docs/bashman/bashref_65.html}
* {@link http://www.faqs.org/docs/bashman/bashref_62.html http://www.faqs.org/docs/bashman/bashref_62.html}
*
* To execute further commands, a new \phpseclib\Net\SSH1 object will need to be created.
*
* Returns false on failure and the output, otherwise.
*
* @see self::interactiveRead()
* @see self::interactiveWrite()
* @param string $cmd
* @return mixed
* @access public
*/
function exec($cmd, $block = true)
{
}
/**
* Creates an interactive shell
*
* @see self::interactiveRead()
* @see self::interactiveWrite()
* @return bool
* @access private
*/
function _initShell()
{
}
/**
* Inputs a command into an interactive shell.
*
* @see self::interactiveWrite()
* @param string $cmd
* @return bool
* @access public
*/
function write($cmd)
{
}
/**
* Returns the output of an interactive shell when there's a match for $expect
*
* $expect can take the form of a string literal or, if $mode == self::READ_REGEX,
* a regular expression.
*
* @see self::write()
* @param string $expect
* @param int $mode
* @return bool
* @access public
*/
function read($expect, $mode = self::READ_SIMPLE)
{
}
/**
* Inputs a command into an interactive shell.
*
* @see self::interactiveRead()
* @param string $cmd
* @return bool
* @access public
*/
function interactiveWrite($cmd)
{
}
/**
* Returns the output of an interactive shell when no more output is available.
*
* Requires PHP 4.3.0 or later due to the use of the stream_select() function. If you see stuff like
* "^[[00m", you're seeing ANSI escape codes. According to
* {@link http://support.microsoft.com/kb/101875 How to Enable ANSI.SYS in a Command Window}, "Windows NT
* does not support ANSI escape sequences in Win32 Console applications", so if you're a Windows user,
* there's not going to be much recourse.
*
* @see self::interactiveRead()
* @return string
* @access public
*/
function interactiveRead()
{
}
/**
* Disconnect
*
* @access public
*/
function disconnect()
{
}
/**
* Destructor.
*
* Will be called, automatically, if you're supporting just PHP5. If you're supporting PHP4, you'll need to call
* disconnect().
*
* @access public
*/
function __destruct()
{
}
/**
* Disconnect
*
* @param string $msg
* @access private
*/
function _disconnect($msg = 'Client Quit')
{
}
/**
* Gets Binary Packets
*
* See 'The Binary Packet Protocol' of protocol-1.5.txt for more info.
*
* Also, this function could be improved upon by adding detection for the following exploit:
* http://www.securiteam.com/securitynews/5LP042K3FY.html
*
* @see self::_send_binary_packet()
* @return array
* @access private
*/
function _get_binary_packet()
{
}
/**
* Sends Binary Packets
*
* Returns true on success, false on failure.
*
* @see self::_get_binary_packet()
* @param string $data
* @return bool
* @access private
*/
function _send_binary_packet($data)
{
}
/**
* Cyclic Redundancy Check (CRC)
*
* PHP's crc32 function is implemented slightly differently than the one that SSH v1 uses, so
* we've reimplemented it. A more detailed discussion of the differences can be found after
* $crc_lookup_table's initialization.
*
* @see self::_get_binary_packet()
* @see self::_send_binary_packet()
* @param string $data
* @return int
* @access private
*/
function _crc($data)
{
}
/**
* String Shift
*
* Inspired by array_shift
*
* @param string $string
* @param int $index
* @return string
* @access private
*/
function _string_shift(&$string, $index = 1)
{
}
/**
* RSA Encrypt
*
* Returns mod(pow($m, $e), $n), where $n should be the product of two (large) primes $p and $q and where $e
* should be a number with the property that gcd($e, ($p - 1) * ($q - 1)) == 1. Could just make anything that
* calls this call modexp, instead, but I think this makes things clearer, maybe...
*
* @see self::__construct()
* @param BigInteger $m
* @param array $key
* @return BigInteger
* @access private
*/
function _rsa_crypt($m, $key)
{
}
/**
* Define Array
*
* Takes any number of arrays whose indices are integers and whose values are strings and defines a bunch of
* named constants from it, using the value as the name of the constant and the index as the value of the constant.
* If any of the constants that would be defined already exists, none of the constants will be defined.
*
* @param array $array
* @access private
*/
function _define_array()
{
}
/**
* Returns a log of the packets that have been sent and received.
*
* Returns a string if NET_SSH1_LOGGING == self::LOG_COMPLEX, an array if NET_SSH1_LOGGING == self::LOG_SIMPLE and false if !defined('NET_SSH1_LOGGING')
*
* @access public
* @return array|false|string
*/
function getLog()
{
}
/**
* Formats a log for printing
*
* @param array $message_log
* @param array $message_number_log
* @access private
* @return string
*/
function _format_log($message_log, $message_number_log)
{
}
/**
* Helper function for _format_log
*
* For use with preg_replace_callback()
*
* @param array $matches
* @access private
* @return string
*/
function _format_log_helper($matches)
{
}
/**
* Return the server key public exponent
*
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function.
*
* @param bool $raw_output
* @return string
* @access public
*/
function getServerKeyPublicExponent($raw_output = false)
{
}
/**
* Return the server key public modulus
*
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function.
*
* @param bool $raw_output
* @return string
* @access public
*/
function getServerKeyPublicModulus($raw_output = false)
{
}
/**
* Return the host key public exponent
*
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function.
*
* @param bool $raw_output
* @return string
* @access public
*/
function getHostKeyPublicExponent($raw_output = false)
{
}
/**
* Return the host key public modulus
*
* Returns, by default, the base-10 representation. If $raw_output is set to true, returns, instead,
* the raw bytes. This behavior is similar to PHP's md5() function.
*
* @param bool $raw_output
* @return string
* @access public
*/
function getHostKeyPublicModulus($raw_output = false)
{
}
/**
* Return a list of ciphers supported by SSH1 server.
*
* Just because a cipher is supported by an SSH1 server doesn't mean it's supported by this library. If $raw_output
* is set to true, returns, instead, an array of constants. ie. instead of array('Triple-DES in CBC mode'), you'll
* get array(self::CIPHER_3DES).
*
* @param bool $raw_output
* @return array
* @access public
*/
function getSupportedCiphers($raw_output = false)
{
}
/**
* Return a list of authentications supported by SSH1 server.
*
* Just because a cipher is supported by an SSH1 server doesn't mean it's supported by this library. If $raw_output
* is set to true, returns, instead, an array of constants. ie. instead of array('password authentication'), you'll
* get array(self::AUTH_PASSWORD).
*
* @param bool $raw_output
* @return array
* @access public
*/
function getSupportedAuthentications($raw_output = false)
{
}
/**
* Return the server identification.
*
* @return string
* @access public
*/
function getServerIdentification()
{
}
/**
* Logs data packets
*
* Makes sure that only the last 1MB worth of packets will be logged
*
* @param string $data
* @access private
*/
function _append_log($protocol_flags, $message)
{
}
}
}
namespace phpseclib\Math {
/**
* Pure-PHP arbitrary precision integer arithmetic library. Supports base-2, base-10, base-16, and base-256
* numbers.
*
* @package BigInteger
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class BigInteger
{
/**#@+
* Reduction constants
*
* @access private
* @see BigInteger::_reduce()
*/
/**
* @see BigInteger::_montgomery()
* @see BigInteger::_prepMontgomery()
*/
const MONTGOMERY = 0;
/**
* @see BigInteger::_barrett()
*/
const BARRETT = 1;
/**
* @see BigInteger::_mod2()
*/
const POWEROF2 = 2;
/**
* @see BigInteger::_remainder()
*/
const CLASSIC = 3;
/**
* @see BigInteger::__clone()
*/
const NONE = 4;
/**#@-*/
/**#@+
* Array constants
*
* Rather than create a thousands and thousands of new BigInteger objects in repeated function calls to add() and
* multiply() or whatever, we'll just work directly on arrays, taking them in as parameters and returning them.
*
* @access private
*/
/**
* $result[self::VALUE] contains the value.
*/
const VALUE = 0;
/**
* $result[self::SIGN] contains the sign.
*/
const SIGN = 1;
/**#@-*/
/**#@+
* @access private
* @see BigInteger::_montgomery()
* @see BigInteger::_barrett()
*/
/**
* Cache constants
*
* $cache[self::VARIABLE] tells us whether or not the cached data is still valid.
*/
const VARIABLE = 0;
/**
* $cache[self::DATA] contains the cached data.
*/
const DATA = 1;
/**#@-*/
/**#@+
* Mode constants.
*
* @access private
* @see BigInteger::__construct()
*/
/**
* To use the pure-PHP implementation
*/
const MODE_INTERNAL = 1;
/**
* To use the BCMath library
*
* (if enabled; otherwise, the internal implementation will be used)
*/
const MODE_BCMATH = 2;
/**
* To use the GMP library
*
* (if present; otherwise, either the BCMath or the internal implementation will be used)
*/
const MODE_GMP = 3;
/**#@-*/
/**
* Karatsuba Cutoff
*
* At what point do we switch between Karatsuba multiplication and schoolbook long multiplication?
*
* @access private
*/
const KARATSUBA_CUTOFF = 25;
/**#@+
* Static properties used by the pure-PHP implementation.
*
* @see __construct()
*/
protected static $base;
protected static $baseFull;
protected static $maxDigit;
protected static $msb;
/**
* $max10 in greatest $max10Len satisfying
* $max10 = 10**$max10Len <= 2**$base.
*/
protected static $max10;
/**
* $max10Len in greatest $max10Len satisfying
* $max10 = 10**$max10Len <= 2**$base.
*/
protected static $max10Len;
protected static $maxDigit2;
/**#@-*/
/**
* Holds the BigInteger's value.
*
* @var array
* @access private
*/
var $value;
/**
* Holds the BigInteger's magnitude.
*
* @var bool
* @access private
*/
var $is_negative = false;
/**
* Precision
*
* @see self::setPrecision()
* @access private
*/
var $precision = -1;
/**
* Precision Bitmask
*
* @see self::setPrecision()
* @access private
*/
var $bitmask = false;
/**
* Mode independent value used for serialization.
*
* If the bcmath or gmp extensions are installed $this->value will be a non-serializable resource, hence the need for
* a variable that'll be serializable regardless of whether or not extensions are being used. Unlike $this->value,
* however, $this->hex is only calculated when $this->__sleep() is called.
*
* @see self::__sleep()
* @see self::__wakeup()
* @var string
* @access private
*/
var $hex;
/**
* Converts base-2, base-10, base-16, and binary strings (base-256) to BigIntegers.
*
* If the second parameter - $base - is negative, then it will be assumed that the number's are encoded using
* two's compliment. The sole exception to this is -10, which is treated the same as 10 is.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger('0x32', 16); // 50 in base-16
*
* echo $a->toString(); // outputs 50
* ?>
* </code>
*
* @param $x base-10 number or base-$base number if $base set.
* @param int $base
* @return \phpseclib\Math\BigInteger
* @access public
*/
function __construct($x = 0, $base = 10)
{
}
/**
* Converts a BigInteger to a byte string (eg. base-256).
*
* Negative numbers are saved as positive numbers, unless $twos_compliment is set to true, at which point, they're
* saved as two's compliment.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger('65');
*
* echo $a->toBytes(); // outputs chr(65)
* ?>
* </code>
*
* @param bool $twos_compliment
* @return string
* @access public
* @internal Converts a base-2**26 number to base-2**8
*/
function toBytes($twos_compliment = false)
{
}
/**
* Converts a BigInteger to a hex string (eg. base-16)).
*
* Negative numbers are saved as positive numbers, unless $twos_compliment is set to true, at which point, they're
* saved as two's compliment.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger('65');
*
* echo $a->toHex(); // outputs '41'
* ?>
* </code>
*
* @param bool $twos_compliment
* @return string
* @access public
* @internal Converts a base-2**26 number to base-2**8
*/
function toHex($twos_compliment = false)
{
}
/**
* Converts a BigInteger to a bit string (eg. base-2).
*
* Negative numbers are saved as positive numbers, unless $twos_compliment is set to true, at which point, they're
* saved as two's compliment.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger('65');
*
* echo $a->toBits(); // outputs '1000001'
* ?>
* </code>
*
* @param bool $twos_compliment
* @return string
* @access public
* @internal Converts a base-2**26 number to base-2**2
*/
function toBits($twos_compliment = false)
{
}
/**
* Converts a BigInteger to a base-10 number.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger('50');
*
* echo $a->toString(); // outputs 50
* ?>
* </code>
*
* @return string
* @access public
* @internal Converts a base-2**26 number to base-10**7 (which is pretty much base-10)
*/
function toString()
{
}
/**
* Copy an object
*
* PHP5 passes objects by reference while PHP4 passes by value. As such, we need a function to guarantee
* that all objects are passed by value, when appropriate. More information can be found here:
*
* {@link http://php.net/language.oop5.basic#51624}
*
* @access public
* @see self::__clone()
* @return \phpseclib\Math\BigInteger
*/
function copy()
{
}
/**
* __toString() magic method
*
* Will be called, automatically, if you're supporting just PHP5. If you're supporting PHP4, you'll need to call
* toString().
*
* @access public
* @internal Implemented per a suggestion by Techie-Michael - thanks!
*/
function __toString()
{
}
/**
* __clone() magic method
*
* Although you can call BigInteger::__toString() directly in PHP5, you cannot call BigInteger::__clone() directly
* in PHP5. You can in PHP4 since it's not a magic method, but in PHP5, you have to call it by using the PHP5
* only syntax of $y = clone $x. As such, if you're trying to write an application that works on both PHP4 and
* PHP5, call BigInteger::copy(), instead.
*
* @access public
* @see self::copy()
* @return \phpseclib\Math\BigInteger
*/
function __clone()
{
}
/**
* __sleep() magic method
*
* Will be called, automatically, when serialize() is called on a BigInteger object.
*
* @see self::__wakeup()
* @access public
*/
function __sleep()
{
}
/**
* __wakeup() magic method
*
* Will be called, automatically, when unserialize() is called on a BigInteger object.
*
* @see self::__sleep()
* @access public
*/
function __wakeup()
{
}
/**
* __debugInfo() magic method
*
* Will be called, automatically, when print_r() or var_dump() are called
*
* @access public
*/
function __debugInfo()
{
}
/**
* Adds two BigIntegers.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger('10');
* $b = new \phpseclib\Math\BigInteger('20');
*
* $c = $a->add($b);
*
* echo $c->toString(); // outputs 30
* ?>
* </code>
*
* @param \phpseclib\Math\BigInteger $y
* @return \phpseclib\Math\BigInteger
* @access public
* @internal Performs base-2**52 addition
*/
function add($y)
{
}
/**
* Performs addition.
*
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
* @param bool $y_negative
* @return array
* @access private
*/
function _add($x_value, $x_negative, $y_value, $y_negative)
{
}
/**
* Subtracts two BigIntegers.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger('10');
* $b = new \phpseclib\Math\BigInteger('20');
*
* $c = $a->subtract($b);
*
* echo $c->toString(); // outputs -10
* ?>
* </code>
*
* @param \phpseclib\Math\BigInteger $y
* @return \phpseclib\Math\BigInteger
* @access public
* @internal Performs base-2**52 subtraction
*/
function subtract($y)
{
}
/**
* Performs subtraction.
*
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
* @param bool $y_negative
* @return array
* @access private
*/
function _subtract($x_value, $x_negative, $y_value, $y_negative)
{
}
/**
* Multiplies two BigIntegers
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger('10');
* $b = new \phpseclib\Math\BigInteger('20');
*
* $c = $a->multiply($b);
*
* echo $c->toString(); // outputs 200
* ?>
* </code>
*
* @param \phpseclib\Math\BigInteger $x
* @return \phpseclib\Math\BigInteger
* @access public
*/
function multiply($x)
{
}
/**
* Performs multiplication.
*
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
* @param bool $y_negative
* @return array
* @access private
*/
function _multiply($x_value, $x_negative, $y_value, $y_negative)
{
}
/**
* Performs long multiplication on two BigIntegers
*
* Modeled after 'multiply' in MutableBigInteger.java.
*
* @param array $x_value
* @param array $y_value
* @return array
* @access private
*/
function _regularMultiply($x_value, $y_value)
{
}
/**
* Performs Karatsuba multiplication on two BigIntegers
*
* See {@link http://en.wikipedia.org/wiki/Karatsuba_algorithm Karatsuba algorithm} and
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=120 MPM 5.2.3}.
*
* @param array $x_value
* @param array $y_value
* @return array
* @access private
*/
function _karatsuba($x_value, $y_value)
{
}
/**
* Performs squaring
*
* @param array $x
* @return array
* @access private
*/
function _square($x = false)
{
}
/**
* Performs traditional squaring on two BigIntegers
*
* Squaring can be done faster than multiplying a number by itself can be. See
* {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=7 HAC 14.2.4} /
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=141 MPM 5.3} for more information.
*
* @param array $value
* @return array
* @access private
*/
function _baseSquare($value)
{
}
/**
* Performs Karatsuba "squaring" on two BigIntegers
*
* See {@link http://en.wikipedia.org/wiki/Karatsuba_algorithm Karatsuba algorithm} and
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=151 MPM 5.3.4}.
*
* @param array $value
* @return array
* @access private
*/
function _karatsubaSquare($value)
{
}
/**
* Divides two BigIntegers.
*
* Returns an array whose first element contains the quotient and whose second element contains the
* "common residue". If the remainder would be positive, the "common residue" and the remainder are the
* same. If the remainder would be negative, the "common residue" is equal to the sum of the remainder
* and the divisor (basically, the "common residue" is the first positive modulo).
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger('10');
* $b = new \phpseclib\Math\BigInteger('20');
*
* list($quotient, $remainder) = $a->divide($b);
*
* echo $quotient->toString(); // outputs 0
* echo "\r\n";
* echo $remainder->toString(); // outputs 10
* ?>
* </code>
*
* @param \phpseclib\Math\BigInteger $y
* @return array
* @access public
* @internal This function is based off of {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=9 HAC 14.20}.
*/
function divide($y)
{
}
/**
* Divides a BigInteger by a regular integer
*
* abc / x = a00 / x + b0 / x + c / x
*
* @param array $dividend
* @param array $divisor
* @return array
* @access private
*/
function _divide_digit($dividend, $divisor)
{
}
/**
* Performs modular exponentiation.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger('10');
* $b = new \phpseclib\Math\BigInteger('20');
* $c = new \phpseclib\Math\BigInteger('30');
*
* $c = $a->modPow($b, $c);
*
* echo $c->toString(); // outputs 10
* ?>
* </code>
*
* @param \phpseclib\Math\BigInteger $e
* @param \phpseclib\Math\BigInteger $n
* @return \phpseclib\Math\BigInteger
* @access public
* @internal The most naive approach to modular exponentiation has very unreasonable requirements, and
* and although the approach involving repeated squaring does vastly better, it, too, is impractical
* for our purposes. The reason being that division - by far the most complicated and time-consuming
* of the basic operations (eg. +,-,*,/) - occurs multiple times within it.
*
* Modular reductions resolve this issue. Although an individual modular reduction takes more time
* then an individual division, when performed in succession (with the same modulo), they're a lot faster.
*
* The two most commonly used modular reductions are Barrett and Montgomery reduction. Montgomery reduction,
* although faster, only works when the gcd of the modulo and of the base being used is 1. In RSA, when the
* base is a power of two, the modulo - a product of two primes - is always going to have a gcd of 1 (because
* the product of two odd numbers is odd), but what about when RSA isn't used?
*
* In contrast, Barrett reduction has no such constraint. As such, some bigint implementations perform a
* Barrett reduction after every operation in the modpow function. Others perform Barrett reductions when the
* modulo is even and Montgomery reductions when the modulo is odd. BigInteger.java's modPow method, however,
* uses a trick involving the Chinese Remainder Theorem to factor the even modulo into two numbers - one odd and
* the other, a power of two - and recombine them, later. This is the method that this modPow function uses.
* {@link http://islab.oregonstate.edu/papers/j34monex.pdf Montgomery Reduction with Even Modulus} elaborates.
*/
function modPow($e, $n)
{
}
/**
* Performs modular exponentiation.
*
* Alias for modPow().
*
* @param \phpseclib\Math\BigInteger $e
* @param \phpseclib\Math\BigInteger $n
* @return \phpseclib\Math\BigInteger
* @access public
*/
function powMod($e, $n)
{
}
/**
* Sliding Window k-ary Modular Exponentiation
*
* Based on {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=27 HAC 14.85} /
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=210 MPM 7.7}. In a departure from those algorithims,
* however, this function performs a modular reduction after every multiplication and squaring operation.
* As such, this function has the same preconditions that the reductions being used do.
*
* @param \phpseclib\Math\BigInteger $e
* @param \phpseclib\Math\BigInteger $n
* @param int $mode
* @return \phpseclib\Math\BigInteger
* @access private
*/
function _slidingWindow($e, $n, $mode)
{
}
/**
* Modular reduction
*
* For most $modes this will return the remainder.
*
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
* @param int $mode
* @return array
*/
function _reduce($x, $n, $mode)
{
}
/**
* Modular reduction preperation
*
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
* @param int $mode
* @return array
*/
function _prepareReduce($x, $n, $mode)
{
}
/**
* Modular multiply
*
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $y
* @param array $n
* @param int $mode
* @return array
*/
function _multiplyReduce($x, $y, $n, $mode)
{
}
/**
* Modular square
*
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
* @param int $mode
* @return array
*/
function _squareReduce($x, $n, $mode)
{
}
/**
* Modulos for Powers of Two
*
* Calculates $x%$n, where $n = 2**$e, for some $e. Since this is basically the same as doing $x & ($n-1),
* we'll just use this function as a wrapper for doing that.
*
* @see self::_slidingWindow()
* @access private
* @param \phpseclib\Math\BigInteger
* @return \phpseclib\Math\BigInteger
*/
function _mod2($n)
{
}
/**
* Barrett Modular Reduction
*
* See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=14 HAC 14.3.3} /
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=165 MPM 6.2.5} for more information. Modified slightly,
* so as not to require negative numbers (initially, this script didn't support negative numbers).
*
* Employs "folding", as described at
* {@link http://www.cosic.esat.kuleuven.be/publications/thesis-149.pdf#page=66 thesis-149.pdf#page=66}. To quote from
* it, "the idea [behind folding] is to find a value x' such that x (mod m) = x' (mod m), with x' being smaller than x."
*
* Unfortunately, the "Barrett Reduction with Folding" algorithm described in thesis-149.pdf is not, as written, all that
* usable on account of (1) its not using reasonable radix points as discussed in
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=162 MPM 6.2.2} and (2) the fact that, even with reasonable
* radix points, it only works when there are an even number of digits in the denominator. The reason for (2) is that
* (x >> 1) + (x >> 1) != x / 2 + x / 2. If x is even, they're the same, but if x is odd, they're not. See the in-line
* comments for details.
*
* @see self::_slidingWindow()
* @access private
* @param array $n
* @param array $m
* @return array
*/
function _barrett($n, $m)
{
}
/**
* (Regular) Barrett Modular Reduction
*
* For numbers with more than four digits BigInteger::_barrett() is faster. The difference between that and this
* is that this function does not fold the denominator into a smaller form.
*
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
* @return array
*/
function _regularBarrett($x, $n)
{
}
/**
* Performs long multiplication up to $stop digits
*
* If you're going to be doing array_slice($product->value, 0, $stop), some cycles can be saved.
*
* @see self::_regularBarrett()
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
* @param bool $y_negative
* @param int $stop
* @return array
* @access private
*/
function _multiplyLower($x_value, $x_negative, $y_value, $y_negative, $stop)
{
}
/**
* Montgomery Modular Reduction
*
* ($x->_prepMontgomery($n))->_montgomery($n) yields $x % $n.
* {@link http://math.libtomcrypt.com/files/tommath.pdf#page=170 MPM 6.3} provides insights on how this can be
* improved upon (basically, by using the comba method). gcd($n, 2) must be equal to one for this function
* to work correctly.
*
* @see self::_prepMontgomery()
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
* @return array
*/
function _montgomery($x, $n)
{
}
/**
* Montgomery Multiply
*
* Interleaves the montgomery reduction and long multiplication algorithms together as described in
* {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=13 HAC 14.36}
*
* @see self::_prepMontgomery()
* @see self::_montgomery()
* @access private
* @param array $x
* @param array $y
* @param array $m
* @return array
*/
function _montgomeryMultiply($x, $y, $m)
{
}
/**
* Prepare a number for use in Montgomery Modular Reductions
*
* @see self::_montgomery()
* @see self::_slidingWindow()
* @access private
* @param array $x
* @param array $n
* @return array
*/
function _prepMontgomery($x, $n)
{
}
/**
* Modular Inverse of a number mod 2**26 (eg. 67108864)
*
* Based off of the bnpInvDigit function implemented and justified in the following URL:
*
* {@link http://www-cs-students.stanford.edu/~tjw/jsbn/jsbn.js}
*
* The following URL provides more info:
*
* {@link http://groups.google.com/group/sci.crypt/msg/7a137205c1be7d85}
*
* As for why we do all the bitmasking... strange things can happen when converting from floats to ints. For
* instance, on some computers, var_dump((int) -4294967297) yields int(-1) and on others, it yields
* int(-2147483648). To avoid problems stemming from this, we use bitmasks to guarantee that ints aren't
* auto-converted to floats. The outermost bitmask is present because without it, there's no guarantee that
* the "residue" returned would be the so-called "common residue". We use fmod, in the last step, because the
* maximum possible $x is 26 bits and the maximum $result is 16 bits. Thus, we have to be able to handle up to
* 40 bits, which only 64-bit floating points will support.
*
* Thanks to Pedro Gimeno Fortea for input!
*
* @see self::_montgomery()
* @access private
* @param array $x
* @return int
*/
function _modInverse67108864($x)
{
}
/**
* Calculates modular inverses.
*
* Say you have (30 mod 17 * x mod 17) mod 17 == 1. x can be found using modular inverses.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger(30);
* $b = new \phpseclib\Math\BigInteger(17);
*
* $c = $a->modInverse($b);
* echo $c->toString(); // outputs 4
*
* echo "\r\n";
*
* $d = $a->multiply($c);
* list(, $d) = $d->divide($b);
* echo $d; // outputs 1 (as per the definition of modular inverse)
* ?>
* </code>
*
* @param \phpseclib\Math\BigInteger $n
* @return \phpseclib\Math\BigInteger|false
* @access public
* @internal See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=21 HAC 14.64} for more information.
*/
function modInverse($n)
{
}
/**
* Calculates the greatest common divisor and Bezout's identity.
*
* Say you have 693 and 609. The GCD is 21. Bezout's identity states that there exist integers x and y such that
* 693*x + 609*y == 21. In point of fact, there are actually an infinite number of x and y combinations and which
* combination is returned is dependent upon which mode is in use. See
* {@link http://en.wikipedia.org/wiki/B%C3%A9zout%27s_identity Bezout's identity - Wikipedia} for more information.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger(693);
* $b = new \phpseclib\Math\BigInteger(609);
*
* extract($a->extendedGCD($b));
*
* echo $gcd->toString() . "\r\n"; // outputs 21
* echo $a->toString() * $x->toString() + $b->toString() * $y->toString(); // outputs 21
* ?>
* </code>
*
* @param \phpseclib\Math\BigInteger $n
* @return \phpseclib\Math\BigInteger
* @access public
* @internal Calculates the GCD using the binary xGCD algorithim described in
* {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap14.pdf#page=19 HAC 14.61}. As the text above 14.61 notes,
* the more traditional algorithim requires "relatively costly multiple-precision divisions".
*/
function extendedGCD($n)
{
}
/**
* Calculates the greatest common divisor
*
* Say you have 693 and 609. The GCD is 21.
*
* Here's an example:
* <code>
* <?php
* $a = new \phpseclib\Math\BigInteger(693);
* $b = new \phpseclib\Math\BigInteger(609);
*
* $gcd = a->extendedGCD($b);
*
* echo $gcd->toString() . "\r\n"; // outputs 21
* ?>
* </code>
*
* @param \phpseclib\Math\BigInteger $n
* @return \phpseclib\Math\BigInteger
* @access public
*/
function gcd($n)
{
}
/**
* Absolute value.
*
* @return \phpseclib\Math\BigInteger
* @access public
*/
function abs()
{
}
/**
* Compares two numbers.
*
* Although one might think !$x->compare($y) means $x != $y, it, in fact, means the opposite. The reason for this is
* demonstrated thusly:
*
* $x > $y: $x->compare($y) > 0
* $x < $y: $x->compare($y) < 0
* $x == $y: $x->compare($y) == 0
*
* Note how the same comparison operator is used. If you want to test for equality, use $x->equals($y).
*
* @param \phpseclib\Math\BigInteger $y
* @return int < 0 if $this is less than $y; > 0 if $this is greater than $y, and 0 if they are equal.
* @access public
* @see self::equals()
* @internal Could return $this->subtract($x), but that's not as fast as what we do do.
*/
function compare($y)
{
}
/**
* Compares two numbers.
*
* @param array $x_value
* @param bool $x_negative
* @param array $y_value
* @param bool $y_negative
* @return int
* @see self::compare()
* @access private
*/
function _compare($x_value, $x_negative, $y_value, $y_negative)
{
}
/**
* Tests the equality of two numbers.
*
* If you need to see if one number is greater than or less than another number, use BigInteger::compare()
*
* @param \phpseclib\Math\BigInteger $x
* @return bool
* @access public
* @see self::compare()
*/
function equals($x)
{
}
/**
* Set Precision
*
* Some bitwise operations give different results depending on the precision being used. Examples include left
* shift, not, and rotates.
*
* @param int $bits
* @access public
*/
function setPrecision($bits)
{
}
/**
* Logical And
*
* @param \phpseclib\Math\BigInteger $x
* @access public
* @internal Implemented per a request by Lluis Pamies i Juarez <lluis _a_ pamies.cat>
* @return \phpseclib\Math\BigInteger
*/
function bitwise_and($x)
{
}
/**
* Logical Or
*
* @param \phpseclib\Math\BigInteger $x
* @access public
* @internal Implemented per a request by Lluis Pamies i Juarez <lluis _a_ pamies.cat>
* @return \phpseclib\Math\BigInteger
*/
function bitwise_or($x)
{
}
/**
* Logical Exclusive-Or
*
* @param \phpseclib\Math\BigInteger $x
* @access public
* @internal Implemented per a request by Lluis Pamies i Juarez <lluis _a_ pamies.cat>
* @return \phpseclib\Math\BigInteger
*/
function bitwise_xor($x)
{
}
/**
* Logical Not
*
* @access public
* @internal Implemented per a request by Lluis Pamies i Juarez <lluis _a_ pamies.cat>
* @return \phpseclib\Math\BigInteger
*/
function bitwise_not()
{
}
/**
* Logical Right Shift
*
* Shifts BigInteger's by $shift bits, effectively dividing by 2**$shift.
*
* @param int $shift
* @return \phpseclib\Math\BigInteger
* @access public
* @internal The only version that yields any speed increases is the internal version.
*/
function bitwise_rightShift($shift)
{
}
/**
* Logical Left Shift
*
* Shifts BigInteger's by $shift bits, effectively multiplying by 2**$shift.
*
* @param int $shift
* @return \phpseclib\Math\BigInteger
* @access public
* @internal The only version that yields any speed increases is the internal version.
*/
function bitwise_leftShift($shift)
{
}
/**
* Logical Left Rotate
*
* Instead of the top x bits being dropped they're appended to the shifted bit string.
*
* @param int $shift
* @return \phpseclib\Math\BigInteger
* @access public
*/
function bitwise_leftRotate($shift)
{
}
/**
* Logical Right Rotate
*
* Instead of the bottom x bits being dropped they're prepended to the shifted bit string.
*
* @param int $shift
* @return \phpseclib\Math\BigInteger
* @access public
*/
function bitwise_rightRotate($shift)
{
}
/**
* Generates a random BigInteger
*
* Byte length is equal to $length. Uses \phpseclib\Crypt\Random if it's loaded and mt_rand if it's not.
*
* @param int $length
* @return \phpseclib\Math\BigInteger
* @access private
*/
function _random_number_helper($size)
{
}
/**
* Generate a random number
*
* Returns a random number between $min and $max where $min and $max
* can be defined using one of the two methods:
*
* $min->random($max)
* $max->random($min)
*
* @param \phpseclib\Math\BigInteger $arg1
* @param \phpseclib\Math\BigInteger $arg2
* @return \phpseclib\Math\BigInteger
* @access public
* @internal The API for creating random numbers used to be $a->random($min, $max), where $a was a BigInteger object.
* That method is still supported for BC purposes.
*/
function random($arg1, $arg2 = false)
{
}
/**
* Generate a random prime number.
*
* If there's not a prime within the given range, false will be returned.
* If more than $timeout seconds have elapsed, give up and return false.
*
* @param \phpseclib\Math\BigInteger $arg1
* @param \phpseclib\Math\BigInteger $arg2
* @param int $timeout
* @return Math_BigInteger|false
* @access public
* @internal See {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap4.pdf#page=15 HAC 4.44}.
*/
function randomPrime($arg1, $arg2 = false, $timeout = false)
{
}
/**
* Make the current number odd
*
* If the current number is odd it'll be unchanged. If it's even, one will be added to it.
*
* @see self::randomPrime()
* @access private
*/
function _make_odd()
{
}
/**
* Checks a numer to see if it's prime
*
* Assuming the $t parameter is not set, this function has an error rate of 2**-80. The main motivation for the
* $t parameter is distributability. BigInteger::randomPrime() can be distributed across multiple pageloads
* on a website instead of just one.
*
* @param \phpseclib\Math\BigInteger $t
* @return bool
* @access public
* @internal Uses the
* {@link http://en.wikipedia.org/wiki/Miller%E2%80%93Rabin_primality_test Miller-Rabin primality test}. See
* {@link http://www.cacr.math.uwaterloo.ca/hac/about/chap4.pdf#page=8 HAC 4.24}.
*/
function isPrime($t = false)
{
}
/**
* Logical Left Shift
*
* Shifts BigInteger's by $shift bits.
*
* @param int $shift
* @access private
*/
function _lshift($shift)
{
}
/**
* Logical Right Shift
*
* Shifts BigInteger's by $shift bits.
*
* @param int $shift
* @access private
*/
function _rshift($shift)
{
}
/**
* Normalize
*
* Removes leading zeros and truncates (if necessary) to maintain the appropriate precision
*
* @param \phpseclib\Math\BigInteger
* @return \phpseclib\Math\BigInteger
* @see self::_trim()
* @access private
*/
function _normalize($result)
{
}
/**
* Trim
*
* Removes leading zeros
*
* @param array $value
* @return \phpseclib\Math\BigInteger
* @access private
*/
function _trim($value)
{
}
/**
* Array Repeat
*
* @param $input Array
* @param $multiplier mixed
* @return array
* @access private
*/
function _array_repeat($input, $multiplier)
{
}
/**
* Logical Left Shift
*
* Shifts binary strings $shift bits, essentially multiplying by 2**$shift.
*
* @param $x String
* @param $shift Integer
* @return string
* @access private
*/
function _base256_lshift(&$x, $shift)
{
}
/**
* Logical Right Shift
*
* Shifts binary strings $shift bits, essentially dividing by 2**$shift and returning the remainder.
*
* @param $x String
* @param $shift Integer
* @return string
* @access private
*/
function _base256_rshift(&$x, $shift)
{
}
// one quirk about how the following functions are implemented is that PHP defines N to be an unsigned long
// at 32-bits, while java's longs are 64-bits.
/**
* Converts 32-bit integers to bytes.
*
* @param int $x
* @return string
* @access private
*/
function _int2bytes($x)
{
}
/**
* Converts bytes to 32-bit integers
*
* @param string $x
* @return int
* @access private
*/
function _bytes2int($x)
{
}
/**
* DER-encode an integer
*
* The ability to DER-encode integers is needed to create RSA public keys for use with OpenSSL
*
* @see self::modPow()
* @access private
* @param int $length
* @return string
*/
function _encodeASN1Length($length)
{
}
/**
* Single digit division
*
* Even if int64 is being used the division operator will return a float64 value
* if the dividend is not evenly divisible by the divisor. Since a float64 doesn't
* have the precision of int64 this is a problem so, when int64 is being used,
* we'll guarantee that the dividend is divisible by first subtracting the remainder.
*
* @access private
* @param int $x
* @param int $y
* @return int
*/
function _safe_divide($x, $y)
{
}
}
}
namespace phpseclib\Crypt {
/**
* Base Class for all \phpseclib\Crypt\* cipher classes
*
* @package Base
* @author Jim Wigginton <terrafrost@php.net>
* @author Hans-Juergen Petrich <petrich@tronic-media.com>
*/
abstract class Base
{
/**#@+
* @access public
* @see \phpseclib\Crypt\Base::encrypt()
* @see \phpseclib\Crypt\Base::decrypt()
*/
/**
* Encrypt / decrypt using the Counter mode.
*
* Set to -1 since that's what Crypt/Random.php uses to index the CTR mode.
*
* @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Counter_.28CTR.29
*/
const MODE_CTR = -1;
/**
* Encrypt / decrypt using the Electronic Code Book mode.
*
* @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Electronic_codebook_.28ECB.29
*/
const MODE_ECB = 1;
/**
* Encrypt / decrypt using the Code Book Chaining mode.
*
* @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher-block_chaining_.28CBC.29
*/
const MODE_CBC = 2;
/**
* Encrypt / decrypt using the Cipher Feedback mode.
*
* @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Cipher_feedback_.28CFB.29
*/
const MODE_CFB = 3;
/**
* Encrypt / decrypt using the Output Feedback mode.
*
* @link http://en.wikipedia.org/wiki/Block_cipher_modes_of_operation#Output_feedback_.28OFB.29
*/
const MODE_OFB = 4;
/**
* Encrypt / decrypt using streaming mode.
*/
const MODE_STREAM = 5;
/**#@-*/
/**
* Whirlpool available flag
*
* @see \phpseclib\Crypt\Base::_hashInlineCryptFunction()
* @var bool
* @access private
*/
static $WHIRLPOOL_AVAILABLE;
/**#@+
* @access private
* @see \phpseclib\Crypt\Base::__construct()
*/
/**
* Base value for the internal implementation $engine switch
*/
const ENGINE_INTERNAL = 1;
/**
* Base value for the mcrypt implementation $engine switch
*/
const ENGINE_MCRYPT = 2;
/**
* Base value for the mcrypt implementation $engine switch
*/
const ENGINE_OPENSSL = 3;
/**#@-*/
/**
* The Encryption Mode
*
* @see self::__construct()
* @var int
* @access private
*/
var $mode;
/**
* The Block Length of the block cipher
*
* @var int
* @access private
*/
var $block_size = 16;
/**
* The Key
*
* @see self::setKey()
* @var string
* @access private
*/
var $key = "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00";
/**
* The Initialization Vector
*
* @see self::setIV()
* @var string
* @access private
*/
var $iv;
/**
* A "sliding" Initialization Vector
*
* @see self::enableContinuousBuffer()
* @see self::_clearBuffers()
* @var string
* @access private
*/
var $encryptIV;
/**
* A "sliding" Initialization Vector
*
* @see self::enableContinuousBuffer()
* @see self::_clearBuffers()
* @var string
* @access private
*/
var $decryptIV;
/**
* Continuous Buffer status
*
* @see self::enableContinuousBuffer()
* @var bool
* @access private
*/
var $continuousBuffer = false;
/**
* Encryption buffer for CTR, OFB and CFB modes
*
* @see self::encrypt()
* @see self::_clearBuffers()
* @var array
* @access private
*/
var $enbuffer;
/**
* Decryption buffer for CTR, OFB and CFB modes
*
* @see self::decrypt()
* @see self::_clearBuffers()
* @var array
* @access private
*/
var $debuffer;
/**
* mcrypt resource for encryption
*
* The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
* Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.
*
* @see self::encrypt()
* @var resource
* @access private
*/
var $enmcrypt;
/**
* mcrypt resource for decryption
*
* The mcrypt resource can be recreated every time something needs to be created or it can be created just once.
* Since mcrypt operates in continuous mode, by default, it'll need to be recreated when in non-continuous mode.
*
* @see self::decrypt()
* @var resource
* @access private
*/
var $demcrypt;
/**
* Does the enmcrypt resource need to be (re)initialized?
*
* @see \phpseclib\Crypt\Twofish::setKey()
* @see \phpseclib\Crypt\Twofish::setIV()
* @var bool
* @access private
*/
var $enchanged = true;
/**
* Does the demcrypt resource need to be (re)initialized?
*
* @see \phpseclib\Crypt\Twofish::setKey()
* @see \phpseclib\Crypt\Twofish::setIV()
* @var bool
* @access private
*/
var $dechanged = true;
/**
* mcrypt resource for CFB mode
*
* mcrypt's CFB mode, in (and only in) buffered context,
* is broken, so phpseclib implements the CFB mode by it self,
* even when the mcrypt php extension is available.
*
* In order to do the CFB-mode work (fast) phpseclib
* use a separate ECB-mode mcrypt resource.
*
* @link http://phpseclib.sourceforge.net/cfb-demo.phps
* @see self::encrypt()
* @see self::decrypt()
* @see self::_setupMcrypt()
* @var resource
* @access private
*/
var $ecb;
/**
* Optimizing value while CFB-encrypting
*
* Only relevant if $continuousBuffer enabled
* and $engine == self::ENGINE_MCRYPT
*
* It's faster to re-init $enmcrypt if
* $buffer bytes > $cfb_init_len than
* using the $ecb resource furthermore.
*
* This value depends of the chosen cipher
* and the time it would be needed for it's
* initialization [by mcrypt_generic_init()]
* which, typically, depends on the complexity
* on its internaly Key-expanding algorithm.
*
* @see self::encrypt()
* @var int
* @access private
*/
var $cfb_init_len = 600;
/**
* Does internal cipher state need to be (re)initialized?
*
* @see self::setKey()
* @see self::setIV()
* @see self::disableContinuousBuffer()
* @var bool
* @access private
*/
var $changed = true;
/**
* Padding status
*
* @see self::enablePadding()
* @var bool
* @access private
*/
var $padding = true;
/**
* Is the mode one that is paddable?
*
* @see self::__construct()
* @var bool
* @access private
*/
var $paddable = false;
/**
* Holds which crypt engine internaly should be use,
* which will be determined automatically on __construct()
*
* Currently available $engines are:
* - self::ENGINE_OPENSSL (very fast, php-extension: openssl, extension_loaded('openssl') required)
* - self::ENGINE_MCRYPT (fast, php-extension: mcrypt, extension_loaded('mcrypt') required)
* - self::ENGINE_INTERNAL (slower, pure php-engine, no php-extension required)
*
* @see self::_setEngine()
* @see self::encrypt()
* @see self::decrypt()
* @var int
* @access private
*/
var $engine;
/**
* Holds the preferred crypt engine
*
* @see self::_setEngine()
* @see self::setPreferredEngine()
* @var int
* @access private
*/
var $preferredEngine;
/**
* The mcrypt specific name of the cipher
*
* Only used if $engine == self::ENGINE_MCRYPT
*
* @link http://www.php.net/mcrypt_module_open
* @link http://www.php.net/mcrypt_list_algorithms
* @see self::_setupMcrypt()
* @var string
* @access private
*/
var $cipher_name_mcrypt;
/**
* The openssl specific name of the cipher
*
* Only used if $engine == self::ENGINE_OPENSSL
*
* @link http://www.php.net/openssl-get-cipher-methods
* @var string
* @access private
*/
var $cipher_name_openssl;
/**
* The openssl specific name of the cipher in ECB mode
*
* If OpenSSL does not support the mode we're trying to use (CTR)
* it can still be emulated with ECB mode.
*
* @link http://www.php.net/openssl-get-cipher-methods
* @var string
* @access private
*/
var $cipher_name_openssl_ecb;
/**
* The default salt used by setPassword()
*
* @see self::setPassword()
* @var string
* @access private
*/
var $password_default_salt = 'phpseclib/salt';
/**
* The name of the performance-optimized callback function
*
* Used by encrypt() / decrypt()
* only if $engine == self::ENGINE_INTERNAL
*
* @see self::encrypt()
* @see self::decrypt()
* @see self::_setupInlineCrypt()
* @see self::$use_inline_crypt
* @var Callback
* @access private
*/
var $inline_crypt;
/**
* Holds whether performance-optimized $inline_crypt() can/should be used.
*
* @see self::encrypt()
* @see self::decrypt()
* @see self::inline_crypt
* @var mixed
* @access private
*/
var $use_inline_crypt;
/**
* If OpenSSL can be used in ECB but not in CTR we can emulate CTR
*
* @see self::_openssl_ctr_process()
* @var bool
* @access private
*/
var $openssl_emulate_ctr = false;
/**
* Determines what options are passed to openssl_encrypt/decrypt
*
* @see self::isValidEngine()
* @var mixed
* @access private
*/
var $openssl_options;
/**
* Has the key length explicitly been set or should it be derived from the key, itself?
*
* @see self::setKeyLength()
* @var bool
* @access private
*/
var $explicit_key_length = false;
/**
* Don't truncate / null pad key
*
* @see self::_clearBuffers()
* @var bool
* @access private
*/
var $skip_key_adjustment = false;
/**
* Default Constructor.
*
* Determines whether or not the mcrypt extension should be used.
*
* $mode could be:
*
* - self::MODE_ECB
*
* - self::MODE_CBC
*
* - self::MODE_CTR
*
* - self::MODE_CFB
*
* - self::MODE_OFB
*
* If not explicitly set, self::MODE_CBC will be used.
*
* @param int $mode
* @access public
*/
function __construct($mode = self::MODE_CBC)
{
}
/**
* Sets the initialization vector. (optional)
*
* SetIV is not required when self::MODE_ECB (or ie for AES: \phpseclib\Crypt\AES::MODE_ECB) is being used. If not explicitly set, it'll be assumed
* to be all zero's.
*
* @access public
* @param string $iv
* @internal Can be overwritten by a sub class, but does not have to be
*/
function setIV($iv)
{
}
/**
* Sets the key length.
*
* Keys with explicitly set lengths need to be treated accordingly
*
* @access public
* @param int $length
*/
function setKeyLength($length)
{
}
/**
* Returns the current key length in bits
*
* @access public
* @return int
*/
function getKeyLength()
{
}
/**
* Returns the current block length in bits
*
* @access public
* @return int
*/
function getBlockLength()
{
}
/**
* Sets the key.
*
* The min/max length(s) of the key depends on the cipher which is used.
* If the key not fits the length(s) of the cipher it will paded with null bytes
* up to the closest valid key length. If the key is more than max length,
* we trim the excess bits.
*
* If the key is not explicitly set, it'll be assumed to be all null bytes.
*
* @access public
* @param string $key
* @internal Could, but not must, extend by the child Crypt_* class
*/
function setKey($key)
{
}
/**
* Sets the password.
*
* Depending on what $method is set to, setPassword()'s (optional) parameters are as follows:
* {@link http://en.wikipedia.org/wiki/PBKDF2 pbkdf2} or pbkdf1:
* $hash, $salt, $count, $dkLen
*
* Where $hash (default = sha1) currently supports the following hashes: see: Crypt/Hash.php
*
* @see Crypt/Hash.php
* @param string $password
* @param string $method
* @return bool
* @access public
* @internal Could, but not must, extend by the child Crypt_* class
*/
function setPassword($password, $method = 'pbkdf2')
{
}
/**
* Encrypts a message.
*
* $plaintext will be padded with additional bytes such that it's length is a multiple of the block size. Other cipher
* implementations may or may not pad in the same manner. Other common approaches to padding and the reasons why it's
* necessary are discussed in the following
* URL:
*
* {@link http://www.di-mgt.com.au/cryptopad.html http://www.di-mgt.com.au/cryptopad.html}
*
* An alternative to padding is to, separately, send the length of the file. This is what SSH, in fact, does.
* strlen($plaintext) will still need to be a multiple of the block size, however, arbitrary values can be added to make it that
* length.
*
* @see self::decrypt()
* @access public
* @param string $plaintext
* @return string $ciphertext
* @internal Could, but not must, extend by the child Crypt_* class
*/
function encrypt($plaintext)
{
}
/**
* Decrypts a message.
*
* If strlen($ciphertext) is not a multiple of the block size, null bytes will be added to the end of the string until
* it is.
*
* @see self::encrypt()
* @access public
* @param string $ciphertext
* @return string $plaintext
* @internal Could, but not must, extend by the child Crypt_* class
*/
function decrypt($ciphertext)
{
}
/**
* OpenSSL CTR Processor
*
* PHP's OpenSSL bindings do not operate in continuous mode so we'll wrap around it. Since the keystream
* for CTR is the same for both encrypting and decrypting this function is re-used by both Base::encrypt()
* and Base::decrypt(). Also, OpenSSL doesn't implement CTR for all of it's symmetric ciphers so this
* function will emulate CTR with ECB when necessary.
*
* @see self::encrypt()
* @see self::decrypt()
* @param string $plaintext
* @param string $encryptIV
* @param array $buffer
* @return string
* @access private
*/
function _openssl_ctr_process($plaintext, &$encryptIV, &$buffer)
{
}
/**
* OpenSSL OFB Processor
*
* PHP's OpenSSL bindings do not operate in continuous mode so we'll wrap around it. Since the keystream
* for OFB is the same for both encrypting and decrypting this function is re-used by both Base::encrypt()
* and Base::decrypt().
*
* @see self::encrypt()
* @see self::decrypt()
* @param string $plaintext
* @param string $encryptIV
* @param array $buffer
* @return string
* @access private
*/
function _openssl_ofb_process($plaintext, &$encryptIV, &$buffer)
{
}
/**
* phpseclib <-> OpenSSL Mode Mapper
*
* May need to be overwritten by classes extending this one in some cases
*
* @return int
* @access private
*/
function _openssl_translate_mode()
{
}
/**
* Pad "packets".
*
* Block ciphers working by encrypting between their specified [$this->]block_size at a time
* If you ever need to encrypt or decrypt something that isn't of the proper length, it becomes necessary to
* pad the input so that it is of the proper length.
*
* Padding is enabled by default. Sometimes, however, it is undesirable to pad strings. Such is the case in SSH,
* where "packets" are padded with random bytes before being encrypted. Unpad these packets and you risk stripping
* away characters that shouldn't be stripped away. (SSH knows how many bytes are added because the length is
* transmitted separately)
*
* @see self::disablePadding()
* @access public
*/
function enablePadding()
{
}
/**
* Do not pad packets.
*
* @see self::enablePadding()
* @access public
*/
function disablePadding()
{
}
/**
* Treat consecutive "packets" as if they are a continuous buffer.
*
* Say you have a 32-byte plaintext $plaintext. Using the default behavior, the two following code snippets
* will yield different outputs:
*
* <code>
* echo $rijndael->encrypt(substr($plaintext, 0, 16));
* echo $rijndael->encrypt(substr($plaintext, 16, 16));
* </code>
* <code>
* echo $rijndael->encrypt($plaintext);
* </code>
*
* The solution is to enable the continuous buffer. Although this will resolve the above discrepancy, it creates
* another, as demonstrated with the following:
*
* <code>
* $rijndael->encrypt(substr($plaintext, 0, 16));
* echo $rijndael->decrypt($rijndael->encrypt(substr($plaintext, 16, 16)));
* </code>
* <code>
* echo $rijndael->decrypt($rijndael->encrypt(substr($plaintext, 16, 16)));
* </code>
*
* With the continuous buffer disabled, these would yield the same output. With it enabled, they yield different
* outputs. The reason is due to the fact that the initialization vector's change after every encryption /
* decryption round when the continuous buffer is enabled. When it's disabled, they remain constant.
*
* Put another way, when the continuous buffer is enabled, the state of the \phpseclib\Crypt\*() object changes after each
* encryption / decryption round, whereas otherwise, it'd remain constant. For this reason, it's recommended that
* continuous buffers not be used. They do offer better security and are, in fact, sometimes required (SSH uses them),
* however, they are also less intuitive and more likely to cause you problems.
*
* @see self::disableContinuousBuffer()
* @access public
* @internal Could, but not must, extend by the child Crypt_* class
*/
function enableContinuousBuffer()
{
}
/**
* Treat consecutive packets as if they are a discontinuous buffer.
*
* The default behavior.
*
* @see self::enableContinuousBuffer()
* @access public
* @internal Could, but not must, extend by the child Crypt_* class
*/
function disableContinuousBuffer()
{
}
/**
* Test for engine validity
*
* @see self::__construct()
* @param int $engine
* @access public
* @return bool
*/
function isValidEngine($engine)
{
}
/**
* Sets the preferred crypt engine
*
* Currently, $engine could be:
*
* - \phpseclib\Crypt\Base::ENGINE_OPENSSL [very fast]
*
* - \phpseclib\Crypt\Base::ENGINE_MCRYPT [fast]
*
* - \phpseclib\Crypt\Base::ENGINE_INTERNAL [slow]
*
* If the preferred crypt engine is not available the fastest available one will be used
*
* @see self::__construct()
* @param int $engine
* @access public
*/
function setPreferredEngine($engine)
{
}
/**
* Returns the engine currently being utilized
*
* @see self::_setEngine()
* @access public
*/
function getEngine()
{
}
/**
* Sets the engine as appropriate
*
* @see self::__construct()
* @access private
*/
function _setEngine()
{
}
/**
* Encrypts a block
*
* Note: Must be extended by the child \phpseclib\Crypt\* class
*
* @access private
* @param string $in
* @return string
*/
abstract function _encryptBlock($in);
/**
* Decrypts a block
*
* Note: Must be extended by the child \phpseclib\Crypt\* class
*
* @access private
* @param string $in
* @return string
*/
abstract function _decryptBlock($in);
/**
* Setup the key (expansion)
*
* Only used if $engine == self::ENGINE_INTERNAL
*
* Note: Must extend by the child \phpseclib\Crypt\* class
*
* @see self::_setup()
* @access private
*/
abstract function _setupKey();
/**
* Setup the self::ENGINE_INTERNAL $engine
*
* (re)init, if necessary, the internal cipher $engine and flush all $buffers
* Used (only) if $engine == self::ENGINE_INTERNAL
*
* _setup() will be called each time if $changed === true
* typically this happens when using one or more of following public methods:
*
* - setKey()
*
* - setIV()
*
* - disableContinuousBuffer()
*
* - First run of encrypt() / decrypt() with no init-settings
*
* @see self::setKey()
* @see self::setIV()
* @see self::disableContinuousBuffer()
* @access private
* @internal _setup() is always called before en/decryption.
* @internal Could, but not must, extend by the child Crypt_* class
*/
function _setup()
{
}
/**
* Setup the self::ENGINE_MCRYPT $engine
*
* (re)init, if necessary, the (ext)mcrypt resources and flush all $buffers
* Used (only) if $engine = self::ENGINE_MCRYPT
*
* _setupMcrypt() will be called each time if $changed === true
* typically this happens when using one or more of following public methods:
*
* - setKey()
*
* - setIV()
*
* - disableContinuousBuffer()
*
* - First run of encrypt() / decrypt()
*
* @see self::setKey()
* @see self::setIV()
* @see self::disableContinuousBuffer()
* @access private
* @internal Could, but not must, extend by the child Crypt_* class
*/
function _setupMcrypt()
{
}
/**
* Pads a string
*
* Pads a string using the RSA PKCS padding standards so that its length is a multiple of the blocksize.
* $this->block_size - (strlen($text) % $this->block_size) bytes are added, each of which is equal to
* chr($this->block_size - (strlen($text) % $this->block_size)
*
* If padding is disabled and $text is not a multiple of the blocksize, the string will be padded regardless
* and padding will, hence forth, be enabled.
*
* @see self::_unpad()
* @param string $text
* @access private
* @return string
*/
function _pad($text)
{
}
/**
* Unpads a string.
*
* If padding is enabled and the reported padding length is invalid the encryption key will be assumed to be wrong
* and false will be returned.
*
* @see self::_pad()
* @param string $text
* @access private
* @return string
*/
function _unpad($text)
{
}
/**
* Clears internal buffers
*
* Clearing/resetting the internal buffers is done everytime
* after disableContinuousBuffer() or on cipher $engine (re)init
* ie after setKey() or setIV()
*
* @access public
* @internal Could, but not must, extend by the child Crypt_* class
*/
function _clearBuffers()
{
}
/**
* String Shift
*
* Inspired by array_shift
*
* @param string $string
* @param int $index
* @access private
* @return string
*/
function _string_shift(&$string, $index = 1)
{
}
/**
* String Pop
*
* Inspired by array_pop
*
* @param string $string
* @param int $index
* @access private
* @return string
*/
function _string_pop(&$string, $index = 1)
{
}
/**
* Increment the current string
*
* @see self::decrypt()
* @see self::encrypt()
* @param string $var
* @access private
*/
function _increment_str(&$var)
{
}
/**
* Setup the performance-optimized function for de/encrypt()
*
* Stores the created (or existing) callback function-name
* in $this->inline_crypt
*
* Internally for phpseclib developers:
*
* _setupInlineCrypt() would be called only if:
*
* - $engine == self::ENGINE_INTERNAL and
*
* - $use_inline_crypt === true
*
* - each time on _setup(), after(!) _setupKey()
*
*
* This ensures that _setupInlineCrypt() has always a
* full ready2go initializated internal cipher $engine state
* where, for example, the keys allready expanded,
* keys/block_size calculated and such.
*
* It is, each time if called, the responsibility of _setupInlineCrypt():
*
* - to set $this->inline_crypt to a valid and fully working callback function
* as a (faster) replacement for encrypt() / decrypt()
*
* - NOT to create unlimited callback functions (for memory reasons!)
* no matter how often _setupInlineCrypt() would be called. At some
* point of amount they must be generic re-useable.
*
* - the code of _setupInlineCrypt() it self,
* and the generated callback code,
* must be, in following order:
* - 100% safe
* - 100% compatible to encrypt()/decrypt()
* - using only php5+ features/lang-constructs/php-extensions if
* compatibility (down to php4) or fallback is provided
* - readable/maintainable/understandable/commented and... not-cryptic-styled-code :-)
* - >= 10% faster than encrypt()/decrypt() [which is, by the way,
* the reason for the existence of _setupInlineCrypt() :-)]
* - memory-nice
* - short (as good as possible)
*
* Note: - _setupInlineCrypt() is using _createInlineCryptFunction() to create the full callback function code.
* - In case of using inline crypting, _setupInlineCrypt() must extend by the child \phpseclib\Crypt\* class.
* - The following variable names are reserved:
* - $_* (all variable names prefixed with an underscore)
* - $self (object reference to it self. Do not use $this, but $self instead)
* - $in (the content of $in has to en/decrypt by the generated code)
* - The callback function should not use the 'return' statement, but en/decrypt'ing the content of $in only
*
*
* @see self::_setup()
* @see self::_createInlineCryptFunction()
* @see self::encrypt()
* @see self::decrypt()
* @access private
* @internal If a Crypt_* class providing inline crypting it must extend _setupInlineCrypt()
*/
function _setupInlineCrypt()
{
}
/**
* Creates the performance-optimized function for en/decrypt()
*
* Internally for phpseclib developers:
*
* _createInlineCryptFunction():
*
* - merge the $cipher_code [setup'ed by _setupInlineCrypt()]
* with the current [$this->]mode of operation code
*
* - create the $inline function, which called by encrypt() / decrypt()
* as its replacement to speed up the en/decryption operations.
*
* - return the name of the created $inline callback function
*
* - used to speed up en/decryption
*
*
*
* The main reason why can speed up things [up to 50%] this way are:
*
* - using variables more effective then regular.
* (ie no use of expensive arrays but integers $k_0, $k_1 ...
* or even, for example, the pure $key[] values hardcoded)
*
* - avoiding 1000's of function calls of ie _encryptBlock()
* but inlining the crypt operations.
* in the mode of operation for() loop.
*
* - full loop unroll the (sometimes key-dependent) rounds
* avoiding this way ++$i counters and runtime-if's etc...
*
* The basic code architectur of the generated $inline en/decrypt()
* lambda function, in pseudo php, is:
*
* <code>
* +----------------------------------------------------------------------------------------------+
* | callback $inline = create_function: |
* | lambda_function_0001_crypt_ECB($action, $text) |
* | { |
* | INSERT PHP CODE OF: |
* | $cipher_code['init_crypt']; // general init code. |
* | // ie: $sbox'es declarations used for |
* | // encrypt and decrypt'ing. |
* | |
* | switch ($action) { |
* | case 'encrypt': |
* | INSERT PHP CODE OF: |
* | $cipher_code['init_encrypt']; // encrypt sepcific init code. |
* | ie: specified $key or $box |
* | declarations for encrypt'ing. |
* | |
* | foreach ($ciphertext) { |
* | $in = $block_size of $ciphertext; |
* | |
* | INSERT PHP CODE OF: |
* | $cipher_code['encrypt_block']; // encrypt's (string) $in, which is always: |
* | // strlen($in) == $this->block_size |
* | // here comes the cipher algorithm in action |
* | // for encryption. |
* | // $cipher_code['encrypt_block'] has to |
* | // encrypt the content of the $in variable |
* | |
* | $plaintext .= $in; |
* | } |
* | return $plaintext; |
* | |
* | case 'decrypt': |
* | INSERT PHP CODE OF: |
* | $cipher_code['init_decrypt']; // decrypt sepcific init code |
* | ie: specified $key or $box |
* | declarations for decrypt'ing. |
* | foreach ($plaintext) { |
* | $in = $block_size of $plaintext; |
* | |
* | INSERT PHP CODE OF: |
* | $cipher_code['decrypt_block']; // decrypt's (string) $in, which is always |
* | // strlen($in) == $this->block_size |
* | // here comes the cipher algorithm in action |
* | // for decryption. |
* | // $cipher_code['decrypt_block'] has to |
* | // decrypt the content of the $in variable |
* | $ciphertext .= $in; |
* | } |
* | return $ciphertext; |
* | } |
* | } |
* +----------------------------------------------------------------------------------------------+
* </code>
*
* See also the \phpseclib\Crypt\*::_setupInlineCrypt()'s for
* productive inline $cipher_code's how they works.
*
* Structure of:
* <code>
* $cipher_code = array(
* 'init_crypt' => (string) '', // optional
* 'init_encrypt' => (string) '', // optional
* 'init_decrypt' => (string) '', // optional
* 'encrypt_block' => (string) '', // required
* 'decrypt_block' => (string) '' // required
* );
* </code>
*
* @see self::_setupInlineCrypt()
* @see self::encrypt()
* @see self::decrypt()
* @param array $cipher_code
* @access private
* @return string (the name of the created callback function)
*/
function _createInlineCryptFunction($cipher_code)
{
}
/**
* Holds the lambda_functions table (classwide)
*
* Each name of the lambda function, created from
* _setupInlineCrypt() && _createInlineCryptFunction()
* is stored, classwide (!), here for reusing.
*
* The string-based index of $function is a classwide
* unique value representing, at least, the $mode of
* operation (or more... depends of the optimizing level)
* for which $mode the lambda function was created.
*
* @access private
* @return array &$functions
*/
function &_getLambdaFunctions()
{
}
/**
* Generates a digest from $bytes
*
* @see self::_setupInlineCrypt()
* @access private
* @param $bytes
* @return string
*/
function _hashInlineCryptFunction($bytes)
{
}
/**
* Convert float to int
*
* On ARM CPUs converting floats to ints doesn't always work
*
* @access private
* @param string $x
* @return int
*/
function safe_intval($x)
{
}
/**
* eval()'able string for in-line float to int
*
* @access private
* @return string
*/
function safe_intval_inline()
{
}
}
/**
* Pure-PHP implementation of RC2.
*
* @package RC2
* @access public
*/
class RC2 extends \phpseclib\Crypt\Base
{
/**
* Block Length of the cipher
*
* @see \phpseclib\Crypt\Base::block_size
* @var int
* @access private
*/
var $block_size = 8;
/**
* The Key
*
* @see \phpseclib\Crypt\Base::key
* @see self::setKey()
* @var string
* @access private
*/
var $key;
/**
* The Original (unpadded) Key
*
* @see \phpseclib\Crypt\Base::key
* @see self::setKey()
* @see self::encrypt()
* @see self::decrypt()
* @var string
* @access private
*/
var $orig_key;
/**
* Don't truncate / null pad key
*
* @see \phpseclib\Crypt\Base::_clearBuffers()
* @var bool
* @access private
*/
var $skip_key_adjustment = true;
/**
* Key Length (in bytes)
*
* @see \phpseclib\Crypt\RC2::setKeyLength()
* @var int
* @access private
*/
var $key_length = 16;
// = 128 bits
/**
* The mcrypt specific name of the cipher
*
* @see \phpseclib\Crypt\Base::cipher_name_mcrypt
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'rc2';
/**
* Optimizing value while CFB-encrypting
*
* @see \phpseclib\Crypt\Base::cfb_init_len
* @var int
* @access private
*/
var $cfb_init_len = 500;
/**
* The key length in bits.
*
* @see self::setKeyLength()
* @see self::setKey()
* @var int
* @access private
* @internal Should be in range [1..1024].
* @internal Changing this value after setting the key has no effect.
*/
var $default_key_length = 1024;
/**
* The key length in bits.
*
* @see self::isValidEnine()
* @see self::setKey()
* @var int
* @access private
* @internal Should be in range [1..1024].
*/
var $current_key_length;
/**
* The Key Schedule
*
* @see self::_setupKey()
* @var array
* @access private
*/
var $keys;
/**
* Key expansion randomization table.
* Twice the same 256-value sequence to save a modulus in key expansion.
*
* @see self::setKey()
* @var array
* @access private
*/
var $pitable = array(0xd9, 0x78, 0xf9, 0xc4, 0x19, 0xdd, 0xb5, 0xed, 0x28, 0xe9, 0xfd, 0x79, 0x4a, 0xa0, 0xd8, 0x9d, 0xc6, 0x7e, 0x37, 0x83, 0x2b, 0x76, 0x53, 0x8e, 0x62, 0x4c, 0x64, 0x88, 0x44, 0x8b, 0xfb, 0xa2, 0x17, 0x9a, 0x59, 0xf5, 0x87, 0xb3, 0x4f, 0x13, 0x61, 0x45, 0x6d, 0x8d, 0x9, 0x81, 0x7d, 0x32, 0xbd, 0x8f, 0x40, 0xeb, 0x86, 0xb7, 0x7b, 0xb, 0xf0, 0x95, 0x21, 0x22, 0x5c, 0x6b, 0x4e, 0x82, 0x54, 0xd6, 0x65, 0x93, 0xce, 0x60, 0xb2, 0x1c, 0x73, 0x56, 0xc0, 0x14, 0xa7, 0x8c, 0xf1, 0xdc, 0x12, 0x75, 0xca, 0x1f, 0x3b, 0xbe, 0xe4, 0xd1, 0x42, 0x3d, 0xd4, 0x30, 0xa3, 0x3c, 0xb6, 0x26, 0x6f, 0xbf, 0xe, 0xda, 0x46, 0x69, 0x7, 0x57, 0x27, 0xf2, 0x1d, 0x9b, 0xbc, 0x94, 0x43, 0x3, 0xf8, 0x11, 0xc7, 0xf6, 0x90, 0xef, 0x3e, 0xe7, 0x6, 0xc3, 0xd5, 0x2f, 0xc8, 0x66, 0x1e, 0xd7, 0x8, 0xe8, 0xea, 0xde, 0x80, 0x52, 0xee, 0xf7, 0x84, 0xaa, 0x72, 0xac, 0x35, 0x4d, 0x6a, 0x2a, 0x96, 0x1a, 0xd2, 0x71, 0x5a, 0x15, 0x49, 0x74, 0x4b, 0x9f, 0xd0, 0x5e, 0x4, 0x18, 0xa4, 0xec, 0xc2, 0xe0, 0x41, 0x6e, 0xf, 0x51, 0xcb, 0xcc, 0x24, 0x91, 0xaf, 0x50, 0xa1, 0xf4, 0x70, 0x39, 0x99, 0x7c, 0x3a, 0x85, 0x23, 0xb8, 0xb4, 0x7a, 0xfc, 0x2, 0x36, 0x5b, 0x25, 0x55, 0x97, 0x31, 0x2d, 0x5d, 0xfa, 0x98, 0xe3, 0x8a, 0x92, 0xae, 0x5, 0xdf, 0x29, 0x10, 0x67, 0x6c, 0xba, 0xc9, 0xd3, 0x0, 0xe6, 0xcf, 0xe1, 0x9e, 0xa8, 0x2c, 0x63, 0x16, 0x1, 0x3f, 0x58, 0xe2, 0x89, 0xa9, 0xd, 0x38, 0x34, 0x1b, 0xab, 0x33, 0xff, 0xb0, 0xbb, 0x48, 0xc, 0x5f, 0xb9, 0xb1, 0xcd, 0x2e, 0xc5, 0xf3, 0xdb, 0x47, 0xe5, 0xa5, 0x9c, 0x77, 0xa, 0xa6, 0x20, 0x68, 0xfe, 0x7f, 0xc1, 0xad, 0xd9, 0x78, 0xf9, 0xc4, 0x19, 0xdd, 0xb5, 0xed, 0x28, 0xe9, 0xfd, 0x79, 0x4a, 0xa0, 0xd8, 0x9d, 0xc6, 0x7e, 0x37, 0x83, 0x2b, 0x76, 0x53, 0x8e, 0x62, 0x4c, 0x64, 0x88, 0x44, 0x8b, 0xfb, 0xa2, 0x17, 0x9a, 0x59, 0xf5, 0x87, 0xb3, 0x4f, 0x13, 0x61, 0x45, 0x6d, 0x8d, 0x9, 0x81, 0x7d, 0x32, 0xbd, 0x8f, 0x40, 0xeb, 0x86, 0xb7, 0x7b, 0xb, 0xf0, 0x95, 0x21, 0x22, 0x5c, 0x6b, 0x4e, 0x82, 0x54, 0xd6, 0x65, 0x93, 0xce, 0x60, 0xb2, 0x1c, 0x73, 0x56, 0xc0, 0x14, 0xa7, 0x8c, 0xf1, 0xdc, 0x12, 0x75, 0xca, 0x1f, 0x3b, 0xbe, 0xe4, 0xd1, 0x42, 0x3d, 0xd4, 0x30, 0xa3, 0x3c, 0xb6, 0x26, 0x6f, 0xbf, 0xe, 0xda, 0x46, 0x69, 0x7, 0x57, 0x27, 0xf2, 0x1d, 0x9b, 0xbc, 0x94, 0x43, 0x3, 0xf8, 0x11, 0xc7, 0xf6, 0x90, 0xef, 0x3e, 0xe7, 0x6, 0xc3, 0xd5, 0x2f, 0xc8, 0x66, 0x1e, 0xd7, 0x8, 0xe8, 0xea, 0xde, 0x80, 0x52, 0xee, 0xf7, 0x84, 0xaa, 0x72, 0xac, 0x35, 0x4d, 0x6a, 0x2a, 0x96, 0x1a, 0xd2, 0x71, 0x5a, 0x15, 0x49, 0x74, 0x4b, 0x9f, 0xd0, 0x5e, 0x4, 0x18, 0xa4, 0xec, 0xc2, 0xe0, 0x41, 0x6e, 0xf, 0x51, 0xcb, 0xcc, 0x24, 0x91, 0xaf, 0x50, 0xa1, 0xf4, 0x70, 0x39, 0x99, 0x7c, 0x3a, 0x85, 0x23, 0xb8, 0xb4, 0x7a, 0xfc, 0x2, 0x36, 0x5b, 0x25, 0x55, 0x97, 0x31, 0x2d, 0x5d, 0xfa, 0x98, 0xe3, 0x8a, 0x92, 0xae, 0x5, 0xdf, 0x29, 0x10, 0x67, 0x6c, 0xba, 0xc9, 0xd3, 0x0, 0xe6, 0xcf, 0xe1, 0x9e, 0xa8, 0x2c, 0x63, 0x16, 0x1, 0x3f, 0x58, 0xe2, 0x89, 0xa9, 0xd, 0x38, 0x34, 0x1b, 0xab, 0x33, 0xff, 0xb0, 0xbb, 0x48, 0xc, 0x5f, 0xb9, 0xb1, 0xcd, 0x2e, 0xc5, 0xf3, 0xdb, 0x47, 0xe5, 0xa5, 0x9c, 0x77, 0xa, 0xa6, 0x20, 0x68, 0xfe, 0x7f, 0xc1, 0xad);
/**
* Inverse key expansion randomization table.
*
* @see self::setKey()
* @var array
* @access private
*/
var $invpitable = array(0xd1, 0xda, 0xb9, 0x6f, 0x9c, 0xc8, 0x78, 0x66, 0x80, 0x2c, 0xf8, 0x37, 0xea, 0xe0, 0x62, 0xa4, 0xcb, 0x71, 0x50, 0x27, 0x4b, 0x95, 0xd9, 0x20, 0x9d, 0x4, 0x91, 0xe3, 0x47, 0x6a, 0x7e, 0x53, 0xfa, 0x3a, 0x3b, 0xb4, 0xa8, 0xbc, 0x5f, 0x68, 0x8, 0xca, 0x8f, 0x14, 0xd7, 0xc0, 0xef, 0x7b, 0x5b, 0xbf, 0x2f, 0xe5, 0xe2, 0x8c, 0xba, 0x12, 0xe1, 0xaf, 0xb2, 0x54, 0x5d, 0x59, 0x76, 0xdb, 0x32, 0xa2, 0x58, 0x6e, 0x1c, 0x29, 0x64, 0xf3, 0xe9, 0x96, 0xc, 0x98, 0x19, 0x8d, 0x3e, 0x26, 0xab, 0xa5, 0x85, 0x16, 0x40, 0xbd, 0x49, 0x67, 0xdc, 0x22, 0x94, 0xbb, 0x3c, 0xc1, 0x9b, 0xeb, 0x45, 0x28, 0x18, 0xd8, 0x1a, 0x42, 0x7d, 0xcc, 0xfb, 0x65, 0x8e, 0x3d, 0xcd, 0x2a, 0xa3, 0x60, 0xae, 0x93, 0x8a, 0x48, 0x97, 0x51, 0x15, 0xf7, 0x1, 0xb, 0xb7, 0x36, 0xb1, 0x2e, 0x11, 0xfd, 0x84, 0x2d, 0x3f, 0x13, 0x88, 0xb3, 0x34, 0x24, 0x1b, 0xde, 0xc5, 0x1d, 0x4d, 0x2b, 0x17, 0x31, 0x74, 0xa9, 0xc6, 0x43, 0x6d, 0x39, 0x90, 0xbe, 0xc3, 0xb0, 0x21, 0x6b, 0xf6, 0xf, 0xd5, 0x99, 0xd, 0xac, 0x1f, 0x5c, 0x9e, 0xf5, 0xf9, 0x4c, 0xd6, 0xdf, 0x89, 0xe4, 0x8b, 0xff, 0xc7, 0xaa, 0xe7, 0xed, 0x46, 0x25, 0xb6, 0x6, 0x5e, 0x35, 0xb5, 0xec, 0xce, 0xe8, 0x6c, 0x30, 0x55, 0x61, 0x4a, 0xfe, 0xa0, 0x79, 0x3, 0xf0, 0x10, 0x72, 0x7c, 0xcf, 0x52, 0xa6, 0xa7, 0xee, 0x44, 0xd3, 0x9a, 0x57, 0x92, 0xd0, 0x5a, 0x7a, 0x41, 0x7f, 0xe, 0x0, 0x63, 0xf2, 0x4f, 0x5, 0x83, 0xc9, 0xa1, 0xd4, 0xdd, 0xc4, 0x56, 0xf4, 0xd2, 0x77, 0x81, 0x9, 0x82, 0x33, 0x9f, 0x7, 0x86, 0x75, 0x38, 0x4e, 0x69, 0xf1, 0xad, 0x23, 0x73, 0x87, 0x70, 0x2, 0xc2, 0x1e, 0xb8, 0xa, 0xfc, 0xe6);
/**
* Test for engine validity
*
* This is mainly just a wrapper to set things up for \phpseclib\Crypt\Base::isValidEngine()
*
* @see \phpseclib\Crypt\Base::__construct()
* @param int $engine
* @access public
* @return bool
*/
function isValidEngine($engine)
{
}
/**
* Sets the key length.
*
* Valid key lengths are 8 to 1024.
* Calling this function after setting the key has no effect until the next
* \phpseclib\Crypt\RC2::setKey() call.
*
* @access public
* @param int $length in bits
*/
function setKeyLength($length)
{
}
/**
* Returns the current key length
*
* @access public
* @return int
*/
function getKeyLength()
{
}
/**
* Sets the key.
*
* Keys can be of any length. RC2, itself, uses 8 to 1024 bit keys (eg.
* strlen($key) <= 128), however, we only use the first 128 bytes if $key
* has more then 128 bytes in it, and set $key to a single null byte if
* it is empty.
*
* If the key is not explicitly set, it'll be assumed to be a single
* null byte.
*
* @see \phpseclib\Crypt\Base::setKey()
* @access public
* @param string $key
* @param int $t1 optional Effective key length in bits.
*/
function setKey($key, $t1 = 0)
{
}
/**
* Encrypts a message.
*
* Mostly a wrapper for \phpseclib\Crypt\Base::encrypt, with some additional OpenSSL handling code
*
* @see self::decrypt()
* @access public
* @param string $plaintext
* @return string $ciphertext
*/
function encrypt($plaintext)
{
}
/**
* Decrypts a message.
*
* Mostly a wrapper for \phpseclib\Crypt\Base::decrypt, with some additional OpenSSL handling code
*
* @see self::encrypt()
* @access public
* @param string $ciphertext
* @return string $plaintext
*/
function decrypt($ciphertext)
{
}
/**
* Encrypts a block
*
* @see \phpseclib\Crypt\Base::_encryptBlock()
* @see \phpseclib\Crypt\Base::encrypt()
* @access private
* @param string $in
* @return string
*/
function _encryptBlock($in)
{
}
/**
* Decrypts a block
*
* @see \phpseclib\Crypt\Base::_decryptBlock()
* @see \phpseclib\Crypt\Base::decrypt()
* @access private
* @param string $in
* @return string
*/
function _decryptBlock($in)
{
}
/**
* Setup the \phpseclib\Crypt\Base::ENGINE_MCRYPT $engine
*
* @see \phpseclib\Crypt\Base::_setupMcrypt()
* @access private
*/
function _setupMcrypt()
{
}
/**
* Creates the key schedule
*
* @see \phpseclib\Crypt\Base::_setupKey()
* @access private
*/
function _setupKey()
{
}
/**
* Setup the performance-optimized function for de/encrypt()
*
* @see \phpseclib\Crypt\Base::_setupInlineCrypt()
* @access private
*/
function _setupInlineCrypt()
{
}
}
/**
* Pure-PHP Random Number Generator
*
* @package Random
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class Random
{
/**
* Generate a random string.
*
* Although microoptimizations are generally discouraged as they impair readability this function is ripe with
* microoptimizations because this function has the potential of being called a huge number of times.
* eg. for RSA key generation.
*
* @param int $length
* @return string
*/
static function string($length)
{
}
}
/**
* Pure-PHP implementation of Rijndael.
*
* @package Rijndael
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class Rijndael extends \phpseclib\Crypt\Base
{
/**
* The mcrypt specific name of the cipher
*
* Mcrypt is useable for 128/192/256-bit $block_size/$key_length. For 160/224 not.
* \phpseclib\Crypt\Rijndael determines automatically whether mcrypt is useable
* or not for the current $block_size/$key_length.
* In case of, $cipher_name_mcrypt will be set dynamically at run time accordingly.
*
* @see \phpseclib\Crypt\Base::cipher_name_mcrypt
* @see \phpseclib\Crypt\Base::engine
* @see self::isValidEngine()
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'rijndael-128';
/**
* The default salt used by setPassword()
*
* @see \phpseclib\Crypt\Base::password_default_salt
* @see \phpseclib\Crypt\Base::setPassword()
* @var string
* @access private
*/
var $password_default_salt = 'phpseclib';
/**
* The Key Schedule
*
* @see self::_setup()
* @var array
* @access private
*/
var $w;
/**
* The Inverse Key Schedule
*
* @see self::_setup()
* @var array
* @access private
*/
var $dw;
/**
* The Block Length divided by 32
*
* @see self::setBlockLength()
* @var int
* @access private
* @internal The max value is 256 / 32 = 8, the min value is 128 / 32 = 4. Exists in conjunction with $block_size
* because the encryption / decryption / key schedule creation requires this number and not $block_size. We could
* derive this from $block_size or vice versa, but that'd mean we'd have to do multiple shift operations, so in lieu
* of that, we'll just precompute it once.
*/
var $Nb = 4;
/**
* The Key Length (in bytes)
*
* @see self::setKeyLength()
* @var int
* @access private
* @internal The max value is 256 / 8 = 32, the min value is 128 / 8 = 16. Exists in conjunction with $Nk
* because the encryption / decryption / key schedule creation requires this number and not $key_length. We could
* derive this from $key_length or vice versa, but that'd mean we'd have to do multiple shift operations, so in lieu
* of that, we'll just precompute it once.
*/
var $key_length = 16;
/**
* The Key Length divided by 32
*
* @see self::setKeyLength()
* @var int
* @access private
* @internal The max value is 256 / 32 = 8, the min value is 128 / 32 = 4
*/
var $Nk = 4;
/**
* The Number of Rounds
*
* @var int
* @access private
* @internal The max value is 14, the min value is 10.
*/
var $Nr;
/**
* Shift offsets
*
* @var array
* @access private
*/
var $c;
/**
* Holds the last used key- and block_size information
*
* @var array
* @access private
*/
var $kl;
/**
* Sets the key length.
*
* Valid key lengths are 128, 160, 192, 224, and 256. If the length is less than 128, it will be rounded up to
* 128. If the length is greater than 128 and invalid, it will be rounded down to the closest valid amount.
*
* Note: phpseclib extends Rijndael (and AES) for using 160- and 224-bit keys but they are officially not defined
* and the most (if not all) implementations are not able using 160/224-bit keys but round/pad them up to
* 192/256 bits as, for example, mcrypt will do.
*
* That said, if you want be compatible with other Rijndael and AES implementations,
* you should not setKeyLength(160) or setKeyLength(224).
*
* Additional: In case of 160- and 224-bit keys, phpseclib will/can, for that reason, not use
* the mcrypt php extension, even if available.
* This results then in slower encryption.
*
* @access public
* @param int $length
*/
function setKeyLength($length)
{
}
/**
* Sets the block length
*
* Valid block lengths are 128, 160, 192, 224, and 256. If the length is less than 128, it will be rounded up to
* 128. If the length is greater than 128 and invalid, it will be rounded down to the closest valid amount.
*
* @access public
* @param int $length
*/
function setBlockLength($length)
{
}
/**
* Test for engine validity
*
* This is mainly just a wrapper to set things up for \phpseclib\Crypt\Base::isValidEngine()
*
* @see \phpseclib\Crypt\Base::__construct()
* @param int $engine
* @access public
* @return bool
*/
function isValidEngine($engine)
{
}
/**
* Encrypts a block
*
* @access private
* @param string $in
* @return string
*/
function _encryptBlock($in)
{
}
/**
* Decrypts a block
*
* @access private
* @param string $in
* @return string
*/
function _decryptBlock($in)
{
}
/**
* Setup the key (expansion)
*
* @see \phpseclib\Crypt\Base::_setupKey()
* @access private
*/
function _setupKey()
{
}
/**
* Performs S-Box substitutions
*
* @access private
* @param int $word
*/
function _subWord($word)
{
}
/**
* Provides the mixColumns and sboxes tables
*
* @see self::_encryptBlock()
* @see self::_setupInlineCrypt()
* @see self::_subWord()
* @access private
* @return array &$tables
*/
function &_getTables()
{
}
/**
* Provides the inverse mixColumns and inverse sboxes tables
*
* @see self::_decryptBlock()
* @see self::_setupInlineCrypt()
* @see self::_setupKey()
* @access private
* @return array &$tables
*/
function &_getInvTables()
{
}
/**
* Setup the performance-optimized function for de/encrypt()
*
* @see \phpseclib\Crypt\Base::_setupInlineCrypt()
* @access private
*/
function _setupInlineCrypt()
{
}
}
/**
* Pure-PHP implementation of Blowfish.
*
* @package Blowfish
* @author Jim Wigginton <terrafrost@php.net>
* @author Hans-Juergen Petrich <petrich@tronic-media.com>
* @access public
*/
class Blowfish extends \phpseclib\Crypt\Base
{
/**
* Block Length of the cipher
*
* @see \phpseclib\Crypt\Base::block_size
* @var int
* @access private
*/
var $block_size = 8;
/**
* The mcrypt specific name of the cipher
*
* @see \phpseclib\Crypt\Base::cipher_name_mcrypt
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'blowfish';
/**
* Optimizing value while CFB-encrypting
*
* @see \phpseclib\Crypt\Base::cfb_init_len
* @var int
* @access private
*/
var $cfb_init_len = 500;
/**
* The fixed subkeys boxes ($sbox0 - $sbox3) with 256 entries each
*
* S-Box 0
*
* @access private
* @var array
*/
var $sbox0 = array(0xd1310ba6, 0x98dfb5ac, 0x2ffd72db, 0xd01adfb7, 0xb8e1afed, 0x6a267e96, 0xba7c9045, 0xf12c7f99, 0x24a19947, 0xb3916cf7, 0x801f2e2, 0x858efc16, 0x636920d8, 0x71574e69, 0xa458fea3, 0xf4933d7e, 0xd95748f, 0x728eb658, 0x718bcd58, 0x82154aee, 0x7b54a41d, 0xc25a59b5, 0x9c30d539, 0x2af26013, 0xc5d1b023, 0x286085f0, 0xca417918, 0xb8db38ef, 0x8e79dcb0, 0x603a180e, 0x6c9e0e8b, 0xb01e8a3e, 0xd71577c1, 0xbd314b27, 0x78af2fda, 0x55605c60, 0xe65525f3, 0xaa55ab94, 0x57489862, 0x63e81440, 0x55ca396a, 0x2aab10b6, 0xb4cc5c34, 0x1141e8ce, 0xa15486af, 0x7c72e993, 0xb3ee1411, 0x636fbc2a, 0x2ba9c55d, 0x741831f6, 0xce5c3e16, 0x9b87931e, 0xafd6ba33, 0x6c24cf5c, 0x7a325381, 0x28958677, 0x3b8f4898, 0x6b4bb9af, 0xc4bfe81b, 0x66282193, 0x61d809cc, 0xfb21a991, 0x487cac60, 0x5dec8032, 0xef845d5d, 0xe98575b1, 0xdc262302, 0xeb651b88, 0x23893e81, 0xd396acc5, 0xf6d6ff3, 0x83f44239, 0x2e0b4482, 0xa4842004, 0x69c8f04a, 0x9e1f9b5e, 0x21c66842, 0xf6e96c9a, 0x670c9c61, 0xabd388f0, 0x6a51a0d2, 0xd8542f68, 0x960fa728, 0xab5133a3, 0x6eef0b6c, 0x137a3be4, 0xba3bf050, 0x7efb2a98, 0xa1f1651d, 0x39af0176, 0x66ca593e, 0x82430e88, 0x8cee8619, 0x456f9fb4, 0x7d84a5c3, 0x3b8b5ebe, 0xe06f75d8, 0x85c12073, 0x401a449f, 0x56c16aa6, 0x4ed3aa62, 0x363f7706, 0x1bfedf72, 0x429b023d, 0x37d0d724, 0xd00a1248, 0xdb0fead3, 0x49f1c09b, 0x75372c9, 0x80991b7b, 0x25d479d8, 0xf6e8def7, 0xe3fe501a, 0xb6794c3b, 0x976ce0bd, 0x4c006ba, 0xc1a94fb6, 0x409f60c4, 0x5e5c9ec2, 0x196a2463, 0x68fb6faf, 0x3e6c53b5, 0x1339b2eb, 0x3b52ec6f, 0x6dfc511f, 0x9b30952c, 0xcc814544, 0xaf5ebd09, 0xbee3d004, 0xde334afd, 0x660f2807, 0x192e4bb3, 0xc0cba857, 0x45c8740f, 0xd20b5f39, 0xb9d3fbdb, 0x5579c0bd, 0x1a60320a, 0xd6a100c6, 0x402c7279, 0x679f25fe, 0xfb1fa3cc, 0x8ea5e9f8, 0xdb3222f8, 0x3c7516df, 0xfd616b15, 0x2f501ec8, 0xad0552ab, 0x323db5fa, 0xfd238760, 0x53317b48, 0x3e00df82, 0x9e5c57bb, 0xca6f8ca0, 0x1a87562e, 0xdf1769db, 0xd542a8f6, 0x287effc3, 0xac6732c6, 0x8c4f5573, 0x695b27b0, 0xbbca58c8, 0xe1ffa35d, 0xb8f011a0, 0x10fa3d98, 0xfd2183b8, 0x4afcb56c, 0x2dd1d35b, 0x9a53e479, 0xb6f84565, 0xd28e49bc, 0x4bfb9790, 0xe1ddf2da, 0xa4cb7e33, 0x62fb1341, 0xcee4c6e8, 0xef20cada, 0x36774c01, 0xd07e9efe, 0x2bf11fb4, 0x95dbda4d, 0xae909198, 0xeaad8e71, 0x6b93d5a0, 0xd08ed1d0, 0xafc725e0, 0x8e3c5b2f, 0x8e7594b7, 0x8ff6e2fb, 0xf2122b64, 0x8888b812, 0x900df01c, 0x4fad5ea0, 0x688fc31c, 0xd1cff191, 0xb3a8c1ad, 0x2f2f2218, 0xbe0e1777, 0xea752dfe, 0x8b021fa1, 0xe5a0cc0f, 0xb56f74e8, 0x18acf3d6, 0xce89e299, 0xb4a84fe0, 0xfd13e0b7, 0x7cc43b81, 0xd2ada8d9, 0x165fa266, 0x80957705, 0x93cc7314, 0x211a1477, 0xe6ad2065, 0x77b5fa86, 0xc75442f5, 0xfb9d35cf, 0xebcdaf0c, 0x7b3e89a0, 0xd6411bd3, 0xae1e7e49, 0x250e2d, 0x2071b35e, 0x226800bb, 0x57b8e0af, 0x2464369b, 0xf009b91e, 0x5563911d, 0x59dfa6aa, 0x78c14389, 0xd95a537f, 0x207d5ba2, 0x2e5b9c5, 0x83260376, 0x6295cfa9, 0x11c81968, 0x4e734a41, 0xb3472dca, 0x7b14a94a, 0x1b510052, 0x9a532915, 0xd60f573f, 0xbc9bc6e4, 0x2b60a476, 0x81e67400, 0x8ba6fb5, 0x571be91f, 0xf296ec6b, 0x2a0dd915, 0xb6636521, 0xe7b9f9b6, 0xff34052e, 0xc5855664, 0x53b02d5d, 0xa99f8fa1, 0x8ba4799, 0x6e85076a);
/**
* S-Box 1
*
* @access private
* @var array
*/
var $sbox1 = array(0x4b7a70e9, 0xb5b32944, 0xdb75092e, 0xc4192623, 0xad6ea6b0, 0x49a7df7d, 0x9cee60b8, 0x8fedb266, 0xecaa8c71, 0x699a17ff, 0x5664526c, 0xc2b19ee1, 0x193602a5, 0x75094c29, 0xa0591340, 0xe4183a3e, 0x3f54989a, 0x5b429d65, 0x6b8fe4d6, 0x99f73fd6, 0xa1d29c07, 0xefe830f5, 0x4d2d38e6, 0xf0255dc1, 0x4cdd2086, 0x8470eb26, 0x6382e9c6, 0x21ecc5e, 0x9686b3f, 0x3ebaefc9, 0x3c971814, 0x6b6a70a1, 0x687f3584, 0x52a0e286, 0xb79c5305, 0xaa500737, 0x3e07841c, 0x7fdeae5c, 0x8e7d44ec, 0x5716f2b8, 0xb03ada37, 0xf0500c0d, 0xf01c1f04, 0x200b3ff, 0xae0cf51a, 0x3cb574b2, 0x25837a58, 0xdc0921bd, 0xd19113f9, 0x7ca92ff6, 0x94324773, 0x22f54701, 0x3ae5e581, 0x37c2dadc, 0xc8b57634, 0x9af3dda7, 0xa9446146, 0xfd0030e, 0xecc8c73e, 0xa4751e41, 0xe238cd99, 0x3bea0e2f, 0x3280bba1, 0x183eb331, 0x4e548b38, 0x4f6db908, 0x6f420d03, 0xf60a04bf, 0x2cb81290, 0x24977c79, 0x5679b072, 0xbcaf89af, 0xde9a771f, 0xd9930810, 0xb38bae12, 0xdccf3f2e, 0x5512721f, 0x2e6b7124, 0x501adde6, 0x9f84cd87, 0x7a584718, 0x7408da17, 0xbc9f9abc, 0xe94b7d8c, 0xec7aec3a, 0xdb851dfa, 0x63094366, 0xc464c3d2, 0xef1c1847, 0x3215d908, 0xdd433b37, 0x24c2ba16, 0x12a14d43, 0x2a65c451, 0x50940002, 0x133ae4dd, 0x71dff89e, 0x10314e55, 0x81ac77d6, 0x5f11199b, 0x43556f1, 0xd7a3c76b, 0x3c11183b, 0x5924a509, 0xf28fe6ed, 0x97f1fbfa, 0x9ebabf2c, 0x1e153c6e, 0x86e34570, 0xeae96fb1, 0x860e5e0a, 0x5a3e2ab3, 0x771fe71c, 0x4e3d06fa, 0x2965dcb9, 0x99e71d0f, 0x803e89d6, 0x5266c825, 0x2e4cc978, 0x9c10b36a, 0xc6150eba, 0x94e2ea78, 0xa5fc3c53, 0x1e0a2df4, 0xf2f74ea7, 0x361d2b3d, 0x1939260f, 0x19c27960, 0x5223a708, 0xf71312b6, 0xebadfe6e, 0xeac31f66, 0xe3bc4595, 0xa67bc883, 0xb17f37d1, 0x18cff28, 0xc332ddef, 0xbe6c5aa5, 0x65582185, 0x68ab9802, 0xeecea50f, 0xdb2f953b, 0x2aef7dad, 0x5b6e2f84, 0x1521b628, 0x29076170, 0xecdd4775, 0x619f1510, 0x13cca830, 0xeb61bd96, 0x334fe1e, 0xaa0363cf, 0xb5735c90, 0x4c70a239, 0xd59e9e0b, 0xcbaade14, 0xeecc86bc, 0x60622ca7, 0x9cab5cab, 0xb2f3846e, 0x648b1eaf, 0x19bdf0ca, 0xa02369b9, 0x655abb50, 0x40685a32, 0x3c2ab4b3, 0x319ee9d5, 0xc021b8f7, 0x9b540b19, 0x875fa099, 0x95f7997e, 0x623d7da8, 0xf837889a, 0x97e32d77, 0x11ed935f, 0x16681281, 0xe358829, 0xc7e61fd6, 0x96dedfa1, 0x7858ba99, 0x57f584a5, 0x1b227263, 0x9b83c3ff, 0x1ac24696, 0xcdb30aeb, 0x532e3054, 0x8fd948e4, 0x6dbc3128, 0x58ebf2ef, 0x34c6ffea, 0xfe28ed61, 0xee7c3c73, 0x5d4a14d9, 0xe864b7e3, 0x42105d14, 0x203e13e0, 0x45eee2b6, 0xa3aaabea, 0xdb6c4f15, 0xfacb4fd0, 0xc742f442, 0xef6abbb5, 0x654f3b1d, 0x41cd2105, 0xd81e799e, 0x86854dc7, 0xe44b476a, 0x3d816250, 0xcf62a1f2, 0x5b8d2646, 0xfc8883a0, 0xc1c7b6a3, 0x7f1524c3, 0x69cb7492, 0x47848a0b, 0x5692b285, 0x95bbf00, 0xad19489d, 0x1462b174, 0x23820e00, 0x58428d2a, 0xc55f5ea, 0x1dadf43e, 0x233f7061, 0x3372f092, 0x8d937e41, 0xd65fecf1, 0x6c223bdb, 0x7cde3759, 0xcbee7460, 0x4085f2a7, 0xce77326e, 0xa6078084, 0x19f8509e, 0xe8efd855, 0x61d99735, 0xa969a7aa, 0xc50c06c2, 0x5a04abfc, 0x800bcadc, 0x9e447a2e, 0xc3453484, 0xfdd56705, 0xe1e9ec9, 0xdb73dbd3, 0x105588cd, 0x675fda79, 0xe3674340, 0xc5c43465, 0x713e38d8, 0x3d28f89e, 0xf16dff20, 0x153e21e7, 0x8fb03d4a, 0xe6e39f2b, 0xdb83adf7);
/**
* S-Box 2
*
* @access private
* @var array
*/
var $sbox2 = array(0xe93d5a68, 0x948140f7, 0xf64c261c, 0x94692934, 0x411520f7, 0x7602d4f7, 0xbcf46b2e, 0xd4a20068, 0xd4082471, 0x3320f46a, 0x43b7d4b7, 0x500061af, 0x1e39f62e, 0x97244546, 0x14214f74, 0xbf8b8840, 0x4d95fc1d, 0x96b591af, 0x70f4ddd3, 0x66a02f45, 0xbfbc09ec, 0x3bd9785, 0x7fac6dd0, 0x31cb8504, 0x96eb27b3, 0x55fd3941, 0xda2547e6, 0xabca0a9a, 0x28507825, 0x530429f4, 0xa2c86da, 0xe9b66dfb, 0x68dc1462, 0xd7486900, 0x680ec0a4, 0x27a18dee, 0x4f3ffea2, 0xe887ad8c, 0xb58ce006, 0x7af4d6b6, 0xaace1e7c, 0xd3375fec, 0xce78a399, 0x406b2a42, 0x20fe9e35, 0xd9f385b9, 0xee39d7ab, 0x3b124e8b, 0x1dc9faf7, 0x4b6d1856, 0x26a36631, 0xeae397b2, 0x3a6efa74, 0xdd5b4332, 0x6841e7f7, 0xca7820fb, 0xfb0af54e, 0xd8feb397, 0x454056ac, 0xba489527, 0x55533a3a, 0x20838d87, 0xfe6ba9b7, 0xd096954b, 0x55a867bc, 0xa1159a58, 0xcca92963, 0x99e1db33, 0xa62a4a56, 0x3f3125f9, 0x5ef47e1c, 0x9029317c, 0xfdf8e802, 0x4272f70, 0x80bb155c, 0x5282ce3, 0x95c11548, 0xe4c66d22, 0x48c1133f, 0xc70f86dc, 0x7f9c9ee, 0x41041f0f, 0x404779a4, 0x5d886e17, 0x325f51eb, 0xd59bc0d1, 0xf2bcc18f, 0x41113564, 0x257b7834, 0x602a9c60, 0xdff8e8a3, 0x1f636c1b, 0xe12b4c2, 0x2e1329e, 0xaf664fd1, 0xcad18115, 0x6b2395e0, 0x333e92e1, 0x3b240b62, 0xeebeb922, 0x85b2a20e, 0xe6ba0d99, 0xde720c8c, 0x2da2f728, 0xd0127845, 0x95b794fd, 0x647d0862, 0xe7ccf5f0, 0x5449a36f, 0x877d48fa, 0xc39dfd27, 0xf33e8d1e, 0xa476341, 0x992eff74, 0x3a6f6eab, 0xf4f8fd37, 0xa812dc60, 0xa1ebddf8, 0x991be14c, 0xdb6e6b0d, 0xc67b5510, 0x6d672c37, 0x2765d43b, 0xdcd0e804, 0xf1290dc7, 0xcc00ffa3, 0xb5390f92, 0x690fed0b, 0x667b9ffb, 0xcedb7d9c, 0xa091cf0b, 0xd9155ea3, 0xbb132f88, 0x515bad24, 0x7b9479bf, 0x763bd6eb, 0x37392eb3, 0xcc115979, 0x8026e297, 0xf42e312d, 0x6842ada7, 0xc66a2b3b, 0x12754ccc, 0x782ef11c, 0x6a124237, 0xb79251e7, 0x6a1bbe6, 0x4bfb6350, 0x1a6b1018, 0x11caedfa, 0x3d25bdd8, 0xe2e1c3c9, 0x44421659, 0xa121386, 0xd90cec6e, 0xd5abea2a, 0x64af674e, 0xda86a85f, 0xbebfe988, 0x64e4c3fe, 0x9dbc8057, 0xf0f7c086, 0x60787bf8, 0x6003604d, 0xd1fd8346, 0xf6381fb0, 0x7745ae04, 0xd736fccc, 0x83426b33, 0xf01eab71, 0xb0804187, 0x3c005e5f, 0x77a057be, 0xbde8ae24, 0x55464299, 0xbf582e61, 0x4e58f48f, 0xf2ddfda2, 0xf474ef38, 0x8789bdc2, 0x5366f9c3, 0xc8b38e74, 0xb475f255, 0x46fcd9b9, 0x7aeb2661, 0x8b1ddf84, 0x846a0e79, 0x915f95e2, 0x466e598e, 0x20b45770, 0x8cd55591, 0xc902de4c, 0xb90bace1, 0xbb8205d0, 0x11a86248, 0x7574a99e, 0xb77f19b6, 0xe0a9dc09, 0x662d09a1, 0xc4324633, 0xe85a1f02, 0x9f0be8c, 0x4a99a025, 0x1d6efe10, 0x1ab93d1d, 0xba5a4df, 0xa186f20f, 0x2868f169, 0xdcb7da83, 0x573906fe, 0xa1e2ce9b, 0x4fcd7f52, 0x50115e01, 0xa70683fa, 0xa002b5c4, 0xde6d027, 0x9af88c27, 0x773f8641, 0xc3604c06, 0x61a806b5, 0xf0177a28, 0xc0f586e0, 0x6058aa, 0x30dc7d62, 0x11e69ed7, 0x2338ea63, 0x53c2dd94, 0xc2c21634, 0xbbcbee56, 0x90bcb6de, 0xebfc7da1, 0xce591d76, 0x6f05e409, 0x4b7c0188, 0x39720a3d, 0x7c927c24, 0x86e3725f, 0x724d9db9, 0x1ac15bb4, 0xd39eb8fc, 0xed545578, 0x8fca5b5, 0xd83d7cd3, 0x4dad0fc4, 0x1e50ef5e, 0xb161e6f8, 0xa28514d9, 0x6c51133c, 0x6fd5c7e7, 0x56e14ec4, 0x362abfce, 0xddc6c837, 0xd79a3234, 0x92638212, 0x670efa8e, 0x406000e0);
/**
* S-Box 3
*
* @access private
* @var array
*/
var $sbox3 = array(0x3a39ce37, 0xd3faf5cf, 0xabc27737, 0x5ac52d1b, 0x5cb0679e, 0x4fa33742, 0xd3822740, 0x99bc9bbe, 0xd5118e9d, 0xbf0f7315, 0xd62d1c7e, 0xc700c47b, 0xb78c1b6b, 0x21a19045, 0xb26eb1be, 0x6a366eb4, 0x5748ab2f, 0xbc946e79, 0xc6a376d2, 0x6549c2c8, 0x530ff8ee, 0x468dde7d, 0xd5730a1d, 0x4cd04dc6, 0x2939bbdb, 0xa9ba4650, 0xac9526e8, 0xbe5ee304, 0xa1fad5f0, 0x6a2d519a, 0x63ef8ce2, 0x9a86ee22, 0xc089c2b8, 0x43242ef6, 0xa51e03aa, 0x9cf2d0a4, 0x83c061ba, 0x9be96a4d, 0x8fe51550, 0xba645bd6, 0x2826a2f9, 0xa73a3ae1, 0x4ba99586, 0xef5562e9, 0xc72fefd3, 0xf752f7da, 0x3f046f69, 0x77fa0a59, 0x80e4a915, 0x87b08601, 0x9b09e6ad, 0x3b3ee593, 0xe990fd5a, 0x9e34d797, 0x2cf0b7d9, 0x22b8b51, 0x96d5ac3a, 0x17da67d, 0xd1cf3ed6, 0x7c7d2d28, 0x1f9f25cf, 0xadf2b89b, 0x5ad6b472, 0x5a88f54c, 0xe029ac71, 0xe019a5e6, 0x47b0acfd, 0xed93fa9b, 0xe8d3c48d, 0x283b57cc, 0xf8d56629, 0x79132e28, 0x785f0191, 0xed756055, 0xf7960e44, 0xe3d35e8c, 0x15056dd4, 0x88f46dba, 0x3a16125, 0x564f0bd, 0xc3eb9e15, 0x3c9057a2, 0x97271aec, 0xa93a072a, 0x1b3f6d9b, 0x1e6321f5, 0xf59c66fb, 0x26dcf319, 0x7533d928, 0xb155fdf5, 0x3563482, 0x8aba3cbb, 0x28517711, 0xc20ad9f8, 0xabcc5167, 0xccad925f, 0x4de81751, 0x3830dc8e, 0x379d5862, 0x9320f991, 0xea7a90c2, 0xfb3e7bce, 0x5121ce64, 0x774fbe32, 0xa8b6e37e, 0xc3293d46, 0x48de5369, 0x6413e680, 0xa2ae0810, 0xdd6db224, 0x69852dfd, 0x9072166, 0xb39a460a, 0x6445c0dd, 0x586cdecf, 0x1c20c8ae, 0x5bbef7dd, 0x1b588d40, 0xccd2017f, 0x6bb4e3bb, 0xdda26a7e, 0x3a59ff45, 0x3e350a44, 0xbcb4cdd5, 0x72eacea8, 0xfa6484bb, 0x8d6612ae, 0xbf3c6f47, 0xd29be463, 0x542f5d9e, 0xaec2771b, 0xf64e6370, 0x740e0d8d, 0xe75b1357, 0xf8721671, 0xaf537d5d, 0x4040cb08, 0x4eb4e2cc, 0x34d2466a, 0x115af84, 0xe1b00428, 0x95983a1d, 0x6b89fb4, 0xce6ea048, 0x6f3f3b82, 0x3520ab82, 0x11a1d4b, 0x277227f8, 0x611560b1, 0xe7933fdc, 0xbb3a792b, 0x344525bd, 0xa08839e1, 0x51ce794b, 0x2f32c9b7, 0xa01fbac9, 0xe01cc87e, 0xbcc7d1f6, 0xcf0111c3, 0xa1e8aac7, 0x1a908749, 0xd44fbd9a, 0xd0dadecb, 0xd50ada38, 0x339c32a, 0xc6913667, 0x8df9317c, 0xe0b12b4f, 0xf79e59b7, 0x43f5bb3a, 0xf2d519ff, 0x27d9459c, 0xbf97222c, 0x15e6fc2a, 0xf91fc71, 0x9b941525, 0xfae59361, 0xceb69ceb, 0xc2a86459, 0x12baa8d1, 0xb6c1075e, 0xe3056a0c, 0x10d25065, 0xcb03a442, 0xe0ec6e0e, 0x1698db3b, 0x4c98a0be, 0x3278e964, 0x9f1f9532, 0xe0d392df, 0xd3a0342b, 0x8971f21e, 0x1b0a7441, 0x4ba3348c, 0xc5be7120, 0xc37632d8, 0xdf359f8d, 0x9b992f2e, 0xe60b6f47, 0xfe3f11d, 0xe54cda54, 0x1edad891, 0xce6279cf, 0xcd3e7e6f, 0x1618b166, 0xfd2c1d05, 0x848fd2c5, 0xf6fb2299, 0xf523f357, 0xa6327623, 0x93a83531, 0x56cccd02, 0xacf08162, 0x5a75ebb5, 0x6e163697, 0x88d273cc, 0xde966292, 0x81b949d0, 0x4c50901b, 0x71c65614, 0xe6c6c7bd, 0x327a140a, 0x45e1d006, 0xc3f27b9a, 0xc9aa53fd, 0x62a80f00, 0xbb25bfe2, 0x35bdd2f6, 0x71126905, 0xb2040222, 0xb6cbcf7c, 0xcd769c2b, 0x53113ec0, 0x1640e3d3, 0x38abbd60, 0x2547adf0, 0xba38209c, 0xf746ce76, 0x77afa1c5, 0x20756060, 0x85cbfe4e, 0x8ae88dd8, 0x7aaaf9b0, 0x4cf9aa7e, 0x1948c25c, 0x2fb8a8c, 0x1c36ae4, 0xd6ebe1f9, 0x90d4f869, 0xa65cdea0, 0x3f09252d, 0xc208e69f, 0xb74e6132, 0xce77e25b, 0x578fdfe3, 0x3ac372e6);
/**
* P-Array consists of 18 32-bit subkeys
*
* @var array
* @access private
*/
var $parray = array(0x243f6a88, 0x85a308d3, 0x13198a2e, 0x3707344, 0xa4093822, 0x299f31d0, 0x82efa98, 0xec4e6c89, 0x452821e6, 0x38d01377, 0xbe5466cf, 0x34e90c6c, 0xc0ac29b7, 0xc97c50dd, 0x3f84d5b5, 0xb5470917, 0x9216d5d9, 0x8979fb1b);
/**
* The BCTX-working Array
*
* Holds the expanded key [p] and the key-depended s-boxes [sb]
*
* @var array
* @access private
*/
var $bctx;
/**
* Holds the last used key
*
* @var array
* @access private
*/
var $kl;
/**
* The Key Length (in bytes)
*
* @see \phpseclib\Crypt\Base::setKeyLength()
* @var int
* @access private
* @internal The max value is 256 / 8 = 32, the min value is 128 / 8 = 16. Exists in conjunction with $Nk
* because the encryption / decryption / key schedule creation requires this number and not $key_length. We could
* derive this from $key_length or vice versa, but that'd mean we'd have to do multiple shift operations, so in lieu
* of that, we'll just precompute it once.
*/
var $key_length = 16;
/**
* Sets the key length.
*
* Key lengths can be between 32 and 448 bits.
*
* @access public
* @param int $length
*/
function setKeyLength($length)
{
}
/**
* Test for engine validity
*
* This is mainly just a wrapper to set things up for \phpseclib\Crypt\Base::isValidEngine()
*
* @see \phpseclib\Crypt\Base::isValidEngine()
* @param int $engine
* @access public
* @return bool
*/
function isValidEngine($engine)
{
}
/**
* Setup the key (expansion)
*
* @see \phpseclib\Crypt\Base::_setupKey()
* @access private
*/
function _setupKey()
{
}
/**
* Encrypts a block
*
* @access private
* @param string $in
* @return string
*/
function _encryptBlock($in)
{
}
/**
* Decrypts a block
*
* @access private
* @param string $in
* @return string
*/
function _decryptBlock($in)
{
}
/**
* Setup the performance-optimized function for de/encrypt()
*
* @see \phpseclib\Crypt\Base::_setupInlineCrypt()
* @access private
*/
function _setupInlineCrypt()
{
}
}
/**
* Pure-PHP implementation of Twofish.
*
* @package Twofish
* @author Jim Wigginton <terrafrost@php.net>
* @author Hans-Juergen Petrich <petrich@tronic-media.com>
* @access public
*/
class Twofish extends \phpseclib\Crypt\Base
{
/**
* The mcrypt specific name of the cipher
*
* @see \phpseclib\Crypt\Base::cipher_name_mcrypt
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'twofish';
/**
* Optimizing value while CFB-encrypting
*
* @see \phpseclib\Crypt\Base::cfb_init_len
* @var int
* @access private
*/
var $cfb_init_len = 800;
/**
* Q-Table
*
* @var array
* @access private
*/
var $q0 = array(0xa9, 0x67, 0xb3, 0xe8, 0x4, 0xfd, 0xa3, 0x76, 0x9a, 0x92, 0x80, 0x78, 0xe4, 0xdd, 0xd1, 0x38, 0xd, 0xc6, 0x35, 0x98, 0x18, 0xf7, 0xec, 0x6c, 0x43, 0x75, 0x37, 0x26, 0xfa, 0x13, 0x94, 0x48, 0xf2, 0xd0, 0x8b, 0x30, 0x84, 0x54, 0xdf, 0x23, 0x19, 0x5b, 0x3d, 0x59, 0xf3, 0xae, 0xa2, 0x82, 0x63, 0x1, 0x83, 0x2e, 0xd9, 0x51, 0x9b, 0x7c, 0xa6, 0xeb, 0xa5, 0xbe, 0x16, 0xc, 0xe3, 0x61, 0xc0, 0x8c, 0x3a, 0xf5, 0x73, 0x2c, 0x25, 0xb, 0xbb, 0x4e, 0x89, 0x6b, 0x53, 0x6a, 0xb4, 0xf1, 0xe1, 0xe6, 0xbd, 0x45, 0xe2, 0xf4, 0xb6, 0x66, 0xcc, 0x95, 0x3, 0x56, 0xd4, 0x1c, 0x1e, 0xd7, 0xfb, 0xc3, 0x8e, 0xb5, 0xe9, 0xcf, 0xbf, 0xba, 0xea, 0x77, 0x39, 0xaf, 0x33, 0xc9, 0x62, 0x71, 0x81, 0x79, 0x9, 0xad, 0x24, 0xcd, 0xf9, 0xd8, 0xe5, 0xc5, 0xb9, 0x4d, 0x44, 0x8, 0x86, 0xe7, 0xa1, 0x1d, 0xaa, 0xed, 0x6, 0x70, 0xb2, 0xd2, 0x41, 0x7b, 0xa0, 0x11, 0x31, 0xc2, 0x27, 0x90, 0x20, 0xf6, 0x60, 0xff, 0x96, 0x5c, 0xb1, 0xab, 0x9e, 0x9c, 0x52, 0x1b, 0x5f, 0x93, 0xa, 0xef, 0x91, 0x85, 0x49, 0xee, 0x2d, 0x4f, 0x8f, 0x3b, 0x47, 0x87, 0x6d, 0x46, 0xd6, 0x3e, 0x69, 0x64, 0x2a, 0xce, 0xcb, 0x2f, 0xfc, 0x97, 0x5, 0x7a, 0xac, 0x7f, 0xd5, 0x1a, 0x4b, 0xe, 0xa7, 0x5a, 0x28, 0x14, 0x3f, 0x29, 0x88, 0x3c, 0x4c, 0x2, 0xb8, 0xda, 0xb0, 0x17, 0x55, 0x1f, 0x8a, 0x7d, 0x57, 0xc7, 0x8d, 0x74, 0xb7, 0xc4, 0x9f, 0x72, 0x7e, 0x15, 0x22, 0x12, 0x58, 0x7, 0x99, 0x34, 0x6e, 0x50, 0xde, 0x68, 0x65, 0xbc, 0xdb, 0xf8, 0xc8, 0xa8, 0x2b, 0x40, 0xdc, 0xfe, 0x32, 0xa4, 0xca, 0x10, 0x21, 0xf0, 0xd3, 0x5d, 0xf, 0x0, 0x6f, 0x9d, 0x36, 0x42, 0x4a, 0x5e, 0xc1, 0xe0);
/**
* Q-Table
*
* @var array
* @access private
*/
var $q1 = array(0x75, 0xf3, 0xc6, 0xf4, 0xdb, 0x7b, 0xfb, 0xc8, 0x4a, 0xd3, 0xe6, 0x6b, 0x45, 0x7d, 0xe8, 0x4b, 0xd6, 0x32, 0xd8, 0xfd, 0x37, 0x71, 0xf1, 0xe1, 0x30, 0xf, 0xf8, 0x1b, 0x87, 0xfa, 0x6, 0x3f, 0x5e, 0xba, 0xae, 0x5b, 0x8a, 0x0, 0xbc, 0x9d, 0x6d, 0xc1, 0xb1, 0xe, 0x80, 0x5d, 0xd2, 0xd5, 0xa0, 0x84, 0x7, 0x14, 0xb5, 0x90, 0x2c, 0xa3, 0xb2, 0x73, 0x4c, 0x54, 0x92, 0x74, 0x36, 0x51, 0x38, 0xb0, 0xbd, 0x5a, 0xfc, 0x60, 0x62, 0x96, 0x6c, 0x42, 0xf7, 0x10, 0x7c, 0x28, 0x27, 0x8c, 0x13, 0x95, 0x9c, 0xc7, 0x24, 0x46, 0x3b, 0x70, 0xca, 0xe3, 0x85, 0xcb, 0x11, 0xd0, 0x93, 0xb8, 0xa6, 0x83, 0x20, 0xff, 0x9f, 0x77, 0xc3, 0xcc, 0x3, 0x6f, 0x8, 0xbf, 0x40, 0xe7, 0x2b, 0xe2, 0x79, 0xc, 0xaa, 0x82, 0x41, 0x3a, 0xea, 0xb9, 0xe4, 0x9a, 0xa4, 0x97, 0x7e, 0xda, 0x7a, 0x17, 0x66, 0x94, 0xa1, 0x1d, 0x3d, 0xf0, 0xde, 0xb3, 0xb, 0x72, 0xa7, 0x1c, 0xef, 0xd1, 0x53, 0x3e, 0x8f, 0x33, 0x26, 0x5f, 0xec, 0x76, 0x2a, 0x49, 0x81, 0x88, 0xee, 0x21, 0xc4, 0x1a, 0xeb, 0xd9, 0xc5, 0x39, 0x99, 0xcd, 0xad, 0x31, 0x8b, 0x1, 0x18, 0x23, 0xdd, 0x1f, 0x4e, 0x2d, 0xf9, 0x48, 0x4f, 0xf2, 0x65, 0x8e, 0x78, 0x5c, 0x58, 0x19, 0x8d, 0xe5, 0x98, 0x57, 0x67, 0x7f, 0x5, 0x64, 0xaf, 0x63, 0xb6, 0xfe, 0xf5, 0xb7, 0x3c, 0xa5, 0xce, 0xe9, 0x68, 0x44, 0xe0, 0x4d, 0x43, 0x69, 0x29, 0x2e, 0xac, 0x15, 0x59, 0xa8, 0xa, 0x9e, 0x6e, 0x47, 0xdf, 0x34, 0x35, 0x6a, 0xcf, 0xdc, 0x22, 0xc9, 0xc0, 0x9b, 0x89, 0xd4, 0xed, 0xab, 0x12, 0xa2, 0xd, 0x52, 0xbb, 0x2, 0x2f, 0xa9, 0xd7, 0x61, 0x1e, 0xb4, 0x50, 0x4, 0xf6, 0xc2, 0x16, 0x25, 0x86, 0x56, 0x55, 0x9, 0xbe, 0x91);
/**
* M-Table
*
* @var array
* @access private
*/
var $m0 = array(0xbcbc3275, 0xecec21f3, 0x202043c6, 0xb3b3c9f4, 0xdada03db, 0x2028b7b, 0xe2e22bfb, 0x9e9efac8, 0xc9c9ec4a, 0xd4d409d3, 0x18186be6, 0x1e1e9f6b, 0x98980e45, 0xb2b2387d, 0xa6a6d2e8, 0x2626b74b, 0x3c3c57d6, 0x93938a32, 0x8282eed8, 0x525298fd, 0x7b7bd437, 0xbbbb3771, 0x5b5b97f1, 0x474783e1, 0x24243c30, 0x5151e20f, 0xbabac6f8, 0x4a4af31b, 0xbfbf4887, 0xd0d70fa, 0xb0b0b306, 0x7575de3f, 0xd2d2fd5e, 0x7d7d20ba, 0x666631ae, 0x3a3aa35b, 0x59591c8a, 0x0, 0xcdcd93bc, 0x1a1ae09d, 0xaeae2c6d, 0x7f7fabc1, 0x2b2bc7b1, 0xbebeb90e, 0xe0e0a080, 0x8a8a105d, 0x3b3b52d2, 0x6464bad5, 0xd8d888a0, 0xe7e7a584, 0x5f5fe807, 0x1b1b1114, 0x2c2cc2b5, 0xfcfcb490, 0x3131272c, 0x808065a3, 0x73732ab2, 0xc0c8173, 0x79795f4c, 0x6b6b4154, 0x4b4b0292, 0x53536974, 0x94948f36, 0x83831f51, 0x2a2a3638, 0xc4c49cb0, 0x2222c8bd, 0xd5d5f85a, 0xbdbdc3fc, 0x48487860, 0xffffce62, 0x4c4c0796, 0x4141776c, 0xc7c7e642, 0xebeb24f7, 0x1c1c1410, 0x5d5d637c, 0x36362228, 0x6767c027, 0xe9e9af8c, 0x4444f913, 0x1414ea95, 0xf5f5bb9c, 0xcfcf18c7, 0x3f3f2d24, 0xc0c0e346, 0x7272db3b, 0x54546c70, 0x29294cca, 0xf0f035e3, 0x808fe85, 0xc6c617cb, 0xf3f34f11, 0x8c8ce4d0, 0xa4a45993, 0xcaca96b8, 0x68683ba6, 0xb8b84d83, 0x38382820, 0xe5e52eff, 0xadad569f, 0xb0b8477, 0xc8c81dc3, 0x9999ffcc, 0x5858ed03, 0x19199a6f, 0xe0e0a08, 0x95957ebf, 0x70705040, 0xf7f730e7, 0x6e6ecf2b, 0x1f1f6ee2, 0xb5b53d79, 0x9090f0c, 0x616134aa, 0x57571682, 0x9f9f0b41, 0x9d9d803a, 0x111164ea, 0x2525cdb9, 0xafafdde4, 0x4545089a, 0xdfdf8da4, 0xa3a35c97, 0xeaead57e, 0x353558da, 0xededd07a, 0x4343fc17, 0xf8f8cb66, 0xfbfbb194, 0x3737d3a1, 0xfafa401d, 0xc2c2683d, 0xb4b4ccf0, 0x32325dde, 0x9c9c71b3, 0x5656e70b, 0xe3e3da72, 0x878760a7, 0x15151b1c, 0xf9f93aef, 0x6363bfd1, 0x3434a953, 0x9a9a853e, 0xb1b1428f, 0x7c7cd133, 0x88889b26, 0x3d3da65f, 0xa1a1d7ec, 0xe4e4df76, 0x8181942a, 0x91910149, 0xf0ffb81, 0xeeeeaa88, 0x161661ee, 0xd7d77321, 0x9797f5c4, 0xa5a5a81a, 0xfefe3feb, 0x6d6db5d9, 0x7878aec5, 0xc5c56d39, 0x1d1de599, 0x7676a4cd, 0x3e3edcad, 0xcbcb6731, 0xb6b6478b, 0xefef5b01, 0x12121e18, 0x6060c523, 0x6a6ab0dd, 0x4d4df61f, 0xcecee94e, 0xdede7c2d, 0x55559df9, 0x7e7e5a48, 0x2121b24f, 0x3037af2, 0xa0a02665, 0x5e5e198e, 0x5a5a6678, 0x65654b5c, 0x62624e58, 0xfdfd4519, 0x606f48d, 0x404086e5, 0xf2f2be98, 0x3333ac57, 0x17179067, 0x5058e7f, 0xe8e85e05, 0x4f4f7d64, 0x89896aaf, 0x10109563, 0x74742fb6, 0xa0a75fe, 0x5c5c92f5, 0x9b9b74b7, 0x2d2d333c, 0x3030d6a5, 0x2e2e49ce, 0x494989e9, 0x46467268, 0x77775544, 0xa8a8d8e0, 0x9696044d, 0x2828bd43, 0xa9a92969, 0xd9d97929, 0x8686912e, 0xd1d187ac, 0xf4f44a15, 0x8d8d1559, 0xd6d682a8, 0xb9b9bc0a, 0x42420d9e, 0xf6f6c16e, 0x2f2fb847, 0xdddd06df, 0x23233934, 0xcccc6235, 0xf1f1c46a, 0xc1c112cf, 0x8585ebdc, 0x8f8f9e22, 0x7171a1c9, 0x9090f0c0, 0xaaaa539b, 0x101f189, 0x8b8be1d4, 0x4e4e8ced, 0x8e8e6fab, 0xababa212, 0x6f6f3ea2, 0xe6e6540d, 0xdbdbf252, 0x92927bbb, 0xb7b7b602, 0x6969ca2f, 0x3939d9a9, 0xd3d30cd7, 0xa7a72361, 0xa2a2ad1e, 0xc3c399b4, 0x6c6c4450, 0x7070504, 0x4047ff6, 0x272746c2, 0xacaca716, 0xd0d07625, 0x50501386, 0xdcdcf756, 0x84841a55, 0xe1e15109, 0x7a7a25be, 0x1313ef91);
/**
* M-Table
*
* @var array
* @access private
*/
var $m1 = array(0xa9d93939, 0x67901717, 0xb3719c9c, 0xe8d2a6a6, 0x4050707, 0xfd985252, 0xa3658080, 0x76dfe4e4, 0x9a084545, 0x92024b4b, 0x80a0e0e0, 0x78665a5a, 0xe4ddafaf, 0xddb06a6a, 0xd1bf6363, 0x38362a2a, 0xd54e6e6, 0xc6432020, 0x3562cccc, 0x98bef2f2, 0x181e1212, 0xf724ebeb, 0xecd7a1a1, 0x6c774141, 0x43bd2828, 0x7532bcbc, 0x37d47b7b, 0x269b8888, 0xfa700d0d, 0x13f94444, 0x94b1fbfb, 0x485a7e7e, 0xf27a0303, 0xd0e48c8c, 0x8b47b6b6, 0x303c2424, 0x84a5e7e7, 0x54416b6b, 0xdf06dddd, 0x23c56060, 0x1945fdfd, 0x5ba33a3a, 0x3d68c2c2, 0x59158d8d, 0xf321ecec, 0xae316666, 0xa23e6f6f, 0x82165757, 0x63951010, 0x15befef, 0x834db8b8, 0x2e918686, 0xd9b56d6d, 0x511f8383, 0x9b53aaaa, 0x7c635d5d, 0xa63b6868, 0xeb3ffefe, 0xa5d63030, 0xbe257a7a, 0x16a7acac, 0xc0f0909, 0xe335f0f0, 0x6123a7a7, 0xc0f09090, 0x8cafe9e9, 0x3a809d9d, 0xf5925c5c, 0x73810c0c, 0x2c273131, 0x2576d0d0, 0xbe75656, 0xbb7b9292, 0x4ee9cece, 0x89f10101, 0x6b9f1e1e, 0x53a93434, 0x6ac4f1f1, 0xb499c3c3, 0xf1975b5b, 0xe1834747, 0xe66b1818, 0xbdc82222, 0x450e9898, 0xe26e1f1f, 0xf4c9b3b3, 0xb62f7474, 0x66cbf8f8, 0xccff9999, 0x95ea1414, 0x3ed5858, 0x56f7dcdc, 0xd4e18b8b, 0x1c1b1515, 0x1eada2a2, 0xd70cd3d3, 0xfb2be2e2, 0xc31dc8c8, 0x8e195e5e, 0xb5c22c2c, 0xe9894949, 0xcf12c1c1, 0xbf7e9595, 0xba207d7d, 0xea641111, 0x77840b0b, 0x396dc5c5, 0xaf6a8989, 0x33d17c7c, 0xc9a17171, 0x62ceffff, 0x7137bbbb, 0x81fb0f0f, 0x793db5b5, 0x951e1e1, 0xaddc3e3e, 0x242d3f3f, 0xcda47676, 0xf99d5555, 0xd8ee8282, 0xe5864040, 0xc5ae7878, 0xb9cd2525, 0x4d049696, 0x44557777, 0x80a0e0e, 0x86135050, 0xe730f7f7, 0xa1d33737, 0x1d40fafa, 0xaa346161, 0xed8c4e4e, 0x6b3b0b0, 0x706c5454, 0xb22a7373, 0xd2523b3b, 0x410b9f9f, 0x7b8b0202, 0xa088d8d8, 0x114ff3f3, 0x3167cbcb, 0xc2462727, 0x27c06767, 0x90b4fcfc, 0x20283838, 0xf67f0404, 0x60784848, 0xff2ee5e5, 0x96074c4c, 0x5c4b6565, 0xb1c72b2b, 0xab6f8e8e, 0x9e0d4242, 0x9cbbf5f5, 0x52f2dbdb, 0x1bf34a4a, 0x5fa63d3d, 0x9359a4a4, 0xabcb9b9, 0xef3af9f9, 0x91ef1313, 0x85fe0808, 0x49019191, 0xee611616, 0x2d7cdede, 0x4fb22121, 0x8f42b1b1, 0x3bdb7272, 0x47b82f2f, 0x8748bfbf, 0x6d2caeae, 0x46e3c0c0, 0xd6573c3c, 0x3e859a9a, 0x6929a9a9, 0x647d4f4f, 0x2a948181, 0xce492e2e, 0xcb17c6c6, 0x2fca6969, 0xfcc3bdbd, 0x975ca3a3, 0x55ee8e8, 0x7ad0eded, 0xac87d1d1, 0x7f8e0505, 0xd5ba6464, 0x1aa8a5a5, 0x4bb72626, 0xeb9bebe, 0xa7608787, 0x5af8d5d5, 0x28223636, 0x14111b1b, 0x3fde7575, 0x2979d9d9, 0x88aaeeee, 0x3c332d2d, 0x4c5f7979, 0x2b6b7b7, 0xb896caca, 0xda583535, 0xb09cc4c4, 0x17fc4343, 0x551a8484, 0x1ff64d4d, 0x8a1c5959, 0x7d38b2b2, 0x57ac3333, 0xc718cfcf, 0x8df40606, 0x74695353, 0xb7749b9b, 0xc4f59797, 0x9f56adad, 0x72dae3e3, 0x7ed5eaea, 0x154af4f4, 0x229e8f8f, 0x12a2abab, 0x584e6262, 0x7e85f5f, 0x99e51d1d, 0x34392323, 0x6ec1f6f6, 0x50446c6c, 0xde5d3232, 0x68724646, 0x6526a0a0, 0xbc93cdcd, 0xdb03dada, 0xf8c6baba, 0xc8fa9e9e, 0xa882d6d6, 0x2bcf6e6e, 0x40507070, 0xdceb8585, 0xfe750a0a, 0x328a9393, 0xa48ddfdf, 0xca4c2929, 0x10141c1c, 0x2173d7d7, 0xf0ccb4b4, 0xd309d4d4, 0x5d108a8a, 0xfe25151, 0x0, 0x6f9a1919, 0x9de01a1a, 0x368f9494, 0x42e6c7c7, 0x4aecc9c9, 0x5efdd2d2, 0xc1ab7f7f, 0xe0d8a8a8);
/**
* M-Table
*
* @var array
* @access private
*/
var $m2 = array(0xbc75bc32, 0xecf3ec21, 0x20c62043, 0xb3f4b3c9, 0xdadbda03, 0x27b028b, 0xe2fbe22b, 0x9ec89efa, 0xc94ac9ec, 0xd4d3d409, 0x18e6186b, 0x1e6b1e9f, 0x9845980e, 0xb27db238, 0xa6e8a6d2, 0x264b26b7, 0x3cd63c57, 0x9332938a, 0x82d882ee, 0x52fd5298, 0x7b377bd4, 0xbb71bb37, 0x5bf15b97, 0x47e14783, 0x2430243c, 0x510f51e2, 0xbaf8bac6, 0x4a1b4af3, 0xbf87bf48, 0xdfa0d70, 0xb006b0b3, 0x753f75de, 0xd25ed2fd, 0x7dba7d20, 0x66ae6631, 0x3a5b3aa3, 0x598a591c, 0x0, 0xcdbccd93, 0x1a9d1ae0, 0xae6dae2c, 0x7fc17fab, 0x2bb12bc7, 0xbe0ebeb9, 0xe080e0a0, 0x8a5d8a10, 0x3bd23b52, 0x64d564ba, 0xd8a0d888, 0xe784e7a5, 0x5f075fe8, 0x1b141b11, 0x2cb52cc2, 0xfc90fcb4, 0x312c3127, 0x80a38065, 0x73b2732a, 0xc730c81, 0x794c795f, 0x6b546b41, 0x4b924b02, 0x53745369, 0x9436948f, 0x8351831f, 0x2a382a36, 0xc4b0c49c, 0x22bd22c8, 0xd55ad5f8, 0xbdfcbdc3, 0x48604878, 0xff62ffce, 0x4c964c07, 0x416c4177, 0xc742c7e6, 0xebf7eb24, 0x1c101c14, 0x5d7c5d63, 0x36283622, 0x672767c0, 0xe98ce9af, 0x441344f9, 0x149514ea, 0xf59cf5bb, 0xcfc7cf18, 0x3f243f2d, 0xc046c0e3, 0x723b72db, 0x5470546c, 0x29ca294c, 0xf0e3f035, 0x88508fe, 0xc6cbc617, 0xf311f34f, 0x8cd08ce4, 0xa493a459, 0xcab8ca96, 0x68a6683b, 0xb883b84d, 0x38203828, 0xe5ffe52e, 0xad9fad56, 0xb770b84, 0xc8c3c81d, 0x99cc99ff, 0x580358ed, 0x196f199a, 0xe080e0a, 0x95bf957e, 0x70407050, 0xf7e7f730, 0x6e2b6ecf, 0x1fe21f6e, 0xb579b53d, 0x90c090f, 0x61aa6134, 0x57825716, 0x9f419f0b, 0x9d3a9d80, 0x11ea1164, 0x25b925cd, 0xafe4afdd, 0x459a4508, 0xdfa4df8d, 0xa397a35c, 0xea7eead5, 0x35da3558, 0xed7aedd0, 0x431743fc, 0xf866f8cb, 0xfb94fbb1, 0x37a137d3, 0xfa1dfa40, 0xc23dc268, 0xb4f0b4cc, 0x32de325d, 0x9cb39c71, 0x560b56e7, 0xe372e3da, 0x87a78760, 0x151c151b, 0xf9eff93a, 0x63d163bf, 0x345334a9, 0x9a3e9a85, 0xb18fb142, 0x7c337cd1, 0x8826889b, 0x3d5f3da6, 0xa1eca1d7, 0xe476e4df, 0x812a8194, 0x91499101, 0xf810ffb, 0xee88eeaa, 0x16ee1661, 0xd721d773, 0x97c497f5, 0xa51aa5a8, 0xfeebfe3f, 0x6dd96db5, 0x78c578ae, 0xc539c56d, 0x1d991de5, 0x76cd76a4, 0x3ead3edc, 0xcb31cb67, 0xb68bb647, 0xef01ef5b, 0x1218121e, 0x602360c5, 0x6add6ab0, 0x4d1f4df6, 0xce4ecee9, 0xde2dde7c, 0x55f9559d, 0x7e487e5a, 0x214f21b2, 0x3f2037a, 0xa065a026, 0x5e8e5e19, 0x5a785a66, 0x655c654b, 0x6258624e, 0xfd19fd45, 0x68d06f4, 0x40e54086, 0xf298f2be, 0x335733ac, 0x17671790, 0x57f058e, 0xe805e85e, 0x4f644f7d, 0x89af896a, 0x10631095, 0x74b6742f, 0xafe0a75, 0x5cf55c92, 0x9bb79b74, 0x2d3c2d33, 0x30a530d6, 0x2ece2e49, 0x49e94989, 0x46684672, 0x77447755, 0xa8e0a8d8, 0x964d9604, 0x284328bd, 0xa969a929, 0xd929d979, 0x862e8691, 0xd1acd187, 0xf415f44a, 0x8d598d15, 0xd6a8d682, 0xb90ab9bc, 0x429e420d, 0xf66ef6c1, 0x2f472fb8, 0xdddfdd06, 0x23342339, 0xcc35cc62, 0xf16af1c4, 0xc1cfc112, 0x85dc85eb, 0x8f228f9e, 0x71c971a1, 0x90c090f0, 0xaa9baa53, 0x18901f1, 0x8bd48be1, 0x4eed4e8c, 0x8eab8e6f, 0xab12aba2, 0x6fa26f3e, 0xe60de654, 0xdb52dbf2, 0x92bb927b, 0xb702b7b6, 0x692f69ca, 0x39a939d9, 0xd3d7d30c, 0xa761a723, 0xa21ea2ad, 0xc3b4c399, 0x6c506c44, 0x7040705, 0x4f6047f, 0x27c22746, 0xac16aca7, 0xd025d076, 0x50865013, 0xdc56dcf7, 0x8455841a, 0xe109e151, 0x7abe7a25, 0x139113ef);
/**
* M-Table
*
* @var array
* @access private
*/
var $m3 = array(0xd939a9d9, 0x90176790, 0x719cb371, 0xd2a6e8d2, 0x5070405, 0x9852fd98, 0x6580a365, 0xdfe476df, 0x8459a08, 0x24b9202, 0xa0e080a0, 0x665a7866, 0xddafe4dd, 0xb06addb0, 0xbf63d1bf, 0x362a3836, 0x54e60d54, 0x4320c643, 0x62cc3562, 0xbef298be, 0x1e12181e, 0x24ebf724, 0xd7a1ecd7, 0x77416c77, 0xbd2843bd, 0x32bc7532, 0xd47b37d4, 0x9b88269b, 0x700dfa70, 0xf94413f9, 0xb1fb94b1, 0x5a7e485a, 0x7a03f27a, 0xe48cd0e4, 0x47b68b47, 0x3c24303c, 0xa5e784a5, 0x416b5441, 0x6dddf06, 0xc56023c5, 0x45fd1945, 0xa33a5ba3, 0x68c23d68, 0x158d5915, 0x21ecf321, 0x3166ae31, 0x3e6fa23e, 0x16578216, 0x95106395, 0x5bef015b, 0x4db8834d, 0x91862e91, 0xb56dd9b5, 0x1f83511f, 0x53aa9b53, 0x635d7c63, 0x3b68a63b, 0x3ffeeb3f, 0xd630a5d6, 0x257abe25, 0xa7ac16a7, 0xf090c0f, 0x35f0e335, 0x23a76123, 0xf090c0f0, 0xafe98caf, 0x809d3a80, 0x925cf592, 0x810c7381, 0x27312c27, 0x76d02576, 0xe7560be7, 0x7b92bb7b, 0xe9ce4ee9, 0xf10189f1, 0x9f1e6b9f, 0xa93453a9, 0xc4f16ac4, 0x99c3b499, 0x975bf197, 0x8347e183, 0x6b18e66b, 0xc822bdc8, 0xe98450e, 0x6e1fe26e, 0xc9b3f4c9, 0x2f74b62f, 0xcbf866cb, 0xff99ccff, 0xea1495ea, 0xed5803ed, 0xf7dc56f7, 0xe18bd4e1, 0x1b151c1b, 0xada21ead, 0xcd3d70c, 0x2be2fb2b, 0x1dc8c31d, 0x195e8e19, 0xc22cb5c2, 0x8949e989, 0x12c1cf12, 0x7e95bf7e, 0x207dba20, 0x6411ea64, 0x840b7784, 0x6dc5396d, 0x6a89af6a, 0xd17c33d1, 0xa171c9a1, 0xceff62ce, 0x37bb7137, 0xfb0f81fb, 0x3db5793d, 0x51e10951, 0xdc3eaddc, 0x2d3f242d, 0xa476cda4, 0x9d55f99d, 0xee82d8ee, 0x8640e586, 0xae78c5ae, 0xcd25b9cd, 0x4964d04, 0x55774455, 0xa0e080a, 0x13508613, 0x30f7e730, 0xd337a1d3, 0x40fa1d40, 0x3461aa34, 0x8c4eed8c, 0xb3b006b3, 0x6c54706c, 0x2a73b22a, 0x523bd252, 0xb9f410b, 0x8b027b8b, 0x88d8a088, 0x4ff3114f, 0x67cb3167, 0x4627c246, 0xc06727c0, 0xb4fc90b4, 0x28382028, 0x7f04f67f, 0x78486078, 0x2ee5ff2e, 0x74c9607, 0x4b655c4b, 0xc72bb1c7, 0x6f8eab6f, 0xd429e0d, 0xbbf59cbb, 0xf2db52f2, 0xf34a1bf3, 0xa63d5fa6, 0x59a49359, 0xbcb90abc, 0x3af9ef3a, 0xef1391ef, 0xfe0885fe, 0x1914901, 0x6116ee61, 0x7cde2d7c, 0xb2214fb2, 0x42b18f42, 0xdb723bdb, 0xb82f47b8, 0x48bf8748, 0x2cae6d2c, 0xe3c046e3, 0x573cd657, 0x859a3e85, 0x29a96929, 0x7d4f647d, 0x94812a94, 0x492ece49, 0x17c6cb17, 0xca692fca, 0xc3bdfcc3, 0x5ca3975c, 0x5ee8055e, 0xd0ed7ad0, 0x87d1ac87, 0x8e057f8e, 0xba64d5ba, 0xa8a51aa8, 0xb7264bb7, 0xb9be0eb9, 0x6087a760, 0xf8d55af8, 0x22362822, 0x111b1411, 0xde753fde, 0x79d92979, 0xaaee88aa, 0x332d3c33, 0x5f794c5f, 0xb6b702b6, 0x96cab896, 0x5835da58, 0x9cc4b09c, 0xfc4317fc, 0x1a84551a, 0xf64d1ff6, 0x1c598a1c, 0x38b27d38, 0xac3357ac, 0x18cfc718, 0xf4068df4, 0x69537469, 0x749bb774, 0xf597c4f5, 0x56ad9f56, 0xdae372da, 0xd5ea7ed5, 0x4af4154a, 0x9e8f229e, 0xa2ab12a2, 0x4e62584e, 0xe85f07e8, 0xe51d99e5, 0x39233439, 0xc1f66ec1, 0x446c5044, 0x5d32de5d, 0x72466872, 0x26a06526, 0x93cdbc93, 0x3dadb03, 0xc6baf8c6, 0xfa9ec8fa, 0x82d6a882, 0xcf6e2bcf, 0x50704050, 0xeb85dceb, 0x750afe75, 0x8a93328a, 0x8ddfa48d, 0x4c29ca4c, 0x141c1014, 0x73d72173, 0xccb4f0cc, 0x9d4d309, 0x108a5d10, 0xe2510fe2, 0x0, 0x9a196f9a, 0xe01a9de0, 0x8f94368f, 0xe6c742e6, 0xecc94aec, 0xfdd25efd, 0xab7fc1ab, 0xd8a8e0d8);
/**
* The Key Schedule Array
*
* @var array
* @access private
*/
var $K = array();
/**
* The Key depended S-Table 0
*
* @var array
* @access private
*/
var $S0 = array();
/**
* The Key depended S-Table 1
*
* @var array
* @access private
*/
var $S1 = array();
/**
* The Key depended S-Table 2
*
* @var array
* @access private
*/
var $S2 = array();
/**
* The Key depended S-Table 3
*
* @var array
* @access private
*/
var $S3 = array();
/**
* Holds the last used key
*
* @var array
* @access private
*/
var $kl;
/**
* The Key Length (in bytes)
*
* @see Crypt_Twofish::setKeyLength()
* @var int
* @access private
*/
var $key_length = 16;
/**
* Sets the key length.
*
* Valid key lengths are 128, 192 or 256 bits
*
* @access public
* @param int $length
*/
function setKeyLength($length)
{
}
/**
* Setup the key (expansion)
*
* @see \phpseclib\Crypt\Base::_setupKey()
* @access private
*/
function _setupKey()
{
}
/**
* _mdsrem function using by the twofish cipher algorithm
*
* @access private
* @param string $A
* @param string $B
* @return array
*/
function _mdsrem($A, $B)
{
}
/**
* Encrypts a block
*
* @access private
* @param string $in
* @return string
*/
function _encryptBlock($in)
{
}
/**
* Decrypts a block
*
* @access private
* @param string $in
* @return string
*/
function _decryptBlock($in)
{
}
/**
* Setup the performance-optimized function for de/encrypt()
*
* @see \phpseclib\Crypt\Base::_setupInlineCrypt()
* @access private
*/
function _setupInlineCrypt()
{
}
}
/**
* Pure-PHP implementation of AES.
*
* @package AES
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class AES extends \phpseclib\Crypt\Rijndael
{
/**
* Dummy function
*
* Since \phpseclib\Crypt\AES extends \phpseclib\Crypt\Rijndael, this function is, technically, available, but it doesn't do anything.
*
* @see \phpseclib\Crypt\Rijndael::setBlockLength()
* @access public
* @param int $length
*/
function setBlockLength($length)
{
}
/**
* Sets the key length
*
* Valid key lengths are 128, 192, and 256. If the length is less than 128, it will be rounded up to
* 128. If the length is greater than 128 and invalid, it will be rounded down to the closest valid amount.
*
* @see \phpseclib\Crypt\Rijndael:setKeyLength()
* @access public
* @param int $length
*/
function setKeyLength($length)
{
}
/**
* Sets the key.
*
* Rijndael supports five different key lengths, AES only supports three.
*
* @see \phpseclib\Crypt\Rijndael:setKey()
* @see setKeyLength()
* @access public
* @param string $key
*/
function setKey($key)
{
}
}
/**
* Pure-PHP implementation of DES.
*
* @package DES
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class DES extends \phpseclib\Crypt\Base
{
/**#@+
* @access private
* @see \phpseclib\Crypt\DES::_setupKey()
* @see \phpseclib\Crypt\DES::_processBlock()
*/
/**
* Contains $keys[self::ENCRYPT]
*/
const ENCRYPT = 0;
/**
* Contains $keys[self::DECRYPT]
*/
const DECRYPT = 1;
/**#@-*/
/**
* Block Length of the cipher
*
* @see \phpseclib\Crypt\Base::block_size
* @var int
* @access private
*/
var $block_size = 8;
/**
* Key Length (in bytes)
*
* @see \phpseclib\Crypt\Base::setKeyLength()
* @var int
* @access private
*/
var $key_length = 8;
/**
* The mcrypt specific name of the cipher
*
* @see \phpseclib\Crypt\Base::cipher_name_mcrypt
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'des';
/**
* The OpenSSL names of the cipher / modes
*
* @see \phpseclib\Crypt\Base::openssl_mode_names
* @var array
* @access private
*/
var $openssl_mode_names = array(self::MODE_ECB => 'des-ecb', self::MODE_CBC => 'des-cbc', self::MODE_CFB => 'des-cfb', self::MODE_OFB => 'des-ofb');
/**
* Optimizing value while CFB-encrypting
*
* @see \phpseclib\Crypt\Base::cfb_init_len
* @var int
* @access private
*/
var $cfb_init_len = 500;
/**
* Switch for DES/3DES encryption
*
* Used only if $engine == self::ENGINE_INTERNAL
*
* @see self::_setupKey()
* @see self::_processBlock()
* @var int
* @access private
*/
var $des_rounds = 1;
/**
* max possible size of $key
*
* @see self::setKey()
* @var string
* @access private
*/
var $key_length_max = 8;
/**
* The Key Schedule
*
* @see self::_setupKey()
* @var array
* @access private
*/
var $keys;
/**
* Shuffle table.
*
* For each byte value index, the entry holds an 8-byte string
* with each byte containing all bits in the same state as the
* corresponding bit in the index value.
*
* @see self::_processBlock()
* @see self::_setupKey()
* @var array
* @access private
*/
var $shuffle = array("\x00\x00\x00\x00\x00\x00\x00\x00", "\x00\x00\x00\x00\x00\x00\x00\xff", "\x00\x00\x00\x00\x00\x00\xff\x00", "\x00\x00\x00\x00\x00\x00\xff\xff", "\x00\x00\x00\x00\x00\xff\x00\x00", "\x00\x00\x00\x00\x00\xff\x00\xff", "\x00\x00\x00\x00\x00\xff\xff\x00", "\x00\x00\x00\x00\x00\xff\xff\xff", "\x00\x00\x00\x00\xff\x00\x00\x00", "\x00\x00\x00\x00\xff\x00\x00\xff", "\x00\x00\x00\x00\xff\x00\xff\x00", "\x00\x00\x00\x00\xff\x00\xff\xff", "\x00\x00\x00\x00\xff\xff\x00\x00", "\x00\x00\x00\x00\xff\xff\x00\xff", "\x00\x00\x00\x00\xff\xff\xff\x00", "\x00\x00\x00\x00\xff\xff\xff\xff", "\x00\x00\x00\xff\x00\x00\x00\x00", "\x00\x00\x00\xff\x00\x00\x00\xff", "\x00\x00\x00\xff\x00\x00\xff\x00", "\x00\x00\x00\xff\x00\x00\xff\xff", "\x00\x00\x00\xff\x00\xff\x00\x00", "\x00\x00\x00\xff\x00\xff\x00\xff", "\x00\x00\x00\xff\x00\xff\xff\x00", "\x00\x00\x00\xff\x00\xff\xff\xff", "\x00\x00\x00\xff\xff\x00\x00\x00", "\x00\x00\x00\xff\xff\x00\x00\xff", "\x00\x00\x00\xff\xff\x00\xff\x00", "\x00\x00\x00\xff\xff\x00\xff\xff", "\x00\x00\x00\xff\xff\xff\x00\x00", "\x00\x00\x00\xff\xff\xff\x00\xff", "\x00\x00\x00\xff\xff\xff\xff\x00", "\x00\x00\x00\xff\xff\xff\xff\xff", "\x00\x00\xff\x00\x00\x00\x00\x00", "\x00\x00\xff\x00\x00\x00\x00\xff", "\x00\x00\xff\x00\x00\x00\xff\x00", "\x00\x00\xff\x00\x00\x00\xff\xff", "\x00\x00\xff\x00\x00\xff\x00\x00", "\x00\x00\xff\x00\x00\xff\x00\xff", "\x00\x00\xff\x00\x00\xff\xff\x00", "\x00\x00\xff\x00\x00\xff\xff\xff", "\x00\x00\xff\x00\xff\x00\x00\x00", "\x00\x00\xff\x00\xff\x00\x00\xff", "\x00\x00\xff\x00\xff\x00\xff\x00", "\x00\x00\xff\x00\xff\x00\xff\xff", "\x00\x00\xff\x00\xff\xff\x00\x00", "\x00\x00\xff\x00\xff\xff\x00\xff", "\x00\x00\xff\x00\xff\xff\xff\x00", "\x00\x00\xff\x00\xff\xff\xff\xff", "\x00\x00\xff\xff\x00\x00\x00\x00", "\x00\x00\xff\xff\x00\x00\x00\xff", "\x00\x00\xff\xff\x00\x00\xff\x00", "\x00\x00\xff\xff\x00\x00\xff\xff", "\x00\x00\xff\xff\x00\xff\x00\x00", "\x00\x00\xff\xff\x00\xff\x00\xff", "\x00\x00\xff\xff\x00\xff\xff\x00", "\x00\x00\xff\xff\x00\xff\xff\xff", "\x00\x00\xff\xff\xff\x00\x00\x00", "\x00\x00\xff\xff\xff\x00\x00\xff", "\x00\x00\xff\xff\xff\x00\xff\x00", "\x00\x00\xff\xff\xff\x00\xff\xff", "\x00\x00\xff\xff\xff\xff\x00\x00", "\x00\x00\xff\xff\xff\xff\x00\xff", "\x00\x00\xff\xff\xff\xff\xff\x00", "\x00\x00\xff\xff\xff\xff\xff\xff", "\x00\xff\x00\x00\x00\x00\x00\x00", "\x00\xff\x00\x00\x00\x00\x00\xff", "\x00\xff\x00\x00\x00\x00\xff\x00", "\x00\xff\x00\x00\x00\x00\xff\xff", "\x00\xff\x00\x00\x00\xff\x00\x00", "\x00\xff\x00\x00\x00\xff\x00\xff", "\x00\xff\x00\x00\x00\xff\xff\x00", "\x00\xff\x00\x00\x00\xff\xff\xff", "\x00\xff\x00\x00\xff\x00\x00\x00", "\x00\xff\x00\x00\xff\x00\x00\xff", "\x00\xff\x00\x00\xff\x00\xff\x00", "\x00\xff\x00\x00\xff\x00\xff\xff", "\x00\xff\x00\x00\xff\xff\x00\x00", "\x00\xff\x00\x00\xff\xff\x00\xff", "\x00\xff\x00\x00\xff\xff\xff\x00", "\x00\xff\x00\x00\xff\xff\xff\xff", "\x00\xff\x00\xff\x00\x00\x00\x00", "\x00\xff\x00\xff\x00\x00\x00\xff", "\x00\xff\x00\xff\x00\x00\xff\x00", "\x00\xff\x00\xff\x00\x00\xff\xff", "\x00\xff\x00\xff\x00\xff\x00\x00", "\x00\xff\x00\xff\x00\xff\x00\xff", "\x00\xff\x00\xff\x00\xff\xff\x00", "\x00\xff\x00\xff\x00\xff\xff\xff", "\x00\xff\x00\xff\xff\x00\x00\x00", "\x00\xff\x00\xff\xff\x00\x00\xff", "\x00\xff\x00\xff\xff\x00\xff\x00", "\x00\xff\x00\xff\xff\x00\xff\xff", "\x00\xff\x00\xff\xff\xff\x00\x00", "\x00\xff\x00\xff\xff\xff\x00\xff", "\x00\xff\x00\xff\xff\xff\xff\x00", "\x00\xff\x00\xff\xff\xff\xff\xff", "\x00\xff\xff\x00\x00\x00\x00\x00", "\x00\xff\xff\x00\x00\x00\x00\xff", "\x00\xff\xff\x00\x00\x00\xff\x00", "\x00\xff\xff\x00\x00\x00\xff\xff", "\x00\xff\xff\x00\x00\xff\x00\x00", "\x00\xff\xff\x00\x00\xff\x00\xff", "\x00\xff\xff\x00\x00\xff\xff\x00", "\x00\xff\xff\x00\x00\xff\xff\xff", "\x00\xff\xff\x00\xff\x00\x00\x00", "\x00\xff\xff\x00\xff\x00\x00\xff", "\x00\xff\xff\x00\xff\x00\xff\x00", "\x00\xff\xff\x00\xff\x00\xff\xff", "\x00\xff\xff\x00\xff\xff\x00\x00", "\x00\xff\xff\x00\xff\xff\x00\xff", "\x00\xff\xff\x00\xff\xff\xff\x00", "\x00\xff\xff\x00\xff\xff\xff\xff", "\x00\xff\xff\xff\x00\x00\x00\x00", "\x00\xff\xff\xff\x00\x00\x00\xff", "\x00\xff\xff\xff\x00\x00\xff\x00", "\x00\xff\xff\xff\x00\x00\xff\xff", "\x00\xff\xff\xff\x00\xff\x00\x00", "\x00\xff\xff\xff\x00\xff\x00\xff", "\x00\xff\xff\xff\x00\xff\xff\x00", "\x00\xff\xff\xff\x00\xff\xff\xff", "\x00\xff\xff\xff\xff\x00\x00\x00", "\x00\xff\xff\xff\xff\x00\x00\xff", "\x00\xff\xff\xff\xff\x00\xff\x00", "\x00\xff\xff\xff\xff\x00\xff\xff", "\x00\xff\xff\xff\xff\xff\x00\x00", "\x00\xff\xff\xff\xff\xff\x00\xff", "\x00\xff\xff\xff\xff\xff\xff\x00", "\x00\xff\xff\xff\xff\xff\xff\xff", "\xff\x00\x00\x00\x00\x00\x00\x00", "\xff\x00\x00\x00\x00\x00\x00\xff", "\xff\x00\x00\x00\x00\x00\xff\x00", "\xff\x00\x00\x00\x00\x00\xff\xff", "\xff\x00\x00\x00\x00\xff\x00\x00", "\xff\x00\x00\x00\x00\xff\x00\xff", "\xff\x00\x00\x00\x00\xff\xff\x00", "\xff\x00\x00\x00\x00\xff\xff\xff", "\xff\x00\x00\x00\xff\x00\x00\x00", "\xff\x00\x00\x00\xff\x00\x00\xff", "\xff\x00\x00\x00\xff\x00\xff\x00", "\xff\x00\x00\x00\xff\x00\xff\xff", "\xff\x00\x00\x00\xff\xff\x00\x00", "\xff\x00\x00\x00\xff\xff\x00\xff", "\xff\x00\x00\x00\xff\xff\xff\x00", "\xff\x00\x00\x00\xff\xff\xff\xff", "\xff\x00\x00\xff\x00\x00\x00\x00", "\xff\x00\x00\xff\x00\x00\x00\xff", "\xff\x00\x00\xff\x00\x00\xff\x00", "\xff\x00\x00\xff\x00\x00\xff\xff", "\xff\x00\x00\xff\x00\xff\x00\x00", "\xff\x00\x00\xff\x00\xff\x00\xff", "\xff\x00\x00\xff\x00\xff\xff\x00", "\xff\x00\x00\xff\x00\xff\xff\xff", "\xff\x00\x00\xff\xff\x00\x00\x00", "\xff\x00\x00\xff\xff\x00\x00\xff", "\xff\x00\x00\xff\xff\x00\xff\x00", "\xff\x00\x00\xff\xff\x00\xff\xff", "\xff\x00\x00\xff\xff\xff\x00\x00", "\xff\x00\x00\xff\xff\xff\x00\xff", "\xff\x00\x00\xff\xff\xff\xff\x00", "\xff\x00\x00\xff\xff\xff\xff\xff", "\xff\x00\xff\x00\x00\x00\x00\x00", "\xff\x00\xff\x00\x00\x00\x00\xff", "\xff\x00\xff\x00\x00\x00\xff\x00", "\xff\x00\xff\x00\x00\x00\xff\xff", "\xff\x00\xff\x00\x00\xff\x00\x00", "\xff\x00\xff\x00\x00\xff\x00\xff", "\xff\x00\xff\x00\x00\xff\xff\x00", "\xff\x00\xff\x00\x00\xff\xff\xff", "\xff\x00\xff\x00\xff\x00\x00\x00", "\xff\x00\xff\x00\xff\x00\x00\xff", "\xff\x00\xff\x00\xff\x00\xff\x00", "\xff\x00\xff\x00\xff\x00\xff\xff", "\xff\x00\xff\x00\xff\xff\x00\x00", "\xff\x00\xff\x00\xff\xff\x00\xff", "\xff\x00\xff\x00\xff\xff\xff\x00", "\xff\x00\xff\x00\xff\xff\xff\xff", "\xff\x00\xff\xff\x00\x00\x00\x00", "\xff\x00\xff\xff\x00\x00\x00\xff", "\xff\x00\xff\xff\x00\x00\xff\x00", "\xff\x00\xff\xff\x00\x00\xff\xff", "\xff\x00\xff\xff\x00\xff\x00\x00", "\xff\x00\xff\xff\x00\xff\x00\xff", "\xff\x00\xff\xff\x00\xff\xff\x00", "\xff\x00\xff\xff\x00\xff\xff\xff", "\xff\x00\xff\xff\xff\x00\x00\x00", "\xff\x00\xff\xff\xff\x00\x00\xff", "\xff\x00\xff\xff\xff\x00\xff\x00", "\xff\x00\xff\xff\xff\x00\xff\xff", "\xff\x00\xff\xff\xff\xff\x00\x00", "\xff\x00\xff\xff\xff\xff\x00\xff", "\xff\x00\xff\xff\xff\xff\xff\x00", "\xff\x00\xff\xff\xff\xff\xff\xff", "\xff\xff\x00\x00\x00\x00\x00\x00", "\xff\xff\x00\x00\x00\x00\x00\xff", "\xff\xff\x00\x00\x00\x00\xff\x00", "\xff\xff\x00\x00\x00\x00\xff\xff", "\xff\xff\x00\x00\x00\xff\x00\x00", "\xff\xff\x00\x00\x00\xff\x00\xff", "\xff\xff\x00\x00\x00\xff\xff\x00", "\xff\xff\x00\x00\x00\xff\xff\xff", "\xff\xff\x00\x00\xff\x00\x00\x00", "\xff\xff\x00\x00\xff\x00\x00\xff", "\xff\xff\x00\x00\xff\x00\xff\x00", "\xff\xff\x00\x00\xff\x00\xff\xff", "\xff\xff\x00\x00\xff\xff\x00\x00", "\xff\xff\x00\x00\xff\xff\x00\xff", "\xff\xff\x00\x00\xff\xff\xff\x00", "\xff\xff\x00\x00\xff\xff\xff\xff", "\xff\xff\x00\xff\x00\x00\x00\x00", "\xff\xff\x00\xff\x00\x00\x00\xff", "\xff\xff\x00\xff\x00\x00\xff\x00", "\xff\xff\x00\xff\x00\x00\xff\xff", "\xff\xff\x00\xff\x00\xff\x00\x00", "\xff\xff\x00\xff\x00\xff\x00\xff", "\xff\xff\x00\xff\x00\xff\xff\x00", "\xff\xff\x00\xff\x00\xff\xff\xff", "\xff\xff\x00\xff\xff\x00\x00\x00", "\xff\xff\x00\xff\xff\x00\x00\xff", "\xff\xff\x00\xff\xff\x00\xff\x00", "\xff\xff\x00\xff\xff\x00\xff\xff", "\xff\xff\x00\xff\xff\xff\x00\x00", "\xff\xff\x00\xff\xff\xff\x00\xff", "\xff\xff\x00\xff\xff\xff\xff\x00", "\xff\xff\x00\xff\xff\xff\xff\xff", "\xff\xff\xff\x00\x00\x00\x00\x00", "\xff\xff\xff\x00\x00\x00\x00\xff", "\xff\xff\xff\x00\x00\x00\xff\x00", "\xff\xff\xff\x00\x00\x00\xff\xff", "\xff\xff\xff\x00\x00\xff\x00\x00", "\xff\xff\xff\x00\x00\xff\x00\xff", "\xff\xff\xff\x00\x00\xff\xff\x00", "\xff\xff\xff\x00\x00\xff\xff\xff", "\xff\xff\xff\x00\xff\x00\x00\x00", "\xff\xff\xff\x00\xff\x00\x00\xff", "\xff\xff\xff\x00\xff\x00\xff\x00", "\xff\xff\xff\x00\xff\x00\xff\xff", "\xff\xff\xff\x00\xff\xff\x00\x00", "\xff\xff\xff\x00\xff\xff\x00\xff", "\xff\xff\xff\x00\xff\xff\xff\x00", "\xff\xff\xff\x00\xff\xff\xff\xff", "\xff\xff\xff\xff\x00\x00\x00\x00", "\xff\xff\xff\xff\x00\x00\x00\xff", "\xff\xff\xff\xff\x00\x00\xff\x00", "\xff\xff\xff\xff\x00\x00\xff\xff", "\xff\xff\xff\xff\x00\xff\x00\x00", "\xff\xff\xff\xff\x00\xff\x00\xff", "\xff\xff\xff\xff\x00\xff\xff\x00", "\xff\xff\xff\xff\x00\xff\xff\xff", "\xff\xff\xff\xff\xff\x00\x00\x00", "\xff\xff\xff\xff\xff\x00\x00\xff", "\xff\xff\xff\xff\xff\x00\xff\x00", "\xff\xff\xff\xff\xff\x00\xff\xff", "\xff\xff\xff\xff\xff\xff\x00\x00", "\xff\xff\xff\xff\xff\xff\x00\xff", "\xff\xff\xff\xff\xff\xff\xff\x00", "\xff\xff\xff\xff\xff\xff\xff\xff");
/**
* IP mapping helper table.
*
* Indexing this table with each source byte performs the initial bit permutation.
*
* @var array
* @access private
*/
var $ipmap = array(0x0, 0x10, 0x1, 0x11, 0x20, 0x30, 0x21, 0x31, 0x2, 0x12, 0x3, 0x13, 0x22, 0x32, 0x23, 0x33, 0x40, 0x50, 0x41, 0x51, 0x60, 0x70, 0x61, 0x71, 0x42, 0x52, 0x43, 0x53, 0x62, 0x72, 0x63, 0x73, 0x4, 0x14, 0x5, 0x15, 0x24, 0x34, 0x25, 0x35, 0x6, 0x16, 0x7, 0x17, 0x26, 0x36, 0x27, 0x37, 0x44, 0x54, 0x45, 0x55, 0x64, 0x74, 0x65, 0x75, 0x46, 0x56, 0x47, 0x57, 0x66, 0x76, 0x67, 0x77, 0x80, 0x90, 0x81, 0x91, 0xa0, 0xb0, 0xa1, 0xb1, 0x82, 0x92, 0x83, 0x93, 0xa2, 0xb2, 0xa3, 0xb3, 0xc0, 0xd0, 0xc1, 0xd1, 0xe0, 0xf0, 0xe1, 0xf1, 0xc2, 0xd2, 0xc3, 0xd3, 0xe2, 0xf2, 0xe3, 0xf3, 0x84, 0x94, 0x85, 0x95, 0xa4, 0xb4, 0xa5, 0xb5, 0x86, 0x96, 0x87, 0x97, 0xa6, 0xb6, 0xa7, 0xb7, 0xc4, 0xd4, 0xc5, 0xd5, 0xe4, 0xf4, 0xe5, 0xf5, 0xc6, 0xd6, 0xc7, 0xd7, 0xe6, 0xf6, 0xe7, 0xf7, 0x8, 0x18, 0x9, 0x19, 0x28, 0x38, 0x29, 0x39, 0xa, 0x1a, 0xb, 0x1b, 0x2a, 0x3a, 0x2b, 0x3b, 0x48, 0x58, 0x49, 0x59, 0x68, 0x78, 0x69, 0x79, 0x4a, 0x5a, 0x4b, 0x5b, 0x6a, 0x7a, 0x6b, 0x7b, 0xc, 0x1c, 0xd, 0x1d, 0x2c, 0x3c, 0x2d, 0x3d, 0xe, 0x1e, 0xf, 0x1f, 0x2e, 0x3e, 0x2f, 0x3f, 0x4c, 0x5c, 0x4d, 0x5d, 0x6c, 0x7c, 0x6d, 0x7d, 0x4e, 0x5e, 0x4f, 0x5f, 0x6e, 0x7e, 0x6f, 0x7f, 0x88, 0x98, 0x89, 0x99, 0xa8, 0xb8, 0xa9, 0xb9, 0x8a, 0x9a, 0x8b, 0x9b, 0xaa, 0xba, 0xab, 0xbb, 0xc8, 0xd8, 0xc9, 0xd9, 0xe8, 0xf8, 0xe9, 0xf9, 0xca, 0xda, 0xcb, 0xdb, 0xea, 0xfa, 0xeb, 0xfb, 0x8c, 0x9c, 0x8d, 0x9d, 0xac, 0xbc, 0xad, 0xbd, 0x8e, 0x9e, 0x8f, 0x9f, 0xae, 0xbe, 0xaf, 0xbf, 0xcc, 0xdc, 0xcd, 0xdd, 0xec, 0xfc, 0xed, 0xfd, 0xce, 0xde, 0xcf, 0xdf, 0xee, 0xfe, 0xef, 0xff);
/**
* Inverse IP mapping helper table.
* Indexing this table with a byte value reverses the bit order.
*
* @var array
* @access private
*/
var $invipmap = array(0x0, 0x80, 0x40, 0xc0, 0x20, 0xa0, 0x60, 0xe0, 0x10, 0x90, 0x50, 0xd0, 0x30, 0xb0, 0x70, 0xf0, 0x8, 0x88, 0x48, 0xc8, 0x28, 0xa8, 0x68, 0xe8, 0x18, 0x98, 0x58, 0xd8, 0x38, 0xb8, 0x78, 0xf8, 0x4, 0x84, 0x44, 0xc4, 0x24, 0xa4, 0x64, 0xe4, 0x14, 0x94, 0x54, 0xd4, 0x34, 0xb4, 0x74, 0xf4, 0xc, 0x8c, 0x4c, 0xcc, 0x2c, 0xac, 0x6c, 0xec, 0x1c, 0x9c, 0x5c, 0xdc, 0x3c, 0xbc, 0x7c, 0xfc, 0x2, 0x82, 0x42, 0xc2, 0x22, 0xa2, 0x62, 0xe2, 0x12, 0x92, 0x52, 0xd2, 0x32, 0xb2, 0x72, 0xf2, 0xa, 0x8a, 0x4a, 0xca, 0x2a, 0xaa, 0x6a, 0xea, 0x1a, 0x9a, 0x5a, 0xda, 0x3a, 0xba, 0x7a, 0xfa, 0x6, 0x86, 0x46, 0xc6, 0x26, 0xa6, 0x66, 0xe6, 0x16, 0x96, 0x56, 0xd6, 0x36, 0xb6, 0x76, 0xf6, 0xe, 0x8e, 0x4e, 0xce, 0x2e, 0xae, 0x6e, 0xee, 0x1e, 0x9e, 0x5e, 0xde, 0x3e, 0xbe, 0x7e, 0xfe, 0x1, 0x81, 0x41, 0xc1, 0x21, 0xa1, 0x61, 0xe1, 0x11, 0x91, 0x51, 0xd1, 0x31, 0xb1, 0x71, 0xf1, 0x9, 0x89, 0x49, 0xc9, 0x29, 0xa9, 0x69, 0xe9, 0x19, 0x99, 0x59, 0xd9, 0x39, 0xb9, 0x79, 0xf9, 0x5, 0x85, 0x45, 0xc5, 0x25, 0xa5, 0x65, 0xe5, 0x15, 0x95, 0x55, 0xd5, 0x35, 0xb5, 0x75, 0xf5, 0xd, 0x8d, 0x4d, 0xcd, 0x2d, 0xad, 0x6d, 0xed, 0x1d, 0x9d, 0x5d, 0xdd, 0x3d, 0xbd, 0x7d, 0xfd, 0x3, 0x83, 0x43, 0xc3, 0x23, 0xa3, 0x63, 0xe3, 0x13, 0x93, 0x53, 0xd3, 0x33, 0xb3, 0x73, 0xf3, 0xb, 0x8b, 0x4b, 0xcb, 0x2b, 0xab, 0x6b, 0xeb, 0x1b, 0x9b, 0x5b, 0xdb, 0x3b, 0xbb, 0x7b, 0xfb, 0x7, 0x87, 0x47, 0xc7, 0x27, 0xa7, 0x67, 0xe7, 0x17, 0x97, 0x57, 0xd7, 0x37, 0xb7, 0x77, 0xf7, 0xf, 0x8f, 0x4f, 0xcf, 0x2f, 0xaf, 0x6f, 0xef, 0x1f, 0x9f, 0x5f, 0xdf, 0x3f, 0xbf, 0x7f, 0xff);
/**
* Pre-permuted S-box1
*
* Each box ($sbox1-$sbox8) has been vectorized, then each value pre-permuted using the
* P table: concatenation can then be replaced by exclusive ORs.
*
* @var array
* @access private
*/
var $sbox1 = array(0x808200, 0x0, 0x8000, 0x808202, 0x808002, 0x8202, 0x2, 0x8000, 0x200, 0x808200, 0x808202, 0x200, 0x800202, 0x808002, 0x800000, 0x2, 0x202, 0x800200, 0x800200, 0x8200, 0x8200, 0x808000, 0x808000, 0x800202, 0x8002, 0x800002, 0x800002, 0x8002, 0x0, 0x202, 0x8202, 0x800000, 0x8000, 0x808202, 0x2, 0x808000, 0x808200, 0x800000, 0x800000, 0x200, 0x808002, 0x8000, 0x8200, 0x800002, 0x200, 0x2, 0x800202, 0x8202, 0x808202, 0x8002, 0x808000, 0x800202, 0x800002, 0x202, 0x8202, 0x808200, 0x202, 0x800200, 0x800200, 0x0, 0x8002, 0x8200, 0x0, 0x808002);
/**
* Pre-permuted S-box2
*
* @var array
* @access private
*/
var $sbox2 = array(0x40084010, 0x40004000, 0x4000, 0x84010, 0x80000, 0x10, 0x40080010, 0x40004010, 0x40000010, 0x40084010, 0x40084000, 0x40000000, 0x40004000, 0x80000, 0x10, 0x40080010, 0x84000, 0x80010, 0x40004010, 0x0, 0x40000000, 0x4000, 0x84010, 0x40080000, 0x80010, 0x40000010, 0x0, 0x84000, 0x4010, 0x40084000, 0x40080000, 0x4010, 0x0, 0x84010, 0x40080010, 0x80000, 0x40004010, 0x40080000, 0x40084000, 0x4000, 0x40080000, 0x40004000, 0x10, 0x40084010, 0x84010, 0x10, 0x4000, 0x40000000, 0x4010, 0x40084000, 0x80000, 0x40000010, 0x80010, 0x40004010, 0x40000010, 0x80010, 0x84000, 0x0, 0x40004000, 0x4010, 0x40000000, 0x40080010, 0x40084010, 0x84000);
/**
* Pre-permuted S-box3
*
* @var array
* @access private
*/
var $sbox3 = array(0x104, 0x4010100, 0x0, 0x4010004, 0x4000100, 0x0, 0x10104, 0x4000100, 0x10004, 0x4000004, 0x4000004, 0x10000, 0x4010104, 0x10004, 0x4010000, 0x104, 0x4000000, 0x4, 0x4010100, 0x100, 0x10100, 0x4010000, 0x4010004, 0x10104, 0x4000104, 0x10100, 0x10000, 0x4000104, 0x4, 0x4010104, 0x100, 0x4000000, 0x4010100, 0x4000000, 0x10004, 0x104, 0x10000, 0x4010100, 0x4000100, 0x0, 0x100, 0x10004, 0x4010104, 0x4000100, 0x4000004, 0x100, 0x0, 0x4010004, 0x4000104, 0x10000, 0x4000000, 0x4010104, 0x4, 0x10104, 0x10100, 0x4000004, 0x4010000, 0x4000104, 0x104, 0x4010000, 0x10104, 0x4, 0x4010004, 0x10100);
/**
* Pre-permuted S-box4
*
* @var array
* @access private
*/
var $sbox4 = array(0x80401000, 0x80001040, 0x80001040, 0x40, 0x401040, 0x80400040, 0x80400000, 0x80001000, 0x0, 0x401000, 0x401000, 0x80401040, 0x80000040, 0x0, 0x400040, 0x80400000, 0x80000000, 0x1000, 0x400000, 0x80401000, 0x40, 0x400000, 0x80001000, 0x1040, 0x80400040, 0x80000000, 0x1040, 0x400040, 0x1000, 0x401040, 0x80401040, 0x80000040, 0x400040, 0x80400000, 0x401000, 0x80401040, 0x80000040, 0x0, 0x0, 0x401000, 0x1040, 0x400040, 0x80400040, 0x80000000, 0x80401000, 0x80001040, 0x80001040, 0x40, 0x80401040, 0x80000040, 0x80000000, 0x1000, 0x80400000, 0x80001000, 0x401040, 0x80400040, 0x80001000, 0x1040, 0x400000, 0x80401000, 0x40, 0x400000, 0x1000, 0x401040);
/**
* Pre-permuted S-box5
*
* @var array
* @access private
*/
var $sbox5 = array(0x80, 0x1040080, 0x1040000, 0x21000080, 0x40000, 0x80, 0x20000000, 0x1040000, 0x20040080, 0x40000, 0x1000080, 0x20040080, 0x21000080, 0x21040000, 0x40080, 0x20000000, 0x1000000, 0x20040000, 0x20040000, 0x0, 0x20000080, 0x21040080, 0x21040080, 0x1000080, 0x21040000, 0x20000080, 0x0, 0x21000000, 0x1040080, 0x1000000, 0x21000000, 0x40080, 0x40000, 0x21000080, 0x80, 0x1000000, 0x20000000, 0x1040000, 0x21000080, 0x20040080, 0x1000080, 0x20000000, 0x21040000, 0x1040080, 0x20040080, 0x80, 0x1000000, 0x21040000, 0x21040080, 0x40080, 0x21000000, 0x21040080, 0x1040000, 0x0, 0x20040000, 0x21000000, 0x40080, 0x1000080, 0x20000080, 0x40000, 0x0, 0x20040000, 0x1040080, 0x20000080);
/**
* Pre-permuted S-box6
*
* @var array
* @access private
*/
var $sbox6 = array(0x10000008, 0x10200000, 0x2000, 0x10202008, 0x10200000, 0x8, 0x10202008, 0x200000, 0x10002000, 0x202008, 0x200000, 0x10000008, 0x200008, 0x10002000, 0x10000000, 0x2008, 0x0, 0x200008, 0x10002008, 0x2000, 0x202000, 0x10002008, 0x8, 0x10200008, 0x10200008, 0x0, 0x202008, 0x10202000, 0x2008, 0x202000, 0x10202000, 0x10000000, 0x10002000, 0x8, 0x10200008, 0x202000, 0x10202008, 0x200000, 0x2008, 0x10000008, 0x200000, 0x10002000, 0x10000000, 0x2008, 0x10000008, 0x10202008, 0x202000, 0x10200000, 0x202008, 0x10202000, 0x0, 0x10200008, 0x8, 0x2000, 0x10200000, 0x202008, 0x2000, 0x200008, 0x10002008, 0x0, 0x10202000, 0x10000000, 0x200008, 0x10002008);
/**
* Pre-permuted S-box7
*
* @var array
* @access private
*/
var $sbox7 = array(0x100000, 0x2100001, 0x2000401, 0x0, 0x400, 0x2000401, 0x100401, 0x2100400, 0x2100401, 0x100000, 0x0, 0x2000001, 0x1, 0x2000000, 0x2100001, 0x401, 0x2000400, 0x100401, 0x100001, 0x2000400, 0x2000001, 0x2100000, 0x2100400, 0x100001, 0x2100000, 0x400, 0x401, 0x2100401, 0x100400, 0x1, 0x2000000, 0x100400, 0x2000000, 0x100400, 0x100000, 0x2000401, 0x2000401, 0x2100001, 0x2100001, 0x1, 0x100001, 0x2000000, 0x2000400, 0x100000, 0x2100400, 0x401, 0x100401, 0x2100400, 0x401, 0x2000001, 0x2100401, 0x2100000, 0x100400, 0x0, 0x1, 0x2100401, 0x0, 0x100401, 0x2100000, 0x400, 0x2000001, 0x2000400, 0x400, 0x100001);
/**
* Pre-permuted S-box8
*
* @var array
* @access private
*/
var $sbox8 = array(0x8000820, 0x800, 0x20000, 0x8020820, 0x8000000, 0x8000820, 0x20, 0x8000000, 0x20020, 0x8020000, 0x8020820, 0x20800, 0x8020800, 0x20820, 0x800, 0x20, 0x8020000, 0x8000020, 0x8000800, 0x820, 0x20800, 0x20020, 0x8020020, 0x8020800, 0x820, 0x0, 0x0, 0x8020020, 0x8000020, 0x8000800, 0x20820, 0x20000, 0x20820, 0x20000, 0x8020800, 0x800, 0x20, 0x8020020, 0x800, 0x20820, 0x8000800, 0x20, 0x8000020, 0x8020000, 0x8020020, 0x8000000, 0x20000, 0x8000820, 0x0, 0x8020820, 0x20020, 0x8000020, 0x8020000, 0x8000800, 0x8000820, 0x0, 0x8020820, 0x20800, 0x20800, 0x820, 0x820, 0x20020, 0x8000000, 0x8020800);
/**
* Test for engine validity
*
* This is mainly just a wrapper to set things up for \phpseclib\Crypt\Base::isValidEngine()
*
* @see \phpseclib\Crypt\Base::isValidEngine()
* @param int $engine
* @access public
* @return bool
*/
function isValidEngine($engine)
{
}
/**
* Sets the key.
*
* Keys can be of any length. DES, itself, uses 64-bit keys (eg. strlen($key) == 8), however, we
* only use the first eight, if $key has more then eight characters in it, and pad $key with the
* null byte if it is less then eight characters long.
*
* DES also requires that every eighth bit be a parity bit, however, we'll ignore that.
*
* If the key is not explicitly set, it'll be assumed to be all zero's.
*
* @see \phpseclib\Crypt\Base::setKey()
* @access public
* @param string $key
*/
function setKey($key)
{
}
/**
* Encrypts a block
*
* @see \phpseclib\Crypt\Base::_encryptBlock()
* @see \phpseclib\Crypt\Base::encrypt()
* @see self::encrypt()
* @access private
* @param string $in
* @return string
*/
function _encryptBlock($in)
{
}
/**
* Decrypts a block
*
* @see \phpseclib\Crypt\Base::_decryptBlock()
* @see \phpseclib\Crypt\Base::decrypt()
* @see self::decrypt()
* @access private
* @param string $in
* @return string
*/
function _decryptBlock($in)
{
}
/**
* Encrypts or decrypts a 64-bit block
*
* $mode should be either self::ENCRYPT or self::DECRYPT. See
* {@link http://en.wikipedia.org/wiki/Image:Feistel.png Feistel.png} to get a general
* idea of what this function does.
*
* @see self::_encryptBlock()
* @see self::_decryptBlock()
* @access private
* @param string $block
* @param int $mode
* @return string
*/
function _processBlock($block, $mode)
{
}
/**
* Creates the key schedule
*
* @see \phpseclib\Crypt\Base::_setupKey()
* @access private
*/
function _setupKey()
{
}
/**
* Setup the performance-optimized function for de/encrypt()
*
* @see \phpseclib\Crypt\Base::_setupInlineCrypt()
* @access private
*/
function _setupInlineCrypt()
{
}
}
/**
* Pure-PHP implementation of Triple DES.
*
* @package TripleDES
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class TripleDES extends \phpseclib\Crypt\DES
{
/**
* Encrypt / decrypt using inner chaining
*
* Inner chaining is used by SSH-1 and is generally considered to be less secure then outer chaining (self::MODE_CBC3).
*/
const MODE_3CBC = -2;
/**
* Encrypt / decrypt using outer chaining
*
* Outer chaining is used by SSH-2 and when the mode is set to \phpseclib\Crypt\Base::MODE_CBC.
*/
const MODE_CBC3 = \phpseclib\Crypt\Base::MODE_CBC;
/**
* Key Length (in bytes)
*
* @see \phpseclib\Crypt\TripleDES::setKeyLength()
* @var int
* @access private
*/
var $key_length = 24;
/**
* The default salt used by setPassword()
*
* @see \phpseclib\Crypt\Base::password_default_salt
* @see \phpseclib\Crypt\Base::setPassword()
* @var string
* @access private
*/
var $password_default_salt = 'phpseclib';
/**
* The mcrypt specific name of the cipher
*
* @see \phpseclib\Crypt\DES::cipher_name_mcrypt
* @see \phpseclib\Crypt\Base::cipher_name_mcrypt
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'tripledes';
/**
* Optimizing value while CFB-encrypting
*
* @see \phpseclib\Crypt\Base::cfb_init_len
* @var int
* @access private
*/
var $cfb_init_len = 750;
/**
* max possible size of $key
*
* @see self::setKey()
* @see \phpseclib\Crypt\DES::setKey()
* @var string
* @access private
*/
var $key_length_max = 24;
/**
* Internal flag whether using self::MODE_3CBC or not
*
* @var bool
* @access private
*/
var $mode_3cbc;
/**
* The \phpseclib\Crypt\DES objects
*
* Used only if $mode_3cbc === true
*
* @var array
* @access private
*/
var $des;
/**
* Default Constructor.
*
* Determines whether or not the mcrypt extension should be used.
*
* $mode could be:
*
* - \phpseclib\Crypt\Base::MODE_ECB
*
* - \phpseclib\Crypt\Base::MODE_CBC
*
* - \phpseclib\Crypt\Base::MODE_CTR
*
* - \phpseclib\Crypt\Base::MODE_CFB
*
* - \phpseclib\Crypt\Base::MODE_OFB
*
* - \phpseclib\Crypt\TripleDES::MODE_3CBC
*
* If not explicitly set, \phpseclib\Crypt\Base::MODE_CBC will be used.
*
* @see \phpseclib\Crypt\DES::__construct()
* @see \phpseclib\Crypt\Base::__construct()
* @param int $mode
* @access public
*/
function __construct($mode = \phpseclib\Crypt\Base::MODE_CBC)
{
}
/**
* Test for engine validity
*
* This is mainly just a wrapper to set things up for \phpseclib\Crypt\Base::isValidEngine()
*
* @see \phpseclib\Crypt\Base::__construct()
* @param int $engine
* @access public
* @return bool
*/
function isValidEngine($engine)
{
}
/**
* Sets the initialization vector. (optional)
*
* SetIV is not required when \phpseclib\Crypt\Base::MODE_ECB is being used. If not explicitly set, it'll be assumed
* to be all zero's.
*
* @see \phpseclib\Crypt\Base::setIV()
* @access public
* @param string $iv
*/
function setIV($iv)
{
}
/**
* Sets the key length.
*
* Valid key lengths are 64, 128 and 192
*
* @see \phpseclib\Crypt\Base:setKeyLength()
* @access public
* @param int $length
*/
function setKeyLength($length)
{
}
/**
* Sets the key.
*
* Keys can be of any length. Triple DES, itself, can use 128-bit (eg. strlen($key) == 16) or
* 192-bit (eg. strlen($key) == 24) keys. This function pads and truncates $key as appropriate.
*
* DES also requires that every eighth bit be a parity bit, however, we'll ignore that.
*
* If the key is not explicitly set, it'll be assumed to be all null bytes.
*
* @access public
* @see \phpseclib\Crypt\DES::setKey()
* @see \phpseclib\Crypt\Base::setKey()
* @param string $key
*/
function setKey($key)
{
}
/**
* Encrypts a message.
*
* @see \phpseclib\Crypt\Base::encrypt()
* @access public
* @param string $plaintext
* @return string $cipertext
*/
function encrypt($plaintext)
{
}
/**
* Decrypts a message.
*
* @see \phpseclib\Crypt\Base::decrypt()
* @access public
* @param string $ciphertext
* @return string $plaintext
*/
function decrypt($ciphertext)
{
}
/**
* Treat consecutive "packets" as if they are a continuous buffer.
*
* Say you have a 16-byte plaintext $plaintext. Using the default behavior, the two following code snippets
* will yield different outputs:
*
* <code>
* echo $des->encrypt(substr($plaintext, 0, 8));
* echo $des->encrypt(substr($plaintext, 8, 8));
* </code>
* <code>
* echo $des->encrypt($plaintext);
* </code>
*
* The solution is to enable the continuous buffer. Although this will resolve the above discrepancy, it creates
* another, as demonstrated with the following:
*
* <code>
* $des->encrypt(substr($plaintext, 0, 8));
* echo $des->decrypt($des->encrypt(substr($plaintext, 8, 8)));
* </code>
* <code>
* echo $des->decrypt($des->encrypt(substr($plaintext, 8, 8)));
* </code>
*
* With the continuous buffer disabled, these would yield the same output. With it enabled, they yield different
* outputs. The reason is due to the fact that the initialization vector's change after every encryption /
* decryption round when the continuous buffer is enabled. When it's disabled, they remain constant.
*
* Put another way, when the continuous buffer is enabled, the state of the \phpseclib\Crypt\DES() object changes after each
* encryption / decryption round, whereas otherwise, it'd remain constant. For this reason, it's recommended that
* continuous buffers not be used. They do offer better security and are, in fact, sometimes required (SSH uses them),
* however, they are also less intuitive and more likely to cause you problems.
*
* @see \phpseclib\Crypt\Base::enableContinuousBuffer()
* @see self::disableContinuousBuffer()
* @access public
*/
function enableContinuousBuffer()
{
}
/**
* Treat consecutive packets as if they are a discontinuous buffer.
*
* The default behavior.
*
* @see \phpseclib\Crypt\Base::disableContinuousBuffer()
* @see self::enableContinuousBuffer()
* @access public
*/
function disableContinuousBuffer()
{
}
/**
* Creates the key schedule
*
* @see \phpseclib\Crypt\DES::_setupKey()
* @see \phpseclib\Crypt\Base::_setupKey()
* @access private
*/
function _setupKey()
{
}
/**
* Sets the internal crypt engine
*
* @see \phpseclib\Crypt\Base::__construct()
* @see \phpseclib\Crypt\Base::setPreferredEngine()
* @param int $engine
* @access public
* @return int
*/
function setPreferredEngine($engine)
{
}
}
/**
* Pure-PHP PKCS#1 compliant implementation of RSA.
*
* @package RSA
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class RSA
{
/**#@+
* @access public
* @see self::encrypt()
* @see self::decrypt()
*/
/**
* Use {@link http://en.wikipedia.org/wiki/Optimal_Asymmetric_Encryption_Padding Optimal Asymmetric Encryption Padding}
* (OAEP) for encryption / decryption.
*
* Uses sha1 by default.
*
* @see self::setHash()
* @see self::setMGFHash()
*/
const ENCRYPTION_OAEP = 1;
/**
* Use PKCS#1 padding.
*
* Although self::ENCRYPTION_OAEP offers more security, including PKCS#1 padding is necessary for purposes of backwards
* compatibility with protocols (like SSH-1) written before OAEP's introduction.
*/
const ENCRYPTION_PKCS1 = 2;
/**
* Do not use any padding
*
* Although this method is not recommended it can none-the-less sometimes be useful if you're trying to decrypt some legacy
* stuff, if you're trying to diagnose why an encrypted message isn't decrypting, etc.
*/
const ENCRYPTION_NONE = 3;
/**#@-*/
/**#@+
* @access public
* @see self::sign()
* @see self::verify()
* @see self::setHash()
*/
/**
* Use the Probabilistic Signature Scheme for signing
*
* Uses sha1 by default.
*
* @see self::setSaltLength()
* @see self::setMGFHash()
*/
const SIGNATURE_PSS = 1;
/**
* Use the PKCS#1 scheme by default.
*
* Although self::SIGNATURE_PSS offers more security, including PKCS#1 signing is necessary for purposes of backwards
* compatibility with protocols (like SSH-2) written before PSS's introduction.
*/
const SIGNATURE_PKCS1 = 2;
/**#@-*/
/**#@+
* @access private
* @see \phpseclib\Crypt\RSA::createKey()
*/
/**
* ASN1 Integer
*/
const ASN1_INTEGER = 2;
/**
* ASN1 Bit String
*/
const ASN1_BITSTRING = 3;
/**
* ASN1 Octet String
*/
const ASN1_OCTETSTRING = 4;
/**
* ASN1 Object Identifier
*/
const ASN1_OBJECT = 6;
/**
* ASN1 Sequence (with the constucted bit set)
*/
const ASN1_SEQUENCE = 48;
/**#@-*/
/**#@+
* @access private
* @see \phpseclib\Crypt\RSA::__construct()
*/
/**
* To use the pure-PHP implementation
*/
const MODE_INTERNAL = 1;
/**
* To use the OpenSSL library
*
* (if enabled; otherwise, the internal implementation will be used)
*/
const MODE_OPENSSL = 2;
/**#@-*/
/**#@+
* @access public
* @see \phpseclib\Crypt\RSA::createKey()
* @see \phpseclib\Crypt\RSA::setPrivateKeyFormat()
*/
/**
* PKCS#1 formatted private key
*
* Used by OpenSSH
*/
const PRIVATE_FORMAT_PKCS1 = 0;
/**
* PuTTY formatted private key
*/
const PRIVATE_FORMAT_PUTTY = 1;
/**
* XML formatted private key
*/
const PRIVATE_FORMAT_XML = 2;
/**
* PKCS#8 formatted private key
*/
const PRIVATE_FORMAT_PKCS8 = 8;
/**#@-*/
/**#@+
* @access public
* @see \phpseclib\Crypt\RSA::createKey()
* @see \phpseclib\Crypt\RSA::setPublicKeyFormat()
*/
/**
* Raw public key
*
* An array containing two \phpseclib\Math\BigInteger objects.
*
* The exponent can be indexed with any of the following:
*
* 0, e, exponent, publicExponent
*
* The modulus can be indexed with any of the following:
*
* 1, n, modulo, modulus
*/
const PUBLIC_FORMAT_RAW = 3;
/**
* PKCS#1 formatted public key (raw)
*
* Used by File/X509.php
*
* Has the following header:
*
* -----BEGIN RSA PUBLIC KEY-----
*
* Analogous to ssh-keygen's pem format (as specified by -m)
*/
const PUBLIC_FORMAT_PKCS1 = 4;
const PUBLIC_FORMAT_PKCS1_RAW = 4;
/**
* XML formatted public key
*/
const PUBLIC_FORMAT_XML = 5;
/**
* OpenSSH formatted public key
*
* Place in $HOME/.ssh/authorized_keys
*/
const PUBLIC_FORMAT_OPENSSH = 6;
/**
* PKCS#1 formatted public key (encapsulated)
*
* Used by PHP's openssl_public_encrypt() and openssl's rsautl (when -pubin is set)
*
* Has the following header:
*
* -----BEGIN PUBLIC KEY-----
*
* Analogous to ssh-keygen's pkcs8 format (as specified by -m). Although PKCS8
* is specific to private keys it's basically creating a DER-encoded wrapper
* for keys. This just extends that same concept to public keys (much like ssh-keygen)
*/
const PUBLIC_FORMAT_PKCS8 = 7;
/**#@-*/
/**
* Precomputed Zero
*
* @var \phpseclib\Math\BigInteger
* @access private
*/
var $zero;
/**
* Precomputed One
*
* @var \phpseclib\Math\BigInteger
* @access private
*/
var $one;
/**
* Private Key Format
*
* @var int
* @access private
*/
var $privateKeyFormat = self::PRIVATE_FORMAT_PKCS1;
/**
* Public Key Format
*
* @var int
* @access public
*/
var $publicKeyFormat = self::PUBLIC_FORMAT_PKCS8;
/**
* Modulus (ie. n)
*
* @var \phpseclib\Math\BigInteger
* @access private
*/
var $modulus;
/**
* Modulus length
*
* @var \phpseclib\Math\BigInteger
* @access private
*/
var $k;
/**
* Exponent (ie. e or d)
*
* @var \phpseclib\Math\BigInteger
* @access private
*/
var $exponent;
/**
* Primes for Chinese Remainder Theorem (ie. p and q)
*
* @var array
* @access private
*/
var $primes;
/**
* Exponents for Chinese Remainder Theorem (ie. dP and dQ)
*
* @var array
* @access private
*/
var $exponents;
/**
* Coefficients for Chinese Remainder Theorem (ie. qInv)
*
* @var array
* @access private
*/
var $coefficients;
/**
* Hash name
*
* @var string
* @access private
*/
var $hashName;
/**
* Hash function
*
* @var \phpseclib\Crypt\Hash
* @access private
*/
var $hash;
/**
* Length of hash function output
*
* @var int
* @access private
*/
var $hLen;
/**
* Length of salt
*
* @var int
* @access private
*/
var $sLen;
/**
* Hash function for the Mask Generation Function
*
* @var \phpseclib\Crypt\Hash
* @access private
*/
var $mgfHash;
/**
* Length of MGF hash function output
*
* @var int
* @access private
*/
var $mgfHLen;
/**
* Encryption mode
*
* @var int
* @access private
*/
var $encryptionMode = self::ENCRYPTION_OAEP;
/**
* Signature mode
*
* @var int
* @access private
*/
var $signatureMode = self::SIGNATURE_PSS;
/**
* Public Exponent
*
* @var mixed
* @access private
*/
var $publicExponent = false;
/**
* Password
*
* @var string
* @access private
*/
var $password = false;
/**
* Components
*
* For use with parsing XML formatted keys. PHP's XML Parser functions use utilized - instead of PHP's DOM functions -
* because PHP's XML Parser functions work on PHP4 whereas PHP's DOM functions - although surperior - don't.
*
* @see self::_start_element_handler()
* @var array
* @access private
*/
var $components = array();
/**
* Current String
*
* For use with parsing XML formatted keys.
*
* @see self::_character_handler()
* @see self::_stop_element_handler()
* @var mixed
* @access private
*/
var $current;
/**
* OpenSSL configuration file name.
*
* Set to null to use system configuration file.
* @see self::createKey()
* @var mixed
* @Access public
*/
var $configFile;
/**
* Public key comment field.
*
* @var string
* @access private
*/
var $comment = 'phpseclib-generated-key';
/**
* The constructor
*
* If you want to make use of the openssl extension, you'll need to set the mode manually, yourself. The reason
* \phpseclib\Crypt\RSA doesn't do it is because OpenSSL doesn't fail gracefully. openssl_pkey_new(), in particular, requires
* openssl.cnf be present somewhere and, unfortunately, the only real way to find out is too late.
*
* @return \phpseclib\Crypt\RSA
* @access public
*/
function __construct()
{
}
/**
* Create public / private key pair
*
* Returns an array with the following three elements:
* - 'privatekey': The private key.
* - 'publickey': The public key.
* - 'partialkey': A partially computed key (if the execution time exceeded $timeout).
* Will need to be passed back to \phpseclib\Crypt\RSA::createKey() as the third parameter for further processing.
*
* @access public
* @param int $bits
* @param int $timeout
* @param array $p
*/
function createKey($bits = 1024, $timeout = false, $partial = array())
{
}
/**
* Convert a private key to the appropriate format.
*
* @access private
* @see self::setPrivateKeyFormat()
* @param string $RSAPrivateKey
* @return string
*/
function _convertPrivateKey($n, $e, $d, $primes, $exponents, $coefficients)
{
}
/**
* Convert a public key to the appropriate format
*
* @access private
* @see self::setPublicKeyFormat()
* @param string $RSAPrivateKey
* @return string
*/
function _convertPublicKey($n, $e)
{
}
/**
* Break a public or private key down into its constituant components
*
* @access private
* @see self::_convertPublicKey()
* @see self::_convertPrivateKey()
* @param string $key
* @param int $type
* @return array
*/
function _parseKey($key, $type)
{
}
/**
* Returns the key size
*
* More specifically, this returns the size of the modulo in bits.
*
* @access public
* @return int
*/
function getSize()
{
}
/**
* Start Element Handler
*
* Called by xml_set_element_handler()
*
* @access private
* @param resource $parser
* @param string $name
* @param array $attribs
*/
function _start_element_handler($parser, $name, $attribs)
{
}
/**
* Stop Element Handler
*
* Called by xml_set_element_handler()
*
* @access private
* @param resource $parser
* @param string $name
*/
function _stop_element_handler($parser, $name)
{
}
/**
* Data Handler
*
* Called by xml_set_character_data_handler()
*
* @access private
* @param resource $parser
* @param string $data
*/
function _data_handler($parser, $data)
{
}
/**
* Loads a public or private key
*
* Returns true on success and false on failure (ie. an incorrect password was provided or the key was malformed)
*
* @access public
* @param string $key
* @param int $type optional
*/
function loadKey($key, $type = false)
{
}
/**
* Sets the password
*
* Private keys can be encrypted with a password. To unset the password, pass in the empty string or false.
* Or rather, pass in $password such that empty($password) && !is_string($password) is true.
*
* @see self::createKey()
* @see self::loadKey()
* @access public
* @param string $password
*/
function setPassword($password = false)
{
}
/**
* Defines the public key
*
* Some private key formats define the public exponent and some don't. Those that don't define it are problematic when
* used in certain contexts. For example, in SSH-2, RSA authentication works by sending the public key along with a
* message signed by the private key to the server. The SSH-2 server looks the public key up in an index of public keys
* and if it's present then proceeds to verify the signature. Problem is, if your private key doesn't include the public
* exponent this won't work unless you manually add the public exponent. phpseclib tries to guess if the key being used
* is the public key but in the event that it guesses incorrectly you might still want to explicitly set the key as being
* public.
*
* Do note that when a new key is loaded the index will be cleared.
*
* Returns true on success, false on failure
*
* @see self::getPublicKey()
* @access public
* @param string $key optional
* @param int $type optional
* @return bool
*/
function setPublicKey($key = false, $type = false)
{
}
/**
* Defines the private key
*
* If phpseclib guessed a private key was a public key and loaded it as such it might be desirable to force
* phpseclib to treat the key as a private key. This function will do that.
*
* Do note that when a new key is loaded the index will be cleared.
*
* Returns true on success, false on failure
*
* @see self::getPublicKey()
* @access public
* @param string $key optional
* @param int $type optional
* @return bool
*/
function setPrivateKey($key = false, $type = false)
{
}
/**
* Returns the public key
*
* The public key is only returned under two circumstances - if the private key had the public key embedded within it
* or if the public key was set via setPublicKey(). If the currently loaded key is supposed to be the public key this
* function won't return it since this library, for the most part, doesn't distinguish between public and private keys.
*
* @see self::getPublicKey()
* @access public
* @param string $key
* @param int $type optional
*/
function getPublicKey($type = self::PUBLIC_FORMAT_PKCS8)
{
}
/**
* Returns the public key's fingerprint
*
* The public key's fingerprint is returned, which is equivalent to running `ssh-keygen -lf rsa.pub`. If there is
* no public key currently loaded, false is returned.
* Example output (md5): "c1:b1:30:29:d7:b8:de:6c:97:77:10:d7:46:41:63:87" (as specified by RFC 4716)
*
* @access public
* @param string $algorithm The hashing algorithm to be used. Valid options are 'md5' and 'sha256'. False is returned
* for invalid values.
* @return mixed
*/
function getPublicKeyFingerprint($algorithm = 'md5')
{
}
/**
* Returns the private key
*
* The private key is only returned if the currently loaded key contains the constituent prime numbers.
*
* @see self::getPublicKey()
* @access public
* @param string $key
* @param int $type optional
* @return mixed
*/
function getPrivateKey($type = self::PUBLIC_FORMAT_PKCS1)
{
}
/**
* Returns a minimalistic private key
*
* Returns the private key without the prime number constituants. Structurally identical to a public key that
* hasn't been set as the public key
*
* @see self::getPrivateKey()
* @access private
* @param string $key
* @param int $type optional
*/
function _getPrivatePublicKey($mode = self::PUBLIC_FORMAT_PKCS8)
{
}
/**
* __toString() magic method
*
* @access public
* @return string
*/
function __toString()
{
}
/**
* __clone() magic method
*
* @access public
* @return Crypt_RSA
*/
function __clone()
{
}
/**
* Generates the smallest and largest numbers requiring $bits bits
*
* @access private
* @param int $bits
* @return array
*/
function _generateMinMax($bits)
{
}
/**
* DER-decode the length
*
* DER supports lengths up to (2**8)**127, however, we'll only support lengths up to (2**8)**4. See
* {@link http://itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf#p=13 X.690 paragraph 8.1.3} for more information.
*
* @access private
* @param string $string
* @return int
*/
function _decodeLength(&$string)
{
}
/**
* DER-encode the length
*
* DER supports lengths up to (2**8)**127, however, we'll only support lengths up to (2**8)**4. See
* {@link http://itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf#p=13 X.690 paragraph 8.1.3} for more information.
*
* @access private
* @param int $length
* @return string
*/
function _encodeLength($length)
{
}
/**
* String Shift
*
* Inspired by array_shift
*
* @param string $string
* @param int $index
* @return string
* @access private
*/
function _string_shift(&$string, $index = 1)
{
}
/**
* Determines the private key format
*
* @see self::createKey()
* @access public
* @param int $format
*/
function setPrivateKeyFormat($format)
{
}
/**
* Determines the public key format
*
* @see self::createKey()
* @access public
* @param int $format
*/
function setPublicKeyFormat($format)
{
}
/**
* Determines which hashing function should be used
*
* Used with signature production / verification and (if the encryption mode is self::ENCRYPTION_OAEP) encryption and
* decryption. If $hash isn't supported, sha1 is used.
*
* @access public
* @param string $hash
*/
function setHash($hash)
{
}
/**
* Determines which hashing function should be used for the mask generation function
*
* The mask generation function is used by self::ENCRYPTION_OAEP and self::SIGNATURE_PSS and although it's
* best if Hash and MGFHash are set to the same thing this is not a requirement.
*
* @access public
* @param string $hash
*/
function setMGFHash($hash)
{
}
/**
* Determines the salt length
*
* To quote from {@link http://tools.ietf.org/html/rfc3447#page-38 RFC3447#page-38}:
*
* Typical salt lengths in octets are hLen (the length of the output
* of the hash function Hash) and 0.
*
* @access public
* @param int $format
*/
function setSaltLength($sLen)
{
}
/**
* Integer-to-Octet-String primitive
*
* See {@link http://tools.ietf.org/html/rfc3447#section-4.1 RFC3447#section-4.1}.
*
* @access private
* @param \phpseclib\Math\BigInteger $x
* @param int $xLen
* @return string
*/
function _i2osp($x, $xLen)
{
}
/**
* Octet-String-to-Integer primitive
*
* See {@link http://tools.ietf.org/html/rfc3447#section-4.2 RFC3447#section-4.2}.
*
* @access private
* @param string $x
* @return \phpseclib\Math\BigInteger
*/
function _os2ip($x)
{
}
/**
* Exponentiate with or without Chinese Remainder Theorem
*
* See {@link http://tools.ietf.org/html/rfc3447#section-5.1.1 RFC3447#section-5.1.2}.
*
* @access private
* @param \phpseclib\Math\BigInteger $x
* @return \phpseclib\Math\BigInteger
*/
function _exponentiate($x)
{
}
/**
* Performs RSA Blinding
*
* Protects against timing attacks by employing RSA Blinding.
* Returns $x->modPow($this->exponents[$i], $this->primes[$i])
*
* @access private
* @param \phpseclib\Math\BigInteger $x
* @param \phpseclib\Math\BigInteger $r
* @param int $i
* @return \phpseclib\Math\BigInteger
*/
function _blind($x, $r, $i)
{
}
/**
* Performs blinded RSA equality testing
*
* Protects against a particular type of timing attack described.
*
* See {@link http://codahale.com/a-lesson-in-timing-attacks/ A Lesson In Timing Attacks (or, Don't use MessageDigest.isEquals)}
*
* Thanks for the heads up singpolyma!
*
* @access private
* @param string $x
* @param string $y
* @return bool
*/
function _equals($x, $y)
{
}
/**
* RSAEP
*
* See {@link http://tools.ietf.org/html/rfc3447#section-5.1.1 RFC3447#section-5.1.1}.
*
* @access private
* @param \phpseclib\Math\BigInteger $m
* @return \phpseclib\Math\BigInteger
*/
function _rsaep($m)
{
}
/**
* RSADP
*
* See {@link http://tools.ietf.org/html/rfc3447#section-5.1.2 RFC3447#section-5.1.2}.
*
* @access private
* @param \phpseclib\Math\BigInteger $c
* @return \phpseclib\Math\BigInteger
*/
function _rsadp($c)
{
}
/**
* RSASP1
*
* See {@link http://tools.ietf.org/html/rfc3447#section-5.2.1 RFC3447#section-5.2.1}.
*
* @access private
* @param \phpseclib\Math\BigInteger $m
* @return \phpseclib\Math\BigInteger
*/
function _rsasp1($m)
{
}
/**
* RSAVP1
*
* See {@link http://tools.ietf.org/html/rfc3447#section-5.2.2 RFC3447#section-5.2.2}.
*
* @access private
* @param \phpseclib\Math\BigInteger $s
* @return \phpseclib\Math\BigInteger
*/
function _rsavp1($s)
{
}
/**
* MGF1
*
* See {@link http://tools.ietf.org/html/rfc3447#appendix-B.2.1 RFC3447#appendix-B.2.1}.
*
* @access private
* @param string $mgfSeed
* @param int $mgfLen
* @return string
*/
function _mgf1($mgfSeed, $maskLen)
{
}
/**
* RSAES-OAEP-ENCRYPT
*
* See {@link http://tools.ietf.org/html/rfc3447#section-7.1.1 RFC3447#section-7.1.1} and
* {http://en.wikipedia.org/wiki/Optimal_Asymmetric_Encryption_Padding OAES}.
*
* @access private
* @param string $m
* @param string $l
* @return string
*/
function _rsaes_oaep_encrypt($m, $l = '')
{
}
/**
* RSAES-OAEP-DECRYPT
*
* See {@link http://tools.ietf.org/html/rfc3447#section-7.1.2 RFC3447#section-7.1.2}. The fact that the error
* messages aren't distinguishable from one another hinders debugging, but, to quote from RFC3447#section-7.1.2:
*
* Note. Care must be taken to ensure that an opponent cannot
* distinguish the different error conditions in Step 3.g, whether by
* error message or timing, or, more generally, learn partial
* information about the encoded message EM. Otherwise an opponent may
* be able to obtain useful information about the decryption of the
* ciphertext C, leading to a chosen-ciphertext attack such as the one
* observed by Manger [36].
*
* As for $l... to quote from {@link http://tools.ietf.org/html/rfc3447#page-17 RFC3447#page-17}:
*
* Both the encryption and the decryption operations of RSAES-OAEP take
* the value of a label L as input. In this version of PKCS #1, L is
* the empty string; other uses of the label are outside the scope of
* this document.
*
* @access private
* @param string $c
* @param string $l
* @return string
*/
function _rsaes_oaep_decrypt($c, $l = '')
{
}
/**
* Raw Encryption / Decryption
*
* Doesn't use padding and is not recommended.
*
* @access private
* @param string $m
* @return string
*/
function _raw_encrypt($m)
{
}
/**
* RSAES-PKCS1-V1_5-ENCRYPT
*
* See {@link http://tools.ietf.org/html/rfc3447#section-7.2.1 RFC3447#section-7.2.1}.
*
* @access private
* @param string $m
* @return string
*/
function _rsaes_pkcs1_v1_5_encrypt($m)
{
}
/**
* RSAES-PKCS1-V1_5-DECRYPT
*
* See {@link http://tools.ietf.org/html/rfc3447#section-7.2.2 RFC3447#section-7.2.2}.
*
* For compatibility purposes, this function departs slightly from the description given in RFC3447.
* The reason being that RFC2313#section-8.1 (PKCS#1 v1.5) states that ciphertext's encrypted by the
* private key should have the second byte set to either 0 or 1 and that ciphertext's encrypted by the
* public key should have the second byte set to 2. In RFC3447 (PKCS#1 v2.1), the second byte is supposed
* to be 2 regardless of which key is used. For compatibility purposes, we'll just check to make sure the
* second byte is 2 or less. If it is, we'll accept the decrypted string as valid.
*
* As a consequence of this, a private key encrypted ciphertext produced with \phpseclib\Crypt\RSA may not decrypt
* with a strictly PKCS#1 v1.5 compliant RSA implementation. Public key encrypted ciphertext's should but
* not private key encrypted ciphertext's.
*
* @access private
* @param string $c
* @return string
*/
function _rsaes_pkcs1_v1_5_decrypt($c)
{
}
/**
* EMSA-PSS-ENCODE
*
* See {@link http://tools.ietf.org/html/rfc3447#section-9.1.1 RFC3447#section-9.1.1}.
*
* @access private
* @param string $m
* @param int $emBits
*/
function _emsa_pss_encode($m, $emBits)
{
}
/**
* EMSA-PSS-VERIFY
*
* See {@link http://tools.ietf.org/html/rfc3447#section-9.1.2 RFC3447#section-9.1.2}.
*
* @access private
* @param string $m
* @param string $em
* @param int $emBits
* @return string
*/
function _emsa_pss_verify($m, $em, $emBits)
{
}
/**
* RSASSA-PSS-SIGN
*
* See {@link http://tools.ietf.org/html/rfc3447#section-8.1.1 RFC3447#section-8.1.1}.
*
* @access private
* @param string $m
* @return string
*/
function _rsassa_pss_sign($m)
{
}
/**
* RSASSA-PSS-VERIFY
*
* See {@link http://tools.ietf.org/html/rfc3447#section-8.1.2 RFC3447#section-8.1.2}.
*
* @access private
* @param string $m
* @param string $s
* @return string
*/
function _rsassa_pss_verify($m, $s)
{
}
/**
* EMSA-PKCS1-V1_5-ENCODE
*
* See {@link http://tools.ietf.org/html/rfc3447#section-9.2 RFC3447#section-9.2}.
*
* @access private
* @param string $m
* @param int $emLen
* @return string
*/
function _emsa_pkcs1_v1_5_encode($m, $emLen)
{
}
/**
* RSASSA-PKCS1-V1_5-SIGN
*
* See {@link http://tools.ietf.org/html/rfc3447#section-8.2.1 RFC3447#section-8.2.1}.
*
* @access private
* @param string $m
* @return string
*/
function _rsassa_pkcs1_v1_5_sign($m)
{
}
/**
* RSASSA-PKCS1-V1_5-VERIFY
*
* See {@link http://tools.ietf.org/html/rfc3447#section-8.2.2 RFC3447#section-8.2.2}.
*
* @access private
* @param string $m
* @return string
*/
function _rsassa_pkcs1_v1_5_verify($m, $s)
{
}
/**
* Set Encryption Mode
*
* Valid values include self::ENCRYPTION_OAEP and self::ENCRYPTION_PKCS1.
*
* @access public
* @param int $mode
*/
function setEncryptionMode($mode)
{
}
/**
* Set Signature Mode
*
* Valid values include self::SIGNATURE_PSS and self::SIGNATURE_PKCS1
*
* @access public
* @param int $mode
*/
function setSignatureMode($mode)
{
}
/**
* Set public key comment.
*
* @access public
* @param string $comment
*/
function setComment($comment)
{
}
/**
* Get public key comment.
*
* @access public
* @return string
*/
function getComment()
{
}
/**
* Encryption
*
* Both self::ENCRYPTION_OAEP and self::ENCRYPTION_PKCS1 both place limits on how long $plaintext can be.
* If $plaintext exceeds those limits it will be broken up so that it does and the resultant ciphertext's will
* be concatenated together.
*
* @see self::decrypt()
* @access public
* @param string $plaintext
* @return string
*/
function encrypt($plaintext)
{
}
/**
* Decryption
*
* @see self::encrypt()
* @access public
* @param string $plaintext
* @return string
*/
function decrypt($ciphertext)
{
}
/**
* Create a signature
*
* @see self::verify()
* @access public
* @param string $message
* @return string
*/
function sign($message)
{
}
/**
* Verifies a signature
*
* @see self::sign()
* @access public
* @param string $message
* @param string $signature
* @return bool
*/
function verify($message, $signature)
{
}
/**
* Extract raw BER from Base64 encoding
*
* @access private
* @param string $str
* @return string
*/
function _extractBER($str)
{
}
}
/**
* Pure-PHP implementation of RC4.
*
* @package RC4
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class RC4 extends \phpseclib\Crypt\Base
{
/**#@+
* @access private
* @see \phpseclib\Crypt\RC4::_crypt()
*/
const ENCRYPT = 0;
const DECRYPT = 1;
/**#@-*/
/**
* Block Length of the cipher
*
* RC4 is a stream cipher
* so we the block_size to 0
*
* @see \phpseclib\Crypt\Base::block_size
* @var int
* @access private
*/
var $block_size = 0;
/**
* Key Length (in bytes)
*
* @see \phpseclib\Crypt\RC4::setKeyLength()
* @var int
* @access private
*/
var $key_length = 128;
// = 1024 bits
/**
* The mcrypt specific name of the cipher
*
* @see \phpseclib\Crypt\Base::cipher_name_mcrypt
* @var string
* @access private
*/
var $cipher_name_mcrypt = 'arcfour';
/**
* Holds whether performance-optimized $inline_crypt() can/should be used.
*
* @see \phpseclib\Crypt\Base::inline_crypt
* @var mixed
* @access private
*/
var $use_inline_crypt = false;
// currently not available
/**
* The Key
*
* @see self::setKey()
* @var string
* @access private
*/
var $key;
/**
* The Key Stream for decryption and encryption
*
* @see self::setKey()
* @var array
* @access private
*/
var $stream;
/**
* Default Constructor.
*
* Determines whether or not the mcrypt extension should be used.
*
* @see \phpseclib\Crypt\Base::__construct()
* @return \phpseclib\Crypt\RC4
* @access public
*/
function __construct()
{
}
/**
* Test for engine validity
*
* This is mainly just a wrapper to set things up for \phpseclib\Crypt\Base::isValidEngine()
*
* @see \phpseclib\Crypt\Base::__construct()
* @param int $engine
* @access public
* @return bool
*/
function isValidEngine($engine)
{
}
/**
* Dummy function.
*
* Some protocols, such as WEP, prepend an "initialization vector" to the key, effectively creating a new key [1].
* If you need to use an initialization vector in this manner, feel free to prepend it to the key, yourself, before
* calling setKey().
*
* [1] WEP's initialization vectors (IV's) are used in a somewhat insecure way. Since, in that protocol,
* the IV's are relatively easy to predict, an attack described by
* {@link http://www.drizzle.com/~aboba/IEEE/rc4_ksaproc.pdf Scott Fluhrer, Itsik Mantin, and Adi Shamir}
* can be used to quickly guess at the rest of the key. The following links elaborate:
*
* {@link http://www.rsa.com/rsalabs/node.asp?id=2009 http://www.rsa.com/rsalabs/node.asp?id=2009}
* {@link http://en.wikipedia.org/wiki/Related_key_attack http://en.wikipedia.org/wiki/Related_key_attack}
*
* @param string $iv
* @see self::setKey()
* @access public
*/
function setIV($iv)
{
}
/**
* Sets the key length
*
* Keys can be between 1 and 256 bytes long.
*
* @access public
* @param int $length
*/
function setKeyLength($length)
{
}
/**
* Encrypts a message.
*
* @see \phpseclib\Crypt\Base::decrypt()
* @see self::_crypt()
* @access public
* @param string $plaintext
* @return string $ciphertext
*/
function encrypt($plaintext)
{
}
/**
* Decrypts a message.
*
* $this->decrypt($this->encrypt($plaintext)) == $this->encrypt($this->encrypt($plaintext)).
* At least if the continuous buffer is disabled.
*
* @see \phpseclib\Crypt\Base::encrypt()
* @see self::_crypt()
* @access public
* @param string $ciphertext
* @return string $plaintext
*/
function decrypt($ciphertext)
{
}
/**
* Encrypts a block
*
* @access private
* @param string $in
*/
function _encryptBlock($in)
{
}
/**
* Decrypts a block
*
* @access private
* @param string $in
*/
function _decryptBlock($in)
{
}
/**
* Setup the key (expansion)
*
* @see \phpseclib\Crypt\Base::_setupKey()
* @access private
*/
function _setupKey()
{
}
/**
* Encrypts or decrypts a message.
*
* @see self::encrypt()
* @see self::decrypt()
* @access private
* @param string $text
* @param int $mode
* @return string $text
*/
function _crypt($text, $mode)
{
}
}
/**
* Pure-PHP implementations of keyed-hash message authentication codes (HMACs) and various cryptographic hashing functions.
*
* @package Hash
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class Hash
{
/**#@+
* @access private
* @see \phpseclib\Crypt\Hash::__construct()
*/
/**
* Toggles the internal implementation
*/
const MODE_INTERNAL = 1;
/**
* Toggles the mhash() implementation, which has been deprecated on PHP 5.3.0+.
*/
const MODE_MHASH = 2;
/**
* Toggles the hash() implementation, which works on PHP 5.1.2+.
*/
const MODE_HASH = 3;
/**#@-*/
/**
* Hash Parameter
*
* @see self::setHash()
* @var int
* @access private
*/
var $hashParam;
/**
* Byte-length of compression blocks / key (Internal HMAC)
*
* @see self::setAlgorithm()
* @var int
* @access private
*/
var $b;
/**
* Byte-length of hash output (Internal HMAC)
*
* @see self::setHash()
* @var int
* @access private
*/
var $l = false;
/**
* Hash Algorithm
*
* @see self::setHash()
* @var string
* @access private
*/
var $hash;
/**
* Key
*
* @see self::setKey()
* @var string
* @access private
*/
var $key = false;
/**
* Outer XOR (Internal HMAC)
*
* @see self::setKey()
* @var string
* @access private
*/
var $opad;
/**
* Inner XOR (Internal HMAC)
*
* @see self::setKey()
* @var string
* @access private
*/
var $ipad;
/**
* Default Constructor.
*
* @param string $hash
* @return \phpseclib\Crypt\Hash
* @access public
*/
function __construct($hash = 'sha1')
{
}
/**
* Sets the key for HMACs
*
* Keys can be of any length.
*
* @access public
* @param string $key
*/
function setKey($key = false)
{
}
/**
* Gets the hash function.
*
* As set by the constructor or by the setHash() method.
*
* @access public
* @return string
*/
function getHash()
{
}
/**
* Sets the hash function.
*
* @access public
* @param string $hash
*/
function setHash($hash)
{
}
/**
* Compute the HMAC.
*
* @access public
* @param string $text
* @return string
*/
function hash($text)
{
}
/**
* Returns the hash length (in bytes)
*
* @access public
* @return int
*/
function getLength()
{
}
/**
* Wrapper for MD5
*
* @access private
* @param string $m
*/
function _md5($m)
{
}
/**
* Wrapper for SHA1
*
* @access private
* @param string $m
*/
function _sha1($m)
{
}
/**
* Pure-PHP implementation of MD2
*
* See {@link http://tools.ietf.org/html/rfc1319 RFC1319}.
*
* @access private
* @param string $m
*/
function _md2($m)
{
}
/**
* Pure-PHP implementation of SHA256
*
* See {@link http://en.wikipedia.org/wiki/SHA_hash_functions#SHA-256_.28a_SHA-2_variant.29_pseudocode SHA-256 (a SHA-2 variant) pseudocode - Wikipedia}.
*
* @access private
* @param string $m
*/
function _sha256($m)
{
}
/**
* Pure-PHP implementation of SHA384 and SHA512
*
* @access private
* @param string $m
*/
function _sha512($m)
{
}
/**
* Right Rotate
*
* @access private
* @param int $int
* @param int $amt
* @see self::_sha256()
* @return int
*/
function _rightRotate($int, $amt)
{
}
/**
* Right Shift
*
* @access private
* @param int $int
* @param int $amt
* @see self::_sha256()
* @return int
*/
function _rightShift($int, $amt)
{
}
/**
* Not
*
* @access private
* @param int $int
* @see self::_sha256()
* @return int
*/
function _not($int)
{
}
/**
* Add
*
* _sha256() adds multiple unsigned 32-bit integers. Since PHP doesn't support unsigned integers and since the
* possibility of overflow exists, care has to be taken. BigInteger could be used but this should be faster.
*
* @param int $...
* @return int
* @see self::_sha256()
* @access private
*/
function _add()
{
}
/**
* String Shift
*
* Inspired by array_shift
*
* @param string $string
* @param int $index
* @return string
* @access private
*/
function _string_shift(&$string, $index = 1)
{
}
}
}
namespace phpseclib\File {
/**
* Pure-PHP X.509 Parser
*
* @package X509
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class X509
{
/**
* Flag to only accept signatures signed by certificate authorities
*
* Not really used anymore but retained all the same to suppress E_NOTICEs from old installs
*
* @access public
*/
const VALIDATE_SIGNATURE_BY_CA = 1;
/**#@+
* @access public
* @see \phpseclib\File\X509::getDN()
*/
/**
* Return internal array representation
*/
const DN_ARRAY = 0;
/**
* Return string
*/
const DN_STRING = 1;
/**
* Return ASN.1 name string
*/
const DN_ASN1 = 2;
/**
* Return OpenSSL compatible array
*/
const DN_OPENSSL = 3;
/**
* Return canonical ASN.1 RDNs string
*/
const DN_CANON = 4;
/**
* Return name hash for file indexing
*/
const DN_HASH = 5;
/**#@-*/
/**#@+
* @access public
* @see \phpseclib\File\X509::saveX509()
* @see \phpseclib\File\X509::saveCSR()
* @see \phpseclib\File\X509::saveCRL()
*/
/**
* Save as PEM
*
* ie. a base64-encoded PEM with a header and a footer
*/
const FORMAT_PEM = 0;
/**
* Save as DER
*/
const FORMAT_DER = 1;
/**
* Save as a SPKAC
*
* Only works on CSRs. Not currently supported.
*/
const FORMAT_SPKAC = 2;
/**
* Auto-detect the format
*
* Used only by the load*() functions
*/
const FORMAT_AUTO_DETECT = 3;
/**#@-*/
/**
* Attribute value disposition.
* If disposition is >= 0, this is the index of the target value.
*/
const ATTR_ALL = -1;
// All attribute values (array).
const ATTR_APPEND = -2;
// Add a value.
const ATTR_REPLACE = -3;
// Clear first, then add a value.
/**
* ASN.1 syntax for X.509 certificates
*
* @var array
* @access private
*/
var $Certificate;
/**#@+
* ASN.1 syntax for various extensions
*
* @access private
*/
var $DirectoryString;
var $PKCS9String;
var $AttributeValue;
var $Extensions;
var $KeyUsage;
var $ExtKeyUsageSyntax;
var $BasicConstraints;
var $KeyIdentifier;
var $CRLDistributionPoints;
var $AuthorityKeyIdentifier;
var $CertificatePolicies;
var $AuthorityInfoAccessSyntax;
var $SubjectAltName;
var $SubjectDirectoryAttributes;
var $PrivateKeyUsagePeriod;
var $IssuerAltName;
var $PolicyMappings;
var $NameConstraints;
var $CPSuri;
var $UserNotice;
var $netscape_cert_type;
var $netscape_comment;
var $netscape_ca_policy_url;
var $Name;
var $RelativeDistinguishedName;
var $CRLNumber;
var $CRLReason;
var $IssuingDistributionPoint;
var $InvalidityDate;
var $CertificateIssuer;
var $HoldInstructionCode;
var $SignedPublicKeyAndChallenge;
/**#@-*/
/**#@+
* ASN.1 syntax for various DN attributes
*
* @access private
*/
var $PostalAddress;
/**#@-*/
/**
* ASN.1 syntax for Certificate Signing Requests (RFC2986)
*
* @var array
* @access private
*/
var $CertificationRequest;
/**
* ASN.1 syntax for Certificate Revocation Lists (RFC5280)
*
* @var array
* @access private
*/
var $CertificateList;
/**
* Distinguished Name
*
* @var array
* @access private
*/
var $dn;
/**
* Public key
*
* @var string
* @access private
*/
var $publicKey;
/**
* Private key
*
* @var string
* @access private
*/
var $privateKey;
/**
* Object identifiers for X.509 certificates
*
* @var array
* @access private
* @link http://en.wikipedia.org/wiki/Object_identifier
*/
var $oids;
/**
* The certificate authorities
*
* @var array
* @access private
*/
var $CAs;
/**
* The currently loaded certificate
*
* @var array
* @access private
*/
var $currentCert;
/**
* The signature subject
*
* There's no guarantee \phpseclib\File\X509 is going to re-encode an X.509 cert in the same way it was originally
* encoded so we take save the portion of the original cert that the signature would have made for.
*
* @var string
* @access private
*/
var $signatureSubject;
/**
* Certificate Start Date
*
* @var string
* @access private
*/
var $startDate;
/**
* Certificate End Date
*
* @var string
* @access private
*/
var $endDate;
/**
* Serial Number
*
* @var string
* @access private
*/
var $serialNumber;
/**
* Key Identifier
*
* See {@link http://tools.ietf.org/html/rfc5280#section-4.2.1.1 RFC5280#section-4.2.1.1} and
* {@link http://tools.ietf.org/html/rfc5280#section-4.2.1.2 RFC5280#section-4.2.1.2}.
*
* @var string
* @access private
*/
var $currentKeyIdentifier;
/**
* CA Flag
*
* @var bool
* @access private
*/
var $caFlag = false;
/**
* SPKAC Challenge
*
* @var string
* @access private
*/
var $challenge;
/**
* Default Constructor.
*
* @return \phpseclib\File\X509
* @access public
*/
function __construct()
{
}
/**
* Load X.509 certificate
*
* Returns an associative array describing the X.509 cert or a false if the cert failed to load
*
* @param string $cert
* @param int $mode
* @access public
* @return mixed
*/
function loadX509($cert, $mode = self::FORMAT_AUTO_DETECT)
{
}
/**
* Save X.509 certificate
*
* @param array $cert
* @param int $format optional
* @access public
* @return string
*/
function saveX509($cert, $format = self::FORMAT_PEM)
{
}
/**
* Map extension values from octet string to extension-specific internal
* format.
*
* @param array ref $root
* @param string $path
* @param object $asn1
* @access private
*/
function _mapInExtensions(&$root, $path, $asn1)
{
}
/**
* Map extension values from extension-specific internal format to
* octet string.
*
* @param array ref $root
* @param string $path
* @param object $asn1
* @access private
*/
function _mapOutExtensions(&$root, $path, $asn1)
{
}
/**
* Map attribute values from ANY type to attribute-specific internal
* format.
*
* @param array ref $root
* @param string $path
* @param object $asn1
* @access private
*/
function _mapInAttributes(&$root, $path, $asn1)
{
}
/**
* Map attribute values from attribute-specific internal format to
* ANY type.
*
* @param array ref $root
* @param string $path
* @param object $asn1
* @access private
*/
function _mapOutAttributes(&$root, $path, $asn1)
{
}
/**
* Map DN values from ANY type to DN-specific internal
* format.
*
* @param array ref $root
* @param string $path
* @param object $asn1
* @access private
*/
function _mapInDNs(&$root, $path, $asn1)
{
}
/**
* Map DN values from DN-specific internal format to
* ANY type.
*
* @param array ref $root
* @param string $path
* @param object $asn1
* @access private
*/
function _mapOutDNs(&$root, $path, $asn1)
{
}
/**
* Associate an extension ID to an extension mapping
*
* @param string $extnId
* @access private
* @return mixed
*/
function _getMapping($extnId)
{
}
/**
* Load an X.509 certificate as a certificate authority
*
* @param string $cert
* @access public
* @return bool
*/
function loadCA($cert)
{
}
/**
* Validate an X.509 certificate against a URL
*
* From RFC2818 "HTTP over TLS":
*
* Matching is performed using the matching rules specified by
* [RFC2459]. If more than one identity of a given type is present in
* the certificate (e.g., more than one dNSName name, a match in any one
* of the set is considered acceptable.) Names may contain the wildcard
* character * which is considered to match any single domain name
* component or component fragment. E.g., *.a.com matches foo.a.com but
* not bar.foo.a.com. f*.com matches foo.com but not bar.com.
*
* @param string $url
* @access public
* @return bool
*/
function validateURL($url)
{
}
/**
* Validate a date
*
* If $date isn't defined it is assumed to be the current date.
*
* @param int $date optional
* @access public
*/
function validateDate($date = null)
{
}
/**
* Validate a signature
*
* Works on X.509 certs, CSR's and CRL's.
* Returns true if the signature is verified, false if it is not correct or null on error
*
* By default returns false for self-signed certs. Call validateSignature(false) to make this support
* self-signed.
*
* The behavior of this function is inspired by {@link http://php.net/openssl-verify openssl_verify}.
*
* @param bool $caonly optional
* @access public
* @return mixed
*/
function validateSignature($caonly = true)
{
}
/**
* Validates a signature
*
* Returns true if the signature is verified, false if it is not correct or null on error
*
* @param string $publicKeyAlgorithm
* @param string $publicKey
* @param string $signatureAlgorithm
* @param string $signature
* @param string $signatureSubject
* @access private
* @return int
*/
function _validateSignature($publicKeyAlgorithm, $publicKey, $signatureAlgorithm, $signature, $signatureSubject)
{
}
/**
* Reformat public keys
*
* Reformats a public key to a format supported by phpseclib (if applicable)
*
* @param string $algorithm
* @param string $key
* @access private
* @return string
*/
function _reformatKey($algorithm, $key)
{
}
/**
* Decodes an IP address
*
* Takes in a base64 encoded "blob" and returns a human readable IP address
*
* @param string $ip
* @access private
* @return string
*/
function _decodeIP($ip)
{
}
/**
* Encodes an IP address
*
* Takes a human readable IP address into a base64-encoded "blob"
*
* @param string $ip
* @access private
* @return string
*/
function _encodeIP($ip)
{
}
/**
* "Normalizes" a Distinguished Name property
*
* @param string $propName
* @access private
* @return mixed
*/
function _translateDNProp($propName)
{
}
/**
* Set a Distinguished Name property
*
* @param string $propName
* @param mixed $propValue
* @param string $type optional
* @access public
* @return bool
*/
function setDNProp($propName, $propValue, $type = 'utf8String')
{
}
/**
* Remove Distinguished Name properties
*
* @param string $propName
* @access public
*/
function removeDNProp($propName)
{
}
/**
* Get Distinguished Name properties
*
* @param string $propName
* @param array $dn optional
* @param bool $withType optional
* @return mixed
* @access public
*/
function getDNProp($propName, $dn = null, $withType = false)
{
}
/**
* Set a Distinguished Name
*
* @param mixed $dn
* @param bool $merge optional
* @param string $type optional
* @access public
* @return bool
*/
function setDN($dn, $merge = false, $type = 'utf8String')
{
}
/**
* Get the Distinguished Name for a certificates subject
*
* @param mixed $format optional
* @param array $dn optional
* @access public
* @return bool
*/
function getDN($format = self::DN_ARRAY, $dn = null)
{
}
/**
* Get the Distinguished Name for a certificate/crl issuer
*
* @param int $format optional
* @access public
* @return mixed
*/
function getIssuerDN($format = self::DN_ARRAY)
{
}
/**
* Get the Distinguished Name for a certificate/csr subject
* Alias of getDN()
*
* @param int $format optional
* @access public
* @return mixed
*/
function getSubjectDN($format = self::DN_ARRAY)
{
}
/**
* Get an individual Distinguished Name property for a certificate/crl issuer
*
* @param string $propName
* @param bool $withType optional
* @access public
* @return mixed
*/
function getIssuerDNProp($propName, $withType = false)
{
}
/**
* Get an individual Distinguished Name property for a certificate/csr subject
*
* @param string $propName
* @param bool $withType optional
* @access public
* @return mixed
*/
function getSubjectDNProp($propName, $withType = false)
{
}
/**
* Get the certificate chain for the current cert
*
* @access public
* @return mixed
*/
function getChain()
{
}
/**
* Set public key
*
* Key needs to be a \phpseclib\Crypt\RSA object
*
* @param object $key
* @access public
* @return bool
*/
function setPublicKey($key)
{
}
/**
* Set private key
*
* Key needs to be a \phpseclib\Crypt\RSA object
*
* @param object $key
* @access public
*/
function setPrivateKey($key)
{
}
/**
* Set challenge
*
* Used for SPKAC CSR's
*
* @param string $challenge
* @access public
*/
function setChallenge($challenge)
{
}
/**
* Gets the public key
*
* Returns a \phpseclib\Crypt\RSA object or a false.
*
* @access public
* @return mixed
*/
function getPublicKey()
{
}
/**
* Load a Certificate Signing Request
*
* @param string $csr
* @access public
* @return mixed
*/
function loadCSR($csr, $mode = self::FORMAT_AUTO_DETECT)
{
}
/**
* Save CSR request
*
* @param array $csr
* @param int $format optional
* @access public
* @return string
*/
function saveCSR($csr, $format = self::FORMAT_PEM)
{
}
/**
* Load a SPKAC CSR
*
* SPKAC's are produced by the HTML5 keygen element:
*
* https://developer.mozilla.org/en-US/docs/HTML/Element/keygen
*
* @param string $csr
* @access public
* @return mixed
*/
function loadSPKAC($spkac)
{
}
/**
* Save a SPKAC CSR request
*
* @param array $csr
* @param int $format optional
* @access public
* @return string
*/
function saveSPKAC($spkac, $format = self::FORMAT_PEM)
{
}
/**
* Load a Certificate Revocation List
*
* @param string $crl
* @access public
* @return mixed
*/
function loadCRL($crl, $mode = self::FORMAT_AUTO_DETECT)
{
}
/**
* Save Certificate Revocation List.
*
* @param array $crl
* @param int $format optional
* @access public
* @return string
*/
function saveCRL($crl, $format = self::FORMAT_PEM)
{
}
/**
* Helper function to build a time field according to RFC 3280 section
* - 4.1.2.5 Validity
* - 5.1.2.4 This Update
* - 5.1.2.5 Next Update
* - 5.1.2.6 Revoked Certificates
* by choosing utcTime iff year of date given is before 2050 and generalTime else.
*
* @param string $date in format date('D, d M Y H:i:s O')
* @access private
* @return array
*/
function _timeField($date)
{
}
/**
* Sign an X.509 certificate
*
* $issuer's private key needs to be loaded.
* $subject can be either an existing X.509 cert (if you want to resign it),
* a CSR or something with the DN and public key explicitly set.
*
* @param \phpseclib\File\X509 $issuer
* @param \phpseclib\File\X509 $subject
* @param string $signatureAlgorithm optional
* @access public
* @return mixed
*/
function sign($issuer, $subject, $signatureAlgorithm = 'sha1WithRSAEncryption')
{
}
/**
* Sign a CSR
*
* @access public
* @return mixed
*/
function signCSR($signatureAlgorithm = 'sha1WithRSAEncryption')
{
}
/**
* Sign a SPKAC
*
* @access public
* @return mixed
*/
function signSPKAC($signatureAlgorithm = 'sha1WithRSAEncryption')
{
}
/**
* Sign a CRL
*
* $issuer's private key needs to be loaded.
*
* @param \phpseclib\File\X509 $issuer
* @param \phpseclib\File\X509 $crl
* @param string $signatureAlgorithm optional
* @access public
* @return mixed
*/
function signCRL($issuer, $crl, $signatureAlgorithm = 'sha1WithRSAEncryption')
{
}
/**
* X.509 certificate signing helper function.
*
* @param object $key
* @param \phpseclib\File\X509 $subject
* @param string $signatureAlgorithm
* @access public
* @return mixed
*/
function _sign($key, $signatureAlgorithm)
{
}
/**
* Set certificate start date
*
* @param string $date
* @access public
*/
function setStartDate($date)
{
}
/**
* Set certificate end date
*
* @param string $date
* @access public
*/
function setEndDate($date)
{
}
/**
* Set Serial Number
*
* @param string $serial
* @param $base optional
* @access public
*/
function setSerialNumber($serial, $base = -256)
{
}
/**
* Turns the certificate into a certificate authority
*
* @access public
*/
function makeCA()
{
}
/**
* Check for validity of subarray
*
* This is intended for use in conjunction with _subArrayUnchecked(),
* implementing the checks included in _subArray() but without copying
* a potentially large array by passing its reference by-value to is_array().
*
* @param array $root
* @param string $path
* @return boolean
* @access private
*/
function _isSubArrayValid($root, $path)
{
}
/**
* Get a reference to a subarray
*
* This variant of _subArray() does no is_array() checking,
* so $root should be checked with _isSubArrayValid() first.
*
* This is here for performance reasons:
* Passing a reference (i.e. $root) by-value (i.e. to is_array())
* creates a copy. If $root is an especially large array, this is expensive.
*
* @param array $root
* @param string $path absolute path with / as component separator
* @param bool $create optional
* @access private
* @return array|false
*/
function &_subArrayUnchecked(&$root, $path, $create = false)
{
}
/**
* Get a reference to a subarray
*
* @param array $root
* @param string $path absolute path with / as component separator
* @param bool $create optional
* @access private
* @return array|false
*/
function &_subArray(&$root, $path, $create = false)
{
}
/**
* Get a reference to an extension subarray
*
* @param array $root
* @param string $path optional absolute path with / as component separator
* @param bool $create optional
* @access private
* @return array|false
*/
function &_extensions(&$root, $path = null, $create = false)
{
}
/**
* Remove an Extension
*
* @param string $id
* @param string $path optional
* @access private
* @return bool
*/
function _removeExtension($id, $path = null)
{
}
/**
* Get an Extension
*
* Returns the extension if it exists and false if not
*
* @param string $id
* @param array $cert optional
* @param string $path optional
* @access private
* @return mixed
*/
function _getExtension($id, $cert = null, $path = null)
{
}
/**
* Returns a list of all extensions in use
*
* @param array $cert optional
* @param string $path optional
* @access private
* @return array
*/
function _getExtensions($cert = null, $path = null)
{
}
/**
* Set an Extension
*
* @param string $id
* @param mixed $value
* @param bool $critical optional
* @param bool $replace optional
* @param string $path optional
* @access private
* @return bool
*/
function _setExtension($id, $value, $critical = false, $replace = true, $path = null)
{
}
/**
* Remove a certificate, CSR or CRL Extension
*
* @param string $id
* @access public
* @return bool
*/
function removeExtension($id)
{
}
/**
* Get a certificate, CSR or CRL Extension
*
* Returns the extension if it exists and false if not
*
* @param string $id
* @param array $cert optional
* @access public
* @return mixed
*/
function getExtension($id, $cert = null)
{
}
/**
* Returns a list of all extensions in use in certificate, CSR or CRL
*
* @param array $cert optional
* @access public
* @return array
*/
function getExtensions($cert = null)
{
}
/**
* Set a certificate, CSR or CRL Extension
*
* @param string $id
* @param mixed $value
* @param bool $critical optional
* @param bool $replace optional
* @access public
* @return bool
*/
function setExtension($id, $value, $critical = false, $replace = true)
{
}
/**
* Remove a CSR attribute.
*
* @param string $id
* @param int $disposition optional
* @access public
* @return bool
*/
function removeAttribute($id, $disposition = self::ATTR_ALL)
{
}
/**
* Get a CSR attribute
*
* Returns the attribute if it exists and false if not
*
* @param string $id
* @param int $disposition optional
* @param array $csr optional
* @access public
* @return mixed
*/
function getAttribute($id, $disposition = self::ATTR_ALL, $csr = null)
{
}
/**
* Returns a list of all CSR attributes in use
*
* @param array $csr optional
* @access public
* @return array
*/
function getAttributes($csr = null)
{
}
/**
* Set a CSR attribute
*
* @param string $id
* @param mixed $value
* @param bool $disposition optional
* @access public
* @return bool
*/
function setAttribute($id, $value, $disposition = self::ATTR_ALL)
{
}
/**
* Sets the subject key identifier
*
* This is used by the id-ce-authorityKeyIdentifier and the id-ce-subjectKeyIdentifier extensions.
*
* @param string $value
* @access public
*/
function setKeyIdentifier($value)
{
}
/**
* Compute a public key identifier.
*
* Although key identifiers may be set to any unique value, this function
* computes key identifiers from public key according to the two
* recommended methods (4.2.1.2 RFC 3280).
* Highly polymorphic: try to accept all possible forms of key:
* - Key object
* - \phpseclib\File\X509 object with public or private key defined
* - Certificate or CSR array
* - \phpseclib\File\ASN1\Element object
* - PEM or DER string
*
* @param mixed $key optional
* @param int $method optional
* @access public
* @return string binary key identifier
*/
function computeKeyIdentifier($key = null, $method = 1)
{
}
/**
* Format a public key as appropriate
*
* @access private
* @return array
*/
function _formatSubjectPublicKey()
{
}
/**
* Set the domain name's which the cert is to be valid for
*
* @access public
* @return array
*/
function setDomain()
{
}
/**
* Set the IP Addresses's which the cert is to be valid for
*
* @access public
* @param string $ipAddress optional
*/
function setIPAddress()
{
}
/**
* Helper function to build domain array
*
* @access private
* @param string $domain
* @return array
*/
function _dnsName($domain)
{
}
/**
* Helper function to build IP Address array
*
* (IPv6 is not currently supported)
*
* @access private
* @param string $address
* @return array
*/
function _iPAddress($address)
{
}
/**
* Get the index of a revoked certificate.
*
* @param array $rclist
* @param string $serial
* @param bool $create optional
* @access private
* @return int|false
*/
function _revokedCertificate(&$rclist, $serial, $create = false)
{
}
/**
* Revoke a certificate.
*
* @param string $serial
* @param string $date optional
* @access public
* @return bool
*/
function revoke($serial, $date = null)
{
}
/**
* Unrevoke a certificate.
*
* @param string $serial
* @access public
* @return bool
*/
function unrevoke($serial)
{
}
/**
* Get a revoked certificate.
*
* @param string $serial
* @access public
* @return mixed
*/
function getRevoked($serial)
{
}
/**
* List revoked certificates
*
* @param array $crl optional
* @access public
* @return array
*/
function listRevoked($crl = null)
{
}
/**
* Remove a Revoked Certificate Extension
*
* @param string $serial
* @param string $id
* @access public
* @return bool
*/
function removeRevokedCertificateExtension($serial, $id)
{
}
/**
* Get a Revoked Certificate Extension
*
* Returns the extension if it exists and false if not
*
* @param string $serial
* @param string $id
* @param array $crl optional
* @access public
* @return mixed
*/
function getRevokedCertificateExtension($serial, $id, $crl = null)
{
}
/**
* Returns a list of all extensions in use for a given revoked certificate
*
* @param string $serial
* @param array $crl optional
* @access public
* @return array
*/
function getRevokedCertificateExtensions($serial, $crl = null)
{
}
/**
* Set a Revoked Certificate Extension
*
* @param string $serial
* @param string $id
* @param mixed $value
* @param bool $critical optional
* @param bool $replace optional
* @access public
* @return bool
*/
function setRevokedCertificateExtension($serial, $id, $value, $critical = false, $replace = true)
{
}
/**
* Extract raw BER from Base64 encoding
*
* @access private
* @param string $str
* @return string
*/
function _extractBER($str)
{
}
/**
* Returns the OID corresponding to a name
*
* What's returned in the associative array returned by loadX509() (or load*()) is either a name or an OID if
* no OID to name mapping is available. The problem with this is that what may be an unmapped OID in one version
* of phpseclib may not be unmapped in the next version, so apps that are looking at this OID may not be able
* to work from version to version.
*
* This method will return the OID if a name is passed to it and if no mapping is avialable it'll assume that
* what's being passed to it already is an OID and return that instead. A few examples.
*
* getOID('2.16.840.1.101.3.4.2.1') == '2.16.840.1.101.3.4.2.1'
* getOID('id-sha256') == '2.16.840.1.101.3.4.2.1'
* getOID('zzz') == 'zzz'
*
* @access public
* @return string
*/
function getOID($name)
{
}
}
/**
* Pure-PHP ANSI Decoder
*
* @package ANSI
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class ANSI
{
/**
* Max Width
*
* @var int
* @access private
*/
var $max_x;
/**
* Max Height
*
* @var int
* @access private
*/
var $max_y;
/**
* Max History
*
* @var int
* @access private
*/
var $max_history;
/**
* History
*
* @var array
* @access private
*/
var $history;
/**
* History Attributes
*
* @var array
* @access private
*/
var $history_attrs;
/**
* Current Column
*
* @var int
* @access private
*/
var $x;
/**
* Current Row
*
* @var int
* @access private
*/
var $y;
/**
* Old Column
*
* @var int
* @access private
*/
var $old_x;
/**
* Old Row
*
* @var int
* @access private
*/
var $old_y;
/**
* An empty attribute cell
*
* @var object
* @access private
*/
var $base_attr_cell;
/**
* The current attribute cell
*
* @var object
* @access private
*/
var $attr_cell;
/**
* An empty attribute row
*
* @var array
* @access private
*/
var $attr_row;
/**
* The current screen text
*
* @var array
* @access private
*/
var $screen;
/**
* The current screen attributes
*
* @var array
* @access private
*/
var $attrs;
/**
* Current ANSI code
*
* @var string
* @access private
*/
var $ansi;
/**
* Tokenization
*
* @var array
* @access private
*/
var $tokenization;
/**
* Default Constructor.
*
* @return \phpseclib\File\ANSI
* @access public
*/
function __construct()
{
}
/**
* Set terminal width and height
*
* Resets the screen as well
*
* @param int $x
* @param int $y
* @access public
*/
function setDimensions($x, $y)
{
}
/**
* Set the number of lines that should be logged past the terminal height
*
* @param int $x
* @param int $y
* @access public
*/
function setHistory($history)
{
}
/**
* Load a string
*
* @param string $source
* @access public
*/
function loadString($source)
{
}
/**
* Appdend a string
*
* @param string $source
* @access public
*/
function appendString($source)
{
}
/**
* Add a new line
*
* Also update the $this->screen and $this->history buffers
*
* @access private
*/
function _newLine()
{
}
/**
* Returns the current coordinate without preformating
*
* @access private
* @return string
*/
function _processCoordinate($last_attr, $cur_attr, $char)
{
}
/**
* Returns the current screen without preformating
*
* @access private
* @return string
*/
function _getScreen()
{
}
/**
* Returns the current screen
*
* @access public
* @return string
*/
function getScreen()
{
}
/**
* Returns the current screen and the x previous lines
*
* @access public
* @return string
*/
function getHistory()
{
}
}
}
namespace phpseclib\File\ASN1 {
/**
* ASN.1 Element
*
* Bypass normal encoding rules in phpseclib\File\ASN1::encodeDER()
*
* @package ASN1
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class Element
{
/**
* Raw element value
*
* @var string
* @access private
*/
var $element;
/**
* Constructor
*
* @param string $encoded
* @return \phpseclib\File\ASN1\Element
* @access public
*/
function __construct($encoded)
{
}
}
}
namespace phpseclib\File {
/**
* Pure-PHP ASN.1 Parser
*
* @package ASN1
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class ASN1
{
/**#@+
* Tag Classes
*
* @access private
* @link http://www.itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf#page=12
*/
const CLASS_UNIVERSAL = 0;
const CLASS_APPLICATION = 1;
const CLASS_CONTEXT_SPECIFIC = 2;
const CLASS_PRIVATE = 3;
/**#@-*/
/**#@+
* Tag Classes
*
* @access private
* @link http://www.obj-sys.com/asn1tutorial/node124.html
*/
const TYPE_BOOLEAN = 1;
const TYPE_INTEGER = 2;
const TYPE_BIT_STRING = 3;
const TYPE_OCTET_STRING = 4;
const TYPE_NULL = 5;
const TYPE_OBJECT_IDENTIFIER = 6;
//const TYPE_OBJECT_DESCRIPTOR = 7;
//const TYPE_INSTANCE_OF = 8; // EXTERNAL
const TYPE_REAL = 9;
const TYPE_ENUMERATED = 10;
//const TYPE_EMBEDDED = 11;
const TYPE_UTF8_STRING = 12;
//const TYPE_RELATIVE_OID = 13;
const TYPE_SEQUENCE = 16;
// SEQUENCE OF
const TYPE_SET = 17;
// SET OF
/**#@-*/
/**#@+
* More Tag Classes
*
* @access private
* @link http://www.obj-sys.com/asn1tutorial/node10.html
*/
const TYPE_NUMERIC_STRING = 18;
const TYPE_PRINTABLE_STRING = 19;
const TYPE_TELETEX_STRING = 20;
// T61String
const TYPE_VIDEOTEX_STRING = 21;
const TYPE_IA5_STRING = 22;
const TYPE_UTC_TIME = 23;
const TYPE_GENERALIZED_TIME = 24;
const TYPE_GRAPHIC_STRING = 25;
const TYPE_VISIBLE_STRING = 26;
// ISO646String
const TYPE_GENERAL_STRING = 27;
const TYPE_UNIVERSAL_STRING = 28;
//const TYPE_CHARACTER_STRING = 29;
const TYPE_BMP_STRING = 30;
/**#@-*/
/**#@+
* Tag Aliases
*
* These tags are kinda place holders for other tags.
*
* @access private
*/
const TYPE_CHOICE = -1;
const TYPE_ANY = -2;
/**#@-*/
/**
* ASN.1 object identifier
*
* @var array
* @access private
* @link http://en.wikipedia.org/wiki/Object_identifier
*/
var $oids = array();
/**
* Default date format
*
* @var string
* @access private
* @link http://php.net/class.datetime
*/
var $format = 'D, d M Y H:i:s O';
/**
* Default date format
*
* @var array
* @access private
* @see self::setTimeFormat()
* @see self::asn1map()
* @link http://php.net/class.datetime
*/
var $encoded;
/**
* Filters
*
* If the mapping type is self::TYPE_ANY what do we actually encode it as?
*
* @var array
* @access private
* @see self::_encode_der()
*/
var $filters;
/**
* Type mapping table for the ANY type.
*
* Structured or unknown types are mapped to a \phpseclib\File\ASN1\Element.
* Unambiguous types get the direct mapping (int/real/bool).
* Others are mapped as a choice, with an extra indexing level.
*
* @var array
* @access public
*/
var $ANYmap = array(
self::TYPE_BOOLEAN => true,
self::TYPE_INTEGER => true,
self::TYPE_BIT_STRING => 'bitString',
self::TYPE_OCTET_STRING => 'octetString',
self::TYPE_NULL => 'null',
self::TYPE_OBJECT_IDENTIFIER => 'objectIdentifier',
self::TYPE_REAL => true,
self::TYPE_ENUMERATED => 'enumerated',
self::TYPE_UTF8_STRING => 'utf8String',
self::TYPE_NUMERIC_STRING => 'numericString',
self::TYPE_PRINTABLE_STRING => 'printableString',
self::TYPE_TELETEX_STRING => 'teletexString',
self::TYPE_VIDEOTEX_STRING => 'videotexString',
self::TYPE_IA5_STRING => 'ia5String',
self::TYPE_UTC_TIME => 'utcTime',
self::TYPE_GENERALIZED_TIME => 'generalTime',
self::TYPE_GRAPHIC_STRING => 'graphicString',
self::TYPE_VISIBLE_STRING => 'visibleString',
self::TYPE_GENERAL_STRING => 'generalString',
self::TYPE_UNIVERSAL_STRING => 'universalString',
//self::TYPE_CHARACTER_STRING => 'characterString',
self::TYPE_BMP_STRING => 'bmpString',
);
/**
* String type to character size mapping table.
*
* Non-convertable types are absent from this table.
* size == 0 indicates variable length encoding.
*
* @var array
* @access public
*/
var $stringTypeSize = array(self::TYPE_UTF8_STRING => 0, self::TYPE_BMP_STRING => 2, self::TYPE_UNIVERSAL_STRING => 4, self::TYPE_PRINTABLE_STRING => 1, self::TYPE_TELETEX_STRING => 1, self::TYPE_IA5_STRING => 1, self::TYPE_VISIBLE_STRING => 1);
/**
* Parse BER-encoding
*
* Serves a similar purpose to openssl's asn1parse
*
* @param string $encoded
* @return array
* @access public
*/
function decodeBER($encoded)
{
}
/**
* Parse BER-encoding (Helper function)
*
* Sometimes we want to get the BER encoding of a particular tag. $start lets us do that without having to reencode.
* $encoded is passed by reference for the recursive calls done for self::TYPE_BIT_STRING and
* self::TYPE_OCTET_STRING. In those cases, the indefinite length is used.
*
* @param string $encoded
* @param int $start
* @param int $encoded_pos
* @return array
* @access private
*/
function _decode_ber($encoded, $start = 0, $encoded_pos = 0)
{
}
/**
* ASN.1 Map
*
* Provides an ASN.1 semantic mapping ($mapping) from a parsed BER-encoding to a human readable format.
*
* "Special" mappings may be applied on a per tag-name basis via $special.
*
* @param array $decoded
* @param array $mapping
* @param array $special
* @return array
* @access public
*/
function asn1map($decoded, $mapping, $special = array())
{
}
/**
* ASN.1 Encode
*
* DER-encodes an ASN.1 semantic mapping ($mapping). Some libraries would probably call this function
* an ASN.1 compiler.
*
* "Special" mappings can be applied via $special.
*
* @param string $source
* @param string $mapping
* @param int $idx
* @return string
* @access public
*/
function encodeDER($source, $mapping, $special = array())
{
}
/**
* ASN.1 Encode (Helper function)
*
* @param string $source
* @param string $mapping
* @param int $idx
* @return string
* @access private
*/
function _encode_der($source, $mapping, $idx = null, $special = array())
{
}
/**
* DER-encode the length
*
* DER supports lengths up to (2**8)**127, however, we'll only support lengths up to (2**8)**4. See
* {@link http://itu.int/ITU-T/studygroups/com17/languages/X.690-0207.pdf#p=13 X.690 paragraph 8.1.3} for more information.
*
* @access private
* @param int $length
* @return string
*/
function _encodeLength($length)
{
}
/**
* BER-decode the time
*
* Called by _decode_ber() and in the case of implicit tags asn1map().
*
* @access private
* @param string $content
* @param int $tag
* @return string
*/
function _decodeTime($content, $tag)
{
}
/**
* Set the time format
*
* Sets the time / date format for asn1map().
*
* @access public
* @param string $format
*/
function setTimeFormat($format)
{
}
/**
* Load OIDs
*
* Load the relevant OIDs for a particular ASN.1 semantic mapping.
*
* @access public
* @param array $oids
*/
function loadOIDs($oids)
{
}
/**
* Load filters
*
* See \phpseclib\File\X509, etc, for an example.
*
* @access public
* @param array $filters
*/
function loadFilters($filters)
{
}
/**
* String Shift
*
* Inspired by array_shift
*
* @param string $string
* @param int $index
* @return string
* @access private
*/
function _string_shift(&$string, $index = 1)
{
}
/**
* String type conversion
*
* This is a lazy conversion, dealing only with character size.
* No real conversion table is used.
*
* @param string $in
* @param int $from
* @param int $to
* @return string
* @access public
*/
function convert($in, $from = self::TYPE_UTF8_STRING, $to = self::TYPE_UTF8_STRING)
{
}
}
}
namespace phpseclib\System\SSH {
/**
* Pure-PHP ssh-agent client identity factory
*
* requestIdentities() method pumps out \phpseclib\System\SSH\Agent\Identity objects
*
* @package SSH\Agent
* @author Jim Wigginton <terrafrost@php.net>
* @access internal
*/
class Agent
{
/**#@+
* Message numbers
*
* @access private
*/
// to request SSH1 keys you have to use SSH_AGENTC_REQUEST_RSA_IDENTITIES (1)
const SSH_AGENTC_REQUEST_IDENTITIES = 11;
// this is the SSH2 response; the SSH1 response is SSH_AGENT_RSA_IDENTITIES_ANSWER (2).
const SSH_AGENT_IDENTITIES_ANSWER = 12;
// the SSH1 request is SSH_AGENTC_RSA_CHALLENGE (3)
const SSH_AGENTC_SIGN_REQUEST = 13;
// the SSH1 response is SSH_AGENT_RSA_RESPONSE (4)
const SSH_AGENT_SIGN_RESPONSE = 14;
/**#@-*/
/**@+
* Agent forwarding status
*
* @access private
*/
// no forwarding requested and not active
const FORWARD_NONE = 0;
// request agent forwarding when opportune
const FORWARD_REQUEST = 1;
// forwarding has been request and is active
const FORWARD_ACTIVE = 2;
/**#@-*/
/**
* Unused
*/
const SSH_AGENT_FAILURE = 5;
/**
* Socket Resource
*
* @var resource
* @access private
*/
var $fsock;
/**
* Agent forwarding status
*
* @access private
*/
var $forward_status = self::FORWARD_NONE;
/**
* Buffer for accumulating forwarded authentication
* agent data arriving on SSH data channel destined
* for agent unix socket
*
* @access private
*/
var $socket_buffer = '';
/**
* Tracking the number of bytes we are expecting
* to arrive for the agent socket on the SSH data
* channel
*/
var $expected_bytes = 0;
/**
* Default Constructor
*
* @return \phpseclib\System\SSH\Agent
* @access public
*/
function __construct()
{
}
/**
* Request Identities
*
* See "2.5.2 Requesting a list of protocol 2 keys"
* Returns an array containing zero or more \phpseclib\System\SSH\Agent\Identity objects
*
* @return array
* @access public
*/
function requestIdentities()
{
}
/**
* Signal that agent forwarding should
* be requested when a channel is opened
*
* @param Net_SSH2 $ssh
* @return bool
* @access public
*/
function startSSHForwarding($ssh)
{
}
/**
* Request agent forwarding of remote server
*
* @param Net_SSH2 $ssh
* @return bool
* @access private
*/
function _request_forwarding($ssh)
{
}
/**
* On successful channel open
*
* This method is called upon successful channel
* open to give the SSH Agent an opportunity
* to take further action. i.e. request agent forwarding
*
* @param Net_SSH2 $ssh
* @access private
*/
function _on_channel_open($ssh)
{
}
/**
* Forward data to SSH Agent and return data reply
*
* @param string $data
* @return data from SSH Agent
* @access private
*/
function _forward_data($data)
{
}
}
}
namespace phpseclib\System\SSH\Agent {
/**
* Pure-PHP ssh-agent client identity object
*
* Instantiation should only be performed by \phpseclib\System\SSH\Agent class.
* This could be thought of as implementing an interface that phpseclib\Crypt\RSA
* implements. ie. maybe a Net_SSH_Auth_PublicKey interface or something.
* The methods in this interface would be getPublicKey and sign since those are the
* methods phpseclib looks for to perform public key authentication.
*
* @package SSH\Agent
* @author Jim Wigginton <terrafrost@php.net>
* @access internal
*/
class Identity
{
/**
* Key Object
*
* @var \phpseclib\Crypt\RSA
* @access private
* @see self::getPublicKey()
*/
var $key;
/**
* Key Blob
*
* @var string
* @access private
* @see self::sign()
*/
var $key_blob;
/**
* Socket Resource
*
* @var resource
* @access private
* @see self::sign()
*/
var $fsock;
/**
* Default Constructor.
*
* @param resource $fsock
* @return \phpseclib\System\SSH\Agent\Identity
* @access private
*/
function __construct($fsock)
{
}
/**
* Set Public Key
*
* Called by \phpseclib\System\SSH\Agent::requestIdentities()
*
* @param \phpseclib\Crypt\RSA $key
* @access private
*/
function setPublicKey($key)
{
}
/**
* Set Public Key
*
* Called by \phpseclib\System\SSH\Agent::requestIdentities(). The key blob could be extracted from $this->key
* but this saves a small amount of computation.
*
* @param string $key_blob
* @access private
*/
function setPublicKeyBlob($key_blob)
{
}
/**
* Get Public Key
*
* Wrapper for $this->key->getPublicKey()
*
* @param int $format optional
* @return mixed
* @access public
*/
function getPublicKey($format = null)
{
}
/**
* Set Signature Mode
*
* Doesn't do anything as ssh-agent doesn't let you pick and choose the signature mode. ie.
* ssh-agent's only supported mode is \phpseclib\Crypt\RSA::SIGNATURE_PKCS1
*
* @param int $mode
* @access public
*/
function setSignatureMode($mode)
{
}
/**
* Create a signature
*
* See "2.6.2 Protocol 2 private key signature request"
*
* @param string $message
* @return string
* @access public
*/
function sign($message)
{
}
}
}
namespace {
/**
* mcrypt_compat stream filter
*
* @author Jim Wigginton <terrafrost@php.net>
* @access public
*/
class phpseclib_mcrypt_filter extends \php_user_filter
{
/**
* Called when applying the filter
*
* This method is called whenever data is read from or written to the attached stream
* (such as with fread() or fwrite()).
*
* @param resource $in
* @param resource $out
* @param int $consumed
* @param bool $closing
* @link http://php.net/manual/en/php-user-filter.filter.php
* @return int
* @access public
*/
public function filter($in, $out, &$consumed, $closing)
{
}
/**
* Called when creating the filter
*
* This method is called during instantiation of the filter class object.
* If your filter allocates or initializes any other resources (such as a buffer),
* this is the place to do it.
*
* @link http://php.net/manual/en/php-user-filter.oncreate.php
* @return bool
* @access public
*/
public function onCreate()
{
}
}
}
namespace Interop\Http\ServerMiddleware {
interface MiddlewareInterface
{
/**
* Process an incoming server request and return a response, optionally delegating
* to the next middleware component to create the response.
*
* @param ServerRequestInterface $request
* @param DelegateInterface $delegate
*
* @return ResponseInterface
*/
public function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate);
}
interface DelegateInterface
{
/**
* Dispatch the next available middleware and return the response.
*
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function process(\Psr\Http\Message\ServerRequestInterface $request);
}
}
namespace Interop\Http\Factory {
interface RequestFactoryInterface
{
/**
* Create a new request.
*
* @param string $method
* @param UriInterface|string $uri
*
* @return RequestInterface
*/
public function createRequest($method, $uri);
}
interface ServerRequestFactoryInterface
{
/**
* Create a new server request.
*
* The method and URI of the request SHOULD be derived from the given
* server parameters.
*
* If the method or URI parameter is passed, these values MUST be used
* instead of the server parameters.
*
* @param array $server
* @param string|null $method
* @param UriInterface|string|null $uri
*
* @throws \InvalidArgumentException
* If no valid method or URI can be determined.
*
* @return ServerRequestInterface
*/
public function createServerRequest(array $server, $method = null, $uri = null);
}
interface ResponseFactoryInterface
{
/**
* Create a new response.
*
* @param integer $code HTTP status code
*
* @return ResponseInterface
*/
public function createResponse($code = 200);
}
interface UploadedFileFactoryInterface
{
/**
* Create a new uploaded file.
*
* If a string is used to create the file, a temporary resource will be
* created with the content of the string.
*
* If a size is not provided it will be determined by checking the size of
* the file.
*
* @see http://php.net/manual/features.file-upload.post-method.php
* @see http://php.net/manual/features.file-upload.errors.php
*
* @param string|resource $file
* @param integer $size in bytes
* @param integer $error PHP file upload error
* @param string $clientFilename
* @param string $clientMediaType
*
* @return UploadedFileInterface
*
* @throws \InvalidArgumentException
* If the file resource is not readable.
*/
public function createUploadedFile($file, $size = null, $error = \UPLOAD_ERR_OK, $clientFilename = null, $clientMediaType = null);
}
interface UriFactoryInterface
{
/**
* Create a new URI.
*
* @param string $uri
*
* @return UriInterface
*
* @throws \InvalidArgumentException
* If the given URI cannot be parsed.
*/
public function createUri($uri = '');
}
interface StreamFactoryInterface
{
/**
* Create a new stream from a string.
*
* The stream SHOULD be created with a temporary resource.
*
* @param string $content
*
* @return StreamInterface
*/
public function createStream($content = '');
/**
* Create a stream from an existing file.
*
* The file MUST be opened using the given mode, which may be any mode
* supported by the `fopen` function.
*
* @param string $file
* @param string $mode
*
* @return StreamInterface
*/
public function createStreamFromFile($file, $mode = 'r');
/**
* Create a new stream from an existing resource.
*
* The stream MUST be readable and may be writable.
*
* @param resource $resource
*
* @return StreamInterface
*/
public function createStreamFromResource($resource);
}
}
namespace League\Flysystem {
class RootViolationException extends \LogicException
{
//
}
}
namespace League\Flysystem\Plugin {
trait PluggableTrait
{
/**
* @var array
*/
protected $plugins = [];
/**
* Register a plugin.
*
* @param PluginInterface $plugin
*
* @throws LogicException
*
* @return $this
*/
public function addPlugin(\League\Flysystem\PluginInterface $plugin)
{
}
/**
* Find a specific plugin.
*
* @param string $method
*
* @throws PluginNotFoundException
*
* @return PluginInterface
*/
protected function findPlugin($method)
{
}
/**
* Invoke a plugin by method name.
*
* @param string $method
* @param array $arguments
* @param FilesystemInterface $filesystem
*
* @throws PluginNotFoundException
*
* @return mixed
*/
protected function invokePlugin($method, array $arguments, \League\Flysystem\FilesystemInterface $filesystem)
{
}
/**
* Plugins pass-through.
*
* @param string $method
* @param array $arguments
*
* @throws BadMethodCallException
*
* @return mixed
*/
public function __call($method, array $arguments)
{
}
}
}
namespace League\Flysystem {
/**
* Class MountManager.
*
* Proxies methods to Filesystem (@see __call):
*
* @method AdapterInterface getAdapter($prefix)
* @method Config getConfig($prefix)
* @method bool has($path)
* @method bool write($path, $contents, array $config = [])
* @method bool writeStream($path, $resource, array $config = [])
* @method bool put($path, $contents, $config = [])
* @method bool putStream($path, $contents, $config = [])
* @method string readAndDelete($path)
* @method bool update($path, $contents, $config = [])
* @method bool updateStream($path, $resource, $config = [])
* @method string|false read($path)
* @method resource|false readStream($path)
* @method bool rename($path, $newpath)
* @method bool delete($path)
* @method bool deleteDir($dirname)
* @method bool createDir($dirname, $config = [])
* @method array listFiles($directory = '', $recursive = false)
* @method array listPaths($directory = '', $recursive = false)
* @method array getWithMetadata($path, array $metadata)
* @method string|false getMimetype($path)
* @method int|false getTimestamp($path)
* @method string|false getVisibility($path)
* @method int|false getSize($path);
* @method bool setVisibility($path, $visibility)
* @method array|false getMetadata($path)
* @method Handler get($path, Handler $handler = null)
* @method Filesystem flushCache()
* @method void assertPresent($path)
* @method void assertAbsent($path)
* @method Filesystem addPlugin(PluginInterface $plugin)
*/
class MountManager
{
use \League\Flysystem\Plugin\PluggableTrait;
/**
* @var FilesystemInterface[]
*/
protected $filesystems = [];
/**
* Constructor.
*
* @param FilesystemInterface[] $filesystems [:prefix => Filesystem,]
*
* @throws InvalidArgumentException
*/
public function __construct(array $filesystems = [])
{
}
/**
* Mount filesystems.
*
* @param FilesystemInterface[] $filesystems [:prefix => Filesystem,]
*
* @throws InvalidArgumentException
*
* @return $this
*/
public function mountFilesystems(array $filesystems)
{
}
/**
* Mount filesystems.
*
* @param string $prefix
* @param FilesystemInterface $filesystem
*
* @throws InvalidArgumentException
*
* @return $this
*/
public function mountFilesystem($prefix, \League\Flysystem\FilesystemInterface $filesystem)
{
}
/**
* Get the filesystem with the corresponding prefix.
*
* @param string $prefix
*
* @throws FilesystemNotFoundException
*
* @return FilesystemInterface
*/
public function getFilesystem($prefix)
{
}
/**
* Retrieve the prefix from an arguments array.
*
* @param array $arguments
*
* @throws InvalidArgumentException
*
* @return array [:prefix, :arguments]
*/
public function filterPrefix(array $arguments)
{
}
/**
* @param string $directory
* @param bool $recursive
*
* @throws InvalidArgumentException
* @throws FilesystemNotFoundException
*
* @return array
*/
public function listContents($directory = '', $recursive = false)
{
}
/**
* Call forwarder.
*
* @param string $method
* @param array $arguments
*
* @throws InvalidArgumentException
* @throws FilesystemNotFoundException
*
* @return mixed
*/
public function __call($method, $arguments)
{
}
/**
* @param string $from
* @param string $to
* @param array $config
*
* @throws InvalidArgumentException
* @throws FilesystemNotFoundException
*
* @return bool
*/
public function copy($from, $to, array $config = [])
{
}
/**
* List with plugin adapter.
*
* @param array $keys
* @param string $directory
* @param bool $recursive
*
* @throws InvalidArgumentException
* @throws FilesystemNotFoundException
*
* @return array
*/
public function listWith(array $keys = [], $directory = '', $recursive = false)
{
}
/**
* Move a file.
*
* @param string $from
* @param string $to
* @param array $config
*
* @throws InvalidArgumentException
* @throws FilesystemNotFoundException
*
* @return bool
*/
public function move($from, $to, array $config = [])
{
}
/**
* Invoke a plugin on a filesystem mounted on a given prefix.
*
* @param string $method
* @param array $arguments
* @param string $prefix
*
* @throws FilesystemNotFoundException
*
* @return mixed
*/
public function invokePluginOnFilesystem($method, $arguments, $prefix)
{
}
/**
* @param string $path
*
* @throws InvalidArgumentException
*
* @return string[] [:prefix, :path]
*/
protected function getPrefixAndPath($path)
{
}
}
/**
* @deprecated
*/
abstract class Handler
{
/**
* @var string
*/
protected $path;
/**
* @var FilesystemInterface
*/
protected $filesystem;
/**
* Constructor.
*
* @param FilesystemInterface $filesystem
* @param string $path
*/
public function __construct(\League\Flysystem\FilesystemInterface $filesystem = null, $path = null)
{
}
/**
* Check whether the entree is a directory.
*
* @return bool
*/
public function isDir()
{
}
/**
* Check whether the entree is a file.
*
* @return bool
*/
public function isFile()
{
}
/**
* Retrieve the entree type (file|dir).
*
* @return string file or dir
*/
public function getType()
{
}
/**
* Set the Filesystem object.
*
* @param FilesystemInterface $filesystem
*
* @return $this
*/
public function setFilesystem(\League\Flysystem\FilesystemInterface $filesystem)
{
}
/**
* Retrieve the Filesystem object.
*
* @return FilesystemInterface
*/
public function getFilesystem()
{
}
/**
* Set the entree path.
*
* @param string $path
*
* @return $this
*/
public function setPath($path)
{
}
/**
* Retrieve the entree path.
*
* @return string path
*/
public function getPath()
{
}
/**
* Plugins pass-through.
*
* @param string $method
* @param array $arguments
*
* @return mixed
*/
public function __call($method, array $arguments)
{
}
}
/**
* @deprecated
*/
class Directory extends \League\Flysystem\Handler
{
/**
* Delete the directory.
*
* @return bool
*/
public function delete()
{
}
/**
* List the directory contents.
*
* @param bool $recursive
*
* @return array|bool directory contents or false
*/
public function getContents($recursive = false)
{
}
}
class Exception extends \Exception
{
//
}
class FileNotFoundException extends \League\Flysystem\Exception
{
/**
* @var string
*/
protected $path;
/**
* Constructor.
*
* @param string $path
* @param int $code
* @param \Exception $previous
*/
public function __construct($path, $code = 0, \Exception $previous = null)
{
}
/**
* Get the path which was not found.
*
* @return string
*/
public function getPath()
{
}
}
/**
* @internal
*/
trait ConfigAwareTrait
{
/**
* @var Config
*/
protected $config;
/**
* Set the config.
*
* @param Config|array|null $config
*/
protected function setConfig($config)
{
}
/**
* Get the Config.
*
* @return Config config object
*/
public function getConfig()
{
}
/**
* Convert a config array to a Config object with the correct fallback.
*
* @param array $config
*
* @return Config
*/
protected function prepareConfig(array $config)
{
}
}
class FileExistsException extends \League\Flysystem\Exception
{
/**
* @var string
*/
protected $path;
/**
* Constructor.
*
* @param string $path
* @param int $code
* @param BaseException $previous
*/
public function __construct($path, $code = 0, \Exception $previous = null)
{
}
/**
* Get the path which was found.
*
* @return string
*/
public function getPath()
{
}
}
class Config
{
/**
* @var array
*/
protected $settings = [];
/**
* @var Config
*/
protected $fallback;
/**
* Constructor.
*
* @param array $settings
*/
public function __construct(array $settings = [])
{
}
/**
* Get a setting.
*
* @param string $key
* @param mixed $default
*
* @return mixed config setting or default when not found
*/
public function get($key, $default = null)
{
}
/**
* Check if an item exists by key.
*
* @param string $key
*
* @return bool
*/
public function has($key)
{
}
/**
* Try to retrieve a default setting from a config fallback.
*
* @param string $key
* @param mixed $default
*
* @return mixed config setting or default when not found
*/
protected function getDefault($key, $default)
{
}
/**
* Set a setting.
*
* @param string $key
* @param mixed $value
*
* @return $this
*/
public function set($key, $value)
{
}
/**
* Set the fallback.
*
* @param Config $fallback
*
* @return $this
*/
public function setFallback(\League\Flysystem\Config $fallback)
{
}
}
interface FilesystemInterface
{
/**
* Check whether a file exists.
*
* @param string $path
*
* @return bool
*/
public function has($path);
/**
* Read a file.
*
* @param string $path The path to the file.
*
* @throws FileNotFoundException
*
* @return string|false The file contents or false on failure.
*/
public function read($path);
/**
* Retrieves a read-stream for a path.
*
* @param string $path The path to the file.
*
* @throws FileNotFoundException
*
* @return resource|false The path resource or false on failure.
*/
public function readStream($path);
/**
* List contents of a directory.
*
* @param string $directory The directory to list.
* @param bool $recursive Whether to list recursively.
*
* @return array A list of file metadata.
*/
public function listContents($directory = '', $recursive = false);
/**
* Get a file's metadata.
*
* @param string $path The path to the file.
*
* @throws FileNotFoundException
*
* @return array|false The file metadata or false on failure.
*/
public function getMetadata($path);
/**
* Get a file's size.
*
* @param string $path The path to the file.
*
* @throws FileNotFoundException
*
* @return int|false The file size or false on failure.
*/
public function getSize($path);
/**
* Get a file's mime-type.
*
* @param string $path The path to the file.
*
* @throws FileNotFoundException
*
* @return string|false The file mime-type or false on failure.
*/
public function getMimetype($path);
/**
* Get a file's timestamp.
*
* @param string $path The path to the file.
*
* @throws FileNotFoundException
*
* @return string|false The timestamp or false on failure.
*/
public function getTimestamp($path);
/**
* Get a file's visibility.
*
* @param string $path The path to the file.
*
* @throws FileNotFoundException
*
* @return string|false The visibility (public|private) or false on failure.
*/
public function getVisibility($path);
/**
* Write a new file.
*
* @param string $path The path of the new file.
* @param string $contents The file contents.
* @param array $config An optional configuration array.
*
* @throws FileExistsException
*
* @return bool True on success, false on failure.
*/
public function write($path, $contents, array $config = []);
/**
* Write a new file using a stream.
*
* @param string $path The path of the new file.
* @param resource $resource The file handle.
* @param array $config An optional configuration array.
*
* @throws InvalidArgumentException If $resource is not a file handle.
* @throws FileExistsException
*
* @return bool True on success, false on failure.
*/
public function writeStream($path, $resource, array $config = []);
/**
* Update an existing file.
*
* @param string $path The path of the existing file.
* @param string $contents The file contents.
* @param array $config An optional configuration array.
*
* @throws FileNotFoundException
*
* @return bool True on success, false on failure.
*/
public function update($path, $contents, array $config = []);
/**
* Update an existing file using a stream.
*
* @param string $path The path of the existing file.
* @param resource $resource The file handle.
* @param array $config An optional configuration array.
*
* @throws InvalidArgumentException If $resource is not a file handle.
* @throws FileNotFoundException
*
* @return bool True on success, false on failure.
*/
public function updateStream($path, $resource, array $config = []);
/**
* Rename a file.
*
* @param string $path Path to the existing file.
* @param string $newpath The new path of the file.
*
* @throws FileExistsException Thrown if $newpath exists.
* @throws FileNotFoundException Thrown if $path does not exist.
*
* @return bool True on success, false on failure.
*/
public function rename($path, $newpath);
/**
* Copy a file.
*
* @param string $path Path to the existing file.
* @param string $newpath The new path of the file.
*
* @throws FileExistsException Thrown if $newpath exists.
* @throws FileNotFoundException Thrown if $path does not exist.
*
* @return bool True on success, false on failure.
*/
public function copy($path, $newpath);
/**
* Delete a file.
*
* @param string $path
*
* @throws FileNotFoundException
*
* @return bool True on success, false on failure.
*/
public function delete($path);
/**
* Delete a directory.
*
* @param string $dirname
*
* @throws RootViolationException Thrown if $dirname is empty.
*
* @return bool True on success, false on failure.
*/
public function deleteDir($dirname);
/**
* Create a directory.
*
* @param string $dirname The name of the new directory.
* @param array $config An optional configuration array.
*
* @return bool True on success, false on failure.
*/
public function createDir($dirname, array $config = []);
/**
* Set the visibility for a file.
*
* @param string $path The path to the file.
* @param string $visibility One of 'public' or 'private'.
*
* @throws FileNotFoundException
*
* @return bool True on success, false on failure.
*/
public function setVisibility($path, $visibility);
/**
* Create a file or update if exists.
*
* @param string $path The path to the file.
* @param string $contents The file contents.
* @param array $config An optional configuration array.
*
* @return bool True on success, false on failure.
*/
public function put($path, $contents, array $config = []);
/**
* Create a file or update if exists.
*
* @param string $path The path to the file.
* @param resource $resource The file handle.
* @param array $config An optional configuration array.
*
* @throws InvalidArgumentException Thrown if $resource is not a resource.
*
* @return bool True on success, false on failure.
*/
public function putStream($path, $resource, array $config = []);
/**
* Read and delete a file.
*
* @param string $path The path to the file.
*
* @throws FileNotFoundException
*
* @return string|false The file contents, or false on failure.
*/
public function readAndDelete($path);
/**
* Get a file/directory handler.
*
* @deprecated
*
* @param string $path The path to the file.
* @param Handler $handler An optional existing handler to populate.
*
* @return Handler Either a file or directory handler.
*/
public function get($path, \League\Flysystem\Handler $handler = null);
/**
* Register a plugin.
*
* @param PluginInterface $plugin The plugin to register.
*
* @return $this
*/
public function addPlugin(\League\Flysystem\PluginInterface $plugin);
}
interface ReadInterface
{
/**
* Check whether a file exists.
*
* @param string $path
*
* @return array|bool|null
*/
public function has($path);
/**
* Read a file.
*
* @param string $path
*
* @return array|false
*/
public function read($path);
/**
* Read a file as a stream.
*
* @param string $path
*
* @return array|false
*/
public function readStream($path);
/**
* List contents of a directory.
*
* @param string $directory
* @param bool $recursive
*
* @return array
*/
public function listContents($directory = '', $recursive = false);
/**
* Get all the meta data of a file or directory.
*
* @param string $path
*
* @return array|false
*/
public function getMetadata($path);
/**
* Get the size of a file.
*
* @param string $path
*
* @return array|false
*/
public function getSize($path);
/**
* Get the mimetype of a file.
*
* @param string $path
*
* @return array|false
*/
public function getMimetype($path);
/**
* Get the last modified time of a file as a timestamp.
*
* @param string $path
*
* @return array|false
*/
public function getTimestamp($path);
/**
* Get the visibility of a file.
*
* @param string $path
*
* @return array|false
*/
public function getVisibility($path);
}
interface AdapterInterface extends \League\Flysystem\ReadInterface
{
/**
* @const VISIBILITY_PUBLIC public visibility
*/
const VISIBILITY_PUBLIC = 'public';
/**
* @const VISIBILITY_PRIVATE private visibility
*/
const VISIBILITY_PRIVATE = 'private';
/**
* Write a new file.
*
* @param string $path
* @param string $contents
* @param Config $config Config object
*
* @return array|false false on failure file meta data on success
*/
public function write($path, $contents, \League\Flysystem\Config $config);
/**
* Write a new file using a stream.
*
* @param string $path
* @param resource $resource
* @param Config $config Config object
*
* @return array|false false on failure file meta data on success
*/
public function writeStream($path, $resource, \League\Flysystem\Config $config);
/**
* Update a file.
*
* @param string $path
* @param string $contents
* @param Config $config Config object
*
* @return array|false false on failure file meta data on success
*/
public function update($path, $contents, \League\Flysystem\Config $config);
/**
* Update a file using a stream.
*
* @param string $path
* @param resource $resource
* @param Config $config Config object
*
* @return array|false false on failure file meta data on success
*/
public function updateStream($path, $resource, \League\Flysystem\Config $config);
/**
* Rename a file.
*
* @param string $path
* @param string $newpath
*
* @return bool
*/
public function rename($path, $newpath);
/**
* Copy a file.
*
* @param string $path
* @param string $newpath
*
* @return bool
*/
public function copy($path, $newpath);
/**
* Delete a file.
*
* @param string $path
*
* @return bool
*/
public function delete($path);
/**
* Delete a directory.
*
* @param string $dirname
*
* @return bool
*/
public function deleteDir($dirname);
/**
* Create a directory.
*
* @param string $dirname directory name
* @param Config $config
*
* @return array|false
*/
public function createDir($dirname, \League\Flysystem\Config $config);
/**
* Set the visibility for a file.
*
* @param string $path
* @param string $visibility
*
* @return array|false file meta data
*/
public function setVisibility($path, $visibility);
}
interface PluginInterface
{
/**
* Get the method name.
*
* @return string
*/
public function getMethod();
/**
* Set the Filesystem object.
*
* @param FilesystemInterface $filesystem
*/
public function setFilesystem(\League\Flysystem\FilesystemInterface $filesystem);
}
class Util
{
/**
* Get normalized pathinfo.
*
* @param string $path
*
* @return array pathinfo
*/
public static function pathinfo($path)
{
}
/**
* Normalize a dirname return value.
*
* @param string $dirname
*
* @return string normalized dirname
*/
public static function normalizeDirname($dirname)
{
}
/**
* Get a normalized dirname from a path.
*
* @param string $path
*
* @return string dirname
*/
public static function dirname($path)
{
}
/**
* Map result arrays.
*
* @param array $object
* @param array $map
*
* @return array mapped result
*/
public static function map(array $object, array $map)
{
}
/**
* Normalize path.
*
* @param string $path
*
* @throws LogicException
*
* @return string
*/
public static function normalizePath($path)
{
}
/**
* Normalize relative directories in a path.
*
* @param string $path
*
* @throws LogicException
*
* @return string
*/
public static function normalizeRelativePath($path)
{
}
/**
* Removes unprintable characters and invalid unicode characters.
*
* @param string $path
*
* @return string $path
*/
protected static function removeFunkyWhiteSpace($path)
{
}
/**
* Normalize prefix.
*
* @param string $prefix
* @param string $separator
*
* @return string normalized path
*/
public static function normalizePrefix($prefix, $separator)
{
}
/**
* Get content size.
*
* @param string $contents
*
* @return int content size
*/
public static function contentSize($contents)
{
}
/**
* Guess MIME Type based on the path of the file and it's content.
*
* @param string $path
* @param string|resource $content
*
* @return string|null MIME Type or NULL if no extension detected
*/
public static function guessMimeType($path, $content)
{
}
/**
* Emulate directories.
*
* @param array $listing
*
* @return array listing with emulated directories
*/
public static function emulateDirectories(array $listing)
{
}
/**
* Ensure a Config instance.
*
* @param null|array|Config $config
*
* @return Config config instance
*
* @throw LogicException
*/
public static function ensureConfig($config)
{
}
/**
* Rewind a stream.
*
* @param resource $resource
*/
public static function rewindStream($resource)
{
}
public static function isSeekableStream($resource)
{
}
/**
* Get the size of a stream.
*
* @param resource $resource
*
* @return int stream size
*/
public static function getStreamSize($resource)
{
}
/**
* Emulate the directories of a single object.
*
* @param array $object
* @param array $directories
* @param array $listedDirectories
*
* @return array
*/
protected static function emulateObjectDirectories(array $object, array $directories, array $listedDirectories)
{
}
}
}
namespace League\Flysystem\Util {
/**
* @internal
*/
class ContentListingFormatter
{
/**
* @param string $directory
* @param bool $recursive
*/
public function __construct($directory, $recursive)
{
}
/**
* Format contents listing.
*
* @param array $listing
*
* @return array
*/
public function formatListing(array $listing)
{
}
}
class StreamHasher
{
/**
* StreamHasher constructor.
*
* @param string $algo
*/
public function __construct($algo)
{
}
/**
* @param resource $resource
*
* @return string
*/
public function hash($resource)
{
}
}
/**
* @internal
*/
class MimeType
{
/**
* Detects MIME Type based on given content.
*
* @param mixed $content
*
* @return string|null MIME Type or NULL if no mime type detected
*/
public static function detectByContent($content)
{
}
// @codeCoverageIgnoreEnd
/**
* Detects MIME Type based on file extension.
*
* @param string $extension
*
* @return string|null MIME Type or NULL if no extension detected
*/
public static function detectByFileExtension($extension)
{
}
/**
* @param string $filename
*
* @return string|null MIME Type or NULL if no extension detected
*/
public static function detectByFilename($filename)
{
}
/**
* @return array Map of file extension to MIME Type
*/
public static function getExtensionToMimeTypeMap()
{
}
}
}
namespace League\Flysystem {
class NotSupportedException extends \RuntimeException
{
/**
* Create a new exception for a link.
*
* @param SplFileInfo $file
*
* @return static
*/
public static function forLink(\SplFileInfo $file)
{
}
/**
* Create a new exception for a link.
*
* @param string $systemType
*
* @return static
*/
public static function forFtpSystemType($systemType)
{
}
}
class UnreadableFileException extends \League\Flysystem\Exception
{
public static function forFileInfo(\SplFileInfo $fileInfo)
{
}
}
/**
* @method array getWithMetadata(string $path, array $metadata)
* @method bool forceCopy(string $path, string $newpath)
* @method bool forceRename(string $path, string $newpath)
* @method array listFiles(string $path = '', boolean $recursive = false)
* @method array listPaths(string $path = '', boolean $recursive = false)
* @method array listWith(array $keys = [], $directory = '', $recursive = false)
*/
class Filesystem implements \League\Flysystem\FilesystemInterface
{
use \League\Flysystem\Plugin\PluggableTrait;
use \League\Flysystem\ConfigAwareTrait;
/**
* @var AdapterInterface
*/
protected $adapter;
/**
* Constructor.
*
* @param AdapterInterface $adapter
* @param Config|array $config
*/
public function __construct(\League\Flysystem\AdapterInterface $adapter, $config = null)
{
}
/**
* Get the Adapter.
*
* @return AdapterInterface adapter
*/
public function getAdapter()
{
}
/**
* @inheritdoc
*/
public function has($path)
{
}
/**
* @inheritdoc
*/
public function write($path, $contents, array $config = [])
{
}
/**
* @inheritdoc
*/
public function writeStream($path, $resource, array $config = [])
{
}
/**
* @inheritdoc
*/
public function put($path, $contents, array $config = [])
{
}
/**
* @inheritdoc
*/
public function putStream($path, $resource, array $config = [])
{
}
/**
* @inheritdoc
*/
public function readAndDelete($path)
{
}
/**
* @inheritdoc
*/
public function update($path, $contents, array $config = [])
{
}
/**
* @inheritdoc
*/
public function updateStream($path, $resource, array $config = [])
{
}
/**
* @inheritdoc
*/
public function read($path)
{
}
/**
* @inheritdoc
*/
public function readStream($path)
{
}
/**
* @inheritdoc
*/
public function rename($path, $newpath)
{
}
/**
* @inheritdoc
*/
public function copy($path, $newpath)
{
}
/**
* @inheritdoc
*/
public function delete($path)
{
}
/**
* @inheritdoc
*/
public function deleteDir($dirname)
{
}
/**
* @inheritdoc
*/
public function createDir($dirname, array $config = [])
{
}
/**
* @inheritdoc
*/
public function listContents($directory = '', $recursive = false)
{
}
/**
* @inheritdoc
*/
public function getMimetype($path)
{
}
/**
* @inheritdoc
*/
public function getTimestamp($path)
{
}
/**
* @inheritdoc
*/
public function getVisibility($path)
{
}
/**
* @inheritdoc
*/
public function getSize($path)
{
}
/**
* @inheritdoc
*/
public function setVisibility($path, $visibility)
{
}
/**
* @inheritdoc
*/
public function getMetadata($path)
{
}
/**
* @inheritdoc
*/
public function get($path, \League\Flysystem\Handler $handler = null)
{
}
/**
* Assert a file is present.
*
* @param string $path path to file
*
* @throws FileNotFoundException
*
* @return void
*/
public function assertPresent($path)
{
}
/**
* Assert a file is absent.
*
* @param string $path path to file
*
* @throws FileExistsException
*
* @return void
*/
public function assertAbsent($path)
{
}
}
}
namespace League\Flysystem\Adapter {
abstract class AbstractAdapter implements \League\Flysystem\AdapterInterface
{
/**
* @var string|null path prefix
*/
protected $pathPrefix;
/**
* @var string
*/
protected $pathSeparator = '/';
/**
* Set the path prefix.
*
* @param string $prefix
*
* @return void
*/
public function setPathPrefix($prefix)
{
}
/**
* Get the path prefix.
*
* @return string|null path prefix or null if pathPrefix is empty
*/
public function getPathPrefix()
{
}
/**
* Prefix a path.
*
* @param string $path
*
* @return string prefixed path
*/
public function applyPathPrefix($path)
{
}
/**
* Remove a path prefix.
*
* @param string $path
*
* @return string path without the prefix
*/
public function removePathPrefix($path)
{
}
}
}
namespace League\Flysystem\Adapter\Polyfill {
/**
* A helper for adapters that only handle strings to provide read streams.
*/
trait StreamedReadingTrait
{
/**
* Reads a file as a stream.
*
* @param string $path
*
* @return array|false
*
* @see League\Flysystem\ReadInterface::readStream()
*/
public function readStream($path)
{
}
/**
* Reads a file.
*
* @param string $path
*
* @return array|false
*
* @see League\Flysystem\ReadInterface::read()
*/
public abstract function read($path);
}
trait StreamedWritingTrait
{
/**
* Stream fallback delegator.
*
* @param string $path
* @param resource $resource
* @param Config $config
* @param string $fallback
*
* @return mixed fallback result
*/
protected function stream($path, $resource, \League\Flysystem\Config $config, $fallback)
{
}
/**
* Write using a stream.
*
* @param string $path
* @param resource $resource
* @param Config $config
*
* @return mixed false or file metadata
*/
public function writeStream($path, $resource, \League\Flysystem\Config $config)
{
}
/**
* Update a file using a stream.
*
* @param string $path
* @param resource $resource
* @param Config $config Config object or visibility setting
*
* @return mixed false of file metadata
*/
public function updateStream($path, $resource, \League\Flysystem\Config $config)
{
}
// Required abstract methods
public abstract function write($pash, $contents, \League\Flysystem\Config $config);
public abstract function update($pash, $contents, \League\Flysystem\Config $config);
}
trait StreamedTrait
{
use \League\Flysystem\Adapter\Polyfill\StreamedReadingTrait;
use \League\Flysystem\Adapter\Polyfill\StreamedWritingTrait;
}
trait StreamedCopyTrait
{
/**
* Copy a file.
*
* @param string $path
* @param string $newpath
*
* @return bool
*/
public function copy($path, $newpath)
{
}
// Required abstract method
/**
* @param string $path
* @return resource
*/
public abstract function readStream($path);
/**
* @param string $path
* @param resource $resource
* @param Config $config
* @return resource
*/
public abstract function writeStream($path, $resource, \League\Flysystem\Config $config);
}
}
namespace League\Flysystem\Adapter {
class NullAdapter extends \League\Flysystem\Adapter\AbstractAdapter
{
use \League\Flysystem\Adapter\Polyfill\StreamedTrait;
use \League\Flysystem\Adapter\Polyfill\StreamedCopyTrait;
/**
* Check whether a file is present.
*
* @param string $path
*
* @return bool
*/
public function has($path)
{
}
/**
* @inheritdoc
*/
public function write($path, $contents, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function update($path, $contents, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function read($path)
{
}
/**
* @inheritdoc
*/
public function rename($path, $newpath)
{
}
/**
* @inheritdoc
*/
public function delete($path)
{
}
/**
* @inheritdoc
*/
public function listContents($directory = '', $recursive = false)
{
}
/**
* @inheritdoc
*/
public function getMetadata($path)
{
}
/**
* @inheritdoc
*/
public function getSize($path)
{
}
/**
* @inheritdoc
*/
public function getMimetype($path)
{
}
/**
* @inheritdoc
*/
public function getTimestamp($path)
{
}
/**
* @inheritdoc
*/
public function getVisibility($path)
{
}
/**
* @inheritdoc
*/
public function setVisibility($path, $visibility)
{
}
/**
* @inheritdoc
*/
public function createDir($dirname, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function deleteDir($dirname)
{
}
}
/**
* Adapters that implement this interface let the Filesystem know that it files can be overwritten using the write
* functions and don't need the update function to be called. This can help improve performance when asserts are disabled.
*/
interface CanOverwriteFiles
{
}
abstract class AbstractFtpAdapter extends \League\Flysystem\Adapter\AbstractAdapter
{
/**
* @var mixed
*/
protected $connection;
/**
* @var string
*/
protected $host;
/**
* @var int
*/
protected $port = 21;
/**
* @var bool
*/
protected $ssl = false;
/**
* @var int
*/
protected $timeout = 90;
/**
* @var bool
*/
protected $passive = true;
/**
* @var string
*/
protected $separator = '/';
/**
* @var string|null
*/
protected $root;
/**
* @var int
*/
protected $permPublic = 0744;
/**
* @var int
*/
protected $permPrivate = 0700;
/**
* @var array
*/
protected $configurable = [];
/**
* @var string
*/
protected $systemType;
/**
* @var bool
*/
protected $alternativeRecursion = false;
/**
* @var SafeStorage
*/
protected $safeStorage;
/**
* Constructor.
*
* @param array $config
*/
public function __construct(array $config)
{
}
/**
* Set the config.
*
* @param array $config
*
* @return $this
*/
public function setConfig(array $config)
{
}
/**
* Returns the host.
*
* @return string
*/
public function getHost()
{
}
/**
* Set the host.
*
* @param string $host
*
* @return $this
*/
public function setHost($host)
{
}
/**
* Set the public permission value.
*
* @param int $permPublic
*
* @return $this
*/
public function setPermPublic($permPublic)
{
}
/**
* Set the private permission value.
*
* @param int $permPrivate
*
* @return $this
*/
public function setPermPrivate($permPrivate)
{
}
/**
* Returns the ftp port.
*
* @return int
*/
public function getPort()
{
}
/**
* Returns the root folder to work from.
*
* @return string
*/
public function getRoot()
{
}
/**
* Set the ftp port.
*
* @param int|string $port
*
* @return $this
*/
public function setPort($port)
{
}
/**
* Set the root folder to work from.
*
* @param string $root
*
* @return $this
*/
public function setRoot($root)
{
}
/**
* Returns the ftp username.
*
* @return string username
*/
public function getUsername()
{
}
/**
* Set ftp username.
*
* @param string $username
*
* @return $this
*/
public function setUsername($username)
{
}
/**
* Returns the password.
*
* @return string password
*/
public function getPassword()
{
}
/**
* Set the ftp password.
*
* @param string $password
*
* @return $this
*/
public function setPassword($password)
{
}
/**
* Returns the amount of seconds before the connection will timeout.
*
* @return int
*/
public function getTimeout()
{
}
/**
* Set the amount of seconds before the connection should timeout.
*
* @param int $timeout
*
* @return $this
*/
public function setTimeout($timeout)
{
}
/**
* Return the FTP system type.
*
* @return string
*/
public function getSystemType()
{
}
/**
* Set the FTP system type (windows or unix).
*
* @param string $systemType
*
* @return $this
*/
public function setSystemType($systemType)
{
}
/**
* @inheritdoc
*/
public function listContents($directory = '', $recursive = false)
{
}
protected abstract function listDirectoryContents($directory, $recursive = false);
/**
* Normalize a directory listing.
*
* @param array $listing
* @param string $prefix
*
* @return array directory listing
*/
protected function normalizeListing(array $listing, $prefix = '')
{
}
/**
* Sort a directory listing.
*
* @param array $result
*
* @return array sorted listing
*/
protected function sortListing(array $result)
{
}
/**
* Normalize a file entry.
*
* @param string $item
* @param string $base
*
* @return array normalized file array
*
* @throws NotSupportedException
*/
protected function normalizeObject($item, $base)
{
}
/**
* Normalize a Unix file entry.
*
* @param string $item
* @param string $base
*
* @return array normalized file array
*/
protected function normalizeUnixObject($item, $base)
{
}
/**
* Normalize a Windows/DOS file entry.
*
* @param string $item
* @param string $base
*
* @return array normalized file array
*/
protected function normalizeWindowsObject($item, $base)
{
}
/**
* Get the system type from a listing item.
*
* @param string $item
*
* @return string the system type
*/
protected function detectSystemType($item)
{
}
/**
* Get the file type from the permissions.
*
* @param string $permissions
*
* @return string file type
*/
protected function detectType($permissions)
{
}
/**
* Normalize a permissions string.
*
* @param string $permissions
*
* @return int
*/
protected function normalizePermissions($permissions)
{
}
/**
* Filter out dot-directories.
*
* @param array $list
*
* @return array
*/
public function removeDotDirectories(array $list)
{
}
/**
* @inheritdoc
*/
public function has($path)
{
}
/**
* @inheritdoc
*/
public function getSize($path)
{
}
/**
* @inheritdoc
*/
public function getVisibility($path)
{
}
/**
* Ensure a directory exists.
*
* @param string $dirname
*/
public function ensureDirectory($dirname)
{
}
/**
* @return mixed
*/
public function getConnection()
{
}
/**
* Get the public permission value.
*
* @return int
*/
public function getPermPublic()
{
}
/**
* Get the private permission value.
*
* @return int
*/
public function getPermPrivate()
{
}
/**
* Disconnect on destruction.
*/
public function __destruct()
{
}
/**
* Establish a connection.
*/
public abstract function connect();
/**
* Close the connection.
*/
public abstract function disconnect();
/**
* Check if a connection is active.
*
* @return bool
*/
public abstract function isConnected();
}
class Ftp extends \League\Flysystem\Adapter\AbstractFtpAdapter
{
use \League\Flysystem\Adapter\Polyfill\StreamedCopyTrait;
/**
* @var int
*/
protected $transferMode = FTP_BINARY;
/**
* @var null|bool
*/
protected $ignorePassiveAddress = null;
/**
* @var bool
*/
protected $recurseManually = false;
/**
* @var bool
*/
protected $utf8 = false;
/**
* @var array
*/
protected $configurable = ['host', 'port', 'username', 'password', 'ssl', 'timeout', 'root', 'permPrivate', 'permPublic', 'passive', 'transferMode', 'systemType', 'ignorePassiveAddress', 'recurseManually', 'utf8'];
/**
* @var bool
*/
protected $isPureFtpd;
/**
* Set the transfer mode.
*
* @param int $mode
*
* @return $this
*/
public function setTransferMode($mode)
{
}
/**
* Set if Ssl is enabled.
*
* @param bool $ssl
*
* @return $this
*/
public function setSsl($ssl)
{
}
/**
* Set if passive mode should be used.
*
* @param bool $passive
*/
public function setPassive($passive = true)
{
}
/**
* @param bool $ignorePassiveAddress
*/
public function setIgnorePassiveAddress($ignorePassiveAddress)
{
}
/**
* @param bool $recurseManually
*/
public function setRecurseManually($recurseManually)
{
}
/**
* @param bool $utf8
*/
public function setUtf8($utf8)
{
}
/**
* Connect to the FTP server.
*/
public function connect()
{
}
/**
* Set the connection to UTF-8 mode.
*/
protected function setUtf8Mode()
{
}
/**
* Set the connections to passive mode.
*
* @throws RuntimeException
*/
protected function setConnectionPassiveMode()
{
}
/**
* Set the connection root.
*/
protected function setConnectionRoot()
{
}
/**
* Login.
*
* @throws RuntimeException
*/
protected function login()
{
}
/**
* Disconnect from the FTP server.
*/
public function disconnect()
{
}
/**
* @inheritdoc
*/
public function write($path, $contents, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function writeStream($path, $resource, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function update($path, $contents, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function updateStream($path, $resource, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function rename($path, $newpath)
{
}
/**
* @inheritdoc
*/
public function delete($path)
{
}
/**
* @inheritdoc
*/
public function deleteDir($dirname)
{
}
/**
* @inheritdoc
*/
public function createDir($dirname, \League\Flysystem\Config $config)
{
}
/**
* Create a directory.
*
* @param string $directory
* @param resource $connection
*
* @return bool
*/
protected function createActualDirectory($directory, $connection)
{
}
/**
* @inheritdoc
*/
public function getMetadata($path)
{
}
/**
* @inheritdoc
*/
public function getMimetype($path)
{
}
/**
* @inheritdoc
*/
public function getTimestamp($path)
{
}
/**
* @inheritdoc
*/
public function read($path)
{
}
/**
* @inheritdoc
*/
public function readStream($path)
{
}
/**
* @inheritdoc
*/
public function setVisibility($path, $visibility)
{
}
/**
* @inheritdoc
*
* @param string $directory
*/
protected function listDirectoryContents($directory, $recursive = true)
{
}
/**
* @inheritdoc
*
* @param string $directory
*/
protected function listDirectoryContentsRecursive($directory)
{
}
/**
* Check if the connection is open.
*
* @return bool
* @throws ErrorException
*/
public function isConnected()
{
}
/**
* @return bool
*/
protected function isPureFtpdServer()
{
}
/**
* The ftp_rawlist function with optional escaping.
*
* @param string $options
* @param string $path
*
* @return array
*/
protected function ftpRawlist($options, $path)
{
}
}
class Ftpd extends \League\Flysystem\Adapter\Ftp
{
/**
* @inheritdoc
*/
public function getMetadata($path)
{
}
/**
* @inheritdoc
*/
protected function listDirectoryContents($directory, $recursive = true)
{
}
}
class SynologyFtp extends \League\Flysystem\Adapter\Ftpd
{
// This class merely exists because of BC.
}
}
namespace League\Flysystem\Adapter\Polyfill {
trait NotSupportingVisibilityTrait
{
/**
* Get the visibility of a file.
*
* @param string $path
*
* @throws LogicException
*/
public function getVisibility($path)
{
}
/**
* Set the visibility for a file.
*
* @param string $path
* @param string $visibility
*
* @throws LogicException
*/
public function setVisibility($path, $visibility)
{
}
}
}
namespace League\Flysystem\Adapter {
class Local extends \League\Flysystem\Adapter\AbstractAdapter
{
/**
* @var int
*/
const SKIP_LINKS = 01;
/**
* @var int
*/
const DISALLOW_LINKS = 02;
/**
* @var array
*/
protected static $permissions = ['file' => ['public' => 0644, 'private' => 0600], 'dir' => ['public' => 0755, 'private' => 0700]];
/**
* @var string
*/
protected $pathSeparator = DIRECTORY_SEPARATOR;
/**
* @var array
*/
protected $permissionMap;
/**
* @var int
*/
protected $writeFlags;
/**
* Constructor.
*
* @param string $root
* @param int $writeFlags
* @param int $linkHandling
* @param array $permissions
*
* @throws LogicException
*/
public function __construct($root, $writeFlags = LOCK_EX, $linkHandling = self::DISALLOW_LINKS, array $permissions = [])
{
}
/**
* Ensure the root directory exists.
*
* @param string $root root directory path
*
* @return void
*
* @throws Exception in case the root directory can not be created
*/
protected function ensureDirectory($root)
{
}
/**
* @inheritdoc
*/
public function has($path)
{
}
/**
* @inheritdoc
*/
public function write($path, $contents, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function writeStream($path, $resource, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function readStream($path)
{
}
/**
* @inheritdoc
*/
public function updateStream($path, $resource, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function update($path, $contents, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function read($path)
{
}
/**
* @inheritdoc
*/
public function rename($path, $newpath)
{
}
/**
* @inheritdoc
*/
public function copy($path, $newpath)
{
}
/**
* @inheritdoc
*/
public function delete($path)
{
}
/**
* @inheritdoc
*/
public function listContents($directory = '', $recursive = false)
{
}
/**
* @inheritdoc
*/
public function getMetadata($path)
{
}
/**
* @inheritdoc
*/
public function getSize($path)
{
}
/**
* @inheritdoc
*/
public function getMimetype($path)
{
}
/**
* @inheritdoc
*/
public function getTimestamp($path)
{
}
/**
* @inheritdoc
*/
public function getVisibility($path)
{
}
/**
* @inheritdoc
*/
public function setVisibility($path, $visibility)
{
}
/**
* @inheritdoc
*/
public function createDir($dirname, \League\Flysystem\Config $config)
{
}
/**
* @inheritdoc
*/
public function deleteDir($dirname)
{
}
/**
* @param SplFileInfo $file
*/
protected function deleteFileInfoObject(\SplFileInfo $file)
{
}
/**
* Normalize the file info.
*
* @param SplFileInfo $file
*
* @return array|void
*
* @throws NotSupportedException
*/
protected function normalizeFileInfo(\SplFileInfo $file)
{
}
/**
* Get the normalized path from a SplFileInfo object.
*
* @param SplFileInfo $file
*
* @return string
*/
protected function getFilePath(\SplFileInfo $file)
{
}
/**
* @param string $path
* @param int $mode
*
* @return RecursiveIteratorIterator
*/
protected function getRecursiveDirectoryIterator($path, $mode = \RecursiveIteratorIterator::SELF_FIRST)
{
}
/**
* @param string $path
*
* @return DirectoryIterator
*/
protected function getDirectoryIterator($path)
{
}
/**
* @param SplFileInfo $file
*
* @return array
*/
protected function mapFileInfo(\SplFileInfo $file)
{
}
/**
* @param SplFileInfo $file
*
* @throws UnreadableFileException
*/
protected function guardAgainstUnreadableFileInfo(\SplFileInfo $file)
{
}
}
}
namespace League\Flysystem {
final class SafeStorage
{
public function __construct()
{
}
public function storeSafely($key, $value)
{
}
public function retrieveSafely($key)
{
}
public function __destruct()
{
}
}
}
namespace League\Flysystem\Plugin {
abstract class AbstractPlugin implements \League\Flysystem\PluginInterface
{
/**
* @var FilesystemInterface
*/
protected $filesystem;
/**
* Set the Filesystem object.
*
* @param FilesystemInterface $filesystem
*/
public function setFilesystem(\League\Flysystem\FilesystemInterface $filesystem)
{
}
}
class ForcedCopy extends \League\Flysystem\Plugin\AbstractPlugin
{
/**
* @inheritdoc
*/
public function getMethod()
{
}
/**
* Copies a file, overwriting any existing files.
*
* @param string $path Path to the existing file.
* @param string $newpath The new path of the file.
*
* @throws FileExistsException
* @throws FileNotFoundException Thrown if $path does not exist.
*
* @return bool True on success, false on failure.
*/
public function handle($path, $newpath)
{
}
}
class EmptyDir extends \League\Flysystem\Plugin\AbstractPlugin
{
/**
* Get the method name.
*
* @return string
*/
public function getMethod()
{
}
/**
* Empty a directory's contents.
*
* @param string $dirname
*/
public function handle($dirname)
{
}
}
class ListWith extends \League\Flysystem\Plugin\AbstractPlugin
{
/**
* Get the method name.
*
* @return string
*/
public function getMethod()
{
}
/**
* List contents with metadata.
*
* @param array $keys
* @param string $directory
* @param bool $recursive
*
* @return array listing with metadata
*/
public function handle(array $keys = [], $directory = '', $recursive = false)
{
}
/**
* Get a meta-data value by key name.
*
* @param array $object
* @param string $key
*
* @return array
*/
protected function getMetadataByName(array $object, $key)
{
}
}
class ForcedRename extends \League\Flysystem\Plugin\AbstractPlugin
{
/**
* @inheritdoc
*/
public function getMethod()
{
}
/**
* Renames a file, overwriting the destination if it exists.
*
* @param string $path Path to the existing file.
* @param string $newpath The new path of the file.
*
* @throws FileNotFoundException Thrown if $path does not exist.
* @throws FileExistsException
*
* @return bool True on success, false on failure.
*/
public function handle($path, $newpath)
{
}
}
class ListPaths extends \League\Flysystem\Plugin\AbstractPlugin
{
/**
* Get the method name.
*
* @return string
*/
public function getMethod()
{
}
/**
* List all paths.
*
* @param string $directory
* @param bool $recursive
*
* @return array paths
*/
public function handle($directory = '', $recursive = false)
{
}
}
class ListFiles extends \League\Flysystem\Plugin\AbstractPlugin
{
/**
* Get the method name.
*
* @return string
*/
public function getMethod()
{
}
/**
* List all files in the directory.
*
* @param string $directory
* @param bool $recursive
*
* @return array
*/
public function handle($directory = '', $recursive = false)
{
}
}
class GetWithMetadata extends \League\Flysystem\Plugin\AbstractPlugin
{
/**
* Get the method name.
*
* @return string
*/
public function getMethod()
{
}
/**
* Get metadata for an object with required metadata.
*
* @param string $path path to file
* @param array $metadata metadata keys
*
* @throws InvalidArgumentException
* @throws FileNotFoundException
*
* @return array|false metadata
*/
public function handle($path, array $metadata)
{
}
}
class PluginNotFoundException extends \LogicException
{
// This exception doesn't require additional information.
}
}
namespace League\Flysystem {
/**
* @deprecated
*/
class File extends \League\Flysystem\Handler
{
/**
* Check whether the file exists.
*
* @return bool
*/
public function exists()
{
}
/**
* Read the file.
*
* @return string|false file contents
*/
public function read()
{
}
/**
* Read the file as a stream.
*
* @return resource|false file stream
*/
public function readStream()
{
}
/**
* Write the new file.
*
* @param string $content
*
* @return bool success boolean
*/
public function write($content)
{
}
/**
* Write the new file using a stream.
*
* @param resource $resource
*
* @return bool success boolean
*/
public function writeStream($resource)
{
}
/**
* Update the file contents.
*
* @param string $content
*
* @return bool success boolean
*/
public function update($content)
{
}
/**
* Update the file contents with a stream.
*
* @param resource $resource
*
* @return bool success boolean
*/
public function updateStream($resource)
{
}
/**
* Create the file or update if exists.
*
* @param string $content
*
* @return bool success boolean
*/
public function put($content)
{
}
/**
* Create the file or update if exists using a stream.
*
* @param resource $resource
*
* @return bool success boolean
*/
public function putStream($resource)
{
}
/**
* Rename the file.
*
* @param string $newpath
*
* @return bool success boolean
*/
public function rename($newpath)
{
}
/**
* Copy the file.
*
* @param string $newpath
*
* @return File|false new file or false
*/
public function copy($newpath)
{
}
/**
* Get the file's timestamp.
*
* @return string|false The timestamp or false on failure.
*/
public function getTimestamp()
{
}
/**
* Get the file's mimetype.
*
* @return string|false The file mime-type or false on failure.
*/
public function getMimetype()
{
}
/**
* Get the file's visibility.
*
* @return string|false The visibility (public|private) or false on failure.
*/
public function getVisibility()
{
}
/**
* Get the file's metadata.
*
* @return array|false The file metadata or false on failure.
*/
public function getMetadata()
{
}
/**
* Get the file size.
*
* @return int|false The file size or false on failure.
*/
public function getSize()
{
}
/**
* Delete the file.
*
* @return bool success boolean
*/
public function delete()
{
}
}
/**
* Thrown when the MountManager cannot find a filesystem.
*/
class FilesystemNotFoundException extends \LogicException
{
}
}
namespace League\Flysystem\AwsS3v3 {
class AwsS3Adapter extends \League\Flysystem\Adapter\AbstractAdapter implements \League\Flysystem\Adapter\CanOverwriteFiles
{
const PUBLIC_GRANT_URI = 'http://acs.amazonaws.com/groups/global/AllUsers';
/**
* @var array
*/
protected static $resultMap = ['Body' => 'contents', 'ContentLength' => 'size', 'ContentType' => 'mimetype', 'Size' => 'size', 'Metadata' => 'metadata', 'StorageClass' => 'storageclass', 'ETag' => 'etag', 'VersionId' => 'versionid'];
/**
* @var array
*/
protected static $metaOptions = ['ACL', 'CacheControl', 'ContentDisposition', 'ContentEncoding', 'ContentLength', 'ContentType', 'Expires', 'GrantFullControl', 'GrantRead', 'GrantReadACP', 'GrantWriteACP', 'Metadata', 'RequestPayer', 'SSECustomerAlgorithm', 'SSECustomerKey', 'SSECustomerKeyMD5', 'SSEKMSKeyId', 'ServerSideEncryption', 'StorageClass', 'Tagging', 'WebsiteRedirectLocation'];
/**
* @var S3Client
*/
protected $s3Client;
/**
* @var string
*/
protected $bucket;
/**
* @var array
*/
protected $options = [];
/**
* Constructor.
*
* @param S3Client $client
* @param string $bucket
* @param string $prefix
* @param array $options
*/
public function __construct(\Aws\S3\S3Client $client, $bucket, $prefix = '', array $options = [])
{
}
/**
* Get the S3Client bucket.
*
* @return string
*/
public function getBucket()
{
}
/**
* Set the S3Client bucket.
*
* @return string
*/
public function setBucket($bucket)
{
}
/**
* Get the S3Client instance.
*
* @return S3Client
*/
public function getClient()
{
}
/**
* Write a new file.
*
* @param string $path
* @param string $contents
* @param Config $config Config object
*
* @return false|array false on failure file meta data on success
*/
public function write($path, $contents, \League\Flysystem\Config $config)
{
}
/**
* Update a file.
*
* @param string $path
* @param string $contents
* @param Config $config Config object
*
* @return false|array false on failure file meta data on success
*/
public function update($path, $contents, \League\Flysystem\Config $config)
{
}
/**
* Rename a file.
*
* @param string $path
* @param string $newpath
*
* @return bool
*/
public function rename($path, $newpath)
{
}
/**
* Delete a file.
*
* @param string $path
*
* @return bool
*/
public function delete($path)
{
}
/**
* Delete a directory.
*
* @param string $dirname
*
* @return bool
*/
public function deleteDir($dirname)
{
}
/**
* Create a directory.
*
* @param string $dirname directory name
* @param Config $config
*
* @return bool|array
*/
public function createDir($dirname, \League\Flysystem\Config $config)
{
}
/**
* Check whether a file exists.
*
* @param string $path
*
* @return bool
*/
public function has($path)
{
}
/**
* Read a file.
*
* @param string $path
*
* @return false|array
*/
public function read($path)
{
}
/**
* List contents of a directory.
*
* @param string $directory
* @param bool $recursive
*
* @return array
*/
public function listContents($directory = '', $recursive = false)
{
}
/**
* @param array $options
*
* @return array
*/
protected function retrievePaginatedListing(array $options)
{
}
/**
* Get all the meta data of a file or directory.
*
* @param string $path
*
* @return false|array
*/
public function getMetadata($path)
{
}
/**
* Get all the meta data of a file or directory.
*
* @param string $path
*
* @return false|array
*/
public function getSize($path)
{
}
/**
* Get the mimetype of a file.
*
* @param string $path
*
* @return false|array
*/
public function getMimetype($path)
{
}
/**
* Get the timestamp of a file.
*
* @param string $path
*
* @return false|array
*/
public function getTimestamp($path)
{
}
/**
* Write a new file using a stream.
*
* @param string $path
* @param resource $resource
* @param Config $config Config object
*
* @return array|false false on failure file meta data on success
*/
public function writeStream($path, $resource, \League\Flysystem\Config $config)
{
}
/**
* Update a file using a stream.
*
* @param string $path
* @param resource $resource
* @param Config $config Config object
*
* @return array|false false on failure file meta data on success
*/
public function updateStream($path, $resource, \League\Flysystem\Config $config)
{
}
/**
* Copy a file.
*
* @param string $path
* @param string $newpath
*
* @return bool
*/
public function copy($path, $newpath)
{
}
/**
* Read a file as a stream.
*
* @param string $path
*
* @return array|false
*/
public function readStream($path)
{
}
/**
* Read an object and normalize the response.
*
* @param $path
*
* @return array|bool
*/
protected function readObject($path)
{
}
/**
* Set the visibility for a file.
*
* @param string $path
* @param string $visibility
*
* @return array|false file meta data
*/
public function setVisibility($path, $visibility)
{
}
/**
* Get the visibility of a file.
*
* @param string $path
*
* @return array|false
*/
public function getVisibility($path)
{
}
/**
* {@inheritdoc}
*/
public function applyPathPrefix($path)
{
}
/**
* {@inheritdoc}
*/
public function setPathPrefix($prefix)
{
}
/**
* Get the object acl presented as a visibility.
*
* @param string $path
*
* @return string
*/
protected function getRawVisibility($path)
{
}
/**
* Upload an object.
*
* @param $path
* @param $body
* @param Config $config
*
* @return array|bool
*/
protected function upload($path, $body, \League\Flysystem\Config $config)
{
}
/**
* Get options from the config.
*
* @param Config $config
*
* @return array
*/
protected function getOptionsFromConfig(\League\Flysystem\Config $config)
{
}
/**
* Normalize the object result array.
*
* @param array $response
* @param string $path
*
* @return array
*/
protected function normalizeResponse(array $response, $path = null)
{
}
/**
* @param $location
*
* @return bool
*/
protected function doesDirectoryExist($location)
{
}
}
}
namespace League\CLImate {
/**
* @method mixed black(string $str = null)
* @method mixed red(string $str = null)
* @method mixed green(string $str = null)
* @method mixed yellow(string $str = null)
* @method mixed blue(string $str = null)
* @method mixed magenta(string $str = null)
* @method mixed cyan(string $str = null)
* @method mixed lightGray(string $str = null)
* @method mixed darkGray(string $str = null)
* @method mixed lightRed(string $str = null)
* @method mixed lightGreen(string $str = null)
* @method mixed lightYellow(string $str = null)
* @method mixed lightBlue(string $str = null)
* @method mixed lightMagenta(string $str = null)
* @method mixed lightCyan(string $str = null)
* @method mixed white(string $str = null)
*
* @method mixed backgroundBlack(string $str = null)
* @method mixed backgroundRed(string $str = null)
* @method mixed backgroundGreen(string $str = null)
* @method mixed backgroundYellow(string $str = null)
* @method mixed backgroundBlue(string $str = null)
* @method mixed backgroundMagenta(string $str = null)
* @method mixed backgroundCyan(string $str = null)
* @method mixed backgroundLightGray(string $str = null)
* @method mixed backgroundDarkGray(string $str = null)
* @method mixed backgroundLightRed(string $str = null)
* @method mixed backgroundLightGreen(string $str = null)
* @method mixed backgroundLightYellow(string $str = null)
* @method mixed backgroundLightBlue(string $str = null)
* @method mixed backgroundLightMagenta(string $str = null)
* @method mixed backgroundLightCyan(string $str = null)
* @method mixed backgroundWhite(string $str = null)
*
* @method mixed bold(string $str = null)
* @method mixed dim(string $str = null)
* @method mixed underline(string $str = null)
* @method mixed blink(string $str = null)
* @method mixed invert(string $str = null)
* @method mixed hidden(string $str = null)
*
* @method mixed info(string $str = null)
* @method mixed comment(string $str = null)
* @method mixed whisper(string $str = null)
* @method mixed shout(string $str = null)
* @method mixed error(string $str = null)
*
* @method mixed out(string $str)
* @method mixed inline(string $str)
* @method mixed table(array $data)
* @method mixed json(mixed $var)
* @method mixed br($count = 1)
* @method mixed tab($count = 1)
* @method mixed draw(string $art)
* @method mixed border(string $char = null, integer $length = null)
* @method mixed dump(mixed $var)
* @method mixed flank(string $output, string $char = null, integer $length = null)
* @method mixed progress(integer $total = null)
* @method mixed padding(integer $length = 0, string $char = '.')
* @method mixed input(string $prompt, Util\Reader\ReaderInterface $reader = null)
* @method mixed confirm(string $prompt, Util\Reader\ReaderInterface $reader = null)
* @method mixed password(string $prompt, Util\Reader\ReaderInterface $reader = null)
* @method mixed checkboxes(string $prompt, array $options, Util\Reader\ReaderInterface $reader = null)
* @method mixed radio(string $prompt, array $options, Util\Reader\ReaderInterface $reader = null)
* @method mixed animation(string $art, TerminalObject\Helper\Sleeper $sleeper = null)
* @method mixed columns(array $data, $column_count = null)
* @method mixed clear()
*
* @method CLImate addArt(string $dir)
*/
class CLImate
{
/**
* An instance of the Style class
*
* @var \League\CLImate\Decorator\Style $style
*/
public $style;
/**
* An instance of the Terminal Object Router class
*
* @var \League\CLImate\TerminalObject\Router\Router $router
*/
protected $router;
/**
* An instance of the Settings Manager class
*
* @var \League\CLImate\Settings\Manager $settings
*/
protected $settings;
/**
* An instance of the Argument Manager class
*
* @var \League\CLImate\Argument\Manager $arguments
*/
public $arguments;
/**
* An instance of the Output class
*
* @var \League\CLImate\Util\Output $output
*/
public $output;
/**
* An instance of the Util Factory
*
* @var \League\CLImate\Util\UtilFactory $util
*/
protected $util;
public function __construct()
{
}
/**
* Set the style property
*
* @param \League\CLImate\Decorator\Style $style
*/
public function setStyle(\League\CLImate\Decorator\Style $style)
{
}
/**
* Set the router property
*
* @param \League\CLImate\TerminalObject\Router\Router $router
*/
public function setRouter(\League\CLImate\TerminalObject\Router\Router $router)
{
}
/**
* Set the settings property
*
* @param \League\CLImate\Settings\Manager $manager
*/
public function setSettingsManager(\League\CLImate\Settings\Manager $manager)
{
}
/**
* Set the arguments property
*
* @param \League\CLImate\Argument\Manager $manager
*/
public function setArgumentManager(\League\CLImate\Argument\Manager $manager)
{
}
/**
* Set the output property
*
* @param \League\CLImate\Util\Output $output
*/
public function setOutput(\League\CLImate\Util\Output $output)
{
}
/**
* Set the util property
*
* @param \League\CLImate\Util\UtilFactory $util
*/
public function setUtil(\League\CLImate\Util\UtilFactory $util)
{
}
/**
* Extend CLImate with custom methods
*
* @param string|object|array $class
* @param string $key Optional custom key instead of class name
*
* @return \League\CLImate\CLImate
*/
public function extend($class, $key = null)
{
}
/**
* Force ansi support on
*
* @return \League\CLImate\CLImate
*/
public function forceAnsiOn()
{
}
/**
* Force ansi support off
*
* @return \League\CLImate\CLImate
*/
public function forceAnsiOff()
{
}
/**
* Write line to writer once
*
* @param string|array $writer
*
* @return \League\CLImate\CLImate
*/
public function to($writer)
{
}
/**
* Output the program's usage statement
*
* @param array $argv
*/
public function usage(array $argv = null)
{
}
/**
* Set the program's description
*
* @param string $description
*
* @return \League\CLImate\CLImate
*/
public function description($description)
{
}
/**
* Check if we have valid output
*
* @param mixed $output
*
* @return boolean
*/
protected function hasOutput($output)
{
}
/**
* Search for the method within the string
* and route it if we find one.
*
* @param string $method
* @param string $name
*
* @return string The new string without the executed method.
*/
protected function parseStyleMethod($method, $name)
{
}
/**
* Search for any style methods within the name and apply them
*
* @param string $name
* @param array $method_search
*
* @return string Anything left over after applying styles
*/
protected function applyStyleMethods($name, $method_search = null)
{
}
/**
* Search for style methods in the current name
*
* @param string $name
* @param array $search
* @return string
*/
protected function searchForStyleMethods($name, $search)
{
}
/**
* Build up the terminal object and return it
*
* @param string $name
* @param array $arguments
*
* @return object|null
*/
protected function buildTerminalObject($name, $arguments)
{
}
/**
* Route anything leftover after styles were applied
*
* @param string $name
* @param array $arguments
*
* @return object|null
*/
protected function routeRemainingMethod($name, array $arguments)
{
}
/**
* Magic method for anything called that doesn't exist
*
* @param string $requested_method
* @param array $arguments
*
* @return \League\CLImate\CLImate|\League\CLImate\TerminalObject\Dynamic\DynamicTerminalObject
*
* List of many of the possible method being called here
* documented at the top of this class.
*/
public function __call($requested_method, $arguments)
{
}
}
}
namespace League\CLImate\TerminalObject\Helper {
interface SleeperInterface
{
/**
* @param int|float $percentage
*/
public function speed($percentage);
public function sleep();
}
class Sleeper implements \League\CLImate\TerminalObject\Helper\SleeperInterface
{
/**
* The default length of the sleep
*
* @var int|float $speed
*/
protected $speed = 50000;
/**
* Set the speed based on a percentage (50% slower, 200% faster, etc)
*
* @param int|float $percentage
*
* @return float
*/
public function speed($percentage)
{
}
/**
* Sleep for the specified amount of time
*/
public function sleep()
{
}
}
trait Art
{
/**
* The directories we should be looking for art in
*
* @var array $art_dirs
*/
protected $art_dirs = [];
/**
* The default art if we can't find what the user requested
*
* @var string $default_art
*/
protected $default_art = '404';
/**
* The art requested by the user
*
* @var string $art
*/
protected $art = '';
/**
* Specify which settings Draw needs to import
*
* @return array
*/
public function settings()
{
}
/**
* Import the Art setting (any directories the user added)
*
* @param \League\CLImate\Settings\Art $setting
*/
public function importSettingArt($setting)
{
}
/**
* Add a directory to search for art in
*
* @param string $dir
*/
protected function addDir($dir)
{
}
/**
* Find a valid art path
*
* @param string $art
*
* @return array
*/
protected function artDir($art)
{
}
/**
* Find a valid art path
*
* @param string $art
*
* @return string
*/
protected function artFile($art)
{
}
/**
* Find a set of files in the current art directories
* based on a pattern
*
* @param string $art
* @param string $pattern
*
* @return array
*/
protected function fileSearch($art, $pattern)
{
}
/**
* Parse the contents of the file and return each line
*
* @param string $path
*
* @return array
*/
protected function parse($path)
{
}
}
trait StringLength
{
/**
* Tags the should not be ultimately considered
* when calculating any string lengths
*
* @var array $ignore_tags
*/
protected $ignore_tags = [];
/**
* Set the ignore tags property
*/
protected function setIgnoreTags()
{
}
/**
* Determine the length of the string without any tags
*
* @param string $str
*
* @return integer
*/
protected function lengthWithoutTags($str)
{
}
/**
* Get the string without the tags that are to be ignored
*
* @param string $str
*
* @return string
*/
protected function withoutTags($str)
{
}
/**
* Apply padding to a string
*
* @param string $str
* @param string $final_length
* @param string $padding_side
*
* @return string
*/
protected function pad($str, $final_length, $padding_side = 'right')
{
}
/**
* Apply padding to an array of strings
*
* @param array $arr
* @param integer $final_length
* @param string $padding_side
*
* @return array
*/
protected function padArray($arr, $final_length, $padding_side = 'right')
{
}
/**
* Find the max string length in an array
*
* @param array $arr
* @return int
*/
protected function maxStrLen(array $arr)
{
}
/**
* Get an array of the string lengths from an array of strings
*
* @param array $arr
* @return array
*/
protected function arrayOfStrLens(array $arr)
{
}
}
}
namespace League\CLImate\TerminalObject\Dynamic {
interface DynamicTerminalObjectInterface
{
public function settings();
/**
* @param $setting
* @return void
*/
public function importSetting($setting);
/**
* @param \League\CLImate\Decorator\Parser\Parser $parser
*/
public function parser(\League\CLImate\Decorator\Parser\Parser $parser);
/**
* @param UtilFactory $util
*/
public function util(\League\CLImate\Util\UtilFactory $util);
}
}
namespace League\CLImate\Settings {
trait SettingsImporter
{
/**
* Dictates any settings that a class may need access to
*
* @return array
*/
public function settings()
{
}
/**
* Import the setting into the class
*
* @param \League\CLImate\Settings\SettingsInterface $setting
*/
public function importSetting($setting)
{
}
}
}
namespace League\CLImate\Decorator\Parser {
trait ParserImporter
{
/**
* An instance of the Parser class
*
* @var \League\CLImate\Decorator\Parser\Parser $parser
*/
protected $parser;
/**
* Import the parser and set the property
*
* @param \League\CLImate\Decorator\Parser\Parser $parser
*/
public function parser(\League\CLImate\Decorator\Parser\Parser $parser)
{
}
}
}
namespace League\CLImate\Util {
trait OutputImporter
{
/**
* An instance of the OutputFactory
*
* @var \League\CLImate\Util\Output $output
*/
protected $output;
/**
* Sets the $output property
*
* @param Output $output
*/
public function output(\League\CLImate\Util\Output $output)
{
}
}
trait UtilImporter
{
/**
* An instance of the UtilFactory
*
* @var \League\CLImate\Util\UtilFactory $util
*/
protected $util;
/**
* Sets the $util property
*
* @param UtilFactory $util
*/
public function util(\League\CLImate\Util\UtilFactory $util)
{
}
}
}
namespace League\CLImate\TerminalObject\Dynamic {
/**
* The dynamic terminal object doesn't adhere to the basic terminal object
* contract, which is why it gets its own base class
*/
abstract class DynamicTerminalObject implements \League\CLImate\TerminalObject\Dynamic\DynamicTerminalObjectInterface
{
use \League\CLImate\Settings\SettingsImporter, \League\CLImate\Decorator\Parser\ParserImporter, \League\CLImate\Util\OutputImporter, \League\CLImate\Util\UtilImporter;
}
abstract class InputAbstract extends \League\CLImate\TerminalObject\Dynamic\DynamicTerminalObject
{
/**
* The prompt text
*
* @var string $prompt
*/
protected $prompt;
/**
* An instance of ReaderInterface
*
* @var \League\CLImate\Util\Reader\ReaderInterface $reader
*/
protected $reader;
/**
* Do it! Prompt the user for information!
*
* @return string
*/
public abstract function prompt();
/**
* Format the prompt incorporating spacing and any acceptable options
*
* @return string
*/
protected abstract function promptFormatted();
}
class Input extends \League\CLImate\TerminalObject\Dynamic\InputAbstract
{
/**
* An array of acceptable responses
*
* @var array|object $acceptable
*/
protected $acceptable;
/**
* Whether we should be strict about the response given
*
* @var boolean $strict
*/
protected $strict = false;
/**
* Whether to accept multiple lines of input
*
* Terminated by ^D
*
* @var boolean $multiLine
*/
protected $multiLine = false;
/**
* Whether we should display the acceptable responses to the user
*
* @var boolean $show_acceptable
*/
protected $show_acceptable = false;
/**
* A default answer in the case of no user response,
* prevents re-prompting
*
* @var string
*/
protected $default = '';
public function __construct($prompt, \League\CLImate\Util\Reader\ReaderInterface $reader = null)
{
}
/**
* Do it! Prompt the user for information!
*
* @return string
*/
public function prompt()
{
}
/**
* Define the acceptable responses and whether or not to
* display them to the user
*
* @param array|object $acceptable
* @param boolean $show
*
* @return \League\CLImate\TerminalObject\Dynamic\Input
*/
public function accept($acceptable, $show = false)
{
}
/**
* Define whether we should be strict about exact responses
*
* @return \League\CLImate\TerminalObject\Dynamic\Input
*/
public function strict()
{
}
/**
* Set a default response
*
* @param string $default
*
* @return \League\CLImate\TerminalObject\Dynamic\Input
*/
public function defaultTo($default)
{
}
/**
* Set multiline input to true
*
* @return \League\CLImate\TerminalObject\Dynamic\Input
*/
public function multiLine()
{
}
/**
* @return string
*/
protected function getUserInput()
{
}
/**
* Write out the formatted prompt
*/
protected function writePrompt()
{
}
/**
* If no response was given and there is a default, return it,
* otherwise return response
*
* @param string $response
*
* @return string
*/
protected function valueOrDefault($response)
{
}
/**
* Format the acceptable responses as options
*
* @return string
*/
protected function acceptableFormatted()
{
}
/**
* Format the acceptable item depending on whether it is the default or not
*
* @param string $item
*
* @return string
*/
protected function acceptableItemFormatted($item)
{
}
/**
* Format the prompt incorporating spacing and any acceptable options
*
* @return string
*/
protected function promptFormatted()
{
}
/**
* Apply some string manipulation functions for normalization
*
* @param string|array $var
* @return array
*/
protected function levelPlayingField($var)
{
}
/**
* Determine whether or not the acceptable property is of type closure
*
* @return boolean
*/
protected function acceptableIsClosure()
{
}
/**
* Determine if the user's response is in the acceptable responses array
*
* @param string $response
*
* @return boolean $response
*/
protected function isAcceptableResponse($response)
{
}
/**
* Determine if the user's response is valid based on the current settings
*
* @param string $response
*
* @return boolean $response
*/
protected function isValidResponse($response)
{
}
}
class Password extends \League\CLImate\TerminalObject\Dynamic\Input
{
public function prompt()
{
}
}
class Checkboxes extends \League\CLImate\TerminalObject\Dynamic\InputAbstract
{
/**
* The options to choose from
*
* @var Checkbox\CheckboxGroup $checkboxes
*/
protected $checkboxes;
public function __construct($prompt, array $options, \League\CLImate\Util\Reader\ReaderInterface $reader = null)
{
}
/**
* Do it! Prompt the user for information!
*
* @return string
*/
public function prompt()
{
}
/**
* Build out the checkboxes
*
* @param array $options
*
* @return Checkbox\CheckboxGroup
*/
protected function buildCheckboxes(array $options)
{
}
/**
* Format the prompt string
*
* @return string
*/
protected function promptFormatted()
{
}
/**
* Output the checkboxes and listen for any keystrokes
*/
protected function writeCheckboxes()
{
}
/**
* Listen for input and act on it
*/
protected function listenForInput()
{
}
/**
* Take the appropriate action based on the input character,
* returns whether to stop listening or not
*
* @param string $char
*
* @return bool
*/
protected function handleCharacter($char)
{
}
/**
* Move the cursor to the top of the option list
*/
protected function moveCursorToTop()
{
}
/**
* Handle any ANSI characters
*/
protected function handleAnsi()
{
}
/**
* Re-write the checkboxes based on the current objects
*/
protected function updateCheckboxView()
{
}
}
class Radio extends \League\CLImate\TerminalObject\Dynamic\Checkboxes
{
/**
* Build out the checkboxes
*
* @param array $options
*
* @return Checkbox\RadioGroup
*/
protected function buildCheckboxes(array $options)
{
}
}
class Confirm extends \League\CLImate\TerminalObject\Dynamic\Input
{
/**
* Let us know if the user confirmed
*
* @return boolean
*/
public function confirmed()
{
}
}
class Animation extends \League\CLImate\TerminalObject\Dynamic\DynamicTerminalObject
{
use \League\CLImate\TerminalObject\Helper\Art;
/**
* @var \League\CLImate\TerminalObject\Helper\Sleeper $sleeper
*/
protected $sleeper;
/**
* @var \League\CLImate\TerminalObject\Dynamic\Animation\Keyframe $keyframes
*/
protected $keyframes;
public function __construct($art, \League\CLImate\TerminalObject\Helper\Sleeper $sleeper = null, \League\CLImate\TerminalObject\Dynamic\Animation\Keyframe $keyframes = null)
{
}
/**
* Run a basic animation
*/
public function run()
{
}
/**
* Set the speed of the animation based on a percentage
* (50% slower, 200% faster, etc)
*
* @param int|float $percentage
*
* @return \League\CLImate\TerminalObject\Dynamic\Animation
*/
public function speed($percentage)
{
}
/**
* Scroll the art
*
* @param string $direction
* @return bool
*/
public function scroll($direction = 'right')
{
}
/**
* Animate the art exiting the screen
*
* @param string $direction top|bottom|right|left
*/
public function exitTo($direction)
{
}
/**
* Animate the art entering the screen
*
* @param string $direction top|bottom|right|left
*/
public function enterFrom($direction)
{
}
protected function getScrollDirectionMapping()
{
}
protected function getLines()
{
}
/**
* @param \League\CLImate\TerminalObject\Helper\Sleeper $sleeper
*/
protected function setSleeper($sleeper = null)
{
}
/**
* @param League\CLImate\TerminalObject\Dynamic\Animation\Keyframe $keyframes
*/
protected function setKeyFrames($keyframes)
{
}
/**
* Set up the necessary properties on the Keyframe class
*/
protected function setupKeyframes()
{
}
/**
* Animate the given keyframes
*
* @param array $keyframes Array of arrays
*/
protected function animate(array $keyframes)
{
}
/**
* Write the current keyframe to the terminal, line by line
*
* @param array $lines
* @param integer $count
*/
protected function writeKeyFrame(array $lines, $count)
{
}
/**
* Format the line to re-write previous lines, if necessary
*
* @param string $line
* @param integer $key
* @param integer $last_frame_count
*
* @return string
*/
protected function getLineFormatted($line, $key, $last_frame_count)
{
}
}
}
namespace League\CLImate\TerminalObject\Dynamic\Animation {
class Keyframe
{
use \League\CLImate\TerminalObject\Helper\StringLength, \League\CLImate\Decorator\Parser\ParserImporter, \League\CLImate\Util\UtilImporter;
/**
* Get the enter keyframes for the desired direction
*
* @param array $lines
* @param string $direction
*
* @return array
*/
public function enterFrom($lines, $direction)
{
}
/**
* Get the exit keyframes for the desired direction
*
* @param array $lines
* @param string $direction
*
* @return array
*/
public function exitTo($lines, $direction)
{
}
/**
* Get scroll keyframes
*
* @param array $lines
* @param string $enter_from
* @param string $exit_to
*
* @return array
*/
public function scroll($lines, $enter_from, $exit_to)
{
}
/**
* Get the line parser for the direction
*
* @param string $direction
* @return string
*/
protected function getLineMethod($direction)
{
}
/**
* Adjust the array of lines if necessary
*
* @param array $lines
* @param string $direction
*
* @return array
*/
protected function adjustLines(array $lines, $direction)
{
}
/**
* Pad the array of lines for "right" animation
*
* @param array $lines
* @return array
*/
protected function adjustRightLines(array $lines)
{
}
/**
* Pad the array of lines for "left" animation
*
* @param array $lines
* @return array
*/
protected function adjustLeftLines(array $lines)
{
}
/**
* Get the keyframes appropriate for the animation direction
*
* @param string $direction
* @param array $lines
* @param string $line_method
*
* @return array
*/
protected function getDirectionFrames($direction, array $lines, $line_method)
{
}
/**
* Create horizontal exit animation keyframes for the art
*
* @param array $lines
* @param string $line_method
*
* @return array
*/
protected function exitHorizontalFrames(array $lines, $line_method)
{
}
/**
* Get the keyframe for a horizontal animation
*
* @param array $lines
* @param int $frame_number
* @param string $line_method
* @param int $length
*
* @return array
*/
protected function getHorizontalKeyframe(array $lines, $frame_number, $line_method, $length)
{
}
/**
* Create vertical exit animation keyframes for the art
*
* @param array $lines
* @param string $line_method
*
* @return array
*/
protected function exitVerticalFrames(array $lines, $line_method)
{
}
/**
* Get the current line as it is exiting left
*
* @param string $line
* @param int $frame_number
*
* @return string
*/
protected function currentLeftLine($line, $frame_number)
{
}
/**
* Get the current line as it is exiting right
*
* @param string $line
* @param int $frame_number
* @param int $length
*
* @return string
*/
protected function currentRightLine($line, $frame_number, $length)
{
}
/**
* Slice off X number of lines from the bottom and fill the rest with empty strings
*
* @param array $lines
* @param integer $total_lines
* @param integer $current
*
* @return array
*/
protected function currentTopLine($lines, $total_lines, $current)
{
}
/**
* Slice off X number of lines from the top and fill the rest with empty strings
*
* @param array $lines
* @param integer $total_lines
* @param integer $current
*
* @return array
*/
protected function currentBottomLine($lines, $total_lines, $current)
{
}
}
}
namespace League\CLImate\TerminalObject\Dynamic\Checkbox {
class CheckboxGroup
{
use \League\CLImate\Util\OutputImporter, \League\CLImate\Decorator\Parser\ParserImporter, \League\CLImate\Util\UtilImporter;
protected $checkboxes = [];
protected $count;
public function __construct(array $options)
{
}
public function write()
{
}
/**
* Retrieve the checked option values
*
* @return array
*/
public function getCheckedValues()
{
}
/**
* Set the newly selected option based on the direction
*
* @param string $direction 'previous' or 'next'
*/
public function setCurrent($direction)
{
}
/**
* Toggle the current option's checked status
*/
public function toggleCurrent()
{
}
/**
* Get the number of checkboxes
*
* @return int
*/
public function count()
{
}
/**
* Retrieve the checked options
*
* @return array
*/
protected function getChecked()
{
}
/**
* Determine whether the option is checked
*
* @param Checkbox $option
*
* @return bool
*/
protected function isChecked($option)
{
}
/**
* Retrieve the option's value
*
* @param Checkbox $option
*
* @return mixed
*/
protected function getValue($option)
{
}
/**
* Get the currently selected option
*
* @return array
*/
protected function getCurrent()
{
}
/**
* Retrieve the correct current key
*
* @param string $direction 'previous' or 'next'
* @param Checkbox $option
* @param int $key
*
* @return int
*/
protected function getCurrentKey($direction, $option, $key)
{
}
/**
* @param Checkbox $option
* @param int $key
*
* @return int
*/
protected function getPreviousKey($option, $key)
{
}
/**
* @param Checkbox $option
* @param int $key
*
* @return int
*/
protected function getNextKey($option, $key)
{
}
/**
* @param Checkbox $checkbox
*/
protected function writeCheckbox($checkbox)
{
}
}
class RadioGroup extends \League\CLImate\TerminalObject\Dynamic\Checkbox\CheckboxGroup
{
/**
* Toggle the currently selected option, uncheck all of the others
*/
public function toggleCurrent()
{
}
/**
* Get the checked option
*
* @return string|bool|int
*/
public function getCheckedValues()
{
}
}
class Checkbox
{
use \League\CLImate\TerminalObject\Helper\StringLength, \League\CLImate\Decorator\Parser\ParserImporter, \League\CLImate\Util\UtilImporter;
/**
* The value of the checkbox
*
* @var string|int|bool $value
*/
protected $value;
/**
* The label for the checkbox
*
* @var string|int $label
*/
protected $label;
/**
* Whether the checkbox is checked
*
* @var bool $checked
*/
protected $checked = false;
/**
* Whether pointer is currently pointing at the checkbox
*
* @var bool $current
*/
protected $current = false;
/**
* Whether the checkbox is the first in the group
*
* @var bool $first
*/
protected $first = false;
/**
* Whether the checkbox is the last in the group
*
* @var bool $last
*/
protected $last = false;
public function __construct($label, $value)
{
}
/**
* @return bool
*/
public function isCurrent()
{
}
/**
* @return bool
*/
public function isChecked()
{
}
/**
* @return bool
*/
public function isFirst()
{
}
/**
* @return bool
*/
public function isLast()
{
}
/**
* Set whether the pointer is currently pointing at this checkbox
*
* @param bool $current
*
* @return Checkbox
*/
public function setCurrent($current = true)
{
}
/**
* Set whether the checkbox is currently checked
*
* @param bool $checked
*
* @return Checkbox
*/
public function setChecked($checked = true)
{
}
/**
* @return Checkbox
*/
public function setFirst()
{
}
/**
* @return Checkbox
*/
public function setLast()
{
}
/**
* @return string|int|bool
*/
public function getValue()
{
}
/**
* Build out basic checkbox string based on current options
*
* @return string
*/
protected function buildCheckboxString()
{
}
/**
* Get the padding string based on the length of the terminal/line
*
* @param string $line
*
* @return string
*/
protected function getPaddingString($line)
{
}
/**
* Get the checkbox symbol
*
* @param bool $checked
*
* @return string
*/
protected function checkbox($checked)
{
}
/**
* Get the pointer symbol
*
* @return string
*/
protected function pointer()
{
}
public function __toString()
{
}
}
}
namespace League\CLImate\TerminalObject\Dynamic {
class Padding extends \League\CLImate\TerminalObject\Dynamic\DynamicTerminalObject
{
/**
* The length that lines should be padded to
*
* @var integer $length
*/
protected $length = 0;
/**
* The character(s) that should be used to pad
*
* @var string $char
*/
protected $char = '.';
/**
* If they pass in a padding character, set the char
*
* @param int $length
* @param string $char
*/
public function __construct($length = null, $char = null)
{
}
/**
* Set the character(s) that should be used to pad
*
* @param string $char
*
* @return \League\CLImate\TerminalObject\Dynamic\Padding
*/
public function char($char)
{
}
/**
* Set the length of the line that should be generated
*
* @param integer $length
*
* @return \League\CLImate\TerminalObject\Dynamic\Padding
*/
public function length($length)
{
}
/**
* Get the length of the line based on the width of the terminal window
*
* @return integer
*/
protected function getLength()
{
}
/**
* Pad the content with the characters
*
* @param string $content
*
* @return string
*/
protected function padContent($content)
{
}
/**
* Output the content and pad to the previously defined length
*
* @param string $content
*
* @return \League\CLImate\TerminalObject\Dynamic\Padding
*/
public function label($content)
{
}
/**
* Output result
*
* @param string $content
*/
public function result($content)
{
}
}
class Progress extends \League\CLImate\TerminalObject\Dynamic\DynamicTerminalObject
{
/**
* The total number of items involved
*
* @var integer $total
*/
protected $total = 0;
/**
* The current item that the progress bar represents
*
* @var integer $current
*/
protected $current = 0;
/**
* The current percentage displayed
*
* @var string $current_percentage
*/
protected $current_percentage = '';
/**
* The string length of the bar when at 100%
*
* @var integer $bar_str_len
*/
protected $bar_str_len;
/**
* Flag indicating whether we are writing the bar for the first time
*
* @var boolean $first_line
*/
protected $first_line = true;
/**
* Current status bar label
*
* @var string $label
*/
protected $label;
/**
* Force a redraw every time
*
* @var boolean $force_redraw
*/
protected $force_redraw = false;
/**
* If they pass in a total, set the total
*
* @param integer $total
*/
public function __construct($total = null)
{
}
/**
* Set the total property
*
* @param integer $total
*
* @return Progress
*/
public function total($total)
{
}
/**
* Determines the current percentage we are at and re-writes the progress bar
*
* @param integer $current
* @param mixed $label
* @throws \Exception
*/
public function current($current, $label = null)
{
}
/**
* Increments the current position we are at and re-writes the progress bar
*
* @param integer $increment The number of items to increment by
* @param string $label
*/
public function advance($increment = 1, $label = null)
{
}
/**
* Force the progress bar to redraw every time regardless of whether it has changed or not
*
* @param boolean $force
* @return Progress
*/
public function forceRedraw($force = true)
{
}
/**
* Draw the progress bar, if necessary
*
* @param string $current
* @param string $label
*/
protected function drawProgressBar($current, $label)
{
}
/**
* Build the progress bar str and return it
*
* @param integer $current
* @param string $label
*
* @return string
*/
protected function getProgressBar($current, $label)
{
}
/**
* Get the progress bar string, basically:
* =============> 50% label
*
* @param integer $current
* @param string $label
*
* @return string
*/
protected function getProgressBarStr($current, $label)
{
}
/**
* Get the string for the actual bar based on the current length
*
* @param integer $length
*
* @return string
*/
protected function getBar($length)
{
}
/**
* Get the length of the bar string based on the width of the terminal window
*
* @return integer
*/
protected function getBarStrLen()
{
}
/**
* Format the percentage so it looks pretty
*
* @param integer $percentage
* @return float
*/
protected function percentageFormatted($percentage)
{
}
/**
* Format the label so it is positioned correctly
*
* @param string $label
* @return string
*/
protected function labelFormatted($label)
{
}
/**
* Determine whether the progress bar has changed and we need to redrew
*
* @param string $percentage
* @param string $label
*
* @return boolean
*/
protected function shouldRedraw($percentage, $label)
{
}
}
}
namespace League\CLImate\TerminalObject\Router {
interface RouterInterface
{
/**
* @param $class
* @return string
*/
public function path($class);
/**
* @param $class
* @return boolean
*/
public function exists($class);
/**
* @param $obj
* @return null|\League\CLImate\TerminalObject\Dynamic\DynamicTerminalObject
*/
public function execute($obj);
/**
* @return string
*/
public function pathPrefix();
}
abstract class BaseRouter implements \League\CLImate\TerminalObject\Router\RouterInterface
{
protected $extensions = [];
/**
* Add a custom extension to CLImate
*
* @param string $key
* @param string $class
*/
public function addExtension($key, $class)
{
}
/**
* Get the full path for the class based on the key
*
* @param string $class
*
* @return string
*/
public function path($class)
{
}
/**
* Determines if the requested class is a
* valid terminal object class
*
* @param string $class
*
* @return boolean
*/
public function exists($class)
{
}
/**
* Get the full path for the terminal object class
*
* @param string $class
*
* @return string
*/
protected function getPath($class)
{
}
/**
* Get an extension by its key
*
* @param string $key
*
* @return string|false Full class path to extension
*/
protected function getExtension($key)
{
}
/**
* Get the class short name
*
* @param string $name
*
* @return string
*/
protected function shortName($name)
{
}
}
class DynamicRouter extends \League\CLImate\TerminalObject\Router\BaseRouter
{
use \League\CLImate\Util\OutputImporter;
/**
* @return string
*/
public function pathPrefix()
{
}
/**
* Execute a dynamic terminal object using given arguments
*
* @param \League\CLImate\TerminalObject\Dynamic\DynamicTerminalObject $obj
*
* @return \League\CLImate\TerminalObject\Dynamic\DynamicTerminalObject
*/
public function execute($obj)
{
}
}
class Router
{
use \League\CLImate\Decorator\Parser\ParserImporter, \League\CLImate\Settings\SettingsImporter, \League\CLImate\Util\OutputImporter, \League\CLImate\Util\UtilImporter;
/**
* An instance of the Settings Manager class
*
* @var \League\CLImate\Settings\Manager $settings;
*/
protected $settings;
/**
* An instance of the Dynamic Router class
*
* @var \League\CLImate\TerminalObject\Router\DynamicRouter $dynamic;
*/
protected $dynamic;
/**
* An instance of the Basic Router class
*
* @var \League\CLImate\TerminalObject\Router\BasicRouter $basic;
*/
protected $basic;
public function __construct(\League\CLImate\TerminalObject\Router\DynamicRouter $dynamic = null, \League\CLImate\TerminalObject\Router\BasicRouter $basic = null)
{
}
/**
* Register a custom class with the router
*
* @param string $key
* @param string $class
*/
public function addExtension($key, $class)
{
}
/**
* Check if the name matches an existing terminal object
*
* @param string $name
*
* @return boolean
*/
public function exists($name)
{
}
/**
* Execute a terminal object using given arguments
*
* @param string $name
* @param mixed $arguments
*
* @return null|\League\CLImate\TerminalObject\Basic\BasicTerminalObjectInterface
*/
public function execute($name, $arguments)
{
}
/**
* Get the object whether it's a string or already instantiated
*
* @param \League\CLImate\TerminalObject\Router\RouterInterface $router
* @param string $name
* @param array $arguments
*
* @return \League\CLImate\TerminalObject\Dynamic\DynamicTerminalObjectInterface|\League\CLImate\TerminalObject\Basic\BasicTerminalObjectInterface
*/
protected function getObject($router, $name, $arguments)
{
}
/**
* Determine which type of router we are using and return it
*
* @param string $name
*
* @return \League\CLImate\TerminalObject\Router\RouterInterface|null
*/
protected function getRouter($name)
{
}
/**
* Set the settings property
*
* @param \League\CLImate\Settings\Manager $settings
*
* @return Router
*/
public function settings(\League\CLImate\Settings\Manager $settings)
{
}
}
class ExtensionCollection
{
/**
* @var array collection
*/
protected $collection = ['basic' => [], 'dynamic' => []];
/**
* @var string $basic_interface
*/
protected $basic_interface = 'League\\CLImate\\TerminalObject\\Basic\\BasicTerminalObjectInterface';
/**
* @var string $dynamic_interface
*/
protected $dynamic_interface = 'League\\CLImate\\TerminalObject\\Dynamic\\DynamicTerminalObjectInterface';
public function __construct($key, $class)
{
}
public function collection()
{
}
/**
* Create the collection from the key/class
*
* @param string $original_key
* @param string|object|array $original_class
*
* @return type
*/
protected function createCollection($original_key, $original_class)
{
}
/**
* Convert the given class and key to an array of classes
*
* @param string|object|array $class
* @param string $key Optional custom key instead of class name
*
* @return array
*/
protected function convertToArray($key, $class)
{
}
/**
* Ensure that the extension is valid
*
* @param string|object|array $class
*/
protected function validateExtension($class)
{
}
/**
* @param string|object $class
*
* @throws \Exception if extension class does not exist
*/
protected function validateClassExists($class)
{
}
/**
* @param string|object $class
*
* @throws \Exception if extension class does not implement either Dynamic or Basic interface
*/
protected function validateClassImplementation($class)
{
}
/**
* Determine the extension key based on the class
*
* @param string|null $key
* @param string|object $class
*
* @return string
*/
protected function getKey($key, $class)
{
}
/**
* Get the type of class the extension implements
*
* @param string|object $class
*
* @return string 'basic' or 'dynamic'
*/
protected function getType($class)
{
}
}
class BasicRouter extends \League\CLImate\TerminalObject\Router\BaseRouter
{
use \League\CLImate\Util\OutputImporter;
/**
* @return string
*/
public function pathPrefix()
{
}
/**
* Execute a basic terminal object
*
* @param \League\CLImate\TerminalObject\Basic\BasicTerminalObject $obj
* @return void
*/
public function execute($obj)
{
}
}
}
namespace League\CLImate\TerminalObject\Basic {
interface BasicTerminalObjectInterface
{
public function result();
public function settings();
/**
* @param $setting
* @return void
*/
public function importSetting($setting);
/**
* @return boolean
*/
public function sameLine();
/**
* @param \League\CLImate\Decorator\Parser\Parser $parser
*/
public function parser(\League\CLImate\Decorator\Parser\Parser $parser);
/**
* @param UtilFactory $util
*/
public function util(\League\CLImate\Util\UtilFactory $util);
}
abstract class BasicTerminalObject implements \League\CLImate\TerminalObject\Basic\BasicTerminalObjectInterface
{
use \League\CLImate\Settings\SettingsImporter, \League\CLImate\Decorator\Parser\ParserImporter, \League\CLImate\Util\UtilImporter;
/**
* Set the property if there is a valid value
*
* @param string $key
* @param string $value
*/
protected function set($key, $value)
{
}
/**
* Get the parser for the current object
*
* @return \League\CLImate\Decorator\Parser\Parser
*/
public function getParser()
{
}
/**
* Check if this object requires a new line to be added after the output
*
* @return boolean
*/
public function sameLine()
{
}
}
class Out extends \League\CLImate\TerminalObject\Basic\BasicTerminalObject
{
/**
* The content to output
*
* @var string $content
*/
protected $content;
public function __construct($content)
{
}
/**
* Return the content to output
*
* @return string
*/
public function result()
{
}
}
class Inline extends \League\CLImate\TerminalObject\Basic\Out
{
/**
* Check if this object requires a new line should be added after the output
*
* @return boolean
*/
public function sameLine()
{
}
}
class Columns extends \League\CLImate\TerminalObject\Basic\BasicTerminalObject
{
use \League\CLImate\TerminalObject\Helper\StringLength;
/**
* Number of columns
*
* @var integer $column_count
*/
protected $column_count;
/**
* Data to columnize
*
* @var array $data
*/
protected $data;
public function __construct($data, $column_count = null)
{
}
/**
* Calculate the number of columns organize data
*
* @return array
*/
public function result()
{
}
/**
* Get columns for a regular array
*
* @return array
*/
protected function columns()
{
}
/**
* Re-configure the data into it's final form
*/
protected function setData()
{
}
/**
* Re-configure an array of arrays into column arrays
*/
protected function setArrayOfArraysData()
{
}
/**
* Get columns for an associative array
*
* @return array
*/
protected function associativeColumns()
{
}
/**
* Get the row of data
*
* @param integer $key
* @param array $column_widths
*
* @return string
*/
protected function getRow($key, $column_widths)
{
}
/**
* Get the standard column width
*
* @param array $data
*
* @return integer
*/
protected function getColumnWidth($data)
{
}
/**
* Get an array of each column's width
*
* @return array
*/
protected function getColumnWidths()
{
}
/**
* Set the count property
*
* @param integer $column_width
*/
protected function setColumnCount($column_width)
{
}
/**
* Set the count property via an array
*
* @param array $items
*/
protected function setColumnCountViaArray($items)
{
}
/**
* Get the number of rows per column
*
* @param integer $column_width
*
* @return integer
*/
protected function getMaxRows($column_width)
{
}
}
class Table extends \League\CLImate\TerminalObject\Basic\BasicTerminalObject
{
use \League\CLImate\TerminalObject\Helper\StringLength;
/**
* The data for the table, an array of (arrays|objects)
*
* @var array $data
*/
protected $data = [];
/**
* An array of the widths of each column in the table
*
* @var array $column_widths
*/
protected $column_widths = [];
/**
* The width of the table
*
* @var integer $table_width
*/
protected $table_width = 0;
/**
* The divider between table cells
*
* @var string $column_divider
*/
protected $column_divider = ' | ';
/**
* The border to divide each row of the table
*
* @var string $border
*/
protected $border;
/**
* The array of rows that will ultimately be returned
*
* @var array $rows
*/
protected $rows = [];
public function __construct(array $data)
{
}
/**
* Return the built rows
*
* @return array
*/
public function result()
{
}
/**
* Determine the width of the table
*
* @return integer
*/
protected function getWidth()
{
}
/**
* Get the border for each row based on the table width
*/
protected function getBorder()
{
}
/**
* Check for a header row (if it's an array of associative arrays or objects),
* if there is one, tack it onto the front of the rows array
*/
protected function buildHeaderRow()
{
}
/**
* Get table row
*
* @param mixed $columns
*
* @return string
*/
protected function buildRow($columns)
{
}
/**
* Build the string for this particular table cell
*
* @param mixed $key
* @param string $column
*
* @return string
*/
protected function buildCell($key, $column)
{
}
/**
* Get the header row for the table if it's an associative array or object
*
* @return mixed
*/
protected function getHeaderRow()
{
}
/**
* Determine the width of each column
*
* @return array
*/
protected function getColumnWidths()
{
}
/**
* Set up an array of default column widths
*
* @param array $columns
*
* @return array
*/
protected function getDefaultColumnWidths(array $columns)
{
}
/**
* Determine the width of the columns without tags
*
* @param array $current_width
* @param string $str
*
* @return integer
*/
protected function getCellWidth($current_width, $str)
{
}
}
class Flank extends \League\CLImate\TerminalObject\Basic\BasicTerminalObject
{
/**
* The string that will be flanked
*
* @var string $str
*/
protected $str;
/**
* The character(s) to repeat on either side of the string
*
* @var string $char
*/
protected $char = '#';
/**
* How many times the character(s) should be repeated on either side
*
* @var integer $repeat
*/
protected $repeat = 3;
public function __construct($str, $char = null, $repeat = null)
{
}
/**
* Set the character(s) to repeat on either side
*
* @param string $char
*
* @return Flank
*/
public function char($char)
{
}
/**
* Set the repeat of the flank character(s)
*
* @param integer $repeat
*
* @return Flank
*/
public function repeat($repeat)
{
}
/**
* Return the flanked string
*
* @return string
*/
public function result()
{
}
}
class Dump extends \League\CLImate\TerminalObject\Basic\BasicTerminalObject
{
/**
* The data to convert to JSON
*
* @var mixed $data
*/
protected $data;
public function __construct($data)
{
}
/**
* Return the data as JSON
*
* @return string
*/
public function result()
{
}
}
abstract class Repeatable extends \League\CLImate\TerminalObject\Basic\BasicTerminalObject
{
/**
* How many times the element should be repeated
*
* @var integer
*/
protected $count;
public function __construct($count = 1)
{
}
}
/**
* Tab class to enable tabs to be output without using the escape character.
*/
class Tab extends \League\CLImate\TerminalObject\Basic\Repeatable
{
/**
* Check if this object requires a new line should be added after the output.
*
* @return boolean
*/
public function sameLine()
{
}
/**
* Return the relevant number of tab characters.
*
* @return string
*/
public function result()
{
}
}
class Br extends \League\CLImate\TerminalObject\Basic\Repeatable
{
/**
* Return an empty string
*
* @return string
*/
public function result()
{
}
}
class Json extends \League\CLImate\TerminalObject\Basic\BasicTerminalObject
{
/**
* The data to convert to JSON
*
* @var mixed $data
*/
protected $data;
public function __construct($data)
{
}
/**
* Return the data as JSON
*
* @return string
*/
public function result()
{
}
}
class Clear extends \League\CLImate\TerminalObject\Basic\BasicTerminalObject
{
/**
* Clear the terminal
*
* @return string
*/
public function result()
{
}
public function sameLine()
{
}
}
class Draw extends \League\CLImate\TerminalObject\Basic\BasicTerminalObject
{
use \League\CLImate\TerminalObject\Helper\Art;
public function __construct($art)
{
}
/**
* Return the art
*
* @return array
*/
public function result()
{
}
}
class Border extends \League\CLImate\TerminalObject\Basic\BasicTerminalObject
{
/**
* The character to repeat for the border
*
* @var string $char
*/
protected $char = '-';
/**
* The length of the border
*
* @var integer $length
*/
protected $length;
public function __construct($char = null, $length = null)
{
}
/**
* Set the character to repeat for the border
*
* @param string $char
*
* @return Border
*/
public function char($char)
{
}
/**
* Set the length of the border
*
* @param integer $length
*
* @return Border
*/
public function length($length)
{
}
/**
* Return the border
*
* @return string
*/
public function result()
{
}
}
}
namespace League\CLImate\Util\Reader {
interface ReaderInterface
{
/**
* @return string
*/
public function line();
/**
* @return string
*/
public function multiLine();
}
class Stdin implements \League\CLImate\Util\Reader\ReaderInterface
{
protected $stdIn = false;
/**
* Read the line typed in by the user
*
* @return string
*/
public function line()
{
}
/**
* Read from STDIN until EOF (^D) is reached
*
* @return string
*/
public function multiLine()
{
}
/**
* Read one character
*
* @param int $count
*
* @return string
*/
public function char($count = 1)
{
}
/**
* Read the line, but hide what the user is typing
*
* @return string
*/
public function hidden()
{
}
/**
* Return a valid STDIN, even if it previously EOF'ed
*
* Lazily re-opens STDIN after hitting an EOF
*
* @return resource
* @throws \Exception
*/
protected function getStdIn()
{
}
/**
* Attempt to set the stdin property
*
* @throws \Exception
*/
protected function setStdIn()
{
}
}
}
namespace League\CLImate\Util {
class Helper
{
/**
* @param string|array $var
*
* @return array
*/
public static function toArray($var)
{
}
/**
* Flatten a multi-dimensional array
*
* @param array $arr
*
* @return array
*/
public static function flatten(array $arr)
{
}
/**
* Convert a string to snake case
*
* @param string $str
*
* @return string
*/
public static function snakeCase($str)
{
}
}
class Output
{
/**
* The content to be output
*
* @var string $content
*/
protected $content;
/**
* Whether or not to add a new line after the output
*
* @var boolean $new_line
*/
protected $new_line = true;
/**
* The array of available writers
*
* @var array[] $writers
*/
protected $writers = [];
/**
* Default writers when one isn't specifed
*
* @var WriterInterface[] $default
*/
protected $default = [];
/**
* Writers to be used just once
*
* @var null|array $once
*/
protected $once;
protected $persist = false;
public function __construct()
{
}
/**
* Dictate that a new line should not be added after the output
*/
public function sameLine()
{
}
/**
* Add a writer to the available writers
*
* @param string $key
* @param WriterInterface|array $writer
*
* @return \League\CLImate\Util\Output
*/
public function add($key, $writer)
{
}
/**
* Set the default writer
*
* @param string|array $keys
*/
public function defaultTo($keys)
{
}
/**
* Add a default writer
*
* @param string|array $keys
*/
public function addDefault($keys)
{
}
/**
* Register a writer to be used just once
*
* @param string|array $keys
*
* @return \League\CLImate\Util\Output
*/
public function once($keys)
{
}
/**
* Persist or un-persist one time writers (for multi-line output)
*
* @param bool $persist
*
* @return \League\CLImate\Util\Output
*/
public function persist($persist = true)
{
}
/**
* Get a specific writer
*
* @throws \Exception if writer key doesn't exist
* @param string $writer
*
* @return WriterInterface|array
*/
public function get($writer)
{
}
/**
* Get the currently available writers
*
* @return array
*/
public function getAvailable()
{
}
/**
* Write the content using the provided writer
*
* @param string $content
*/
public function write($content)
{
}
/**
* Resolve the writer(s) down to an array of WriterInterface classes
*
* @param WriterInterface|array|string $writer
*
* @return array
*/
protected function resolve($writer)
{
}
/**
* @param array $writer
*
* @return array
*/
protected function resolveArrayWriter($writer)
{
}
/**
* @param object $writer
*
* @return WriterInterface|false
*/
protected function resolveObjectWriter($writer)
{
}
/**
* @param string $writer
*
* @return array|false
*/
protected function resolveStringWriter($writer)
{
}
/**
* @param mixed $writer
* @throws \Exception For non-valid writer
*/
protected function handleUnknownWriter($writer)
{
}
/**
* Get the readable version of the writer(s)
*
* @param array $writer
*
* @return string|array
*/
protected function getReadable(array $writer)
{
}
/**
* Get the writers based on their keys
*
* @param string|array $keys
*
* @return array
*/
protected function getWriters($keys)
{
}
/**
* @return WriterInterface[]
*/
protected function getCurrentWriters()
{
}
/**
* Reset anything only used for the current content being written
*/
protected function resetOneTimers()
{
}
}
}
namespace League\CLImate\Util\Writer {
interface WriterInterface
{
/**
* @param string $content
*
* @return void
*/
public function write($content);
}
class StdOut implements \League\CLImate\Util\Writer\WriterInterface
{
/**
* Write the content to the stream
*
* @param string $content
*/
public function write($content)
{
}
}
class StdErr implements \League\CLImate\Util\Writer\WriterInterface
{
/**
* Write the content to the stream
*
* @param string $content
*/
public function write($content)
{
}
}
class File implements \League\CLImate\Util\Writer\WriterInterface
{
/** @var resource|string */
protected $resource;
/** @var boolean $close_locally */
protected $close_locally = false;
/** @var boolean $use_locking */
protected $use_locking = false;
/** @var boolean $gzip_file */
protected $gzip_file = false;
/**
* @param string|resource $resource
* @param bool $use_locking
* @param bool $gzip_file
*/
public function __construct($resource, $use_locking = false, $gzip_file = false)
{
}
public function lock()
{
}
public function gzipped()
{
}
/**
* Write the content to the stream
*
* @param string $content
*/
public function write($content)
{
}
protected function getResource()
{
}
protected function openResource()
{
}
public function _destruct()
{
}
}
class Buffer implements \League\CLImate\Util\Writer\WriterInterface
{
/**
* @var string $contents The buffered data.
*/
protected $contents = "";
/**
* Write the content to the buffer.
*
* @param string $content
*
* @return void
*/
public function write($content)
{
}
/**
* Get the buffered data.
*
* @return string
*/
public function get()
{
}
/**
* Clean the buffer and throw away any data.
*
* @return void
*/
public function clean()
{
}
}
}
namespace League\CLImate\Util\System {
class SystemFactory
{
/**
* @var \League\CLImate\Util\System\System $instance
*/
protected static $instance;
/**
* Get an instance of the appropriate System class
*
* @return \League\CLImate\Util\System\System
*/
public static function getInstance()
{
}
/**
* Set the $instance property to the appropriate system
*
* @return \League\CLImate\Util\System\System
*/
protected static function getSystem()
{
}
}
abstract class System
{
protected $force_ansi;
/**
* Force ansi on or off
*
* @param bool $force
*/
public function forceAnsi($force = true)
{
}
/**
* @return integer|null
*/
public abstract function width();
/**
* @return integer|null
*/
public abstract function height();
/**
* Check if the stream supports ansi escape characters.
*
* @return bool
*/
protected abstract function systemHasAnsiSupport();
/**
* Check if we are forcing ansi, fallback to system support
*
* @return bool
*/
public function hasAnsiSupport()
{
}
/**
* Wraps exec function, allowing the dimension methods to decouple
*
* @param string $command
* @param boolean $full
*
* @return string|array
*/
public function exec($command, $full = false)
{
}
}
class Linux extends \League\CLImate\Util\System\System
{
/**
* Get the width of the terminal
*
* @return integer|null
*/
public function width()
{
}
/**
* Get the height of the terminal
*
* @return integer|null
*/
public function height()
{
}
/**
* Determine if system has access to bash commands
*
* @return bool
*/
public function canAccessBash()
{
}
/**
* Display a hidden response prompt and return the response
*
* @param string $prompt
*
* @return string
*/
public function hiddenResponsePrompt($prompt)
{
}
/**
* Determine if dimension is numeric and return it
*
* @param integer|string|null $dimension
*
* @return integer|null
*/
protected function getDimension($dimension)
{
}
/**
* Check if the stream supports ansi escape characters.
*
* Based on https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Console/Output/StreamOutput.php
*
* @return bool
*/
protected function systemHasAnsiSupport()
{
}
}
class Windows extends \League\CLImate\Util\System\System
{
/**
* Get the width of the terminal
*
* @return integer|null
*/
public function width()
{
}
/**
* Get the height of the terminal
*
* @return integer|null
*/
public function height()
{
}
/**
* Get specified terminal dimension
*
* @param string $key
*
* @return integer|null
*/
protected function getDimension($key)
{
}
/**
* Get information about the dimensions of the terminal
*
* @return array
*/
protected function getDimensions()
{
}
/**
* Check if the stream supports ansi escape characters.
*
* Based on https://github.com/symfony/symfony/blob/master/src/Symfony/Component/Console/Output/StreamOutput.php
*
* @return bool
*/
protected function systemHasAnsiSupport()
{
}
}
}
namespace League\CLImate\Util {
class UtilFactory
{
/**
* A instance of the appropriate System class
*
* @var \League\CLImate\Util\System\System
*/
public $system;
/**
* A instance of the Cursor class
*
* @var \League\CLImate\Util\Cursor
*/
public $cursor;
public function __construct(\League\CLImate\Util\System\System $system = null, \League\CLImate\Util\Cursor $cursor = null)
{
}
/**
* Get the width of the terminal
*
* @return integer
*/
public function width()
{
}
/**
* Get the height of the terminal
*
* @return integer
*/
public function height()
{
}
/**
* Determine if the value is numeric, fallback to a default if not
*
* @param integer|null $dimension
* @param integer $default
*
* @return integer
*/
protected function getDimension($dimension, $default)
{
}
}
class Cursor
{
/**
* Move the cursor up in the terminal x number of lines.
*
* @param int $lines
*
* @return string
*/
public function up($lines = 1)
{
}
/**
* Move the cursor left in the terminal x number of columns.
*
* @param int $cols
*
* @return string
*/
public function left($cols = 1)
{
}
/**
* Move cursor to the beginning of the current line.
*
* @return string
*/
public function startOfCurrentLine()
{
}
/**
* Delete the current line to the end.
*
* @return string
*/
public function deleteCurrentLine()
{
}
/**
* Get the style for hiding the cursor
*
* @return string
*/
public function hide()
{
}
/**
* Get the style for returning the cursor to its default
*
* @return string
*/
public function defaultStyle()
{
}
}
}
namespace League\CLImate\Argument {
class Manager
{
/**
* An array of arguments passed to the program.
*
* @var Argument[] $arguments
*/
protected $arguments = [];
/**
* A program's description.
*
* @var string $description
*/
protected $description;
/**
* Filter class to find various types of arguments
*
* @var \League\CLImate\Argument\Filter $filter
*/
protected $filter;
/**
* Summary builder class
*
* @var \League\CLImate\Argument\Summary $summary
*/
protected $summary;
/**
* Argument parser class
*
* @var \League\CLImate\Argument\Parser $parser
*/
protected $parser;
public function __construct()
{
}
/**
* Add an argument.
*
* @throws \Exception if $argument isn't an array or Argument object.
* @param Argument|string|array $argument
* @param $options
*/
public function add($argument, array $options = [])
{
}
/**
* Add multiple arguments to a CLImate script.
*
* @param array $arguments
*/
protected function addMany(array $arguments = [])
{
}
/**
* Determine if an argument exists.
*
* @param string $name
* @return bool
*/
public function exists($name)
{
}
/**
* Retrieve an argument's value.
*
* @param string $name
* @return string|int|float|bool|null
*/
public function get($name)
{
}
/**
* Retrieve all arguments.
*
* @return Argument[]
*/
public function all()
{
}
/**
* Determine if an argument has been defined on the command line.
*
* This can be useful for making sure an argument is present on the command
* line before parse()'ing them into argument objects.
*
* @param string $name
* @param array $argv
*
* @return bool
*/
public function defined($name, array $argv = null)
{
}
/**
* Check if the defined argument matches the command argument.
*
* @param Argument $argument
* @param string $command_argument
*
* @return bool
*/
protected function isArgument($argument, $command_argument)
{
}
/**
* Retrieve all arguments as key/value pairs.
*
* @return array
*/
public function toArray()
{
}
/**
* Set a program's description.
*
* @param string $description
*/
public function description($description)
{
}
/**
* Output a script's usage statement.
*
* @param CLImate $climate
* @param array $argv
*/
public function usage(\League\CLImate\CLImate $climate, array $argv = null)
{
}
/**
* Parse command line arguments into CLImate arguments.
*
* @throws \Exception if required arguments aren't defined.
* @param array $argv
*/
public function parse(array $argv = null)
{
}
/**
* Get the trailing arguments
*
* @return string|null
*/
public function trailing()
{
}
}
class Summary
{
/**
* @var \League\CLImate\CLImate $climate
*/
protected $climate;
/**
* @var string $description
*/
protected $description;
/**
* @var string $command
*/
protected $command;
/**
* @var Filter $filter
*/
protected $filter;
/**
* @param \League\CLImate\CLImate $climate
*
* @return \League\CLImate\Argument\Summary
*/
public function setClimate(\League\CLImate\CLImate $climate)
{
}
/**
* @param string $description
*
* @return \League\CLImate\Argument\Summary
*/
public function setDescription($description)
{
}
/**
* @param string $command
*
* @return \League\CLImate\Argument\Summary
*/
public function setCommand($command)
{
}
/**
* @param Filter $filter
* @param Argument[] $arguments
*
* @return \League\CLImate\Argument\Summary
*/
public function setFilter($filter, $arguments)
{
}
/**
* Output the full summary for the program
*/
public function output()
{
}
/**
* Build a short summary of a list of arguments.
*
* @param Argument[] $arguments
*
* @return string
*/
public function short($arguments)
{
}
/**
* Build an argument's summary for use in a usage statement.
*
* For example, "-u username, --user username", "--force", or
* "-c count (default: 7)".
*
* @param Argument $argument
*
* @return string
*/
public function argument(\League\CLImate\Argument\Argument $argument)
{
}
/**
* Build argument summary surrounded by brackets
*
* @param Argument $argument
*
* @return string
*/
protected function argumentBracketed(\League\CLImate\Argument\Argument $argument)
{
}
/**
* Get the arguments ordered by whether or not they have a prefix
*
* @return Argument[]
*/
protected function getOrderedArguments()
{
}
/**
* Print out the argument list
*
* @param array $arguments
* @param string $type
*/
protected function outputArguments($arguments, $type)
{
}
/**
* Builds the summary for any prefixed arguments
*
* @param Argument $argument
*
* @return string
*/
protected function prefixedArguments(\League\CLImate\Argument\Argument $argument)
{
}
}
class Filter
{
protected $arguments = [];
/**
* Set the available arguments
*
* @param array $arguments
*/
public function setArguments(array $arguments)
{
}
/**
* Retrieve optional arguments
*
* @return Argument[]
*/
public function optional()
{
}
/**
* Retrieve required arguments
*
* @return Argument[]
*/
public function required()
{
}
/**
* Retrieve arguments with prefix
*
* @return Argument[]
*/
public function withPrefix()
{
}
/**
* Retrieve arguments without prefix
*
* @return Argument[]
*/
public function withoutPrefix()
{
}
/**
* Find all required arguments that don't have values after parsing.
*
* These arguments weren't defined on the command line.
*
* @return Argument[]
*/
public function missing()
{
}
/**
* Filter defined arguments as to whether they are required or not
*
* @param string[] $filters
*
* @return Argument[]
*/
protected function filterArguments($filters = [])
{
}
/**
* Determine whether an argument as a prefix
*
* @param Argument $argument
*
* @return bool
*/
protected function noPrefix($argument)
{
}
/**
* Determine whether an argument as a prefix
*
* @param Argument $argument
*
* @return bool
*/
protected function hasPrefix($argument)
{
}
/**
* Determine whether an argument is required
*
* @param Argument $argument
*
* @return bool
*/
protected function isRequired($argument)
{
}
/**
* Determine whether an argument is optional
*
* @param Argument $argument
*
* @return bool
*/
protected function isOptional($argument)
{
}
/**
* Determine whether an argument is optional
*
* @param Argument $argument
*
* @return bool
*/
protected function noValue($argument)
{
}
/**
* Compare two arguments by their short and long prefixes.
*
* @see usort()
*
* @param Argument $a
* @param Argument $b
*
* @return int
*/
public function compareByPrefix(\League\CLImate\Argument\Argument $a, \League\CLImate\Argument\Argument $b)
{
}
/**
* Prep the prefix string for comparison
*
* @param Argument $argument
*
* @return string
*/
protected function prefixCompareString(\League\CLImate\Argument\Argument $argument)
{
}
}
class Argument
{
/**
* An argument's name.
*
* Use this name when internally referring to the argument.
*
* @var string
*/
protected $name;
/**
* An argument's short representation.
*
* @var string
*/
protected $prefix;
/**
* An argument's long representation.
*
* @var string
*/
protected $longPrefix;
/**
* An argument's description.
*
* @var string
*/
protected $description;
/**
* Whether or not an argument is required.
*
* @var bool
*/
protected $required = false;
/**
* Whether or not an argument only needs to be defined to have a value.
*
* These arguments have the value true when they are defined on the command
* line.
*
* @var bool
*/
protected $noValue = false;
/**
* Which data type to cast an argument's value to.
*
* Valid data types are "string", "int", "float", and "bool".
*
* @var string
*/
protected $castTo = 'string';
/**
* An argument's default value.
*
* @var string
*/
protected $defaultValue;
/**
* An argument's value, after type casting.
*
* @var string|int|float|bool
*/
protected $value;
/**
* Build a new command argument.
*
* @param string $name
*/
public function __construct($name)
{
}
/**
* Build a new command argument from an array.
*
* @param string $name
* @param array $params
*
* @return Argument
*/
public static function createFromArray($name, array $params)
{
}
/**
* Get argument params based on settable properties
*
* @param array $params
*
* @return array
*/
protected static function getSettableArgumentParams(array $params)
{
}
/**
* Retrieve an argument's name.
*
* Use this name when internally referring to the argument.
*
* @return string
*/
public function name()
{
}
/**
* Set an argument's name.
*
* Use this name when internally referring to the argument.
*
* @param string $name
*/
protected function setName($name)
{
}
/**
* Retrieve an argument's short form.
*
* @return string
*/
public function prefix()
{
}
/**
* Set an argument's short form.
*
* @param string $prefix
*/
protected function setPrefix($prefix)
{
}
/**
* Retrieve an argument's long form.
*
* @return string
*/
public function longPrefix()
{
}
/**
* Set an argument's short form.
*
* @param string $longPrefix
*/
protected function setLongPrefix($longPrefix)
{
}
/**
* Determine if an argument has a prefix.
*
* @return bool
*/
public function hasPrefix()
{
}
/**
* Retrieve an argument's description.
*
* @return string
*/
public function description()
{
}
/**
* Set an argument's description.
*
* @param string $description
*/
protected function setDescription($description)
{
}
/**
* Determine whether or not an argument is required.
*
* @return bool
*/
public function isRequired()
{
}
/**
* Set whether an argument is required or not.
*
* @param bool $required
*/
protected function setRequired($required)
{
}
/**
* Determine whether or not an argument only needs to be defined to have a
* value.
*
* @return bool
*/
public function noValue()
{
}
/**
* Set whether or not an argument only needs to be defined to have a value.
*
* @param bool $noValue
*/
protected function setNoValue($noValue)
{
}
/**
* Retrieve the data type to cast an argument's value to.
*
* @return string
*/
public function castTo()
{
}
/**
* Set the data type to cast an argument's value to.
*
* Valid data types are "string", "int", "float", and "bool".
*
* @throws \Exception if $castTo is not a valid data type.
* @param string $castTo
*/
protected function setCastTo($castTo)
{
}
/**
* Retrieve an argument's default value.
*
* @return string
*/
public function defaultValue()
{
}
/**
* Set an argument's default value.
*
* @param string $defaultValue
*/
public function setDefaultValue($defaultValue)
{
}
/**
* Retrieve an argument's value.
*
* Argument values are type cast based on the value of $castTo.
*
* @return string|int|float|bool
*/
public function value()
{
}
/**
* Set an argument's value based on its command line entry.
*
* Argument values are type cast based on the value of $castTo.
*
* @param string|bool $value
*/
public function setValue($value)
{
}
/**
* @param string $value
*
* @return string
*/
protected function castToString($value)
{
}
/**
* @param string $value
*
* @return int
*/
protected function castToInt($value)
{
}
/**
* @param string $value
*
* @return float
*/
protected function castToFloat($value)
{
}
/**
* @param string $value
*
* @return bool
*/
protected function castToBool($value)
{
}
}
class Parser
{
/**
* Filter class to find various types of arguments
*
* @var \League\CLImate\Argument\Filter $filter
*/
protected $filter;
/**
* Summary builder class
*
* @var \League\CLImate\Argument\Summary $summary
*/
protected $summary;
protected $trailing;
public function __construct()
{
}
/**
* @param Filter $filter
* @param Argument[] $arguments
*
* @return \League\CLImate\Argument\Parser
*/
public function setFilter($filter, $arguments)
{
}
/**
* Parse command line arguments into CLImate arguments.
*
* @throws \Exception if required arguments aren't defined.
* @param array $argv
*/
public function parse(array $argv = null)
{
}
/**
* Get the command name.
*
* @param array $argv
*
* @return string
*/
public function command(array $argv = null)
{
}
/**
* Get the passed arguments.
*
* @param array $argv
*
* @return array
*/
public function arguments(array $argv = null)
{
}
/**
* Get the trailing arguments
*
* @return string|null
*/
public function trailing()
{
}
/**
* Remove the trailing arguments from the parser and set them aside
*
* @param array $arguments
*
* @return array
*/
protected function removeTrailingArguments(array $arguments)
{
}
/**
* Parse command line options into prefixed CLImate arguments.
*
* Prefixed arguments are arguments with a prefix (-) or a long prefix (--)
* on the command line.
*
* Return the arguments passed on the command line that didn't match up with
* prefixed arguments so they can be assigned to non-prefixed arguments.
*
* @param array $argv
* @return array
*/
protected function prefixedArguments(array $argv = [])
{
}
/**
* Parse unset command line options into non-prefixed CLImate arguments.
*
* Non-prefixed arguments are parsed after the prefixed arguments on the
* command line, in the order that they're defined in the script.
*
* @param array $unParsedArguments
*/
protected function nonPrefixedArguments(array $unParsedArguments = [])
{
}
/**
* Parse the name and value of the argument passed in
*
* @param string $cliArgument
* @return string[] [$name, $value]
*/
protected function getNameAndValue($cliArgument)
{
}
/**
* Attempt to set the an argument's value and remove applicable
* arguments from array
*
* @param array $argv
* @param int $key
* @param string $passed_argument
*
* @return array The new $argv
*/
protected function trySettingArgumentValue($argv, $key, $passed_argument)
{
}
/**
* Set the argument's value
*
* @param array $argv
* @param Argument $argument
* @param int $key
* @param string|null $value
*
* @return array The new $argv
*/
protected function setArgumentValue($argv, $argument, $key, $value)
{
}
/**
* Search for argument in defined prefix arguments
*
* @param string $name
*
* @return Argument|false
*/
protected function findPrefixedArgument($name)
{
}
/**
* Pull a command name and arguments from $argv.
*
* @param array $argv
* @return array
*/
protected function getCommandAndArguments(array $argv = null)
{
}
}
}
namespace League\CLImate\Decorator\Component {
interface DecoratorInterface
{
public function add($key, $value);
/**
* @return void
*/
public function defaults();
public function get($val);
public function set($val);
public function all();
public function current();
/**
* @return void
*/
public function reset();
}
abstract class BaseDecorator implements \League\CLImate\Decorator\Component\DecoratorInterface
{
/**
* An array of defaults for the decorator
*
* @var array $defaults;
*/
protected $defaults = [];
/**
* An array of currently set codes for the decorator
*
* @var array $current;
*/
protected $current = [];
public function __construct()
{
}
/**
* Load up the defaults for this decorator
*/
public function defaults()
{
}
/**
* Reset the currently set decorator
*/
public function reset()
{
}
/**
* Retrieve the currently set codes for the decorator
*
* @return array
*/
public function current()
{
}
}
class Format extends \League\CLImate\Decorator\Component\BaseDecorator
{
/**
* The available formatting options
*
* @var array
*/
protected $formats = [];
/**
* An array of default formats
*
* @var array $defaults
*/
protected $defaults = ['bold' => 1, 'dim' => 2, 'underline' => 4, 'blink' => 5, 'invert' => 7, 'hidden' => 8];
/**
* Add a format into the mix
*
* @param string $key
* @param mixed $value
*/
public function add($key, $value)
{
}
/**
* Retrieve all of the available formats
*
* @return array
*/
public function all()
{
}
/**
* Get the code for the format
*
* @param string $val
*
* @return string
*/
public function get($val)
{
}
/**
* Set the current format
*
* @param string $val
*
* @return boolean
*/
public function set($val)
{
}
}
class Color extends \League\CLImate\Decorator\Component\BaseDecorator
{
/**
* The available colors
*
* @var array
*/
protected $colors = [];
/**
* An array of default colors
*
* @var array $defaults
*/
protected $defaults = ['default' => 39, 'black' => 30, 'red' => 31, 'green' => 32, 'yellow' => 33, 'blue' => 34, 'magenta' => 35, 'cyan' => 36, 'light_gray' => 37, 'dark_gray' => 90, 'light_red' => 91, 'light_green' => 92, 'light_yellow' => 93, 'light_blue' => 94, 'light_magenta' => 95, 'light_cyan' => 96, 'white' => 97];
/**
* Add a color into the mix
*
* @param string $key
* @param integer $value
*/
public function add($key, $value)
{
}
/**
* Retrieve all of available colors
*
* @return array
*/
public function all()
{
}
/**
* Get the code for the color
*
* @param string $val
*
* @return string
*/
public function get($val)
{
}
/**
* Set the current color
*
* @param string $val
*
* @return boolean
*/
public function set($val)
{
}
}
class BackgroundColor extends \League\CLImate\Decorator\Component\Color
{
/**
* The difference to add to a foreground color code
* to get a background color code
*
* @const integer ADD
*/
const ADD = 10;
/**
* Get the code for the requested color
*
* @param mixed $val
*
* @return mixed
*/
public function get($val)
{
}
/**
* Set the current background color
*
* @param mixed $val
*
* @return boolean
*/
public function set($val)
{
}
/**
* Get all of the available background colors
*
* @return array
*/
public function all()
{
}
/**
* Strip the color of any prefixes
*
* @param string $val
*
* @return string
*/
protected function strip($val)
{
}
}
class Command extends \League\CLImate\Decorator\Component\BaseDecorator
{
/**
* Commands that correspond to a color in the $colors property
*
* @var array
*/
public $commands = [];
/**
* The default commands available
*
* @var array $defaults
*/
protected $defaults = ['info' => 'green', 'comment' => 'yellow', 'whisper' => 'light_gray', 'shout' => 'red', 'error' => 'light_red'];
/**
* Add a command into the mix
*
* @param string $key
* @param mixed $value
*/
public function add($key, $value)
{
}
/**
* Retrieve all of the available commands
*
* @return array
*/
public function all()
{
}
/**
* Get the style that corresponds to the command
*
* @param string $val
*
* @return string
*/
public function get($val)
{
}
/**
* Set the currently used command
*
* @param string $val
*
* @return string|false
*/
public function set($val)
{
}
}
}
namespace League\CLImate\Decorator\Parser {
abstract class Parser
{
/**
* An array of the currently applied codes
*
* @var array $current;
*/
protected $current = [];
/**
* An array of the tags that should be searched for
* and their corresponding replacements
*
* @var \League\CLImate\Decorator\Tags $tags
*/
public $tags;
public function __construct(array $current, \League\CLImate\Decorator\Tags $tags)
{
}
/**
* Wrap the string in the current style
*
* @param string $str
*
* @return string
*/
public abstract function apply($str);
}
class Ansi extends \League\CLImate\Decorator\Parser\Parser
{
/**
* Wrap the string in the current style
*
* @param string $str
*
* @return string
*/
public function apply($str)
{
}
/**
* Get the string that begins the style
*
* @param string $codes
* @return string
*/
protected function start($codes = null)
{
}
/**
* Get the string that ends the style
*
* @param string|array $codes
* @return string
*/
protected function end($codes = null)
{
}
/**
* Wrap the code string in the full escaped sequence
*
* @param string $codes
*
* @return string
*/
protected function wrapCodes($codes)
{
}
/**
* Parse the string for tags and replace them with their codes
*
* @param string $str
*
* @return string
*/
protected function parse($str)
{
}
/**
* Parse the given string for the tags and replace them with the appropriate codes
*
* @param string $str
* @param array $tags
*
* @return string
*/
protected function parseTags($str, $tags)
{
}
/**
* Replace the tag in the str
*
* @param string $str
* @param string $tag
* @param array $history
*
* @return string
*/
protected function replaceTag($str, $tag, &$history)
{
}
/**
* Stringify the codes
*
* @param mixed $codes
*
* @return string
*/
protected function codeStr($codes)
{
}
/**
* Retrieve the current style code
*
* @return string
*/
protected function currentCode()
{
}
}
class ParserFactory
{
/**
* Get an instance of the appropriate Parser class
*
* @param System $system
* @param array $current
* @param Tags $tags
* @return Parser
*/
public static function getInstance(\League\CLImate\Util\System\System $system, array $current, \League\CLImate\Decorator\Tags $tags)
{
}
}
class NonAnsi extends \League\CLImate\Decorator\Parser\Parser
{
/**
* Strip the string of any tags
*
* @param string $str
*
* @return string
*/
public function apply($str)
{
}
}
}
namespace League\CLImate\Decorator {
class Tags
{
/**
* Original keys passed in to build tags
*
* @var array $tags
*/
protected $keys = [];
/**
* Available tags and their values
*
* @var array $tags
*/
protected $tags = [];
public function __construct(array $keys)
{
}
/**
* Get all available tags
*
* @return array
*/
public function all()
{
}
/**
* Get the value of the requested tag
*
* @param string $key
*
* @return string|null
*/
public function value($key)
{
}
/**
* Get the regular expression that can be used to parse the string for tags
*
* @return string
*/
public function regex()
{
}
/**
* Build the search and replace for all of the various style tags
*/
protected function build()
{
}
}
/**
* @method void addColor(string $color, integer $code)
* @method void addFormat(string $format, integer $code)
* @method void addCommand(string $command, mixed $style)
*/
class Style
{
/**
* An array of Decorator objects
*
* @var Component\DecoratorInterface[] $style
*/
protected $style = [];
/**
* An array of the available Decorators
* and their corresponding class names
*
* @var array $available
*/
protected $available = ['format' => 'Format', 'color' => 'Color', 'background' => 'BackgroundColor', 'command' => 'Command'];
protected $parser;
/**
* An array of the current styles applied
*
* @var array $current
*/
protected $current = [];
public function __construct()
{
}
/**
* Get all of the styles available
*
* @return array
*/
public function all()
{
}
/**
* Attempt to get the corresponding code for the style
*
* @param mixed $key
*
* @return mixed
*/
public function get($key)
{
}
/**
* Attempt to set some aspect of the styling,
* return true if attempt was successful
*
* @param string $key
*
* @return boolean
*/
public function set($key)
{
}
/**
* Reset the current styles applied
*
*/
public function reset()
{
}
/**
* Get a new instance of the Parser class based on the current settings
*
* @param \League\CLImate\Util\System\System $system
*
* @return \League\CLImate\Decorator\Parser\Parser
*/
public function parser(\League\CLImate\Util\System\System $system)
{
}
/**
* Compile an array of the current codes
*
* @return array
*/
public function current()
{
}
/**
* Make sure that the code is an integer, if not let's try and get it there
*
* @param mixed $code
*
* @return boolean
*/
protected function validateCode($code)
{
}
/**
* Validate an array of codes
*
* @param array $codes
*
* @return boolean
*/
protected function validateCodeArray(array $codes)
{
}
/**
* Convert the array of codes to integers
*
* @param array $codes
* @return array
*/
protected function convertToCodes(array $codes)
{
}
/**
* Retrieve the integers from the mixed code input
*
* @param string|array $code
*
* @return integer|array
*/
protected function getCode($code)
{
}
/**
* Retrieve an array of integers from the array of codes
*
* @param array $codes
*
* @return array
*/
protected function getCodeArray(array $codes)
{
}
/**
* Parse the add method for the style they are trying to add
*
* @param string $method
*
* @return string
*/
protected function parseAddMethod($method)
{
}
/**
* Add a custom style
*
* @param string $style
* @param string $key
* @param string $value
*/
protected function add($style, $key, $value)
{
}
/**
* Magic Methods
*
* List of possible magic methods are at the top of this class
*
* @param string $requested_method
* @param array $arguments
*/
public function __call($requested_method, $arguments)
{
}
}
}
namespace League\CLImate\Settings {
class Manager
{
/**
* An array of settings that have been... set
*
* @var array $settings
*/
protected $settings = [];
/**
* Check and see if the requested setting is a valid, registered setting
*
* @param string $name
*
* @return boolean
*/
public function exists($name)
{
}
/**
* Add a setting
*
* @param string $name
* @param mixed $value
*/
public function add($name, $value)
{
}
/**
* Get the value of the requested setting if it exists
*
* @param string $key
*
* @return mixed
*/
public function get($key)
{
}
/**
* Get the short name for the requested settings class
*
* @param string $name
*
* @return string
*/
protected function getPath($name)
{
}
/**
* Get the short class name for the setting
*
* @param string $name
*
* @return string
*/
protected function getClassName($name)
{
}
}
interface SettingsInterface
{
/**
* @return void
*/
public function add();
}
class Art implements \League\CLImate\Settings\SettingsInterface
{
/**
* An array of valid art directories
* @var array[] $dirs
*/
public $dirs = [];
/**
* Add directories of art
*/
public function add()
{
}
}
}
namespace League\Plates {
/**
* Template API and environment settings storage.
*/
class Engine
{
/**
* Default template directory.
* @var Directory
*/
protected $directory;
/**
* Template file extension.
* @var FileExtension
*/
protected $fileExtension;
/**
* Collection of template folders.
* @var Folders
*/
protected $folders;
/**
* Collection of template functions.
* @var Functions
*/
protected $functions;
/**
* Collection of preassigned template data.
* @var Data
*/
protected $data;
/**
* Create new Engine instance.
* @param string $directory
* @param string $fileExtension
*/
public function __construct($directory = null, $fileExtension = 'php')
{
}
/**
* Set path to templates directory.
* @param string|null $directory Pass null to disable the default directory.
* @return Engine
*/
public function setDirectory($directory)
{
}
/**
* Get path to templates directory.
* @return string
*/
public function getDirectory()
{
}
/**
* Set the template file extension.
* @param string|null $fileExtension Pass null to manually set it.
* @return Engine
*/
public function setFileExtension($fileExtension)
{
}
/**
* Get the template file extension.
* @return string
*/
public function getFileExtension()
{
}
/**
* Add a new template folder for grouping templates under different namespaces.
* @param string $name
* @param string $directory
* @param boolean $fallback
* @return Engine
*/
public function addFolder($name, $directory, $fallback = false)
{
}
/**
* Remove a template folder.
* @param string $name
* @return Engine
*/
public function removeFolder($name)
{
}
/**
* Get collection of all template folders.
* @return Folders
*/
public function getFolders()
{
}
/**
* Add preassigned template data.
* @param array $data;
* @param null|string|array $templates;
* @return Engine
*/
public function addData(array $data, $templates = null)
{
}
/**
* Get all preassigned template data.
* @param null|string $template;
* @return array
*/
public function getData($template = null)
{
}
/**
* Register a new template function.
* @param string $name;
* @param callback $callback;
* @return Engine
*/
public function registerFunction($name, $callback)
{
}
/**
* Remove a template function.
* @param string $name;
* @return Engine
*/
public function dropFunction($name)
{
}
/**
* Get a template function.
* @param string $name
* @return Func
*/
public function getFunction($name)
{
}
/**
* Check if a template function exists.
* @param string $name
* @return boolean
*/
public function doesFunctionExist($name)
{
}
/**
* Load an extension.
* @param ExtensionInterface $extension
* @return Engine
*/
public function loadExtension(\League\Plates\Extension\ExtensionInterface $extension)
{
}
/**
* Load multiple extensions.
* @param array $extensions
* @return Engine
*/
public function loadExtensions(array $extensions = array())
{
}
/**
* Get a template path.
* @param string $name
* @return string
*/
public function path($name)
{
}
/**
* Check if a template exists.
* @param string $name
* @return boolean
*/
public function exists($name)
{
}
/**
* Create a new template.
* @param string $name
* @return Template
*/
public function make($name)
{
}
/**
* Create a new template and render it.
* @param string $name
* @param array $data
* @return string
*/
public function render($name, array $data = array())
{
}
}
}
namespace League\Plates\Extension {
/**
* A common interface for extensions.
*/
interface ExtensionInterface
{
public function register(\League\Plates\Engine $engine);
}
/**
* Extension that adds a number of URI checks.
*/
class URI implements \League\Plates\Extension\ExtensionInterface
{
/**
* Instance of the current template.
* @var Template
*/
public $template;
/**
* The request URI.
* @var string
*/
protected $uri;
/**
* The request URI as an array.
* @var array
*/
protected $parts;
/**
* Create new URI instance.
* @param string $uri
*/
public function __construct($uri)
{
}
/**
* Register extension functions.
* @param Engine $engine
* @return null
*/
public function register(\League\Plates\Engine $engine)
{
}
/**
* Perform URI check.
* @param null|integer|string $var1
* @param mixed $var2
* @param mixed $var3
* @param mixed $var4
* @return mixed
*/
public function runUri($var1 = null, $var2 = null, $var3 = null, $var4 = null)
{
}
/**
* Perform a URI segment match.
* @param integer $key
* @param string $string
* @param mixed $returnOnTrue
* @param mixed $returnOnFalse
* @return mixed
*/
protected function checkUriSegmentMatch($key, $string, $returnOnTrue = null, $returnOnFalse = null)
{
}
/**
* Perform a regular express match.
* @param string $regex
* @param mixed $returnOnTrue
* @param mixed $returnOnFalse
* @return mixed
*/
protected function checkUriRegexMatch($regex, $returnOnTrue = null, $returnOnFalse = null)
{
}
}
/**
* Extension that adds the ability to create "cache busted" asset URLs.
*/
class Asset implements \League\Plates\Extension\ExtensionInterface
{
/**
* Instance of the current template.
* @var Template
*/
public $template;
/**
* Path to asset directory.
* @var string
*/
public $path;
/**
* Enables the filename method.
* @var boolean
*/
public $filenameMethod;
/**
* Create new Asset instance.
* @param string $path
* @param boolean $filenameMethod
*/
public function __construct($path, $filenameMethod = false)
{
}
/**
* Register extension function.
* @param Engine $engine
* @return null
*/
public function register(\League\Plates\Engine $engine)
{
}
/**
* Create "cache busted" asset URL.
* @param string $url
* @return string
*/
public function cachedAssetUrl($url)
{
}
}
}
namespace League\Plates\Template {
/**
* Default template directory.
*/
class Directory
{
/**
* Template directory path.
* @var string
*/
protected $path;
/**
* Create new Directory instance.
* @param string $path
*/
public function __construct($path = null)
{
}
/**
* Set path to templates directory.
* @param string|null $path Pass null to disable the default directory.
* @return Directory
*/
public function set($path)
{
}
/**
* Get path to templates directory.
* @return string
*/
public function get()
{
}
}
/**
* A collection of template functions.
*/
class Functions
{
/**
* Array of template functions.
* @var array
*/
protected $functions = array();
/**
* Add a new template function.
* @param string $name;
* @param callback $callback;
* @return Functions
*/
public function add($name, $callback)
{
}
/**
* Remove a template function.
* @param string $name;
* @return Functions
*/
public function remove($name)
{
}
/**
* Get a template function.
* @param string $name
* @return Func
*/
public function get($name)
{
}
/**
* Check if a template function exists.
* @param string $name
* @return boolean
*/
public function exists($name)
{
}
}
/**
* A template function.
*/
class Func
{
/**
* The function name.
* @var string
*/
protected $name;
/**
* The function callback.
* @var callable
*/
protected $callback;
/**
* Create new Func instance.
* @param string $name
* @param callable $callback
*/
public function __construct($name, $callback)
{
}
/**
* Set the function name.
* @param string $name
* @return Func
*/
public function setName($name)
{
}
/**
* Get the function name.
* @return string
*/
public function getName()
{
}
/**
* Set the function callback
* @param callable $callback
* @return Func
*/
public function setCallback($callback)
{
}
/**
* Get the function callback.
* @return callable
*/
public function getCallback()
{
}
/**
* Call the function.
* @param Template $template
* @param array $arguments
* @return mixed
*/
public function call(\League\Plates\Template\Template $template = null, $arguments = array())
{
}
}
/**
* A template name.
*/
class Name
{
/**
* Instance of the template engine.
* @var Engine
*/
protected $engine;
/**
* The original name.
* @var string
*/
protected $name;
/**
* The parsed template folder.
* @var Folder
*/
protected $folder;
/**
* The parsed template filename.
* @var string
*/
protected $file;
/**
* Create a new Name instance.
* @param Engine $engine
* @param string $name
*/
public function __construct(\League\Plates\Engine $engine, $name)
{
}
/**
* Set the engine.
* @param Engine $engine
* @return Name
*/
public function setEngine(\League\Plates\Engine $engine)
{
}
/**
* Get the engine.
* @return Engine
*/
public function getEngine()
{
}
/**
* Set the original name and parse it.
* @param string $name
* @return Name
*/
public function setName($name)
{
}
/**
* Get the original name.
* @return string
*/
public function getName()
{
}
/**
* Set the parsed template folder.
* @param string $folder
* @return Name
*/
public function setFolder($folder)
{
}
/**
* Get the parsed template folder.
* @return string
*/
public function getFolder()
{
}
/**
* Set the parsed template file.
* @param string $file
* @return Name
*/
public function setFile($file)
{
}
/**
* Get the parsed template file.
* @return string
*/
public function getFile()
{
}
/**
* Resolve template path.
* @return string
*/
public function getPath()
{
}
/**
* Check if template path exists.
* @return boolean
*/
public function doesPathExist()
{
}
/**
* Get the default templates directory.
* @return string
*/
protected function getDefaultDirectory()
{
}
}
/**
* Container which holds template data and provides access to template functions.
*/
class Template
{
/**
* Instance of the template engine.
* @var Engine
*/
protected $engine;
/**
* The name of the template.
* @var Name
*/
protected $name;
/**
* The data assigned to the template.
* @var array
*/
protected $data = array();
/**
* An array of section content.
* @var array
*/
protected $sections = array();
/**
* The name of the section currently being rendered.
* @var string
*/
protected $sectionName;
/**
* Whether the section should be appended or not.
* @var boolean
*/
protected $appendSection;
/**
* The name of the template layout.
* @var string
*/
protected $layoutName;
/**
* The data assigned to the template layout.
* @var array
*/
protected $layoutData;
/**
* Create new Template instance.
* @param Engine $engine
* @param string $name
*/
public function __construct(\League\Plates\Engine $engine, $name)
{
}
/**
* Magic method used to call extension functions.
* @param string $name
* @param array $arguments
* @return mixed
*/
public function __call($name, $arguments)
{
}
/**
* Alias for render() method.
* @throws \Throwable
* @throws \Exception
* @return string
*/
public function __toString()
{
}
/**
* Assign or get template data.
* @param array $data
* @return mixed
*/
public function data(array $data = null)
{
}
/**
* Check if the template exists.
* @return boolean
*/
public function exists()
{
}
/**
* Get the template path.
* @return string
*/
public function path()
{
}
/**
* Render the template and layout.
* @param array $data
* @throws \Throwable
* @throws \Exception
* @return string
*/
public function render(array $data = array())
{
}
/**
* Set the template's layout.
* @param string $name
* @param array $data
* @return null
*/
public function layout($name, array $data = array())
{
}
/**
* Start a new section block.
* @param string $name
* @return null
*/
public function start($name)
{
}
/**
* Start a new append section block.
* @param string $name
* @return null
*/
public function push($name)
{
}
/**
* Stop the current section block.
* @return null
*/
public function stop()
{
}
/**
* Alias of stop().
* @return null
*/
public function end()
{
}
/**
* Returns the content for a section block.
* @param string $name Section name
* @param string $default Default section content
* @return string|null
*/
public function section($name, $default = null)
{
}
/**
* Fetch a rendered template.
* @param string $name
* @param array $data
* @return string
*/
public function fetch($name, array $data = array())
{
}
/**
* Output a rendered template.
* @param string $name
* @param array $data
* @return null
*/
public function insert($name, array $data = array())
{
}
/**
* Apply multiple functions to variable.
* @param mixed $var
* @param string $functions
* @return mixed
*/
public function batch($var, $functions)
{
}
/**
* Escape string.
* @param string $string
* @param null|string $functions
* @return string
*/
public function escape($string, $functions = null)
{
}
/**
* Alias to escape function.
* @param string $string
* @param null|string $functions
* @return string
*/
public function e($string, $functions = null)
{
}
}
/**
* Preassigned template data.
*/
class Data
{
/**
* Variables shared by all templates.
* @var array
*/
protected $sharedVariables = array();
/**
* Specific template variables.
* @var array
*/
protected $templateVariables = array();
/**
* Add template data.
* @param array $data;
* @param null|string|array $templates;
* @return Data
*/
public function add(array $data, $templates = null)
{
}
/**
* Add data shared with all templates.
* @param array $data;
* @return Data
*/
public function shareWithAll($data)
{
}
/**
* Add data shared with some templates.
* @param array $data;
* @param array $templates;
* @return Data
*/
public function shareWithSome($data, array $templates)
{
}
/**
* Get template data.
* @param null|string $template;
* @return array
*/
public function get($template = null)
{
}
}
/**
* Template file extension.
*/
class FileExtension
{
/**
* Template file extension.
* @var string
*/
protected $fileExtension;
/**
* Create new FileExtension instance.
* @param null|string $fileExtension
*/
public function __construct($fileExtension = 'php')
{
}
/**
* Set the template file extension.
* @param null|string $fileExtension
* @return FileExtension
*/
public function set($fileExtension)
{
}
/**
* Get the template file extension.
* @return string
*/
public function get()
{
}
}
/**
* A template folder.
*/
class Folder
{
/**
* The folder name.
* @var string
*/
protected $name;
/**
* The folder path.
* @var string
*/
protected $path;
/**
* The folder fallback status.
* @var boolean
*/
protected $fallback;
/**
* Create a new Folder instance.
* @param string $name
* @param string $path
* @param boolean $fallback
*/
public function __construct($name, $path, $fallback = false)
{
}
/**
* Set the folder name.
* @param string $name
* @return Folder
*/
public function setName($name)
{
}
/**
* Get the folder name.
* @return string
*/
public function getName()
{
}
/**
* Set the folder path.
* @param string $path
* @return Folder
*/
public function setPath($path)
{
}
/**
* Get the folder path.
* @return string
*/
public function getPath()
{
}
/**
* Set the folder fallback status.
* @param boolean $fallback
* @return Folder
*/
public function setFallback($fallback)
{
}
/**
* Get the folder fallback status.
* @return boolean
*/
public function getFallback()
{
}
}
/**
* A collection of template folders.
*/
class Folders
{
/**
* Array of template folders.
* @var array
*/
protected $folders = array();
/**
* Add a template folder.
* @param string $name
* @param string $path
* @param boolean $fallback
* @return Folders
*/
public function add($name, $path, $fallback = false)
{
}
/**
* Remove a template folder.
* @param string $name
* @return Folders
*/
public function remove($name)
{
}
/**
* Get a template folder.
* @param string $name
* @return Folder
*/
public function get($name)
{
}
/**
* Check if a template folder exists.
* @param string $name
* @return boolean
*/
public function exists($name)
{
}
}
}
namespace mindplay {
/**
* Pseudo-namespace for functions that generate human-readable string representations
* of most types of PHP values.
*/
abstract class readable
{
/**
* @var int strings longer than this number of characters will be truncated when formatting string-values
*/
public static $max_string_length = 120;
/**
* @var string[] map where PHP error severity code => constant name
*/
public static $severity_names = [E_ERROR => "E_ERROR", E_USER_ERROR => "E_USER_ERROR", E_CORE_ERROR => "E_CORE_ERROR", E_COMPILE_ERROR => "E_COMPILE_ERROR", E_PARSE => "E_PARSE", E_WARNING => "E_WARNING", E_USER_WARNING => "E_USER_WARNING", E_CORE_WARNING => "E_CORE_WARNING", E_COMPILE_WARNING => "E_COMPILE_WARNING", E_NOTICE => "E_NOTICE", E_USER_NOTICE => "E_USER_NOTICE", E_STRICT => "E_STRICT", E_RECOVERABLE_ERROR => "E_RECOVERABLE_ERROR", E_DEPRECATED => "E_DEPRECATED", E_USER_DEPRECATED => "E_USER_DEPRECATED"];
/**
* @param mixed $value any type of PHP value
*
* @return string readable representation of the given value
*/
public static function value($value)
{
}
/**
* @param array $array array containing any type of PHP values
*
* @return string comma-separated human-readable representation of the given values
*/
public static function values(array $array)
{
}
/**
* @param mixed $value any type of PHP value
*
* @return string human-readable type-name
*/
public static function typeof($value)
{
}
/**
* @param mixed $callable
*
* @return string human-readable description of callback
*/
public static function callback($callable)
{
}
/**
* @param Exception|Error|Throwable|int $error an Exception, Error (or one of the E_* error severity constants)
*
* @return string
*/
public static function error($error)
{
}
/**
* @param int $severity one of the E_* error severity constants
*
* @return string
*/
public static function severity($severity)
{
}
/**
* @param array|Exception|Error|Throwable $source Exception, Error or stack-trace data as provided
* by Exception::getTrace() or by debug_backtrace()
* @param bool $with_params if TRUE, calls will be formatted with parameters
*
* @return string
*/
public static function trace($source, $with_params = true)
{
}
}
}
namespace mindplay\middleman {
/**
* PSR-7 / PSR-15 middleware dispatcher
*/
class Dispatcher implements \Interop\Http\ServerMiddleware\MiddlewareInterface
{
/**
* @param (callable|MiddlewareInterface|mixed)[] $stack middleware stack (with at least one middleware component)
* @param callable|null $resolver optional middleware resolver:
* function (string $name): MiddlewareInterface
*
* @throws InvalidArgumentException if an empty middleware stack was given
*/
public function __construct($stack, callable $resolver = null)
{
}
/**
* Dispatches the middleware stack and returns the resulting `ResponseInterface`.
*
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*
* @throws LogicException on unexpected result from any middleware on the stack
*/
public function dispatch(\Psr\Http\Message\ServerRequestInterface $request)
{
}
/**
* @inheritdoc
*/
public function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
/**
* PSR-15 delegate wrapper for internal callbacks generated by {@see Dispatcher} during dispatch.
*
* @internal
*/
class Delegate implements \Interop\Http\ServerMiddleware\DelegateInterface
{
/**
* @param callable $callback function (RequestInterface $request) : ResponseInterface
*/
public function __construct(callable $callback)
{
}
/**
* Dispatch the next available middleware and return the response.
*
* @param ServerRequestInterface $request
* @return ResponseInterface
*/
public function process(\Psr\Http\Message\ServerRequestInterface $request)
{
}
/**
* Dispatch the next available middleware and return the response.
*
* This method duplicates `next()` to provide backwards compatibility with non-PSR 15 middleware.
*
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function __invoke(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
/**
* Optionally, pass this as `$resolver` to {@see Dispatcher::__construct()} to provide
* integration with a dependency injection container - for example:
*
* $dispatcher = new Dispatcher(
* [
* RouterMiddleware::class,
* ErrorMiddleware::class,
* ],
* new InteropResolver($container)
* );
*
* Note that this resolver will ignore any middleware component that is not a string - so you
* can mix component names with regular middleware closures, callable objects, and so on.
*
* You can use class-names or other component names, depending on what your container supports.
*
* @link https://github.com/container-interop/container-interop
*/
class ContainerResolver
{
/**
* @param ContainerInterface $container
*/
public function __construct(\Interop\Container\ContainerInterface $container)
{
}
public function __invoke($name)
{
}
}
}
namespace React\Promise {
interface PromiseInterface
{
/**
* @return PromiseInterface
*/
public function then(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null);
}
interface CancellablePromiseInterface extends \React\Promise\PromiseInterface
{
/**
* @return void
*/
public function cancel();
}
class CancellationQueue
{
public function __invoke()
{
}
public function enqueue($cancellable)
{
}
}
interface ExtendedPromiseInterface extends \React\Promise\PromiseInterface
{
/**
* @return void
*/
public function done(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null);
/**
* @return ExtendedPromiseInterface
*/
public function otherwise(callable $onRejected);
/**
* @return ExtendedPromiseInterface
*/
public function always(callable $onFulfilledOrRejected);
/**
* @return ExtendedPromiseInterface
*/
public function progress(callable $onProgress);
}
class Promise implements \React\Promise\ExtendedPromiseInterface, \React\Promise\CancellablePromiseInterface
{
public function __construct(callable $resolver, callable $canceller = null)
{
}
public function then(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function done(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function otherwise(callable $onRejected)
{
}
public function always(callable $onFulfilledOrRejected)
{
}
public function progress(callable $onProgress)
{
}
public function cancel()
{
}
}
class UnhandledRejectionException extends \RuntimeException
{
public static function resolve($reason)
{
}
public function __construct($reason)
{
}
public function getReason()
{
}
}
class RejectedPromise implements \React\Promise\ExtendedPromiseInterface, \React\Promise\CancellablePromiseInterface
{
public function __construct($reason = null)
{
}
public function then(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function done(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function otherwise(callable $onRejected)
{
}
public function always(callable $onFulfilledOrRejected)
{
}
public function progress(callable $onProgress)
{
}
public function cancel()
{
}
}
class FulfilledPromise implements \React\Promise\ExtendedPromiseInterface, \React\Promise\CancellablePromiseInterface
{
public function __construct($value = null)
{
}
public function then(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function done(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function otherwise(callable $onRejected)
{
}
public function always(callable $onFulfilledOrRejected)
{
}
public function progress(callable $onProgress)
{
}
public function cancel()
{
}
}
interface PromisorInterface
{
/**
* @return PromiseInterface
*/
public function promise();
}
class Deferred implements \React\Promise\PromisorInterface
{
public function __construct(callable $canceller = null)
{
}
public function promise()
{
}
public function resolve($value = null)
{
}
public function reject($reason = null)
{
}
public function notify($update = null)
{
}
/**
* @deprecated 2.2.0
* @see Deferred::notify()
*/
public function progress($update = null)
{
}
}
}
namespace React\Promise\Exception {
class LengthException extends \LengthException
{
}
}
namespace React\Promise {
class LazyPromise implements \React\Promise\ExtendedPromiseInterface, \React\Promise\CancellablePromiseInterface
{
public function __construct(callable $factory)
{
}
public function then(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function done(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function otherwise(callable $onRejected)
{
}
public function always(callable $onFulfilledOrRejected)
{
}
public function progress(callable $onProgress)
{
}
public function cancel()
{
}
/**
* @internal
* @see Promise::settle()
*/
public function promise()
{
}
}
}
namespace Abraham\TwitterOAuth {
/**
* Handle setting and storing config for TwitterOAuth.
*
* @author Abraham Williams <abraham@abrah.am>
*/
class Config
{
/** @var int How long to wait for a response from the API */
protected $timeout = 5;
/** @var int how long to wait while connecting to the API */
protected $connectionTimeout = 5;
/**
* Decode JSON Response as associative Array
*
* @see http://php.net/manual/en/function.json-decode.php
*
* @var bool
*/
protected $decodeJsonAsArray = false;
/** @var string User-Agent header */
protected $userAgent = 'TwitterOAuth (+https://twitteroauth.com)';
/** @var array Store proxy connection details */
protected $proxy = [];
/** @var bool Whether to encode the curl requests with gzip or not */
protected $gzipEncoding = true;
/** @var integer Size for Chunked Uploads */
protected $chunkSize = 250000;
// 0.25 MegaByte
/**
* Set the connection and response timeouts.
*
* @param int $connectionTimeout
* @param int $timeout
*/
public function setTimeouts($connectionTimeout, $timeout)
{
}
/**
* @param bool $value
*/
public function setDecodeJsonAsArray($value)
{
}
/**
* @param string $userAgent
*/
public function setUserAgent($userAgent)
{
}
/**
* @param array $proxy
*/
public function setProxy(array $proxy)
{
}
/**
* Whether to encode the curl requests with gzip or not.
*
* @param boolean $gzipEncoding
*/
public function setGzipEncoding($gzipEncoding)
{
}
/**
* Set the size of each part of file for chunked media upload.
*
* @param int $value
*/
public function setChunkSize($value)
{
}
}
/**
* A class for implementing a Signature Method
* See section 9 ("Signing Requests") in the spec
*/
abstract class SignatureMethod
{
/**
* Needs to return the name of the Signature Method (ie HMAC-SHA1)
*
* @return string
*/
public abstract function getName();
/**
* Build up the signature
* NOTE: The output of this function MUST NOT be urlencoded.
* the encoding is handled in OAuthRequest when the final
* request is serialized
*
* @param Request $request
* @param Consumer $consumer
* @param Token $token
*
* @return string
*/
public abstract function buildSignature(\Abraham\TwitterOAuth\Request $request, \Abraham\TwitterOAuth\Consumer $consumer, \Abraham\TwitterOAuth\Token $token = null);
/**
* Verifies that a given signature is correct
*
* @param Request $request
* @param Consumer $consumer
* @param Token $token
* @param string $signature
*
* @return bool
*/
public function checkSignature(\Abraham\TwitterOAuth\Request $request, \Abraham\TwitterOAuth\Consumer $consumer, \Abraham\TwitterOAuth\Token $token, $signature)
{
}
}
class Util
{
/**
* @param $input
*
* @return array|mixed|string
*/
public static function urlencodeRfc3986($input)
{
}
/**
* @param string $string
*
* @return string
*/
public static function urldecodeRfc3986($string)
{
}
/**
* This function takes a input like a=b&a=c&d=e and returns the parsed
* parameters like this
* array('a' => array('b','c'), 'd' => 'e')
*
* @param string $input
*
* @return array
*/
public static function parseParameters($input)
{
}
/**
* @param array $params
*
* @return string
*/
public static function buildHttpQuery(array $params)
{
}
}
class Request
{
protected $parameters;
protected $httpMethod;
protected $httpUrl;
public static $version = '1.0';
/**
* Constructor
*
* @param string $httpMethod
* @param string $httpUrl
* @param array|null $parameters
*/
public function __construct($httpMethod, $httpUrl, array $parameters = [])
{
}
/**
* pretty much a helper function to set up the request
*
* @param Consumer $consumer
* @param Token $token
* @param string $httpMethod
* @param string $httpUrl
* @param array $parameters
*
* @return Request
*/
public static function fromConsumerAndToken(\Abraham\TwitterOAuth\Consumer $consumer, \Abraham\TwitterOAuth\Token $token = null, $httpMethod, $httpUrl, array $parameters = [])
{
}
/**
* @param string $name
* @param string $value
*/
public function setParameter($name, $value)
{
}
/**
* @param $name
*
* @return string|null
*/
public function getParameter($name)
{
}
/**
* @return array
*/
public function getParameters()
{
}
/**
* @param $name
*/
public function removeParameter($name)
{
}
/**
* The request parameters, sorted and concatenated into a normalized string.
*
* @return string
*/
public function getSignableParameters()
{
}
/**
* Returns the base string of this request
*
* The base string defined as the method, the url
* and the parameters (normalized), each urlencoded
* and the concated with &.
*
* @return string
*/
public function getSignatureBaseString()
{
}
/**
* Returns the HTTP Method in uppercase
*
* @return string
*/
public function getNormalizedHttpMethod()
{
}
/**
* parses the url and rebuilds it to be
* scheme://host/path
*
* @return string
*/
public function getNormalizedHttpUrl()
{
}
/**
* Builds a url usable for a GET request
*
* @return string
*/
public function toUrl()
{
}
/**
* Builds the data one would send in a POST request
*
* @return string
*/
public function toPostdata()
{
}
/**
* Builds the Authorization: header
*
* @return string
* @throws TwitterOAuthException
*/
public function toHeader()
{
}
/**
* @return string
*/
public function __toString()
{
}
/**
* @param SignatureMethod $signatureMethod
* @param Consumer $consumer
* @param Token $token
*/
public function signRequest(\Abraham\TwitterOAuth\SignatureMethod $signatureMethod, \Abraham\TwitterOAuth\Consumer $consumer, \Abraham\TwitterOAuth\Token $token = null)
{
}
/**
* @param SignatureMethod $signatureMethod
* @param Consumer $consumer
* @param Token $token
*
* @return string
*/
public function buildSignature(\Abraham\TwitterOAuth\SignatureMethod $signatureMethod, \Abraham\TwitterOAuth\Consumer $consumer, \Abraham\TwitterOAuth\Token $token = null)
{
}
/**
* @return string
*/
public static function generateNonce()
{
}
}
class Consumer
{
/** @var string */
public $key;
/** @var string */
public $secret;
/** @var string|null */
public $callbackUrl;
/**
* @param string $key
* @param string $secret
* @param null $callbackUrl
*/
public function __construct($key, $secret, $callbackUrl = null)
{
}
/**
* @return string
*/
public function __toString()
{
}
}
}
namespace Abraham\TwitterOAuth\Util {
/**
* @author louis <louis@systemli.org>
*/
class JsonDecoder
{
/**
* Decodes a JSON string to stdObject or associative array
*
* @param string $string
* @param bool $asArray
*
* @return array|object
*/
public static function decode($string, $asArray)
{
}
}
}
namespace Abraham\TwitterOAuth {
/**
* TwitterOAuth class for interacting with the Twitter API.
*
* @author Abraham Williams <abraham@abrah.am>
*/
class TwitterOAuth extends \Abraham\TwitterOAuth\Config
{
const API_VERSION = '1.1';
const API_HOST = 'https://api.twitter.com';
const UPLOAD_HOST = 'https://upload.twitter.com';
/**
* Constructor
*
* @param string $consumerKey The Application Consumer Key
* @param string $consumerSecret The Application Consumer Secret
* @param string|null $oauthToken The Client Token (optional)
* @param string|null $oauthTokenSecret The Client Token Secret (optional)
*/
public function __construct($consumerKey, $consumerSecret, $oauthToken = null, $oauthTokenSecret = null)
{
}
/**
* @param string $oauthToken
* @param string $oauthTokenSecret
*/
public function setOauthToken($oauthToken, $oauthTokenSecret)
{
}
/**
* @return string|null
*/
public function getLastApiPath()
{
}
/**
* @return int
*/
public function getLastHttpCode()
{
}
/**
* @return array
*/
public function getLastXHeaders()
{
}
/**
* @return array|object|null
*/
public function getLastBody()
{
}
/**
* Resets the last response cache.
*/
public function resetLastResponse()
{
}
/**
* Make URLs for user browser navigation.
*
* @param string $path
* @param array $parameters
*
* @return string
*/
public function url($path, array $parameters)
{
}
/**
* Make /oauth/* requests to the API.
*
* @param string $path
* @param array $parameters
*
* @return array
* @throws TwitterOAuthException
*/
public function oauth($path, array $parameters = [])
{
}
/**
* Make /oauth2/* requests to the API.
*
* @param string $path
* @param array $parameters
*
* @return array|object
*/
public function oauth2($path, array $parameters = [])
{
}
/**
* Make GET requests to the API.
*
* @param string $path
* @param array $parameters
*
* @return array|object
*/
public function get($path, array $parameters = [])
{
}
/**
* Make POST requests to the API.
*
* @param string $path
* @param array $parameters
*
* @return array|object
*/
public function post($path, array $parameters = [])
{
}
/**
* Make DELETE requests to the API.
*
* @param string $path
* @param array $parameters
*
* @return array|object
*/
public function delete($path, array $parameters = [])
{
}
/**
* Make PUT requests to the API.
*
* @param string $path
* @param array $parameters
*
* @return array|object
*/
public function put($path, array $parameters = [])
{
}
/**
* Upload media to upload.twitter.com.
*
* @param string $path
* @param array $parameters
* @param boolean $chunked
*
* @return array|object
*/
public function upload($path, array $parameters = [], $chunked = false)
{
}
}
/**
* The HMAC-SHA1 signature method uses the HMAC-SHA1 signature algorithm as defined in [RFC2104]
* where the Signature Base String is the text and the key is the concatenated values (each first
* encoded per Parameter Encoding) of the Consumer Secret and Token Secret, separated by an '&'
* character (ASCII code 38) even if empty.
* - Chapter 9.2 ("HMAC-SHA1")
*/
class HmacSha1 extends \Abraham\TwitterOAuth\SignatureMethod
{
/**
* {@inheritDoc}
*/
public function getName()
{
}
/**
* {@inheritDoc}
*/
public function buildSignature(\Abraham\TwitterOAuth\Request $request, \Abraham\TwitterOAuth\Consumer $consumer, \Abraham\TwitterOAuth\Token $token = null)
{
}
}
/**
* @author Abraham Williams <abraham@abrah.am>
*/
class TwitterOAuthException extends \Exception
{
}
class Token
{
/** @var string */
public $key;
/** @var string */
public $secret;
/**
* @param string $key The OAuth Token
* @param string $secret The OAuth Token Secret
*/
public function __construct($key, $secret)
{
}
/**
* Generates the basic string serialization of a token that a server
* would respond to request_token and access_token calls with
*
* @return string
*/
public function __toString()
{
}
}
/**
* The result of the most recent API request.
*
* @author Abraham Williams <abraham@abrah.am>
*/
class Response
{
/**
* @param string $apiPath
*/
public function setApiPath($apiPath)
{
}
/**
* @return string|null
*/
public function getApiPath()
{
}
/**
* @param array|object $body
*/
public function setBody($body)
{
}
/**
* @return array|object|string
*/
public function getBody()
{
}
/**
* @param int $httpCode
*/
public function setHttpCode($httpCode)
{
}
/**
* @return int
*/
public function getHttpCode()
{
}
/**
* @param array $headers
*/
public function setHeaders(array $headers)
{
}
/**
* @return array
*/
public function getsHeaders()
{
}
/**
* @param array $xHeaders
*/
public function setXHeaders(array $xHeaders = [])
{
}
/**
* @return array
*/
public function getXHeaders()
{
}
}
}
namespace Bitpay {
/**
* Item that was sold
*
* @package Bitpay
*/
interface ItemInterface
{
/**
* Used to display an item SKU code or part number to the buyer. Maximum string
* length is 100 characters.
*
* @return string
*/
public function getCode();
/**
* Used to display an item description to the buyer. Maximum string length is 100
* characters.
*
* @return string
*/
public function getDescription();
/**
* @return float
*/
public function getPrice();
/**
* @return integer
*/
public function getQuantity();
/**
* default value: false
* ● true: Indicates a physical item will be shipped (or picked up)
* ● false: Indicates that nothing is to be shipped for this order
*
* @return boolean
*/
public function isPhysical();
}
/**
* Interface for an access token for the given client
*
* @package Bitpay
*/
interface AccessTokenInterface
{
/**
* @return string
*/
public function getId();
/**
* @return string
*/
public function getEmail();
/**
* @return string
*/
public function getLabel();
}
/**
* @package Bitpay
*/
class AccessToken implements \Bitpay\AccessTokenInterface
{
/**
* @var string
*/
protected $id;
/**
* @var string
*/
protected $email;
/**
* @var string
*/
protected $label;
/**
* Set various defaults for this object.
*/
public function __construct($id = null, $email = null, $label = null)
{
}
/**
* Setter for the id.
*
* @param string $id
* @return AccessToken
*/
public function setId($id)
{
}
/**
* @inheritdoc
*/
public function getId()
{
}
/**
* Setter for the email address.
*
* @param string $email
* @return AccessToken
*/
public function setEmail($email)
{
}
/**
* @inheritdoc
*/
public function getEmail()
{
}
/**
* Setter for the label.
*
* @param string $label
* @return AccessToken
*/
public function setLabel($label)
{
}
/**
* @inheritdoc
*/
public function getLabel()
{
}
}
/**
* @package Bitpay
*/
interface InvoiceInterface
{
/**
* An invoice starts in this state. When in this state and only in this state, payments
* to the associated bitcoin address are credited to the invoice. If an invoice has
* received a partial payment, it will still reflect a status of new to the merchant
* (from a merchant system perspective, an invoice is either paid or not paid, partial
* payments and over payments are handled by bitpay.com by either refunding the
* customer or applying the funds to a new invoice.
*/
const STATUS_NEW = 'new';
/**
* As soon as full payment (or over payment) is received, an invoice goes into the
* paid status.
*/
const STATUS_PAID = 'paid';
/**
* The transaction speed preference of an invoice determines when an invoice is
* confirmed. For the high speed setting, it will be confirmed as soon as full
* payment is received on the bitcoin network (note, the invoice will go from a status
* of new to confirmed, bypassing the paid status). For the medium speed setting,
* the invoice is confirmed after the payment transaction(s) have been confirmed by
* 1 block on the bitcoin network. For the low speed setting, 6 blocks on the bitcoin
* network are required. Invoices are considered complete after 6 blocks on the
* bitcoin network, therefore an invoice will go from a paid status directly to a
* complete status if the transaction speed is set to low.
*/
const STATUS_CONFIRMED = 'confirmed';
/**
* When an invoice is complete, it means that BitPay.com has credited the
* merchant’s account for the invoice. Currently, 6 confirmation blocks on the
* bitcoin network are required for an invoice to be complete. Note, in the future (for
* qualified payers), invoices may move to a complete status immediately upon
* payment, in which case the invoice will move directly from a new status to a
* complete status.
*/
const STATUS_COMPLETE = 'complete';
/**
* An expired invoice is one where payment was not received and the 15 minute
* payment window has elapsed.
*/
const STATUS_EXPIRED = 'expired';
/**
* An invoice is considered invalid when it was paid, but payment was not confirmed
* within 1 hour after receipt. It is possible that some transactions on the bitcoin
* network can take longer than 1 hour to be included in a block. In such
* circumstances, once payment is confirmed, BitPay.com will make arrangements
* with the merchant regarding the funds (which can either be credited to the
* merchant account on another invoice, or returned to the buyer).
*/
const STATUS_INVALID = 'invalid';
/**
* Code comment for each transaction speed
*/
const TRANSACTION_SPEED_HIGH = 'high';
const TRANSACTION_SPEED_MEDIUM = 'medium';
const TRANSACTION_SPEED_LOW = 'low';
/**
* This is the amount that is required to be collected from the buyer. Note, if this is
* specified in a currency other than BTC, the price will be converted into BTC at
* market exchange rates to determine the amount collected from the buyer.
*
* @return float
*/
public function getPrice();
/**
* This is the currency code set for the price setting. The pricing currencies
* currently supported are USD, EUR, BTC, and all of the codes listed on this page:
* https://bitpay.com/bitcoinexchangerates
*
* @return CurrencyInterface
*/
public function getCurrency();
/**
* If there is not an item already set, we need to use a default item
* so that some methods do not throw errors about methods and
* non-objects.
*
* @return ItemInterface
*/
public function getItem();
/**
* @return BuyerInterface
*/
public function getBuyer();
/**
* default value: set in your https://bitpay.com/ordersettings, the default value set in
* your merchant dashboard is “medium”.
*
* ● “high”: An invoice is considered to be "confirmed" immediately upon
* receipt of payment.
* ● “medium”: An invoice is considered to be "confirmed" after 1 block
* confirmation (~10 minutes).
* ● “low”: An invoice is considered to be "confirmed" after 6 block
* confirmations (~1 hour).
*
* NOTE: Orders are posted to your Account Summary after 6 block confirmations
* regardless of this setting.
*
* @return string
*/
public function getTransactionSpeed();
/**
* Bitpay.com will send an email to this email address when the invoice status
* changes.
*
* @return string
*/
public function getNotificationEmail();
/**
* A URL to send status update messages to your server (this must be an https
* URL, unencrypted http URLs or any other type of URL is not supported).
* Bitpay.com will send a POST request with a JSON encoding of the invoice to
* this URL when the invoice status changes.
*
* @return string
*/
public function getNotificationUrl();
/**
* This is the URL for a return link that is displayed on the receipt, to return the
* shopper back to your website after a successful purchase. This could be a page
* specific to the order, or to their account.
*
* @return string
*/
public function getRedirectUrl();
/**
* A passthru variable provided by the merchant and designed to be used by the
* merchant to correlate the invoice with an order or other object in their system.
* Maximum string length is 100 characters.
*
* @return array|object
*/
public function getPosData();
/**
* The current invoice status. The possible states are described earlier in this
* document.
*
* @return string
*/
public function getStatus();
/**
* default value: false
* ● true: Notifications will be sent on every status change.
* ● false: Notifications are only sent when an invoice is confirmed (according
* to the “transactionSpeed” setting).
*
* @return boolean
*/
public function isFullNotifications();
/**
* The unique id of the invoice assigned by bitpay.com
*
* @return string
*/
public function getId();
/**
* An https URL where the invoice can be viewed.
*
* @return string
*/
public function getUrl();
/**
* The amount of bitcoins being requested for payment of this invoice (same as the
* price if the merchant set the price in BTC).
*
* @return float
*/
public function getBtcPrice();
/**
* The time the invoice was created in milliseconds since midnight January 1,
* 1970. Time format is “20140101T19:01:01.123Z”.
*
* @return DateTime
*/
public function getInvoiceTime();
/**
* The time at which the invoice expires and no further payment will be accepted (in
* milliseconds since midnight January 1, 1970). Currently, all invoices are valid for
* 15 minutes. Time format is “20140101T19:01:01.123Z”.
*
* @return DateTime
*/
public function getExpirationTime();
/**
* The current time on the BitPay.com system (by subtracting the current time from
* the expiration time, the amount of time remaining for payment can be
* determined). Time format is “20140101T19:01:01.123Z”.
*
* @return DateTime
*/
public function getCurrentTime();
/**
* Used to display your public order number to the buyer on the BitPay invoice. In
* the merchant Account Summary page, this value is used to identify the ledger
* entry. Maximum string length is 100 characters.
*
* @return string
*/
public function getOrderId();
/**
* Used to display an item description to the buyer. Maximum string length is 100
* characters.
*
* @deprecated
* @return string
*/
public function getItemDesc();
/**
* Used to display an item SKU code or part number to the buyer. Maximum string
* length is 100 characters.
*
* @deprecated
* @return string
*/
public function getItemCode();
/**
* default value: false
* ● true: Indicates a physical item will be shipped (or picked up)
* ● false: Indicates that nothing is to be shipped for this order
*
* @deprecated
* @return boolean
*/
public function isPhysical();
/**
* These fields are used for display purposes only and will be shown on the invoice
* if provided. Maximum string length of each field is 100 characters.
*
* @deprecated
* @return string
*/
public function getBuyerName();
/**
* These fields are used for display purposes only and will be shown on the invoice
* if provided. Maximum string length of each field is 100 characters.
*
* @deprecated
* @return string
*/
public function getBuyerAddress1();
/**
* These fields are used for display purposes only and will be shown on the invoice
* if provided. Maximum string length of each field is 100 characters.
*
* @deprecated
* @return string
*/
public function getBuyerAddress2();
/**
* These fields are used for display purposes only and will be shown on the invoice
* if provided. Maximum string length of each field is 100 characters.
*
* @deprecated
* @return string
*/
public function getBuyerCity();
/**
* These fields are used for display purposes only and will be shown on the invoice
* if provided. Maximum string length of each field is 100 characters.
*
* @deprecated
* @return string
*/
public function getBuyerState();
/**
* These fields are used for display purposes only and will be shown on the invoice
* if provided. Maximum string length of each field is 100 characters.
*
* @deprecated
* @return string
*/
public function getBuyerZip();
/**
* These fields are used for display purposes only and will be shown on the invoice
* if provided. Maximum string length of each field is 100 characters.
*
* @deprecated
* @return string
*/
public function getBuyerCountry();
/**
* These fields are used for display purposes only and will be shown on the invoice
* if provided. Maximum string length of each field is 100 characters.
*
* @deprecated
* @return string
*/
public function getBuyerEmail();
/**
* These fields are used for display purposes only and will be shown on the invoice
* if provided. Maximum string length of each field is 100 characters.
*
* @deprecated
* @return string
*/
public function getBuyerPhone();
/**
* Returns exception status.
*/
public function getExceptionStatus();
/**
* Returns the amount of BTC paid.
*/
public function getBtcPaid();
/**
* Returns the exchange rate.
*/
public function getRate();
/**
* Returns the token for this resource.
*/
public function getToken();
/**
* Returns a set of payment urls.
*
* @return PaymentUrlInterface
*/
public function getPaymentUrls();
}
/**
* @package Bitpay
*/
class Invoice implements \Bitpay\InvoiceInterface
{
/**
* @var CurrencyInterface
*/
protected $currency = null;
/**
* @var string
*/
protected $orderId = '';
/**
* @var ItemInterface
*/
protected $item = null;
/**
* @var string
*/
protected $transactionSpeed = '';
/**
* @var string
*/
protected $notificationEmail = '';
/**
* @var string
*/
protected $notificationUrl = '';
/**
* @var string
*/
protected $redirectUrl = '';
/**
* @var string
*/
protected $posData = '';
/**
* @var string
*/
protected $status = '';
/**
* @var boolean
*/
protected $fullNotifications = false;
/**
* @var string
*/
protected $id = '';
/**
* @var string
*/
protected $url = '';
/**
* @var float
*/
protected $btcPrice = 0.0;
/**
* @var \DateTime
*/
protected $invoiceTime = null;
/**
* @var \DateTime
*/
protected $expirationTime = null;
/**
* @var \DateTime
*/
protected $currentTime = null;
/**
* @var BuyerInterface
*/
protected $buyer = null;
/**
* @var string
*/
protected $exceptionStatus = '';
/**
* @var float
*/
protected $btcPaid = 0.0;
/**
* @var float
*/
protected $rate = 0.0;
/**
* @var Token
*/
protected $token = null;
/**
* @var PaymentUrlInterface
*/
protected $paymentUrls = null;
public function __construct($transactionSpeed = self::TRANSACTION_SPEED_LOW, $fullNotifications = false, $item = null, $currency = null, $orderId = '', $posData = '')
{
}
/**
* @inheritdoc
*/
public function getPrice()
{
}
/**
* @param float $price
* @return Invoice
*/
public function setPrice($price)
{
}
/**
* @inheritdoc
*/
public function getCurrency()
{
}
/**
* @param CurrencyInterface $currency
* @return Invoice
*/
public function setCurrency(\Bitpay\CurrencyInterface $currency)
{
}
/**
* @inheritdoc
*/
public function getItem()
{
}
/**
* @param ItemInterface $item
* @return Invoice
*/
public function setItem(\Bitpay\ItemInterface $item)
{
}
/**
* @inheritdoc
*/
public function getBuyer()
{
}
/**
* @param BuyerInterface $buyer
* @return Invoice
*/
public function setBuyer(\Bitpay\BuyerInterface $buyer)
{
}
/**
* @inheritdoc
*/
public function getTransactionSpeed()
{
}
/**
* @param string $transactionSpeed
* @return Invoice
*/
public function setTransactionSpeed($transactionSpeed)
{
}
/**
* @inheritdoc
*/
public function getNotificationEmail()
{
}
/**
* @param string $notificationEmail
* @return Invoice
*/
public function setNotificationEmail($notificationEmail)
{
}
/**
* @inheritdoc
*/
public function getNotificationUrl()
{
}
/**
* @param string $notificationUrl
* @return Invoice
*/
public function setNotificationUrl($notificationUrl)
{
}
/**
* @inheritdoc
*/
public function getRedirectUrl()
{
}
/**
* @param string $redirectUrl
* @return Invoice
*/
public function setRedirectUrl($redirectUrl)
{
}
/**
* @inheritdoc
*/
public function getPosData()
{
}
/**
* @param string $posData
* @return Invoice
*/
public function setPosData($posData)
{
}
/**
* @inheritdoc
*/
public function getStatus()
{
}
/**
* @param string $status
* @return Invoice
*/
public function setStatus($status)
{
}
/**
* @inheritdoc
*/
public function isFullNotifications()
{
}
public function setFullNotifications($notifications)
{
}
/**
* @inheritdoc
*/
public function getId()
{
}
/**
* @param string $id
* @return Invoice
*/
public function setId($id)
{
}
/**
* @inheritdoc
*/
public function getUrl()
{
}
/**
* @param string $url
* @return Invoice
*/
public function setUrl($url)
{
}
/**
* @inheritdoc
*/
public function getBtcPrice()
{
}
/**
* @param float $btcPrice
* @return Invoice
*/
public function setBtcPrice($btcPrice)
{
}
/**
* @inheritdoc
*/
public function getInvoiceTime()
{
}
/**
* @param \DateTime $invoiceTime
* @return Invoice
*/
public function setInvoiceTime($invoiceTime)
{
}
/**
* @inheritdoc
*/
public function getExpirationTime()
{
}
/**
* @param \DateTime $expirationTime
* return Invoice
*/
public function setExpirationTime($expirationTime)
{
}
/**
* @inheritdoc
*/
public function getCurrentTime()
{
}
/**
* @param \DateTime $currentTime
* @return Invoice
*/
public function setCurrentTime($currentTime)
{
}
/**
* @inheritdoc
*/
public function getOrderId()
{
}
/**
* @param string $orderId
* @return Invoice
*/
public function setOrderId($orderId)
{
}
/**
* @inheritdoc
*/
public function getItemDesc()
{
}
/**
* @inheritdoc
*/
public function getItemCode()
{
}
/**
* @inheritdoc
*/
public function isPhysical()
{
}
/**
* @inheritdoc
*/
public function getBuyerName()
{
}
/**
* @inheritdoc
*/
public function getBuyerAddress1()
{
}
/**
* @inheritdoc
*/
public function getBuyerAddress2()
{
}
/**
* @inheritdoc
*/
public function getBuyerCity()
{
}
/**
* @inheritdoc
*/
public function getBuyerState()
{
}
/**
* @inheritdoc
*/
public function getBuyerZip()
{
}
/**
* @inheritdoc
*/
public function getBuyerCountry()
{
}
/**
* @inheritdoc
*/
public function getBuyerEmail()
{
}
/**
* @inheritdoc
*/
public function getBuyerPhone()
{
}
/**
* @inheritdoc
*/
public function getExceptionStatus()
{
}
/**
* @param
* @return Invoice
*/
public function setExceptionStatus($exceptionStatus)
{
}
/**
* @param void
* @return
*/
public function getBtcPaid()
{
}
/**
* @param
* @return Invoice
*/
public function setBtcPaid($btcPaid)
{
}
/**
* @param void
* @return Invoice
*/
public function getRate()
{
}
/**
* @param
* @return
*/
public function setRate($rate)
{
}
/**
* @return TokenInterface
*/
public function getToken()
{
}
/**
* @param TokenInterface $token
* @return Invoice
*/
public function setToken(\Bitpay\TokenInterface $token)
{
}
/**
* @return PaymentUrlInterface
*/
public function getPaymentUrls()
{
}
/**
* @param PaymentUrlInterface $paymentUrls
* @return Invoice
*/
public function setPaymentUrls(\Bitpay\PaymentUrlInterface $paymentUrls)
{
}
/**
* @param string $paymentUrlType
* @return string
*/
public function getPaymentUrl($paymentUrlType)
{
}
}
/**
* Interface PaymentUrlInterface
* @package Bitpay
*/
interface PaymentUrlInterface
{
/**
* This is a list of returned payment url types
*
*/
const BIP_21 = 'BIP21';
const BIP_72 = 'BIP72';
const BIP_72B = 'BIP72b';
const BIP_73 = 'BIP73';
/**
* Return the account parameter given by Bitpay.
*
* @return string
*/
public function getUrl($urlType);
}
/**
* @package Bitpay
*/
class PaymentUrlSet implements \Bitpay\PaymentUrlInterface
{
/**
* @var array
*/
protected $paymentUrls;
public function __construct(array $paymentUrls = array())
{
}
/**
* Return the account parameter given by Bitpay.
*
* @return string
*/
public function getUrl($urlType)
{
}
/**
* Return the account parameter given by Bitpay.
*
* @return PaymentUrlInterface
*/
public function setUrls(array $paymentUrls)
{
}
}
}
namespace Bitpay\Client {
/**
* @package Bitpay
*/
class ConnectionException extends \Exception
{
}
/**
* @package Bitpay
*/
interface ResponseInterface
{
/**
* @return string
*/
public function getBody();
/**
* Returns the status code of the response
*
* @return integer
*/
public function getStatusCode();
/**
* Returns a $key => $value array of http headers
*
* @return array
*/
public function getHeaders();
}
/**
* @package Bitpay
*/
interface RequestInterface
{
const METHOD_POST = 'POST';
const METHOD_GET = 'GET';
const METHOD_PUT = 'PUT';
const METHOD_DELETE = 'DELETE';
/**
* Returns the method for this request
*
* @return string
*/
public function getMethod();
/**
* Should always return https
*
* @return string
*/
public function getSchema();
/**
* Returns the host to send the request to. The host would be something
* such as `test.bitpay.com` or `bitpay.com`
*
* @return string
*/
public function getHost();
/**
* Returns port to send request on
*
* @return integer
*/
public function getPort();
/**
* example of path is `api/invoice` as this is appended to $host
*
* @return string
*/
public function getPath();
/**
* Returns $schema://$host:$port/$path
*
* @return string
*/
public function getUri();
/**
* Checks the request to see if the method matches a known value
*
* @param string $method
*
* @return boolean
*/
public function isMethod($method);
/**
* Returns the request body
*
* @return string
*/
public function getBody();
/**
* Returns a $key => $value array of http headers
*
* @return array
*/
public function getHeaders();
}
/**
* Generic Request object used to send requests to servers
*
* @package Bitpay
*/
class Request implements \Bitpay\Client\RequestInterface
{
/**
* @var array
*/
protected $headers;
/**
* @var string
*/
protected $body;
/**
* $schema://$hostname/$path
*
* @var string
*/
protected $uri;
/**
* See the RequestInterface for all the valid methods
*
* @var string
*/
protected $method;
/**
* This should be something such as `test.bitpay.com` or just `bitpay.com`
*
* @var string
*/
protected $host;
/**
* The path is added to the end of the host
*
* @var string
*/
protected $path;
/**
* Default is 443 but should be changed by whatever is passed in through the Adapter.
*
* @var integer
*/
protected $port;
public function __construct()
{
}
/**
* Converts this request into a standard HTTP/1.1 message to be sent over
* the wire.
*
* @return string
*/
public function __toString()
{
}
/**
* @inheritdoc
*/
public function isMethod($method)
{
}
/**
* @inheritdoc
*/
public function getPort()
{
}
/**
* @inheritdoc
*/
public function setPort($port)
{
}
/**
* @inheritdoc
*/
public function getMethod()
{
}
/**
* Set the method of the request, for known methods see the
* RequestInterface.
*
* @param string $method
*/
public function setMethod($method)
{
}
/**
* @inheritdoc
*/
public function getSchema()
{
}
/**
* @inheritdoc
*/
public function getUri()
{
}
/**
* @inheritdoc
*/
public function getUriWithPort()
{
}
/**
* @inheritdoc
*/
public function getHost()
{
}
/**
* Sets the host for the request.
*
* @param string $host
* @return Request
*/
public function setHost($host)
{
}
/**
* @inheritdoc
*/
public function getHeaders()
{
}
/**
* @return array
*/
public function getHeaderFields()
{
}
/**
* @return string
*/
public function getHeadersAsString()
{
}
/**
* Set a http header for the request.
*
* @param string $header
* @param string $value
* @throws \Exception
*/
public function setHeader($header, $value)
{
}
/**
* @inheritdoc
*/
public function getBody()
{
}
/**
* Sets the body of the request.
*
* @param string $body
* @return Request
*/
public function setBody($body)
{
}
/**
* @inheritdoc
*/
public function getPath()
{
}
/**
* @param string $host
* @return Request
*/
public function setPath($path)
{
}
}
}
namespace Bitpay\Client\Adapter {
/**
* A client can be configured to use a specific adapter to make requests, by
* default the CurlAdapter is what is used.
*
* @package Bitpay
*/
interface AdapterInterface
{
/**
* Send a request to BitPay.
*
* @param \Bitpay\Client\Request $request
* @return \Bitpay\Client\Response
*/
public function sendRequest(\Bitpay\Client\Request $request);
}
/**
* Adapter class that sends Request objects using cURL.
*
* @package Bitpay
*/
class CurlAdapter implements \Bitpay\Client\Adapter\AdapterInterface
{
/**
* @var array
*/
protected $curlOptions;
/**
* @param array $curlOptions
*/
public function __construct(array $curlOptions = array())
{
}
/**
* Returns an array of cURL settings to use
*
* @return array
*/
public function getCurlOptions()
{
}
/**
* @inheritdoc
*/
public function sendRequest(\Bitpay\Client\Request $request)
{
}
}
}
namespace Bitpay\Client {
/**
* @package Bitpay
*/
class BitpayException extends \Exception
{
}
/**
* @package Bitpay
*/
class ArgumentException extends \Exception
{
}
/**
* Generic Response class used to parse a response from a server.
*
* @package Bitpay
*/
class Response implements \Bitpay\Client\ResponseInterface
{
/**
* @var string
*/
protected $raw;
/**
* @var array
*/
protected $headers;
/**
* @var string
*/
protected $body;
/**
* @var integer
*/
protected $statusCode;
public function __construct($raw = null)
{
}
/**
* Returns the raw http response
*
* @return string
*/
public function __toString()
{
}
/**
* @param Response
*/
public static function createFromRawResponse($rawResponse)
{
}
/**
* @inheritdoc
*/
public function getStatusCode()
{
}
/**
* @param integer
* @return Response
*/
public function setStatusCode($statusCode)
{
}
/**
* @inheritdoc
*/
public function getBody()
{
}
/**
* Set the body of the response
*
* @param string $body
* @return Response
*/
public function setBody($body)
{
}
/**
* @inheritdoc
*/
public function getHeaders()
{
}
/**
* @param string $header
* @param string $value
* @return Response
*/
public function setHeader($header, $value)
{
}
}
}
namespace Bitpay {
/**
* @package Bitpay
*/
interface UserInterface
{
/**
* @return string
*/
public function getPhone();
/**
* @return string
*/
public function getEmail();
/**
* @return string
*/
public function getFirstName();
/**
* @return string
*/
public function getLastName();
/**
* $address = array($lineOne, $lineTwo);
*
* @return array
*/
public function getAddress();
/**
* @return string
*/
public function getCity();
/**
* @return string
*/
public function getState();
/**
* @return string
*/
public function getZip();
/**
* @return string
*/
public function getCountry();
}
/**
* @package Bitpay
*/
interface BuyerInterface extends \Bitpay\UserInterface
{
}
/**
* @package Bitpay
*/
class User implements \Bitpay\UserInterface
{
/**
* @var string
*/
protected $phone;
/**
* @var string
*/
protected $email;
/**
* @var string
*/
protected $firstName;
/**
* @var string
*/
protected $lastName;
/**
* @var array
*/
protected $address;
/**
* @var string
*/
protected $city;
/**
* @var string
*/
protected $state;
/**
* @var string
*/
protected $zip;
/**
* @var string
*/
protected $country;
/**
* @var bool
*/
protected $agreedToTOSandPP;
/**
* @inheritdoc
*/
public function getPhone()
{
}
/**
* @param string $phone
* @return User
*/
public function setPhone($phone)
{
}
/**
* @inheritdoc
*/
public function getEmail()
{
}
/**
* @param string $email
* @return User
*/
public function setEmail($email)
{
}
/**
* @inheritdoc
*/
public function getFirstName()
{
}
/**
* @param string $firstName
* @return User
*/
public function setFirstName($firstName)
{
}
/**
* @inheritdoc
*/
public function getLastName()
{
}
/**
* @param string $lastName
* @return User
*/
public function setLastName($lastName)
{
}
/**
* @inheritdoc
*/
public function getAddress()
{
}
/**
* @param array $address
* @return User
*/
public function setAddress(array $address)
{
}
/**
* @inheritdoc
*/
public function getCity()
{
}
/**
* @param string $city
* @return User
*/
public function setCity($city)
{
}
/**
* @inheritdoc
*/
public function getState()
{
}
/**
* @param string $state
* @return User
*/
public function setState($state)
{
}
/**
* @inheritdoc
*/
public function getZip()
{
}
/**
* @param string $zip
* @return User
*/
public function setZip($zip)
{
}
/**
* @inheritdoc
*/
public function getCountry()
{
}
/**
* @param string $country
* @return User
*/
public function setCountry($country)
{
}
/**
* @param bool $boolvalue
* @return User
*/
public function setAgreedToTOSandPP($boolvalue)
{
}
/**
* @return bool
*/
public function getAgreedToTOSandPP()
{
}
}
/**
*
* @package Bitpay
*/
class Buyer extends \Bitpay\User implements \Bitpay\BuyerInterface
{
}
}
namespace Bitpay\Storage {
/**
* @package Bitpay
*/
interface StorageInterface
{
/**
* @param KeyInterface $key
*/
public function persist(\Bitpay\KeyInterface $key);
/**
* @param string $id
* @return KeyInterface
*/
public function load($id);
}
/**
* @codeCoverageIgnore
* @package Bitpay
*/
class MockStorage implements \Bitpay\Storage\StorageInterface
{
/**
* @param Key $key
*/
public function persist(\Bitpay\KeyInterface $key)
{
}
/**
* @param string $id
* @return void
*/
public function load($id)
{
}
}
/**
* @package Bitpay
*/
class EncryptedFilesystemStorage implements \Bitpay\Storage\StorageInterface
{
/**
* Initialization Vector
*/
const IV = '0000000000000000';
/**
* @var string
*/
const METHOD = 'AES-128-CBC';
/**
* @var int
*/
const OPENSSL_RAW_DATA = 1;
/**
* @param string $password
*/
public function __construct($password)
{
}
/**
* @inheritdoc
*/
public function persist(\Bitpay\KeyInterface $key)
{
}
/**
* @inheritdoc
*/
public function load($id)
{
}
}
/**
* Used to persist keys to the filesystem.
*
* @package Bitpay
*/
class FilesystemStorage implements \Bitpay\Storage\StorageInterface
{
/**
* @inheritdoc
*/
public function persist(\Bitpay\KeyInterface $key)
{
}
/**
* @inheritdoc
*/
public function load($id)
{
}
}
}
namespace Bitpay {
/**
* Creates a bill for the calling merchant.
*
* @package Bitpay
*/
interface BillInterface
{
/**
* @return array
*/
public function getItems();
/**
* @return Currency
*/
public function getCurrency();
/**
* @return string
*/
public function getName();
/**
* $address = array($lineOne, $lineTwo);
*
* @return array
*/
public function getAddress();
/**
* @return string
*/
public function getCity();
/**
* @return string
*/
public function getState();
/**
* @return string
*/
public function getZip();
/**
* @return string
*/
public function getCountry();
/**
* @return string
*/
public function getEmail();
/**
* @return string
*/
public function getPhone();
/**
* @return string
*/
public function getStatus();
/**
* @return string
*/
public function getShowRate();
/**
* @return boolean
*/
public function getArchived();
}
/**
*
* @package Bitpay
*/
class Bill implements \Bitpay\BillInterface
{
/**
* @var array
*/
protected $items;
/**
* @var Currency
*/
protected $currency;
/**
* @var string
*/
protected $name;
/**
* @var array
*/
protected $address;
/**
* @var string
*/
protected $city;
/**
* @var string
*/
protected $state;
/**
* @var string
*/
protected $zip;
/**
* @var string
*/
protected $country;
/**
* @var string
*/
protected $email;
/**
* @var string
*/
protected $phone;
/**
* @var string
*/
protected $status;
/**
* @var string
*/
protected $showRate;
/**
* @var boolean
*/
protected $archived;
public function __construct()
{
}
/**
* @inheritdoc
*/
public function getItems()
{
}
/**
* @param Item $item
* @return Bill
*/
public function addItem(\Bitpay\Item $item)
{
}
/**
* @inheritdoc
*/
public function getCurrency()
{
}
/**
* @param Currency $currency
* @return Bill
*/
public function setCurrency(\Bitpay\Currency $currency)
{
}
/**
* @inheritdoc
*/
public function getName()
{
}
/**
* @param string $name
* @return Bill
*/
public function setName($name)
{
}
/**
* @inheritdoc
*/
public function getAddress()
{
}
/**
* @param array $address
* @return Bill
*/
public function setAddress($address)
{
}
/**
* @inheritdoc
*/
public function getCity()
{
}
/**
* @param string $city
* @return Bill
*/
public function setCity($city)
{
}
/**
* @inheritdoc
*/
public function getState()
{
}
/**
* @param string $state
* @return Bill
*/
public function setState($state)
{
}
/**
* @inheritdoc
*/
public function getZip()
{
}
/**
* @param string $zip
* @return Bill
*/
public function setZip($zip)
{
}
/**
* @inheritdoc
*/
public function getCountry()
{
}
/**
* @param string $country
* @return Bill
*/
public function setCountry($country)
{
}
/**
* @inheritdoc
*/
public function getEmail()
{
}
/**
* @param string $email
* @return Bill
*/
public function setEmail($email)
{
}
/**
* @inheritdoc
*/
public function getPhone()
{
}
/**
* @param string $phone
* @return Bill
*/
public function setPhone($phone)
{
}
/**
* @inheritdoc
*/
public function getStatus()
{
}
/**
* @param string $status
* @return Bill
*/
public function setStatus($status)
{
}
/**
* @inheritdoc
*/
public function getShowRate()
{
}
/**
* @param string $showRate
* @return Bill
*/
public function setShowRate($showRate)
{
}
/**
* @inheritdoc
*/
public function getArchived()
{
}
/**
* @param boolean $archived
* @return Bill
*/
public function setArchived($archived)
{
}
}
/**
* Sets up container and prepares for dependency injection.
*
* @package Bitpay
*/
class Bitpay
{
/**
* @var ContainerBuilder
*/
protected $container;
/**
* First argument can either be a string or fullpath to a yaml file that
* contains configuration parameters. For a list of configuration values
* see \Bitpay\Config\Configuration class
*
* The second argument is the container if you want to build one by hand.
*
* @param array|string $config
* @param null|ContainerBuilder $container
*/
public function __construct($config = array(), \Symfony\Component\DependencyInjection\ContainerBuilder $container = null)
{
}
/**
* Initialize the container
*
* @param array|string $config
*/
protected function initializeContainer($config)
{
}
/**
* Build the container of services and parameters.
*
* @param array|string $config
* @return ContainerBuilder
*/
protected function buildContainer($config)
{
}
/**
* @return array<string,string>
*/
protected function getParameters()
{
}
/**
* @return ContainerBuilder
*/
public function getContainer()
{
}
/**
* @return object|null
*/
public function get($service)
{
}
}
}
namespace Bitpay\Network {
/**
*
* @package Bitcore
*/
interface NetworkInterface
{
/**
* Name of network, currently on livenet and testnet
*
* @return string
*/
public function getName();
/**
* @return string
*/
public function getAddressVersion();
/**
* The host that is used to interact with this network
*
* @see https://github.com/bitpay/insight
* @see https://github.com/bitpay/insight-api
*
* @return string
*/
public function getApiHost();
/**
* The port of the host
*
* @return integer
*/
public function getApiPort();
}
/**
*
* @package Bitcore
*/
class Customnet implements \Bitpay\Network\NetworkInterface
{
protected $host_url;
protected $host_port;
public $isPortRequiredInUrl;
public function __construct($url, $port, $isPortRequiredInUrl = false)
{
}
public function getName()
{
}
public function getAddressVersion()
{
}
public function getApiHost()
{
}
public function getApiPort()
{
}
}
/**
*
* @package Bitcore
*/
interface NetworkAwareInterface
{
/**
* Set the network the object will work with
*
* @param NetworkInterface $network
*/
public function setNetwork(\Bitpay\Network\NetworkInterface $network = null);
}
/**
* @package Bitpay
*/
class Testnet implements \Bitpay\Network\NetworkInterface
{
public function getName()
{
}
public function getAddressVersion()
{
}
public function getApiHost()
{
}
public function getApiPort()
{
}
}
/**
*
* @package Bitcore
*/
abstract class NetworkAware implements \Bitpay\Network\NetworkAwareInterface
{
/**
* @var NetworkInterface
*/
protected $network;
/**
* @inheritdoc
*/
public function setNetwork(\Bitpay\Network\NetworkInterface $network = null)
{
}
}
/**
*
* @package Bitcore
*/
class Livenet implements \Bitpay\Network\NetworkInterface
{
public function getName()
{
}
public function getAddressVersion()
{
}
public function getApiHost()
{
}
public function getApiPort()
{
}
}
}
namespace Bitpay {
/**
* Class PayoutTransaction
* @package Bitpay
*/
interface PayoutTransactionInterface
{
/**
* Get bitcoin blockchain transaction ID for the payout transaction.
* @return mixed
*/
public function getTransactionID();
/**
* The amount of bitcoin paid.
* @return float
*/
public function getAmount();
/**
* The date and time when the payment was sent.
* @return string
*/
public function getDate();
}
/**
* Class PayoutTransaction
* @package Bitpay
*/
class PayoutTransaction implements \Bitpay\PayoutTransactionInterface
{
/**
* @var string
*/
protected $txid;
/**
* @var float
*/
protected $amount;
/**
* @var string
*/
protected $date;
/**
* @inheritdoc
*/
public function getTransactionId()
{
}
/**
* Set transaction ID for payout.
* @param $txid
* @return $this
*/
public function setTransactionId($txid)
{
}
/**
* @inheritdoc
*/
public function getAmount()
{
}
/**
* Set the amount of bitcoin paid in the paout.
* @param $amount
* @return $this
*/
public function setAmount($amount)
{
}
/**
* @inheritdoc
*/
public function getDate()
{
}
/**
* Set the date and time of when the payment was sent.
* @param $date
* @return $this
*/
public function setDate($date)
{
}
}
}
namespace Bitpay\Util {
interface CurveParameterInterface
{
public function aHex();
public function bHex();
public function gHex();
public function gxHex();
public function gyHex();
public function hHex();
public function nHex();
public function pHex();
}
/**
* Elliptic curve parameters for secp256k1, see:
* http://www.secg.org/collateral/sec2_final.pdf
* also:
*
* @see https://en.bitcoin.it/wiki/Secp256k1
* @package Bitpay
*/
class Secp256k1 implements \Bitpay\Util\CurveParameterInterface
{
const A = '00';
const B = '07';
const G = '0479BE667EF9DCBBAC55A06295CE870B07029BFCDB2DCE28D959F2815B16F81798483ADA7726A3C4655DA4FBFC0E1108A8FD17B448A68554199C47D08FFB10D4B8';
const H = '01';
const N = 'FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEBAAEDCE6AF48A03BBFD25E8CD0364141';
const P = 'FFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFFEFFFFFC2F';
public function aHex()
{
}
public function bHex()
{
}
public function gHex()
{
}
public function gxHex()
{
}
public function gyHex()
{
}
public function hHex()
{
}
public function nHex()
{
}
public function pHex()
{
}
}
/**
* Utility class used by string and arbitrary integer methods.
*
* @package Bitpay
*/
class Util
{
/**
* @var string
*/
const HEX_CHARS = '0123456789abcdef';
/**
* Computes a digest hash value for the given data using
* the given method, and returns a raw or binhex encoded
* string. Uses the OpenSSL extension.
*
* @see http://us1.php.net/manual/en/function.openssl-digest.php
* @param string $data
* @param boolean $binary
* @return string
*/
public static function sha256($data, $binary = false)
{
}
/**
* Computes a digest hash value for the given data using
* the given method, and returns a raw or binhex encoded
* string. Uses the OpenSSL extension.
*
* @see http://us1.php.net/manual/en/function.openssl-digest.php
* @param string $data
* @return string
*/
public static function sha512($data)
{
}
/**
* Generate a keyed hash value using the HMAC method.
*
* @see http://us1.php.net/manual/en/function.hash-hmac.php
* @param string $data
* @param string $key
* @return string
*/
public static function sha512hmac($data, $key)
{
}
/**
* Uses the OpenSSL extention to calculate the RIPDEMD160
* hash of a value.
*
* @see http://php.net/manual/en/function.openssl-digest.php
* @param string $data
* @param boolean $binary
* @return string
*/
public static function ripe160($data, $binary = false)
{
}
/**
* Returns a SHA256 hash of a RIPEMD160 hash of a value.
*
* @param string $data
* @return string
*/
public static function sha256ripe160($data)
{
}
/**
* Returns a double SHA256 hash of a value.
*
* @param string $data
* @param boolean $binary
* @return string
*/
public static function twoSha256($data, $binary = false)
{
}
/**
* Returns a GUID for use in REST calls.
*
* @see http://en.wikipedia.org/wiki/Globally_unique_identifier
* @return string
*/
public static function guid()
{
}
/**
* Encodes a decimal value into hexadecimal.
*
* @param string $dec
* @return string
* @throws \Exception
*/
public static function encodeHex($dec)
{
}
/**
* Decodes a hexadecimal value into decimal.
*
* @param string $hex
* @return string
* @throws \Exception
*/
public static function decodeHex($hex)
{
}
/**
* Calculates a new EC curve point.
*
* @param string $hex
* @param PointInterface $point
* @param CurveParameterInterface $parameters
* @return Point
*/
public static function doubleAndAdd($hex, \Bitpay\PointInterface $point, \Bitpay\Util\CurveParameterInterface $parameters = null)
{
}
/**
* This method returns a binary string representation of
* the decimal number. Used for the doubleAndAdd() method.
*
* @see http://php.net/manual/en/function.decbin.php (but for large numbers)
* @param string $dec
* @return string $bin
*/
public static function decToBin($dec)
{
}
/**
* Point multiplication method 2P = R where
* s = (3xP2 + a)/(2yP) mod p
* xR = s2 - 2xP mod p
* yR = -yP + s(xP - xR) mod p
*
* @param PointInterface $point
* @param CurveParameterInterface $parameters
* @return PointInterface
* @throws \Exception
*/
public static function pointDouble(\Bitpay\PointInterface $point, \Bitpay\Util\CurveParameterInterface $parameters = null)
{
}
/**
* Point addition method P + Q = R where:
* s = (yP - yQ)/(xP - xQ) mod p
* xR = s2 - xP - xQ mod p
* yR = -yP + s(xP - xR) mod p
*
* @param PointInterface $P
* @param PointInterface $Q
* @return PointInterface
*/
public static function pointAdd(\Bitpay\PointInterface $P, \Bitpay\PointInterface $Q)
{
}
/**
* Converts hex value into octet (byte) string.
*
* @param string $hex
* @return string $byte
*/
public static function binConv($hex)
{
}
/**
* Checks dependencies for the library.
*
* @return array list of each requirement, boolean true if met, string error message if not as value
*/
public static function checkRequirements()
{
}
}
/**
* Utility class for encoding/decoding BASE-58 data
*
* @package Bitpay
*/
final class Base58
{
/**
* @var string
*/
const BASE58_CHARS = '123456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz';
/**
* Encodes a numeric string into BASE-58 format.
*
* @param string $data
* @return string $output_string
* @throws \Exception
*/
public static function encode($data)
{
}
/**
* Decodes a numeric string from BASE-58 format.
*
* @param string $data
* @return string $return
*/
public static function decode($data)
{
}
}
/**
* Utility class for generating an operating system & enivironment fingerprint.
*
* @package Bitpay
*/
class Fingerprint
{
protected static $sigData;
protected static $finHash;
/**
* Generates a string of environment information and
* takes the hash of that value to use as the env
* fingerprint.
*
* @return string
*/
public static final function generate()
{
}
}
/**
* General error class.
*
* @package Bitpay
*/
class Error
{
/**
* Generates a backtrace and returns an array of associative
* arrays or prints to stdout. The possible returned elements
* are as follows: function, line, file, class, object, type
* and args.
* (PHP 4 >= 4.3.0, PHP 5)
*
* @param bool
* @param bool
* @param int
* @return array|void
*/
public final function backtrace($print = false, $options = false, $limit = 0)
{
}
/**
* Get the last occurred error and returns an associative
* array describing the last error with keys "type", "message",
* "file" and "line". If the error has been caused by a PHP
* internal function then the "message" begins with its name.
* Returns NULL if there hasn't been an error yet.
* (PHP 5 >= 5.2.0)
*
* @param void
* @return array
*/
public final function last()
{
}
/**
* Send an error message to the defined error handling
* routines. Returns true on success or false on failure.
* The possible values for $message_type are: 0 = system log,
* 1 = email to $destination, 2 = depricated, 3 = appended
* to file $destination, 4 = sent to SAPI log handler.
* (PHP 4, PHP 5)
*
* @param string
* @param int
* @param string
* @param string
*/
public final function log($message, $message_type = 0, $destination = '', $extra_headers = '')
{
}
/**
* Sets which PHP errors are reported or returns the old
* error_reporting level or the current level if no level
* parameter is given.
* (PHP 4, PHP 5)
*
* @param bool
* @return int
*/
public final function reporting($level = false)
{
}
/**
* Sets or restores either the error or exception handler
* based on the $type and $action parameters.
* (PHP 4 >= 4.0.1, PHP 5)
*
* @param string
* @param string
* @param mixed
* @param int
* return mixed
*/
public final function handler($type = 'error', $action = 'restore', $callable_handler = false, $error_types = null)
{
}
/**
* Generates a user-level error/warning/notice message.
* This function returns FALSE if wrong $error_type is
* specified, TRUE otherwise. The $error_msg param is
* limited to 1024 bytes.
* (PHP 4 >= 4.0.1, PHP 5)
*
* @param string
* @param int
* @return bool
*/
public final function raise($error_msg, $error_type = E_USER_NOTICE)
{
}
}
/**
* Generates cryptographically-secure random numbers using the OpenSSL extension.
*
* @package Bitpay
*/
class SecureRandom
{
/**
* @var boolean
*/
protected static $hasOpenSSL;
/**
* Generates 32 bytes of random data using the OpenSSL extension.
*
* @see http://php.net/manual/en/function.openssl-random-pseudo-bytes.php
* @param integer $bytes
* @return string $random
* @throws \Exception
*/
public static function generateRandom($bytes = 32)
{
}
/**
* Returns true/false if the OpenSSL extension is installed & enabled.
*
* @return boolean
*/
public static function hasOpenSSL()
{
}
}
}
namespace Bitpay\Math {
class Math
{
public static function setEngine($engine)
{
}
public static function getEngine()
{
}
public static function __callStatic($name, $arguments)
{
}
}
/**
* @package Bitcore
*/
interface EngineInterface
{
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function add($a, $b);
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function cmp($a, $b);
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function div($a, $b);
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function invertm($a, $b);
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function mod($a, $b);
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function mul($a, $b);
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function pow($a, $b);
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function sub($a, $b);
}
class GmpEngine implements \Bitpay\Math\EngineInterface
{
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function add($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function cmp($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function div($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function invertm($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function mod($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function mul($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function pow($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function sub($a, $b)
{
}
}
class BcEngine implements \Bitpay\Math\EngineInterface
{
const HEX_CHARS = '0123456789abcdef';
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function __construct()
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function add($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function cmp($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function div($a, $b)
{
}
/**
* Finds inverse number $inv for $num by modulus $mod, such as:
* $inv * $num = 1 (mod $mod)
*
* @param string $num
* @param string $mod
* @return string
* @access public
*/
public function invertm($num, $mod)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function mod($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function mul($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function pow($a, $b)
{
}
/**
* @param String $a Numeric String
* @param String $b Numeric String
*/
public function sub($a, $b)
{
}
public function input($x)
{
}
/**
* Function to determine if two numbers are
* co-prime according to the Euclidean algo.
*
* @param string $a First param to check.
* @param string $b Second param to check.
* @return bool Whether the params are cp.
*/
public function coprime($a, $b)
{
}
}
}
namespace Bitpay {
/**
* @package Bitpay
*/
class Item implements \Bitpay\ItemInterface
{
/**
* @var string
*/
protected $code;
/**
* @var string
*/
protected $description;
/**
* @var float
*/
protected $price;
/**
* @var integer
*/
protected $quantity;
/**
* @var boolean
*/
protected $physical;
public function __construct()
{
}
/**
* @inheritdoc
*/
public function getCode()
{
}
/**
* @param string $code
* @return ItemInterface
*/
public function setCode($code)
{
}
/**
* @inheritdoc
*/
public function getDescription()
{
}
/**
* @param string $description
* @return ItemInterface
*/
public function setDescription($description)
{
}
/**
* @inheritdoc
*/
public function getPrice()
{
}
/**
* @param mixed $price A float, integer, or en_US formatted numeric string
* @return Item
*/
public function setPrice($price)
{
}
/**
* @inheritdoc
*/
public function getQuantity()
{
}
/**
* @param integer $quantity
* @return Item
*/
public function setQuantity($quantity)
{
}
/**
* @inheritdoc
*/
public function isPhysical()
{
}
/**
* @param boolean $physical
* @return Item
*/
public function setPhysical($physical)
{
}
/**
* Checks the new price to include BTC
* values with more than 6 decimals.
*
* @param string $price The price value to check
* @throws \Exception
*/
protected function checkPriceFormat($price)
{
}
}
/**
* @package Bitpay
*/
class PublicKey extends \Bitpay\Key
{
/**
* @var SinKey
*/
protected $sin;
/**
* @var PrivateKey
*/
protected $privateKey;
/**
* Returns the compressed public key value
*
* @return string
*/
public function __toString()
{
}
/**
* @param PrivateKey
* @return PublicKey
*/
public static function createFromPrivateKey(\Bitpay\PrivateKey $private)
{
}
/**
* @param PrivateKey
* @return PublicKey
*/
public function setPrivateKey(\Bitpay\PrivateKey $privateKey)
{
}
/**
* Generates an uncompressed and compressed EC public key.
*
* @param \Bitpay\PrivateKey $privateKey
* @return \Bitpay\PublicKey
* @throws \Exception
*/
public function generate(\Bitpay\PrivateKey $privateKey = null)
{
}
/**
* Checks to see if the public key is not blank and contains
* valid decimal and hex valules for this->hex & this->dec
*
* @return boolean
*/
public function isValid()
{
}
/**
* @return SinKey
*/
public function getSin()
{
}
}
/**
* Interface PayoutInstructionInterface
* @package Bitpay
*/
interface PayoutInstructionInterface
{
/**
* Get Bitpay ID for this instruction.
* @return string
*/
public function getId();
/**
* Get Label for instruction payout.
* @return string
*/
public function getLabel();
/**
* Get the bitcoin address for the recipient.
* @return string
*/
public function getAddress();
/**
* Return the amount to pay the recipient.
* @return string
*/
public function getAmount();
/**
* Get the BTC array (once rates are set)
* @return array
*/
public function getBtc();
/**
* Return the status of this payout instruction
* @return string
*/
public function getStatus();
/**
* Return the transactions for this payout
* @return array
*/
public function getTransactions();
}
/**
* @package BitPay
*/
class SinKey extends \Bitpay\Key
{
/**
* Type 2 (ephemeral)
*/
const SIN_TYPE = '02';
/**
* Always the prefix!
* (well, right now)
*/
const SIN_VERSION = '0F';
/**
* @var string
*/
protected $value;
/**
* @var PublicKey
*/
protected $publicKey;
/**
* @return string
*/
public function __toString()
{
}
/**
* @param PublicKey
* @return SinKey
*/
public function setPublicKey(\Bitpay\PublicKey $publicKey)
{
}
/**
* Generates a Service Identification Number (SIN), see:
* https://en.bitcoin.it/wiki/Identity_protocol_v1
*
* @return SinKey
* @throws \Exception
*/
public function generate()
{
}
/**
* Checks to make sure that this SIN is a valid object.
*
* @return boolean
*/
public function isValid()
{
}
}
/**
* Creates an application for a new merchant account.
*
* @package Bitpay
*/
interface ApplicationInterface
{
/**
* @return array
*/
public function getUsers();
/**
* @return array
*/
public function getOrgs();
}
/**
* @package Bitpay
*/
class Application implements \Bitpay\ApplicationInterface
{
/**
* @var array
*/
protected $users;
/**
* @var array
*/
protected $orgs;
public function __construct()
{
}
/**
* @inheritdoc
*/
public function getUsers()
{
}
/**
* @inheritdoc
*/
public function getOrgs()
{
}
/**
* Add user to stack
*
* @param User $user
* @return Application
*/
public function addUser(\Bitpay\User $user)
{
}
/**
* Add org to stack
*
* @param Org $org
* @return Application
*/
public function addOrg(\Bitpay\Org $org)
{
}
}
/**
* @package Bitpay
*/
class Autoloader
{
/**
* Register the autoloader, by default this will put the BitPay autoloader
* first on the stack, to append the autoloader, pass `false` as an argument.
*
* Some applications will throw exceptions if the class isn't found and
* some are not compatible with PSR standards.
*
* @param boolean $prepend
* @throws \Exception
*/
public static function register($prepend = true)
{
}
/**
* Unregister this autoloader.
*
* @param boolean $ignoreFailures
* @throws \Exception
*/
public static function unregister($ignoreFailures = true)
{
}
/**
* Give a class name and it will require the file.
*
* @param string $class
* @return bool|null
* @throws \Exception
*/
public static function autoload($class)
{
}
}
/**
* Interface PayoutInterface
* @package Bitpay
*/
interface PayoutInterface
{
/**
* The payroll flow begins with the payroll provider creating a payout request,
* using the payroll facade.
*/
const STATUS_NEW = 'new';
/**
* Once Bitpay receives a corresponding ACH transfer from the payroll provider,
* the finance group marks the payout as 'funded'.
*/
const STATUS_FUNDED = 'funded';
/**
* A payout is marked as processing when it has begun to be processed, but
* is not yet complete.
*/
const STATUS_PROCESSING = 'processing';
/**
* A batch is marked as complete when all payments have been delivered to the
* destinations.
*/
const STATUS_COMPLETE = 'complete';
/**
* A payout can be cancelled by making a request on the API with a payout specific
* token (returned when payout was requested)
*/
const STATUS_CANCELLED = 'cancelled';
/**
* The batch ID of the payout assigned by Bitpay.com
*
* @return string
*/
public function getId();
/**
* Return the account parameter given by Bitpay.
*
* @return string
*/
public function getAccountId();
/**
* This is the total amount of the batch. Note, this amount must equal the sum of
* the amounts paid to the individual addresses. Adding an instruction to a payout
* will automatically increase this value.
*
* @return float
*/
public function getAmount();
/**
* This will return the Bitcoin amount for this transaction. This
* should only be called once the payout is funded
*
* @return float
*/
public function getBtcAmount();
/**
* This is the currency code set for the batch amount. The pricing currencies
* currently supported are USD and EUR.
*
* @return \Bitpay\CurrencyInterface
*/
public function getCurrency();
/**
* The date and time when the batch should be sent. The time is in milliseconds
* since midnight January 1, 1970.
*
* @return \DateTime
*/
public function getEffectiveDate();
/**
* The date and time when the batch was created by the payee. The time is in milliseconds
* since midnight January 1, 1970.
*
* @return \DateTime
*/
public function getRequestDate();
/**
* This is an array containing the details of the batch. Each payment instruction
* entry specifies the details for a single payout. There is no specific upper
* limit on the number of payment instruction entries in the batch instructions
*
* @return array
*/
public function getInstructions();
/**
* Status updates for the batch will be sent to this email address. If no value is
* specified, the Merchant email will be used as a notification.
*
* @return string
*/
public function getNotificationEmail();
/**
* A URL to send status update messages to your server (this must be an https
* URL, unencrypted http URLs or any other type of URL is not supported).
* Bitpay.com will send a POST request with a JSON encoding of the batch to this
* URL when the batch status changes.
*
* @return string
*/
public function getNotificationUrl();
/**
* The method you select determines the exchange rate used to compute the
* payouts for the entire batch.
*
* @return string
*/
public function getPricingMethod();
/**
* This is your reference label for this batch. It will be passedthrough on each
* response for you to identify the batch in your system. Maximum string length is
* 100 characters.
* This passthrough variable can be a JSONencoded string, for example
* { "ref":711454, "company":"Johns Data Center" }
*
* @return string
*/
public function getReference();
/**
* Get the status for this payout.
*
* @return $string;
*/
public function getStatus();
/**
* Get the payroll token
*
* @return mixed
*/
public function getToken();
/**
* Get the response token, for cancelling payout requests later.
*
* @return string
*/
public function getResponseToken();
}
}
namespace Bitpay\DependencyInjection {
/**
* @package Bitpay
*/
class BitpayExtension implements \Symfony\Component\DependencyInjection\Extension\ExtensionInterface
{
public function load(array $configs, \Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
/**
* @codeCoverageIgnore
*/
public function getAlias()
{
}
/**
* @codeCoverageIgnore
*/
public function getNamespace()
{
}
/**
* @codeCoverageIgnore
*/
public function getXsdValidationBasePath()
{
}
}
}
namespace Bitpay\DependencyInjection\Loader {
/**
* Used to load a configuration that is passed in as an array
*
* @package Bitpay
*/
class ArrayLoader extends \Symfony\Component\Config\Loader\Loader
{
protected $container;
public function __construct(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
public function load($resource, $type = null)
{
}
public function supports($resource, $type = null)
{
}
}
}
namespace Bitpay {
/**
* @package Bitpay
*/
interface TokenInterface
{
/**
* @return string
*/
public function getToken();
/**
* @return string
*/
public function getResource();
/**
* @return string
*/
public function getFacade();
/**
* @return \DateTime
*/
public function getCreatedAt();
/**
* @return array
*/
public function getPolicies();
/**
* @return string
*/
public function getPairingCode();
/**
* @return \DateTime
*/
public function getPairingExpiration();
}
/**
* @package Bitpay
*/
class Token implements \Bitpay\TokenInterface
{
/**
* @var string
*/
protected $token;
/**
* @var string
*/
protected $resource;
/**
* @var string
*/
protected $facade;
/**
* @var \DateTime
*/
protected $createdAt;
/**
* @var array
*/
protected $policies;
/**
* @var string
*/
protected $pairingCode;
/**
* @var \DateTime
*/
protected $pairingExpiration;
public function __construct()
{
}
/**
* @return string
*/
public function __toString()
{
}
/**
* @return string
*/
public function getToken()
{
}
/**
* @param string
* @return Token
*/
public function setToken($token)
{
}
/**
* @return string
*/
public function getResource()
{
}
/**
* @param string
* @return Token
*/
public function setResource($resource)
{
}
/**
* @return string
*/
public function getFacade()
{
}
/**
* @param string
* @return Token
*/
public function setFacade($facade)
{
}
/**
* @return \DateTime
*/
public function getCreatedAt()
{
}
/**
* @param \DateTime
* @return Token
*/
public function setCreatedAt(\DateTime $createdAt)
{
}
/**
* @return array
*/
public function getPolicies()
{
}
/**
* @param string
* @return Token
*/
public function setPolicies($policies)
{
}
/**
* @return string
*/
public function getPairingCode()
{
}
/**
* @param string
* @return Token
*/
public function setPairingCode($pairingCode)
{
}
/**
* @return \DateTime
*/
public function getPairingExpiration()
{
}
/**
* @param \DateTime
* @return Token
*/
public function setPairingExpiration(\DateTime $pairingExpiration)
{
}
}
/**
* Class Payout
* @package Bitpay
*/
class Payout implements \Bitpay\PayoutInterface
{
/**
* @var string
*/
protected $id;
/**
* @var string
*/
protected $account_id;
/**
* @var string
*/
protected $status;
/**
* @var float
*/
protected $amount;
/**
* @var float
*/
protected $btc;
/**
* @var CurrencyInterface
*/
protected $currency;
/**
* @var string
*/
protected $effectiveDate;
/**
* @var string
*/
protected $requestDate;
/**
* @var array
*/
protected $instructions = array();
/**
* @var string
*/
protected $notificationEmail;
/**
* @var string
*/
protected $notificationUrl;
/**
* @var string
*/
protected $pricingMethod;
/**
* @var string
*/
protected $rate;
/**
* @var string
*/
protected $reference;
/**
* @var string
*/
protected $responseToken;
/**
* @var TokenInterface
*/
protected $token;
/**
* @inheritdoc
*/
public function getId()
{
}
/**
* Set the batch ID as assigned from bitpay.
*
* @param $id
* @return $this
*/
public function setId($id)
{
}
/**
* @inheritdoc
*/
public function getAccountId()
{
}
/**
* Set Account Id - Bitpays account ID for the payout.
*
* @param $id
* @return $this
*/
public function setAccountId($id)
{
}
/**
* @inheritdoc
*/
public function getAmount()
{
}
/**
* Sets the amount for this payout.
* @param $amount
* @return $this
*/
public function setAmount($amount)
{
}
/**
* @interitdoc
*/
public function getCurrency()
{
}
/**
* Set Currency
* @param CurrencyInterface $currency
* @return $this
*/
public function setCurrency(\Bitpay\CurrencyInterface $currency)
{
}
/**
* @inheritdoc
*/
public function getEffectiveDate()
{
}
/**
* Set Effective date - date payout should be given to employees.
* @param $effectiveDate
* @return $this
*/
public function setEffectiveDate($effectiveDate)
{
}
/**
* Get rate assigned to payout at effectiveDate
*/
public function getRate()
{
}
/**
* Set the rate in bitcoin for the payouts of this transaction.
* @param $rate
* @return $this
*/
public function setRate($rate)
{
}
/**
* @inheritdoc
*/
public function getBtcAmount()
{
}
/**
* Set the Bitcoin amount for this payout, once set by Bitpay.
* @param $amount
* @return $this
*/
public function setBtcAmount($amount)
{
}
/**
* @inheritdoc
*/
public function getRequestDate()
{
}
/**
* Set
*/
public function setRequestDate($requestDate)
{
}
/**
* @inheritdoc
*/
public function getInstructions()
{
}
/**
* Add Instruction of PayoutInstructionInterface type
* Increases $this->amount by value.
*
* @param PayoutInstructionInterface $instruction
* @return $this
*/
public function addInstruction(\Bitpay\PayoutInstructionInterface $instruction)
{
}
/**
* Update Instruction - Supply an index of the instruction to update,
* plus the function and single argument, to do something to an instruction.
*
* @param $index
* @param $function
* @param $argument
* @return $this
*/
public function updateInstruction($index, $function, $argument)
{
}
/**
* @inheritdoc
*/
public function getStatus()
{
}
/**
* Sets the status for the current payout request
* @param $status
* @return $this
*/
public function setStatus($status)
{
}
/**
* @inheritdoc
*/
public function getToken()
{
}
/**
* Set the token to authorize this request.
* @param TokenInterface $token
* @return $this
*/
public function setToken(\Bitpay\TokenInterface $token)
{
}
/**
* @inheritdoc
*/
public function getResponseToken()
{
}
/**
* Set Response Token - returned by Bitpay when payout request is created
*
* @param $responseToken
* @return $this
*/
public function setResponseToken($responseToken)
{
}
/**
* @inheritdoc
*/
public function getPricingMethod()
{
}
/**
* Set the pricing method for this payout request
* @param $pricingMethod
* @return $this
*/
public function setPricingMethod($pricingMethod)
{
}
/**
* @inheritdoc
*/
public function getReference()
{
}
/**
* Set the payroll providers reference for this payout
*
* @param $reference
* @return $this
*/
public function setReference($reference)
{
}
/**
* @inheritdoc
*/
public function getNotificationEmail()
{
}
/**
* Set an email address where updates to payout status should be sent.
*
* @param $notificationEmail
* @return $this
*/
public function setNotificationEmail($notificationEmail)
{
}
/**
* @inheritdoc
*/
public function getNotificationUrl()
{
}
/**
* Set a notification url - where updated Payout objects will be sent
*
* @param $notificationUrl
* @return $this
*/
public function setNotificationUrl($notificationUrl)
{
}
}
/**
* Used to manage keys
*
* @package Bitcore
*/
class KeyManager
{
/**
* @var Bitpay\Storage\StorageInterface
*/
protected $storage;
/**
* @param StorageInterface $storage
*/
public function __construct(\Bitpay\Storage\StorageInterface $storage)
{
}
/**
* @param KeyInterface $key
*/
public function persist(\Bitpay\KeyInterface $key)
{
}
/**
* @return KeyInterface
*/
public function load($id)
{
}
}
}
namespace Bitpay\Config {
/**
* This class contains all the valid configuration settings that can be used.
* If you update this file to add new settings, please make sure you update the
* documentation as well.
*
* @see http://symfony.com/doc/current/components/config/definition.html
* @package Bitpay
*/
class Configuration implements \Symfony\Component\Config\Definition\ConfigurationInterface
{
/**
* @return TreeBuilder
*/
public function getConfigTreeBuilder()
{
}
/**
* Adds the key_storage node with validation rules.
* key_storage MUST:
* * implement Bitpay\Storage\StorageInterface
* * be a class that can be loaded
*
* @return \Symfony\Component\Config\Definition\Builder\NodeDefinition
* @throws \Exception
*/
protected function addKeyStorageNode()
{
}
}
}
namespace Bitpay {
/**
* This is the currency code set for the price setting. The currencies supported are any
* of the codes listed on this page: https://bitpay.com/bitcoin-exchange-rates
*
* @package Bitpay
*/
interface CurrencyInterface
{
/**
* @return string
*/
public function getCode();
/**
* @return string
*/
public function getSymbol();
/**
* @return string
*/
public function getPrecision();
/**
* @return string
*/
public function getExchangePctFee();
/**
* @return boolean
*/
public function isPayoutEnabled();
/**
* @return string
*/
public function getName();
/**
* @return string
*/
public function getPluralName();
/**
* @return array
*/
public function getAlts();
/**
* @return array
*/
public function getPayoutFields();
}
/**
* For the most part this should conform to ISO 4217
*
* @see http://en.wikipedia.org/wiki/ISO_4217
* @package Bitpay
*/
class Currency implements \Bitpay\CurrencyInterface
{
/**
* @see https://bitpay.com/currencies
* @var array
*/
protected static $availableCurrencies = array('BTC', 'AED', 'AFN', 'ALL', 'AMD', 'ANG', 'AOA', 'ARS', 'AUD', 'AWG', 'AZN', 'BAM', 'BBD', 'BDT', 'BGN', 'BHD', 'BIF', 'BMD', 'BND', 'BOB', 'BRL', 'BSD', 'BTN', 'BWP', 'BYR', 'BZD', 'CAD', 'CDF', 'CHF', 'CLF', 'CLP', 'CNY', 'COP', 'CRC', 'CVE', 'CZK', 'DJF', 'DKK', 'DOP', 'DZD', 'EEK', 'EGP', 'ETB', 'EUR', 'FJD', 'FKP', 'GBP', 'GEL', 'GHS', 'GIP', 'GMD', 'GNF', 'GTQ', 'GYD', 'HKD', 'HNL', 'HRK', 'HTG', 'HUF', 'IDR', 'ILS', 'INR', 'IQD', 'ISK', 'JEP', 'JMD', 'JOD', 'JPY', 'KES', 'KGS', 'KHR', 'KMF', 'KRW', 'KWD', 'KYD', 'KZT', 'LAK', 'LBP', 'LKR', 'LRD', 'LSL', 'LTL', 'LVL', 'LYD', 'MAD', 'MDL', 'MGA', 'MKD', 'MMK', 'MNT', 'MOP', 'MRO', 'MUR', 'MVR', 'MWK', 'MXN', 'MYR', 'MZN', 'NAD', 'NGN', 'NIO', 'NOK', 'NPR', 'NZD', 'OMR', 'PAB', 'PEN', 'PGK', 'PHP', 'PKR', 'PLN', 'PYG', 'QAR', 'RON', 'RSD', 'RUB', 'RWF', 'SAR', 'SBD', 'SCR', 'SDG', 'SEK', 'SGD', 'SHP', 'SLL', 'SOS', 'SRD', 'STD', 'SVC', 'SYP', 'SZL', 'THB', 'TJS', 'TMT', 'TND', 'TOP', 'TRY', 'TTD', 'TWD', 'TZS', 'UAH', 'UGX', 'USD', 'UYU', 'UZS', 'VEF', 'VND', 'VUV', 'WST', 'XAF', 'XAG', 'XAU', 'XCD', 'XOF', 'XPF', 'YER', 'ZAR', 'ZMW', 'ZWL');
/**
* @var string
*/
protected $code;
/**
* @var string
*/
protected $symbol;
/**
* @var integer
*/
protected $precision;
/**
* @var string
*/
protected $exchangePercentageFee;
/**
* @var boolean
*/
protected $payoutEnabled;
/**
* @var string
*/
protected $name;
/**
* @var string
*/
protected $pluralName;
/**
* @var array
*/
protected $alts;
/**
* @var array
*/
protected $payoutFields;
/**
* @param string $code The Currency Code to use, ie USD
* @throws Exception Throws an exception if the Currency Code is not supported
*/
public function __construct($code = null)
{
}
/**
* @inheritdoc
*/
public function getCode()
{
}
/**
* This will change the $code to all uppercase
*
* @param string $code The Currency Code to use, ie USD
* @throws Exception Throws an exception if the Currency Code is not supported
* @return CurrencyInterface
*/
public function setCode($code)
{
}
/**
* @inheritdoc
*/
public function getSymbol()
{
}
/**
* @param string $symbol
*
* @return CurrencyInterface
*/
public function setSymbol($symbol)
{
}
/**
* @inheritdoc
*/
public function getPrecision()
{
}
/**
* @param integer $precision
*
* @return CurrencyInterface
*/
public function setPrecision($precision)
{
}
/**
* @inheritdoc
*/
public function getExchangePctFee()
{
}
/**
* @param string $fee
*
* @return CurrencyInterface
*/
public function setExchangePctFee($fee)
{
}
/**
* @inheritdoc
*/
public function isPayoutEnabled()
{
}
/**
* @param boolean $enabled
*
* @return CurrencyInterface
*/
public function setPayoutEnabled($enabled)
{
}
/**
* @inheritdoc
*/
public function getName()
{
}
/**
* @param string $name
*
* @return CurrencyInterface
*/
public function setName($name)
{
}
/**
* @inheritdoc
*/
public function getPluralName()
{
}
/**
* @param string $pluralName
*
* @return CurrencyInterface
*/
public function setPluralName($pluralName)
{
}
/**
* @inheritdoc
*/
public function getAlts()
{
}
/**
* @param array $alts
*
* @return CurrencyInterface
*/
public function setAlts($alts)
{
}
/**
* @inheritdoc
*/
public function getPayoutFields()
{
}
/**
* @param array $payoutFields
*
* @return CurrencyInterface
*/
public function setPayoutFields(array $payoutFields)
{
}
}
}
namespace Bitpay\Crypto {
/**
* All crypto extensions MUST support this interface
*/
interface CryptoInterface
{
/**
* If the users system supports the cryto extension, this should return
* true, otherwise it should return false.
*
* @return boolean
*/
public static function hasSupport();
/**
* @return array
*/
public function getAlgos();
}
/**
* Wrapper around the HASH Message Digest Framework for PHP
*
* @see http://php.net/manual/en/book.hash.php
*/
class HashExtension implements \Bitpay\Crypto\CryptoInterface
{
/**
* @inheritdoc
*/
public static function hasSupport()
{
}
/**
* Return a list of registered hashing algorithms.
* (PHP 5 >= 5.1.2, PECL hash >= 1.1)
*
* @return array
*/
public function getAlgos()
{
}
/**
* Copy a hashing context.
* (PHP 5 >= 5.3.0)
*
* @param resource
* @return resource
*/
public final function copy($context)
{
}
/**
* Compares two strings using the same time
* whether they're equal or not. This function
* should be used to mitigate timing attacks;
* for instance, when testing crypt() password
* hashes.
* (PHP 5 >= 5.6.0)
*
* @param string
* @param string
*/
public function equals($string1, $string2)
{
}
/**
* Generate a hash value using the contents of
* a given file. Returns a string containing
* the calculated message digest as lowercase
* hexits unless raw_output is set to true in
* which case the raw binary representation of
* the message digest is returned.
* (PHP 5 >= 5.1.2, PECL hash >= 1.1)
*
* @param string
* @param string
* @param bool
* @return string
*/
public function file($algorithm, $filename, $raw_output = false)
{
}
/**
* Finalize an incremental hash and return
* resulting digest.
* (PHP 5 >= 5.1.2, PECL hash >= 1.1)
*
* @param resource
* @param bool
* @return string
*/
public function finalize($context, $raw_output = false)
{
}
/**
* Generate a keyed hash value using the HMAC
* method and the contents of a given file.
* (PHP 5 >= 5.1.2, PECL hash >= 1.1)
*
* @param string
* @param string
* @param string
* @param bool
* @return string
*/
public function hmacFile($algorithm, $filename, $key, $raw_output = false)
{
}
/**
* Generate a keyed hash value using the HMAC
* method and the message passed via $data.
* (PHP 5 >= 5.1.2, PECL hash >= 1.1)
*
* @param string
* @param string
* @param string
* @param bool
* @return string
*/
public function hmac($algo, $data, $key, $raw_output = false)
{
}
/**
* Initialize an incremental hashing context and
* returns a Hashing Context resource for use with
* hash_update(), hash_update_stream(), hash_update_file(),
* and hash_final(). Note: the only option possible
* for $options at this time is HASH_HMAC. When
* this is specified, the key *must* be used as well.
* (PHP 5 >= 5.1.2, PECL hash >= 1.1)
*
* @param string
* @param int
* @param string
* @return resource
*/
public function init($algorithm, $options = 0, $key = null)
{
}
/**
* Generate a PBKDF2 key derivation of a supplied
* password. An E_WARNING will be raised if the
* algorithm is unknown, the iterations parameter
* is less than or equal to 0, the length is less
* than 0 or the salt is too long (greater than
* INT_MAX - 4). The salt should be generated
* randomly with openssl_ramdom_pseudo_bytes().
* (PHP 5 >= 5.5.0)
*
* @param string
* @param string
* @param string
* @param int
* @param int
* @param bool
* @return string
*/
public function pbkdf2($algo, $password, $salt, $iterations, $length = 0, $raw_output = false)
{
}
/**
* Pump data into an active hashing context
* from a file. Returns TRUE on success or
* FALSE on failure.
* (PHP 5 >= 5.1.2, PECL hash >= 1.1)
*
* @param resource
* @param string
* @param resource
* @return bool
*/
public function updateFile($hcontext, $filename, $scontext = null)
{
}
/**
* Pump data into an active hashing context
* from an open stream. Returns the actual
* number of bytes added to the hashing
* context from handle.
* (PHP 5 >= 5.1.2, PECL hash >= 1.1)
*
* @param resource
* @param resource
* @param int
* @return int
*/
public function updateStream($context, $handle, $length = -1)
{
}
/**
* Pump data into an active hashing context.
* The PHP function itself only returns true.
* (PHP 5 >= 5.1.2, PECL hash >= 1.1)
*
* @param resource
* @param string
* @return bool
*/
public function update($context, $data)
{
}
/**
* Generate a hash value (message digest)
* based on the request algorithm and the
* provided data. Outputs hex unless the
* $raw_output param is set to true.
* (PHP 5 >= 5.1.2, PECL hash >= 1.1)
*
* @param string
* @param string
* @param bool
* @return string
*/
public function generate($algo, $data, $raw_output = false)
{
}
}
/**
* Wrapper around the OpenSSL PHP Extension
*
* @see http://php.net/manual/en/book.openssl.php
*/
class OpenSSLExtension implements \Bitpay\Crypto\CryptoInterface
{
/**
* @inheritdoc
*/
public static function hasSupport()
{
}
/**
* @inheritdoc
*/
public function getAlgos()
{
}
/**
* Function to generate a new RSA keypair. This is not
* used for point derivation or for generating signatures.
* Only used for assymetric data encryption, as needed.
*
* @param int
* @param string
* @return array|boolean array of keys on success, boolean false on failure
*/
public final function generateKeypair($keybits = 512, $digest_alg = 'sha512')
{
}
/**
* Generates a high-quality random number suitable for
* use in cryptographic functions and returns hex value.
*
* @param int
* @return string|bool
*/
public final function randomNumber($bytes = 32)
{
}
/**
* Returns the cipher length on success, or FALSE
* on failure. (PHP 5 >= PHP 5.3.3)
*
* @param string
* @return int|bool
*/
public final function cypherIVLength($cypher = '')
{
}
/**
* Takes the Certificate Signing Request represented
* by $csr and saves it as ascii-armoured text into
* the file named by $outfilename.
* (PHP 4 >= 4.2.0, PHP 5)
*
* @param resource
* @param string
* @param bool
* @return bool
*/
public final function saveCSRtoFile($csr, $outfilename, $notext = true)
{
}
/**
* Takes the Certificate Signing Request represented
* by $csr and stores it as ascii-armoured text into
* $out, which is passed by reference.
* (PHP 4 >= 4.2.0, PHP 5)
*
* @param resource
* @param string
* @param bool
* @return bool
*/
public final function saveCSRtoString($csr, $out, $notext = true)
{
}
}
}
namespace Bitpay {
/**
* Class PayoutInstruction
* @package Bitpay
*/
class PayoutInstruction implements \Bitpay\PayoutInstructionInterface
{
/**
* A transaction is unpaid when the payout in bitcoin has not yet occured.
*/
const STATUS_UNPAID = 'unpaid';
/**
* A transaction is marked as paid once the payroll is complete and bitcoins are
* sent to the recipient
*/
const STATUS_PAID = 'paid';
/**
* @var string
*/
protected $id;
/**
* @var array
*/
protected $btc;
/**
* @var string
*/
protected $label;
/**
* @var string
*/
protected $address;
/**
* @var float
*/
protected $amount;
/**
* @var string
*/
protected $status;
/**
* @var array
*/
protected $transactions = array();
public function __construct()
{
}
/**
* @inheritdoc
*/
public function getId()
{
}
/**
* Set the Bitpay ID for this payout instruction
*
* @param $id
* @return $this
*/
public function setId($id)
{
}
/**
* @inheritdoc
*/
public function getLabel()
{
}
/**
* Set the employers label for this instruction.
* @param $label
* @return $this
*/
public function setLabel($label)
{
}
/**
* @inheritdoc
*/
public function getAddress()
{
}
/**
* Set the bitcoin address for this instruction.
* @param $address
* @return $this
*/
public function setAddress($address)
{
}
/**
* @inheritdoc
*/
public function getAmount()
{
}
/**
* Set the amount for this instruction.
* @param $amount
* @return $this
*/
public function setAmount($amount)
{
}
/**
* @inheritdoc
*/
public function getBtc()
{
}
/**
* Set BTC array (available once rates are set)
* @param $btc
* @return $this
*/
public function setBtc($btc)
{
}
/**
* @inheritdoc
*/
public function getStatus()
{
}
/**
* Set the status for this instruction
* @param $status
* @return $this
*/
public function setStatus($status)
{
}
/**
* @inheritdoc
*/
public function getTransactions()
{
}
/**
* Add payout transaction to the
* @param PayoutTransactionInterface $transaction
* @return $this
*/
public function addTransaction(\Bitpay\PayoutTransactionInterface $transaction)
{
}
}
}
namespace {
/**
* Filesystem tools not provided by default; can recursively create, copy
* and delete folders. Some template methods are provided for extensibility.
*
* @note This class must be instantiated to be used, although it does
* not maintain state.
*/
class FSTools
{
/**
* Returns a global instance of FSTools
*/
public static function singleton()
{
}
/**
* Sets our global singleton to something else; useful for overloading
* functions.
*/
public static function setSingleton($singleton)
{
}
/**
* Recursively creates a directory
* @param string $folder Name of folder to create
* @note Adapted from the PHP manual comment 76612
*/
public function mkdirr($folder)
{
}
/**
* Copy a file, or recursively copy a folder and its contents; modified
* so that copied files, if PHP, have includes removed
* @note Adapted from http://aidanlister.com/repos/v/function.copyr.php
*/
public function copyr($source, $dest)
{
}
/**
* Overloadable function that tests a filename for copyability. By
* default, everything should be copied; you can restrict things to
* ignore hidden files, unreadable files, etc. This function
* applies to copyr().
*/
public function copyable($file)
{
}
/**
* Delete a file, or a folder and its contents
* @note Adapted from http://aidanlister.com/repos/v/function.rmdirr.php
*/
public function rmdirr($dirname)
{
}
/**
* Recursively globs a directory.
*/
public function globr($dir, $pattern, $flags = \NULL)
{
}
/**
* Allows for PHP functions to be called and be stubbed.
* @warning This function will not work for functions that need
* to pass references; manually define a stub function for those.
*/
public function __call($name, $args)
{
}
}
/**
* Custom FSTools for this script that overloads some behavior
* @warning The overloading of copy() is not necessarily global for
* this script. Watch out!
*/
class MergeLibraryFSTools extends \FSTools
{
public function copyable($entry)
{
}
public function copy($source, $dest)
{
}
}
class HTML5
{
const PCDATA = 0;
const RCDATA = 1;
const CDATA = 2;
const PLAINTEXT = 3;
const DOCTYPE = 0;
const STARTTAG = 1;
const ENDTAG = 2;
const COMMENT = 3;
const CHARACTR = 4;
const EOF = 5;
public function __construct($data)
{
}
public function save()
{
}
}
class HTML5TreeConstructer
{
public $stack = array();
// The different phases.
const INIT_PHASE = 0;
const ROOT_PHASE = 1;
const MAIN_PHASE = 2;
const END_PHASE = 3;
// The different insertion modes for the main phase.
const BEFOR_HEAD = 0;
const IN_HEAD = 1;
const AFTER_HEAD = 2;
const IN_BODY = 3;
const IN_TABLE = 4;
const IN_CAPTION = 5;
const IN_CGROUP = 6;
const IN_TBODY = 7;
const IN_ROW = 8;
const IN_CELL = 9;
const IN_SELECT = 10;
const AFTER_BODY = 11;
const IN_FRAME = 12;
const AFTR_FRAME = 13;
// The different types of elements.
const SPECIAL = 0;
const SCOPING = 1;
const FORMATTING = 2;
const PHRASING = 3;
const MARKER = 0;
public function __construct()
{
}
// Process tag tokens
public function emitToken($token)
{
}
public function save()
{
}
}
/**
* Meta-class for HTML Purifier's extra class hierarchies, similar to
* HTMLPurifier_Bootstrap.
*/
class HTMLPurifierExtras
{
public static function autoload($class)
{
}
public static function getPath($class)
{
}
}
/**
* Represents a file in the filesystem
*
* @warning Be sure to distinguish between get() and write() versus
* read() and put(), the former operates on the entire file, while
* the latter operates on a handle.
*/
class FSTools_File
{
/** Filename of file this object represents */
protected $name;
/** Handle for the file */
protected $handle = \false;
/** Instance of FSTools for interfacing with filesystem */
protected $fs;
/**
* Filename of file you wish to instantiate.
* @note This file need not exist
*/
public function __construct($name, $fs = \false)
{
}
/** Returns the filename of the file. */
public function getName()
{
}
/** Returns directory of the file without trailing slash */
public function getDirectory()
{
}
/**
* Retrieves the contents of a file
* @todo Throw an exception if file doesn't exist
*/
public function get()
{
}
/** Writes contents to a file, creates new file if necessary */
public function write($contents)
{
}
/** Deletes the file */
public function delete()
{
}
/** Returns true if file exists and is a file. */
public function exists()
{
}
/** Returns last file modification time */
public function getMTime()
{
}
/**
* Chmod a file
* @note We ignore errors because of some weird owner trickery due
* to SVN duality
*/
public function chmod($octal_code)
{
}
/** Opens file's handle */
public function open($mode)
{
}
/** Closes file's handle */
public function close()
{
}
/** Retrieves a line from an open file, with optional max length $length */
public function getLine($length = \null)
{
}
/** Retrieves a character from an open file */
public function getChar()
{
}
/** Retrieves an $length bytes of data from an open data */
public function read($length)
{
}
/** Writes to an open file */
public function put($string)
{
}
/** Returns TRUE if the end of the file has been reached */
public function eof()
{
}
public function __destruct()
{
}
}
/**
* Decorator/extender XSLT processor specifically for HTML documents.
*/
class ConfigDoc_HTMLXSLTProcessor
{
/**
* Instance of XSLTProcessor
*/
protected $xsltProcessor;
public function __construct($proc = \false)
{
}
/**
* @note Allows a string $xsl filename to be passed
*/
public function importStylesheet($xsl)
{
}
/**
* Transforms an XML file into compatible XHTML based on the stylesheet
* @param $xml XML DOM tree, or string filename
* @return string HTML output
* @todo Rename to transformToXHTML, as transformToHTML is misleading
*/
public function transformToHTML($xml)
{
}
/**
* Bulk sets parameters for the XSL stylesheet
* @param array $options Associative array of options to set
*/
public function setParameters($options)
{
}
/**
* Forward any other calls to the XSLT processor
*/
public function __call($name, $arguments)
{
}
}
// custom class to aid unit testing
class RowTimer extends \Benchmark_Timer
{
public $name;
public function __construct($name, $auto = \false)
{
}
public function getOutput()
{
}
}
/*! @mainpage
*
* HTML Purifier is an HTML filter that will take an arbitrary snippet of
* HTML and rigorously test, validate and filter it into a version that
* is safe for output onto webpages. It achieves this by:
*
* -# Lexing (parsing into tokens) the document,
* -# Executing various strategies on the tokens:
* -# Removing all elements not in the whitelist,
* -# Making the tokens well-formed,
* -# Fixing the nesting of the nodes, and
* -# Validating attributes of the nodes; and
* -# Generating HTML from the purified tokens.
*
* However, most users will only need to interface with the HTMLPurifier
* and HTMLPurifier_Config.
*/
/*
HTML Purifier 4.9.2 - Standards Compliant HTML Filtering
Copyright (C) 2006-2008 Edward Z. Yang
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
*/
/**
* Facade that coordinates HTML Purifier's subsystems in order to purify HTML.
*
* @note There are several points in which configuration can be specified
* for HTML Purifier. The precedence of these (from lowest to
* highest) is as follows:
* -# Instance: new HTMLPurifier($config)
* -# Invocation: purify($html, $config)
* These configurations are entirely independent of each other and
* are *not* merged (this behavior may change in the future).
*
* @todo We need an easier way to inject strategies using the configuration
* object.
*/
class HTMLPurifier
{
/**
* Version of HTML Purifier.
* @type string
*/
public $version = '4.9.2';
/**
* Constant with version of HTML Purifier.
*/
const VERSION = '4.9.2';
/**
* Global configuration object.
* @type HTMLPurifier_Config
*/
public $config;
/**
* @type HTMLPurifier_Strategy_Core
*/
protected $strategy;
/**
* @type HTMLPurifier_Generator
*/
protected $generator;
/**
* Resultant context of last run purification.
* Is an array of contexts if the last called method was purifyArray().
* @type HTMLPurifier_Context
*/
public $context;
/**
* Initializes the purifier.
*
* @param HTMLPurifier_Config|mixed $config Optional HTMLPurifier_Config object
* for all instances of the purifier, if omitted, a default
* configuration is supplied (which can be overridden on a
* per-use basis).
* The parameter can also be any type that
* HTMLPurifier_Config::create() supports.
*/
public function __construct($config = \null)
{
}
/**
* Adds a filter to process the output. First come first serve
*
* @param HTMLPurifier_Filter $filter HTMLPurifier_Filter object
*/
public function addFilter($filter)
{
}
/**
* Filters an HTML snippet/document to be XSS-free and standards-compliant.
*
* @param string $html String of HTML to purify
* @param HTMLPurifier_Config $config Config object for this operation,
* if omitted, defaults to the config object specified during this
* object's construction. The parameter can also be any type
* that HTMLPurifier_Config::create() supports.
*
* @return string Purified HTML
*/
public function purify($html, $config = \null)
{
}
/**
* Filters an array of HTML snippets
*
* @param string[] $array_of_html Array of html snippets
* @param HTMLPurifier_Config $config Optional config object for this operation.
* See HTMLPurifier::purify() for more details.
*
* @return string[] Array of purified HTML
*/
public function purifyArray($array_of_html, $config = \null)
{
}
/**
* Singleton for enforcing just one HTML Purifier in your system
*
* @param HTMLPurifier|HTMLPurifier_Config $prototype Optional prototype
* HTMLPurifier instance to overload singleton with,
* or HTMLPurifier_Config instance to configure the
* generated version with.
*
* @return HTMLPurifier
*/
public static function instance($prototype = \null)
{
}
/**
* Singleton for enforcing just one HTML Purifier in your system
*
* @param HTMLPurifier|HTMLPurifier_Config $prototype Optional prototype
* HTMLPurifier instance to overload singleton with,
* or HTMLPurifier_Config instance to configure the
* generated version with.
*
* @return HTMLPurifier
* @note Backwards compatibility, see instance()
*/
public static function getInstance($prototype = \null)
{
}
}
/**
* Class for converting between different unit-lengths as specified by
* CSS.
*/
class HTMLPurifier_UnitConverter
{
const ENGLISH = 1;
const METRIC = 2;
const DIGITAL = 3;
/**
* Units information array. Units are grouped into measuring systems
* (English, Metric), and are assigned an integer representing
* the conversion factor between that unit and the smallest unit in
* the system. Numeric indexes are actually magical constants that
* encode conversion data from one system to the next, with a O(n^2)
* constraint on memory (this is generally not a problem, since
* the number of measuring systems is small.)
*/
protected static $units = array(self::ENGLISH => array(
'px' => 3,
// This is as per CSS 2.1 and Firefox. Your mileage may vary
'pt' => 4,
'pc' => 48,
'in' => 288,
self::METRIC => array('pt', '0.352777778', 'mm'),
), self::METRIC => array('mm' => 1, 'cm' => 10, self::ENGLISH => array('mm', '2.83464567', 'pt')));
/**
* Minimum bcmath precision for output.
* @type int
*/
protected $outputPrecision;
/**
* Bcmath precision for internal calculations.
* @type int
*/
protected $internalPrecision;
public function __construct($output_precision = 4, $internal_precision = 10, $force_no_bcmath = \false)
{
}
/**
* Converts a length object of one unit into another unit.
* @param HTMLPurifier_Length $length
* Instance of HTMLPurifier_Length to convert. You must validate()
* it before passing it here!
* @param string $to_unit
* Unit to convert to.
* @return HTMLPurifier_Length|bool
* @note
* About precision: This conversion function pays very special
* attention to the incoming precision of values and attempts
* to maintain a number of significant figure. Results are
* fairly accurate up to nine digits. Some caveats:
* - If a number is zero-padded as a result of this significant
* figure tracking, the zeroes will be eliminated.
* - If a number contains less than four sigfigs ($outputPrecision)
* and this causes some decimals to be excluded, those
* decimals will be added on.
*/
public function convert($length, $to_unit)
{
}
/**
* Returns the number of significant figures in a string number.
* @param string $n Decimal number
* @return int number of sigfigs
*/
public function getSigFigs($n)
{
}
}
/**
* Object that provides entity lookup table from entity name to character
*/
class HTMLPurifier_EntityLookup
{
/**
* Assoc array of entity name to character represented.
* @type array
*/
public $table;
/**
* Sets up the entity lookup table from the serialized file contents.
* @param bool $file
* @note The serialized contents are versioned, but were generated
* using the maintenance script generate_entity_file.php
* @warning This is not in constructor to help enforce the Singleton
*/
public function setup($file = \false)
{
}
/**
* Retrieves sole instance of the object.
* @param bool|HTMLPurifier_EntityLookup $prototype Optional prototype of custom lookup table to overload with.
* @return HTMLPurifier_EntityLookup
*/
public static function instance($prototype = \false)
{
}
}
/**
* Defines common attribute collections that modules reference
*/
class HTMLPurifier_AttrCollections
{
/**
* Associative array of attribute collections, indexed by name.
* @type array
*/
public $info = array();
/**
* Performs all expansions on internal data for use by other inclusions
* It also collects all attribute collection extensions from
* modules
* @param HTMLPurifier_AttrTypes $attr_types HTMLPurifier_AttrTypes instance
* @param HTMLPurifier_HTMLModule[] $modules Hash array of HTMLPurifier_HTMLModule members
*/
public function __construct($attr_types, $modules)
{
}
public function doConstruct($attr_types, $modules)
{
}
/**
* Takes a reference to an attribute associative array and performs
* all inclusions specified by the zero index.
* @param array &$attr Reference to attribute array
*/
public function performInclusions(&$attr)
{
}
/**
* Expands all string identifiers in an attribute array by replacing
* them with the appropriate values inside HTMLPurifier_AttrTypes
* @param array &$attr Reference to attribute array
* @param HTMLPurifier_AttrTypes $attr_types HTMLPurifier_AttrTypes instance
*/
public function expandIdentifiers(&$attr, $attr_types)
{
}
}
/**
* Represents an XHTML 1.1 module, with information on elements, tags
* and attributes.
* @note Even though this is technically XHTML 1.1, it is also used for
* regular HTML parsing. We are using modulization as a convenient
* way to represent the internals of HTMLDefinition, and our
* implementation is by no means conforming and does not directly
* use the normative DTDs or XML schemas.
* @note The public variables in a module should almost directly
* correspond to the variables in HTMLPurifier_HTMLDefinition.
* However, the prefix info carries no special meaning in these
* objects (include it anyway if that's the correspondence though).
* @todo Consider making some member functions protected
*/
class HTMLPurifier_HTMLModule
{
// -- Overloadable ----------------------------------------------------
/**
* Short unique string identifier of the module.
* @type string
*/
public $name;
/**
* Informally, a list of elements this module changes.
* Not used in any significant way.
* @type array
*/
public $elements = array();
/**
* Associative array of element names to element definitions.
* Some definitions may be incomplete, to be merged in later
* with the full definition.
* @type array
*/
public $info = array();
/**
* Associative array of content set names to content set additions.
* This is commonly used to, say, add an A element to the Inline
* content set. This corresponds to an internal variable $content_sets
* and NOT info_content_sets member variable of HTMLDefinition.
* @type array
*/
public $content_sets = array();
/**
* Associative array of attribute collection names to attribute
* collection additions. More rarely used for adding attributes to
* the global collections. Example is the StyleAttribute module adding
* the style attribute to the Core. Corresponds to HTMLDefinition's
* attr_collections->info, since the object's data is only info,
* with extra behavior associated with it.
* @type array
*/
public $attr_collections = array();
/**
* Associative array of deprecated tag name to HTMLPurifier_TagTransform.
* @type array
*/
public $info_tag_transform = array();
/**
* List of HTMLPurifier_AttrTransform to be performed before validation.
* @type array
*/
public $info_attr_transform_pre = array();
/**
* List of HTMLPurifier_AttrTransform to be performed after validation.
* @type array
*/
public $info_attr_transform_post = array();
/**
* List of HTMLPurifier_Injector to be performed during well-formedness fixing.
* An injector will only be invoked if all of it's pre-requisites are met;
* if an injector fails setup, there will be no error; it will simply be
* silently disabled.
* @type array
*/
public $info_injector = array();
/**
* Boolean flag that indicates whether or not getChildDef is implemented.
* For optimization reasons: may save a call to a function. Be sure
* to set it if you do implement getChildDef(), otherwise it will have
* no effect!
* @type bool
*/
public $defines_child_def = \false;
/**
* Boolean flag whether or not this module is safe. If it is not safe, all
* of its members are unsafe. Modules are safe by default (this might be
* slightly dangerous, but it doesn't make much sense to force HTML Purifier,
* which is based off of safe HTML, to explicitly say, "This is safe," even
* though there are modules which are "unsafe")
*
* @type bool
* @note Previously, safety could be applied at an element level granularity.
* We've removed this ability, so in order to add "unsafe" elements
* or attributes, a dedicated module with this property set to false
* must be used.
*/
public $safe = \true;
/**
* Retrieves a proper HTMLPurifier_ChildDef subclass based on
* content_model and content_model_type member variables of
* the HTMLPurifier_ElementDef class. There is a similar function
* in HTMLPurifier_HTMLDefinition.
* @param HTMLPurifier_ElementDef $def
* @return HTMLPurifier_ChildDef subclass
*/
public function getChildDef($def)
{
}
// -- Convenience -----------------------------------------------------
/**
* Convenience function that sets up a new element
* @param string $element Name of element to add
* @param string|bool $type What content set should element be registered to?
* Set as false to skip this step.
* @param string $contents Allowed children in form of:
* "$content_model_type: $content_model"
* @param array $attr_includes What attribute collections to register to
* element?
* @param array $attr What unique attributes does the element define?
* @see HTMLPurifier_ElementDef:: for in-depth descriptions of these parameters.
* @return HTMLPurifier_ElementDef Created element definition object, so you
* can set advanced parameters
*/
public function addElement($element, $type, $contents, $attr_includes = array(), $attr = array())
{
}
/**
* Convenience function that creates a totally blank, non-standalone
* element.
* @param string $element Name of element to create
* @return HTMLPurifier_ElementDef Created element
*/
public function addBlankElement($element)
{
}
/**
* Convenience function that registers an element to a content set
* @param string $element Element to register
* @param string $type Name content set (warning: case sensitive, usually upper-case
* first letter)
*/
public function addElementToContentSet($element, $type)
{
}
/**
* Convenience function that transforms single-string contents
* into separate content model and content model type
* @param string $contents Allowed children in form of:
* "$content_model_type: $content_model"
* @return array
* @note If contents is an object, an array of two nulls will be
* returned, and the callee needs to take the original $contents
* and use it directly.
*/
public function parseContents($contents)
{
}
/**
* Convenience function that merges a list of attribute includes into
* an attribute array.
* @param array $attr Reference to attr array to modify
* @param array $attr_includes Array of includes / string include to merge in
*/
public function mergeInAttrIncludes(&$attr, $attr_includes)
{
}
/**
* Convenience function that generates a lookup table with boolean
* true as value.
* @param string $list List of values to turn into a lookup
* @note You can also pass an arbitrary number of arguments in
* place of the regular argument
* @return array array equivalent of list
*/
public function makeLookup($list)
{
}
/**
* Lazy load construction of the module after determining whether
* or not it's needed, and also when a finalized configuration object
* is available.
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* Super-class for definition datatype objects, implements serialization
* functions for the class.
*/
abstract class HTMLPurifier_Definition
{
/**
* Has setup() been called yet?
* @type bool
*/
public $setup = \false;
/**
* If true, write out the final definition object to the cache after
* setup. This will be true only if all invocations to get a raw
* definition object are also optimized. This does not cause file
* system thrashing because on subsequent calls the cached object
* is used and any writes to the raw definition object are short
* circuited. See enduser-customize.html for the high-level
* picture.
* @type bool
*/
public $optimized = \null;
/**
* What type of definition is it?
* @type string
*/
public $type;
/**
* Sets up the definition object into the final form, something
* not done by the constructor
* @param HTMLPurifier_Config $config
*/
protected abstract function doSetup($config);
/**
* Setup function that aborts if already setup
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* Definition of the purified HTML that describes allowed children,
* attributes, and many other things.
*
* Conventions:
*
* All member variables that are prefixed with info
* (including the main $info array) are used by HTML Purifier internals
* and should not be directly edited when customizing the HTMLDefinition.
* They can usually be set via configuration directives or custom
* modules.
*
* On the other hand, member variables without the info prefix are used
* internally by the HTMLDefinition and MUST NOT be used by other HTML
* Purifier internals. Many of them, however, are public, and may be
* edited by userspace code to tweak the behavior of HTMLDefinition.
*
* @note This class is inspected by Printer_HTMLDefinition; please
* update that class if things here change.
*
* @warning Directives that change this object's structure must be in
* the HTML or Attr namespace!
*/
class HTMLPurifier_HTMLDefinition extends \HTMLPurifier_Definition
{
// FULLY-PUBLIC VARIABLES ---------------------------------------------
/**
* Associative array of element names to HTMLPurifier_ElementDef.
* @type HTMLPurifier_ElementDef[]
*/
public $info = array();
/**
* Associative array of global attribute name to attribute definition.
* @type array
*/
public $info_global_attr = array();
/**
* String name of parent element HTML will be going into.
* @type string
*/
public $info_parent = 'div';
/**
* Definition for parent element, allows parent element to be a
* tag that's not allowed inside the HTML fragment.
* @type HTMLPurifier_ElementDef
*/
public $info_parent_def;
/**
* String name of element used to wrap inline elements in block context.
* @type string
* @note This is rarely used except for BLOCKQUOTEs in strict mode
*/
public $info_block_wrapper = 'p';
/**
* Associative array of deprecated tag name to HTMLPurifier_TagTransform.
* @type array
*/
public $info_tag_transform = array();
/**
* Indexed list of HTMLPurifier_AttrTransform to be performed before validation.
* @type HTMLPurifier_AttrTransform[]
*/
public $info_attr_transform_pre = array();
/**
* Indexed list of HTMLPurifier_AttrTransform to be performed after validation.
* @type HTMLPurifier_AttrTransform[]
*/
public $info_attr_transform_post = array();
/**
* Nested lookup array of content set name (Block, Inline) to
* element name to whether or not it belongs in that content set.
* @type array
*/
public $info_content_sets = array();
/**
* Indexed list of HTMLPurifier_Injector to be used.
* @type HTMLPurifier_Injector[]
*/
public $info_injector = array();
/**
* Doctype object
* @type HTMLPurifier_Doctype
*/
public $doctype;
// RAW CUSTOMIZATION STUFF --------------------------------------------
/**
* Adds a custom attribute to a pre-existing element
* @note This is strictly convenience, and does not have a corresponding
* method in HTMLPurifier_HTMLModule
* @param string $element_name Element name to add attribute to
* @param string $attr_name Name of attribute
* @param mixed $def Attribute definition, can be string or object, see
* HTMLPurifier_AttrTypes for details
*/
public function addAttribute($element_name, $attr_name, $def)
{
}
/**
* Adds a custom element to your HTML definition
* @see HTMLPurifier_HTMLModule::addElement() for detailed
* parameter and return value descriptions.
*/
public function addElement($element_name, $type, $contents, $attr_collections, $attributes = array())
{
}
/**
* Adds a blank element to your HTML definition, for overriding
* existing behavior
* @param string $element_name
* @return HTMLPurifier_ElementDef
* @see HTMLPurifier_HTMLModule::addBlankElement() for detailed
* parameter and return value descriptions.
*/
public function addBlankElement($element_name)
{
}
/**
* Retrieves a reference to the anonymous module, so you can
* bust out advanced features without having to make your own
* module.
* @return HTMLPurifier_HTMLModule
*/
public function getAnonymousModule()
{
}
// PUBLIC BUT INTERNAL VARIABLES --------------------------------------
/**
* @type string
*/
public $type = 'HTML';
/**
* @type HTMLPurifier_HTMLModuleManager
*/
public $manager;
/**
* Performs low-cost, preliminary initialization.
*/
public function __construct()
{
}
/**
* @param HTMLPurifier_Config $config
*/
protected function doSetup($config)
{
}
/**
* Extract out the information from the manager
* @param HTMLPurifier_Config $config
*/
protected function processModules($config)
{
}
/**
* Sets up stuff based on config. We need a better way of doing this.
* @param HTMLPurifier_Config $config
*/
protected function setupConfigStuff($config)
{
}
/**
* Parses a TinyMCE-flavored Allowed Elements and Attributes list into
* separate lists for processing. Format is element[attr1|attr2],element2...
* @warning Although it's largely drawn from TinyMCE's implementation,
* it is different, and you'll probably have to modify your lists
* @param array $list String list to parse
* @return array
* @todo Give this its own class, probably static interface
*/
public function parseTinyMCEAllowedList($list)
{
}
}
/**
* Responsible for creating definition caches.
*/
class HTMLPurifier_DefinitionCacheFactory
{
/**
* @type array
*/
protected $caches = array('Serializer' => array());
/**
* @type array
*/
protected $implementations = array();
/**
* @type HTMLPurifier_DefinitionCache_Decorator[]
*/
protected $decorators = array();
/**
* Initialize default decorators
*/
public function setup()
{
}
/**
* Retrieves an instance of global definition cache factory.
* @param HTMLPurifier_DefinitionCacheFactory $prototype
* @return HTMLPurifier_DefinitionCacheFactory
*/
public static function instance($prototype = \null)
{
}
/**
* Registers a new definition cache object
* @param string $short Short name of cache object, for reference
* @param string $long Full class name of cache object, for construction
*/
public function register($short, $long)
{
}
/**
* Factory method that creates a cache object based on configuration
* @param string $type Name of definitions handled by cache
* @param HTMLPurifier_Config $config Config instance
* @return mixed
*/
public function create($type, $config)
{
}
/**
* Registers a decorator to add to all new cache objects
* @param HTMLPurifier_DefinitionCache_Decorator|string $decorator An instance or the name of a decorator
*/
public function addDecorator($decorator)
{
}
}
/**
* Component of HTMLPurifier_AttrContext that accumulates IDs to prevent dupes
* @note In Slashdot-speak, dupe means duplicate.
* @note The default constructor does not accept $config or $context objects:
* use must use the static build() factory method to perform initialization.
*/
class HTMLPurifier_IDAccumulator
{
/**
* Lookup table of IDs we've accumulated.
* @public
*/
public $ids = array();
/**
* Builds an IDAccumulator, also initializing the default blacklist
* @param HTMLPurifier_Config $config Instance of HTMLPurifier_Config
* @param HTMLPurifier_Context $context Instance of HTMLPurifier_Context
* @return HTMLPurifier_IDAccumulator Fully initialized HTMLPurifier_IDAccumulator
*/
public static function build($config, $context)
{
}
/**
* Add an ID to the lookup table.
* @param string $id ID to be added.
* @return bool status, true if success, false if there's a dupe
*/
public function add($id)
{
}
/**
* Load a list of IDs into the lookup table
* @param $array_of_ids Array of IDs to load
* @note This function doesn't care about duplicates
*/
public function load($array_of_ids)
{
}
}
// if want to implement error collecting here, we'll need to use some sort
// of global data (probably trigger_error) because it's impossible to pass
// $config or $context to the callback functions.
/**
* Handles referencing and derefencing character entities
*/
class HTMLPurifier_EntityParser
{
/**
* Reference to entity lookup table.
* @type HTMLPurifier_EntityLookup
*/
protected $_entity_lookup;
/**
* Callback regex string for entities in text.
* @type string
*/
protected $_textEntitiesRegex;
/**
* Callback regex string for entities in attributes.
* @type string
*/
protected $_attrEntitiesRegex;
/**
* Tests if the beginning of a string is a semi-optional regex
*/
protected $_semiOptionalPrefixRegex;
public function __construct()
{
}
/**
* Substitute entities with the parsed equivalents. Use this on
* textual data in an HTML document (as opposed to attributes.)
*
* @param string $string String to have entities parsed.
* @return string Parsed string.
*/
public function substituteTextEntities($string)
{
}
/**
* Substitute entities with the parsed equivalents. Use this on
* attribute contents in documents.
*
* @param string $string String to have entities parsed.
* @return string Parsed string.
*/
public function substituteAttrEntities($string)
{
}
/**
* Callback function for substituteNonSpecialEntities() that does the work.
*
* @param array $matches PCRE matches array, with 0 the entire match, and
* either index 1, 2 or 3 set with a hex value, dec value,
* or string (respectively).
* @return string Replacement string.
*/
protected function entityCallback($matches)
{
}
// LEGACY CODE BELOW
/**
* Callback regex string for parsing entities.
* @type string
*/
protected $_substituteEntitiesRegex = '/&(?:[#]x([a-fA-F0-9]+)|[#]0*(\\d+)|([A-Za-z_:][A-Za-z0-9.\\-_:]*));?/';
// 1. hex 2. dec 3. string (XML style)
/**
* Decimal to parsed string conversion table for special entities.
* @type array
*/
protected $_special_dec2str = array(34 => '"', 38 => '&', 39 => "'", 60 => '<', 62 => '>');
/**
* Stripped entity names to decimal conversion table for special entities.
* @type array
*/
protected $_special_ent2dec = array('quot' => 34, 'amp' => 38, 'lt' => 60, 'gt' => 62);
/**
* Substitutes non-special entities with their parsed equivalents. Since
* running this whenever you have parsed character is t3h 5uck, we run
* it before everything else.
*
* @param string $string String to have non-special entities parsed.
* @return string Parsed string.
*/
public function substituteNonSpecialEntities($string)
{
}
/**
* Callback function for substituteNonSpecialEntities() that does the work.
*
* @param array $matches PCRE matches array, with 0 the entire match, and
* either index 1, 2 or 3 set with a hex value, dec value,
* or string (respectively).
* @return string Replacement string.
*/
protected function nonSpecialEntityCallback($matches)
{
}
/**
* Substitutes only special entities with their parsed equivalents.
*
* @notice We try to avoid calling this function because otherwise, it
* would have to be called a lot (for every parsed section).
*
* @param string $string String to have non-special entities parsed.
* @return string Parsed string.
*/
public function substituteSpecialEntities($string)
{
}
/**
* Callback function for substituteSpecialEntities() that does the work.
*
* This callback has same syntax as nonSpecialEntityCallback().
*
* @param array $matches PCRE-style matches array, with 0 the entire match, and
* either index 1, 2 or 3 set with a hex value, dec value,
* or string (respectively).
* @return string Replacement string.
*/
protected function specialEntityCallback($matches)
{
}
}
/**
* Structure that stores an HTML element definition. Used by
* HTMLPurifier_HTMLDefinition and HTMLPurifier_HTMLModule.
* @note This class is inspected by HTMLPurifier_Printer_HTMLDefinition.
* Please update that class too.
* @warning If you add new properties to this class, you MUST update
* the mergeIn() method.
*/
class HTMLPurifier_ElementDef
{
/**
* Does the definition work by itself, or is it created solely
* for the purpose of merging into another definition?
* @type bool
*/
public $standalone = \true;
/**
* Associative array of attribute name to HTMLPurifier_AttrDef.
* @type array
* @note Before being processed by HTMLPurifier_AttrCollections
* when modules are finalized during
* HTMLPurifier_HTMLDefinition->setup(), this array may also
* contain an array at index 0 that indicates which attribute
* collections to load into the full array. It may also
* contain string indentifiers in lieu of HTMLPurifier_AttrDef,
* see HTMLPurifier_AttrTypes on how they are expanded during
* HTMLPurifier_HTMLDefinition->setup() processing.
*/
public $attr = array();
// XXX: Design note: currently, it's not possible to override
// previously defined AttrTransforms without messing around with
// the final generated config. This is by design; a previous version
// used an associated list of attr_transform, but it was extremely
// easy to accidentally override other attribute transforms by
// forgetting to specify an index (and just using 0.) While we
// could check this by checking the index number and complaining,
// there is a second problem which is that it is not at all easy to
// tell when something is getting overridden. Combine this with a
// codebase where this isn't really being used, and it's perfect for
// nuking.
/**
* List of tags HTMLPurifier_AttrTransform to be done before validation.
* @type array
*/
public $attr_transform_pre = array();
/**
* List of tags HTMLPurifier_AttrTransform to be done after validation.
* @type array
*/
public $attr_transform_post = array();
/**
* HTMLPurifier_ChildDef of this tag.
* @type HTMLPurifier_ChildDef
*/
public $child;
/**
* Abstract string representation of internal ChildDef rules.
* @see HTMLPurifier_ContentSets for how this is parsed and then transformed
* into an HTMLPurifier_ChildDef.
* @warning This is a temporary variable that is not available after
* being processed by HTMLDefinition
* @type string
*/
public $content_model;
/**
* Value of $child->type, used to determine which ChildDef to use,
* used in combination with $content_model.
* @warning This must be lowercase
* @warning This is a temporary variable that is not available after
* being processed by HTMLDefinition
* @type string
*/
public $content_model_type;
/**
* Does the element have a content model (#PCDATA | Inline)*? This
* is important for chameleon ins and del processing in
* HTMLPurifier_ChildDef_Chameleon. Dynamically set: modules don't
* have to worry about this one.
* @type bool
*/
public $descendants_are_inline = \false;
/**
* List of the names of required attributes this element has.
* Dynamically populated by HTMLPurifier_HTMLDefinition::getElement()
* @type array
*/
public $required_attr = array();
/**
* Lookup table of tags excluded from all descendants of this tag.
* @type array
* @note SGML permits exclusions for all descendants, but this is
* not possible with DTDs or XML Schemas. W3C has elected to
* use complicated compositions of content_models to simulate
* exclusion for children, but we go the simpler, SGML-style
* route of flat-out exclusions, which correctly apply to
* all descendants and not just children. Note that the XHTML
* Modularization Abstract Modules are blithely unaware of such
* distinctions.
*/
public $excludes = array();
/**
* This tag is explicitly auto-closed by the following tags.
* @type array
*/
public $autoclose = array();
/**
* If a foreign element is found in this element, test if it is
* allowed by this sub-element; if it is, instead of closing the
* current element, place it inside this element.
* @type string
*/
public $wrap;
/**
* Whether or not this is a formatting element affected by the
* "Active Formatting Elements" algorithm.
* @type bool
*/
public $formatting;
/**
* Low-level factory constructor for creating new standalone element defs
*/
public static function create($content_model, $content_model_type, $attr)
{
}
/**
* Merges the values of another element definition into this one.
* Values from the new element def take precedence if a value is
* not mergeable.
* @param HTMLPurifier_ElementDef $def
*/
public function mergeIn($def)
{
}
}
/**
* Injects tokens into the document while parsing for well-formedness.
* This enables "formatter-like" functionality such as auto-paragraphing,
* smiley-ification and linkification to take place.
*
* A note on how handlers create changes; this is done by assigning a new
* value to the $token reference. These values can take a variety of forms and
* are best described HTMLPurifier_Strategy_MakeWellFormed->processToken()
* documentation.
*
* @todo Allow injectors to request a re-run on their output. This
* would help if an operation is recursive.
*/
abstract class HTMLPurifier_Injector
{
/**
* Advisory name of injector, this is for friendly error messages.
* @type string
*/
public $name;
/**
* @type HTMLPurifier_HTMLDefinition
*/
protected $htmlDefinition;
/**
* Reference to CurrentNesting variable in Context. This is an array
* list of tokens that we are currently "inside"
* @type array
*/
protected $currentNesting;
/**
* Reference to current token.
* @type HTMLPurifier_Token
*/
protected $currentToken;
/**
* Reference to InputZipper variable in Context.
* @type HTMLPurifier_Zipper
*/
protected $inputZipper;
/**
* Array of elements and attributes this injector creates and therefore
* need to be allowed by the definition. Takes form of
* array('element' => array('attr', 'attr2'), 'element2')
* @type array
*/
public $needed = array();
/**
* Number of elements to rewind backwards (relative).
* @type bool|int
*/
protected $rewindOffset = \false;
/**
* Rewind to a spot to re-perform processing. This is useful if you
* deleted a node, and now need to see if this change affected any
* earlier nodes. Rewinding does not affect other injectors, and can
* result in infinite loops if not used carefully.
* @param bool|int $offset
* @warning HTML Purifier will prevent you from fast-forwarding with this
* function.
*/
public function rewindOffset($offset)
{
}
/**
* Retrieves rewind offset, and then unsets it.
* @return bool|int
*/
public function getRewindOffset()
{
}
/**
* Prepares the injector by giving it the config and context objects:
* this allows references to important variables to be made within
* the injector. This function also checks if the HTML environment
* will work with the Injector (see checkNeeded()).
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string Boolean false if success, string of missing needed element/attribute if failure
*/
public function prepare($config, $context)
{
}
/**
* This function checks if the HTML environment
* will work with the Injector: if p tags are not allowed, the
* Auto-Paragraphing injector should not be enabled.
* @param HTMLPurifier_Config $config
* @return bool|string Boolean false if success, string of missing needed element/attribute if failure
*/
public function checkNeeded($config)
{
}
/**
* Tests if the context node allows a certain element
* @param string $name Name of element to test for
* @return bool True if element is allowed, false if it is not
*/
public function allowsElement($name)
{
}
/**
* Iterator function, which starts with the next token and continues until
* you reach the end of the input tokens.
* @warning Please prevent previous references from interfering with this
* functions by setting $i = null beforehand!
* @param int $i Current integer index variable for inputTokens
* @param HTMLPurifier_Token $current Current token variable.
* Do NOT use $token, as that variable is also a reference
* @return bool
*/
protected function forward(&$i, &$current)
{
}
/**
* Similar to _forward, but accepts a third parameter $nesting (which
* should be initialized at 0) and stops when we hit the end tag
* for the node $this->inputIndex starts in.
* @param int $i Current integer index variable for inputTokens
* @param HTMLPurifier_Token $current Current token variable.
* Do NOT use $token, as that variable is also a reference
* @param int $nesting
* @return bool
*/
protected function forwardUntilEndToken(&$i, &$current, &$nesting)
{
}
/**
* Iterator function, starts with the previous token and continues until
* you reach the beginning of input tokens.
* @warning Please prevent previous references from interfering with this
* functions by setting $i = null beforehand!
* @param int $i Current integer index variable for inputTokens
* @param HTMLPurifier_Token $current Current token variable.
* Do NOT use $token, as that variable is also a reference
* @return bool
*/
protected function backward(&$i, &$current)
{
}
/**
* Handler that is called when a text token is processed
*/
public function handleText(&$token)
{
}
/**
* Handler that is called when a start or empty token is processed
*/
public function handleElement(&$token)
{
}
/**
* Handler that is called when an end token is processed
*/
public function handleEnd(&$token)
{
}
/**
* Notifier that is called when an end token is processed
* @param HTMLPurifier_Token $token Current token variable.
* @note This differs from handlers in that the token is read-only
* @deprecated
*/
public function notifyEnd($token)
{
}
}
/**
* Injector that removes spans with no attributes
*/
class HTMLPurifier_Injector_RemoveSpansWithoutAttributes extends \HTMLPurifier_Injector
{
/**
* @type string
*/
public $name = 'RemoveSpansWithoutAttributes';
/**
* @type array
*/
public $needed = array('span');
public function prepare($config, $context)
{
}
/**
* @param HTMLPurifier_Token $token
*/
public function handleElement(&$token)
{
}
/**
* @param HTMLPurifier_Token $token
*/
public function handleEnd(&$token)
{
}
}
/**
* Injector that displays the URL of an anchor instead of linking to it, in addition to showing the text of the link.
*/
class HTMLPurifier_Injector_DisplayLinkURI extends \HTMLPurifier_Injector
{
/**
* @type string
*/
public $name = 'DisplayLinkURI';
/**
* @type array
*/
public $needed = array('a');
/**
* @param $token
*/
public function handleElement(&$token)
{
}
/**
* @param HTMLPurifier_Token $token
*/
public function handleEnd(&$token)
{
}
}
class HTMLPurifier_Injector_RemoveEmpty extends \HTMLPurifier_Injector
{
/**
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return void
*/
public function prepare($config, $context)
{
}
/**
* @param HTMLPurifier_Token $token
*/
public function handleElement(&$token)
{
}
}
/**
* Injector that auto paragraphs text in the root node based on
* double-spacing.
* @todo Ensure all states are unit tested, including variations as well.
* @todo Make a graph of the flow control for this Injector.
*/
class HTMLPurifier_Injector_AutoParagraph extends \HTMLPurifier_Injector
{
/**
* @type string
*/
public $name = 'AutoParagraph';
/**
* @type array
*/
public $needed = array('p');
/**
* @param HTMLPurifier_Token_Text $token
*/
public function handleText(&$token)
{
}
/**
* @param HTMLPurifier_Token $token
*/
public function handleElement(&$token)
{
}
}
/**
* Injector that converts http, https and ftp text URLs to actual links.
*/
class HTMLPurifier_Injector_Linkify extends \HTMLPurifier_Injector
{
/**
* @type string
*/
public $name = 'Linkify';
/**
* @type array
*/
public $needed = array('a' => array('href'));
/**
* @param HTMLPurifier_Token $token
*/
public function handleText(&$token)
{
}
}
/**
* Adds important param elements to inside of object in order to make
* things safe.
*/
class HTMLPurifier_Injector_SafeObject extends \HTMLPurifier_Injector
{
/**
* @type string
*/
public $name = 'SafeObject';
/**
* @type array
*/
public $needed = array('object', 'param');
/**
* @type array
*/
protected $objectStack = array();
/**
* @type array
*/
protected $paramStack = array();
/**
* Keep this synchronized with AttrTransform/SafeParam.php.
* @type array
*/
protected $addParam = array('allowScriptAccess' => 'never', 'allowNetworking' => 'internal');
/**
* These are all lower-case keys.
* @type array
*/
protected $allowedParam = array('wmode' => \true, 'movie' => \true, 'flashvars' => \true, 'src' => \true, 'allowfullscreen' => \true);
/**
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return void
*/
public function prepare($config, $context)
{
}
/**
* @param HTMLPurifier_Token $token
*/
public function handleElement(&$token)
{
}
public function handleEnd(&$token)
{
}
}
/**
* Injector that converts configuration directive syntax %Namespace.Directive
* to links
*/
class HTMLPurifier_Injector_PurifierLinkify extends \HTMLPurifier_Injector
{
/**
* @type string
*/
public $name = 'PurifierLinkify';
/**
* @type string
*/
public $docURL;
/**
* @type array
*/
public $needed = array('a' => array('href'));
/**
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
*/
public function prepare($config, $context)
{
}
/**
* @param HTMLPurifier_Token $token
*/
public function handleText(&$token)
{
}
}
/**
* Validates the attributes of a token. Doesn't manage required attributes
* very well. The only reason we factored this out was because RemoveForeignElements
* also needed it besides ValidateAttributes.
*/
class HTMLPurifier_AttrValidator
{
/**
* Validates the attributes of a token, mutating it as necessary.
* that has valid tokens
* @param HTMLPurifier_Token $token Token to validate.
* @param HTMLPurifier_Config $config Instance of HTMLPurifier_Config
* @param HTMLPurifier_Context $context Instance of HTMLPurifier_Context
*/
public function validateToken($token, $config, $context)
{
}
}
// OUT OF DATE, NEEDS UPDATING!
// USE XMLWRITER!
class HTMLPurifier_Printer
{
/**
* For HTML generation convenience funcs.
* @type HTMLPurifier_Generator
*/
protected $generator;
/**
* For easy access.
* @type HTMLPurifier_Config
*/
protected $config;
/**
* Initialize $generator.
*/
public function __construct()
{
}
/**
* Give generator necessary configuration if possible
* @param HTMLPurifier_Config $config
*/
public function prepareGenerator($config)
{
}
/**
* Main function that renders object or aspect of that object
* @note Parameters vary depending on printer
*/
// function render() {}
/**
* Returns a start tag
* @param string $tag Tag name
* @param array $attr Attribute array
* @return string
*/
protected function start($tag, $attr = array())
{
}
/**
* Returns an end tag
* @param string $tag Tag name
* @return string
*/
protected function end($tag)
{
}
/**
* Prints a complete element with content inside
* @param string $tag Tag name
* @param string $contents Element contents
* @param array $attr Tag attributes
* @param bool $escape whether or not to escape contents
* @return string
*/
protected function element($tag, $contents, $attr = array(), $escape = \true)
{
}
/**
* @param string $tag
* @param array $attr
* @return string
*/
protected function elementEmpty($tag, $attr = array())
{
}
/**
* @param string $text
* @return string
*/
protected function text($text)
{
}
/**
* Prints a simple key/value row in a table.
* @param string $name Key
* @param mixed $value Value
* @return string
*/
protected function row($name, $value)
{
}
/**
* Escapes a string for HTML output.
* @param string $string String to escape
* @return string
*/
protected function escape($string)
{
}
/**
* Takes a list of strings and turns them into a single list
* @param string[] $array List of strings
* @param bool $polite Bool whether or not to add an end before the last
* @return string
*/
protected function listify($array, $polite = \false)
{
}
/**
* Retrieves the class of an object without prefixes, as well as metadata
* @param object $obj Object to determine class of
* @param string $sec_prefix Further prefix to remove
* @return string
*/
protected function getClass($obj, $sec_prefix = '')
{
}
}
class HTMLPurifier_Printer_HTMLDefinition extends \HTMLPurifier_Printer
{
/**
* @type HTMLPurifier_HTMLDefinition, for easy access
*/
protected $def;
/**
* @param HTMLPurifier_Config $config
* @return string
*/
public function render($config)
{
}
/**
* Renders the Doctype table
* @return string
*/
protected function renderDoctype()
{
}
/**
* Renders environment table, which is miscellaneous info
* @return string
*/
protected function renderEnvironment()
{
}
/**
* Renders the Content Sets table
* @return string
*/
protected function renderContentSets()
{
}
/**
* Renders the Elements ($info) table
* @return string
*/
protected function renderInfo()
{
}
/**
* Renders a row describing the allowed children of an element
* @param HTMLPurifier_ChildDef $def HTMLPurifier_ChildDef of pertinent element
* @return string
*/
protected function renderChildren($def)
{
}
/**
* Listifies a tag lookup table.
* @param array $array Tag lookup array in form of array('tagname' => true)
* @return string
*/
protected function listifyTagLookup($array)
{
}
/**
* Listifies a list of objects by retrieving class names and internal state
* @param array $array List of objects
* @return string
* @todo Also add information about internal state
*/
protected function listifyObjectList($array)
{
}
/**
* Listifies a hash of attributes to AttrDef classes
* @param array $array Array hash in form of array('attrname' => HTMLPurifier_AttrDef)
* @return string
*/
protected function listifyAttr($array)
{
}
/**
* Creates a heavy header row
* @param string $text
* @param int $num
* @return string
*/
protected function heavyHeader($text, $num = 1)
{
}
}
class HTMLPurifier_Printer_CSSDefinition extends \HTMLPurifier_Printer
{
/**
* @type HTMLPurifier_CSSDefinition
*/
protected $def;
/**
* @param HTMLPurifier_Config $config
* @return string
*/
public function render($config)
{
}
}
/**
* @todo Rewrite to use Interchange objects
*/
class HTMLPurifier_Printer_ConfigForm extends \HTMLPurifier_Printer
{
/**
* Printers for specific fields.
* @type HTMLPurifier_Printer[]
*/
protected $fields = array();
/**
* Documentation URL, can have fragment tagged on end.
* @type string
*/
protected $docURL;
/**
* Name of form element to stuff config in.
* @type string
*/
protected $name;
/**
* Whether or not to compress directive names, clipping them off
* after a certain amount of letters. False to disable or integer letters
* before clipping.
* @type bool
*/
protected $compress = \false;
/**
* @param string $name Form element name for directives to be stuffed into
* @param string $doc_url String documentation URL, will have fragment tagged on
* @param bool $compress Integer max length before compressing a directive name, set to false to turn off
*/
public function __construct($name, $doc_url = \null, $compress = \false)
{
}
/**
* Sets default column and row size for textareas in sub-printers
* @param $cols Integer columns of textarea, null to use default
* @param $rows Integer rows of textarea, null to use default
*/
public function setTextareaDimensions($cols = \null, $rows = \null)
{
}
/**
* Retrieves styling, in case it is not accessible by webserver
*/
public static function getCSS()
{
}
/**
* Retrieves JavaScript, in case it is not accessible by webserver
*/
public static function getJavaScript()
{
}
/**
* Returns HTML output for a configuration form
* @param HTMLPurifier_Config|array $config Configuration object of current form state, or an array
* where [0] has an HTML namespace and [1] is being rendered.
* @param array|bool $allowed Optional namespace(s) and directives to restrict form to.
* @param bool $render_controls
* @return string
*/
public function render($config, $allowed = \true, $render_controls = \true)
{
}
/**
* Renders a single namespace
* @param $ns String namespace name
* @param array $directives array of directives to values
* @return string
*/
protected function renderNamespace($ns, $directives)
{
}
}
/**
* Printer decorator for directives that accept null
*/
class HTMLPurifier_Printer_ConfigForm_NullDecorator extends \HTMLPurifier_Printer
{
/**
* Printer being decorated
* @type HTMLPurifier_Printer
*/
protected $obj;
/**
* @param HTMLPurifier_Printer $obj Printer to decorate
*/
public function __construct($obj)
{
}
/**
* @param string $ns
* @param string $directive
* @param string $value
* @param string $name
* @param HTMLPurifier_Config|array $config
* @return string
*/
public function render($ns, $directive, $value, $name, $config)
{
}
}
/**
* Swiss-army knife configuration form field printer
*/
class HTMLPurifier_Printer_ConfigForm_default extends \HTMLPurifier_Printer
{
/**
* @type int
*/
public $cols = 18;
/**
* @type int
*/
public $rows = 5;
/**
* @param string $ns
* @param string $directive
* @param string $value
* @param string $name
* @param HTMLPurifier_Config|array $config
* @return string
*/
public function render($ns, $directive, $value, $name, $config)
{
}
}
/**
* Bool form field printer
*/
class HTMLPurifier_Printer_ConfigForm_bool extends \HTMLPurifier_Printer
{
/**
* @param string $ns
* @param string $directive
* @param string $value
* @param string $name
* @param HTMLPurifier_Config|array $config
* @return string
*/
public function render($ns, $directive, $value, $name, $config)
{
}
}
/**
* Forgivingly lexes HTML (SGML-style) markup into tokens.
*
* A lexer parses a string of SGML-style markup and converts them into
* corresponding tokens. It doesn't check for well-formedness, although its
* internal mechanism may make this automatic (such as the case of
* HTMLPurifier_Lexer_DOMLex). There are several implementations to choose
* from.
*
* A lexer is HTML-oriented: it might work with XML, but it's not
* recommended, as we adhere to a subset of the specification for optimization
* reasons. This might change in the future. Also, most tokenizers are not
* expected to handle DTDs or PIs.
*
* This class should not be directly instantiated, but you may use create() to
* retrieve a default copy of the lexer. Being a supertype, this class
* does not actually define any implementation, but offers commonly used
* convenience functions for subclasses.
*
* @note The unit tests will instantiate this class for testing purposes, as
* many of the utility functions require a class to be instantiated.
* This means that, even though this class is not runnable, it will
* not be declared abstract.
*
* @par
*
* @note
* We use tokens rather than create a DOM representation because DOM would:
*
* @par
* -# Require more processing and memory to create,
* -# Is not streamable, and
* -# Has the entire document structure (html and body not needed).
*
* @par
* However, DOM is helpful in that it makes it easy to move around nodes
* without a lot of lookaheads to see when a tag is closed. This is a
* limitation of the token system and some workarounds would be nice.
*/
class HTMLPurifier_Lexer
{
/**
* Whether or not this lexer implements line-number/column-number tracking.
* If it does, set to true.
*/
public $tracksLineNumbers = \false;
// -- STATIC ----------------------------------------------------------
/**
* Retrieves or sets the default Lexer as a Prototype Factory.
*
* By default HTMLPurifier_Lexer_DOMLex will be returned. There are
* a few exceptions involving special features that only DirectLex
* implements.
*
* @note The behavior of this class has changed, rather than accepting
* a prototype object, it now accepts a configuration object.
* To specify your own prototype, set %Core.LexerImpl to it.
* This change in behavior de-singletonizes the lexer object.
*
* @param HTMLPurifier_Config $config
* @return HTMLPurifier_Lexer
* @throws HTMLPurifier_Exception
*/
public static function create($config)
{
}
// -- CONVENIENCE MEMBERS ---------------------------------------------
public function __construct()
{
}
/**
* Most common entity to raw value conversion table for special entities.
* @type array
*/
protected $_special_entity2str = array('"' => '"', '&' => '&', '<' => '<', '>' => '>', ''' => "'", ''' => "'", ''' => "'");
public function parseText($string, $config)
{
}
public function parseAttr($string, $config)
{
}
/**
* Parses special entities into the proper characters.
*
* This string will translate escaped versions of the special characters
* into the correct ones.
*
* @param string $string String character data to be parsed.
* @return string Parsed character data.
*/
public function parseData($string, $is_attr, $config)
{
}
/**
* Lexes an HTML string into tokens.
* @param $string String HTML.
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return HTMLPurifier_Token[] array representation of HTML.
*/
public function tokenizeHTML($string, $config, $context)
{
}
/**
* Translates CDATA sections into regular sections (through escaping).
* @param string $string HTML string to process.
* @return string HTML with CDATA sections escaped.
*/
protected static function escapeCDATA($string)
{
}
/**
* Special CDATA case that is especially convoluted for <script>
* @param string $string HTML string to process.
* @return string HTML with CDATA sections escaped.
*/
protected static function escapeCommentedCDATA($string)
{
}
/**
* Special Internet Explorer conditional comments should be removed.
* @param string $string HTML string to process.
* @return string HTML with conditional comments removed.
*/
protected static function removeIEConditional($string)
{
}
/**
* Callback function for escapeCDATA() that does the work.
*
* @warning Though this is public in order to let the callback happen,
* calling it directly is not recommended.
* @param array $matches PCRE matches array, with index 0 the entire match
* and 1 the inside of the CDATA section.
* @return string Escaped internals of the CDATA section.
*/
protected static function CDATACallback($matches)
{
}
/**
* Takes a piece of HTML and normalizes it by converting entities, fixing
* encoding, extracting bits, and other good stuff.
* @param string $html HTML.
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
* @todo Consider making protected
*/
public function normalize($html, $config, $context)
{
}
/**
* Takes a string of HTML (fragment or document) and returns the content
* @todo Consider making protected
*/
public function extractBody($html)
{
}
}
/**
* Parser that uses PHP 5's DOM extension (part of the core).
*
* In PHP 5, the DOM XML extension was revamped into DOM and added to the core.
* It gives us a forgiving HTML parser, which we use to transform the HTML
* into a DOM, and then into the tokens. It is blazingly fast (for large
* documents, it performs twenty times faster than
* HTMLPurifier_Lexer_DirectLex,and is the default choice for PHP 5.
*
* @note Any empty elements will have empty tokens associated with them, even if
* this is prohibited by the spec. This is cannot be fixed until the spec
* comes into play.
*
* @note PHP's DOM extension does not actually parse any entities, we use
* our own function to do that.
*
* @warning DOM tends to drop whitespace, which may wreak havoc on indenting.
* If this is a huge problem, due to the fact that HTML is hand
* edited and you are unable to get a parser cache that caches the
* the output of HTML Purifier while keeping the original HTML lying
* around, you may want to run Tidy on the resulting output or use
* HTMLPurifier_DirectLex
*/
class HTMLPurifier_Lexer_DOMLex extends \HTMLPurifier_Lexer
{
public function __construct()
{
}
/**
* @param string $html
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return HTMLPurifier_Token[]
*/
public function tokenizeHTML($html, $config, $context)
{
}
/**
* Iterative function that tokenizes a node, putting it into an accumulator.
* To iterate is human, to recurse divine - L. Peter Deutsch
* @param DOMNode $node DOMNode to be tokenized.
* @param HTMLPurifier_Token[] $tokens Array-list of already tokenized tokens.
* @return HTMLPurifier_Token of node appended to previously passed tokens.
*/
protected function tokenizeDOM($node, &$tokens, $config)
{
}
/**
* @param DOMNode $node DOMNode to be tokenized.
* @param HTMLPurifier_Token[] $tokens Array-list of already tokenized tokens.
* @param bool $collect Says whether or start and close are collected, set to
* false at first recursion because it's the implicit DIV
* tag you're dealing with.
* @return bool if the token needs an endtoken
* @todo data and tagName properties don't seem to exist in DOMNode?
*/
protected function createStartNode($node, &$tokens, $collect, $config)
{
}
/**
* @param DOMNode $node
* @param HTMLPurifier_Token[] $tokens
*/
protected function createEndNode($node, &$tokens)
{
}
/**
* Converts a DOMNamedNodeMap of DOMAttr objects into an assoc array.
*
* @param DOMNamedNodeMap $node_map DOMNamedNodeMap of DOMAttr objects.
* @return array Associative array of attributes.
*/
protected function transformAttrToAssoc($node_map)
{
}
/**
* An error handler that mutes all errors
* @param int $errno
* @param string $errstr
*/
public function muteErrorHandler($errno, $errstr)
{
}
/**
* Callback function for undoing escaping of stray angled brackets
* in comments
* @param array $matches
* @return string
*/
public function callbackUndoCommentSubst($matches)
{
}
/**
* Callback function that entity-izes ampersands in comments so that
* callbackUndoCommentSubst doesn't clobber them
* @param array $matches
* @return string
*/
public function callbackArmorCommentEntities($matches)
{
}
/**
* Wraps an HTML fragment in the necessary HTML
* @param string $html
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
*/
protected function wrapHTML($html, $config, $context, $use_div = \true)
{
}
}
/**
* Experimental HTML5-based parser using Jeroen van der Meer's PH5P library.
* Occupies space in the HTML5 pseudo-namespace, which may cause conflicts.
*
* @note
* Recent changes to PHP's DOM extension have resulted in some fatal
* error conditions with the original version of PH5P. Pending changes,
* this lexer will punt to DirectLex if DOM throws an exception.
*/
class HTMLPurifier_Lexer_PH5P extends \HTMLPurifier_Lexer_DOMLex
{
/**
* @param string $html
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return HTMLPurifier_Token[]
*/
public function tokenizeHTML($html, $config, $context)
{
}
}
/**
* Our in-house implementation of a parser.
*
* A pure PHP parser, DirectLex has absolutely no dependencies, making
* it a reasonably good default for PHP4. Written with efficiency in mind,
* it can be four times faster than HTMLPurifier_Lexer_PEARSax3, although it
* pales in comparison to HTMLPurifier_Lexer_DOMLex.
*
* @todo Reread XML spec and document differences.
*/
class HTMLPurifier_Lexer_DirectLex extends \HTMLPurifier_Lexer
{
/**
* @type bool
*/
public $tracksLineNumbers = \true;
/**
* Whitespace characters for str(c)spn.
* @type string
*/
protected $_whitespace = " \t\r\n";
/**
* Callback function for script CDATA fudge
* @param array $matches, in form of array(opening tag, contents, closing tag)
* @return string
*/
protected function scriptCallback($matches)
{
}
/**
* @param String $html
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array|HTMLPurifier_Token[]
*/
public function tokenizeHTML($html, $config, $context)
{
}
/**
* PHP 5.0.x compatible substr_count that implements offset and length
* @param string $haystack
* @param string $needle
* @param int $offset
* @param int $length
* @return int
*/
protected function substrCount($haystack, $needle, $offset, $length)
{
}
/**
* Takes the inside of an HTML tag and makes an assoc array of attributes.
*
* @param string $string Inside of tag excluding name.
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array Assoc array of attributes.
*/
public function parseAttributeString($string, $config, $context)
{
}
}
/**
* @todo Unit test
*/
class HTMLPurifier_ContentSets
{
/**
* List of content set strings (pipe separators) indexed by name.
* @type array
*/
public $info = array();
/**
* List of content set lookups (element => true) indexed by name.
* @type array
* @note This is in HTMLPurifier_HTMLDefinition->info_content_sets
*/
public $lookup = array();
/**
* Synchronized list of defined content sets (keys of info).
* @type array
*/
protected $keys = array();
/**
* Synchronized list of defined content values (values of info).
* @type array
*/
protected $values = array();
/**
* Merges in module's content sets, expands identifiers in the content
* sets and populates the keys, values and lookup member variables.
* @param HTMLPurifier_HTMLModule[] $modules List of HTMLPurifier_HTMLModule
*/
public function __construct($modules)
{
}
/**
* Accepts a definition; generates and assigns a ChildDef for it
* @param HTMLPurifier_ElementDef $def HTMLPurifier_ElementDef reference
* @param HTMLPurifier_HTMLModule $module Module that defined the ElementDef
*/
public function generateChildDef(&$def, $module)
{
}
public function generateChildDefCallback($matches)
{
}
/**
* Instantiates a ChildDef based on content_model and content_model_type
* member variables in HTMLPurifier_ElementDef
* @note This will also defer to modules for custom HTMLPurifier_ChildDef
* subclasses that need content set expansion
* @param HTMLPurifier_ElementDef $def HTMLPurifier_ElementDef to have ChildDef extracted
* @param HTMLPurifier_HTMLModule $module Module that defined the ElementDef
* @return HTMLPurifier_ChildDef corresponding to ElementDef
*/
public function getChildDef($def, $module)
{
}
/**
* Converts a string list of elements separated by pipes into
* a lookup array.
* @param string $string List of elements
* @return array Lookup array of elements
*/
protected function convertToLookup($string)
{
}
}
/**
* Class that handles operations involving percent-encoding in URIs.
*
* @warning
* Be careful when reusing instances of PercentEncoder. The object
* you use for normalize() SHOULD NOT be used for encode(), or
* vice-versa.
*/
class HTMLPurifier_PercentEncoder
{
/**
* Reserved characters to preserve when using encode().
* @type array
*/
protected $preserve = array();
/**
* String of characters that should be preserved while using encode().
* @param bool $preserve
*/
public function __construct($preserve = \false)
{
}
/**
* Our replacement for urlencode, it encodes all non-reserved characters,
* as well as any extra characters that were instructed to be preserved.
* @note
* Assumes that the string has already been normalized, making any
* and all percent escape sequences valid. Percents will not be
* re-escaped, regardless of their status in $preserve
* @param string $string String to be encoded
* @return string Encoded string.
*/
public function encode($string)
{
}
/**
* Fix up percent-encoding by decoding unreserved characters and normalizing.
* @warning This function is affected by $preserve, even though the
* usual desired behavior is for this not to preserve those
* characters. Be careful when reusing instances of PercentEncoder!
* @param string $string String to normalize
* @return string
*/
public function normalize($string)
{
}
}
/**
* Processes an entire attribute array for corrections needing multiple values.
*
* Occasionally, a certain attribute will need to be removed and popped onto
* another value. Instead of creating a complex return syntax for
* HTMLPurifier_AttrDef, we just pass the whole attribute array to a
* specialized object and have that do the special work. That is the
* family of HTMLPurifier_AttrTransform.
*
* An attribute transformation can be assigned to run before or after
* HTMLPurifier_AttrDef validation. See HTMLPurifier_HTMLDefinition for
* more details.
*/
abstract class HTMLPurifier_AttrTransform
{
/**
* Abstract: makes changes to the attributes dependent on multiple values.
*
* @param array $attr Assoc array of attributes, usually from
* HTMLPurifier_Token_Tag::$attr
* @param HTMLPurifier_Config $config Mandatory HTMLPurifier_Config object.
* @param HTMLPurifier_Context $context Mandatory HTMLPurifier_Context object
* @return array Processed attribute array.
*/
public abstract function transform($attr, $config, $context);
/**
* Prepends CSS properties to the style attribute, creating the
* attribute if it doesn't exist.
* @param array &$attr Attribute array to process (passed by reference)
* @param string $css CSS to prepend
*/
public function prependCSS(&$attr, $css)
{
}
/**
* Retrieves and removes an attribute
* @param array &$attr Attribute array to process (passed by reference)
* @param mixed $key Key of attribute to confiscate
* @return mixed
*/
public function confiscateAttr(&$attr, $key)
{
}
}
/**
* Configuration object that triggers customizable behavior.
*
* @warning This class is strongly defined: that means that the class
* will fail if an undefined directive is retrieved or set.
*
* @note Many classes that could (although many times don't) use the
* configuration object make it a mandatory parameter. This is
* because a configuration object should always be forwarded,
* otherwise, you run the risk of missing a parameter and then
* being stumped when a configuration directive doesn't work.
*
* @todo Reconsider some of the public member variables
*/
class HTMLPurifier_Config
{
/**
* HTML Purifier's version
* @type string
*/
public $version = '4.9.2';
/**
* Whether or not to automatically finalize
* the object if a read operation is done.
* @type bool
*/
public $autoFinalize = \true;
// protected member variables
/**
* Namespace indexed array of serials for specific namespaces.
* @see getSerial() for more info.
* @type string[]
*/
protected $serials = array();
/**
* Serial for entire configuration object.
* @type string
*/
protected $serial;
/**
* Parser for variables.
* @type HTMLPurifier_VarParser_Flexible
*/
protected $parser = \null;
/**
* Reference HTMLPurifier_ConfigSchema for value checking.
* @type HTMLPurifier_ConfigSchema
* @note This is public for introspective purposes. Please don't
* abuse!
*/
public $def;
/**
* Indexed array of definitions.
* @type HTMLPurifier_Definition[]
*/
protected $definitions;
/**
* Whether or not config is finalized.
* @type bool
*/
protected $finalized = \false;
/**
* Property list containing configuration directives.
* @type array
*/
protected $plist;
/**
* Set to false if you do not want line and file numbers in errors.
* (useful when unit testing). This will also compress some errors
* and exceptions.
* @type bool
*/
public $chatty = \true;
/**
* Constructor
* @param HTMLPurifier_ConfigSchema $definition ConfigSchema that defines
* what directives are allowed.
* @param HTMLPurifier_PropertyList $parent
*/
public function __construct($definition, $parent = \null)
{
}
/**
* Convenience constructor that creates a config object based on a mixed var
* @param mixed $config Variable that defines the state of the config
* object. Can be: a HTMLPurifier_Config() object,
* an array of directives based on loadArray(),
* or a string filename of an ini file.
* @param HTMLPurifier_ConfigSchema $schema Schema object
* @return HTMLPurifier_Config Configured object
*/
public static function create($config, $schema = \null)
{
}
/**
* Creates a new config object that inherits from a previous one.
* @param HTMLPurifier_Config $config Configuration object to inherit from.
* @return HTMLPurifier_Config object with $config as its parent.
*/
public static function inherit(\HTMLPurifier_Config $config)
{
}
/**
* Convenience constructor that creates a default configuration object.
* @return HTMLPurifier_Config default object.
*/
public static function createDefault()
{
}
/**
* Retrieves a value from the configuration.
*
* @param string $key String key
* @param mixed $a
*
* @return mixed
*/
public function get($key, $a = \null)
{
}
/**
* Retrieves an array of directives to values from a given namespace
*
* @param string $namespace String namespace
*
* @return array
*/
public function getBatch($namespace)
{
}
/**
* Returns a SHA-1 signature of a segment of the configuration object
* that uniquely identifies that particular configuration
*
* @param string $namespace Namespace to get serial for
*
* @return string
* @note Revision is handled specially and is removed from the batch
* before processing!
*/
public function getBatchSerial($namespace)
{
}
/**
* Returns a SHA-1 signature for the entire configuration object
* that uniquely identifies that particular configuration
*
* @return string
*/
public function getSerial()
{
}
/**
* Retrieves all directives, organized by namespace
*
* @warning This is a pretty inefficient function, avoid if you can
*/
public function getAll()
{
}
/**
* Sets a value to configuration.
*
* @param string $key key
* @param mixed $value value
* @param mixed $a
*/
public function set($key, $value, $a = \null)
{
}
/**
* Retrieves object reference to the HTML definition.
*
* @param bool $raw Return a copy that has not been setup yet. Must be
* called before it's been setup, otherwise won't work.
* @param bool $optimized If true, this method may return null, to
* indicate that a cached version of the modified
* definition object is available and no further edits
* are necessary. Consider using
* maybeGetRawHTMLDefinition, which is more explicitly
* named, instead.
*
* @return HTMLPurifier_HTMLDefinition
*/
public function getHTMLDefinition($raw = \false, $optimized = \false)
{
}
/**
* Retrieves object reference to the CSS definition
*
* @param bool $raw Return a copy that has not been setup yet. Must be
* called before it's been setup, otherwise won't work.
* @param bool $optimized If true, this method may return null, to
* indicate that a cached version of the modified
* definition object is available and no further edits
* are necessary. Consider using
* maybeGetRawCSSDefinition, which is more explicitly
* named, instead.
*
* @return HTMLPurifier_CSSDefinition
*/
public function getCSSDefinition($raw = \false, $optimized = \false)
{
}
/**
* Retrieves object reference to the URI definition
*
* @param bool $raw Return a copy that has not been setup yet. Must be
* called before it's been setup, otherwise won't work.
* @param bool $optimized If true, this method may return null, to
* indicate that a cached version of the modified
* definition object is available and no further edits
* are necessary. Consider using
* maybeGetRawURIDefinition, which is more explicitly
* named, instead.
*
* @return HTMLPurifier_URIDefinition
*/
public function getURIDefinition($raw = \false, $optimized = \false)
{
}
/**
* Retrieves a definition
*
* @param string $type Type of definition: HTML, CSS, etc
* @param bool $raw Whether or not definition should be returned raw
* @param bool $optimized Only has an effect when $raw is true. Whether
* or not to return null if the result is already present in
* the cache. This is off by default for backwards
* compatibility reasons, but you need to do things this
* way in order to ensure that caching is done properly.
* Check out enduser-customize.html for more details.
* We probably won't ever change this default, as much as the
* maybe semantics is the "right thing to do."
*
* @throws HTMLPurifier_Exception
* @return HTMLPurifier_Definition
*/
public function getDefinition($type, $raw = \false, $optimized = \false)
{
}
public function maybeGetRawDefinition($name)
{
}
/**
* @return HTMLPurifier_HTMLDefinition
*/
public function maybeGetRawHTMLDefinition()
{
}
/**
* @return HTMLPurifier_CSSDefinition
*/
public function maybeGetRawCSSDefinition()
{
}
/**
* @return HTMLPurifier_URIDefinition
*/
public function maybeGetRawURIDefinition()
{
}
/**
* Loads configuration values from an array with the following structure:
* Namespace.Directive => Value
*
* @param array $config_array Configuration associative array
*/
public function loadArray($config_array)
{
}
/**
* Returns a list of array(namespace, directive) for all directives
* that are allowed in a web-form context as per an allowed
* namespaces/directives list.
*
* @param array $allowed List of allowed namespaces/directives
* @param HTMLPurifier_ConfigSchema $schema Schema to use, if not global copy
*
* @return array
*/
public static function getAllowedDirectivesForForm($allowed, $schema = \null)
{
}
/**
* Loads configuration values from $_GET/$_POST that were posted
* via ConfigForm
*
* @param array $array $_GET or $_POST array to import
* @param string|bool $index Index/name that the config variables are in
* @param array|bool $allowed List of allowed namespaces/directives
* @param bool $mq_fix Boolean whether or not to enable magic quotes fix
* @param HTMLPurifier_ConfigSchema $schema Schema to use, if not global copy
*
* @return mixed
*/
public static function loadArrayFromForm($array, $index = \false, $allowed = \true, $mq_fix = \true, $schema = \null)
{
}
/**
* Merges in configuration values from $_GET/$_POST to object. NOT STATIC.
*
* @param array $array $_GET or $_POST array to import
* @param string|bool $index Index/name that the config variables are in
* @param array|bool $allowed List of allowed namespaces/directives
* @param bool $mq_fix Boolean whether or not to enable magic quotes fix
*/
public function mergeArrayFromForm($array, $index = \false, $allowed = \true, $mq_fix = \true)
{
}
/**
* Prepares an array from a form into something usable for the more
* strict parts of HTMLPurifier_Config
*
* @param array $array $_GET or $_POST array to import
* @param string|bool $index Index/name that the config variables are in
* @param array|bool $allowed List of allowed namespaces/directives
* @param bool $mq_fix Boolean whether or not to enable magic quotes fix
* @param HTMLPurifier_ConfigSchema $schema Schema to use, if not global copy
*
* @return array
*/
public static function prepareArrayFromForm($array, $index = \false, $allowed = \true, $mq_fix = \true, $schema = \null)
{
}
/**
* Loads configuration values from an ini file
*
* @param string $filename Name of ini file
*/
public function loadIni($filename)
{
}
/**
* Checks whether or not the configuration object is finalized.
*
* @param string|bool $error String error message, or false for no error
*
* @return bool
*/
public function isFinalized($error = \false)
{
}
/**
* Finalizes configuration only if auto finalize is on and not
* already finalized
*/
public function autoFinalize()
{
}
/**
* Finalizes a configuration object, prohibiting further change
*/
public function finalize()
{
}
/**
* Produces a nicely formatted error message by supplying the
* stack frame information OUTSIDE of HTMLPurifier_Config.
*
* @param string $msg An error message
* @param int $no An error number
*/
protected function triggerError($msg, $no)
{
}
/**
* Returns a serialized form of the configuration object that can
* be reconstituted.
*
* @return string
*/
public function serialize()
{
}
}
/**
* Pre-transform that changes converts a boolean attribute to fixed CSS
*/
class HTMLPurifier_AttrTransform_BoolToCSS extends \HTMLPurifier_AttrTransform
{
/**
* Name of boolean attribute that is trigger.
* @type string
*/
protected $attr;
/**
* CSS declarations to add to style, needs trailing semicolon.
* @type string
*/
protected $css;
/**
* @param string $attr attribute name to convert from
* @param string $css CSS declarations to add to style (needs semicolon)
*/
public function __construct($attr, $css)
{
}
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Pre-transform that changes deprecated name attribute to ID if necessary
*/
class HTMLPurifier_AttrTransform_Name extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Validates name/value pairs in param tags to be used in safe objects. This
* will only allow name values it recognizes, and pre-fill certain attributes
* with required values.
*
* @note
* This class only supports Flash. In the future, Quicktime support
* may be added.
*
* @warning
* This class expects an injector to add the necessary parameters tags.
*/
class HTMLPurifier_AttrTransform_SafeParam extends \HTMLPurifier_AttrTransform
{
/**
* @type string
*/
public $name = "SafeParam";
public function __construct()
{
}
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Pre-transform that changes deprecated bgcolor attribute to CSS.
*/
class HTMLPurifier_AttrTransform_BgColor extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Implements required attribute stipulation for <script>
*/
class HTMLPurifier_AttrTransform_ScriptRequired extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Sets height/width defaults for <textarea>
*/
class HTMLPurifier_AttrTransform_Textarea extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Performs miscellaneous cross attribute validation and filtering for
* input elements. This is meant to be a post-transform.
*/
class HTMLPurifier_AttrTransform_Input extends \HTMLPurifier_AttrTransform
{
/**
* @type HTMLPurifier_AttrDef_HTML_Pixels
*/
protected $pixels;
public function __construct()
{
}
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Post-transform that performs validation to the name attribute; if
* it is present with an equivalent id attribute, it is passed through;
* otherwise validation is performed.
*/
class HTMLPurifier_AttrTransform_NameSync extends \HTMLPurifier_AttrTransform
{
public function __construct()
{
}
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Pre-transform that changes proprietary background attribute to CSS.
*/
class HTMLPurifier_AttrTransform_Background extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
// must be called POST validation
/**
* Adds target="blank" to all outbound links. This transform is
* only attached if Attr.TargetBlank is TRUE. This works regardless
* of whether or not Attr.AllowedFrameTargets
*/
class HTMLPurifier_AttrTransform_TargetBlank extends \HTMLPurifier_AttrTransform
{
public function __construct()
{
}
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
class HTMLPurifier_AttrTransform_SafeEmbed extends \HTMLPurifier_AttrTransform
{
/**
* @type string
*/
public $name = "SafeEmbed";
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Post-transform that copies lang's value to xml:lang (and vice-versa)
* @note Theoretically speaking, this could be a pre-transform, but putting
* post is more efficient.
*/
class HTMLPurifier_AttrTransform_Lang extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Pre-transform that changes deprecated hspace and vspace attributes to CSS
*/
class HTMLPurifier_AttrTransform_ImgSpace extends \HTMLPurifier_AttrTransform
{
/**
* @type string
*/
protected $attr;
/**
* @type array
*/
protected $css = array('hspace' => array('left', 'right'), 'vspace' => array('top', 'bottom'));
/**
* @param string $attr
*/
public function __construct($attr)
{
}
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
// must be called POST validation
/**
* Adds rel="nofollow" to all outbound links. This transform is
* only attached if Attr.Nofollow is TRUE.
*/
class HTMLPurifier_AttrTransform_Nofollow extends \HTMLPurifier_AttrTransform
{
public function __construct()
{
}
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Writes default type for all objects. Currently only supports flash.
*/
class HTMLPurifier_AttrTransform_SafeObject extends \HTMLPurifier_AttrTransform
{
/**
* @type string
*/
public $name = "SafeObject";
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Generic pre-transform that converts an attribute with a fixed number of
* values (enumerated) to CSS.
*/
class HTMLPurifier_AttrTransform_EnumToCSS extends \HTMLPurifier_AttrTransform
{
/**
* Name of attribute to transform from.
* @type string
*/
protected $attr;
/**
* Lookup array of attribute values to CSS.
* @type array
*/
protected $enumToCSS = array();
/**
* Case sensitivity of the matching.
* @type bool
* @warning Currently can only be guaranteed to work with ASCII
* values.
*/
protected $caseSensitive = \false;
/**
* @param string $attr Attribute name to transform from
* @param array $enum_to_css Lookup array of attribute values to CSS
* @param bool $case_sensitive Case sensitivity indicator, default false
*/
public function __construct($attr, $enum_to_css, $case_sensitive = \false)
{
}
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
// must be called POST validation
/**
* Adds rel="noopener" to any links which target a different window
* than the current one. This is used to prevent malicious websites
* from silently replacing the original window, which could be used
* to do phishing.
* This transform is controlled by %HTML.TargetNoopener.
*/
class HTMLPurifier_AttrTransform_TargetNoopener extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
// this MUST be placed in post, as it assumes that any value in dir is valid
/**
* Post-trasnform that ensures that bdo tags have the dir attribute set.
*/
class HTMLPurifier_AttrTransform_BdoDir extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
// must be called POST validation
/**
* Transform that supplies default values for the src and alt attributes
* in img tags, as well as prevents the img tag from being removed
* because of a missing alt tag. This needs to be registered as both
* a pre and post attribute transform.
*/
class HTMLPurifier_AttrTransform_ImgRequired extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
// must be called POST validation
/**
* Adds rel="noreferrer" to any links which target a different window
* than the current one. This is used to prevent malicious websites
* from silently replacing the original window, which could be used
* to do phishing.
* This transform is controlled by %HTML.TargetNoreferrer.
*/
class HTMLPurifier_AttrTransform_TargetNoreferrer extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Pre-transform that changes deprecated border attribute to CSS.
*/
class HTMLPurifier_AttrTransform_Border extends \HTMLPurifier_AttrTransform
{
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* Class for handling width/height length attribute transformations to CSS
*/
class HTMLPurifier_AttrTransform_Length extends \HTMLPurifier_AttrTransform
{
/**
* @type string
*/
protected $name;
/**
* @type string
*/
protected $cssName;
public function __construct($name, $css_name = \null)
{
}
/**
* @param array $attr
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function transform($attr, $config, $context)
{
}
}
/**
* A zipper is a purely-functional data structure which contains
* a focus that can be efficiently manipulated. It is known as
* a "one-hole context". This mutable variant implements a zipper
* for a list as a pair of two arrays, laid out as follows:
*
* Base list: 1 2 3 4 [ ] 6 7 8 9
* Front list: 1 2 3 4
* Back list: 9 8 7 6
*
* User is expected to keep track of the "current element" and properly
* fill it back in as necessary. (ToDo: Maybe it's more user friendly
* to implicitly track the current element?)
*
* Nota bene: the current class gets confused if you try to store NULLs
* in the list.
*/
class HTMLPurifier_Zipper
{
public $front, $back;
public function __construct($front, $back)
{
}
/**
* Creates a zipper from an array, with a hole in the
* 0-index position.
* @param Array to zipper-ify.
* @return Tuple of zipper and element of first position.
*/
public static function fromArray($array)
{
}
/**
* Convert zipper back into a normal array, optionally filling in
* the hole with a value. (Usually you should supply a $t, unless you
* are at the end of the array.)
*/
public function toArray($t = \NULL)
{
}
/**
* Move hole to the next element.
* @param $t Element to fill hole with
* @return Original contents of new hole.
*/
public function next($t)
{
}
/**
* Iterated hole advancement.
* @param $t Element to fill hole with
* @param $i How many forward to advance hole
* @return Original contents of new hole, i away
*/
public function advance($t, $n)
{
}
/**
* Move hole to the previous element
* @param $t Element to fill hole with
* @return Original contents of new hole.
*/
public function prev($t)
{
}
/**
* Delete contents of current hole, shifting hole to
* next element.
* @return Original contents of new hole.
*/
public function delete()
{
}
/**
* Returns true if we are at the end of the list.
* @return bool
*/
public function done()
{
}
/**
* Insert element before hole.
* @param Element to insert
*/
public function insertBefore($t)
{
}
/**
* Insert element after hole.
* @param Element to insert
*/
public function insertAfter($t)
{
}
/**
* Splice in multiple elements at hole. Functional specification
* in terms of array_splice:
*
* $arr1 = $arr;
* $old1 = array_splice($arr1, $i, $delete, $replacement);
*
* list($z, $t) = HTMLPurifier_Zipper::fromArray($arr);
* $t = $z->advance($t, $i);
* list($old2, $t) = $z->splice($t, $delete, $replacement);
* $arr2 = $z->toArray($t);
*
* assert($old1 === $old2);
* assert($arr1 === $arr2);
*
* NB: the absolute index location after this operation is
* *unchanged!*
*
* @param Current contents of hole.
*/
public function splice($t, $delete, $replacement)
{
}
}
class HTMLPurifier_DoctypeRegistry
{
/**
* Hash of doctype names to doctype objects.
* @type array
*/
protected $doctypes;
/**
* Lookup table of aliases to real doctype names.
* @type array
*/
protected $aliases;
/**
* Registers a doctype to the registry
* @note Accepts a fully-formed doctype object, or the
* parameters for constructing a doctype object
* @param string $doctype Name of doctype or literal doctype object
* @param bool $xml
* @param array $modules Modules doctype will load
* @param array $tidy_modules Modules doctype will load for certain modes
* @param array $aliases Alias names for doctype
* @param string $dtd_public
* @param string $dtd_system
* @return HTMLPurifier_Doctype Editable registered doctype
*/
public function register($doctype, $xml = \true, $modules = array(), $tidy_modules = array(), $aliases = array(), $dtd_public = \null, $dtd_system = \null)
{
}
/**
* Retrieves reference to a doctype of a certain name
* @note This function resolves aliases
* @note When possible, use the more fully-featured make()
* @param string $doctype Name of doctype
* @return HTMLPurifier_Doctype Editable doctype object
*/
public function get($doctype)
{
}
/**
* Creates a doctype based on a configuration object,
* will perform initialization on the doctype
* @note Use this function to get a copy of doctype that config
* can hold on to (this is necessary in order to tell
* Generator whether or not the current document is XML
* based or not).
* @param HTMLPurifier_Config $config
* @return HTMLPurifier_Doctype
*/
public function make($config)
{
}
/**
* Retrieves the doctype from the configuration object
* @param HTMLPurifier_Config $config
* @return string
*/
public function getDoctypeFromConfig($config)
{
}
}
/**
* Bootstrap class that contains meta-functionality for HTML Purifier such as
* the autoload function.
*
* @note
* This class may be used without any other files from HTML Purifier.
*/
class HTMLPurifier_Bootstrap
{
/**
* Autoload function for HTML Purifier
* @param string $class Class to load
* @return bool
*/
public static function autoload($class)
{
}
/**
* Returns the path for a specific class.
* @param string $class Class path to get
* @return string
*/
public static function getPath($class)
{
}
/**
* "Pre-registers" our autoloader on the SPL stack.
*/
public static function registerAutoload()
{
}
}
/**
* Provides lookup array of attribute types to HTMLPurifier_AttrDef objects
*/
class HTMLPurifier_AttrTypes
{
/**
* Lookup array of attribute string identifiers to concrete implementations.
* @type HTMLPurifier_AttrDef[]
*/
protected $info = array();
/**
* Constructs the info array, supplying default implementations for attribute
* types.
*/
public function __construct()
{
}
/**
* Retrieves a type
* @param string $type String type name
* @return HTMLPurifier_AttrDef Object AttrDef for type
*/
public function get($type)
{
}
/**
* Sets a new implementation for a type
* @param string $type String type name
* @param HTMLPurifier_AttrDef $impl Object AttrDef for type
*/
public function set($type, $impl)
{
}
}
/**
* Chainable filters for custom URI processing.
*
* These filters can perform custom actions on a URI filter object,
* including transformation or blacklisting. A filter named Foo
* must have a corresponding configuration directive %URI.Foo,
* unless always_load is specified to be true.
*
* The following contexts may be available while URIFilters are being
* processed:
*
* - EmbeddedURI: true if URI is an embedded resource that will
* be loaded automatically on page load
* - CurrentToken: a reference to the token that is currently
* being processed
* - CurrentAttr: the name of the attribute that is currently being
* processed
* - CurrentCSSProperty: the name of the CSS property that is
* currently being processed (if applicable)
*
* @warning This filter is called before scheme object validation occurs.
* Make sure, if you require a specific scheme object, you
* you check that it exists. This allows filters to convert
* proprietary URI schemes into regular ones.
*/
abstract class HTMLPurifier_URIFilter
{
/**
* Unique identifier of filter.
* @type string
*/
public $name;
/**
* True if this filter should be run after scheme validation.
* @type bool
*/
public $post = \false;
/**
* True if this filter should always be loaded.
* This permits a filter to be named Foo without the corresponding
* %URI.Foo directive existing.
* @type bool
*/
public $always_load = \false;
/**
* Performs initialization for the filter. If the filter returns
* false, this means that it shouldn't be considered active.
* @param HTMLPurifier_Config $config
* @return bool
*/
public function prepare($config)
{
}
/**
* Filter a URI object
* @param HTMLPurifier_URI $uri Reference to URI object variable
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool Whether or not to continue processing: false indicates
* URL is no good, true indicates continue processing. Note that
* all changes are committed directly on the URI object
*/
public abstract function filter(&$uri, $config, $context);
}
/**
* Global exception class for HTML Purifier; any exceptions we throw
* are from here.
*/
class HTMLPurifier_Exception extends \Exception
{
}
/**
* HTML Purifier's internal representation of a URI.
* @note
* Internal data-structures are completely escaped. If the data needs
* to be used in a non-URI context (which is very unlikely), be sure
* to decode it first. The URI may not necessarily be well-formed until
* validate() is called.
*/
class HTMLPurifier_URI
{
/**
* @type string
*/
public $scheme;
/**
* @type string
*/
public $userinfo;
/**
* @type string
*/
public $host;
/**
* @type int
*/
public $port;
/**
* @type string
*/
public $path;
/**
* @type string
*/
public $query;
/**
* @type string
*/
public $fragment;
/**
* @param string $scheme
* @param string $userinfo
* @param string $host
* @param int $port
* @param string $path
* @param string $query
* @param string $fragment
* @note Automatically normalizes scheme and port
*/
public function __construct($scheme, $userinfo, $host, $port, $path, $query, $fragment)
{
}
/**
* Retrieves a scheme object corresponding to the URI's scheme/default
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return HTMLPurifier_URIScheme Scheme object appropriate for validating this URI
*/
public function getSchemeObj($config, $context)
{
}
/**
* Generic validation method applicable for all schemes. May modify
* this URI in order to get it into a compliant form.
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool True if validation/filtering succeeds, false if failure
*/
public function validate($config, $context)
{
}
/**
* Convert URI back to string
* @return string URI appropriate for output
*/
public function toString()
{
}
/**
* Returns true if this URL might be considered a 'local' URL given
* the current context. This is true when the host is null, or
* when it matches the host supplied to the configuration.
*
* Note that this does not do any scheme checking, so it is mostly
* only appropriate for metadata that doesn't care about protocol
* security. isBenign is probably what you actually want.
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function isLocal($config, $context)
{
}
/**
* Returns true if this URL should be considered a 'benign' URL,
* that is:
*
* - It is a local URL (isLocal), and
* - It has a equal or better level of security
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function isBenign($config, $context)
{
}
}
/**
* Abstract base node class that all others inherit from.
*
* Why do we not use the DOM extension? (1) It is not always available,
* (2) it has funny constraints on the data it can represent,
* whereas we want a maximally flexible representation, and (3) its
* interface is a bit cumbersome.
*/
abstract class HTMLPurifier_Node
{
/**
* Line number of the start token in the source document
* @type int
*/
public $line;
/**
* Column number of the start token in the source document. Null if unknown.
* @type int
*/
public $col;
/**
* Lookup array of processing that this token is exempt from.
* Currently, valid values are "ValidateAttributes".
* @type array
*/
public $armor = array();
/**
* When true, this node should be ignored as non-existent.
*
* Who is responsible for ignoring dead nodes? FixNesting is
* responsible for removing them before passing on to child
* validators.
*/
public $dead = \false;
/**
* Returns a pair of start and end tokens, where the end token
* is null if it is not necessary. Does not include children.
* @type array
*/
public abstract function toTokenPair();
}
/**
* A UTF-8 specific character encoder that handles cleaning and transforming.
* @note All functions in this class should be static.
*/
class HTMLPurifier_Encoder
{
/**
* Error-handler that mutes errors, alternative to shut-up operator.
*/
public static function muteErrorHandler()
{
}
/**
* iconv wrapper which mutes errors, but doesn't work around bugs.
* @param string $in Input encoding
* @param string $out Output encoding
* @param string $text The text to convert
* @return string
*/
public static function unsafeIconv($in, $out, $text)
{
}
/**
* iconv wrapper which mutes errors and works around bugs.
* @param string $in Input encoding
* @param string $out Output encoding
* @param string $text The text to convert
* @param int $max_chunk_size
* @return string
*/
public static function iconv($in, $out, $text, $max_chunk_size = 8000)
{
}
/**
* Cleans a UTF-8 string for well-formedness and SGML validity
*
* It will parse according to UTF-8 and return a valid UTF8 string, with
* non-SGML codepoints excluded.
*
* Specifically, it will permit:
* \x{9}\x{A}\x{D}\x{20}-\x{7E}\x{A0}-\x{D7FF}\x{E000}-\x{FFFD}\x{10000}-\x{10FFFF}
* Source: https://www.w3.org/TR/REC-xml/#NT-Char
* Arguably this function should be modernized to the HTML5 set
* of allowed characters:
* https://www.w3.org/TR/html5/syntax.html#preprocessing-the-input-stream
* which simultaneously expand and restrict the set of allowed characters.
*
* @param string $str The string to clean
* @param bool $force_php
* @return string
*
* @note Just for reference, the non-SGML code points are 0 to 31 and
* 127 to 159, inclusive. However, we allow code points 9, 10
* and 13, which are the tab, line feed and carriage return
* respectively. 128 and above the code points map to multibyte
* UTF-8 representations.
*
* @note Fallback code adapted from utf8ToUnicode by Henri Sivonen and
* hsivonen@iki.fi at <http://iki.fi/hsivonen/php-utf8/> under the
* LGPL license. Notes on what changed are inside, but in general,
* the original code transformed UTF-8 text into an array of integer
* Unicode codepoints. Understandably, transforming that back to
* a string would be somewhat expensive, so the function was modded to
* directly operate on the string. However, this discourages code
* reuse, and the logic enumerated here would be useful for any
* function that needs to be able to understand UTF-8 characters.
* As of right now, only smart lossless character encoding converters
* would need that, and I'm probably not going to implement them.
*/
public static function cleanUTF8($str, $force_php = \false)
{
}
/**
* Translates a Unicode codepoint into its corresponding UTF-8 character.
* @note Based on Feyd's function at
* <http://forums.devnetwork.net/viewtopic.php?p=191404#191404>,
* which is in public domain.
* @note While we're going to do code point parsing anyway, a good
* optimization would be to refuse to translate code points that
* are non-SGML characters. However, this could lead to duplication.
* @note This is very similar to the unichr function in
* maintenance/generate-entity-file.php (although this is superior,
* due to its sanity checks).
*/
// +----------+----------+----------+----------+
// | 33222222 | 22221111 | 111111 | |
// | 10987654 | 32109876 | 54321098 | 76543210 | bit
// +----------+----------+----------+----------+
// | | | | 0xxxxxxx | 1 byte 0x00000000..0x0000007F
// | | | 110yyyyy | 10xxxxxx | 2 byte 0x00000080..0x000007FF
// | | 1110zzzz | 10yyyyyy | 10xxxxxx | 3 byte 0x00000800..0x0000FFFF
// | 11110www | 10wwzzzz | 10yyyyyy | 10xxxxxx | 4 byte 0x00010000..0x0010FFFF
// +----------+----------+----------+----------+
// | 00000000 | 00011111 | 11111111 | 11111111 | Theoretical upper limit of legal scalars: 2097151 (0x001FFFFF)
// | 00000000 | 00010000 | 11111111 | 11111111 | Defined upper limit of legal scalar codes
// +----------+----------+----------+----------+
public static function unichr($code)
{
}
/**
* @return bool
*/
public static function iconvAvailable()
{
}
/**
* Convert a string to UTF-8 based on configuration.
* @param string $str The string to convert
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
*/
public static function convertToUTF8($str, $config, $context)
{
}
/**
* Converts a string from UTF-8 based on configuration.
* @param string $str The string to convert
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
* @note Currently, this is a lossy conversion, with unexpressable
* characters being omitted.
*/
public static function convertFromUTF8($str, $config, $context)
{
}
/**
* Lossless (character-wise) conversion of HTML to ASCII
* @param string $str UTF-8 string to be converted to ASCII
* @return string ASCII encoded string with non-ASCII character entity-ized
* @warning Adapted from MediaWiki, claiming fair use: this is a common
* algorithm. If you disagree with this license fudgery,
* implement it yourself.
* @note Uses decimal numeric entities since they are best supported.
* @note This is a DUMB function: it has no concept of keeping
* character entities that the projected character encoding
* can allow. We could possibly implement a smart version
* but that would require it to also know which Unicode
* codepoints the charset supported (not an easy task).
* @note Sort of with cleanUTF8() but it assumes that $str is
* well-formed UTF-8
*/
public static function convertToASCIIDumbLossless($str)
{
}
/** No bugs detected in iconv. */
const ICONV_OK = 0;
/** Iconv truncates output if converting from UTF-8 to another
* character set with //IGNORE, and a non-encodable character is found */
const ICONV_TRUNCATES = 1;
/** Iconv does not support //IGNORE, making it unusable for
* transcoding purposes */
const ICONV_UNUSABLE = 2;
/**
* glibc iconv has a known bug where it doesn't handle the magic
* //IGNORE stanza correctly. In particular, rather than ignore
* characters, it will return an EILSEQ after consuming some number
* of characters, and expect you to restart iconv as if it were
* an E2BIG. Old versions of PHP did not respect the errno, and
* returned the fragment, so as a result you would see iconv
* mysteriously truncating output. We can work around this by
* manually chopping our input into segments of about 8000
* characters, as long as PHP ignores the error code. If PHP starts
* paying attention to the error code, iconv becomes unusable.
*
* @return int Error code indicating severity of bug.
*/
public static function testIconvTruncateBug()
{
}
/**
* This expensive function tests whether or not a given character
* encoding supports ASCII. 7/8-bit encodings like Shift_JIS will
* fail this test, and require special processing. Variable width
* encodings shouldn't ever fail.
*
* @param string $encoding Encoding name to test, as per iconv format
* @param bool $bypass Whether or not to bypass the precompiled arrays.
* @return Array of UTF-8 characters to their corresponding ASCII,
* which can be used to "undo" any overzealous iconv action.
*/
public static function testEncodingSupportsASCII($encoding, $bypass = \false)
{
}
}
/**
* Converts a stream of HTMLPurifier_Token into an HTMLPurifier_Node,
* and back again.
*
* @note This transformation is not an equivalence. We mutate the input
* token stream to make it so; see all [MUT] markers in code.
*/
class HTMLPurifier_Arborize
{
public static function arborize($tokens, $config, $context)
{
}
public static function flatten($node, $config, $context)
{
}
}
/**
* Represents a document type, contains information on which modules
* need to be loaded.
* @note This class is inspected by Printer_HTMLDefinition->renderDoctype.
* If structure changes, please update that function.
*/
class HTMLPurifier_Doctype
{
/**
* Full name of doctype
* @type string
*/
public $name;
/**
* List of standard modules (string identifiers or literal objects)
* that this doctype uses
* @type array
*/
public $modules = array();
/**
* List of modules to use for tidying up code
* @type array
*/
public $tidyModules = array();
/**
* Is the language derived from XML (i.e. XHTML)?
* @type bool
*/
public $xml = \true;
/**
* List of aliases for this doctype
* @type array
*/
public $aliases = array();
/**
* Public DTD identifier
* @type string
*/
public $dtdPublic;
/**
* System DTD identifier
* @type string
*/
public $dtdSystem;
public function __construct($name = \null, $xml = \true, $modules = array(), $tidyModules = array(), $aliases = array(), $dtd_public = \null, $dtd_system = \null)
{
}
}
/**
* Parses string hash files. File format is as such:
*
* DefaultKeyValue
* KEY: Value
* KEY2: Value2
* --MULTILINE-KEY--
* Multiline
* value.
*
* Which would output something similar to:
*
* array(
* 'ID' => 'DefaultKeyValue',
* 'KEY' => 'Value',
* 'KEY2' => 'Value2',
* 'MULTILINE-KEY' => "Multiline\nvalue.\n",
* )
*
* We use this as an easy to use file-format for configuration schema
* files, but the class itself is usage agnostic.
*
* You can use ---- to forcibly terminate parsing of a single string-hash;
* this marker is used in multi string-hashes to delimit boundaries.
*/
class HTMLPurifier_StringHashParser
{
/**
* @type string
*/
public $default = 'ID';
/**
* Parses a file that contains a single string-hash.
* @param string $file
* @return array
*/
public function parseFile($file)
{
}
/**
* Parses a file that contains multiple string-hashes delimited by '----'
* @param string $file
* @return array
*/
public function parseMultiFile($file)
{
}
/**
* Internal parser that acepts a file handle.
* @note While it's possible to simulate in-memory parsing by using
* custom stream wrappers, if such a use-case arises we should
* factor out the file handle into its own class.
* @param resource $fh File handle with pointer at start of valid string-hash
* block.
* @return array
*/
protected function parseHandle($fh)
{
}
}
/**
* Implements safety checks for safe iframes.
*
* @warning This filter is *critical* for ensuring that %HTML.SafeIframe
* works safely.
*/
class HTMLPurifier_URIFilter_SafeIframe extends \HTMLPurifier_URIFilter
{
/**
* @type string
*/
public $name = 'SafeIframe';
/**
* @type bool
*/
public $always_load = \true;
/**
* @type string
*/
protected $regexp = \null;
// XXX: The not so good bit about how this is all set up now is we
// can't check HTML.SafeIframe in the 'prepare' step: we have to
// defer till the actual filtering.
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function prepare($config)
{
}
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function filter(&$uri, $config, $context)
{
}
}
// It's not clear to me whether or not Punycode means that hostnames
// do not have canonical forms anymore. As far as I can tell, it's
// not a problem (punycoding should be identity when no Unicode
// points are involved), but I'm not 100% sure
class HTMLPurifier_URIFilter_HostBlacklist extends \HTMLPurifier_URIFilter
{
/**
* @type string
*/
public $name = 'HostBlacklist';
/**
* @type array
*/
protected $blacklist = array();
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function prepare($config)
{
}
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function filter(&$uri, $config, $context)
{
}
}
class HTMLPurifier_URIFilter_DisableResources extends \HTMLPurifier_URIFilter
{
/**
* @type string
*/
public $name = 'DisableResources';
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function filter(&$uri, $config, $context)
{
}
}
class HTMLPurifier_URIFilter_DisableExternal extends \HTMLPurifier_URIFilter
{
/**
* @type string
*/
public $name = 'DisableExternal';
/**
* @type array
*/
protected $ourHostParts = \false;
/**
* @param HTMLPurifier_Config $config
* @return void
*/
public function prepare($config)
{
}
/**
* @param HTMLPurifier_URI $uri Reference
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function filter(&$uri, $config, $context)
{
}
}
class HTMLPurifier_URIFilter_DisableExternalResources extends \HTMLPurifier_URIFilter_DisableExternal
{
/**
* @type string
*/
public $name = 'DisableExternalResources';
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function filter(&$uri, $config, $context)
{
}
}
// does not support network paths
class HTMLPurifier_URIFilter_MakeAbsolute extends \HTMLPurifier_URIFilter
{
/**
* @type string
*/
public $name = 'MakeAbsolute';
/**
* @type
*/
protected $base;
/**
* @type array
*/
protected $basePathStack = array();
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function prepare($config)
{
}
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function filter(&$uri, $config, $context)
{
}
}
class HTMLPurifier_URIFilter_Munge extends \HTMLPurifier_URIFilter
{
/**
* @type string
*/
public $name = 'Munge';
/**
* @type bool
*/
public $post = \true;
/**
* @type array
*/
protected $replace = array();
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function prepare($config)
{
}
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function filter(&$uri, $config, $context)
{
}
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
*/
protected function makeReplace($uri, $config, $context)
{
}
}
/**
* Supertype for classes that define a strategy for modifying/purifying tokens.
*
* While HTMLPurifier's core purpose is fixing HTML into something proper,
* strategies provide plug points for extra configuration or even extra
* features, such as custom tags, custom parsing of text, etc.
*/
abstract class HTMLPurifier_Strategy
{
/**
* Executes the strategy on the tokens.
*
* @param HTMLPurifier_Token[] $tokens Array of HTMLPurifier_Token objects to be operated on.
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return HTMLPurifier_Token[] Processed array of token objects.
*/
public abstract function execute($tokens, $config, $context);
}
/**
* Parses string representations into their corresponding native PHP
* variable type. The base implementation does a simple type-check.
*/
class HTMLPurifier_VarParser
{
const STRING = 1;
const ISTRING = 2;
const TEXT = 3;
const ITEXT = 4;
const INT = 5;
const FLOAT = 6;
const BOOL = 7;
const LOOKUP = 8;
const ALIST = 9;
const HASH = 10;
const MIXED = 11;
/**
* Lookup table of allowed types. Mainly for backwards compatibility, but
* also convenient for transforming string type names to the integer constants.
*/
public static $types = array('string' => self::STRING, 'istring' => self::ISTRING, 'text' => self::TEXT, 'itext' => self::ITEXT, 'int' => self::INT, 'float' => self::FLOAT, 'bool' => self::BOOL, 'lookup' => self::LOOKUP, 'list' => self::ALIST, 'hash' => self::HASH, 'mixed' => self::MIXED);
/**
* Lookup table of types that are string, and can have aliases or
* allowed value lists.
*/
public static $stringTypes = array(self::STRING => \true, self::ISTRING => \true, self::TEXT => \true, self::ITEXT => \true);
/**
* Validate a variable according to type.
* It may return NULL as a valid type if $allow_null is true.
*
* @param mixed $var Variable to validate
* @param int $type Type of variable, see HTMLPurifier_VarParser->types
* @param bool $allow_null Whether or not to permit null as a value
* @return string Validated and type-coerced variable
* @throws HTMLPurifier_VarParserException
*/
public final function parse($var, $type, $allow_null = \false)
{
}
/**
* Actually implements the parsing. Base implementation does not
* do anything to $var. Subclasses should overload this!
* @param mixed $var
* @param int $type
* @param bool $allow_null
* @return string
*/
protected function parseImplementation($var, $type, $allow_null)
{
}
/**
* Throws an exception.
* @throws HTMLPurifier_VarParserException
*/
protected function error($msg)
{
}
/**
* Throws an inconsistency exception.
* @note This should not ever be called. It would be called if we
* extend the allowed values of HTMLPurifier_VarParser without
* updating subclasses.
* @param string $class
* @param int $type
* @throws HTMLPurifier_Exception
*/
protected function errorInconsistent($class, $type)
{
}
/**
* Generic error for if a type didn't work.
* @param mixed $var
* @param int $type
*/
protected function errorGeneric($var, $type)
{
}
/**
* @param int $type
* @return string
*/
public static function getTypeName($type)
{
}
}
/**
* This variable parser uses PHP's internal code engine. Because it does
* this, it can represent all inputs; however, it is dangerous and cannot
* be used by users.
*/
class HTMLPurifier_VarParser_Native extends \HTMLPurifier_VarParser
{
/**
* @param mixed $var
* @param int $type
* @param bool $allow_null
* @return null|string
*/
protected function parseImplementation($var, $type, $allow_null)
{
}
/**
* @param string $expr
* @return mixed
* @throws HTMLPurifier_VarParserException
*/
protected function evalExpression($expr)
{
}
}
/**
* Performs safe variable parsing based on types which can be used by
* users. This may not be able to represent all possible data inputs,
* however.
*/
class HTMLPurifier_VarParser_Flexible extends \HTMLPurifier_VarParser
{
/**
* @param mixed $var
* @param int $type
* @param bool $allow_null
* @return array|bool|float|int|mixed|null|string
* @throws HTMLPurifier_VarParserException
*/
protected function parseImplementation($var, $type, $allow_null)
{
}
}
/**
* Removes all unrecognized tags from the list of tokens.
*
* This strategy iterates through all the tokens and removes unrecognized
* tokens. If a token is not recognized but a TagTransform is defined for
* that element, the element will be transformed accordingly.
*/
class HTMLPurifier_Strategy_RemoveForeignElements extends \HTMLPurifier_Strategy
{
/**
* @param HTMLPurifier_Token[] $tokens
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array|HTMLPurifier_Token[]
*/
public function execute($tokens, $config, $context)
{
}
}
/**
* Takes a well formed list of tokens and fixes their nesting.
*
* HTML elements dictate which elements are allowed to be their children,
* for example, you can't have a p tag in a span tag. Other elements have
* much more rigorous definitions: tables, for instance, require a specific
* order for their elements. There are also constraints not expressible by
* document type definitions, such as the chameleon nature of ins/del
* tags and global child exclusions.
*
* The first major objective of this strategy is to iterate through all
* the nodes and determine whether or not their children conform to the
* element's definition. If they do not, the child definition may
* optionally supply an amended list of elements that is valid or
* require that the entire node be deleted (and the previous node
* rescanned).
*
* The second objective is to ensure that explicitly excluded elements of
* an element do not appear in its children. Code that accomplishes this
* task is pervasive through the strategy, though the two are distinct tasks
* and could, theoretically, be seperated (although it's not recommended).
*
* @note Whether or not unrecognized children are silently dropped or
* translated into text depends on the child definitions.
*
* @todo Enable nodes to be bubbled out of the structure. This is
* easier with our new algorithm.
*/
class HTMLPurifier_Strategy_FixNesting extends \HTMLPurifier_Strategy
{
/**
* @param HTMLPurifier_Token[] $tokens
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array|HTMLPurifier_Token[]
*/
public function execute($tokens, $config, $context)
{
}
}
/**
* Takes tokens makes them well-formed (balance end tags, etc.)
*
* Specification of the armor attributes this strategy uses:
*
* - MakeWellFormed_TagClosedError: This armor field is used to
* suppress tag closed errors for certain tokens [TagClosedSuppress],
* in particular, if a tag was generated automatically by HTML
* Purifier, we may rely on our infrastructure to close it for us
* and shouldn't report an error to the user [TagClosedAuto].
*/
class HTMLPurifier_Strategy_MakeWellFormed extends \HTMLPurifier_Strategy
{
/**
* Array stream of tokens being processed.
* @type HTMLPurifier_Token[]
*/
protected $tokens;
/**
* Current token.
* @type HTMLPurifier_Token
*/
protected $token;
/**
* Zipper managing the true state.
* @type HTMLPurifier_Zipper
*/
protected $zipper;
/**
* Current nesting of elements.
* @type array
*/
protected $stack;
/**
* Injectors active in this stream processing.
* @type HTMLPurifier_Injector[]
*/
protected $injectors;
/**
* Current instance of HTMLPurifier_Config.
* @type HTMLPurifier_Config
*/
protected $config;
/**
* Current instance of HTMLPurifier_Context.
* @type HTMLPurifier_Context
*/
protected $context;
/**
* @param HTMLPurifier_Token[] $tokens
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return HTMLPurifier_Token[]
* @throws HTMLPurifier_Exception
*/
public function execute($tokens, $config, $context)
{
}
/**
* Processes arbitrary token values for complicated substitution patterns.
* In general:
*
* If $token is an array, it is a list of tokens to substitute for the
* current token. These tokens then get individually processed. If there
* is a leading integer in the list, that integer determines how many
* tokens from the stream should be removed.
*
* If $token is a regular token, it is swapped with the current token.
*
* If $token is false, the current token is deleted.
*
* If $token is an integer, that number of tokens (with the first token
* being the current one) will be deleted.
*
* @param HTMLPurifier_Token|array|int|bool $token Token substitution value
* @param HTMLPurifier_Injector|int $injector Injector that performed the substitution; default is if
* this is not an injector related operation.
* @throws HTMLPurifier_Exception
*/
protected function processToken($token, $injector = -1)
{
}
}
/**
* Validate all attributes in the tokens.
*/
class HTMLPurifier_Strategy_ValidateAttributes extends \HTMLPurifier_Strategy
{
/**
* @param HTMLPurifier_Token[] $tokens
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return HTMLPurifier_Token[]
*/
public function execute($tokens, $config, $context)
{
}
}
/**
* Composite strategy that runs multiple strategies on tokens.
*/
abstract class HTMLPurifier_Strategy_Composite extends \HTMLPurifier_Strategy
{
/**
* List of strategies to run tokens through.
* @type HTMLPurifier_Strategy[]
*/
protected $strategies = array();
/**
* @param HTMLPurifier_Token[] $tokens
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return HTMLPurifier_Token[]
*/
public function execute($tokens, $config, $context)
{
}
}
/**
* Core strategy composed of the big four strategies.
*/
class HTMLPurifier_Strategy_Core extends \HTMLPurifier_Strategy_Composite
{
public function __construct()
{
}
}
class HTMLPurifier_HTMLModuleManager
{
/**
* @type HTMLPurifier_DoctypeRegistry
*/
public $doctypes;
/**
* Instance of current doctype.
* @type string
*/
public $doctype;
/**
* @type HTMLPurifier_AttrTypes
*/
public $attrTypes;
/**
* Active instances of modules for the specified doctype are
* indexed, by name, in this array.
* @type HTMLPurifier_HTMLModule[]
*/
public $modules = array();
/**
* Array of recognized HTMLPurifier_HTMLModule instances,
* indexed by module's class name. This array is usually lazy loaded, but a
* user can overload a module by pre-emptively registering it.
* @type HTMLPurifier_HTMLModule[]
*/
public $registeredModules = array();
/**
* List of extra modules that were added by the user
* using addModule(). These get unconditionally merged into the current doctype, whatever
* it may be.
* @type HTMLPurifier_HTMLModule[]
*/
public $userModules = array();
/**
* Associative array of element name to list of modules that have
* definitions for the element; this array is dynamically filled.
* @type array
*/
public $elementLookup = array();
/**
* List of prefixes we should use for registering small names.
* @type array
*/
public $prefixes = array('HTMLPurifier_HTMLModule_');
/**
* @type HTMLPurifier_ContentSets
*/
public $contentSets;
/**
* @type HTMLPurifier_AttrCollections
*/
public $attrCollections;
/**
* If set to true, unsafe elements and attributes will be allowed.
* @type bool
*/
public $trusted = \false;
public function __construct()
{
}
/**
* Registers a module to the recognized module list, useful for
* overloading pre-existing modules.
* @param $module Mixed: string module name, with or without
* HTMLPurifier_HTMLModule prefix, or instance of
* subclass of HTMLPurifier_HTMLModule.
* @param $overload Boolean whether or not to overload previous modules.
* If this is not set, and you do overload a module,
* HTML Purifier will complain with a warning.
* @note This function will not call autoload, you must instantiate
* (and thus invoke) autoload outside the method.
* @note If a string is passed as a module name, different variants
* will be tested in this order:
* - Check for HTMLPurifier_HTMLModule_$name
* - Check all prefixes with $name in order they were added
* - Check for literal object name
* - Throw fatal error
* If your object name collides with an internal class, specify
* your module manually. All modules must have been included
* externally: registerModule will not perform inclusions for you!
*/
public function registerModule($module, $overload = \false)
{
}
/**
* Adds a module to the current doctype by first registering it,
* and then tacking it on to the active doctype
*/
public function addModule($module)
{
}
/**
* Adds a class prefix that registerModule() will use to resolve a
* string name to a concrete class
*/
public function addPrefix($prefix)
{
}
/**
* Performs processing on modules, after being called you may
* use getElement() and getElements()
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
/**
* Takes a module and adds it to the active module collection,
* registering it if necessary.
*/
public function processModule($module)
{
}
/**
* Retrieves merged element definitions.
* @return Array of HTMLPurifier_ElementDef
*/
public function getElements()
{
}
/**
* Retrieves a single merged element definition
* @param string $name Name of element
* @param bool $trusted Boolean trusted overriding parameter: set to true
* if you want the full version of an element
* @return HTMLPurifier_ElementDef Merged HTMLPurifier_ElementDef
* @note You may notice that modules are getting iterated over twice (once
* in getElements() and once here). This
* is because
*/
public function getElement($name, $trusted = \null)
{
}
}
/**
* This is in almost every respect equivalent to an array except
* that it keeps track of which keys were accessed.
*
* @warning For the sake of backwards compatibility with early versions
* of PHP 5, you must not use the $hash[$key] syntax; if you do
* our version of offsetGet is never called.
*/
class HTMLPurifier_StringHash extends \ArrayObject
{
/**
* @type array
*/
protected $accessed = array();
/**
* Retrieves a value, and logs the access.
* @param mixed $index
* @return mixed
*/
public function offsetGet($index)
{
}
/**
* Returns a lookup array of all array indexes that have been accessed.
* @return array in form array($index => true).
*/
public function getAccessed()
{
}
/**
* Resets the access array.
*/
public function resetAccessed()
{
}
}
/**
* XHTML 1.1 Text Module, defines basic text containers. Core Module.
* @note In the normative XML Schema specification, this module
* is further abstracted into the following modules:
* - Block Phrasal (address, blockquote, pre, h1, h2, h3, h4, h5, h6)
* - Block Structural (div, p)
* - Inline Phrasal (abbr, acronym, cite, code, dfn, em, kbd, q, samp, strong, var)
* - Inline Structural (br, span)
* This module, functionally, does not distinguish between these
* sub-modules, but the code is internally structured to reflect
* these distinctions.
*/
class HTMLPurifier_HTMLModule_Text extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Text';
/**
* @type array
*/
public $content_sets = array('Flow' => 'Heading | Block | Inline');
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 Ruby Annotation Module, defines elements that indicate
* short runs of text alongside base text for annotation or pronounciation.
*/
class HTMLPurifier_HTMLModule_Ruby extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Ruby';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 Target Module, defines target attribute in link elements.
*/
class HTMLPurifier_HTMLModule_Target extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Target';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 List Module, defines list-oriented elements. Core Module.
*/
class HTMLPurifier_HTMLModule_List extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'List';
// According to the abstract schema, the List content set is a fully formed
// one or more expr, but it invariably occurs in an optional declaration
// so we're not going to do that subtlety. It might cause trouble
// if a user defines "List" and expects that multiple lists are
// allowed to be specified, but then again, that's not very intuitive.
// Furthermore, the actual XML Schema may disagree. Regardless,
// we don't have support for such nested expressions without using
// the incredibly inefficient and draconic Custom ChildDef.
/**
* @type array
*/
public $content_sets = array('Flow' => 'List');
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
class HTMLPurifier_HTMLModule_XMLCommonAttributes extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'XMLCommonAttributes';
/**
* @type array
*/
public $attr_collections = array('Lang' => array('xml:lang' => 'LanguageCode'));
}
/**
* XHTML 1.1 Presentation Module, defines simple presentation-related
* markup. Text Extension Module.
* @note The official XML Schema and DTD specs further divide this into
* two modules:
* - Block Presentation (hr)
* - Inline Presentation (b, big, i, small, sub, sup, tt)
* We have chosen not to heed this distinction, as content_sets
* provides satisfactory disambiguation.
*/
class HTMLPurifier_HTMLModule_Presentation extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Presentation';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
class HTMLPurifier_HTMLModule_Name extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Name';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 Hypertext Module, defines hypertext links. Core Module.
*/
class HTMLPurifier_HTMLModule_Hypertext extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Hypertext';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 Legacy module defines elements that were previously
* deprecated.
*
* @note Not all legacy elements have been implemented yet, which
* is a bit of a reverse problem as compared to browsers! In
* addition, this legacy module may implement a bit more than
* mandated by XHTML 1.1.
*
* This module can be used in combination with TransformToStrict in order
* to transform as many deprecated elements as possible, but retain
* questionably deprecated elements that do not have good alternatives
* as well as transform elements that don't have an implementation.
* See docs/ref-strictness.txt for more details.
*/
class HTMLPurifier_HTMLModule_Legacy extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Legacy';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 Tables Module, fully defines accessible table elements.
*/
class HTMLPurifier_HTMLModule_Tables extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Tables';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
class HTMLPurifier_HTMLModule_NonXMLCommonAttributes extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'NonXMLCommonAttributes';
/**
* @type array
*/
public $attr_collections = array('Lang' => array('lang' => 'LanguageCode'));
}
/**
* XHTML 1.1 Edit Module, defines editing-related elements. Text Extension
* Module.
*/
class HTMLPurifier_HTMLModule_StyleAttribute extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'StyleAttribute';
/**
* @type array
*/
public $attr_collections = array(
// The inclusion routine differs from the Abstract Modules but
// is in line with the DTD and XML Schemas.
'Style' => array('style' => \false),
// see constructor
'Core' => array(0 => array('Style')),
);
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* Module adds the target=blank attribute transformation to a tags. It
* is enabled by HTML.TargetBlank
*/
class HTMLPurifier_HTMLModule_TargetBlank extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'TargetBlank';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 Forms module, defines all form-related elements found in HTML 4.
*/
class HTMLPurifier_HTMLModule_Forms extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Forms';
/**
* @type bool
*/
public $safe = \false;
/**
* @type array
*/
public $content_sets = array('Block' => 'Form', 'Inline' => 'Formctrl');
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* A "safe" embed module. See SafeObject. This is a proprietary element.
*/
class HTMLPurifier_HTMLModule_SafeEmbed extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'SafeEmbed';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/*
WARNING: THIS MODULE IS EXTREMELY DANGEROUS AS IT ENABLES INLINE SCRIPTING
INSIDE HTML PURIFIER DOCUMENTS. USE ONLY WITH TRUSTED USER INPUT!!!
*/
/**
* XHTML 1.1 Scripting module, defines elements that are used to contain
* information pertaining to executable scripts or the lack of support
* for executable scripts.
* @note This module does not contain inline scripting elements
*/
class HTMLPurifier_HTMLModule_Scripting extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Scripting';
/**
* @type array
*/
public $elements = array('script', 'noscript');
/**
* @type array
*/
public $content_sets = array('Block' => 'script | noscript', 'Inline' => 'script | noscript');
/**
* @type bool
*/
public $safe = \false;
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 Image Module provides basic image embedding.
* @note There is specialized code for removing empty images in
* HTMLPurifier_Strategy_RemoveForeignElements
*/
class HTMLPurifier_HTMLModule_Image extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Image';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 Bi-directional Text Module, defines elements that
* declare directionality of content. Text Extension Module.
*/
class HTMLPurifier_HTMLModule_Bdo extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Bdo';
/**
* @type array
*/
public $attr_collections = array('I18N' => array('dir' => \false));
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* A "safe" script module. No inline JS is allowed, and pointed to JS
* files must match whitelist.
*/
class HTMLPurifier_HTMLModule_SafeScripting extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'SafeScripting';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* Module adds the nofollow attribute transformation to a tags. It
* is enabled by HTML.Nofollow
*/
class HTMLPurifier_HTMLModule_Nofollow extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Nofollow';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* A "safe" object module. In theory, objects permitted by this module will
* be safe, and untrusted users can be allowed to embed arbitrary flash objects
* (maybe other types too, but only Flash is supported as of right now).
* Highly experimental.
*/
class HTMLPurifier_HTMLModule_SafeObject extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'SafeObject';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* Abstract class for a set of proprietary modules that clean up (tidy)
* poorly written HTML.
* @todo Figure out how to protect some of these methods/properties
*/
class HTMLPurifier_HTMLModule_Tidy extends \HTMLPurifier_HTMLModule
{
/**
* List of supported levels.
* Index zero is a special case "no fixes" level.
* @type array
*/
public $levels = array(0 => 'none', 'light', 'medium', 'heavy');
/**
* Default level to place all fixes in.
* Disabled by default.
* @type string
*/
public $defaultLevel = \null;
/**
* Lists of fixes used by getFixesForLevel().
* Format is:
* HTMLModule_Tidy->fixesForLevel[$level] = array('fix-1', 'fix-2');
* @type array
*/
public $fixesForLevel = array('light' => array(), 'medium' => array(), 'heavy' => array());
/**
* Lazy load constructs the module by determining the necessary
* fixes to create and then delegating to the populate() function.
* @param HTMLPurifier_Config $config
* @todo Wildcard matching and error reporting when an added or
* subtracted fix has no effect.
*/
public function setup($config)
{
}
/**
* Retrieves all fixes per a level, returning fixes for that specific
* level as well as all levels below it.
* @param string $level level identifier, see $levels for valid values
* @return array Lookup up table of fixes
*/
public function getFixesForLevel($level)
{
}
/**
* Dynamically populates the $fixesForLevel member variable using
* the fixes array. It may be custom overloaded, used in conjunction
* with $defaultLevel, or not used at all.
* @param array $fixes
*/
public function makeFixesForLevel($fixes)
{
}
/**
* Populates the module with transforms and other special-case code
* based on a list of fixes passed to it
* @param array $fixes Lookup table of fixes to activate
*/
public function populate($fixes)
{
}
/**
* Parses a fix name and determines what kind of fix it is, as well
* as other information defined by the fix
* @param $name String name of fix
* @return array(string $fix_type, array $fix_parameters)
* @note $fix_parameters is type dependant, see populate() for usage
* of these parameters
*/
public function getFixType($name)
{
}
/**
* Defines all fixes the module will perform in a compact
* associative array of fix name to fix implementation.
* @return array
*/
public function makeFixes()
{
}
}
/**
* Module adds the target-based noopener attribute transformation to a tags. It
* is enabled by HTML.TargetNoopener
*/
class HTMLPurifier_HTMLModule_TargetNoopener extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'TargetNoopener';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
class HTMLPurifier_HTMLModule_CommonAttributes extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'CommonAttributes';
/**
* @type array
*/
public $attr_collections = array('Core' => array(
0 => array('Style'),
// 'xml:space' => false,
'class' => 'Class',
'id' => 'ID',
'title' => 'CDATA',
), 'Lang' => array(), 'I18N' => array(0 => array('Lang')), 'Common' => array(0 => array('Core', 'I18N')));
}
/**
* Module defines proprietary tags and attributes in HTML.
* @warning If this module is enabled, standards-compliance is off!
*/
class HTMLPurifier_HTMLModule_Proprietary extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Proprietary';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
class HTMLPurifier_HTMLModule_Tidy_XHTMLAndHTML4 extends \HTMLPurifier_HTMLModule_Tidy
{
/**
* @return array
*/
public function makeFixes()
{
}
}
class HTMLPurifier_HTMLModule_Tidy_Transitional extends \HTMLPurifier_HTMLModule_Tidy_XHTMLAndHTML4
{
/**
* @type string
*/
public $name = 'Tidy_Transitional';
/**
* @type string
*/
public $defaultLevel = 'heavy';
}
/**
* Name is deprecated, but allowed in strict doctypes, so onl
*/
class HTMLPurifier_HTMLModule_Tidy_Name extends \HTMLPurifier_HTMLModule_Tidy
{
/**
* @type string
*/
public $name = 'Tidy_Name';
/**
* @type string
*/
public $defaultLevel = 'heavy';
/**
* @return array
*/
public function makeFixes()
{
}
}
class HTMLPurifier_HTMLModule_Tidy_XHTML extends \HTMLPurifier_HTMLModule_Tidy
{
/**
* @type string
*/
public $name = 'Tidy_XHTML';
/**
* @type string
*/
public $defaultLevel = 'medium';
/**
* @return array
*/
public function makeFixes()
{
}
}
class HTMLPurifier_HTMLModule_Tidy_Strict extends \HTMLPurifier_HTMLModule_Tidy_XHTMLAndHTML4
{
/**
* @type string
*/
public $name = 'Tidy_Strict';
/**
* @type string
*/
public $defaultLevel = 'light';
/**
* @return array
*/
public function makeFixes()
{
}
/**
* @type bool
*/
public $defines_child_def = \true;
/**
* @param HTMLPurifier_ElementDef $def
* @return HTMLPurifier_ChildDef_StrictBlockquote
*/
public function getChildDef($def)
{
}
}
class HTMLPurifier_HTMLModule_Tidy_Proprietary extends \HTMLPurifier_HTMLModule_Tidy
{
/**
* @type string
*/
public $name = 'Tidy_Proprietary';
/**
* @type string
*/
public $defaultLevel = 'light';
/**
* @return array
*/
public function makeFixes()
{
}
}
/**
* Module adds the target-based noreferrer attribute transformation to a tags. It
* is enabled by HTML.TargetNoreferrer
*/
class HTMLPurifier_HTMLModule_TargetNoreferrer extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'TargetNoreferrer';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 Object Module, defines elements for generic object inclusion
* @warning Users will commonly use <embed> to cater to legacy browsers: this
* module does not allow this sort of behavior
*/
class HTMLPurifier_HTMLModule_Object extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Object';
/**
* @type bool
*/
public $safe = \false;
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* XHTML 1.1 Edit Module, defines editing-related elements. Text Extension
* Module.
*/
class HTMLPurifier_HTMLModule_Edit extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Edit';
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
// HTML 4.01 specifies that ins/del must not contain block
// elements when used in an inline context, chameleon is
// a complicated workaround to acheive this effect
// Inline context ! Block context (exclamation mark is
// separator, see getChildDef for parsing)
/**
* @type bool
*/
public $defines_child_def = \true;
/**
* @param HTMLPurifier_ElementDef $def
* @return HTMLPurifier_ChildDef_Chameleon
*/
public function getChildDef($def)
{
}
}
/**
* XHTML 1.1 Iframe Module provides inline frames.
*
* @note This module is not considered safe unless an Iframe
* whitelisting mechanism is specified. Currently, the only
* such mechanism is %URL.SafeIframeRegexp
*/
class HTMLPurifier_HTMLModule_Iframe extends \HTMLPurifier_HTMLModule
{
/**
* @type string
*/
public $name = 'Iframe';
/**
* @type bool
*/
public $safe = \false;
/**
* @param HTMLPurifier_Config $config
*/
public function setup($config)
{
}
}
/**
* Abstract class representing Definition cache managers that implements
* useful common methods and is a factory.
* @todo Create a separate maintenance file advanced users can use to
* cache their custom HTMLDefinition, which can be loaded
* via a configuration directive
* @todo Implement memcached
*/
abstract class HTMLPurifier_DefinitionCache
{
/**
* @type string
*/
public $type;
/**
* @param string $type Type of definition objects this instance of the
* cache will handle.
*/
public function __construct($type)
{
}
/**
* Generates a unique identifier for a particular configuration
* @param HTMLPurifier_Config $config Instance of HTMLPurifier_Config
* @return string
*/
public function generateKey($config)
{
}
/**
* Tests whether or not a key is old with respect to the configuration's
* version and revision number.
* @param string $key Key to test
* @param HTMLPurifier_Config $config Instance of HTMLPurifier_Config to test against
* @return bool
*/
public function isOld($key, $config)
{
}
/**
* Checks if a definition's type jives with the cache's type
* @note Throws an error on failure
* @param HTMLPurifier_Definition $def Definition object to check
* @return bool true if good, false if not
*/
public function checkDefType($def)
{
}
/**
* Adds a definition object to the cache
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
*/
public abstract function add($def, $config);
/**
* Unconditionally saves a definition object to the cache
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
*/
public abstract function set($def, $config);
/**
* Replace an object in the cache
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
*/
public abstract function replace($def, $config);
/**
* Retrieves a definition object from the cache
* @param HTMLPurifier_Config $config
*/
public abstract function get($config);
/**
* Removes a definition object to the cache
* @param HTMLPurifier_Config $config
*/
public abstract function remove($config);
/**
* Clears all objects from cache
* @param HTMLPurifier_Config $config
*/
public abstract function flush($config);
/**
* Clears all expired (older version or revision) objects from cache
* @note Be careful implementing this method as flush. Flush must
* not interfere with other Definition types, and cleanup()
* should not be repeatedly called by userland code.
* @param HTMLPurifier_Config $config
*/
public abstract function cleanup($config);
}
class HTMLPurifier_DefinitionCache_Serializer extends \HTMLPurifier_DefinitionCache
{
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return int|bool
*/
public function add($def, $config)
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return int|bool
*/
public function set($def, $config)
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return int|bool
*/
public function replace($def, $config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return bool|HTMLPurifier_Config
*/
public function get($config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function remove($config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function flush($config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function cleanup($config)
{
}
/**
* Generates the file path to the serial file corresponding to
* the configuration and definition name
* @param HTMLPurifier_Config $config
* @return string
* @todo Make protected
*/
public function generateFilePath($config)
{
}
/**
* Generates the path to the directory contain this cache's serial files
* @param HTMLPurifier_Config $config
* @return string
* @note No trailing slash
* @todo Make protected
*/
public function generateDirectoryPath($config)
{
}
/**
* Generates path to base directory that contains all definition type
* serials
* @param HTMLPurifier_Config $config
* @return mixed|string
* @todo Make protected
*/
public function generateBaseDirectoryPath($config)
{
}
}
/**
* Null cache object to use when no caching is on.
*/
class HTMLPurifier_DefinitionCache_Null extends \HTMLPurifier_DefinitionCache
{
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return bool
*/
public function add($def, $config)
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return bool
*/
public function set($def, $config)
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return bool
*/
public function replace($def, $config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function remove($config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function get($config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function flush($config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return bool
*/
public function cleanup($config)
{
}
}
class HTMLPurifier_DefinitionCache_Decorator extends \HTMLPurifier_DefinitionCache
{
/**
* Cache object we are decorating
* @type HTMLPurifier_DefinitionCache
*/
public $cache;
/**
* The name of the decorator
* @var string
*/
public $name;
public function __construct()
{
}
/**
* Lazy decorator function
* @param HTMLPurifier_DefinitionCache $cache Reference to cache object to decorate
* @return HTMLPurifier_DefinitionCache_Decorator
*/
public function decorate(&$cache)
{
}
/**
* Cross-compatible clone substitute
* @return HTMLPurifier_DefinitionCache_Decorator
*/
public function copy()
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function add($def, $config)
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function set($def, $config)
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function replace($def, $config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function get($config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function remove($config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function flush($config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function cleanup($config)
{
}
}
/**
* Definition cache decorator class that saves all cache retrievals
* to PHP's memory; good for unit tests or circumstances where
* there are lots of configuration objects floating around.
*/
class HTMLPurifier_DefinitionCache_Decorator_Memory extends \HTMLPurifier_DefinitionCache_Decorator
{
/**
* @type array
*/
protected $definitions;
/**
* @type string
*/
public $name = 'Memory';
/**
* @return HTMLPurifier_DefinitionCache_Decorator_Memory
*/
public function copy()
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function add($def, $config)
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function set($def, $config)
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function replace($def, $config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function get($config)
{
}
}
/**
* Definition cache decorator class that cleans up the cache
* whenever there is a cache miss.
*/
class HTMLPurifier_DefinitionCache_Decorator_Cleanup extends \HTMLPurifier_DefinitionCache_Decorator
{
/**
* @type string
*/
public $name = 'Cleanup';
/**
* @return HTMLPurifier_DefinitionCache_Decorator_Cleanup
*/
public function copy()
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function add($def, $config)
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function set($def, $config)
{
}
/**
* @param HTMLPurifier_Definition $def
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function replace($def, $config)
{
}
/**
* @param HTMLPurifier_Config $config
* @return mixed
*/
public function get($config)
{
}
}
/**
* Defines a mutation of an obsolete tag into a valid tag.
*/
abstract class HTMLPurifier_TagTransform
{
/**
* Tag name to transform the tag to.
* @type string
*/
public $transform_to;
/**
* Transforms the obsolete tag into the valid tag.
* @param HTMLPurifier_Token_Tag $tag Tag to be transformed.
* @param HTMLPurifier_Config $config Mandatory HTMLPurifier_Config object
* @param HTMLPurifier_Context $context Mandatory HTMLPurifier_Context object
*/
public abstract function transform($tag, $config, $context);
/**
* Prepends CSS properties to the style attribute, creating the
* attribute if it doesn't exist.
* @warning Copied over from AttrTransform, be sure to keep in sync
* @param array $attr Attribute array to process (passed by reference)
* @param string $css CSS to prepend
*/
protected function prependCSS(&$attr, $css)
{
}
}
/**
* Transforms FONT tags to the proper form (SPAN with CSS styling)
*
* This transformation takes the three proprietary attributes of FONT and
* transforms them into their corresponding CSS attributes. These are color,
* face, and size.
*
* @note Size is an interesting case because it doesn't map cleanly to CSS.
* Thanks to
* http://style.cleverchimp.com/font_size_intervals/altintervals.html
* for reasonable mappings.
* @warning This doesn't work completely correctly; specifically, this
* TagTransform operates before well-formedness is enforced, so
* the "active formatting elements" algorithm doesn't get applied.
*/
class HTMLPurifier_TagTransform_Font extends \HTMLPurifier_TagTransform
{
/**
* @type string
*/
public $transform_to = 'span';
/**
* @type array
*/
protected $_size_lookup = array('0' => 'xx-small', '1' => 'xx-small', '2' => 'small', '3' => 'medium', '4' => 'large', '5' => 'x-large', '6' => 'xx-large', '7' => '300%', '-1' => 'smaller', '-2' => '60%', '+1' => 'larger', '+2' => '150%', '+3' => '200%', '+4' => '300%');
/**
* @param HTMLPurifier_Token_Tag $tag
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return HTMLPurifier_Token_End|string
*/
public function transform($tag, $config, $context)
{
}
}
/**
* Simple transformation, just change tag name to something else,
* and possibly add some styling. This will cover most of the deprecated
* tag cases.
*/
class HTMLPurifier_TagTransform_Simple extends \HTMLPurifier_TagTransform
{
/**
* @type string
*/
protected $style;
/**
* @param string $transform_to Tag name to transform to.
* @param string $style CSS style to add to the tag
*/
public function __construct($transform_to, $style = \null)
{
}
/**
* @param HTMLPurifier_Token_Tag $tag
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
*/
public function transform($tag, $config, $context)
{
}
}
/**
* Error collection class that enables HTML Purifier to report HTML
* problems back to the user
*/
class HTMLPurifier_ErrorCollector
{
/**
* Identifiers for the returned error array. These are purposely numeric
* so list() can be used.
*/
const LINENO = 0;
const SEVERITY = 1;
const MESSAGE = 2;
const CHILDREN = 3;
/**
* @type array
*/
protected $errors;
/**
* @type array
*/
protected $_current;
/**
* @type array
*/
protected $_stacks = array(array());
/**
* @type HTMLPurifier_Language
*/
protected $locale;
/**
* @type HTMLPurifier_Generator
*/
protected $generator;
/**
* @type HTMLPurifier_Context
*/
protected $context;
/**
* @type array
*/
protected $lines = array();
/**
* @param HTMLPurifier_Context $context
*/
public function __construct($context)
{
}
/**
* Sends an error message to the collector for later use
* @param int $severity Error severity, PHP error style (don't use E_USER_)
* @param string $msg Error message text
*/
public function send($severity, $msg)
{
}
/**
* Retrieves raw error data for custom formatter to use
*/
public function getRaw()
{
}
/**
* Default HTML formatting implementation for error messages
* @param HTMLPurifier_Config $config Configuration, vital for HTML output nature
* @param array $errors Errors array to display; used for recursion.
* @return string
*/
public function getHTMLFormatted($config, $errors = \null)
{
}
}
/**
* Concrete text token class.
*
* Text tokens comprise of regular parsed character data (PCDATA) and raw
* character data (from the CDATA sections). Internally, their
* data is parsed with all entities expanded. Surprisingly, the text token
* does have a "tag name" called #PCDATA, which is how the DTD represents it
* in permissible child nodes.
*/
class HTMLPurifier_Node_Text extends \HTMLPurifier_Node
{
/**
* PCDATA tag name compatible with DTD, see
* HTMLPurifier_ChildDef_Custom for details.
* @type string
*/
public $name = '#PCDATA';
/**
* @type string
*/
public $data;
/**< Parsed character data of text. */
/**
* @type bool
*/
public $is_whitespace;
/**< Bool indicating if node is whitespace. */
/**
* Constructor, accepts data and determines if it is whitespace.
* @param string $data String parsed character data.
* @param int $line
* @param int $col
*/
public function __construct($data, $is_whitespace, $line = \null, $col = \null)
{
}
public function toTokenPair()
{
}
}
/**
* Concrete comment node class.
*/
class HTMLPurifier_Node_Comment extends \HTMLPurifier_Node
{
/**
* Character data within comment.
* @type string
*/
public $data;
/**
* @type bool
*/
public $is_whitespace = \true;
/**
* Transparent constructor.
*
* @param string $data String comment data.
* @param int $line
* @param int $col
*/
public function __construct($data, $line = \null, $col = \null)
{
}
public function toTokenPair()
{
}
}
/**
* Concrete element node class.
*/
class HTMLPurifier_Node_Element extends \HTMLPurifier_Node
{
/**
* The lower-case name of the tag, like 'a', 'b' or 'blockquote'.
*
* @note Strictly speaking, XML tags are case sensitive, so we shouldn't
* be lower-casing them, but these tokens cater to HTML tags, which are
* insensitive.
* @type string
*/
public $name;
/**
* Associative array of the node's attributes.
* @type array
*/
public $attr = array();
/**
* List of child elements.
* @type array
*/
public $children = array();
/**
* Does this use the <a></a> form or the </a> form, i.e.
* is it a pair of start/end tokens or an empty token.
* @bool
*/
public $empty = \false;
public $endCol = \null, $endLine = \null, $endArmor = array();
public function __construct($name, $attr = array(), $line = \null, $col = \null, $armor = array())
{
}
public function toTokenPair()
{
}
}
/**
* Registry object that contains information about the current context.
* @warning Is a bit buggy when variables are set to null: it thinks
* they don't exist! So use false instead, please.
* @note Since the variables Context deals with may not be objects,
* references are very important here! Do not remove!
*/
class HTMLPurifier_Context
{
/**
* Registers a variable into the context.
* @param string $name String name
* @param mixed $ref Reference to variable to be registered
*/
public function register($name, &$ref)
{
}
/**
* Retrieves a variable reference from the context.
* @param string $name String name
* @param bool $ignore_error Boolean whether or not to ignore error
* @return mixed
*/
public function &get($name, $ignore_error = \false)
{
}
/**
* Destroys a variable in the context.
* @param string $name String name
*/
public function destroy($name)
{
}
/**
* Checks whether or not the variable exists.
* @param string $name String name
* @return bool
*/
public function exists($name)
{
}
/**
* Loads a series of variables from an associative array
* @param array $context_array Assoc array of variables to load
*/
public function loadArray($context_array)
{
}
}
/**
* Property list iterator. Do not instantiate this class directly.
*/
class HTMLPurifier_PropertyListIterator extends \FilterIterator
{
/**
* @type int
*/
protected $l;
/**
* @type string
*/
protected $filter;
/**
* @param Iterator $iterator Array of data to iterate over
* @param string $filter Optional prefix to only allow values of
*/
public function __construct(\Iterator $iterator, $filter = \null)
{
}
/**
* @return bool
*/
public function accept()
{
}
}
/**
* Records errors for particular segments of an HTML document such as tokens,
* attributes or CSS properties. They can contain error structs (which apply
* to components of what they represent), but their main purpose is to hold
* errors applying to whatever struct is being used.
*/
class HTMLPurifier_ErrorStruct
{
/**
* Possible values for $children first-key. Note that top-level structures
* are automatically token-level.
*/
const TOKEN = 0;
const ATTR = 1;
const CSSPROP = 2;
/**
* Type of this struct.
* @type string
*/
public $type;
/**
* Value of the struct we are recording errors for. There are various
* values for this:
* - TOKEN: Instance of HTMLPurifier_Token
* - ATTR: array('attr-name', 'value')
* - CSSPROP: array('prop-name', 'value')
* @type mixed
*/
public $value;
/**
* Errors registered for this structure.
* @type array
*/
public $errors = array();
/**
* Child ErrorStructs that are from this structure. For example, a TOKEN
* ErrorStruct would contain ATTR ErrorStructs. This is a multi-dimensional
* array in structure: [TYPE]['identifier']
* @type array
*/
public $children = array();
/**
* @param string $type
* @param string $id
* @return mixed
*/
public function getChild($type, $id)
{
}
/**
* @param int $severity
* @param string $message
*/
public function addError($severity, $message)
{
}
}
/**
* Represents a pre or post processing filter on HTML Purifier's output
*
* Sometimes, a little ad-hoc fixing of HTML has to be done before
* it gets sent through HTML Purifier: you can use filters to acheive
* this effect. For instance, YouTube videos can be preserved using
* this manner. You could have used a decorator for this task, but
* PHP's support for them is not terribly robust, so we're going
* to just loop through the filters.
*
* Filters should be exited first in, last out. If there are three filters,
* named 1, 2 and 3, the order of execution should go 1->preFilter,
* 2->preFilter, 3->preFilter, purify, 3->postFilter, 2->postFilter,
* 1->postFilter.
*
* @note Methods are not declared abstract as it is perfectly legitimate
* for an implementation not to want anything to happen on a step
*/
class HTMLPurifier_Filter
{
/**
* Name of the filter for identification purposes.
* @type string
*/
public $name;
/**
* Pre-processor function, handles HTML before HTML Purifier
* @param string $html
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
*/
public function preFilter($html, $config, $context)
{
}
/**
* Post-processor function, handles HTML after HTML Purifier
* @param string $html
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
*/
public function postFilter($html, $config, $context)
{
}
}
class HTMLPurifier_ConfigSchema_InterchangeBuilder
{
/**
* Used for processing DEFAULT, nothing else.
* @type HTMLPurifier_VarParser
*/
protected $varParser;
/**
* @param HTMLPurifier_VarParser $varParser
*/
public function __construct($varParser = \null)
{
}
/**
* @param string $dir
* @return HTMLPurifier_ConfigSchema_Interchange
*/
public static function buildFromDirectory($dir = \null)
{
}
/**
* @param HTMLPurifier_ConfigSchema_Interchange $interchange
* @param string $dir
* @return HTMLPurifier_ConfigSchema_Interchange
*/
public function buildDir($interchange, $dir = \null)
{
}
/**
* @param HTMLPurifier_ConfigSchema_Interchange $interchange
* @param string $file
*/
public function buildFile($interchange, $file)
{
}
/**
* Builds an interchange object based on a hash.
* @param HTMLPurifier_ConfigSchema_Interchange $interchange HTMLPurifier_ConfigSchema_Interchange object to build
* @param HTMLPurifier_StringHash $hash source data
* @throws HTMLPurifier_ConfigSchema_Exception
*/
public function build($interchange, $hash)
{
}
/**
* @param HTMLPurifier_ConfigSchema_Interchange $interchange
* @param HTMLPurifier_StringHash $hash
* @throws HTMLPurifier_ConfigSchema_Exception
*/
public function buildDirective($interchange, $hash)
{
}
/**
* Evaluates an array PHP code string without array() wrapper
* @param string $contents
*/
protected function evalArray($contents)
{
}
/**
* Converts an array list into a lookup array.
* @param array $array
* @return array
*/
protected function lookup($array)
{
}
/**
* Convenience function that creates an HTMLPurifier_ConfigSchema_Interchange_Id
* object based on a string Id.
* @param string $id
* @return HTMLPurifier_ConfigSchema_Interchange_Id
*/
protected function id($id)
{
}
/**
* Triggers errors for any unused keys passed in the hash; such keys
* may indicate typos, missing values, etc.
* @param HTMLPurifier_StringHash $hash Hash to check.
*/
protected function _findUnused($hash)
{
}
}
/**
* Exceptions related to configuration schema
*/
class HTMLPurifier_ConfigSchema_Exception extends \HTMLPurifier_Exception
{
}
/**
* Converts HTMLPurifier_ConfigSchema_Interchange to an XML format,
* which can be further processed to generate documentation.
*/
class HTMLPurifier_ConfigSchema_Builder_Xml extends \XMLWriter
{
/**
* @type HTMLPurifier_ConfigSchema_Interchange
*/
protected $interchange;
/**
* @param string $html
*/
protected function writeHTMLDiv($html)
{
}
/**
* @param mixed $var
* @return string
*/
protected function export($var)
{
}
/**
* @param HTMLPurifier_ConfigSchema_Interchange $interchange
*/
public function build($interchange)
{
}
/**
* @param HTMLPurifier_ConfigSchema_Interchange_Directive $directive
*/
public function buildDirective($directive)
{
}
}
/**
* Converts HTMLPurifier_ConfigSchema_Interchange to our runtime
* representation used to perform checks on user configuration.
*/
class HTMLPurifier_ConfigSchema_Builder_ConfigSchema
{
/**
* @param HTMLPurifier_ConfigSchema_Interchange $interchange
* @return HTMLPurifier_ConfigSchema
*/
public function build($interchange)
{
}
}
/**
* Generic schema interchange format that can be converted to a runtime
* representation (HTMLPurifier_ConfigSchema) or HTML documentation. Members
* are completely validated.
*/
class HTMLPurifier_ConfigSchema_Interchange
{
/**
* Name of the application this schema is describing.
* @type string
*/
public $name;
/**
* Array of Directive ID => array(directive info)
* @type HTMLPurifier_ConfigSchema_Interchange_Directive[]
*/
public $directives = array();
/**
* Adds a directive array to $directives
* @param HTMLPurifier_ConfigSchema_Interchange_Directive $directive
* @throws HTMLPurifier_ConfigSchema_Exception
*/
public function addDirective($directive)
{
}
/**
* Convenience function to perform standard validation. Throws exception
* on failed validation.
*/
public function validate()
{
}
}
/**
* Fluent interface for validating the contents of member variables.
* This should be immutable. See HTMLPurifier_ConfigSchema_Validator for
* use-cases. We name this an 'atom' because it's ONLY for validations that
* are independent and usually scalar.
*/
class HTMLPurifier_ConfigSchema_ValidatorAtom
{
/**
* @type string
*/
protected $context;
/**
* @type object
*/
protected $obj;
/**
* @type string
*/
protected $member;
/**
* @type mixed
*/
protected $contents;
public function __construct($context, $obj, $member)
{
}
/**
* @return HTMLPurifier_ConfigSchema_ValidatorAtom
*/
public function assertIsString()
{
}
/**
* @return HTMLPurifier_ConfigSchema_ValidatorAtom
*/
public function assertIsBool()
{
}
/**
* @return HTMLPurifier_ConfigSchema_ValidatorAtom
*/
public function assertIsArray()
{
}
/**
* @return HTMLPurifier_ConfigSchema_ValidatorAtom
*/
public function assertNotNull()
{
}
/**
* @return HTMLPurifier_ConfigSchema_ValidatorAtom
*/
public function assertAlnum()
{
}
/**
* @return HTMLPurifier_ConfigSchema_ValidatorAtom
*/
public function assertNotEmpty()
{
}
/**
* @return HTMLPurifier_ConfigSchema_ValidatorAtom
*/
public function assertIsLookup()
{
}
/**
* @param string $msg
* @throws HTMLPurifier_ConfigSchema_Exception
*/
protected function error($msg)
{
}
}
/**
* Interchange component class describing configuration directives.
*/
class HTMLPurifier_ConfigSchema_Interchange_Directive
{
/**
* ID of directive.
* @type HTMLPurifier_ConfigSchema_Interchange_Id
*/
public $id;
/**
* Type, e.g. 'integer' or 'istring'.
* @type string
*/
public $type;
/**
* Default value, e.g. 3 or 'DefaultVal'.
* @type mixed
*/
public $default;
/**
* HTML description.
* @type string
*/
public $description;
/**
* Whether or not null is allowed as a value.
* @type bool
*/
public $typeAllowsNull = \false;
/**
* Lookup table of allowed scalar values.
* e.g. array('allowed' => true).
* Null if all values are allowed.
* @type array
*/
public $allowed;
/**
* List of aliases for the directive.
* e.g. array(new HTMLPurifier_ConfigSchema_Interchange_Id('Ns', 'Dir'))).
* @type HTMLPurifier_ConfigSchema_Interchange_Id[]
*/
public $aliases = array();
/**
* Hash of value aliases, e.g. array('alt' => 'real'). Null if value
* aliasing is disabled (necessary for non-scalar types).
* @type array
*/
public $valueAliases;
/**
* Version of HTML Purifier the directive was introduced, e.g. '1.3.1'.
* Null if the directive has always existed.
* @type string
*/
public $version;
/**
* ID of directive that supercedes this old directive.
* Null if not deprecated.
* @type HTMLPurifier_ConfigSchema_Interchange_Id
*/
public $deprecatedUse;
/**
* Version of HTML Purifier this directive was deprecated. Null if not
* deprecated.
* @type string
*/
public $deprecatedVersion;
/**
* List of external projects this directive depends on, e.g. array('CSSTidy').
* @type array
*/
public $external = array();
}
/**
* Represents a directive ID in the interchange format.
*/
class HTMLPurifier_ConfigSchema_Interchange_Id
{
/**
* @type string
*/
public $key;
/**
* @param string $key
*/
public function __construct($key)
{
}
/**
* @return string
* @warning This is NOT magic, to ensure that people don't abuse SPL and
* cause problems for PHP 5.0 support.
*/
public function toString()
{
}
/**
* @return string
*/
public function getRootNamespace()
{
}
/**
* @return string
*/
public function getDirective()
{
}
/**
* @param string $id
* @return HTMLPurifier_ConfigSchema_Interchange_Id
*/
public static function make($id)
{
}
}
/**
* Performs validations on HTMLPurifier_ConfigSchema_Interchange
*
* @note If you see '// handled by InterchangeBuilder', that means a
* design decision in that class would prevent this validation from
* ever being necessary. We have them anyway, however, for
* redundancy.
*/
class HTMLPurifier_ConfigSchema_Validator
{
/**
* @type HTMLPurifier_ConfigSchema_Interchange
*/
protected $interchange;
/**
* @type array
*/
protected $aliases;
/**
* Context-stack to provide easy to read error messages.
* @type array
*/
protected $context = array();
/**
* to test default's type.
* @type HTMLPurifier_VarParser
*/
protected $parser;
public function __construct()
{
}
/**
* Validates a fully-formed interchange object.
* @param HTMLPurifier_ConfigSchema_Interchange $interchange
* @return bool
*/
public function validate($interchange)
{
}
/**
* Validates a HTMLPurifier_ConfigSchema_Interchange_Id object.
* @param HTMLPurifier_ConfigSchema_Interchange_Id $id
*/
public function validateId($id)
{
}
/**
* Validates a HTMLPurifier_ConfigSchema_Interchange_Directive object.
* @param HTMLPurifier_ConfigSchema_Interchange_Directive $d
*/
public function validateDirective($d)
{
}
/**
* Extra validation if $allowed member variable of
* HTMLPurifier_ConfigSchema_Interchange_Directive is defined.
* @param HTMLPurifier_ConfigSchema_Interchange_Directive $d
*/
public function validateDirectiveAllowed($d)
{
}
/**
* Extra validation if $valueAliases member variable of
* HTMLPurifier_ConfigSchema_Interchange_Directive is defined.
* @param HTMLPurifier_ConfigSchema_Interchange_Directive $d
*/
public function validateDirectiveValueAliases($d)
{
}
/**
* Extra validation if $aliases member variable of
* HTMLPurifier_ConfigSchema_Interchange_Directive is defined.
* @param HTMLPurifier_ConfigSchema_Interchange_Directive $d
*/
public function validateDirectiveAliases($d)
{
}
// protected helper functions
/**
* Convenience function for generating HTMLPurifier_ConfigSchema_ValidatorAtom
* for validating simple member variables of objects.
* @param $obj
* @param $member
* @return HTMLPurifier_ConfigSchema_ValidatorAtom
*/
protected function with($obj, $member)
{
}
/**
* Emits an error, providing helpful context.
* @throws HTMLPurifier_ConfigSchema_Exception
*/
protected function error($target, $msg)
{
}
/**
* Returns a formatted context string.
* @return string
*/
protected function getFormattedContext()
{
}
}
/**
* A simple array-backed queue, based off of the classic Okasaki
* persistent amortized queue. The basic idea is to maintain two
* stacks: an input stack and an output stack. When the output
* stack runs out, reverse the input stack and use it as the output
* stack.
*
* We don't use the SPL implementation because it's only supported
* on PHP 5.3 and later.
*
* Exercise: Prove that push/pop on this queue take amortized O(1) time.
*
* Exercise: Extend this queue to be a deque, while preserving amortized
* O(1) time. Some care must be taken on rebalancing to avoid quadratic
* behaviour caused by repeatedly shuffling data from the input stack
* to the output stack and back.
*/
class HTMLPurifier_Queue
{
public function __construct($input = array())
{
}
/**
* Shifts an element off the front of the queue.
*/
public function shift()
{
}
/**
* Pushes an element onto the front of the queue.
*/
public function push($x)
{
}
/**
* Checks if it's empty.
*/
public function isEmpty()
{
}
}
/**
* Validator for the components of a URI for a specific scheme
*/
abstract class HTMLPurifier_URIScheme
{
/**
* Scheme's default port (integer). If an explicit port number is
* specified that coincides with the default port, it will be
* elided.
* @type int
*/
public $default_port = \null;
/**
* Whether or not URIs of this scheme are locatable by a browser
* http and ftp are accessible, while mailto and news are not.
* @type bool
*/
public $browsable = \false;
/**
* Whether or not data transmitted over this scheme is encrypted.
* https is secure, http is not.
* @type bool
*/
public $secure = \false;
/**
* Whether or not the URI always uses <hier_part>, resolves edge cases
* with making relative URIs absolute
* @type bool
*/
public $hierarchical = \false;
/**
* Whether or not the URI may omit a hostname when the scheme is
* explicitly specified, ala file:///path/to/file. As of writing,
* 'file' is the only scheme that browsers support his properly.
* @type bool
*/
public $may_omit_host = \false;
/**
* Validates the components of a URI for a specific scheme.
* @param HTMLPurifier_URI $uri Reference to a HTMLPurifier_URI object
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool success or failure
*/
public abstract function doValidate(&$uri, $config, $context);
/**
* Public interface for validating components of a URI. Performs a
* bunch of default actions. Don't overload this method.
* @param HTMLPurifier_URI $uri Reference to a HTMLPurifier_URI object
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool success or failure
*/
public function validate(&$uri, $config, $context)
{
}
}
/**
* Generates HTML from tokens.
* @todo Refactor interface so that configuration/context is determined
* upon instantiation, no need for messy generateFromTokens() calls
* @todo Make some of the more internal functions protected, and have
* unit tests work around that
*/
class HTMLPurifier_Generator
{
/**
* Configuration for the generator
* @type HTMLPurifier_Config
*/
protected $config;
/**
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
*/
public function __construct($config, $context)
{
}
/**
* Generates HTML from an array of tokens.
* @param HTMLPurifier_Token[] $tokens Array of HTMLPurifier_Token
* @return string Generated HTML
*/
public function generateFromTokens($tokens)
{
}
/**
* Generates HTML from a single token.
* @param HTMLPurifier_Token $token HTMLPurifier_Token object.
* @return string Generated HTML
*/
public function generateFromToken($token)
{
}
/**
* Special case processor for the contents of script tags
* @param HTMLPurifier_Token $token HTMLPurifier_Token object.
* @return string
* @warning This runs into problems if there's already a literal
* --> somewhere inside the script contents.
*/
public function generateScriptFromToken($token)
{
}
/**
* Generates attribute declarations from attribute array.
* @note This does not include the leading or trailing space.
* @param array $assoc_array_of_attributes Attribute array
* @param string $element Name of element attributes are for, used to check
* attribute minimization.
* @return string Generated HTML fragment for insertion.
*/
public function generateAttributes($assoc_array_of_attributes, $element = '')
{
}
/**
* Escapes raw text data.
* @todo This really ought to be protected, but until we have a facility
* for properly generating HTML here w/o using tokens, it stays
* public.
* @param string $string String data to escape for HTML.
* @param int $quote Quoting style, like htmlspecialchars. ENT_NOQUOTES is
* permissible for non-attribute output.
* @return string escaped data.
*/
public function escape($string, $quote = \null)
{
}
}
class HTMLPurifier_URIDefinition extends \HTMLPurifier_Definition
{
public $type = 'URI';
protected $filters = array();
protected $postFilters = array();
protected $registeredFilters = array();
/**
* HTMLPurifier_URI object of the base specified at %URI.Base
*/
public $base;
/**
* String host to consider "home" base, derived off of $base
*/
public $host;
/**
* Name of default scheme based on %URI.DefaultScheme and %URI.Base
*/
public $defaultScheme;
public function __construct()
{
}
public function registerFilter($filter)
{
}
public function addFilter($filter, $config)
{
}
protected function doSetup($config)
{
}
protected function setupFilters($config)
{
}
protected function setupMemberVariables($config)
{
}
public function getDefaultScheme($config, $context)
{
}
public function filter(&$uri, $config, $context)
{
}
public function postFilter(&$uri, $config, $context)
{
}
}
/**
* Represents a language and defines localizable string formatting and
* other functions, as well as the localized messages for HTML Purifier.
*/
class HTMLPurifier_Language
{
/**
* ISO 639 language code of language. Prefers shortest possible version.
* @type string
*/
public $code = 'en';
/**
* Fallback language code.
* @type bool|string
*/
public $fallback = \false;
/**
* Array of localizable messages.
* @type array
*/
public $messages = array();
/**
* Array of localizable error codes.
* @type array
*/
public $errorNames = array();
/**
* True if no message file was found for this language, so English
* is being used instead. Check this if you'd like to notify the
* user that they've used a non-supported language.
* @type bool
*/
public $error = \false;
/**
* Has the language object been loaded yet?
* @type bool
* @todo Make it private, fix usage in HTMLPurifier_LanguageTest
*/
public $_loaded = \false;
/**
* @type HTMLPurifier_Config
*/
protected $config;
/**
* @type HTMLPurifier_Context
*/
protected $context;
/**
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
*/
public function __construct($config, $context)
{
}
/**
* Loads language object with necessary info from factory cache
* @note This is a lazy loader
*/
public function load()
{
}
/**
* Retrieves a localised message.
* @param string $key string identifier of message
* @return string localised message
*/
public function getMessage($key)
{
}
/**
* Retrieves a localised error name.
* @param int $int error number, corresponding to PHP's error reporting
* @return string localised message
*/
public function getErrorName($int)
{
}
/**
* Converts an array list into a string readable representation
* @param array $array
* @return string
*/
public function listify($array)
{
}
/**
* Formats a localised message with passed parameters
* @param string $key string identifier of message
* @param array $args Parameters to substitute in
* @return string localised message
* @todo Implement conditionals? Right now, some messages make
* reference to line numbers, but those aren't always available
*/
public function formatMessage($key, $args = array())
{
}
}
/**
* Generic property list implementation
*/
class HTMLPurifier_PropertyList
{
/**
* Internal data-structure for properties.
* @type array
*/
protected $data = array();
/**
* Parent plist.
* @type HTMLPurifier_PropertyList
*/
protected $parent;
/**
* Cache.
* @type array
*/
protected $cache;
/**
* @param HTMLPurifier_PropertyList $parent Parent plist
*/
public function __construct($parent = \null)
{
}
/**
* Recursively retrieves the value for a key
* @param string $name
* @throws HTMLPurifier_Exception
*/
public function get($name)
{
}
/**
* Sets the value of a key, for this plist
* @param string $name
* @param mixed $value
*/
public function set($name, $value)
{
}
/**
* Returns true if a given key exists
* @param string $name
* @return bool
*/
public function has($name)
{
}
/**
* Resets a value to the value of it's parent, usually the default. If
* no value is specified, the entire plist is reset.
* @param string $name
*/
public function reset($name = \null)
{
}
/**
* Squashes this property list and all of its property lists into a single
* array, and returns the array. This value is cached by default.
* @param bool $force If true, ignores the cache and regenerates the array.
* @return array
*/
public function squash($force = \false)
{
}
/**
* Returns the parent plist.
* @return HTMLPurifier_PropertyList
*/
public function getParent()
{
}
/**
* Sets the parent plist.
* @param HTMLPurifier_PropertyList $plist Parent plist
*/
public function setParent($plist)
{
}
}
/**
* Abstract base token class that all others inherit from.
*/
abstract class HTMLPurifier_Token
{
/**
* Line number node was on in source document. Null if unknown.
* @type int
*/
public $line;
/**
* Column of line node was on in source document. Null if unknown.
* @type int
*/
public $col;
/**
* Lookup array of processing that this token is exempt from.
* Currently, valid values are "ValidateAttributes" and
* "MakeWellFormed_TagClosedError"
* @type array
*/
public $armor = array();
/**
* Used during MakeWellFormed. See Note [Injector skips]
* @type
*/
public $skip;
/**
* @type
*/
public $rewind;
/**
* @type
*/
public $carryover;
/**
* @param string $n
* @return null|string
*/
public function __get($n)
{
}
/**
* Sets the position of the token in the source document.
* @param int $l
* @param int $c
*/
public function position($l = \null, $c = \null)
{
}
/**
* Convenience function for DirectLex settings line/col position.
* @param int $l
* @param int $c
*/
public function rawPosition($l, $c)
{
}
/**
* Converts a token into its corresponding node.
*/
public abstract function toNode();
}
/**
* Concrete text token class.
*
* Text tokens comprise of regular parsed character data (PCDATA) and raw
* character data (from the CDATA sections). Internally, their
* data is parsed with all entities expanded. Surprisingly, the text token
* does have a "tag name" called #PCDATA, which is how the DTD represents it
* in permissible child nodes.
*/
class HTMLPurifier_Token_Text extends \HTMLPurifier_Token
{
/**
* @type string
*/
public $name = '#PCDATA';
/**< PCDATA tag name compatible with DTD. */
/**
* @type string
*/
public $data;
/**< Parsed character data of text. */
/**
* @type bool
*/
public $is_whitespace;
/**< Bool indicating if node is whitespace. */
/**
* Constructor, accepts data and determines if it is whitespace.
* @param string $data String parsed character data.
* @param int $line
* @param int $col
*/
public function __construct($data, $line = \null, $col = \null)
{
}
public function toNode()
{
}
}
/**
* Concrete comment token class. Generally will be ignored.
*/
class HTMLPurifier_Token_Comment extends \HTMLPurifier_Token
{
/**
* Character data within comment.
* @type string
*/
public $data;
/**
* @type bool
*/
public $is_whitespace = \true;
/**
* Transparent constructor.
*
* @param string $data String comment data.
* @param int $line
* @param int $col
*/
public function __construct($data, $line = \null, $col = \null)
{
}
public function toNode()
{
}
}
/**
* Abstract class of a tag token (start, end or empty), and its behavior.
*/
abstract class HTMLPurifier_Token_Tag extends \HTMLPurifier_Token
{
/**
* Static bool marker that indicates the class is a tag.
*
* This allows us to check objects with <tt>!empty($obj->is_tag)</tt>
* without having to use a function call <tt>is_a()</tt>.
* @type bool
*/
public $is_tag = \true;
/**
* The lower-case name of the tag, like 'a', 'b' or 'blockquote'.
*
* @note Strictly speaking, XML tags are case sensitive, so we shouldn't
* be lower-casing them, but these tokens cater to HTML tags, which are
* insensitive.
* @type string
*/
public $name;
/**
* Associative array of the tag's attributes.
* @type array
*/
public $attr = array();
/**
* Non-overloaded constructor, which lower-cases passed tag name.
*
* @param string $name String name.
* @param array $attr Associative array of attributes.
* @param int $line
* @param int $col
* @param array $armor
*/
public function __construct($name, $attr = array(), $line = \null, $col = \null, $armor = array())
{
}
public function toNode()
{
}
}
/**
* Concrete start token class.
*/
class HTMLPurifier_Token_Start extends \HTMLPurifier_Token_Tag
{
}
/**
* Concrete empty token class.
*/
class HTMLPurifier_Token_Empty extends \HTMLPurifier_Token_Tag
{
public function toNode()
{
}
}
/**
* Concrete end token class.
*
* @warning This class accepts attributes even though end tags cannot. This
* is for optimization reasons, as under normal circumstances, the Lexers
* do not pass attributes.
*/
class HTMLPurifier_Token_End extends \HTMLPurifier_Token_Tag
{
/**
* Token that started this node.
* Added by MakeWellFormed. Please do not edit this!
* @type HTMLPurifier_Token
*/
public $start;
public function toNode()
{
}
}
/**
* Defines allowed CSS attributes and what their values are.
* @see HTMLPurifier_HTMLDefinition
*/
class HTMLPurifier_CSSDefinition extends \HTMLPurifier_Definition
{
public $type = 'CSS';
/**
* Assoc array of attribute name to definition object.
* @type HTMLPurifier_AttrDef[]
*/
public $info = array();
/**
* Constructs the info array. The meat of this class.
* @param HTMLPurifier_Config $config
*/
protected function doSetup($config)
{
}
/**
* @param HTMLPurifier_Config $config
*/
protected function doSetupProprietary($config)
{
}
/**
* @param HTMLPurifier_Config $config
*/
protected function doSetupTricky($config)
{
}
/**
* @param HTMLPurifier_Config $config
*/
protected function doSetupTrusted($config)
{
}
/**
* Performs extra config-based processing. Based off of
* HTMLPurifier_HTMLDefinition.
* @param HTMLPurifier_Config $config
* @todo Refactor duplicate elements into common class (probably using
* composition, not inheritance).
*/
protected function setupConfigStuff($config)
{
}
}
/**
* Defines allowed child nodes and validates nodes against it.
*/
abstract class HTMLPurifier_ChildDef
{
/**
* Type of child definition, usually right-most part of class name lowercase.
* Used occasionally in terms of context.
* @type string
*/
public $type;
/**
* Indicates whether or not an empty array of children is okay.
*
* This is necessary for redundant checking when changes affecting
* a child node may cause a parent node to now be disallowed.
* @type bool
*/
public $allow_empty;
/**
* Lookup array of all elements that this definition could possibly allow.
* @type array
*/
public $elements = array();
/**
* Get lookup of tag names that should not close this element automatically.
* All other elements will do so.
* @param HTMLPurifier_Config $config HTMLPurifier_Config object
* @return array
*/
public function getAllowedElements($config)
{
}
/**
* Validates nodes according to definition and returns modification.
*
* @param HTMLPurifier_Node[] $children Array of HTMLPurifier_Node
* @param HTMLPurifier_Config $config HTMLPurifier_Config object
* @param HTMLPurifier_Context $context HTMLPurifier_Context object
* @return bool|array true to leave nodes as is, false to remove parent node, array of replacement children
*/
public abstract function validateChildren($children, $config, $context);
}
/**
* Definition that allows a set of elements, but disallows empty children.
*/
class HTMLPurifier_ChildDef_Required extends \HTMLPurifier_ChildDef
{
/**
* Lookup table of allowed elements.
* @type array
*/
public $elements = array();
/**
* Whether or not the last passed node was all whitespace.
* @type bool
*/
protected $whitespace = \false;
/**
* @param array|string $elements List of allowed element names (lowercase).
*/
public function __construct($elements)
{
}
/**
* @type bool
*/
public $allow_empty = \false;
/**
* @type string
*/
public $type = 'required';
/**
* @param array $children
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function validateChildren($children, $config, $context)
{
}
}
/**
* Definition for tables. The general idea is to extract out all of the
* essential bits, and then reconstruct it later.
*
* This is a bit confusing, because the DTDs and the W3C
* validators seem to disagree on the appropriate definition. The
* DTD claims:
*
* (CAPTION?, (COL*|COLGROUP*), THEAD?, TFOOT?, TBODY+)
*
* But actually, the HTML4 spec then has this to say:
*
* The TBODY start tag is always required except when the table
* contains only one table body and no table head or foot sections.
* The TBODY end tag may always be safely omitted.
*
* So the DTD is kind of wrong. The validator is, unfortunately, kind
* of on crack.
*
* The definition changed again in XHTML1.1; and in my opinion, this
* formulation makes the most sense.
*
* caption?, ( col* | colgroup* ), (( thead?, tfoot?, tbody+ ) | ( tr+ ))
*
* Essentially, we have two modes: thead/tfoot/tbody mode, and tr mode.
* If we encounter a thead, tfoot or tbody, we are placed in the former
* mode, and we *must* wrap any stray tr segments with a tbody. But if
* we don't run into any of them, just have tr tags is OK.
*/
class HTMLPurifier_ChildDef_Table extends \HTMLPurifier_ChildDef
{
/**
* @type bool
*/
public $allow_empty = \false;
/**
* @type string
*/
public $type = 'table';
/**
* @type array
*/
public $elements = array('tr' => \true, 'tbody' => \true, 'thead' => \true, 'tfoot' => \true, 'caption' => \true, 'colgroup' => \true, 'col' => \true);
public function __construct()
{
}
/**
* @param array $children
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function validateChildren($children, $config, $context)
{
}
}
/**
* Definition that uses different definitions depending on context.
*
* The del and ins tags are notable because they allow different types of
* elements depending on whether or not they're in a block or inline context.
* Chameleon allows this behavior to happen by using two different
* definitions depending on context. While this somewhat generalized,
* it is specifically intended for those two tags.
*/
class HTMLPurifier_ChildDef_Chameleon extends \HTMLPurifier_ChildDef
{
/**
* Instance of the definition object to use when inline. Usually stricter.
* @type HTMLPurifier_ChildDef_Optional
*/
public $inline;
/**
* Instance of the definition object to use when block.
* @type HTMLPurifier_ChildDef_Optional
*/
public $block;
/**
* @type string
*/
public $type = 'chameleon';
/**
* @param array $inline List of elements to allow when inline.
* @param array $block List of elements to allow when block.
*/
public function __construct($inline, $block)
{
}
/**
* @param HTMLPurifier_Node[] $children
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function validateChildren($children, $config, $context)
{
}
}
/**
* Definition for list containers ul and ol.
*
* What does this do? The big thing is to handle ol/ul at the top
* level of list nodes, which should be handled specially by /folding/
* them into the previous list node. We generally shouldn't ever
* see other disallowed elements, because the autoclose behavior
* in MakeWellFormed handles it.
*/
class HTMLPurifier_ChildDef_List extends \HTMLPurifier_ChildDef
{
/**
* @type string
*/
public $type = 'list';
/**
* @type array
*/
// lying a little bit, so that we can handle ul and ol ourselves
// XXX: This whole business with 'wrap' is all a bit unsatisfactory
public $elements = array('li' => \true, 'ul' => \true, 'ol' => \true);
/**
* @param array $children
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function validateChildren($children, $config, $context)
{
}
}
/**
* Definition that allows a set of elements, and allows no children.
* @note This is a hack to reuse code from HTMLPurifier_ChildDef_Required,
* really, one shouldn't inherit from the other. Only altered behavior
* is to overload a returned false with an array. Thus, it will never
* return false.
*/
class HTMLPurifier_ChildDef_Optional extends \HTMLPurifier_ChildDef_Required
{
/**
* @type bool
*/
public $allow_empty = \true;
/**
* @type string
*/
public $type = 'optional';
/**
* @param array $children
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function validateChildren($children, $config, $context)
{
}
}
/**
* Definition that disallows all elements.
* @warning validateChildren() in this class is actually never called, because
* empty elements are corrected in HTMLPurifier_Strategy_MakeWellFormed
* before child definitions are parsed in earnest by
* HTMLPurifier_Strategy_FixNesting.
*/
class HTMLPurifier_ChildDef_Empty extends \HTMLPurifier_ChildDef
{
/**
* @type bool
*/
public $allow_empty = \true;
/**
* @type string
*/
public $type = 'empty';
public function __construct()
{
}
/**
* @param HTMLPurifier_Node[] $children
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function validateChildren($children, $config, $context)
{
}
}
/**
* Custom validation class, accepts DTD child definitions
*
* @warning Currently this class is an all or nothing proposition, that is,
* it will only give a bool return value.
*/
class HTMLPurifier_ChildDef_Custom extends \HTMLPurifier_ChildDef
{
/**
* @type string
*/
public $type = 'custom';
/**
* @type bool
*/
public $allow_empty = \false;
/**
* Allowed child pattern as defined by the DTD.
* @type string
*/
public $dtd_regex;
/**
* @param $dtd_regex Allowed child pattern from the DTD
*/
public function __construct($dtd_regex)
{
}
/**
* Compiles the PCRE regex from a DTD regex ($dtd_regex to $_pcre_regex)
*/
protected function _compileRegex()
{
}
/**
* @param HTMLPurifier_Node[] $children
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function validateChildren($children, $config, $context)
{
}
}
/**
* Takes the contents of blockquote when in strict and reformats for validation.
*/
class HTMLPurifier_ChildDef_StrictBlockquote extends \HTMLPurifier_ChildDef_Required
{
/**
* @type array
*/
protected $real_elements;
/**
* @type array
*/
protected $fake_elements;
/**
* @type bool
*/
public $allow_empty = \true;
/**
* @type string
*/
public $type = 'strictblockquote';
/**
* @type bool
*/
protected $init = \false;
/**
* @param HTMLPurifier_Config $config
* @return array
* @note We don't want MakeWellFormed to auto-close inline elements since
* they might be allowed.
*/
public function getAllowedElements($config)
{
}
/**
* @param array $children
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
public function validateChildren($children, $config, $context)
{
}
}
/**
* Class responsible for generating HTMLPurifier_Language objects, managing
* caching and fallbacks.
* @note Thanks to MediaWiki for the general logic, although this version
* has been entirely rewritten
* @todo Serialized cache for languages
*/
class HTMLPurifier_LanguageFactory
{
/**
* Cache of language code information used to load HTMLPurifier_Language objects.
* Structure is: $factory->cache[$language_code][$key] = $value
* @type array
*/
public $cache;
/**
* Valid keys in the HTMLPurifier_Language object. Designates which
* variables to slurp out of a message file.
* @type array
*/
public $keys = array('fallback', 'messages', 'errorNames');
/**
* Instance to validate language codes.
* @type HTMLPurifier_AttrDef_Lang
*
*/
protected $validator;
/**
* Cached copy of dirname(__FILE__), directory of current file without
* trailing slash.
* @type string
*/
protected $dir;
/**
* Keys whose contents are a hash map and can be merged.
* @type array
*/
protected $mergeable_keys_map = array('messages' => \true, 'errorNames' => \true);
/**
* Keys whose contents are a list and can be merged.
* @value array lookup
*/
protected $mergeable_keys_list = array();
/**
* Retrieve sole instance of the factory.
* @param HTMLPurifier_LanguageFactory $prototype Optional prototype to overload sole instance with,
* or bool true to reset to default factory.
* @return HTMLPurifier_LanguageFactory
*/
public static function instance($prototype = \null)
{
}
/**
* Sets up the singleton, much like a constructor
* @note Prevents people from getting this outside of the singleton
*/
public function setup()
{
}
/**
* Creates a language object, handles class fallbacks
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @param bool|string $code Code to override configuration with. Private parameter.
* @return HTMLPurifier_Language
*/
public function create($config, $context, $code = \false)
{
}
/**
* Returns the fallback language for language
* @note Loads the original language into cache
* @param string $code language code
* @return string|bool
*/
public function getFallbackFor($code)
{
}
/**
* Loads language into the cache, handles message file and fallbacks
* @param string $code language code
*/
public function loadLanguage($code)
{
}
}
/**
* Parses a URI into the components and fragment identifier as specified
* by RFC 3986.
*/
class HTMLPurifier_URIParser
{
/**
* Instance of HTMLPurifier_PercentEncoder to do normalization with.
*/
protected $percentEncoder;
public function __construct()
{
}
/**
* Parses a URI.
* @param $uri string URI to parse
* @return HTMLPurifier_URI representation of URI. This representation has
* not been validated yet and may not conform to RFC.
*/
public function parse($uri)
{
}
}
class HTMLPurifier_Filter_YouTube extends \HTMLPurifier_Filter
{
/**
* @type string
*/
public $name = 'YouTube';
/**
* @param string $html
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
*/
public function preFilter($html, $config, $context)
{
}
/**
* @param string $html
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
*/
public function postFilter($html, $config, $context)
{
}
/**
* @param $url
* @return string
*/
protected function armorUrl($url)
{
}
/**
* @param array $matches
* @return string
*/
protected function postFilterCallback($matches)
{
}
}
/**
* This filter extracts <style> blocks from input HTML, cleans them up
* using CSSTidy, and then places them in $purifier->context->get('StyleBlocks')
* so they can be used elsewhere in the document.
*
* @note
* See tests/HTMLPurifier/Filter/ExtractStyleBlocksTest.php for
* sample usage.
*
* @note
* This filter can also be used on stylesheets not included in the
* document--something purists would probably prefer. Just directly
* call HTMLPurifier_Filter_ExtractStyleBlocks->cleanCSS()
*/
class HTMLPurifier_Filter_ExtractStyleBlocks extends \HTMLPurifier_Filter
{
/**
* @type string
*/
public $name = 'ExtractStyleBlocks';
public function __construct()
{
}
/**
* Save the contents of CSS blocks to style matches
* @param array $matches preg_replace style $matches array
*/
protected function styleCallback($matches)
{
}
/**
* Removes inline <style> tags from HTML, saves them for later use
* @param string $html
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
* @todo Extend to indicate non-text/css style blocks
*/
public function preFilter($html, $config, $context)
{
}
/**
* Takes CSS (the stuff found in <style>) and cleans it.
* @warning Requires CSSTidy <http://csstidy.sourceforge.net/>
* @param string $css CSS styling to clean
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @throws HTMLPurifier_Exception
* @return string Cleaned CSS
*/
public function cleanCSS($css, $config, $context)
{
}
}
/**
* Registry for retrieving specific URI scheme validator objects.
*/
class HTMLPurifier_URISchemeRegistry
{
/**
* Retrieve sole instance of the registry.
* @param HTMLPurifier_URISchemeRegistry $prototype Optional prototype to overload sole instance with,
* or bool true to reset to default registry.
* @return HTMLPurifier_URISchemeRegistry
* @note Pass a registry object $prototype with a compatible interface and
* the function will copy it and return it all further times.
*/
public static function instance($prototype = \null)
{
}
/**
* Cache of retrieved schemes.
* @type HTMLPurifier_URIScheme[]
*/
protected $schemes = array();
/**
* Retrieves a scheme validator object
* @param string $scheme String scheme name like http or mailto
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return HTMLPurifier_URIScheme
*/
public function getScheme($scheme, $config, $context)
{
}
/**
* Registers a custom scheme to the cache, bypassing reflection.
* @param string $scheme Scheme name
* @param HTMLPurifier_URIScheme $scheme_obj
*/
public function register($scheme, $scheme_obj)
{
}
}
/**
* Configuration definition, defines directives and their defaults.
*/
class HTMLPurifier_ConfigSchema
{
/**
* Defaults of the directives and namespaces.
* @type array
* @note This shares the exact same structure as HTMLPurifier_Config::$conf
*/
public $defaults = array();
/**
* The default property list. Do not edit this property list.
* @type array
*/
public $defaultPlist;
/**
* Definition of the directives.
* The structure of this is:
*
* array(
* 'Namespace' => array(
* 'Directive' => new stdclass(),
* )
* )
*
* The stdclass may have the following properties:
*
* - If isAlias isn't set:
* - type: Integer type of directive, see HTMLPurifier_VarParser for definitions
* - allow_null: If set, this directive allows null values
* - aliases: If set, an associative array of value aliases to real values
* - allowed: If set, a lookup array of allowed (string) values
* - If isAlias is set:
* - namespace: Namespace this directive aliases to
* - name: Directive name this directive aliases to
*
* In certain degenerate cases, stdclass will actually be an integer. In
* that case, the value is equivalent to an stdclass with the type
* property set to the integer. If the integer is negative, type is
* equal to the absolute value of integer, and allow_null is true.
*
* This class is friendly with HTMLPurifier_Config. If you need introspection
* about the schema, you're better of using the ConfigSchema_Interchange,
* which uses more memory but has much richer information.
* @type array
*/
public $info = array();
/**
* Application-wide singleton
* @type HTMLPurifier_ConfigSchema
*/
protected static $singleton;
public function __construct()
{
}
/**
* Unserializes the default ConfigSchema.
* @return HTMLPurifier_ConfigSchema
*/
public static function makeFromSerial()
{
}
/**
* Retrieves an instance of the application-wide configuration definition.
* @param HTMLPurifier_ConfigSchema $prototype
* @return HTMLPurifier_ConfigSchema
*/
public static function instance($prototype = \null)
{
}
/**
* Defines a directive for configuration
* @warning Will fail of directive's namespace is defined.
* @warning This method's signature is slightly different from the legacy
* define() static method! Beware!
* @param string $key Name of directive
* @param mixed $default Default value of directive
* @param string $type Allowed type of the directive. See
* HTMLPurifier_DirectiveDef::$type for allowed values
* @param bool $allow_null Whether or not to allow null values
*/
public function add($key, $default, $type, $allow_null)
{
}
/**
* Defines a directive value alias.
*
* Directive value aliases are convenient for developers because it lets
* them set a directive to several values and get the same result.
* @param string $key Name of Directive
* @param array $aliases Hash of aliased values to the real alias
*/
public function addValueAliases($key, $aliases)
{
}
/**
* Defines a set of allowed values for a directive.
* @warning This is slightly different from the corresponding static
* method definition.
* @param string $key Name of directive
* @param array $allowed Lookup array of allowed values
*/
public function addAllowedValues($key, $allowed)
{
}
/**
* Defines a directive alias for backwards compatibility
* @param string $key Directive that will be aliased
* @param string $new_key Directive that the alias will be to
*/
public function addAlias($key, $new_key)
{
}
/**
* Replaces any stdclass that only has the type property with type integer.
*/
public function postProcess()
{
}
}
/**
* Base class for all validating attribute definitions.
*
* This family of classes forms the core for not only HTML attribute validation,
* but also any sort of string that needs to be validated or cleaned (which
* means CSS properties and composite definitions are defined here too).
* Besides defining (through code) what precisely makes the string valid,
* subclasses are also responsible for cleaning the code if possible.
*/
abstract class HTMLPurifier_AttrDef
{
/**
* Tells us whether or not an HTML attribute is minimized.
* Has no meaning in other contexts.
* @type bool
*/
public $minimized = \false;
/**
* Tells us whether or not an HTML attribute is required.
* Has no meaning in other contexts
* @type bool
*/
public $required = \false;
/**
* Validates and cleans passed string according to a definition.
*
* @param string $string String to be validated and cleaned.
* @param HTMLPurifier_Config $config Mandatory HTMLPurifier_Config object.
* @param HTMLPurifier_Context $context Mandatory HTMLPurifier_Context object.
*/
public abstract function validate($string, $config, $context);
/**
* Convenience method that parses a string as if it were CDATA.
*
* This method process a string in the manner specified at
* <http://www.w3.org/TR/html4/types.html#h-6.2> by removing
* leading and trailing whitespace, ignoring line feeds, and replacing
* carriage returns and tabs with spaces. While most useful for HTML
* attributes specified as CDATA, it can also be applied to most CSS
* values.
*
* @note This method is not entirely standards compliant, as trim() removes
* more types of whitespace than specified in the spec. In practice,
* this is rarely a problem, as those extra characters usually have
* already been removed by HTMLPurifier_Encoder.
*
* @warning This processing is inconsistent with XML's whitespace handling
* as specified by section 3.3.3 and referenced XHTML 1.0 section
* 4.7. However, note that we are NOT necessarily
* parsing XML, thus, this behavior may still be correct. We
* assume that newlines have been normalized.
*/
public function parseCDATA($string)
{
}
/**
* Factory method for creating this class from a string.
* @param string $string String construction info
* @return HTMLPurifier_AttrDef Created AttrDef object corresponding to $string
*/
public function make($string)
{
}
/**
* Removes spaces from rgb(0, 0, 0) so that shorthand CSS properties work
* properly. THIS IS A HACK!
* @param string $string a CSS colour definition
* @return string
*/
protected function mungeRgb($string)
{
}
/**
* Parses a possibly escaped CSS string and returns the "pure"
* version of it.
*/
protected function expandCSSEscape($string)
{
}
}
/**
* Exception type for HTMLPurifier_VarParser
*/
class HTMLPurifier_VarParserException extends \HTMLPurifier_Exception
{
}
// private class for unit testing
class HTMLPurifier_Language_en_x_test extends \HTMLPurifier_Language
{
}
/**
* Validates ftp (File Transfer Protocol) URIs as defined by generic RFC 1738.
*/
class HTMLPurifier_URIScheme_ftp extends \HTMLPurifier_URIScheme
{
/**
* @type int
*/
public $default_port = 21;
/**
* @type bool
*/
public $browsable = \true;
// usually
/**
* @type bool
*/
public $hierarchical = \true;
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function doValidate(&$uri, $config, $context)
{
}
}
/**
* Validates nntp (Network News Transfer Protocol) as defined by generic RFC 1738
*/
class HTMLPurifier_URIScheme_nntp extends \HTMLPurifier_URIScheme
{
/**
* @type int
*/
public $default_port = 119;
/**
* @type bool
*/
public $browsable = \false;
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function doValidate(&$uri, $config, $context)
{
}
}
/**
* Validates tel (for phone numbers).
*
* The relevant specifications for this protocol are RFC 3966 and RFC 5341,
* but this class takes a much simpler approach: we normalize phone
* numbers so that they only include (possibly) a leading plus,
* and then any number of digits and x'es.
*/
class HTMLPurifier_URIScheme_tel extends \HTMLPurifier_URIScheme
{
/**
* @type bool
*/
public $browsable = \false;
/**
* @type bool
*/
public $may_omit_host = \true;
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function doValidate(&$uri, $config, $context)
{
}
}
/**
* Validates file as defined by RFC 1630 and RFC 1738.
*/
class HTMLPurifier_URIScheme_file extends \HTMLPurifier_URIScheme
{
/**
* Generally file:// URLs are not accessible from most
* machines, so placing them as an img src is incorrect.
* @type bool
*/
public $browsable = \false;
/**
* Basically the *only* URI scheme for which this is true, since
* accessing files on the local machine is very common. In fact,
* browsers on some operating systems don't understand the
* authority, though I hear it is used on Windows to refer to
* network shares.
* @type bool
*/
public $may_omit_host = \true;
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function doValidate(&$uri, $config, $context)
{
}
}
/**
* Validates http (HyperText Transfer Protocol) as defined by RFC 2616
*/
class HTMLPurifier_URIScheme_http extends \HTMLPurifier_URIScheme
{
/**
* @type int
*/
public $default_port = 80;
/**
* @type bool
*/
public $browsable = \true;
/**
* @type bool
*/
public $hierarchical = \true;
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function doValidate(&$uri, $config, $context)
{
}
}
/**
* Validates https (Secure HTTP) according to http scheme.
*/
class HTMLPurifier_URIScheme_https extends \HTMLPurifier_URIScheme_http
{
/**
* @type int
*/
public $default_port = 443;
/**
* @type bool
*/
public $secure = \true;
}
// VERY RELAXED! Shouldn't cause problems, not even Firefox checks if the
// email is valid, but be careful!
/**
* Validates mailto (for E-mail) according to RFC 2368
* @todo Validate the email address
* @todo Filter allowed query parameters
*/
class HTMLPurifier_URIScheme_mailto extends \HTMLPurifier_URIScheme
{
/**
* @type bool
*/
public $browsable = \false;
/**
* @type bool
*/
public $may_omit_host = \true;
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function doValidate(&$uri, $config, $context)
{
}
}
/**
* Validates news (Usenet) as defined by generic RFC 1738
*/
class HTMLPurifier_URIScheme_news extends \HTMLPurifier_URIScheme
{
/**
* @type bool
*/
public $browsable = \false;
/**
* @type bool
*/
public $may_omit_host = \true;
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function doValidate(&$uri, $config, $context)
{
}
}
/**
* Implements data: URI for base64 encoded images supported by GD.
*/
class HTMLPurifier_URIScheme_data extends \HTMLPurifier_URIScheme
{
/**
* @type bool
*/
public $browsable = \true;
/**
* @type array
*/
public $allowed_types = array(
// you better write validation code for other types if you
// decide to allow them
'image/jpeg' => \true,
'image/gif' => \true,
'image/png' => \true,
);
// this is actually irrelevant since we only write out the path
// component
/**
* @type bool
*/
public $may_omit_host = \true;
/**
* @param HTMLPurifier_URI $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool
*/
public function doValidate(&$uri, $config, $context)
{
}
/**
* @param int $errno
* @param string $errstr
*/
public function muteErrorHandler($errno, $errstr)
{
}
}
/**
* Validates arbitrary text according to the HTML spec.
*/
class HTMLPurifier_AttrDef_Text extends \HTMLPurifier_AttrDef
{
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
// Enum = Enumerated
/**
* Validates a keyword against a list of valid values.
* @warning The case-insensitive compare of this function uses PHP's
* built-in strtolower and ctype_lower functions, which may
* cause problems with international comparisons
*/
class HTMLPurifier_AttrDef_Enum extends \HTMLPurifier_AttrDef
{
/**
* Lookup table of valid values.
* @type array
* @todo Make protected
*/
public $valid_values = array();
/**
* Bool indicating whether or not enumeration is case sensitive.
* @note In general this is always case insensitive.
*/
protected $case_sensitive = \false;
// values according to W3C spec
/**
* @param array $valid_values List of valid values
* @param bool $case_sensitive Whether or not case sensitive
*/
public function __construct($valid_values = array(), $case_sensitive = \false)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
/**
* @param string $string In form of comma-delimited list of case-insensitive
* valid values. Example: "foo,bar,baz". Prepend "s:" to make
* case sensitive
* @return HTMLPurifier_AttrDef_Enum
*/
public function make($string)
{
}
}
/**
* Special-case enum attribute definition that lazy loads allowed frame targets
*/
class HTMLPurifier_AttrDef_HTML_FrameTarget extends \HTMLPurifier_AttrDef_Enum
{
/**
* @type array
*/
public $valid_values = \false;
// uninitialized value
/**
* @type bool
*/
protected $case_sensitive = \false;
public function __construct()
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates the HTML attribute ID.
* @warning Even though this is the id processor, it
* will ignore the directive Attr:IDBlacklist, since it will only
* go according to the ID accumulator. Since the accumulator is
* automatically generated, it will have already absorbed the
* blacklist. If you're hacking around, make sure you use load()!
*/
class HTMLPurifier_AttrDef_HTML_ID extends \HTMLPurifier_AttrDef
{
// selector is NOT a valid thing to use for IDREFs, because IDREFs
// *must* target IDs that exist, whereas selector #ids do not.
/**
* Determines whether or not we're validating an ID in a CSS
* selector context.
* @type bool
*/
protected $selector;
/**
* @param bool $selector
*/
public function __construct($selector = \false)
{
}
/**
* @param string $id
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($id, $config, $context)
{
}
}
/**
* Validates a color according to the HTML spec.
*/
class HTMLPurifier_AttrDef_HTML_Color extends \HTMLPurifier_AttrDef
{
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates a boolean attribute
*/
class HTMLPurifier_AttrDef_HTML_Bool extends \HTMLPurifier_AttrDef
{
/**
* @type bool
*/
protected $name;
/**
* @type bool
*/
public $minimized = \true;
/**
* @param bool $name
*/
public function __construct($name = \false)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
/**
* @param string $string Name of attribute
* @return HTMLPurifier_AttrDef_HTML_Bool
*/
public function make($string)
{
}
}
/**
* Validates a rel/rev link attribute against a directive of allowed values
* @note We cannot use Enum because link types allow multiple
* values.
* @note Assumes link types are ASCII text
*/
class HTMLPurifier_AttrDef_HTML_LinkTypes extends \HTMLPurifier_AttrDef
{
/**
* Name config attribute to pull.
* @type string
*/
protected $name;
/**
* @param string $name
*/
public function __construct($name)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates contents based on NMTOKENS attribute type.
*/
class HTMLPurifier_AttrDef_HTML_Nmtokens extends \HTMLPurifier_AttrDef
{
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
/**
* Splits a space separated list of tokens into its constituent parts.
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
protected function split($string, $config, $context)
{
}
/**
* Template method for removing certain tokens based on arbitrary criteria.
* @note If we wanted to be really functional, we'd do an array_filter
* with a callback. But... we're not.
* @param array $tokens
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
protected function filter($tokens, $config, $context)
{
}
}
/**
* Validates an integer representation of pixels according to the HTML spec.
*/
class HTMLPurifier_AttrDef_HTML_Pixels extends \HTMLPurifier_AttrDef
{
/**
* @type int
*/
protected $max;
/**
* @param int $max
*/
public function __construct($max = \null)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
/**
* @param string $string
* @return HTMLPurifier_AttrDef
*/
public function make($string)
{
}
}
/**
* Validates the HTML type length (not to be confused with CSS's length).
*
* This accepts integer pixels or percentages as lengths for certain
* HTML attributes.
*/
class HTMLPurifier_AttrDef_HTML_Length extends \HTMLPurifier_AttrDef_HTML_Pixels
{
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates a MultiLength as defined by the HTML spec.
*
* A multilength is either a integer (pixel count), a percentage, or
* a relative number.
*/
class HTMLPurifier_AttrDef_HTML_MultiLength extends \HTMLPurifier_AttrDef_HTML_Length
{
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Implements special behavior for class attribute (normally NMTOKENS)
*/
class HTMLPurifier_AttrDef_HTML_Class extends \HTMLPurifier_AttrDef_HTML_Nmtokens
{
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
protected function split($string, $config, $context)
{
}
/**
* @param array $tokens
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return array
*/
protected function filter($tokens, $config, $context)
{
}
}
/**
* Validates the HTML attribute style, otherwise known as CSS.
* @note We don't implement the whole CSS specification, so it might be
* difficult to reuse this component in the context of validating
* actual stylesheet declarations.
* @note If we were really serious about validating the CSS, we would
* tokenize the styles and then parse the tokens. Obviously, we
* are not doing that. Doing that could seriously harm performance,
* but would make these components a lot more viable for a CSS
* filtering solution.
*/
class HTMLPurifier_AttrDef_CSS extends \HTMLPurifier_AttrDef
{
/**
* @param string $css
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($css, $config, $context)
{
}
}
/**
* Validates a URI as defined by RFC 3986.
* @note Scheme-specific mechanics deferred to HTMLPurifier_URIScheme
*/
class HTMLPurifier_AttrDef_URI extends \HTMLPurifier_AttrDef
{
/**
* @type HTMLPurifier_URIParser
*/
protected $parser;
/**
* @type bool
*/
protected $embedsResource;
/**
* @param bool $embeds_resource Does the URI here result in an extra HTTP request?
*/
public function __construct($embeds_resource = \false)
{
}
/**
* @param string $string
* @return HTMLPurifier_AttrDef_URI
*/
public function make($string)
{
}
/**
* @param string $uri
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($uri, $config, $context)
{
}
}
/**
* Framework class for strings that involve multiple values.
*
* Certain CSS properties such as border-width and margin allow multiple
* lengths to be specified. This class can take a vanilla border-width
* definition and multiply it, usually into a max of four.
*
* @note Even though the CSS specification isn't clear about it, inherit
* can only be used alone: it will never manifest as part of a multi
* shorthand declaration. Thus, this class does not allow inherit.
*/
class HTMLPurifier_AttrDef_CSS_Multiple extends \HTMLPurifier_AttrDef
{
/**
* Instance of component definition to defer validation to.
* @type HTMLPurifier_AttrDef
* @todo Make protected
*/
public $single;
/**
* Max number of values allowed.
* @todo Make protected
*/
public $max;
/**
* @param HTMLPurifier_AttrDef $single HTMLPurifier_AttrDef to multiply
* @param int $max Max number of values allowed (usually four)
*/
public function __construct($single, $max = 4)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates shorthand CSS property list-style.
* @warning Does not support url tokens that have internal spaces.
*/
class HTMLPurifier_AttrDef_CSS_ListStyle extends \HTMLPurifier_AttrDef
{
/**
* Local copy of validators.
* @type HTMLPurifier_AttrDef[]
* @note See HTMLPurifier_AttrDef_CSS_Font::$info for a similar impl.
*/
protected $info;
/**
* @param HTMLPurifier_Config $config
*/
public function __construct($config)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates a Percentage as defined by the CSS spec.
*/
class HTMLPurifier_AttrDef_CSS_Percentage extends \HTMLPurifier_AttrDef
{
/**
* Instance to defer number validation to.
* @type HTMLPurifier_AttrDef_CSS_Number
*/
protected $number_def;
/**
* @param bool $non_negative Whether to forbid negative values
*/
public function __construct($non_negative = \false)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates the value for the CSS property text-decoration
* @note This class could be generalized into a version that acts sort of
* like Enum except you can compound the allowed values.
*/
class HTMLPurifier_AttrDef_CSS_TextDecoration extends \HTMLPurifier_AttrDef
{
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates a URI in CSS syntax, which uses url('http://example.com')
* @note While theoretically speaking a URI in a CSS document could
* be non-embedded, as of CSS2 there is no such usage so we're
* generalizing it. This may need to be changed in the future.
* @warning Since HTMLPurifier_AttrDef_CSS blindly uses semicolons as
* the separator, you cannot put a literal semicolon in
* in the URI. Try percent encoding it, in that case.
*/
class HTMLPurifier_AttrDef_CSS_URI extends \HTMLPurifier_AttrDef_URI
{
public function __construct()
{
}
/**
* @param string $uri_string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($uri_string, $config, $context)
{
}
}
/**
* Validates a font family list according to CSS spec
*/
class HTMLPurifier_AttrDef_CSS_FontFamily extends \HTMLPurifier_AttrDef
{
protected $mask = \null;
public function __construct()
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates shorthand CSS property font.
*/
class HTMLPurifier_AttrDef_CSS_Font extends \HTMLPurifier_AttrDef
{
/**
* Local copy of validators
* @type HTMLPurifier_AttrDef[]
* @note If we moved specific CSS property definitions to their own
* classes instead of having them be assembled at run time by
* CSSDefinition, this wouldn't be necessary. We'd instantiate
* our own copies.
*/
protected $info = array();
/**
* @param HTMLPurifier_Config $config
*/
public function __construct($config)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Decorator which enables !important to be used in CSS values.
*/
class HTMLPurifier_AttrDef_CSS_ImportantDecorator extends \HTMLPurifier_AttrDef
{
/**
* @type HTMLPurifier_AttrDef
*/
public $def;
/**
* @type bool
*/
public $allow;
/**
* @param HTMLPurifier_AttrDef $def Definition to wrap
* @param bool $allow Whether or not to allow !important
*/
public function __construct($def, $allow = \false)
{
}
/**
* Intercepts and removes !important if necessary
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates a number as defined by the CSS spec.
*/
class HTMLPurifier_AttrDef_CSS_Number extends \HTMLPurifier_AttrDef
{
/**
* Indicates whether or not only positive values are allowed.
* @type bool
*/
protected $non_negative = \false;
/**
* @param bool $non_negative indicates whether negatives are forbidden
*/
public function __construct($non_negative = \false)
{
}
/**
* @param string $number
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string|bool
* @warning Some contexts do not pass $config, $context. These
* variables should not be used without checking HTMLPurifier_Length
*/
public function validate($number, $config, $context)
{
}
}
/**
* Microsoft's proprietary filter: CSS property
* @note Currently supports the alpha filter. In the future, this will
* probably need an extensible framework
*/
class HTMLPurifier_AttrDef_CSS_Filter extends \HTMLPurifier_AttrDef
{
/**
* @type HTMLPurifier_AttrDef_Integer
*/
protected $intValidator;
public function __construct()
{
}
/**
* @param string $value
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($value, $config, $context)
{
}
}
class HTMLPurifier_AttrDef_CSS_AlphaValue extends \HTMLPurifier_AttrDef_CSS_Number
{
public function __construct()
{
}
/**
* @param string $number
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return string
*/
public function validate($number, $config, $context)
{
}
}
/**
* Decorator which enables CSS properties to be disabled for specific elements.
*/
class HTMLPurifier_AttrDef_CSS_DenyElementDecorator extends \HTMLPurifier_AttrDef
{
/**
* @type HTMLPurifier_AttrDef
*/
public $def;
/**
* @type string
*/
public $element;
/**
* @param HTMLPurifier_AttrDef $def Definition to wrap
* @param string $element Element to deny
*/
public function __construct($def, $element)
{
}
/**
* Checks if CurrentToken is set and equal to $this->element
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates Color as defined by CSS.
*/
class HTMLPurifier_AttrDef_CSS_Color extends \HTMLPurifier_AttrDef
{
/**
* @type HTMLPurifier_AttrDef_CSS_AlphaValue
*/
protected $alpha;
public function __construct()
{
}
/**
* @param string $color
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($color, $config, $context)
{
}
}
/**
* Validates shorthand CSS property background.
* @warning Does not support url tokens that have internal spaces.
*/
class HTMLPurifier_AttrDef_CSS_Background extends \HTMLPurifier_AttrDef
{
/**
* Local copy of component validators.
* @type HTMLPurifier_AttrDef[]
* @note See HTMLPurifier_AttrDef_Font::$info for a similar impl.
*/
protected $info;
/**
* @param HTMLPurifier_Config $config
*/
public function __construct($config)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/* W3C says:
[ // adjective and number must be in correct order, even if
// you could switch them without introducing ambiguity.
// some browsers support that syntax
[
<percentage> | <length> | left | center | right
]
[
<percentage> | <length> | top | center | bottom
]?
] |
[ // this signifies that the vertical and horizontal adjectives
// can be arbitrarily ordered, however, there can only be two,
// one of each, or none at all
[
left | center | right
] ||
[
top | center | bottom
]
]
top, left = 0%
center, (none) = 50%
bottom, right = 100%
*/
/* QuirksMode says:
keyword + length/percentage must be ordered correctly, as per W3C
Internet Explorer and Opera, however, support arbitrary ordering. We
should fix it up.
Minor issue though, not strictly necessary.
*/
// control freaks may appreciate the ability to convert these to
// percentages or something, but it's not necessary
/**
* Validates the value of background-position.
*/
class HTMLPurifier_AttrDef_CSS_BackgroundPosition extends \HTMLPurifier_AttrDef
{
/**
* @type HTMLPurifier_AttrDef_CSS_Length
*/
protected $length;
/**
* @type HTMLPurifier_AttrDef_CSS_Percentage
*/
protected $percentage;
public function __construct()
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Allows multiple validators to attempt to validate attribute.
*
* Composite is just what it sounds like: a composite of many validators.
* This means that multiple HTMLPurifier_AttrDef objects will have a whack
* at the string. If one of them passes, that's what is returned. This is
* especially useful for CSS values, which often are a choice between
* an enumerated set of predefined values or a flexible data type.
*/
class HTMLPurifier_AttrDef_CSS_Composite extends \HTMLPurifier_AttrDef
{
/**
* List of objects that may process strings.
* @type HTMLPurifier_AttrDef[]
* @todo Make protected
*/
public $defs;
/**
* @param HTMLPurifier_AttrDef[] $defs List of HTMLPurifier_AttrDef objects
*/
public function __construct($defs)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates the border property as defined by CSS.
*/
class HTMLPurifier_AttrDef_CSS_Border extends \HTMLPurifier_AttrDef
{
/**
* Local copy of properties this property is shorthand for.
* @type HTMLPurifier_AttrDef[]
*/
protected $info = array();
/**
* @param HTMLPurifier_Config $config
*/
public function __construct($config)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates based on {ident} CSS grammar production
*/
class HTMLPurifier_AttrDef_CSS_Ident extends \HTMLPurifier_AttrDef
{
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Represents a Length as defined by CSS.
*/
class HTMLPurifier_AttrDef_CSS_Length extends \HTMLPurifier_AttrDef
{
/**
* @type HTMLPurifier_Length|string
*/
protected $min;
/**
* @type HTMLPurifier_Length|string
*/
protected $max;
/**
* @param HTMLPurifier_Length|string $min Minimum length, or null for no bound. String is also acceptable.
* @param HTMLPurifier_Length|string $max Maximum length, or null for no bound. String is also acceptable.
*/
public function __construct($min = \null, $max = \null)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Dummy AttrDef that mimics another AttrDef, BUT it generates clones
* with make.
*/
class HTMLPurifier_AttrDef_Clone extends \HTMLPurifier_AttrDef
{
/**
* What we're cloning.
* @type HTMLPurifier_AttrDef
*/
protected $clone;
/**
* @param HTMLPurifier_AttrDef $clone
*/
public function __construct($clone)
{
}
/**
* @param string $v
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($v, $config, $context)
{
}
/**
* @param string $string
* @return HTMLPurifier_AttrDef
*/
public function make($string)
{
}
}
/**
* Validates the HTML attribute lang, effectively a language code.
* @note Built according to RFC 3066, which obsoleted RFC 1766
*/
class HTMLPurifier_AttrDef_Lang extends \HTMLPurifier_AttrDef
{
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
abstract class HTMLPurifier_AttrDef_URI_Email extends \HTMLPurifier_AttrDef
{
/**
* Unpacks a mailbox into its display-name and address
* @param string $string
* @return mixed
*/
public function unpack($string)
{
}
}
/**
* Primitive email validation class based on the regexp found at
* http://www.regular-expressions.info/email.html
*/
class HTMLPurifier_AttrDef_URI_Email_SimpleCheck extends \HTMLPurifier_AttrDef_URI_Email
{
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates an IPv4 address
* @author Feyd @ forums.devnetwork.net (public domain)
*/
class HTMLPurifier_AttrDef_URI_IPv4 extends \HTMLPurifier_AttrDef
{
/**
* IPv4 regex, protected so that IPv6 can reuse it.
* @type string
*/
protected $ip4;
/**
* @param string $aIP
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($aIP, $config, $context)
{
}
/**
* Lazy load function to prevent regex from being stuffed in
* cache.
*/
protected function _loadRegex()
{
}
}
/**
* Validates a host according to the IPv4, IPv6 and DNS (future) specifications.
*/
class HTMLPurifier_AttrDef_URI_Host extends \HTMLPurifier_AttrDef
{
/**
* IPv4 sub-validator.
* @type HTMLPurifier_AttrDef_URI_IPv4
*/
protected $ipv4;
/**
* IPv6 sub-validator.
* @type HTMLPurifier_AttrDef_URI_IPv6
*/
protected $ipv6;
public function __construct()
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates an IPv6 address.
* @author Feyd @ forums.devnetwork.net (public domain)
* @note This function requires brackets to have been removed from address
* in URI.
*/
class HTMLPurifier_AttrDef_URI_IPv6 extends \HTMLPurifier_AttrDef_URI_IPv4
{
/**
* @param string $aIP
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($aIP, $config, $context)
{
}
}
/**
* Decorator that, depending on a token, switches between two definitions.
*/
class HTMLPurifier_AttrDef_Switch
{
/**
* @type string
*/
protected $tag;
/**
* @type HTMLPurifier_AttrDef
*/
protected $withTag;
/**
* @type HTMLPurifier_AttrDef
*/
protected $withoutTag;
/**
* @param string $tag Tag name to switch upon
* @param HTMLPurifier_AttrDef $with_tag Call if token matches tag
* @param HTMLPurifier_AttrDef $without_tag Call if token doesn't match, or there is no token
*/
public function __construct($tag, $with_tag, $without_tag)
{
}
/**
* @param string $string
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($string, $config, $context)
{
}
}
/**
* Validates an integer.
* @note While this class was modeled off the CSS definition, no currently
* allowed CSS uses this type. The properties that do are: widows,
* orphans, z-index, counter-increment, counter-reset. Some of the
* HTML attributes, however, find use for a non-negative version of this.
*/
class HTMLPurifier_AttrDef_Integer extends \HTMLPurifier_AttrDef
{
/**
* Whether or not negative values are allowed.
* @type bool
*/
protected $negative = \true;
/**
* Whether or not zero is allowed.
* @type bool
*/
protected $zero = \true;
/**
* Whether or not positive values are allowed.
* @type bool
*/
protected $positive = \true;
/**
* @param $negative Bool indicating whether or not negative values are allowed
* @param $zero Bool indicating whether or not zero is allowed
* @param $positive Bool indicating whether or not positive values are allowed
*/
public function __construct($negative = \true, $zero = \true, $positive = \true)
{
}
/**
* @param string $integer
* @param HTMLPurifier_Config $config
* @param HTMLPurifier_Context $context
* @return bool|string
*/
public function validate($integer, $config, $context)
{
}
}
/**
* Factory for token generation.
*
* @note Doing some benchmarking indicates that the new operator is much
* slower than the clone operator (even discounting the cost of the
* constructor). This class is for that optimization.
* Other then that, there's not much point as we don't
* maintain parallel HTMLPurifier_Token hierarchies (the main reason why
* you'd want to use an abstract factory).
* @todo Port DirectLex to use this
*/
class HTMLPurifier_TokenFactory
{
/**
* Generates blank prototypes for cloning.
*/
public function __construct()
{
}
/**
* Creates a HTMLPurifier_Token_Start.
* @param string $name Tag name
* @param array $attr Associative array of attributes
* @return HTMLPurifier_Token_Start Generated HTMLPurifier_Token_Start
*/
public function createStart($name, $attr = array())
{
}
/**
* Creates a HTMLPurifier_Token_End.
* @param string $name Tag name
* @return HTMLPurifier_Token_End Generated HTMLPurifier_Token_End
*/
public function createEnd($name)
{
}
/**
* Creates a HTMLPurifier_Token_Empty.
* @param string $name Tag name
* @param array $attr Associative array of attributes
* @return HTMLPurifier_Token_Empty Generated HTMLPurifier_Token_Empty
*/
public function createEmpty($name, $attr = array())
{
}
/**
* Creates a HTMLPurifier_Token_Text.
* @param string $data Data of text token
* @return HTMLPurifier_Token_Text Generated HTMLPurifier_Token_Text
*/
public function createText($data)
{
}
/**
* Creates a HTMLPurifier_Token_Comment.
* @param string $data Data of comment token
* @return HTMLPurifier_Token_Comment Generated HTMLPurifier_Token_Comment
*/
public function createComment($data)
{
}
}
/**
* Represents a measurable length, with a string numeric magnitude
* and a unit. This object is immutable.
*/
class HTMLPurifier_Length
{
/**
* String numeric magnitude.
* @type string
*/
protected $n;
/**
* String unit. False is permitted if $n = 0.
* @type string|bool
*/
protected $unit;
/**
* Whether or not this length is valid. Null if not calculated yet.
* @type bool
*/
protected $isValid;
/**
* Array Lookup array of units recognized by CSS 2.1
* @type array
*/
protected static $allowedUnits = array('em' => \true, 'ex' => \true, 'px' => \true, 'in' => \true, 'cm' => \true, 'mm' => \true, 'pt' => \true, 'pc' => \true);
/**
* @param string $n Magnitude
* @param bool|string $u Unit
*/
public function __construct($n = '0', $u = \false)
{
}
/**
* @param string $s Unit string, like '2em' or '3.4in'
* @return HTMLPurifier_Length
* @warning Does not perform validation.
*/
public static function make($s)
{
}
/**
* Validates the number and unit.
* @return bool
*/
protected function validate()
{
}
/**
* Returns string representation of number.
* @return string
*/
public function toString()
{
}
/**
* Retrieves string numeric magnitude.
* @return string
*/
public function getN()
{
}
/**
* Retrieves string unit.
* @return string
*/
public function getUnit()
{
}
/**
* Returns true if this length unit is valid.
* @return bool
*/
public function isValid()
{
}
/**
* Compares two lengths, and returns 1 if greater, -1 if less and 0 if equal.
* @param HTMLPurifier_Length $l
* @return int
* @warning If both values are too large or small, this calculation will
* not work properly
*/
public function compareTo($l)
{
}
}
}
namespace PhpCollection {
/**
* Basic interface which adds some behaviors, and a few methods common to all collections.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface CollectionInterface extends \Traversable, \Countable
{
/**
* Returns whether this collection contains the passed element.
*
* @param mixed $elem
*
* @return boolean
*/
public function contains($elem);
/**
* Returns whether the collection is empty.
*
* @return boolean
*/
public function isEmpty();
/**
* Returns a filtered collection of the same type.
*
* Removes all elements for which the provided callable returns false.
*
* @param callable $callable receives an element of the collection and must return true (= keep) or false (= remove).
*
* @return CollectionInterface
*/
public function filter($callable);
/**
* Returns a filtered collection of the same type.
*
* Removes all elements for which the provided callable returns true.
*
* @param callable $callable receives an element of the collection and must return true (= remove) or false (= keep).
*
* @return CollectionInterface
*/
public function filterNot($callable);
/**
* Applies the callable to an initial value and each element, going left to right.
*
* @param mixed $initialValue
* @param callable $callable receives the current value (the first time this equals $initialValue) and the element
*
* @return mixed the last value returned by $callable, or $initialValue if collection is empty.
*/
public function foldLeft($initialValue, $callable);
/**
* Applies the callable to each element, and an initial value, going right to left.
*
* @param mixed $initialValue
* @param callable $callable receives the element, and the current value (the first time this equals $initialValue).
* @return mixed the last value returned by $callable, or $initialValue if collection is empty.
*/
public function foldRight($initialValue, $callable);
}
/**
* Interface for sets.
*
* Each Set contains equal values only once.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface SetInterface extends \PhpCollection\CollectionInterface, \IteratorAggregate
{
/**
* @param object|scalar $elem
* @return void
*/
public function add($elem);
/**
* @param object|scalar $elements
* @return void
*/
public function addAll(array $elements);
/**
* @param object|scalar $elem
* @return void
*/
public function remove($elem);
/**
* Returns the first element in the collection if available.
*
* @return Option
*/
public function first();
/**
* Returns the last element in the collection if available.
*
* @return Option
*/
public function last();
/**
* Returns all elements in this Set.
*
* @return array
*/
public function all();
/**
* Returns a new Set with all elements in reverse order.
*
* @return SetInterface
*/
public function reverse();
/**
* Adds the elements of another Set to this Set.
*
* @param SetInterface $seq
*
* @return SetInterface
*/
public function addSet(\PhpCollection\SetInterface $seq);
/**
* Returns a new Set by omitting the given number of elements from the beginning.
*
* If the passed number is greater than the available number of elements, all will be removed.
*
* @param integer $number
*
* @return SetInterface
*/
public function drop($number);
/**
* Returns a new Set by omitting the given number of elements from the end.
*
* If the passed number is greater than the available number of elements, all will be removed.
*
* @param integer $number
*
* @return SetInterface
*/
public function dropRight($number);
/**
* Returns a new Set by omitting elements from the beginning for as long as the callable returns true.
*
* @param callable $callable Receives the element to drop as first argument, and returns true (drop), or false (stop).
*
* @return SetInterface
*/
public function dropWhile($callable);
/**
* Creates a new collection by taking the given number of elements from the beginning
* of the current collection.
*
* If the passed number is greater than the available number of elements, then all elements
* will be returned as a new collection.
*
* @param integer $number
*
* @return CollectionInterface
*/
public function take($number);
/**
* Creates a new collection by taking elements from the current collection
* for as long as the callable returns true.
*
* @param callable $callable
*
* @return CollectionInterface
*/
public function takeWhile($callable);
/**
* Creates a new collection by applying the passed callable to all elements
* of the current collection.
*
* @param callable $callable
* @return CollectionInterface
*/
public function map($callable);
}
/**
* Interface for external handlers that provide ObjectBasics functionality.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface ObjectBasicsHandler
{
/**
* @param object $object This object is guaranteed to be of the type the handler was registered for.
* @return string|integer
*/
public function hash($object);
/**
* @param object $firstObject This object is guaranteed to be of the type the handler was registered for.
* @param object $secondObject This might be an object of any class.
* @return boolean
*/
public function equals($firstObject, $secondObject);
}
}
namespace PhpCollection\ObjectBasicsHandler {
class DateTimeHandler implements \PhpCollection\ObjectBasicsHandler
{
public function hash($object)
{
}
public function equals($thisObject, $otherObject)
{
}
}
class IdentityHandler implements \PhpCollection\ObjectBasicsHandler
{
public function hash($object)
{
}
public function equals($a, $b)
{
}
}
}
namespace PhpCollection {
/**
* Implementation of a Set.
*
* Each set guarantees that equal elements are only contained once in the Set.
*
* This implementation constraints Sets to either consist of objects that implement ObjectBasics, or objects that have
* an external ObjectBasicsHandler implementation, or simple scalars. These types cannot be mixed within the same Set.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class Set implements \PhpCollection\SetInterface
{
const ELEM_TYPE_SCALAR = 1;
const ELEM_TYPE_OBJECT = 2;
const ELEM_TYPE_OBJECT_WITH_HANDLER = 3;
public function __construct(array $elements = array())
{
}
public function first()
{
}
public function last()
{
}
public function getIterator()
{
}
public function addSet(\PhpCollection\SetInterface $set)
{
}
public function take($number)
{
}
/**
* Extracts element from the head while the passed callable returns true.
*
* @param callable $callable receives elements of this Set as first argument, and returns true/false.
*
* @return Set
*/
public function takeWhile($callable)
{
}
public function drop($number)
{
}
public function dropRight($number)
{
}
public function dropWhile($callable)
{
}
public function map($callable)
{
}
public function reverse()
{
}
public function all()
{
}
public function filterNot($callable)
{
}
public function filter($callable)
{
}
public function foldLeft($initialValue, $callable)
{
}
public function foldRight($initialValue, $callable)
{
}
public function addAll(array $elements)
{
}
public function count()
{
}
public function contains($elem)
{
}
public function remove($elem)
{
}
public function isEmpty()
{
}
public function add($elem)
{
}
protected function createNew(array $elements)
{
}
}
/**
* Implementation for ObjectBasics for entity-like objects.
*
* Two objects are considered equal if they refer to the same instance.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
trait EntityLikeObject
{
public function hash()
{
}
public function equals(\PhpCollection\ObjectBasics $other)
{
}
}
/**
* Interface for mutable sequences.
*
* Equality of elements in the sequence is established via a shallow comparison (===).
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface SequenceInterface extends \PhpCollection\CollectionInterface
{
/**
* Returns the first element in the collection if available.
*
* @return Option
*/
public function first();
/**
* Returns the last element in the collection if available.
*
* @return Option
*/
public function last();
/**
* Returns all elements in this sequence.
*
* @return array
*/
public function all();
/**
* Returns a new Sequence with all elements in reverse order.
*
* @return SequenceInterface
*/
public function reverse();
/**
* Adds the elements of another sequence to this sequence.
*
* @param SequenceInterface $seq
*
* @return SequenceInterface
*/
public function addSequence(\PhpCollection\SequenceInterface $seq);
/**
* Returns the index of the passed element.
*
* @param mixed $elem
*
* @return integer the index (0-based), or -1 if not found
*/
public function indexOf($elem);
/**
* Returns the last index of the passed element.
*
* @param mixed $elem
* @return integer the index (0-based), or -1 if not found
*/
public function lastIndexOf($elem);
/**
* Returns whether the given index is defined in the sequence.
*
* @param integer $index (0-based)
* @return boolean
*/
public function isDefinedAt($index);
/**
* Returns the first index where the given callable returns true.
*
* @param callable $callable receives the element as first argument, and returns true, or false
*
* @return integer the index (0-based), or -1 if the callable returns false for all elements
*/
public function indexWhere($callable);
/**
* Returns the last index where the given callable returns true.
*
* @param callable $callable receives the element as first argument, and returns true, or false
*
* @return integer the index (0-based), or -1 if the callable returns false for all elements
*/
public function lastIndexWhere($callable);
/**
* Returns all indices of this collection.
*
* @return integer[]
*/
public function indices();
/**
* Returns the element at the given index.
*
* @param integer $index (0-based)
*
* @return mixed
*/
public function get($index);
/**
* Adds an element to the sequence.
*
* @param mixed $elem
*
* @return void
*/
public function add($elem);
/**
* Removes the element at the given index, and returns it.
*
* @param integer $index
*
* @return mixed
*/
public function remove($index);
/**
* Adds all elements to the sequence.
*
* @param array $elements
*
* @return void
*/
public function addAll(array $elements);
/**
* Updates the value at the given index.
*
* @param integer $index
* @param mixed $value
*
* @return void
*/
public function update($index, $value);
/**
* Returns a new sequence by omitting the given number of elements from the beginning.
*
* If the passed number is greater than the available number of elements, all will be removed.
*
* @param integer $number
*
* @return SequenceInterface
*/
public function drop($number);
/**
* Returns a new sequence by omitting the given number of elements from the end.
*
* If the passed number is greater than the available number of elements, all will be removed.
*
* @param integer $number
*
* @return SequenceInterface
*/
public function dropRight($number);
/**
* Returns a new sequence by omitting elements from the beginning for as long as the callable returns true.
*
* @param callable $callable Receives the element to drop as first argument, and returns true (drop), or false (stop).
*
* @return SequenceInterface
*/
public function dropWhile($callable);
/**
* Creates a new collection by taking the given number of elements from the beginning
* of the current collection.
*
* If the passed number is greater than the available number of elements, then all elements
* will be returned as a new collection.
*
* @param integer $number
*
* @return CollectionInterface
*/
public function take($number);
/**
* Creates a new collection by taking elements from the current collection
* for as long as the callable returns true.
*
* @param callable $callable
*
* @return CollectionInterface
*/
public function takeWhile($callable);
/**
* Creates a new collection by applying the passed callable to all elements
* of the current collection.
*
* @param callable $callable
* @return CollectionInterface
*/
public function map($callable);
}
abstract class AbstractCollection
{
public function contains($searchedElem)
{
}
public function find($callable)
{
}
}
/**
* A sequence with numerically indexed elements.
*
* This is rawly equivalent to an array with only numeric keys.
* There are no restrictions on how many same values may occur in the sequence.
*
* This sequence is mutable.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class AbstractSequence extends \PhpCollection\AbstractCollection implements \IteratorAggregate, \PhpCollection\SequenceInterface
{
protected $elements;
/**
* @param array $elements
*/
public function __construct(array $elements = array())
{
}
public function addSequence(\PhpCollection\SequenceInterface $seq)
{
}
public function indexOf($searchedElement)
{
}
public function lastIndexOf($searchedElement)
{
}
public function reverse()
{
}
public function isDefinedAt($index)
{
}
/**
* Returns a filtered sequence.
*
* @param callable $callable receives the element and must return true (= keep) or false (= remove).
*
* @return AbstractSequence
*/
public function filter($callable)
{
}
public function map($callable)
{
}
/**
* Returns a filtered sequence.
*
* @param callable $callable receives the element and must return true (= remove) or false (= keep).
*
* @return AbstractSequence
*/
public function filterNot($callable)
{
}
public function foldLeft($initialValue, $callable)
{
}
public function foldRight($initialValue, $callable)
{
}
/**
* Finds the first index where the given callable returns true.
*
* @param callable $callable
*
* @return integer the index, or -1 if the predicate is not true for any element.
*/
public function indexWhere($callable)
{
}
public function lastIndexWhere($callable)
{
}
public function last()
{
}
public function first()
{
}
public function indices()
{
}
/**
* Returns an element based on its index (0-based).
*
* @param integer $index
*
* @return T
*/
public function get($index)
{
}
/**
* Removes the element at the given index, and returns it.
*
* @param int $index
*
* @return T
*
* @throws \OutOfBoundsException If there is no element at the given index.
*/
public function remove($index)
{
}
/**
* Updates the element at the given index (0-based).
*
* @param integer $index
* @param T $value
*/
public function update($index, $value)
{
}
public function isEmpty()
{
}
public function all()
{
}
public function add($newElement)
{
}
public function addAll(array $addedElements)
{
}
public function take($number)
{
}
/**
* Extracts element from the head while the passed callable returns true.
*
* @param callable $callable receives elements of this sequence as first argument, and returns true/false.
*
* @return Sequence
*/
public function takeWhile($callable)
{
}
public function drop($number)
{
}
public function dropRight($number)
{
}
public function dropWhile($callable)
{
}
public function exists($callable)
{
}
public function count()
{
}
public function getIterator()
{
}
protected function createNew(array $elements)
{
}
}
/**
* A sequence with a fixed sort-order.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class SortedSequence extends \PhpCollection\AbstractSequence
{
public function __construct($sortFunc, array $elements = array())
{
}
public function add($newElement)
{
}
public function addAll(array $addedElements)
{
}
protected function createNew(array $elements)
{
}
}
/**
* Interface for sortable collections.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface SortableInterface
{
public function sortWith($callable);
}
/**
* Basic map interface.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface MapInterface extends \PhpCollection\CollectionInterface
{
/**
* Returns the first element in the collection if available.
*
* @return Option on array<K,V>
*/
public function first();
/**
* Returns the last element in the collection if available.
*
* @return Option on array<K,V>
*/
public function last();
/**
* Returns all elements in this collection.
*
* @return array
*/
public function all();
/**
* Searches the collection for an element.
*
* @param callable $callable receives the element as first argument, and returns true, or false
*
* @return Option on array<K,V>
*/
public function find($callable);
/**
* Returns the value associated with the given key.
*
* @param mixed $key
*
* @return Option on V
*/
public function get($key);
/**
* Returns whether this map contains a given key.
*
* @param mixed $key
*
* @return boolean
*/
public function containsKey($key);
/**
* Puts a new element in the map.
*
* @param mixed $key
* @param mixed $value
*
* @return void
*/
public function set($key, $value);
/**
* Removes an element from the map.
*
* @param mixed $key
*
* @return mixed
*/
public function remove($key);
/**
* Adds all another map to this map, and returns itself.
*
* @param MapInterface $map
*
* @return MapInterface
*/
public function addMap(\PhpCollection\MapInterface $map);
/**
* Returns an array with the keys.
*
* @return array
*/
public function keys();
/**
* Returns an array with the values.
*
* @return array
*/
public function values();
/**
* Returns a new sequence by omitting the given number of elements from the beginning.
*
* If the passed number is greater than the available number of elements, all will be removed.
*
* @param integer $number
*
* @return MapInterface
*/
public function drop($number);
/**
* Returns a new sequence by omitting the given number of elements from the end.
*
* If the passed number is greater than the available number of elements, all will be removed.
*
* @param integer $number
*
* @return MapInterface
*/
public function dropRight($number);
/**
* Returns a new sequence by omitting elements from the beginning for as long as the callable returns true.
*
* @param callable $callable Receives the element to drop as first argument, and returns true (drop), or false (stop).
*
* @return MapInterface
*/
public function dropWhile($callable);
/**
* Creates a new collection by taking the given number of elements from the beginning
* of the current collection.
*
* If the passed number is greater than the available number of elements, then all elements
* will be returned as a new collection.
*
* @param integer $number
*
* @return MapInterface
*/
public function take($number);
/**
* Creates a new collection by taking elements from the current collection
* for as long as the callable returns true.
*
* @param callable $callable
*
* @return MapInterface
*/
public function takeWhile($callable);
}
/**
* A simple map implementation which basically wraps an array with an object oriented interface.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class AbstractMap extends \PhpCollection\AbstractCollection implements \IteratorAggregate, \PhpCollection\MapInterface
{
protected $elements;
public function __construct(array $elements = array())
{
}
public function set($key, $value)
{
}
public function exists($callable)
{
}
/**
* Sets all key/value pairs in the map.
*
* @param array $kvMap
*
* @return void
*/
public function setAll(array $kvMap)
{
}
public function addMap(\PhpCollection\MapInterface $map)
{
}
public function get($key)
{
}
public function all()
{
}
public function remove($key)
{
}
public function clear()
{
}
public function first()
{
}
public function last()
{
}
public function contains($elem)
{
}
public function containsKey($key)
{
}
public function isEmpty()
{
}
/**
* Returns a new filtered map.
*
* @param callable $callable receives the element and must return true (= keep), or false (= remove).
*
* @return AbstractMap
*/
public function filter($callable)
{
}
/**
* Returns a new filtered map.
*
* @param callable $callable receives the element and must return true (= remove), or false (= keep).
*
* @return AbstractMap
*/
public function filterNot($callable)
{
}
public function foldLeft($initialValue, $callable)
{
}
public function foldRight($initialValue, $callable)
{
}
public function dropWhile($callable)
{
}
public function drop($number)
{
}
public function dropRight($number)
{
}
public function take($number)
{
}
public function takeWhile($callable)
{
}
public function find($callable)
{
}
public function keys()
{
}
public function values()
{
}
public function count()
{
}
public function getIterator()
{
}
protected function createNew(array $elements)
{
}
}
class Map extends \PhpCollection\AbstractMap implements \PhpCollection\SortableInterface
{
public function sortWith($callable)
{
}
}
/**
* Unsorted sequence implementation.
*
* Characteristics:
*
* - Keys: consequentially numbered, without gaps
* - Values: anything, duplicates allowed
* - Ordering: same as input unless when explicitly sorted
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class Sequence extends \PhpCollection\AbstractSequence implements \PhpCollection\SortableInterface
{
public function sortWith($callable)
{
}
}
/**
* Interface that must be implemented by objects that are used as keys, or in sets.
*
* For entities, you can use the "EntityLikeObject" trait.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface ObjectBasics
{
/**
* Produces a hash for the given object.
*
* If two objects are equal (as per the equals() method), the hash() method must produce
* the same hash for them.
*
* The reverse can, but does not necessarily have to be true. That is, if two objects have the
* same hash, they do not necessarily have to be equal, but the equals() method must be called
* to be sure.
*
* When implementing this method try to use a simple and fast algorithm that produces reasonably
* different results for non-equal objects, and shift the heavy comparison logic to equals().
*
* @return string|integer
*/
public function hash();
/**
* Whether two objects are equal.
*
* This can compare by referential equality (===), or in case of value objects like (\DateTime) compare
* the individual properties of the objects; it's up to the implementation.
*
* @return boolean
*/
public function equals(\PhpCollection\ObjectBasics $other);
}
/**
* Registry for handlers that provide ObjectBasics functionality for classes.
*
* You want to register a handler if you cannot implement the ObjectBasics interface, for example
* because a class is provided by a third-party package, or built into PHP.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
abstract class ObjectBasicsHandlerRegistry
{
/**
* Defines an alias.
*
* $aliasClass must be a sub-type (extend or implement) $handlingClass; otherwise you will run into trouble.
*
* Aliases can only be one level deep,
*
* i.e. aliasClass -> handlingClass is supported,
* but aliasClass -> anotherAliasClass -> handlingClass is not.
*
* @param string $handlingClass The class that should be aliased, i.e. MyDateTime
* @param string $aliasClass The class that should be used instead, i.e. DateTime
*/
public static function addAliasFor($handlingClass, $aliasClass)
{
}
public static function addHandlerFor($handlingClass, $handlerInstanceOrClassName)
{
}
public static function getHandler($className)
{
}
}
}
namespace Symfony\Polyfill\Php55 {
/**
* @internal
*/
final class Php55
{
public static function boolval($val)
{
}
public static function json_last_error_msg()
{
}
/**
* @author Sebastiaan Stok <s.stok@rollerscapes.net>
*/
public static function hash_pbkdf2($algorithm, $password, $salt, $iterations, $length = 0, $rawOutput = false)
{
}
}
/**
* @internal
*/
final class Php55ArrayColumn
{
public static function array_column(array $input, $columnKey, $indexKey = null)
{
}
}
}
namespace Symfony\Component\HttpFoundation {
/**
* ParameterBag is a container for key/value pairs.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class ParameterBag implements \IteratorAggregate, \Countable
{
/**
* Parameter storage.
*
* @var array
*/
protected $parameters;
/**
* Constructor.
*
* @param array $parameters An array of parameters
*/
public function __construct(array $parameters = array())
{
}
/**
* Returns the parameters.
*
* @return array An array of parameters
*/
public function all()
{
}
/**
* Returns the parameter keys.
*
* @return array An array of parameter keys
*/
public function keys()
{
}
/**
* Replaces the current parameters by a new set.
*
* @param array $parameters An array of parameters
*/
public function replace(array $parameters = array())
{
}
/**
* Adds parameters.
*
* @param array $parameters An array of parameters
*/
public function add(array $parameters = array())
{
}
/**
* Returns a parameter by name.
*
* Note: Finding deep items is deprecated since version 2.8, to be removed in 3.0.
*
* @param string $key The key
* @param mixed $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return mixed
*
* @throws \InvalidArgumentException
*/
public function get($key, $default = null, $deep = false)
{
}
/**
* Sets a parameter by name.
*
* @param string $key The key
* @param mixed $value The value
*/
public function set($key, $value)
{
}
/**
* Returns true if the parameter is defined.
*
* @param string $key The key
*
* @return bool true if the parameter exists, false otherwise
*/
public function has($key)
{
}
/**
* Removes a parameter.
*
* @param string $key The key
*/
public function remove($key)
{
}
/**
* Returns the alphabetic characters of the parameter value.
*
* @param string $key The parameter key
* @param string $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return string The filtered value
*/
public function getAlpha($key, $default = '', $deep = false)
{
}
/**
* Returns the alphabetic characters and digits of the parameter value.
*
* @param string $key The parameter key
* @param string $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return string The filtered value
*/
public function getAlnum($key, $default = '', $deep = false)
{
}
/**
* Returns the digits of the parameter value.
*
* @param string $key The parameter key
* @param string $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return string The filtered value
*/
public function getDigits($key, $default = '', $deep = false)
{
}
/**
* Returns the parameter value converted to integer.
*
* @param string $key The parameter key
* @param int $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return int The filtered value
*/
public function getInt($key, $default = 0, $deep = false)
{
}
/**
* Returns the parameter value converted to boolean.
*
* @param string $key The parameter key
* @param mixed $default The default value if the parameter key does not exist
* @param bool $deep If true, a path like foo[bar] will find deeper items
*
* @return bool The filtered value
*/
public function getBoolean($key, $default = false, $deep = false)
{
}
/**
* Filter key.
*
* @param string $key Key.
* @param mixed $default Default = null.
* @param int $filter FILTER_* constant.
* @param mixed $options Filter options.
* @param bool $deep Default = false.
*
* @see http://php.net/manual/en/function.filter-var.php
*
* @return mixed
*/
public function filter($key, $default = null, $filter = FILTER_DEFAULT, $options = array(), $deep = false)
{
}
/**
* Returns an iterator for parameters.
*
* @return \ArrayIterator An \ArrayIterator instance
*/
public function getIterator()
{
}
/**
* Returns the number of parameters.
*
* @return int The number of parameters
*/
public function count()
{
}
}
/**
* FileBag is a container for uploaded files.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Bulat Shakirzyanov <mallluhuct@gmail.com>
*/
class FileBag extends \Symfony\Component\HttpFoundation\ParameterBag
{
/**
* Constructor.
*
* @param array $parameters An array of HTTP files
*/
public function __construct(array $parameters = array())
{
}
/**
* {@inheritdoc}
*/
public function replace(array $files = array())
{
}
/**
* {@inheritdoc}
*/
public function set($key, $value)
{
}
/**
* {@inheritdoc}
*/
public function add(array $files = array())
{
}
/**
* Converts uploaded files to UploadedFile instances.
*
* @param array|UploadedFile $file A (multi-dimensional) array of uploaded file information
*
* @return array A (multi-dimensional) array of UploadedFile instances
*/
protected function convertFileInformation($file)
{
}
/**
* Fixes a malformed PHP $_FILES array.
*
* PHP has a bug that the format of the $_FILES array differs, depending on
* whether the uploaded file fields had normal field names or array-like
* field names ("normal" vs. "parent[child]").
*
* This method fixes the array to look like the "normal" $_FILES array.
*
* It's safe to pass an already converted array, in which case this method
* just returns the original array unmodified.
*
* @param array $data
*
* @return array
*/
protected function fixPhpFilesArray($data)
{
}
}
}
namespace Symfony\Component\HttpFoundation\Session {
/**
* Interface for the session.
*
* @author Drak <drak@zikula.org>
*/
interface SessionInterface
{
/**
* Starts the session storage.
*
* @return bool True if session started.
*
* @throws \RuntimeException If session fails to start.
*/
public function start();
/**
* Returns the session ID.
*
* @return string The session ID.
*/
public function getId();
/**
* Sets the session ID.
*
* @param string $id
*/
public function setId($id);
/**
* Returns the session name.
*
* @return mixed The session name.
*/
public function getName();
/**
* Sets the session name.
*
* @param string $name
*/
public function setName($name);
/**
* Invalidates the current session.
*
* Clears all session attributes and flashes and regenerates the
* session and deletes the old session from persistence.
*
* @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
* will leave the system settings unchanged, 0 sets the cookie
* to expire with browser session. Time is in seconds, and is
* not a Unix timestamp.
*
* @return bool True if session invalidated, false if error.
*/
public function invalidate($lifetime = null);
/**
* Migrates the current session to a new session id while maintaining all
* session attributes.
*
* @param bool $destroy Whether to delete the old session or leave it to garbage collection.
* @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
* will leave the system settings unchanged, 0 sets the cookie
* to expire with browser session. Time is in seconds, and is
* not a Unix timestamp.
*
* @return bool True if session migrated, false if error.
*/
public function migrate($destroy = false, $lifetime = null);
/**
* Force the session to be saved and closed.
*
* This method is generally not required for real sessions as
* the session will be automatically saved at the end of
* code execution.
*/
public function save();
/**
* Checks if an attribute is defined.
*
* @param string $name The attribute name
*
* @return bool true if the attribute is defined, false otherwise
*/
public function has($name);
/**
* Returns an attribute.
*
* @param string $name The attribute name
* @param mixed $default The default value if not found.
*
* @return mixed
*/
public function get($name, $default = null);
/**
* Sets an attribute.
*
* @param string $name
* @param mixed $value
*/
public function set($name, $value);
/**
* Returns attributes.
*
* @return array Attributes
*/
public function all();
/**
* Sets attributes.
*
* @param array $attributes Attributes
*/
public function replace(array $attributes);
/**
* Removes an attribute.
*
* @param string $name
*
* @return mixed The removed value or null when it does not exist
*/
public function remove($name);
/**
* Clears all attributes.
*/
public function clear();
/**
* Checks if the session was started.
*
* @return bool
*/
public function isStarted();
/**
* Registers a SessionBagInterface with the session.
*
* @param SessionBagInterface $bag
*/
public function registerBag(\Symfony\Component\HttpFoundation\Session\SessionBagInterface $bag);
/**
* Gets a bag instance by name.
*
* @param string $name
*
* @return SessionBagInterface
*/
public function getBag($name);
/**
* Gets session meta.
*
* @return MetadataBag
*/
public function getMetadataBag();
}
/**
* Session.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Drak <drak@zikula.org>
*/
class Session implements \Symfony\Component\HttpFoundation\Session\SessionInterface, \IteratorAggregate, \Countable
{
/**
* Storage driver.
*
* @var SessionStorageInterface
*/
protected $storage;
/**
* Constructor.
*
* @param SessionStorageInterface $storage A SessionStorageInterface instance.
* @param AttributeBagInterface $attributes An AttributeBagInterface instance, (defaults null for default AttributeBag)
* @param FlashBagInterface $flashes A FlashBagInterface instance (defaults null for default FlashBag)
*/
public function __construct(\Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface $storage = null, \Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface $attributes = null, \Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface $flashes = null)
{
}
/**
* {@inheritdoc}
*/
public function start()
{
}
/**
* {@inheritdoc}
*/
public function has($name)
{
}
/**
* {@inheritdoc}
*/
public function get($name, $default = null)
{
}
/**
* {@inheritdoc}
*/
public function set($name, $value)
{
}
/**
* {@inheritdoc}
*/
public function all()
{
}
/**
* {@inheritdoc}
*/
public function replace(array $attributes)
{
}
/**
* {@inheritdoc}
*/
public function remove($name)
{
}
/**
* {@inheritdoc}
*/
public function clear()
{
}
/**
* {@inheritdoc}
*/
public function isStarted()
{
}
/**
* Returns an iterator for attributes.
*
* @return \ArrayIterator An \ArrayIterator instance
*/
public function getIterator()
{
}
/**
* Returns the number of attributes.
*
* @return int The number of attributes
*/
public function count()
{
}
/**
* {@inheritdoc}
*/
public function invalidate($lifetime = null)
{
}
/**
* {@inheritdoc}
*/
public function migrate($destroy = false, $lifetime = null)
{
}
/**
* {@inheritdoc}
*/
public function save()
{
}
/**
* {@inheritdoc}
*/
public function getId()
{
}
/**
* {@inheritdoc}
*/
public function setId($id)
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
public function setName($name)
{
}
/**
* {@inheritdoc}
*/
public function getMetadataBag()
{
}
/**
* {@inheritdoc}
*/
public function registerBag(\Symfony\Component\HttpFoundation\Session\SessionBagInterface $bag)
{
}
/**
* {@inheritdoc}
*/
public function getBag($name)
{
}
/**
* Gets the flashbag interface.
*
* @return FlashBagInterface
*/
public function getFlashBag()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Session\Storage {
/**
* StorageInterface.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Drak <drak@zikula.org>
*/
interface SessionStorageInterface
{
/**
* Starts the session.
*
* @return bool True if started.
*
* @throws \RuntimeException If something goes wrong starting the session.
*/
public function start();
/**
* Checks if the session is started.
*
* @return bool True if started, false otherwise.
*/
public function isStarted();
/**
* Returns the session ID.
*
* @return string The session ID or empty.
*/
public function getId();
/**
* Sets the session ID.
*
* @param string $id
*/
public function setId($id);
/**
* Returns the session name.
*
* @return mixed The session name.
*/
public function getName();
/**
* Sets the session name.
*
* @param string $name
*/
public function setName($name);
/**
* Regenerates id that represents this storage.
*
* This method must invoke session_regenerate_id($destroy) unless
* this interface is used for a storage object designed for unit
* or functional testing where a real PHP session would interfere
* with testing.
*
* Note regenerate+destroy should not clear the session data in memory
* only delete the session data from persistent storage.
*
* Care: When regenerating the session ID no locking is involved in PHP's
* session design. See https://bugs.php.net/bug.php?id=61470 for a discussion.
* So you must make sure the regenerated session is saved BEFORE sending the
* headers with the new ID. Symfony's HttpKernel offers a listener for this.
* See Symfony\Component\HttpKernel\EventListener\SaveSessionListener.
* Otherwise session data could get lost again for concurrent requests with the
* new ID. One result could be that you get logged out after just logging in.
*
* @param bool $destroy Destroy session when regenerating?
* @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
* will leave the system settings unchanged, 0 sets the cookie
* to expire with browser session. Time is in seconds, and is
* not a Unix timestamp.
*
* @return bool True if session regenerated, false if error
*
* @throws \RuntimeException If an error occurs while regenerating this storage
*/
public function regenerate($destroy = false, $lifetime = null);
/**
* Force the session to be saved and closed.
*
* This method must invoke session_write_close() unless this interface is
* used for a storage object design for unit or functional testing where
* a real PHP session would interfere with testing, in which case
* it should actually persist the session data if required.
*
* @throws \RuntimeException If the session is saved without being started, or if the session
* is already closed.
*/
public function save();
/**
* Clear all session data in memory.
*/
public function clear();
/**
* Gets a SessionBagInterface by name.
*
* @param string $name
*
* @return SessionBagInterface
*
* @throws \InvalidArgumentException If the bag does not exist
*/
public function getBag($name);
/**
* Registers a SessionBagInterface for use.
*
* @param SessionBagInterface $bag
*/
public function registerBag(\Symfony\Component\HttpFoundation\Session\SessionBagInterface $bag);
/**
* @return MetadataBag
*/
public function getMetadataBag();
}
/**
* This provides a base class for session attribute storage.
*
* @author Drak <drak@zikula.org>
*/
class NativeSessionStorage implements \Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface
{
/**
* Array of SessionBagInterface.
*
* @var SessionBagInterface[]
*/
protected $bags;
/**
* @var bool
*/
protected $started = false;
/**
* @var bool
*/
protected $closed = false;
/**
* @var AbstractProxy
*/
protected $saveHandler;
/**
* @var MetadataBag
*/
protected $metadataBag;
/**
* Constructor.
*
* Depending on how you want the storage driver to behave you probably
* want to override this constructor entirely.
*
* List of options for $options array with their defaults.
*
* @see http://php.net/session.configuration for options
* but we omit 'session.' from the beginning of the keys for convenience.
*
* ("auto_start", is not supported as it tells PHP to start a session before
* PHP starts to execute user-land code. Setting during runtime has no effect).
*
* cache_limiter, "" (use "0" to prevent headers from being sent entirely).
* cookie_domain, ""
* cookie_httponly, ""
* cookie_lifetime, "0"
* cookie_path, "/"
* cookie_secure, ""
* entropy_file, ""
* entropy_length, "0"
* gc_divisor, "100"
* gc_maxlifetime, "1440"
* gc_probability, "1"
* hash_bits_per_character, "4"
* hash_function, "0"
* name, "PHPSESSID"
* referer_check, ""
* serialize_handler, "php"
* use_cookies, "1"
* use_only_cookies, "1"
* use_trans_sid, "0"
* upload_progress.enabled, "1"
* upload_progress.cleanup, "1"
* upload_progress.prefix, "upload_progress_"
* upload_progress.name, "PHP_SESSION_UPLOAD_PROGRESS"
* upload_progress.freq, "1%"
* upload_progress.min-freq, "1"
* url_rewriter.tags, "a=href,area=href,frame=src,form=,fieldset="
*
* @param array $options Session configuration options.
* @param AbstractProxy|NativeSessionHandler|\SessionHandlerInterface|null $handler
* @param MetadataBag $metaBag MetadataBag.
*/
public function __construct(array $options = array(), $handler = null, \Symfony\Component\HttpFoundation\Session\Storage\MetadataBag $metaBag = null)
{
}
/**
* Gets the save handler instance.
*
* @return AbstractProxy
*/
public function getSaveHandler()
{
}
/**
* {@inheritdoc}
*/
public function start()
{
}
/**
* {@inheritdoc}
*/
public function getId()
{
}
/**
* {@inheritdoc}
*/
public function setId($id)
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
public function setName($name)
{
}
/**
* {@inheritdoc}
*/
public function regenerate($destroy = false, $lifetime = null)
{
}
/**
* {@inheritdoc}
*/
public function save()
{
}
/**
* {@inheritdoc}
*/
public function clear()
{
}
/**
* {@inheritdoc}
*/
public function registerBag(\Symfony\Component\HttpFoundation\Session\SessionBagInterface $bag)
{
}
/**
* {@inheritdoc}
*/
public function getBag($name)
{
}
/**
* Sets the MetadataBag.
*
* @param MetadataBag $metaBag
*/
public function setMetadataBag(\Symfony\Component\HttpFoundation\Session\Storage\MetadataBag $metaBag = null)
{
}
/**
* Gets the MetadataBag.
*
* @return MetadataBag
*/
public function getMetadataBag()
{
}
/**
* {@inheritdoc}
*/
public function isStarted()
{
}
/**
* Sets session.* ini variables.
*
* For convenience we omit 'session.' from the beginning of the keys.
* Explicitly ignores other ini keys.
*
* @param array $options Session ini directives array(key => value).
*
* @see http://php.net/session.configuration
*/
public function setOptions(array $options)
{
}
/**
* Registers session save handler as a PHP session handler.
*
* To use internal PHP session save handlers, override this method using ini_set with
* session.save_handler and session.save_path e.g.
*
* ini_set('session.save_handler', 'files');
* ini_set('session.save_path', '/tmp');
*
* or pass in a NativeSessionHandler instance which configures session.save_handler in the
* constructor, for a template see NativeFileSessionHandler or use handlers in
* composer package drak/native-session
*
* @see http://php.net/session-set-save-handler
* @see http://php.net/sessionhandlerinterface
* @see http://php.net/sessionhandler
* @see http://github.com/drak/NativeSession
*
* @param AbstractProxy|NativeSessionHandler|\SessionHandlerInterface|null $saveHandler
*
* @throws \InvalidArgumentException
*/
public function setSaveHandler($saveHandler = null)
{
}
/**
* Load the session with attributes.
*
* After starting the session, PHP retrieves the session from whatever handlers
* are set to (either PHP's internal, or a custom save handler set with session_set_save_handler()).
* PHP takes the return value from the read() handler, unserializes it
* and populates $_SESSION with the result automatically.
*
* @param array|null $session
*/
protected function loadSession(array &$session = null)
{
}
}
/**
* Allows session to be started by PHP and managed by Symfony.
*
* @author Drak <drak@zikula.org>
*/
class PhpBridgeSessionStorage extends \Symfony\Component\HttpFoundation\Session\Storage\NativeSessionStorage
{
/**
* Constructor.
*
* @param AbstractProxy|NativeSessionHandler|\SessionHandlerInterface|null $handler
* @param MetadataBag $metaBag MetadataBag
*/
public function __construct($handler = null, \Symfony\Component\HttpFoundation\Session\Storage\MetadataBag $metaBag = null)
{
}
/**
* {@inheritdoc}
*/
public function start()
{
}
/**
* {@inheritdoc}
*/
public function clear()
{
}
}
/**
* MockArraySessionStorage mocks the session for unit tests.
*
* No PHP session is actually started since a session can be initialized
* and shutdown only once per PHP execution cycle.
*
* When doing functional testing, you should use MockFileSessionStorage instead.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Bulat Shakirzyanov <mallluhuct@gmail.com>
* @author Drak <drak@zikula.org>
*/
class MockArraySessionStorage implements \Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface
{
/**
* @var string
*/
protected $id = '';
/**
* @var string
*/
protected $name;
/**
* @var bool
*/
protected $started = false;
/**
* @var bool
*/
protected $closed = false;
/**
* @var array
*/
protected $data = array();
/**
* @var MetadataBag
*/
protected $metadataBag;
/**
* @var array
*/
protected $bags;
/**
* Constructor.
*
* @param string $name Session name
* @param MetadataBag $metaBag MetadataBag instance.
*/
public function __construct($name = 'MOCKSESSID', \Symfony\Component\HttpFoundation\Session\Storage\MetadataBag $metaBag = null)
{
}
/**
* Sets the session data.
*
* @param array $array
*/
public function setSessionData(array $array)
{
}
/**
* {@inheritdoc}
*/
public function start()
{
}
/**
* {@inheritdoc}
*/
public function regenerate($destroy = false, $lifetime = null)
{
}
/**
* {@inheritdoc}
*/
public function getId()
{
}
/**
* {@inheritdoc}
*/
public function setId($id)
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
public function setName($name)
{
}
/**
* {@inheritdoc}
*/
public function save()
{
}
/**
* {@inheritdoc}
*/
public function clear()
{
}
/**
* {@inheritdoc}
*/
public function registerBag(\Symfony\Component\HttpFoundation\Session\SessionBagInterface $bag)
{
}
/**
* {@inheritdoc}
*/
public function getBag($name)
{
}
/**
* {@inheritdoc}
*/
public function isStarted()
{
}
/**
* Sets the MetadataBag.
*
* @param MetadataBag $bag
*/
public function setMetadataBag(\Symfony\Component\HttpFoundation\Session\Storage\MetadataBag $bag = null)
{
}
/**
* Gets the MetadataBag.
*
* @return MetadataBag
*/
public function getMetadataBag()
{
}
/**
* Generates a session ID.
*
* This doesn't need to be particularly cryptographically secure since this is just
* a mock.
*
* @return string
*/
protected function generateId()
{
}
protected function loadSession()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Session\Storage\Proxy {
/**
* AbstractProxy.
*
* @author Drak <drak@zikula.org>
*/
abstract class AbstractProxy
{
/**
* Flag if handler wraps an internal PHP session handler (using \SessionHandler).
*
* @var bool
*/
protected $wrapper = false;
/**
* @var bool
*/
protected $active = false;
/**
* @var string
*/
protected $saveHandlerName;
/**
* Gets the session.save_handler name.
*
* @return string
*/
public function getSaveHandlerName()
{
}
/**
* Is this proxy handler and instance of \SessionHandlerInterface.
*
* @return bool
*/
public function isSessionHandlerInterface()
{
}
/**
* Returns true if this handler wraps an internal PHP session save handler using \SessionHandler.
*
* @return bool
*/
public function isWrapper()
{
}
/**
* Has a session started?
*
* @return bool
*/
public function isActive()
{
}
/**
* Sets the active flag.
*
* Has no effect under PHP 5.4+ as status is detected
* automatically in isActive()
*
* @internal
*
* @param bool $flag
*
* @throws \LogicException
*/
public function setActive($flag)
{
}
/**
* Gets the session ID.
*
* @return string
*/
public function getId()
{
}
/**
* Sets the session ID.
*
* @param string $id
*
* @throws \LogicException
*/
public function setId($id)
{
}
/**
* Gets the session name.
*
* @return string
*/
public function getName()
{
}
/**
* Sets the session name.
*
* @param string $name
*
* @throws \LogicException
*/
public function setName($name)
{
}
}
/**
* SessionHandler proxy.
*
* @author Drak <drak@zikula.org>
*/
class SessionHandlerProxy extends \Symfony\Component\HttpFoundation\Session\Storage\Proxy\AbstractProxy implements \SessionHandlerInterface
{
/**
* @var \SessionHandlerInterface
*/
protected $handler;
/**
* Constructor.
*
* @param \SessionHandlerInterface $handler
*/
public function __construct(\SessionHandlerInterface $handler)
{
}
// \SessionHandlerInterface
/**
* {@inheritdoc}
*/
public function open($savePath, $sessionName)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function read($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function write($sessionId, $data)
{
}
/**
* {@inheritdoc}
*/
public function destroy($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function gc($maxlifetime)
{
}
}
/**
* NativeProxy.
*
* This proxy is built-in session handlers in PHP 5.3.x
*
* @author Drak <drak@zikula.org>
*/
class NativeProxy extends \Symfony\Component\HttpFoundation\Session\Storage\Proxy\AbstractProxy
{
/**
* Constructor.
*/
public function __construct()
{
}
/**
* Returns true if this handler wraps an internal PHP session save handler using \SessionHandler.
*
* @return bool False.
*/
public function isWrapper()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Session\Storage {
/**
* MockFileSessionStorage is used to mock sessions for
* functional testing when done in a single PHP process.
*
* No PHP session is actually started since a session can be initialized
* and shutdown only once per PHP execution cycle and this class does
* not pollute any session related globals, including session_*() functions
* or session.* PHP ini directives.
*
* @author Drak <drak@zikula.org>
*/
class MockFileSessionStorage extends \Symfony\Component\HttpFoundation\Session\Storage\MockArraySessionStorage
{
/**
* Constructor.
*
* @param string $savePath Path of directory to save session files.
* @param string $name Session name.
* @param MetadataBag $metaBag MetadataBag instance.
*/
public function __construct($savePath = null, $name = 'MOCKSESSID', \Symfony\Component\HttpFoundation\Session\Storage\MetadataBag $metaBag = null)
{
}
/**
* {@inheritdoc}
*/
public function start()
{
}
/**
* {@inheritdoc}
*/
public function regenerate($destroy = false, $lifetime = null)
{
}
/**
* {@inheritdoc}
*/
public function save()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Session\Storage\Handler {
/**
* MemcachedSessionHandler.
*
* Memcached based session storage handler based on the Memcached class
* provided by the PHP memcached extension.
*
* @see http://php.net/memcached
*
* @author Drak <drak@zikula.org>
*/
class MemcachedSessionHandler implements \SessionHandlerInterface
{
/**
* Constructor.
*
* List of available options:
* * prefix: The prefix to use for the memcached keys in order to avoid collision
* * expiretime: The time to live in seconds
*
* @param \Memcached $memcached A \Memcached instance
* @param array $options An associative array of Memcached options
*
* @throws \InvalidArgumentException When unsupported options are passed
*/
public function __construct(\Memcached $memcached, array $options = array())
{
}
/**
* {@inheritdoc}
*/
public function open($savePath, $sessionName)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function read($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function write($sessionId, $data)
{
}
/**
* {@inheritdoc}
*/
public function destroy($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function gc($maxlifetime)
{
}
/**
* Return a Memcached instance.
*
* @return \Memcached
*/
protected function getMemcached()
{
}
}
/**
* MemcacheSessionHandler.
*
* @author Drak <drak@zikula.org>
*/
class MemcacheSessionHandler implements \SessionHandlerInterface
{
/**
* Constructor.
*
* List of available options:
* * prefix: The prefix to use for the memcache keys in order to avoid collision
* * expiretime: The time to live in seconds
*
* @param \Memcache $memcache A \Memcache instance
* @param array $options An associative array of Memcache options
*
* @throws \InvalidArgumentException When unsupported options are passed
*/
public function __construct(\Memcache $memcache, array $options = array())
{
}
/**
* {@inheritdoc}
*/
public function open($savePath, $sessionName)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function read($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function write($sessionId, $data)
{
}
/**
* {@inheritdoc}
*/
public function destroy($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function gc($maxlifetime)
{
}
/**
* Return a Memcache instance.
*
* @return \Memcache
*/
protected function getMemcache()
{
}
}
/**
* MongoDB session handler.
*
* @author Markus Bachmann <markus.bachmann@bachi.biz>
*/
class MongoDbSessionHandler implements \SessionHandlerInterface
{
/**
* Constructor.
*
* List of available options:
* * database: The name of the database [required]
* * collection: The name of the collection [required]
* * id_field: The field name for storing the session id [default: _id]
* * data_field: The field name for storing the session data [default: data]
* * time_field: The field name for storing the timestamp [default: time]
* * expiry_field: The field name for storing the expiry-timestamp [default: expires_at]
*
* It is strongly recommended to put an index on the `expiry_field` for
* garbage-collection. Alternatively it's possible to automatically expire
* the sessions in the database as described below:
*
* A TTL collections can be used on MongoDB 2.2+ to cleanup expired sessions
* automatically. Such an index can for example look like this:
*
* db.<session-collection>.ensureIndex(
* { "<expiry-field>": 1 },
* { "expireAfterSeconds": 0 }
* )
*
* More details on: http://docs.mongodb.org/manual/tutorial/expire-data/
*
* If you use such an index, you can drop `gc_probability` to 0 since
* no garbage-collection is required.
*
* @param \Mongo|\MongoClient $mongo A MongoClient or Mongo instance
* @param array $options An associative array of field options
*
* @throws \InvalidArgumentException When MongoClient or Mongo instance not provided
* @throws \InvalidArgumentException When "database" or "collection" not provided
*/
public function __construct($mongo, array $options)
{
}
/**
* {@inheritdoc}
*/
public function open($savePath, $sessionName)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function destroy($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function gc($maxlifetime)
{
}
/**
* {@inheritdoc}
*/
public function write($sessionId, $data)
{
}
/**
* {@inheritdoc}
*/
public function read($sessionId)
{
}
/**
* Return a Mongo instance.
*
* @return \Mongo
*/
protected function getMongo()
{
}
}
/**
* NullSessionHandler.
*
* Can be used in unit testing or in a situations where persisted sessions are not desired.
*
* @author Drak <drak@zikula.org>
*/
class NullSessionHandler implements \SessionHandlerInterface
{
/**
* {@inheritdoc}
*/
public function open($savePath, $sessionName)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function read($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function write($sessionId, $data)
{
}
/**
* {@inheritdoc}
*/
public function destroy($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function gc($maxlifetime)
{
}
}
/**
* Session handler using a PDO connection to read and write data.
*
* It works with MySQL, PostgreSQL, Oracle, SQL Server and SQLite and implements
* different locking strategies to handle concurrent access to the same session.
* Locking is necessary to prevent loss of data due to race conditions and to keep
* the session data consistent between read() and write(). With locking, requests
* for the same session will wait until the other one finished writing. For this
* reason it's best practice to close a session as early as possible to improve
* concurrency. PHPs internal files session handler also implements locking.
*
* Attention: Since SQLite does not support row level locks but locks the whole database,
* it means only one session can be accessed at a time. Even different sessions would wait
* for another to finish. So saving session in SQLite should only be considered for
* development or prototypes.
*
* Session data is a binary string that can contain non-printable characters like the null byte.
* For this reason it must be saved in a binary column in the database like BLOB in MySQL.
* Saving it in a character column could corrupt the data. You can use createTable()
* to initialize a correctly defined table.
*
* @see http://php.net/sessionhandlerinterface
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Michael Williams <michael.williams@funsational.com>
* @author Tobias Schultze <http://tobion.de>
*/
class PdoSessionHandler implements \SessionHandlerInterface
{
/**
* No locking is done. This means sessions are prone to loss of data due to
* race conditions of concurrent requests to the same session. The last session
* write will win in this case. It might be useful when you implement your own
* logic to deal with this like an optimistic approach.
*/
const LOCK_NONE = 0;
/**
* Creates an application-level lock on a session. The disadvantage is that the
* lock is not enforced by the database and thus other, unaware parts of the
* application could still concurrently modify the session. The advantage is it
* does not require a transaction.
* This mode is not available for SQLite and not yet implemented for oci and sqlsrv.
*/
const LOCK_ADVISORY = 1;
/**
* Issues a real row lock. Since it uses a transaction between opening and
* closing a session, you have to be careful when you use same database connection
* that you also use for your application logic. This mode is the default because
* it's the only reliable solution across DBMSs.
*/
const LOCK_TRANSACTIONAL = 2;
/**
* Constructor.
*
* You can either pass an existing database connection as PDO instance or
* pass a DSN string that will be used to lazy-connect to the database
* when the session is actually used. Furthermore it's possible to pass null
* which will then use the session.save_path ini setting as PDO DSN parameter.
*
* List of available options:
* * db_table: The name of the table [default: sessions]
* * db_id_col: The column where to store the session id [default: sess_id]
* * db_data_col: The column where to store the session data [default: sess_data]
* * db_lifetime_col: The column where to store the lifetime [default: sess_lifetime]
* * db_time_col: The column where to store the timestamp [default: sess_time]
* * db_username: The username when lazy-connect [default: '']
* * db_password: The password when lazy-connect [default: '']
* * db_connection_options: An array of driver-specific connection options [default: array()]
* * lock_mode: The strategy for locking, see constants [default: LOCK_TRANSACTIONAL]
*
* @param \PDO|string|null $pdoOrDsn A \PDO instance or DSN string or null
* @param array $options An associative array of options
*
* @throws \InvalidArgumentException When PDO error mode is not PDO::ERRMODE_EXCEPTION
*/
public function __construct($pdoOrDsn = null, array $options = array())
{
}
/**
* Creates the table to store sessions which can be called once for setup.
*
* Session ID is saved in a column of maximum length 128 because that is enough even
* for a 512 bit configured session.hash_function like Whirlpool. Session data is
* saved in a BLOB. One could also use a shorter inlined varbinary column
* if one was sure the data fits into it.
*
* @throws \PDOException When the table already exists
* @throws \DomainException When an unsupported PDO driver is used
*/
public function createTable()
{
}
/**
* Returns true when the current session exists but expired according to session.gc_maxlifetime.
*
* Can be used to distinguish between a new session and one that expired due to inactivity.
*
* @return bool Whether current session expired
*/
public function isSessionExpired()
{
}
/**
* {@inheritdoc}
*/
public function open($savePath, $sessionName)
{
}
/**
* {@inheritdoc}
*/
public function read($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function gc($maxlifetime)
{
}
/**
* {@inheritdoc}
*/
public function destroy($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function write($sessionId, $data)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* Return a PDO instance.
*
* @return \PDO
*/
protected function getConnection()
{
}
}
class NativeSessionHandler extends \SessionHandler
{
}
/**
* NativeFileSessionHandler.
*
* Native session handler using PHP's built in file storage.
*
* @author Drak <drak@zikula.org>
*/
class NativeFileSessionHandler extends \Symfony\Component\HttpFoundation\Session\Storage\Handler\NativeSessionHandler
{
/**
* Constructor.
*
* @param string $savePath Path of directory to save session files.
* Default null will leave setting as defined by PHP.
* '/path', 'N;/path', or 'N;octal-mode;/path
*
* @see http://php.net/session.configuration.php#ini.session.save-path for further details.
*
* @throws \InvalidArgumentException On invalid $savePath
*/
public function __construct($savePath = null)
{
}
}
/**
* Session handler using a PDO connection to read and write data.
*
* Session data is a binary string that can contain non-printable characters like the null byte.
* For this reason this handler base64 encodes the data to be able to save it in a character column.
*
* This version of the PdoSessionHandler does NOT implement locking. So concurrent requests to the
* same session can result in data loss due to race conditions.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Michael Williams <michael.williams@funsational.com>
* @author Tobias Schultze <http://tobion.de>
*
* @deprecated since version 2.6, to be removed in 3.0. Use
* {@link PdoSessionHandler} instead.
*/
class LegacyPdoSessionHandler implements \SessionHandlerInterface
{
/**
* Constructor.
*
* List of available options:
* * db_table: The name of the table [required]
* * db_id_col: The column where to store the session id [default: sess_id]
* * db_data_col: The column where to store the session data [default: sess_data]
* * db_time_col: The column where to store the timestamp [default: sess_time]
*
* @param \PDO $pdo A \PDO instance
* @param array $dbOptions An associative array of DB options
*
* @throws \InvalidArgumentException When "db_table" option is not provided
*/
public function __construct(\PDO $pdo, array $dbOptions = array())
{
}
/**
* {@inheritdoc}
*/
public function open($savePath, $sessionName)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function destroy($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function gc($maxlifetime)
{
}
/**
* {@inheritdoc}
*/
public function read($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function write($sessionId, $data)
{
}
/**
* Return a PDO instance.
*
* @return \PDO
*/
protected function getConnection()
{
}
}
/**
* Wraps another SessionHandlerInterface to only write the session when it has been modified.
*
* @author Adrien Brault <adrien.brault@gmail.com>
*/
class WriteCheckSessionHandler implements \SessionHandlerInterface
{
public function __construct(\SessionHandlerInterface $wrappedSessionHandler)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function destroy($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function gc($maxlifetime)
{
}
/**
* {@inheritdoc}
*/
public function open($savePath, $sessionName)
{
}
/**
* {@inheritdoc}
*/
public function read($sessionId)
{
}
/**
* {@inheritdoc}
*/
public function write($sessionId, $data)
{
}
}
}
namespace Symfony\Component\HttpFoundation\Session {
/**
* Session Bag store.
*
* @author Drak <drak@zikula.org>
*/
interface SessionBagInterface
{
/**
* Gets this bag's name.
*
* @return string
*/
public function getName();
/**
* Initializes the Bag.
*
* @param array $array
*/
public function initialize(array &$array);
/**
* Gets the storage key for this bag.
*
* @return string
*/
public function getStorageKey();
/**
* Clears out data from bag.
*
* @return mixed Whatever data was contained.
*/
public function clear();
}
}
namespace Symfony\Component\HttpFoundation\Session\Storage {
/**
* Metadata container.
*
* Adds metadata to the session.
*
* @author Drak <drak@zikula.org>
*/
class MetadataBag implements \Symfony\Component\HttpFoundation\Session\SessionBagInterface
{
const CREATED = 'c';
const UPDATED = 'u';
const LIFETIME = 'l';
/**
* @var array
*/
protected $meta = array(self::CREATED => 0, self::UPDATED => 0, self::LIFETIME => 0);
/**
* Constructor.
*
* @param string $storageKey The key used to store bag in the session.
* @param int $updateThreshold The time to wait between two UPDATED updates
*/
public function __construct($storageKey = '_sf2_meta', $updateThreshold = 0)
{
}
/**
* {@inheritdoc}
*/
public function initialize(array &$array)
{
}
/**
* Gets the lifetime that the session cookie was set with.
*
* @return int
*/
public function getLifetime()
{
}
/**
* Stamps a new session's metadata.
*
* @param int $lifetime Sets the cookie lifetime for the session cookie. A null value
* will leave the system settings unchanged, 0 sets the cookie
* to expire with browser session. Time is in seconds, and is
* not a Unix timestamp.
*/
public function stampNew($lifetime = null)
{
}
/**
* {@inheritdoc}
*/
public function getStorageKey()
{
}
/**
* Gets the created timestamp metadata.
*
* @return int Unix timestamp
*/
public function getCreated()
{
}
/**
* Gets the last used metadata.
*
* @return int Unix timestamp
*/
public function getLastUsed()
{
}
/**
* {@inheritdoc}
*/
public function clear()
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* Sets name.
*
* @param string $name
*/
public function setName($name)
{
}
}
}
namespace Symfony\Component\HttpFoundation\Session\Attribute {
/**
* Attributes store.
*
* @author Drak <drak@zikula.org>
*/
interface AttributeBagInterface extends \Symfony\Component\HttpFoundation\Session\SessionBagInterface
{
/**
* Checks if an attribute is defined.
*
* @param string $name The attribute name
*
* @return bool true if the attribute is defined, false otherwise
*/
public function has($name);
/**
* Returns an attribute.
*
* @param string $name The attribute name
* @param mixed $default The default value if not found
*
* @return mixed
*/
public function get($name, $default = null);
/**
* Sets an attribute.
*
* @param string $name
* @param mixed $value
*/
public function set($name, $value);
/**
* Returns attributes.
*
* @return array Attributes
*/
public function all();
/**
* Sets attributes.
*
* @param array $attributes Attributes
*/
public function replace(array $attributes);
/**
* Removes an attribute.
*
* @param string $name
*
* @return mixed The removed value or null when it does not exist
*/
public function remove($name);
}
/**
* This class relates to session attribute storage.
*/
class AttributeBag implements \Symfony\Component\HttpFoundation\Session\Attribute\AttributeBagInterface, \IteratorAggregate, \Countable
{
/**
* @var array
*/
protected $attributes = array();
/**
* Constructor.
*
* @param string $storageKey The key used to store attributes in the session
*/
public function __construct($storageKey = '_sf2_attributes')
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
public function setName($name)
{
}
/**
* {@inheritdoc}
*/
public function initialize(array &$attributes)
{
}
/**
* {@inheritdoc}
*/
public function getStorageKey()
{
}
/**
* {@inheritdoc}
*/
public function has($name)
{
}
/**
* {@inheritdoc}
*/
public function get($name, $default = null)
{
}
/**
* {@inheritdoc}
*/
public function set($name, $value)
{
}
/**
* {@inheritdoc}
*/
public function all()
{
}
/**
* {@inheritdoc}
*/
public function replace(array $attributes)
{
}
/**
* {@inheritdoc}
*/
public function remove($name)
{
}
/**
* {@inheritdoc}
*/
public function clear()
{
}
/**
* Returns an iterator for attributes.
*
* @return \ArrayIterator An \ArrayIterator instance
*/
public function getIterator()
{
}
/**
* Returns the number of attributes.
*
* @return int The number of attributes
*/
public function count()
{
}
}
/**
* This class provides structured storage of session attributes using
* a name spacing character in the key.
*
* @author Drak <drak@zikula.org>
*/
class NamespacedAttributeBag extends \Symfony\Component\HttpFoundation\Session\Attribute\AttributeBag
{
/**
* Constructor.
*
* @param string $storageKey Session storage key.
* @param string $namespaceCharacter Namespace character to use in keys.
*/
public function __construct($storageKey = '_sf2_attributes', $namespaceCharacter = '/')
{
}
/**
* {@inheritdoc}
*/
public function has($name)
{
}
/**
* {@inheritdoc}
*/
public function get($name, $default = null)
{
}
/**
* {@inheritdoc}
*/
public function set($name, $value)
{
}
/**
* {@inheritdoc}
*/
public function remove($name)
{
}
/**
* Resolves a path in attributes property and returns it as a reference.
*
* This method allows structured namespacing of session attributes.
*
* @param string $name Key name
* @param bool $writeContext Write context, default false
*
* @return array
*/
protected function &resolveAttributePath($name, $writeContext = false)
{
}
/**
* Resolves the key from the name.
*
* This is the last part in a dot separated string.
*
* @param string $name
*
* @return string
*/
protected function resolveKey($name)
{
}
}
}
namespace Symfony\Component\HttpFoundation\Session\Flash {
/**
* FlashBagInterface.
*
* @author Drak <drak@zikula.org>
*/
interface FlashBagInterface extends \Symfony\Component\HttpFoundation\Session\SessionBagInterface
{
/**
* Adds a flash message for type.
*
* @param string $type
* @param string $message
*/
public function add($type, $message);
/**
* Registers a message for a given type.
*
* @param string $type
* @param string|array $message
*/
public function set($type, $message);
/**
* Gets flash messages for a given type.
*
* @param string $type Message category type.
* @param array $default Default value if $type does not exist.
*
* @return array
*/
public function peek($type, array $default = array());
/**
* Gets all flash messages.
*
* @return array
*/
public function peekAll();
/**
* Gets and clears flash from the stack.
*
* @param string $type
* @param array $default Default value if $type does not exist.
*
* @return array
*/
public function get($type, array $default = array());
/**
* Gets and clears flashes from the stack.
*
* @return array
*/
public function all();
/**
* Sets all flash messages.
*/
public function setAll(array $messages);
/**
* Has flash messages for a given type?
*
* @param string $type
*
* @return bool
*/
public function has($type);
/**
* Returns a list of all defined types.
*
* @return array
*/
public function keys();
}
/**
* AutoExpireFlashBag flash message container.
*
* @author Drak <drak@zikula.org>
*/
class AutoExpireFlashBag implements \Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface
{
/**
* Constructor.
*
* @param string $storageKey The key used to store flashes in the session.
*/
public function __construct($storageKey = '_sf2_flashes')
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
public function setName($name)
{
}
/**
* {@inheritdoc}
*/
public function initialize(array &$flashes)
{
}
/**
* {@inheritdoc}
*/
public function add($type, $message)
{
}
/**
* {@inheritdoc}
*/
public function peek($type, array $default = array())
{
}
/**
* {@inheritdoc}
*/
public function peekAll()
{
}
/**
* {@inheritdoc}
*/
public function get($type, array $default = array())
{
}
/**
* {@inheritdoc}
*/
public function all()
{
}
/**
* {@inheritdoc}
*/
public function setAll(array $messages)
{
}
/**
* {@inheritdoc}
*/
public function set($type, $messages)
{
}
/**
* {@inheritdoc}
*/
public function has($type)
{
}
/**
* {@inheritdoc}
*/
public function keys()
{
}
/**
* {@inheritdoc}
*/
public function getStorageKey()
{
}
/**
* {@inheritdoc}
*/
public function clear()
{
}
}
/**
* FlashBag flash message container.
*
* \IteratorAggregate implementation is deprecated and will be removed in 3.0.
*
* @author Drak <drak@zikula.org>
*/
class FlashBag implements \Symfony\Component\HttpFoundation\Session\Flash\FlashBagInterface, \IteratorAggregate
{
/**
* Constructor.
*
* @param string $storageKey The key used to store flashes in the session.
*/
public function __construct($storageKey = '_sf2_flashes')
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
public function setName($name)
{
}
/**
* {@inheritdoc}
*/
public function initialize(array &$flashes)
{
}
/**
* {@inheritdoc}
*/
public function add($type, $message)
{
}
/**
* {@inheritdoc}
*/
public function peek($type, array $default = array())
{
}
/**
* {@inheritdoc}
*/
public function peekAll()
{
}
/**
* {@inheritdoc}
*/
public function get($type, array $default = array())
{
}
/**
* {@inheritdoc}
*/
public function all()
{
}
/**
* {@inheritdoc}
*/
public function set($type, $messages)
{
}
/**
* {@inheritdoc}
*/
public function setAll(array $messages)
{
}
/**
* {@inheritdoc}
*/
public function has($type)
{
}
/**
* {@inheritdoc}
*/
public function keys()
{
}
/**
* {@inheritdoc}
*/
public function getStorageKey()
{
}
/**
* {@inheritdoc}
*/
public function clear()
{
}
/**
* Returns an iterator for flashes.
*
* @deprecated since version 2.4, to be removed in 3.0.
*
* @return \ArrayIterator An \ArrayIterator instance
*/
public function getIterator()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests {
abstract class ResponseTestCase extends \PHPUnit_Framework_TestCase
{
public function testNoCacheControlHeaderOnAttachmentUsingHTTPSAndMSIE()
{
}
protected abstract function provideResponse();
}
class BinaryFileResponseTest extends \Symfony\Component\HttpFoundation\Tests\ResponseTestCase
{
public function testConstruction()
{
}
public function testConstructWithNonAsciiFilename()
{
}
/**
* @expectedException \LogicException
*/
public function testSetContent()
{
}
public function testGetContent()
{
}
public function testSetContentDispositionGeneratesSafeFallbackFilename()
{
}
/**
* @dataProvider provideRanges
*/
public function testRequests($requestRange, $offset, $length, $responseRange)
{
}
/**
* @dataProvider provideRanges
*/
public function testRequestsWithoutEtag($requestRange, $offset, $length, $responseRange)
{
}
public function provideRanges()
{
}
public function testRangeRequestsWithoutLastModifiedDate()
{
}
/**
* @dataProvider provideFullFileRanges
*/
public function testFullFileRequests($requestRange)
{
}
public function provideFullFileRanges()
{
}
/**
* @dataProvider provideInvalidRanges
*/
public function testInvalidRequests($requestRange)
{
}
public function provideInvalidRanges()
{
}
/**
* @dataProvider provideXSendfileFiles
*/
public function testXSendfile($file)
{
}
public function provideXSendfileFiles()
{
}
/**
* @dataProvider getSampleXAccelMappings
*/
public function testXAccelMapping($realpath, $mapping, $virtual)
{
}
public function testDeleteFileAfterSend()
{
}
public function testAcceptRangeOnUnsafeMethods()
{
}
public function testAcceptRangeNotOverriden()
{
}
public function getSampleXAccelMappings()
{
}
protected function provideResponse()
{
}
public static function tearDownAfterClass()
{
}
}
/**
* CookieTest.
*
* @author John Kary <john@johnkary.net>
* @author Hugo Hamon <hugo.hamon@sensio.com>
*
* @group time-sensitive
*/
class CookieTest extends \PHPUnit_Framework_TestCase
{
public function invalidNames()
{
}
/**
* @dataProvider invalidNames
* @expectedException \InvalidArgumentException
*/
public function testInstantiationThrowsExceptionIfCookieNameContainsInvalidCharacters($name)
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testInvalidExpiration()
{
}
public function testGetValue()
{
}
public function testGetPath()
{
}
public function testGetExpiresTime()
{
}
public function testConstructorWithDateTime()
{
}
/**
* @requires PHP 5.5
*/
public function testConstructorWithDateTimeImmutable()
{
}
public function testGetExpiresTimeWithStringValue()
{
}
public function testGetDomain()
{
}
public function testIsSecure()
{
}
public function testIsHttpOnly()
{
}
public function testCookieIsNotCleared()
{
}
public function testCookieIsCleared()
{
}
public function testToString()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests\Session {
/**
* SessionTest.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Drak <drak@zikula.org>
*/
class SessionTest extends \PHPUnit_Framework_TestCase
{
/**
* @var \Symfony\Component\HttpFoundation\Session\Storage\SessionStorageInterface
*/
protected $storage;
/**
* @var \Symfony\Component\HttpFoundation\Session\SessionInterface
*/
protected $session;
protected function setUp()
{
}
protected function tearDown()
{
}
public function testStart()
{
}
public function testIsStarted()
{
}
public function testSetId()
{
}
public function testSetName()
{
}
public function testGet()
{
}
/**
* @dataProvider setProvider
*/
public function testSet($key, $value)
{
}
/**
* @dataProvider setProvider
*/
public function testHas($key, $value)
{
}
public function testReplace()
{
}
/**
* @dataProvider setProvider
*/
public function testAll($key, $value, $result)
{
}
/**
* @dataProvider setProvider
*/
public function testClear($key, $value)
{
}
public function setProvider()
{
}
/**
* @dataProvider setProvider
*/
public function testRemove($key, $value)
{
}
public function testInvalidate()
{
}
public function testMigrate()
{
}
public function testMigrateDestroy()
{
}
public function testSave()
{
}
public function testGetId()
{
}
public function testGetFlashBag()
{
}
public function testGetIterator()
{
}
public function testGetCount()
{
}
public function testGetMeta()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests\Session\Storage {
/**
* Test class for MetadataBag.
*
* @group time-sensitive
*/
class MetadataBagTest extends \PHPUnit_Framework_TestCase
{
/**
* @var MetadataBag
*/
protected $bag;
/**
* @var array
*/
protected $array = array();
protected function setUp()
{
}
protected function tearDown()
{
}
public function testInitialize()
{
}
public function testGetSetName()
{
}
public function testGetStorageKey()
{
}
public function testGetLifetime()
{
}
public function testGetCreated()
{
}
public function testGetLastUsed()
{
}
public function testClear()
{
}
public function testSkipLastUsedUpdate()
{
}
public function testDoesNotSkipLastUsedUpdate()
{
}
}
/**
* Test class for MockArraySessionStorage.
*
* @author Drak <drak@zikula.org>
*/
class MockArraySessionStorageTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
protected function tearDown()
{
}
public function testStart()
{
}
public function testRegenerate()
{
}
public function testGetId()
{
}
/**
* @expectedException \RuntimeException
*/
public function testUnstartedSave()
{
}
}
/**
* Test class for PhpSessionStorage.
*
* @author Drak <drak@zikula.org>
*
* These tests require separate processes.
*
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
*/
class PhpBridgeSessionStorageTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
protected function tearDown()
{
}
/**
* @return PhpBridgeSessionStorage
*/
protected function getStorage()
{
}
public function testPhpSession53()
{
}
/**
* @requires PHP 5.4
*/
public function testPhpSession54()
{
}
public function testClear()
{
}
}
/**
* Test class for MockFileSessionStorage.
*
* @author Drak <drak@zikula.org>
*/
class MockFileSessionStorageTest extends \PHPUnit_Framework_TestCase
{
/**
* @var MockFileSessionStorage
*/
protected $storage;
protected function setUp()
{
}
protected function tearDown()
{
}
public function testStart()
{
}
public function testRegenerate()
{
}
public function testGetId()
{
}
public function testSave()
{
}
public function testMultipleInstances()
{
}
/**
* @expectedException \RuntimeException
*/
public function testSaveWithoutStart()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests\Session\Storage\Proxy {
// Note until PHPUnit_Mock_Objects 1.2 is released you cannot mock abstracts due to
// https://github.com/sebastianbergmann/phpunit-mock-objects/issues/73
class ConcreteProxy extends \Symfony\Component\HttpFoundation\Session\Storage\Proxy\AbstractProxy
{
}
class ConcreteSessionHandlerInterfaceProxy extends \Symfony\Component\HttpFoundation\Session\Storage\Proxy\AbstractProxy implements \SessionHandlerInterface
{
public function open($savePath, $sessionName)
{
}
public function close()
{
}
public function read($id)
{
}
public function write($id, $data)
{
}
public function destroy($id)
{
}
public function gc($maxlifetime)
{
}
}
/**
* Test class for AbstractProxy.
*
* @author Drak <drak@zikula.org>
*/
class AbstractProxyTest extends \PHPUnit_Framework_TestCase
{
/**
* @var AbstractProxy
*/
protected $proxy;
protected function setUp()
{
}
protected function tearDown()
{
}
public function testGetSaveHandlerName()
{
}
public function testIsSessionHandlerInterface()
{
}
public function testIsWrapper()
{
}
public function testIsActivePhp53()
{
}
/**
* @runInSeparateProcess
* @preserveGlobalState disabled
* @requires PHP 5.4
*/
public function testIsActivePhp54()
{
}
public function testSetActivePhp53()
{
}
/**
* @runInSeparateProcess
* @preserveGlobalState disabled
* @expectedException \LogicException
* @requires PHP 5.4
*/
public function testSetActivePhp54()
{
}
/**
* @runInSeparateProcess
* @preserveGlobalState disabled
*/
public function testName()
{
}
/**
* @expectedException \LogicException
*/
public function testNameExceptionPhp53()
{
}
/**
* @runInSeparateProcess
* @preserveGlobalState disabled
* @expectedException \LogicException
* @requires PHP 5.4
*/
public function testNameExceptionPhp54()
{
}
/**
* @runInSeparateProcess
* @preserveGlobalState disabled
*/
public function testId()
{
}
/**
* @expectedException \LogicException
*/
public function testIdExceptionPhp53()
{
}
/**
* @runInSeparateProcess
* @preserveGlobalState disabled
* @expectedException \LogicException
* @requires PHP 5.4
*/
public function testIdExceptionPhp54()
{
}
}
/**
* Test class for NativeProxy.
*
* @author Drak <drak@zikula.org>
*/
class NativeProxyTest extends \PHPUnit_Framework_TestCase
{
public function testIsWrapper()
{
}
public function testGetSaveHandlerName()
{
}
}
/**
* Tests for SessionHandlerProxy class.
*
* @author Drak <drak@zikula.org>
*
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
*/
class SessionHandlerProxyTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
protected function tearDown()
{
}
public function testOpen()
{
}
public function testOpenFalse()
{
}
public function testClose()
{
}
public function testCloseFalse()
{
}
public function testRead()
{
}
public function testWrite()
{
}
public function testDestroy()
{
}
public function testGc()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests\Session\Storage\Handler {
/**
* @author Adrien Brault <adrien.brault@gmail.com>
*/
class WriteCheckSessionHandlerTest extends \PHPUnit_Framework_TestCase
{
public function test()
{
}
public function testWrite()
{
}
public function testSkippedWrite()
{
}
public function testNonSkippedWrite()
{
}
}
/**
* Test class for NativeSessionHandler.
*
* @author Drak <drak@zikula.org>
*
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
*/
class NativeSessionHandlerTest extends \PHPUnit_Framework_TestCase
{
public function testConstruct()
{
}
}
/**
* @requires extension memcached
* @group time-sensitive
*/
class MemcachedSessionHandlerTest extends \PHPUnit_Framework_TestCase
{
const PREFIX = 'prefix_';
const TTL = 1000;
/**
* @var MemcachedSessionHandler
*/
protected $storage;
protected $memcached;
protected function setUp()
{
}
protected function tearDown()
{
}
public function testOpenSession()
{
}
public function testCloseSession()
{
}
public function testReadSession()
{
}
public function testWriteSession()
{
}
public function testDestroySession()
{
}
public function testGcSession()
{
}
/**
* @dataProvider getOptionFixtures
*/
public function testSupportedOptions($options, $supported)
{
}
public function getOptionFixtures()
{
}
public function testGetConnection()
{
}
}
/**
* @requires extension memcache
* @group time-sensitive
*/
class MemcacheSessionHandlerTest extends \PHPUnit_Framework_TestCase
{
const PREFIX = 'prefix_';
const TTL = 1000;
/**
* @var MemcacheSessionHandler
*/
protected $storage;
protected $memcache;
protected function setUp()
{
}
protected function tearDown()
{
}
public function testOpenSession()
{
}
public function testCloseSession()
{
}
public function testReadSession()
{
}
public function testWriteSession()
{
}
public function testDestroySession()
{
}
public function testGcSession()
{
}
/**
* @dataProvider getOptionFixtures
*/
public function testSupportedOptions($options, $supported)
{
}
public function getOptionFixtures()
{
}
public function testGetConnection()
{
}
}
/**
* @requires extension pdo_sqlite
* @group time-sensitive
*/
class PdoSessionHandlerTest extends \PHPUnit_Framework_TestCase
{
protected function tearDown()
{
}
protected function getPersistentSqliteDsn()
{
}
protected function getMemorySqlitePdo()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testWrongPdoErrMode()
{
}
/**
* @expectedException \RuntimeException
*/
public function testInexistentTable()
{
}
/**
* @expectedException \RuntimeException
*/
public function testCreateTableTwice()
{
}
public function testWithLazyDsnConnection()
{
}
public function testWithLazySavePathConnection()
{
}
public function testReadWriteReadWithNullByte()
{
}
public function testReadConvertsStreamToString()
{
}
public function testReadLockedConvertsStreamToString()
{
}
public function testReadingRequiresExactlySameId()
{
}
/**
* Simulates session_regenerate_id(true) which will require an INSERT or UPDATE (replace).
*/
public function testWriteDifferentSessionIdThanRead()
{
}
public function testWrongUsageStillWorks()
{
}
public function testSessionDestroy()
{
}
public function testSessionGC()
{
}
public function testGetConnection()
{
}
public function testGetConnectionConnectsIfNeeded()
{
}
}
class MockPdo extends \PDO
{
public $prepareResult;
public function __construct($driverName = null, $errorMode = null)
{
}
public function getAttribute($attribute)
{
}
public function prepare($statement, $driverOptions = array())
{
}
public function beginTransaction()
{
}
}
/**
* @author Markus Bachmann <markus.bachmann@bachi.biz>
* @requires extension mongo
* @group time-sensitive
*/
class MongoDbSessionHandlerTest extends \PHPUnit_Framework_TestCase
{
public $options;
protected function setUp()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testConstructorShouldThrowExceptionForInvalidMongo()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testConstructorShouldThrowExceptionForMissingOptions()
{
}
public function testOpenMethodAlwaysReturnTrue()
{
}
public function testCloseMethodAlwaysReturnTrue()
{
}
public function testRead()
{
}
public function testWrite()
{
}
public function testWriteWhenUsingExpiresField()
{
}
public function testReplaceSessionData()
{
}
public function testDestroy()
{
}
public function testGc()
{
}
}
/**
* @group legacy
* @group time-sensitive
* @requires extension pdo_sqlite
*/
class LegacyPdoSessionHandlerTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
public function testIncompleteOptions()
{
}
public function testWrongPdoErrMode()
{
}
public function testWrongTableOptionsWrite()
{
}
public function testWrongTableOptionsRead()
{
}
public function testWriteRead()
{
}
public function testMultipleInstances()
{
}
public function testSessionDestroy()
{
}
public function testSessionGC()
{
}
public function testGetConnection()
{
}
}
/**
* Test class for NullSessionHandler.
*
* @author Drak <drak@zikula.org>
*
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
*/
class NullSessionHandlerTest extends \PHPUnit_Framework_TestCase
{
public function testSaveHandlers()
{
}
public function testSession()
{
}
public function testNothingIsPersisted()
{
}
public function getStorage()
{
}
}
/**
* Test class for NativeFileSessionHandler.
*
* @author Drak <drak@zikula.org>
*
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
*/
class NativeFileSessionHandlerTest extends \PHPUnit_Framework_TestCase
{
public function testConstruct()
{
}
/**
* @dataProvider savePathDataProvider
*/
public function testConstructSavePath($savePath, $expectedSavePath, $path)
{
}
public function savePathDataProvider()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testConstructException()
{
}
public function testConstructDefault()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests\Session\Storage {
/**
* Test class for NativeSessionStorage.
*
* @author Drak <drak@zikula.org>
*
* These tests require separate processes.
*
* @runTestsInSeparateProcesses
* @preserveGlobalState disabled
*/
class NativeSessionStorageTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
protected function tearDown()
{
}
/**
* @param array $options
*
* @return NativeSessionStorage
*/
protected function getStorage(array $options = array())
{
}
public function testBag()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testRegisterBagException()
{
}
/**
* @expectedException \LogicException
*/
public function testRegisterBagForAStartedSessionThrowsException()
{
}
public function testGetId()
{
}
public function testRegenerate()
{
}
public function testRegenerateDestroy()
{
}
public function testSessionGlobalIsUpToDateAfterIdRegeneration()
{
}
public function testRegenerationFailureDoesNotFlagStorageAsStarted()
{
}
public function testDefaultSessionCacheLimiter()
{
}
public function testExplicitSessionCacheLimiter()
{
}
public function testCookieOptions()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testSetSaveHandlerException()
{
}
public function testSetSaveHandler53()
{
}
/**
* @requires PHP 5.4
*/
public function testSetSaveHandler54()
{
}
/**
* @expectedException \RuntimeException
*/
public function testStartedOutside()
{
}
public function testRestart()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests\Session\Attribute {
/**
* Tests AttributeBag.
*
* @author Drak <drak@zikula.org>
*/
class AttributeBagTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
protected function tearDown()
{
}
public function testInitialize()
{
}
public function testGetStorageKey()
{
}
public function testGetSetName()
{
}
/**
* @dataProvider attributesProvider
*/
public function testHas($key, $value, $exists)
{
}
/**
* @dataProvider attributesProvider
*/
public function testGet($key, $value, $expected)
{
}
public function testGetDefaults()
{
}
/**
* @dataProvider attributesProvider
*/
public function testSet($key, $value, $expected)
{
}
public function testAll()
{
}
public function testReplace()
{
}
public function testRemove()
{
}
public function testClear()
{
}
public function attributesProvider()
{
}
public function testGetIterator()
{
}
public function testCount()
{
}
}
/**
* Tests NamespacedAttributeBag.
*
* @author Drak <drak@zikula.org>
*/
class NamespacedAttributeBagTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
protected function tearDown()
{
}
public function testInitialize()
{
}
public function testGetStorageKey()
{
}
/**
* @dataProvider attributesProvider
*/
public function testHas($key, $value, $exists)
{
}
/**
* @dataProvider attributesProvider
*/
public function testGet($key, $value, $expected)
{
}
public function testGetDefaults()
{
}
/**
* @dataProvider attributesProvider
*/
public function testSet($key, $value, $expected)
{
}
public function testAll()
{
}
public function testReplace()
{
}
public function testRemove()
{
}
public function testRemoveExistingNamespacedAttribute()
{
}
public function testRemoveNonexistingNamespacedAttribute()
{
}
public function testClear()
{
}
public function attributesProvider()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests\Session\Flash {
/**
* AutoExpireFlashBagTest.
*
* @author Drak <drak@zikula.org>
*/
class AutoExpireFlashBagTest extends \PHPUnit_Framework_TestCase
{
/**
* @var array
*/
protected $array = array();
protected function setUp()
{
}
protected function tearDown()
{
}
public function testInitialize()
{
}
public function testGetStorageKey()
{
}
public function testGetSetName()
{
}
public function testPeek()
{
}
public function testSet()
{
}
public function testHas()
{
}
public function testKeys()
{
}
public function testPeekAll()
{
}
public function testGet()
{
}
public function testSetAll()
{
}
public function testAll()
{
}
public function testClear()
{
}
}
/**
* FlashBagTest.
*
* @author Drak <drak@zikula.org>
*/
class FlashBagTest extends \PHPUnit_Framework_TestCase
{
/**
* @var array
*/
protected $array = array();
protected function setUp()
{
}
protected function tearDown()
{
}
public function testInitialize()
{
}
public function testGetStorageKey()
{
}
public function testGetSetName()
{
}
public function testPeek()
{
}
public function testGet()
{
}
public function testAll()
{
}
public function testSet()
{
}
public function testHas()
{
}
public function testKeys()
{
}
public function testPeekAll()
{
}
/**
* @group legacy
*/
public function testLegacyGetIterator()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests {
/**
* @group time-sensitive
*/
class ResponseTest extends \Symfony\Component\HttpFoundation\Tests\ResponseTestCase
{
public function testCreate()
{
}
public function testToString()
{
}
public function testClone()
{
}
public function testSendHeaders()
{
}
public function testSend()
{
}
public function testGetCharset()
{
}
public function testIsCacheable()
{
}
public function testIsCacheableWithErrorCode()
{
}
public function testIsCacheableWithNoStoreDirective()
{
}
public function testIsCacheableWithSetTtl()
{
}
public function testMustRevalidate()
{
}
public function testMustRevalidateWithMustRevalidateCacheControlHeader()
{
}
public function testMustRevalidateWithProxyRevalidateCacheControlHeader()
{
}
public function testSetNotModified()
{
}
public function testIsSuccessful()
{
}
public function testIsNotModified()
{
}
public function testIsNotModifiedNotSafe()
{
}
public function testIsNotModifiedLastModified()
{
}
public function testIsNotModifiedEtag()
{
}
public function testIsNotModifiedLastModifiedAndEtag()
{
}
public function testIsNotModifiedIfModifiedSinceAndEtagWithoutLastModified()
{
}
public function testIsValidateable()
{
}
public function testGetDate()
{
}
public function testGetMaxAge()
{
}
public function testSetSharedMaxAge()
{
}
public function testIsPrivate()
{
}
public function testExpire()
{
}
public function testGetTtl()
{
}
public function testSetClientTtl()
{
}
public function testGetSetProtocolVersion()
{
}
public function testGetVary()
{
}
public function testSetVary()
{
}
public function testDefaultContentType()
{
}
public function testContentTypeCharset()
{
}
public function testPrepareDoesNothingIfContentTypeIsSet()
{
}
public function testPrepareDoesNothingIfRequestFormatIsNotDefined()
{
}
public function testPrepareSetContentType()
{
}
public function testPrepareRemovesContentForHeadRequests()
{
}
public function testPrepareRemovesContentForInformationalResponse()
{
}
public function testPrepareRemovesContentLength()
{
}
public function testPrepareSetsPragmaOnHttp10Only()
{
}
public function testSetCache()
{
}
public function testSendContent()
{
}
public function testSetPublic()
{
}
public function testSetExpires()
{
}
public function testSetLastModified()
{
}
public function testIsInvalid()
{
}
/**
* @dataProvider getStatusCodeFixtures
*/
public function testSetStatusCode($code, $text, $expectedText)
{
}
public function getStatusCodeFixtures()
{
}
public function testIsInformational()
{
}
public function testIsRedirectRedirection()
{
}
public function testIsNotFound()
{
}
public function testIsEmpty()
{
}
public function testIsForbidden()
{
}
public function testIsOk()
{
}
public function testIsServerOrClientError()
{
}
public function testHasVary()
{
}
public function testSetEtag()
{
}
/**
* @dataProvider validContentProvider
*/
public function testSetContent($content)
{
}
/**
* @expectedException \UnexpectedValueException
* @dataProvider invalidContentProvider
*/
public function testSetContentInvalid($content)
{
}
public function testSettersAreChainable()
{
}
public function validContentProvider()
{
}
public function invalidContentProvider()
{
}
protected function createDateTimeOneHourAgo()
{
}
protected function createDateTimeOneHourLater()
{
}
protected function createDateTimeNow()
{
}
protected function provideResponse()
{
}
}
class StringableObject
{
public function __toString()
{
}
}
/**
* ServerBagTest.
*
* @author Bulat Shakirzyanov <mallluhuct@gmail.com>
*/
class ServerBagTest extends \PHPUnit_Framework_TestCase
{
public function testShouldExtractHeadersFromServerArray()
{
}
public function testHttpPasswordIsOptional()
{
}
public function testHttpBasicAuthWithPhpCgi()
{
}
public function testHttpBasicAuthWithPhpCgiBogus()
{
}
public function testHttpBasicAuthWithPhpCgiRedirect()
{
}
public function testHttpBasicAuthWithPhpCgiEmptyPassword()
{
}
public function testHttpDigestAuthWithPhpCgi()
{
}
public function testHttpDigestAuthWithPhpCgiBogus()
{
}
public function testHttpDigestAuthWithPhpCgiRedirect()
{
}
public function testOAuthBearerAuth()
{
}
public function testOAuthBearerAuthWithRedirect()
{
}
/**
* @see https://github.com/symfony/symfony/issues/17345
*/
public function testItDoesNotOverwriteTheAuthorizationHeaderIfItIsAlreadySet()
{
}
}
class ApacheRequestTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider provideServerVars
*/
public function testUriMethods($server, $expectedRequestUri, $expectedBaseUrl, $expectedPathInfo)
{
}
public function provideServerVars()
{
}
}
/**
* FileBagTest.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Bulat Shakirzyanov <mallluhuct@gmail.com>
*/
class FileBagTest extends \PHPUnit_Framework_TestCase
{
/**
* @expectedException \InvalidArgumentException
*/
public function testFileMustBeAnArrayOrUploadedFile()
{
}
public function testShouldConvertsUploadedFiles()
{
}
public function testShouldSetEmptyUploadedFilesToNull()
{
}
public function testShouldConvertUploadedFilesWithPhpBug()
{
}
public function testShouldConvertNestedUploadedFilesWithPhpBug()
{
}
public function testShouldNotConvertNestedUploadedFiles()
{
}
protected function createTempFile()
{
}
protected function setUp()
{
}
protected function tearDown()
{
}
}
class ExpressionRequestMatcherTest extends \PHPUnit_Framework_TestCase
{
/**
* @expectedException \LogicException
*/
public function testWhenNoExpressionIsSet()
{
}
/**
* @dataProvider provideExpressions
*/
public function testMatchesWhenParentMatchesIsTrue($expression, $expected)
{
}
/**
* @dataProvider provideExpressions
*/
public function testMatchesWhenParentMatchesIsFalse($expression)
{
}
public function provideExpressions()
{
}
}
class RequestStackTest extends \PHPUnit_Framework_TestCase
{
public function testGetCurrentRequest()
{
}
public function testGetMasterRequest()
{
}
public function testGetParentRequest()
{
}
}
class HeaderBagTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testToStringNull()
{
}
public function testToStringNotNull()
{
}
public function testKeys()
{
}
public function testGetDate()
{
}
/**
* @expectedException \RuntimeException
*/
public function testGetDateException()
{
}
public function testGetCacheControlHeader()
{
}
public function testAll()
{
}
public function testReplace()
{
}
public function testGet()
{
}
public function testSetAssociativeArray()
{
}
public function testContains()
{
}
public function testCacheControlDirectiveAccessors()
{
}
public function testCacheControlDirectiveParsing()
{
}
public function testCacheControlDirectiveParsingQuotedZero()
{
}
public function testCacheControlDirectiveOverrideWithReplace()
{
}
public function testGetIterator()
{
}
public function testCount()
{
}
}
class RequestTest extends \PHPUnit_Framework_TestCase
{
public function testInitialize()
{
}
public function testGetLocale()
{
}
public function testGetUser()
{
}
public function testGetPassword()
{
}
public function testIsNoCache()
{
}
public function testGetContentType()
{
}
public function testSetDefaultLocale()
{
}
public function testCreate()
{
}
public function testCreateCheckPrecedence()
{
}
public function testDuplicate()
{
}
public function testDuplicateWithFormat()
{
}
/**
* @dataProvider getFormatToMimeTypeMapProvider
*/
public function testGetFormatFromMimeType($format, $mimeTypes)
{
}
public function testGetFormatFromMimeTypeWithParameters()
{
}
/**
* @dataProvider getFormatToMimeTypeMapProvider
*/
public function testGetMimeTypeFromFormat($format, $mimeTypes)
{
}
public function testGetFormatWithCustomMimeType()
{
}
public function getFormatToMimeTypeMapProvider()
{
}
public function testGetUri()
{
}
public function testGetUriForPath()
{
}
/**
* @dataProvider getRelativeUriForPathData()
*/
public function testGetRelativeUriForPath($expected, $pathinfo, $path)
{
}
public function getRelativeUriForPathData()
{
}
public function testGetUserInfo()
{
}
public function testGetSchemeAndHttpHost()
{
}
/**
* @dataProvider getQueryStringNormalizationData
*/
public function testGetQueryString($query, $expectedQuery, $msg)
{
}
public function getQueryStringNormalizationData()
{
}
public function testGetQueryStringReturnsNull()
{
}
public function testGetHost()
{
}
public function testGetPort()
{
}
/**
* @expectedException \RuntimeException
*/
public function testGetHostWithFakeHttpHostValue()
{
}
public function testGetSetMethod()
{
}
/**
* @dataProvider testGetClientIpsProvider
*/
public function testGetClientIp($expected, $remoteAddr, $httpForwardedFor, $trustedProxies)
{
}
/**
* @dataProvider testGetClientIpsProvider
*/
public function testGetClientIps($expected, $remoteAddr, $httpForwardedFor, $trustedProxies)
{
}
/**
* @dataProvider testGetClientIpsForwardedProvider
*/
public function testGetClientIpsForwarded($expected, $remoteAddr, $httpForwarded, $trustedProxies)
{
}
public function testGetClientIpsForwardedProvider()
{
}
public function testGetClientIpsProvider()
{
}
public function testGetContentWorksTwiceInDefaultMode()
{
}
public function testGetContentReturnsResource()
{
}
public function testGetContentReturnsResourceWhenContentSetInConstructor()
{
}
public function testContentAsResource()
{
}
/**
* @expectedException \LogicException
* @dataProvider getContentCantBeCalledTwiceWithResourcesProvider
*/
public function testGetContentCantBeCalledTwiceWithResources($first, $second)
{
}
/**
* @dataProvider getContentCantBeCalledTwiceWithResourcesProvider
* @requires PHP 5.6
*/
public function testGetContentCanBeCalledTwiceWithResources($first, $second)
{
}
public function getContentCantBeCalledTwiceWithResourcesProvider()
{
}
public function provideOverloadedMethods()
{
}
/**
* @dataProvider provideOverloadedMethods
*/
public function testCreateFromGlobals($method)
{
}
public function testOverrideGlobals()
{
}
public function testGetScriptName()
{
}
public function testGetBasePath()
{
}
public function testGetPathInfo()
{
}
public function testGetPreferredLanguage()
{
}
public function testIsXmlHttpRequest()
{
}
/**
* @requires extension intl
*/
public function testIntlLocale()
{
}
public function testGetCharsets()
{
}
public function testGetEncodings()
{
}
public function testGetAcceptableContentTypes()
{
}
public function testGetLanguages()
{
}
public function testGetRequestFormat()
{
}
public function testHasSession()
{
}
public function testGetSession()
{
}
public function testHasPreviousSession()
{
}
public function testToString()
{
}
public function testIsMethod()
{
}
/**
* @dataProvider getBaseUrlData
*/
public function testGetBaseUrl($uri, $server, $expectedBaseUrl, $expectedPathInfo)
{
}
public function getBaseUrlData()
{
}
/**
* @dataProvider urlencodedStringPrefixData
*/
public function testUrlencodedStringPrefix($string, $prefix, $expect)
{
}
public function urlencodedStringPrefixData()
{
}
public function testTrustedProxies()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testSetTrustedProxiesInvalidHeaderName()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testGetTrustedProxiesInvalidHeaderName()
{
}
/**
* @dataProvider iisRequestUriProvider
*/
public function testIISRequestUri($headers, $server, $expectedRequestUri)
{
}
public function iisRequestUriProvider()
{
}
public function testTrustedHosts()
{
}
public function testFactory()
{
}
/**
* @dataProvider getLongHostNames
*/
public function testVeryLongHosts($host)
{
}
/**
* @dataProvider getHostValidities
*/
public function testHostValidity($host, $isValid, $expectedHost = null, $expectedPort = null)
{
}
public function getHostValidities()
{
}
public function getLongHostNames()
{
}
}
}
namespace Symfony\Component\HttpFoundation {
/**
* Request represents an HTTP request.
*
* The methods dealing with URL accept / return a raw path (% encoded):
* * getBasePath
* * getBaseUrl
* * getPathInfo
* * getRequestUri
* * getUri
* * getUriForPath
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class Request
{
const HEADER_FORWARDED = 'forwarded';
const HEADER_CLIENT_IP = 'client_ip';
const HEADER_CLIENT_HOST = 'client_host';
const HEADER_CLIENT_PROTO = 'client_proto';
const HEADER_CLIENT_PORT = 'client_port';
const METHOD_HEAD = 'HEAD';
const METHOD_GET = 'GET';
const METHOD_POST = 'POST';
const METHOD_PUT = 'PUT';
const METHOD_PATCH = 'PATCH';
const METHOD_DELETE = 'DELETE';
const METHOD_PURGE = 'PURGE';
const METHOD_OPTIONS = 'OPTIONS';
const METHOD_TRACE = 'TRACE';
const METHOD_CONNECT = 'CONNECT';
/**
* @var string[]
*/
protected static $trustedProxies = array();
/**
* @var string[]
*/
protected static $trustedHostPatterns = array();
/**
* @var string[]
*/
protected static $trustedHosts = array();
/**
* Names for headers that can be trusted when
* using trusted proxies.
*
* The FORWARDED header is the standard as of rfc7239.
*
* The other headers are non-standard, but widely used
* by popular reverse proxies (like Apache mod_proxy or Amazon EC2).
*/
protected static $trustedHeaders = array(self::HEADER_FORWARDED => 'FORWARDED', self::HEADER_CLIENT_IP => 'X_FORWARDED_FOR', self::HEADER_CLIENT_HOST => 'X_FORWARDED_HOST', self::HEADER_CLIENT_PROTO => 'X_FORWARDED_PROTO', self::HEADER_CLIENT_PORT => 'X_FORWARDED_PORT');
protected static $httpMethodParameterOverride = false;
/**
* Custom parameters.
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*/
public $attributes;
/**
* Request body parameters ($_POST).
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*/
public $request;
/**
* Query string parameters ($_GET).
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*/
public $query;
/**
* Server and execution environment parameters ($_SERVER).
*
* @var \Symfony\Component\HttpFoundation\ServerBag
*/
public $server;
/**
* Uploaded files ($_FILES).
*
* @var \Symfony\Component\HttpFoundation\FileBag
*/
public $files;
/**
* Cookies ($_COOKIE).
*
* @var \Symfony\Component\HttpFoundation\ParameterBag
*/
public $cookies;
/**
* Headers (taken from the $_SERVER).
*
* @var \Symfony\Component\HttpFoundation\HeaderBag
*/
public $headers;
/**
* @var string
*/
protected $content;
/**
* @var array
*/
protected $languages;
/**
* @var array
*/
protected $charsets;
/**
* @var array
*/
protected $encodings;
/**
* @var array
*/
protected $acceptableContentTypes;
/**
* @var string
*/
protected $pathInfo;
/**
* @var string
*/
protected $requestUri;
/**
* @var string
*/
protected $baseUrl;
/**
* @var string
*/
protected $basePath;
/**
* @var string
*/
protected $method;
/**
* @var string
*/
protected $format;
/**
* @var \Symfony\Component\HttpFoundation\Session\SessionInterface
*/
protected $session;
/**
* @var string
*/
protected $locale;
/**
* @var string
*/
protected $defaultLocale = 'en';
/**
* @var array
*/
protected static $formats;
protected static $requestFactory;
/**
* Constructor.
*
* @param array $query The GET parameters
* @param array $request The POST parameters
* @param array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
* @param array $cookies The COOKIE parameters
* @param array $files The FILES parameters
* @param array $server The SERVER parameters
* @param string|resource $content The raw body data
*/
public function __construct(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), $content = null)
{
}
/**
* Sets the parameters for this request.
*
* This method also re-initializes all properties.
*
* @param array $query The GET parameters
* @param array $request The POST parameters
* @param array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
* @param array $cookies The COOKIE parameters
* @param array $files The FILES parameters
* @param array $server The SERVER parameters
* @param string|resource $content The raw body data
*/
public function initialize(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), $content = null)
{
}
/**
* Creates a new request with values from PHP's super globals.
*
* @return Request A new request
*/
public static function createFromGlobals()
{
}
/**
* Creates a Request based on a given URI and configuration.
*
* The information contained in the URI always take precedence
* over the other information (server and parameters).
*
* @param string $uri The URI
* @param string $method The HTTP method
* @param array $parameters The query (GET) or request (POST) parameters
* @param array $cookies The request cookies ($_COOKIE)
* @param array $files The request files ($_FILES)
* @param array $server The server parameters ($_SERVER)
* @param string $content The raw body data
*
* @return Request A Request instance
*/
public static function create($uri, $method = 'GET', $parameters = array(), $cookies = array(), $files = array(), $server = array(), $content = null)
{
}
/**
* Sets a callable able to create a Request instance.
*
* This is mainly useful when you need to override the Request class
* to keep BC with an existing system. It should not be used for any
* other purpose.
*
* @param callable|null $callable A PHP callable
*/
public static function setFactory($callable)
{
}
/**
* Clones a request and overrides some of its parameters.
*
* @param array $query The GET parameters
* @param array $request The POST parameters
* @param array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
* @param array $cookies The COOKIE parameters
* @param array $files The FILES parameters
* @param array $server The SERVER parameters
*
* @return Request The duplicated request
*/
public function duplicate(array $query = null, array $request = null, array $attributes = null, array $cookies = null, array $files = null, array $server = null)
{
}
/**
* Clones the current request.
*
* Note that the session is not cloned as duplicated requests
* are most of the time sub-requests of the main one.
*/
public function __clone()
{
}
/**
* Returns the request as a string.
*
* @return string The request
*/
public function __toString()
{
}
/**
* Overrides the PHP global variables according to this request instance.
*
* It overrides $_GET, $_POST, $_REQUEST, $_SERVER, $_COOKIE.
* $_FILES is never overridden, see rfc1867
*/
public function overrideGlobals()
{
}
/**
* Sets a list of trusted proxies.
*
* You should only list the reverse proxies that you manage directly.
*
* @param array $proxies A list of trusted proxies
*/
public static function setTrustedProxies(array $proxies)
{
}
/**
* Gets the list of trusted proxies.
*
* @return array An array of trusted proxies.
*/
public static function getTrustedProxies()
{
}
/**
* Sets a list of trusted host patterns.
*
* You should only list the hosts you manage using regexs.
*
* @param array $hostPatterns A list of trusted host patterns
*/
public static function setTrustedHosts(array $hostPatterns)
{
}
/**
* Gets the list of trusted host patterns.
*
* @return array An array of trusted host patterns.
*/
public static function getTrustedHosts()
{
}
/**
* Sets the name for trusted headers.
*
* The following header keys are supported:
*
* * Request::HEADER_CLIENT_IP: defaults to X-Forwarded-For (see getClientIp())
* * Request::HEADER_CLIENT_HOST: defaults to X-Forwarded-Host (see getHost())
* * Request::HEADER_CLIENT_PORT: defaults to X-Forwarded-Port (see getPort())
* * Request::HEADER_CLIENT_PROTO: defaults to X-Forwarded-Proto (see getScheme() and isSecure())
*
* Setting an empty value allows to disable the trusted header for the given key.
*
* @param string $key The header key
* @param string $value The header name
*
* @throws \InvalidArgumentException
*/
public static function setTrustedHeaderName($key, $value)
{
}
/**
* Gets the trusted proxy header name.
*
* @param string $key The header key
*
* @return string The header name
*
* @throws \InvalidArgumentException
*/
public static function getTrustedHeaderName($key)
{
}
/**
* Normalizes a query string.
*
* It builds a normalized query string, where keys/value pairs are alphabetized,
* have consistent escaping and unneeded delimiters are removed.
*
* @param string $qs Query string
*
* @return string A normalized query string for the Request
*/
public static function normalizeQueryString($qs)
{
}
/**
* Enables support for the _method request parameter to determine the intended HTTP method.
*
* Be warned that enabling this feature might lead to CSRF issues in your code.
* Check that you are using CSRF tokens when required.
* If the HTTP method parameter override is enabled, an html-form with method "POST" can be altered
* and used to send a "PUT" or "DELETE" request via the _method request parameter.
* If these methods are not protected against CSRF, this presents a possible vulnerability.
*
* The HTTP method can only be overridden when the real HTTP method is POST.
*/
public static function enableHttpMethodParameterOverride()
{
}
/**
* Checks whether support for the _method request parameter is enabled.
*
* @return bool True when the _method request parameter is enabled, false otherwise
*/
public static function getHttpMethodParameterOverride()
{
}
/**
* Gets a "parameter" value.
*
* This method is mainly useful for libraries that want to provide some flexibility.
*
* Order of precedence: GET, PATH, POST
*
* Avoid using this method in controllers:
*
* * slow
* * prefer to get from a "named" source
*
* It is better to explicitly get request parameters from the appropriate
* public property instead (query, attributes, request).
*
* Note: Finding deep items is deprecated since version 2.8, to be removed in 3.0.
*
* @param string $key the key
* @param mixed $default the default value if the parameter key does not exist
* @param bool $deep is parameter deep in multidimensional array
*
* @return mixed
*/
public function get($key, $default = null, $deep = false)
{
}
/**
* Gets the Session.
*
* @return SessionInterface|null The session
*/
public function getSession()
{
}
/**
* Whether the request contains a Session which was started in one of the
* previous requests.
*
* @return bool
*/
public function hasPreviousSession()
{
}
/**
* Whether the request contains a Session object.
*
* This method does not give any information about the state of the session object,
* like whether the session is started or not. It is just a way to check if this Request
* is associated with a Session instance.
*
* @return bool true when the Request contains a Session object, false otherwise
*/
public function hasSession()
{
}
/**
* Sets the Session.
*
* @param SessionInterface $session The Session
*/
public function setSession(\Symfony\Component\HttpFoundation\Session\SessionInterface $session)
{
}
/**
* Returns the client IP addresses.
*
* In the returned array the most trusted IP address is first, and the
* least trusted one last. The "real" client IP address is the last one,
* but this is also the least trusted one. Trusted proxies are stripped.
*
* Use this method carefully; you should use getClientIp() instead.
*
* @return array The client IP addresses
*
* @see getClientIp()
*/
public function getClientIps()
{
}
/**
* Returns the client IP address.
*
* This method can read the client IP address from the "X-Forwarded-For" header
* when trusted proxies were set via "setTrustedProxies()". The "X-Forwarded-For"
* header value is a comma+space separated list of IP addresses, the left-most
* being the original client, and each successive proxy that passed the request
* adding the IP address where it received the request from.
*
* If your reverse proxy uses a different header name than "X-Forwarded-For",
* ("Client-Ip" for instance), configure it via "setTrustedHeaderName()" with
* the "client-ip" key.
*
* @return string The client IP address
*
* @see getClientIps()
* @see http://en.wikipedia.org/wiki/X-Forwarded-For
*/
public function getClientIp()
{
}
/**
* Returns current script name.
*
* @return string
*/
public function getScriptName()
{
}
/**
* Returns the path being requested relative to the executed script.
*
* The path info always starts with a /.
*
* Suppose this request is instantiated from /mysite on localhost:
*
* * http://localhost/mysite returns an empty string
* * http://localhost/mysite/about returns '/about'
* * http://localhost/mysite/enco%20ded returns '/enco%20ded'
* * http://localhost/mysite/about?var=1 returns '/about'
*
* @return string The raw path (i.e. not urldecoded)
*/
public function getPathInfo()
{
}
/**
* Returns the root path from which this request is executed.
*
* Suppose that an index.php file instantiates this request object:
*
* * http://localhost/index.php returns an empty string
* * http://localhost/index.php/page returns an empty string
* * http://localhost/web/index.php returns '/web'
* * http://localhost/we%20b/index.php returns '/we%20b'
*
* @return string The raw path (i.e. not urldecoded)
*/
public function getBasePath()
{
}
/**
* Returns the root URL from which this request is executed.
*
* The base URL never ends with a /.
*
* This is similar to getBasePath(), except that it also includes the
* script filename (e.g. index.php) if one exists.
*
* @return string The raw URL (i.e. not urldecoded)
*/
public function getBaseUrl()
{
}
/**
* Gets the request's scheme.
*
* @return string
*/
public function getScheme()
{
}
/**
* Returns the port on which the request is made.
*
* This method can read the client port from the "X-Forwarded-Port" header
* when trusted proxies were set via "setTrustedProxies()".
*
* The "X-Forwarded-Port" header must contain the client port.
*
* If your reverse proxy uses a different header name than "X-Forwarded-Port",
* configure it via "setTrustedHeaderName()" with the "client-port" key.
*
* @return string
*/
public function getPort()
{
}
/**
* Returns the user.
*
* @return string|null
*/
public function getUser()
{
}
/**
* Returns the password.
*
* @return string|null
*/
public function getPassword()
{
}
/**
* Gets the user info.
*
* @return string A user name and, optionally, scheme-specific information about how to gain authorization to access the server
*/
public function getUserInfo()
{
}
/**
* Returns the HTTP host being requested.
*
* The port name will be appended to the host if it's non-standard.
*
* @return string
*/
public function getHttpHost()
{
}
/**
* Returns the requested URI (path and query string).
*
* @return string The raw URI (i.e. not URI decoded)
*/
public function getRequestUri()
{
}
/**
* Gets the scheme and HTTP host.
*
* If the URL was called with basic authentication, the user
* and the password are not added to the generated string.
*
* @return string The scheme and HTTP host
*/
public function getSchemeAndHttpHost()
{
}
/**
* Generates a normalized URI (URL) for the Request.
*
* @return string A normalized URI (URL) for the Request
*
* @see getQueryString()
*/
public function getUri()
{
}
/**
* Generates a normalized URI for the given path.
*
* @param string $path A path to use instead of the current one
*
* @return string The normalized URI for the path
*/
public function getUriForPath($path)
{
}
/**
* Returns the path as relative reference from the current Request path.
*
* Only the URIs path component (no schema, host etc.) is relevant and must be given.
* Both paths must be absolute and not contain relative parts.
* Relative URLs from one resource to another are useful when generating self-contained downloadable document archives.
* Furthermore, they can be used to reduce the link size in documents.
*
* Example target paths, given a base path of "/a/b/c/d":
* - "/a/b/c/d" -> ""
* - "/a/b/c/" -> "./"
* - "/a/b/" -> "../"
* - "/a/b/c/other" -> "other"
* - "/a/x/y" -> "../../x/y"
*
* @param string $path The target path
*
* @return string The relative target path
*/
public function getRelativeUriForPath($path)
{
}
/**
* Generates the normalized query string for the Request.
*
* It builds a normalized query string, where keys/value pairs are alphabetized
* and have consistent escaping.
*
* @return string|null A normalized query string for the Request
*/
public function getQueryString()
{
}
/**
* Checks whether the request is secure or not.
*
* This method can read the client protocol from the "X-Forwarded-Proto" header
* when trusted proxies were set via "setTrustedProxies()".
*
* The "X-Forwarded-Proto" header must contain the protocol: "https" or "http".
*
* If your reverse proxy uses a different header name than "X-Forwarded-Proto"
* ("SSL_HTTPS" for instance), configure it via "setTrustedHeaderName()" with
* the "client-proto" key.
*
* @return bool
*/
public function isSecure()
{
}
/**
* Returns the host name.
*
* This method can read the client host name from the "X-Forwarded-Host" header
* when trusted proxies were set via "setTrustedProxies()".
*
* The "X-Forwarded-Host" header must contain the client host name.
*
* If your reverse proxy uses a different header name than "X-Forwarded-Host",
* configure it via "setTrustedHeaderName()" with the "client-host" key.
*
* @return string
*
* @throws \UnexpectedValueException when the host name is invalid
*/
public function getHost()
{
}
/**
* Sets the request method.
*
* @param string $method
*/
public function setMethod($method)
{
}
/**
* Gets the request "intended" method.
*
* If the X-HTTP-Method-Override header is set, and if the method is a POST,
* then it is used to determine the "real" intended HTTP method.
*
* The _method request parameter can also be used to determine the HTTP method,
* but only if enableHttpMethodParameterOverride() has been called.
*
* The method is always an uppercased string.
*
* @return string The request method
*
* @see getRealMethod()
*/
public function getMethod()
{
}
/**
* Gets the "real" request method.
*
* @return string The request method
*
* @see getMethod()
*/
public function getRealMethod()
{
}
/**
* Gets the mime type associated with the format.
*
* @param string $format The format
*
* @return string The associated mime type (null if not found)
*/
public function getMimeType($format)
{
}
/**
* Gets the format associated with the mime type.
*
* @param string $mimeType The associated mime type
*
* @return string|null The format (null if not found)
*/
public function getFormat($mimeType)
{
}
/**
* Associates a format with mime types.
*
* @param string $format The format
* @param string|array $mimeTypes The associated mime types (the preferred one must be the first as it will be used as the content type)
*/
public function setFormat($format, $mimeTypes)
{
}
/**
* Gets the request format.
*
* Here is the process to determine the format:
*
* * format defined by the user (with setRequestFormat())
* * _format request parameter
* * $default
*
* @param string $default The default format
*
* @return string The request format
*/
public function getRequestFormat($default = 'html')
{
}
/**
* Sets the request format.
*
* @param string $format The request format.
*/
public function setRequestFormat($format)
{
}
/**
* Gets the format associated with the request.
*
* @return string|null The format (null if no content type is present)
*/
public function getContentType()
{
}
/**
* Sets the default locale.
*
* @param string $locale
*/
public function setDefaultLocale($locale)
{
}
/**
* Get the default locale.
*
* @return string
*/
public function getDefaultLocale()
{
}
/**
* Sets the locale.
*
* @param string $locale
*/
public function setLocale($locale)
{
}
/**
* Get the locale.
*
* @return string
*/
public function getLocale()
{
}
/**
* Checks if the request method is of specified type.
*
* @param string $method Uppercase request method (GET, POST etc).
*
* @return bool
*/
public function isMethod($method)
{
}
/**
* Checks whether the method is safe or not.
*
* @return bool
*/
public function isMethodSafe()
{
}
/**
* Returns the request body content.
*
* @param bool $asResource If true, a resource will be returned
*
* @return string|resource The request body content or a resource to read the body stream.
*
* @throws \LogicException
*/
public function getContent($asResource = false)
{
}
/**
* Gets the Etags.
*
* @return array The entity tags
*/
public function getETags()
{
}
/**
* @return bool
*/
public function isNoCache()
{
}
/**
* Returns the preferred language.
*
* @param array $locales An array of ordered available locales
*
* @return string|null The preferred locale
*/
public function getPreferredLanguage(array $locales = null)
{
}
/**
* Gets a list of languages acceptable by the client browser.
*
* @return array Languages ordered in the user browser preferences
*/
public function getLanguages()
{
}
/**
* Gets a list of charsets acceptable by the client browser.
*
* @return array List of charsets in preferable order
*/
public function getCharsets()
{
}
/**
* Gets a list of encodings acceptable by the client browser.
*
* @return array List of encodings in preferable order
*/
public function getEncodings()
{
}
/**
* Gets a list of content types acceptable by the client browser.
*
* @return array List of content types in preferable order
*/
public function getAcceptableContentTypes()
{
}
/**
* Returns true if the request is a XMLHttpRequest.
*
* It works if your JavaScript library sets an X-Requested-With HTTP header.
* It is known to work with common JavaScript frameworks:
*
* @link http://en.wikipedia.org/wiki/List_of_Ajax_frameworks#JavaScript
*
* @return bool true if the request is an XMLHttpRequest, false otherwise
*/
public function isXmlHttpRequest()
{
}
/*
* The following methods are derived from code of the Zend Framework (1.10dev - 2010-01-24)
*
* Code subject to the new BSD license (http://framework.zend.com/license/new-bsd).
*
* Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
*/
protected function prepareRequestUri()
{
}
/**
* Prepares the base URL.
*
* @return string
*/
protected function prepareBaseUrl()
{
}
/**
* Prepares the base path.
*
* @return string base path
*/
protected function prepareBasePath()
{
}
/**
* Prepares the path info.
*
* @return string path info
*/
protected function preparePathInfo()
{
}
/**
* Initializes HTTP request formats.
*/
protected static function initializeFormats()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests {
class RequestContentProxy extends \Symfony\Component\HttpFoundation\Request
{
public function getContent($asResource = false)
{
}
}
class NewRequest extends \Symfony\Component\HttpFoundation\Request
{
public function getFoo()
{
}
}
class RequestMatcherTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider testMethodFixtures
*/
public function testMethod($requestMethod, $matcherMethod, $isMatch)
{
}
public function testMethodFixtures()
{
}
public function testScheme()
{
}
/**
* @dataProvider testHostFixture
*/
public function testHost($pattern, $isMatch)
{
}
public function testHostFixture()
{
}
public function testPath()
{
}
public function testPathWithLocaleIsNotSupported()
{
}
public function testPathWithEncodedCharacters()
{
}
public function testAttributes()
{
}
}
class IpUtilsTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider testIpv4Provider
*/
public function testIpv4($matches, $remoteAddr, $cidr)
{
}
public function testIpv4Provider()
{
}
/**
* @dataProvider testIpv6Provider
*/
public function testIpv6($matches, $remoteAddr, $cidr)
{
}
public function testIpv6Provider()
{
}
/**
* @expectedException \RuntimeException
* @requires extension sockets
*/
public function testAnIpv6WithOptionDisabledIpv6()
{
}
}
class ParameterBagTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testAll()
{
}
public function testKeys()
{
}
public function testAdd()
{
}
public function testRemove()
{
}
public function testReplace()
{
}
public function testGet()
{
}
public function testGetDoesNotUseDeepByDefault()
{
}
/**
* @group legacy
* @dataProvider getInvalidPaths
* @expectedException \InvalidArgumentException
*/
public function testGetDeepWithInvalidPaths($path)
{
}
public function getInvalidPaths()
{
}
/**
* @group legacy
*/
public function testGetDeep()
{
}
public function testSet()
{
}
public function testHas()
{
}
public function testGetAlpha()
{
}
public function testGetAlnum()
{
}
public function testGetDigits()
{
}
public function testGetInt()
{
}
public function testFilter()
{
}
public function testGetIterator()
{
}
public function testCount()
{
}
public function testGetBoolean()
{
}
}
/**
* @group time-sensitive
*/
class ResponseHeaderBagTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider provideAllPreserveCase
*/
public function testAllPreserveCase($headers, $expected)
{
}
public function provideAllPreserveCase()
{
}
public function testCacheControlHeader()
{
}
public function testToStringIncludesCookieHeaders()
{
}
public function testClearCookieSecureNotHttpOnly()
{
}
public function testReplace()
{
}
public function testReplaceWithRemove()
{
}
public function testCookiesWithSameNames()
{
}
public function testRemoveCookie()
{
}
public function testRemoveCookieWithNullRemove()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testGetCookiesWithInvalidArgument()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testMakeDispositionInvalidDisposition()
{
}
/**
* @dataProvider provideMakeDisposition
*/
public function testMakeDisposition($disposition, $filename, $filenameFallback, $expected)
{
}
public function testToStringDoesntMessUpHeaders()
{
}
public function provideMakeDisposition()
{
}
/**
* @dataProvider provideMakeDispositionFail
* @expectedException \InvalidArgumentException
*/
public function testMakeDispositionFail($disposition, $filename)
{
}
public function provideMakeDispositionFail()
{
}
}
class JsonResponseTest extends \PHPUnit_Framework_TestCase
{
public function testConstructorEmptyCreatesJsonObject()
{
}
public function testConstructorWithArrayCreatesJsonArray()
{
}
public function testConstructorWithAssocArrayCreatesJsonObject()
{
}
public function testConstructorWithSimpleTypes()
{
}
public function testConstructorWithCustomStatus()
{
}
public function testConstructorAddsContentTypeHeader()
{
}
public function testConstructorWithCustomHeaders()
{
}
public function testConstructorWithCustomContentType()
{
}
public function testCreate()
{
}
public function testStaticCreateEmptyJsonObject()
{
}
public function testStaticCreateJsonArray()
{
}
public function testStaticCreateJsonObject()
{
}
public function testStaticCreateWithSimpleTypes()
{
}
public function testStaticCreateWithCustomStatus()
{
}
public function testStaticCreateAddsContentTypeHeader()
{
}
public function testStaticCreateWithCustomHeaders()
{
}
public function testStaticCreateWithCustomContentType()
{
}
public function testSetCallback()
{
}
public function testJsonEncodeFlags()
{
}
public function testGetEncodingOptions()
{
}
public function testSetEncodingOptions()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testSetCallbackInvalidIdentifier()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testSetContent()
{
}
/**
* @expectedException \Exception
* @expectedExceptionMessage This error is expected
* @requires PHP 5.4
*/
public function testSetContentJsonSerializeError()
{
}
}
class JsonSerializableObject implements \JsonSerializable
{
public function jsonSerialize()
{
}
}
class RedirectResponseTest extends \PHPUnit_Framework_TestCase
{
public function testGenerateMetaRedirect()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testRedirectResponseConstructorNullUrl()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testRedirectResponseConstructorWrongStatusCode()
{
}
public function testGenerateLocationHeader()
{
}
public function testGetTargetUrl()
{
}
public function testSetTargetUrl()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testSetTargetUrlNull()
{
}
public function testCreate()
{
}
}
class AcceptHeaderItemTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider provideFromStringData
*/
public function testFromString($string, $value, array $attributes)
{
}
public function provideFromStringData()
{
}
/**
* @dataProvider provideToStringData
*/
public function testToString($value, array $attributes, $string)
{
}
public function provideToStringData()
{
}
public function testValue()
{
}
public function testQuality()
{
}
public function testAttribute()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests\File {
class FileTest extends \PHPUnit_Framework_TestCase
{
protected $file;
public function testGetMimeTypeUsesMimeTypeGuessers()
{
}
public function testGuessExtensionWithoutGuesser()
{
}
public function testGuessExtensionIsBasedOnMimeType()
{
}
/**
* @requires extension fileinfo
*/
public function testGuessExtensionWithReset()
{
}
public function testConstructWhenFileNotExists()
{
}
public function testMove()
{
}
public function testMoveWithNewName()
{
}
public function getFilenameFixtures()
{
}
/**
* @dataProvider getFilenameFixtures
*/
public function testMoveWithNonLatinName($filename, $sanitizedFilename)
{
}
public function testMoveToAnUnexistentDirectory()
{
}
protected function createMockGuesser($path, $mimeType)
{
}
}
class UploadedFileTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
public function testConstructWhenFileNotExists()
{
}
public function testFileUploadsWithNoMimeType()
{
}
public function testFileUploadsWithUnknownMimeType()
{
}
public function testGuessClientExtension()
{
}
public function testGuessClientExtensionWithIncorrectMimeType()
{
}
public function testErrorIsOkByDefault()
{
}
public function testGetClientOriginalName()
{
}
public function testGetClientOriginalExtension()
{
}
/**
* @expectedException \Symfony\Component\HttpFoundation\File\Exception\FileException
*/
public function testMoveLocalFileIsNotAllowed()
{
}
public function testMoveLocalFileIsAllowedInTestMode()
{
}
public function testGetClientOriginalNameSanitizeFilename()
{
}
public function testGetSize()
{
}
public function testGetExtension()
{
}
public function testIsValid()
{
}
/**
* @dataProvider uploadedFileErrorProvider
*/
public function testIsInvalidOnUploadError($error)
{
}
public function uploadedFileErrorProvider()
{
}
public function testIsInvalidIfNotHttpUpload()
{
}
}
}
namespace Symfony\Component\HttpFoundation\File {
/**
* A file in the file system.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class File extends \SplFileInfo
{
/**
* Constructs a new file from the given path.
*
* @param string $path The path to the file
* @param bool $checkPath Whether to check the path or not
*
* @throws FileNotFoundException If the given path is not a file
*/
public function __construct($path, $checkPath = true)
{
}
/**
* Returns the extension based on the mime type.
*
* If the mime type is unknown, returns null.
*
* This method uses the mime type as guessed by getMimeType()
* to guess the file extension.
*
* @return string|null The guessed extension or null if it cannot be guessed
*
* @see ExtensionGuesser
* @see getMimeType()
*/
public function guessExtension()
{
}
/**
* Returns the mime type of the file.
*
* The mime type is guessed using a MimeTypeGuesser instance, which uses finfo(),
* mime_content_type() and the system binary "file" (in this order), depending on
* which of those are available.
*
* @return string|null The guessed mime type (i.e. "application/pdf")
*
* @see MimeTypeGuesser
*/
public function getMimeType()
{
}
/**
* Moves the file to a new location.
*
* @param string $directory The destination folder
* @param string $name The new file name
*
* @return File A File object representing the new file
*
* @throws FileException if the target file could not be created
*/
public function move($directory, $name = null)
{
}
protected function getTargetFile($directory, $name = null)
{
}
/**
* Returns locale independent base name of the given path.
*
* @param string $name The new file name
*
* @return string containing
*/
protected function getName($name)
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests\File {
class FakeFile extends \Symfony\Component\HttpFoundation\File\File
{
public function __construct($realpath, $path)
{
}
public function isReadable()
{
}
public function getRealpath()
{
}
public function getSize()
{
}
public function getMTime()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests\File\MimeType {
/**
* @requires extension fileinfo
*/
class MimeTypeTest extends \PHPUnit_Framework_TestCase
{
protected $path;
public function testGuessImageWithoutExtension()
{
}
public function testGuessImageWithDirectory()
{
}
public function testGuessImageWithFileBinaryMimeTypeGuesser()
{
}
public function testGuessImageWithKnownExtension()
{
}
public function testGuessFileWithUnknownExtension()
{
}
public function testGuessWithIncorrectPath()
{
}
public function testGuessWithNonReadablePath()
{
}
public static function tearDownAfterClass()
{
}
}
}
namespace Symfony\Component\HttpFoundation\Tests {
class StreamedResponseTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testPrepareWith11Protocol()
{
}
public function testPrepareWith10Protocol()
{
}
public function testPrepareWithHeadRequest()
{
}
public function testPrepareWithCacheHeaders()
{
}
public function testSendContent()
{
}
/**
* @expectedException \LogicException
*/
public function testSendContentWithNonCallable()
{
}
/**
* @expectedException \LogicException
*/
public function testSetCallbackNonCallable()
{
}
/**
* @expectedException \LogicException
*/
public function testSetContent()
{
}
public function testGetContent()
{
}
public function testCreate()
{
}
}
class AcceptHeaderTest extends \PHPUnit_Framework_TestCase
{
public function testFirst()
{
}
/**
* @dataProvider provideFromStringData
*/
public function testFromString($string, array $items)
{
}
public function provideFromStringData()
{
}
/**
* @dataProvider provideToStringData
*/
public function testToString(array $items, $string)
{
}
public function provideToStringData()
{
}
/**
* @dataProvider provideFilterData
*/
public function testFilter($string, $filter, array $values)
{
}
public function provideFilterData()
{
}
/**
* @dataProvider provideSortingData
*/
public function testSorting($string, array $values)
{
}
public function provideSortingData()
{
}
}
}
namespace Symfony\Component\HttpFoundation {
/**
* Represents an Accept-* header.
*
* An accept header is compound with a list of items,
* sorted by descending quality.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class AcceptHeader
{
/**
* Constructor.
*
* @param AcceptHeaderItem[] $items
*/
public function __construct(array $items)
{
}
/**
* Builds an AcceptHeader instance from a string.
*
* @param string $headerValue
*
* @return AcceptHeader
*/
public static function fromString($headerValue)
{
}
/**
* Returns header value's string representation.
*
* @return string
*/
public function __toString()
{
}
/**
* Tests if header has given value.
*
* @param string $value
*
* @return bool
*/
public function has($value)
{
}
/**
* Returns given value's item, if exists.
*
* @param string $value
*
* @return AcceptHeaderItem|null
*/
public function get($value)
{
}
/**
* Adds an item.
*
* @param AcceptHeaderItem $item
*
* @return AcceptHeader
*/
public function add(\Symfony\Component\HttpFoundation\AcceptHeaderItem $item)
{
}
/**
* Returns all items.
*
* @return AcceptHeaderItem[]
*/
public function all()
{
}
/**
* Filters items on their value using given regex.
*
* @param string $pattern
*
* @return AcceptHeader
*/
public function filter($pattern)
{
}
/**
* Returns first item.
*
* @return AcceptHeaderItem|null
*/
public function first()
{
}
}
/**
* Request represents an HTTP request from an Apache server.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class ApacheRequest extends \Symfony\Component\HttpFoundation\Request
{
/**
* {@inheritdoc}
*/
protected function prepareRequestUri()
{
}
/**
* {@inheritdoc}
*/
protected function prepareBaseUrl()
{
}
}
/**
* Response represents an HTTP response.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class Response
{
const HTTP_CONTINUE = 100;
const HTTP_SWITCHING_PROTOCOLS = 101;
const HTTP_PROCESSING = 102;
// RFC2518
const HTTP_OK = 200;
const HTTP_CREATED = 201;
const HTTP_ACCEPTED = 202;
const HTTP_NON_AUTHORITATIVE_INFORMATION = 203;
const HTTP_NO_CONTENT = 204;
const HTTP_RESET_CONTENT = 205;
const HTTP_PARTIAL_CONTENT = 206;
const HTTP_MULTI_STATUS = 207;
// RFC4918
const HTTP_ALREADY_REPORTED = 208;
// RFC5842
const HTTP_IM_USED = 226;
// RFC3229
const HTTP_MULTIPLE_CHOICES = 300;
const HTTP_MOVED_PERMANENTLY = 301;
const HTTP_FOUND = 302;
const HTTP_SEE_OTHER = 303;
const HTTP_NOT_MODIFIED = 304;
const HTTP_USE_PROXY = 305;
const HTTP_RESERVED = 306;
const HTTP_TEMPORARY_REDIRECT = 307;
const HTTP_PERMANENTLY_REDIRECT = 308;
// RFC7238
const HTTP_BAD_REQUEST = 400;
const HTTP_UNAUTHORIZED = 401;
const HTTP_PAYMENT_REQUIRED = 402;
const HTTP_FORBIDDEN = 403;
const HTTP_NOT_FOUND = 404;
const HTTP_METHOD_NOT_ALLOWED = 405;
const HTTP_NOT_ACCEPTABLE = 406;
const HTTP_PROXY_AUTHENTICATION_REQUIRED = 407;
const HTTP_REQUEST_TIMEOUT = 408;
const HTTP_CONFLICT = 409;
const HTTP_GONE = 410;
const HTTP_LENGTH_REQUIRED = 411;
const HTTP_PRECONDITION_FAILED = 412;
const HTTP_REQUEST_ENTITY_TOO_LARGE = 413;
const HTTP_REQUEST_URI_TOO_LONG = 414;
const HTTP_UNSUPPORTED_MEDIA_TYPE = 415;
const HTTP_REQUESTED_RANGE_NOT_SATISFIABLE = 416;
const HTTP_EXPECTATION_FAILED = 417;
const HTTP_I_AM_A_TEAPOT = 418;
// RFC2324
const HTTP_MISDIRECTED_REQUEST = 421;
// RFC7540
const HTTP_UNPROCESSABLE_ENTITY = 422;
// RFC4918
const HTTP_LOCKED = 423;
// RFC4918
const HTTP_FAILED_DEPENDENCY = 424;
// RFC4918
const HTTP_RESERVED_FOR_WEBDAV_ADVANCED_COLLECTIONS_EXPIRED_PROPOSAL = 425;
// RFC2817
const HTTP_UPGRADE_REQUIRED = 426;
// RFC2817
const HTTP_PRECONDITION_REQUIRED = 428;
// RFC6585
const HTTP_TOO_MANY_REQUESTS = 429;
// RFC6585
const HTTP_REQUEST_HEADER_FIELDS_TOO_LARGE = 431;
// RFC6585
const HTTP_UNAVAILABLE_FOR_LEGAL_REASONS = 451;
const HTTP_INTERNAL_SERVER_ERROR = 500;
const HTTP_NOT_IMPLEMENTED = 501;
const HTTP_BAD_GATEWAY = 502;
const HTTP_SERVICE_UNAVAILABLE = 503;
const HTTP_GATEWAY_TIMEOUT = 504;
const HTTP_VERSION_NOT_SUPPORTED = 505;
const HTTP_VARIANT_ALSO_NEGOTIATES_EXPERIMENTAL = 506;
// RFC2295
const HTTP_INSUFFICIENT_STORAGE = 507;
// RFC4918
const HTTP_LOOP_DETECTED = 508;
// RFC5842
const HTTP_NOT_EXTENDED = 510;
// RFC2774
const HTTP_NETWORK_AUTHENTICATION_REQUIRED = 511;
// RFC6585
/**
* @var \Symfony\Component\HttpFoundation\ResponseHeaderBag
*/
public $headers;
/**
* @var string
*/
protected $content;
/**
* @var string
*/
protected $version;
/**
* @var int
*/
protected $statusCode;
/**
* @var string
*/
protected $statusText;
/**
* @var string
*/
protected $charset;
/**
* Status codes translation table.
*
* The list of codes is complete according to the
* {@link http://www.iana.org/assignments/http-status-codes/ Hypertext Transfer Protocol (HTTP) Status Code Registry}
* (last updated 2016-03-01).
*
* Unless otherwise noted, the status code is defined in RFC2616.
*
* @var array
*/
public static $statusTexts = array(
100 => 'Continue',
101 => 'Switching Protocols',
102 => 'Processing',
// RFC2518
200 => 'OK',
201 => 'Created',
202 => 'Accepted',
203 => 'Non-Authoritative Information',
204 => 'No Content',
205 => 'Reset Content',
206 => 'Partial Content',
207 => 'Multi-Status',
// RFC4918
208 => 'Already Reported',
// RFC5842
226 => 'IM Used',
// RFC3229
300 => 'Multiple Choices',
301 => 'Moved Permanently',
302 => 'Found',
303 => 'See Other',
304 => 'Not Modified',
305 => 'Use Proxy',
307 => 'Temporary Redirect',
308 => 'Permanent Redirect',
// RFC7238
400 => 'Bad Request',
401 => 'Unauthorized',
402 => 'Payment Required',
403 => 'Forbidden',
404 => 'Not Found',
405 => 'Method Not Allowed',
406 => 'Not Acceptable',
407 => 'Proxy Authentication Required',
408 => 'Request Timeout',
409 => 'Conflict',
410 => 'Gone',
411 => 'Length Required',
412 => 'Precondition Failed',
413 => 'Payload Too Large',
414 => 'URI Too Long',
415 => 'Unsupported Media Type',
416 => 'Range Not Satisfiable',
417 => 'Expectation Failed',
418 => 'I\'m a teapot',
// RFC2324
421 => 'Misdirected Request',
// RFC7540
422 => 'Unprocessable Entity',
// RFC4918
423 => 'Locked',
// RFC4918
424 => 'Failed Dependency',
// RFC4918
425 => 'Reserved for WebDAV advanced collections expired proposal',
// RFC2817
426 => 'Upgrade Required',
// RFC2817
428 => 'Precondition Required',
// RFC6585
429 => 'Too Many Requests',
// RFC6585
431 => 'Request Header Fields Too Large',
// RFC6585
451 => 'Unavailable For Legal Reasons',
// RFC7725
500 => 'Internal Server Error',
501 => 'Not Implemented',
502 => 'Bad Gateway',
503 => 'Service Unavailable',
504 => 'Gateway Timeout',
505 => 'HTTP Version Not Supported',
506 => 'Variant Also Negotiates (Experimental)',
// RFC2295
507 => 'Insufficient Storage',
// RFC4918
508 => 'Loop Detected',
// RFC5842
510 => 'Not Extended',
// RFC2774
511 => 'Network Authentication Required',
);
/**
* Constructor.
*
* @param mixed $content The response content, see setContent()
* @param int $status The response status code
* @param array $headers An array of response headers
*
* @throws \InvalidArgumentException When the HTTP status code is not valid
*/
public function __construct($content = '', $status = 200, $headers = array())
{
}
/**
* Factory method for chainability.
*
* Example:
*
* return Response::create($body, 200)
* ->setSharedMaxAge(300);
*
* @param mixed $content The response content, see setContent()
* @param int $status The response status code
* @param array $headers An array of response headers
*
* @return Response
*/
public static function create($content = '', $status = 200, $headers = array())
{
}
/**
* Returns the Response as an HTTP string.
*
* The string representation of the Response is the same as the
* one that will be sent to the client only if the prepare() method
* has been called before.
*
* @return string The Response as an HTTP string
*
* @see prepare()
*/
public function __toString()
{
}
/**
* Clones the current Response instance.
*/
public function __clone()
{
}
/**
* Prepares the Response before it is sent to the client.
*
* This method tweaks the Response to ensure that it is
* compliant with RFC 2616. Most of the changes are based on
* the Request that is "associated" with this Response.
*
* @param Request $request A Request instance
*
* @return Response The current response.
*/
public function prepare(\Symfony\Component\HttpFoundation\Request $request)
{
}
/**
* Sends HTTP headers.
*
* @return Response
*/
public function sendHeaders()
{
}
/**
* Sends content for the current web response.
*
* @return Response
*/
public function sendContent()
{
}
/**
* Sends HTTP headers and content.
*
* @return Response
*/
public function send()
{
}
/**
* Sets the response content.
*
* Valid types are strings, numbers, null, and objects that implement a __toString() method.
*
* @param mixed $content Content that can be cast to string
*
* @return Response
*
* @throws \UnexpectedValueException
*/
public function setContent($content)
{
}
/**
* Gets the current response content.
*
* @return string Content
*/
public function getContent()
{
}
/**
* Sets the HTTP protocol version (1.0 or 1.1).
*
* @param string $version The HTTP protocol version
*
* @return Response
*/
public function setProtocolVersion($version)
{
}
/**
* Gets the HTTP protocol version.
*
* @return string The HTTP protocol version
*/
public function getProtocolVersion()
{
}
/**
* Sets the response status code.
*
* @param int $code HTTP status code
* @param mixed $text HTTP status text
*
* If the status text is null it will be automatically populated for the known
* status codes and left empty otherwise.
*
* @return Response
*
* @throws \InvalidArgumentException When the HTTP status code is not valid
*/
public function setStatusCode($code, $text = null)
{
}
/**
* Retrieves the status code for the current web response.
*
* @return int Status code
*/
public function getStatusCode()
{
}
/**
* Sets the response charset.
*
* @param string $charset Character set
*
* @return Response
*/
public function setCharset($charset)
{
}
/**
* Retrieves the response charset.
*
* @return string Character set
*/
public function getCharset()
{
}
/**
* Returns true if the response is worth caching under any circumstance.
*
* Responses marked "private" with an explicit Cache-Control directive are
* considered uncacheable.
*
* Responses with neither a freshness lifetime (Expires, max-age) nor cache
* validator (Last-Modified, ETag) are considered uncacheable.
*
* @return bool true if the response is worth caching, false otherwise
*/
public function isCacheable()
{
}
/**
* Returns true if the response is "fresh".
*
* Fresh responses may be served from cache without any interaction with the
* origin. A response is considered fresh when it includes a Cache-Control/max-age
* indicator or Expires header and the calculated age is less than the freshness lifetime.
*
* @return bool true if the response is fresh, false otherwise
*/
public function isFresh()
{
}
/**
* Returns true if the response includes headers that can be used to validate
* the response with the origin server using a conditional GET request.
*
* @return bool true if the response is validateable, false otherwise
*/
public function isValidateable()
{
}
/**
* Marks the response as "private".
*
* It makes the response ineligible for serving other clients.
*
* @return Response
*/
public function setPrivate()
{
}
/**
* Marks the response as "public".
*
* It makes the response eligible for serving other clients.
*
* @return Response
*/
public function setPublic()
{
}
/**
* Returns true if the response must be revalidated by caches.
*
* This method indicates that the response must not be served stale by a
* cache in any circumstance without first revalidating with the origin.
* When present, the TTL of the response should not be overridden to be
* greater than the value provided by the origin.
*
* @return bool true if the response must be revalidated by a cache, false otherwise
*/
public function mustRevalidate()
{
}
/**
* Returns the Date header as a DateTime instance.
*
* @return \DateTime A \DateTime instance
*
* @throws \RuntimeException When the header is not parseable
*/
public function getDate()
{
}
/**
* Sets the Date header.
*
* @param \DateTime $date A \DateTime instance
*
* @return Response
*/
public function setDate(\DateTime $date)
{
}
/**
* Returns the age of the response.
*
* @return int The age of the response in seconds
*/
public function getAge()
{
}
/**
* Marks the response stale by setting the Age header to be equal to the maximum age of the response.
*
* @return Response
*/
public function expire()
{
}
/**
* Returns the value of the Expires header as a DateTime instance.
*
* @return \DateTime|null A DateTime instance or null if the header does not exist
*/
public function getExpires()
{
}
/**
* Sets the Expires HTTP header with a DateTime instance.
*
* Passing null as value will remove the header.
*
* @param \DateTime|null $date A \DateTime instance or null to remove the header
*
* @return Response
*/
public function setExpires(\DateTime $date = null)
{
}
/**
* Returns the number of seconds after the time specified in the response's Date
* header when the response should no longer be considered fresh.
*
* First, it checks for a s-maxage directive, then a max-age directive, and then it falls
* back on an expires header. It returns null when no maximum age can be established.
*
* @return int|null Number of seconds
*/
public function getMaxAge()
{
}
/**
* Sets the number of seconds after which the response should no longer be considered fresh.
*
* This methods sets the Cache-Control max-age directive.
*
* @param int $value Number of seconds
*
* @return Response
*/
public function setMaxAge($value)
{
}
/**
* Sets the number of seconds after which the response should no longer be considered fresh by shared caches.
*
* This methods sets the Cache-Control s-maxage directive.
*
* @param int $value Number of seconds
*
* @return Response
*/
public function setSharedMaxAge($value)
{
}
/**
* Returns the response's time-to-live in seconds.
*
* It returns null when no freshness information is present in the response.
*
* When the responses TTL is <= 0, the response may not be served from cache without first
* revalidating with the origin.
*
* @return int|null The TTL in seconds
*/
public function getTtl()
{
}
/**
* Sets the response's time-to-live for shared caches.
*
* This method adjusts the Cache-Control/s-maxage directive.
*
* @param int $seconds Number of seconds
*
* @return Response
*/
public function setTtl($seconds)
{
}
/**
* Sets the response's time-to-live for private/client caches.
*
* This method adjusts the Cache-Control/max-age directive.
*
* @param int $seconds Number of seconds
*
* @return Response
*/
public function setClientTtl($seconds)
{
}
/**
* Returns the Last-Modified HTTP header as a DateTime instance.
*
* @return \DateTime|null A DateTime instance or null if the header does not exist
*
* @throws \RuntimeException When the HTTP header is not parseable
*/
public function getLastModified()
{
}
/**
* Sets the Last-Modified HTTP header with a DateTime instance.
*
* Passing null as value will remove the header.
*
* @param \DateTime|null $date A \DateTime instance or null to remove the header
*
* @return Response
*/
public function setLastModified(\DateTime $date = null)
{
}
/**
* Returns the literal value of the ETag HTTP header.
*
* @return string|null The ETag HTTP header or null if it does not exist
*/
public function getEtag()
{
}
/**
* Sets the ETag value.
*
* @param string|null $etag The ETag unique identifier or null to remove the header
* @param bool $weak Whether you want a weak ETag or not
*
* @return Response
*/
public function setEtag($etag = null, $weak = false)
{
}
/**
* Sets the response's cache headers (validation and/or expiration).
*
* Available options are: etag, last_modified, max_age, s_maxage, private, and public.
*
* @param array $options An array of cache options
*
* @return Response
*
* @throws \InvalidArgumentException
*/
public function setCache(array $options)
{
}
/**
* Modifies the response so that it conforms to the rules defined for a 304 status code.
*
* This sets the status, removes the body, and discards any headers
* that MUST NOT be included in 304 responses.
*
* @return Response
*
* @see http://tools.ietf.org/html/rfc2616#section-10.3.5
*/
public function setNotModified()
{
}
/**
* Returns true if the response includes a Vary header.
*
* @return bool true if the response includes a Vary header, false otherwise
*/
public function hasVary()
{
}
/**
* Returns an array of header names given in the Vary header.
*
* @return array An array of Vary names
*/
public function getVary()
{
}
/**
* Sets the Vary header.
*
* @param string|array $headers
* @param bool $replace Whether to replace the actual value or not (true by default)
*
* @return Response
*/
public function setVary($headers, $replace = true)
{
}
/**
* Determines if the Response validators (ETag, Last-Modified) match
* a conditional value specified in the Request.
*
* If the Response is not modified, it sets the status code to 304 and
* removes the actual content by calling the setNotModified() method.
*
* @param Request $request A Request instance
*
* @return bool true if the Response validators match the Request, false otherwise
*/
public function isNotModified(\Symfony\Component\HttpFoundation\Request $request)
{
}
/**
* Is response invalid?
*
* @return bool
*
* @see http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
*/
public function isInvalid()
{
}
/**
* Is response informative?
*
* @return bool
*/
public function isInformational()
{
}
/**
* Is response successful?
*
* @return bool
*/
public function isSuccessful()
{
}
/**
* Is the response a redirect?
*
* @return bool
*/
public function isRedirection()
{
}
/**
* Is there a client error?
*
* @return bool
*/
public function isClientError()
{
}
/**
* Was there a server side error?
*
* @return bool
*/
public function isServerError()
{
}
/**
* Is the response OK?
*
* @return bool
*/
public function isOk()
{
}
/**
* Is the response forbidden?
*
* @return bool
*/
public function isForbidden()
{
}
/**
* Is the response a not found error?
*
* @return bool
*/
public function isNotFound()
{
}
/**
* Is the response a redirect of some form?
*
* @param string $location
*
* @return bool
*/
public function isRedirect($location = null)
{
}
/**
* Is the response empty?
*
* @return bool
*/
public function isEmpty()
{
}
/**
* Cleans or flushes output buffers up to target level.
*
* Resulting level can be greater than target level if a non-removable buffer has been encountered.
*
* @param int $targetLevel The target output buffering level
* @param bool $flush Whether to flush or clean the buffers
*/
public static function closeOutputBuffers($targetLevel, $flush)
{
}
/**
* Checks if we need to remove Cache-Control for SSL encrypted downloads when using IE < 9.
*
* @link http://support.microsoft.com/kb/323308
*/
protected function ensureIEOverSSLCompatibility(\Symfony\Component\HttpFoundation\Request $request)
{
}
}
/**
* Response represents an HTTP response in JSON format.
*
* Note that this class does not force the returned JSON content to be an
* object. It is however recommended that you do return an object as it
* protects yourself against XSSI and JSON-JavaScript Hijacking.
*
* @see https://www.owasp.org/index.php/OWASP_AJAX_Security_Guidelines#Always_return_JSON_with_an_Object_on_the_outside
*
* @author Igor Wiedler <igor@wiedler.ch>
*/
class JsonResponse extends \Symfony\Component\HttpFoundation\Response
{
protected $data;
protected $callback;
// Encode <, >, ', &, and " for RFC4627-compliant JSON, which may also be embedded into HTML.
// 15 === JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT
protected $encodingOptions = 15;
/**
* Constructor.
*
* @param mixed $data The response data
* @param int $status The response status code
* @param array $headers An array of response headers
*/
public function __construct($data = null, $status = 200, $headers = array())
{
}
/**
* {@inheritdoc}
*/
public static function create($data = null, $status = 200, $headers = array())
{
}
/**
* Sets the JSONP callback.
*
* @param string|null $callback The JSONP callback or null to use none
*
* @return JsonResponse
*
* @throws \InvalidArgumentException When the callback name is not valid
*/
public function setCallback($callback = null)
{
}
/**
* Sets the data to be sent as JSON.
*
* @param mixed $data
*
* @return JsonResponse
*
* @throws \InvalidArgumentException
*/
public function setData($data = array())
{
}
/**
* Returns options used while encoding data to JSON.
*
* @return int
*/
public function getEncodingOptions()
{
}
/**
* Sets options used while encoding data to JSON.
*
* @param int $encodingOptions
*
* @return JsonResponse
*/
public function setEncodingOptions($encodingOptions)
{
}
/**
* Updates the content and headers according to the JSON data and callback.
*
* @return JsonResponse
*/
protected function update()
{
}
}
/**
* RedirectResponse represents an HTTP response doing a redirect.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class RedirectResponse extends \Symfony\Component\HttpFoundation\Response
{
protected $targetUrl;
/**
* Creates a redirect response so that it conforms to the rules defined for a redirect status code.
*
* @param string $url The URL to redirect to. The URL should be a full URL, with schema etc.,
* but practically every browser redirects on paths only as well
* @param int $status The status code (302 by default)
* @param array $headers The headers (Location is always set to the given URL)
*
* @throws \InvalidArgumentException
*
* @see http://tools.ietf.org/html/rfc2616#section-10.3
*/
public function __construct($url, $status = 302, $headers = array())
{
}
/**
* {@inheritdoc}
*/
public static function create($url = '', $status = 302, $headers = array())
{
}
/**
* Returns the target URL.
*
* @return string target URL
*/
public function getTargetUrl()
{
}
/**
* Sets the redirect target of this response.
*
* @param string $url The URL to redirect to
*
* @return RedirectResponse The current response.
*
* @throws \InvalidArgumentException
*/
public function setTargetUrl($url)
{
}
}
/**
* Represents a cookie.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class Cookie
{
protected $name;
protected $value;
protected $domain;
protected $expire;
protected $path;
protected $secure;
protected $httpOnly;
/**
* Constructor.
*
* @param string $name The name of the cookie
* @param string $value The value of the cookie
* @param int|string|\DateTime|\DateTimeInterface $expire The time the cookie expires
* @param string $path The path on the server in which the cookie will be available on
* @param string $domain The domain that the cookie is available to
* @param bool $secure Whether the cookie should only be transmitted over a secure HTTPS connection from the client
* @param bool $httpOnly Whether the cookie will be made accessible only through the HTTP protocol
*
* @throws \InvalidArgumentException
*/
public function __construct($name, $value = null, $expire = 0, $path = '/', $domain = null, $secure = false, $httpOnly = true)
{
}
/**
* Returns the cookie as a string.
*
* @return string The cookie
*/
public function __toString()
{
}
/**
* Gets the name of the cookie.
*
* @return string
*/
public function getName()
{
}
/**
* Gets the value of the cookie.
*
* @return string
*/
public function getValue()
{
}
/**
* Gets the domain that the cookie is available to.
*
* @return string
*/
public function getDomain()
{
}
/**
* Gets the time the cookie expires.
*
* @return int
*/
public function getExpiresTime()
{
}
/**
* Gets the path on the server in which the cookie will be available on.
*
* @return string
*/
public function getPath()
{
}
/**
* Checks whether the cookie should only be transmitted over a secure HTTPS connection from the client.
*
* @return bool
*/
public function isSecure()
{
}
/**
* Checks whether the cookie will be made accessible only through the HTTP protocol.
*
* @return bool
*/
public function isHttpOnly()
{
}
/**
* Whether this cookie is about to be cleared.
*
* @return bool
*/
public function isCleared()
{
}
}
/**
* RequestMatcherInterface is an interface for strategies to match a Request.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
interface RequestMatcherInterface
{
/**
* Decides whether the rule(s) implemented by the strategy matches the supplied request.
*
* @param Request $request The request to check for a match
*
* @return bool true if the request matches, false otherwise
*/
public function matches(\Symfony\Component\HttpFoundation\Request $request);
}
/**
* RequestMatcher compares a pre-defined set of checks against a Request instance.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class RequestMatcher implements \Symfony\Component\HttpFoundation\RequestMatcherInterface
{
/**
* @param string|null $path
* @param string|null $host
* @param string|string[]|null $methods
* @param string|string[]|null $ips
* @param array $attributes
* @param string|string[]|null $schemes
*/
public function __construct($path = null, $host = null, $methods = null, $ips = null, array $attributes = array(), $schemes = null)
{
}
/**
* Adds a check for the HTTP scheme.
*
* @param string|string[]|null $scheme An HTTP scheme or an array of HTTP schemes
*/
public function matchScheme($scheme)
{
}
/**
* Adds a check for the URL host name.
*
* @param string $regexp A Regexp
*/
public function matchHost($regexp)
{
}
/**
* Adds a check for the URL path info.
*
* @param string $regexp A Regexp
*/
public function matchPath($regexp)
{
}
/**
* Adds a check for the client IP.
*
* @param string $ip A specific IP address or a range specified using IP/netmask like 192.168.1.0/24
*/
public function matchIp($ip)
{
}
/**
* Adds a check for the client IP.
*
* @param string|string[] $ips A specific IP address or a range specified using IP/netmask like 192.168.1.0/24
*/
public function matchIps($ips)
{
}
/**
* Adds a check for the HTTP method.
*
* @param string|string[] $method An HTTP method or an array of HTTP methods
*/
public function matchMethod($method)
{
}
/**
* Adds a check for request attribute.
*
* @param string $key The request attribute name
* @param string $regexp A Regexp
*/
public function matchAttribute($key, $regexp)
{
}
/**
* {@inheritdoc}
*/
public function matches(\Symfony\Component\HttpFoundation\Request $request)
{
}
}
/**
* ExpressionRequestMatcher uses an expression to match a Request.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class ExpressionRequestMatcher extends \Symfony\Component\HttpFoundation\RequestMatcher
{
public function setExpression(\Symfony\Component\ExpressionLanguage\ExpressionLanguage $language, $expression)
{
}
public function matches(\Symfony\Component\HttpFoundation\Request $request)
{
}
}
/**
* StreamedResponse represents a streamed HTTP response.
*
* A StreamedResponse uses a callback for its content.
*
* The callback should use the standard PHP functions like echo
* to stream the response back to the client. The flush() method
* can also be used if needed.
*
* @see flush()
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class StreamedResponse extends \Symfony\Component\HttpFoundation\Response
{
protected $callback;
protected $streamed;
/**
* Constructor.
*
* @param callable|null $callback A valid PHP callback or null to set it later
* @param int $status The response status code
* @param array $headers An array of response headers
*/
public function __construct($callback = null, $status = 200, $headers = array())
{
}
/**
* Factory method for chainability.
*
* @param callable|null $callback A valid PHP callback or null to set it later
* @param int $status The response status code
* @param array $headers An array of response headers
*
* @return StreamedResponse
*/
public static function create($callback = null, $status = 200, $headers = array())
{
}
/**
* Sets the PHP callback associated with this Response.
*
* @param callable $callback A valid PHP callback
*
* @throws \LogicException
*/
public function setCallback($callback)
{
}
/**
* {@inheritdoc}
*
* This method only sends the content once.
*/
public function sendContent()
{
}
/**
* {@inheritdoc}
*
* @throws \LogicException when the content is not null
*/
public function setContent($content)
{
}
/**
* {@inheritdoc}
*
* @return false
*/
public function getContent()
{
}
}
/**
* HeaderBag is a container for HTTP headers.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class HeaderBag implements \IteratorAggregate, \Countable
{
protected $headers = array();
protected $cacheControl = array();
/**
* Constructor.
*
* @param array $headers An array of HTTP headers
*/
public function __construct(array $headers = array())
{
}
/**
* Returns the headers as a string.
*
* @return string The headers
*/
public function __toString()
{
}
/**
* Returns the headers.
*
* @return array An array of headers
*/
public function all()
{
}
/**
* Returns the parameter keys.
*
* @return array An array of parameter keys
*/
public function keys()
{
}
/**
* Replaces the current HTTP headers by a new set.
*
* @param array $headers An array of HTTP headers
*/
public function replace(array $headers = array())
{
}
/**
* Adds new headers the current HTTP headers set.
*
* @param array $headers An array of HTTP headers
*/
public function add(array $headers)
{
}
/**
* Returns a header value by name.
*
* @param string $key The header name
* @param mixed $default The default value
* @param bool $first Whether to return the first value or all header values
*
* @return string|array The first header value if $first is true, an array of values otherwise
*/
public function get($key, $default = null, $first = true)
{
}
/**
* Sets a header by name.
*
* @param string $key The key
* @param string|array $values The value or an array of values
* @param bool $replace Whether to replace the actual value or not (true by default)
*/
public function set($key, $values, $replace = true)
{
}
/**
* Returns true if the HTTP header is defined.
*
* @param string $key The HTTP header
*
* @return bool true if the parameter exists, false otherwise
*/
public function has($key)
{
}
/**
* Returns true if the given HTTP header contains the given value.
*
* @param string $key The HTTP header name
* @param string $value The HTTP value
*
* @return bool true if the value is contained in the header, false otherwise
*/
public function contains($key, $value)
{
}
/**
* Removes a header.
*
* @param string $key The HTTP header name
*/
public function remove($key)
{
}
/**
* Returns the HTTP header value converted to a date.
*
* @param string $key The parameter key
* @param \DateTime $default The default value
*
* @return null|\DateTime The parsed DateTime or the default value if the header does not exist
*
* @throws \RuntimeException When the HTTP header is not parseable
*/
public function getDate($key, \DateTime $default = null)
{
}
/**
* Adds a custom Cache-Control directive.
*
* @param string $key The Cache-Control directive name
* @param mixed $value The Cache-Control directive value
*/
public function addCacheControlDirective($key, $value = true)
{
}
/**
* Returns true if the Cache-Control directive is defined.
*
* @param string $key The Cache-Control directive
*
* @return bool true if the directive exists, false otherwise
*/
public function hasCacheControlDirective($key)
{
}
/**
* Returns a Cache-Control directive value by name.
*
* @param string $key The directive name
*
* @return mixed|null The directive value if defined, null otherwise
*/
public function getCacheControlDirective($key)
{
}
/**
* Removes a Cache-Control directive.
*
* @param string $key The Cache-Control directive
*/
public function removeCacheControlDirective($key)
{
}
/**
* Returns an iterator for headers.
*
* @return \ArrayIterator An \ArrayIterator instance
*/
public function getIterator()
{
}
/**
* Returns the number of headers.
*
* @return int The number of headers
*/
public function count()
{
}
protected function getCacheControlHeader()
{
}
/**
* Parses a Cache-Control HTTP header.
*
* @param string $header The value of the Cache-Control HTTP header
*
* @return array An array representing the attribute values
*/
protected function parseCacheControl($header)
{
}
}
/**
* Represents an Accept-* header item.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class AcceptHeaderItem
{
/**
* Constructor.
*
* @param string $value
* @param array $attributes
*/
public function __construct($value, array $attributes = array())
{
}
/**
* Builds an AcceptHeaderInstance instance from a string.
*
* @param string $itemValue
*
* @return AcceptHeaderItem
*/
public static function fromString($itemValue)
{
}
/**
* Returns header value's string representation.
*
* @return string
*/
public function __toString()
{
}
/**
* Set the item value.
*
* @param string $value
*
* @return AcceptHeaderItem
*/
public function setValue($value)
{
}
/**
* Returns the item value.
*
* @return string
*/
public function getValue()
{
}
/**
* Set the item quality.
*
* @param float $quality
*
* @return AcceptHeaderItem
*/
public function setQuality($quality)
{
}
/**
* Returns the item quality.
*
* @return float
*/
public function getQuality()
{
}
/**
* Set the item index.
*
* @param int $index
*
* @return AcceptHeaderItem
*/
public function setIndex($index)
{
}
/**
* Returns the item index.
*
* @return int
*/
public function getIndex()
{
}
/**
* Tests if an attribute exists.
*
* @param string $name
*
* @return bool
*/
public function hasAttribute($name)
{
}
/**
* Returns an attribute by its name.
*
* @param string $name
* @param mixed $default
*
* @return mixed
*/
public function getAttribute($name, $default = null)
{
}
/**
* Returns all attributes.
*
* @return array
*/
public function getAttributes()
{
}
/**
* Set an attribute.
*
* @param string $name
* @param string $value
*
* @return AcceptHeaderItem
*/
public function setAttribute($name, $value)
{
}
}
/**
* Request stack that controls the lifecycle of requests.
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
*/
class RequestStack
{
/**
* Pushes a Request on the stack.
*
* This method should generally not be called directly as the stack
* management should be taken care of by the application itself.
*/
public function push(\Symfony\Component\HttpFoundation\Request $request)
{
}
/**
* Pops the current request from the stack.
*
* This operation lets the current request go out of scope.
*
* This method should generally not be called directly as the stack
* management should be taken care of by the application itself.
*
* @return Request|null
*/
public function pop()
{
}
/**
* @return Request|null
*/
public function getCurrentRequest()
{
}
/**
* Gets the master Request.
*
* Be warned that making your code aware of the master request
* might make it un-compatible with other features of your framework
* like ESI support.
*
* @return Request|null
*/
public function getMasterRequest()
{
}
/**
* Returns the parent request of the current.
*
* Be warned that making your code aware of the parent request
* might make it un-compatible with other features of your framework
* like ESI support.
*
* If current Request is the master request, it returns null.
*
* @return Request|null
*/
public function getParentRequest()
{
}
}
/**
* ServerBag is a container for HTTP headers from the $_SERVER variable.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Bulat Shakirzyanov <mallluhuct@gmail.com>
* @author Robert Kiss <kepten@gmail.com>
*/
class ServerBag extends \Symfony\Component\HttpFoundation\ParameterBag
{
/**
* Gets the HTTP headers.
*
* @return array
*/
public function getHeaders()
{
}
}
/**
* ResponseHeaderBag is a container for Response HTTP headers.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class ResponseHeaderBag extends \Symfony\Component\HttpFoundation\HeaderBag
{
const COOKIES_FLAT = 'flat';
const COOKIES_ARRAY = 'array';
const DISPOSITION_ATTACHMENT = 'attachment';
const DISPOSITION_INLINE = 'inline';
/**
* @var array
*/
protected $computedCacheControl = array();
/**
* @var array
*/
protected $cookies = array();
/**
* @var array
*/
protected $headerNames = array();
/**
* Constructor.
*
* @param array $headers An array of HTTP headers
*/
public function __construct(array $headers = array())
{
}
/**
* {@inheritdoc}
*/
public function __toString()
{
}
/**
* Returns the headers, with original capitalizations.
*
* @return array An array of headers
*/
public function allPreserveCase()
{
}
/**
* {@inheritdoc}
*/
public function replace(array $headers = array())
{
}
/**
* {@inheritdoc}
*/
public function set($key, $values, $replace = true)
{
}
/**
* {@inheritdoc}
*/
public function remove($key)
{
}
/**
* {@inheritdoc}
*/
public function hasCacheControlDirective($key)
{
}
/**
* {@inheritdoc}
*/
public function getCacheControlDirective($key)
{
}
/**
* Sets a cookie.
*
* @param Cookie $cookie
*/
public function setCookie(\Symfony\Component\HttpFoundation\Cookie $cookie)
{
}
/**
* Removes a cookie from the array, but does not unset it in the browser.
*
* @param string $name
* @param string $path
* @param string $domain
*/
public function removeCookie($name, $path = '/', $domain = null)
{
}
/**
* Returns an array with all cookies.
*
* @param string $format
*
* @return array
*
* @throws \InvalidArgumentException When the $format is invalid
*/
public function getCookies($format = self::COOKIES_FLAT)
{
}
/**
* Clears a cookie in the browser.
*
* @param string $name
* @param string $path
* @param string $domain
* @param bool $secure
* @param bool $httpOnly
*/
public function clearCookie($name, $path = '/', $domain = null, $secure = false, $httpOnly = true)
{
}
/**
* Generates a HTTP Content-Disposition field-value.
*
* @param string $disposition One of "inline" or "attachment"
* @param string $filename A unicode string
* @param string $filenameFallback A string containing only ASCII characters that
* is semantically equivalent to $filename. If the filename is already ASCII,
* it can be omitted, or just copied from $filename
*
* @return string A string suitable for use as a Content-Disposition field-value.
*
* @throws \InvalidArgumentException
*
* @see RFC 6266
*/
public function makeDisposition($disposition, $filename, $filenameFallback = '')
{
}
/**
* Returns the calculated value of the cache-control header.
*
* This considers several other headers and calculates or modifies the
* cache-control header to a sensible, conservative value.
*
* @return string
*/
protected function computeCacheControlValue()
{
}
}
/**
* Http utility functions.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class IpUtils
{
/**
* Checks if an IPv4 or IPv6 address is contained in the list of given IPs or subnets.
*
* @param string $requestIp IP to check
* @param string|array $ips List of IPs or subnets (can be a string if only a single one)
*
* @return bool Whether the IP is valid
*/
public static function checkIp($requestIp, $ips)
{
}
/**
* Compares two IPv4 addresses.
* In case a subnet is given, it checks if it contains the request IP.
*
* @param string $requestIp IPv4 address to check
* @param string $ip IPv4 address or subnet in CIDR notation
*
* @return bool Whether the request IP matches the IP, or whether the request IP is within the CIDR subnet.
*/
public static function checkIp4($requestIp, $ip)
{
}
/**
* Compares two IPv6 addresses.
* In case a subnet is given, it checks if it contains the request IP.
*
* @author David Soria Parra <dsp at php dot net>
*
* @see https://github.com/dsp/v6tools
*
* @param string $requestIp IPv6 address to check
* @param string $ip IPv6 address or subnet in CIDR notation
*
* @return bool Whether the IP is valid
*
* @throws \RuntimeException When IPV6 support is not enabled
*/
public static function checkIp6($requestIp, $ip)
{
}
}
/**
* BinaryFileResponse represents an HTTP response delivering a file.
*
* @author Niklas Fiekas <niklas.fiekas@tu-clausthal.de>
* @author stealth35 <stealth35-php@live.fr>
* @author Igor Wiedler <igor@wiedler.ch>
* @author Jordan Alliot <jordan.alliot@gmail.com>
* @author Sergey Linnik <linniksa@gmail.com>
*/
class BinaryFileResponse extends \Symfony\Component\HttpFoundation\Response
{
protected static $trustXSendfileTypeHeader = false;
/**
* @var File
*/
protected $file;
protected $offset;
protected $maxlen;
protected $deleteFileAfterSend = false;
/**
* Constructor.
*
* @param \SplFileInfo|string $file The file to stream
* @param int $status The response status code
* @param array $headers An array of response headers
* @param bool $public Files are public by default
* @param null|string $contentDisposition The type of Content-Disposition to set automatically with the filename
* @param bool $autoEtag Whether the ETag header should be automatically set
* @param bool $autoLastModified Whether the Last-Modified header should be automatically set
*/
public function __construct($file, $status = 200, $headers = array(), $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
{
}
/**
* @param \SplFileInfo|string $file The file to stream
* @param int $status The response status code
* @param array $headers An array of response headers
* @param bool $public Files are public by default
* @param null|string $contentDisposition The type of Content-Disposition to set automatically with the filename
* @param bool $autoEtag Whether the ETag header should be automatically set
* @param bool $autoLastModified Whether the Last-Modified header should be automatically set
*
* @return BinaryFileResponse The created response
*/
public static function create($file = null, $status = 200, $headers = array(), $public = true, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
{
}
/**
* Sets the file to stream.
*
* @param \SplFileInfo|string $file The file to stream
* @param string $contentDisposition
* @param bool $autoEtag
* @param bool $autoLastModified
*
* @return BinaryFileResponse
*
* @throws FileException
*/
public function setFile($file, $contentDisposition = null, $autoEtag = false, $autoLastModified = true)
{
}
/**
* Gets the file.
*
* @return File The file to stream
*/
public function getFile()
{
}
/**
* Automatically sets the Last-Modified header according the file modification date.
*/
public function setAutoLastModified()
{
}
/**
* Automatically sets the ETag header according to the checksum of the file.
*/
public function setAutoEtag()
{
}
/**
* Sets the Content-Disposition header with the given filename.
*
* @param string $disposition ResponseHeaderBag::DISPOSITION_INLINE or ResponseHeaderBag::DISPOSITION_ATTACHMENT
* @param string $filename Optionally use this filename instead of the real name of the file
* @param string $filenameFallback A fallback filename, containing only ASCII characters. Defaults to an automatically encoded filename
*
* @return BinaryFileResponse
*/
public function setContentDisposition($disposition, $filename = '', $filenameFallback = '')
{
}
/**
* {@inheritdoc}
*/
public function prepare(\Symfony\Component\HttpFoundation\Request $request)
{
}
/**
* Sends the file.
*
* {@inheritdoc}
*/
public function sendContent()
{
}
/**
* {@inheritdoc}
*
* @throws \LogicException when the content is not null
*/
public function setContent($content)
{
}
/**
* {@inheritdoc}
*
* @return false
*/
public function getContent()
{
}
/**
* Trust X-Sendfile-Type header.
*/
public static function trustXSendfileTypeHeader()
{
}
/**
* If this is set to true, the file will be unlinked after the request is send
* Note: If the X-Sendfile header is used, the deleteFileAfterSend setting will not be used.
*
* @param bool $shouldDelete
*
* @return BinaryFileResponse
*/
public function deleteFileAfterSend($shouldDelete)
{
}
}
}
namespace Symfony\Component\HttpFoundation\File {
/**
* A file uploaded through a form.
*
* @author Bernhard Schussek <bschussek@gmail.com>
* @author Florian Eckerstorfer <florian@eckerstorfer.org>
* @author Fabien Potencier <fabien@symfony.com>
*/
class UploadedFile extends \Symfony\Component\HttpFoundation\File\File
{
/**
* Accepts the information of the uploaded file as provided by the PHP global $_FILES.
*
* The file object is only created when the uploaded file is valid (i.e. when the
* isValid() method returns true). Otherwise the only methods that could be called
* on an UploadedFile instance are:
*
* * getClientOriginalName,
* * getClientMimeType,
* * isValid,
* * getError.
*
* Calling any other method on an non-valid instance will cause an unpredictable result.
*
* @param string $path The full temporary path to the file
* @param string $originalName The original file name
* @param string|null $mimeType The type of the file as provided by PHP; null defaults to application/octet-stream
* @param int|null $size The file size
* @param int|null $error The error constant of the upload (one of PHP's UPLOAD_ERR_XXX constants); null defaults to UPLOAD_ERR_OK
* @param bool $test Whether the test mode is active
*
* @throws FileException If file_uploads is disabled
* @throws FileNotFoundException If the file does not exist
*/
public function __construct($path, $originalName, $mimeType = null, $size = null, $error = null, $test = false)
{
}
/**
* Returns the original file name.
*
* It is extracted from the request from which the file has been uploaded.
* Then it should not be considered as a safe value.
*
* @return string|null The original name
*/
public function getClientOriginalName()
{
}
/**
* Returns the original file extension.
*
* It is extracted from the original file name that was uploaded.
* Then it should not be considered as a safe value.
*
* @return string The extension
*/
public function getClientOriginalExtension()
{
}
/**
* Returns the file mime type.
*
* The client mime type is extracted from the request from which the file
* was uploaded, so it should not be considered as a safe value.
*
* For a trusted mime type, use getMimeType() instead (which guesses the mime
* type based on the file content).
*
* @return string|null The mime type
*
* @see getMimeType()
*/
public function getClientMimeType()
{
}
/**
* Returns the extension based on the client mime type.
*
* If the mime type is unknown, returns null.
*
* This method uses the mime type as guessed by getClientMimeType()
* to guess the file extension. As such, the extension returned
* by this method cannot be trusted.
*
* For a trusted extension, use guessExtension() instead (which guesses
* the extension based on the guessed mime type for the file).
*
* @return string|null The guessed extension or null if it cannot be guessed
*
* @see guessExtension()
* @see getClientMimeType()
*/
public function guessClientExtension()
{
}
/**
* Returns the file size.
*
* It is extracted from the request from which the file has been uploaded.
* Then it should not be considered as a safe value.
*
* @return int|null The file size
*/
public function getClientSize()
{
}
/**
* Returns the upload error.
*
* If the upload was successful, the constant UPLOAD_ERR_OK is returned.
* Otherwise one of the other UPLOAD_ERR_XXX constants is returned.
*
* @return int The upload error
*/
public function getError()
{
}
/**
* Returns whether the file was uploaded successfully.
*
* @return bool True if the file has been uploaded with HTTP and no error occurred.
*/
public function isValid()
{
}
/**
* Moves the file to a new location.
*
* @param string $directory The destination folder
* @param string $name The new file name
*
* @return File A File object representing the new file
*
* @throws FileException if, for any reason, the file could not have been moved
*/
public function move($directory, $name = null)
{
}
/**
* Returns the maximum size of an uploaded file as configured in php.ini.
*
* @return int The maximum size of an uploaded file in bytes
*/
public static function getMaxFilesize()
{
}
/**
* Returns an informative upload error message.
*
* @return string The error message regarding the specified error code
*/
public function getErrorMessage()
{
}
}
}
namespace Symfony\Component\HttpFoundation\File\MimeType {
/**
* Guesses the mime type of a file.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
interface MimeTypeGuesserInterface
{
/**
* Guesses the mime type of the file with the given path.
*
* @param string $path The path to the file
*
* @return string The mime type or NULL, if none could be guessed
*
* @throws FileNotFoundException If the file does not exist
* @throws AccessDeniedException If the file could not be read
*/
public function guess($path);
}
/**
* Guesses the mime type using the PECL extension FileInfo.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class FileinfoMimeTypeGuesser implements \Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface
{
/**
* Constructor.
*
* @param string $magicFile A magic file to use with the finfo instance
*
* @link http://www.php.net/manual/en/function.finfo-open.php
*/
public function __construct($magicFile = null)
{
}
/**
* Returns whether this guesser is supported on the current OS/PHP setup.
*
* @return bool
*/
public static function isSupported()
{
}
/**
* {@inheritdoc}
*/
public function guess($path)
{
}
}
/**
* Guesses the file extension corresponding to a given mime type.
*/
interface ExtensionGuesserInterface
{
/**
* Makes a best guess for a file extension, given a mime type.
*
* @param string $mimeType The mime type
*
* @return string The guessed extension or NULL, if none could be guessed
*/
public function guess($mimeType);
}
/**
* Guesses the mime type with the binary "file" (only available on *nix).
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class FileBinaryMimeTypeGuesser implements \Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface
{
/**
* Constructor.
*
* The $cmd pattern must contain a "%s" string that will be replaced
* with the file name to guess.
*
* The command output must start with the mime type of the file.
*
* @param string $cmd The command to run to get the mime type of a file
*/
public function __construct($cmd = 'file -b --mime %s 2>/dev/null')
{
}
/**
* Returns whether this guesser is supported on the current OS.
*
* @return bool
*/
public static function isSupported()
{
}
/**
* {@inheritdoc}
*/
public function guess($path)
{
}
}
/**
* Provides a best-guess mapping of mime type to file extension.
*/
class MimeTypeExtensionGuesser implements \Symfony\Component\HttpFoundation\File\MimeType\ExtensionGuesserInterface
{
/**
* A map of mime types and their default extensions.
*
* This list has been placed under the public domain by the Apache HTTPD project.
* This list has been updated from upstream on 2013-04-23.
*
* @see http://svn.apache.org/repos/asf/httpd/httpd/trunk/docs/conf/mime.types
*
* @var array
*/
protected $defaultExtensions = array('application/andrew-inset' => 'ez', 'application/applixware' => 'aw', 'application/atom+xml' => 'atom', 'application/atomcat+xml' => 'atomcat', 'application/atomsvc+xml' => 'atomsvc', 'application/ccxml+xml' => 'ccxml', 'application/cdmi-capability' => 'cdmia', 'application/cdmi-container' => 'cdmic', 'application/cdmi-domain' => 'cdmid', 'application/cdmi-object' => 'cdmio', 'application/cdmi-queue' => 'cdmiq', 'application/cu-seeme' => 'cu', 'application/davmount+xml' => 'davmount', 'application/docbook+xml' => 'dbk', 'application/dssc+der' => 'dssc', 'application/dssc+xml' => 'xdssc', 'application/ecmascript' => 'ecma', 'application/emma+xml' => 'emma', 'application/epub+zip' => 'epub', 'application/exi' => 'exi', 'application/font-tdpfr' => 'pfr', 'application/gml+xml' => 'gml', 'application/gpx+xml' => 'gpx', 'application/gxf' => 'gxf', 'application/hyperstudio' => 'stk', 'application/inkml+xml' => 'ink', 'application/ipfix' => 'ipfix', 'application/java-archive' => 'jar', 'application/java-serialized-object' => 'ser', 'application/java-vm' => 'class', 'application/javascript' => 'js', 'application/json' => 'json', 'application/jsonml+json' => 'jsonml', 'application/lost+xml' => 'lostxml', 'application/mac-binhex40' => 'hqx', 'application/mac-compactpro' => 'cpt', 'application/mads+xml' => 'mads', 'application/marc' => 'mrc', 'application/marcxml+xml' => 'mrcx', 'application/mathematica' => 'ma', 'application/mathml+xml' => 'mathml', 'application/mbox' => 'mbox', 'application/mediaservercontrol+xml' => 'mscml', 'application/metalink+xml' => 'metalink', 'application/metalink4+xml' => 'meta4', 'application/mets+xml' => 'mets', 'application/mods+xml' => 'mods', 'application/mp21' => 'm21', 'application/mp4' => 'mp4s', 'application/msword' => 'doc', 'application/mxf' => 'mxf', 'application/octet-stream' => 'bin', 'application/oda' => 'oda', 'application/oebps-package+xml' => 'opf', 'application/ogg' => 'ogx', 'application/omdoc+xml' => 'omdoc', 'application/onenote' => 'onetoc', 'application/oxps' => 'oxps', 'application/patch-ops-error+xml' => 'xer', 'application/pdf' => 'pdf', 'application/pgp-encrypted' => 'pgp', 'application/pgp-signature' => 'asc', 'application/pics-rules' => 'prf', 'application/pkcs10' => 'p10', 'application/pkcs7-mime' => 'p7m', 'application/pkcs7-signature' => 'p7s', 'application/pkcs8' => 'p8', 'application/pkix-attr-cert' => 'ac', 'application/pkix-cert' => 'cer', 'application/pkix-crl' => 'crl', 'application/pkix-pkipath' => 'pkipath', 'application/pkixcmp' => 'pki', 'application/pls+xml' => 'pls', 'application/postscript' => 'ai', 'application/prs.cww' => 'cww', 'application/pskc+xml' => 'pskcxml', 'application/rdf+xml' => 'rdf', 'application/reginfo+xml' => 'rif', 'application/relax-ng-compact-syntax' => 'rnc', 'application/resource-lists+xml' => 'rl', 'application/resource-lists-diff+xml' => 'rld', 'application/rls-services+xml' => 'rs', 'application/rpki-ghostbusters' => 'gbr', 'application/rpki-manifest' => 'mft', 'application/rpki-roa' => 'roa', 'application/rsd+xml' => 'rsd', 'application/rss+xml' => 'rss', 'application/rtf' => 'rtf', 'application/sbml+xml' => 'sbml', 'application/scvp-cv-request' => 'scq', 'application/scvp-cv-response' => 'scs', 'application/scvp-vp-request' => 'spq', 'application/scvp-vp-response' => 'spp', 'application/sdp' => 'sdp', 'application/set-payment-initiation' => 'setpay', 'application/set-registration-initiation' => 'setreg', 'application/shf+xml' => 'shf', 'application/smil+xml' => 'smi', 'application/sparql-query' => 'rq', 'application/sparql-results+xml' => 'srx', 'application/srgs' => 'gram', 'application/srgs+xml' => 'grxml', 'application/sru+xml' => 'sru', 'application/ssdl+xml' => 'ssdl', 'application/ssml+xml' => 'ssml', 'application/tei+xml' => 'tei', 'application/thraud+xml' => 'tfi', 'application/timestamped-data' => 'tsd', 'application/vnd.3gpp.pic-bw-large' => 'plb', 'application/vnd.3gpp.pic-bw-small' => 'psb', 'application/vnd.3gpp.pic-bw-var' => 'pvb', 'application/vnd.3gpp2.tcap' => 'tcap', 'application/vnd.3m.post-it-notes' => 'pwn', 'application/vnd.accpac.simply.aso' => 'aso', 'application/vnd.accpac.simply.imp' => 'imp', 'application/vnd.acucobol' => 'acu', 'application/vnd.acucorp' => 'atc', 'application/vnd.adobe.air-application-installer-package+zip' => 'air', 'application/vnd.adobe.formscentral.fcdt' => 'fcdt', 'application/vnd.adobe.fxp' => 'fxp', 'application/vnd.adobe.xdp+xml' => 'xdp', 'application/vnd.adobe.xfdf' => 'xfdf', 'application/vnd.ahead.space' => 'ahead', 'application/vnd.airzip.filesecure.azf' => 'azf', 'application/vnd.airzip.filesecure.azs' => 'azs', 'application/vnd.amazon.ebook' => 'azw', 'application/vnd.americandynamics.acc' => 'acc', 'application/vnd.amiga.ami' => 'ami', 'application/vnd.android.package-archive' => 'apk', 'application/vnd.anser-web-certificate-issue-initiation' => 'cii', 'application/vnd.anser-web-funds-transfer-initiation' => 'fti', 'application/vnd.antix.game-component' => 'atx', 'application/vnd.apple.installer+xml' => 'mpkg', 'application/vnd.apple.mpegurl' => 'm3u8', 'application/vnd.aristanetworks.swi' => 'swi', 'application/vnd.astraea-software.iota' => 'iota', 'application/vnd.audiograph' => 'aep', 'application/vnd.blueice.multipass' => 'mpm', 'application/vnd.bmi' => 'bmi', 'application/vnd.businessobjects' => 'rep', 'application/vnd.chemdraw+xml' => 'cdxml', 'application/vnd.chipnuts.karaoke-mmd' => 'mmd', 'application/vnd.cinderella' => 'cdy', 'application/vnd.claymore' => 'cla', 'application/vnd.cloanto.rp9' => 'rp9', 'application/vnd.clonk.c4group' => 'c4g', 'application/vnd.cluetrust.cartomobile-config' => 'c11amc', 'application/vnd.cluetrust.cartomobile-config-pkg' => 'c11amz', 'application/vnd.commonspace' => 'csp', 'application/vnd.contact.cmsg' => 'cdbcmsg', 'application/vnd.cosmocaller' => 'cmc', 'application/vnd.crick.clicker' => 'clkx', 'application/vnd.crick.clicker.keyboard' => 'clkk', 'application/vnd.crick.clicker.palette' => 'clkp', 'application/vnd.crick.clicker.template' => 'clkt', 'application/vnd.crick.clicker.wordbank' => 'clkw', 'application/vnd.criticaltools.wbs+xml' => 'wbs', 'application/vnd.ctc-posml' => 'pml', 'application/vnd.cups-ppd' => 'ppd', 'application/vnd.curl.car' => 'car', 'application/vnd.curl.pcurl' => 'pcurl', 'application/vnd.dart' => 'dart', 'application/vnd.data-vision.rdz' => 'rdz', 'application/vnd.dece.data' => 'uvf', 'application/vnd.dece.ttml+xml' => 'uvt', 'application/vnd.dece.unspecified' => 'uvx', 'application/vnd.dece.zip' => 'uvz', 'application/vnd.denovo.fcselayout-link' => 'fe_launch', 'application/vnd.dna' => 'dna', 'application/vnd.dolby.mlp' => 'mlp', 'application/vnd.dpgraph' => 'dpg', 'application/vnd.dreamfactory' => 'dfac', 'application/vnd.ds-keypoint' => 'kpxx', 'application/vnd.dvb.ait' => 'ait', 'application/vnd.dvb.service' => 'svc', 'application/vnd.dynageo' => 'geo', 'application/vnd.ecowin.chart' => 'mag', 'application/vnd.enliven' => 'nml', 'application/vnd.epson.esf' => 'esf', 'application/vnd.epson.msf' => 'msf', 'application/vnd.epson.quickanime' => 'qam', 'application/vnd.epson.salt' => 'slt', 'application/vnd.epson.ssf' => 'ssf', 'application/vnd.eszigno3+xml' => 'es3', 'application/vnd.ezpix-album' => 'ez2', 'application/vnd.ezpix-package' => 'ez3', 'application/vnd.fdf' => 'fdf', 'application/vnd.fdsn.mseed' => 'mseed', 'application/vnd.fdsn.seed' => 'seed', 'application/vnd.flographit' => 'gph', 'application/vnd.fluxtime.clip' => 'ftc', 'application/vnd.framemaker' => 'fm', 'application/vnd.frogans.fnc' => 'fnc', 'application/vnd.frogans.ltf' => 'ltf', 'application/vnd.fsc.weblaunch' => 'fsc', 'application/vnd.fujitsu.oasys' => 'oas', 'application/vnd.fujitsu.oasys2' => 'oa2', 'application/vnd.fujitsu.oasys3' => 'oa3', 'application/vnd.fujitsu.oasysgp' => 'fg5', 'application/vnd.fujitsu.oasysprs' => 'bh2', 'application/vnd.fujixerox.ddd' => 'ddd', 'application/vnd.fujixerox.docuworks' => 'xdw', 'application/vnd.fujixerox.docuworks.binder' => 'xbd', 'application/vnd.fuzzysheet' => 'fzs', 'application/vnd.genomatix.tuxedo' => 'txd', 'application/vnd.geogebra.file' => 'ggb', 'application/vnd.geogebra.tool' => 'ggt', 'application/vnd.geometry-explorer' => 'gex', 'application/vnd.geonext' => 'gxt', 'application/vnd.geoplan' => 'g2w', 'application/vnd.geospace' => 'g3w', 'application/vnd.gmx' => 'gmx', 'application/vnd.google-earth.kml+xml' => 'kml', 'application/vnd.google-earth.kmz' => 'kmz', 'application/vnd.grafeq' => 'gqf', 'application/vnd.groove-account' => 'gac', 'application/vnd.groove-help' => 'ghf', 'application/vnd.groove-identity-message' => 'gim', 'application/vnd.groove-injector' => 'grv', 'application/vnd.groove-tool-message' => 'gtm', 'application/vnd.groove-tool-template' => 'tpl', 'application/vnd.groove-vcard' => 'vcg', 'application/vnd.hal+xml' => 'hal', 'application/vnd.handheld-entertainment+xml' => 'zmm', 'application/vnd.hbci' => 'hbci', 'application/vnd.hhe.lesson-player' => 'les', 'application/vnd.hp-hpgl' => 'hpgl', 'application/vnd.hp-hpid' => 'hpid', 'application/vnd.hp-hps' => 'hps', 'application/vnd.hp-jlyt' => 'jlt', 'application/vnd.hp-pcl' => 'pcl', 'application/vnd.hp-pclxl' => 'pclxl', 'application/vnd.hydrostatix.sof-data' => 'sfd-hdstx', 'application/vnd.ibm.minipay' => 'mpy', 'application/vnd.ibm.modcap' => 'afp', 'application/vnd.ibm.rights-management' => 'irm', 'application/vnd.ibm.secure-container' => 'sc', 'application/vnd.iccprofile' => 'icc', 'application/vnd.igloader' => 'igl', 'application/vnd.immervision-ivp' => 'ivp', 'application/vnd.immervision-ivu' => 'ivu', 'application/vnd.insors.igm' => 'igm', 'application/vnd.intercon.formnet' => 'xpw', 'application/vnd.intergeo' => 'i2g', 'application/vnd.intu.qbo' => 'qbo', 'application/vnd.intu.qfx' => 'qfx', 'application/vnd.ipunplugged.rcprofile' => 'rcprofile', 'application/vnd.irepository.package+xml' => 'irp', 'application/vnd.is-xpr' => 'xpr', 'application/vnd.isac.fcs' => 'fcs', 'application/vnd.jam' => 'jam', 'application/vnd.jcp.javame.midlet-rms' => 'rms', 'application/vnd.jisp' => 'jisp', 'application/vnd.joost.joda-archive' => 'joda', 'application/vnd.kahootz' => 'ktz', 'application/vnd.kde.karbon' => 'karbon', 'application/vnd.kde.kchart' => 'chrt', 'application/vnd.kde.kformula' => 'kfo', 'application/vnd.kde.kivio' => 'flw', 'application/vnd.kde.kontour' => 'kon', 'application/vnd.kde.kpresenter' => 'kpr', 'application/vnd.kde.kspread' => 'ksp', 'application/vnd.kde.kword' => 'kwd', 'application/vnd.kenameaapp' => 'htke', 'application/vnd.kidspiration' => 'kia', 'application/vnd.kinar' => 'kne', 'application/vnd.koan' => 'skp', 'application/vnd.kodak-descriptor' => 'sse', 'application/vnd.las.las+xml' => 'lasxml', 'application/vnd.llamagraphics.life-balance.desktop' => 'lbd', 'application/vnd.llamagraphics.life-balance.exchange+xml' => 'lbe', 'application/vnd.lotus-1-2-3' => '123', 'application/vnd.lotus-approach' => 'apr', 'application/vnd.lotus-freelance' => 'pre', 'application/vnd.lotus-notes' => 'nsf', 'application/vnd.lotus-organizer' => 'org', 'application/vnd.lotus-screencam' => 'scm', 'application/vnd.lotus-wordpro' => 'lwp', 'application/vnd.macports.portpkg' => 'portpkg', 'application/vnd.mcd' => 'mcd', 'application/vnd.medcalcdata' => 'mc1', 'application/vnd.mediastation.cdkey' => 'cdkey', 'application/vnd.mfer' => 'mwf', 'application/vnd.mfmp' => 'mfm', 'application/vnd.micrografx.flo' => 'flo', 'application/vnd.micrografx.igx' => 'igx', 'application/vnd.mif' => 'mif', 'application/vnd.mobius.daf' => 'daf', 'application/vnd.mobius.dis' => 'dis', 'application/vnd.mobius.mbk' => 'mbk', 'application/vnd.mobius.mqy' => 'mqy', 'application/vnd.mobius.msl' => 'msl', 'application/vnd.mobius.plc' => 'plc', 'application/vnd.mobius.txf' => 'txf', 'application/vnd.mophun.application' => 'mpn', 'application/vnd.mophun.certificate' => 'mpc', 'application/vnd.mozilla.xul+xml' => 'xul', 'application/vnd.ms-artgalry' => 'cil', 'application/vnd.ms-cab-compressed' => 'cab', 'application/vnd.ms-excel' => 'xls', 'application/vnd.ms-excel.addin.macroenabled.12' => 'xlam', 'application/vnd.ms-excel.sheet.binary.macroenabled.12' => 'xlsb', 'application/vnd.ms-excel.sheet.macroenabled.12' => 'xlsm', 'application/vnd.ms-excel.template.macroenabled.12' => 'xltm', 'application/vnd.ms-fontobject' => 'eot', 'application/vnd.ms-htmlhelp' => 'chm', 'application/vnd.ms-ims' => 'ims', 'application/vnd.ms-lrm' => 'lrm', 'application/vnd.ms-officetheme' => 'thmx', 'application/vnd.ms-pki.seccat' => 'cat', 'application/vnd.ms-pki.stl' => 'stl', 'application/vnd.ms-powerpoint' => 'ppt', 'application/vnd.ms-powerpoint.addin.macroenabled.12' => 'ppam', 'application/vnd.ms-powerpoint.presentation.macroenabled.12' => 'pptm', 'application/vnd.ms-powerpoint.slide.macroenabled.12' => 'sldm', 'application/vnd.ms-powerpoint.slideshow.macroenabled.12' => 'ppsm', 'application/vnd.ms-powerpoint.template.macroenabled.12' => 'potm', 'application/vnd.ms-project' => 'mpp', 'application/vnd.ms-word.document.macroenabled.12' => 'docm', 'application/vnd.ms-word.template.macroenabled.12' => 'dotm', 'application/vnd.ms-works' => 'wps', 'application/vnd.ms-wpl' => 'wpl', 'application/vnd.ms-xpsdocument' => 'xps', 'application/vnd.mseq' => 'mseq', 'application/vnd.musician' => 'mus', 'application/vnd.muvee.style' => 'msty', 'application/vnd.mynfc' => 'taglet', 'application/vnd.neurolanguage.nlu' => 'nlu', 'application/vnd.nitf' => 'ntf', 'application/vnd.noblenet-directory' => 'nnd', 'application/vnd.noblenet-sealer' => 'nns', 'application/vnd.noblenet-web' => 'nnw', 'application/vnd.nokia.n-gage.data' => 'ngdat', 'application/vnd.nokia.n-gage.symbian.install' => 'n-gage', 'application/vnd.nokia.radio-preset' => 'rpst', 'application/vnd.nokia.radio-presets' => 'rpss', 'application/vnd.novadigm.edm' => 'edm', 'application/vnd.novadigm.edx' => 'edx', 'application/vnd.novadigm.ext' => 'ext', 'application/vnd.oasis.opendocument.chart' => 'odc', 'application/vnd.oasis.opendocument.chart-template' => 'otc', 'application/vnd.oasis.opendocument.database' => 'odb', 'application/vnd.oasis.opendocument.formula' => 'odf', 'application/vnd.oasis.opendocument.formula-template' => 'odft', 'application/vnd.oasis.opendocument.graphics' => 'odg', 'application/vnd.oasis.opendocument.graphics-template' => 'otg', 'application/vnd.oasis.opendocument.image' => 'odi', 'application/vnd.oasis.opendocument.image-template' => 'oti', 'application/vnd.oasis.opendocument.presentation' => 'odp', 'application/vnd.oasis.opendocument.presentation-template' => 'otp', 'application/vnd.oasis.opendocument.spreadsheet' => 'ods', 'application/vnd.oasis.opendocument.spreadsheet-template' => 'ots', 'application/vnd.oasis.opendocument.text' => 'odt', 'application/vnd.oasis.opendocument.text-master' => 'odm', 'application/vnd.oasis.opendocument.text-template' => 'ott', 'application/vnd.oasis.opendocument.text-web' => 'oth', 'application/vnd.olpc-sugar' => 'xo', 'application/vnd.oma.dd2+xml' => 'dd2', 'application/vnd.openofficeorg.extension' => 'oxt', 'application/vnd.openxmlformats-officedocument.presentationml.presentation' => 'pptx', 'application/vnd.openxmlformats-officedocument.presentationml.slide' => 'sldx', 'application/vnd.openxmlformats-officedocument.presentationml.slideshow' => 'ppsx', 'application/vnd.openxmlformats-officedocument.presentationml.template' => 'potx', 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet' => 'xlsx', 'application/vnd.openxmlformats-officedocument.spreadsheetml.template' => 'xltx', 'application/vnd.openxmlformats-officedocument.wordprocessingml.document' => 'docx', 'application/vnd.openxmlformats-officedocument.wordprocessingml.template' => 'dotx', 'application/vnd.osgeo.mapguide.package' => 'mgp', 'application/vnd.osgi.dp' => 'dp', 'application/vnd.osgi.subsystem' => 'esa', 'application/vnd.palm' => 'pdb', 'application/vnd.pawaafile' => 'paw', 'application/vnd.pg.format' => 'str', 'application/vnd.pg.osasli' => 'ei6', 'application/vnd.picsel' => 'efif', 'application/vnd.pmi.widget' => 'wg', 'application/vnd.pocketlearn' => 'plf', 'application/vnd.powerbuilder6' => 'pbd', 'application/vnd.previewsystems.box' => 'box', 'application/vnd.proteus.magazine' => 'mgz', 'application/vnd.publishare-delta-tree' => 'qps', 'application/vnd.pvi.ptid1' => 'ptid', 'application/vnd.quark.quarkxpress' => 'qxd', 'application/vnd.realvnc.bed' => 'bed', 'application/vnd.recordare.musicxml' => 'mxl', 'application/vnd.recordare.musicxml+xml' => 'musicxml', 'application/vnd.rig.cryptonote' => 'cryptonote', 'application/vnd.rim.cod' => 'cod', 'application/vnd.rn-realmedia' => 'rm', 'application/vnd.rn-realmedia-vbr' => 'rmvb', 'application/vnd.route66.link66+xml' => 'link66', 'application/vnd.sailingtracker.track' => 'st', 'application/vnd.seemail' => 'see', 'application/vnd.sema' => 'sema', 'application/vnd.semd' => 'semd', 'application/vnd.semf' => 'semf', 'application/vnd.shana.informed.formdata' => 'ifm', 'application/vnd.shana.informed.formtemplate' => 'itp', 'application/vnd.shana.informed.interchange' => 'iif', 'application/vnd.shana.informed.package' => 'ipk', 'application/vnd.simtech-mindmapper' => 'twd', 'application/vnd.smaf' => 'mmf', 'application/vnd.smart.teacher' => 'teacher', 'application/vnd.solent.sdkm+xml' => 'sdkm', 'application/vnd.spotfire.dxp' => 'dxp', 'application/vnd.spotfire.sfs' => 'sfs', 'application/vnd.stardivision.calc' => 'sdc', 'application/vnd.stardivision.draw' => 'sda', 'application/vnd.stardivision.impress' => 'sdd', 'application/vnd.stardivision.math' => 'smf', 'application/vnd.stardivision.writer' => 'sdw', 'application/vnd.stardivision.writer-global' => 'sgl', 'application/vnd.stepmania.package' => 'smzip', 'application/vnd.stepmania.stepchart' => 'sm', 'application/vnd.sun.xml.calc' => 'sxc', 'application/vnd.sun.xml.calc.template' => 'stc', 'application/vnd.sun.xml.draw' => 'sxd', 'application/vnd.sun.xml.draw.template' => 'std', 'application/vnd.sun.xml.impress' => 'sxi', 'application/vnd.sun.xml.impress.template' => 'sti', 'application/vnd.sun.xml.math' => 'sxm', 'application/vnd.sun.xml.writer' => 'sxw', 'application/vnd.sun.xml.writer.global' => 'sxg', 'application/vnd.sun.xml.writer.template' => 'stw', 'application/vnd.sus-calendar' => 'sus', 'application/vnd.svd' => 'svd', 'application/vnd.symbian.install' => 'sis', 'application/vnd.syncml+xml' => 'xsm', 'application/vnd.syncml.dm+wbxml' => 'bdm', 'application/vnd.syncml.dm+xml' => 'xdm', 'application/vnd.tao.intent-module-archive' => 'tao', 'application/vnd.tcpdump.pcap' => 'pcap', 'application/vnd.tmobile-livetv' => 'tmo', 'application/vnd.trid.tpt' => 'tpt', 'application/vnd.triscape.mxs' => 'mxs', 'application/vnd.trueapp' => 'tra', 'application/vnd.ufdl' => 'ufd', 'application/vnd.uiq.theme' => 'utz', 'application/vnd.umajin' => 'umj', 'application/vnd.unity' => 'unityweb', 'application/vnd.uoml+xml' => 'uoml', 'application/vnd.vcx' => 'vcx', 'application/vnd.visio' => 'vsd', 'application/vnd.visionary' => 'vis', 'application/vnd.vsf' => 'vsf', 'application/vnd.wap.wbxml' => 'wbxml', 'application/vnd.wap.wmlc' => 'wmlc', 'application/vnd.wap.wmlscriptc' => 'wmlsc', 'application/vnd.webturbo' => 'wtb', 'application/vnd.wolfram.player' => 'nbp', 'application/vnd.wordperfect' => 'wpd', 'application/vnd.wqd' => 'wqd', 'application/vnd.wt.stf' => 'stf', 'application/vnd.xara' => 'xar', 'application/vnd.xfdl' => 'xfdl', 'application/vnd.yamaha.hv-dic' => 'hvd', 'application/vnd.yamaha.hv-script' => 'hvs', 'application/vnd.yamaha.hv-voice' => 'hvp', 'application/vnd.yamaha.openscoreformat' => 'osf', 'application/vnd.yamaha.openscoreformat.osfpvg+xml' => 'osfpvg', 'application/vnd.yamaha.smaf-audio' => 'saf', 'application/vnd.yamaha.smaf-phrase' => 'spf', 'application/vnd.yellowriver-custom-menu' => 'cmp', 'application/vnd.zul' => 'zir', 'application/vnd.zzazz.deck+xml' => 'zaz', 'application/voicexml+xml' => 'vxml', 'application/widget' => 'wgt', 'application/winhlp' => 'hlp', 'application/wsdl+xml' => 'wsdl', 'application/wspolicy+xml' => 'wspolicy', 'application/x-7z-compressed' => '7z', 'application/x-abiword' => 'abw', 'application/x-ace-compressed' => 'ace', 'application/x-apple-diskimage' => 'dmg', 'application/x-authorware-bin' => 'aab', 'application/x-authorware-map' => 'aam', 'application/x-authorware-seg' => 'aas', 'application/x-bcpio' => 'bcpio', 'application/x-bittorrent' => 'torrent', 'application/x-blorb' => 'blb', 'application/x-bzip' => 'bz', 'application/x-bzip2' => 'bz2', 'application/x-cbr' => 'cbr', 'application/x-cdlink' => 'vcd', 'application/x-cfs-compressed' => 'cfs', 'application/x-chat' => 'chat', 'application/x-chess-pgn' => 'pgn', 'application/x-conference' => 'nsc', 'application/x-cpio' => 'cpio', 'application/x-csh' => 'csh', 'application/x-debian-package' => 'deb', 'application/x-dgc-compressed' => 'dgc', 'application/x-director' => 'dir', 'application/x-doom' => 'wad', 'application/x-dtbncx+xml' => 'ncx', 'application/x-dtbook+xml' => 'dtb', 'application/x-dtbresource+xml' => 'res', 'application/x-dvi' => 'dvi', 'application/x-envoy' => 'evy', 'application/x-eva' => 'eva', 'application/x-font-bdf' => 'bdf', 'application/x-font-ghostscript' => 'gsf', 'application/x-font-linux-psf' => 'psf', 'application/x-font-otf' => 'otf', 'application/x-font-pcf' => 'pcf', 'application/x-font-snf' => 'snf', 'application/x-font-ttf' => 'ttf', 'application/x-font-type1' => 'pfa', 'application/x-font-woff' => 'woff', 'application/x-freearc' => 'arc', 'application/x-futuresplash' => 'spl', 'application/x-gca-compressed' => 'gca', 'application/x-glulx' => 'ulx', 'application/x-gnumeric' => 'gnumeric', 'application/x-gramps-xml' => 'gramps', 'application/x-gtar' => 'gtar', 'application/x-hdf' => 'hdf', 'application/x-install-instructions' => 'install', 'application/x-iso9660-image' => 'iso', 'application/x-java-jnlp-file' => 'jnlp', 'application/x-latex' => 'latex', 'application/x-lzh-compressed' => 'lzh', 'application/x-mie' => 'mie', 'application/x-mobipocket-ebook' => 'prc', 'application/x-ms-application' => 'application', 'application/x-ms-shortcut' => 'lnk', 'application/x-ms-wmd' => 'wmd', 'application/x-ms-wmz' => 'wmz', 'application/x-ms-xbap' => 'xbap', 'application/x-msaccess' => 'mdb', 'application/x-msbinder' => 'obd', 'application/x-mscardfile' => 'crd', 'application/x-msclip' => 'clp', 'application/x-msdownload' => 'exe', 'application/x-msmediaview' => 'mvb', 'application/x-msmetafile' => 'wmf', 'application/x-msmoney' => 'mny', 'application/x-mspublisher' => 'pub', 'application/x-msschedule' => 'scd', 'application/x-msterminal' => 'trm', 'application/x-mswrite' => 'wri', 'application/x-netcdf' => 'nc', 'application/x-nzb' => 'nzb', 'application/x-pkcs12' => 'p12', 'application/x-pkcs7-certificates' => 'p7b', 'application/x-pkcs7-certreqresp' => 'p7r', 'application/x-rar-compressed' => 'rar', 'application/x-rar' => 'rar', 'application/x-research-info-systems' => 'ris', 'application/x-sh' => 'sh', 'application/x-shar' => 'shar', 'application/x-shockwave-flash' => 'swf', 'application/x-silverlight-app' => 'xap', 'application/x-sql' => 'sql', 'application/x-stuffit' => 'sit', 'application/x-stuffitx' => 'sitx', 'application/x-subrip' => 'srt', 'application/x-sv4cpio' => 'sv4cpio', 'application/x-sv4crc' => 'sv4crc', 'application/x-t3vm-image' => 't3', 'application/x-tads' => 'gam', 'application/x-tar' => 'tar', 'application/x-tcl' => 'tcl', 'application/x-tex' => 'tex', 'application/x-tex-tfm' => 'tfm', 'application/x-texinfo' => 'texinfo', 'application/x-tgif' => 'obj', 'application/x-ustar' => 'ustar', 'application/x-wais-source' => 'src', 'application/x-x509-ca-cert' => 'der', 'application/x-xfig' => 'fig', 'application/x-xliff+xml' => 'xlf', 'application/x-xpinstall' => 'xpi', 'application/x-xz' => 'xz', 'application/x-zmachine' => 'z1', 'application/xaml+xml' => 'xaml', 'application/xcap-diff+xml' => 'xdf', 'application/xenc+xml' => 'xenc', 'application/xhtml+xml' => 'xhtml', 'application/xml' => 'xml', 'application/xml-dtd' => 'dtd', 'application/xop+xml' => 'xop', 'application/xproc+xml' => 'xpl', 'application/xslt+xml' => 'xslt', 'application/xspf+xml' => 'xspf', 'application/xv+xml' => 'mxml', 'application/yang' => 'yang', 'application/yin+xml' => 'yin', 'application/zip' => 'zip', 'audio/adpcm' => 'adp', 'audio/basic' => 'au', 'audio/midi' => 'mid', 'audio/mp4' => 'mp4a', 'audio/mpeg' => 'mpga', 'audio/ogg' => 'oga', 'audio/s3m' => 's3m', 'audio/silk' => 'sil', 'audio/vnd.dece.audio' => 'uva', 'audio/vnd.digital-winds' => 'eol', 'audio/vnd.dra' => 'dra', 'audio/vnd.dts' => 'dts', 'audio/vnd.dts.hd' => 'dtshd', 'audio/vnd.lucent.voice' => 'lvp', 'audio/vnd.ms-playready.media.pya' => 'pya', 'audio/vnd.nuera.ecelp4800' => 'ecelp4800', 'audio/vnd.nuera.ecelp7470' => 'ecelp7470', 'audio/vnd.nuera.ecelp9600' => 'ecelp9600', 'audio/vnd.rip' => 'rip', 'audio/webm' => 'weba', 'audio/x-aac' => 'aac', 'audio/x-aiff' => 'aif', 'audio/x-caf' => 'caf', 'audio/x-flac' => 'flac', 'audio/x-matroska' => 'mka', 'audio/x-mpegurl' => 'm3u', 'audio/x-ms-wax' => 'wax', 'audio/x-ms-wma' => 'wma', 'audio/x-pn-realaudio' => 'ram', 'audio/x-pn-realaudio-plugin' => 'rmp', 'audio/x-wav' => 'wav', 'audio/xm' => 'xm', 'chemical/x-cdx' => 'cdx', 'chemical/x-cif' => 'cif', 'chemical/x-cmdf' => 'cmdf', 'chemical/x-cml' => 'cml', 'chemical/x-csml' => 'csml', 'chemical/x-xyz' => 'xyz', 'image/bmp' => 'bmp', 'image/x-ms-bmp' => 'bmp', 'image/cgm' => 'cgm', 'image/g3fax' => 'g3', 'image/gif' => 'gif', 'image/ief' => 'ief', 'image/jpeg' => 'jpeg', 'image/ktx' => 'ktx', 'image/png' => 'png', 'image/prs.btif' => 'btif', 'image/sgi' => 'sgi', 'image/svg+xml' => 'svg', 'image/tiff' => 'tiff', 'image/vnd.adobe.photoshop' => 'psd', 'image/vnd.dece.graphic' => 'uvi', 'image/vnd.dvb.subtitle' => 'sub', 'image/vnd.djvu' => 'djvu', 'image/vnd.dwg' => 'dwg', 'image/vnd.dxf' => 'dxf', 'image/vnd.fastbidsheet' => 'fbs', 'image/vnd.fpx' => 'fpx', 'image/vnd.fst' => 'fst', 'image/vnd.fujixerox.edmics-mmr' => 'mmr', 'image/vnd.fujixerox.edmics-rlc' => 'rlc', 'image/vnd.ms-modi' => 'mdi', 'image/vnd.ms-photo' => 'wdp', 'image/vnd.net-fpx' => 'npx', 'image/vnd.wap.wbmp' => 'wbmp', 'image/vnd.xiff' => 'xif', 'image/webp' => 'webp', 'image/x-3ds' => '3ds', 'image/x-cmu-raster' => 'ras', 'image/x-cmx' => 'cmx', 'image/x-freehand' => 'fh', 'image/x-icon' => 'ico', 'image/x-mrsid-image' => 'sid', 'image/x-pcx' => 'pcx', 'image/x-pict' => 'pic', 'image/x-portable-anymap' => 'pnm', 'image/x-portable-bitmap' => 'pbm', 'image/x-portable-graymap' => 'pgm', 'image/x-portable-pixmap' => 'ppm', 'image/x-rgb' => 'rgb', 'image/x-tga' => 'tga', 'image/x-xbitmap' => 'xbm', 'image/x-xpixmap' => 'xpm', 'image/x-xwindowdump' => 'xwd', 'message/rfc822' => 'eml', 'model/iges' => 'igs', 'model/mesh' => 'msh', 'model/vnd.collada+xml' => 'dae', 'model/vnd.dwf' => 'dwf', 'model/vnd.gdl' => 'gdl', 'model/vnd.gtw' => 'gtw', 'model/vnd.mts' => 'mts', 'model/vnd.vtu' => 'vtu', 'model/vrml' => 'wrl', 'model/x3d+binary' => 'x3db', 'model/x3d+vrml' => 'x3dv', 'model/x3d+xml' => 'x3d', 'text/cache-manifest' => 'appcache', 'text/calendar' => 'ics', 'text/css' => 'css', 'text/csv' => 'csv', 'text/html' => 'html', 'text/n3' => 'n3', 'text/plain' => 'txt', 'text/prs.lines.tag' => 'dsc', 'text/richtext' => 'rtx', 'text/rtf' => 'rtf', 'text/sgml' => 'sgml', 'text/tab-separated-values' => 'tsv', 'text/troff' => 't', 'text/turtle' => 'ttl', 'text/uri-list' => 'uri', 'text/vcard' => 'vcard', 'text/vnd.curl' => 'curl', 'text/vnd.curl.dcurl' => 'dcurl', 'text/vnd.curl.scurl' => 'scurl', 'text/vnd.curl.mcurl' => 'mcurl', 'text/vnd.dvb.subtitle' => 'sub', 'text/vnd.fly' => 'fly', 'text/vnd.fmi.flexstor' => 'flx', 'text/vnd.graphviz' => 'gv', 'text/vnd.in3d.3dml' => '3dml', 'text/vnd.in3d.spot' => 'spot', 'text/vnd.sun.j2me.app-descriptor' => 'jad', 'text/vnd.wap.wml' => 'wml', 'text/vnd.wap.wmlscript' => 'wmls', 'text/x-asm' => 's', 'text/x-c' => 'c', 'text/x-fortran' => 'f', 'text/x-pascal' => 'p', 'text/x-java-source' => 'java', 'text/x-opml' => 'opml', 'text/x-nfo' => 'nfo', 'text/x-setext' => 'etx', 'text/x-sfv' => 'sfv', 'text/x-uuencode' => 'uu', 'text/x-vcalendar' => 'vcs', 'text/x-vcard' => 'vcf', 'video/3gpp' => '3gp', 'video/3gpp2' => '3g2', 'video/h261' => 'h261', 'video/h263' => 'h263', 'video/h264' => 'h264', 'video/jpeg' => 'jpgv', 'video/jpm' => 'jpm', 'video/mj2' => 'mj2', 'video/mp4' => 'mp4', 'video/mpeg' => 'mpeg', 'video/ogg' => 'ogv', 'video/quicktime' => 'qt', 'video/vnd.dece.hd' => 'uvh', 'video/vnd.dece.mobile' => 'uvm', 'video/vnd.dece.pd' => 'uvp', 'video/vnd.dece.sd' => 'uvs', 'video/vnd.dece.video' => 'uvv', 'video/vnd.dvb.file' => 'dvb', 'video/vnd.fvt' => 'fvt', 'video/vnd.mpegurl' => 'mxu', 'video/vnd.ms-playready.media.pyv' => 'pyv', 'video/vnd.uvvu.mp4' => 'uvu', 'video/vnd.vivo' => 'viv', 'video/webm' => 'webm', 'video/x-f4v' => 'f4v', 'video/x-fli' => 'fli', 'video/x-flv' => 'flv', 'video/x-m4v' => 'm4v', 'video/x-matroska' => 'mkv', 'video/x-mng' => 'mng', 'video/x-ms-asf' => 'asf', 'video/x-ms-vob' => 'vob', 'video/x-ms-wm' => 'wm', 'video/x-ms-wmv' => 'wmv', 'video/x-ms-wmx' => 'wmx', 'video/x-ms-wvx' => 'wvx', 'video/x-msvideo' => 'avi', 'video/x-sgi-movie' => 'movie', 'video/x-smv' => 'smv', 'x-conference/x-cooltalk' => 'ice');
/**
* {@inheritdoc}
*/
public function guess($mimeType)
{
}
}
/**
* A singleton mime type to file extension guesser.
*
* A default guesser is provided.
* You can register custom guessers by calling the register()
* method on the singleton instance:
*
* $guesser = ExtensionGuesser::getInstance();
* $guesser->register(new MyCustomExtensionGuesser());
*
* The last registered guesser is preferred over previously registered ones.
*/
class ExtensionGuesser implements \Symfony\Component\HttpFoundation\File\MimeType\ExtensionGuesserInterface
{
/**
* All registered ExtensionGuesserInterface instances.
*
* @var array
*/
protected $guessers = array();
/**
* Returns the singleton instance.
*
* @return ExtensionGuesser
*/
public static function getInstance()
{
}
/**
* Registers a new extension guesser.
*
* When guessing, this guesser is preferred over previously registered ones.
*
* @param ExtensionGuesserInterface $guesser
*/
public function register(\Symfony\Component\HttpFoundation\File\MimeType\ExtensionGuesserInterface $guesser)
{
}
/**
* Tries to guess the extension.
*
* The mime type is passed to each registered mime type guesser in reverse order
* of their registration (last registered is queried first). Once a guesser
* returns a value that is not NULL, this method terminates and returns the
* value.
*
* @param string $mimeType The mime type
*
* @return string The guessed extension or NULL, if none could be guessed
*/
public function guess($mimeType)
{
}
}
/**
* A singleton mime type guesser.
*
* By default, all mime type guessers provided by the framework are installed
* (if available on the current OS/PHP setup).
*
* You can register custom guessers by calling the register() method on the
* singleton instance. Custom guessers are always called before any default ones.
*
* $guesser = MimeTypeGuesser::getInstance();
* $guesser->register(new MyCustomMimeTypeGuesser());
*
* If you want to change the order of the default guessers, just re-register your
* preferred one as a custom one. The last registered guesser is preferred over
* previously registered ones.
*
* Re-registering a built-in guesser also allows you to configure it:
*
* $guesser = MimeTypeGuesser::getInstance();
* $guesser->register(new FileinfoMimeTypeGuesser('/path/to/magic/file'));
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class MimeTypeGuesser implements \Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface
{
/**
* All registered MimeTypeGuesserInterface instances.
*
* @var array
*/
protected $guessers = array();
/**
* Returns the singleton instance.
*
* @return MimeTypeGuesser
*/
public static function getInstance()
{
}
/**
* Resets the singleton instance.
*/
public static function reset()
{
}
/**
* Registers a new mime type guesser.
*
* When guessing, this guesser is preferred over previously registered ones.
*
* @param MimeTypeGuesserInterface $guesser
*/
public function register(\Symfony\Component\HttpFoundation\File\MimeType\MimeTypeGuesserInterface $guesser)
{
}
/**
* Tries to guess the mime type of the given file.
*
* The file is passed to each registered mime type guesser in reverse order
* of their registration (last registered is queried first). Once a guesser
* returns a value that is not NULL, this method terminates and returns the
* value.
*
* @param string $path The path to the file
*
* @return string The mime type or NULL, if none could be guessed
*
* @throws \LogicException
* @throws FileNotFoundException
* @throws AccessDeniedException
*/
public function guess($path)
{
}
}
}
namespace Symfony\Component\HttpFoundation\File\Exception {
/**
* Thrown when an error occurred in the component File.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class FileException extends \RuntimeException
{
}
/**
* Thrown when an error occurred during file upload.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class UploadException extends \Symfony\Component\HttpFoundation\File\Exception\FileException
{
}
/**
* Thrown when a file was not found.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class FileNotFoundException extends \Symfony\Component\HttpFoundation\File\Exception\FileException
{
/**
* Constructor.
*
* @param string $path The path to the file that was not found
*/
public function __construct($path)
{
}
}
class UnexpectedTypeException extends \Symfony\Component\HttpFoundation\File\Exception\FileException
{
public function __construct($value, $expectedType)
{
}
}
/**
* Thrown when the access on a file was denied.
*
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class AccessDeniedException extends \Symfony\Component\HttpFoundation\File\Exception\FileException
{
/**
* Constructor.
*
* @param string $path The path to the accessed file
*/
public function __construct($path)
{
}
}
}
namespace Symfony\Component\Filesystem\Tests {
class LockHandlerTest extends \PHPUnit\Framework\TestCase
{
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
* @expectedExceptionMessage Failed to create "/a/b/c/d/e": mkdir(): Permission denied.
*/
public function testConstructWhenRepositoryDoesNotExist()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
* @expectedExceptionMessage The directory "/" is not writable.
*/
public function testConstructWhenRepositoryIsNotWriteable()
{
}
public function testErrorHandlingInLockIfLockPathBecomesUnwritable()
{
}
public function testConstructSanitizeName()
{
}
public function testLockRelease()
{
}
public function testLockTwice()
{
}
public function testLockIsReleased()
{
}
}
class FilesystemTestCase extends \PHPUnit\Framework\TestCase
{
protected $longPathNamesWindows = array();
/**
* @var \Symfony\Component\Filesystem\Filesystem
*/
protected $filesystem = null;
/**
* @var string
*/
protected $workspace = null;
public static function setUpBeforeClass()
{
}
protected function setUp()
{
}
protected function tearDown()
{
}
/**
* @param int $expectedFilePerms expected file permissions as three digits (i.e. 755)
* @param string $filePath
*/
protected function assertFilePermissions($expectedFilePerms, $filePath)
{
}
protected function getFileOwner($filepath)
{
}
protected function getFileGroup($filepath)
{
}
protected function markAsSkippedIfLinkIsMissing()
{
}
protected function markAsSkippedIfSymlinkIsMissing($relative = false)
{
}
protected function markAsSkippedIfChmodIsMissing()
{
}
protected function markAsSkippedIfPosixIsMissing()
{
}
}
/**
* Test class for Filesystem.
*/
class ExceptionTest extends \PHPUnit\Framework\TestCase
{
public function testGetPath()
{
}
public function testGeneratedMessage()
{
}
public function testGeneratedMessageWithoutPath()
{
}
public function testCustomMessage()
{
}
}
/**
* Test class for Filesystem.
*/
class FilesystemTest extends \Symfony\Component\Filesystem\Tests\FilesystemTestCase
{
public function testCopyCreatesNewFile()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testCopyFails()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testCopyUnreadableFileFails()
{
}
public function testCopyOverridesExistingFileIfModified()
{
}
public function testCopyDoesNotOverrideExistingFileByDefault()
{
}
public function testCopyOverridesExistingFileIfForced()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testCopyWithOverrideWithReadOnlyTargetFails()
{
}
public function testCopyCreatesTargetDirectoryIfItDoesNotExist()
{
}
/**
* @group network
*/
public function testCopyForOriginUrlsAndExistingLocalFileDefaultsToCopy()
{
}
public function testMkdirCreatesDirectoriesRecursively()
{
}
public function testMkdirCreatesDirectoriesFromArray()
{
}
public function testMkdirCreatesDirectoriesFromTraversableObject()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testMkdirCreatesDirectoriesFails()
{
}
public function testTouchCreatesEmptyFile()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testTouchFails()
{
}
public function testTouchCreatesEmptyFilesFromArray()
{
}
public function testTouchCreatesEmptyFilesFromTraversableObject()
{
}
public function testRemoveCleansFilesAndDirectoriesIteratively()
{
}
public function testRemoveCleansArrayOfFilesAndDirectories()
{
}
public function testRemoveCleansTraversableObjectOfFilesAndDirectories()
{
}
public function testRemoveIgnoresNonExistingFiles()
{
}
public function testRemoveCleansInvalidLinks()
{
}
public function testFilesExists()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testFilesExistsFails()
{
}
public function testFilesExistsTraversableObjectOfFilesAndDirectories()
{
}
public function testFilesNotExistsTraversableObjectOfFilesAndDirectories()
{
}
public function testInvalidFileNotExists()
{
}
public function testChmodChangesFileMode()
{
}
public function testChmodWithWrongModLeavesPreviousPermissionsUntouched()
{
}
public function testChmodRecursive()
{
}
public function testChmodAppliesUmask()
{
}
public function testChmodChangesModeOfArrayOfFiles()
{
}
public function testChmodChangesModeOfTraversableFileObject()
{
}
public function testChmodChangesZeroModeOnSubdirectoriesOnRecursive()
{
}
public function testChown()
{
}
public function testChownRecursive()
{
}
public function testChownSymlink()
{
}
public function testChownLink()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testChownSymlinkFails()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testChownLinkFails()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testChownFail()
{
}
public function testChgrp()
{
}
public function testChgrpRecursive()
{
}
public function testChgrpSymlink()
{
}
public function testChgrpLink()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testChgrpSymlinkFails()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testChgrpLinkFails()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testChgrpFail()
{
}
public function testRename()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testRenameThrowsExceptionIfTargetAlreadyExists()
{
}
public function testRenameOverwritesTheTargetIfItAlreadyExists()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testRenameThrowsExceptionOnError()
{
}
public function testSymlink()
{
}
/**
* @depends testSymlink
*/
public function testRemoveSymlink()
{
}
public function testSymlinkIsOverwrittenIfPointsToDifferentTarget()
{
}
public function testSymlinkIsNotOverwrittenIfAlreadyCreated()
{
}
public function testSymlinkCreatesTargetDirectoryIfItDoesNotExist()
{
}
public function testLink()
{
}
/**
* @depends testLink
*/
public function testRemoveLink()
{
}
public function testLinkIsOverwrittenIfPointsToDifferentTarget()
{
}
public function testLinkIsNotOverwrittenIfAlreadyCreated()
{
}
public function testLinkWithSeveralTargets()
{
}
public function testLinkWithSameTarget()
{
}
public function testReadRelativeLink()
{
}
public function testReadAbsoluteLink()
{
}
public function testReadBrokenLink()
{
}
public function testReadLinkDefaultPathDoesNotExist()
{
}
public function testReadLinkDefaultPathNotLink()
{
}
public function testReadLinkCanonicalizePath()
{
}
public function testReadLinkCanonicalizedPathDoesNotExist()
{
}
/**
* @dataProvider providePathsForMakePathRelative
*/
public function testMakePathRelative($endPath, $startPath, $expectedPath)
{
}
/**
* @return array
*/
public function providePathsForMakePathRelative()
{
}
public function testMirrorCopiesFilesAndDirectoriesRecursively()
{
}
public function testMirrorCreatesEmptyDirectory()
{
}
public function testMirrorCopiesLinks()
{
}
public function testMirrorCopiesLinkedDirectoryContents()
{
}
public function testMirrorCopiesRelativeLinkedContents()
{
}
/**
* @dataProvider providePathsForIsAbsolutePath
*/
public function testIsAbsolutePath($path, $expectedResult)
{
}
/**
* @return array
*/
public function providePathsForIsAbsolutePath()
{
}
public function testTempnam()
{
}
public function testTempnamWithFileScheme()
{
}
public function testTempnamWithMockScheme()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testTempnamWithZlibSchemeFails()
{
}
public function testTempnamWithPHPTempSchemeFails()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testTempnamWithPharSchemeFails()
{
}
/**
* @expectedException \Symfony\Component\Filesystem\Exception\IOException
*/
public function testTempnamWithHTTPSchemeFails()
{
}
public function testTempnamOnUnwritableFallsBackToSysTmp()
{
}
public function testDumpFile()
{
}
public function testDumpFileOverwritesAnExistingFile()
{
}
public function testDumpFileWithFileScheme()
{
}
public function testDumpFileWithZlibScheme()
{
}
public function testAppendToFile()
{
}
public function testAppendToFileWithScheme()
{
}
public function testAppendToFileWithZlibScheme()
{
}
public function testAppendToFileCreateTheFileIfNotExists()
{
}
public function testDumpKeepsExistingPermissionsWhenOverwritingAnExistingFile()
{
}
public function testCopyShouldKeepExecutionPermission()
{
}
}
}
namespace Symfony\Component\Filesystem\Tests\Fixtures\MockStream {
/**
* Mock stream class to be used with stream_wrapper_register.
* stream_wrapper_register('mock', 'Symfony\Component\Filesystem\Tests\Fixtures\MockStream\MockStream').
*/
class MockStream
{
/**
* Opens file or URL.
*
* @param string $path Specifies the URL that was passed to the original function
* @param string $mode The mode used to open the file, as detailed for fopen()
* @param int $options Holds additional flags set by the streams API
* @param string $opened_path If the path is opened successfully, and STREAM_USE_PATH is set in options,
* opened_path should be set to the full path of the file/resource that was actually opened
*
* @return bool
*/
public function stream_open($path, $mode, $options, &$opened_path)
{
}
/**
* @param string $path The file path or URL to stat
* @param array $flags Holds additional flags set by the streams API
*
* @return array File stats
*/
public function url_stat($path, $flags)
{
}
}
}
namespace Symfony\Component\Filesystem {
/**
* LockHandler class provides a simple abstraction to lock anything by means of
* a file lock.
*
* A locked file is created based on the lock name when calling lock(). Other
* lock handlers will not be able to lock the same name until it is released
* (explicitly by calling release() or implicitly when the instance holding the
* lock is destroyed).
*
* @author Grégoire Pineau <lyrixx@lyrixx.info>
* @author Romain Neutron <imprec@gmail.com>
* @author Nicolas Grekas <p@tchwork.com>
*/
class LockHandler
{
/**
* @param string $name The lock name
* @param string|null $lockPath The directory to store the lock. Default values will use temporary directory
*
* @throws IOException If the lock directory could not be created or is not writable
*/
public function __construct($name, $lockPath = null)
{
}
/**
* Lock the resource.
*
* @param bool $blocking wait until the lock is released
*
* @return bool Returns true if the lock was acquired, false otherwise
*
* @throws IOException If the lock file could not be created or opened
*/
public function lock($blocking = false)
{
}
/**
* Release the resource.
*/
public function release()
{
}
}
}
namespace Symfony\Polyfill\Php54 {
/**
* @author Nicolas Grekas <p@tchwork.com>
*
* @internal
*/
final class Php54
{
public static function hex2bin($data)
{
}
}
}
namespace Symfony\Component\Config\Tests {
class ResourceCheckerConfigCacheTest extends \PHPUnit\Framework\TestCase
{
protected function setUp()
{
}
protected function tearDown()
{
}
public function testGetPath()
{
}
public function testCacheIsNotFreshIfEmpty()
{
}
public function testCacheIsFreshIfNocheckerProvided()
{
}
public function testResourcesWithoutcheckersAreIgnoredAndConsideredFresh()
{
}
public function testIsFreshWithchecker()
{
}
public function testIsNotFreshWithchecker()
{
}
public function testCacheIsNotFreshWhenUnserializeFails()
{
}
public function testCacheKeepsContent()
{
}
public function testCacheIsNotFreshIfNotExistsMetaFile()
{
}
}
}
namespace Symfony\Component\Config\Tests\Util {
class XmlUtilsTest extends \PHPUnit\Framework\TestCase
{
public function testLoadFile()
{
}
public function testLoadFileWithInternalErrorsEnabled()
{
}
/**
* @dataProvider getDataForConvertDomToArray
*/
public function testConvertDomToArray($expected, $xml, $root = false, $checkPrefix = true)
{
}
public function getDataForConvertDomToArray()
{
}
/**
* @dataProvider getDataForPhpize
*/
public function testPhpize($expected, $value)
{
}
public function getDataForPhpize()
{
}
public function testLoadEmptyXmlFile()
{
}
// test for issue https://github.com/symfony/symfony/issues/9731
public function testLoadWrongEmptyXMLWithErrorHandler()
{
}
}
interface Validator
{
public function validate();
}
}
namespace Symfony\Component\Config\Tests {
class FileLocatorTest extends \PHPUnit\Framework\TestCase
{
/**
* @dataProvider getIsAbsolutePathTests
*/
public function testIsAbsolutePath($path)
{
}
public function getIsAbsolutePathTests()
{
}
public function testLocate()
{
}
/**
* @expectedException \Symfony\Component\Config\Exception\FileLocatorFileNotFoundException
* @expectedExceptionMessage The file "foobar.xml" does not exist
*/
public function testLocateThrowsAnExceptionIfTheFileDoesNotExists()
{
}
/**
* @expectedException \Symfony\Component\Config\Exception\FileLocatorFileNotFoundException
*/
public function testLocateThrowsAnExceptionIfTheFileDoesNotExistsInAbsolutePath()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage An empty file name is not valid to be located.
*/
public function testLocateEmpty()
{
}
}
class ConfigCacheTest extends \PHPUnit\Framework\TestCase
{
protected function setUp()
{
}
protected function tearDown()
{
}
/**
* @dataProvider debugModes
*/
public function testCacheIsNotValidIfNothingHasBeenCached($debug)
{
}
public function testIsAlwaysFreshInProduction()
{
}
/**
* @dataProvider debugModes
*/
public function testIsFreshWhenNoResourceProvided($debug)
{
}
public function testFreshResourceInDebug()
{
}
public function testStaleResourceInDebug()
{
}
public function debugModes()
{
}
}
}
namespace Symfony\Component\Config\Tests\Loader {
class LoaderTest extends \PHPUnit\Framework\TestCase
{
public function testGetSetResolver()
{
}
public function testResolve()
{
}
/**
* @expectedException \Symfony\Component\Config\Exception\FileLoaderLoadException
*/
public function testResolveWhenResolverCannotFindLoader()
{
}
public function testImport()
{
}
public function testImportWithType()
{
}
}
class ProjectLoader1 extends \Symfony\Component\Config\Loader\Loader
{
public function load($resource, $type = null)
{
}
public function supports($resource, $type = null)
{
}
public function getType()
{
}
}
class DelegatingLoaderTest extends \PHPUnit\Framework\TestCase
{
public function testConstructor()
{
}
public function testGetSetResolver()
{
}
public function testSupports()
{
}
public function testLoad()
{
}
/**
* @expectedException \Symfony\Component\Config\Exception\FileLoaderLoadException
*/
public function testLoadThrowsAnExceptionIfTheResourceCannotBeLoaded()
{
}
}
class FileLoaderTest extends \PHPUnit\Framework\TestCase
{
public function testImportWithFileLocatorDelegation()
{
}
}
class TestFileLoader extends \Symfony\Component\Config\Loader\FileLoader
{
public function load($resource, $type = null)
{
}
public function supports($resource, $type = null)
{
}
public function addLoading($resource)
{
}
public function removeLoading($resource)
{
}
public function clearLoading()
{
}
public function setSupports($supports)
{
}
}
class LoaderResolverTest extends \PHPUnit\Framework\TestCase
{
public function testConstructor()
{
}
public function testResolve()
{
}
public function testLoaders()
{
}
}
}
namespace Symfony\Component\Config\Tests\Resource {
class FileResourceTest extends \PHPUnit\Framework\TestCase
{
protected $resource;
protected $file;
protected $time;
protected function setUp()
{
}
protected function tearDown()
{
}
public function testGetResource()
{
}
public function testGetResourceWithScheme()
{
}
public function testToString()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessageRegExp /The file ".*" does not exist./
*/
public function testResourceDoesNotExist()
{
}
public function testIsFresh()
{
}
public function testIsFreshForDeletedResources()
{
}
public function testSerializeUnserialize()
{
}
}
class ResourceStub implements \Symfony\Component\Config\Resource\SelfCheckingResourceInterface
{
public function setFresh($isFresh)
{
}
public function __toString()
{
}
public function isFresh($timestamp)
{
}
}
class FileExistenceResourceTest extends \PHPUnit\Framework\TestCase
{
protected $resource;
protected $file;
protected $time;
protected function setUp()
{
}
protected function tearDown()
{
}
public function testToString()
{
}
public function testGetResource()
{
}
public function testIsFreshWithExistingResource()
{
}
public function testIsFreshWithAbsentResource()
{
}
}
class DirectoryResourceTest extends \PHPUnit\Framework\TestCase
{
protected $directory;
protected function setUp()
{
}
protected function tearDown()
{
}
protected function removeDirectory($directory)
{
}
public function testGetResource()
{
}
public function testGetPattern()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessageRegExp /The directory ".*" does not exist./
*/
public function testResourceDoesNotExist()
{
}
public function testIsFresh()
{
}
public function testIsFreshForDeletedResources()
{
}
public function testIsFreshUpdateFile()
{
}
public function testIsFreshNewFile()
{
}
public function testIsFreshNewFileWithDifferentPattern()
{
}
public function testIsFreshDeleteFile()
{
}
public function testIsFreshDeleteDirectory()
{
}
public function testIsFreshCreateFileInSubdirectory()
{
}
public function testIsFreshModifySubdirectory()
{
}
public function testFilterRegexListNoMatch()
{
}
public function testFilterRegexListMatch()
{
}
public function testSerializeUnserialize()
{
}
public function testResourcesWithDifferentPatternsAreDifferent()
{
}
}
class ClassExistenceResourceTest extends \PHPUnit\Framework\TestCase
{
public function testToString()
{
}
public function testGetResource()
{
}
public function testIsFreshWhenClassDoesNotExist()
{
}
public function testIsFreshWhenClassExists()
{
}
}
}
namespace Symfony\Component\Config\Tests\Fixtures\Configuration {
class ExampleConfiguration implements \Symfony\Component\Config\Definition\ConfigurationInterface
{
public function getConfigTreeBuilder()
{
}
}
}
namespace Symfony\Component\Config\Tests\Definition\Builder {
class NodeBuilder extends \Symfony\Component\Config\Definition\Builder\NodeBuilder
{
public function barNode($name)
{
}
protected function getNodeClass($type)
{
}
}
class VariableNodeDefinition extends \Symfony\Component\Config\Definition\Builder\VariableNodeDefinition
{
}
class BarNodeDefinition extends \Symfony\Component\Config\Definition\Builder\NodeDefinition
{
protected function createNode()
{
}
}
}
namespace Symfony\Component\Config\Tests\Fixtures {
class BarNode extends \Symfony\Component\Config\Definition\ArrayNode
{
}
}
namespace Symfony\Component\Config\Tests {
class ConfigCacheFactoryTest extends \PHPUnit\Framework\TestCase
{
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage Invalid type for callback argument. Expected callable, but got "object".
*/
public function testCachWithInvalidCallback()
{
}
}
}
namespace Symfony\Component\Config\Tests\Exception {
class FileLoaderLoadExceptionTest extends \PHPUnit\Framework\TestCase
{
public function testMessageCannotLoadResource()
{
}
public function testMessageCannotImportResourceFromSource()
{
}
public function testMessageCannotImportBundleResource()
{
}
public function testMessageHasPreviousErrorWithDotAndUnableToLoad()
{
}
public function testMessageHasPreviousErrorWithoutDotAndUnableToLoad()
{
}
public function testMessageHasPreviousErrorAndUnableToLoadBundle()
{
}
}
}
namespace Symfony\Component\Config\Tests\Definition {
class BooleanNodeTest extends \PHPUnit\Framework\TestCase
{
/**
* @dataProvider getValidValues
*/
public function testNormalize($value)
{
}
/**
* @dataProvider getValidValues
*
* @param bool $value
*/
public function testValidNonEmptyValues($value)
{
}
public function getValidValues()
{
}
/**
* @dataProvider getInvalidValues
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidTypeException
*/
public function testNormalizeThrowsExceptionOnInvalidValues($value)
{
}
public function getInvalidValues()
{
}
}
class MergeTest extends \PHPUnit\Framework\TestCase
{
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\ForbiddenOverwriteException
*/
public function testForbiddenOverwrite()
{
}
public function testUnsetKey()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
*/
public function testDoesNotAllowNewKeysInSubsequentConfigs()
{
}
public function testPerformsNoDeepMerging()
{
}
public function testPrototypeWithoutAKeyAttribute()
{
}
}
class IntegerNodeTest extends \PHPUnit\Framework\TestCase
{
/**
* @dataProvider getValidValues
*/
public function testNormalize($value)
{
}
/**
* @dataProvider getValidValues
*
* @param int $value
*/
public function testValidNonEmptyValues($value)
{
}
public function getValidValues()
{
}
/**
* @dataProvider getInvalidValues
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidTypeException
*/
public function testNormalizeThrowsExceptionOnInvalidValues($value)
{
}
public function getInvalidValues()
{
}
}
class ArrayNodeTest extends \PHPUnit\Framework\TestCase
{
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidTypeException
*/
public function testNormalizeThrowsExceptionWhenFalseIsNotAllowed()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
* @expectedExceptionMessage Unrecognized option "foo" under "root"
*/
public function testExceptionThrownOnUnrecognizedChild()
{
}
public function ignoreAndRemoveMatrixProvider()
{
}
/**
* @dataProvider ignoreAndRemoveMatrixProvider
*/
public function testIgnoreAndRemoveBehaviors($ignore, $remove, $expected, $message = '')
{
}
/**
* @dataProvider getPreNormalizationTests
*/
public function testPreNormalize($denormalized, $normalized)
{
}
public function getPreNormalizationTests()
{
}
/**
* @dataProvider getZeroNamedNodeExamplesData
*/
public function testNodeNameCanBeZero($denormalized, $normalized)
{
}
public function getZeroNamedNodeExamplesData()
{
}
/**
* @dataProvider getPreNormalizedNormalizedOrderedData
*/
public function testChildrenOrderIsMaintainedOnNormalizeValue($prenormalized, $normalized)
{
}
public function getPreNormalizedNormalizedOrderedData()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage Child nodes must be named.
*/
public function testAddChildEmptyName()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage A child node named "foo" already exists.
*/
public function testAddChildNameAlreadyExists()
{
}
/**
* @expectedException \RuntimeException
* @expectedExceptionMessage The node at path "foo" has no default value.
*/
public function testGetDefaultValueWithoutDefaultValue()
{
}
}
}
namespace Symfony\Component\Config\Tests\Definition\Dumper {
class XmlReferenceDumperTest extends \PHPUnit\Framework\TestCase
{
public function testDumper()
{
}
public function testNamespaceDumper()
{
}
}
class YamlReferenceDumperTest extends \PHPUnit\Framework\TestCase
{
public function testDumper()
{
}
}
}
namespace Symfony\Component\Config\Tests\Definition {
class ScalarNodeTest extends \PHPUnit\Framework\TestCase
{
/**
* @dataProvider getValidValues
*/
public function testNormalize($value)
{
}
public function getValidValues()
{
}
/**
* @dataProvider getInvalidValues
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidTypeException
*/
public function testNormalizeThrowsExceptionOnInvalidValues($value)
{
}
public function getInvalidValues()
{
}
public function testNormalizeThrowsExceptionWithoutHint()
{
}
public function testNormalizeThrowsExceptionWithErrorMessage()
{
}
/**
* @dataProvider getValidNonEmptyValues
*
* @param mixed $value
*/
public function testValidNonEmptyValues($value)
{
}
public function getValidNonEmptyValues()
{
}
/**
* @dataProvider getEmptyValues
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
*
* @param mixed $value
*/
public function testNotAllowedEmptyValuesThrowException($value)
{
}
public function getEmptyValues()
{
}
}
class PrototypedArrayNodeTest extends \PHPUnit\Framework\TestCase
{
public function testGetDefaultValueReturnsAnEmptyArrayForPrototypes()
{
}
public function testGetDefaultValueReturnsDefaultValueForPrototypes()
{
}
// a remapped key (e.g. "mapping" -> "mappings") should be unset after being used
public function testRemappedKeysAreUnset()
{
}
/**
* Tests that when a key attribute is mapped, that key is removed from the array.
*
* <things>
* <option id="option1" value="foo">
* <option id="option2" value="bar">
* </things>
*
* The above should finally be mapped to an array that looks like this
* (because "id" is the key attribute).
*
* array(
* 'things' => array(
* 'option1' => 'foo',
* 'option2' => 'bar',
* )
* )
*/
public function testMappedAttributeKeyIsRemoved()
{
}
/**
* Tests the opposite of the testMappedAttributeKeyIsRemoved because
* the removal can be toggled with an option.
*/
public function testMappedAttributeKeyNotRemoved()
{
}
public function testAddDefaultChildren()
{
}
public function testDefaultChildrenWinsOverDefaultValue()
{
}
protected function getPrototypeNodeWithDefaultChildren()
{
}
/**
* Tests that when a key attribute is mapped, that key is removed from the array.
* And if only 'value' element is left in the array, it will replace its wrapper array.
*
* <things>
* <option id="option1" value="value1">
* </things>
*
* The above should finally be mapped to an array that looks like this
* (because "id" is the key attribute).
*
* array(
* 'things' => array(
* 'option1' => 'value1'
* )
* )
*
* It's also possible to mix 'value-only' and 'non-value-only' elements in the array.
*
* <things>
* <option id="option1" value="value1">
* <option id="option2" value="value2" foo="foo2">
* </things>
*
* The above should finally be mapped to an array as follows
*
* array(
* 'things' => array(
* 'option1' => 'value1',
* 'option2' => array(
* 'value' => 'value2',
* 'foo' => 'foo2'
* )
* )
* )
*
* The 'value' element can also be ArrayNode:
*
* <things>
* <option id="option1">
* <value>
* <foo>foo1</foo>
* <bar>bar1</bar>
* </value>
* </option>
* </things>
*
* The above should be finally be mapped to an array as follows
*
* array(
* 'things' => array(
* 'option1' => array(
* 'foo' => 'foo1',
* 'bar' => 'bar1'
* )
* )
* )
*
* If using VariableNode for value node, it's also possible to mix different types of value nodes:
*
* <things>
* <option id="option1">
* <value>
* <foo>foo1</foo>
* <bar>bar1</bar>
* </value>
* </option>
* <option id="option2" value="value2">
* </things>
*
* The above should be finally mapped to an array as follows
*
* array(
* 'things' => array(
* 'option1' => array(
* 'foo' => 'foo1',
* 'bar' => 'bar1'
* ),
* 'option2' => 'value2'
* )
* )
*
*
* @dataProvider getDataForKeyRemovedLeftValueOnly
*/
public function testMappedAttributeKeyIsRemovedLeftValueOnly($value, $children, $expected)
{
}
public function getDataForKeyRemovedLeftValueOnly()
{
}
}
}
namespace Symfony\Component\Config\Tests\Definition\Builder {
class NodeBuilderTest extends \PHPUnit\Framework\TestCase
{
/**
* @expectedException \RuntimeException
*/
public function testThrowsAnExceptionWhenTryingToCreateANonRegisteredNodeType()
{
}
/**
* @expectedException \RuntimeException
*/
public function testThrowsAnExceptionWhenTheNodeClassIsNotFound()
{
}
public function testAddingANewNodeType()
{
}
public function testOverridingAnExistingNodeType()
{
}
public function testNodeTypesAreNotCaseSensitive()
{
}
public function testNumericNodeCreation()
{
}
}
class SomeNodeDefinition extends \Symfony\Component\Config\Definition\Builder\VariableNodeDefinition
{
}
class ExprBuilderTest extends \PHPUnit\Framework\TestCase
{
public function testAlwaysExpression()
{
}
public function testIfTrueExpression()
{
}
public function testIfStringExpression()
{
}
public function testIfNullExpression()
{
}
public function testIfEmptyExpression()
{
}
public function testIfArrayExpression()
{
}
public function testIfInArrayExpression()
{
}
public function testIfNotInArrayExpression()
{
}
public function testThenEmptyArrayExpression()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
*/
public function testThenInvalid()
{
}
public function testThenUnsetExpression()
{
}
/**
* @expectedException \RuntimeException
* @expectedExceptionMessage You must specify an if part.
*/
public function testEndIfPartNotSpecified()
{
}
/**
* @expectedException \RuntimeException
* @expectedExceptionMessage You must specify a then part.
*/
public function testEndThenPartNotSpecified()
{
}
/**
* Create a test treebuilder with a variable node, and init the validation.
*
* @return TreeBuilder
*/
protected function getTestBuilder()
{
}
/**
* Close the validation process and finalize with the given config.
*
* @param TreeBuilder $testBuilder The tree builder to finalize
* @param array $config The config you want to use for the finalization, if nothing provided
* a simple array('key'=>'value') will be used
*
* @return array The finalized config values
*/
protected function finalizeTestBuilder($testBuilder, $config = null)
{
}
/**
* Return a closure that will return the given value.
*
* @param mixed $val The value that the closure must return
*
* @return \Closure
*/
protected function returnClosure($val)
{
}
/**
* Assert that the given test builder, will return the given value.
*
* @param mixed $value The value to test
* @param TreeBuilder $treeBuilder The tree builder to finalize
* @param mixed $config The config values that new to be finalized
*/
protected function assertFinalizedValueIs($value, $treeBuilder, $config = null)
{
}
}
class ArrayNodeDefinitionTest extends \PHPUnit\Framework\TestCase
{
public function testAppendingSomeNode()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidDefinitionException
* @dataProvider providePrototypeNodeSpecificCalls
*/
public function testPrototypeNodeSpecificOption($method, $args)
{
}
public function providePrototypeNodeSpecificCalls()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidDefinitionException
*/
public function testConcreteNodeSpecificOption()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidDefinitionException
*/
public function testPrototypeNodesCantHaveADefaultValueWhenUsingDefaultChildren()
{
}
public function testPrototypedArrayNodeDefaultWhenUsingDefaultChildren()
{
}
/**
* @dataProvider providePrototypedArrayNodeDefaults
*/
public function testPrototypedArrayNodeDefault($args, $shouldThrowWhenUsingAttrAsKey, $shouldThrowWhenNotUsingAttrAsKey, $defaults)
{
}
public function providePrototypedArrayNodeDefaults()
{
}
public function testNestedPrototypedArrayNodes()
{
}
public function testEnabledNodeDefaults()
{
}
/**
* @dataProvider getEnableableNodeFixtures
*/
public function testTrueEnableEnabledNode($expected, $config, $message)
{
}
public function testCanBeDisabled()
{
}
public function testIgnoreExtraKeys()
{
}
public function testNormalizeKeys()
{
}
public function getEnableableNodeFixtures()
{
}
protected function getField($object, $field)
{
}
}
class BooleanNodeDefinitionTest extends \PHPUnit\Framework\TestCase
{
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidDefinitionException
* @expectedExceptionMessage ->cannotBeEmpty() is not applicable to BooleanNodeDefinition.
*/
public function testCannotBeEmptyThrowsAnException()
{
}
}
class TreeBuilderTest extends \PHPUnit\Framework\TestCase
{
public function testUsingACustomNodeBuilder()
{
}
public function testOverrideABuiltInNodeType()
{
}
public function testAddANodeType()
{
}
public function testCreateABuiltInNodeTypeWithACustomNodeBuilder()
{
}
public function testPrototypedArrayNodeUseTheCustomNodeBuilder()
{
}
public function testAnExtendedNodeBuilderGetsPropagatedToTheChildren()
{
}
public function testDefinitionInfoGetsTransferredToNode()
{
}
public function testDefinitionExampleGetsTransferredToNode()
{
}
}
class NumericNodeDefinitionTest extends \PHPUnit\Framework\TestCase
{
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage You cannot define a min(4) as you already have a max(3)
*/
public function testIncoherentMinAssertion()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage You cannot define a max(2) as you already have a min(3)
*/
public function testIncoherentMaxAssertion()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
* @expectedExceptionMessage The value 4 is too small for path "foo". Should be greater than or equal to 5
*/
public function testIntegerMinAssertion()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
* @expectedExceptionMessage The value 4 is too big for path "foo". Should be less than or equal to 3
*/
public function testIntegerMaxAssertion()
{
}
public function testIntegerValidMinMaxAssertion()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
* @expectedExceptionMessage The value 400 is too small for path "foo". Should be greater than or equal to 500
*/
public function testFloatMinAssertion()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
* @expectedExceptionMessage The value 4.3 is too big for path "foo". Should be less than or equal to 0.3
*/
public function testFloatMaxAssertion()
{
}
public function testFloatValidMinMaxAssertion()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidDefinitionException
* @expectedExceptionMessage ->cannotBeEmpty() is not applicable to NumericNodeDefinition.
*/
public function testCannotBeEmptyThrowsAnException()
{
}
}
class EnumNodeDefinitionTest extends \PHPUnit\Framework\TestCase
{
public function testWithOneValue()
{
}
public function testWithOneDistinctValue()
{
}
/**
* @expectedException \RuntimeException
* @expectedExceptionMessage You must call ->values() on enum nodes.
*/
public function testNoValuesPassed()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage ->values() must be called with at least one value.
*/
public function testWithNoValues()
{
}
public function testGetNode()
{
}
}
}
namespace Symfony\Component\Config\Tests\Definition {
class FloatNodeTest extends \PHPUnit\Framework\TestCase
{
/**
* @dataProvider getValidValues
*/
public function testNormalize($value)
{
}
/**
* @dataProvider getValidValues
*
* @param int $value
*/
public function testValidNonEmptyValues($value)
{
}
public function getValidValues()
{
}
/**
* @dataProvider getInvalidValues
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidTypeException
*/
public function testNormalizeThrowsExceptionOnInvalidValues($value)
{
}
public function getInvalidValues()
{
}
}
class NormalizationTest extends \PHPUnit\Framework\TestCase
{
/**
* @dataProvider getEncoderTests
*/
public function testNormalizeEncoders($denormalized)
{
}
public function getEncoderTests()
{
}
/**
* @dataProvider getAnonymousKeysTests
*/
public function testAnonymousKeysArray($denormalized)
{
}
public function getAnonymousKeysTests()
{
}
/**
* @dataProvider getNumericKeysTests
*/
public function testNumericKeysAsAttributes($denormalized)
{
}
public function getNumericKeysTests()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
* @expectedExceptionMessage The attribute "id" must be set for path "root.thing".
*/
public function testNonAssociativeArrayThrowsExceptionIfAttributeNotSet()
{
}
public function testAssociativeArrayPreserveKeys()
{
}
public static function assertNormalized(\Symfony\Component\Config\Definition\NodeInterface $tree, $denormalized, $normalized)
{
}
}
class EnumNodeTest extends \PHPUnit\Framework\TestCase
{
public function testFinalizeValue()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage $values must contain at least one element.
*/
public function testConstructionWithNoValues()
{
}
public function testConstructionWithOneValue()
{
}
public function testConstructionWithOneDistinctValue()
{
}
/**
* @expectedException \Symfony\Component\Config\Definition\Exception\InvalidConfigurationException
* @expectedExceptionMessage The value "foobar" is not allowed for path "foo". Permissible values: "foo", "bar"
*/
public function testFinalizeWithInvalidValue()
{
}
}
class FinalizationTest extends \PHPUnit\Framework\TestCase
{
public function testUnsetKeyWithDeepHierarchy()
{
}
protected function process(\Symfony\Component\Config\Definition\NodeInterface $tree, array $configs)
{
}
}
}
namespace Symfony\Component\Config\Exception {
/**
* Exception class for when a resource cannot be loaded or imported.
*
* @author Ryan Weaver <ryan@thatsquality.com>
*/
class FileLoaderLoadException extends \Exception
{
/**
* @param string $resource The resource that could not be imported
* @param string $sourceResource The original resource importing the new resource
* @param int $code The error code
* @param \Exception $previous A previous exception
*/
public function __construct($resource, $sourceResource = null, $code = null, $previous = null)
{
}
protected function varToString($var)
{
}
}
}
namespace Symfony\Component\Process\Tests {
/**
* @author Robert Schönthal <seroscho@googlemail.com>
*/
class PhpExecutableFinderTest extends \PHPUnit\Framework\TestCase
{
/**
* tests find() with the constant PHP_BINARY.
*/
public function testFind()
{
}
/**
* tests find() with the env var / constant PHP_BINARY with HHVM.
*/
public function testFindWithHHVM()
{
}
/**
* tests find() with the env var PHP_PATH.
*/
public function testFindArguments()
{
}
}
class ProcessBuilderTest extends \PHPUnit\Framework\TestCase
{
/**
* @group legacy
*/
public function testInheritEnvironmentVars()
{
}
public function testAddEnvironmentVariables()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
*/
public function testNegativeTimeoutFromSetter()
{
}
public function testNullTimeout()
{
}
public function testShouldSetArguments()
{
}
public function testPrefixIsPrependedToAllGeneratedProcess()
{
}
public function testArrayPrefixesArePrependedToAllGeneratedProcess()
{
}
public function testShouldEscapeArguments()
{
}
public function testShouldEscapeArgumentsAndPrefix()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\LogicException
*/
public function testShouldThrowALogicExceptionIfNoPrefixAndNoArgument()
{
}
public function testShouldNotThrowALogicExceptionIfNoArgument()
{
}
public function testShouldNotThrowALogicExceptionIfNoPrefix()
{
}
public function testShouldReturnProcessWithDisabledOutput()
{
}
public function testShouldReturnProcessWithEnabledOutput()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
* @expectedExceptionMessage Symfony\Component\Process\ProcessBuilder::setInput only accepts strings, Traversable objects or stream resources.
*/
public function testInvalidInput()
{
}
public function testDoesNotPrefixExec()
{
}
}
class PhpProcessTest extends \PHPUnit\Framework\TestCase
{
public function testNonBlockingWorks()
{
}
public function testCommandLine()
{
}
}
/**
* @author Chris Smith <chris@cs278.org>
*/
class ExecutableFinderTest extends \PHPUnit\Framework\TestCase
{
protected function tearDown()
{
}
public function testFind()
{
}
public function testFindWithDefault()
{
}
public function testFindWithExtraDirs()
{
}
public function testFindWithOpenBaseDir()
{
}
public function testFindProcessInOpenBasedir()
{
}
}
/**
* @group legacy
*/
class ProcessUtilsTest extends \PHPUnit\Framework\TestCase
{
/**
* @dataProvider dataArguments
*/
public function testEscapeArgument($result, $argument)
{
}
public function dataArguments()
{
}
}
/**
* @author Robert Schönthal <seroscho@googlemail.com>
*/
class ProcessTest extends \PHPUnit\Framework\TestCase
{
public static function setUpBeforeClass()
{
}
protected function tearDown()
{
}
public function testThatProcessDoesNotThrowWarningDuringRun()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
*/
public function testNegativeTimeoutFromConstructor()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
*/
public function testNegativeTimeoutFromSetter()
{
}
public function testFloatAndNullTimeout()
{
}
/**
* @requires extension pcntl
*/
public function testStopWithTimeoutIsActuallyWorking()
{
}
public function testAllOutputIsActuallyReadOnTermination()
{
}
public function testCallbacksAreExecutedWithStart()
{
}
/**
* tests results from sub processes.
*
* @dataProvider responsesCodeProvider
*/
public function testProcessResponses($expected, $getter, $code)
{
}
/**
* tests results from sub processes.
*
* @dataProvider pipesCodeProvider
*/
public function testProcessPipes($code, $size)
{
}
/**
* @dataProvider pipesCodeProvider
*/
public function testSetStreamAsInput($code, $size)
{
}
public function testLiveStreamAsInput()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\LogicException
* @expectedExceptionMessage Input can not be set while the process is running.
*/
public function testSetInputWhileRunningThrowsAnException()
{
}
/**
* @dataProvider provideInvalidInputValues
* @expectedException \Symfony\Component\Process\Exception\InvalidArgumentException
* @expectedExceptionMessage Symfony\Component\Process\Process::setInput only accepts strings, Traversable objects or stream resources.
*/
public function testInvalidInput($value)
{
}
public function provideInvalidInputValues()
{
}
/**
* @dataProvider provideInputValues
*/
public function testValidInput($expected, $value)
{
}
public function provideInputValues()
{
}
public function chainedCommandsOutputProvider()
{
}
/**
* @dataProvider chainedCommandsOutputProvider
*/
public function testChainedCommandsOutput($expected, $operator, $input)
{
}
public function testCallbackIsExecutedForOutput()
{
}
public function testCallbackIsExecutedForOutputWheneverOutputIsDisabled()
{
}
public function testGetErrorOutput()
{
}
public function testFlushErrorOutput()
{
}
/**
* @dataProvider provideIncrementalOutput
*/
public function testIncrementalOutput($getOutput, $getIncrementalOutput, $uri)
{
}
public function provideIncrementalOutput()
{
}
public function testGetOutput()
{
}
public function testFlushOutput()
{
}
public function testZeroAsOutput()
{
}
public function testExitCodeCommandFailed()
{
}
/**
* @group tty
*/
public function testTTYCommand()
{
}
/**
* @group tty
*/
public function testTTYCommandExitCode()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\RuntimeException
* @expectedExceptionMessage TTY mode is not supported on Windows platform.
*/
public function testTTYInWindowsEnvironment()
{
}
public function testExitCodeTextIsNullWhenExitCodeIsNull()
{
}
public function testPTYCommand()
{
}
public function testMustRun()
{
}
public function testSuccessfulMustRunHasCorrectExitCode()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\ProcessFailedException
*/
public function testMustRunThrowsException()
{
}
public function testExitCodeText()
{
}
public function testStartIsNonBlocking()
{
}
public function testUpdateStatus()
{
}
public function testGetExitCodeIsNullOnStart()
{
}
public function testGetExitCodeIsNullOnWhenStartingAgain()
{
}
public function testGetExitCode()
{
}
public function testStatus()
{
}
public function testStop()
{
}
public function testIsSuccessful()
{
}
public function testIsSuccessfulOnlyAfterTerminated()
{
}
public function testIsNotSuccessful()
{
}
public function testProcessIsNotSignaled()
{
}
public function testProcessWithoutTermSignal()
{
}
public function testProcessIsSignaledIfStopped()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\RuntimeException
* @expectedExceptionMessage The process has been signaled
*/
public function testProcessThrowsExceptionWhenExternallySignaled()
{
}
public function testRestart()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\ProcessTimedOutException
* @expectedExceptionMessage exceeded the timeout of 0.1 seconds.
*/
public function testRunProcessWithTimeout()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\ProcessTimedOutException
* @expectedExceptionMessage exceeded the timeout of 0.1 seconds.
*/
public function testIterateOverProcessWithTimeout()
{
}
public function testCheckTimeoutOnNonStartedProcess()
{
}
public function testCheckTimeoutOnTerminatedProcess()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\ProcessTimedOutException
* @expectedExceptionMessage exceeded the timeout of 0.1 seconds.
*/
public function testCheckTimeoutOnStartedProcess()
{
}
public function testIdleTimeout()
{
}
public function testIdleTimeoutNotExceededWhenOutputIsSent()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\ProcessTimedOutException
* @expectedExceptionMessage exceeded the timeout of 0.1 seconds.
*/
public function testStartAfterATimeout()
{
}
public function testGetPid()
{
}
public function testGetPidIsNullBeforeStart()
{
}
public function testGetPidIsNullAfterRun()
{
}
/**
* @requires extension pcntl
*/
public function testSignal()
{
}
/**
* @requires extension pcntl
*/
public function testExitCodeIsAvailableAfterSignal()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\LogicException
* @expectedExceptionMessage Can not send signal on a non running process.
*/
public function testSignalProcessNotRunning()
{
}
/**
* @dataProvider provideMethodsThatNeedARunningProcess
*/
public function testMethodsThatNeedARunningProcess($method)
{
}
public function provideMethodsThatNeedARunningProcess()
{
}
/**
* @dataProvider provideMethodsThatNeedATerminatedProcess
* @expectedException \Symfony\Component\Process\Exception\LogicException
* @expectedExceptionMessage Process must be terminated before calling
*/
public function testMethodsThatNeedATerminatedProcess($method)
{
}
public function provideMethodsThatNeedATerminatedProcess()
{
}
/**
* @dataProvider provideWrongSignal
* @expectedException \Symfony\Component\Process\Exception\RuntimeException
*/
public function testWrongSignal($signal)
{
}
public function provideWrongSignal()
{
}
public function testDisableOutputDisablesTheOutput()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\RuntimeException
* @expectedExceptionMessage Disabling output while the process is running is not possible.
*/
public function testDisableOutputWhileRunningThrowsException()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\RuntimeException
* @expectedExceptionMessage Enabling output while the process is running is not possible.
*/
public function testEnableOutputWhileRunningThrowsException()
{
}
public function testEnableOrDisableOutputAfterRunDoesNotThrowException()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\LogicException
* @expectedExceptionMessage Output can not be disabled while an idle timeout is set.
*/
public function testDisableOutputWhileIdleTimeoutIsSet()
{
}
/**
* @expectedException \Symfony\Component\Process\Exception\LogicException
* @expectedExceptionMessage timeout can not be set while the output is disabled.
*/
public function testSetIdleTimeoutWhileOutputIsDisabled()
{
}
public function testSetNullIdleTimeoutWhileOutputIsDisabled()
{
}
/**
* @dataProvider provideOutputFetchingMethods
* @expectedException \Symfony\Component\Process\Exception\LogicException
* @expectedExceptionMessage Output has been disabled.
*/
public function testGetOutputWhileDisabled($fetchMethod)
{
}
public function provideOutputFetchingMethods()
{
}
public function testStopTerminatesProcessCleanly()
{
}
public function testKillSignalTerminatesProcessCleanly()
{
}
public function testTermSignalTerminatesProcessCleanly()
{
}
public function responsesCodeProvider()
{
}
public function pipesCodeProvider()
{
}
/**
* @dataProvider provideVariousIncrementals
*/
public function testIncrementalOutputDoesNotRequireAnotherCall($stream, $method)
{
}
public function provideVariousIncrementals()
{
}
public function testIteratorInput()
{
}
public function testSimpleInputStream()
{
}
public function testInputStreamWithCallable()
{
}
public function testInputStreamWithGenerator()
{
}
public function testInputStreamOnEmpty()
{
}
public function testIteratorOutput()
{
}
public function testNonBlockingNorClearingIteratorOutput()
{
}
public function testChainedProcesses()
{
}
public function testSetBadEnv()
{
}
public function testEnvBackupDoesNotDeleteExistingVars()
{
}
public function testEnvIsInherited()
{
}
/**
* @group legacy
*/
public function testInheritEnvDisabled()
{
}
public function testGetCommandLine()
{
}
/**
* @dataProvider provideEscapeArgument
*/
public function testEscapeArgument($arg)
{
}
/**
* @dataProvider provideEscapeArgument
* @group legacy
*/
public function testEscapeArgumentWhenInheritEnvDisabled($arg)
{
}
public function testRawCommandLine()
{
}
public function provideEscapeArgument()
{
}
public function testEnvArgument()
{
}
}
class NonStringifiable
{
}
/**
* @author Sebastian Marek <proofek@gmail.com>
*/
class ProcessFailedExceptionTest extends \PHPUnit\Framework\TestCase
{
/**
* tests ProcessFailedException throws exception if the process was successful.
*/
public function testProcessFailedExceptionThrowsException()
{
}
/**
* tests ProcessFailedException uses information from process output
* to generate exception message.
*/
public function testProcessFailedExceptionPopulatesInformationFromProcessOutput()
{
}
/**
* Tests that ProcessFailedException does not extract information from
* process output if it was previously disabled.
*/
public function testDisabledOutputInFailedExceptionDoesNotPopulateOutput()
{
}
}
}
namespace Symfony\Component\Process {
/**
* Process builder.
*
* @author Kris Wallsmith <kris@symfony.com>
*/
class ProcessBuilder
{
/**
* Constructor.
*
* @param string[] $arguments An array of arguments
*/
public function __construct(array $arguments = array())
{
}
/**
* Creates a process builder instance.
*
* @param string[] $arguments An array of arguments
*
* @return static
*/
public static function create(array $arguments = array())
{
}
/**
* Adds an unescaped argument to the command string.
*
* @param string $argument A command argument
*
* @return $this
*/
public function add($argument)
{
}
/**
* Adds a prefix to the command string.
*
* The prefix is preserved when resetting arguments.
*
* @param string|array $prefix A command prefix or an array of command prefixes
*
* @return $this
*/
public function setPrefix($prefix)
{
}
/**
* Sets the arguments of the process.
*
* Arguments must not be escaped.
* Previous arguments are removed.
*
* @param string[] $arguments
*
* @return $this
*/
public function setArguments(array $arguments)
{
}
/**
* Sets the working directory.
*
* @param null|string $cwd The working directory
*
* @return $this
*/
public function setWorkingDirectory($cwd)
{
}
/**
* Sets whether environment variables will be inherited or not.
*
* @param bool $inheritEnv
*
* @return $this
*
* @deprecated since version 3.3, to be removed in 4.0.
*/
public function inheritEnvironmentVariables($inheritEnv = true)
{
}
/**
* Sets an environment variable.
*
* Setting a variable overrides its previous value. Use `null` to unset a
* defined environment variable.
*
* @param string $name The variable name
* @param null|string $value The variable value
*
* @return $this
*/
public function setEnv($name, $value)
{
}
/**
* Adds a set of environment variables.
*
* Already existing environment variables with the same name will be
* overridden by the new values passed to this method. Pass `null` to unset
* a variable.
*
* @param array $variables The variables
*
* @return $this
*/
public function addEnvironmentVariables(array $variables)
{
}
/**
* Sets the input of the process.
*
* @param resource|scalar|\Traversable|null $input The input content
*
* @return $this
*
* @throws InvalidArgumentException In case the argument is invalid
*/
public function setInput($input)
{
}
/**
* Sets the process timeout.
*
* To disable the timeout, set this value to null.
*
* @param float|null $timeout
*
* @return $this
*
* @throws InvalidArgumentException
*/
public function setTimeout($timeout)
{
}
/**
* Adds a proc_open option.
*
* @param string $name The option name
* @param string $value The option value
*
* @return $this
*
* @deprecated since version 3.3, to be removed in 4.0.
*/
public function setOption($name, $value)
{
}
/**
* Disables fetching output and error output from the underlying process.
*
* @return $this
*/
public function disableOutput()
{
}
/**
* Enables fetching output and error output from the underlying process.
*
* @return $this
*/
public function enableOutput()
{
}
/**
* Creates a Process instance and returns it.
*
* @return Process
*
* @throws LogicException In case no arguments have been provided
*/
public function getProcess()
{
}
}
}
namespace Symfony\Component\Finder\Tests\Iterator {
abstract class IteratorTestCase extends \PHPUnit_Framework_TestCase
{
protected function assertIterator($expected, \Traversable $iterator)
{
}
protected function assertOrderedIterator($expected, \Traversable $iterator)
{
}
/**
* Same as assertOrderedIterator, but checks the order of groups of
* array elements.
*
* @param array $expected - an array of arrays. For any two subarrays
* $a and $b such that $a goes before $b in $expected, the method
* asserts that any element of $a goes before any element of $b
* in the sequence generated by $iterator
* @param \Traversable $iterator
*/
protected function assertOrderedIteratorForGroups($expected, \Traversable $iterator)
{
}
/**
* Same as IteratorTestCase::assertIterator with foreach usage.
*
* @param array $expected
* @param \Traversable $iterator
*/
protected function assertIteratorInForeach($expected, \Traversable $iterator)
{
}
/**
* Same as IteratorTestCase::assertOrderedIterator with foreach usage.
*
* @param array $expected
* @param \Traversable $iterator
*/
protected function assertOrderedIteratorInForeach($expected, \Traversable $iterator)
{
}
}
abstract class RealIteratorTestCase extends \Symfony\Component\Finder\Tests\Iterator\IteratorTestCase
{
protected static $tmpDir;
protected static $files;
public static function setUpBeforeClass()
{
}
public static function tearDownAfterClass()
{
}
protected static function toAbsolute($files = null)
{
}
protected static function toAbsoluteFixtures($files)
{
}
}
}
namespace Symfony\Component\Finder\Tests {
class FinderTest extends \Symfony\Component\Finder\Tests\Iterator\RealIteratorTestCase
{
public function testCreate()
{
}
public function testDirectories()
{
}
public function testFiles()
{
}
public function testDepth()
{
}
public function testName()
{
}
public function testNotName()
{
}
/**
* @dataProvider getRegexNameTestData
*/
public function testRegexName($regex)
{
}
public function testSize()
{
}
public function testDate()
{
}
public function testExclude()
{
}
public function testIgnoreVCS()
{
}
public function testIgnoreDotFiles()
{
}
public function testSortByName()
{
}
public function testSortByType()
{
}
public function testSortByAccessedTime()
{
}
public function testSortByChangedTime()
{
}
public function testSortByModifiedTime()
{
}
public function testSort()
{
}
public function testFilter()
{
}
public function testFollowLinks()
{
}
public function testIn()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testInWithNonExistentDirectory()
{
}
public function testInWithGlob()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testInWithNonDirectoryGlob()
{
}
public function testInWithGlobBrace()
{
}
/**
* @expectedException \LogicException
*/
public function testGetIteratorWithoutIn()
{
}
public function testGetIterator()
{
}
public function testRelativePath()
{
}
public function testRelativePathname()
{
}
public function testAppendWithAFinder()
{
}
public function testAppendWithAnArray()
{
}
public function testAppendReturnsAFinder()
{
}
public function testAppendDoesNotRequireIn()
{
}
public function testCountDirectories()
{
}
public function testCountFiles()
{
}
/**
* @expectedException \LogicException
*/
public function testCountWithoutIn()
{
}
/**
* @dataProvider getContainsTestData
*/
public function testContains($matchPatterns, $noMatchPatterns, $expected)
{
}
public function testContainsOnDirectory()
{
}
public function testNotContainsOnDirectory()
{
}
/**
* Searching in multiple locations involves AppendIterator which does an unnecessary rewind which leaves FilterIterator
* with inner FilesystemIterator in an invalid state.
*
* @see https://bugs.php.net/68557
*/
public function testMultipleLocations()
{
}
/**
* Searching in multiple locations with sub directories involves
* AppendIterator which does an unnecessary rewind which leaves
* FilterIterator with inner FilesystemIterator in an invalid state.
*
* @see https://bugs.php.net/68557
*/
public function testMultipleLocationsWithSubDirectories()
{
}
/**
* Iterator keys must be the file pathname.
*/
public function testIteratorKeys()
{
}
public function testRegexSpecialCharsLocationWithPathRestrictionContainingStartFlag()
{
}
/**
* @group legacy
*/
public function testAdaptersOrdering()
{
}
/**
* @group legacy
*/
public function testAdaptersChaining()
{
}
public function getContainsTestData()
{
}
public function getRegexNameTestData()
{
}
/**
* @dataProvider getTestPathData
*/
public function testPath($matchPatterns, $noMatchPatterns, array $expected)
{
}
/**
* @group legacy
*/
public function testAdapterSelection()
{
}
public function getTestPathData()
{
}
public function testAccessDeniedException()
{
}
public function testIgnoredAccessDeniedException()
{
}
protected function buildFinder()
{
}
}
/**
* @group legacy
*/
class PhpFinderTest extends \Symfony\Component\Finder\Tests\FinderTest
{
public function testImplementationsAreSynchronized()
{
}
protected function buildFinder()
{
}
}
}
namespace Symfony\Component\Finder\Adapter {
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
interface AdapterInterface
{
/**
* @param bool $followLinks
*
* @return AdapterInterface Current instance
*/
public function setFollowLinks($followLinks);
/**
* @param int $mode
*
* @return AdapterInterface Current instance
*/
public function setMode($mode);
/**
* @param array $exclude
*
* @return AdapterInterface Current instance
*/
public function setExclude(array $exclude);
/**
* @param array $depths
*
* @return AdapterInterface Current instance
*/
public function setDepths(array $depths);
/**
* @param array $names
*
* @return AdapterInterface Current instance
*/
public function setNames(array $names);
/**
* @param array $notNames
*
* @return AdapterInterface Current instance
*/
public function setNotNames(array $notNames);
/**
* @param array $contains
*
* @return AdapterInterface Current instance
*/
public function setContains(array $contains);
/**
* @param array $notContains
*
* @return AdapterInterface Current instance
*/
public function setNotContains(array $notContains);
/**
* @param array $sizes
*
* @return AdapterInterface Current instance
*/
public function setSizes(array $sizes);
/**
* @param array $dates
*
* @return AdapterInterface Current instance
*/
public function setDates(array $dates);
/**
* @param array $filters
*
* @return AdapterInterface Current instance
*/
public function setFilters(array $filters);
/**
* @param \Closure|int $sort
*
* @return AdapterInterface Current instance
*/
public function setSort($sort);
/**
* @param array $paths
*
* @return AdapterInterface Current instance
*/
public function setPath(array $paths);
/**
* @param array $notPaths
*
* @return AdapterInterface Current instance
*/
public function setNotPath(array $notPaths);
/**
* @param bool $ignore
*
* @return AdapterInterface Current instance
*/
public function ignoreUnreadableDirs($ignore = true);
/**
* @param string $dir
*
* @return \Iterator Result iterator
*/
public function searchInDirectory($dir);
/**
* Tests adapter support for current platform.
*
* @return bool
*/
public function isSupported();
/**
* Returns adapter name.
*
* @return string
*/
public function getName();
}
/**
* Interface for finder engine implementations.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
*/
abstract class AbstractAdapter implements \Symfony\Component\Finder\Adapter\AdapterInterface
{
protected $followLinks = false;
protected $mode = 0;
protected $minDepth = 0;
protected $maxDepth = PHP_INT_MAX;
protected $exclude = array();
protected $names = array();
protected $notNames = array();
protected $contains = array();
protected $notContains = array();
protected $sizes = array();
protected $dates = array();
protected $filters = array();
protected $sort = false;
protected $paths = array();
protected $notPaths = array();
protected $ignoreUnreadableDirs = false;
/**
* {@inheritdoc}
*/
public function isSupported()
{
}
/**
* {@inheritdoc}
*/
public function setFollowLinks($followLinks)
{
}
/**
* {@inheritdoc}
*/
public function setMode($mode)
{
}
/**
* {@inheritdoc}
*/
public function setDepths(array $depths)
{
}
/**
* {@inheritdoc}
*/
public function setExclude(array $exclude)
{
}
/**
* {@inheritdoc}
*/
public function setNames(array $names)
{
}
/**
* {@inheritdoc}
*/
public function setNotNames(array $notNames)
{
}
/**
* {@inheritdoc}
*/
public function setContains(array $contains)
{
}
/**
* {@inheritdoc}
*/
public function setNotContains(array $notContains)
{
}
/**
* {@inheritdoc}
*/
public function setSizes(array $sizes)
{
}
/**
* {@inheritdoc}
*/
public function setDates(array $dates)
{
}
/**
* {@inheritdoc}
*/
public function setFilters(array $filters)
{
}
/**
* {@inheritdoc}
*/
public function setSort($sort)
{
}
/**
* {@inheritdoc}
*/
public function setPath(array $paths)
{
}
/**
* {@inheritdoc}
*/
public function setNotPath(array $notPaths)
{
}
/**
* {@inheritdoc}
*/
public function ignoreUnreadableDirs($ignore = true)
{
}
/**
* Returns whether the adapter is supported in the current environment.
*
* This method should be implemented in all adapters. Do not implement
* isSupported in the adapters as the generic implementation provides a cache
* layer.
*
* @see isSupported()
*
* @return bool Whether the adapter is supported
*/
protected abstract function canBeUsed();
}
}
namespace Symfony\Component\Finder\Tests\FakeAdapter {
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class DummyAdapter extends \Symfony\Component\Finder\Adapter\AbstractAdapter
{
/**
* @param \Iterator $iterator
*/
public function __construct(\Iterator $iterator)
{
}
/**
* {@inheritdoc}
*/
public function searchInDirectory($dir)
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
protected function canBeUsed()
{
}
}
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class NamedAdapter extends \Symfony\Component\Finder\Adapter\AbstractAdapter
{
/**
* @param string $name
*/
public function __construct($name)
{
}
/**
* {@inheritdoc}
*/
public function searchInDirectory($dir)
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
protected function canBeUsed()
{
}
}
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class UnsupportedAdapter extends \Symfony\Component\Finder\Adapter\AbstractAdapter
{
/**
* {@inheritdoc}
*/
public function searchInDirectory($dir)
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
protected function canBeUsed()
{
}
}
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class FailingAdapter extends \Symfony\Component\Finder\Adapter\AbstractAdapter
{
/**
* {@inheritdoc}
*/
public function searchInDirectory($dir)
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
protected function canBeUsed()
{
}
}
}
namespace Symfony\Component\Finder\Tests {
/**
* @group legacy
*/
class GnuFinderTest extends \Symfony\Component\Finder\Tests\FinderTest
{
protected function buildFinder()
{
}
}
}
namespace Symfony\Component\Finder\Tests\Shell {
/**
* @group legacy
*/
class CommandTest extends \PHPUnit_Framework_TestCase
{
public function testCreate()
{
}
public function testAdd()
{
}
public function testAddAsFirst()
{
}
public function testAddAsLast()
{
}
public function testAddInBetween()
{
}
public function testCount()
{
}
public function testTop()
{
}
public function testTopLabeled()
{
}
public function testArg()
{
}
public function testCmd()
{
}
public function testInsDuplicateLabelException()
{
}
public function testEnd()
{
}
public function testEndNoParentException()
{
}
public function testGetMissingLabelException()
{
}
public function testErrorHandler()
{
}
public function testExecute()
{
}
public function testCastToString()
{
}
}
}
namespace Symfony\Component\Finder\Tests\Comparator {
class NumberComparatorTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getConstructorTestData
*/
public function testConstructor($successes, $failures)
{
}
/**
* @dataProvider getTestData
*/
public function testTest($test, $match, $noMatch)
{
}
public function getTestData()
{
}
public function getConstructorTestData()
{
}
}
class ComparatorTest extends \PHPUnit_Framework_TestCase
{
public function testGetSetOperator()
{
}
public function testGetSetTarget()
{
}
/**
* @dataProvider getTestData
*/
public function testTest($operator, $target, $match, $noMatch)
{
}
public function getTestData()
{
}
}
class DateComparatorTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
/**
* @dataProvider getTestData
*/
public function testTest($test, $match, $noMatch)
{
}
public function getTestData()
{
}
}
}
namespace Symfony\Component\Finder\Tests {
/**
* @group legacy
*/
class BsdFinderTest extends \Symfony\Component\Finder\Tests\FinderTest
{
protected function buildFinder()
{
}
}
}
namespace Symfony\Component\Finder\Tests\Iterator {
class SortableIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\RealIteratorTestCase
{
public function testConstructor()
{
}
/**
* @dataProvider getAcceptData
*/
public function testAccept($mode, $expected)
{
}
public function getAcceptData()
{
}
}
class MockFileListIterator extends \ArrayIterator
{
public function __construct(array $filesArray = array())
{
}
}
class FileTypeFilterIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\RealIteratorTestCase
{
/**
* @dataProvider getAcceptData
*/
public function testAccept($mode, $expected)
{
}
public function getAcceptData()
{
}
}
class InnerTypeIterator extends \ArrayIterator
{
public function current()
{
}
public function isFile()
{
}
public function isDir()
{
}
}
class Iterator implements \Iterator
{
protected $values = array();
public function __construct(array $values = array())
{
}
public function attach(\SplFileInfo $fileinfo)
{
}
public function rewind()
{
}
public function valid()
{
}
public function next()
{
}
public function current()
{
}
public function key()
{
}
}
class MultiplePcreFilterIteratorTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getIsRegexFixtures
*/
public function testIsRegex($string, $isRegex, $message)
{
}
public function getIsRegexFixtures()
{
}
}
class TestMultiplePcreFilterIterator extends \Symfony\Component\Finder\Iterator\MultiplePcreFilterIterator
{
public function __construct()
{
}
public function accept()
{
}
public function isRegex($str)
{
}
public function toRegex($str)
{
}
}
class CustomFilterIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\IteratorTestCase
{
/**
* @expectedException \InvalidArgumentException
*/
public function testWithInvalidFilter()
{
}
/**
* @dataProvider getAcceptData
*/
public function testAccept($filters, $expected)
{
}
public function getAcceptData()
{
}
}
class FilenameFilterIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\IteratorTestCase
{
/**
* @dataProvider getAcceptData
*/
public function testAccept($matchPatterns, $noMatchPatterns, $expected)
{
}
public function getAcceptData()
{
}
}
class InnerNameIterator extends \ArrayIterator
{
public function current()
{
}
public function getFilename()
{
}
}
class DateRangeFilterIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\RealIteratorTestCase
{
/**
* @dataProvider getAcceptData
*/
public function testAccept($size, $expected)
{
}
public function getAcceptData()
{
}
}
class DepthRangeFilterIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\RealIteratorTestCase
{
/**
* @dataProvider getAcceptData
*/
public function testAccept($minDepth, $maxDepth, $expected)
{
}
public function getAcceptData()
{
}
}
class FilecontentFilterIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\IteratorTestCase
{
public function testAccept()
{
}
public function testDirectory()
{
}
public function testUnreadableFile()
{
}
/**
* @dataProvider getTestFilterData
*/
public function testFilter(\Iterator $inner, array $matchPatterns, array $noMatchPatterns, array $resultArray)
{
}
public function getTestFilterData()
{
}
}
class PathFilterIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\IteratorTestCase
{
/**
* @dataProvider getTestFilterData
*/
public function testFilter(\Iterator $inner, array $matchPatterns, array $noMatchPatterns, array $resultArray)
{
}
public function getTestFilterData()
{
}
}
class MockSplFileInfo extends \SplFileInfo
{
const TYPE_DIRECTORY = 1;
const TYPE_FILE = 2;
const TYPE_UNKNOWN = 3;
public function __construct($param)
{
}
public function isFile()
{
}
public function isDir()
{
}
public function isReadable()
{
}
public function getContents()
{
}
public function setContents($contents)
{
}
public function setMode($mode)
{
}
public function setType($type)
{
}
public function setRelativePath($relativePath)
{
}
public function setRelativePathname($relativePathname)
{
}
public function getRelativePath()
{
}
public function getRelativePathname()
{
}
}
class RecursiveDirectoryIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\IteratorTestCase
{
/**
* @group network
*/
public function testRewindOnFtp()
{
}
/**
* @group network
*/
public function testSeekOnFtp()
{
}
}
class SizeRangeFilterIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\RealIteratorTestCase
{
/**
* @dataProvider getAcceptData
*/
public function testAccept($size, $expected)
{
}
public function getAcceptData()
{
}
}
class InnerSizeIterator extends \ArrayIterator
{
public function current()
{
}
public function getFilename()
{
}
public function isFile()
{
}
public function getSize()
{
}
}
/**
* @author Alex Bogomazov
*/
class FilterIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\RealIteratorTestCase
{
public function testFilterFilesystemIterators()
{
}
}
class ExcludeDirectoryFilterIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\RealIteratorTestCase
{
/**
* @dataProvider getAcceptData
*/
public function testAccept($directories, $expected)
{
}
public function getAcceptData()
{
}
}
/**
* @group legacy
*/
class FilePathsIteratorTest extends \Symfony\Component\Finder\Tests\Iterator\RealIteratorTestCase
{
/**
* @dataProvider getSubPathData
*/
public function testSubPath($baseDir, array $paths, array $subPaths, array $subPathnames)
{
}
public function getSubPathData()
{
}
}
}
namespace Symfony\Component\Finder\Tests {
class GlobTest extends \PHPUnit_Framework_TestCase
{
public function testGlobToRegexDelimiters()
{
}
}
}
namespace Symfony\Component\Finder\Tests\Expression {
/**
* @group legacy
*/
class RegexTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getHasFlagsData
*/
public function testHasFlags($regex, $start, $end)
{
}
/**
* @dataProvider getHasJokersData
*/
public function testHasJokers($regex, $start, $end)
{
}
/**
* @dataProvider getSetFlagsData
*/
public function testSetFlags($regex, $start, $end, $expected)
{
}
/**
* @dataProvider getSetJokersData
*/
public function testSetJokers($regex, $start, $end, $expected)
{
}
public function testOptions()
{
}
public function testMixFlagsAndJokers()
{
}
/**
* @dataProvider getReplaceJokersTestData
*/
public function testReplaceJokers($regex, $expected)
{
}
public function getHasFlagsData()
{
}
public function getHasJokersData()
{
}
public function getSetFlagsData()
{
}
public function getSetJokersData()
{
}
public function getReplaceJokersTestData()
{
}
}
/**
* @group legacy
*/
class ExpressionTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getTypeGuesserData
*/
public function testTypeGuesser($expr, $type)
{
}
/**
* @dataProvider getCaseSensitiveData
*/
public function testCaseSensitive($expr, $isCaseSensitive)
{
}
/**
* @dataProvider getRegexRenderingData
*/
public function testRegexRendering($expr, $body)
{
}
public function getTypeGuesserData()
{
}
public function getCaseSensitiveData()
{
}
public function getRegexRenderingData()
{
}
}
/**
* @group legacy
*/
class GlobTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getToRegexData
*/
public function testGlobToRegex($glob, $match, $noMatch)
{
}
public function getToRegexData()
{
}
}
}
namespace Symfony\Component\Finder\Shell {
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class Shell
{
const TYPE_UNIX = 1;
const TYPE_DARWIN = 2;
const TYPE_CYGWIN = 3;
const TYPE_WINDOWS = 4;
const TYPE_BSD = 5;
/**
* Returns guessed OS type.
*
* @return int
*/
public function getType()
{
}
/**
* Tests if a command is available.
*
* @param string $command
*
* @return bool
*/
public function testCommand($command)
{
}
}
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class Command
{
/**
* Constructor.
*
* @param Command|null $parent Parent command
*/
public function __construct(\Symfony\Component\Finder\Shell\Command $parent = null)
{
}
/**
* Returns command as string.
*
* @return string
*/
public function __toString()
{
}
/**
* Creates a new Command instance.
*
* @param Command|null $parent Parent command
*
* @return Command New Command instance
*/
public static function create(\Symfony\Component\Finder\Shell\Command $parent = null)
{
}
/**
* Escapes special chars from input.
*
* @param string $input A string to escape
*
* @return string The escaped string
*/
public static function escape($input)
{
}
/**
* Quotes input.
*
* @param string $input An argument string
*
* @return string The quoted string
*/
public static function quote($input)
{
}
/**
* Appends a string or a Command instance.
*
* @param string|Command $bit
*
* @return Command The current Command instance
*/
public function add($bit)
{
}
/**
* Prepends a string or a command instance.
*
* @param string|Command $bit
*
* @return Command The current Command instance
*/
public function top($bit)
{
}
/**
* Appends an argument, will be quoted.
*
* @param string $arg
*
* @return Command The current Command instance
*/
public function arg($arg)
{
}
/**
* Appends escaped special command chars.
*
* @param string $esc
*
* @return Command The current Command instance
*/
public function cmd($esc)
{
}
/**
* Inserts a labeled command to feed later.
*
* @param string $label The unique label
*
* @return Command The current Command instance
*
* @throws \RuntimeException If label already exists
*/
public function ins($label)
{
}
/**
* Retrieves a previously labeled command.
*
* @param string $label
*
* @return Command The labeled command
*
* @throws \RuntimeException
*/
public function get($label)
{
}
/**
* Returns parent command (if any).
*
* @return Command Parent command
*
* @throws \RuntimeException If command has no parent
*/
public function end()
{
}
/**
* Counts bits stored in command.
*
* @return int The bits count
*/
public function length()
{
}
/**
* @param \Closure $errorHandler
*
* @return Command
*/
public function setErrorHandler(\Closure $errorHandler)
{
}
/**
* @return \Closure|null
*/
public function getErrorHandler()
{
}
/**
* Executes current command.
*
* @return array The command result
*
* @throws \RuntimeException
*/
public function execute()
{
}
/**
* Joins bits.
*
* @return string
*/
public function join()
{
}
/**
* Insert a string or a Command instance before the bit at given position $index (index starts from 0).
*
* @param string|Command $bit
* @param int $index
*
* @return Command The current Command instance
*/
public function addAtIndex($bit, $index)
{
}
}
}
namespace Symfony\Component\Finder\Adapter {
/**
* Shell engine implementation using GNU find command.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
*/
abstract class AbstractFindAdapter extends \Symfony\Component\Finder\Adapter\AbstractAdapter
{
/**
* @var Shell
*/
protected $shell;
/**
* Constructor.
*/
public function __construct()
{
}
/**
* {@inheritdoc}
*/
public function searchInDirectory($dir)
{
}
/**
* {@inheritdoc}
*/
protected function canBeUsed()
{
}
/**
* @param Command $command
* @param string $dir
*
* @return Command
*/
protected function buildFindCommand(\Symfony\Component\Finder\Shell\Command $command, $dir)
{
}
/**
* @param Command $command
* @param string $sort
*/
protected abstract function buildFormatSorting(\Symfony\Component\Finder\Shell\Command $command, $sort);
/**
* @param Command $command
* @param array $contains
* @param bool $not
*/
protected abstract function buildContentFiltering(\Symfony\Component\Finder\Shell\Command $command, array $contains, $not = false);
}
/**
* Shell engine implementation using BSD find command.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
*/
class BsdFindAdapter extends \Symfony\Component\Finder\Adapter\AbstractFindAdapter
{
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
protected function canBeUsed()
{
}
/**
* {@inheritdoc}
*/
protected function buildFormatSorting(\Symfony\Component\Finder\Shell\Command $command, $sort)
{
}
/**
* {@inheritdoc}
*/
protected function buildFindCommand(\Symfony\Component\Finder\Shell\Command $command, $dir)
{
}
/**
* {@inheritdoc}
*/
protected function buildContentFiltering(\Symfony\Component\Finder\Shell\Command $command, array $contains, $not = false)
{
}
}
/**
* PHP finder engine implementation.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
*/
class PhpAdapter extends \Symfony\Component\Finder\Adapter\AbstractAdapter
{
/**
* {@inheritdoc}
*/
public function searchInDirectory($dir)
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
protected function canBeUsed()
{
}
}
/**
* Shell engine implementation using GNU find command.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0. Use Finder instead.
*/
class GnuFindAdapter extends \Symfony\Component\Finder\Adapter\AbstractFindAdapter
{
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
protected function buildFormatSorting(\Symfony\Component\Finder\Shell\Command $command, $sort)
{
}
/**
* {@inheritdoc}
*/
protected function canBeUsed()
{
}
/**
* {@inheritdoc}
*/
protected function buildFindCommand(\Symfony\Component\Finder\Shell\Command $command, $dir)
{
}
/**
* {@inheritdoc}
*/
protected function buildContentFiltering(\Symfony\Component\Finder\Shell\Command $command, array $contains, $not = false)
{
}
}
}
namespace Symfony\Component\Finder\Iterator {
/**
* Iterate over shell command result.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class FilePathsIterator extends \ArrayIterator
{
/**
* @param array $paths List of paths returned by shell command
* @param string $baseDir Base dir for relative path building
*/
public function __construct(array $paths, $baseDir)
{
}
/**
* @param string $name
* @param array $arguments
*
* @return mixed
*/
public function __call($name, array $arguments)
{
}
/**
* Return an instance of SplFileInfo with support for relative paths.
*
* @return SplFileInfo File information
*/
public function current()
{
}
/**
* @return string
*/
public function key()
{
}
public function next()
{
}
public function rewind()
{
}
/**
* @return string
*/
public function getSubPath()
{
}
/**
* @return string
*/
public function getSubPathname()
{
}
}
/**
* This iterator just overrides the rewind method in order to correct a PHP bug,
* which existed before version 5.5.23/5.6.7.
*
* @see https://bugs.php.net/68557
*
* @author Alex Bogomazov
*/
abstract class FilterIterator extends \FilterIterator
{
/**
* This is a workaround for the problem with \FilterIterator leaving inner \FilesystemIterator in wrong state after
* rewind in some cases.
*
* @see FilterIterator::rewind()
*/
public function rewind()
{
}
}
}
namespace Symfony\Component\Finder\Exception {
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*/
interface ExceptionInterface
{
/**
* @return \Symfony\Component\Finder\Adapter\AdapterInterface
*/
public function getAdapter();
}
/**
* Base exception for all adapter failures.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class AdapterFailureException extends \RuntimeException implements \Symfony\Component\Finder\Exception\ExceptionInterface
{
/**
* @param AdapterInterface $adapter
* @param string|null $message
* @param \Exception|null $previous
*/
public function __construct(\Symfony\Component\Finder\Adapter\AdapterInterface $adapter, $message = null, \Exception $previous = null)
{
}
/**
* {@inheritdoc}
*/
public function getAdapter()
{
}
}
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class OperationNotPermitedException extends \Symfony\Component\Finder\Exception\AdapterFailureException
{
}
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since 2.8, to be removed in 3.0.
*/
class ShellCommandFailureException extends \Symfony\Component\Finder\Exception\AdapterFailureException
{
/**
* @param AdapterInterface $adapter
* @param Command $command
* @param \Exception|null $previous
*/
public function __construct(\Symfony\Component\Finder\Adapter\AdapterInterface $adapter, \Symfony\Component\Finder\Shell\Command $command, \Exception $previous = null)
{
}
/**
* @return Command
*/
public function getCommand()
{
}
}
}
namespace Symfony\Component\Finder\Expression {
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*/
interface ValueInterface
{
/**
* Renders string representation of expression.
*
* @return string
*/
public function render();
/**
* Renders string representation of pattern.
*
* @return string
*/
public function renderPattern();
/**
* Returns value case sensitivity.
*
* @return bool
*/
public function isCaseSensitive();
/**
* Returns expression type.
*
* @return int
*/
public function getType();
/**
* @param string $expr
*
* @return ValueInterface
*/
public function prepend($expr);
/**
* @param string $expr
*
* @return ValueInterface
*/
public function append($expr);
}
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class Expression implements \Symfony\Component\Finder\Expression\ValueInterface
{
const TYPE_REGEX = 1;
const TYPE_GLOB = 2;
/**
* @param string $expr
*
* @return Expression
*/
public static function create($expr)
{
}
/**
* @param string $expr
*/
public function __construct($expr)
{
}
/**
* @return string
*/
public function __toString()
{
}
/**
* {@inheritdoc}
*/
public function render()
{
}
/**
* {@inheritdoc}
*/
public function renderPattern()
{
}
/**
* @return bool
*/
public function isCaseSensitive()
{
}
/**
* @return int
*/
public function getType()
{
}
/**
* {@inheritdoc}
*/
public function prepend($expr)
{
}
/**
* {@inheritdoc}
*/
public function append($expr)
{
}
/**
* @return bool
*/
public function isRegex()
{
}
/**
* @return bool
*/
public function isGlob()
{
}
/**
* @return Glob
*
* @throws \LogicException
*/
public function getGlob()
{
}
/**
* @return Regex
*/
public function getRegex()
{
}
}
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class Glob implements \Symfony\Component\Finder\Expression\ValueInterface
{
/**
* @param string $pattern
*/
public function __construct($pattern)
{
}
/**
* {@inheritdoc}
*/
public function render()
{
}
/**
* {@inheritdoc}
*/
public function renderPattern()
{
}
/**
* {@inheritdoc}
*/
public function getType()
{
}
/**
* {@inheritdoc}
*/
public function isCaseSensitive()
{
}
/**
* {@inheritdoc}
*/
public function prepend($expr)
{
}
/**
* {@inheritdoc}
*/
public function append($expr)
{
}
/**
* Tests if glob is expandable ("*.{a,b}" syntax).
*
* @return bool
*/
public function isExpandable()
{
}
/**
* @param bool $strictLeadingDot
* @param bool $strictWildcardSlash
*
* @return Regex
*/
public function toRegex($strictLeadingDot = true, $strictWildcardSlash = true)
{
}
}
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class Regex implements \Symfony\Component\Finder\Expression\ValueInterface
{
const START_FLAG = '^';
const END_FLAG = '$';
const BOUNDARY = '~';
const JOKER = '.*';
const ESCAPING = '\\';
/**
* @param string $expr
*
* @return Regex
*
* @throws \InvalidArgumentException
*/
public static function create($expr)
{
}
/**
* @param string $pattern
* @param string $options
* @param string $delimiter
*/
public function __construct($pattern, $options = '', $delimiter = null)
{
}
/**
* @return string
*/
public function __toString()
{
}
/**
* {@inheritdoc}
*/
public function render()
{
}
/**
* {@inheritdoc}
*/
public function renderPattern()
{
}
/**
* {@inheritdoc}
*/
public function isCaseSensitive()
{
}
/**
* {@inheritdoc}
*/
public function getType()
{
}
/**
* {@inheritdoc}
*/
public function prepend($expr)
{
}
/**
* {@inheritdoc}
*/
public function append($expr)
{
}
/**
* @param string $option
*
* @return bool
*/
public function hasOption($option)
{
}
/**
* @param string $option
*
* @return Regex
*/
public function addOption($option)
{
}
/**
* @param string $option
*
* @return Regex
*/
public function removeOption($option)
{
}
/**
* @param bool $startFlag
*
* @return Regex
*/
public function setStartFlag($startFlag)
{
}
/**
* @return bool
*/
public function hasStartFlag()
{
}
/**
* @param bool $endFlag
*
* @return Regex
*/
public function setEndFlag($endFlag)
{
}
/**
* @return bool
*/
public function hasEndFlag()
{
}
/**
* @param bool $startJoker
*
* @return Regex
*/
public function setStartJoker($startJoker)
{
}
/**
* @return bool
*/
public function hasStartJoker()
{
}
/**
* @param bool $endJoker
*
* @return Regex
*/
public function setEndJoker($endJoker)
{
}
/**
* @return bool
*/
public function hasEndJoker()
{
}
/**
* @param array $replacement
*
* @return Regex
*/
public function replaceJokers($replacement)
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests {
class ContainerBuilderTest extends \PHPUnit_Framework_TestCase
{
public function testDefinitions()
{
}
/**
* @group legacy
* @expectedDeprecation The "deprecated_foo" service is deprecated. You should stop using it, as it will soon be removed.
*/
public function testCreateDeprecatedService()
{
}
public function testRegister()
{
}
public function testHas()
{
}
public function testGet()
{
}
public function testNonSharedServicesReturnsDifferentInstances()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage You have requested a synthetic service ("foo"). The DIC does not know how to construct this service.
*/
public function testGetUnsetLoadingServiceWhenCreateServiceThrowsAnException()
{
}
public function testGetServiceIds()
{
}
public function testAliases()
{
}
public function testGetAliases()
{
}
public function testSetAliases()
{
}
public function testAddAliases()
{
}
public function testSetReplacesAlias()
{
}
public function testAliasesKeepInvalidBehavior()
{
}
public function testAddGetCompilerPass()
{
}
public function testCreateService()
{
}
public function testCreateProxyWithRealServiceInstantiator()
{
}
public function testCreateServiceClass()
{
}
public function testCreateServiceArguments()
{
}
public function testCreateServiceFactory()
{
}
public function testCreateServiceMethodCalls()
{
}
public function testCreateServiceMethodCallsWithEscapedParam()
{
}
public function testCreateServiceProperties()
{
}
public function testCreateServiceConfigurator()
{
}
/**
* @expectedException \RuntimeException
*/
public function testCreateSyntheticService()
{
}
public function testCreateServiceWithExpression()
{
}
public function testResolveServices()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage Constructing service "foo" from a parent definition is not supported at build time.
*/
public function testResolveServicesWithDecoratedDefinition()
{
}
public function testResolveServicesWithCustomDefinitionClass()
{
}
public function testMerge()
{
}
/**
* @expectedException \LogicException
*/
public function testMergeLogicException()
{
}
public function testfindTaggedServiceIds()
{
}
public function testFindUnusedTags()
{
}
public function testFindDefinition()
{
}
public function testAddObjectResource()
{
}
public function testAddClassResource()
{
}
public function testCompilesClassDefinitionsOfLazyServices()
{
}
public function testResources()
{
}
public function testExtension()
{
}
public function testRegisteredButNotLoadedExtension()
{
}
public function testRegisteredAndLoadedExtension()
{
}
public function testPrivateServiceUser()
{
}
/**
* @expectedException \BadMethodCallException
*/
public function testThrowsExceptionWhenSetServiceOnAFrozenContainer()
{
}
public function testThrowsExceptionWhenAddServiceOnAFrozenContainer()
{
}
public function testNoExceptionWhenSetSyntheticServiceOnAFrozenContainer()
{
}
/**
* @expectedException \BadMethodCallException
*/
public function testThrowsExceptionWhenSetDefinitionOnAFrozenContainer()
{
}
public function testExtensionConfig()
{
}
public function testAbstractAlias()
{
}
public function testLazyLoadedService()
{
}
public function testInitializePropertiesBeforeMethodCalls()
{
}
public function testAutowiring()
{
}
}
class FooClass
{
}
class A
{
}
class B
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\A $a)
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests\Dumper {
class PhpDumperTest extends \PHPUnit_Framework_TestCase
{
protected static $fixturesPath;
public static function setUpBeforeClass()
{
}
public function testDump()
{
}
public function testDumpOptimizationString()
{
}
public function testDumpRelativeDir()
{
}
/**
* @dataProvider provideInvalidParameters
* @expectedException \InvalidArgumentException
*/
public function testExportParameters($parameters)
{
}
public function provideInvalidParameters()
{
}
public function testAddParameters()
{
}
public function testAddService()
{
}
public function testServicesWithAnonymousFactories()
{
}
public function testAddServiceIdWithUnsupportedCharacters()
{
}
public function testConflictingServiceIds()
{
}
public function testConflictingMethodsWithParent()
{
}
/**
* @dataProvider provideInvalidFactories
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage Cannot dump definition
*/
public function testInvalidFactories($factory)
{
}
public function provideInvalidFactories()
{
}
public function testAliases()
{
}
public function testFrozenContainerWithoutAliases()
{
}
public function testOverrideServiceWhenUsingADumpedContainer()
{
}
public function testOverrideServiceWhenUsingADumpedContainerAndServiceIsUsedFromAnotherOne()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException
*/
public function testCircularReference()
{
}
public function testDumpAutowireData()
{
}
public function testInlinedDefinitionReferencingServiceContainer()
{
}
public function testInitializePropertiesBeforeMethodCalls()
{
}
public function testCircularReferenceAllowanceForLazyServices()
{
}
public function testCircularReferenceAllowanceForInlinedDefinitionsForLazyServices()
{
}
}
class YamlDumperTest extends \PHPUnit_Framework_TestCase
{
protected static $fixturesPath;
public static function setUpBeforeClass()
{
}
public function testDump()
{
}
public function testAddParameters()
{
}
public function testAddService()
{
}
public function testDumpAutowireData()
{
}
}
class GraphvizDumperTest extends \PHPUnit_Framework_TestCase
{
protected static $fixturesPath;
public static function setUpBeforeClass()
{
}
public function testDump()
{
}
public function testDumpWithFrozenContainer()
{
}
public function testDumpWithFrozenCustomClassContainer()
{
}
public function testDumpWithUnresolvedParameter()
{
}
}
class XmlDumperTest extends \PHPUnit_Framework_TestCase
{
protected static $fixturesPath;
public static function setUpBeforeClass()
{
}
public function testDump()
{
}
public function testExportParameters()
{
}
public function testAddParameters()
{
}
public function testAddService()
{
}
public function testDumpAnonymousServices()
{
}
public function testDumpEntities()
{
}
/**
* @dataProvider provideDecoratedServicesData
*/
public function testDumpDecoratedServices($expectedXmlDump, $container)
{
}
public function provideDecoratedServicesData()
{
}
/**
* @dataProvider provideCompiledContainerData
*/
public function testCompiledContainerCanBeDumped($containerFile)
{
}
public function provideCompiledContainerData()
{
}
public function testDumpInlinedServices()
{
}
public function testDumpAutowireData()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests {
class ReferenceTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testCaseInsensitive()
{
}
}
class DefinitionDecoratorTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
/**
* @dataProvider getPropertyTests
*/
public function testSetProperty($property, $changeKey)
{
}
public function getPropertyTests()
{
}
public function testSetPublic()
{
}
public function testSetLazy()
{
}
public function testSetAutowired()
{
}
public function testSetArgument()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testReplaceArgumentShouldRequireIntegerIndex()
{
}
public function testReplaceArgument()
{
}
/**
* @expectedException \OutOfBoundsException
*/
public function testGetArgumentShouldCheckBounds()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests\Loader {
class XmlFileLoaderTest extends \PHPUnit_Framework_TestCase
{
protected static $fixturesPath;
public static function setUpBeforeClass()
{
}
public function testLoad()
{
}
public function testParseFile()
{
}
public function testLoadWithExternalEntitiesDisabled()
{
}
public function testLoadParameters()
{
}
public function testLoadImports()
{
}
public function testLoadAnonymousServices()
{
}
public function testLoadServices()
{
}
public function testParsesTags()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
*/
public function testParseTagsWithoutNameThrowsException()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
* @expectedExceptionMessageRegExp /The tag name for service ".+" in .* must be a non-empty string/
*/
public function testParseTagWithEmptyNameThrowsException()
{
}
public function testDeprecated()
{
}
public function testConvertDomElementToArray()
{
}
public function testExtensions()
{
}
public function testExtensionInPhar()
{
}
public function testSupports()
{
}
public function testNoNamingConflictsForAnonymousServices()
{
}
public function testDocTypeIsNotAllowed()
{
}
public function testXmlNamespaces()
{
}
public function testLoadIndexedArguments()
{
}
public function testLoadInlinedServices()
{
}
public function testType()
{
}
public function testAutowire()
{
}
/**
* @group legacy
* @expectedDeprecation Using the attribute "class" is deprecated for the service "bar" which is defined as an alias %s.
* @expectedDeprecation Using the element "tag" is deprecated for the service "bar" which is defined as an alias %s.
* @expectedDeprecation Using the element "factory" is deprecated for the service "bar" which is defined as an alias %s.
*/
public function testAliasDefinitionContainsUnsupportedElements()
{
}
public function testArgumentWithKeyOutsideCollection()
{
}
}
class IniFileLoaderTest extends \PHPUnit_Framework_TestCase
{
protected static $fixturesPath;
protected $container;
protected $loader;
public static function setUpBeforeClass()
{
}
protected function setUp()
{
}
public function testIniFileCanBeLoaded()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The file "foo.ini" does not exist (in:
*/
public function testExceptionIsRaisedWhenIniFileDoesNotExist()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The "nonvalid.ini" file is not valid.
*/
public function testExceptionIsRaisedWhenIniFileCannotBeParsed()
{
}
public function testSupports()
{
}
}
class YamlFileLoaderTest extends \PHPUnit_Framework_TestCase
{
protected static $fixturesPath;
public static function setUpBeforeClass()
{
}
public function testLoadFile()
{
}
/**
* @dataProvider provideInvalidFiles
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
*/
public function testLoadInvalidFile($file)
{
}
public function provideInvalidFiles()
{
}
public function testLoadParameters()
{
}
public function testLoadImports()
{
}
public function testLoadServices()
{
}
public function testLoadFactoryShortSyntax()
{
}
public function testExtensions()
{
}
public function testSupports()
{
}
public function testNonArrayTagsThrowsException()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
* @expectedExceptionMessage A "tags" entry must be an array for service
*/
public function testNonArrayTagThrowsException()
{
}
public function testTagWithoutNameThrowsException()
{
}
public function testTagWithAttributeArrayThrowsException()
{
}
public function testLoadYamlOnlyWithKeys()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
* @expectedExceptionMessageRegExp /The tag name for service ".+" in .+ must be a non-empty string/
*/
public function testTagWithEmptyNameThrowsException()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
* @expectedExceptionMessageREgExp /The tag name for service "\.+" must be a non-empty string/
*/
public function testTagWithNonStringNameThrowsException()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
*/
public function testTypesNotArray()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
*/
public function testTypeNotString()
{
}
public function testTypes()
{
}
public function testAutowire()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
* @expectedExceptionMessage The value of the "decorates" option for the "bar" service must be the id of the service without the "@" prefix (replace "@foo" with "foo").
*/
public function testDecoratedServicesWithWrongSyntaxThrowsException()
{
}
}
class DirectoryLoaderTest extends \PHPUnit_Framework_TestCase
{
public static function setUpBeforeClass()
{
}
protected function setUp()
{
}
public function testDirectoryCanBeLoadedRecursively()
{
}
public function testImports()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The file "foo" does not exist (in:
*/
public function testExceptionIsRaisedWhenDirectoryDoesNotExist()
{
}
public function testSupports()
{
}
}
class PhpFileLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testSupports()
{
}
public function testLoad()
{
}
}
class ClosureLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testSupports()
{
}
public function testLoad()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests {
class ContainerTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
/**
* @dataProvider dataForTestCamelize
*/
public function testCamelize($id, $expected)
{
}
public function dataForTestCamelize()
{
}
/**
* @dataProvider dataForTestUnderscore
*/
public function testUnderscore($id, $expected)
{
}
public function dataForTestUnderscore()
{
}
public function testCompile()
{
}
public function testIsFrozen()
{
}
public function testGetParameterBag()
{
}
public function testGetSetParameter()
{
}
public function testGetServiceIds()
{
}
public function testSet()
{
}
public function testSetWithNullResetTheService()
{
}
public function testSetReplacesAlias()
{
}
public function testGet()
{
}
public function testGetThrowServiceNotFoundException()
{
}
public function testGetCircularReference()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage You have requested a synthetic service ("request"). The DIC does not know how to construct this service.
*/
public function testGetSyntheticServiceAlwaysThrows()
{
}
public function testHas()
{
}
public function testInitialized()
{
}
public function testReset()
{
}
/**
* @expectedException \Exception
* @expectedExceptionMessage Something went terribly wrong!
*/
public function testGetThrowsException()
{
}
public function testGetThrowsExceptionOnServiceConfiguration()
{
}
protected function getField($obj, $field)
{
}
public function testAlias()
{
}
public function testThatCloningIsNotSupported()
{
}
}
class ProjectServiceContainer extends \Symfony\Component\DependencyInjection\Container
{
public $__bar;
public $__foo_bar;
public $__foo_baz;
public function __construct()
{
}
protected function getBarService()
{
}
protected function getFooBarService()
{
}
protected function getFoo_BazService()
{
}
protected function getCircularService()
{
}
protected function getThrowExceptionService()
{
}
protected function getThrowsExceptionOnServiceConfigurationService()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests\Extension {
class ExtensionTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getResolvedEnabledFixtures
*/
public function testIsConfigEnabledReturnsTheResolvedValue($enabled)
{
}
public function getResolvedEnabledFixtures()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
* @expectedExceptionMessage The config array has no 'enabled' key.
*/
public function testIsConfigEnabledOnNonEnableableConfig()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests\Fixtures {
class CustomDefinition extends \Symfony\Component\DependencyInjection\Definition
{
}
}
namespace Bar {
class FooClass
{
public $foo;
public $moo;
public $bar = null;
public $initialized = false;
public $configured = false;
public $called = false;
public $arguments = array();
public function __construct($arguments = array())
{
}
public static function getInstance($arguments = array())
{
}
public function initialize()
{
}
public function configure()
{
}
public function setBar($value = null)
{
}
}
}
namespace {
class ProjectExtension implements \Symfony\Component\DependencyInjection\Extension\ExtensionInterface
{
public function load(array $configs, \Symfony\Component\DependencyInjection\ContainerBuilder $configuration)
{
}
public function getXsdValidationBasePath()
{
}
public function getNamespace()
{
}
public function getAlias()
{
}
public function getConfiguration(array $config, \Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
class ProjectWithXsdExtension extends \ProjectExtension
{
public function getXsdValidationBasePath()
{
}
public function getNamespace()
{
}
public function getAlias()
{
}
}
class BarClass
{
protected $baz;
public $foo = 'foo';
public function setBaz(\BazClass $baz)
{
}
public function getBaz()
{
}
}
class BazClass
{
protected $foo;
public function setFoo(\Foo $foo)
{
}
public function configure($instance)
{
}
public static function getInstance()
{
}
public static function configureStatic($instance)
{
}
public static function configureStatic1()
{
}
}
class BarUserClass
{
public $bar;
public function __construct(\BarClass $bar)
{
}
}
class MethodCallClass
{
public $simple;
public $complex;
public function callMe()
{
}
public function callPassed()
{
}
}
class DummyProxyDumper implements \Symfony\Component\DependencyInjection\LazyProxy\PhpDumper\DumperInterface
{
public function isProxyCandidate(\Symfony\Component\DependencyInjection\Definition $definition)
{
}
public function getProxyFactoryCode(\Symfony\Component\DependencyInjection\Definition $definition, $id)
{
}
public function getProxyCode(\Symfony\Component\DependencyInjection\Definition $definition)
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests\Fixtures\includes {
class FooVariadic
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\Foo $foo)
{
}
public function bar(...$arguments)
{
}
}
}
namespace {
/**
* ProjectServiceContainer.
*
* This class has been auto-generated
* by the Symfony Dependency Injection Component.
*/
class ProjectServiceContainer extends \Symfony\Component\DependencyInjection\Container
{
/**
* Constructor.
*/
public function __construct()
{
}
/**
* Gets the 'foo' service.
*
* This service is autowired.
*
* @return \Foo A Foo instance
*/
protected function getFooService()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Dump {
/**
* Container.
*
* This class has been auto-generated
* by the Symfony Dependency Injection Component.
*/
class Container extends \Symfony\Component\DependencyInjection\Dump\AbstractContainer
{
/**
* Constructor.
*/
public function __construct()
{
}
}
}
namespace Container14 {
class ProjectServiceContainer extends \Symfony\Component\DependencyInjection\ContainerBuilder
{
}
}
namespace Symfony\Component\DependencyInjection\Tests\Fixtures\containers {
class CustomContainer extends \Symfony\Component\DependencyInjection\Container
{
public function getBarService()
{
}
public function getFoobarService()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests {
class ParameterTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
}
class DefinitionTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testSetGetFactory()
{
}
public function testSetGetClass()
{
}
public function testSetGetDecoratedService()
{
}
public function testArguments()
{
}
public function testMethodCalls()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
* @expectedExceptionMessage Method name cannot be empty.
*/
public function testExceptionOnEmptyMethodCall()
{
}
public function testSetGetFile()
{
}
public function testSetIsShared()
{
}
public function testSetIsPublic()
{
}
public function testSetIsSynthetic()
{
}
public function testSetIsLazy()
{
}
public function testSetIsAbstract()
{
}
public function testSetIsDeprecated()
{
}
/**
* @dataProvider invalidDeprecationMessageProvider
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
*/
public function testSetDeprecatedWithInvalidDeprecationTemplate($message)
{
}
public function invalidDeprecationMessageProvider()
{
}
public function testSetGetConfigurator()
{
}
public function testClearTags()
{
}
public function testClearTag()
{
}
public function testTags()
{
}
public function testSetArgument()
{
}
/**
* @expectedException \OutOfBoundsException
*/
public function testGetArgumentShouldCheckBounds()
{
}
/**
* @expectedException \OutOfBoundsException
* @expectedExceptionMessage The index "1" is not in the range [0, 0].
*/
public function testReplaceArgumentShouldCheckBounds()
{
}
/**
* @expectedException \OutOfBoundsException
* @expectedExceptionMessage Cannot replace arguments if none have been configured yet.
*/
public function testReplaceArgumentWithoutExistingArgumentsShouldCheckBounds()
{
}
public function testSetGetProperties()
{
}
public function testSetProperty()
{
}
public function testAutowired()
{
}
public function testTypes()
{
}
}
class CrossCheckTest extends \PHPUnit_Framework_TestCase
{
protected static $fixturesPath;
public static function setUpBeforeClass()
{
}
/**
* @dataProvider crossCheckLoadersDumpers
*/
public function testCrossCheck($fixture, $type)
{
}
public function crossCheckLoadersDumpers()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests\Config {
class AutowireServiceResourceTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
public function testToString()
{
}
public function testSerializeUnserialize()
{
}
public function testIsFresh()
{
}
public function testIsFreshForDeletedResources()
{
}
public function testIsNotFreshChangedResource()
{
}
public function testIsFreshSameConstructorArgs()
{
}
public function testNotFreshIfClassNotFound()
{
}
protected function tearDown()
{
}
}
class Foo
{
public function __construct($foo)
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests\LazyProxy\Instantiator {
/**
* Tests for {@see \Symfony\Component\DependencyInjection\Instantiator\RealServiceInstantiator}.
*
* @author Marco Pivetta <ocramius@gmail.com>
*/
class RealServiceInstantiatorTest extends \PHPUnit_Framework_TestCase
{
public function testInstantiateProxy()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests\LazyProxy\PhpDumper {
/**
* Tests for {@see \Symfony\Component\DependencyInjection\PhpDumper\NullDumper}.
*
* @author Marco Pivetta <ocramius@gmail.com>
*/
class NullDumperTest extends \PHPUnit_Framework_TestCase
{
public function testNullDumper()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests\Compiler {
class CheckExceptionOnInvalidReferenceBehaviorPassTest extends \PHPUnit_Framework_TestCase
{
public function testProcess()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException
*/
public function testProcessThrowsExceptionOnInvalidReference()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException
*/
public function testProcessThrowsExceptionOnInvalidReferenceFromInlinedDefinition()
{
}
}
class MergeExtensionConfigurationPassTest extends \PHPUnit_Framework_TestCase
{
public function testExpressionLanguageProviderForwarding()
{
}
}
class OptionalServiceClass extends \Symfony\Bug\NotExistClass
{
}
class ResolveInvalidReferencesPassTest extends \PHPUnit_Framework_TestCase
{
public function testProcess()
{
}
public function testProcessIgnoreInvalidArgumentInCollectionArgument()
{
}
public function testProcessKeepMethodCallOnInvalidArgumentInCollectionArgument()
{
}
public function testProcessIgnoreNonExistentServices()
{
}
public function testProcessRemovesPropertiesOnInvalid()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
class AnalyzeServiceReferencesPassTest extends \PHPUnit_Framework_TestCase
{
public function testProcess()
{
}
public function testProcessDetectsReferencesFromInlinedDefinitions()
{
}
public function testProcessDetectsReferencesFromInlinedFactoryDefinitions()
{
}
public function testProcessDoesNotSaveDuplicateReferences()
{
}
public function testProcessDetectsFactoryReferences()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
class RemoveUnusedDefinitionsPassTest extends \PHPUnit_Framework_TestCase
{
public function testProcess()
{
}
public function testProcessRemovesUnusedDefinitionsRecursively()
{
}
public function testProcessWorksWithInlinedDefinitions()
{
}
public function testProcessWontRemovePrivateFactory()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
class InlineServiceDefinitionsPassTest extends \PHPUnit_Framework_TestCase
{
public function testProcess()
{
}
public function testProcessDoesNotInlinesWhenAliasedServiceIsShared()
{
}
public function testProcessDoesInlineNonSharedService()
{
}
public function testProcessInlinesIfMultipleReferencesButAllFromTheSameDefinition()
{
}
public function testProcessInlinesPrivateFactoryReference()
{
}
public function testProcessDoesNotInlinePrivateFactoryIfReferencedMultipleTimesWithinTheSameDefinition()
{
}
public function testProcessDoesNotInlineReferenceWhenUsedByInlineFactory()
{
}
public function testProcessDoesNotInlineWhenServiceIsPrivateButLazy()
{
}
public function testProcessDoesNotInlineWhenServiceReferencesItself()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
/**
* @author Wouter J <wouter@wouterj.nl>
*/
class ExtensionCompilerPassTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
public function testProcess()
{
}
}
class DecoratorServicePassTest extends \PHPUnit_Framework_TestCase
{
public function testProcessWithoutAlias()
{
}
public function testProcessWithAlias()
{
}
public function testProcessWithPriority()
{
}
public function testProcessMovesTagsFromDecoratedDefinitionToDecoratingDefinition()
{
}
public function testProcessMergesAutowiringTypesInDecoratingDefinitionAndRemoveThemFromDecoratedDefinition()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
class CheckDefinitionValidityPassTest extends \PHPUnit_Framework_TestCase
{
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
*/
public function testProcessDetectsSyntheticNonPublicDefinitions()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
*/
public function testProcessDetectsNonSyntheticNonAbstractDefinitionWithoutClass()
{
}
public function testProcess()
{
}
public function testValidTags()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
*/
public function testInvalidTags()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
/**
* @author Kévin Dunglas <dunglas@gmail.com>
*/
class AutowirePassTest extends \PHPUnit_Framework_TestCase
{
public function testProcess()
{
}
/**
* @requires PHP 5.6
*/
public function testProcessVariadic()
{
}
public function testProcessAutowireParent()
{
}
public function testProcessAutowireInterface()
{
}
public function testCompleteExistingDefinition()
{
}
public function testCompleteExistingDefinitionWithNotDefinedArguments()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage Unable to autowire argument of type "Symfony\Component\DependencyInjection\Tests\Compiler\CollisionInterface" for the service "a". Multiple services exist for this interface (c1, c2, c3).
*/
public function testTypeCollision()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage Unable to autowire argument of type "Symfony\Component\DependencyInjection\Tests\Compiler\Foo" for the service "a". Multiple services exist for this class (a1, a2).
*/
public function testTypeNotGuessable()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage Unable to autowire argument of type "Symfony\Component\DependencyInjection\Tests\Compiler\A" for the service "a". Multiple services exist for this class (a1, a2).
*/
public function testTypeNotGuessableWithSubclass()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage Unable to autowire argument of type "Symfony\Component\DependencyInjection\Tests\Compiler\CollisionInterface" for the service "a". No services were found matching this interface and it cannot be auto-registered.
*/
public function testTypeNotGuessableNoServicesFound()
{
}
public function testTypeNotGuessableWithTypeSet()
{
}
public function testWithTypeSet()
{
}
public function testCreateDefinition()
{
}
public function testResolveParameter()
{
}
public function testOptionalParameter()
{
}
public function testDontTriggerAutowiring()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage Cannot autowire argument 2 for Symfony\Component\DependencyInjection\Tests\Compiler\BadTypeHintedArgument because the type-hinted class does not exist (Class Symfony\Component\DependencyInjection\Tests\Compiler\NotARealClass does not exist).
*/
public function testClassNotFoundThrowsException()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage Cannot autowire argument 2 for Symfony\Component\DependencyInjection\Tests\Compiler\BadParentTypeHintedArgument because the type-hinted class does not exist (Class Symfony\Component\DependencyInjection\Tests\Compiler\OptionalServiceClass does not exist).
*/
public function testParentClassNotFoundThrowsException()
{
}
public function testDontUseAbstractServices()
{
}
public function testSomeSpecificArgumentsAreSet()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage Unable to autowire argument index 1 ($foo) for the service "arg_no_type_hint". If this is an object, give it a type-hint. Otherwise, specify this argument's value explicitly.
*/
public function testScalarArgsCannotBeAutowired()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\RuntimeException
* @expectedExceptionMessage Unable to autowire argument index 1 ($foo) for the service "not_really_optional_scalar". If this is an object, give it a type-hint. Otherwise, specify this argument's value explicitly.
*/
public function testOptionalScalarNotReallyOptionalThrowException()
{
}
public function testOptionalScalarArgsDontMessUpOrder()
{
}
public function testOptionalScalarArgsNotPassedIfLast()
{
}
/**
* @dataProvider getCreateResourceTests
*/
public function testCreateResourceForClass($className, $isEqual)
{
}
public function getCreateResourceTests()
{
}
public function testIgnoreServiceWithClassNotExisting()
{
}
public function testEmptyStringIsKept()
{
}
}
class Foo
{
}
class Bar
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\Foo $foo)
{
}
}
class A
{
}
class B extends \Symfony\Component\DependencyInjection\Tests\Compiler\A
{
}
class C
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\A $a)
{
}
}
interface DInterface
{
}
interface EInterface extends \Symfony\Component\DependencyInjection\Tests\Compiler\DInterface
{
}
interface IInterface
{
}
class I implements \Symfony\Component\DependencyInjection\Tests\Compiler\IInterface
{
}
class F extends \Symfony\Component\DependencyInjection\Tests\Compiler\I implements \Symfony\Component\DependencyInjection\Tests\Compiler\EInterface
{
}
class G
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\DInterface $d, \Symfony\Component\DependencyInjection\Tests\Compiler\EInterface $e, \Symfony\Component\DependencyInjection\Tests\Compiler\IInterface $i)
{
}
}
class H
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\B $b, \Symfony\Component\DependencyInjection\Tests\Compiler\DInterface $d)
{
}
}
interface CollisionInterface
{
}
class CollisionA implements \Symfony\Component\DependencyInjection\Tests\Compiler\CollisionInterface
{
}
class CollisionB implements \Symfony\Component\DependencyInjection\Tests\Compiler\CollisionInterface
{
}
class CannotBeAutowired
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\CollisionInterface $collision)
{
}
}
class Lille
{
}
class Dunglas
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\Lille $l)
{
}
}
class LesTilleuls
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\Dunglas $k)
{
}
}
class OptionalParameter
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\CollisionInterface $c = null, \Symfony\Component\DependencyInjection\Tests\Compiler\A $a, \Symfony\Component\DependencyInjection\Tests\Compiler\Foo $f = null)
{
}
}
class BadTypeHintedArgument
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\Dunglas $k, \Symfony\Component\DependencyInjection\Tests\Compiler\NotARealClass $r)
{
}
}
class BadParentTypeHintedArgument
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\Dunglas $k, \Symfony\Component\DependencyInjection\Tests\Compiler\OptionalServiceClass $r)
{
}
}
class NotGuessableArgument
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\Foo $k)
{
}
}
class NotGuessableArgumentForSubclass
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\A $k)
{
}
}
class MultipleArguments
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\A $k, $foo, \Symfony\Component\DependencyInjection\Tests\Compiler\Dunglas $dunglas)
{
}
}
class MultipleArgumentsOptionalScalar
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\A $a, $foo = 'default_val', \Symfony\Component\DependencyInjection\Tests\Compiler\Lille $lille = null)
{
}
}
class MultipleArgumentsOptionalScalarLast
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\A $a, \Symfony\Component\DependencyInjection\Tests\Compiler\Lille $lille, $foo = 'some_val')
{
}
}
class MultipleArgumentsOptionalScalarNotReallyOptional
{
public function __construct(\Symfony\Component\DependencyInjection\Tests\Compiler\A $a, $foo = 'default_val', \Symfony\Component\DependencyInjection\Tests\Compiler\Lille $lille)
{
}
}
/*
* Classes used for testing createResourceForClass
*/
class ClassForResource
{
public function __construct($foo, \Symfony\Component\DependencyInjection\Tests\Compiler\Bar $bar = null)
{
}
public function setBar(\Symfony\Component\DependencyInjection\Tests\Compiler\Bar $bar)
{
}
}
class IdenticalClassResource extends \Symfony\Component\DependencyInjection\Tests\Compiler\ClassForResource
{
}
class ClassChangedConstructorArgs extends \Symfony\Component\DependencyInjection\Tests\Compiler\ClassForResource
{
public function __construct($foo, \Symfony\Component\DependencyInjection\Tests\Compiler\Bar $bar, $baz)
{
}
}
class CheckCircularReferencesPassTest extends \PHPUnit_Framework_TestCase
{
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException
*/
public function testProcess()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException
*/
public function testProcessWithAliases()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException
*/
public function testProcessWithFactory()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException
*/
public function testProcessDetectsIndirectCircularReference()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException
*/
public function testProcessDetectsIndirectCircularReferenceWithFactory()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException
*/
public function testDeepCircularReference()
{
}
public function testProcessIgnoresMethodCalls()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
class ResolveReferencesToAliasesPassTest extends \PHPUnit_Framework_TestCase
{
public function testProcess()
{
}
public function testProcessRecursively()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException
*/
public function testAliasCircularReference()
{
}
public function testResolveFactory()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
class ReplaceAliasByActualDefinitionPassTest extends \PHPUnit_Framework_TestCase
{
public function testProcess()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testProcessWithInvalidAlias()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
class AutoAliasServicePassTest extends \PHPUnit_Framework_TestCase
{
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\ParameterNotFoundException
*/
public function testProcessWithMissingParameter()
{
}
/**
* @expectedException \Symfony\Component\DependencyInjection\Exception\InvalidArgumentException
*/
public function testProcessWithMissingFormat()
{
}
public function testProcessWithNonExistingAlias()
{
}
public function testProcessWithExistingAlias()
{
}
public function testProcessWithManualAlias()
{
}
}
class ServiceClassDefault
{
}
class ServiceClassMysql extends \Symfony\Component\DependencyInjection\Tests\Compiler\ServiceClassDefault
{
}
class ServiceClassMariaDb extends \Symfony\Component\DependencyInjection\Tests\Compiler\ServiceClassMysql
{
}
class ResolveParameterPlaceHoldersPassTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
public function testClassParametersShouldBeResolved()
{
}
public function testFactoryParametersShouldBeResolved()
{
}
public function testArgumentParametersShouldBeResolved()
{
}
public function testMethodCallParametersShouldBeResolved()
{
}
public function testPropertyParametersShouldBeResolved()
{
}
public function testFileParametersShouldBeResolved()
{
}
public function testAliasParametersShouldBeResolved()
{
}
}
class CheckReferenceValidityPassTest extends \PHPUnit_Framework_TestCase
{
/**
* @expectedException \RuntimeException
*/
public function testProcessDetectsReferenceToAbstractDefinition()
{
}
public function testProcess()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
class ResolveDefinitionTemplatesPassTest extends \PHPUnit_Framework_TestCase
{
public function testProcess()
{
}
public function testProcessAppendsMethodCallsAlways()
{
}
public function testProcessDoesNotCopyAbstract()
{
}
public function testProcessDoesNotCopyShared()
{
}
public function testProcessDoesNotCopyTags()
{
}
public function testProcessDoesNotCopyDecoratedService()
{
}
public function testProcessDoesNotDropShared()
{
}
public function testProcessHandlesMultipleInheritance()
{
}
public function testSetLazyOnServiceHasParent()
{
}
public function testSetLazyOnServiceIsParent()
{
}
public function testSetAutowiredOnServiceHasParent()
{
}
public function testSetAutowiredOnServiceIsParent()
{
}
public function testDeepDefinitionsResolving()
{
}
public function testSetDecoratedServiceOnServiceHasParent()
{
}
public function testDecoratedServiceCopiesDeprecatedStatusFromParent()
{
}
public function testDecoratedServiceCanOverwriteDeprecatedParentStatus()
{
}
public function testProcessMergeAutowiringTypes()
{
}
public function testProcessResolvesAliases()
{
}
protected function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
/**
* This class tests the integration of the different compiler passes.
*/
class IntegrationTest extends \PHPUnit_Framework_TestCase
{
/**
* This tests that dependencies are correctly processed.
*
* We're checking that:
*
* * A is public, B/C are private
* * A -> C
* * B -> C
*/
public function testProcessRemovesAndInlinesRecursively()
{
}
public function testProcessInlinesReferencesToAliases()
{
}
public function testProcessInlinesWhenThereAreMultipleReferencesButFromTheSameDefinition()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Tests\ParameterBag {
class FrozenParameterBagTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
/**
* @expectedException \LogicException
*/
public function testClear()
{
}
/**
* @expectedException \LogicException
*/
public function testSet()
{
}
/**
* @expectedException \LogicException
*/
public function testAdd()
{
}
/**
* @expectedException \LogicException
*/
public function testRemove()
{
}
}
class ParameterBagTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testClear()
{
}
public function testRemove()
{
}
public function testGetSet()
{
}
public function testGetThrowParameterNotFoundException()
{
}
public function testHas()
{
}
public function testResolveValue()
{
}
public function testResolveIndicatesWhyAParameterIsNeeded()
{
}
public function testResolveUnescapesValue()
{
}
public function testEscapeValue()
{
}
/**
* @dataProvider stringsWithSpacesProvider
*/
public function testResolveStringWithSpacesReturnsString($expected, $test, $description)
{
}
public function stringsWithSpacesProvider()
{
}
}
}
namespace Symfony\Component\DependencyInjection {
/**
* ResettableContainerInterface defines additional resetting functionality
* for containers, allowing to release shared services when the container is
* not needed anymore.
*
* @author Christophe Coevoet <stof@notk.org>
*/
interface ResettableContainerInterface extends \Symfony\Component\DependencyInjection\ContainerInterface
{
/**
* Resets shared services from the container.
*
* The container is not intended to be used again after being reset in a normal workflow. This method is
* meant as a way to release references for ref-counting.
* A subsequent call to ContainerInterface::get will recreate a new instance of the shared service.
*/
public function reset();
}
/**
* This definition decorates another definition.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class DefinitionDecorator extends \Symfony\Component\DependencyInjection\Definition
{
/**
* @param string $parent The id of Definition instance to decorate
*/
public function __construct($parent)
{
}
/**
* Returns the Definition being decorated.
*
* @return string
*/
public function getParent()
{
}
/**
* Returns all changes tracked for the Definition object.
*
* @return array An array of changes for this Definition
*/
public function getChanges()
{
}
/**
* {@inheritdoc}
*/
public function setClass($class)
{
}
/**
* {@inheritdoc}
*/
public function setFactory($callable)
{
}
/**
* {@inheritdoc}
*/
public function setConfigurator($callable)
{
}
/**
* {@inheritdoc}
*/
public function setFile($file)
{
}
/**
* {@inheritdoc}
*/
public function setPublic($boolean)
{
}
/**
* {@inheritdoc}
*/
public function setLazy($boolean)
{
}
/**
* {@inheritdoc}
*/
public function setDecoratedService($id, $renamedId = null, $priority = 0)
{
}
/**
* {@inheritdoc}
*/
public function setDeprecated($boolean = true, $template = null)
{
}
/**
* {@inheritdoc}
*/
public function setAutowired($autowired)
{
}
/**
* Gets an argument to pass to the service constructor/factory method.
*
* If replaceArgument() has been used to replace an argument, this method
* will return the replacement value.
*
* @param int $index
*
* @return mixed The argument value
*
* @throws OutOfBoundsException When the argument does not exist
*/
public function getArgument($index)
{
}
/**
* You should always use this method when overwriting existing arguments
* of the parent definition.
*
* If you directly call setArguments() keep in mind that you must follow
* certain conventions when you want to overwrite the arguments of the
* parent definition, otherwise your arguments will only be appended.
*
* @param int $index
* @param mixed $value
*
* @return $this
*
* @throws InvalidArgumentException when $index isn't an integer
*/
public function replaceArgument($index, $value)
{
}
}
}
namespace Symfony\Component\DependencyInjection\Config {
class AutowireServiceResource implements \Symfony\Component\Config\Resource\SelfCheckingResourceInterface, \Serializable
{
public function __construct($class, $path, array $autowiringMetadata)
{
}
public function isFresh($timestamp)
{
}
public function __toString()
{
}
public function serialize()
{
}
public function unserialize($serialized)
{
}
/**
* @deprecated Implemented for compatibility with Symfony 2.8
*/
public function getResource()
{
}
}
}
namespace Symfony\Component\DependencyInjection\Compiler {
/**
* This replaces all DefinitionDecorator instances with their equivalent fully
* merged Definition instance.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
* @author Nicolas Grekas <p@tchwork.com>
*/
class ResolveDefinitionTemplatesPass implements \Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface
{
/**
* Process the ContainerBuilder to replace DefinitionDecorator instances with their real Definition instances.
*
* @param ContainerBuilder $container
*/
public function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
}
/**
* Interface that must be implemented by passes that are run as part of an
* RepeatedPass.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface RepeatablePassInterface extends \Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface
{
/**
* Sets the RepeatedPass interface.
*
* @param RepeatedPass $repeatedPass
*/
public function setRepeatedPass(\Symfony\Component\DependencyInjection\Compiler\RepeatedPass $repeatedPass);
}
/**
* Used to format logging messages during the compilation.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class LoggingFormatter
{
public function formatRemoveService(\Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface $pass, $id, $reason)
{
}
public function formatInlineService(\Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface $pass, $id, $target)
{
}
public function formatUpdateReference(\Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface $pass, $serviceId, $oldDestId, $newDestId)
{
}
public function formatResolveInheritance(\Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface $pass, $childId, $parentId)
{
}
public function format(\Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface $pass, $message)
{
}
}
/**
* A pass that might be run repeatedly.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class RepeatedPass implements \Symfony\Component\DependencyInjection\Compiler\CompilerPassInterface
{
/**
* @param RepeatablePassInterface[] $passes An array of RepeatablePassInterface objects
*
* @throws InvalidArgumentException when the passes don't implement RepeatablePassInterface
*/
public function __construct(array $passes)
{
}
/**
* Process the repeatable passes that run more than once.
*
* @param ContainerBuilder $container
*/
public function process(\Symfony\Component\DependencyInjection\ContainerBuilder $container)
{
}
/**
* Sets if the pass should repeat.
*/
public function setRepeat()
{
}
/**
* Returns the passes.
*
* @return RepeatablePassInterface[] An array of RepeatablePassInterface objects
*/
public function getPasses()
{
}
}
}
namespace Symfony\Component\Console {
/**
* A Shell wraps an Application to add shell capabilities to it.
*
* Support for history and completion only works with a PHP compiled
* with readline support (either --with-readline or --with-libedit)
*
* @deprecated since version 2.8, to be removed in 3.0.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Martin Hasoň <martin.hason@gmail.com>
*/
class Shell
{
/**
* Constructor.
*
* If there is no readline support for the current PHP executable
* a \RuntimeException exception is thrown.
*
* @param Application $application An application instance
*/
public function __construct(\Symfony\Component\Console\Application $application)
{
}
/**
* Runs the shell.
*/
public function run()
{
}
/**
* Returns the shell header.
*
* @return string The header string
*/
protected function getHeader()
{
}
/**
* Renders a prompt.
*
* @return string The prompt
*/
protected function getPrompt()
{
}
protected function getOutput()
{
}
protected function getApplication()
{
}
public function getProcessIsolation()
{
}
public function setProcessIsolation($processIsolation)
{
}
}
}
namespace Symfony\Component\Console\Tests\Output {
class ConsoleOutputTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
}
class StreamOutputTest extends \PHPUnit_Framework_TestCase
{
protected $stream;
protected function setUp()
{
}
protected function tearDown()
{
}
public function testConstructor()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The StreamOutput class needs a stream as its first argument.
*/
public function testStreamIsRequired()
{
}
public function testGetStream()
{
}
public function testDoWrite()
{
}
}
class NullOutputTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testVerbosity()
{
}
}
class OutputTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testSetIsDecorated()
{
}
public function testSetGetVerbosity()
{
}
public function testWriteWithVerbosityQuiet()
{
}
public function testWriteAnArrayOfMessages()
{
}
/**
* @dataProvider provideWriteArguments
*/
public function testWriteRawMessage($message, $type, $expectedOutput)
{
}
public function provideWriteArguments()
{
}
public function testWriteWithDecorationTurnedOff()
{
}
public function testWriteDecoratedMessage()
{
}
public function testWriteWithInvalidStyle()
{
}
/**
* @dataProvider verbosityProvider
*/
public function testWriteWithVerbosityOption($verbosity, $expected, $msg)
{
}
public function verbosityProvider()
{
}
}
class TestOutput extends \Symfony\Component\Console\Output\Output
{
public $output = '';
public function clear()
{
}
protected function doWrite($message, $newline)
{
}
}
}
namespace Symfony\Component\Console\Tests\Helper {
/**
* @group time-sensitive
*/
class ProgressBarTest extends \PHPUnit_Framework_TestCase
{
public function testMultipleStart()
{
}
public function testAdvance()
{
}
public function testAdvanceWithStep()
{
}
public function testAdvanceMultipleTimes()
{
}
public function testAdvanceOverMax()
{
}
public function testFormat()
{
}
public function testCustomizations()
{
}
public function testDisplayWithoutStart()
{
}
public function testDisplayWithQuietVerbosity()
{
}
public function testFinishWithoutStart()
{
}
public function testPercent()
{
}
public function testOverwriteWithShorterLine()
{
}
public function testStartWithMax()
{
}
public function testSetCurrentProgress()
{
}
/**
*/
public function testSetCurrentBeforeStarting()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage You can't regress the progress bar
*/
public function testRegressProgress()
{
}
public function testRedrawFrequency()
{
}
public function testRedrawFrequencyIsAtLeastOneIfZeroGiven()
{
}
public function testRedrawFrequencyIsAtLeastOneIfSmallerOneGiven()
{
}
public function testMultiByteSupport()
{
}
public function testClear()
{
}
public function testPercentNotHundredBeforeComplete()
{
}
public function testNonDecoratedOutput()
{
}
public function testNonDecoratedOutputWithClear()
{
}
public function testNonDecoratedOutputWithoutMax()
{
}
public function testParallelBars()
{
}
public function testWithoutMax()
{
}
public function testAddingPlaceholderFormatter()
{
}
public function testMultilineFormat()
{
}
public function testAnsiColorsAndEmojis()
{
}
public function testSetFormat()
{
}
/**
* @dataProvider provideFormat
*/
public function testFormatsWithoutMax($format)
{
}
/**
* Provides each defined format.
*
* @return array
*/
public function provideFormat()
{
}
protected function getOutputStream($decorated = true, $verbosity = \Symfony\Component\Console\Output\StreamOutput::VERBOSITY_NORMAL)
{
}
protected function generateOutput($expected)
{
}
}
/**
* @group time-sensitive
*/
class ProgressIndicatorTest extends \PHPUnit_Framework_TestCase
{
public function testDefaultIndicator()
{
}
public function testNonDecoratedOutput()
{
}
public function testCustomIndicatorValues()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage Must have at least 2 indicator value characters.
*/
public function testCannotSetInvalidIndicatorCharacters()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage Progress indicator already started.
*/
public function testCannotStartAlreadyStartedIndicator()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage Progress indicator has not yet been started.
*/
public function testCannotAdvanceUnstartedIndicator()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage Progress indicator has not yet been started.
*/
public function testCannotFinishUnstartedIndicator()
{
}
/**
* @dataProvider provideFormat
*/
public function testFormats($format)
{
}
/**
* Provides each defined format.
*
* @return array
*/
public function provideFormat()
{
}
protected function getOutputStream($decorated = true, $verbosity = \Symfony\Component\Console\Output\StreamOutput::VERBOSITY_NORMAL)
{
}
protected function generateOutput($expected)
{
}
}
/**
* @group tty
*/
class QuestionHelperTest extends \PHPUnit_Framework_TestCase
{
public function testAskChoice()
{
}
public function testAsk()
{
}
public function testAskWithAutocomplete()
{
}
public function testAskWithAutocompleteWithNonSequentialKeys()
{
}
public function testAskHiddenResponse()
{
}
/**
* @dataProvider getAskConfirmationData
*/
public function testAskConfirmation($question, $expected, $default = true)
{
}
public function getAskConfirmationData()
{
}
public function testAskConfirmationWithCustomTrueAnswer()
{
}
public function testAskAndValidate()
{
}
/**
* @dataProvider simpleAnswerProvider
*/
public function testSelectChoiceFromSimpleChoices($providedAnswer, $expectedValue)
{
}
public function simpleAnswerProvider()
{
}
/**
* @dataProvider mixedKeysChoiceListAnswerProvider
*/
public function testChoiceFromChoicelistWithMixedKeys($providedAnswer, $expectedValue)
{
}
public function mixedKeysChoiceListAnswerProvider()
{
}
/**
* @dataProvider answerProvider
*/
public function testSelectChoiceFromChoiceList($providedAnswer, $expectedValue)
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The provided answer is ambiguous. Value should be one of env_2 or env_3.
*/
public function testAmbiguousChoiceFromChoicelist()
{
}
public function answerProvider()
{
}
public function testNoInteraction()
{
}
/**
* @requires function mb_strwidth
*/
public function testChoiceOutputFormattingQuestionForUtf8Keys()
{
}
protected function getInputStream($input)
{
}
protected function createOutputInterface()
{
}
protected function createInputInterfaceMock($interactive = true)
{
}
}
class HelperSetTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testSet()
{
}
public function testHas()
{
}
public function testGet()
{
}
public function testSetCommand()
{
}
public function testGetCommand()
{
}
public function testIteration()
{
}
}
/**
* @group legacy
*/
class LegacyTableHelperTest extends \PHPUnit_Framework_TestCase
{
protected $stream;
protected function setUp()
{
}
protected function tearDown()
{
}
/**
* @dataProvider testRenderProvider
*/
public function testRender($headers, $rows, $layout, $expected)
{
}
/**
* @dataProvider testRenderProvider
*/
public function testRenderAddRows($headers, $rows, $layout, $expected)
{
}
/**
* @dataProvider testRenderProvider
*/
public function testRenderAddRowsOneByOne($headers, $rows, $layout, $expected)
{
}
public function testRenderProvider()
{
}
public function testRenderMultiByte()
{
}
public function testRenderFullWidthCharacters()
{
}
protected function getOutputStream()
{
}
protected function getOutputContent(\Symfony\Component\Console\Output\StreamOutput $output)
{
}
}
class TableTest extends \PHPUnit_Framework_TestCase
{
protected $stream;
protected function setUp()
{
}
protected function tearDown()
{
}
/**
* @dataProvider testRenderProvider
*/
public function testRender($headers, $rows, $style, $expected)
{
}
/**
* @dataProvider testRenderProvider
*/
public function testRenderAddRows($headers, $rows, $style, $expected)
{
}
/**
* @dataProvider testRenderProvider
*/
public function testRenderAddRowsOneByOne($headers, $rows, $style, $expected)
{
}
public function testRenderProvider()
{
}
public function testRenderMultiByte()
{
}
public function testStyle()
{
}
public function testRowSeparator()
{
}
public function testRenderMultiCalls()
{
}
public function testColumnStyle()
{
}
protected function getOutputStream()
{
}
protected function getOutputContent(\Symfony\Component\Console\Output\StreamOutput $output)
{
}
}
class FormatterHelperTest extends \PHPUnit_Framework_TestCase
{
public function testFormatSection()
{
}
public function testFormatBlock()
{
}
public function testFormatBlockWithDiacriticLetters()
{
}
public function testFormatBlockWithDoubleWidthDiacriticLetters()
{
}
public function testFormatBlockLGEscaping()
{
}
}
class HelperTest extends \PHPUnit_Framework_TestCase
{
public function formatTimeProvider()
{
}
/**
* @dataProvider formatTimeProvider
*
* @param int $secs
* @param string $expectedFormat
*/
public function testFormatTime($secs, $expectedFormat)
{
}
}
/**
* @group legacy
*/
class LegacyDialogHelperTest extends \PHPUnit_Framework_TestCase
{
public function testSelect()
{
}
public function testSelectOnErrorOutput()
{
}
public function testAsk()
{
}
public function testAskOnErrorOutput()
{
}
public function testAskWithAutocomplete()
{
}
/**
* @group tty
*/
public function testAskHiddenResponse()
{
}
/**
* @group tty
*/
public function testAskHiddenResponseOnErrorOutput()
{
}
public function testAskConfirmation()
{
}
public function testAskAndValidate()
{
}
public function testNoInteraction()
{
}
protected function getInputStream($input)
{
}
protected function getOutputStream()
{
}
protected function getConsoleOutput($stderr)
{
}
}
/**
* @group legacy
* @group time-sensitive
*/
class LegacyProgressHelperTest extends \PHPUnit_Framework_TestCase
{
public function testAdvance()
{
}
public function testAdvanceWithStep()
{
}
public function testAdvanceMultipleTimes()
{
}
public function testCustomizations()
{
}
public function testPercent()
{
}
public function testOverwriteWithShorterLine()
{
}
public function testSetCurrentProgress()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage You must start the progress bar
*/
public function testSetCurrentBeforeStarting()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage You can't regress the progress bar
*/
public function testRegressProgress()
{
}
public function testRedrawFrequency()
{
}
public function testMultiByteSupport()
{
}
public function testClear()
{
}
public function testPercentNotHundredBeforeComplete()
{
}
public function testNonDecoratedOutput()
{
}
protected function getOutputStream($decorated = true)
{
}
protected $lastMessagesLength;
protected function generateOutput($expected)
{
}
}
class ProcessHelperTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider provideCommandsAndOutput
*/
public function testVariousProcessRuns($expected, $cmd, $verbosity, $error)
{
}
public function testPassedCallbackIsExecuted()
{
}
public function provideCommandsAndOutput()
{
}
}
class TableStyleTest extends \PHPUnit_Framework_TestCase
{
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage Invalid padding type. Expected one of (STR_PAD_LEFT, STR_PAD_RIGHT, STR_PAD_BOTH).
*/
public function testSetPadTypeWithInvalidType()
{
}
}
}
namespace Symfony\Component\Console\Tests\Style {
class SymfonyStyleTest extends \PHPUnit_Framework_TestCase
{
/** @var Command */
protected $command;
/** @var CommandTester */
protected $tester;
protected function setUp()
{
}
protected function tearDown()
{
}
/**
* @dataProvider inputCommandToOutputFilesProvider
*/
public function testOutputs($inputCommandFilepath, $outputFilepath)
{
}
public function inputCommandToOutputFilesProvider()
{
}
public function testLongWordsBlockWrapping()
{
}
}
/**
* Use this class in tests to force the line length
* and ensure a consistent output for expectations.
*/
class SymfonyStyleWithForcedLineLength extends \Symfony\Component\Console\Style\SymfonyStyle
{
public function __construct(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
}
namespace Symfony\Component\Console\Tests\Tester {
class ApplicationTesterTest extends \PHPUnit_Framework_TestCase
{
protected $application;
protected $tester;
protected function setUp()
{
}
protected function tearDown()
{
}
public function testRun()
{
}
public function testGetInput()
{
}
public function testGetOutput()
{
}
public function testGetDisplay()
{
}
public function testGetStatusCode()
{
}
}
class CommandTesterTest extends \PHPUnit_Framework_TestCase
{
protected $command;
protected $tester;
protected function setUp()
{
}
protected function tearDown()
{
}
public function testExecute()
{
}
public function testGetInput()
{
}
public function testGetOutput()
{
}
public function testGetDisplay()
{
}
public function testGetStatusCode()
{
}
public function testCommandFromApplication()
{
}
}
}
namespace Psr\Log\Test {
/**
* Provides a base test class for ensuring compliance with the LoggerInterface.
*
* Implementors can extend the class and implement abstract methods to run this
* as part of their test suite.
*/
abstract class LoggerInterfaceTest extends \PHPUnit_Framework_TestCase
{
/**
* @return LoggerInterface
*/
public abstract function getLogger();
/**
* This must return the log messages in order.
*
* The simple formatting of the messages is: "<LOG LEVEL> <MESSAGE>".
*
* Example ->error('Foo') would yield "error Foo".
*
* @return string[]
*/
public abstract function getLogs();
public function testImplements()
{
}
/**
* @dataProvider provideLevelsAndMessages
*/
public function testLogsAtAllLevels($level, $message)
{
}
public function provideLevelsAndMessages()
{
}
/**
* @expectedException \Psr\Log\InvalidArgumentException
*/
public function testThrowsOnInvalidLevel()
{
}
public function testContextReplacement()
{
}
public function testObjectCastToString()
{
}
public function testContextCanContainAnything()
{
}
public function testContextExceptionKeyCanBeExceptionOrOtherValues()
{
}
}
}
namespace Symfony\Component\Console\Tests\Logger {
/**
* Console logger test.
*
* @author Kévin Dunglas <dunglas@gmail.com>
*/
class ConsoleLoggerTest extends \Psr\Log\Test\LoggerInterfaceTest
{
/**
* @var DummyOutput
*/
protected $output;
/**
* {@inheritdoc}
*/
public function getLogger()
{
}
/**
* {@inheritdoc}
*/
public function getLogs()
{
}
}
}
namespace Symfony\Component\Console\Tests\Command {
class ListCommandTest extends \PHPUnit_Framework_TestCase
{
public function testExecuteListsCommands()
{
}
public function testExecuteListsCommandsWithXmlOption()
{
}
public function testExecuteListsCommandsWithRawOption()
{
}
public function testExecuteListsCommandsWithNamespaceArgument()
{
}
public function testExecuteListsCommandsOrder()
{
}
public function testExecuteListsCommandsOrderRaw()
{
}
}
class CommandTest extends \PHPUnit_Framework_TestCase
{
protected static $fixturesPath;
public static function setUpBeforeClass()
{
}
public function testConstructor()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage The command defined in "Symfony\Component\Console\Command\Command" cannot have an empty name.
*/
public function testCommandNameCannotBeEmpty()
{
}
public function testSetApplication()
{
}
public function testSetGetDefinition()
{
}
public function testAddArgument()
{
}
public function testAddOption()
{
}
public function testGetNamespaceGetNameSetName()
{
}
/**
* @dataProvider provideInvalidCommandNames
*/
public function testInvalidCommandNames($name)
{
}
public function provideInvalidCommandNames()
{
}
public function testGetSetDescription()
{
}
public function testGetSetHelp()
{
}
public function testGetProcessedHelp()
{
}
public function testGetSetAliases()
{
}
public function testGetSynopsis()
{
}
public function testGetHelper()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage Cannot retrieve helper "formatter" because there is no HelperSet defined.
*/
public function testGetHelperWithoutHelperSet()
{
}
public function testMergeApplicationDefinition()
{
}
public function testMergeApplicationDefinitionWithoutArgsThenWithArgsAddsArgs()
{
}
public function testRunInteractive()
{
}
public function testRunNonInteractive()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage You must override the execute() method in the concrete command class.
*/
public function testExecuteMethodNeedsToBeOverridden()
{
}
/**
* @expectedException Symfony\Component\Console\Exception\InvalidOptionException
* @expectedExceptionMessage The "--bar" option does not exist.
*/
public function testRunWithInvalidOption()
{
}
public function testRunReturnsIntegerExitCode()
{
}
public function testRunWithApplication()
{
}
public function testRunReturnsAlwaysInteger()
{
}
public function testSetCode()
{
}
public function getSetCodeBindToClosureTests()
{
}
/**
* @dataProvider getSetCodeBindToClosureTests
* @requires PHP 5.4
*/
public function testSetCodeBindToClosure($previouslyBound, $expected)
{
}
public function testSetCodeWithNonClosureCallable()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage Invalid callable provided to Command::setCode.
*/
public function testSetCodeWithNonCallable()
{
}
public function callableMethodCommand(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* @group legacy
*/
public function testLegacyAsText()
{
}
/**
* @group legacy
*/
public function testLegacyAsXml()
{
}
}
class HelpCommandTest extends \PHPUnit_Framework_TestCase
{
public function testExecuteForCommandAlias()
{
}
public function testExecuteForCommand()
{
}
public function testExecuteForCommandWithXmlOption()
{
}
public function testExecuteForApplicationCommand()
{
}
public function testExecuteForApplicationCommandWithXmlOption()
{
}
}
}
namespace Symfony\Component\Console\Tests\Fixtures {
class DescriptorCommand2 extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
}
}
namespace {
class TestCommand extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
protected function interact(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
}
namespace Symfony\Component\Console\Tests\Fixtures {
class DescriptorApplication1 extends \Symfony\Component\Console\Application
{
}
}
namespace {
class Foo1Command extends \Symfony\Component\Console\Command\Command
{
public $input;
public $output;
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
class Foo5Command extends \Symfony\Component\Console\Command\Command
{
public function __construct()
{
}
}
class FooSubnamespaced2Command extends \Symfony\Component\Console\Command\Command
{
public $input;
public $output;
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
class BarBucCommand extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
}
class FoobarCommand extends \Symfony\Component\Console\Command\Command
{
public $input;
public $output;
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
}
namespace Symfony\Component\Console\Tests\Fixtures {
class DescriptorApplication2 extends \Symfony\Component\Console\Application
{
public function __construct()
{
}
}
}
namespace {
class Foo4Command extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
}
}
namespace Symfony\Component\Console\Tests\Fixtures {
/**
* Dummy output.
*
* @author Kévin Dunglas <dunglas@gmail.com>
*/
class DummyOutput extends \Symfony\Component\Console\Output\BufferedOutput
{
/**
* @return array
*/
public function getLogs()
{
}
}
}
namespace {
class Foo3Command extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
class FooSubnamespaced1Command extends \Symfony\Component\Console\Command\Command
{
public $input;
public $output;
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
class FooCommand extends \Symfony\Component\Console\Command\Command
{
public $input;
public $output;
protected function configure()
{
}
protected function interact(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
class Foo2Command extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
class Foo6Command extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
}
}
namespace Symfony\Component\Console\Tests\Fixtures {
class DescriptorCommand1 extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
}
}
namespace Symfony\Component\Console\Tests {
class ApplicationTest extends \PHPUnit_Framework_TestCase
{
protected static $fixturesPath;
public static function setUpBeforeClass()
{
}
protected function normalizeLineBreaks($text)
{
}
/**
* Replaces the dynamic placeholders of the command help text with a static version.
* The placeholder %command.full_name% includes the script path that is not predictable
* and can not be tested against.
*/
protected function ensureStaticCommandHelp(\Symfony\Component\Console\Application $application)
{
}
public function testConstructor()
{
}
public function testSetGetName()
{
}
public function testSetGetVersion()
{
}
public function testGetLongVersion()
{
}
public function testHelp()
{
}
public function testAll()
{
}
public function testRegister()
{
}
public function testAdd()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage Command class "Foo5Command" is not correctly initialized. You probably forgot to call the parent constructor.
*/
public function testAddCommandWithEmptyConstructor()
{
}
public function testHasGet()
{
}
public function testSilentHelp()
{
}
/**
* @expectedException Symfony\Component\Console\Exception\CommandNotFoundException
* @expectedExceptionMessage The command "foofoo" does not exist.
*/
public function testGetInvalidCommand()
{
}
public function testGetNamespaces()
{
}
public function testFindNamespace()
{
}
public function testFindNamespaceWithSubnamespaces()
{
}
/**
* @expectedException Symfony\Component\Console\Exception\CommandNotFoundException
* @expectedExceptionMessage The namespace "f" is ambiguous (foo, foo1).
*/
public function testFindAmbiguousNamespace()
{
}
/**
* @expectedException Symfony\Component\Console\Exception\CommandNotFoundException
* @expectedExceptionMessage There are no commands defined in the "bar" namespace.
*/
public function testFindInvalidNamespace()
{
}
/**
* @expectedException Symfony\Component\Console\Exception\CommandNotFoundException
* @expectedExceptionMessage Command "foo1" is not defined
*/
public function testFindUniqueNameButNamespaceName()
{
}
public function testFind()
{
}
/**
* @dataProvider provideAmbiguousAbbreviations
*/
public function testFindWithAmbiguousAbbreviations($abbreviation, $expectedExceptionMessage)
{
}
public function provideAmbiguousAbbreviations()
{
}
public function testFindCommandEqualNamespace()
{
}
public function testFindCommandWithAmbiguousNamespacesButUniqueName()
{
}
public function testFindCommandWithMissingNamespace()
{
}
/**
* @dataProvider provideInvalidCommandNamesSingle
* @expectedException Symfony\Component\Console\Exception\CommandNotFoundException
* @expectedExceptionMessage Did you mean this
*/
public function testFindAlternativeExceptionMessageSingle($name)
{
}
public function provideInvalidCommandNamesSingle()
{
}
public function testFindAlternativeExceptionMessageMultiple()
{
}
public function testFindAlternativeCommands()
{
}
public function testFindAlternativeCommandsWithAnAlias()
{
}
public function testFindAlternativeNamespace()
{
}
public function testFindNamespaceDoesNotFailOnDeepSimilarNamespaces()
{
}
/**
* @expectedException Symfony\Component\Console\Exception\CommandNotFoundException
* @expectedExceptionMessage Command "foo::bar" is not defined.
*/
public function testFindWithDoubleColonInNameThrowsException()
{
}
public function testSetCatchExceptions()
{
}
/**
* @group legacy
*/
public function testLegacyAsText()
{
}
/**
* @group legacy
*/
public function testLegacyAsXml()
{
}
public function testRenderException()
{
}
public function testRenderExceptionWithDoubleWidthCharacters()
{
}
public function testRun()
{
}
/**
* Issue #9285.
*
* If the "verbose" option is just before an argument in ArgvInput,
* an argument value should not be treated as verbosity value.
* This test will fail with "Not enough arguments." if broken
*/
public function testVerboseValueNotBreakArguments()
{
}
public function testRunReturnsIntegerExitCode()
{
}
public function testRunReturnsExitCodeOneForExceptionCodeZero()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage An option with shortcut "e" already exists.
*/
public function testAddingOptionWithDuplicateShortcut()
{
}
/**
* @expectedException \LogicException
* @dataProvider getAddingAlreadySetDefinitionElementData
*/
public function testAddingAlreadySetDefinitionElementData($def)
{
}
public function getAddingAlreadySetDefinitionElementData()
{
}
public function testGetDefaultHelperSetReturnsDefaultValues()
{
}
public function testAddingSingleHelperSetOverwritesDefaultValues()
{
}
public function testOverwritingDefaultHelperSetOverwritesDefaultValues()
{
}
public function testGetDefaultInputDefinitionReturnsDefaultValues()
{
}
public function testOverwritingDefaultInputDefinitionOverwritesDefaultValues()
{
}
public function testSettingCustomInputDefinitionOverwritesDefaultValues()
{
}
public function testRunWithDispatcher()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage caught
*/
public function testRunWithExceptionAndDispatcher()
{
}
public function testRunDispatchesAllEventsWithException()
{
}
public function testRunWithDispatcherSkippingCommand()
{
}
public function testRunWithDispatcherAccessingInputOptions()
{
}
public function testRunWithDispatcherAddingInputOptions()
{
}
public function testTerminalDimensions()
{
}
protected function getDispatcher($skipCommand = false)
{
}
public function testSetRunCustomDefaultCommand()
{
}
/**
* @requires function posix_isatty
*/
public function testCanCheckIfTerminalIsInteractive()
{
}
}
class CustomApplication extends \Symfony\Component\Console\Application
{
/**
* Overwrites the default input definition.
*
* @return InputDefinition An InputDefinition instance
*/
protected function getDefaultInputDefinition()
{
}
/**
* Gets the default helper set with the helpers that should always be available.
*
* @return HelperSet A HelperSet instance
*/
protected function getDefaultHelperSet()
{
}
}
class CustomDefaultCommandApplication extends \Symfony\Component\Console\Application
{
/**
* Overwrites the constructor in order to set a different default command.
*/
public function __construct()
{
}
}
}
namespace Symfony\Component\Console\Tests\Formatter {
class OutputFormatterStyleStackTest extends \PHPUnit_Framework_TestCase
{
public function testPush()
{
}
public function testPop()
{
}
public function testPopEmpty()
{
}
public function testPopNotLast()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testInvalidPop()
{
}
}
class OutputFormatterTest extends \PHPUnit_Framework_TestCase
{
public function testEmptyTag()
{
}
public function testLGCharEscaping()
{
}
public function testBundledStyles()
{
}
public function testNestedStyles()
{
}
public function testAdjacentStyles()
{
}
public function testStyleMatchingNotGreedy()
{
}
public function testStyleEscaping()
{
}
public function testDeepNestedStyles()
{
}
public function testNewStyle()
{
}
public function testRedefineStyle()
{
}
public function testInlineStyle()
{
}
public function testNonStyleTag()
{
}
public function testFormatLongString()
{
}
public function testFormatToStringObject()
{
}
public function testNotDecoratedFormatter()
{
}
public function testContentWithLineBreaks()
{
}
}
class TableCell
{
public function __toString()
{
}
}
class OutputFormatterStyleTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testForeground()
{
}
public function testBackground()
{
}
public function testOptions()
{
}
}
}
namespace Symfony\Component\Console\Tests\Descriptor {
abstract class AbstractDescriptorTest extends \PHPUnit_Framework_TestCase
{
/** @dataProvider getDescribeInputArgumentTestData */
public function testDescribeInputArgument(\Symfony\Component\Console\Input\InputArgument $argument, $expectedDescription)
{
}
/** @dataProvider getDescribeInputOptionTestData */
public function testDescribeInputOption(\Symfony\Component\Console\Input\InputOption $option, $expectedDescription)
{
}
/** @dataProvider getDescribeInputDefinitionTestData */
public function testDescribeInputDefinition(\Symfony\Component\Console\Input\InputDefinition $definition, $expectedDescription)
{
}
/** @dataProvider getDescribeCommandTestData */
public function testDescribeCommand(\Symfony\Component\Console\Command\Command $command, $expectedDescription)
{
}
/** @dataProvider getDescribeApplicationTestData */
public function testDescribeApplication(\Symfony\Component\Console\Application $application, $expectedDescription)
{
}
public function getDescribeInputArgumentTestData()
{
}
public function getDescribeInputOptionTestData()
{
}
public function getDescribeInputDefinitionTestData()
{
}
public function getDescribeCommandTestData()
{
}
public function getDescribeApplicationTestData()
{
}
protected abstract function getDescriptor();
protected abstract function getFormat();
protected function assertDescription($expectedDescription, $describedObject)
{
}
}
class MarkdownDescriptorTest extends \Symfony\Component\Console\Tests\Descriptor\AbstractDescriptorTest
{
protected function getDescriptor()
{
}
protected function getFormat()
{
}
}
class XmlDescriptorTest extends \Symfony\Component\Console\Tests\Descriptor\AbstractDescriptorTest
{
protected function getDescriptor()
{
}
protected function getFormat()
{
}
}
class JsonDescriptorTest extends \Symfony\Component\Console\Tests\Descriptor\AbstractDescriptorTest
{
protected function getDescriptor()
{
}
protected function getFormat()
{
}
protected function assertDescription($expectedDescription, $describedObject)
{
}
}
class TextDescriptorTest extends \Symfony\Component\Console\Tests\Descriptor\AbstractDescriptorTest
{
protected function getDescriptor()
{
}
protected function getFormat()
{
}
}
/**
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class ObjectsProvider
{
public static function getInputArguments()
{
}
public static function getInputOptions()
{
}
public static function getInputDefinitions()
{
}
public static function getCommands()
{
}
public static function getApplications()
{
}
}
}
namespace Symfony\Component\Console\Tests\Input {
class InputArgumentTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testModes()
{
}
/**
* @dataProvider provideInvalidModes
*/
public function testInvalidModes($mode)
{
}
public function provideInvalidModes()
{
}
public function testIsArray()
{
}
public function testGetDescription()
{
}
public function testGetDefault()
{
}
public function testSetDefault()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage Cannot set a default value except for InputArgument::OPTIONAL mode.
*/
public function testSetDefaultWithRequiredArgument()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage A default value for an array argument must be an array.
*/
public function testSetDefaultWithArrayArgument()
{
}
}
class InputTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testOptions()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The "foo" option does not exist.
*/
public function testSetInvalidOption()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The "foo" option does not exist.
*/
public function testGetInvalidOption()
{
}
public function testArguments()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The "foo" argument does not exist.
*/
public function testSetInvalidArgument()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The "foo" argument does not exist.
*/
public function testGetInvalidArgument()
{
}
/**
* @expectedException \RuntimeException
* @expectedExceptionMessage Not enough arguments (missing: "name").
*/
public function testValidateWithMissingArguments()
{
}
/**
* @expectedException \RuntimeException
* @expectedExceptionMessage Not enough arguments (missing: "name").
*/
public function testValidateWithMissingRequiredArguments()
{
}
public function testValidate()
{
}
public function testSetGetInteractive()
{
}
}
class ArrayInputTest extends \PHPUnit_Framework_TestCase
{
public function testGetFirstArgument()
{
}
public function testHasParameterOption()
{
}
public function testGetParameterOption()
{
}
public function testParseArguments()
{
}
/**
* @dataProvider provideOptions
*/
public function testParseOptions($input, $options, $expectedOptions, $message)
{
}
public function provideOptions()
{
}
/**
* @dataProvider provideInvalidInput
*/
public function testParseInvalidInput($parameters, $definition, $expectedExceptionMessage)
{
}
public function provideInvalidInput()
{
}
public function testToString()
{
}
}
class StringInputTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getTokenizeData
*/
public function testTokenize($input, $tokens, $message)
{
}
public function testInputOptionWithGivenString()
{
}
/**
* @group legacy
*/
public function testLegacyInputOptionDefinitionInConstructor()
{
}
public function getTokenizeData()
{
}
public function testToString()
{
}
}
class InputOptionTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage Impossible to have an option mode VALUE_IS_ARRAY if the option does not accept a value.
*/
public function testArrayModeWithoutValue()
{
}
public function testShortcut()
{
}
public function testModes()
{
}
/**
* @dataProvider provideInvalidModes
*/
public function testInvalidModes($mode)
{
}
public function provideInvalidModes()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testEmptyNameIsInvalid()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testDoubleDashNameIsInvalid()
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testSingleDashOptionIsInvalid()
{
}
public function testIsArray()
{
}
public function testGetDescription()
{
}
public function testGetDefault()
{
}
public function testSetDefault()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage Cannot set a default value when using InputOption::VALUE_NONE mode.
*/
public function testDefaultValueWithValueNoneMode()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage A default value for an array option must be an array.
*/
public function testDefaultValueWithIsArrayMode()
{
}
public function testEquals()
{
}
}
class ArgvInputTest extends \PHPUnit_Framework_TestCase
{
public function testConstructor()
{
}
public function testParseArguments()
{
}
/**
* @dataProvider provideOptions
*/
public function testParseOptions($input, $options, $expectedOptions, $message)
{
}
public function provideOptions()
{
}
/**
* @dataProvider provideInvalidInput
*/
public function testInvalidInput($argv, $definition, $expectedExceptionMessage)
{
}
public function provideInvalidInput()
{
}
public function testParseArrayArgument()
{
}
public function testParseArrayOption()
{
}
public function testParseNegativeNumberAfterDoubleDash()
{
}
public function testParseEmptyStringArgument()
{
}
public function testGetFirstArgument()
{
}
public function testHasParameterOption()
{
}
public function testToString()
{
}
/**
* @dataProvider provideGetParameterOptionValues
*/
public function testGetParameterOptionEqualSign($argv, $key, $expected)
{
}
public function provideGetParameterOptionValues()
{
}
public function testParseSingleDashAsArgument()
{
}
}
class InputDefinitionTest extends \PHPUnit_Framework_TestCase
{
protected static $fixtures;
protected $foo, $bar, $foo1, $foo2;
public static function setUpBeforeClass()
{
}
public function testConstructorArguments()
{
}
public function testConstructorOptions()
{
}
public function testSetArguments()
{
}
public function testAddArguments()
{
}
public function testAddArgument()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage An argument with name "foo" already exists.
*/
public function testArgumentsMustHaveDifferentNames()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage Cannot add an argument after an array argument.
*/
public function testArrayArgumentHasToBeLast()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage Cannot add a required argument after an optional one.
*/
public function testRequiredArgumentCannotFollowAnOptionalOne()
{
}
public function testGetArgument()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The "bar" argument does not exist.
*/
public function testGetInvalidArgument()
{
}
public function testHasArgument()
{
}
public function testGetArgumentRequiredCount()
{
}
public function testGetArgumentCount()
{
}
public function testGetArgumentDefaults()
{
}
public function testSetOptions()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The "-f" option does not exist.
*/
public function testSetOptionsClearsOptions()
{
}
public function testAddOptions()
{
}
public function testAddOption()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage An option named "foo" already exists.
*/
public function testAddDuplicateOption()
{
}
/**
* @expectedException \LogicException
* @expectedExceptionMessage An option with shortcut "f" already exists.
*/
public function testAddDuplicateShortcutOption()
{
}
public function testGetOption()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The "--bar" option does not exist.
*/
public function testGetInvalidOption()
{
}
public function testHasOption()
{
}
public function testHasShortcut()
{
}
public function testGetOptionForShortcut()
{
}
public function testGetOptionForMultiShortcut()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The "-l" option does not exist.
*/
public function testGetOptionForInvalidShortcut()
{
}
public function testGetOptionDefaults()
{
}
/**
* @dataProvider getGetSynopsisData
*/
public function testGetSynopsis(\Symfony\Component\Console\Input\InputDefinition $definition, $expectedSynopsis, $message = null)
{
}
public function getGetSynopsisData()
{
}
public function testGetShortSynopsis()
{
}
/**
* @group legacy
*/
public function testLegacyAsText()
{
}
/**
* @group legacy
*/
public function testLegacyAsXml()
{
}
protected function initializeArguments()
{
}
protected function initializeOptions()
{
}
}
}
namespace Symfony\Component\Console\Event {
/**
* Allows to handle exception thrown in a command.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class ConsoleExceptionEvent extends \Symfony\Component\Console\Event\ConsoleEvent
{
public function __construct(\Symfony\Component\Console\Command\Command $command, \Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output, \Exception $exception, $exitCode)
{
}
/**
* Returns the thrown exception.
*
* @return \Exception The thrown exception
*/
public function getException()
{
}
/**
* Replaces the thrown exception.
*
* This exception will be thrown if no response is set in the event.
*
* @param \Exception $exception The thrown exception
*/
public function setException(\Exception $exception)
{
}
/**
* Gets the exit code.
*
* @return int The command exit code
*/
public function getExitCode()
{
}
}
}
namespace Symfony\Component\Console\Helper {
/**
* Provides helpers to display table output.
*
* @author Саша Стаменковић <umpirsky@gmail.com>
* @author Fabien Potencier <fabien@symfony.com>
*
* @deprecated since version 2.5, to be removed in 3.0
* Use {@link Table} instead.
*/
class TableHelper extends \Symfony\Component\Console\Helper\Helper
{
const LAYOUT_DEFAULT = 0;
const LAYOUT_BORDERLESS = 1;
const LAYOUT_COMPACT = 2;
public function __construct($triggerDeprecationError = true)
{
}
/**
* Sets table layout type.
*
* @param int $layout self::LAYOUT_*
*
* @return TableHelper
*
* @throws InvalidArgumentException when the table layout is not known
*/
public function setLayout($layout)
{
}
public function setHeaders(array $headers)
{
}
public function setRows(array $rows)
{
}
public function addRows(array $rows)
{
}
public function addRow(array $row)
{
}
public function setRow($column, array $row)
{
}
/**
* Sets padding character, used for cell padding.
*
* @param string $paddingChar
*
* @return TableHelper
*/
public function setPaddingChar($paddingChar)
{
}
/**
* Sets horizontal border character.
*
* @param string $horizontalBorderChar
*
* @return TableHelper
*/
public function setHorizontalBorderChar($horizontalBorderChar)
{
}
/**
* Sets vertical border character.
*
* @param string $verticalBorderChar
*
* @return TableHelper
*/
public function setVerticalBorderChar($verticalBorderChar)
{
}
/**
* Sets crossing character.
*
* @param string $crossingChar
*
* @return TableHelper
*/
public function setCrossingChar($crossingChar)
{
}
/**
* Sets header cell format.
*
* @param string $cellHeaderFormat
*
* @return TableHelper
*/
public function setCellHeaderFormat($cellHeaderFormat)
{
}
/**
* Sets row cell format.
*
* @param string $cellRowFormat
*
* @return TableHelper
*/
public function setCellRowFormat($cellRowFormat)
{
}
/**
* Sets row cell content format.
*
* @param string $cellRowContentFormat
*
* @return TableHelper
*/
public function setCellRowContentFormat($cellRowContentFormat)
{
}
/**
* Sets table border format.
*
* @param string $borderFormat
*
* @return TableHelper
*/
public function setBorderFormat($borderFormat)
{
}
/**
* Sets cell padding type.
*
* @param int $padType STR_PAD_*
*
* @return TableHelper
*/
public function setPadType($padType)
{
}
/**
* Renders table to output.
*
* Example:
* +---------------+-----------------------+------------------+
* | ISBN | Title | Author |
* +---------------+-----------------------+------------------+
* | 99921-58-10-7 | Divine Comedy | Dante Alighieri |
* | 9971-5-0210-0 | A Tale of Two Cities | Charles Dickens |
* | 960-425-059-0 | The Lord of the Rings | J. R. R. Tolkien |
* +---------------+-----------------------+------------------+
*
* @param OutputInterface $output
*/
public function render(\Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
}
/**
* The Progress class provides helpers to display progress output.
*
* @author Chris Jones <leeked@gmail.com>
* @author Fabien Potencier <fabien@symfony.com>
*
* @deprecated since version 2.5, to be removed in 3.0
* Use {@link ProgressBar} instead.
*/
class ProgressHelper extends \Symfony\Component\Console\Helper\Helper
{
const FORMAT_QUIET = ' %percent%%';
const FORMAT_NORMAL = ' %current%/%max% [%bar%] %percent%%';
const FORMAT_VERBOSE = ' %current%/%max% [%bar%] %percent%% Elapsed: %elapsed%';
const FORMAT_QUIET_NOMAX = ' %current%';
const FORMAT_NORMAL_NOMAX = ' %current% [%bar%]';
const FORMAT_VERBOSE_NOMAX = ' %current% [%bar%] Elapsed: %elapsed%';
public function __construct($triggerDeprecationError = true)
{
}
/**
* Sets the progress bar width.
*
* @param int $size The progress bar size
*/
public function setBarWidth($size)
{
}
/**
* Sets the bar character.
*
* @param string $char A character
*/
public function setBarCharacter($char)
{
}
/**
* Sets the empty bar character.
*
* @param string $char A character
*/
public function setEmptyBarCharacter($char)
{
}
/**
* Sets the progress bar character.
*
* @param string $char A character
*/
public function setProgressCharacter($char)
{
}
/**
* Sets the progress bar format.
*
* @param string $format The format
*/
public function setFormat($format)
{
}
/**
* Sets the redraw frequency.
*
* @param int $freq The frequency in steps
*/
public function setRedrawFrequency($freq)
{
}
/**
* Starts the progress output.
*
* @param OutputInterface $output An Output instance
* @param int|null $max Maximum steps
*/
public function start(\Symfony\Component\Console\Output\OutputInterface $output, $max = null)
{
}
/**
* Advances the progress output X steps.
*
* @param int $step Number of steps to advance
* @param bool $redraw Whether to redraw or not
*
* @throws LogicException
*/
public function advance($step = 1, $redraw = false)
{
}
/**
* Sets the current progress.
*
* @param int $current The current progress
* @param bool $redraw Whether to redraw or not
*
* @throws LogicException
*/
public function setCurrent($current, $redraw = false)
{
}
/**
* Outputs the current progress string.
*
* @param bool $finish Forces the end result
*
* @throws LogicException
*/
public function display($finish = false)
{
}
/**
* Removes the progress bar from the current line.
*
* This is useful if you wish to write some output
* while a progress bar is running.
* Call display() to show the progress bar again.
*/
public function clear()
{
}
/**
* Finishes the progress output.
*/
public function finish()
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
}
/**
* The Dialog class provides helpers to interact with the user.
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @deprecated since version 2.5, to be removed in 3.0.
* Use {@link \Symfony\Component\Console\Helper\QuestionHelper} instead.
*/
class DialogHelper extends \Symfony\Component\Console\Helper\InputAwareHelper
{
public function __construct($triggerDeprecationError = true)
{
}
/**
* Asks the user to select a value.
*
* @param OutputInterface $output An Output instance
* @param string|array $question The question to ask
* @param array $choices List of choices to pick from
* @param bool|string $default The default answer if the user enters nothing
* @param bool|int $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param string $errorMessage Message which will be shown if invalid value from choice list would be picked
* @param bool $multiselect Select more than one value separated by comma
*
* @return int|string|array The selected value or values (the key of the choices array)
*
* @throws InvalidArgumentException
*/
public function select(\Symfony\Component\Console\Output\OutputInterface $output, $question, $choices, $default = null, $attempts = false, $errorMessage = 'Value "%s" is invalid', $multiselect = false)
{
}
/**
* Asks a question to the user.
*
* @param OutputInterface $output An Output instance
* @param string|array $question The question to ask
* @param string $default The default answer if none is given by the user
* @param array $autocomplete List of values to autocomplete
*
* @return string The user answer
*
* @throws RuntimeException If there is no data to read in the input stream
*/
public function ask(\Symfony\Component\Console\Output\OutputInterface $output, $question, $default = null, array $autocomplete = null)
{
}
/**
* Asks a confirmation to the user.
*
* The question will be asked until the user answers by nothing, yes, or no.
*
* @param OutputInterface $output An Output instance
* @param string|array $question The question to ask
* @param bool $default The default answer if the user enters nothing
*
* @return bool true if the user has confirmed, false otherwise
*/
public function askConfirmation(\Symfony\Component\Console\Output\OutputInterface $output, $question, $default = true)
{
}
/**
* Asks a question to the user, the response is hidden.
*
* @param OutputInterface $output An Output instance
* @param string|array $question The question
* @param bool $fallback In case the response can not be hidden, whether to fallback on non-hidden question or not
*
* @return string The answer
*
* @throws RuntimeException In case the fallback is deactivated and the response can not be hidden
*/
public function askHiddenResponse(\Symfony\Component\Console\Output\OutputInterface $output, $question, $fallback = true)
{
}
/**
* Asks for a value and validates the response.
*
* The validator receives the data to validate. It must return the
* validated data when the data is valid and throw an exception
* otherwise.
*
* @param OutputInterface $output An Output instance
* @param string|array $question The question to ask
* @param callable $validator A PHP callback
* @param int|false $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param string $default The default answer if none is given by the user
* @param array $autocomplete List of values to autocomplete
*
* @return mixed
*
* @throws \Exception When any of the validators return an error
*/
public function askAndValidate(\Symfony\Component\Console\Output\OutputInterface $output, $question, $validator, $attempts = false, $default = null, array $autocomplete = null)
{
}
/**
* Asks for a value, hide and validates the response.
*
* The validator receives the data to validate. It must return the
* validated data when the data is valid and throw an exception
* otherwise.
*
* @param OutputInterface $output An Output instance
* @param string|array $question The question to ask
* @param callable $validator A PHP callback
* @param int|false $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param bool $fallback In case the response can not be hidden, whether to fallback on non-hidden question or not
*
* @return string The response
*
* @throws \Exception When any of the validators return an error
* @throws RuntimeException In case the fallback is deactivated and the response can not be hidden
*/
public function askHiddenResponseAndValidate(\Symfony\Component\Console\Output\OutputInterface $output, $question, $validator, $attempts = false, $fallback = true)
{
}
/**
* Sets the input stream to read from when interacting with the user.
*
* This is mainly useful for testing purpose.
*
* @param resource $stream The input stream
*/
public function setInputStream($stream)
{
}
/**
* Returns the helper's input stream.
*
* @return resource|null The input stream or null if the default STDIN is used
*/
public function getInputStream()
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
}
}
namespace Symfony\Component\Yaml {
/**
* Inline implements a YAML parser/dumper for the YAML inline syntax.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class Inline
{
const REGEX_QUOTED_STRING = '(?:"([^"\\\\]*(?:\\\\.[^"\\\\]*)*)"|\'([^\']*(?:\'\'[^\']*)*)\')';
/**
* Converts a YAML string to a PHP array.
*
* @param string $value A YAML string
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
* @param bool $objectSupport true if object support is enabled, false otherwise
* @param bool $objectForMap true if maps should return a stdClass instead of array()
* @param array $references Mapping of variable names to values
*
* @return array A PHP array representing the YAML string
*
* @throws ParseException
*/
public static function parse($value, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false, $references = array())
{
}
/**
* Dumps a given PHP variable to a YAML string.
*
* @param mixed $value The PHP variable to convert
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
* @param bool $objectSupport true if object support is enabled, false otherwise
*
* @return string The YAML string representing the PHP array
*
* @throws DumpException When trying to dump PHP resource
*/
public static function dump($value, $exceptionOnInvalidType = false, $objectSupport = false)
{
}
/**
* Check if given array is hash or just normal indexed array.
*
* @internal
*
* @param array $value The PHP array to check
*
* @return bool true if value is hash array, false otherwise
*/
public static function isHash(array $value)
{
}
/**
* Parses a scalar to a YAML string.
*
* @param string $scalar
* @param string $delimiters
* @param array $stringDelimiters
* @param int &$i
* @param bool $evaluate
* @param array $references
*
* @return string A YAML string
*
* @throws ParseException When malformed inline YAML string is parsed
*
* @internal
*/
public static function parseScalar($scalar, $delimiters = null, $stringDelimiters = array('"', "'"), &$i = 0, $evaluate = true, $references = array())
{
}
}
}
namespace Symfony\Component\Yaml\Tests {
class ParserTest extends \PHPUnit_Framework_TestCase
{
protected $parser;
protected function setUp()
{
}
protected function tearDown()
{
}
/**
* @dataProvider getDataFormSpecifications
*/
public function testSpecifications($file, $expected, $yaml, $comment)
{
}
public function getDataFormSpecifications()
{
}
public function testTabsInYaml()
{
}
public function testEndOfTheDocumentMarker()
{
}
public function getBlockChompingTests()
{
}
/**
* @dataProvider getBlockChompingTests
*/
public function testBlockChomping($expected, $yaml)
{
}
/**
* Regression test for issue #7989.
*
* @see https://github.com/symfony/symfony/issues/7989
*/
public function testBlockLiteralWithLeadingNewlines()
{
}
public function testObjectSupportEnabled()
{
}
/**
* @dataProvider invalidDumpedObjectProvider
*/
public function testObjectSupportDisabledButNoExceptions($input)
{
}
/**
* @dataProvider getObjectForMapTests
*/
public function testObjectForMap($yaml, $expected)
{
}
public function getObjectForMapTests()
{
}
/**
* @dataProvider invalidDumpedObjectProvider
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testObjectsSupportDisabledWithExceptions($yaml)
{
}
public function invalidDumpedObjectProvider()
{
}
/**
* @requires extension iconv
*/
public function testNonUtf8Exception()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testUnindentedCollectionException()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testShortcutKeyUnindentedCollectionException()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
* @expectedExceptionMessageRegExp /^Multiple documents are not supported.+/
*/
public function testMultipleDocumentsNotSupportedException()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testSequenceInAMapping()
{
}
public function testSequenceInMappingStartedBySingleDashLine()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testMappingInASequence()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
* @expectedExceptionMessage missing colon
*/
public function testScalarInSequence()
{
}
/**
* > It is an error for two equal keys to appear in the same mapping node.
* > In such a case the YAML processor may continue, ignoring the second
* > `key: value` pair and issuing an appropriate warning. This strategy
* > preserves a consistent information model for one-pass and random access
* > applications.
*
* @see http://yaml.org/spec/1.2/spec.html#id2759572
* @see http://yaml.org/spec/1.1/#id932806
*/
public function testMappingDuplicateKeyBlock()
{
}
public function testMappingDuplicateKeyFlow()
{
}
public function testEmptyValue()
{
}
public function testCommentAtTheRootIndent()
{
}
public function testStringBlockWithComments()
{
}
public function testFoldedStringBlockWithComments()
{
}
public function testNestedFoldedStringBlockWithComments()
{
}
public function testReferenceResolvingInInlineStrings()
{
}
public function testYamlDirective()
{
}
public function testFloatKeys()
{
}
/**
* @group legacy
* throw ParseException in Symfony 3.0
*/
public function testColonInMappingValueException()
{
}
public function testColonInMappingValueExceptionNotTriggeredByColonInComment()
{
}
/**
* @dataProvider getCommentLikeStringInScalarBlockData
*/
public function testCommentLikeStringsAreNotStrippedInBlockScalars($yaml, $expectedParserResult)
{
}
public function getCommentLikeStringInScalarBlockData()
{
}
public function testBlankLinesAreParsedAsNewLinesInFoldedBlocks()
{
}
public function testAdditionallyIndentedLinesAreParsedAsNewLinesInFoldedBlocks()
{
}
}
class B
{
public $b = 'foo';
}
class DumperTest extends \PHPUnit_Framework_TestCase
{
protected $parser;
protected $dumper;
protected $path;
protected $array = array('' => 'bar', 'foo' => '#bar', 'foo\'bar' => array(), 'bar' => array(1, 'foo'), 'foobar' => array('foo' => 'bar', 'bar' => array(1, 'foo'), 'foobar' => array('foo' => 'bar', 'bar' => array(1, 'foo'))));
protected function setUp()
{
}
protected function tearDown()
{
}
public function testSetIndentation()
{
}
public function testSpecifications()
{
}
public function testInlineLevel()
{
}
public function testObjectSupportEnabled()
{
}
public function testObjectSupportDisabledButNoExceptions()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\DumpException
*/
public function testObjectSupportDisabledWithExceptions()
{
}
/**
* @dataProvider getEscapeSequences
*/
public function testEscapedEscapeSequencesInQuotedScalar($input, $expected)
{
}
public function getEscapeSequences()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The indentation must be greater than zero
*/
public function testZeroIndentationThrowsException()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The indentation must be greater than zero
*/
public function testNegativeIndentationThrowsException()
{
}
}
class A
{
public $a = 'foo';
}
class InlineTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getTestsForParse
*/
public function testParse($yaml, $value)
{
}
/**
* @dataProvider getTestsForParseWithMapObjects
*/
public function testParseWithMapObjects($yaml, $value)
{
}
/**
* @dataProvider getTestsForDump
*/
public function testDump($yaml, $value)
{
}
public function testDumpNumericValueWithLocale()
{
}
public function testHashStringsResemblingExponentialNumericsShouldNotBeChangedToINF()
{
}
/**
* @group legacy
* throws \Symfony\Component\Yaml\Exception\ParseException in 3.0
*/
public function testParseScalarWithNonEscapedBlackslashShouldThrowException()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testParseScalarWithNonEscapedBlackslashAtTheEndShouldThrowException()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testParseScalarWithIncorrectlyQuotedStringShouldThrowException()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testParseScalarWithIncorrectlyDoubleQuotedStringShouldThrowException()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testParseInvalidMappingKeyShouldThrowException()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testParseInvalidMappingShouldThrowException()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
*/
public function testParseInvalidSequenceShouldThrowException()
{
}
public function testParseScalarWithCorrectlyQuotedStringShouldReturnString()
{
}
/**
* @dataProvider getDataForParseReferences
*/
public function testParseReferences($yaml, $expected)
{
}
public function getDataForParseReferences()
{
}
public function testParseMapReferenceInSequence()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
* @expectedExceptionMessage A reference must contain at least one character.
*/
public function testParseUnquotedAsterisk()
{
}
/**
* @expectedException \Symfony\Component\Yaml\Exception\ParseException
* @expectedExceptionMessage A reference must contain at least one character.
*/
public function testParseUnquotedAsteriskFollowedByAComment()
{
}
/**
* @group legacy
* @dataProvider getReservedIndicators
* throws \Symfony\Component\Yaml\Exception\ParseException in 3.0
*/
public function testParseUnquotedScalarStartingWithReservedIndicator($indicator)
{
}
public function getReservedIndicators()
{
}
/**
* @group legacy
* @dataProvider getScalarIndicators
* throws \Symfony\Component\Yaml\Exception\ParseException in 3.0
*/
public function testParseUnquotedScalarStartingWithScalarIndicator($indicator)
{
}
public function getScalarIndicators()
{
}
/**
* @dataProvider getDataForIsHash
*/
public function testIsHash($array, $expected)
{
}
public function getDataForIsHash()
{
}
public function getTestsForParse()
{
}
public function getTestsForParseWithMapObjects()
{
}
public function getTestsForDump()
{
}
}
class ParseExceptionTest extends \PHPUnit_Framework_TestCase
{
public function testGetMessage()
{
}
public function testGetMessageWithUnicodeInFilename()
{
}
}
class YamlTest extends \PHPUnit_Framework_TestCase
{
public function testParseAndDump()
{
}
/**
* @group legacy
*/
public function testLegacyParseFromFile()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The indentation must be greater than zero
*/
public function testZeroIndentationThrowsException()
{
}
/**
* @expectedException \InvalidArgumentException
* @expectedExceptionMessage The indentation must be greater than zero
*/
public function testNegativeIndentationThrowsException()
{
}
}
}
namespace Symfony\Component\Yaml {
/**
* Dumper dumps PHP variables to YAML strings.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class Dumper
{
/**
* The amount of spaces to use for indentation of nested nodes.
*
* @var int
*/
protected $indentation = 4;
/**
* Sets the indentation.
*
* @param int $num The amount of spaces to use for indentation of nested nodes.
*/
public function setIndentation($num)
{
}
/**
* Dumps a PHP value to YAML.
*
* @param mixed $input The PHP value
* @param int $inline The level where you switch to inline YAML
* @param int $indent The level of indentation (used internally)
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
* @param bool $objectSupport true if object support is enabled, false otherwise
*
* @return string The YAML representation of the PHP value
*/
public function dump($input, $inline = 0, $indent = 0, $exceptionOnInvalidType = false, $objectSupport = false)
{
}
}
/**
* Escaper encapsulates escaping rules for single and double-quoted
* YAML strings.
*
* @author Matthew Lewinski <matthew@lewinski.org>
*
* @internal
*/
class Escaper
{
// Characters that would cause a dumped string to require double quoting.
const REGEX_CHARACTER_TO_ESCAPE = "[\\x00-\\x1f]|
| |
|
";
/**
* Determines if a PHP value would require double quoting in YAML.
*
* @param string $value A PHP value
*
* @return bool True if the value would require double quotes.
*/
public static function requiresDoubleQuoting($value)
{
}
/**
* Escapes and surrounds a PHP value with double quotes.
*
* @param string $value A PHP value
*
* @return string The quoted, escaped string
*/
public static function escapeWithDoubleQuotes($value)
{
}
/**
* Determines if a PHP value would require single quoting in YAML.
*
* @param string $value A PHP value
*
* @return bool True if the value would require single quotes.
*/
public static function requiresSingleQuoting($value)
{
}
/**
* Escapes and surrounds a PHP value with single quotes.
*
* @param string $value A PHP value
*
* @return string The quoted, escaped string
*/
public static function escapeWithSingleQuotes($value)
{
}
}
/**
* Unescaper encapsulates unescaping rules for single and double-quoted
* YAML strings.
*
* @author Matthew Lewinski <matthew@lewinski.org>
*
* @internal
*/
class Unescaper
{
/**
* Parser and Inline assume UTF-8 encoding, so escaped Unicode characters
* must be converted to that encoding.
*
* @deprecated since version 2.5, to be removed in 3.0
*
* @internal
*/
const ENCODING = 'UTF-8';
/**
* Regex fragment that matches an escaped character in a double quoted string.
*/
const REGEX_ESCAPED_CHARACTER = '\\\\(x[0-9a-fA-F]{2}|u[0-9a-fA-F]{4}|U[0-9a-fA-F]{8}|.)';
/**
* Unescapes a single quoted string.
*
* @param string $value A single quoted string.
*
* @return string The unescaped string.
*/
public function unescapeSingleQuotedString($value)
{
}
/**
* Unescapes a double quoted string.
*
* @param string $value A double quoted string.
*
* @return string The unescaped string.
*/
public function unescapeDoubleQuotedString($value)
{
}
/**
* Unescapes a character that was found in a double-quoted string.
*
* @param string $value An escaped character
*
* @return string The unescaped character
*
* @internal This method is public to be usable as callback. It should not
* be used in user code. Should be changed in 3.0.
*/
public function unescapeCharacter($value)
{
}
}
}
namespace Symfony\Component\Yaml\Exception {
/**
* Exception interface for all exceptions thrown by the component.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
interface ExceptionInterface
{
}
/**
* Exception class thrown when an error occurs during parsing.
*
* @author Romain Neutron <imprec@gmail.com>
*/
class RuntimeException extends \RuntimeException implements \Symfony\Component\Yaml\Exception\ExceptionInterface
{
}
/**
* Exception class thrown when an error occurs during parsing.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class ParseException extends \Symfony\Component\Yaml\Exception\RuntimeException
{
/**
* Constructor.
*
* @param string $message The error message
* @param int $parsedLine The line where the error occurred
* @param int $snippet The snippet of code near the problem
* @param string $parsedFile The file name where the error occurred
* @param \Exception $previous The previous exception
*/
public function __construct($message, $parsedLine = -1, $snippet = null, $parsedFile = null, \Exception $previous = null)
{
}
/**
* Gets the snippet of code near the error.
*
* @return string The snippet of code
*/
public function getSnippet()
{
}
/**
* Sets the snippet of code near the error.
*
* @param string $snippet The code snippet
*/
public function setSnippet($snippet)
{
}
/**
* Gets the filename where the error occurred.
*
* This method returns null if a string is parsed.
*
* @return string The filename
*/
public function getParsedFile()
{
}
/**
* Sets the filename where the error occurred.
*
* @param string $parsedFile The filename
*/
public function setParsedFile($parsedFile)
{
}
/**
* Gets the line where the error occurred.
*
* @return int The file line
*/
public function getParsedLine()
{
}
/**
* Sets the line where the error occurred.
*
* @param int $parsedLine The file line
*/
public function setParsedLine($parsedLine)
{
}
}
/**
* Exception class thrown when an error occurs during dumping.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class DumpException extends \Symfony\Component\Yaml\Exception\RuntimeException
{
}
}
namespace Symfony\Component\Yaml {
/**
* Parser parses YAML strings to convert them to PHP arrays.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class Parser
{
const BLOCK_SCALAR_HEADER_PATTERN = '(?P<separator>\\||>)(?P<modifiers>\\+|\\-|\\d+|\\+\\d+|\\-\\d+|\\d+\\+|\\d+\\-)?(?P<comments> +#.*)?';
// BC - wrongly named
const FOLDED_SCALAR_PATTERN = self::BLOCK_SCALAR_HEADER_PATTERN;
/**
* Constructor.
*
* @param int $offset The offset of YAML document (used for line numbers in error messages)
* @param int|null $totalNumberOfLines The overall number of lines being parsed
*/
public function __construct($offset = 0, $totalNumberOfLines = null)
{
}
/**
* Parses a YAML string to a PHP value.
*
* @param string $value A YAML string
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
* @param bool $objectSupport true if object support is enabled, false otherwise
* @param bool $objectForMap true if maps should return a stdClass instead of array()
*
* @return mixed A PHP value
*
* @throws ParseException If the YAML is not valid
*/
public function parse($value, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false)
{
}
}
/**
* Yaml offers convenience methods to load and dump YAML.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class Yaml
{
/**
* Parses YAML into a PHP value.
*
* Usage:
* <code>
* $array = Yaml::parse(file_get_contents('config.yml'));
* print_r($array);
* </code>
*
* As this method accepts both plain strings and file names as an input,
* you must validate the input before calling this method. Passing a file
* as an input is a deprecated feature and will be removed in 3.0.
*
* Note: the ability to pass file names to the Yaml::parse method is deprecated since version 2.2 and will be removed in 3.0. Pass the YAML contents of the file instead.
*
* @param string $input Path to a YAML file or a string containing YAML
* @param bool $exceptionOnInvalidType True if an exception must be thrown on invalid types false otherwise
* @param bool $objectSupport True if object support is enabled, false otherwise
* @param bool $objectForMap True if maps should return a stdClass instead of array()
*
* @return mixed The YAML converted to a PHP value
*
* @throws ParseException If the YAML is not valid
*/
public static function parse($input, $exceptionOnInvalidType = false, $objectSupport = false, $objectForMap = false)
{
}
/**
* Dumps a PHP array to a YAML string.
*
* The dump method, when supplied with an array, will do its best
* to convert the array into friendly YAML.
*
* @param array $array PHP array
* @param int $inline The level where you switch to inline YAML
* @param int $indent The amount of spaces to use for indentation of nested nodes.
* @param bool $exceptionOnInvalidType true if an exception must be thrown on invalid types (a PHP resource or object), false otherwise
* @param bool $objectSupport true if object support is enabled, false otherwise
*
* @return string A YAML string representing the original PHP array
*/
public static function dump($array, $inline = 2, $indent = 4, $exceptionOnInvalidType = false, $objectSupport = false)
{
}
}
}
namespace Symfony\Polyfill\Iconv {
/**
* iconv implementation in pure PHP, UTF-8 centric.
*
* Implemented:
* - iconv - Convert string to requested character encoding
* - iconv_mime_decode - Decodes a MIME header field
* - iconv_mime_decode_headers - Decodes multiple MIME header fields at once
* - iconv_get_encoding - Retrieve internal configuration variables of iconv extension
* - iconv_set_encoding - Set current setting for character encoding conversion
* - iconv_mime_encode - Composes a MIME header field
* - iconv_strlen - Returns the character count of string
* - iconv_strpos - Finds position of first occurrence of a needle within a haystack
* - iconv_strrpos - Finds the last occurrence of a needle within a haystack
* - iconv_substr - Cut out part of a string
*
* Charsets available for conversion are defined by files
* in the charset/ directory and by Iconv::$alias below.
* You're welcome to send back any addition you make.
*
* @author Nicolas Grekas <p@tchwork.com>
*
* @internal
*/
final class Iconv
{
const ERROR_ILLEGAL_CHARACTER = 'iconv(): Detected an illegal character in input string';
const ERROR_WRONG_CHARSET = 'iconv(): Wrong charset, conversion from `%s\' to `%s\' is not allowed';
public static $inputEncoding = 'utf-8';
public static $outputEncoding = 'utf-8';
public static $internalEncoding = 'utf-8';
public static function iconv($inCharset, $outCharset, $str)
{
}
public static function iconv_mime_decode_headers($str, $mode = 0, $charset = null)
{
}
public static function iconv_mime_decode($str, $mode = 0, $charset = null)
{
}
public static function iconv_get_encoding($type = 'all')
{
}
public static function iconv_set_encoding($type, $charset)
{
}
public static function iconv_mime_encode($fieldName, $fieldValue, $pref = null)
{
}
public static function iconv_strlen($s, $encoding = null)
{
}
public static function strlen1($s, $encoding = null)
{
}
public static function strlen2($s, $encoding = null)
{
}
public static function iconv_strpos($haystack, $needle, $offset = 0, $encoding = null)
{
}
public static function iconv_strrpos($haystack, $needle, $encoding = null)
{
}
public static function iconv_substr($s, $start, $length = 2147483647, $encoding = null)
{
}
}
}
namespace Symfony\Component\Translation\DataCollector {
/**
* @author Abdellatif Ait boudad <a.aitboudad@gmail.com>
*/
class TranslationDataCollector extends \Symfony\Component\HttpKernel\DataCollector\DataCollector implements \Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface
{
/**
* @param DataCollectorTranslator $translator
*/
public function __construct(\Symfony\Component\Translation\DataCollectorTranslator $translator)
{
}
/**
* {@inheritdoc}
*/
public function lateCollect()
{
}
/**
* {@inheritdoc}
*/
public function collect(\Symfony\Component\HttpFoundation\Request $request, \Symfony\Component\HttpFoundation\Response $response, \Exception $exception = null)
{
}
/**
* @return array
*/
public function getMessages()
{
}
/**
* @return int
*/
public function getCountMissings()
{
}
/**
* @return int
*/
public function getCountFallbacks()
{
}
/**
* @return int
*/
public function getCountDefines()
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
}
}
namespace Symfony\Component\Translation\Tests {
class TranslatorCacheTest extends \PHPUnit_Framework_TestCase
{
protected $tmpDir;
protected function setUp()
{
}
protected function tearDown()
{
}
protected function deleteTmpDir()
{
}
/**
* @dataProvider runForDebugAndProduction
*/
public function testThatACacheIsUsed($debug)
{
}
public function testCatalogueIsReloadedWhenResourcesAreNoLongerFresh()
{
}
/**
* @dataProvider runForDebugAndProduction
*/
public function testDifferentTranslatorsForSameLocaleDoNotOverwriteEachOthersCache($debug)
{
}
public function testDifferentCacheFilesAreUsedForDifferentSetsOfFallbackLocales()
{
}
public function testPrimaryAndFallbackCataloguesContainTheSameMessagesRegardlessOfCaching()
{
}
public function testRefreshCacheWhenResourcesAreNoLongerFresh()
{
}
protected function getCatalogue($locale, $messages, $resources = array())
{
}
public function runForDebugAndProduction()
{
}
}
class StaleResource implements \Symfony\Component\Config\Resource\SelfCheckingResourceInterface
{
public function isFresh($timestamp)
{
}
public function getResource()
{
}
public function __toString()
{
}
}
class IdentityTranslatorTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getTransTests
*/
public function testTrans($expected, $id, $parameters)
{
}
/**
* @dataProvider getTransChoiceTests
*/
public function testTransChoiceWithExplicitLocale($expected, $id, $number, $parameters)
{
}
/**
* @dataProvider getTransChoiceTests
*/
public function testTransChoiceWithDefaultLocale($expected, $id, $number, $parameters)
{
}
public function testGetSetLocale()
{
}
public function testGetLocaleReturnsDefaultLocaleIfNotSet()
{
}
public function getTransTests()
{
}
public function getTransChoiceTests()
{
}
}
}
namespace Symfony\Component\Translation\Tests\DataCollector {
class TranslationDataCollectorTest extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
public function testCollectEmptyMessages()
{
}
public function testCollect()
{
}
}
}
namespace Symfony\Component\Translation\Tests\Dumper {
class JsonFileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testFormatCatalogue()
{
}
public function testDumpWithCustomEncoding()
{
}
}
class CsvFileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testFormatCatalogue()
{
}
}
class FileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testDump()
{
}
public function testDumpBackupsFileIfExisting()
{
}
public function testDumpCreatesNestedDirectoriesAndFile()
{
}
}
}
namespace Symfony\Component\Translation\Dumper {
/**
* DumperInterface is the interface implemented by all translation dumpers.
* There is no common option.
*
* @author Michel Salib <michelsalib@hotmail.com>
*/
interface DumperInterface
{
/**
* Dumps the message catalogue.
*
* @param MessageCatalogue $messages The message catalogue
* @param array $options Options that are used by the dumper
*/
public function dump(\Symfony\Component\Translation\MessageCatalogue $messages, $options = array());
}
/**
* FileDumper is an implementation of DumperInterface that dump a message catalogue to file(s).
* Performs backup of already existing files.
*
* Options:
* - path (mandatory): the directory where the files should be saved
*
* @author Michel Salib <michelsalib@hotmail.com>
*/
abstract class FileDumper implements \Symfony\Component\Translation\Dumper\DumperInterface
{
/**
* A template for the relative paths to files.
*
* @var string
*/
protected $relativePathTemplate = '%domain%.%locale%.%extension%';
/**
* Sets the template for the relative paths to files.
*
* @param string $relativePathTemplate A template for the relative paths to files
*/
public function setRelativePathTemplate($relativePathTemplate)
{
}
/**
* Sets backup flag.
*
* @param bool
*/
public function setBackup($backup)
{
}
/**
* {@inheritdoc}
*/
public function dump(\Symfony\Component\Translation\MessageCatalogue $messages, $options = array())
{
}
/**
* Transforms a domain of a message catalogue to its string representation.
*
* Override this function in child class if $options is used for message formatting.
*
* @param MessageCatalogue $messages
* @param string $domain
* @param array $options
*
* @return string representation
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* Transforms a domain of a message catalogue to its string representation.
*
* @param MessageCatalogue $messages
* @param string $domain
*
* @return string representation
*
* @deprecated since version 2.8, to be removed in 3.0. Overwrite formatCatalogue() instead.
*/
protected function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain)
{
}
/**
* Gets the file extension of the dumper.
*
* @return string file extension
*/
protected abstract function getExtension();
}
}
namespace Symfony\Component\Translation\Tests\Dumper {
class ConcreteFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
protected function getExtension()
{
}
}
class YamlFileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testTreeFormatCatalogue()
{
}
public function testLinearFormatCatalogue()
{
}
}
class MoFileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testFormatCatalogue()
{
}
}
class IcuResFileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testFormatCatalogue()
{
}
}
class PoFileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testFormatCatalogue()
{
}
}
class QtFileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testFormatCatalogue()
{
}
}
class XliffFileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testFormatCatalogue()
{
}
public function testFormatCatalogueXliff2()
{
}
public function testFormatCatalogueWithCustomToolInfo()
{
}
public function testFormatCatalogueWithTargetAttributesMetadata()
{
}
}
class PhpFileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testFormatCatalogue()
{
}
}
class IniFileDumperTest extends \PHPUnit_Framework_TestCase
{
public function testFormatCatalogue()
{
}
}
}
namespace Symfony\Component\Translation\Tests\Util {
class ArrayConverterTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider messsagesData
*/
public function testDump($input, $expectedOutput)
{
}
public function messsagesData()
{
}
}
}
namespace Symfony\Component\Translation\Tests {
class LoggingTranslatorTest extends \PHPUnit_Framework_TestCase
{
public function testTransWithNoTranslationIsLogged()
{
}
public function testTransChoiceFallbackIsLogged()
{
}
}
class DataCollectorTranslatorTest extends \PHPUnit_Framework_TestCase
{
public function testCollectMessages()
{
}
}
}
namespace Symfony\Component\Translation\Tests\Loader {
abstract class LocalizedTestCase extends \PHPUnit_Framework_TestCase
{
protected function setUp()
{
}
}
/**
* @requires extension intl
*/
class IcuDatFileLoaderTest extends \Symfony\Component\Translation\Tests\Loader\LocalizedTestCase
{
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadInvalidResource()
{
}
public function testDatEnglishLoad()
{
}
public function testDatFrenchLoad()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
}
class CsvFileLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testLoad()
{
}
public function testLoadDoesNothingIfEmpty()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadNonLocalResource()
{
}
}
class XliffFileLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testLoad()
{
}
public function testLoadWithInternalErrorsEnabled()
{
}
public function testLoadWithResname()
{
}
public function testIncompleteResource()
{
}
public function testEncoding()
{
}
public function testTargetAttributesAreStoredCorrectly()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadInvalidResource()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadResourceDoesNotValidate()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadThrowsAnExceptionIfFileNotLocal()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
* @expectedExceptionMessage Document types are not allowed.
*/
public function testDocTypeIsNotAllowed()
{
}
public function testParseEmptyFile()
{
}
public function testLoadNotes()
{
}
public function testLoadVersion2()
{
}
}
class IniFileLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testLoad()
{
}
public function testLoadDoesNothingIfEmpty()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
}
class MoFileLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testLoad()
{
}
public function testLoadPlurals()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadInvalidResource()
{
}
public function testLoadEmptyTranslation()
{
}
}
class JsonFileLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testLoad()
{
}
public function testLoadDoesNothingIfEmpty()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
* @expectedExceptionMessage Error parsing JSON - Syntax error, malformed JSON
*/
public function testParseException()
{
}
}
class YamlFileLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testLoad()
{
}
public function testLoadDoesNothingIfEmpty()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadThrowsAnExceptionIfFileNotLocal()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadThrowsAnExceptionIfNotAnArray()
{
}
}
class QtFileLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testLoad()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadNonLocalResource()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadInvalidResource()
{
}
public function testLoadEmptyResource()
{
}
}
class PoFileLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testLoad()
{
}
public function testLoadPlurals()
{
}
public function testLoadDoesNothingIfEmpty()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
public function testLoadEmptyTranslation()
{
}
public function testEscapedId()
{
}
public function testEscapedIdPlurals()
{
}
public function testSkipFuzzyTranslations()
{
}
}
/**
* @requires extension intl
*/
class IcuResFileLoaderTest extends \Symfony\Component\Translation\Tests\Loader\LocalizedTestCase
{
public function testLoad()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadInvalidResource()
{
}
}
class PhpFileLoaderTest extends \PHPUnit_Framework_TestCase
{
public function testLoad()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testLoadNonExistingResource()
{
}
/**
* @expectedException \Symfony\Component\Translation\Exception\InvalidResourceException
*/
public function testLoadThrowsAnExceptionIfFileNotLocal()
{
}
}
}
namespace Symfony\Component\Translation\Tests {
class TranslatorTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getInvalidLocalesTests
* @expectedException \InvalidArgumentException
*/
public function testConstructorInvalidLocale($locale)
{
}
/**
* @dataProvider getValidLocalesTests
*/
public function testConstructorValidLocale($locale)
{
}
public function testConstructorWithoutLocale()
{
}
public function testSetGetLocale()
{
}
/**
* @dataProvider getInvalidLocalesTests
* @expectedException \InvalidArgumentException
*/
public function testSetInvalidLocale($locale)
{
}
/**
* @dataProvider getValidLocalesTests
*/
public function testSetValidLocale($locale)
{
}
public function testGetCatalogue()
{
}
public function testGetCatalogueReturnsConsolidatedCatalogue()
{
}
public function testSetFallbackLocales()
{
}
public function testSetFallbackLocalesMultiple()
{
}
/**
* @dataProvider getInvalidLocalesTests
* @expectedException \InvalidArgumentException
*/
public function testSetFallbackInvalidLocales($locale)
{
}
/**
* @dataProvider getValidLocalesTests
*/
public function testSetFallbackValidLocales($locale)
{
}
public function testTransWithFallbackLocale()
{
}
/**
* @dataProvider getInvalidLocalesTests
* @expectedException \InvalidArgumentException
*/
public function testAddResourceInvalidLocales($locale)
{
}
/**
* @dataProvider getValidLocalesTests
*/
public function testAddResourceValidLocales($locale)
{
}
public function testAddResourceAfterTrans()
{
}
/**
* @dataProvider getTransFileTests
* @expectedException \Symfony\Component\Translation\Exception\NotFoundResourceException
*/
public function testTransWithoutFallbackLocaleFile($format, $loader)
{
}
/**
* @dataProvider getTransFileTests
*/
public function testTransWithFallbackLocaleFile($format, $loader)
{
}
public function testTransWithFallbackLocaleBis()
{
}
public function testTransWithFallbackLocaleTer()
{
}
public function testTransNonExistentWithFallback()
{
}
/**
* @expectedException \RuntimeException
*/
public function testWhenAResourceHasNoRegisteredLoader()
{
}
public function testFallbackCatalogueResources()
{
}
/**
* @dataProvider getTransTests
*/
public function testTrans($expected, $id, $translation, $parameters, $locale, $domain)
{
}
/**
* @dataProvider getInvalidLocalesTests
* @expectedException \InvalidArgumentException
*/
public function testTransInvalidLocale($locale)
{
}
/**
* @dataProvider getValidLocalesTests
*/
public function testTransValidLocale($locale)
{
}
/**
* @dataProvider getFlattenedTransTests
*/
public function testFlattenedTrans($expected, $messages, $id)
{
}
/**
* @dataProvider getTransChoiceTests
*/
public function testTransChoice($expected, $id, $translation, $number, $parameters, $locale, $domain)
{
}
/**
* @dataProvider getInvalidLocalesTests
* @expectedException \InvalidArgumentException
*/
public function testTransChoiceInvalidLocale($locale)
{
}
/**
* @dataProvider getValidLocalesTests
*/
public function testTransChoiceValidLocale($locale)
{
}
public function getTransFileTests()
{
}
public function getTransTests()
{
}
public function getFlattenedTransTests()
{
}
public function getTransChoiceTests()
{
}
public function getInvalidLocalesTests()
{
}
public function getValidLocalesTests()
{
}
public function testTransChoiceFallback()
{
}
public function testTransChoiceFallbackBis()
{
}
public function testTransChoiceFallbackWithNoTranslation()
{
}
/**
* @group legacy
* @dataProvider dataProviderGetMessages
*/
public function testLegacyGetMessages($resources, $locale, $expected)
{
}
public function dataProviderGetMessages()
{
}
}
class StringClass
{
protected $str;
public function __construct($str)
{
}
public function __toString()
{
}
}
class MessageSelectorTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getChooseTests
*/
public function testChoose($expected, $id, $number)
{
}
public function testReturnMessageIfExactlyOneStandardRuleIsGiven()
{
}
/**
* @dataProvider getNonMatchingMessages
* @expectedException \InvalidArgumentException
*/
public function testThrowExceptionIfMatchingMessageCannotBeFound($id, $number)
{
}
public function getNonMatchingMessages()
{
}
public function getChooseTests()
{
}
}
}
namespace Symfony\Component\Translation\Tests\Writer {
class TranslationWriterTest extends \PHPUnit_Framework_TestCase
{
public function testWriteTranslations()
{
}
public function testDisableBackup()
{
}
}
class NonBackupDumper implements \Symfony\Component\Translation\Dumper\DumperInterface
{
public function dump(\Symfony\Component\Translation\MessageCatalogue $messages, $options = array())
{
}
}
class BackupDumper implements \Symfony\Component\Translation\Dumper\DumperInterface
{
public $backup = true;
public function dump(\Symfony\Component\Translation\MessageCatalogue $messages, $options = array())
{
}
public function setBackup($backup)
{
}
}
}
namespace Symfony\Component\Translation\Tests {
/**
* Test should cover all languages mentioned on http://translate.sourceforge.net/wiki/l10n/pluralforms
* and Plural forms mentioned on http://www.gnu.org/software/gettext/manual/gettext.html#Plural-forms.
*
* See also https://developer.mozilla.org/en/Localization_and_Plurals which mentions 15 rules having a maximum of 6 forms.
* The mozilla code is also interesting to check for.
*
* As mentioned by chx http://drupal.org/node/1273968 we can cover all by testing number from 0 to 199
*
* The goal to cover all languages is to far fetched so this test case is smaller.
*
* @author Clemens Tolboom clemens@build2be.nl
*/
class PluralizationRulesTest extends \PHPUnit_Framework_TestCase
{
/**
* We test failed langcode here.
*
* TODO: The languages mentioned in the data provide need to get fixed somehow within PluralizationRules.
*
* @dataProvider failingLangcodes
*/
public function testFailedLangcodes($nplural, $langCodes)
{
}
/**
* @dataProvider successLangcodes
*/
public function testLangcodes($nplural, $langCodes)
{
}
/**
* This array should contain all currently known langcodes.
*
* As it is impossible to have this ever complete we should try as hard as possible to have it almost complete.
*
* @return array
*/
public function successLangcodes()
{
}
/**
* This array should be at least empty within the near future.
*
* This both depends on a complete list trying to add above as understanding
* the plural rules of the current failing languages.
*
* @return array with nplural together with langcodes
*/
public function failingLangcodes()
{
}
/**
* We validate only on the plural coverage. Thus the real rules is not tested.
*
* @param string $nplural plural expected
* @param array $matrix containing langcodes and their plural index values.
* @param bool $expectSuccess
*/
protected function validateMatrix($nplural, $matrix, $expectSuccess = true)
{
}
protected function generateTestData($plural, $langCodes)
{
}
}
class MessageCatalogueTest extends \PHPUnit_Framework_TestCase
{
public function testGetLocale()
{
}
public function testGetDomains()
{
}
public function testAll()
{
}
public function testHas()
{
}
public function testGetSet()
{
}
public function testAdd()
{
}
public function testReplace()
{
}
public function testAddCatalogue()
{
}
public function testAddFallbackCatalogue()
{
}
/**
* @expectedException \LogicException
*/
public function testAddFallbackCatalogueWithParentCircularReference()
{
}
/**
* @expectedException \LogicException
*/
public function testAddFallbackCatalogueWithFallbackCircularReference()
{
}
/**
* @expectedException \LogicException
*/
public function testAddCatalogueWhenLocaleIsNotTheSameAsTheCurrentOne()
{
}
public function testGetAddResource()
{
}
public function testMetadataDelete()
{
}
public function testMetadataSetGetDelete()
{
}
public function testMetadataMerge()
{
}
}
}
namespace Symfony\Component\Translation\Tests\Catalogue {
abstract class AbstractOperationTest extends \PHPUnit_Framework_TestCase
{
public function testGetEmptyDomains()
{
}
public function testGetMergedDomains()
{
}
public function testGetMessagesFromUnknownDomain()
{
}
public function testGetEmptyMessages()
{
}
public function testGetEmptyResult()
{
}
protected abstract function createOperation(\Symfony\Component\Translation\MessageCatalogueInterface $source, \Symfony\Component\Translation\MessageCatalogueInterface $target);
}
class MergeOperationTest extends \Symfony\Component\Translation\Tests\Catalogue\AbstractOperationTest
{
public function testGetMessagesFromSingleDomain()
{
}
public function testGetResultFromSingleDomain()
{
}
public function testGetResultWithMetadata()
{
}
protected function createOperation(\Symfony\Component\Translation\MessageCatalogueInterface $source, \Symfony\Component\Translation\MessageCatalogueInterface $target)
{
}
}
class TargetOperationTest extends \Symfony\Component\Translation\Tests\Catalogue\AbstractOperationTest
{
public function testGetMessagesFromSingleDomain()
{
}
public function testGetResultFromSingleDomain()
{
}
public function testGetResultWithMetadata()
{
}
protected function createOperation(\Symfony\Component\Translation\MessageCatalogueInterface $source, \Symfony\Component\Translation\MessageCatalogueInterface $target)
{
}
}
/**
* @group legacy
*/
class DiffOperationTest extends \Symfony\Component\Translation\Tests\Catalogue\TargetOperationTest
{
protected function createOperation(\Symfony\Component\Translation\MessageCatalogueInterface $source, \Symfony\Component\Translation\MessageCatalogueInterface $target)
{
}
}
}
namespace Symfony\Component\Translation\Tests {
class IntervalTest extends \PHPUnit_Framework_TestCase
{
/**
* @dataProvider getTests
*/
public function testTest($expected, $number, $interval)
{
}
/**
* @expectedException \InvalidArgumentException
*/
public function testTestException()
{
}
public function getTests()
{
}
}
}
namespace Symfony\Component\Translation {
/**
* MessageCatalogueInterface.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
interface MessageCatalogueInterface
{
/**
* Gets the catalogue locale.
*
* @return string The locale
*/
public function getLocale();
/**
* Gets the domains.
*
* @return array An array of domains
*/
public function getDomains();
/**
* Gets the messages within a given domain.
*
* If $domain is null, it returns all messages.
*
* @param string $domain The domain name
*
* @return array An array of messages
*/
public function all($domain = null);
/**
* Sets a message translation.
*
* @param string $id The message id
* @param string $translation The messages translation
* @param string $domain The domain name
*/
public function set($id, $translation, $domain = 'messages');
/**
* Checks if a message has a translation.
*
* @param string $id The message id
* @param string $domain The domain name
*
* @return bool true if the message has a translation, false otherwise
*/
public function has($id, $domain = 'messages');
/**
* Checks if a message has a translation (it does not take into account the fallback mechanism).
*
* @param string $id The message id
* @param string $domain The domain name
*
* @return bool true if the message has a translation, false otherwise
*/
public function defines($id, $domain = 'messages');
/**
* Gets a message translation.
*
* @param string $id The message id
* @param string $domain The domain name
*
* @return string The message translation
*/
public function get($id, $domain = 'messages');
/**
* Sets translations for a given domain.
*
* @param array $messages An array of translations
* @param string $domain The domain name
*/
public function replace($messages, $domain = 'messages');
/**
* Adds translations for a given domain.
*
* @param array $messages An array of translations
* @param string $domain The domain name
*/
public function add($messages, $domain = 'messages');
/**
* Merges translations from the given Catalogue into the current one.
*
* The two catalogues must have the same locale.
*
* @param MessageCatalogueInterface $catalogue A MessageCatalogueInterface instance
*/
public function addCatalogue(\Symfony\Component\Translation\MessageCatalogueInterface $catalogue);
/**
* Merges translations from the given Catalogue into the current one
* only when the translation does not exist.
*
* This is used to provide default translations when they do not exist for the current locale.
*
* @param MessageCatalogueInterface $catalogue A MessageCatalogueInterface instance
*/
public function addFallbackCatalogue(\Symfony\Component\Translation\MessageCatalogueInterface $catalogue);
/**
* Gets the fallback catalogue.
*
* @return MessageCatalogueInterface|null A MessageCatalogueInterface instance or null when no fallback has been set
*/
public function getFallbackCatalogue();
/**
* Returns an array of resources loaded to build this collection.
*
* @return ResourceInterface[] An array of resources
*/
public function getResources();
/**
* Adds a resource for this collection.
*
* @param ResourceInterface $resource A resource instance
*/
public function addResource(\Symfony\Component\Config\Resource\ResourceInterface $resource);
}
/**
* MetadataAwareInterface.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
interface MetadataAwareInterface
{
/**
* Gets metadata for the given domain and key.
*
* Passing an empty domain will return an array with all metadata indexed by
* domain and then by key. Passing an empty key will return an array with all
* metadata for the given domain.
*
* @param string $key The key
* @param string $domain The domain name
*
* @return mixed The value that was set or an array with the domains/keys or null
*/
public function getMetadata($key = '', $domain = 'messages');
/**
* Adds metadata to a message domain.
*
* @param string $key The key
* @param mixed $value The value
* @param string $domain The domain name
*/
public function setMetadata($key, $value, $domain = 'messages');
/**
* Deletes metadata for the given key and domain.
*
* Passing an empty domain will delete all metadata. Passing an empty key will
* delete all metadata for the given domain.
*
* @param string $key The key
* @param string $domain The domain name
*/
public function deleteMetadata($key = '', $domain = 'messages');
}
}
namespace Symfony\Component\Translation\Dumper {
/**
* PoFileDumper generates a gettext formatted string representation of a message catalogue.
*
* @author Stealth35
*/
class PoFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
/**
* {@inheritdoc}
*/
public function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* {@inheritdoc}
*/
protected function getExtension()
{
}
}
/**
* MoFileDumper generates a gettext formatted string representation of a message catalogue.
*
* @author Stealth35
*/
class MoFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
/**
* {@inheritdoc}
*/
public function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* {@inheritdoc}
*/
protected function getExtension()
{
}
}
/**
* IniFileDumper generates an ini formatted string representation of a message catalogue.
*
* @author Stealth35
*/
class IniFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
/**
* {@inheritdoc}
*/
public function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* {@inheritdoc}
*/
protected function getExtension()
{
}
}
/**
* YamlFileDumper generates yaml files from a message catalogue.
*
* @author Michel Salib <michelsalib@hotmail.com>
*/
class YamlFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
/**
* {@inheritdoc}
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* {@inheritdoc}
*/
protected function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain)
{
}
/**
* {@inheritdoc}
*/
protected function getExtension()
{
}
}
/**
* QtFileDumper generates ts files from a message catalogue.
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
*/
class QtFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
/**
* {@inheritdoc}
*/
public function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain)
{
}
/**
* {@inheritdoc}
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* {@inheritdoc}
*/
protected function getExtension()
{
}
}
/**
* CsvFileDumper generates a csv formatted string representation of a message catalogue.
*
* @author Stealth35
*/
class CsvFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
/**
* {@inheritdoc}
*/
public function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* Sets the delimiter and escape character for CSV.
*
* @param string $delimiter delimiter character
* @param string $enclosure enclosure character
*/
public function setCsvControl($delimiter = ';', $enclosure = '"')
{
}
/**
* {@inheritdoc}
*/
protected function getExtension()
{
}
}
/**
* JsonFileDumper generates an json formatted string representation of a message catalogue.
*
* @author singles
*/
class JsonFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
/**
* {@inheritdoc}
*/
public function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* {@inheritdoc}
*/
protected function getExtension()
{
}
}
/**
* IcuResDumper generates an ICU ResourceBundle formatted string representation of a message catalogue.
*
* @author Stealth35
*/
class IcuResFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
/**
* {@inheritdoc}
*/
protected $relativePathTemplate = '%domain%/%locale%.%extension%';
/**
* {@inheritdoc}
*/
public function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* {@inheritdoc}
*/
protected function getExtension()
{
}
}
/**
* XliffFileDumper generates xliff files from a message catalogue.
*
* @author Michel Salib <michelsalib@hotmail.com>
*/
class XliffFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
/**
* {@inheritdoc}
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* {@inheritdoc}
*/
protected function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain)
{
}
/**
* {@inheritdoc}
*/
protected function getExtension()
{
}
}
/**
* PhpFileDumper generates PHP files from a message catalogue.
*
* @author Michel Salib <michelsalib@hotmail.com>
*/
class PhpFileDumper extends \Symfony\Component\Translation\Dumper\FileDumper
{
/**
* {@inheritdoc}
*/
protected function format(\Symfony\Component\Translation\MessageCatalogue $messages, $domain)
{
}
/**
* {@inheritdoc}
*/
public function formatCatalogue(\Symfony\Component\Translation\MessageCatalogue $messages, $domain, array $options = array())
{
}
/**
* {@inheritdoc}
*/
protected function getExtension()
{
}
}
}
namespace Symfony\Component\Translation {
/**
* MessageSelector.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Bernhard Schussek <bschussek@gmail.com>
*/
class MessageSelector
{
/**
* Given a message with different plural translations separated by a
* pipe (|), this method returns the correct portion of the message based
* on the given number, locale and the pluralization rules in the message
* itself.
*
* The message supports two different types of pluralization rules:
*
* interval: {0} There are no apples|{1} There is one apple|]1,Inf] There are %count% apples
* indexed: There is one apple|There are %count% apples
*
* The indexed solution can also contain labels (e.g. one: There is one apple).
* This is purely for making the translations more clear - it does not
* affect the functionality.
*
* The two methods can also be mixed:
* {0} There are no apples|one: There is one apple|more: There are %count% apples
*
* @param string $message The message being translated
* @param int $number The number of items represented for the message
* @param string $locale The locale to use for choosing
*
* @return string
*
* @throws \InvalidArgumentException
*/
public function choose($message, $number, $locale)
{
}
}
/**
* Tests if a given number belongs to a given math interval.
*
* An interval can represent a finite set of numbers:
*
* {1,2,3,4}
*
* An interval can represent numbers between two numbers:
*
* [1, +Inf]
* ]-1,2[
*
* The left delimiter can be [ (inclusive) or ] (exclusive).
* The right delimiter can be [ (exclusive) or ] (inclusive).
* Beside numbers, you can use -Inf and +Inf for the infinite.
*
* @author Fabien Potencier <fabien@symfony.com>
*
* @see http://en.wikipedia.org/wiki/Interval_%28mathematics%29#The_ISO_notation
*/
class Interval
{
/**
* Tests if the given number is in the math interval.
*
* @param int $number A number
* @param string $interval An interval
*
* @return bool
*
* @throws \InvalidArgumentException
*/
public static function test($number, $interval)
{
}
/**
* Returns a Regexp that matches valid intervals.
*
* @return string A Regexp (without the delimiters)
*/
public static function getIntervalRegexp()
{
}
}
/**
* TranslatorInterface.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
interface TranslatorInterface
{
/**
* Translates the given message.
*
* @param string $id The message id (may also be an object that can be cast to string)
* @param array $parameters An array of parameters for the message
* @param string|null $domain The domain for the message or null to use the default
* @param string|null $locale The locale or null to use the default
*
* @return string The translated string
*
* @throws \InvalidArgumentException If the locale contains invalid characters
*/
public function trans($id, array $parameters = array(), $domain = null, $locale = null);
/**
* Translates the given choice message by choosing a translation according to a number.
*
* @param string $id The message id (may also be an object that can be cast to string)
* @param int $number The number to use to find the indice of the message
* @param array $parameters An array of parameters for the message
* @param string|null $domain The domain for the message or null to use the default
* @param string|null $locale The locale or null to use the default
*
* @return string The translated string
*
* @throws \InvalidArgumentException If the locale contains invalid characters
*/
public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null);
/**
* Sets the current locale.
*
* @param string $locale The locale
*
* @throws \InvalidArgumentException If the locale contains invalid characters
*/
public function setLocale($locale);
/**
* Returns the current locale.
*
* @return string The locale
*/
public function getLocale();
}
/**
* TranslatorBagInterface.
*
* @author Abdellatif Ait boudad <a.aitboudad@gmail.com>
*/
interface TranslatorBagInterface
{
/**
* Gets the catalogue by locale.
*
* @param string|null $locale The locale or null to use the default
*
* @return MessageCatalogueInterface
*
* @throws \InvalidArgumentException If the locale contains invalid characters
*/
public function getCatalogue($locale = null);
}
/**
* Translator.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class Translator implements \Symfony\Component\Translation\TranslatorInterface, \Symfony\Component\Translation\TranslatorBagInterface
{
/**
* @var MessageCatalogueInterface[]
*/
protected $catalogues = array();
/**
* @var string
*/
protected $locale;
/**
* Constructor.
*
* @param string $locale The locale
* @param MessageSelector|null $selector The message selector for pluralization
* @param string|null $cacheDir The directory to use for the cache
* @param bool $debug Use cache in debug mode ?
*
* @throws \InvalidArgumentException If a locale contains invalid characters
*/
public function __construct($locale, \Symfony\Component\Translation\MessageSelector $selector = null, $cacheDir = null, $debug = false)
{
}
/**
* Sets the ConfigCache factory to use.
*
* @param ConfigCacheFactoryInterface $configCacheFactory
*/
public function setConfigCacheFactory(\Symfony\Component\Config\ConfigCacheFactoryInterface $configCacheFactory)
{
}
/**
* Adds a Loader.
*
* @param string $format The name of the loader (@see addResource())
* @param LoaderInterface $loader A LoaderInterface instance
*/
public function addLoader($format, \Symfony\Component\Translation\Loader\LoaderInterface $loader)
{
}
/**
* Adds a Resource.
*
* @param string $format The name of the loader (@see addLoader())
* @param mixed $resource The resource name
* @param string $locale The locale
* @param string $domain The domain
*
* @throws \InvalidArgumentException If the locale contains invalid characters
*/
public function addResource($format, $resource, $locale, $domain = null)
{
}
/**
* {@inheritdoc}
*/
public function setLocale($locale)
{
}
/**
* {@inheritdoc}
*/
public function getLocale()
{
}
/**
* Sets the fallback locale(s).
*
* @param string|array $locales The fallback locale(s)
*
* @throws \InvalidArgumentException If a locale contains invalid characters
*
* @deprecated since version 2.3, to be removed in 3.0. Use setFallbackLocales() instead.
*/
public function setFallbackLocale($locales)
{
}
/**
* Sets the fallback locales.
*
* @param array $locales The fallback locales
*
* @throws \InvalidArgumentException If a locale contains invalid characters
*/
public function setFallbackLocales(array $locales)
{
}
/**
* Gets the fallback locales.
*
* @return array $locales The fallback locales
*/
public function getFallbackLocales()
{
}
/**
* {@inheritdoc}
*/
public function trans($id, array $parameters = array(), $domain = null, $locale = null)
{
}
/**
* {@inheritdoc}
*/
public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null)
{
}
/**
* {@inheritdoc}
*/
public function getCatalogue($locale = null)
{
}
/**
* Gets the loaders.
*
* @return array LoaderInterface[]
*/
protected function getLoaders()
{
}
/**
* Collects all messages for the given locale.
*
* @param string|null $locale Locale of translations, by default is current locale
*
* @return array[array] indexed by catalog
*
* @deprecated since version 2.8, to be removed in 3.0. Use TranslatorBagInterface::getCatalogue() method instead.
*/
public function getMessages($locale = null)
{
}
/**
* @param string $locale
*/
protected function loadCatalogue($locale)
{
}
/**
* @param string $locale
*/
protected function initializeCatalogue($locale)
{
}
/**
* This method is public because it needs to be callable from a closure in PHP 5.3. It should be made protected (or even private, if possible) in 3.0.
*
* @internal
*/
public function dumpCatalogue($locale, \Symfony\Component\Config\ConfigCacheInterface $cache)
{
}
protected function computeFallbackLocales($locale)
{
}
/**
* Asserts that the locale is valid, throws an Exception if not.
*
* @param string $locale Locale to tests
*
* @throws \InvalidArgumentException If the locale contains invalid characters
*/
protected function assertValidLocale($locale)
{
}
}
}
namespace Symfony\Component\Translation\Util {
/**
* ArrayConverter generates tree like structure from a message catalogue.
* e.g. this
* 'foo.bar1' => 'test1',
* 'foo.bar2' => 'test2'
* converts to follows:
* foo:
* bar1: test1
* bar2: test2.
*
* @author Gennady Telegin <gtelegin@gmail.com>
*/
class ArrayConverter
{
/**
* Converts linear messages array to tree-like array.
* For example this rray('foo.bar' => 'value') will be converted to array('foo' => array('bar' => 'value')).
*
* @param array $messages Linear messages array
*
* @return array Tree-like messages array
*/
public static function expandToTree(array $messages)
{
}
}
}
namespace Symfony\Component\Translation {
/**
* MessageCatalogue.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class MessageCatalogue implements \Symfony\Component\Translation\MessageCatalogueInterface, \Symfony\Component\Translation\MetadataAwareInterface
{
/**
* Constructor.
*
* @param string $locale The locale
* @param array $messages An array of messages classified by domain
*/
public function __construct($locale, array $messages = array())
{
}
/**
* {@inheritdoc}
*/
public function getLocale()
{
}
/**
* {@inheritdoc}
*/
public function getDomains()
{
}
/**
* {@inheritdoc}
*/
public function all($domain = null)
{
}
/**
* {@inheritdoc}
*/
public function set($id, $translation, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function has($id, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function defines($id, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function get($id, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function replace($messages, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function add($messages, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function addCatalogue(\Symfony\Component\Translation\MessageCatalogueInterface $catalogue)
{
}
/**
* {@inheritdoc}
*/
public function addFallbackCatalogue(\Symfony\Component\Translation\MessageCatalogueInterface $catalogue)
{
}
/**
* {@inheritdoc}
*/
public function getFallbackCatalogue()
{
}
/**
* {@inheritdoc}
*/
public function getResources()
{
}
/**
* {@inheritdoc}
*/
public function addResource(\Symfony\Component\Config\Resource\ResourceInterface $resource)
{
}
/**
* {@inheritdoc}
*/
public function getMetadata($key = '', $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function setMetadata($key, $value, $domain = 'messages')
{
}
/**
* {@inheritdoc}
*/
public function deleteMetadata($key = '', $domain = 'messages')
{
}
}
/**
* Returns the plural rules for a given locale.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class PluralizationRules
{
/**
* Returns the plural position to use for the given locale and number.
*
* @param int $number The number
* @param string $locale The locale
*
* @return int The plural position
*/
public static function get($number, $locale)
{
}
/**
* Overrides the default plural rule for a given locale.
*
* @param callable $rule A PHP callable
* @param string $locale The locale
*
* @throws \LogicException
*/
public static function set($rule, $locale)
{
}
}
}
namespace Symfony\Component\Translation\Extractor {
/**
* Base class used by classes that extract translation messages from files.
*
* @author Marcos D. Sánchez <marcosdsanchez@gmail.com>
*/
abstract class AbstractFileExtractor
{
/**
* @param string|array $resource files, a file or a directory
*
* @return array
*/
protected function extractFiles($resource)
{
}
/**
* @param string $file
*
* @return bool
*
* @throws \InvalidArgumentException
*/
protected function isFile($file)
{
}
/**
* @param string $file
*
* @return bool
*/
protected abstract function canBeExtracted($file);
/**
* @param string|array $resource files, a file or a directory
*
* @return array files to be extracted
*/
protected abstract function extractFromDirectory($resource);
}
/**
* Extracts translation messages from a directory or files to the catalogue.
* New found messages are injected to the catalogue using the prefix.
*
* @author Michel Salib <michelsalib@hotmail.com>
*/
interface ExtractorInterface
{
/**
* Extracts translation messages from files, a file or a directory to the catalogue.
*
* @param string|array $resource files, a file or a directory
* @param MessageCatalogue $catalogue The catalogue
*/
public function extract($resource, \Symfony\Component\Translation\MessageCatalogue $catalogue);
/**
* Sets the prefix that should be used for new found messages.
*
* @param string $prefix The prefix
*/
public function setPrefix($prefix);
}
/**
* ChainExtractor extracts translation messages from template files.
*
* @author Michel Salib <michelsalib@hotmail.com>
*/
class ChainExtractor implements \Symfony\Component\Translation\Extractor\ExtractorInterface
{
/**
* Adds a loader to the translation extractor.
*
* @param string $format The format of the loader
* @param ExtractorInterface $extractor The loader
*/
public function addExtractor($format, \Symfony\Component\Translation\Extractor\ExtractorInterface $extractor)
{
}
/**
* {@inheritdoc}
*/
public function setPrefix($prefix)
{
}
/**
* {@inheritdoc}
*/
public function extract($directory, \Symfony\Component\Translation\MessageCatalogue $catalogue)
{
}
}
}
namespace Symfony\Component\Translation\Loader {
/**
* LoaderInterface is the interface implemented by all translation loaders.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
interface LoaderInterface
{
/**
* Loads a locale.
*
* @param mixed $resource A resource
* @param string $locale A locale
* @param string $domain The domain
*
* @return MessageCatalogue A MessageCatalogue instance
*
* @throws NotFoundResourceException when the resource cannot be found
* @throws InvalidResourceException when the resource cannot be loaded
*/
public function load($resource, $locale, $domain = 'messages');
}
/**
* ArrayLoader loads translations from a PHP array.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class ArrayLoader implements \Symfony\Component\Translation\Loader\LoaderInterface
{
/**
* {@inheritdoc}
*/
public function load($resource, $locale, $domain = 'messages')
{
}
}
/**
* @author Abdellatif Ait boudad <a.aitboudad@gmail.com>
*/
abstract class FileLoader extends \Symfony\Component\Translation\Loader\ArrayLoader
{
/**
* {@inheritdoc}
*/
public function load($resource, $locale, $domain = 'messages')
{
}
/*
* @param string $resource
*
* @return array
*
* @throws InvalidResourceException If stream content has an invalid format.
*/
protected abstract function loadResource($resource);
}
/**
* IniFileLoader loads translations from an ini file.
*
* @author stealth35
*/
class IniFileLoader extends \Symfony\Component\Translation\Loader\FileLoader
{
/**
* {@inheritdoc}
*/
protected function loadResource($resource)
{
}
}
/**
* YamlFileLoader loads translations from Yaml files.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class YamlFileLoader extends \Symfony\Component\Translation\Loader\FileLoader
{
/**
* {@inheritdoc}
*/
protected function loadResource($resource)
{
}
}
/**
* IcuResFileLoader loads translations from a resource bundle.
*
* @author stealth35
*/
class IcuResFileLoader implements \Symfony\Component\Translation\Loader\LoaderInterface
{
/**
* {@inheritdoc}
*/
public function load($resource, $locale, $domain = 'messages')
{
}
/**
* Flattens an ResourceBundle.
*
* The scheme used is:
* key { key2 { key3 { "value" } } }
* Becomes:
* 'key.key2.key3' => 'value'
*
* This function takes an array by reference and will modify it
*
* @param \ResourceBundle $rb the ResourceBundle that will be flattened
* @param array $messages used internally for recursive calls
* @param string $path current path being parsed, used internally for recursive calls
*
* @return array the flattened ResourceBundle
*/
protected function flatten(\ResourceBundle $rb, array &$messages = array(), $path = null)
{
}
}
/**
* IcuResFileLoader loads translations from a resource bundle.
*
* @author stealth35
*/
class IcuDatFileLoader extends \Symfony\Component\Translation\Loader\IcuResFileLoader
{
/**
* {@inheritdoc}
*/
public function load($resource, $locale, $domain = 'messages')
{
}
}
/**
* XliffFileLoader loads translations from XLIFF files.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class XliffFileLoader implements \Symfony\Component\Translation\Loader\LoaderInterface
{
/**
* {@inheritdoc}
*/
public function load($resource, $locale, $domain = 'messages')
{
}
}
/**
* QtFileLoader loads translations from QT Translations XML files.
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
*/
class QtFileLoader implements \Symfony\Component\Translation\Loader\LoaderInterface
{
/**
* {@inheritdoc}
*/
public function load($resource, $locale, $domain = 'messages')
{
}
}
/**
* @copyright Copyright (c) 2010, Union of RAD http://union-of-rad.org (http://lithify.me/)
*/
class MoFileLoader extends \Symfony\Component\Translation\Loader\FileLoader
{
/**
* Magic used for validating the format of a MO file as well as
* detecting if the machine used to create that file was little endian.
*
* @var float
*/
const MO_LITTLE_ENDIAN_MAGIC = 0x950412de;
/**
* Magic used for validating the format of a MO file as well as
* detecting if the machine used to create that file was big endian.
*
* @var float
*/
const MO_BIG_ENDIAN_MAGIC = 0xde120495;
/**
* The size of the header of a MO file in bytes.
*
* @var int Number of bytes.
*/
const MO_HEADER_SIZE = 28;
/**
* Parses machine object (MO) format, independent of the machine's endian it
* was created on. Both 32bit and 64bit systems are supported.
*
* {@inheritdoc}
*/
protected function loadResource($resource)
{
}
}
/**
* JsonFileLoader loads translations from an json file.
*
* @author singles
*/
class JsonFileLoader extends \Symfony\Component\Translation\Loader\FileLoader
{
/**
* {@inheritdoc}
*/
protected function loadResource($resource)
{
}
}
/**
* CsvFileLoader loads translations from CSV files.
*
* @author Saša Stamenković <umpirsky@gmail.com>
*/
class CsvFileLoader extends \Symfony\Component\Translation\Loader\FileLoader
{
/**
* {@inheritdoc}
*/
protected function loadResource($resource)
{
}
/**
* Sets the delimiter, enclosure, and escape character for CSV.
*
* @param string $delimiter delimiter character
* @param string $enclosure enclosure character
* @param string $escape escape character
*/
public function setCsvControl($delimiter = ';', $enclosure = '"', $escape = '\\')
{
}
}
/**
* PhpFileLoader loads translations from PHP files returning an array of translations.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class PhpFileLoader extends \Symfony\Component\Translation\Loader\FileLoader
{
/**
* {@inheritdoc}
*/
protected function loadResource($resource)
{
}
}
/**
* @copyright Copyright (c) 2010, Union of RAD http://union-of-rad.org (http://lithify.me/)
* @copyright Copyright (c) 2012, Clemens Tolboom
*/
class PoFileLoader extends \Symfony\Component\Translation\Loader\FileLoader
{
/**
* Parses portable object (PO) format.
*
* From http://www.gnu.org/software/gettext/manual/gettext.html#PO-Files
* we should be able to parse files having:
*
* white-space
* # translator-comments
* #. extracted-comments
* #: reference...
* #, flag...
* #| msgid previous-untranslated-string
* msgid untranslated-string
* msgstr translated-string
*
* extra or different lines are:
*
* #| msgctxt previous-context
* #| msgid previous-untranslated-string
* msgctxt context
*
* #| msgid previous-untranslated-string-singular
* #| msgid_plural previous-untranslated-string-plural
* msgid untranslated-string-singular
* msgid_plural untranslated-string-plural
* msgstr[0] translated-string-case-0
* ...
* msgstr[N] translated-string-case-n
*
* The definition states:
* - white-space and comments are optional.
* - msgid "" that an empty singleline defines a header.
*
* This parser sacrifices some features of the reference implementation the
* differences to that implementation are as follows.
* - No support for comments spanning multiple lines.
* - Translator and extracted comments are treated as being the same type.
* - Message IDs are allowed to have other encodings as just US-ASCII.
*
* Items with an empty id are ignored.
*
* {@inheritdoc}
*/
protected function loadResource($resource)
{
}
}
}
namespace Symfony\Component\Translation\Writer {
/**
* TranslationWriter writes translation messages.
*
* @author Michel Salib <michelsalib@hotmail.com>
*/
class TranslationWriter
{
/**
* Adds a dumper to the writer.
*
* @param string $format The format of the dumper
* @param DumperInterface $dumper The dumper
*/
public function addDumper($format, \Symfony\Component\Translation\Dumper\DumperInterface $dumper)
{
}
/**
* Disables dumper backup.
*/
public function disableBackup()
{
}
/**
* Obtains the list of supported formats.
*
* @return array
*/
public function getFormats()
{
}
/**
* Writes translation from the catalogue according to the selected format.
*
* @param MessageCatalogue $catalogue The message catalogue to dump
* @param string $format The format to use to dump the messages
* @param array $options Options that are passed to the dumper
*
* @throws \InvalidArgumentException
*/
public function writeTranslations(\Symfony\Component\Translation\MessageCatalogue $catalogue, $format, $options = array())
{
}
}
}
namespace Symfony\Component\Translation {
/**
* IdentityTranslator does not translate anything.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class IdentityTranslator implements \Symfony\Component\Translation\TranslatorInterface
{
/**
* Constructor.
*
* @param MessageSelector|null $selector The message selector for pluralization
*/
public function __construct(\Symfony\Component\Translation\MessageSelector $selector = null)
{
}
/**
* {@inheritdoc}
*/
public function setLocale($locale)
{
}
/**
* {@inheritdoc}
*/
public function getLocale()
{
}
/**
* {@inheritdoc}
*/
public function trans($id, array $parameters = array(), $domain = null, $locale = null)
{
}
/**
* {@inheritdoc}
*/
public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null)
{
}
}
/**
* @author Abdellatif Ait boudad <a.aitboudad@gmail.com>
*/
class LoggingTranslator implements \Symfony\Component\Translation\TranslatorInterface, \Symfony\Component\Translation\TranslatorBagInterface
{
/**
* @param TranslatorInterface $translator The translator must implement TranslatorBagInterface
* @param LoggerInterface $logger
*/
public function __construct(\Symfony\Component\Translation\TranslatorInterface $translator, \Psr\Log\LoggerInterface $logger)
{
}
/**
* {@inheritdoc}
*/
public function trans($id, array $parameters = array(), $domain = null, $locale = null)
{
}
/**
* {@inheritdoc}
*/
public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null)
{
}
/**
* {@inheritdoc}
*/
public function setLocale($locale)
{
}
/**
* {@inheritdoc}
*/
public function getLocale()
{
}
/**
* {@inheritdoc}
*/
public function getCatalogue($locale = null)
{
}
/**
* Passes through all unknown calls onto the translator object.
*/
public function __call($method, $args)
{
}
}
}
namespace Symfony\Component\Translation\Exception {
/**
* Exception interface for all exceptions thrown by the component.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
interface ExceptionInterface
{
}
/**
* Thrown when a resource cannot be loaded.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class InvalidResourceException extends \InvalidArgumentException implements \Symfony\Component\Translation\Exception\ExceptionInterface
{
}
/**
* Thrown when a resource does not exist.
*
* @author Fabien Potencier <fabien@symfony.com>
*/
class NotFoundResourceException extends \InvalidArgumentException implements \Symfony\Component\Translation\Exception\ExceptionInterface
{
}
}
namespace Symfony\Component\Translation\Catalogue {
/**
* Represents an operation on catalogue(s).
*
* An instance of this interface performs an operation on one or more catalogues and
* stores intermediate and final results of the operation.
*
* The first catalogue in its argument(s) is called the 'source catalogue' or 'source' and
* the following results are stored:
*
* Messages: also called 'all', are valid messages for the given domain after the operation is performed.
*
* New Messages: also called 'new' (new = all ∖ source = {x: x ∈ all ∧ x ∉ source}).
*
* Obsolete Messages: also called 'obsolete' (obsolete = source ∖ all = {x: x ∈ source ∧ x ∉ all}).
*
* Result: also called 'result', is the resulting catalogue for the given domain that holds the same messages as 'all'.
*
* @author Jean-François Simon <jeanfrancois.simon@sensiolabs.com>
*/
interface OperationInterface
{
/**
* Returns domains affected by operation.
*
* @return array
*/
public function getDomains();
/**
* Returns all valid messages ('all') after operation.
*
* @param string $domain
*
* @return array
*/
public function getMessages($domain);
/**
* Returns new messages ('new') after operation.
*
* @param string $domain
*
* @return array
*/
public function getNewMessages($domain);
/**
* Returns obsolete messages ('obsolete') after operation.
*
* @param string $domain
*
* @return array
*/
public function getObsoleteMessages($domain);
/**
* Returns resulting catalogue ('result').
*
* @return MessageCatalogueInterface
*/
public function getResult();
}
/**
* Base catalogues binary operation class.
*
* A catalogue binary operation performs operation on
* source (the left argument) and target (the right argument) catalogues.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*/
abstract class AbstractOperation implements \Symfony\Component\Translation\Catalogue\OperationInterface
{
/**
* @var MessageCatalogueInterface The source catalogue
*/
protected $source;
/**
* @var MessageCatalogueInterface The target catalogue
*/
protected $target;
/**
* @var MessageCatalogue The result catalogue
*/
protected $result;
/**
* This array stores 'all', 'new' and 'obsolete' messages for all valid domains.
*
* The data structure of this array is as follows:
* ```php
* array(
* 'domain 1' => array(
* 'all' => array(...),
* 'new' => array(...),
* 'obsolete' => array(...)
* ),
* 'domain 2' => array(
* 'all' => array(...),
* 'new' => array(...),
* 'obsolete' => array(...)
* ),
* ...
* )
* ```
*
* @var array The array that stores 'all', 'new' and 'obsolete' messages
*/
protected $messages;
/**
* @param MessageCatalogueInterface $source The source catalogue
* @param MessageCatalogueInterface $target The target catalogue
*
* @throws \LogicException
*/
public function __construct(\Symfony\Component\Translation\MessageCatalogueInterface $source, \Symfony\Component\Translation\MessageCatalogueInterface $target)
{
}
/**
* {@inheritdoc}
*/
public function getDomains()
{
}
/**
* {@inheritdoc}
*/
public function getMessages($domain)
{
}
/**
* {@inheritdoc}
*/
public function getNewMessages($domain)
{
}
/**
* {@inheritdoc}
*/
public function getObsoleteMessages($domain)
{
}
/**
* {@inheritdoc}
*/
public function getResult()
{
}
/**
* Performs operation on source and target catalogues for the given domain and
* stores the results.
*
* @param string $domain The domain which the operation will be performed for
*/
protected abstract function processDomain($domain);
}
/**
* Target operation between two catalogues:
* intersection = source ∩ target = {x: x ∈ source ∧ x ∈ target}
* all = intersection ∪ (target ∖ intersection) = target
* new = all ∖ source = {x: x ∈ target ∧ x ∉ source}
* obsolete = source ∖ all = source ∖ target = {x: x ∈ source ∧ x ∉ target}
* Basically, the result contains messages from the target catalogue.
*
* @author Michael Lee <michael.lee@zerustech.com>
*/
class TargetOperation extends \Symfony\Component\Translation\Catalogue\AbstractOperation
{
/**
* {@inheritdoc}
*/
protected function processDomain($domain)
{
}
}
/**
* Diff operation between two catalogues.
*
* The name of 'Diff' is misleading because the operation
* has nothing to do with diff:
*
* intersection = source ∩ target = {x: x ∈ source ∧ x ∈ target}
* all = intersection ∪ (target ∖ intersection) = target
* new = all ∖ source = {x: x ∈ target ∧ x ∉ source}
* obsolete = source ∖ all = source ∖ target = {x: x ∈ source ∧ x ∉ target}
*
* @author Jean-François Simon <contact@jfsimon.fr>
*
* @deprecated since version 2.8, to be removed in 3.0. Use TargetOperation instead.
*/
class DiffOperation extends \Symfony\Component\Translation\Catalogue\TargetOperation
{
}
/**
* Merge operation between two catalogues as follows:
* all = source ∪ target = {x: x ∈ source ∨ x ∈ target}
* new = all ∖ source = {x: x ∈ target ∧ x ∉ source}
* obsolete = source ∖ all = {x: x ∈ source ∧ x ∉ source ∧ x ∉ target} = ∅
* Basically, the result contains messages from both catalogues.
*
* @author Jean-François Simon <contact@jfsimon.fr>
*/
class MergeOperation extends \Symfony\Component\Translation\Catalogue\AbstractOperation
{
/**
* {@inheritdoc}
*/
protected function processDomain($domain)
{
}
}
}
namespace Symfony\Component\Translation {
/**
* @author Abdellatif Ait boudad <a.aitboudad@gmail.com>
*/
class DataCollectorTranslator implements \Symfony\Component\Translation\TranslatorInterface, \Symfony\Component\Translation\TranslatorBagInterface
{
const MESSAGE_DEFINED = 0;
const MESSAGE_MISSING = 1;
const MESSAGE_EQUALS_FALLBACK = 2;
/**
* @param TranslatorInterface $translator The translator must implement TranslatorBagInterface
*/
public function __construct(\Symfony\Component\Translation\TranslatorInterface $translator)
{
}
/**
* {@inheritdoc}
*/
public function trans($id, array $parameters = array(), $domain = null, $locale = null)
{
}
/**
* {@inheritdoc}
*/
public function transChoice($id, $number, array $parameters = array(), $domain = null, $locale = null)
{
}
/**
* {@inheritdoc}
*/
public function setLocale($locale)
{
}
/**
* {@inheritdoc}
*/
public function getLocale()
{
}
/**
* {@inheritdoc}
*/
public function getCatalogue($locale = null)
{
}
/**
* Passes through all unknown calls onto the translator object.
*/
public function __call($method, $args)
{
}
/**
* @return array
*/
public function getCollectedMessages()
{
}
}
}
namespace Whoops\Util {
/**
* Used as output callable for Symfony\Component\VarDumper\Dumper\HtmlDumper::dump()
*
* @see TemplateHelper::dump()
*/
class HtmlDumperOutput
{
public function __invoke($line, $depth)
{
}
public function getOutput()
{
}
public function clear()
{
}
}
/**
* Exposes useful tools for working with/in templates
*/
class TemplateHelper
{
public function __construct()
{
}
/**
* Escapes a string for output in an HTML document
*
* @param string $raw
* @return string
*/
public function escape($raw)
{
}
/**
* Escapes a string for output in an HTML document, but preserves
* URIs within it, and converts them to clickable anchor elements.
*
* @param string $raw
* @return string
*/
public function escapeButPreserveUris($raw)
{
}
/**
* Makes sure that the given string breaks on the delimiter.
*
* @param string $delimiter
* @param string $s
* @return string
*/
public function breakOnDelimiter($delimiter, $s)
{
}
/**
* Replace the part of the path that all files have in common.
*
* @param string $path
* @return string
*/
public function shorten($path)
{
}
/**
* Format the given value into a human readable string.
*
* @param mixed $value
* @return string
*/
public function dump($value)
{
}
/**
* Format the args of the given Frame as a human readable html string
*
* @param Frame $frame
* @return string the rendered html
*/
public function dumpArgs(\Whoops\Exception\Frame $frame)
{
}
/**
* Convert a string to a slug version of itself
*
* @param string $original
* @return string
*/
public function slug($original)
{
}
/**
* Given a template path, render it within its own scope. This
* method also accepts an array of additional variables to be
* passed to the template.
*
* @param string $template
* @param array $additionalVariables
*/
public function render($template, array $additionalVariables = null)
{
}
/**
* Sets the variables to be passed to all templates rendered
* by this template helper.
*
* @param array $variables
*/
public function setVariables(array $variables)
{
}
/**
* Sets a single template variable, by its name:
*
* @param string $variableName
* @param mixd $variableValue
*/
public function setVariable($variableName, $variableValue)
{
}
/**
* Gets a single template variable, by its name, or
* $defaultValue if the variable does not exist
*
* @param string $variableName
* @param mixed $defaultValue
* @return mixed
*/
public function getVariable($variableName, $defaultValue = null)
{
}
/**
* Unsets a single template variable, by its name
*
* @param string $variableName
*/
public function delVariable($variableName)
{
}
/**
* Returns all variables for this helper
*
* @return array
*/
public function getVariables()
{
}
/**
* Set the cloner used for dumping variables.
*
* @param AbstractCloner $cloner
*/
public function setCloner($cloner)
{
}
/**
* Get the cloner used for dumping variables.
*
* @return AbstractCloner
*/
public function getCloner()
{
}
/**
* Set the application root path.
*
* @param string $applicationRootPath
*/
public function setApplicationRootPath($applicationRootPath)
{
}
/**
* Return the application root path.
*
* @return string
*/
public function getApplicationRootPath()
{
}
}
class SystemFacade
{
/**
* Turns on output buffering.
*
* @return bool
*/
public function startOutputBuffering()
{
}
/**
* @param callable $handler
* @param int $types
*
* @return callable|null
*/
public function setErrorHandler(callable $handler, $types = 'use-php-defaults')
{
}
/**
* @param callable $handler
*
* @return callable|null
*/
public function setExceptionHandler(callable $handler)
{
}
/**
* @return void
*/
public function restoreExceptionHandler()
{
}
/**
* @return void
*/
public function restoreErrorHandler()
{
}
/**
* @param callable $function
*
* @return void
*/
public function registerShutdownFunction(callable $function)
{
}
/**
* @return string|false
*/
public function cleanOutputBuffer()
{
}
/**
* @return int
*/
public function getOutputBufferLevel()
{
}
/**
* @return bool
*/
public function endOutputBuffering()
{
}
/**
* @return void
*/
public function flushOutputBuffer()
{
}
/**
* @return int
*/
public function getErrorReportingLevel()
{
}
/**
* @return array|null
*/
public function getLastError()
{
}
/**
* @param int $httpCode
*
* @return int
*/
public function setHttpResponseCode($httpCode)
{
}
/**
* @param int $exitStatus
*/
public function stopExecution($exitStatus)
{
}
}
class Misc
{
/**
* Can we at this point in time send HTTP headers?
*
* Currently this checks if we are even serving an HTTP request,
* as opposed to running from a command line.
*
* If we are serving an HTTP request, we check if it's not too late.
*
* @return bool
*/
public static function canSendHeaders()
{
}
public static function isAjaxRequest()
{
}
/**
* Check, if possible, that this execution was triggered by a command line.
* @return bool
*/
public static function isCommandLine()
{
}
/**
* Translate ErrorException code into the represented constant.
*
* @param int $error_code
* @return string
*/
public static function translateErrorCode($error_code)
{
}
/**
* Determine if an error level is fatal (halts execution)
*
* @param int $level
* @return bool
*/
public static function isLevelFatal($level)
{
}
}
}
namespace Whoops {
interface RunInterface
{
const EXCEPTION_HANDLER = "handleException";
const ERROR_HANDLER = "handleError";
const SHUTDOWN_HANDLER = "handleShutdown";
/**
* Pushes a handler to the end of the stack
*
* @throws InvalidArgumentException If argument is not callable or instance of HandlerInterface
* @param Callable|HandlerInterface $handler
* @return Run
*/
public function pushHandler($handler);
/**
* Removes the last handler in the stack and returns it.
* Returns null if there"s nothing else to pop.
*
* @return null|HandlerInterface
*/
public function popHandler();
/**
* Returns an array with all handlers, in the
* order they were added to the stack.
*
* @return array
*/
public function getHandlers();
/**
* Clears all handlers in the handlerStack, including
* the default PrettyPage handler.
*
* @return Run
*/
public function clearHandlers();
/**
* Registers this instance as an error handler.
*
* @return Run
*/
public function register();
/**
* Unregisters all handlers registered by this Whoops\Run instance
*
* @return Run
*/
public function unregister();
/**
* Should Whoops allow Handlers to force the script to quit?
*
* @param bool|int $exit
* @return bool
*/
public function allowQuit($exit = null);
/**
* Silence particular errors in particular files
*
* @param array|string $patterns List or a single regex pattern to match
* @param int $levels Defaults to E_STRICT | E_DEPRECATED
* @return \Whoops\Run
*/
public function silenceErrorsInPaths($patterns, $levels = 10240);
/**
* Should Whoops send HTTP error code to the browser if possible?
* Whoops will by default send HTTP code 500, but you may wish to
* use 502, 503, or another 5xx family code.
*
* @param bool|int $code
* @return int|false
*/
public function sendHttpCode($code = null);
/**
* Should Whoops push output directly to the client?
* If this is false, output will be returned by handleException
*
* @param bool|int $send
* @return bool
*/
public function writeToOutput($send = null);
/**
* Handles an exception, ultimately generating a Whoops error
* page.
*
* @param \Throwable $exception
* @return string Output generated by handlers
*/
public function handleException($exception);
/**
* Converts generic PHP errors to \ErrorException
* instances, before passing them off to be handled.
*
* This method MUST be compatible with set_error_handler.
*
* @param int $level
* @param string $message
* @param string $file
* @param int $line
*
* @return bool
* @throws ErrorException
*/
public function handleError($level, $message, $file = null, $line = null);
/**
* Special case to deal with Fatal errors and the like.
*/
public function handleShutdown();
}
final class Run implements \Whoops\RunInterface
{
public function __construct(\Whoops\Util\SystemFacade $system = null)
{
}
/**
* Pushes a handler to the end of the stack
*
* @throws InvalidArgumentException If argument is not callable or instance of HandlerInterface
* @param Callable|HandlerInterface $handler
* @return Run
*/
public function pushHandler($handler)
{
}
/**
* Removes the last handler in the stack and returns it.
* Returns null if there"s nothing else to pop.
* @return null|HandlerInterface
*/
public function popHandler()
{
}
/**
* Returns an array with all handlers, in the
* order they were added to the stack.
* @return array
*/
public function getHandlers()
{
}
/**
* Clears all handlers in the handlerStack, including
* the default PrettyPage handler.
* @return Run
*/
public function clearHandlers()
{
}
/**
* Registers this instance as an error handler.
* @return Run
*/
public function register()
{
}
/**
* Unregisters all handlers registered by this Whoops\Run instance
* @return Run
*/
public function unregister()
{
}
/**
* Should Whoops allow Handlers to force the script to quit?
* @param bool|int $exit
* @return bool
*/
public function allowQuit($exit = null)
{
}
/**
* Silence particular errors in particular files
* @param array|string $patterns List or a single regex pattern to match
* @param int $levels Defaults to E_STRICT | E_DEPRECATED
* @return \Whoops\Run
*/
public function silenceErrorsInPaths($patterns, $levels = 10240)
{
}
/**
* Returns an array with silent errors in path configuration
*
* @return array
*/
public function getSilenceErrorsInPaths()
{
}
/*
* Should Whoops send HTTP error code to the browser if possible?
* Whoops will by default send HTTP code 500, but you may wish to
* use 502, 503, or another 5xx family code.
*
* @param bool|int $code
* @return int|false
*/
public function sendHttpCode($code = null)
{
}
/**
* Should Whoops push output directly to the client?
* If this is false, output will be returned by handleException
* @param bool|int $send
* @return bool
*/
public function writeToOutput($send = null)
{
}
/**
* Handles an exception, ultimately generating a Whoops error
* page.
*
* @param \Throwable $exception
* @return string Output generated by handlers
*/
public function handleException($exception)
{
}
/**
* Converts generic PHP errors to \ErrorException
* instances, before passing them off to be handled.
*
* This method MUST be compatible with set_error_handler.
*
* @param int $level
* @param string $message
* @param string $file
* @param int $line
*
* @return bool
* @throws ErrorException
*/
public function handleError($level, $message, $file = null, $line = null)
{
}
/**
* Special case to deal with Fatal errors and the like.
*/
public function handleShutdown()
{
}
}
}
namespace Whoops\Handler {
interface HandlerInterface
{
/**
* @return int|null A handler may return nothing, or a Handler::HANDLE_* constant
*/
public function handle();
/**
* @param RunInterface $run
* @return void
*/
public function setRun(\Whoops\RunInterface $run);
/**
* @param \Throwable $exception
* @return void
*/
public function setException($exception);
/**
* @param Inspector $inspector
* @return void
*/
public function setInspector(\Whoops\Exception\Inspector $inspector);
}
/**
* Abstract implementation of a Handler.
*/
abstract class Handler implements \Whoops\Handler\HandlerInterface
{
/**
* Return constants that can be returned from Handler::handle
* to message the handler walker.
*/
const DONE = 0x10;
// returning this is optional, only exists for
// semantic purposes
const LAST_HANDLER = 0x20;
const QUIT = 0x30;
/**
* @param RunInterface $run
*/
public function setRun(\Whoops\RunInterface $run)
{
}
/**
* @return RunInterface
*/
protected function getRun()
{
}
/**
* @param Inspector $inspector
*/
public function setInspector(\Whoops\Exception\Inspector $inspector)
{
}
/**
* @return Inspector
*/
protected function getInspector()
{
}
/**
* @param \Throwable $exception
*/
public function setException($exception)
{
}
/**
* @return \Throwable
*/
protected function getException()
{
}
}
/**
* Catches an exception and converts it to a JSON
* response. Additionally can also return exception
* frames for consumption by an API.
*/
class JsonResponseHandler extends \Whoops\Handler\Handler
{
/**
* Returns errors[[]] instead of error[] to be in compliance with the json:api spec
* @param bool $jsonApi Default is false
* @return $this
*/
public function setJsonApi($jsonApi = false)
{
}
/**
* @param bool|null $returnFrames
* @return bool|$this
*/
public function addTraceToOutput($returnFrames = null)
{
}
/**
* @return int
*/
public function handle()
{
}
/**
* @return string
*/
public function contentType()
{
}
}
/**
* Catches an exception and converts it to an XML
* response. Additionally can also return exception
* frames for consumption by an API.
*/
class XmlResponseHandler extends \Whoops\Handler\Handler
{
/**
* @param bool|null $returnFrames
* @return bool|$this
*/
public function addTraceToOutput($returnFrames = null)
{
}
/**
* @return int
*/
public function handle()
{
}
/**
* @return string
*/
public function contentType()
{
}
}
/**
* Wrapper for Closures passed as handlers. Can be used
* directly, or will be instantiated automagically by Whoops\Run
* if passed to Run::pushHandler
*/
class CallbackHandler extends \Whoops\Handler\Handler
{
/**
* @var callable
*/
protected $callable;
/**
* @throws InvalidArgumentException If argument is not callable
* @param callable $callable
*/
public function __construct($callable)
{
}
/**
* @return int|null
*/
public function handle()
{
}
}
/**
* Handler outputing plaintext error messages. Can be used
* directly, or will be instantiated automagically by Whoops\Run
* if passed to Run::pushHandler
*/
class PlainTextHandler extends \Whoops\Handler\Handler
{
const VAR_DUMP_PREFIX = ' | ';
/**
* @var \Psr\Log\LoggerInterface
*/
protected $logger;
/**
* Constructor.
* @throws InvalidArgumentException If argument is not null or a LoggerInterface
* @param \Psr\Log\LoggerInterface|null $logger
*/
public function __construct($logger = null)
{
}
/**
* Set the output logger interface.
* @throws InvalidArgumentException If argument is not null or a LoggerInterface
* @param \Psr\Log\LoggerInterface|null $logger
*/
public function setLogger($logger = null)
{
}
/**
* @return \Psr\Log\LoggerInterface|null
*/
public function getLogger()
{
}
/**
* Add error trace to output.
* @param bool|null $addTraceToOutput
* @return bool|$this
*/
public function addTraceToOutput($addTraceToOutput = null)
{
}
/**
* Add error trace function arguments to output.
* Set to True for all frame args, or integer for the n first frame args.
* @param bool|integer|null $addTraceFunctionArgsToOutput
* @return null|bool|integer
*/
public function addTraceFunctionArgsToOutput($addTraceFunctionArgsToOutput = null)
{
}
/**
* Set the size limit in bytes of frame arguments var_dump output.
* If the limit is reached, the var_dump output is discarded.
* Prevent memory limit errors.
* @var integer
*/
public function setTraceFunctionArgsOutputLimit($traceFunctionArgsOutputLimit)
{
}
/**
* Create plain text response and return it as a string
* @return string
*/
public function generateResponse()
{
}
/**
* Get the size limit in bytes of frame arguments var_dump output.
* If the limit is reached, the var_dump output is discarded.
* Prevent memory limit errors.
* @return integer
*/
public function getTraceFunctionArgsOutputLimit()
{
}
/**
* Only output to logger.
* @param bool|null $loggerOnly
* @return null|bool
*/
public function loggerOnly($loggerOnly = null)
{
}
/**
* @return int
*/
public function handle()
{
}
/**
* @return string
*/
public function contentType()
{
}
}
class PrettyPageHandler extends \Whoops\Handler\Handler
{
/**
* A string identifier for a known IDE/text editor, or a closure
* that resolves a string that can be used to open a given file
* in an editor. If the string contains the special substrings
* %file or %line, they will be replaced with the correct data.
*
* @example
* "txmt://open?url=%file&line=%line"
* @var mixed $editor
*/
protected $editor;
/**
* A list of known editor strings
* @var array
*/
protected $editors = ["sublime" => "subl://open?url=file://%file&line=%line", "textmate" => "txmt://open?url=file://%file&line=%line", "emacs" => "emacs://open?url=file://%file&line=%line", "macvim" => "mvim://open/?url=file://%file&line=%line", "phpstorm" => "phpstorm://open?file=%file&line=%line", "idea" => "idea://open?file=%file&line=%line"];
/**
* Constructor.
*/
public function __construct()
{
}
/**
* @return int|null
*/
public function handle()
{
}
/**
* @return string
*/
public function contentType()
{
}
/**
* Adds an entry to the list of tables displayed in the template.
* The expected data is a simple associative array. Any nested arrays
* will be flattened with print_r
* @param string $label
* @param array $data
*/
public function addDataTable($label, array $data)
{
}
/**
* Lazily adds an entry to the list of tables displayed in the table.
* The supplied callback argument will be called when the error is rendered,
* it should produce a simple associative array. Any nested arrays will
* be flattened with print_r.
*
* @throws InvalidArgumentException If $callback is not callable
* @param string $label
* @param callable $callback Callable returning an associative array
*/
public function addDataTableCallback(
$label,
/* callable */
$callback
)
{
}
/**
* Returns all the extra data tables registered with this handler.
* Optionally accepts a 'label' parameter, to only return the data
* table under that label.
* @param string|null $label
* @return array[]|callable
*/
public function getDataTables($label = null)
{
}
/**
* Allows to disable all attempts to dynamically decide whether to
* handle or return prematurely.
* Set this to ensure that the handler will perform no matter what.
* @param bool|null $value
* @return bool|null
*/
public function handleUnconditionally($value = null)
{
}
/**
* Adds an editor resolver, identified by a string
* name, and that may be a string path, or a callable
* resolver. If the callable returns a string, it will
* be set as the file reference's href attribute.
*
* @example
* $run->addEditor('macvim', "mvim://open?url=file://%file&line=%line")
* @example
* $run->addEditor('remove-it', function($file, $line) {
* unlink($file);
* return "http://stackoverflow.com";
* });
* @param string $identifier
* @param string $resolver
*/
public function addEditor($identifier, $resolver)
{
}
/**
* Set the editor to use to open referenced files, by a string
* identifier, or a callable that will be executed for every
* file reference, with a $file and $line argument, and should
* return a string.
*
* @example
* $run->setEditor(function($file, $line) { return "file:///{$file}"; });
* @example
* $run->setEditor('sublime');
*
* @throws InvalidArgumentException If invalid argument identifier provided
* @param string|callable $editor
*/
public function setEditor($editor)
{
}
/**
* Given a string file path, and an integer file line,
* executes the editor resolver and returns, if available,
* a string that may be used as the href property for that
* file reference.
*
* @throws InvalidArgumentException If editor resolver does not return a string
* @param string $filePath
* @param int $line
* @return string|bool
*/
public function getEditorHref($filePath, $line)
{
}
/**
* Given a boolean if the editor link should
* act as an Ajax request. The editor must be a
* valid callable function/closure
*
* @throws UnexpectedValueException If editor resolver does not return a boolean
* @param string $filePath
* @param int $line
* @return bool
*/
public function getEditorAjax($filePath, $line)
{
}
/**
* Given a boolean if the editor link should
* act as an Ajax request. The editor must be a
* valid callable function/closure
*
* @param string $filePath
* @param int $line
* @return array
*/
protected function getEditor($filePath, $line)
{
}
/**
* @param string $title
* @return void
*/
public function setPageTitle($title)
{
}
/**
* @return string
*/
public function getPageTitle()
{
}
/**
* Adds a path to the list of paths to be searched for
* resources.
*
* @throws InvalidArgumentException If $path is not a valid directory
*
* @param string $path
* @return void
*/
public function addResourcePath($path)
{
}
/**
* Adds a custom css file to be loaded.
*
* @param string $name
* @return void
*/
public function addCustomCss($name)
{
}
/**
* @return array
*/
public function getResourcePaths()
{
}
/**
* Finds a resource, by its relative path, in all available search paths.
* The search is performed starting at the last search path, and all the
* way back to the first, enabling a cascading-type system of overrides
* for all resources.
*
* @throws RuntimeException If resource cannot be found in any of the available paths
*
* @param string $resource
* @return string
*/
protected function getResource($resource)
{
}
/**
* @deprecated
*
* @return string
*/
public function getResourcesPath()
{
}
/**
* @deprecated
*
* @param string $resourcesPath
* @return void
*/
public function setResourcesPath($resourcesPath)
{
}
/**
* Return the application paths.
*
* @return array
*/
public function getApplicationPaths()
{
}
/**
* Set the application paths.
*
* @param array $applicationPaths
*/
public function setApplicationPaths($applicationPaths)
{
}
/**
* Set the application root path.
*
* @param string $applicationRootPath
*/
public function setApplicationRootPath($applicationRootPath)
{
}
/**
* blacklist a sensitive value within one of the superglobal arrays.
*
* @param $superGlobalName string the name of the superglobal array, e.g. '_GET'
* @param $key string the key within the superglobal
*/
public function blacklist($superGlobalName, $key)
{
}
}
}
namespace Whoops\Exception {
class Formatter
{
/**
* Returns all basic information about the exception in a simple array
* for further convertion to other languages
* @param Inspector $inspector
* @param bool $shouldAddTrace
* @return array
*/
public static function formatExceptionAsDataArray(\Whoops\Exception\Inspector $inspector, $shouldAddTrace)
{
}
public static function formatExceptionPlain(\Whoops\Exception\Inspector $inspector)
{
}
}
/**
* Exposes a fluent interface for dealing with an ordered list
* of stack-trace frames.
*/
class FrameCollection implements \ArrayAccess, \IteratorAggregate, \Serializable, \Countable
{
/**
* @param array $frames
*/
public function __construct(array $frames)
{
}
/**
* Filters frames using a callable, returns the same FrameCollection
*
* @param callable $callable
* @return FrameCollection
*/
public function filter($callable)
{
}
/**
* Map the collection of frames
*
* @param callable $callable
* @return FrameCollection
*/
public function map($callable)
{
}
/**
* Returns an array with all frames, does not affect
* the internal array.
*
* @todo If this gets any more complex than this,
* have getIterator use this method.
* @see FrameCollection::getIterator
* @return array
*/
public function getArray()
{
}
/**
* @see IteratorAggregate::getIterator
* @return ArrayIterator
*/
public function getIterator()
{
}
/**
* @see ArrayAccess::offsetExists
* @param int $offset
*/
public function offsetExists($offset)
{
}
/**
* @see ArrayAccess::offsetGet
* @param int $offset
*/
public function offsetGet($offset)
{
}
/**
* @see ArrayAccess::offsetSet
* @param int $offset
*/
public function offsetSet($offset, $value)
{
}
/**
* @see ArrayAccess::offsetUnset
* @param int $offset
*/
public function offsetUnset($offset)
{
}
/**
* @see Countable::count
* @return int
*/
public function count()
{
}
/**
* Count the frames that belongs to the application.
*
* @return int
*/
public function countIsApplication()
{
}
/**
* @see Serializable::serialize
* @return string
*/
public function serialize()
{
}
/**
* @see Serializable::unserialize
* @param string $serializedFrames
*/
public function unserialize($serializedFrames)
{
}
/**
* @param Frame[] $frames Array of Frame instances, usually from $e->getPrevious()
*/
public function prependFrames(array $frames)
{
}
/**
* Gets the innermost part of stack trace that is not the same as that of outer exception
*
* @param FrameCollection $parentFrames Outer exception frames to compare tail against
* @return Frame[]
*/
public function topDiff(\Whoops\Exception\FrameCollection $parentFrames)
{
}
}
class Inspector
{
/**
* @param \Throwable $exception The exception to inspect
*/
public function __construct($exception)
{
}
/**
* @return \Throwable
*/
public function getException()
{
}
/**
* @return string
*/
public function getExceptionName()
{
}
/**
* @return string
*/
public function getExceptionMessage()
{
}
/**
* Does the wrapped Exception has a previous Exception?
* @return bool
*/
public function hasPreviousException()
{
}
/**
* Returns an Inspector for a previous Exception, if any.
* @todo Clean this up a bit, cache stuff a bit better.
* @return Inspector
*/
public function getPreviousExceptionInspector()
{
}
/**
* Returns an iterator for the inspected exception's
* frames.
* @return \Whoops\Exception\FrameCollection
*/
public function getFrames()
{
}
/**
* Gets the backtrace from an exception.
*
* If xdebug is installed
*
* @param \Throwable $exception
* @return array
*/
protected function getTrace($e)
{
}
/**
* Given an exception, generates an array in the format
* generated by Exception::getTrace()
* @param \Throwable $exception
* @return array
*/
protected function getFrameFromException($exception)
{
}
/**
* Given an error, generates an array in the format
* generated by ErrorException
* @param ErrorException $exception
* @return array
*/
protected function getFrameFromError(\Whoops\Exception\ErrorException $exception)
{
}
/**
* Determine if the frame can be used to fill in previous frame's missing info
* happens for call_user_func and call_user_func_array usages (PHP Bug #44428)
*
* @param array $frame
* @return bool
*/
protected function isValidNextFrame(array $frame)
{
}
}
/**
* Wraps ErrorException; mostly used for typing (at least now)
* to easily cleanup the stack trace of redundant info.
*/
class ErrorException extends \ErrorException
{
}
class Frame implements \Serializable
{
/**
* @var array
*/
protected $frame;
/**
* @var string
*/
protected $fileContentsCache;
/**
* @var array[]
*/
protected $comments = [];
/**
* @var bool
*/
protected $application;
/**
* @param array[]
*/
public function __construct(array $frame)
{
}
/**
* @param bool $shortened
* @return string|null
*/
public function getFile($shortened = false)
{
}
/**
* @return int|null
*/
public function getLine()
{
}
/**
* @return string|null
*/
public function getClass()
{
}
/**
* @return string|null
*/
public function getFunction()
{
}
/**
* @return array
*/
public function getArgs()
{
}
/**
* Returns the full contents of the file for this frame,
* if it's known.
* @return string|null
*/
public function getFileContents()
{
}
/**
* Adds a comment to this frame, that can be received and
* used by other handlers. For example, the PrettyPage handler
* can attach these comments under the code for each frame.
*
* An interesting use for this would be, for example, code analysis
* & annotations.
*
* @param string $comment
* @param string $context Optional string identifying the origin of the comment
*/
public function addComment($comment, $context = 'global')
{
}
/**
* Returns all comments for this frame. Optionally allows
* a filter to only retrieve comments from a specific
* context.
*
* @param string $filter
* @return array[]
*/
public function getComments($filter = null)
{
}
/**
* Returns the array containing the raw frame data from which
* this Frame object was built
*
* @return array
*/
public function getRawFrame()
{
}
/**
* Returns the contents of the file for this frame as an
* array of lines, and optionally as a clamped range of lines.
*
* NOTE: lines are 0-indexed
*
* @example
* Get all lines for this file
* $frame->getFileLines(); // => array( 0 => '<?php', 1 => '...', ...)
* @example
* Get one line for this file, starting at line 10 (zero-indexed, remember!)
* $frame->getFileLines(9, 1); // array( 10 => '...', 11 => '...')
*
* @throws InvalidArgumentException if $length is less than or equal to 0
* @param int $start
* @param int $length
* @return string[]|null
*/
public function getFileLines($start = 0, $length = null)
{
}
/**
* Implements the Serializable interface, with special
* steps to also save the existing comments.
*
* @see Serializable::serialize
* @return string
*/
public function serialize()
{
}
/**
* Unserializes the frame data, while also preserving
* any existing comment data.
*
* @see Serializable::unserialize
* @param string $serializedFrame
*/
public function unserialize($serializedFrame)
{
}
/**
* Compares Frame against one another
* @param Frame $frame
* @return bool
*/
public function equals(\Whoops\Exception\Frame $frame)
{
}
/**
* Returns whether this frame belongs to the application or not.
*
* @return boolean
*/
public function isApplication()
{
}
/**
* Mark as an frame belonging to the application.
*
* @param boolean $application
*/
public function setApplication($application)
{
}
}
}
namespace Facebook {
/**
* Class Request
*
* @package Facebook
*/
class FacebookRequest
{
/**
* @var FacebookApp The Facebook app entity.
*/
protected $app;
/**
* @var string|null The access token to use for this request.
*/
protected $accessToken;
/**
* @var string The HTTP method for this request.
*/
protected $method;
/**
* @var string The Graph endpoint for this request.
*/
protected $endpoint;
/**
* @var array The headers to send with this request.
*/
protected $headers = [];
/**
* @var array The parameters to send with this request.
*/
protected $params = [];
/**
* @var array The files to send with this request.
*/
protected $files = [];
/**
* @var string ETag to send with this request.
*/
protected $eTag;
/**
* @var string Graph version to use for this request.
*/
protected $graphVersion;
/**
* Creates a new Request entity.
*
* @param FacebookApp|null $app
* @param AccessToken|string|null $accessToken
* @param string|null $method
* @param string|null $endpoint
* @param array|null $params
* @param string|null $eTag
* @param string|null $graphVersion
*/
public function __construct(\Facebook\FacebookApp $app = null, $accessToken = null, $method = null, $endpoint = null, array $params = [], $eTag = null, $graphVersion = null)
{
}
/**
* Set the access token for this request.
*
* @param AccessToken|string|null
*
* @return FacebookRequest
*/
public function setAccessToken($accessToken)
{
}
/**
* Sets the access token with one harvested from a URL or POST params.
*
* @param string $accessToken The access token.
*
* @return FacebookRequest
*
* @throws FacebookSDKException
*/
public function setAccessTokenFromParams($accessToken)
{
}
/**
* Return the access token for this request.
*
* @return string|null
*/
public function getAccessToken()
{
}
/**
* Return the access token for this request as an AccessToken entity.
*
* @return AccessToken|null
*/
public function getAccessTokenEntity()
{
}
/**
* Set the FacebookApp entity used for this request.
*
* @param FacebookApp|null $app
*/
public function setApp(\Facebook\FacebookApp $app = null)
{
}
/**
* Return the FacebookApp entity used for this request.
*
* @return FacebookApp
*/
public function getApp()
{
}
/**
* Generate an app secret proof to sign this request.
*
* @return string|null
*/
public function getAppSecretProof()
{
}
/**
* Validate that an access token exists for this request.
*
* @throws FacebookSDKException
*/
public function validateAccessToken()
{
}
/**
* Set the HTTP method for this request.
*
* @param string
*/
public function setMethod($method)
{
}
/**
* Return the HTTP method for this request.
*
* @return string
*/
public function getMethod()
{
}
/**
* Validate that the HTTP method is set.
*
* @throws FacebookSDKException
*/
public function validateMethod()
{
}
/**
* Set the endpoint for this request.
*
* @param string
*
* @return FacebookRequest
*
* @throws FacebookSDKException
*/
public function setEndpoint($endpoint)
{
}
/**
* Return the endpoint for this request.
*
* @return string
*/
public function getEndpoint()
{
}
/**
* Generate and return the headers for this request.
*
* @return array
*/
public function getHeaders()
{
}
/**
* Set the headers for this request.
*
* @param array $headers
*/
public function setHeaders(array $headers)
{
}
/**
* Sets the eTag value.
*
* @param string $eTag
*/
public function setETag($eTag)
{
}
/**
* Set the params for this request.
*
* @param array $params
*
* @return FacebookRequest
*
* @throws FacebookSDKException
*/
public function setParams(array $params = [])
{
}
/**
* Set the params for this request without filtering them first.
*
* @param array $params
*
* @return FacebookRequest
*/
public function dangerouslySetParams(array $params = [])
{
}
/**
* Iterate over the params and pull out the file uploads.
*
* @param array $params
*
* @return array
*/
public function sanitizeFileParams(array $params)
{
}
/**
* Add a file to be uploaded.
*
* @param string $key
* @param FacebookFile $file
*/
public function addFile($key, \Facebook\FileUpload\FacebookFile $file)
{
}
/**
* Removes all the files from the upload queue.
*/
public function resetFiles()
{
}
/**
* Get the list of files to be uploaded.
*
* @return array
*/
public function getFiles()
{
}
/**
* Let's us know if there is a file upload with this request.
*
* @return boolean
*/
public function containsFileUploads()
{
}
/**
* Let's us know if there is a video upload with this request.
*
* @return boolean
*/
public function containsVideoUploads()
{
}
/**
* Returns the body of the request as multipart/form-data.
*
* @return RequestBodyMultipart
*/
public function getMultipartBody()
{
}
/**
* Returns the body of the request as URL-encoded.
*
* @return RequestBodyUrlEncoded
*/
public function getUrlEncodedBody()
{
}
/**
* Generate and return the params for this request.
*
* @return array
*/
public function getParams()
{
}
/**
* Only return params on POST requests.
*
* @return array
*/
public function getPostParams()
{
}
/**
* The graph version used for this request.
*
* @return string
*/
public function getGraphVersion()
{
}
/**
* Generate and return the URL for this request.
*
* @return string
*/
public function getUrl()
{
}
/**
* Return the default headers that every request should use.
*
* @return array
*/
public static function getDefaultHeaders()
{
}
}
/**
* Class BatchRequest
*
* @package Facebook
*/
class FacebookBatchRequest extends \Facebook\FacebookRequest implements \IteratorAggregate, \ArrayAccess
{
/**
* @var array An array of FacebookRequest entities to send.
*/
protected $requests;
/**
* @var array An array of files to upload.
*/
protected $attachedFiles;
/**
* Creates a new Request entity.
*
* @param FacebookApp|null $app
* @param array $requests
* @param AccessToken|string|null $accessToken
* @param string|null $graphVersion
*/
public function __construct(\Facebook\FacebookApp $app = null, array $requests = [], $accessToken = null, $graphVersion = null)
{
}
/**
* Adds a new request to the array.
*
* @param FacebookRequest|array $request
* @param string|null|array $options Array of batch request options e.g. 'name', 'omit_response_on_success'.
* If a string is given, it is the value of the 'name' option.
*
* @return FacebookBatchRequest
*
* @throws \InvalidArgumentException
*/
public function add($request, $options = null)
{
}
/**
* Ensures that the FacebookApp and access token fall back when missing.
*
* @param FacebookRequest $request
*
* @throws FacebookSDKException
*/
public function addFallbackDefaults(\Facebook\FacebookRequest $request)
{
}
/**
* Extracts the files from a request.
*
* @param FacebookRequest $request
*
* @return string|null
*
* @throws FacebookSDKException
*/
public function extractFileAttachments(\Facebook\FacebookRequest $request)
{
}
/**
* Return the FacebookRequest entities.
*
* @return array
*/
public function getRequests()
{
}
/**
* Prepares the requests to be sent as a batch request.
*/
public function prepareRequestsForBatch()
{
}
/**
* Converts the requests into a JSON(P) string.
*
* @return string
*/
public function convertRequestsToJson()
{
}
/**
* Validate the request count before sending them as a batch.
*
* @throws FacebookSDKException
*/
public function validateBatchRequestCount()
{
}
/**
* Converts a Request entity into an array that is batch-friendly.
*
* @param FacebookRequest $request The request entity to convert.
* @param string|null|array $options Array of batch request options e.g. 'name', 'omit_response_on_success'.
* If a string is given, it is the value of the 'name' option.
* @param string|null $attachedFiles Names of files associated with the request.
*
* @return array
*/
public function requestEntityToBatchArray(\Facebook\FacebookRequest $request, $options = null, $attachedFiles = null)
{
}
/**
* Get an iterator for the items.
*
* @return ArrayIterator
*/
public function getIterator()
{
}
/**
* @inheritdoc
*/
public function offsetSet($offset, $value)
{
}
/**
* @inheritdoc
*/
public function offsetExists($offset)
{
}
/**
* @inheritdoc
*/
public function offsetUnset($offset)
{
}
/**
* @inheritdoc
*/
public function offsetGet($offset)
{
}
}
}
namespace Facebook\Authentication {
/**
* Class AccessToken
*
* @package Facebook
*/
class AccessToken
{
/**
* The access token value.
*
* @var string
*/
protected $value = '';
/**
* Date when token expires.
*
* @var \DateTime|null
*/
protected $expiresAt;
/**
* Create a new access token entity.
*
* @param string $accessToken
* @param int $expiresAt
*/
public function __construct($accessToken, $expiresAt = 0)
{
}
/**
* Generate an app secret proof to sign a request to Graph.
*
* @param string $appSecret The app secret.
*
* @return string
*/
public function getAppSecretProof($appSecret)
{
}
/**
* Getter for expiresAt.
*
* @return \DateTime|null
*/
public function getExpiresAt()
{
}
/**
* Determines whether or not this is an app access token.
*
* @return bool
*/
public function isAppAccessToken()
{
}
/**
* Determines whether or not this is a long-lived token.
*
* @return bool
*/
public function isLongLived()
{
}
/**
* Checks the expiration of the access token.
*
* @return boolean|null
*/
public function isExpired()
{
}
/**
* Returns the access token as a string.
*
* @return string
*/
public function getValue()
{
}
/**
* Returns the access token as a string.
*
* @return string
*/
public function __toString()
{
}
/**
* Setter for expires_at.
*
* @param int $timeStamp
*/
protected function setExpiresAtFromTimeStamp($timeStamp)
{
}
}
/**
* Class AccessTokenMetadata
*
* Represents metadata from an access token.
*
* @package Facebook
* @see https://developers.facebook.com/docs/graph-api/reference/debug_token
*/
class AccessTokenMetadata
{
/**
* The access token metadata.
*
* @var array
*/
protected $metadata = [];
/**
* Properties that should be cast as DateTime objects.
*
* @var array
*/
protected static $dateProperties = ['expires_at', 'issued_at'];
/**
* @param array $metadata
*
* @throws FacebookSDKException
*/
public function __construct(array $metadata)
{
}
/**
* Returns a value from the metadata.
*
* @param string $field The property to retrieve.
* @param mixed $default The default to return if the property doesn't exist.
*
* @return mixed
*/
public function getField($field, $default = null)
{
}
/**
* Returns a value from the metadata.
*
* @param string $field The property to retrieve.
* @param mixed $default The default to return if the property doesn't exist.
*
* @return mixed
*
* @deprecated 5.0.0 getProperty() has been renamed to getField()
* @todo v6: Remove this method
*/
public function getProperty($field, $default = null)
{
}
/**
* Returns a value from a child property in the metadata.
*
* @param string $parentField The parent property.
* @param string $field The property to retrieve.
* @param mixed $default The default to return if the property doesn't exist.
*
* @return mixed
*/
public function getChildProperty($parentField, $field, $default = null)
{
}
/**
* Returns a value from the error metadata.
*
* @param string $field The property to retrieve.
* @param mixed $default The default to return if the property doesn't exist.
*
* @return mixed
*/
public function getErrorProperty($field, $default = null)
{
}
/**
* Returns a value from the "metadata" metadata. *Brain explodes*
*
* @param string $field The property to retrieve.
* @param mixed $default The default to return if the property doesn't exist.
*
* @return mixed
*/
public function getMetadataProperty($field, $default = null)
{
}
/**
* The ID of the application this access token is for.
*
* @return string|null
*/
public function getAppId()
{
}
/**
* Name of the application this access token is for.
*
* @return string|null
*/
public function getApplication()
{
}
/**
* Any error that a request to the graph api
* would return due to the access token.
*
* @return bool|null
*/
public function isError()
{
}
/**
* The error code for the error.
*
* @return int|null
*/
public function getErrorCode()
{
}
/**
* The error message for the error.
*
* @return string|null
*/
public function getErrorMessage()
{
}
/**
* The error subcode for the error.
*
* @return int|null
*/
public function getErrorSubcode()
{
}
/**
* DateTime when this access token expires.
*
* @return \DateTime|null
*/
public function getExpiresAt()
{
}
/**
* Whether the access token is still valid or not.
*
* @return boolean|null
*/
public function getIsValid()
{
}
/**
* DateTime when this access token was issued.
*
* Note that the issued_at field is not returned
* for short-lived access tokens.
*
* @see https://developers.facebook.com/docs/facebook-login/access-tokens#debug
*
* @return \DateTime|null
*/
public function getIssuedAt()
{
}
/**
* General metadata associated with the access token.
* Can contain data like 'sso', 'auth_type', 'auth_nonce'.
*
* @return array|null
*/
public function getMetadata()
{
}
/**
* The 'sso' child property from the 'metadata' parent property.
*
* @return string|null
*/
public function getSso()
{
}
/**
* The 'auth_type' child property from the 'metadata' parent property.
*
* @return string|null
*/
public function getAuthType()
{
}
/**
* The 'auth_nonce' child property from the 'metadata' parent property.
*
* @return string|null
*/
public function getAuthNonce()
{
}
/**
* For impersonated access tokens, the ID of
* the page this token contains.
*
* @return string|null
*/
public function getProfileId()
{
}
/**
* List of permissions that the user has granted for
* the app in this access token.
*
* @return array
*/
public function getScopes()
{
}
/**
* The ID of the user this access token is for.
*
* @return string|null
*/
public function getUserId()
{
}
/**
* Ensures the app ID from the access token
* metadata is what we expect.
*
* @param string $appId
*
* @throws FacebookSDKException
*/
public function validateAppId($appId)
{
}
/**
* Ensures the user ID from the access token
* metadata is what we expect.
*
* @param string $userId
*
* @throws FacebookSDKException
*/
public function validateUserId($userId)
{
}
/**
* Ensures the access token has not expired yet.
*
* @throws FacebookSDKException
*/
public function validateExpiration()
{
}
}
/**
* Class OAuth2Client
*
* @package Facebook
*/
class OAuth2Client
{
/**
* @const string The base authorization URL.
*/
const BASE_AUTHORIZATION_URL = 'https://www.facebook.com';
/**
* The FacebookApp entity.
*
* @var FacebookApp
*/
protected $app;
/**
* The Facebook client.
*
* @var FacebookClient
*/
protected $client;
/**
* The version of the Graph API to use.
*
* @var string
*/
protected $graphVersion;
/**
* The last request sent to Graph.
*
* @var FacebookRequest|null
*/
protected $lastRequest;
/**
* @param FacebookApp $app
* @param FacebookClient $client
* @param string|null $graphVersion The version of the Graph API to use.
*/
public function __construct(\Facebook\FacebookApp $app, \Facebook\FacebookClient $client, $graphVersion = null)
{
}
/**
* Returns the last FacebookRequest that was sent.
* Useful for debugging and testing.
*
* @return FacebookRequest|null
*/
public function getLastRequest()
{
}
/**
* Get the metadata associated with the access token.
*
* @param AccessToken|string $accessToken The access token to debug.
*
* @return AccessTokenMetadata
*/
public function debugToken($accessToken)
{
}
/**
* Generates an authorization URL to begin the process of authenticating a user.
*
* @param string $redirectUrl The callback URL to redirect to.
* @param array $scope An array of permissions to request.
* @param string $state The CSPRNG-generated CSRF value.
* @param array $params An array of parameters to generate URL.
* @param string $separator The separator to use in http_build_query().
*
* @return string
*/
public function getAuthorizationUrl($redirectUrl, $state, array $scope = [], array $params = [], $separator = '&')
{
}
/**
* Get a valid access token from a code.
*
* @param string $code
* @param string $redirectUri
*
* @return AccessToken
*
* @throws FacebookSDKException
*/
public function getAccessTokenFromCode($code, $redirectUri = '')
{
}
/**
* Exchanges a short-lived access token with a long-lived access token.
*
* @param AccessToken|string $accessToken
*
* @return AccessToken
*
* @throws FacebookSDKException
*/
public function getLongLivedAccessToken($accessToken)
{
}
/**
* Get a valid code from an access token.
*
* @param AccessToken|string $accessToken
* @param string $redirectUri
*
* @return AccessToken
*
* @throws FacebookSDKException
*/
public function getCodeFromLongLivedAccessToken($accessToken, $redirectUri = '')
{
}
/**
* Send a request to the OAuth endpoint.
*
* @param array $params
*
* @return AccessToken
*
* @throws FacebookSDKException
*/
protected function requestAnAccessToken(array $params)
{
}
/**
* Send a request to Graph with an app access token.
*
* @param string $endpoint
* @param array $params
* @param AccessToken|string|null $accessToken
*
* @return FacebookResponse
*
* @throws FacebookResponseException
*/
protected function sendRequestWithClientParams($endpoint, array $params, $accessToken = null)
{
}
/**
* Returns the client_* params for OAuth requests.
*
* @return array
*/
protected function getClientParams()
{
}
}
}
namespace Facebook {
/**
* Class FacebookResponse
*
* @package Facebook
*/
class FacebookResponse
{
/**
* @var int The HTTP status code response from Graph.
*/
protected $httpStatusCode;
/**
* @var array The headers returned from Graph.
*/
protected $headers;
/**
* @var string The raw body of the response from Graph.
*/
protected $body;
/**
* @var array The decoded body of the Graph response.
*/
protected $decodedBody = [];
/**
* @var FacebookRequest The original request that returned this response.
*/
protected $request;
/**
* @var FacebookSDKException The exception thrown by this request.
*/
protected $thrownException;
/**
* Creates a new Response entity.
*
* @param FacebookRequest $request
* @param string|null $body
* @param int|null $httpStatusCode
* @param array|null $headers
*/
public function __construct(\Facebook\FacebookRequest $request, $body = null, $httpStatusCode = null, array $headers = [])
{
}
/**
* Return the original request that returned this response.
*
* @return FacebookRequest
*/
public function getRequest()
{
}
/**
* Return the FacebookApp entity used for this response.
*
* @return FacebookApp
*/
public function getApp()
{
}
/**
* Return the access token that was used for this response.
*
* @return string|null
*/
public function getAccessToken()
{
}
/**
* Return the HTTP status code for this response.
*
* @return int
*/
public function getHttpStatusCode()
{
}
/**
* Return the HTTP headers for this response.
*
* @return array
*/
public function getHeaders()
{
}
/**
* Return the raw body response.
*
* @return string
*/
public function getBody()
{
}
/**
* Return the decoded body response.
*
* @return array
*/
public function getDecodedBody()
{
}
/**
* Get the app secret proof that was used for this response.
*
* @return string|null
*/
public function getAppSecretProof()
{
}
/**
* Get the ETag associated with the response.
*
* @return string|null
*/
public function getETag()
{
}
/**
* Get the version of Graph that returned this response.
*
* @return string|null
*/
public function getGraphVersion()
{
}
/**
* Returns true if Graph returned an error message.
*
* @return boolean
*/
public function isError()
{
}
/**
* Throws the exception.
*
* @throws FacebookSDKException
*/
public function throwException()
{
}
/**
* Instantiates an exception to be thrown later.
*/
public function makeException()
{
}
/**
* Returns the exception that was thrown for this request.
*
* @return FacebookResponseException|null
*/
public function getThrownException()
{
}
/**
* Convert the raw response into an array if possible.
*
* Graph will return 2 types of responses:
* - JSON(P)
* Most responses from Graph are JSON(P)
* - application/x-www-form-urlencoded key/value pairs
* Happens on the `/oauth/access_token` endpoint when exchanging
* a short-lived access token for a long-lived access token
* - And sometimes nothing :/ but that'd be a bug.
*/
public function decodeBody()
{
}
/**
* Instantiate a new GraphObject from response.
*
* @param string|null $subclassName The GraphNode subclass to cast to.
*
* @return \Facebook\GraphNodes\GraphObject
*
* @throws FacebookSDKException
*
* @deprecated 5.0.0 getGraphObject() has been renamed to getGraphNode()
* @todo v6: Remove this method
*/
public function getGraphObject($subclassName = null)
{
}
/**
* Instantiate a new GraphNode from response.
*
* @param string|null $subclassName The GraphNode subclass to cast to.
*
* @return \Facebook\GraphNodes\GraphNode
*
* @throws FacebookSDKException
*/
public function getGraphNode($subclassName = null)
{
}
/**
* Convenience method for creating a GraphAlbum collection.
*
* @return \Facebook\GraphNodes\GraphAlbum
*
* @throws FacebookSDKException
*/
public function getGraphAlbum()
{
}
/**
* Convenience method for creating a GraphPage collection.
*
* @return \Facebook\GraphNodes\GraphPage
*
* @throws FacebookSDKException
*/
public function getGraphPage()
{
}
/**
* Convenience method for creating a GraphSessionInfo collection.
*
* @return \Facebook\GraphNodes\GraphSessionInfo
*
* @throws FacebookSDKException
*/
public function getGraphSessionInfo()
{
}
/**
* Convenience method for creating a GraphUser collection.
*
* @return \Facebook\GraphNodes\GraphUser
*
* @throws FacebookSDKException
*/
public function getGraphUser()
{
}
/**
* Convenience method for creating a GraphEvent collection.
*
* @return \Facebook\GraphNodes\GraphEvent
*
* @throws FacebookSDKException
*/
public function getGraphEvent()
{
}
/**
* Convenience method for creating a GraphGroup collection.
*
* @return \Facebook\GraphNodes\GraphGroup
*
* @throws FacebookSDKException
*/
public function getGraphGroup()
{
}
/**
* Instantiate a new GraphList from response.
*
* @param string|null $subclassName The GraphNode subclass to cast list items to.
* @param boolean $auto_prefix Toggle to auto-prefix the subclass name.
*
* @return \Facebook\GraphNodes\GraphList
*
* @throws FacebookSDKException
*
* @deprecated 5.0.0 getGraphList() has been renamed to getGraphEdge()
* @todo v6: Remove this method
*/
public function getGraphList($subclassName = null, $auto_prefix = true)
{
}
/**
* Instantiate a new GraphEdge from response.
*
* @param string|null $subclassName The GraphNode subclass to cast list items to.
* @param boolean $auto_prefix Toggle to auto-prefix the subclass name.
*
* @return \Facebook\GraphNodes\GraphEdge
*
* @throws FacebookSDKException
*/
public function getGraphEdge($subclassName = null, $auto_prefix = true)
{
}
}
}
namespace Facebook\HttpClients {
/**
* Interface FacebookHttpClientInterface
*
* @package Facebook
*/
interface FacebookHttpClientInterface
{
/**
* Sends a request to the server and returns the raw response.
*
* @param string $url The endpoint to send the request to.
* @param string $method The request method.
* @param string $body The body of the request.
* @param array $headers The request headers.
* @param int $timeOut The timeout in seconds for the request.
*
* @return \Facebook\Http\GraphRawResponse Raw response from the server.
*
* @throws \Facebook\Exceptions\FacebookSDKException
*/
public function send($url, $method, $body, array $headers, $timeOut);
}
/**
* Class FacebookStream
*
* Abstraction for the procedural stream elements so that the functions can be
* mocked and the implementation can be tested.
*
* @package Facebook
*/
class FacebookStream
{
/**
* @var resource Context stream resource instance
*/
protected $stream;
/**
* @var array Response headers from the stream wrapper
*/
protected $responseHeaders = [];
/**
* Make a new context stream reference instance
*
* @param array $options
*/
public function streamContextCreate(array $options)
{
}
/**
* The response headers from the stream wrapper
*
* @return array
*/
public function getResponseHeaders()
{
}
/**
* Send a stream wrapped request
*
* @param string $url
*
* @return mixed
*/
public function fileGetContents($url)
{
}
}
/**
* Class FacebookCurl
*
* Abstraction for the procedural curl elements so that curl can be mocked and the implementation can be tested.
*
* @package Facebook
*/
class FacebookCurl
{
/**
* @var resource Curl resource instance
*/
protected $curl;
/**
* Make a new curl reference instance
*/
public function init()
{
}
/**
* Set a curl option
*
* @param $key
* @param $value
*/
public function setopt($key, $value)
{
}
/**
* Set an array of options to a curl resource
*
* @param array $options
*/
public function setoptArray(array $options)
{
}
/**
* Send a curl request
*
* @return mixed
*/
public function exec()
{
}
/**
* Return the curl error number
*
* @return int
*/
public function errno()
{
}
/**
* Return the curl error message
*
* @return string
*/
public function error()
{
}
/**
* Get info from a curl reference
*
* @param $type
*
* @return mixed
*/
public function getinfo($type)
{
}
/**
* Get the currently installed curl version
*
* @return array
*/
public function version()
{
}
/**
* Close the resource connection to curl
*/
public function close()
{
}
}
class HttpClientsFactory
{
/**
* HTTP client generation.
*
* @param FacebookHttpClientInterface|Client|string|null $handler
*
* @throws Exception If the cURL extension or the Guzzle client aren't available (if required).
* @throws InvalidArgumentException If the http client handler isn't "curl", "stream", "guzzle", or an instance of Facebook\HttpClients\FacebookHttpClientInterface.
*
* @return FacebookHttpClientInterface
*/
public static function createHttpClient($handler)
{
}
}
class FacebookStreamHttpClient implements \Facebook\HttpClients\FacebookHttpClientInterface
{
/**
* @var FacebookStream Procedural stream wrapper as object.
*/
protected $facebookStream;
/**
* @param FacebookStream|null Procedural stream wrapper as object.
*/
public function __construct(\Facebook\HttpClients\FacebookStream $facebookStream = null)
{
}
/**
* @inheritdoc
*/
public function send($url, $method, $body, array $headers, $timeOut)
{
}
/**
* Formats the headers for use in the stream wrapper.
*
* @param array $headers The request headers.
*
* @return string
*/
public function compileHeader(array $headers)
{
}
}
/**
* Class FacebookCurlHttpClient
*
* @package Facebook
*/
class FacebookCurlHttpClient implements \Facebook\HttpClients\FacebookHttpClientInterface
{
/**
* @var string The client error message
*/
protected $curlErrorMessage = '';
/**
* @var int The curl client error code
*/
protected $curlErrorCode = 0;
/**
* @var string|boolean The raw response from the server
*/
protected $rawResponse;
/**
* @var FacebookCurl Procedural curl as object
*/
protected $facebookCurl;
/**
* @param FacebookCurl|null Procedural curl as object
*/
public function __construct(\Facebook\HttpClients\FacebookCurl $facebookCurl = null)
{
}
/**
* @inheritdoc
*/
public function send($url, $method, $body, array $headers, $timeOut)
{
}
/**
* Opens a new curl connection.
*
* @param string $url The endpoint to send the request to.
* @param string $method The request method.
* @param string $body The body of the request.
* @param array $headers The request headers.
* @param int $timeOut The timeout in seconds for the request.
*/
public function openConnection($url, $method, $body, array $headers, $timeOut)
{
}
/**
* Closes an existing curl connection
*/
public function closeConnection()
{
}
/**
* Send the request and get the raw response from curl
*/
public function sendRequest()
{
}
/**
* Compiles the request headers into a curl-friendly format.
*
* @param array $headers The request headers.
*
* @return array
*/
public function compileRequestHeaders(array $headers)
{
}
/**
* Extracts the headers and the body into a two-part array
*
* @return array
*/
public function extractResponseHeadersAndBody()
{
}
}
class FacebookGuzzleHttpClient implements \Facebook\HttpClients\FacebookHttpClientInterface
{
/**
* @var \GuzzleHttp\Client The Guzzle client.
*/
protected $guzzleClient;
/**
* @param \GuzzleHttp\Client|null The Guzzle client.
*/
public function __construct(\GuzzleHttp\Client $guzzleClient = null)
{
}
/**
* @inheritdoc
*/
public function send($url, $method, $body, array $headers, $timeOut)
{
}
/**
* Returns the Guzzle array of headers as a string.
*
* @param ResponseInterface $response The Guzzle response.
*
* @return string
*/
public function getHeadersAsString(\GuzzleHttp\Message\ResponseInterface $response)
{
}
}
}
namespace Facebook\PersistentData {
/**
* Interface PersistentDataInterface
*
* @package Facebook
*/
interface PersistentDataInterface
{
/**
* Get a value from a persistent data store.
*
* @param string $key
*
* @return mixed
*/
public function get($key);
/**
* Set a value in the persistent data store.
*
* @param string $key
* @param mixed $value
*/
public function set($key, $value);
}
/**
* Class FacebookSessionPersistentDataHandler
*
* @package Facebook
*/
class FacebookSessionPersistentDataHandler implements \Facebook\PersistentData\PersistentDataInterface
{
/**
* @var string Prefix to use for session variables.
*/
protected $sessionPrefix = 'FBRLH_';
/**
* Init the session handler.
*
* @param boolean $enableSessionCheck
*
* @throws FacebookSDKException
*/
public function __construct($enableSessionCheck = true)
{
}
/**
* @inheritdoc
*/
public function get($key)
{
}
/**
* @inheritdoc
*/
public function set($key, $value)
{
}
}
class PersistentDataFactory
{
/**
* PersistentData generation.
*
* @param PersistentDataInterface|string|null $handler
*
* @throws InvalidArgumentException If the persistent data handler isn't "session", "memory", or an instance of Facebook\PersistentData\PersistentDataInterface.
*
* @return PersistentDataInterface
*/
public static function createPersistentDataHandler($handler)
{
}
}
/**
* Class FacebookMemoryPersistentDataHandler
*
* @package Facebook
*/
class FacebookMemoryPersistentDataHandler implements \Facebook\PersistentData\PersistentDataInterface
{
/**
* @var array The session data to keep in memory.
*/
protected $sessionData = [];
/**
* @inheritdoc
*/
public function get($key)
{
}
/**
* @inheritdoc
*/
public function set($key, $value)
{
}
}
}
namespace Facebook\GraphNodes {
class Collection implements \ArrayAccess, \Countable, \IteratorAggregate
{
/**
* The items contained in the collection.
*
* @var array
*/
protected $items = [];
/**
* Create a new collection.
*
* @param array $items
*/
public function __construct(array $items = [])
{
}
/**
* Gets the value of a field from the Graph node.
*
* @param string $name The field to retrieve.
* @param mixed $default The default to return if the field doesn't exist.
*
* @return mixed
*/
public function getField($name, $default = null)
{
}
/**
* Gets the value of the named property for this graph object.
*
* @param string $name The property to retrieve.
* @param mixed $default The default to return if the property doesn't exist.
*
* @return mixed
*
* @deprecated 5.0.0 getProperty() has been renamed to getField()
* @todo v6: Remove this method
*/
public function getProperty($name, $default = null)
{
}
/**
* Returns a list of all fields set on the object.
*
* @return array
*/
public function getFieldNames()
{
}
/**
* Returns a list of all properties set on the object.
*
* @return array
*
* @deprecated 5.0.0 getPropertyNames() has been renamed to getFieldNames()
* @todo v6: Remove this method
*/
public function getPropertyNames()
{
}
/**
* Get all of the items in the collection.
*
* @return array
*/
public function all()
{
}
/**
* Get the collection of items as a plain array.
*
* @return array
*/
public function asArray()
{
}
/**
* Run a map over each of the items.
*
* @param \Closure $callback
*
* @return static
*/
public function map(\Closure $callback)
{
}
/**
* Get the collection of items as JSON.
*
* @param int $options
*
* @return string
*/
public function asJson($options = 0)
{
}
/**
* Count the number of items in the collection.
*
* @return int
*/
public function count()
{
}
/**
* Get an iterator for the items.
*
* @return ArrayIterator
*/
public function getIterator()
{
}
/**
* Determine if an item exists at an offset.
*
* @param mixed $key
*
* @return bool
*/
public function offsetExists($key)
{
}
/**
* Get an item at a given offset.
*
* @param mixed $key
*
* @return mixed
*/
public function offsetGet($key)
{
}
/**
* Set the item at a given offset.
*
* @param mixed $key
* @param mixed $value
*
* @return void
*/
public function offsetSet($key, $value)
{
}
/**
* Unset the item at a given offset.
*
* @param string $key
*
* @return void
*/
public function offsetUnset($key)
{
}
/**
* Convert the collection to its string representation.
*
* @return string
*/
public function __toString()
{
}
}
/**
* Class GraphNode
*
* @package Facebook
*/
class GraphNode extends \Facebook\GraphNodes\Collection
{
/**
* @var array Maps object key names to Graph object types.
*/
protected static $graphObjectMap = [];
/**
* Init this Graph object.
*
* @param array $data
*/
public function __construct(array $data = [])
{
}
/**
* Iterates over an array and detects the types each node
* should be cast to and returns all the items as an array.
*
* @TODO Add auto-casting to AccessToken entities.
*
* @param array $data The array to iterate over.
*
* @return array
*/
public function castItems(array $data)
{
}
/**
* Uncasts any auto-casted datatypes.
* Basically the reverse of castItems().
*
* @return array
*/
public function uncastItems()
{
}
/**
* Get the collection of items as JSON.
*
* @param int $options
*
* @return string
*/
public function asJson($options = 0)
{
}
/**
* Detects an ISO 8601 formatted string.
*
* @param string $string
*
* @return boolean
*
* @see https://developers.facebook.com/docs/graph-api/using-graph-api/#readmodifiers
* @see http://www.cl.cam.ac.uk/~mgk25/iso-time.html
* @see http://en.wikipedia.org/wiki/ISO_8601
*/
public function isIso8601DateString($string)
{
}
/**
* Determines if a value from Graph should be cast to DateTime.
*
* @param string $key
*
* @return boolean
*/
public function shouldCastAsDateTime($key)
{
}
/**
* Casts a date value from Graph to DateTime.
*
* @param int|string $value
*
* @return \DateTime
*/
public function castToDateTime($value)
{
}
/**
* Casts a birthday value from Graph to Birthday
*
* @param string $value
*
* @return Birthday
*/
public function castToBirthday($value)
{
}
/**
* Getter for $graphObjectMap.
*
* @return array
*/
public static function getObjectMap()
{
}
}
/**
* Class GraphAlbum
*
* @package Facebook
*/
class GraphAlbum extends \Facebook\GraphNodes\GraphNode
{
/**
* @var array Maps object key names to Graph object types.
*/
protected static $graphObjectMap = ['from' => '\\Facebook\\GraphNodes\\GraphUser', 'place' => '\\Facebook\\GraphNodes\\GraphPage'];
/**
* Returns the ID for the album.
*
* @return string|null
*/
public function getId()
{
}
/**
* Returns whether the viewer can upload photos to this album.
*
* @return boolean|null
*/
public function getCanUpload()
{
}
/**
* Returns the number of photos in this album.
*
* @return int|null
*/
public function getCount()
{
}
/**
* Returns the ID of the album's cover photo.
*
* @return string|null
*/
public function getCoverPhoto()
{
}
/**
* Returns the time the album was initially created.
*
* @return \DateTime|null
*/
public function getCreatedTime()
{
}
/**
* Returns the time the album was updated.
*
* @return \DateTime|null
*/
public function getUpdatedTime()
{
}
/**
* Returns the description of the album.
*
* @return string|null
*/
public function getDescription()
{
}
/**
* Returns profile that created the album.
*
* @return GraphUser|null
*/
public function getFrom()
{
}
/**
* Returns profile that created the album.
*
* @return GraphPage|null
*/
public function getPlace()
{
}
/**
* Returns a link to this album on Facebook.
*
* @return string|null
*/
public function getLink()
{
}
/**
* Returns the textual location of the album.
*
* @return string|null
*/
public function getLocation()
{
}
/**
* Returns the title of the album.
*
* @return string|null
*/
public function getName()
{
}
/**
* Returns the privacy settings for the album.
*
* @return string|null
*/
public function getPrivacy()
{
}
/**
* Returns the type of the album.
*
* enum{ profile, mobile, wall, normal, album }
*
* @return string|null
*/
public function getType()
{
}
}
/**
* Class GraphPage
*
* @package Facebook
*/
class GraphPage extends \Facebook\GraphNodes\GraphNode
{
/**
* @var array Maps object key names to Graph object types.
*/
protected static $graphObjectMap = ['best_page' => '\\Facebook\\GraphNodes\\GraphPage', 'global_brand_parent_page' => '\\Facebook\\GraphNodes\\GraphPage', 'location' => '\\Facebook\\GraphNodes\\GraphLocation', 'cover' => '\\Facebook\\GraphNodes\\GraphCoverPhoto', 'picture' => '\\Facebook\\GraphNodes\\GraphPicture'];
/**
* Returns the ID for the user's page as a string if present.
*
* @return string|null
*/
public function getId()
{
}
/**
* Returns the Category for the user's page as a string if present.
*
* @return string|null
*/
public function getCategory()
{
}
/**
* Returns the Name of the user's page as a string if present.
*
* @return string|null
*/
public function getName()
{
}
/**
* Returns the best available Page on Facebook.
*
* @return GraphPage|null
*/
public function getBestPage()
{
}
/**
* Returns the brand's global (parent) Page.
*
* @return GraphPage|null
*/
public function getGlobalBrandParentPage()
{
}
/**
* Returns the location of this place.
*
* @return GraphLocation|null
*/
public function getLocation()
{
}
/**
* Returns CoverPhoto of the Page.
*
* @return GraphCoverPhoto|null
*/
public function getCover()
{
}
/**
* Returns Picture of the Page.
*
* @return GraphPicture|null
*/
public function getPicture()
{
}
/**
* Returns the page access token for the admin user.
*
* Only available in the `/me/accounts` context.
*
* @return string|null
*/
public function getAccessToken()
{
}
/**
* Returns the roles of the page admin user.
*
* Only available in the `/me/accounts` context.
*
* @return array|null
*/
public function getPerms()
{
}
}
/**
* Class GraphUser
*
* @package Facebook
*/
class GraphUser extends \Facebook\GraphNodes\GraphNode
{
/**
* @var array Maps object key names to Graph object types.
*/
protected static $graphObjectMap = ['hometown' => '\\Facebook\\GraphNodes\\GraphPage', 'location' => '\\Facebook\\GraphNodes\\GraphPage', 'significant_other' => '\\Facebook\\GraphNodes\\GraphUser', 'picture' => '\\Facebook\\GraphNodes\\GraphPicture'];
/**
* Returns the ID for the user as a string if present.
*
* @return string|null
*/
public function getId()
{
}
/**
* Returns the name for the user as a string if present.
*
* @return string|null
*/
public function getName()
{
}
/**
* Returns the first name for the user as a string if present.
*
* @return string|null
*/
public function getFirstName()
{
}
/**
* Returns the middle name for the user as a string if present.
*
* @return string|null
*/
public function getMiddleName()
{
}
/**
* Returns the last name for the user as a string if present.
*
* @return string|null
*/
public function getLastName()
{
}
/**
* Returns the email for the user as a string if present.
*
* @return string|null
*/
public function getEmail()
{
}
/**
* Returns the gender for the user as a string if present.
*
* @return string|null
*/
public function getGender()
{
}
/**
* Returns the Facebook URL for the user as a string if available.
*
* @return string|null
*/
public function getLink()
{
}
/**
* Returns the users birthday, if available.
*
* @return \DateTime|null
*/
public function getBirthday()
{
}
/**
* Returns the current location of the user as a GraphPage.
*
* @return GraphPage|null
*/
public function getLocation()
{
}
/**
* Returns the current location of the user as a GraphPage.
*
* @return GraphPage|null
*/
public function getHometown()
{
}
/**
* Returns the current location of the user as a GraphUser.
*
* @return GraphUser|null
*/
public function getSignificantOther()
{
}
/**
* Returns the picture of the user as a GraphPicture
*
* @return GraphPicture|null
*/
public function getPicture()
{
}
}
/**
* Class GraphEvent
*
* @package Facebook
*/
class GraphEvent extends \Facebook\GraphNodes\GraphNode
{
/**
* @var array Maps object key names to GraphNode types.
*/
protected static $graphObjectMap = ['cover' => '\\Facebook\\GraphNodes\\GraphCoverPhoto', 'place' => '\\Facebook\\GraphNodes\\GraphPage', 'picture' => '\\Facebook\\GraphNodes\\GraphPicture', 'parent_group' => '\\Facebook\\GraphNodes\\GraphGroup'];
/**
* Returns the `id` (The event ID) as string if present.
*
* @return string|null
*/
public function getId()
{
}
/**
* Returns the `cover` (Cover picture) as GraphCoverPhoto if present.
*
* @return GraphCoverPhoto|null
*/
public function getCover()
{
}
/**
* Returns the `description` (Long-form description) as string if present.
*
* @return string|null
*/
public function getDescription()
{
}
/**
* Returns the `end_time` (End time, if one has been set) as DateTime if present.
*
* @return \DateTime|null
*/
public function getEndTime()
{
}
/**
* Returns the `is_date_only` (Whether the event only has a date specified, but no time) as bool if present.
*
* @return bool|null
*/
public function getIsDateOnly()
{
}
/**
* Returns the `name` (Event name) as string if present.
*
* @return string|null
*/
public function getName()
{
}
/**
* Returns the `owner` (The profile that created the event) as GraphNode if present.
*
* @return GraphNode|null
*/
public function getOwner()
{
}
/**
* Returns the `parent_group` (The group the event belongs to) as GraphGroup if present.
*
* @return GraphGroup|null
*/
public function getParentGroup()
{
}
/**
* Returns the `place` (Event Place information) as GraphPage if present.
*
* @return GraphPage|null
*/
public function getPlace()
{
}
/**
* Returns the `privacy` (Who can see the event) as string if present.
*
* @return string|null
*/
public function getPrivacy()
{
}
/**
* Returns the `start_time` (Start time) as DateTime if present.
*
* @return \DateTime|null
*/
public function getStartTime()
{
}
/**
* Returns the `ticket_uri` (The link users can visit to buy a ticket to this event) as string if present.
*
* @return string|null
*/
public function getTicketUri()
{
}
/**
* Returns the `timezone` (Timezone) as string if present.
*
* @return string|null
*/
public function getTimezone()
{
}
/**
* Returns the `updated_time` (Last update time) as DateTime if present.
*
* @return \DateTime|null
*/
public function getUpdatedTime()
{
}
/**
* Returns the `picture` (Event picture) as GraphPicture if present.
*
* @return GraphPicture|null
*/
public function getPicture()
{
}
/**
* Returns the `attending_count` (Number of people attending the event) as int if present.
*
* @return int|null
*/
public function getAttendingCount()
{
}
/**
* Returns the `declined_count` (Number of people who declined the event) as int if present.
*
* @return int|null
*/
public function getDeclinedCount()
{
}
/**
* Returns the `maybe_count` (Number of people who maybe going to the event) as int if present.
*
* @return int|null
*/
public function getMaybeCount()
{
}
/**
* Returns the `noreply_count` (Number of people who did not reply to the event) as int if present.
*
* @return int|null
*/
public function getNoreplyCount()
{
}
/**
* Returns the `invited_count` (Number of people invited to the event) as int if present.
*
* @return int|null
*/
public function getInvitedCount()
{
}
}
/**
* Class GraphApplication
*
* @package Facebook
*/
class GraphApplication extends \Facebook\GraphNodes\GraphNode
{
/**
* Returns the ID for the application.
*
* @return string|null
*/
public function getId()
{
}
}
/**
* Class GraphNodeFactory
*
* @package Facebook
*
* ## Assumptions ##
* GraphEdge - is ALWAYS a numeric array
* GraphEdge - is ALWAYS an array of GraphNode types
* GraphNode - is ALWAYS an associative array
* GraphNode - MAY contain GraphNode's "recurrable"
* GraphNode - MAY contain GraphEdge's "recurrable"
* GraphNode - MAY contain DateTime's "primitives"
* GraphNode - MAY contain string's "primitives"
*/
class GraphNodeFactory
{
/**
* @const string The base graph object class.
*/
const BASE_GRAPH_NODE_CLASS = '\\Facebook\\GraphNodes\\GraphNode';
/**
* @const string The base graph edge class.
*/
const BASE_GRAPH_EDGE_CLASS = '\\Facebook\\GraphNodes\\GraphEdge';
/**
* @const string The graph object prefix.
*/
const BASE_GRAPH_OBJECT_PREFIX = '\\Facebook\\GraphNodes\\';
/**
* @var FacebookResponse The response entity from Graph.
*/
protected $response;
/**
* @var array The decoded body of the FacebookResponse entity from Graph.
*/
protected $decodedBody;
/**
* Init this Graph object.
*
* @param FacebookResponse $response The response entity from Graph.
*/
public function __construct(\Facebook\FacebookResponse $response)
{
}
/**
* Tries to convert a FacebookResponse entity into a GraphNode.
*
* @param string|null $subclassName The GraphNode sub class to cast to.
*
* @return GraphNode
*
* @throws FacebookSDKException
*/
public function makeGraphNode($subclassName = null)
{
}
/**
* Convenience method for creating a GraphAchievement collection.
*
* @return GraphAchievement
*
* @throws FacebookSDKException
*/
public function makeGraphAchievement()
{
}
/**
* Convenience method for creating a GraphAlbum collection.
*
* @return GraphAlbum
*
* @throws FacebookSDKException
*/
public function makeGraphAlbum()
{
}
/**
* Convenience method for creating a GraphPage collection.
*
* @return GraphPage
*
* @throws FacebookSDKException
*/
public function makeGraphPage()
{
}
/**
* Convenience method for creating a GraphSessionInfo collection.
*
* @return GraphSessionInfo
*
* @throws FacebookSDKException
*/
public function makeGraphSessionInfo()
{
}
/**
* Convenience method for creating a GraphUser collection.
*
* @return GraphUser
*
* @throws FacebookSDKException
*/
public function makeGraphUser()
{
}
/**
* Convenience method for creating a GraphEvent collection.
*
* @return GraphEvent
*
* @throws FacebookSDKException
*/
public function makeGraphEvent()
{
}
/**
* Convenience method for creating a GraphGroup collection.
*
* @return GraphGroup
*
* @throws FacebookSDKException
*/
public function makeGraphGroup()
{
}
/**
* Tries to convert a FacebookResponse entity into a GraphEdge.
*
* @param string|null $subclassName The GraphNode sub class to cast the list items to.
* @param boolean $auto_prefix Toggle to auto-prefix the subclass name.
*
* @return GraphEdge
*
* @throws FacebookSDKException
*/
public function makeGraphEdge($subclassName = null, $auto_prefix = true)
{
}
/**
* Validates the decoded body.
*
* @throws FacebookSDKException
*/
public function validateResponseAsArray()
{
}
/**
* Validates that the return data can be cast as a GraphNode.
*
* @throws FacebookSDKException
*/
public function validateResponseCastableAsGraphNode()
{
}
/**
* Validates that the return data can be cast as a GraphEdge.
*
* @throws FacebookSDKException
*/
public function validateResponseCastableAsGraphEdge()
{
}
/**
* Safely instantiates a GraphNode of $subclassName.
*
* @param array $data The array of data to iterate over.
* @param string|null $subclassName The subclass to cast this collection to.
*
* @return GraphNode
*
* @throws FacebookSDKException
*/
public function safelyMakeGraphNode(array $data, $subclassName = null)
{
}
/**
* Takes an array of values and determines how to cast each node.
*
* @param array $data The array of data to iterate over.
* @param string|null $subclassName The subclass to cast this collection to.
* @param string|null $parentKey The key of this data (Graph edge).
* @param string|null $parentNodeId The parent Graph node ID.
*
* @return GraphNode|GraphEdge
*
* @throws FacebookSDKException
*/
public function castAsGraphNodeOrGraphEdge(array $data, $subclassName = null, $parentKey = null, $parentNodeId = null)
{
}
/**
* Return an array of GraphNode's.
*
* @param array $data The array of data to iterate over.
* @param string|null $subclassName The GraphNode subclass to cast each item in the list to.
* @param string|null $parentKey The key of this data (Graph edge).
* @param string|null $parentNodeId The parent Graph node ID.
*
* @return GraphEdge
*
* @throws FacebookSDKException
*/
public function safelyMakeGraphEdge(array $data, $subclassName = null, $parentKey = null, $parentNodeId = null)
{
}
/**
* Get the meta data from a list in a Graph response.
*
* @param array $data The Graph response.
*
* @return array
*/
public function getMetaData(array $data)
{
}
/**
* Determines whether or not the data should be cast as a GraphEdge.
*
* @param array $data
*
* @return boolean
*/
public static function isCastableAsGraphEdge(array $data)
{
}
/**
* Ensures that the subclass in question is valid.
*
* @param string $subclassName The GraphNode subclass to validate.
*
* @throws FacebookSDKException
*/
public static function validateSubclass($subclassName)
{
}
}
/**
* Class GraphObjectFactory
*
* @package Facebook
*
* @deprecated 5.0.0 GraphObjectFactory has been renamed to GraphNodeFactory
* @todo v6: Remove this class
*/
class GraphObjectFactory extends \Facebook\GraphNodes\GraphNodeFactory
{
/**
* @const string The base graph object class.
*/
const BASE_GRAPH_NODE_CLASS = '\\Facebook\\GraphNodes\\GraphObject';
/**
* @const string The base graph edge class.
*/
const BASE_GRAPH_EDGE_CLASS = '\\Facebook\\GraphNodes\\GraphList';
/**
* Tries to convert a FacebookResponse entity into a GraphNode.
*
* @param string|null $subclassName The GraphNode sub class to cast to.
*
* @return GraphNode
*
* @deprecated 5.0.0 GraphObjectFactory has been renamed to GraphNodeFactory
*/
public function makeGraphObject($subclassName = null)
{
}
/**
* Convenience method for creating a GraphEvent collection.
*
* @return GraphEvent
*
* @throws FacebookSDKException
*/
public function makeGraphEvent()
{
}
/**
* Tries to convert a FacebookResponse entity into a GraphEdge.
*
* @param string|null $subclassName The GraphNode sub class to cast the list items to.
* @param boolean $auto_prefix Toggle to auto-prefix the subclass name.
*
* @return GraphEdge
*
* @deprecated 5.0.0 GraphObjectFactory has been renamed to GraphNodeFactory
*/
public function makeGraphList($subclassName = null, $auto_prefix = true)
{
}
}
/**
* Class GraphGroup
*
* @package Facebook
*/
class GraphGroup extends \Facebook\GraphNodes\GraphNode
{
/**
* @var array Maps object key names to GraphNode types.
*/
protected static $graphObjectMap = ['cover' => '\\Facebook\\GraphNodes\\GraphCoverPhoto', 'venue' => '\\Facebook\\GraphNodes\\GraphLocation'];
/**
* Returns the `id` (The Group ID) as string if present.
*
* @return string|null
*/
public function getId()
{
}
/**
* Returns the `cover` (The cover photo of the Group) as GraphCoverPhoto if present.
*
* @return GraphCoverPhoto|null
*/
public function getCover()
{
}
/**
* Returns the `description` (A brief description of the Group) as string if present.
*
* @return string|null
*/
public function getDescription()
{
}
/**
* Returns the `email` (The email address to upload content to the Group. Only current members of the Group can use this) as string if present.
*
* @return string|null
*/
public function getEmail()
{
}
/**
* Returns the `icon` (The URL for the Group's icon) as string if present.
*
* @return string|null
*/
public function getIcon()
{
}
/**
* Returns the `link` (The Group's website) as string if present.
*
* @return string|null
*/
public function getLink()
{
}
/**
* Returns the `name` (The name of the Group) as string if present.
*
* @return string|null
*/
public function getName()
{
}
/**
* Returns the `member_request_count` (Number of people asking to join the group.) as int if present.
*
* @return int|null
*/
public function getMemberRequestCount()
{
}
/**
* Returns the `owner` (The profile that created this Group) as GraphNode if present.
*
* @return GraphNode|null
*/
public function getOwner()
{
}
/**
* Returns the `parent` (The parent Group of this Group, if it exists) as GraphNode if present.
*
* @return GraphNode|null
*/
public function getParent()
{
}
/**
* Returns the `privacy` (The privacy setting of the Group) as string if present.
*
* @return string|null
*/
public function getPrivacy()
{
}
/**
* Returns the `updated_time` (The last time the Group was updated (this includes changes in the Group's properties and changes in posts and comments if user can see them)) as \DateTime if present.
*
* @return \DateTime|null
*/
public function getUpdatedTime()
{
}
/**
* Returns the `venue` (The location for the Group) as GraphLocation if present.
*
* @return GraphLocation|null
*/
public function getVenue()
{
}
}
/**
* Class GraphEdge
*
* @package Facebook
*/
class GraphEdge extends \Facebook\GraphNodes\Collection
{
/**
* @var FacebookRequest The original request that generated this data.
*/
protected $request;
/**
* @var array An array of Graph meta data like pagination, etc.
*/
protected $metaData = [];
/**
* @var string|null The parent Graph edge endpoint that generated the list.
*/
protected $parentEdgeEndpoint;
/**
* @var string|null The subclass of the child GraphNode's.
*/
protected $subclassName;
/**
* Init this collection of GraphNode's.
*
* @param FacebookRequest $request The original request that generated this data.
* @param array $data An array of GraphNode's.
* @param array $metaData An array of Graph meta data like pagination, etc.
* @param string|null $parentEdgeEndpoint The parent Graph edge endpoint that generated the list.
* @param string|null $subclassName The subclass of the child GraphNode's.
*/
public function __construct(\Facebook\FacebookRequest $request, array $data = [], array $metaData = [], $parentEdgeEndpoint = null, $subclassName = null)
{
}
/**
* Gets the parent Graph edge endpoint that generated the list.
*
* @return string|null
*/
public function getParentGraphEdge()
{
}
/**
* Gets the subclass name that the child GraphNode's are cast as.
*
* @return string|null
*/
public function getSubClassName()
{
}
/**
* Returns the raw meta data associated with this GraphEdge.
*
* @return array
*/
public function getMetaData()
{
}
/**
* Returns the next cursor if it exists.
*
* @return string|null
*/
public function getNextCursor()
{
}
/**
* Returns the previous cursor if it exists.
*
* @return string|null
*/
public function getPreviousCursor()
{
}
/**
* Returns the cursor for a specific direction if it exists.
*
* @param string $direction The direction of the page: after|before
*
* @return string|null
*/
public function getCursor($direction)
{
}
/**
* Generates a pagination URL based on a cursor.
*
* @param string $direction The direction of the page: next|previous
*
* @return string|null
*
* @throws FacebookSDKException
*/
public function getPaginationUrl($direction)
{
}
/**
* Validates whether or not we can paginate on this request.
*
* @throws FacebookSDKException
*/
public function validateForPagination()
{
}
/**
* Gets the request object needed to make a next|previous page request.
*
* @param string $direction The direction of the page: next|previous
*
* @return FacebookRequest|null
*
* @throws FacebookSDKException
*/
public function getPaginationRequest($direction)
{
}
/**
* Gets the request object needed to make a "next" page request.
*
* @return FacebookRequest|null
*
* @throws FacebookSDKException
*/
public function getNextPageRequest()
{
}
/**
* Gets the request object needed to make a "previous" page request.
*
* @return FacebookRequest|null
*
* @throws FacebookSDKException
*/
public function getPreviousPageRequest()
{
}
/**
* The total number of results according to Graph if it exists.
*
* This will be returned if the summary=true modifier is present in the request.
*
* @return int|null
*/
public function getTotalCount()
{
}
/**
* @inheritDoc
*/
public function map(\Closure $callback)
{
}
}
/**
* Class GraphAchievement
*
* @package Facebook
*/
class GraphAchievement extends \Facebook\GraphNodes\GraphNode
{
/**
* @var array Maps object key names to Graph object types.
*/
protected static $graphObjectMap = ['from' => '\\Facebook\\GraphNodes\\GraphUser', 'application' => '\\Facebook\\GraphNodes\\GraphApplication'];
/**
* Returns the ID for the achievement.
*
* @return string|null
*/
public function getId()
{
}
/**
* Returns the user who achieved this.
*
* @return GraphUser|null
*/
public function getFrom()
{
}
/**
* Returns the time at which this was achieved.
*
* @return \DateTime|null
*/
public function getPublishTime()
{
}
/**
* Returns the app in which the user achieved this.
*
* @return GraphApplication|null
*/
public function getApplication()
{
}
/**
* Returns information about the achievement type this instance is connected with.
*
* @return array|null
*/
public function getData()
{
}
/**
* Returns the type of achievement.
*
* @see https://developers.facebook.com/docs/graph-api/reference/achievement
*
* @return string
*/
public function getType()
{
}
/**
* Indicates whether gaining the achievement published a feed story for the user.
*
* @return boolean|null
*/
public function isNoFeedStory()
{
}
}
/**
* Class GraphLocation
*
* @package Facebook
*/
class GraphLocation extends \Facebook\GraphNodes\GraphNode
{
/**
* Returns the street component of the location
*
* @return string|null
*/
public function getStreet()
{
}
/**
* Returns the city component of the location
*
* @return string|null
*/
public function getCity()
{
}
/**
* Returns the state component of the location
*
* @return string|null
*/
public function getState()
{
}
/**
* Returns the country component of the location
*
* @return string|null
*/
public function getCountry()
{
}
/**
* Returns the zipcode component of the location
*
* @return string|null
*/
public function getZip()
{
}
/**
* Returns the latitude component of the location
*
* @return float|null
*/
public function getLatitude()
{
}
/**
* Returns the street component of the location
*
* @return float|null
*/
public function getLongitude()
{
}
}
/**
* Class GraphSessionInfo
*
* @package Facebook
*/
class GraphSessionInfo extends \Facebook\GraphNodes\GraphNode
{
/**
* Returns the application id the token was issued for.
*
* @return string|null
*/
public function getAppId()
{
}
/**
* Returns the application name the token was issued for.
*
* @return string|null
*/
public function getApplication()
{
}
/**
* Returns the date & time that the token expires.
*
* @return \DateTime|null
*/
public function getExpiresAt()
{
}
/**
* Returns whether the token is valid.
*
* @return boolean
*/
public function getIsValid()
{
}
/**
* Returns the date & time the token was issued at.
*
* @return \DateTime|null
*/
public function getIssuedAt()
{
}
/**
* Returns the scope permissions associated with the token.
*
* @return array
*/
public function getScopes()
{
}
/**
* Returns the login id of the user associated with the token.
*
* @return string|null
*/
public function getUserId()
{
}
}
/**
* Class GraphCoverPhoto
*
* @package Facebook
*/
class GraphCoverPhoto extends \Facebook\GraphNodes\GraphNode
{
/**
* Returns the id of cover if it exists
*
* @return int|null
*/
public function getId()
{
}
/**
* Returns the source of cover if it exists
*
* @return string|null
*/
public function getSource()
{
}
/**
* Returns the offset_x of cover if it exists
*
* @return int|null
*/
public function getOffsetX()
{
}
/**
* Returns the offset_y of cover if it exists
*
* @return int|null
*/
public function getOffsetY()
{
}
}
/**
* Birthday object to handle various Graph return formats
*
* @package Facebook
*/
class Birthday extends \DateTime
{
/**
* Parses Graph birthday format to set indication flags, possible values:
*
* MM/DD/YYYY
* MM/DD
* YYYY
*
* @link https://developers.facebook.com/docs/graph-api/reference/user
*
* @param string $date
*/
public function __construct($date)
{
}
/**
* Returns whether date object contains birth day and month
*
* @return bool
*/
public function hasDate()
{
}
/**
* Returns whether date object contains birth year
*
* @return bool
*/
public function hasYear()
{
}
}
/**
* Class GraphList
*
* @package Facebook
*
* @deprecated 5.0.0 GraphList has been renamed to GraphEdge
* @todo v6: Remove this class
*/
class GraphList extends \Facebook\GraphNodes\GraphEdge
{
}
/**
* Class GraphObject
*
* @package Facebook
*
* @deprecated 5.0.0 GraphObject has been renamed to GraphNode
* @todo v6: Remove this class
*/
class GraphObject extends \Facebook\GraphNodes\GraphNode
{
}
/**
* Class GraphPicture
*
* @package Facebook
*/
class GraphPicture extends \Facebook\GraphNodes\GraphNode
{
/**
* Returns true if user picture is silhouette.
*
* @return bool|null
*/
public function isSilhouette()
{
}
/**
* Returns the url of user picture if it exists
*
* @return string|null
*/
public function getUrl()
{
}
/**
* Returns the width of user picture if it exists
*
* @return int|null
*/
public function getWidth()
{
}
/**
* Returns the height of user picture if it exists
*
* @return int|null
*/
public function getHeight()
{
}
}
}
namespace Facebook {
/**
* Class Facebook
*
* @package Facebook
*/
class Facebook
{
/**
* @const string Version number of the Facebook PHP SDK.
*/
const VERSION = '5.5.0';
/**
* @const string Default Graph API version for requests.
*/
const DEFAULT_GRAPH_VERSION = 'v2.9';
/**
* @const string The name of the environment variable that contains the app ID.
*/
const APP_ID_ENV_NAME = 'FACEBOOK_APP_ID';
/**
* @const string The name of the environment variable that contains the app secret.
*/
const APP_SECRET_ENV_NAME = 'FACEBOOK_APP_SECRET';
/**
* @var FacebookApp The FacebookApp entity.
*/
protected $app;
/**
* @var FacebookClient The Facebook client service.
*/
protected $client;
/**
* @var OAuth2Client The OAuth 2.0 client service.
*/
protected $oAuth2Client;
/**
* @var UrlDetectionInterface|null The URL detection handler.
*/
protected $urlDetectionHandler;
/**
* @var PseudoRandomStringGeneratorInterface|null The cryptographically secure pseudo-random string generator.
*/
protected $pseudoRandomStringGenerator;
/**
* @var AccessToken|null The default access token to use with requests.
*/
protected $defaultAccessToken;
/**
* @var string|null The default Graph version we want to use.
*/
protected $defaultGraphVersion;
/**
* @var PersistentDataInterface|null The persistent data handler.
*/
protected $persistentDataHandler;
/**
* @var FacebookResponse|FacebookBatchResponse|null Stores the last request made to Graph.
*/
protected $lastResponse;
/**
* Instantiates a new Facebook super-class object.
*
* @param array $config
*
* @throws FacebookSDKException
*/
public function __construct(array $config = [])
{
}
/**
* Returns the FacebookApp entity.
*
* @return FacebookApp
*/
public function getApp()
{
}
/**
* Returns the FacebookClient service.
*
* @return FacebookClient
*/
public function getClient()
{
}
/**
* Returns the OAuth 2.0 client service.
*
* @return OAuth2Client
*/
public function getOAuth2Client()
{
}
/**
* Returns the last response returned from Graph.
*
* @return FacebookResponse|FacebookBatchResponse|null
*/
public function getLastResponse()
{
}
/**
* Returns the URL detection handler.
*
* @return UrlDetectionInterface
*/
public function getUrlDetectionHandler()
{
}
/**
* Returns the default AccessToken entity.
*
* @return AccessToken|null
*/
public function getDefaultAccessToken()
{
}
/**
* Sets the default access token to use with requests.
*
* @param AccessToken|string $accessToken The access token to save.
*
* @throws \InvalidArgumentException
*/
public function setDefaultAccessToken($accessToken)
{
}
/**
* Returns the default Graph version.
*
* @return string
*/
public function getDefaultGraphVersion()
{
}
/**
* Returns the redirect login helper.
*
* @return FacebookRedirectLoginHelper
*/
public function getRedirectLoginHelper()
{
}
/**
* Returns the JavaScript helper.
*
* @return FacebookJavaScriptHelper
*/
public function getJavaScriptHelper()
{
}
/**
* Returns the canvas helper.
*
* @return FacebookCanvasHelper
*/
public function getCanvasHelper()
{
}
/**
* Returns the page tab helper.
*
* @return FacebookPageTabHelper
*/
public function getPageTabHelper()
{
}
/**
* Sends a GET request to Graph and returns the result.
*
* @param string $endpoint
* @param AccessToken|string|null $accessToken
* @param string|null $eTag
* @param string|null $graphVersion
*
* @return FacebookResponse
*
* @throws FacebookSDKException
*/
public function get($endpoint, $accessToken = null, $eTag = null, $graphVersion = null)
{
}
/**
* Sends a POST request to Graph and returns the result.
*
* @param string $endpoint
* @param array $params
* @param AccessToken|string|null $accessToken
* @param string|null $eTag
* @param string|null $graphVersion
*
* @return FacebookResponse
*
* @throws FacebookSDKException
*/
public function post($endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
{
}
/**
* Sends a DELETE request to Graph and returns the result.
*
* @param string $endpoint
* @param array $params
* @param AccessToken|string|null $accessToken
* @param string|null $eTag
* @param string|null $graphVersion
*
* @return FacebookResponse
*
* @throws FacebookSDKException
*/
public function delete($endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
{
}
/**
* Sends a request to Graph for the next page of results.
*
* @param GraphEdge $graphEdge The GraphEdge to paginate over.
*
* @return GraphEdge|null
*
* @throws FacebookSDKException
*/
public function next(\Facebook\GraphNodes\GraphEdge $graphEdge)
{
}
/**
* Sends a request to Graph for the previous page of results.
*
* @param GraphEdge $graphEdge The GraphEdge to paginate over.
*
* @return GraphEdge|null
*
* @throws FacebookSDKException
*/
public function previous(\Facebook\GraphNodes\GraphEdge $graphEdge)
{
}
/**
* Sends a request to Graph for the next page of results.
*
* @param GraphEdge $graphEdge The GraphEdge to paginate over.
* @param string $direction The direction of the pagination: next|previous.
*
* @return GraphEdge|null
*
* @throws FacebookSDKException
*/
public function getPaginationResults(\Facebook\GraphNodes\GraphEdge $graphEdge, $direction)
{
}
/**
* Sends a request to Graph and returns the result.
*
* @param string $method
* @param string $endpoint
* @param array $params
* @param AccessToken|string|null $accessToken
* @param string|null $eTag
* @param string|null $graphVersion
*
* @return FacebookResponse
*
* @throws FacebookSDKException
*/
public function sendRequest($method, $endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
{
}
/**
* Sends a batched request to Graph and returns the result.
*
* @param array $requests
* @param AccessToken|string|null $accessToken
* @param string|null $graphVersion
*
* @return FacebookBatchResponse
*
* @throws FacebookSDKException
*/
public function sendBatchRequest(array $requests, $accessToken = null, $graphVersion = null)
{
}
/**
* Instantiates an empty FacebookBatchRequest entity.
*
* @param AccessToken|string|null $accessToken The top-level access token. Requests with no access token
* will fallback to this.
* @param string|null $graphVersion The Graph API version to use.
* @return FacebookBatchRequest
*/
public function newBatchRequest($accessToken = null, $graphVersion = null)
{
}
/**
* Instantiates a new FacebookRequest entity.
*
* @param string $method
* @param string $endpoint
* @param array $params
* @param AccessToken|string|null $accessToken
* @param string|null $eTag
* @param string|null $graphVersion
*
* @return FacebookRequest
*
* @throws FacebookSDKException
*/
public function request($method, $endpoint, array $params = [], $accessToken = null, $eTag = null, $graphVersion = null)
{
}
/**
* Factory to create FacebookFile's.
*
* @param string $pathToFile
*
* @return FacebookFile
*
* @throws FacebookSDKException
*/
public function fileToUpload($pathToFile)
{
}
/**
* Factory to create FacebookVideo's.
*
* @param string $pathToFile
*
* @return FacebookVideo
*
* @throws FacebookSDKException
*/
public function videoToUpload($pathToFile)
{
}
/**
* Upload a video in chunks.
*
* @param int $target The id of the target node before the /videos edge.
* @param string $pathToFile The full path to the file.
* @param array $metadata The metadata associated with the video file.
* @param string|null $accessToken The access token.
* @param int $maxTransferTries The max times to retry a failed upload chunk.
* @param string|null $graphVersion The Graph API version to use.
*
* @return array
*
* @throws FacebookSDKException
*/
public function uploadVideo($target, $pathToFile, $metadata = [], $accessToken = null, $maxTransferTries = 5, $graphVersion = null)
{
}
}
}
namespace Facebook\FileUpload {
/**
* Class FacebookFile
*
* @package Facebook
*/
class FacebookFile
{
/**
* @var string The path to the file on the system.
*/
protected $path;
/**
* @var resource The stream pointing to the file.
*/
protected $stream;
/**
* Creates a new FacebookFile entity.
*
* @param string $filePath
* @param int $maxLength
* @param int $offset
*
* @throws FacebookSDKException
*/
public function __construct($filePath, $maxLength = -1, $offset = -1)
{
}
/**
* Closes the stream when destructed.
*/
public function __destruct()
{
}
/**
* Opens a stream for the file.
*
* @throws FacebookSDKException
*/
public function open()
{
}
/**
* Stops the file stream.
*/
public function close()
{
}
/**
* Return the contents of the file.
*
* @return string
*/
public function getContents()
{
}
/**
* Return the name of the file.
*
* @return string
*/
public function getFileName()
{
}
/**
* Return the path of the file.
*
* @return string
*/
public function getFilePath()
{
}
/**
* Return the size of the file.
*
* @return int
*/
public function getSize()
{
}
/**
* Return the mimetype of the file.
*
* @return string
*/
public function getMimetype()
{
}
/**
* Returns true if the path to the file is remote.
*
* @param string $pathToFile
*
* @return boolean
*/
protected function isRemoteFile($pathToFile)
{
}
}
/**
* Class FacebookResumableUploader
*
* @package Facebook
*/
class FacebookResumableUploader
{
/**
* @var FacebookApp
*/
protected $app;
/**
* @var string
*/
protected $accessToken;
/**
* @var FacebookClient The Facebook client service.
*/
protected $client;
/**
* @var string Graph version to use for this request.
*/
protected $graphVersion;
/**
* @param FacebookApp $app
* @param FacebookClient $client
* @param AccessToken|string|null $accessToken
* @param string $graphVersion
*/
public function __construct(\Facebook\FacebookApp $app, \Facebook\FacebookClient $client, $accessToken, $graphVersion)
{
}
/**
* Upload by chunks - start phase
*
* @param string $endpoint
* @param FacebookFile $file
*
* @return FacebookTransferChunk
*
* @throws FacebookSDKException
*/
public function start($endpoint, \Facebook\FileUpload\FacebookFile $file)
{
}
/**
* Upload by chunks - transfer phase
*
* @param string $endpoint
* @param FacebookTransferChunk $chunk
* @param boolean $allowToThrow
*
* @return FacebookTransferChunk
*
* @throws FacebookResponseException
*/
public function transfer($endpoint, \Facebook\FileUpload\FacebookTransferChunk $chunk, $allowToThrow = false)
{
}
/**
* Upload by chunks - finish phase
*
* @param string $endpoint
* @param string $uploadSessionId
* @param array $metadata The metadata associated with the file.
*
* @return boolean
*
* @throws FacebookSDKException
*/
public function finish($endpoint, $uploadSessionId, $metadata = [])
{
}
}
/**
* Provides mappings of file extensions to mimetypes
*
* Taken from Guzzle
*
* @see https://github.com/guzzle/guzzle/blob/master/src/Mimetypes.php
*
* @link http://svn.apache.org/repos/asf/httpd/httpd/branches/1.3.x/conf/mime.types
*/
class Mimetypes
{
/** @var self */
protected static $instance;
/** @var array Mapping of extension to mimetype */
protected $mimetypes = ['3dml' => 'text/vnd.in3d.3dml', '3g2' => 'video/3gpp2', '3gp' => 'video/3gpp', '7z' => 'application/x-7z-compressed', 'aab' => 'application/x-authorware-bin', 'aac' => 'audio/x-aac', 'aam' => 'application/x-authorware-map', 'aas' => 'application/x-authorware-seg', 'abw' => 'application/x-abiword', 'ac' => 'application/pkix-attr-cert', 'acc' => 'application/vnd.americandynamics.acc', 'ace' => 'application/x-ace-compressed', 'acu' => 'application/vnd.acucobol', 'acutc' => 'application/vnd.acucorp', 'adp' => 'audio/adpcm', 'aep' => 'application/vnd.audiograph', 'afm' => 'application/x-font-type1', 'afp' => 'application/vnd.ibm.modcap', 'ahead' => 'application/vnd.ahead.space', 'ai' => 'application/postscript', 'aif' => 'audio/x-aiff', 'aifc' => 'audio/x-aiff', 'aiff' => 'audio/x-aiff', 'air' => 'application/vnd.adobe.air-application-installer-package+zip', 'ait' => 'application/vnd.dvb.ait', 'ami' => 'application/vnd.amiga.ami', 'apk' => 'application/vnd.android.package-archive', 'application' => 'application/x-ms-application', 'apr' => 'application/vnd.lotus-approach', 'asa' => 'text/plain', 'asax' => 'application/octet-stream', 'asc' => 'application/pgp-signature', 'ascx' => 'text/plain', 'asf' => 'video/x-ms-asf', 'ashx' => 'text/plain', 'asm' => 'text/x-asm', 'asmx' => 'text/plain', 'aso' => 'application/vnd.accpac.simply.aso', 'asp' => 'text/plain', 'aspx' => 'text/plain', 'asx' => 'video/x-ms-asf', 'atc' => 'application/vnd.acucorp', 'atom' => 'application/atom+xml', 'atomcat' => 'application/atomcat+xml', 'atomsvc' => 'application/atomsvc+xml', 'atx' => 'application/vnd.antix.game-component', 'au' => 'audio/basic', 'avi' => 'video/x-msvideo', 'aw' => 'application/applixware', 'axd' => 'text/plain', 'azf' => 'application/vnd.airzip.filesecure.azf', 'azs' => 'application/vnd.airzip.filesecure.azs', 'azw' => 'application/vnd.amazon.ebook', 'bat' => 'application/x-msdownload', 'bcpio' => 'application/x-bcpio', 'bdf' => 'application/x-font-bdf', 'bdm' => 'application/vnd.syncml.dm+wbxml', 'bed' => 'application/vnd.realvnc.bed', 'bh2' => 'application/vnd.fujitsu.oasysprs', 'bin' => 'application/octet-stream', 'bmi' => 'application/vnd.bmi', 'bmp' => 'image/bmp', 'book' => 'application/vnd.framemaker', 'box' => 'application/vnd.previewsystems.box', 'boz' => 'application/x-bzip2', 'bpk' => 'application/octet-stream', 'btif' => 'image/prs.btif', 'bz' => 'application/x-bzip', 'bz2' => 'application/x-bzip2', 'c' => 'text/x-c', 'c11amc' => 'application/vnd.cluetrust.cartomobile-config', 'c11amz' => 'application/vnd.cluetrust.cartomobile-config-pkg', 'c4d' => 'application/vnd.clonk.c4group', 'c4f' => 'application/vnd.clonk.c4group', 'c4g' => 'application/vnd.clonk.c4group', 'c4p' => 'application/vnd.clonk.c4group', 'c4u' => 'application/vnd.clonk.c4group', 'cab' => 'application/vnd.ms-cab-compressed', 'car' => 'application/vnd.curl.car', 'cat' => 'application/vnd.ms-pki.seccat', 'cc' => 'text/x-c', 'cct' => 'application/x-director', 'ccxml' => 'application/ccxml+xml', 'cdbcmsg' => 'application/vnd.contact.cmsg', 'cdf' => 'application/x-netcdf', 'cdkey' => 'application/vnd.mediastation.cdkey', 'cdmia' => 'application/cdmi-capability', 'cdmic' => 'application/cdmi-container', 'cdmid' => 'application/cdmi-domain', 'cdmio' => 'application/cdmi-object', 'cdmiq' => 'application/cdmi-queue', 'cdx' => 'chemical/x-cdx', 'cdxml' => 'application/vnd.chemdraw+xml', 'cdy' => 'application/vnd.cinderella', 'cer' => 'application/pkix-cert', 'cfc' => 'application/x-coldfusion', 'cfm' => 'application/x-coldfusion', 'cgm' => 'image/cgm', 'chat' => 'application/x-chat', 'chm' => 'application/vnd.ms-htmlhelp', 'chrt' => 'application/vnd.kde.kchart', 'cif' => 'chemical/x-cif', 'cii' => 'application/vnd.anser-web-certificate-issue-initiation', 'cil' => 'application/vnd.ms-artgalry', 'cla' => 'application/vnd.claymore', 'class' => 'application/java-vm', 'clkk' => 'application/vnd.crick.clicker.keyboard', 'clkp' => 'application/vnd.crick.clicker.palette', 'clkt' => 'application/vnd.crick.clicker.template', 'clkw' => 'application/vnd.crick.clicker.wordbank', 'clkx' => 'application/vnd.crick.clicker', 'clp' => 'application/x-msclip', 'cmc' => 'application/vnd.cosmocaller', 'cmdf' => 'chemical/x-cmdf', 'cml' => 'chemical/x-cml', 'cmp' => 'application/vnd.yellowriver-custom-menu', 'cmx' => 'image/x-cmx', 'cod' => 'application/vnd.rim.cod', 'com' => 'application/x-msdownload', 'conf' => 'text/plain', 'cpio' => 'application/x-cpio', 'cpp' => 'text/x-c', 'cpt' => 'application/mac-compactpro', 'crd' => 'application/x-mscardfile', 'crl' => 'application/pkix-crl', 'crt' => 'application/x-x509-ca-cert', 'cryptonote' => 'application/vnd.rig.cryptonote', 'cs' => 'text/plain', 'csh' => 'application/x-csh', 'csml' => 'chemical/x-csml', 'csp' => 'application/vnd.commonspace', 'css' => 'text/css', 'cst' => 'application/x-director', 'csv' => 'text/csv', 'cu' => 'application/cu-seeme', 'curl' => 'text/vnd.curl', 'cww' => 'application/prs.cww', 'cxt' => 'application/x-director', 'cxx' => 'text/x-c', 'dae' => 'model/vnd.collada+xml', 'daf' => 'application/vnd.mobius.daf', 'dataless' => 'application/vnd.fdsn.seed', 'davmount' => 'application/davmount+xml', 'dcr' => 'application/x-director', 'dcurl' => 'text/vnd.curl.dcurl', 'dd2' => 'application/vnd.oma.dd2+xml', 'ddd' => 'application/vnd.fujixerox.ddd', 'deb' => 'application/x-debian-package', 'def' => 'text/plain', 'deploy' => 'application/octet-stream', 'der' => 'application/x-x509-ca-cert', 'dfac' => 'application/vnd.dreamfactory', 'dic' => 'text/x-c', 'dir' => 'application/x-director', 'dis' => 'application/vnd.mobius.dis', 'dist' => 'application/octet-stream', 'distz' => 'application/octet-stream', 'djv' => 'image/vnd.djvu', 'djvu' => 'image/vnd.djvu', 'dll' => 'application/x-msdownload', 'dmg' => 'application/octet-stream', 'dms' => 'application/octet-stream', 'dna' => 'application/vnd.dna', 'doc' => 'application/msword', 'docm' => 'application/vnd.ms-word.document.macroenabled.12', 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'dot' => 'application/msword', 'dotm' => 'application/vnd.ms-word.template.macroenabled.12', 'dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template', 'dp' => 'application/vnd.osgi.dp', 'dpg' => 'application/vnd.dpgraph', 'dra' => 'audio/vnd.dra', 'dsc' => 'text/prs.lines.tag', 'dssc' => 'application/dssc+der', 'dtb' => 'application/x-dtbook+xml', 'dtd' => 'application/xml-dtd', 'dts' => 'audio/vnd.dts', 'dtshd' => 'audio/vnd.dts.hd', 'dump' => 'application/octet-stream', 'dvi' => 'application/x-dvi', 'dwf' => 'model/vnd.dwf', 'dwg' => 'image/vnd.dwg', 'dxf' => 'image/vnd.dxf', 'dxp' => 'application/vnd.spotfire.dxp', 'dxr' => 'application/x-director', 'ecelp4800' => 'audio/vnd.nuera.ecelp4800', 'ecelp7470' => 'audio/vnd.nuera.ecelp7470', 'ecelp9600' => 'audio/vnd.nuera.ecelp9600', 'ecma' => 'application/ecmascript', 'edm' => 'application/vnd.novadigm.edm', 'edx' => 'application/vnd.novadigm.edx', 'efif' => 'application/vnd.picsel', 'ei6' => 'application/vnd.pg.osasli', 'elc' => 'application/octet-stream', 'eml' => 'message/rfc822', 'emma' => 'application/emma+xml', 'eol' => 'audio/vnd.digital-winds', 'eot' => 'application/vnd.ms-fontobject', 'eps' => 'application/postscript', 'epub' => 'application/epub+zip', 'es3' => 'application/vnd.eszigno3+xml', 'esf' => 'application/vnd.epson.esf', 'et3' => 'application/vnd.eszigno3+xml', 'etx' => 'text/x-setext', 'exe' => 'application/x-msdownload', 'exi' => 'application/exi', 'ext' => 'application/vnd.novadigm.ext', 'ez' => 'application/andrew-inset', 'ez2' => 'application/vnd.ezpix-album', 'ez3' => 'application/vnd.ezpix-package', 'f' => 'text/x-fortran', 'f4v' => 'video/x-f4v', 'f77' => 'text/x-fortran', 'f90' => 'text/x-fortran', 'fbs' => 'image/vnd.fastbidsheet', 'fcs' => 'application/vnd.isac.fcs', 'fdf' => 'application/vnd.fdf', 'fe_launch' => 'application/vnd.denovo.fcselayout-link', 'fg5' => 'application/vnd.fujitsu.oasysgp', 'fgd' => 'application/x-director', 'fh' => 'image/x-freehand', 'fh4' => 'image/x-freehand', 'fh5' => 'image/x-freehand', 'fh7' => 'image/x-freehand', 'fhc' => 'image/x-freehand', 'fig' => 'application/x-xfig', 'fli' => 'video/x-fli', 'flo' => 'application/vnd.micrografx.flo', 'flv' => 'video/x-flv', 'flw' => 'application/vnd.kde.kivio', 'flx' => 'text/vnd.fmi.flexstor', 'fly' => 'text/vnd.fly', 'fm' => 'application/vnd.framemaker', 'fnc' => 'application/vnd.frogans.fnc', 'for' => 'text/x-fortran', 'fpx' => 'image/vnd.fpx', 'frame' => 'application/vnd.framemaker', 'fsc' => 'application/vnd.fsc.weblaunch', 'fst' => 'image/vnd.fst', 'ftc' => 'application/vnd.fluxtime.clip', 'fti' => 'application/vnd.anser-web-funds-transfer-initiation', 'fvt' => 'video/vnd.fvt', 'fxp' => 'application/vnd.adobe.fxp', 'fxpl' => 'application/vnd.adobe.fxp', 'fzs' => 'application/vnd.fuzzysheet', 'g2w' => 'application/vnd.geoplan', 'g3' => 'image/g3fax', 'g3w' => 'application/vnd.geospace', 'gac' => 'application/vnd.groove-account', 'gdl' => 'model/vnd.gdl', 'geo' => 'application/vnd.dynageo', 'gex' => 'application/vnd.geometry-explorer', 'ggb' => 'application/vnd.geogebra.file', 'ggt' => 'application/vnd.geogebra.tool', 'ghf' => 'application/vnd.groove-help', 'gif' => 'image/gif', 'gim' => 'application/vnd.groove-identity-message', 'gmx' => 'application/vnd.gmx', 'gnumeric' => 'application/x-gnumeric', 'gph' => 'application/vnd.flographit', 'gqf' => 'application/vnd.grafeq', 'gqs' => 'application/vnd.grafeq', 'gram' => 'application/srgs', 'gre' => 'application/vnd.geometry-explorer', 'grv' => 'application/vnd.groove-injector', 'grxml' => 'application/srgs+xml', 'gsf' => 'application/x-font-ghostscript', 'gtar' => 'application/x-gtar', 'gtm' => 'application/vnd.groove-tool-message', 'gtw' => 'model/vnd.gtw', 'gv' => 'text/vnd.graphviz', 'gxt' => 'application/vnd.geonext', 'h' => 'text/x-c', 'h261' => 'video/h261', 'h263' => 'video/h263', 'h264' => 'video/h264', 'hal' => 'application/vnd.hal+xml', 'hbci' => 'application/vnd.hbci', 'hdf' => 'application/x-hdf', 'hh' => 'text/x-c', 'hlp' => 'application/winhlp', 'hpgl' => 'application/vnd.hp-hpgl', 'hpid' => 'application/vnd.hp-hpid', 'hps' => 'application/vnd.hp-hps', 'hqx' => 'application/mac-binhex40', 'hta' => 'application/octet-stream', 'htc' => 'text/html', 'htke' => 'application/vnd.kenameaapp', 'htm' => 'text/html', 'html' => 'text/html', 'hvd' => 'application/vnd.yamaha.hv-dic', 'hvp' => 'application/vnd.yamaha.hv-voice', 'hvs' => 'application/vnd.yamaha.hv-script', 'i2g' => 'application/vnd.intergeo', 'icc' => 'application/vnd.iccprofile', 'ice' => 'x-conference/x-cooltalk', 'icm' => 'application/vnd.iccprofile', 'ico' => 'image/x-icon', 'ics' => 'text/calendar', 'ief' => 'image/ief', 'ifb' => 'text/calendar', 'ifm' => 'application/vnd.shana.informed.formdata', 'iges' => 'model/iges', 'igl' => 'application/vnd.igloader', 'igm' => 'application/vnd.insors.igm', 'igs' => 'model/iges', 'igx' => 'application/vnd.micrografx.igx', 'iif' => 'application/vnd.shana.informed.interchange', 'imp' => 'application/vnd.accpac.simply.imp', 'ims' => 'application/vnd.ms-ims', 'in' => 'text/plain', 'ini' => 'text/plain', 'ipfix' => 'application/ipfix', 'ipk' => 'application/vnd.shana.informed.package', 'irm' => 'application/vnd.ibm.rights-management', 'irp' => 'application/vnd.irepository.package+xml', 'iso' => 'application/octet-stream', 'itp' => 'application/vnd.shana.informed.formtemplate', 'ivp' => 'application/vnd.immervision-ivp', 'ivu' => 'application/vnd.immervision-ivu', 'jad' => 'text/vnd.sun.j2me.app-descriptor', 'jam' => 'application/vnd.jam', 'jar' => 'application/java-archive', 'java' => 'text/x-java-source', 'jisp' => 'application/vnd.jisp', 'jlt' => 'application/vnd.hp-jlyt', 'jnlp' => 'application/x-java-jnlp-file', 'joda' => 'application/vnd.joost.joda-archive', 'jpe' => 'image/jpeg', 'jpeg' => 'image/jpeg', 'jpg' => 'image/jpeg', 'jpgm' => 'video/jpm', 'jpgv' => 'video/jpeg', 'jpm' => 'video/jpm', 'js' => 'text/javascript', 'json' => 'application/json', 'kar' => 'audio/midi', 'karbon' => 'application/vnd.kde.karbon', 'kfo' => 'application/vnd.kde.kformula', 'kia' => 'application/vnd.kidspiration', 'kml' => 'application/vnd.google-earth.kml+xml', 'kmz' => 'application/vnd.google-earth.kmz', 'kne' => 'application/vnd.kinar', 'knp' => 'application/vnd.kinar', 'kon' => 'application/vnd.kde.kontour', 'kpr' => 'application/vnd.kde.kpresenter', 'kpt' => 'application/vnd.kde.kpresenter', 'ksp' => 'application/vnd.kde.kspread', 'ktr' => 'application/vnd.kahootz', 'ktx' => 'image/ktx', 'ktz' => 'application/vnd.kahootz', 'kwd' => 'application/vnd.kde.kword', 'kwt' => 'application/vnd.kde.kword', 'lasxml' => 'application/vnd.las.las+xml', 'latex' => 'application/x-latex', 'lbd' => 'application/vnd.llamagraphics.life-balance.desktop', 'lbe' => 'application/vnd.llamagraphics.life-balance.exchange+xml', 'les' => 'application/vnd.hhe.lesson-player', 'lha' => 'application/octet-stream', 'link66' => 'application/vnd.route66.link66+xml', 'list' => 'text/plain', 'list3820' => 'application/vnd.ibm.modcap', 'listafp' => 'application/vnd.ibm.modcap', 'log' => 'text/plain', 'lostxml' => 'application/lost+xml', 'lrf' => 'application/octet-stream', 'lrm' => 'application/vnd.ms-lrm', 'ltf' => 'application/vnd.frogans.ltf', 'lvp' => 'audio/vnd.lucent.voice', 'lwp' => 'application/vnd.lotus-wordpro', 'lzh' => 'application/octet-stream', 'm13' => 'application/x-msmediaview', 'm14' => 'application/x-msmediaview', 'm1v' => 'video/mpeg', 'm21' => 'application/mp21', 'm2a' => 'audio/mpeg', 'm2v' => 'video/mpeg', 'm3a' => 'audio/mpeg', 'm3u' => 'audio/x-mpegurl', 'm3u8' => 'application/vnd.apple.mpegurl', 'm4a' => 'audio/mp4', 'm4u' => 'video/vnd.mpegurl', 'm4v' => 'video/mp4', 'ma' => 'application/mathematica', 'mads' => 'application/mads+xml', 'mag' => 'application/vnd.ecowin.chart', 'maker' => 'application/vnd.framemaker', 'man' => 'text/troff', 'mathml' => 'application/mathml+xml', 'mb' => 'application/mathematica', 'mbk' => 'application/vnd.mobius.mbk', 'mbox' => 'application/mbox', 'mc1' => 'application/vnd.medcalcdata', 'mcd' => 'application/vnd.mcd', 'mcurl' => 'text/vnd.curl.mcurl', 'mdb' => 'application/x-msaccess', 'mdi' => 'image/vnd.ms-modi', 'me' => 'text/troff', 'mesh' => 'model/mesh', 'meta4' => 'application/metalink4+xml', 'mets' => 'application/mets+xml', 'mfm' => 'application/vnd.mfmp', 'mgp' => 'application/vnd.osgeo.mapguide.package', 'mgz' => 'application/vnd.proteus.magazine', 'mid' => 'audio/midi', 'midi' => 'audio/midi', 'mif' => 'application/vnd.mif', 'mime' => 'message/rfc822', 'mj2' => 'video/mj2', 'mjp2' => 'video/mj2', 'mlp' => 'application/vnd.dolby.mlp', 'mmd' => 'application/vnd.chipnuts.karaoke-mmd', 'mmf' => 'application/vnd.smaf', 'mmr' => 'image/vnd.fujixerox.edmics-mmr', 'mny' => 'application/x-msmoney', 'mobi' => 'application/x-mobipocket-ebook', 'mods' => 'application/mods+xml', 'mov' => 'video/quicktime', 'movie' => 'video/x-sgi-movie', 'mp2' => 'audio/mpeg', 'mp21' => 'application/mp21', 'mp2a' => 'audio/mpeg', 'mp3' => 'audio/mpeg', 'mp4' => 'video/mp4', 'mp4a' => 'audio/mp4', 'mp4s' => 'application/mp4', 'mp4v' => 'video/mp4', 'mpc' => 'application/vnd.mophun.certificate', 'mpe' => 'video/mpeg', 'mpeg' => 'video/mpeg', 'mpg' => 'video/mpeg', 'mpg4' => 'video/mp4', 'mpga' => 'audio/mpeg', 'mpkg' => 'application/vnd.apple.installer+xml', 'mpm' => 'application/vnd.blueice.multipass', 'mpn' => 'application/vnd.mophun.application', 'mpp' => 'application/vnd.ms-project', 'mpt' => 'application/vnd.ms-project', 'mpy' => 'application/vnd.ibm.minipay', 'mqy' => 'application/vnd.mobius.mqy', 'mrc' => 'application/marc', 'mrcx' => 'application/marcxml+xml', 'ms' => 'text/troff', 'mscml' => 'application/mediaservercontrol+xml', 'mseed' => 'application/vnd.fdsn.mseed', 'mseq' => 'application/vnd.mseq', 'msf' => 'application/vnd.epson.msf', 'msh' => 'model/mesh', 'msi' => 'application/x-msdownload', 'msl' => 'application/vnd.mobius.msl', 'msty' => 'application/vnd.muvee.style', 'mts' => 'model/vnd.mts', 'mus' => 'application/vnd.musician', 'musicxml' => 'application/vnd.recordare.musicxml+xml', 'mvb' => 'application/x-msmediaview', 'mwf' => 'application/vnd.mfer', 'mxf' => 'application/mxf', 'mxl' => 'application/vnd.recordare.musicxml', 'mxml' => 'application/xv+xml', 'mxs' => 'application/vnd.triscape.mxs', 'mxu' => 'video/vnd.mpegurl', 'n-gage' => 'application/vnd.nokia.n-gage.symbian.install', 'n3' => 'text/n3', 'nb' => 'application/mathematica', 'nbp' => 'application/vnd.wolfram.player', 'nc' => 'application/x-netcdf', 'ncx' => 'application/x-dtbncx+xml', 'ngdat' => 'application/vnd.nokia.n-gage.data', 'nlu' => 'application/vnd.neurolanguage.nlu', 'nml' => 'application/vnd.enliven', 'nnd' => 'application/vnd.noblenet-directory', 'nns' => 'application/vnd.noblenet-sealer', 'nnw' => 'application/vnd.noblenet-web', 'npx' => 'image/vnd.net-fpx', 'nsf' => 'application/vnd.lotus-notes', 'oa2' => 'application/vnd.fujitsu.oasys2', 'oa3' => 'application/vnd.fujitsu.oasys3', 'oas' => 'application/vnd.fujitsu.oasys', 'obd' => 'application/x-msbinder', 'oda' => 'application/oda', 'odb' => 'application/vnd.oasis.opendocument.database', 'odc' => 'application/vnd.oasis.opendocument.chart', 'odf' => 'application/vnd.oasis.opendocument.formula', 'odft' => 'application/vnd.oasis.opendocument.formula-template', 'odg' => 'application/vnd.oasis.opendocument.graphics', 'odi' => 'application/vnd.oasis.opendocument.image', 'odm' => 'application/vnd.oasis.opendocument.text-master', 'odp' => 'application/vnd.oasis.opendocument.presentation', 'ods' => 'application/vnd.oasis.opendocument.spreadsheet', 'odt' => 'application/vnd.oasis.opendocument.text', 'oga' => 'audio/ogg', 'ogg' => 'audio/ogg', 'ogv' => 'video/ogg', 'ogx' => 'application/ogg', 'onepkg' => 'application/onenote', 'onetmp' => 'application/onenote', 'onetoc' => 'application/onenote', 'onetoc2' => 'application/onenote', 'opf' => 'application/oebps-package+xml', 'oprc' => 'application/vnd.palm', 'org' => 'application/vnd.lotus-organizer', 'osf' => 'application/vnd.yamaha.openscoreformat', 'osfpvg' => 'application/vnd.yamaha.openscoreformat.osfpvg+xml', 'otc' => 'application/vnd.oasis.opendocument.chart-template', 'otf' => 'application/x-font-otf', 'otg' => 'application/vnd.oasis.opendocument.graphics-template', 'oth' => 'application/vnd.oasis.opendocument.text-web', 'oti' => 'application/vnd.oasis.opendocument.image-template', 'otp' => 'application/vnd.oasis.opendocument.presentation-template', 'ots' => 'application/vnd.oasis.opendocument.spreadsheet-template', 'ott' => 'application/vnd.oasis.opendocument.text-template', 'oxt' => 'application/vnd.openofficeorg.extension', 'p' => 'text/x-pascal', 'p10' => 'application/pkcs10', 'p12' => 'application/x-pkcs12', 'p7b' => 'application/x-pkcs7-certificates', 'p7c' => 'application/pkcs7-mime', 'p7m' => 'application/pkcs7-mime', 'p7r' => 'application/x-pkcs7-certreqresp', 'p7s' => 'application/pkcs7-signature', 'p8' => 'application/pkcs8', 'pas' => 'text/x-pascal', 'paw' => 'application/vnd.pawaafile', 'pbd' => 'application/vnd.powerbuilder6', 'pbm' => 'image/x-portable-bitmap', 'pcf' => 'application/x-font-pcf', 'pcl' => 'application/vnd.hp-pcl', 'pclxl' => 'application/vnd.hp-pclxl', 'pct' => 'image/x-pict', 'pcurl' => 'application/vnd.curl.pcurl', 'pcx' => 'image/x-pcx', 'pdb' => 'application/vnd.palm', 'pdf' => 'application/pdf', 'pfa' => 'application/x-font-type1', 'pfb' => 'application/x-font-type1', 'pfm' => 'application/x-font-type1', 'pfr' => 'application/font-tdpfr', 'pfx' => 'application/x-pkcs12', 'pgm' => 'image/x-portable-graymap', 'pgn' => 'application/x-chess-pgn', 'pgp' => 'application/pgp-encrypted', 'php' => 'text/x-php', 'phps' => 'application/x-httpd-phps', 'pic' => 'image/x-pict', 'pkg' => 'application/octet-stream', 'pki' => 'application/pkixcmp', 'pkipath' => 'application/pkix-pkipath', 'plb' => 'application/vnd.3gpp.pic-bw-large', 'plc' => 'application/vnd.mobius.plc', 'plf' => 'application/vnd.pocketlearn', 'pls' => 'application/pls+xml', 'pml' => 'application/vnd.ctc-posml', 'png' => 'image/png', 'pnm' => 'image/x-portable-anymap', 'portpkg' => 'application/vnd.macports.portpkg', 'pot' => 'application/vnd.ms-powerpoint', 'potm' => 'application/vnd.ms-powerpoint.template.macroenabled.12', 'potx' => 'application/vnd.openxmlformats-officedocument.presentationml.template', 'ppam' => 'application/vnd.ms-powerpoint.addin.macroenabled.12', 'ppd' => 'application/vnd.cups-ppd', 'ppm' => 'image/x-portable-pixmap', 'pps' => 'application/vnd.ms-powerpoint', 'ppsm' => 'application/vnd.ms-powerpoint.slideshow.macroenabled.12', 'ppsx' => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow', 'ppt' => 'application/vnd.ms-powerpoint', 'pptm' => 'application/vnd.ms-powerpoint.presentation.macroenabled.12', 'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'pqa' => 'application/vnd.palm', 'prc' => 'application/x-mobipocket-ebook', 'pre' => 'application/vnd.lotus-freelance', 'prf' => 'application/pics-rules', 'ps' => 'application/postscript', 'psb' => 'application/vnd.3gpp.pic-bw-small', 'psd' => 'image/vnd.adobe.photoshop', 'psf' => 'application/x-font-linux-psf', 'pskcxml' => 'application/pskc+xml', 'ptid' => 'application/vnd.pvi.ptid1', 'pub' => 'application/x-mspublisher', 'pvb' => 'application/vnd.3gpp.pic-bw-var', 'pwn' => 'application/vnd.3m.post-it-notes', 'pya' => 'audio/vnd.ms-playready.media.pya', 'pyv' => 'video/vnd.ms-playready.media.pyv', 'qam' => 'application/vnd.epson.quickanime', 'qbo' => 'application/vnd.intu.qbo', 'qfx' => 'application/vnd.intu.qfx', 'qps' => 'application/vnd.publishare-delta-tree', 'qt' => 'video/quicktime', 'qwd' => 'application/vnd.quark.quarkxpress', 'qwt' => 'application/vnd.quark.quarkxpress', 'qxb' => 'application/vnd.quark.quarkxpress', 'qxd' => 'application/vnd.quark.quarkxpress', 'qxl' => 'application/vnd.quark.quarkxpress', 'qxt' => 'application/vnd.quark.quarkxpress', 'ra' => 'audio/x-pn-realaudio', 'ram' => 'audio/x-pn-realaudio', 'rar' => 'application/x-rar-compressed', 'ras' => 'image/x-cmu-raster', 'rb' => 'text/plain', 'rcprofile' => 'application/vnd.ipunplugged.rcprofile', 'rdf' => 'application/rdf+xml', 'rdz' => 'application/vnd.data-vision.rdz', 'rep' => 'application/vnd.businessobjects', 'res' => 'application/x-dtbresource+xml', 'resx' => 'text/xml', 'rgb' => 'image/x-rgb', 'rif' => 'application/reginfo+xml', 'rip' => 'audio/vnd.rip', 'rl' => 'application/resource-lists+xml', 'rlc' => 'image/vnd.fujixerox.edmics-rlc', 'rld' => 'application/resource-lists-diff+xml', 'rm' => 'application/vnd.rn-realmedia', 'rmi' => 'audio/midi', 'rmp' => 'audio/x-pn-realaudio-plugin', 'rms' => 'application/vnd.jcp.javame.midlet-rms', 'rnc' => 'application/relax-ng-compact-syntax', 'roff' => 'text/troff', 'rp9' => 'application/vnd.cloanto.rp9', 'rpss' => 'application/vnd.nokia.radio-presets', 'rpst' => 'application/vnd.nokia.radio-preset', 'rq' => 'application/sparql-query', 'rs' => 'application/rls-services+xml', 'rsd' => 'application/rsd+xml', 'rss' => 'application/rss+xml', 'rtf' => 'application/rtf', 'rtx' => 'text/richtext', 's' => 'text/x-asm', 'saf' => 'application/vnd.yamaha.smaf-audio', 'sbml' => 'application/sbml+xml', 'sc' => 'application/vnd.ibm.secure-container', 'scd' => 'application/x-msschedule', 'scm' => 'application/vnd.lotus-screencam', 'scq' => 'application/scvp-cv-request', 'scs' => 'application/scvp-cv-response', 'scurl' => 'text/vnd.curl.scurl', 'sda' => 'application/vnd.stardivision.draw', 'sdc' => 'application/vnd.stardivision.calc', 'sdd' => 'application/vnd.stardivision.impress', 'sdkd' => 'application/vnd.solent.sdkm+xml', 'sdkm' => 'application/vnd.solent.sdkm+xml', 'sdp' => 'application/sdp', 'sdw' => 'application/vnd.stardivision.writer', 'see' => 'application/vnd.seemail', 'seed' => 'application/vnd.fdsn.seed', 'sema' => 'application/vnd.sema', 'semd' => 'application/vnd.semd', 'semf' => 'application/vnd.semf', 'ser' => 'application/java-serialized-object', 'setpay' => 'application/set-payment-initiation', 'setreg' => 'application/set-registration-initiation', 'sfd-hdstx' => 'application/vnd.hydrostatix.sof-data', 'sfs' => 'application/vnd.spotfire.sfs', 'sgl' => 'application/vnd.stardivision.writer-global', 'sgm' => 'text/sgml', 'sgml' => 'text/sgml', 'sh' => 'application/x-sh', 'shar' => 'application/x-shar', 'shf' => 'application/shf+xml', 'sig' => 'application/pgp-signature', 'silo' => 'model/mesh', 'sis' => 'application/vnd.symbian.install', 'sisx' => 'application/vnd.symbian.install', 'sit' => 'application/x-stuffit', 'sitx' => 'application/x-stuffitx', 'skd' => 'application/vnd.koan', 'skm' => 'application/vnd.koan', 'skp' => 'application/vnd.koan', 'skt' => 'application/vnd.koan', 'sldm' => 'application/vnd.ms-powerpoint.slide.macroenabled.12', 'sldx' => 'application/vnd.openxmlformats-officedocument.presentationml.slide', 'slt' => 'application/vnd.epson.salt', 'sm' => 'application/vnd.stepmania.stepchart', 'smf' => 'application/vnd.stardivision.math', 'smi' => 'application/smil+xml', 'smil' => 'application/smil+xml', 'snd' => 'audio/basic', 'snf' => 'application/x-font-snf', 'so' => 'application/octet-stream', 'spc' => 'application/x-pkcs7-certificates', 'spf' => 'application/vnd.yamaha.smaf-phrase', 'spl' => 'application/x-futuresplash', 'spot' => 'text/vnd.in3d.spot', 'spp' => 'application/scvp-vp-response', 'spq' => 'application/scvp-vp-request', 'spx' => 'audio/ogg', 'src' => 'application/x-wais-source', 'srt' => 'application/octet-stream', 'sru' => 'application/sru+xml', 'srx' => 'application/sparql-results+xml', 'sse' => 'application/vnd.kodak-descriptor', 'ssf' => 'application/vnd.epson.ssf', 'ssml' => 'application/ssml+xml', 'st' => 'application/vnd.sailingtracker.track', 'stc' => 'application/vnd.sun.xml.calc.template', 'std' => 'application/vnd.sun.xml.draw.template', 'stf' => 'application/vnd.wt.stf', 'sti' => 'application/vnd.sun.xml.impress.template', 'stk' => 'application/hyperstudio', 'stl' => 'application/vnd.ms-pki.stl', 'str' => 'application/vnd.pg.format', 'stw' => 'application/vnd.sun.xml.writer.template', 'sub' => 'image/vnd.dvb.subtitle', 'sus' => 'application/vnd.sus-calendar', 'susp' => 'application/vnd.sus-calendar', 'sv4cpio' => 'application/x-sv4cpio', 'sv4crc' => 'application/x-sv4crc', 'svc' => 'application/vnd.dvb.service', 'svd' => 'application/vnd.svd', 'svg' => 'image/svg+xml', 'svgz' => 'image/svg+xml', 'swa' => 'application/x-director', 'swf' => 'application/x-shockwave-flash', 'swi' => 'application/vnd.aristanetworks.swi', 'sxc' => 'application/vnd.sun.xml.calc', 'sxd' => 'application/vnd.sun.xml.draw', 'sxg' => 'application/vnd.sun.xml.writer.global', 'sxi' => 'application/vnd.sun.xml.impress', 'sxm' => 'application/vnd.sun.xml.math', 'sxw' => 'application/vnd.sun.xml.writer', 't' => 'text/troff', 'tao' => 'application/vnd.tao.intent-module-archive', 'tar' => 'application/x-tar', 'tcap' => 'application/vnd.3gpp2.tcap', 'tcl' => 'application/x-tcl', 'teacher' => 'application/vnd.smart.teacher', 'tei' => 'application/tei+xml', 'teicorpus' => 'application/tei+xml', 'tex' => 'application/x-tex', 'texi' => 'application/x-texinfo', 'texinfo' => 'application/x-texinfo', 'text' => 'text/plain', 'tfi' => 'application/thraud+xml', 'tfm' => 'application/x-tex-tfm', 'thmx' => 'application/vnd.ms-officetheme', 'tif' => 'image/tiff', 'tiff' => 'image/tiff', 'tmo' => 'application/vnd.tmobile-livetv', 'torrent' => 'application/x-bittorrent', 'tpl' => 'application/vnd.groove-tool-template', 'tpt' => 'application/vnd.trid.tpt', 'tr' => 'text/troff', 'tra' => 'application/vnd.trueapp', 'trm' => 'application/x-msterminal', 'tsd' => 'application/timestamped-data', 'tsv' => 'text/tab-separated-values', 'ttc' => 'application/x-font-ttf', 'ttf' => 'application/x-font-ttf', 'ttl' => 'text/turtle', 'twd' => 'application/vnd.simtech-mindmapper', 'twds' => 'application/vnd.simtech-mindmapper', 'txd' => 'application/vnd.genomatix.tuxedo', 'txf' => 'application/vnd.mobius.txf', 'txt' => 'text/plain', 'u32' => 'application/x-authorware-bin', 'udeb' => 'application/x-debian-package', 'ufd' => 'application/vnd.ufdl', 'ufdl' => 'application/vnd.ufdl', 'umj' => 'application/vnd.umajin', 'unityweb' => 'application/vnd.unity', 'uoml' => 'application/vnd.uoml+xml', 'uri' => 'text/uri-list', 'uris' => 'text/uri-list', 'urls' => 'text/uri-list', 'ustar' => 'application/x-ustar', 'utz' => 'application/vnd.uiq.theme', 'uu' => 'text/x-uuencode', 'uva' => 'audio/vnd.dece.audio', 'uvd' => 'application/vnd.dece.data', 'uvf' => 'application/vnd.dece.data', 'uvg' => 'image/vnd.dece.graphic', 'uvh' => 'video/vnd.dece.hd', 'uvi' => 'image/vnd.dece.graphic', 'uvm' => 'video/vnd.dece.mobile', 'uvp' => 'video/vnd.dece.pd', 'uvs' => 'video/vnd.dece.sd', 'uvt' => 'application/vnd.dece.ttml+xml', 'uvu' => 'video/vnd.uvvu.mp4', 'uvv' => 'video/vnd.dece.video', 'uvva' => 'audio/vnd.dece.audio', 'uvvd' => 'application/vnd.dece.data', 'uvvf' => 'application/vnd.dece.data', 'uvvg' => 'image/vnd.dece.graphic', 'uvvh' => 'video/vnd.dece.hd', 'uvvi' => 'image/vnd.dece.graphic', 'uvvm' => 'video/vnd.dece.mobile', 'uvvp' => 'video/vnd.dece.pd', 'uvvs' => 'video/vnd.dece.sd', 'uvvt' => 'application/vnd.dece.ttml+xml', 'uvvu' => 'video/vnd.uvvu.mp4', 'uvvv' => 'video/vnd.dece.video', 'uvvx' => 'application/vnd.dece.unspecified', 'uvx' => 'application/vnd.dece.unspecified', 'vcd' => 'application/x-cdlink', 'vcf' => 'text/x-vcard', 'vcg' => 'application/vnd.groove-vcard', 'vcs' => 'text/x-vcalendar', 'vcx' => 'application/vnd.vcx', 'vis' => 'application/vnd.visionary', 'viv' => 'video/vnd.vivo', 'vor' => 'application/vnd.stardivision.writer', 'vox' => 'application/x-authorware-bin', 'vrml' => 'model/vrml', 'vsd' => 'application/vnd.visio', 'vsf' => 'application/vnd.vsf', 'vss' => 'application/vnd.visio', 'vst' => 'application/vnd.visio', 'vsw' => 'application/vnd.visio', 'vtu' => 'model/vnd.vtu', 'vxml' => 'application/voicexml+xml', 'w3d' => 'application/x-director', 'wad' => 'application/x-doom', 'wav' => 'audio/x-wav', 'wax' => 'audio/x-ms-wax', 'wbmp' => 'image/vnd.wap.wbmp', 'wbs' => 'application/vnd.criticaltools.wbs+xml', 'wbxml' => 'application/vnd.wap.wbxml', 'wcm' => 'application/vnd.ms-works', 'wdb' => 'application/vnd.ms-works', 'weba' => 'audio/webm', 'webm' => 'video/webm', 'webp' => 'image/webp', 'wg' => 'application/vnd.pmi.widget', 'wgt' => 'application/widget', 'wks' => 'application/vnd.ms-works', 'wm' => 'video/x-ms-wm', 'wma' => 'audio/x-ms-wma', 'wmd' => 'application/x-ms-wmd', 'wmf' => 'application/x-msmetafile', 'wml' => 'text/vnd.wap.wml', 'wmlc' => 'application/vnd.wap.wmlc', 'wmls' => 'text/vnd.wap.wmlscript', 'wmlsc' => 'application/vnd.wap.wmlscriptc', 'wmv' => 'video/x-ms-wmv', 'wmx' => 'video/x-ms-wmx', 'wmz' => 'application/x-ms-wmz', 'woff' => 'application/x-font-woff', 'wpd' => 'application/vnd.wordperfect', 'wpl' => 'application/vnd.ms-wpl', 'wps' => 'application/vnd.ms-works', 'wqd' => 'application/vnd.wqd', 'wri' => 'application/x-mswrite', 'wrl' => 'model/vrml', 'wsdl' => 'application/wsdl+xml', 'wspolicy' => 'application/wspolicy+xml', 'wtb' => 'application/vnd.webturbo', 'wvx' => 'video/x-ms-wvx', 'x32' => 'application/x-authorware-bin', 'x3d' => 'application/vnd.hzn-3d-crossword', 'xap' => 'application/x-silverlight-app', 'xar' => 'application/vnd.xara', 'xbap' => 'application/x-ms-xbap', 'xbd' => 'application/vnd.fujixerox.docuworks.binder', 'xbm' => 'image/x-xbitmap', 'xdf' => 'application/xcap-diff+xml', 'xdm' => 'application/vnd.syncml.dm+xml', 'xdp' => 'application/vnd.adobe.xdp+xml', 'xdssc' => 'application/dssc+xml', 'xdw' => 'application/vnd.fujixerox.docuworks', 'xenc' => 'application/xenc+xml', 'xer' => 'application/patch-ops-error+xml', 'xfdf' => 'application/vnd.adobe.xfdf', 'xfdl' => 'application/vnd.xfdl', 'xht' => 'application/xhtml+xml', 'xhtml' => 'application/xhtml+xml', 'xhvml' => 'application/xv+xml', 'xif' => 'image/vnd.xiff', 'xla' => 'application/vnd.ms-excel', 'xlam' => 'application/vnd.ms-excel.addin.macroenabled.12', 'xlc' => 'application/vnd.ms-excel', 'xlm' => 'application/vnd.ms-excel', 'xls' => 'application/vnd.ms-excel', 'xlsb' => 'application/vnd.ms-excel.sheet.binary.macroenabled.12', 'xlsm' => 'application/vnd.ms-excel.sheet.macroenabled.12', 'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'xlt' => 'application/vnd.ms-excel', 'xltm' => 'application/vnd.ms-excel.template.macroenabled.12', 'xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template', 'xlw' => 'application/vnd.ms-excel', 'xml' => 'application/xml', 'xo' => 'application/vnd.olpc-sugar', 'xop' => 'application/xop+xml', 'xpi' => 'application/x-xpinstall', 'xpm' => 'image/x-xpixmap', 'xpr' => 'application/vnd.is-xpr', 'xps' => 'application/vnd.ms-xpsdocument', 'xpw' => 'application/vnd.intercon.formnet', 'xpx' => 'application/vnd.intercon.formnet', 'xsl' => 'application/xml', 'xslt' => 'application/xslt+xml', 'xsm' => 'application/vnd.syncml+xml', 'xspf' => 'application/xspf+xml', 'xul' => 'application/vnd.mozilla.xul+xml', 'xvm' => 'application/xv+xml', 'xvml' => 'application/xv+xml', 'xwd' => 'image/x-xwindowdump', 'xyz' => 'chemical/x-xyz', 'yaml' => 'text/yaml', 'yang' => 'application/yang', 'yin' => 'application/yin+xml', 'yml' => 'text/yaml', 'zaz' => 'application/vnd.zzazz.deck+xml', 'zip' => 'application/zip', 'zir' => 'application/vnd.zul', 'zirz' => 'application/vnd.zul', 'zmm' => 'application/vnd.handheld-entertainment+xml'];
/**
* Get a singleton instance of the class
*
* @return self
* @codeCoverageIgnore
*/
public static function getInstance()
{
}
/**
* Get a mimetype value from a file extension
*
* @param string $extension File extension
*
* @return string|null
*/
public function fromExtension($extension)
{
}
/**
* Get a mimetype from a filename
*
* @param string $filename Filename to generate a mimetype from
*
* @return string|null
*/
public function fromFilename($filename)
{
}
}
/**
* Class FacebookTransferChunk
*
* @package Facebook
*/
class FacebookTransferChunk
{
/**
* @param FacebookFile $file
* @param int $uploadSessionId
* @param int $videoId
* @param int $startOffset
* @param int $endOffset
*/
public function __construct(\Facebook\FileUpload\FacebookFile $file, $uploadSessionId, $videoId, $startOffset, $endOffset)
{
}
/**
* Return the file entity.
*
* @return FacebookFile
*/
public function getFile()
{
}
/**
* Return a FacebookFile entity with partial content.
*
* @return FacebookFile
*/
public function getPartialFile()
{
}
/**
* Return upload session Id
*
* @return int
*/
public function getUploadSessionId()
{
}
/**
* Check whether is the last chunk
*
* @return bool
*/
public function isLastChunk()
{
}
/**
* @return int
*/
public function getStartOffset()
{
}
/**
* Get uploaded video Id
*
* @return int
*/
public function getVideoId()
{
}
}
/**
* Class FacebookVideo
*
* @package Facebook
*/
class FacebookVideo extends \Facebook\FileUpload\FacebookFile
{
}
}
namespace Facebook\Exceptions {
/**
* Class FacebookSDKException
*
* @package Facebook
*/
class FacebookSDKException extends \Exception
{
}
/**
* Class FacebookAuthenticationException
*
* @package Facebook
*/
class FacebookAuthenticationException extends \Facebook\Exceptions\FacebookSDKException
{
}
/**
* Class FacebookThrottleException
*
* @package Facebook
*/
class FacebookThrottleException extends \Facebook\Exceptions\FacebookSDKException
{
}
/**
* Class FacebookResponseException
*
* @package Facebook
*/
class FacebookResponseException extends \Facebook\Exceptions\FacebookSDKException
{
/**
* @var FacebookResponse The response that threw the exception.
*/
protected $response;
/**
* @var array Decoded response.
*/
protected $responseData;
/**
* Creates a FacebookResponseException.
*
* @param FacebookResponse $response The response that threw the exception.
* @param FacebookSDKException $previousException The more detailed exception.
*/
public function __construct(\Facebook\FacebookResponse $response, \Facebook\Exceptions\FacebookSDKException $previousException = null)
{
}
/**
* A factory for creating the appropriate exception based on the response from Graph.
*
* @param FacebookResponse $response The response that threw the exception.
*
* @return FacebookResponseException
*/
public static function create(\Facebook\FacebookResponse $response)
{
}
/**
* Returns the HTTP status code
*
* @return int
*/
public function getHttpStatusCode()
{
}
/**
* Returns the sub-error code
*
* @return int
*/
public function getSubErrorCode()
{
}
/**
* Returns the error type
*
* @return string
*/
public function getErrorType()
{
}
/**
* Returns the raw response used to create the exception.
*
* @return string
*/
public function getRawResponse()
{
}
/**
* Returns the decoded response used to create the exception.
*
* @return array
*/
public function getResponseData()
{
}
/**
* Returns the response entity used to create the exception.
*
* @return FacebookResponse
*/
public function getResponse()
{
}
}
/**
* Class FacebookAuthorizationException
*
* @package Facebook
*/
class FacebookAuthorizationException extends \Facebook\Exceptions\FacebookSDKException
{
}
/**
* Class FacebookResumableUploadException
*
* @package Facebook
*/
class FacebookResumableUploadException extends \Facebook\Exceptions\FacebookSDKException
{
}
/**
* Class FacebookServerException
*
* @package Facebook
*/
class FacebookServerException extends \Facebook\Exceptions\FacebookSDKException
{
}
/**
* Class FacebookOtherException
*
* @package Facebook
*/
class FacebookOtherException extends \Facebook\Exceptions\FacebookSDKException
{
}
/**
* Class FacebookClientException
*
* @package Facebook
*/
class FacebookClientException extends \Facebook\Exceptions\FacebookSDKException
{
}
}
namespace Facebook {
/**
* Class FacebookBatchResponse
*
* @package Facebook
*/
class FacebookBatchResponse extends \Facebook\FacebookResponse implements \IteratorAggregate, \ArrayAccess
{
/**
* @var FacebookBatchRequest The original entity that made the batch request.
*/
protected $batchRequest;
/**
* @var array An array of FacebookResponse entities.
*/
protected $responses = [];
/**
* Creates a new Response entity.
*
* @param FacebookBatchRequest $batchRequest
* @param FacebookResponse $response
*/
public function __construct(\Facebook\FacebookBatchRequest $batchRequest, \Facebook\FacebookResponse $response)
{
}
/**
* Returns an array of FacebookResponse entities.
*
* @return array
*/
public function getResponses()
{
}
/**
* The main batch response will be an array of requests so
* we need to iterate over all the responses.
*
* @param array $responses
*/
public function setResponses(array $responses)
{
}
/**
* Add a response to the list.
*
* @param int $key
* @param array|null $response
*/
public function addResponse($key, $response)
{
}
/**
* @inheritdoc
*/
public function getIterator()
{
}
/**
* @inheritdoc
*/
public function offsetSet($offset, $value)
{
}
/**
* @inheritdoc
*/
public function offsetExists($offset)
{
}
/**
* @inheritdoc
*/
public function offsetUnset($offset)
{
}
/**
* @inheritdoc
*/
public function offsetGet($offset)
{
}
}
}
namespace Facebook\Url {
/**
* Class FacebookUrlManipulator
*
* @package Facebook
*/
class FacebookUrlManipulator
{
/**
* Remove params from a URL.
*
* @param string $url The URL to filter.
* @param array $paramsToFilter The params to filter from the URL.
*
* @return string The URL with the params removed.
*/
public static function removeParamsFromUrl($url, array $paramsToFilter)
{
}
/**
* Gracefully appends params to the URL.
*
* @param string $url The URL that will receive the params.
* @param array $newParams The params to append to the URL.
*
* @return string
*/
public static function appendParamsToUrl($url, array $newParams = [])
{
}
/**
* Returns the params from a URL in the form of an array.
*
* @param string $url The URL to parse the params from.
*
* @return array
*/
public static function getParamsAsArray($url)
{
}
/**
* Adds the params of the first URL to the second URL.
*
* Any params that already exist in the second URL will go untouched.
*
* @param string $urlToStealFrom The URL harvest the params from.
* @param string $urlToAddTo The URL that will receive the new params.
*
* @return string The $urlToAddTo with any new params from $urlToStealFrom.
*/
public static function mergeUrlParams($urlToStealFrom, $urlToAddTo)
{
}
/**
* Check for a "/" prefix and prepend it if not exists.
*
* @param string|null $string
*
* @return string|null
*/
public static function forceSlashPrefix($string)
{
}
/**
* Trims off the hostname and Graph version from a URL.
*
* @param string $urlToTrim The URL the needs the surgery.
*
* @return string The $urlToTrim with the hostname and Graph version removed.
*/
public static function baseGraphUrlEndpoint($urlToTrim)
{
}
}
/**
* Interface UrlDetectionInterface
*
* @package Facebook
*/
interface UrlDetectionInterface
{
/**
* Get the currently active URL.
*
* @return string
*/
public function getCurrentUrl();
}
/**
* Class FacebookUrlDetectionHandler
*
* @package Facebook
*/
class FacebookUrlDetectionHandler implements \Facebook\Url\UrlDetectionInterface
{
/**
* @inheritdoc
*/
public function getCurrentUrl()
{
}
/**
* Get the currently active URL scheme.
*
* @return string
*/
protected function getHttpScheme()
{
}
/**
* Tries to detect if the server is running behind an SSL.
*
* @return boolean
*/
protected function isBehindSsl()
{
}
/**
* Detects an active SSL protocol value.
*
* @param string $protocol
*
* @return boolean
*/
protected function protocolWithActiveSsl($protocol)
{
}
/**
* Tries to detect the host name of the server.
*
* Some elements adapted from
*
* @see https://github.com/symfony/HttpFoundation/blob/master/Request.php
*
* @return string
*/
protected function getHostName()
{
}
protected function getCurrentPort()
{
}
/**
* Returns the a value from the $_SERVER super global.
*
* @param string $key
*
* @return string
*/
protected function getServerVar($key)
{
}
/**
* Gets a value from the HTTP request headers.
*
* @param string $key
*
* @return string
*/
protected function getHeader($key)
{
}
/**
* Checks if the value in X_FORWARDED_HOST is a valid hostname
* Could prevent unintended redirections
*
* @param string $header
*
* @return boolean
*/
protected function isValidForwardedHost($header)
{
}
}
}
namespace Facebook {
/**
* Class SignedRequest
*
* @package Facebook
*/
class SignedRequest
{
/**
* @var FacebookApp The FacebookApp entity.
*/
protected $app;
/**
* @var string The raw encrypted signed request.
*/
protected $rawSignedRequest;
/**
* @var array The payload from the decrypted signed request.
*/
protected $payload;
/**
* Instantiate a new SignedRequest entity.
*
* @param FacebookApp $facebookApp The FacebookApp entity.
* @param string|null $rawSignedRequest The raw signed request.
*/
public function __construct(\Facebook\FacebookApp $facebookApp, $rawSignedRequest = null)
{
}
/**
* Returns the raw signed request data.
*
* @return string|null
*/
public function getRawSignedRequest()
{
}
/**
* Returns the parsed signed request data.
*
* @return array|null
*/
public function getPayload()
{
}
/**
* Returns a property from the signed request data if available.
*
* @param string $key
* @param mixed|null $default
*
* @return mixed|null
*/
public function get($key, $default = null)
{
}
/**
* Returns user_id from signed request data if available.
*
* @return string|null
*/
public function getUserId()
{
}
/**
* Checks for OAuth data in the payload.
*
* @return boolean
*/
public function hasOAuthData()
{
}
/**
* Creates a signed request from an array of data.
*
* @param array $payload
*
* @return string
*/
public function make(array $payload)
{
}
/**
* Validates and decodes a signed request and saves
* the payload to an array.
*/
protected function parse()
{
}
/**
* Splits a raw signed request into signature and payload.
*
* @returns array
*
* @throws FacebookSDKException
*/
protected function split()
{
}
/**
* Decodes the raw signature from a signed request.
*
* @param string $encodedSig
*
* @returns string
*
* @throws FacebookSDKException
*/
protected function decodeSignature($encodedSig)
{
}
/**
* Decodes the raw payload from a signed request.
*
* @param string $encodedPayload
*
* @returns array
*
* @throws FacebookSDKException
*/
protected function decodePayload($encodedPayload)
{
}
/**
* Validates the algorithm used in a signed request.
*
* @throws FacebookSDKException
*/
protected function validateAlgorithm()
{
}
/**
* Hashes the signature used in a signed request.
*
* @param string $encodedData
*
* @return string
*
* @throws FacebookSDKException
*/
protected function hashSignature($encodedData)
{
}
/**
* Validates the signature used in a signed request.
*
* @param string $hashedSig
* @param string $sig
*
* @throws FacebookSDKException
*/
protected function validateSignature($hashedSig, $sig)
{
}
/**
* Base64 decoding which replaces characters:
* + instead of -
* / instead of _
*
* @link http://en.wikipedia.org/wiki/Base64#URL_applications
*
* @param string $input base64 url encoded input
*
* @return string decoded string
*/
public function base64UrlDecode($input)
{
}
/**
* Base64 encoding which replaces characters:
* + instead of -
* / instead of _
*
* @link http://en.wikipedia.org/wiki/Base64#URL_applications
*
* @param string $input string to encode
*
* @return string base64 url encoded input
*/
public function base64UrlEncode($input)
{
}
/**
* Validates a base64 string.
*
* @param string $input base64 value to validate
*
* @throws FacebookSDKException
*/
protected function validateBase64($input)
{
}
}
}
namespace Facebook\Helpers {
/**
* Class FacebookSignedRequestFromInputHelper
*
* @package Facebook
*/
abstract class FacebookSignedRequestFromInputHelper
{
/**
* @var SignedRequest|null The SignedRequest entity.
*/
protected $signedRequest;
/**
* @var FacebookApp The FacebookApp entity.
*/
protected $app;
/**
* @var OAuth2Client The OAuth 2.0 client service.
*/
protected $oAuth2Client;
/**
* Initialize the helper and process available signed request data.
*
* @param FacebookApp $app The FacebookApp entity.
* @param FacebookClient $client The client to make HTTP requests.
* @param string|null $graphVersion The version of Graph to use.
*/
public function __construct(\Facebook\FacebookApp $app, \Facebook\FacebookClient $client, $graphVersion = null)
{
}
/**
* Instantiates a new SignedRequest entity.
*
* @param string|null
*/
public function instantiateSignedRequest($rawSignedRequest = null)
{
}
/**
* Returns an AccessToken entity from the signed request.
*
* @return AccessToken|null
*
* @throws \Facebook\Exceptions\FacebookSDKException
*/
public function getAccessToken()
{
}
/**
* Returns the SignedRequest entity.
*
* @return SignedRequest|null
*/
public function getSignedRequest()
{
}
/**
* Returns the user_id if available.
*
* @return string|null
*/
public function getUserId()
{
}
/**
* Get raw signed request from input.
*
* @return string|null
*/
public abstract function getRawSignedRequest();
/**
* Get raw signed request from POST input.
*
* @return string|null
*/
public function getRawSignedRequestFromPost()
{
}
/**
* Get raw signed request from cookie set from the Javascript SDK.
*
* @return string|null
*/
public function getRawSignedRequestFromCookie()
{
}
}
/**
* Class FacebookJavaScriptLoginHelper
*
* @package Facebook
*/
class FacebookJavaScriptHelper extends \Facebook\Helpers\FacebookSignedRequestFromInputHelper
{
/**
* Get raw signed request from the cookie.
*
* @return string|null
*/
public function getRawSignedRequest()
{
}
}
/**
* Class FacebookRedirectLoginHelper
*
* @package Facebook
*/
class FacebookRedirectLoginHelper
{
/**
* @const int The length of CSRF string to validate the login link.
*/
const CSRF_LENGTH = 32;
/**
* @var OAuth2Client The OAuth 2.0 client service.
*/
protected $oAuth2Client;
/**
* @var UrlDetectionInterface The URL detection handler.
*/
protected $urlDetectionHandler;
/**
* @var PersistentDataInterface The persistent data handler.
*/
protected $persistentDataHandler;
/**
* @var PseudoRandomStringGeneratorInterface The cryptographically secure pseudo-random string generator.
*/
protected $pseudoRandomStringGenerator;
/**
* @param OAuth2Client $oAuth2Client The OAuth 2.0 client service.
* @param PersistentDataInterface|null $persistentDataHandler The persistent data handler.
* @param UrlDetectionInterface|null $urlHandler The URL detection handler.
* @param PseudoRandomStringGeneratorInterface|null $prsg The cryptographically secure pseudo-random string generator.
*/
public function __construct(\Facebook\Authentication\OAuth2Client $oAuth2Client, \Facebook\PersistentData\PersistentDataInterface $persistentDataHandler = null, \Facebook\Url\UrlDetectionInterface $urlHandler = null, \Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface $prsg = null)
{
}
/**
* Returns the persistent data handler.
*
* @return PersistentDataInterface
*/
public function getPersistentDataHandler()
{
}
/**
* Returns the URL detection handler.
*
* @return UrlDetectionInterface
*/
public function getUrlDetectionHandler()
{
}
/**
* Returns the cryptographically secure pseudo-random string generator.
*
* @return PseudoRandomStringGeneratorInterface
*/
public function getPseudoRandomStringGenerator()
{
}
/**
* Returns the URL to send the user in order to login to Facebook.
*
* @param string $redirectUrl The URL Facebook should redirect users to after login.
* @param array $scope List of permissions to request during login.
* @param string $separator The separator to use in http_build_query().
*
* @return string
*/
public function getLoginUrl($redirectUrl, array $scope = [], $separator = '&')
{
}
/**
* Returns the URL to send the user in order to log out of Facebook.
*
* @param AccessToken|string $accessToken The access token that will be logged out.
* @param string $next The url Facebook should redirect the user to after a successful logout.
* @param string $separator The separator to use in http_build_query().
*
* @return string
*
* @throws FacebookSDKException
*/
public function getLogoutUrl($accessToken, $next, $separator = '&')
{
}
/**
* Returns the URL to send the user in order to login to Facebook with permission(s) to be re-asked.
*
* @param string $redirectUrl The URL Facebook should redirect users to after login.
* @param array $scope List of permissions to request during login.
* @param string $separator The separator to use in http_build_query().
*
* @return string
*/
public function getReRequestUrl($redirectUrl, array $scope = [], $separator = '&')
{
}
/**
* Returns the URL to send the user in order to login to Facebook with user to be re-authenticated.
*
* @param string $redirectUrl The URL Facebook should redirect users to after login.
* @param array $scope List of permissions to request during login.
* @param string $separator The separator to use in http_build_query().
*
* @return string
*/
public function getReAuthenticationUrl($redirectUrl, array $scope = [], $separator = '&')
{
}
/**
* Takes a valid code from a login redirect, and returns an AccessToken entity.
*
* @param string|null $redirectUrl The redirect URL.
*
* @return AccessToken|null
*
* @throws FacebookSDKException
*/
public function getAccessToken($redirectUrl = null)
{
}
/**
* Validate the request against a cross-site request forgery.
*
* @throws FacebookSDKException
*/
protected function validateCsrf()
{
}
/**
* Return the code.
*
* @return string|null
*/
protected function getCode()
{
}
/**
* Return the state.
*
* @return string|null
*/
protected function getState()
{
}
/**
* Return the error code.
*
* @return string|null
*/
public function getErrorCode()
{
}
/**
* Returns the error.
*
* @return string|null
*/
public function getError()
{
}
/**
* Returns the error reason.
*
* @return string|null
*/
public function getErrorReason()
{
}
/**
* Returns the error description.
*
* @return string|null
*/
public function getErrorDescription()
{
}
}
/**
* Class FacebookCanvasLoginHelper
*
* @package Facebook
*/
class FacebookCanvasHelper extends \Facebook\Helpers\FacebookSignedRequestFromInputHelper
{
/**
* Returns the app data value.
*
* @return mixed|null
*/
public function getAppData()
{
}
/**
* Get raw signed request from POST.
*
* @return string|null
*/
public function getRawSignedRequest()
{
}
}
/**
* Class FacebookPageTabHelper
*
* @package Facebook
*/
class FacebookPageTabHelper extends \Facebook\Helpers\FacebookCanvasHelper
{
/**
* @var array|null
*/
protected $pageData;
/**
* Initialize the helper and process available signed request data.
*
* @param FacebookApp $app The FacebookApp entity.
* @param FacebookClient $client The client to make HTTP requests.
* @param string|null $graphVersion The version of Graph to use.
*/
public function __construct(\Facebook\FacebookApp $app, \Facebook\FacebookClient $client, $graphVersion = null)
{
}
/**
* Returns a value from the page data.
*
* @param string $key
* @param mixed|null $default
*
* @return mixed|null
*/
public function getPageData($key, $default = null)
{
}
/**
* Returns true if the user is an admin.
*
* @return boolean
*/
public function isAdmin()
{
}
/**
* Returns the page id if available.
*
* @return string|null
*/
public function getPageId()
{
}
}
}
namespace Facebook {
class FacebookApp implements \Serializable
{
/**
* @var string The app ID.
*/
protected $id;
/**
* @var string The app secret.
*/
protected $secret;
/**
* @param string $id
* @param string $secret
*
* @throws FacebookSDKException
*/
public function __construct($id, $secret)
{
}
/**
* Returns the app ID.
*
* @return string
*/
public function getId()
{
}
/**
* Returns the app secret.
*
* @return string
*/
public function getSecret()
{
}
/**
* Returns an app access token.
*
* @return AccessToken
*/
public function getAccessToken()
{
}
/**
* Serializes the FacebookApp entity as a string.
*
* @return string
*/
public function serialize()
{
}
/**
* Unserializes a string as a FacebookApp entity.
*
* @param string $serialized
*/
public function unserialize($serialized)
{
}
}
}
namespace Facebook\Http {
/**
* Class GraphRawResponse
*
* @package Facebook
*/
class GraphRawResponse
{
/**
* @var array The response headers in the form of an associative array.
*/
protected $headers;
/**
* @var string The raw response body.
*/
protected $body;
/**
* @var int The HTTP status response code.
*/
protected $httpResponseCode;
/**
* Creates a new GraphRawResponse entity.
*
* @param string|array $headers The headers as a raw string or array.
* @param string $body The raw response body.
* @param int $httpStatusCode The HTTP response code (if sending headers as parsed array).
*/
public function __construct($headers, $body, $httpStatusCode = null)
{
}
/**
* Return the response headers.
*
* @return array
*/
public function getHeaders()
{
}
/**
* Return the body of the response.
*
* @return string
*/
public function getBody()
{
}
/**
* Return the HTTP response code.
*
* @return int
*/
public function getHttpResponseCode()
{
}
/**
* Sets the HTTP response code from a raw header.
*
* @param string $rawResponseHeader
*/
public function setHttpResponseCodeFromHeader($rawResponseHeader)
{
}
/**
* Parse the raw headers and set as an array.
*
* @param string $rawHeaders The raw headers from the response.
*/
protected function setHeadersFromString($rawHeaders)
{
}
}
/**
* Interface
*
* @package Facebook
*/
interface RequestBodyInterface
{
/**
* Get the body of the request to send to Graph.
*
* @return string
*/
public function getBody();
}
/**
* Class RequestBodyUrlEncoded
*
* @package Facebook
*/
class RequestBodyUrlEncoded implements \Facebook\Http\RequestBodyInterface
{
/**
* @var array The parameters to send with this request.
*/
protected $params = [];
/**
* Creates a new GraphUrlEncodedBody entity.
*
* @param array $params
*/
public function __construct(array $params)
{
}
/**
* @inheritdoc
*/
public function getBody()
{
}
}
/**
* Class RequestBodyMultipartt
*
* Some things copied from Guzzle
*
* @package Facebook
*
* @see https://github.com/guzzle/guzzle/blob/master/src/Post/MultipartBody.php
*/
class RequestBodyMultipart implements \Facebook\Http\RequestBodyInterface
{
/**
* @param array $params The parameters to send with this request.
* @param array $files The files to send with this request.
* @param string $boundary Provide a specific boundary.
*/
public function __construct(array $params = [], array $files = [], $boundary = null)
{
}
/**
* @inheritdoc
*/
public function getBody()
{
}
/**
* Get the boundary
*
* @return string
*/
public function getBoundary()
{
}
/**
* Get the headers needed before transferring the content of a POST file.
*
* @param FacebookFile $file
*
* @return string
*/
protected function getFileHeaders(\Facebook\FileUpload\FacebookFile $file)
{
}
}
}
namespace Facebook {
/**
* Class FacebookClient
*
* @package Facebook
*/
class FacebookClient
{
/**
* @const string Production Graph API URL.
*/
const BASE_GRAPH_URL = 'https://graph.facebook.com';
/**
* @const string Graph API URL for video uploads.
*/
const BASE_GRAPH_VIDEO_URL = 'https://graph-video.facebook.com';
/**
* @const string Beta Graph API URL.
*/
const BASE_GRAPH_URL_BETA = 'https://graph.beta.facebook.com';
/**
* @const string Beta Graph API URL for video uploads.
*/
const BASE_GRAPH_VIDEO_URL_BETA = 'https://graph-video.beta.facebook.com';
/**
* @const int The timeout in seconds for a normal request.
*/
const DEFAULT_REQUEST_TIMEOUT = 60;
/**
* @const int The timeout in seconds for a request that contains file uploads.
*/
const DEFAULT_FILE_UPLOAD_REQUEST_TIMEOUT = 3600;
/**
* @const int The timeout in seconds for a request that contains video uploads.
*/
const DEFAULT_VIDEO_UPLOAD_REQUEST_TIMEOUT = 7200;
/**
* @var bool Toggle to use Graph beta url.
*/
protected $enableBetaMode = false;
/**
* @var FacebookHttpClientInterface HTTP client handler.
*/
protected $httpClientHandler;
/**
* @var int The number of calls that have been made to Graph.
*/
public static $requestCount = 0;
/**
* Instantiates a new FacebookClient object.
*
* @param FacebookHttpClientInterface|null $httpClientHandler
* @param boolean $enableBeta
*/
public function __construct(\Facebook\HttpClients\FacebookHttpClientInterface $httpClientHandler = null, $enableBeta = false)
{
}
/**
* Sets the HTTP client handler.
*
* @param FacebookHttpClientInterface $httpClientHandler
*/
public function setHttpClientHandler(\Facebook\HttpClients\FacebookHttpClientInterface $httpClientHandler)
{
}
/**
* Returns the HTTP client handler.
*
* @return FacebookHttpClientInterface
*/
public function getHttpClientHandler()
{
}
/**
* Detects which HTTP client handler to use.
*
* @return FacebookHttpClientInterface
*/
public function detectHttpClientHandler()
{
}
/**
* Toggle beta mode.
*
* @param boolean $betaMode
*/
public function enableBetaMode($betaMode = true)
{
}
/**
* Returns the base Graph URL.
*
* @param boolean $postToVideoUrl Post to the video API if videos are being uploaded.
*
* @return string
*/
public function getBaseGraphUrl($postToVideoUrl = false)
{
}
/**
* Prepares the request for sending to the client handler.
*
* @param FacebookRequest $request
*
* @return array
*/
public function prepareRequestMessage(\Facebook\FacebookRequest $request)
{
}
/**
* Makes the request to Graph and returns the result.
*
* @param FacebookRequest $request
*
* @return FacebookResponse
*
* @throws FacebookSDKException
*/
public function sendRequest(\Facebook\FacebookRequest $request)
{
}
/**
* Makes a batched request to Graph and returns the result.
*
* @param FacebookBatchRequest $request
*
* @return FacebookBatchResponse
*
* @throws FacebookSDKException
*/
public function sendBatchRequest(\Facebook\FacebookBatchRequest $request)
{
}
}
}
namespace Facebook\PseudoRandomString {
/**
* Interface
*
* @package Facebook
*/
interface PseudoRandomStringGeneratorInterface
{
/**
* Get a cryptographically secure pseudo-random string of arbitrary length.
*
* @see http://sockpuppet.org/blog/2014/02/25/safely-generate-random-numbers/
*
* @param int $length The length of the string to return.
*
* @return string
*
* @throws \Facebook\Exceptions\FacebookSDKException|\InvalidArgumentException
*/
public function getPseudoRandomString($length);
}
trait PseudoRandomStringGeneratorTrait
{
/**
* Validates the length argument of a random string.
*
* @param int $length The length to validate.
*
* @throws \InvalidArgumentException
*/
public function validateLength($length)
{
}
/**
* Converts binary data to hexadecimal of arbitrary length.
*
* @param string $binaryData The binary data to convert to hex.
* @param int $length The length of the string to return.
*
* @return string
*/
public function binToHex($binaryData, $length)
{
}
}
class RandomBytesPseudoRandomStringGenerator implements \Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface
{
use \Facebook\PseudoRandomString\PseudoRandomStringGeneratorTrait;
/**
* @const string The error message when generating the string fails.
*/
const ERROR_MESSAGE = 'Unable to generate a cryptographically secure pseudo-random string from random_bytes(). ';
/**
* @throws FacebookSDKException
*/
public function __construct()
{
}
/**
* @inheritdoc
*/
public function getPseudoRandomString($length)
{
}
}
class OpenSslPseudoRandomStringGenerator implements \Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface
{
use \Facebook\PseudoRandomString\PseudoRandomStringGeneratorTrait;
/**
* @const string The error message when generating the string fails.
*/
const ERROR_MESSAGE = 'Unable to generate a cryptographically secure pseudo-random string from openssl_random_pseudo_bytes().';
/**
* @throws FacebookSDKException
*/
public function __construct()
{
}
/**
* @inheritdoc
*/
public function getPseudoRandomString($length)
{
}
}
class McryptPseudoRandomStringGenerator implements \Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface
{
use \Facebook\PseudoRandomString\PseudoRandomStringGeneratorTrait;
/**
* @const string The error message when generating the string fails.
*/
const ERROR_MESSAGE = 'Unable to generate a cryptographically secure pseudo-random string from mcrypt_create_iv(). ';
/**
* @throws FacebookSDKException
*/
public function __construct()
{
}
/**
* @inheritdoc
*/
public function getPseudoRandomString($length)
{
}
}
class PseudoRandomStringGeneratorFactory
{
/**
* Pseudo random string generator creation.
*
* @param PseudoRandomStringGeneratorInterface|string|null $generator
*
* @throws InvalidArgumentException If the pseudo random string generator must be set to "random_bytes", "mcrypt", "openssl", or "urandom", or be an instance of Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface.
*
* @return PseudoRandomStringGeneratorInterface
*/
public static function createPseudoRandomStringGenerator($generator)
{
}
}
class UrandomPseudoRandomStringGenerator implements \Facebook\PseudoRandomString\PseudoRandomStringGeneratorInterface
{
use \Facebook\PseudoRandomString\PseudoRandomStringGeneratorTrait;
/**
* @const string The error message when generating the string fails.
*/
const ERROR_MESSAGE = 'Unable to generate a cryptographically secure pseudo-random string from /dev/urandom. ';
/**
* @throws FacebookSDKException
*/
public function __construct()
{
}
/**
* @inheritdoc
*/
public function getPseudoRandomString($length)
{
}
}
}
namespace Firebase\JWT {
class SignatureInvalidException extends \UnexpectedValueException
{
}
class BeforeValidException extends \UnexpectedValueException
{
}
class ExpiredException extends \UnexpectedValueException
{
}
/**
* JSON Web Token implementation, based on this spec:
* http://tools.ietf.org/html/draft-ietf-oauth-json-web-token-06
*
* PHP version 5
*
* @category Authentication
* @package Authentication_JWT
* @author Neuman Vong <neuman@twilio.com>
* @author Anant Narayanan <anant@php.net>
* @license http://opensource.org/licenses/BSD-3-Clause 3-clause BSD
* @link https://github.com/firebase/php-jwt
*/
class JWT
{
/**
* When checking nbf, iat or expiration times,
* we want to provide some extra leeway time to
* account for clock skew.
*/
public static $leeway = 0;
public static $supported_algs = array('HS256' => array('hash_hmac', 'SHA256'), 'HS512' => array('hash_hmac', 'SHA512'), 'HS384' => array('hash_hmac', 'SHA384'), 'RS256' => array('openssl', 'SHA256'));
/**
* Decodes a JWT string into a PHP object.
*
* @param string $jwt The JWT
* @param string|array|null $key The key, or map of keys.
* If the algorithm used is asymmetric, this is the public key
* @param array $allowed_algs List of supported verification algorithms
* Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'
*
* @return object The JWT's payload as a PHP object
*
* @throws DomainException Algorithm was not provided
* @throws UnexpectedValueException Provided JWT was invalid
* @throws SignatureInvalidException Provided JWT was invalid because the signature verification failed
* @throws BeforeValidException Provided JWT is trying to be used before it's eligible as defined by 'nbf'
* @throws BeforeValidException Provided JWT is trying to be used before it's been created as defined by 'iat'
* @throws ExpiredException Provided JWT has since expired, as defined by the 'exp' claim
*
* @uses jsonDecode
* @uses urlsafeB64Decode
*/
public static function decode($jwt, $key, $allowed_algs = array())
{
}
/**
* Converts and signs a PHP object or array into a JWT string.
*
* @param object|array $payload PHP object or array
* @param string $key The secret key.
* If the algorithm used is asymmetric, this is the private key
* @param string $alg The signing algorithm.
* Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'
* @param array $head An array with header elements to attach
*
* @return string A signed JWT
*
* @uses jsonEncode
* @uses urlsafeB64Encode
*/
public static function encode($payload, $key, $alg = 'HS256', $keyId = null, $head = null)
{
}
/**
* Sign a string with a given key and algorithm.
*
* @param string $msg The message to sign
* @param string|resource $key The secret key
* @param string $alg The signing algorithm.
* Supported algorithms are 'HS256', 'HS384', 'HS512' and 'RS256'
*
* @return string An encrypted message
*
* @throws DomainException Unsupported algorithm was specified
*/
public static function sign($msg, $key, $alg = 'HS256')
{
}
/**
* Decode a JSON string into a PHP object.
*
* @param string $input JSON string
*
* @return object Object representation of JSON string
*
* @throws DomainException Provided string was invalid JSON
*/
public static function jsonDecode($input)
{
}
/**
* Encode a PHP object into a JSON string.
*
* @param object|array $input A PHP object or array
*
* @return string JSON representation of the PHP object or array
*
* @throws DomainException Provided object could not be encoded to valid JSON
*/
public static function jsonEncode($input)
{
}
/**
* Decode a string with URL-safe Base64.
*
* @param string $input A Base64 encoded string
*
* @return string A decoded string
*/
public static function urlsafeB64Decode($input)
{
}
/**
* Encode a string with URL-safe Base64.
*
* @param string $input The string you want encoded
*
* @return string The base64 encode of what you passed in
*/
public static function urlsafeB64Encode($input)
{
}
}
}
namespace Interop\Container {
/**
* Describes the interface of a container that exposes methods to read its entries.
*/
interface ContainerInterface extends \Psr\Container\ContainerInterface
{
}
}
namespace Interop\Container\Exception {
/**
* Base interface representing a generic exception in a container.
*/
interface ContainerException extends \Psr\Container\ContainerExceptionInterface
{
}
/**
* No entry was found in the container.
*/
interface NotFoundException extends \Interop\Container\Exception\ContainerException, \Psr\Container\NotFoundExceptionInterface
{
}
}
namespace Knp\Menu {
/**
* Interface implemented by a menu item.
*
* It roughly represents a single <li> tag and is what you should interact with
* most of the time by default.
* Originally taken from ioMenuPlugin (http://github.com/weaverryan/ioMenuPlugin)
*/
interface ItemInterface extends \ArrayAccess, \Countable, \IteratorAggregate
{
/**
* @param FactoryInterface $factory
*
* @return ItemInterface
*/
public function setFactory(\Knp\Menu\FactoryInterface $factory);
/**
* @return string
*/
public function getName();
/**
* Renames the item.
*
* This method must also update the key in the parent.
*
* Provides a fluent interface
*
* @param string $name
*
* @return ItemInterface
*
* @throws \InvalidArgumentException if the name is already used by a sibling
*/
public function setName($name);
/**
* Get the uri for a menu item
*
* @return string
*/
public function getUri();
/**
* Set the uri for a menu item
*
* Provides a fluent interface
*
* @param string $uri The uri to set on this menu item
*
* @return ItemInterface
*/
public function setUri($uri);
/**
* Returns the label that will be used to render this menu item
*
* Defaults to the name of no label was specified
*
* @return string
*/
public function getLabel();
/**
* Provides a fluent interface
*
* @param string $label The text to use when rendering this menu item
*
* @return ItemInterface
*/
public function setLabel($label);
/**
* @return array
*/
public function getAttributes();
/**
* Provides a fluent interface
*
* @param array $attributes
*
* @return ItemInterface
*/
public function setAttributes(array $attributes);
/**
* @param string $name The name of the attribute to return
* @param mixed $default The value to return if the attribute doesn't exist
*
* @return mixed
*/
public function getAttribute($name, $default = null);
/**
* Provides a fluent interface
*
* @param string $name
* @param mixed $value
*
* @return ItemInterface
*/
public function setAttribute($name, $value);
/**
* @return array
*/
public function getLinkAttributes();
/**
* Provides a fluent interface
*
* @param array $linkAttributes
*
* @return ItemInterface
*/
public function setLinkAttributes(array $linkAttributes);
/**
* @param string $name The name of the attribute to return
* @param mixed $default The value to return if the attribute doesn't exist
*
* @return mixed
*/
public function getLinkAttribute($name, $default = null);
/**
* Provides a fluent interface
*
* @param string $name
* @param string $value
*
* @return ItemInterface
*/
public function setLinkAttribute($name, $value);
/**
* @return array
*/
public function getChildrenAttributes();
/**
* Provides a fluent interface
*
* @param array $childrenAttributes
*
* @return ItemInterface
*/
public function setChildrenAttributes(array $childrenAttributes);
/**
* @param string $name The name of the attribute to return
* @param mixed $default The value to return if the attribute doesn't exist
*
* @return mixed
*/
public function getChildrenAttribute($name, $default = null);
/**
* Provides a fluent interface
*
* @param string $name
* @param string $value
*
* @return ItemInterface
*/
public function setChildrenAttribute($name, $value);
/**
* @return array
*/
public function getLabelAttributes();
/**
* Provides a fluent interface
*
* @param array $labelAttributes
*
* @return ItemInterface
*/
public function setLabelAttributes(array $labelAttributes);
/**
* @param string $name The name of the attribute to return
* @param mixed $default The value to return if the attribute doesn't exist
*
* @return mixed
*/
public function getLabelAttribute($name, $default = null);
/**
* Provides a fluent interface
*
* @param string $name
* @param mixed $value
*
* @return ItemInterface
*/
public function setLabelAttribute($name, $value);
/**
* @return array
*/
public function getExtras();
/**
* Provides a fluent interface
*
* @param array $extras
*
* @return ItemInterface
*/
public function setExtras(array $extras);
/**
* @param string $name The name of the extra to return
* @param mixed $default The value to return if the extra doesn't exist
*
* @return mixed
*/
public function getExtra($name, $default = null);
/**
* Provides a fluent interface
*
* @param string $name
* @param mixed $value
*
* @return ItemInterface
*/
public function setExtra($name, $value);
/**
* Whether or not this menu item should show its children.
*
* @return boolean
*/
public function getDisplayChildren();
/**
* Set whether or not this menu item should show its children
*
* Provides a fluent interface
*
* @param boolean $bool
*
* @return ItemInterface
*/
public function setDisplayChildren($bool);
/**
* Whether or not to display this menu item
*
* @return boolean
*/
public function isDisplayed();
/**
* Set whether or not this menu should be displayed
*
* Provides a fluent interface
*
* @param boolean $bool
*
* @return ItemInterface
*/
public function setDisplay($bool);
/**
* Add a child menu item to this menu
*
* Returns the child item
*
* @param ItemInterface|string $child An ItemInterface instance or the name of a new item to create
* @param array $options If creating a new item, the options passed to the factory for the item
*
* @return ItemInterface
* @throws \InvalidArgumentException if the item is already in a tree
*/
public function addChild($child, array $options = array());
/**
* Returns the child menu identified by the given name
*
* @param string $name Then name of the child menu to return
*
* @return ItemInterface|null
*/
public function getChild($name);
/**
* Reorder children.
*
* Provides a fluent interface
*
* @param array $order New order of children.
*
* @return ItemInterface
*/
public function reorderChildren($order);
/**
* Makes a deep copy of menu tree. Every item is copied as another object.
*
* @return ItemInterface
*/
public function copy();
/**
* Returns the level of this menu item
*
* The root menu item is 0, followed by 1, 2, etc
*
* @return integer
*/
public function getLevel();
/**
* Returns the root ItemInterface of this menu tree
*
* @return ItemInterface
*/
public function getRoot();
/**
* Returns whether or not this menu item is the root menu item
*
* @return boolean
*/
public function isRoot();
/**
* @return ItemInterface|null
*/
public function getParent();
/**
* Used internally when adding and removing children
*
* Provides a fluent interface
*
* @param ItemInterface|null $parent
*
* @return ItemInterface
*/
public function setParent(\Knp\Menu\ItemInterface $parent = null);
/**
* Return the children as an array of ItemInterface objects
*
* @return ItemInterface[]
*/
public function getChildren();
/**
* Provides a fluent interface
*
* @param array $children An array of ItemInterface objects
*
* @return ItemInterface
*/
public function setChildren(array $children);
/**
* Removes a child from this menu item
*
* Provides a fluent interface
*
* @param ItemInterface|string $name The name of ItemInterface instance or the ItemInterface to remove
*
* @return ItemInterface
*/
public function removeChild($name);
/**
* @return ItemInterface
*/
public function getFirstChild();
/**
* @return ItemInterface
*/
public function getLastChild();
/**
* Returns whether or not this menu items has viewable children
*
* This menu MAY have children, but this will return false if the current
* user does not have access to view any of those items
*
* @return boolean
*/
public function hasChildren();
/**
* Sets whether or not this menu item is "current".
*
* If the state is unknown, use null.
*
* Provides a fluent interface
*
* @param boolean|null $bool Specify that this menu item is current
*
* @return ItemInterface
*/
public function setCurrent($bool);
/**
* Gets whether or not this menu item is "current".
*
* @return boolean|null
*/
public function isCurrent();
/**
* Whether this menu item is last in its parent
*
* @return boolean
*/
public function isLast();
/**
* Whether this menu item is first in its parent
*
* @return boolean
*/
public function isFirst();
/**
* Whereas isFirst() returns if this is the first child of the parent
* menu item, this function takes into consideration whether children are rendered or not.
*
* This returns true if this is the first child that would be rendered
* for the current user
*
* @return boolean
*/
public function actsLikeFirst();
/**
* Whereas isLast() returns if this is the last child of the parent
* menu item, this function takes into consideration whether children are rendered or not.
*
* This returns true if this is the last child that would be rendered
* for the current user
*
* @return boolean
*/
public function actsLikeLast();
}
}
namespace Knp\Menu\Matcher\Voter {
/**
* Interface implemented by the matching voters
*/
interface VoterInterface
{
/**
* Checks whether an item is current.
*
* If the voter is not able to determine a result,
* it should return null to let other voters do the job.
*
* @param ItemInterface $item
*
* @return boolean|null
*/
public function matchItem(\Knp\Menu\ItemInterface $item);
}
/**
* Voter based on the route
*/
class RouteVoter implements \Knp\Menu\Matcher\Voter\VoterInterface
{
public function __construct(\Symfony\Component\HttpFoundation\Request $request = null)
{
}
public function setRequest(\Symfony\Component\HttpFoundation\Request $request)
{
}
public function matchItem(\Knp\Menu\ItemInterface $item)
{
}
}
/**
* Voter based on the uri
*/
class UriVoter implements \Knp\Menu\Matcher\Voter\VoterInterface
{
public function __construct($uri = null)
{
}
public function matchItem(\Knp\Menu\ItemInterface $item)
{
}
}
/**
* Implements the VoterInterface which can be used as voter for "current" class
* `matchItem` will return true if the pattern you're searching for is found in the URI of the item
*/
class RegexVoter implements \Knp\Menu\Matcher\Voter\VoterInterface
{
/**
* @param string $regexp
*/
public function __construct($regexp)
{
}
public function matchItem(\Knp\Menu\ItemInterface $item)
{
}
}
}
namespace Knp\Menu\Matcher {
/**
* Interface implemented by the item matcher
*/
interface MatcherInterface
{
/**
* Checks whether an item is current.
*
* @param ItemInterface $item
*
* @return boolean
*/
public function isCurrent(\Knp\Menu\ItemInterface $item);
/**
* Checks whether an item is the ancestor of a current item.
*
* @param ItemInterface $item
* @param integer $depth The max depth to look for the item
*
* @return boolean
*/
public function isAncestor(\Knp\Menu\ItemInterface $item, $depth = null);
/**
* Clears the state of the matcher.
*/
public function clear();
}
/**
* A MatcherInterface implementation using a voter system
*/
class Matcher implements \Knp\Menu\Matcher\MatcherInterface
{
public function __construct()
{
}
/**
* Adds a voter in the matcher.
*
* @param VoterInterface $voter
*/
public function addVoter(\Knp\Menu\Matcher\Voter\VoterInterface $voter)
{
}
public function isCurrent(\Knp\Menu\ItemInterface $item)
{
}
public function isAncestor(\Knp\Menu\ItemInterface $item, $depth = null)
{
}
public function clear()
{
}
}
}
namespace Knp\Menu\Integration\Silex {
class KnpMenuServiceProvider implements \Silex\ServiceProviderInterface
{
public function register(\Silex\Application $app)
{
}
public function boot(\Silex\Application $app)
{
}
}
}
namespace Knp\Menu\Factory {
interface ExtensionInterface
{
/**
* Builds the full option array used to configure the item.
*
* @param array $options The options processed by the previous extensions
*
* @return array
*/
public function buildOptions(array $options);
/**
* Configures the item with the passed options
*
* @param ItemInterface $item
* @param array $options
*/
public function buildItem(\Knp\Menu\ItemInterface $item, array $options);
}
}
namespace Knp\Menu\Integration\Symfony {
/**
* Factory able to use the Symfony2 Routing component to build the url
*/
class RoutingExtension implements \Knp\Menu\Factory\ExtensionInterface
{
public function __construct(\Symfony\Component\Routing\Generator\UrlGeneratorInterface $generator)
{
}
public function buildOptions(array $options = array())
{
}
public function buildItem(\Knp\Menu\ItemInterface $item, array $options)
{
}
}
}
namespace Knp\Menu\Provider {
interface MenuProviderInterface
{
/**
* Retrieves a menu by its name
*
* @param string $name
* @param array $options
*
* @return \Knp\Menu\ItemInterface
* @throws \InvalidArgumentException if the menu does not exists
*/
public function get($name, array $options = array());
/**
* Checks whether a menu exists in this provider
*
* @param string $name
* @param array $options
*
* @return boolean
*/
public function has($name, array $options = array());
}
class ChainProvider implements \Knp\Menu\Provider\MenuProviderInterface
{
public function __construct(array $providers)
{
}
public function get($name, array $options = array())
{
}
public function has($name, array $options = array())
{
}
}
/**
* A menu provider getting the menus from a class implementing ArrayAccess.
*
* In case the value stored in the registry is a callable rather than an ItemInterface,
* it will be called with the options as first argument and the registry as second argument
* and is expected to return a menu item.
*/
class ArrayAccessProvider implements \Knp\Menu\Provider\MenuProviderInterface
{
/**
* @param \ArrayAccess $registry
* @param array $menuIds The map between menu identifiers and registry keys
*/
public function __construct(\ArrayAccess $registry, array $menuIds = array())
{
}
public function get($name, array $options = array())
{
}
public function has($name, array $options = array())
{
}
}
/**
* Menu provider getting menus from a Pimple 1 container
*
* @deprecated use the ArrayAccessProvider instead.
*/
class PimpleProvider extends \Knp\Menu\Provider\ArrayAccessProvider
{
public function __construct(\Pimple $pimple, array $menuIds = array())
{
}
}
}
namespace Knp\Menu\Factory {
/**
* core factory extension with the main logic
*/
class CoreExtension implements \Knp\Menu\Factory\ExtensionInterface
{
/**
* Builds the full option array used to configure the item.
*
* @param array $options
*
* @return array
*/
public function buildOptions(array $options)
{
}
/**
* Configures the newly created item with the passed options
*
* @param ItemInterface $item
* @param array $options
*/
public function buildItem(\Knp\Menu\ItemInterface $item, array $options)
{
}
}
}
namespace Knp\Menu\Util {
class MenuManipulator
{
/**
* Moves item to specified position. Rearrange siblings accordingly.
*
* @param ItemInterface $item
* @param integer $position Position to move child to.
*/
public function moveToPosition(\Knp\Menu\ItemInterface $item, $position)
{
}
/**
* Moves child to specified position. Rearrange other children accordingly.
*
* @param ItemInterface $item
* @param ItemInterface $child Child to move.
* @param integer $position Position to move child to.
*/
public function moveChildToPosition(\Knp\Menu\ItemInterface $item, \Knp\Menu\ItemInterface $child, $position)
{
}
/**
* Moves item to first position. Rearrange siblings accordingly.
*
* @param ItemInterface $item
*/
public function moveToFirstPosition(\Knp\Menu\ItemInterface $item)
{
}
/**
* Moves item to last position. Rearrange siblings accordingly.
*
* @param ItemInterface $item
*/
public function moveToLastPosition(\Knp\Menu\ItemInterface $item)
{
}
/**
* Get slice of menu as another menu.
*
* If offset and/or length are numeric, it works like in array_slice function:
*
* If offset is non-negative, slice will start at the offset.
* If offset is negative, slice will start that far from the end.
*
* If length is null, slice will have all elements.
* If length is positive, slice will have that many elements.
* If length is negative, slice will stop that far from the end.
*
* It's possible to mix names/object/numeric, for example:
* slice("child1", 2);
* slice(3, $child5);
* Note: when using a child as limit, it will not be included in the returned menu.
* the slice is done before this menu.
*
* @param ItemInterface $item
* @param mixed $offset Name of child, child object, or numeric offset.
* @param mixed $length Name of child, child object, or numeric length.
*
* @return ItemInterface
*/
public function slice(\Knp\Menu\ItemInterface $item, $offset, $length = null)
{
}
/**
* Split menu into two distinct menus.
*
* @param ItemInterface $item
* @param mixed $length Name of child, child object, or numeric length.
*
* @return array Array with two menus, with "primary" and "secondary" key
*/
public function split(\Knp\Menu\ItemInterface $item, $length)
{
}
/**
* Calls a method recursively on all of the children of this item
*
* @example
* $menu->callRecursively('setShowChildren', array(false));
*
* @param ItemInterface $item
* @param string $method
* @param array $arguments
*/
public function callRecursively(\Knp\Menu\ItemInterface $item, $method, $arguments = array())
{
}
/**
* A string representation of this menu item
*
* e.g. Top Level > Second Level > This menu
*
* @param ItemInterface $item
* @param string $separator
*
* @return string
*/
public function getPathAsString(\Knp\Menu\ItemInterface $item, $separator = ' > ')
{
}
/**
* @param ItemInterface $item
* @param integer|null $depth the depth until which children should be exported (null means unlimited)
*
* @return array
*/
public function toArray(\Knp\Menu\ItemInterface $item, $depth = null)
{
}
/**
* Renders an array ready to be used for breadcrumbs.
*
* Each element in the array will be an array with 3 keys:
* - `label` containing the label of the item
* - `url` containing the url of the item (may be `null`)
* - `item` containing the original item (may be `null` for the extra items)
*
* The subItem can be one of the following forms
* * 'subItem'
* * ItemInterface object
* * array('subItem' => '@homepage')
* * array('subItem1', 'subItem2')
* * array(array('label' => 'subItem1', 'url' => '@homepage'), array('label' => 'subItem2'))
*
* @param ItemInterface $item
* @param mixed $subItem A string or array to append onto the end of the array
*
* @return array
*
* @throws \InvalidArgumentException if an element of the subItem is invalid
*/
public function getBreadcrumbsArray(\Knp\Menu\ItemInterface $item, $subItem = null)
{
}
}
}
namespace Knp\Menu {
/**
* Interface implemented by a node to construct a menu from a tree.
*/
interface NodeInterface
{
/**
* Get the name of the node
*
* Each child of a node must have a unique name
*
* @return string
*/
public function getName();
/**
* Get the options for the factory to create the item for this node
*
* @return array
*/
public function getOptions();
/**
* Get the child nodes implementing NodeInterface
*
* @return \Traversable
*/
public function getChildren();
}
/**
* Default implementation of the ItemInterface
*/
class MenuItem implements \Knp\Menu\ItemInterface
{
/**
* Name of this menu item (used for id by parent menu)
* @var string
*/
protected $name = null;
/**
* Label to output, name is used by default
* @var string
*/
protected $label = null;
/**
* Attributes for the item link
* @var array
*/
protected $linkAttributes = array();
/**
* Attributes for the children list
* @var array
*/
protected $childrenAttributes = array();
/**
* Attributes for the item text
* @var array
*/
protected $labelAttributes = array();
/**
* Uri to use in the anchor tag
* @var string
*/
protected $uri = null;
/**
* Attributes for the item
* @var array
*/
protected $attributes = array();
/**
* Extra stuff associated to the item
* @var array
*/
protected $extras = array();
/**
* Whether the item is displayed
* @var boolean
*/
protected $display = true;
/**
* Whether the children of the item are displayed
* @var boolean
*/
protected $displayChildren = true;
/**
* Child items
* @var ItemInterface[]
*/
protected $children = array();
/**
* Parent item
* @var ItemInterface|null
*/
protected $parent = null;
/**
* whether the item is current. null means unknown
* @var boolean|null
*/
protected $isCurrent = null;
/**
* @var FactoryInterface
*/
protected $factory;
/**
* Class constructor
*
* @param string $name The name of this menu, which is how its parent will
* reference it. Also used as label if label not specified
* @param FactoryInterface $factory
*/
public function __construct($name, \Knp\Menu\FactoryInterface $factory)
{
}
/**
* setFactory
*
* @param FactoryInterface $factory
* @return self
*/
public function setFactory(\Knp\Menu\FactoryInterface $factory)
{
}
public function getName()
{
}
public function setName($name)
{
}
public function getUri()
{
}
public function setUri($uri)
{
}
public function getLabel()
{
}
public function setLabel($label)
{
}
public function getAttributes()
{
}
public function setAttributes(array $attributes)
{
}
public function getAttribute($name, $default = null)
{
}
public function setAttribute($name, $value)
{
}
public function getLinkAttributes()
{
}
public function setLinkAttributes(array $linkAttributes)
{
}
public function getLinkAttribute($name, $default = null)
{
}
public function setLinkAttribute($name, $value)
{
}
public function getChildrenAttributes()
{
}
public function setChildrenAttributes(array $childrenAttributes)
{
}
public function getChildrenAttribute($name, $default = null)
{
}
public function setChildrenAttribute($name, $value)
{
}
public function getLabelAttributes()
{
}
public function setLabelAttributes(array $labelAttributes)
{
}
public function getLabelAttribute($name, $default = null)
{
}
public function setLabelAttribute($name, $value)
{
}
public function getExtras()
{
}
public function setExtras(array $extras)
{
}
public function getExtra($name, $default = null)
{
}
public function setExtra($name, $value)
{
}
public function getDisplayChildren()
{
}
public function setDisplayChildren($bool)
{
}
public function isDisplayed()
{
}
public function setDisplay($bool)
{
}
public function addChild($child, array $options = array())
{
}
public function getChild($name)
{
}
public function reorderChildren($order)
{
}
public function copy()
{
}
public function getLevel()
{
}
public function getRoot()
{
}
public function isRoot()
{
}
public function getParent()
{
}
public function setParent(\Knp\Menu\ItemInterface $parent = null)
{
}
public function getChildren()
{
}
public function setChildren(array $children)
{
}
public function removeChild($name)
{
}
public function getFirstChild()
{
}
public function getLastChild()
{
}
public function hasChildren()
{
}
public function setCurrent($bool)
{
}
public function isCurrent()
{
}
public function isLast()
{
}
public function isFirst()
{
}
public function actsLikeFirst()
{
}
public function actsLikeLast()
{
}
/**
* Implements Countable
*/
public function count()
{
}
/**
* Implements IteratorAggregate
*/
public function getIterator()
{
}
/**
* Implements ArrayAccess
*/
public function offsetExists($name)
{
}
/**
* Implements ArrayAccess
*/
public function offsetGet($name)
{
}
/**
* Implements ArrayAccess
*/
public function offsetSet($name, $value)
{
}
/**
* Implements ArrayAccess
*/
public function offsetUnset($name)
{
}
}
}
namespace Knp\Menu\Loader {
interface LoaderInterface
{
/**
* Loads the data into a menu item
*
* @param mixed $data
*
* @return ItemInterface
*/
public function load($data);
/**
* Checks whether the loader can load these data
*
* @param mixed $data
*
* @return boolean
*/
public function supports($data);
}
/**
* Loader importing a menu tree from an array.
*
* The array should match the output of MenuManipulator::toArray
*/
class ArrayLoader implements \Knp\Menu\Loader\LoaderInterface
{
public function __construct(\Knp\Menu\FactoryInterface $factory)
{
}
public function load($data)
{
}
public function supports($data)
{
}
}
class NodeLoader implements \Knp\Menu\Loader\LoaderInterface
{
public function __construct(\Knp\Menu\FactoryInterface $factory)
{
}
public function load($data)
{
}
public function supports($data)
{
}
}
}
namespace Knp\Menu {
/**
* Interface implemented by the factory to create items
*/
interface FactoryInterface
{
/**
* Creates a menu item
*
* @param string $name
* @param array $options
*
* @return ItemInterface
*/
public function createItem($name, array $options = array());
}
/**
* Factory to create a menu from a tree
*/
class MenuFactory implements \Knp\Menu\FactoryInterface
{
public function __construct()
{
}
public function createItem($name, array $options = array())
{
}
/**
* Adds a factory extension
*
* @param ExtensionInterface $extension
* @param integer $priority
*/
public function addExtension(\Knp\Menu\Factory\ExtensionInterface $extension, $priority = 0)
{
}
}
}
namespace Knp\Menu\Iterator {
/**
* Filter iterator keeping only current items
*/
class DisplayedItemFilterIterator extends \RecursiveFilterIterator
{
public function accept()
{
}
public function hasChildren()
{
}
}
/**
* Filter iterator keeping only current items
*/
class CurrentItemFilterIterator extends \FilterIterator
{
public function __construct(\Iterator $iterator, \Knp\Menu\Matcher\MatcherInterface $matcher)
{
}
public function accept()
{
}
}
/**
* Recursive iterator iterating on an item
*/
class RecursiveItemIterator extends \IteratorIterator implements \RecursiveIterator
{
public function hasChildren()
{
}
public function getChildren()
{
}
}
}
namespace Knp\Menu\Renderer {
abstract class Renderer
{
protected $charset = 'UTF-8';
/**
* @param string $charset
*/
public function __construct($charset = null)
{
}
/**
* Renders a HTML attribute
*
* @param string $name
* @param string $value
*
* @return string
*/
protected function renderHtmlAttribute($name, $value)
{
}
/**
* Renders HTML attributes
*
* @param array $attributes
*
* @return string
*/
protected function renderHtmlAttributes(array $attributes)
{
}
/**
* Escapes an HTML value
*
* @param string $value
*
* @return string
*/
protected function escape($value)
{
}
/**
* Fixes double escaped strings.
*
* @param string $escaped string to fix
*
* @return string A single escaped string
*/
protected function fixDoubleEscape($escaped)
{
}
/**
* Get the HTML charset
*
* @return string
*/
public function getCharset()
{
}
/**
* Set the HTML charset
*
* @param string $charset
*/
public function setCharset($charset)
{
}
}
interface RendererProviderInterface
{
/**
* Retrieves a renderer by its name
*
* If null is given, a renderer marked as default is returned.
*
* @param string $name
*
* @return RendererInterface
* @throws \InvalidArgumentException if the renderer does not exists
*/
public function get($name = null);
/**
* Checks whether a renderer exists
*
* @param string $name
*
* @return boolean
*/
public function has($name);
}
interface RendererInterface
{
/**
* Renders menu tree.
*
* Common options:
* - depth: The depth at which the item is rendered
* null: no limit
* 0: no children
* 1: only direct children
* - currentAsLink: whether the current item should be a link
* - currentClass: class added to the current item
* - ancestorClass: class added to the ancestors of the current item
* - firstClass: class added to the first child
* - lastClass: class added to the last child
*
* @param ItemInterface $item Menu item
* @param array $options some rendering options
*
* @return string
*/
public function render(\Knp\Menu\ItemInterface $item, array $options = array());
}
/**
* Renders MenuItem tree as unordered list
*/
class ListRenderer extends \Knp\Menu\Renderer\Renderer implements \Knp\Menu\Renderer\RendererInterface
{
protected $matcher;
protected $defaultOptions;
/**
* @param MatcherInterface $matcher
* @param array $defaultOptions
* @param string $charset
*/
public function __construct(\Knp\Menu\Matcher\MatcherInterface $matcher, array $defaultOptions = array(), $charset = null)
{
}
public function render(\Knp\Menu\ItemInterface $item, array $options = array())
{
}
protected function renderList(\Knp\Menu\ItemInterface $item, array $attributes, array $options)
{
}
/**
* Renders all of the children of this menu.
*
* This calls ->renderItem() on each menu item, which instructs each
* menu item to render themselves as an <li> tag (with nested ul if it
* has children).
* This method updates the depth for the children.
*
* @param ItemInterface $item
* @param array $options The options to render the item.
*
* @return string
*/
protected function renderChildren(\Knp\Menu\ItemInterface $item, array $options)
{
}
/**
* Called by the parent menu item to render this menu.
*
* This renders the li tag to fit into the parent ul as well as its
* own nested ul tag if this menu item has children
*
* @param ItemInterface $item
* @param array $options The options to render the item
*
* @return string
*/
protected function renderItem(\Knp\Menu\ItemInterface $item, array $options)
{
}
/**
* Renders the link in a a tag with link attributes or
* the label in a span tag with label attributes
*
* Tests if item has a an uri and if not tests if it's
* the current item and if the text has to be rendered
* as a link or not.
*
* @param ItemInterface $item The item to render the link or label for
* @param array $options The options to render the item
*
* @return string
*/
protected function renderLink(\Knp\Menu\ItemInterface $item, array $options = array())
{
}
protected function renderLinkElement(\Knp\Menu\ItemInterface $item, array $options)
{
}
protected function renderSpanElement(\Knp\Menu\ItemInterface $item, array $options)
{
}
protected function renderLabel(\Knp\Menu\ItemInterface $item, array $options)
{
}
/**
* If $this->renderCompressed is on, this will apply the necessary
* spacing and line-breaking so that the particular thing being rendered
* makes up its part in a fully-rendered and spaced menu.
*
* @param string $html The html to render in an (un)formatted way
* @param string $type The type [ul,link,li] of thing being rendered
* @param integer $level
* @param array $options
*
* @return string
*/
protected function format($html, $type, $level, array $options)
{
}
}
/**
* A renderer provider getting the renderers from a class implementing ArrayAccess.
*/
class ArrayAccessProvider implements \Knp\Menu\Renderer\RendererProviderInterface
{
/**
* @param \ArrayAccess $registry
* @param string $defaultRenderer The name of the renderer used by default
* @param array $rendererIds The map between renderer names and regstry keys
*/
public function __construct(\ArrayAccess $registry, $defaultRenderer, array $rendererIds)
{
}
public function get($name = null)
{
}
public function has($name)
{
}
}
/**
* Renderer provider getting renderers from a Pimple 1 container
*
* @deprecated use the ArrayAccessProvider instead.
*/
class PimpleProvider extends \Knp\Menu\Renderer\ArrayAccessProvider
{
public function __construct(\Pimple $pimple, $defaultRenderer, array $rendererIds)
{
}
}
class TwigRenderer implements \Knp\Menu\Renderer\RendererInterface
{
/**
* @param \Twig_Environment $environment
* @param string $template
* @param MatcherInterface $matcher
* @param array $defaultOptions
*/
public function __construct(\Twig_Environment $environment, $template, \Knp\Menu\Matcher\MatcherInterface $matcher, array $defaultOptions = array())
{
}
public function render(\Knp\Menu\ItemInterface $item, array $options = array())
{
}
}
}
namespace Knp\Menu\Twig {
class MenuExtension extends \Twig_Extension
{
/**
* @param Helper $helper
*/
public function __construct(\Knp\Menu\Twig\Helper $helper, \Knp\Menu\Matcher\MatcherInterface $matcher = null, \Knp\Menu\Util\MenuManipulator $menuManipulator = null)
{
}
public function getFunctions()
{
}
public function getFilters()
{
}
public function getTests()
{
}
/**
* Retrieves an item following a path in the tree.
*
* @param ItemInterface|string $menu
* @param array $path
* @param array $options
*
* @return ItemInterface
*/
public function get($menu, array $path = array(), array $options = array())
{
}
/**
* Renders a menu with the specified renderer.
*
* @param ItemInterface|string|array $menu
* @param array $options
* @param string $renderer
*
* @return string
*/
public function render($menu, array $options = array(), $renderer = null)
{
}
/**
* Returns an array ready to be used for breadcrumbs.
*
* @param ItemInterface|array|string $item
* @param string|array|null $subItem
*
* @return array
*/
public function getBreadcrumbsArray($menu, $subItem = null)
{
}
/**
* A string representation of this menu item
*
* e.g. Top Level > Second Level > This menu
*
* @param ItemInterface $item
* @param string $separator
*
* @return string
*/
public function pathAsString(\Knp\Menu\ItemInterface $menu, $separator = ' > ')
{
}
/**
* Checks whether an item is current.
*
* @param ItemInterface $item
*
* @return boolean
*/
public function isCurrent(\Knp\Menu\ItemInterface $item)
{
}
/**
* Checks whether an item is the ancestor of a current item.
*
* @param ItemInterface $item
* @param integer $depth The max depth to look for the item
*
* @return boolean
*/
public function isAncestor(\Knp\Menu\ItemInterface $item, $depth = null)
{
}
/**
* @return string
*/
public function getName()
{
}
}
/**
* Helper class containing logic to retrieve and render menus from templating engines
*
*/
class Helper
{
/**
* @param RendererProviderInterface $rendererProvider
* @param MenuProviderInterface|null $menuProvider
*/
public function __construct(\Knp\Menu\Renderer\RendererProviderInterface $rendererProvider, \Knp\Menu\Provider\MenuProviderInterface $menuProvider = null, \Knp\Menu\Util\MenuManipulator $menuManipulator = null)
{
}
/**
* Retrieves item in the menu, eventually using the menu provider.
*
* @param ItemInterface|string $menu
* @param array $path
* @param array $options
*
* @return ItemInterface
*
* @throws \BadMethodCallException when there is no menu provider and the menu is given by name
* @throws \LogicException
* @throws \InvalidArgumentException when the path is invalid
*/
public function get($menu, array $path = array(), array $options = array())
{
}
/**
* Renders a menu with the specified renderer.
*
* If the argument is an array, it will follow the path in the tree to
* get the needed item. The first element of the array is the whole menu.
* If the menu is a string instead of an ItemInterface, the provider
* will be used.
*
* @param ItemInterface|string|array $menu
* @param array $options
* @param string $renderer
*
* @return string
*
* @throws \InvalidArgumentException
*/
public function render($menu, array $options = array(), $renderer = null)
{
}
/**
* Renders an array ready to be used for breadcrumbs.
*
* Each element in the array will be an array with 3 keys:
* - `label` containing the label of the item
* - `url` containing the url of the item (may be `null`)
* - `item` containing the original item (may be `null` for the extra items)
*
* The subItem can be one of the following forms
* * 'subItem'
* * ItemInterface object
* * array('subItem' => '@homepage')
* * array('subItem1', 'subItem2')
* * array(array('label' => 'subItem1', 'url' => '@homepage'), array('label' => 'subItem2'))
*
* @param mixed $item
* @param mixed $subItem A string or array to append onto the end of the array
*
* @return array
*/
public function getBreadcrumbsArray($menu, $subItem = null)
{
}
}
}
namespace Doctrine\Instantiator {
/**
* Instantiator provides utility methods to build objects without invoking their constructors
*
* @author Marco Pivetta <ocramius@gmail.com>
*/
interface InstantiatorInterface
{
/**
* @param string $className
*
* @return object
*
* @throws \Doctrine\Instantiator\Exception\ExceptionInterface
*/
public function instantiate($className);
}
/**
* {@inheritDoc}
*
* @author Marco Pivetta <ocramius@gmail.com>
*/
final class Instantiator implements \Doctrine\Instantiator\InstantiatorInterface
{
/**
* Markers used internally by PHP to define whether {@see \unserialize} should invoke
* the method {@see \Serializable::unserialize()} when dealing with classes implementing
* the {@see \Serializable} interface.
*/
const SERIALIZATION_FORMAT_USE_UNSERIALIZER = 'C';
const SERIALIZATION_FORMAT_AVOID_UNSERIALIZER = 'O';
/**
* {@inheritDoc}
*/
public function instantiate($className)
{
}
}
}
namespace Doctrine\Instantiator\Exception {
/**
* Base exception marker interface for the instantiator component
*
* @author Marco Pivetta <ocramius@gmail.com>
*/
interface ExceptionInterface
{
}
/**
* Exception for given parameters causing invalid/unexpected state on instantiation
*
* @author Marco Pivetta <ocramius@gmail.com>
*/
class UnexpectedValueException extends \UnexpectedValueException implements \Doctrine\Instantiator\Exception\ExceptionInterface
{
/**
* @param ReflectionClass $reflectionClass
* @param Exception $exception
*
* @return self
*/
public static function fromSerializationTriggeredException(\ReflectionClass $reflectionClass, \Exception $exception)
{
}
/**
* @param ReflectionClass $reflectionClass
* @param string $errorString
* @param int $errorCode
* @param string $errorFile
* @param int $errorLine
*
* @return UnexpectedValueException
*/
public static function fromUncleanUnSerialization(\ReflectionClass $reflectionClass, $errorString, $errorCode, $errorFile, $errorLine)
{
}
}
/**
* Exception for invalid arguments provided to the instantiator
*
* @author Marco Pivetta <ocramius@gmail.com>
*/
class InvalidArgumentException extends \InvalidArgumentException implements \Doctrine\Instantiator\Exception\ExceptionInterface
{
/**
* @param string $className
*
* @return self
*/
public static function fromNonExistingClass($className)
{
}
/**
* @param ReflectionClass $reflectionClass
*
* @return self
*/
public static function fromAbstractClass(\ReflectionClass $reflectionClass)
{
}
}
}
namespace Doctrine\Common\Inflector {
/**
* Doctrine inflector has static methods for inflecting text.
*
* The methods in these classes are from several different sources collected
* across several different php projects and several different authors. The
* original author names and emails are not known.
*
* Pluralize & Singularize implementation are borrowed from CakePHP with some modifications.
*
* @link www.doctrine-project.org
* @since 1.0
* @author Konsta Vesterinen <kvesteri@cc.hut.fi>
* @author Jonathan H. Wage <jonwage@gmail.com>
*/
class Inflector
{
/**
* Converts a word into the format for a Doctrine table name. Converts 'ModelName' to 'model_name'.
*
* @param string $word The word to tableize.
*
* @return string The tableized word.
*/
public static function tableize($word)
{
}
/**
* Converts a word into the format for a Doctrine class name. Converts 'table_name' to 'TableName'.
*
* @param string $word The word to classify.
*
* @return string The classified word.
*/
public static function classify($word)
{
}
/**
* Camelizes a word. This uses the classify() method and turns the first character to lowercase.
*
* @param string $word The word to camelize.
*
* @return string The camelized word.
*/
public static function camelize($word)
{
}
/**
* Uppercases words with configurable delimeters between words.
*
* Takes a string and capitalizes all of the words, like PHP's built-in
* ucwords function. This extends that behavior, however, by allowing the
* word delimeters to be configured, rather than only separating on
* whitespace.
*
* Here is an example:
* <code>
* <?php
* $string = 'top-o-the-morning to all_of_you!';
* echo \Doctrine\Common\Inflector\Inflector::ucwords($string);
* // Top-O-The-Morning To All_of_you!
*
* echo \Doctrine\Common\Inflector\Inflector::ucwords($string, '-_ ');
* // Top-O-The-Morning To All_Of_You!
* ?>
* </code>
*
* @param string $string The string to operate on.
* @param string $delimiters A list of word separators.
*
* @return string The string with all delimeter-separated words capitalized.
*/
public static function ucwords($string, $delimiters = " \n\t\r\x00\v-")
{
}
/**
* Clears Inflectors inflected value caches, and resets the inflection
* rules to the initial values.
*
* @return void
*/
public static function reset()
{
}
/**
* Adds custom inflection $rules, of either 'plural' or 'singular' $type.
*
* ### Usage:
*
* {{{
* Inflector::rules('plural', array('/^(inflect)or$/i' => '\1ables'));
* Inflector::rules('plural', array(
* 'rules' => array('/^(inflect)ors$/i' => '\1ables'),
* 'uninflected' => array('dontinflectme'),
* 'irregular' => array('red' => 'redlings')
* ));
* }}}
*
* @param string $type The type of inflection, either 'plural' or 'singular'
* @param array $rules An array of rules to be added.
* @param boolean $reset If true, will unset default inflections for all
* new rules that are being defined in $rules.
*
* @return void
*/
public static function rules($type, $rules, $reset = false)
{
}
/**
* Returns a word in plural form.
*
* @param string $word The word in singular form.
*
* @return string The word in plural form.
*/
public static function pluralize($word)
{
}
/**
* Returns a word in singular form.
*
* @param string $word The word in plural form.
*
* @return string The word in singular form.
*/
public static function singularize($word)
{
}
}
}
namespace Doctrine\Common\Lexer {
/**
* Base class for writing simple lexers, i.e. for creating small DSLs.
*
* @since 2.0
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
*/
abstract class AbstractLexer
{
/**
* The next token in the input.
*
* @var array
*/
public $lookahead;
/**
* The last matched/seen token.
*
* @var array
*/
public $token;
/**
* Sets the input data to be tokenized.
*
* The Lexer is immediately reset and the new input tokenized.
* Any unprocessed tokens from any previous input are lost.
*
* @param string $input The input to be tokenized.
*
* @return void
*/
public function setInput($input)
{
}
/**
* Resets the lexer.
*
* @return void
*/
public function reset()
{
}
/**
* Resets the peek pointer to 0.
*
* @return void
*/
public function resetPeek()
{
}
/**
* Resets the lexer position on the input to the given position.
*
* @param integer $position Position to place the lexical scanner.
*
* @return void
*/
public function resetPosition($position = 0)
{
}
/**
* Retrieve the original lexer's input until a given position.
*
* @param integer $position
*
* @return string
*/
public function getInputUntilPosition($position)
{
}
/**
* Checks whether a given token matches the current lookahead.
*
* @param integer|string $token
*
* @return boolean
*/
public function isNextToken($token)
{
}
/**
* Checks whether any of the given tokens matches the current lookahead.
*
* @param array $tokens
*
* @return boolean
*/
public function isNextTokenAny(array $tokens)
{
}
/**
* Moves to the next token in the input string.
*
* @return boolean
*/
public function moveNext()
{
}
/**
* Tells the lexer to skip input tokens until it sees a token with the given value.
*
* @param string $type The token type to skip until.
*
* @return void
*/
public function skipUntil($type)
{
}
/**
* Checks if given value is identical to the given token.
*
* @param mixed $value
* @param integer $token
*
* @return boolean
*/
public function isA($value, $token)
{
}
/**
* Moves the lookahead token forward.
*
* @return array|null The next token or NULL if there are no more tokens ahead.
*/
public function peek()
{
}
/**
* Peeks at the next token, returns it and immediately resets the peek.
*
* @return array|null The next token or NULL if there are no more tokens ahead.
*/
public function glimpse()
{
}
/**
* Scans the input string for tokens.
*
* @param string $input A query string.
*
* @return void
*/
protected function scan($input)
{
}
/**
* Gets the literal for a given token.
*
* @param integer $token
*
* @return string
*/
public function getLiteral($token)
{
}
/**
* Regex modifiers
*
* @return string
*/
protected function getModifiers()
{
}
/**
* Lexical catchable patterns.
*
* @return array
*/
protected abstract function getCatchablePatterns();
/**
* Lexical non-catchable patterns.
*
* @return array
*/
protected abstract function getNonCatchablePatterns();
/**
* Retrieve token type. Also processes the token value if necessary.
*
* @param string $value
*
* @return integer
*/
protected abstract function getType(&$value);
}
}
namespace Doctrine\Common\Annotations {
/**
* Parses a file for namespaces/use/class declarations.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Christian Kaps <christian.kaps@mohiva.com>
*/
class TokenParser
{
/**
* @param string $contents
*/
public function __construct($contents)
{
}
/**
* Gets the next non whitespace and non comment token.
*
* @param boolean $docCommentIsComment If TRUE then a doc comment is considered a comment and skipped.
* If FALSE then only whitespace and normal comments are skipped.
*
* @return array|null The token if exists, null otherwise.
*/
public function next($docCommentIsComment = TRUE)
{
}
/**
* Parses a single use statement.
*
* @return array A list with all found class names for a use statement.
*/
public function parseUseStatement()
{
}
/**
* Gets all use statements.
*
* @param string $namespaceName The namespace name of the reflected class.
*
* @return array A list with all found use statements.
*/
public function parseUseStatements($namespaceName)
{
}
/**
* Gets the namespace.
*
* @return string The found namespace.
*/
public function parseNamespace()
{
}
/**
* Gets the class name.
*
* @return string The found class name.
*/
public function parseClass()
{
}
}
/**
* Interface for annotation readers.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface Reader
{
/**
* Gets the annotations applied to a class.
*
* @param \ReflectionClass $class The ReflectionClass of the class from which
* the class annotations should be read.
*
* @return array An array of Annotations.
*/
function getClassAnnotations(\ReflectionClass $class);
/**
* Gets a class annotation.
*
* @param \ReflectionClass $class The ReflectionClass of the class from which
* the class annotations should be read.
* @param string $annotationName The name of the annotation.
*
* @return object|null The Annotation or NULL, if the requested annotation does not exist.
*/
function getClassAnnotation(\ReflectionClass $class, $annotationName);
/**
* Gets the annotations applied to a method.
*
* @param \ReflectionMethod $method The ReflectionMethod of the method from which
* the annotations should be read.
*
* @return array An array of Annotations.
*/
function getMethodAnnotations(\ReflectionMethod $method);
/**
* Gets a method annotation.
*
* @param \ReflectionMethod $method The ReflectionMethod to read the annotations from.
* @param string $annotationName The name of the annotation.
*
* @return object|null The Annotation or NULL, if the requested annotation does not exist.
*/
function getMethodAnnotation(\ReflectionMethod $method, $annotationName);
/**
* Gets the annotations applied to a property.
*
* @param \ReflectionProperty $property The ReflectionProperty of the property
* from which the annotations should be read.
*
* @return array An array of Annotations.
*/
function getPropertyAnnotations(\ReflectionProperty $property);
/**
* Gets a property annotation.
*
* @param \ReflectionProperty $property The ReflectionProperty to read the annotations from.
* @param string $annotationName The name of the annotation.
*
* @return object|null The Annotation or NULL, if the requested annotation does not exist.
*/
function getPropertyAnnotation(\ReflectionProperty $property, $annotationName);
}
/**
* File cache reader for annotations.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
* @author Benjamin Eberlei <kontakt@beberlei.de>
*
* @deprecated the FileCacheReader is deprecated and will be removed
* in version 2.0.0 of doctrine/annotations. Please use the
* {@see \Doctrine\Common\Annotations\CachedReader} instead.
*/
class FileCacheReader implements \Doctrine\Common\Annotations\Reader
{
/**
* Constructor.
*
* @param Reader $reader
* @param string $cacheDir
* @param boolean $debug
*
* @throws \InvalidArgumentException
*/
public function __construct(\Doctrine\Common\Annotations\Reader $reader, $cacheDir, $debug = false, $umask = 02)
{
}
/**
* {@inheritDoc}
*/
public function getClassAnnotations(\ReflectionClass $class)
{
}
/**
* {@inheritDoc}
*/
public function getPropertyAnnotations(\ReflectionProperty $property)
{
}
/**
* {@inheritDoc}
*/
public function getMethodAnnotations(\ReflectionMethod $method)
{
}
/**
* {@inheritDoc}
*/
public function getClassAnnotation(\ReflectionClass $class, $annotationName)
{
}
/**
* {@inheritDoc}
*/
public function getMethodAnnotation(\ReflectionMethod $method, $annotationName)
{
}
/**
* {@inheritDoc}
*/
public function getPropertyAnnotation(\ReflectionProperty $property, $annotationName)
{
}
/**
* Clears loaded annotations.
*
* @return void
*/
public function clearLoadedAnnotations()
{
}
}
/**
* A cache aware annotation reader.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
* @author Benjamin Eberlei <kontakt@beberlei.de>
*/
final class CachedReader implements \Doctrine\Common\Annotations\Reader
{
/**
* Constructor.
*
* @param Reader $reader
* @param Cache $cache
* @param bool $debug
*/
public function __construct(\Doctrine\Common\Annotations\Reader $reader, \Doctrine\Common\Cache\Cache $cache, $debug = false)
{
}
/**
* {@inheritDoc}
*/
public function getClassAnnotations(\ReflectionClass $class)
{
}
/**
* {@inheritDoc}
*/
public function getClassAnnotation(\ReflectionClass $class, $annotationName)
{
}
/**
* {@inheritDoc}
*/
public function getPropertyAnnotations(\ReflectionProperty $property)
{
}
/**
* {@inheritDoc}
*/
public function getPropertyAnnotation(\ReflectionProperty $property, $annotationName)
{
}
/**
* {@inheritDoc}
*/
public function getMethodAnnotations(\ReflectionMethod $method)
{
}
/**
* {@inheritDoc}
*/
public function getMethodAnnotation(\ReflectionMethod $method, $annotationName)
{
}
/**
* Clears loaded annotations.
*
* @return void
*/
public function clearLoadedAnnotations()
{
}
}
/**
* A reader for docblock annotations.
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class AnnotationReader implements \Doctrine\Common\Annotations\Reader
{
/**
* Add a new annotation to the globally ignored annotation names with regard to exception handling.
*
* @param string $name
*/
public static function addGlobalIgnoredName($name)
{
}
/**
* Add a new annotation to the globally ignored annotation namespaces with regard to exception handling.
*
* @param string $namespace
*/
public static function addGlobalIgnoredNamespace($namespace)
{
}
/**
* Constructor.
*
* Initializes a new AnnotationReader.
*
* @param DocParser $parser
*/
public function __construct(\Doctrine\Common\Annotations\DocParser $parser = null)
{
}
/**
* {@inheritDoc}
*/
public function getClassAnnotations(\ReflectionClass $class)
{
}
/**
* {@inheritDoc}
*/
public function getClassAnnotation(\ReflectionClass $class, $annotationName)
{
}
/**
* {@inheritDoc}
*/
public function getPropertyAnnotations(\ReflectionProperty $property)
{
}
/**
* {@inheritDoc}
*/
public function getPropertyAnnotation(\ReflectionProperty $property, $annotationName)
{
}
/**
* {@inheritDoc}
*/
public function getMethodAnnotations(\ReflectionMethod $method)
{
}
/**
* {@inheritDoc}
*/
public function getMethodAnnotation(\ReflectionMethod $method, $annotationName)
{
}
}
/**
* Simple Annotation Reader.
*
* This annotation reader is intended to be used in projects where you have
* full-control over all annotations that are available.
*
* @since 2.2
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
* @author Fabio B. Silva <fabio.bat.silva@gmail.com>
*/
class SimpleAnnotationReader implements \Doctrine\Common\Annotations\Reader
{
/**
* Constructor.
*
* Initializes a new SimpleAnnotationReader.
*/
public function __construct()
{
}
/**
* Adds a namespace in which we will look for annotations.
*
* @param string $namespace
*
* @return void
*/
public function addNamespace($namespace)
{
}
/**
* {@inheritDoc}
*/
public function getClassAnnotations(\ReflectionClass $class)
{
}
/**
* {@inheritDoc}
*/
public function getMethodAnnotations(\ReflectionMethod $method)
{
}
/**
* {@inheritDoc}
*/
public function getPropertyAnnotations(\ReflectionProperty $property)
{
}
/**
* {@inheritDoc}
*/
public function getClassAnnotation(\ReflectionClass $class, $annotationName)
{
}
/**
* {@inheritDoc}
*/
public function getMethodAnnotation(\ReflectionMethod $method, $annotationName)
{
}
/**
* {@inheritDoc}
*/
public function getPropertyAnnotation(\ReflectionProperty $property, $annotationName)
{
}
}
/**
* AnnotationRegistry.
*/
final class AnnotationRegistry
{
/**
* @return void
*/
public static function reset()
{
}
/**
* Registers file.
*
* @param string $file
*
* @return void
*/
public static function registerFile($file)
{
}
/**
* Adds a namespace with one or many directories to look for files or null for the include path.
*
* Loading of this namespaces will be done with a PSR-0 namespace loading algorithm.
*
* @param string $namespace
* @param string|array|null $dirs
*
* @return void
*/
public static function registerAutoloadNamespace($namespace, $dirs = null)
{
}
/**
* Registers multiple namespaces.
*
* Loading of this namespaces will be done with a PSR-0 namespace loading algorithm.
*
* @param array $namespaces
*
* @return void
*/
public static function registerAutoloadNamespaces(array $namespaces)
{
}
/**
* Registers an autoloading callable for annotations, much like spl_autoload_register().
*
* NOTE: These class loaders HAVE to be silent when a class was not found!
* IMPORTANT: Loaders have to return true if they loaded a class that could contain the searched annotation class.
*
* @param callable $callable
*
* @return void
*
* @throws \InvalidArgumentException
*/
public static function registerLoader($callable)
{
}
/**
* Autoloads an annotation class silently.
*
* @param string $class
*
* @return boolean
*/
public static function loadAnnotationClass($class)
{
}
}
/**
* Description of AnnotationException
*
* @since 2.0
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
*/
class AnnotationException extends \Exception
{
/**
* Creates a new AnnotationException describing a Syntax error.
*
* @param string $message Exception message
*
* @return AnnotationException
*/
public static function syntaxError($message)
{
}
/**
* Creates a new AnnotationException describing a Semantical error.
*
* @param string $message Exception message
*
* @return AnnotationException
*/
public static function semanticalError($message)
{
}
/**
* Creates a new AnnotationException describing an error which occurred during
* the creation of the annotation.
*
* @since 2.2
*
* @param string $message
*
* @return AnnotationException
*/
public static function creationError($message)
{
}
/**
* Creates a new AnnotationException describing a type error.
*
* @since 1.1
*
* @param string $message
*
* @return AnnotationException
*/
public static function typeError($message)
{
}
/**
* Creates a new AnnotationException describing a constant semantical error.
*
* @since 2.3
*
* @param string $identifier
* @param string $context
*
* @return AnnotationException
*/
public static function semanticalErrorConstants($identifier, $context = null)
{
}
/**
* Creates a new AnnotationException describing an type error of an attribute.
*
* @since 2.2
*
* @param string $attributeName
* @param string $annotationName
* @param string $context
* @param string $expected
* @param mixed $actual
*
* @return AnnotationException
*/
public static function attributeTypeError($attributeName, $annotationName, $context, $expected, $actual)
{
}
/**
* Creates a new AnnotationException describing an required error of an attribute.
*
* @since 2.2
*
* @param string $attributeName
* @param string $annotationName
* @param string $context
* @param string $expected
*
* @return AnnotationException
*/
public static function requiredError($attributeName, $annotationName, $context, $expected)
{
}
/**
* Creates a new AnnotationException describing a invalid enummerator.
*
* @since 2.4
*
* @param string $attributeName
* @param string $annotationName
* @param string $context
* @param array $available
* @param mixed $given
*
* @return AnnotationException
*/
public static function enumeratorError($attributeName, $annotationName, $context, $available, $given)
{
}
/**
* @return AnnotationException
*/
public static function optimizerPlusSaveComments()
{
}
/**
* @return AnnotationException
*/
public static function optimizerPlusLoadComments()
{
}
}
}
namespace Doctrine\Common\Annotations\Annotation {
/**
* Annotation that can be used to signal to the parser
* to check the attribute type during the parsing process.
*
* @author Fabio B. Silva <fabio.bat.silva@gmail.com>
*
* @Annotation
*/
final class Attribute
{
/**
* @var string
*/
public $name;
/**
* @var string
*/
public $type;
/**
* @var boolean
*/
public $required = false;
}
/**
* Annotation that can be used to signal to the parser
* to check if that attribute is required during the parsing process.
*
* @author Fabio B. Silva <fabio.bat.silva@gmail.com>
*
* @Annotation
*/
final class Required
{
}
/**
* Annotation that can be used to signal to the parser
* to check the types of all declared attributes during the parsing process.
*
* @author Fabio B. Silva <fabio.bat.silva@gmail.com>
*
* @Annotation
*/
final class Attributes
{
/**
* @var array<Doctrine\Common\Annotations\Annotation\Attribute>
*/
public $value;
}
/**
* Annotation that can be used to signal to the parser
* to check the annotation target during the parsing process.
*
* @author Fabio B. Silva <fabio.bat.silva@gmail.com>
*
* @Annotation
*/
final class Target
{
const TARGET_CLASS = 1;
const TARGET_METHOD = 2;
const TARGET_PROPERTY = 4;
const TARGET_ANNOTATION = 8;
const TARGET_ALL = 15;
/**
* @var array
*/
public $value;
/**
* Targets as bitmask.
*
* @var integer
*/
public $targets;
/**
* Literal target declaration.
*
* @var integer
*/
public $literal;
/**
* Annotation constructor.
*
* @param array $values
*
* @throws \InvalidArgumentException
*/
public function __construct(array $values)
{
}
}
/**
* Annotation that can be used to signal to the parser
* to check the available values during the parsing process.
*
* @since 2.4
* @author Fabio B. Silva <fabio.bat.silva@gmail.com>
*
* @Annotation
* @Attributes({
* @Attribute("value", required = true, type = "array"),
* @Attribute("literal", required = false, type = "array")
* })
*/
final class Enum
{
/**
* @var array
*/
public $value;
/**
* Literal target declaration.
*
* @var array
*/
public $literal;
/**
* Annotation constructor.
*
* @param array $values
*
* @throws \InvalidArgumentException
*/
public function __construct(array $values)
{
}
}
/**
* Annotation that can be used to signal to the parser to ignore specific
* annotations during the parsing process.
*
* @Annotation
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
final class IgnoreAnnotation
{
/**
* @var array
*/
public $names;
/**
* Constructor.
*
* @param array $values
*
* @throws \RuntimeException
*/
public function __construct(array $values)
{
}
}
}
namespace Doctrine\Common\Annotations {
/**
* Annotations class.
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
*/
class Annotation
{
/**
* Value property. Common among all derived classes.
*
* @var string
*/
public $value;
/**
* Constructor.
*
* @param array $data Key-value for properties to be defined in this class.
*/
public final function __construct(array $data)
{
}
/**
* Error handler for unknown property accessor in Annotation class.
*
* @param string $name Unknown property name.
*
* @throws \BadMethodCallException
*/
public function __get($name)
{
}
/**
* Error handler for unknown property mutator in Annotation class.
*
* @param string $name Unknown property name.
* @param mixed $value Property value.
*
* @throws \BadMethodCallException
*/
public function __set($name, $value)
{
}
}
/**
* Simple lexer for docblock annotations.
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
final class DocLexer extends \Doctrine\Common\Lexer\AbstractLexer
{
const T_NONE = 1;
const T_INTEGER = 2;
const T_STRING = 3;
const T_FLOAT = 4;
// All tokens that are also identifiers should be >= 100
const T_IDENTIFIER = 100;
const T_AT = 101;
const T_CLOSE_CURLY_BRACES = 102;
const T_CLOSE_PARENTHESIS = 103;
const T_COMMA = 104;
const T_EQUALS = 105;
const T_FALSE = 106;
const T_NAMESPACE_SEPARATOR = 107;
const T_OPEN_CURLY_BRACES = 108;
const T_OPEN_PARENTHESIS = 109;
const T_TRUE = 110;
const T_NULL = 111;
const T_COLON = 112;
}
/**
* A parser for docblock annotations.
*
* It is strongly discouraged to change the default annotation parsing process.
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
* @author Fabio B. Silva <fabio.bat.silva@gmail.com>
*/
final class DocParser
{
/**
* Constructs a new DocParser.
*/
public function __construct()
{
}
/**
* Sets the annotation names that are ignored during the parsing process.
*
* The names are supposed to be the raw names as used in the class, not the
* fully qualified class names.
*
* @param bool[] $names indexed by annotation name
*
* @return void
*/
public function setIgnoredAnnotationNames(array $names)
{
}
/**
* Sets the annotation namespaces that are ignored during the parsing process.
*
* @param bool[] $ignoredAnnotationNamespaces indexed by annotation namespace name
*
* @return void
*/
public function setIgnoredAnnotationNamespaces($ignoredAnnotationNamespaces)
{
}
/**
* Sets ignore on not-imported annotations.
*
* @param boolean $bool
*
* @return void
*/
public function setIgnoreNotImportedAnnotations($bool)
{
}
/**
* Sets the default namespaces.
*
* @param string $namespace
*
* @return void
*
* @throws \RuntimeException
*/
public function addNamespace($namespace)
{
}
/**
* Sets the imports.
*
* @param array $imports
*
* @return void
*
* @throws \RuntimeException
*/
public function setImports(array $imports)
{
}
/**
* Sets current target context as bitmask.
*
* @param integer $target
*
* @return void
*/
public function setTarget($target)
{
}
/**
* Parses the given docblock string for annotations.
*
* @param string $input The docblock string to parse.
* @param string $context The parsing context.
*
* @return array Array of annotations. If no annotations are found, an empty array is returned.
*/
public function parse($input, $context = '')
{
}
}
/**
* Allows the reader to be used in-place of Doctrine's reader.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class IndexedReader implements \Doctrine\Common\Annotations\Reader
{
/**
* Constructor.
*
* @param Reader $reader
*/
public function __construct(\Doctrine\Common\Annotations\Reader $reader)
{
}
/**
* {@inheritDoc}
*/
public function getClassAnnotations(\ReflectionClass $class)
{
}
/**
* {@inheritDoc}
*/
public function getClassAnnotation(\ReflectionClass $class, $annotation)
{
}
/**
* {@inheritDoc}
*/
public function getMethodAnnotations(\ReflectionMethod $method)
{
}
/**
* {@inheritDoc}
*/
public function getMethodAnnotation(\ReflectionMethod $method, $annotation)
{
}
/**
* {@inheritDoc}
*/
public function getPropertyAnnotations(\ReflectionProperty $property)
{
}
/**
* {@inheritDoc}
*/
public function getPropertyAnnotation(\ReflectionProperty $property, $annotation)
{
}
/**
* Proxies all methods to the delegate.
*
* @param string $method
* @param array $args
*
* @return mixed
*/
public function __call($method, $args)
{
}
}
/**
* Parses a file for namespaces/use/class declarations.
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Christian Kaps <christian.kaps@mohiva.com>
*/
final class PhpParser
{
/**
* Parses a class.
*
* @param \ReflectionClass $class A <code>ReflectionClass</code> object.
*
* @return array A list with use statements in the form (Alias => FQN).
*/
public function parseClass(\ReflectionClass $class)
{
}
}
}
namespace JMS\Serializer {
/**
* Serializer Interface.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface SerializerInterface
{
/**
* Serializes the given data to the specified output format.
*
* @param object|array|scalar $data
* @param string $format
* @param Context $context
*
* @return string
*/
public function serialize($data, $format, \JMS\Serializer\SerializationContext $context = null);
/**
* Deserializes the given data to the specified type.
*
* @param string $data
* @param string $type
* @param string $format
* @param Context $context
*
* @return object|array|scalar
*/
public function deserialize($data, $type, $format, \JMS\Serializer\DeserializationContext $context = null);
}
/**
* Interface for array transformation.
*
* @author Daniel Bojdo <daniel@bojdo.eu>
*/
interface ArrayTransformerInterface
{
/**
* Converts objects to an array structure.
*
* This is useful when the data needs to be passed on to other methods which expect array data.
*
* @param mixed $data anything that converts to an array, typically an object or an array of objects
* @param SerializationContext|null $context
*
* @return array
*/
public function toArray($data, \JMS\Serializer\SerializationContext $context = null);
/**
* Restores objects from an array structure.
*
* @param array $data
* @param string $type
* @param DeserializationContext|null $context
*
* @return mixed this returns whatever the passed type is, typically an object or an array of objects
*/
public function fromArray(array $data, $type, \JMS\Serializer\DeserializationContext $context = null);
}
/**
* Serializer Implementation.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class Serializer implements \JMS\Serializer\SerializerInterface, \JMS\Serializer\ArrayTransformerInterface
{
/**
* Constructor.
*
* @param \Metadata\MetadataFactoryInterface $factory
* @param Handler\HandlerRegistryInterface $handlerRegistry
* @param Construction\ObjectConstructorInterface $objectConstructor
* @param \PhpCollection\MapInterface $serializationVisitors of VisitorInterface
* @param \PhpCollection\MapInterface $deserializationVisitors of VisitorInterface
* @param EventDispatcher\EventDispatcherInterface $dispatcher
* @param TypeParser $typeParser
* @param ExpressionEvaluatorInterface|null $expressionEvaluator
*/
public function __construct(\Metadata\MetadataFactoryInterface $factory, \JMS\Serializer\Handler\HandlerRegistryInterface $handlerRegistry, \JMS\Serializer\Construction\ObjectConstructorInterface $objectConstructor, \PhpCollection\MapInterface $serializationVisitors, \PhpCollection\MapInterface $deserializationVisitors, \JMS\Serializer\EventDispatcher\EventDispatcherInterface $dispatcher = null, \JMS\Serializer\TypeParser $typeParser = null, \JMS\Serializer\Expression\ExpressionEvaluatorInterface $expressionEvaluator = null)
{
}
public function serialize($data, $format, \JMS\Serializer\SerializationContext $context = null)
{
}
public function deserialize($data, $type, $format, \JMS\Serializer\DeserializationContext $context = null)
{
}
/**
* {@InheritDoc}
*/
public function toArray($data, \JMS\Serializer\SerializationContext $context = null)
{
}
/**
* {@InheritDoc}
*/
public function fromArray(array $data, $type, \JMS\Serializer\DeserializationContext $context = null)
{
}
/**
* @return MetadataFactoryInterface
*/
public function getMetadataFactory()
{
}
/**
* @param SerializationContextFactoryInterface $serializationContextFactory
*
* @return self
*/
public function setSerializationContextFactory(\JMS\Serializer\ContextFactory\SerializationContextFactoryInterface $serializationContextFactory)
{
}
/**
* @param DeserializationContextFactoryInterface $deserializationContextFactory
*
* @return self
*/
public function setDeserializationContextFactory(\JMS\Serializer\ContextFactory\DeserializationContextFactoryInterface $deserializationContextFactory)
{
}
}
abstract class Context
{
/**
* @var \PhpCollection\Map
*/
public $attributes;
public function __construct()
{
}
/**
* @param string $format
*/
public function initialize($format, \JMS\Serializer\VisitorInterface $visitor, \JMS\Serializer\GraphNavigator $navigator, \Metadata\MetadataFactoryInterface $factory)
{
}
public function accept($data, array $type = null)
{
}
public function getMetadataFactory()
{
}
public function getVisitor()
{
}
public function getNavigator()
{
}
public function getExclusionStrategy()
{
}
public function setAttribute($key, $value)
{
}
public function addExclusionStrategy(\JMS\Serializer\Exclusion\ExclusionStrategyInterface $strategy)
{
}
/**
* @param integer $version
*/
public function setVersion($version)
{
}
/**
* @param array|string $groups
*/
public function setGroups($groups)
{
}
public function enableMaxDepthChecks()
{
}
/**
* Set if NULLs should be serialized (TRUE) ot not (FALSE)
*
* @param bool $bool
* @return $this
*/
public function setSerializeNull($bool)
{
}
/**
* Returns TRUE when NULLs should be serialized
* Returns FALSE when NULLs should not be serialized
* Returns NULL when NULLs should not be serialized,
* but the user has not explicitly decided to use this policy
*
* @return bool|null
*/
public function shouldSerializeNull()
{
}
/**
* @return string
*/
public function getFormat()
{
}
public function pushClassMetadata(\JMS\Serializer\Metadata\ClassMetadata $metadata)
{
}
public function pushPropertyMetadata(\JMS\Serializer\Metadata\PropertyMetadata $metadata)
{
}
public function popPropertyMetadata()
{
}
public function popClassMetadata()
{
}
public function getMetadataStack()
{
}
/**
* @return array
*/
public function getCurrentPath()
{
}
public abstract function getDepth();
/**
* @return integer
*/
public abstract function getDirection();
}
class DeserializationContext extends \JMS\Serializer\Context
{
public static function create()
{
}
public function getDirection()
{
}
public function getDepth()
{
}
public function increaseDepth()
{
}
public function decreaseDepth()
{
}
}
}
namespace JMS\Serializer\Naming {
/**
* Interface for property naming strategies.
*
* Implementations translate the property name to a serialized name that is
* displayed.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface PropertyNamingStrategyInterface
{
/**
* Translates the name of the property to the serialized version.
*
* @param PropertyMetadata $property
*
* @return string
*/
public function translateName(\JMS\Serializer\Metadata\PropertyMetadata $property);
}
class IdenticalPropertyNamingStrategy implements \JMS\Serializer\Naming\PropertyNamingStrategyInterface
{
public function translateName(\JMS\Serializer\Metadata\PropertyMetadata $property)
{
}
}
/**
* Naming strategy which uses an annotation to translate the property name.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class SerializedNameAnnotationStrategy implements \JMS\Serializer\Naming\PropertyNamingStrategyInterface
{
public function __construct(\JMS\Serializer\Naming\PropertyNamingStrategyInterface $namingStrategy)
{
}
/**
* {@inheritDoc}
*/
public function translateName(\JMS\Serializer\Metadata\PropertyMetadata $property)
{
}
}
/**
* Generic naming strategy which translates a camel-cased property name.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class CamelCaseNamingStrategy implements \JMS\Serializer\Naming\PropertyNamingStrategyInterface
{
public function __construct($separator = '_', $lowerCase = true)
{
}
/**
* {@inheritDoc}
*/
public function translateName(\JMS\Serializer\Metadata\PropertyMetadata $property)
{
}
}
class CacheNamingStrategy implements \JMS\Serializer\Naming\PropertyNamingStrategyInterface
{
public function __construct(\JMS\Serializer\Naming\PropertyNamingStrategyInterface $delegate)
{
}
public function translateName(\JMS\Serializer\Metadata\PropertyMetadata $property)
{
}
}
}
namespace JMS\Serializer {
/**
* Interface for visitors.
*
* This contains the minimal set of values that must be supported for any
* output format.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface VisitorInterface
{
/**
* Allows visitors to convert the input data to a different representation
* before the actual serialization/deserialization process starts.
*
* @param mixed $data
*
* @return mixed
*/
public function prepare($data);
/**
* @param mixed $data
* @param array $type
*
* @return mixed
*/
public function visitNull($data, array $type, \JMS\Serializer\Context $context);
/**
* @param mixed $data
* @param array $type
*
* @return mixed
*/
public function visitString($data, array $type, \JMS\Serializer\Context $context);
/**
* @param mixed $data
* @param array $type
*
* @return mixed
*/
public function visitBoolean($data, array $type, \JMS\Serializer\Context $context);
/**
* @param mixed $data
* @param array $type
*
* @return mixed
*/
public function visitDouble($data, array $type, \JMS\Serializer\Context $context);
/**
* @param mixed $data
* @param array $type
*
* @return mixed
*/
public function visitInteger($data, array $type, \JMS\Serializer\Context $context);
/**
* @param mixed $data
* @param array $type
*
* @return mixed
*/
public function visitArray($data, array $type, \JMS\Serializer\Context $context);
/**
* Called before the properties of the object are being visited.
*
* @param ClassMetadata $metadata
* @param mixed $data
* @param array $type
*
* @return void
*/
public function startVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context);
/**
* @param PropertyMetadata $metadata
* @param mixed $data
*
* @return void
*/
public function visitProperty(\JMS\Serializer\Metadata\PropertyMetadata $metadata, $data, \JMS\Serializer\Context $context);
/**
* Called after all properties of the object have been visited.
*
* @param ClassMetadata $metadata
* @param mixed $data
* @param array $type
*
* @return mixed
*/
public function endVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context);
/**
* Called before serialization/deserialization starts.
*
* @param GraphNavigator $navigator
*
* @return void
*/
public function setNavigator(\JMS\Serializer\GraphNavigator $navigator);
/**
* @deprecated use Context::getNavigator/Context::accept instead
* @return GraphNavigator
*/
public function getNavigator();
/**
* @return object|array|scalar
*/
public function getResult();
}
interface NullAwareVisitorInterface extends \JMS\Serializer\VisitorInterface
{
/**
* Determine if a value conveys a null value.
* An example could be an xml element (Dom, SimpleXml, ...) that is tagged with a xsi:nil attribute
*
* @param mixed $value
*
* @return bool
*/
public function isNull($value);
}
abstract class AbstractVisitor implements \JMS\Serializer\VisitorInterface
{
protected $namingStrategy;
/**
* @var AccessorStrategyInterface
*/
protected $accessor;
public function __construct(\JMS\Serializer\Naming\PropertyNamingStrategyInterface $namingStrategy, \JMS\Serializer\Accessor\AccessorStrategyInterface $accessorStrategy = null)
{
}
public function getNamingStrategy()
{
}
public function prepare($data)
{
}
/**
* @param array $typeArray
*/
protected function getElementType($typeArray)
{
}
}
class XmlDeserializationVisitor extends \JMS\Serializer\AbstractVisitor implements \JMS\Serializer\NullAwareVisitorInterface
{
public function enableExternalEntities()
{
}
public function setNavigator(\JMS\Serializer\GraphNavigator $navigator)
{
}
public function getNavigator()
{
}
public function prepare($data)
{
}
public function visitNull($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitString($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitBoolean($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitInteger($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitDouble($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitArray($data, array $type, \JMS\Serializer\Context $context)
{
}
public function startVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $object, array $type, \JMS\Serializer\Context $context)
{
}
public function visitProperty(\JMS\Serializer\Metadata\PropertyMetadata $metadata, $data, \JMS\Serializer\Context $context)
{
}
public function endVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function setCurrentObject($object)
{
}
public function getCurrentObject()
{
}
public function revertCurrentObject()
{
}
public function setCurrentMetadata(\JMS\Serializer\Metadata\PropertyMetadata $metadata)
{
}
public function getCurrentMetadata()
{
}
public function revertCurrentMetadata()
{
}
public function getResult()
{
}
/**
* @param array <string> $doctypeWhitelist
*/
public function setDoctypeWhitelist(array $doctypeWhitelist)
{
}
/**
* @return array<string>
*/
public function getDoctypeWhitelist()
{
}
/**
* @param mixed $value
*
* @return bool
*/
public function isNull($value)
{
}
}
/**
* Generic Deserialization Visitor.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
abstract class GenericDeserializationVisitor extends \JMS\Serializer\AbstractVisitor
{
public function setNavigator(\JMS\Serializer\GraphNavigator $navigator)
{
}
public function getNavigator()
{
}
public function prepare($data)
{
}
public function visitNull($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitString($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitBoolean($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitInteger($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitDouble($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitArray($data, array $type, \JMS\Serializer\Context $context)
{
}
public function startVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $object, array $type, \JMS\Serializer\Context $context)
{
}
public function visitProperty(\JMS\Serializer\Metadata\PropertyMetadata $metadata, $data, \JMS\Serializer\Context $context)
{
}
public function endVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function getResult()
{
}
public function setCurrentObject($object)
{
}
public function getCurrentObject()
{
}
public function revertCurrentObject()
{
}
protected abstract function decode($str);
}
}
namespace JMS\Serializer\Construction {
/**
* Implementations of this interface construct new objects during deserialization.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface ObjectConstructorInterface
{
/**
* Constructs a new object.
*
* Implementations could for example create a new object calling "new", use
* "unserialize" techniques, reflection, or other means.
*
* @param VisitorInterface $visitor
* @param ClassMetadata $metadata
* @param mixed $data
* @param array $type ["name" => string, "params" => array]
* @param DeserializationContext $context
*
* @return object
*/
public function construct(\JMS\Serializer\VisitorInterface $visitor, \JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\DeserializationContext $context);
}
class UnserializeObjectConstructor implements \JMS\Serializer\Construction\ObjectConstructorInterface
{
public function construct(\JMS\Serializer\VisitorInterface $visitor, \JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\DeserializationContext $context)
{
}
}
/**
* Doctrine object constructor for new (or existing) objects during deserialization.
*/
class DoctrineObjectConstructor implements \JMS\Serializer\Construction\ObjectConstructorInterface
{
const ON_MISSING_NULL = 'null';
const ON_MISSING_EXCEPTION = 'exception';
const ON_MISSING_FALLBACK = 'fallback';
/**
* Constructor.
*
* @param ManagerRegistry $managerRegistry Manager registry
* @param ObjectConstructorInterface $fallbackConstructor Fallback object constructor
* @param string $fallbackStrategy
*/
public function __construct(\Doctrine\Common\Persistence\ManagerRegistry $managerRegistry, \JMS\Serializer\Construction\ObjectConstructorInterface $fallbackConstructor, $fallbackStrategy = self::ON_MISSING_NULL)
{
}
/**
* {@inheritdoc}
*/
public function construct(\JMS\Serializer\VisitorInterface $visitor, \JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\DeserializationContext $context)
{
}
}
}
namespace JMS\Serializer\Util {
/**
* A writer implementation.
*
* This may be used to simplify writing well-formatted code.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class Writer
{
public $indentationSpaces = 4;
public $indentationLevel = 0;
public $content = '';
public $changeCount = 0;
public function indent()
{
}
public function outdent()
{
}
/**
* @param string $content
*
* @return Writer
*/
public function writeln($content)
{
}
public function revert()
{
}
/**
* @param string $content
*
* @return Writer
*/
public function write($content)
{
}
public function rtrim($preserveNewLines = true)
{
}
public function reset()
{
}
public function getContent()
{
}
}
}
namespace JMS\Serializer\Builder {
interface DriverFactoryInterface
{
/**
* @param array $metadataDirs
* @param Reader $annotationReader
*
* @return DriverInterface
*/
public function createDriver(array $metadataDirs, \Doctrine\Common\Annotations\Reader $annotationReader);
}
class CallbackDriverFactory implements \JMS\Serializer\Builder\DriverFactoryInterface
{
/**
* @param callable $callable
*/
public function __construct($callable)
{
}
public function createDriver(array $metadataDirs, \Doctrine\Common\Annotations\Reader $reader)
{
}
}
class DefaultDriverFactory implements \JMS\Serializer\Builder\DriverFactoryInterface
{
public function createDriver(array $metadataDirs, \Doctrine\Common\Annotations\Reader $annotationReader)
{
}
}
}
namespace JMS\Serializer\ContextFactory {
/**
* Deserialization Context Factory Interface.
*/
interface DeserializationContextFactoryInterface
{
/**
* @return DeserializationContext
*/
public function createDeserializationContext();
}
/**
* Serialization Context Factory Interface.
*/
interface SerializationContextFactoryInterface
{
/**
* @return SerializationContext
*/
public function createSerializationContext();
}
/**
* Default Serialization Context Factory.
*/
class DefaultSerializationContextFactory implements \JMS\Serializer\ContextFactory\SerializationContextFactoryInterface
{
/**
* {@InheritDoc}
*/
public function createSerializationContext()
{
}
}
/**
* Context Factory using a callable.
*/
abstract class CallableContextFactory
{
/**
* @param callable $callable
*/
public function __construct(callable $callable)
{
}
/**
* @return mixed
*/
protected function createContext()
{
}
}
/**
* Deserialization Context Factory using a callable.
*/
class CallableDeserializationContextFactory extends \JMS\Serializer\ContextFactory\CallableContextFactory implements \JMS\Serializer\ContextFactory\DeserializationContextFactoryInterface
{
/**
* {@InheritDoc}
*/
public function createDeserializationContext()
{
}
}
/**
* Serialization Context Factory using a callable.
*/
class CallableSerializationContextFactory extends \JMS\Serializer\ContextFactory\CallableContextFactory implements \JMS\Serializer\ContextFactory\SerializationContextFactoryInterface
{
/**
* {@InheritDoc}
*/
public function createSerializationContext()
{
}
}
/**
* Default Deserialization Context Factory.
*/
class DefaultDeserializationContextFactory implements \JMS\Serializer\ContextFactory\DeserializationContextFactoryInterface
{
/**
* {@InheritDoc}
*/
public function createDeserializationContext()
{
}
}
}
namespace JMS\Serializer {
/**
* @deprecated
*/
abstract class GenericSerializationVisitor extends \JMS\Serializer\AbstractVisitor
{
public function setNavigator(\JMS\Serializer\GraphNavigator $navigator)
{
}
/**
* @return GraphNavigator
*/
public function getNavigator()
{
}
public function visitNull($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitString($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitBoolean($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitInteger($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitDouble($data, array $type, \JMS\Serializer\Context $context)
{
}
/**
* @param array $data
* @param array $type
*/
public function visitArray($data, array $type, \JMS\Serializer\Context $context)
{
}
public function startVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function endVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitProperty(\JMS\Serializer\Metadata\PropertyMetadata $metadata, $data, \JMS\Serializer\Context $context)
{
}
/**
* Allows you to add additional data to the current object/root element.
* @deprecated use setData instead
* @param string $key
* @param integer|float|boolean|string|array|null $value This value must either be a regular scalar, or an array.
* It must not contain any objects anymore.
*/
public function addData($key, $value)
{
}
/**
* Checks if some data key exists.
*
* @param string $key
* @return boolean
*/
public function hasData($key)
{
}
/**
* Allows you to replace existing data on the current object/root element.
*
* @param string $key
* @param integer|float|boolean|string|array|null $value This value must either be a regular scalar, or an array.
* It must not contain any objects anymore.
*/
public function setData($key, $value)
{
}
public function getRoot()
{
}
/**
* @param array|\ArrayObject $data the passed data must be understood by whatever encoding function is applied later.
*/
public function setRoot($data)
{
}
}
/**
* XmlSerializationVisitor.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class XmlSerializationVisitor extends \JMS\Serializer\AbstractVisitor
{
public $document;
public function __construct(\JMS\Serializer\Naming\PropertyNamingStrategyInterface $namingStrategy, \JMS\Serializer\Accessor\AccessorStrategyInterface $accessorStrategy = null)
{
}
public function setDefaultRootName($name, $namespace = null)
{
}
/**
* @return boolean
*/
public function hasDefaultRootName()
{
}
public function setDefaultVersion($version)
{
}
public function setDefaultEncoding($encoding)
{
}
public function setNavigator(\JMS\Serializer\GraphNavigator $navigator)
{
}
public function getNavigator()
{
}
public function visitNull($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitString($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitSimpleString($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitBoolean($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitInteger($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitDouble($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitArray($data, array $type, \JMS\Serializer\Context $context)
{
}
public function startVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitProperty(\JMS\Serializer\Metadata\PropertyMetadata $metadata, $object, \JMS\Serializer\Context $context)
{
}
public function endVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function getResult()
{
}
public function getCurrentNode()
{
}
public function getCurrentMetadata()
{
}
public function getDocument()
{
}
public function setCurrentMetadata(\JMS\Serializer\Metadata\PropertyMetadata $metadata)
{
}
public function setCurrentNode(\DOMNode $node)
{
}
public function revertCurrentNode()
{
}
public function revertCurrentMetadata()
{
}
public function createDocument($version = null, $encoding = null, $addRoot = true)
{
}
public function prepare($data)
{
}
/**
* @return bool
*/
public function isFormatOutput()
{
}
/**
* @param bool $formatOutput
*/
public function setFormatOutput($formatOutput)
{
}
}
}
namespace Metadata {
/**
* Base class for property metadata.
*
* This class is intended to be extended to add your application specific
* properties, and flags.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class PropertyMetadata implements \Serializable
{
public $class;
public $name;
public $reflection;
public function __construct($class, $name)
{
}
/**
* @param object $obj
*
* @return mixed
*/
public function getValue($obj)
{
}
/**
* @param object $obj
* @param string $value
*/
public function setValue($obj, $value)
{
}
public function serialize()
{
}
public function unserialize($str)
{
}
}
}
namespace JMS\Serializer\Metadata {
class PropertyMetadata extends \Metadata\PropertyMetadata
{
const ACCESS_TYPE_PROPERTY = 'property';
const ACCESS_TYPE_PUBLIC_METHOD = 'public_method';
public $sinceVersion;
public $untilVersion;
public $groups;
public $serializedName;
public $type;
public $xmlCollection = false;
public $xmlCollectionInline = false;
public $xmlCollectionSkipWhenEmpty = true;
public $xmlEntryName;
public $xmlEntryNamespace;
public $xmlKeyAttribute;
public $xmlAttribute = false;
public $xmlValue = false;
public $xmlNamespace;
public $xmlKeyValuePairs = false;
public $xmlElementCData = true;
public $getter;
public $setter;
public $inline = false;
public $skipWhenEmpty = false;
public $readOnly = false;
public $xmlAttributeMap = false;
public $maxDepth = null;
public $excludeIf = null;
public function setAccessor($type, $getter = null, $setter = null)
{
}
public function getValue($obj)
{
}
public function setValue($obj, $value)
{
}
public function setType($type)
{
}
public function serialize()
{
}
public function unserialize($str)
{
}
}
class StaticPropertyMetadata extends \JMS\Serializer\Metadata\PropertyMetadata
{
public function __construct($className, $fieldName, $fieldValue, array $groups = array())
{
}
public function getValue($obj)
{
}
public function setValue($obj, $value)
{
}
public function setAccessor($type, $getter = null, $setter = null)
{
}
public function serialize()
{
}
public function unserialize($str)
{
}
}
}
namespace Metadata\Driver {
interface DriverInterface
{
/**
* @param \ReflectionClass $class
*
* @return \Metadata\ClassMetadata
*/
public function loadMetadataForClass(\ReflectionClass $class);
}
/**
* Forces advanced logic to drivers.
*
* @author Jordan Stout <j@jrdn.org>
*/
interface AdvancedDriverInterface extends \Metadata\Driver\DriverInterface
{
/**
* Gets all the metadata class names known to this driver.
*
* @return array
*/
public function getAllClassNames();
}
/**
* Base file driver implementation.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
abstract class AbstractFileDriver implements \Metadata\Driver\AdvancedDriverInterface
{
public function __construct(\Metadata\Driver\FileLocatorInterface $locator)
{
}
public function loadMetadataForClass(\ReflectionClass $class)
{
}
/**
* {@inheritDoc}
*/
public function getAllClassNames()
{
}
/**
* Parses the content of the file, and converts it to the desired metadata.
*
* @param \ReflectionClass $class
* @param string $file
*
* @return \Metadata\ClassMetadata|null
*/
protected abstract function loadMetadataFromFile(\ReflectionClass $class, $file);
/**
* Returns the extension of the file.
*
* @return string
*/
protected abstract function getExtension();
}
}
namespace JMS\Serializer\Metadata\Driver {
class PhpDriver extends \Metadata\Driver\AbstractFileDriver
{
protected function loadMetadataFromFile(\ReflectionClass $class, $file)
{
}
protected function getExtension()
{
}
}
/**
* This class decorates any other driver. If the inner driver does not provide a
* a property type, the decorator will guess based on Doctrine 2 metadata.
*/
abstract class AbstractDoctrineTypeDriver implements \Metadata\Driver\DriverInterface
{
/**
* Map of doctrine 2 field types to JMS\Serializer types
* @var array
*/
protected $fieldMapping = array('string' => 'string', 'text' => 'string', 'blob' => 'string', 'integer' => 'integer', 'smallint' => 'integer', 'bigint' => 'integer', 'datetime' => 'DateTime', 'datetimetz' => 'DateTime', 'time' => 'DateTime', 'date' => 'DateTime', 'float' => 'float', 'decimal' => 'float', 'boolean' => 'boolean', 'array' => 'array', 'json_array' => 'array', 'simple_array' => 'array<string>');
/**
* @var DriverInterface
*/
protected $delegate;
/**
* @var ManagerRegistry
*/
protected $registry;
public function __construct(\Metadata\Driver\DriverInterface $delegate, \Doctrine\Common\Persistence\ManagerRegistry $registry)
{
}
public function loadMetadataForClass(\ReflectionClass $class)
{
}
/**
* @param DoctrineClassMetadata $doctrineMetadata
* @param ClassMetadata $classMetadata
*/
protected function setDiscriminator(\Doctrine\Common\Persistence\Mapping\ClassMetadata $doctrineMetadata, \JMS\Serializer\Metadata\ClassMetadata $classMetadata)
{
}
/**
* @param DoctrineClassMetadata $doctrineMetadata
* @param PropertyMetadata $propertyMetadata
*/
protected function hideProperty(\Doctrine\Common\Persistence\Mapping\ClassMetadata $doctrineMetadata, \JMS\Serializer\Metadata\PropertyMetadata $propertyMetadata)
{
}
/**
* @param DoctrineClassMetadata $doctrineMetadata
* @param PropertyMetadata $propertyMetadata
*/
protected function setPropertyType(\Doctrine\Common\Persistence\Mapping\ClassMetadata $doctrineMetadata, \JMS\Serializer\Metadata\PropertyMetadata $propertyMetadata)
{
}
/**
* @param string $className
*
* @return null|DoctrineClassMetadata
*/
protected function tryLoadingDoctrineMetadata($className)
{
}
/**
* @param string $type
*/
protected function normalizeFieldType($type)
{
}
}
/**
* This class decorates any other driver. If the inner driver does not provide a
* a property type, the decorator will guess based on Doctrine 2 metadata.
*/
class DoctrinePHPCRTypeDriver extends \JMS\Serializer\Metadata\Driver\AbstractDoctrineTypeDriver
{
/**
* @param DoctrineClassMetadata $doctrineMetadata
* @param PropertyMetadata $propertyMetadata
*/
protected function hideProperty(\Doctrine\Common\Persistence\Mapping\ClassMetadata $doctrineMetadata, \JMS\Serializer\Metadata\PropertyMetadata $propertyMetadata)
{
}
protected function setPropertyType(\Doctrine\Common\Persistence\Mapping\ClassMetadata $doctrineMetadata, \JMS\Serializer\Metadata\PropertyMetadata $propertyMetadata)
{
}
}
/**
* This class decorates any other driver. If the inner driver does not provide a
* a property type, the decorator will guess based on Doctrine 2 metadata.
*/
class DoctrineTypeDriver extends \JMS\Serializer\Metadata\Driver\AbstractDoctrineTypeDriver
{
protected function setDiscriminator(\Doctrine\Common\Persistence\Mapping\ClassMetadata $doctrineMetadata, \JMS\Serializer\Metadata\ClassMetadata $classMetadata)
{
}
protected function setPropertyType(\Doctrine\Common\Persistence\Mapping\ClassMetadata $doctrineMetadata, \JMS\Serializer\Metadata\PropertyMetadata $propertyMetadata)
{
}
}
class XmlDriver extends \Metadata\Driver\AbstractFileDriver
{
protected function loadMetadataFromFile(\ReflectionClass $class, $path)
{
}
protected function getExtension()
{
}
}
class YamlDriver extends \Metadata\Driver\AbstractFileDriver
{
protected function loadMetadataFromFile(\ReflectionClass $class, $file)
{
}
protected function getExtension()
{
}
}
}
namespace Metadata {
interface MergeableInterface
{
/**
* @param MergeableInterface $object
*
* @return void
*/
public function merge(\Metadata\MergeableInterface $object);
}
/**
* Base class for class metadata.
*
* This class is intended to be extended to add your own application specific
* properties, and flags.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class ClassMetadata implements \Serializable
{
public $name;
public $reflection;
public $methodMetadata = array();
public $propertyMetadata = array();
public $fileResources = array();
public $createdAt;
public function __construct($name)
{
}
public function addMethodMetadata(\Metadata\MethodMetadata $metadata)
{
}
public function addPropertyMetadata(\Metadata\PropertyMetadata $metadata)
{
}
public function isFresh($timestamp = null)
{
}
public function serialize()
{
}
public function unserialize($str)
{
}
}
class MergeableClassMetadata extends \Metadata\ClassMetadata implements \Metadata\MergeableInterface
{
public function merge(\Metadata\MergeableInterface $object)
{
}
}
}
namespace JMS\Serializer\Metadata {
/**
* Class Metadata used to customize the serialization process.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class ClassMetadata extends \Metadata\MergeableClassMetadata
{
const ACCESSOR_ORDER_UNDEFINED = 'undefined';
const ACCESSOR_ORDER_ALPHABETICAL = 'alphabetical';
const ACCESSOR_ORDER_CUSTOM = 'custom';
/** @var \ReflectionMethod[] */
public $preSerializeMethods = array();
/** @var \ReflectionMethod[] */
public $postSerializeMethods = array();
/** @var \ReflectionMethod[] */
public $postDeserializeMethods = array();
public $xmlRootName;
public $xmlRootNamespace;
public $xmlNamespaces = array();
public $accessorOrder;
public $customOrder;
public $usingExpression = false;
public $handlerCallbacks = array();
public $discriminatorDisabled = false;
public $discriminatorBaseClass;
public $discriminatorFieldName;
public $discriminatorValue;
public $discriminatorMap = array();
public $discriminatorGroups = array();
public $xmlDiscriminatorAttribute = false;
public $xmlDiscriminatorCData = true;
public $xmlDiscriminatorNamespace;
public function setDiscriminator($fieldName, array $map, array $groups = array())
{
}
/**
* Sets the order of properties in the class.
*
* @param string $order
* @param array $customOrder
*
* @throws InvalidArgumentException When the accessor order is not valid
* @throws InvalidArgumentException When the custom order is not valid
*/
public function setAccessorOrder($order, array $customOrder = array())
{
}
public function addPropertyMetadata(\Metadata\PropertyMetadata $metadata)
{
}
public function addPreSerializeMethod(\Metadata\MethodMetadata $method)
{
}
public function addPostSerializeMethod(\Metadata\MethodMetadata $method)
{
}
public function addPostDeserializeMethod(\Metadata\MethodMetadata $method)
{
}
/**
* @param integer $direction
* @param string|integer $format
* @param string $methodName
*/
public function addHandlerCallback($direction, $format, $methodName)
{
}
public function merge(\Metadata\MergeableInterface $object)
{
}
public function registerNamespace($uri, $prefix = null)
{
}
public function serialize()
{
}
public function unserialize($str)
{
}
}
/**
* @Annotation
* @Target("METHOD")
*
* @author Asmir Mustafic <goetas@gmail.com>
*/
class ExpressionPropertyMetadata extends \JMS\Serializer\Metadata\PropertyMetadata
{
/**
* @var string
*/
public $expression;
public function __construct($class, $fieldName, $expression)
{
}
public function setAccessor($type, $getter = null, $setter = null)
{
}
/**
* @param object $object
* @return mixed
*/
public function getValue($object)
{
}
public function setValue($obj, $value)
{
}
public function serialize()
{
}
public function unserialize($str)
{
}
}
class VirtualPropertyMetadata extends \JMS\Serializer\Metadata\PropertyMetadata
{
public function __construct($class, $methodName)
{
}
public function setValue($obj, $value)
{
}
public function setAccessor($type, $getter = null, $setter = null)
{
}
public function serialize()
{
}
public function unserialize($str)
{
}
}
}
namespace JMS\Serializer {
class JsonDeserializationVisitor extends \JMS\Serializer\GenericDeserializationVisitor
{
protected function decode($str)
{
}
}
}
namespace JMS\Serializer\Exclusion {
/**
* Interface for exclusion strategies.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface ExclusionStrategyInterface
{
/**
* Whether the class should be skipped.
*
* @param ClassMetadata $metadata
*
* @return boolean
*/
public function shouldSkipClass(\JMS\Serializer\Metadata\ClassMetadata $metadata, \JMS\Serializer\Context $context);
/**
* Whether the property should be skipped.
*
* @param PropertyMetadata $property
*
* @return boolean
*/
public function shouldSkipProperty(\JMS\Serializer\Metadata\PropertyMetadata $property, \JMS\Serializer\Context $context);
}
/**
* Disjunct Exclusion Strategy.
*
* This strategy is short-circuiting and will skip a class, or property as soon as one of the delegates skips it.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class DisjunctExclusionStrategy implements \JMS\Serializer\Exclusion\ExclusionStrategyInterface
{
/**
* @param ExclusionStrategyInterface[]|SequenceInterface $delegates
*/
public function __construct($delegates)
{
}
public function addStrategy(\JMS\Serializer\Exclusion\ExclusionStrategyInterface $strategy)
{
}
/**
* Whether the class should be skipped.
*
* @param ClassMetadata $metadata
*
* @return boolean
*/
public function shouldSkipClass(\JMS\Serializer\Metadata\ClassMetadata $metadata, \JMS\Serializer\Context $context)
{
}
/**
* Whether the property should be skipped.
*
* @param PropertyMetadata $property
*
* @return boolean
*/
public function shouldSkipProperty(\JMS\Serializer\Metadata\PropertyMetadata $property, \JMS\Serializer\Context $context)
{
}
}
class VersionExclusionStrategy implements \JMS\Serializer\Exclusion\ExclusionStrategyInterface
{
public function __construct($version)
{
}
/**
* {@inheritDoc}
*/
public function shouldSkipClass(\JMS\Serializer\Metadata\ClassMetadata $metadata, \JMS\Serializer\Context $navigatorContext)
{
}
/**
* {@inheritDoc}
*/
public function shouldSkipProperty(\JMS\Serializer\Metadata\PropertyMetadata $property, \JMS\Serializer\Context $navigatorContext)
{
}
}
class GroupsExclusionStrategy implements \JMS\Serializer\Exclusion\ExclusionStrategyInterface
{
const DEFAULT_GROUP = 'Default';
public function __construct(array $groups)
{
}
/**
* {@inheritDoc}
*/
public function shouldSkipClass(\JMS\Serializer\Metadata\ClassMetadata $metadata, \JMS\Serializer\Context $navigatorContext)
{
}
/**
* {@inheritDoc}
*/
public function shouldSkipProperty(\JMS\Serializer\Metadata\PropertyMetadata $property, \JMS\Serializer\Context $navigatorContext)
{
}
}
/**
* Exposes an exclusion strategy based on the Symfony's expression language.
* This is not a standard exclusion strategy and can not be used in user applications.
*
* @internal
*
* @author Asmir Mustafic <goetas@gmail.com>
*/
class ExpressionLanguageExclusionStrategy
{
public function __construct(\JMS\Serializer\Expression\ExpressionEvaluatorInterface $expressionEvaluator)
{
}
/**
* {@inheritDoc}
*/
public function shouldSkipProperty(\JMS\Serializer\Metadata\PropertyMetadata $property, \JMS\Serializer\Context $navigatorContext)
{
}
}
/**
* @author Adrien Brault <adrien.brault@gmail.com>
*/
class DepthExclusionStrategy implements \JMS\Serializer\Exclusion\ExclusionStrategyInterface
{
/**
* {@inheritDoc}
*/
public function shouldSkipClass(\JMS\Serializer\Metadata\ClassMetadata $metadata, \JMS\Serializer\Context $context)
{
}
/**
* {@inheritDoc}
*/
public function shouldSkipProperty(\JMS\Serializer\Metadata\PropertyMetadata $property, \JMS\Serializer\Context $context)
{
}
}
}
namespace JMS\Parser {
/**
* Base Parser which provides some useful parsing methods intended for sub-classing.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
abstract class AbstractParser
{
protected $lexer;
protected $context;
public function __construct(\JMS\Parser\AbstractLexer $lexer)
{
}
/**
* Parses the given input.
*
* @param string $str
* @param string $context parsing context (allows to produce better error messages)
*
* @return mixed
*/
public function parse($str, $context = null)
{
}
/**
* @return mixed
*/
protected abstract function parseInternal();
/**
* Matches a token, and returns its value.
*
* @param integer $type
*
* @return mixed the value of the matched token
*/
protected function match($type)
{
}
/**
* Matches any of the passed tokens, and returns the matched token's value.
*
* @param array<integer> $types
*
* @return mixed
*/
protected function matchAny(array $types)
{
}
/**
* Raises a syntax error exception.
*
* @param string $expectedDesc A human understandable explanation what was expected
* @param array $actualToken The token that was found. If not given, next token will be assumed.
*/
protected function syntaxError($expectedDesc, $actualToken = null)
{
}
}
}
namespace JMS\Serializer {
/**
* Parses a serializer type.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
final class TypeParser extends \JMS\Parser\AbstractParser
{
const T_NAME = 1;
const T_STRING = 2;
const T_OPEN_BRACKET = 3;
const T_CLOSE_BRACKET = 4;
const T_COMMA = 5;
const T_NONE = 6;
public function __construct()
{
}
}
}
namespace JMS\Serializer\Annotation {
abstract class XmlCollection
{
/**
* @var string
*/
public $entry = 'entry';
/**
* @var boolean
*/
public $inline = false;
/**
* @var string
*/
public $namespace;
/**
* @var boolean
*/
public $skipWhenEmpty = true;
}
/**
* @Annotation
* @Target({"PROPERTY","METHOD","ANNOTATION"})
*/
final class XmlMap extends \JMS\Serializer\Annotation\XmlCollection
{
/**
* @var string
*/
public $keyAttribute = '_key';
}
abstract class Version
{
/**
* @Required
* @var string
*/
public $version;
}
/**
* @Annotation
* @Target({"PROPERTY", "METHOD"})
*/
final class Since extends \JMS\Serializer\Annotation\Version
{
}
/**
* @Annotation
* @Target({"PROPERTY","METHOD","ANNOTATION"})
*/
final class Inline
{
}
/**
* @Annotation
* @Target("METHOD")
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
final class HandlerCallback
{
/**
* @Required
* @var string
*/
public $format;
/**
* @Required
* @var string
*/
public $direction;
}
/**
* @Annotation
* @Target({"PROPERTY", "METHOD","ANNOTATION"})
*/
final class XmlAttribute
{
/**
* @var string
*/
public $namespace;
}
/**
* @Annotation
* @Target({"PROPERTY","METHOD", "ANNOTATION"})
*/
final class SerializedName
{
public $name;
public function __construct(array $values)
{
}
}
/**
* @Annotation
* @Target("CLASS")
*/
class XmlDiscriminator
{
/**
* @var boolean
*/
public $attribute = false;
/**
* @var boolean
*/
public $cdata = true;
/**
* @var string
*/
public $namespace;
}
/**
* @Annotation
* @Target({"METHOD", "CLASS"})
*
* @author Alexander Klimenkov <alx.devel@gmail.com>
*/
final class VirtualProperty
{
public $exp;
public $name;
public $options = array();
public function __construct(array $data)
{
}
}
/**
* @Annotation
* @Target("CLASS")
*/
final class ExclusionPolicy
{
const NONE = 'NONE';
const ALL = 'ALL';
public $policy;
public function __construct(array $values)
{
}
}
/**
* @Annotation
* @Target("CLASS")
*/
final class XmlRoot
{
/**
* @Required
* @var string
*/
public $name;
/**
* @var string
*/
public $namespace;
}
/**
* @Annotation
* @Target({"PROPERTY", "METHOD","ANNOTATION"})
*/
final class XmlElement
{
/**
* @var boolean
*/
public $cdata = true;
/**
* @var string
*/
public $namespace;
}
/**
* @Annotation
* @Target("PROPERTY")
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
final class Accessor
{
/**
* @var string
*/
public $getter;
/**
* @var string
*/
public $setter;
}
/**
* This annotation can be declared on methods which should be called
* before the Serialization process.
*
* These methods do not need to be public, and should do any clean-up, or
* preparation of the object that is necessary.
*
* @Annotation
* @Target("METHOD")
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
final class PreSerialize
{
}
/**
* @Annotation
* @Target({"CLASS", "PROPERTY"})
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
final class AccessType
{
/**
* @Required
* @var string
*/
public $type;
}
/**
* @Annotation
* @Target("METHOD")
*/
final class PostSerialize
{
}
/**
* Controls the order of properties in a class.
*
* @Annotation
* @Target("CLASS")
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
final class AccessorOrder
{
/**
* @Required
* @var string
*/
public $order;
/**
* @var array<string>
*/
public $custom = array();
}
/**
* @Annotation
* @Target({"PROPERTY", "METHOD"})
*/
final class XmlAttributeMap
{
}
/**
* @Annotation
* @Target({"PROPERTY", "CLASS", "METHOD", "ANNOTATION"})
*/
final class Exclude
{
public $if;
}
/**
* @Annotation
* @Target({"PROPERTY","METHOD","ANNOTATION"})
*/
final class SkipWhenEmpty
{
}
/**
* @Annotation
* @Target({"PROPERTY", "METHOD","ANNOTATION"})
*/
final class Expose
{
public $if;
}
/**
* @Annotation
* @Target({"PROPERTY","METHOD","ANNOTATION"})
*/
final class XmlList extends \JMS\Serializer\Annotation\XmlCollection
{
}
/**
* @Annotation
* @Target("CLASS")
*/
class Discriminator
{
/** @var array<string> */
public $map;
/** @var string */
public $field = 'type';
/** @var boolean */
public $disabled = false;
/** @var string[] */
public $groups = array();
}
/**
* This annotation can be defined on methods which are called after the
* deserialization of the object is complete.
*
* These methods do not necessarily have to be public.
*
* @Annotation
* @Target("METHOD")
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
final class PostDeserialize
{
}
/**
* @Annotation
* @Target({"PROPERTY", "METHOD","ANNOTATION"})
*/
final class Type
{
/**
* @Required
* @var string
*/
public $name;
}
/**
* @Annotation
* @Target({"PROPERTY","METHOD","ANNOTATION"})
*/
final class Groups
{
/** @var array<string> @Required */
public $groups;
}
/**
* @Annotation
* @Target({"PROPERTY","METHOD","ANNOTATION"})
*/
final class XmlValue
{
/**
* @var boolean
*/
public $cdata = true;
}
/**
* @Annotation
* @Target({"PROPERTY","METHOD","ANNOTATION"})
*/
final class XmlKeyValuePairs
{
}
/**
* @Annotation
* @Target({"PROPERTY","METHOD","ANNOTATION"})
*/
final class MaxDepth
{
/**
* @Required
* @var integer
*/
public $depth;
}
/**
* @Annotation
* @Target("CLASS")
*/
final class XmlNamespace
{
/**
* @Required
* @var string
*/
public $uri;
/**
* @var string
*/
public $prefix = '';
}
/**
* @Annotation
* @Target({"PROPERTY", "METHOD"})
*/
final class Until extends \JMS\Serializer\Annotation\Version
{
}
}
namespace JMS\Serializer\Handler {
interface SubscribingHandlerInterface
{
/**
* Return format:
*
* array(
* array(
* 'direction' => GraphNavigator::DIRECTION_SERIALIZATION,
* 'format' => 'json',
* 'type' => 'DateTime',
* 'method' => 'serializeDateTimeToJson',
* ),
* )
*
* The direction and method keys can be omitted.
*
* @return array
*/
public static function getSubscribingMethods();
}
class ArrayCollectionHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
{
public function __construct($initializeExcluded = true)
{
}
public static function getSubscribingMethods()
{
}
public function serializeCollection(\JMS\Serializer\VisitorInterface $visitor, \Doctrine\Common\Collections\Collection $collection, array $type, \JMS\Serializer\Context $context)
{
}
public function deserializeCollection(\JMS\Serializer\VisitorInterface $visitor, $data, array $type, \JMS\Serializer\Context $context)
{
}
}
class PhpCollectionHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
{
public static function getSubscribingMethods()
{
}
public function serializeMap(\JMS\Serializer\VisitorInterface $visitor, \PhpCollection\Map $map, array $type, \JMS\Serializer\Context $context)
{
}
public function deserializeMap(\JMS\Serializer\VisitorInterface $visitor, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function serializeSequence(\JMS\Serializer\VisitorInterface $visitor, \PhpCollection\Sequence $sequence, array $type, \JMS\Serializer\Context $context)
{
}
public function deserializeSequence(\JMS\Serializer\VisitorInterface $visitor, $data, array $type, \JMS\Serializer\Context $context)
{
}
}
class PropelCollectionHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
{
public static function getSubscribingMethods()
{
}
public function serializeCollection(\JMS\Serializer\VisitorInterface $visitor, \PropelCollection $collection, array $type, \JMS\Serializer\Context $context)
{
}
public function deserializeCollection(\JMS\Serializer\VisitorInterface $visitor, $data, array $type, \JMS\Serializer\Context $context)
{
}
}
/**
* Handler Registry Interface.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface HandlerRegistryInterface
{
/**
* @param SubscribingHandlerInterface $handler
*
* @return void
*/
public function registerSubscribingHandler(\JMS\Serializer\Handler\SubscribingHandlerInterface $handler);
/**
* Registers a handler in the registry.
*
* @param integer $direction one of the GraphNavigator::DIRECTION_??? constants
* @param string $typeName
* @param string $format
* @param callable $handler function(VisitorInterface, mixed $data, array $type): mixed
*
* @return void
*/
public function registerHandler($direction, $typeName, $format, $handler);
/**
* @param integer $direction one of the GraphNavigator::DIRECTION_??? constants
* @param string $typeName
* @param string $format
*
* @return callable|null
*/
public function getHandler($direction, $typeName, $format);
}
class HandlerRegistry implements \JMS\Serializer\Handler\HandlerRegistryInterface
{
protected $handlers;
public static function getDefaultMethod($direction, $type, $format)
{
}
public function __construct(array $handlers = array())
{
}
public function registerSubscribingHandler(\JMS\Serializer\Handler\SubscribingHandlerInterface $handler)
{
}
public function registerHandler($direction, $typeName, $format, $handler)
{
}
public function getHandler($direction, $typeName, $format)
{
}
}
class DateHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
{
public static function getSubscribingMethods()
{
}
public function __construct($defaultFormat = \DateTime::ISO8601, $defaultTimezone = 'UTC', $xmlCData = true)
{
}
public function serializeDateTime(\JMS\Serializer\VisitorInterface $visitor, \DateTime $date, array $type, \JMS\Serializer\Context $context)
{
}
public function serializeDateTimeImmutable(\JMS\Serializer\VisitorInterface $visitor, \DateTimeImmutable $date, array $type, \JMS\Serializer\Context $context)
{
}
public function serializeDateInterval(\JMS\Serializer\VisitorInterface $visitor, \DateInterval $date, array $type, \JMS\Serializer\Context $context)
{
}
public function deserializeDateTimeFromXml(\JMS\Serializer\XmlDeserializationVisitor $visitor, $data, array $type)
{
}
public function deserializeDateTimeImmutableFromXml(\JMS\Serializer\XmlDeserializationVisitor $visitor, $data, array $type)
{
}
public function deserializeDateIntervalFromXml(\JMS\Serializer\XmlDeserializationVisitor $visitor, $data, array $type)
{
}
public function deserializeDateTimeFromJson(\JMS\Serializer\JsonDeserializationVisitor $visitor, $data, array $type)
{
}
public function deserializeDateTimeImmutableFromJson(\JMS\Serializer\JsonDeserializationVisitor $visitor, $data, array $type)
{
}
public function deserializeDateIntervalFromJson(\JMS\Serializer\JsonDeserializationVisitor $visitor, $data, array $type)
{
}
/**
* @param \DateInterval $dateInterval
* @return string
*/
public function format(\DateInterval $dateInterval)
{
}
}
class LazyHandlerRegistry extends \JMS\Serializer\Handler\HandlerRegistry
{
public function __construct(\Symfony\Component\DependencyInjection\ContainerInterface $container, array $handlers = array())
{
}
public function registerHandler($direction, $typeName, $format, $handler)
{
}
public function getHandler($direction, $typeName, $format)
{
}
}
class FormErrorHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
{
public static function getSubscribingMethods()
{
}
public function __construct(\Symfony\Component\Translation\TranslatorInterface $translator)
{
}
public function serializeFormToXml(\JMS\Serializer\XmlSerializationVisitor $visitor, \Symfony\Component\Form\Form $form, array $type)
{
}
public function serializeFormToJson(\JMS\Serializer\JsonSerializationVisitor $visitor, \Symfony\Component\Form\Form $form, array $type)
{
}
public function serializeFormToYml(\JMS\Serializer\YamlSerializationVisitor $visitor, \Symfony\Component\Form\Form $form, array $type)
{
}
public function serializeFormErrorToXml(\JMS\Serializer\XmlSerializationVisitor $visitor, \Symfony\Component\Form\FormError $formError, array $type)
{
}
public function serializeFormErrorToJson(\JMS\Serializer\JsonSerializationVisitor $visitor, \Symfony\Component\Form\FormError $formError, array $type)
{
}
public function serializeFormErrorToYml(\JMS\Serializer\YamlSerializationVisitor $visitor, \Symfony\Component\Form\FormError $formError, array $type)
{
}
}
/**
* @author Asmir Mustafic <goetas@gmail.com>
*/
class StdClassHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
{
public static function getSubscribingMethods()
{
}
public function serializeStdClass(\JMS\Serializer\VisitorInterface $visitor, \stdClass $stdClass, array $type, \JMS\Serializer\Context $context)
{
}
}
class ConstraintViolationHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
{
public static function getSubscribingMethods()
{
}
public function serializeListToXml(\JMS\Serializer\XmlSerializationVisitor $visitor, \Symfony\Component\Validator\ConstraintViolationList $list, array $type)
{
}
public function serializeListToJson(\JMS\Serializer\JsonSerializationVisitor $visitor, \Symfony\Component\Validator\ConstraintViolationList $list, array $type, \JMS\Serializer\Context $context)
{
}
public function serializeListToYml(\JMS\Serializer\YamlSerializationVisitor $visitor, \Symfony\Component\Validator\ConstraintViolationList $list, array $type, \JMS\Serializer\Context $context)
{
}
public function serializeViolationToXml(\JMS\Serializer\XmlSerializationVisitor $visitor, \Symfony\Component\Validator\ConstraintViolation $violation, array $type = null)
{
}
public function serializeViolationToJson(\JMS\Serializer\JsonSerializationVisitor $visitor, \Symfony\Component\Validator\ConstraintViolation $violation, array $type = null)
{
}
public function serializeViolationToYml(\JMS\Serializer\YamlSerializationVisitor $visitor, \Symfony\Component\Validator\ConstraintViolation $violation, array $type = null)
{
}
}
}
namespace JMS\Serializer {
/**
* Handles traversal along the object graph.
*
* This class handles traversal along the graph, and calls different methods
* on visitors, or custom handlers to process its nodes.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
final class GraphNavigator
{
const DIRECTION_SERIALIZATION = 1;
const DIRECTION_DESERIALIZATION = 2;
/**
* Parses a direction string to one of the direction constants.
*
* @param string $dirStr
*
* @return integer
*/
public static function parseDirection($dirStr)
{
}
public function __construct(\Metadata\MetadataFactoryInterface $metadataFactory, \JMS\Serializer\Handler\HandlerRegistryInterface $handlerRegistry, \JMS\Serializer\Construction\ObjectConstructorInterface $objectConstructor, \JMS\Serializer\EventDispatcher\EventDispatcherInterface $dispatcher = null, \JMS\Serializer\Expression\ExpressionEvaluatorInterface $expressionEvaluator = null)
{
}
/**
* Called for each node of the graph that is being traversed.
*
* @param mixed $data the data depends on the direction, and type of visitor
* @param null|array $type array has the format ["name" => string, "params" => array]
* @param Context $context
* @return mixed the return value depends on the direction, and type of visitor
*/
public function accept($data, array $type = null, \JMS\Serializer\Context $context)
{
}
}
/**
* Serialization Visitor for the YAML format.
*
* @see http://www.yaml.org/spec/
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class YamlSerializationVisitor extends \JMS\Serializer\AbstractVisitor
{
public $writer;
public function __construct(\JMS\Serializer\Naming\PropertyNamingStrategyInterface $namingStrategy, \JMS\Serializer\Accessor\AccessorStrategyInterface $accessorStrategy = null)
{
}
public function setNavigator(\JMS\Serializer\GraphNavigator $navigator)
{
}
public function visitNull($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitString($data, array $type, \JMS\Serializer\Context $context)
{
}
/**
* @param array $data
* @param array $type
*/
public function visitArray($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitBoolean($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitDouble($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitInteger($data, array $type, \JMS\Serializer\Context $context)
{
}
public function startVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitProperty(\JMS\Serializer\Metadata\PropertyMetadata $metadata, $data, \JMS\Serializer\Context $context)
{
}
public function endVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function setCurrentMetadata(\JMS\Serializer\Metadata\PropertyMetadata $metadata)
{
}
public function revertCurrentMetadata()
{
}
public function getNavigator()
{
}
public function getResult()
{
}
}
}
namespace JMS\Serializer\Exception {
/**
* Base exception for the Serializer.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface Exception
{
}
/**
* LogicException for the Serializer.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class LogicException extends \LogicException implements \JMS\Serializer\Exception\Exception
{
}
/**
* @author Asmir Mustafic <goetas@gmail.com>
*/
class ExpressionLanguageRequiredException extends \JMS\Serializer\Exception\LogicException
{
}
/**
* RuntimeException for the Serializer.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class RuntimeException extends \RuntimeException implements \JMS\Serializer\Exception\Exception
{
}
/**
* InvalidArgumentException for the Serializer.
*
* @author Asmir Mustafic <goetas@gmail.com>
*/
class ObjectConstructionException extends \JMS\Serializer\Exception\RuntimeException implements \JMS\Serializer\Exception\Exception
{
}
class XmlErrorException extends \JMS\Serializer\Exception\RuntimeException
{
public function __construct(\LibXMLError $error)
{
}
public function getXmlError()
{
}
}
/**
* InvalidArgumentException for the Serializer.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class InvalidArgumentException extends \InvalidArgumentException implements \JMS\Serializer\Exception\Exception
{
}
class UnsupportedFormatException extends \JMS\Serializer\Exception\InvalidArgumentException
{
}
class ValidationFailedException extends \JMS\Serializer\Exception\RuntimeException
{
public function __construct(\Symfony\Component\Validator\ConstraintViolationListInterface $list)
{
}
/**
* @return ConstraintViolationListInterface
*/
public function getConstraintViolationList()
{
}
}
}
namespace JMS\Serializer\Accessor {
/**
* @author Asmir Mustafic <goetas@gmail.com>
*/
interface AccessorStrategyInterface
{
/**
* @param object $object
* @param PropertyMetadata $metadata
* @return mixed
*/
public function getValue($object, \JMS\Serializer\Metadata\PropertyMetadata $metadata);
/**
* @param object $object
* @param mixed $value
* @param PropertyMetadata $metadata
* @return void
*/
public function setValue($object, $value, \JMS\Serializer\Metadata\PropertyMetadata $metadata);
}
/**
* @author Asmir Mustafic <goetas@gmail.com>
*/
class ExpressionAccessorStrategy implements \JMS\Serializer\Accessor\AccessorStrategyInterface
{
public function __construct(\JMS\Serializer\Expression\ExpressionEvaluatorInterface $evaluator, \JMS\Serializer\Accessor\AccessorStrategyInterface $fallback)
{
}
public function getValue($object, \JMS\Serializer\Metadata\PropertyMetadata $metadata)
{
}
public function setValue($object, $value, \JMS\Serializer\Metadata\PropertyMetadata $metadata)
{
}
}
/**
* @author Asmir Mustafic <goetas@gmail.com>
*/
class DefaultAccessorStrategy implements \JMS\Serializer\Accessor\AccessorStrategyInterface
{
public function getValue($object, \JMS\Serializer\Metadata\PropertyMetadata $metadata)
{
}
public function setValue($object, $value, \JMS\Serializer\Metadata\PropertyMetadata $metadata)
{
}
}
}
namespace JMS\Serializer {
/**
* Builder for serializer instances.
*
* This object makes serializer construction a breeze for projects that do not use
* any special dependency injection container.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class SerializerBuilder
{
public static function create()
{
}
public function __construct()
{
}
public function setAccessorStrategy(\JMS\Serializer\Accessor\AccessorStrategyInterface $accessorStrategy)
{
}
protected function getAccessorStrategy()
{
}
public function setExpressionEvaluator(\JMS\Serializer\Expression\ExpressionEvaluatorInterface $expressionEvaluator)
{
}
public function setAnnotationReader(\Doctrine\Common\Annotations\Reader $reader)
{
}
public function setDebug($bool)
{
}
public function setCacheDir($dir)
{
}
public function addDefaultHandlers()
{
}
public function configureHandlers(\Closure $closure)
{
}
public function addDefaultListeners()
{
}
public function configureListeners(\Closure $closure)
{
}
public function setObjectConstructor(\JMS\Serializer\Construction\ObjectConstructorInterface $constructor)
{
}
public function setPropertyNamingStrategy(\JMS\Serializer\Naming\PropertyNamingStrategyInterface $propertyNamingStrategy)
{
}
public function setSerializationVisitor($format, \JMS\Serializer\VisitorInterface $visitor)
{
}
public function setDeserializationVisitor($format, \JMS\Serializer\VisitorInterface $visitor)
{
}
public function addDefaultSerializationVisitors()
{
}
public function addDefaultDeserializationVisitors()
{
}
/**
* @param Boolean $include Whether to include the metadata from the interfaces
*
* @return SerializerBuilder
*/
public function includeInterfaceMetadata($include)
{
}
/**
* Sets a map of namespace prefixes to directories.
*
* This method overrides any previously defined directories.
*
* @param array <string,string> $namespacePrefixToDirMap
*
* @return SerializerBuilder
*
* @throws InvalidArgumentException When a directory does not exist
*/
public function setMetadataDirs(array $namespacePrefixToDirMap)
{
}
/**
* Adds a directory where the serializer will look for class metadata.
*
* The namespace prefix will make the names of the actual metadata files a bit shorter. For example, let's assume
* that you have a directory where you only store metadata files for the ``MyApplication\Entity`` namespace.
*
* If you use an empty prefix, your metadata files would need to look like:
*
* ``my-dir/MyApplication.Entity.SomeObject.yml``
* ``my-dir/MyApplication.Entity.OtherObject.xml``
*
* If you use ``MyApplication\Entity`` as prefix, your metadata files would need to look like:
*
* ``my-dir/SomeObject.yml``
* ``my-dir/OtherObject.yml``
*
* Please keep in mind that you currently may only have one directory per namespace prefix.
*
* @param string $dir The directory where metadata files are located.
* @param string $namespacePrefix An optional prefix if you only store metadata for specific namespaces in this directory.
*
* @return SerializerBuilder
*
* @throws InvalidArgumentException When a directory does not exist
* @throws InvalidArgumentException When a directory has already been registered
*/
public function addMetadataDir($dir, $namespacePrefix = '')
{
}
/**
* Adds a map of namespace prefixes to directories.
*
* @param array <string,string> $namespacePrefixToDirMap
*
* @return SerializerBuilder
*/
public function addMetadataDirs(array $namespacePrefixToDirMap)
{
}
/**
* Similar to addMetadataDir(), but overrides an existing entry.
*
* @param string $dir
* @param string $namespacePrefix
*
* @return SerializerBuilder
*
* @throws InvalidArgumentException When a directory does not exist
* @throws InvalidArgumentException When no directory is configured for the ns prefix
*/
public function replaceMetadataDir($dir, $namespacePrefix = '')
{
}
public function setMetadataDriverFactory(\JMS\Serializer\Builder\DriverFactoryInterface $driverFactory)
{
}
/**
* @param SerializationContextFactoryInterface|callable $serializationContextFactory
*
* @return self
*/
public function setSerializationContextFactory($serializationContextFactory)
{
}
/**
* @param DeserializationContextFactoryInterface|callable $deserializationContextFactory
*
* @return self
*/
public function setDeserializationContextFactory($deserializationContextFactory)
{
}
public function build()
{
}
}
class JsonSerializationVisitor extends \JMS\Serializer\GenericSerializationVisitor
{
public function setNavigator(\JMS\Serializer\GraphNavigator $navigator)
{
}
/**
* @return GraphNavigator
*/
public function getNavigator()
{
}
public function visitNull($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitString($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitBoolean($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitInteger($data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitDouble($data, array $type, \JMS\Serializer\Context $context)
{
}
/**
* @param array $data
* @param array $type
* @param Context $context
* @return mixed
*/
public function visitArray($data, array $type, \JMS\Serializer\Context $context)
{
}
public function startVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function endVisitingObject(\JMS\Serializer\Metadata\ClassMetadata $metadata, $data, array $type, \JMS\Serializer\Context $context)
{
}
public function visitProperty(\JMS\Serializer\Metadata\PropertyMetadata $metadata, $data, \JMS\Serializer\Context $context)
{
}
/**
* Allows you to add additional data to the current object/root element.
* @deprecated use setData instead
* @param string $key
* @param integer|float|boolean|string|array|null $value This value must either be a regular scalar, or an array.
* It must not contain any objects anymore.
*/
public function addData($key, $value)
{
}
/**
* Checks if some data key exists.
*
* @param string $key
* @return boolean
*/
public function hasData($key)
{
}
/**
* Allows you to replace existing data on the current object/root element.
*
* @param string $key
* @param integer|float|boolean|string|array|null $value This value must either be a regular scalar, or an array.
* It must not contain any objects anymore.
*/
public function setData($key, $value)
{
}
public function getRoot()
{
}
/**
* @param array|\ArrayObject $data the passed data must be understood by whatever encoding function is applied later.
*/
public function setRoot($data)
{
}
public function getResult()
{
}
public function getOptions()
{
}
public function setOptions($options)
{
}
}
}
namespace JMS\Serializer\EventDispatcher {
class Event
{
protected $type;
public function __construct(\JMS\Serializer\Context $context, array $type)
{
}
public function getVisitor()
{
}
public function getContext()
{
}
public function getType()
{
}
/**
* Returns whether further event listeners should be triggered.
*
* @see Event::stopPropagation()
*
* @return bool Whether propagation was already stopped for this event
*/
public function isPropagationStopped()
{
}
/**
* Stops the propagation of the event to further event listeners.
*
* If multiple event listeners are connected to the same event, no
* further event listener will be triggered once any trigger calls
* stopPropagation().
*/
public function stopPropagation()
{
}
}
class ObjectEvent extends \JMS\Serializer\EventDispatcher\Event
{
public function __construct(\JMS\Serializer\Context $context, $object, array $type)
{
}
public function getObject()
{
}
}
class PreSerializeEvent extends \JMS\Serializer\EventDispatcher\ObjectEvent
{
/**
* @param string $typeName
* @param array $params
*/
public function setType($typeName, array $params = array())
{
}
}
abstract class Events
{
const PRE_SERIALIZE = 'serializer.pre_serialize';
const POST_SERIALIZE = 'serializer.post_serialize';
const PRE_DESERIALIZE = 'serializer.pre_deserialize';
const POST_DESERIALIZE = 'serializer.post_deserialize';
}
class PreDeserializeEvent extends \JMS\Serializer\EventDispatcher\Event
{
public function __construct(\JMS\Serializer\DeserializationContext $context, $data, array $type)
{
}
public function setType($name, array $params = array())
{
}
public function getData()
{
}
public function setData($data)
{
}
}
interface EventDispatcherInterface
{
/**
* Returns whether there are listeners.
*
* @param string $eventName
* @param string $class
* @param string $format
*
* @return boolean
*/
public function hasListeners($eventName, $class, $format);
/**
* Dispatches an event.
*
* The listeners/subscribers are called in the same order in which they
* were added to the dispatcher.
*
* @param string $eventName
* @param string $class
* @param string $format
* @param Event $event
* @return void
*/
public function dispatch($eventName, $class, $format, \JMS\Serializer\EventDispatcher\Event $event);
/**
* Adds a listener.
*
* @param string $eventName
* @param callable $callable
* @param string|null $class
* @param string|null $format
* @return void
*/
public function addListener($eventName, $callable, $class = null, $format = null);
/**
* Adds a subscribers.
*
* @param EventSubscriberInterface $subscriber
* @return void
*/
public function addSubscriber(\JMS\Serializer\EventDispatcher\EventSubscriberInterface $subscriber);
}
/**
* Light-weight event dispatcher.
*
* This implementation focuses primarily on performance, and dispatching
* events for certain classes. It is not a general purpose event dispatcher.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class EventDispatcher implements \JMS\Serializer\EventDispatcher\EventDispatcherInterface
{
public static function getDefaultMethodName($eventName)
{
}
/**
* Sets the listeners.
*
* @param array $listeners
*/
public function setListeners(array $listeners)
{
}
public function addListener($eventName, $callable, $class = null, $format = null)
{
}
public function addSubscriber(\JMS\Serializer\EventDispatcher\EventSubscriberInterface $subscriber)
{
}
public function hasListeners($eventName, $class, $format)
{
}
public function dispatch($eventName, $class, $format, \JMS\Serializer\EventDispatcher\Event $event)
{
}
/**
* @param string $eventName
* @param string $loweredClass
* @param string $format
*
* @return array An array of listeners
*/
protected function initializeListeners($eventName, $loweredClass, $format)
{
}
}
class LazyEventDispatcher extends \JMS\Serializer\EventDispatcher\EventDispatcher
{
public function __construct(\Symfony\Component\DependencyInjection\ContainerInterface $container)
{
}
/**
* {@inheritdoc}
*/
protected function initializeListeners($eventName, $loweredClass, $format)
{
}
}
interface EventSubscriberInterface
{
/**
* Returns the events to which this class has subscribed.
*
* Return format:
* array(
* array('event' => 'the-event-name', 'method' => 'onEventName', 'class' => 'some-class', 'format' => 'json'),
* array(...),
* )
*
* The class may be omitted if the class wants to subscribe to events of all classes.
* Same goes for the format key.
*
* @return array
*/
public static function getSubscribedEvents();
}
}
namespace JMS\Serializer\EventDispatcher\Subscriber {
class DoctrineProxySubscriber implements \JMS\Serializer\EventDispatcher\EventSubscriberInterface
{
public function __construct($skipVirtualTypeInit = false, $initializeExcluded = true)
{
}
public function onPreSerialize(\JMS\Serializer\EventDispatcher\PreSerializeEvent $event)
{
}
public function onPreSerializeTypedProxy(\JMS\Serializer\EventDispatcher\PreSerializeEvent $event, $eventName, $class, $format, \JMS\Serializer\EventDispatcher\EventDispatcherInterface $dispatcher)
{
}
public static function getSubscribedEvents()
{
}
}
class SymfonyValidatorSubscriber implements \JMS\Serializer\EventDispatcher\EventSubscriberInterface
{
public function __construct(\Symfony\Component\Validator\ValidatorInterface $validator)
{
}
public static function getSubscribedEvents()
{
}
public function onPostDeserialize(\JMS\Serializer\EventDispatcher\Event $event)
{
}
}
class SymfonyValidatorValidatorSubscriber implements \JMS\Serializer\EventDispatcher\EventSubscriberInterface
{
public function __construct(\Symfony\Component\Validator\Validator\ValidatorInterface $validator)
{
}
public static function getSubscribedEvents()
{
}
public function onPostDeserialize(\JMS\Serializer\EventDispatcher\Event $event)
{
}
}
}
namespace JMS\Serializer\Expression {
/**
* @author Asmir Mustafic <goetas@gmail.com>
*/
interface ExpressionEvaluatorInterface
{
/**
* @param string $expression
* @param array $data
* @return mixed
*/
public function evaluate($expression, array $data = array());
}
/**
* @author Asmir Mustafic <goetas@gmail.com>
*/
class ExpressionEvaluator implements \JMS\Serializer\Expression\ExpressionEvaluatorInterface
{
public function __construct(\Symfony\Component\ExpressionLanguage\ExpressionLanguage $expressionLanguage, array $context = array(), array $cache = array())
{
}
/**
* @param string $name
* @param mixed $value
*/
public function setContextVariable($name, $value)
{
}
/**
* @param string $expression
* @param array $data
* @return mixed
*/
public function evaluate($expression, array $data = array())
{
}
}
}
namespace JMS\Serializer\Twig {
/**
* @author Asmir Mustafic <goetas@gmail.com>
*/
final class SerializerRuntimeExtension extends \Twig_Extension
{
public function getName()
{
}
public function getFilters()
{
}
public function getFunctions()
{
}
}
/**
* @author Asmir Mustafic <goetas@gmail.com>
*/
final class SerializerRuntimeHelper
{
public function __construct(\JMS\Serializer\SerializerInterface $serializer)
{
}
/**
* @param $object
* @param string $type
* @param SerializationContext|null $context
* @return string
*/
public function serialize($object, $type = 'json', \JMS\Serializer\SerializationContext $context = null)
{
}
}
/**
* Serializer helper twig extension
*
* Basically provides access to JMSSerializer from Twig
*/
class SerializerExtension extends \Twig_Extension
{
protected $serializer;
public function getName()
{
}
public function __construct(\JMS\Serializer\SerializerInterface $serializer)
{
}
public function getFilters()
{
}
public function getFunctions()
{
}
/**
* @param object $object
* @param string $type
* @param SerializationContext $context
*/
public function serialize($object, $type = 'json', \JMS\Serializer\SerializationContext $context = null)
{
}
}
}
namespace JMS\Serializer {
class SerializationContext extends \JMS\Serializer\Context
{
public static function create()
{
}
/**
* @param string $format
*/
public function initialize($format, \JMS\Serializer\VisitorInterface $visitor, \JMS\Serializer\GraphNavigator $navigator, \Metadata\MetadataFactoryInterface $factory)
{
}
public function startVisiting($object)
{
}
public function stopVisiting($object)
{
}
public function isVisiting($object)
{
}
public function getPath()
{
}
public function getDirection()
{
}
public function getDepth()
{
}
public function getObject()
{
}
public function getVisitingStack()
{
}
public function getVisitingSet()
{
}
/**
* @param string $type
* @return $this
*/
public function setInitialType($type)
{
}
/**
* @return string|null
*/
public function getInitialType()
{
}
}
}
namespace Metadata\Driver {
interface FileLocatorInterface
{
/**
* @param \ReflectionClass $class
* @param string $extension
*
* @return string|null
*/
public function findFileForClass(\ReflectionClass $class, $extension);
}
/**
* Forces advanced logic on a file locator.
*
* @author Jordan Stout <j@jrdn.org>
*/
interface AdvancedFileLocatorInterface extends \Metadata\Driver\FileLocatorInterface
{
/**
* Finds all possible metadata files.
*
* @param string $extension
*
* @return array
*/
public function findAllClasses($extension);
}
class FileLocator implements \Metadata\Driver\AdvancedFileLocatorInterface
{
public function __construct(array $dirs)
{
}
public function getDirs()
{
}
/**
* @param \ReflectionClass $class
* @param string $extension
*
* @return string|null
*/
public function findFileForClass(\ReflectionClass $class, $extension)
{
}
/**
* {@inheritDoc}
*/
public function findAllClasses($extension)
{
}
}
final class DriverChain implements \Metadata\Driver\AdvancedDriverInterface
{
public function __construct(array $drivers = array())
{
}
public function addDriver(\Metadata\Driver\DriverInterface $driver)
{
}
public function loadMetadataForClass(\ReflectionClass $class)
{
}
/**
* {@inheritDoc}
*/
public function getAllClassNames()
{
}
}
class LazyLoadingDriver implements \Metadata\Driver\DriverInterface
{
public function __construct(\Symfony\Component\DependencyInjection\ContainerInterface $container, $realDriverId)
{
}
/**
* {@inheritDoc}
*/
public function loadMetadataForClass(\ReflectionClass $class)
{
}
}
}
namespace Metadata {
/**
* Represents the metadata for the entire class hierarchy.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class ClassHierarchyMetadata
{
public $classMetadata = array();
public function addClassMetadata(\Metadata\ClassMetadata $metadata)
{
}
public function getRootClassMetadata()
{
}
public function getOutsideClassMetadata()
{
}
public function isFresh($timestamp)
{
}
}
}
namespace Metadata\Cache {
interface CacheInterface
{
/**
* Loads a class metadata instance from the cache
*
* @param \ReflectionClass $class
*
* @return ClassMetadata
*/
function loadClassMetadataFromCache(\ReflectionClass $class);
/**
* Puts a class metadata instance into the cache
*
* @param ClassMetadata $metadata
*
* @return void
*/
function putClassMetadataInCache(\Metadata\ClassMetadata $metadata);
/**
* Evicts the class metadata for the given class from the cache.
*
* @param \ReflectionClass $class
*
* @return void
*/
function evictClassMetadataFromCache(\ReflectionClass $class);
}
/**
* @author Henrik Bjornskov <henrik@bjrnskov.dk>
*/
class DoctrineCacheAdapter implements \Metadata\Cache\CacheInterface
{
/**
* @param string $prefix
* @param Cache $cache
*/
public function __construct($prefix, \Doctrine\Common\Cache\Cache $cache)
{
}
/**
* {@inheritDoc}
*/
public function loadClassMetadataFromCache(\ReflectionClass $class)
{
}
/**
* {@inheritDoc}
*/
public function putClassMetadataInCache(\Metadata\ClassMetadata $metadata)
{
}
/**
* {@inheritDoc}
*/
public function evictClassMetadataFromCache(\ReflectionClass $class)
{
}
}
class PsrCacheAdapter implements \Metadata\Cache\CacheInterface
{
public function __construct($prefix, \Psr\Cache\CacheItemPoolInterface $pool)
{
}
/**
* {@inheritDoc}
*/
public function loadClassMetadataFromCache(\ReflectionClass $class)
{
}
/**
* {@inheritDoc}
*/
public function putClassMetadataInCache(\Metadata\ClassMetadata $metadata)
{
}
/**
* {@inheritDoc}
*/
public function evictClassMetadataFromCache(\ReflectionClass $class)
{
}
}
class FileCache implements \Metadata\Cache\CacheInterface
{
public function __construct($dir)
{
}
/**
* {@inheritDoc}
*/
public function loadClassMetadataFromCache(\ReflectionClass $class)
{
}
/**
* {@inheritDoc}
*/
public function putClassMetadataInCache(\Metadata\ClassMetadata $metadata)
{
}
/**
* {@inheritDoc}
*/
public function evictClassMetadataFromCache(\ReflectionClass $class)
{
}
}
}
namespace Metadata {
/**
* Represents the metadata for a class that has not metadata.
*
* @author Adrien Brault <adrien.brault@gmail.com>
*/
class NullMetadata extends \Metadata\ClassMetadata
{
}
final class Version
{
const VERSION = '1.4-DEV';
}
/**
* Interface for Metadata Factory implementations.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface MetadataFactoryInterface
{
/**
* Returns the gathered metadata for the given class name.
*
* If the drivers return instances of MergeableClassMetadata, these will be
* merged prior to returning. Otherwise, all metadata for the inheritance
* hierarchy will be returned as ClassHierarchyMetadata unmerged.
*
* If no metadata is available, null is returned.
*
* @param string $className
*
* @return ClassHierarchyMetadata|MergeableClassMetadata|null
*/
public function getMetadataForClass($className);
}
/**
* Interface for advanced Metadata Factory implementations.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
* @author Jordan Stout <j@jrdn.org>
*/
interface AdvancedMetadataFactoryInterface extends \Metadata\MetadataFactoryInterface
{
/**
* Gets all the possible classes.
*
* @throws \RuntimeException if driver does not an advanced driver.
* @return array
*/
public function getAllClassNames();
}
class MetadataFactory implements \Metadata\AdvancedMetadataFactoryInterface
{
/**
* @param DriverInterface $driver
* @param string $hierarchyMetadataClass
* @param boolean $debug
*/
public function __construct(\Metadata\Driver\DriverInterface $driver, $hierarchyMetadataClass = 'Metadata\\ClassHierarchyMetadata', $debug = false)
{
}
/**
* @param boolean $include
*/
public function setIncludeInterfaces($include)
{
}
public function setCache(\Metadata\Cache\CacheInterface $cache)
{
}
/**
* @param string $className
*
* @return ClassHierarchyMetadata|MergeableClassMetadata|null
*/
public function getMetadataForClass($className)
{
}
/**
* {@inheritDoc}
*/
public function getAllClassNames()
{
}
}
/**
* Base class for method metadata.
*
* This class is intended to be extended to add your application specific
* properties, and flags.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class MethodMetadata implements \Serializable
{
public $class;
public $name;
public $reflection;
public function __construct($class, $name)
{
}
/**
* @param object $obj
* @param array $args
*
* @return mixed
*/
public function invoke($obj, array $args = array())
{
}
public function serialize()
{
}
public function unserialize($str)
{
}
}
}
namespace JMS\Parser {
/**
* Abstract Lexer.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
abstract class AbstractLexer
{
public $token;
public $next;
/**
* Returns the name of the given token.
*
* @param integer $type
*
* @return string
*/
public function getName($type)
{
}
public function setInput($str)
{
}
public function reset()
{
}
/**
* Moves the pointer one token forward.
*
* @return boolean if we have not yet reached the end of the input
*/
public function moveNext()
{
}
/**
* Skips the token stream until a token of the given type.
*
* @param integer $type
*
* @return boolean true if a token of the passed type was found, false otherwise.
*/
public function skipUntil($type)
{
}
/**
* @param integer $type
*
* @return boolean
*/
public function isNext($type)
{
}
/**
* @param array<integer> $types
*
* @return boolean
*/
public function isNextAny(array $types)
{
}
/**
* @return \PhpOption\Option<[string,integer,integer]>
*/
public function peek()
{
}
/**
* @return string
*/
protected abstract function getRegex();
/**
* Determines the type of the given value.
*
* This method may also modify the passed value for example to cast them to
* a different PHP type where necessary.
*
* @param string $value
*
* @return array a tupel of type and normalized value
*/
protected abstract function determineTypeAndValue($value);
}
/**
* The simple lexer is a fully usable lexer that does not require sub-classing.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class SimpleLexer extends \JMS\Parser\AbstractLexer
{
public function __construct($regex, array $tokenNames, $typeCallable)
{
}
public function getName($type)
{
}
protected function getRegex()
{
}
protected function determineTypeAndValue($value)
{
}
}
class SyntaxErrorException extends \RuntimeException
{
public function setActualToken(array $actualToken)
{
}
public function setContext($context)
{
}
public function getActualToken()
{
}
public function getContext()
{
}
}
}
namespace FastRoute {
class Route
{
public $httpMethod;
public $regex;
public $variables;
public $handler;
/**
* Constructs a route (value object).
*
* @param string $httpMethod
* @param mixed $handler
* @param string $regex
* @param array $variables
*/
public function __construct($httpMethod, $handler, $regex, $variables)
{
}
/**
* Tests whether this route matches the given string.
*
* @param string $str
*
* @return bool
*/
public function matches($str)
{
}
}
class BadRouteException extends \LogicException
{
}
interface Dispatcher
{
const NOT_FOUND = 0;
const FOUND = 1;
const METHOD_NOT_ALLOWED = 2;
/**
* Dispatches against the provided HTTP method verb and URI.
*
* Returns array with one of the following formats:
*
* [self::NOT_FOUND]
* [self::METHOD_NOT_ALLOWED, ['GET', 'OTHER_ALLOWED_METHODS']]
* [self::FOUND, $handler, ['varName' => 'value', ...]]
*
* @param string $httpMethod
* @param string $uri
*
* @return array
*/
public function dispatch($httpMethod, $uri);
}
interface DataGenerator
{
/**
* Adds a route to the data generator. The route data uses the
* same format that is returned by RouterParser::parser().
*
* The handler doesn't necessarily need to be a callable, it
* can be arbitrary data that will be returned when the route
* matches.
*
* @param string $httpMethod
* @param array $routeData
* @param mixed $handler
*/
public function addRoute($httpMethod, $routeData, $handler);
/**
* Returns dispatcher data in some unspecified format, which
* depends on the used method of dispatch.
*/
public function getData();
}
interface RouteParser
{
/**
* Parses a route string into multiple route data arrays.
*
* The expected output is defined using an example:
*
* For the route string "/fixedRoutePart/{varName}[/moreFixed/{varName2:\d+}]", if {varName} is interpreted as
* a placeholder and [...] is interpreted as an optional route part, the expected result is:
*
* [
* // first route: without optional part
* [
* "/fixedRoutePart/",
* ["varName", "[^/]+"],
* ],
* // second route: with optional part
* [
* "/fixedRoutePart/",
* ["varName", "[^/]+"],
* "/moreFixed/",
* ["varName2", [0-9]+"],
* ],
* ]
*
* Here one route string was converted into two route data arrays.
*
* @param string $route Route string to parse
*
* @return mixed[][] Array of route data arrays
*/
public function parse($route);
}
class RouteCollector
{
protected $routeParser;
protected $dataGenerator;
protected $currentGroupPrefix;
/**
* Constructs a route collector.
*
* @param RouteParser $routeParser
* @param DataGenerator $dataGenerator
*/
public function __construct(\FastRoute\RouteParser $routeParser, \FastRoute\DataGenerator $dataGenerator)
{
}
/**
* Adds a route to the collection.
*
* The syntax used in the $route string depends on the used route parser.
*
* @param string|string[] $httpMethod
* @param string $route
* @param mixed $handler
*/
public function addRoute($httpMethod, $route, $handler)
{
}
/**
* Create a route group with a common prefix.
*
* All routes created in the passed callback will have the given group prefix prepended.
*
* @param string $prefix
* @param callable $callback
*/
public function addGroup($prefix, callable $callback)
{
}
/**
* Adds a GET route to the collection
*
* This is simply an alias of $this->addRoute('GET', $route, $handler)
*
* @param string $route
* @param mixed $handler
*/
public function get($route, $handler)
{
}
/**
* Adds a POST route to the collection
*
* This is simply an alias of $this->addRoute('POST', $route, $handler)
*
* @param string $route
* @param mixed $handler
*/
public function post($route, $handler)
{
}
/**
* Adds a PUT route to the collection
*
* This is simply an alias of $this->addRoute('PUT', $route, $handler)
*
* @param string $route
* @param mixed $handler
*/
public function put($route, $handler)
{
}
/**
* Adds a DELETE route to the collection
*
* This is simply an alias of $this->addRoute('DELETE', $route, $handler)
*
* @param string $route
* @param mixed $handler
*/
public function delete($route, $handler)
{
}
/**
* Adds a PATCH route to the collection
*
* This is simply an alias of $this->addRoute('PATCH', $route, $handler)
*
* @param string $route
* @param mixed $handler
*/
public function patch($route, $handler)
{
}
/**
* Adds a HEAD route to the collection
*
* This is simply an alias of $this->addRoute('HEAD', $route, $handler)
*
* @param string $route
* @param mixed $handler
*/
public function head($route, $handler)
{
}
/**
* Returns the collected route data, as provided by the data generator.
*
* @return array
*/
public function getData()
{
}
}
}
namespace FastRoute\DataGenerator {
abstract class RegexBasedAbstract implements \FastRoute\DataGenerator
{
protected $staticRoutes = [];
protected $methodToRegexToRoutesMap = [];
protected abstract function getApproxChunkSize();
protected abstract function processChunk($regexToRoutesMap);
public function addRoute($httpMethod, $routeData, $handler)
{
}
public function getData()
{
}
}
class GroupCountBased extends \FastRoute\DataGenerator\RegexBasedAbstract
{
protected function getApproxChunkSize()
{
}
protected function processChunk($regexToRoutesMap)
{
}
}
class GroupPosBased extends \FastRoute\DataGenerator\RegexBasedAbstract
{
protected function getApproxChunkSize()
{
}
protected function processChunk($regexToRoutesMap)
{
}
}
class CharCountBased extends \FastRoute\DataGenerator\RegexBasedAbstract
{
protected function getApproxChunkSize()
{
}
protected function processChunk($regexToRoutesMap)
{
}
}
class MarkBased extends \FastRoute\DataGenerator\RegexBasedAbstract
{
protected function getApproxChunkSize()
{
}
protected function processChunk($regexToRoutesMap)
{
}
}
}
namespace FastRoute\RouteParser {
/**
* Parses route strings of the following form:
*
* "/user/{name}[/{id:[0-9]+}]"
*/
class Std implements \FastRoute\RouteParser
{
const VARIABLE_REGEX = <<<'REGEX'
\{
\s* ([a-zA-Z_][a-zA-Z0-9_-]*) \s*
(?:
: \s* ([^{}]*(?:\{(?-1)\}[^{}]*)*)
)?
\}
REGEX;
const DEFAULT_DISPATCH_REGEX = '[^/]+';
public function parse($route)
{
}
}
}
namespace FastRoute\Dispatcher {
abstract class RegexBasedAbstract implements \FastRoute\Dispatcher
{
protected $staticRouteMap;
protected $variableRouteData;
protected abstract function dispatchVariableRoute($routeData, $uri);
public function dispatch($httpMethod, $uri)
{
}
}
class GroupCountBased extends \FastRoute\Dispatcher\RegexBasedAbstract
{
public function __construct($data)
{
}
protected function dispatchVariableRoute($routeData, $uri)
{
}
}
class GroupPosBased extends \FastRoute\Dispatcher\RegexBasedAbstract
{
public function __construct($data)
{
}
protected function dispatchVariableRoute($routeData, $uri)
{
}
}
class CharCountBased extends \FastRoute\Dispatcher\RegexBasedAbstract
{
public function __construct($data)
{
}
protected function dispatchVariableRoute($routeData, $uri)
{
}
}
class MarkBased extends \FastRoute\Dispatcher\RegexBasedAbstract
{
public function __construct($data)
{
}
protected function dispatchVariableRoute($routeData, $uri)
{
}
}
}
namespace JsonSchema {
/**
* Take in an object that's a JSON schema and take care of all $ref references
*
* @author Tyler Akins <fidian@rumkin.com>
* @see README.md
*/
class RefResolver
{
/**
* HACK to prevent too many recursive expansions.
* Happens e.g. when you want to validate a schema against the schema
* definition.
*
* @var integer
*/
protected static $depth = 0;
/**
* maximum references depth
* @var integer
*/
public static $maxDepth = 7;
/**
* @var UriRetrieverInterface
*/
protected $uriRetriever = null;
/**
* @var object
*/
protected $rootSchema = null;
/**
* @param UriRetriever $retriever
*/
public function __construct($retriever = null)
{
}
/**
* Retrieves a given schema given a ref and a source URI
*
* @param string $ref Reference from schema
* @param string $sourceUri URI where original schema was located
* @return object Schema
*/
public function fetchRef($ref, $sourceUri)
{
}
/**
* Return the URI Retriever, defaulting to making a new one if one
* was not yet set.
*
* @return UriRetriever
*/
public function getUriRetriever()
{
}
/**
* Resolves all $ref references for a given schema. Recurses through
* the object to resolve references of any child schemas.
*
* The 'format' property is omitted because it isn't required for
* validation. Theoretically, this class could be extended to look
* for URIs in formats: "These custom formats MAY be expressed as
* an URI, and this URI MAY reference a schema of that format."
*
* The 'id' property is not filled in, but that could be made to happen.
*
* @param object $schema JSON Schema to flesh out
* @param string $sourceUri URI where this schema was located
*/
public function resolve($schema, $sourceUri = null)
{
}
/**
* Given an object and a property name, that property should be an
* array whose values can be schemas.
*
* @param object $schema JSON Schema to flesh out
* @param string $propertyName Property to work on
* @param string $sourceUri URI where this schema was located
*/
public function resolveArrayOfSchemas($schema, $propertyName, $sourceUri)
{
}
/**
* Given an object and a property name, that property should be an
* object whose properties are schema objects.
*
* @param object $schema JSON Schema to flesh out
* @param string $propertyName Property to work on
* @param string $sourceUri URI where this schema was located
*/
public function resolveObjectOfSchemas($schema, $propertyName, $sourceUri)
{
}
/**
* Given an object and a property name, that property should be a
* schema object.
*
* @param object $schema JSON Schema to flesh out
* @param string $propertyName Property to work on
* @param string $sourceUri URI where this schema was located
*/
public function resolveProperty($schema, $propertyName, $sourceUri)
{
}
/**
* Look for the $ref property in the object. If found, remove the
* reference and augment this object with the contents of another
* schema.
*
* @param object $schema JSON Schema to flesh out
* @param string $sourceUri URI where this schema was located
*/
public function resolveRef($schema, $sourceUri)
{
}
/**
* Set URI Retriever for use with the Ref Resolver
*
* @param UriRetriever $retriever
* @return $this for chaining
*/
public function setUriRetriever(\JsonSchema\Uri\UriRetriever $retriever)
{
}
protected function resolveRefSegment($data, $pathParts)
{
}
}
}
namespace JsonSchema\Uri {
/**
* Retrieves JSON Schema URIs
*
* @author Tyler Akins <fidian@rumkin.com>
*/
class UriRetriever
{
/**
* @var null|UriRetrieverInterface
*/
protected $uriRetriever = null;
/**
* Guarantee the correct media type was encountered
*
* @param UriRetrieverInterface $uriRetriever
* @param string $uri
* @return bool|void
*/
public function confirmMediaType($uriRetriever, $uri)
{
}
/**
* Get a URI Retriever
*
* If none is specified, sets a default FileGetContents retriever and
* returns that object.
*
* @return UriRetrieverInterface
*/
public function getUriRetriever()
{
}
/**
* Resolve a schema based on pointer
*
* URIs can have a fragment at the end in the format of
* #/path/to/object and we are to look up the 'path' property of
* the first object then the 'to' and 'object' properties.
*
* @param object $jsonSchema JSON Schema contents
* @param string $uri JSON Schema URI
* @return object JSON Schema after walking down the fragment pieces
*
* @throws ResourceNotFoundException
*/
public function resolvePointer($jsonSchema, $uri)
{
}
/**
* Retrieve a URI
*
* @param string $uri JSON Schema URI
* @param string|null $baseUri
* @return object JSON Schema contents
*/
public function retrieve($uri, $baseUri = null)
{
}
/**
* Fetch a schema from the given URI, json-decode it and return it.
* Caches schema objects.
*
* @param string $fetchUri Absolute URI
*
* @return object JSON schema object
*/
protected function loadSchema($fetchUri)
{
}
/**
* Set the URI Retriever
*
* @param UriRetrieverInterface $uriRetriever
* @return $this for chaining
*/
public function setUriRetriever(\JsonSchema\Uri\Retrievers\UriRetrieverInterface $uriRetriever)
{
}
/**
* Parses a URI into five main components
*
* @param string $uri
* @return array
*/
public function parse($uri)
{
}
/**
* Builds a URI based on n array with the main components
*
* @param array $components
* @return string
*/
public function generate(array $components)
{
}
/**
* Resolves a URI
*
* @param string $uri Absolute or relative
* @param string $baseUri Optional base URI
* @return string
*/
public function resolve($uri, $baseUri = null)
{
}
/**
* @param string $uri
* @return boolean
*/
public function isValid($uri)
{
}
}
/**
* Resolves JSON Schema URIs
*
* @author Sander Coolen <sander@jibber.nl>
*/
class UriResolver
{
/**
* Parses a URI into five main components
*
* @param string $uri
* @return array
*/
public function parse($uri)
{
}
/**
* Builds a URI based on n array with the main components
*
* @param array $components
* @return string
*/
public function generate(array $components)
{
}
/**
* Resolves a URI
*
* @param string $uri Absolute or relative
* @param string $baseUri Optional base URI
* @return string Absolute URI
*/
public function resolve($uri, $baseUri = null)
{
}
/**
* Tries to glue a relative path onto an absolute one
*
* @param string $relativePath
* @param string $basePath
* @return string Merged path
* @throws UriResolverException
*/
public static function combineRelativePathWithBasePath($relativePath, $basePath)
{
}
/**
* @param string $uri
* @return boolean
*/
public function isValid($uri)
{
}
}
}
namespace JsonSchema\Uri\Retrievers {
/**
* Interface for URI retrievers
*
* @author Sander Coolen <sander@jibber.nl>
*/
interface UriRetrieverInterface
{
/**
* Retrieve a schema from the specified URI
* @param string $uri URI that resolves to a JSON schema
* @throws \JsonSchema\Exception\ResourceNotFoundException
* @return mixed string|null
*/
public function retrieve($uri);
/**
* Get media content type
* @return string
*/
public function getContentType();
}
/**
* AbstractRetriever implements the default shared behavior
* that all decendant Retrievers should inherit
* @author Steven Garcia <webwhammy@gmail.com>
*/
abstract class AbstractRetriever implements \JsonSchema\Uri\Retrievers\UriRetrieverInterface
{
/**
* Media content type
* @var string
*/
protected $contentType;
/**
* {@inheritDoc}
* @see \JsonSchema\Uri\Retrievers\UriRetrieverInterface::getContentType()
*/
public function getContentType()
{
}
}
/**
* Tries to retrieve JSON schemas from a URI using file_get_contents()
*
* @author Sander Coolen <sander@jibber.nl>
*/
class FileGetContents extends \JsonSchema\Uri\Retrievers\AbstractRetriever
{
protected $messageBody;
/**
* {@inheritDoc}
* @see \JsonSchema\Uri\Retrievers\UriRetrieverInterface::retrieve()
*/
public function retrieve($uri)
{
}
/**
* @param string $header
* @return string|null
*/
protected static function getContentTypeMatchInHeader($header)
{
}
}
/**
* Tries to retrieve JSON schemas from a URI using cURL library
*
* @author Sander Coolen <sander@jibber.nl>
*/
class Curl extends \JsonSchema\Uri\Retrievers\AbstractRetriever
{
protected $messageBody;
public function __construct()
{
}
/**
* {@inheritDoc}
* @see \JsonSchema\Uri\Retrievers\UriRetrieverInterface::retrieve()
*/
public function retrieve($uri)
{
}
/**
* @param string $response cURL HTTP response
* @return boolean Whether the Content-Type header was found or not
*/
protected function fetchContentType($response)
{
}
}
/**
* URI retrieved based on a predefined array of schemas
*
* @example
*
* $retriever = new PredefinedArray(array(
* 'http://acme.com/schemas/person#' => '{ ... }',
* 'http://acme.com/schemas/address#' => '{ ... }',
* ))
*
* $schema = $retriever->retrieve('http://acme.com/schemas/person#');
*/
class PredefinedArray extends \JsonSchema\Uri\Retrievers\AbstractRetriever
{
/**
* Constructor
*
* @param array $schemas
* @param string $contentType
*/
public function __construct(array $schemas, $contentType = \JsonSchema\Validator::SCHEMA_MEDIA_TYPE)
{
}
/**
* {@inheritDoc}
* @see \JsonSchema\Uri\Retrievers\UriRetrieverInterface::retrieve()
*/
public function retrieve($uri)
{
}
}
}
namespace JsonSchema\Constraints {
/**
* The Constraints Interface
*
* @author Robert Schönthal <seroscho@googlemail.com>
*/
interface ConstraintInterface
{
/**
* returns all collected errors
*
* @return array
*/
public function getErrors();
/**
* adds errors to this validator
*
* @param array $errors
*/
public function addErrors(array $errors);
/**
* adds an error
*
* @param string $path
* @param string $message
* @param string $constraint the constraint/rule that is broken, e.g.: 'minLength'
* @param array $more more array elements to add to the error
*/
public function addError($path, $message, $constraint = '', array $more = null);
/**
* checks if the validator has not raised errors
*
* @return boolean
*/
public function isValid();
/**
* invokes the validation of an element
*
* @abstract
* @param mixed $value
* @param mixed $schema
* @param mixed $path
* @param mixed $i
*/
public function check($value, $schema = null, $path = null, $i = null);
}
/**
* The Base Constraints, all Validators should extend this class
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
*/
abstract class Constraint implements \JsonSchema\Constraints\ConstraintInterface
{
protected $checkMode = self::CHECK_MODE_NORMAL;
protected $uriRetriever;
protected $errors = array();
protected $inlineSchemaProperty = '$schema';
const CHECK_MODE_NORMAL = 1;
const CHECK_MODE_TYPE_CAST = 2;
/**
* @param int $checkMode
* @param UriRetriever $uriRetriever
* @param Factory $factory
*/
public function __construct($checkMode = self::CHECK_MODE_NORMAL, \JsonSchema\Uri\UriRetriever $uriRetriever = null, \JsonSchema\Constraints\Factory $factory = null)
{
}
/**
* @return UriRetriever $uriRetriever
*/
public function getUriRetriever()
{
}
/**
* @return Factory
*/
public function getFactory()
{
}
/**
* @param UriRetriever $uriRetriever
*/
public function setUriRetriever(\JsonSchema\Uri\UriRetriever $uriRetriever)
{
}
/**
* {@inheritDoc}
*/
public function addError($path, $message, $constraint = '', array $more = null)
{
}
/**
* {@inheritDoc}
*/
public function addErrors(array $errors)
{
}
/**
* {@inheritDoc}
*/
public function getErrors()
{
}
/**
* {@inheritDoc}
*/
public function isValid()
{
}
/**
* Clears any reported errors. Should be used between
* multiple validation checks.
*/
public function reset()
{
}
/**
* Bubble down the path
*
* @param string $path Current path
* @param mixed $i What to append to the path
*
* @return string
*/
protected function incrementPath($path, $i)
{
}
/**
* Validates an array
*
* @param mixed $value
* @param mixed $schema
* @param mixed $path
* @param mixed $i
*/
protected function checkArray($value, $schema = null, $path = null, $i = null)
{
}
/**
* Validates an object
*
* @param mixed $value
* @param mixed $schema
* @param mixed $path
* @param mixed $i
* @param mixed $patternProperties
*/
protected function checkObject($value, $schema = null, $path = null, $i = null, $patternProperties = null)
{
}
/**
* Validates the type of a property
*
* @param mixed $value
* @param mixed $schema
* @param mixed $path
* @param mixed $i
*/
protected function checkType($value, $schema = null, $path = null, $i = null)
{
}
/**
* Checks a undefined element
*
* @param mixed $value
* @param mixed $schema
* @param mixed $path
* @param mixed $i
*/
protected function checkUndefined($value, $schema = null, $path = null, $i = null)
{
}
/**
* Checks a string element
*
* @param mixed $value
* @param mixed $schema
* @param mixed $path
* @param mixed $i
*/
protected function checkString($value, $schema = null, $path = null, $i = null)
{
}
/**
* Checks a number element
*
* @param mixed $value
* @param mixed $schema
* @param mixed $path
* @param mixed $i
*/
protected function checkNumber($value, $schema = null, $path = null, $i = null)
{
}
/**
* Checks a enum element
*
* @param mixed $value
* @param mixed $schema
* @param mixed $path
* @param mixed $i
*/
protected function checkEnum($value, $schema = null, $path = null, $i = null)
{
}
protected function checkFormat($value, $schema = null, $path = null, $i = null)
{
}
/**
* @param string $uri JSON Schema URI
* @return string JSON Schema contents
*/
protected function retrieveUri($uri)
{
}
}
/**
* The UndefinedConstraint Constraints
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
*/
class UndefinedConstraint extends \JsonSchema\Constraints\Constraint
{
/**
* {@inheritDoc}
*/
public function check($value, $schema = null, $path = null, $i = null)
{
}
/**
* Validates the value against the types
*
* @param mixed $value
* @param mixed $schema
* @param string $path
* @param string $i
*/
public function validateTypes($value, $schema = null, $path = null, $i = null)
{
}
/**
* Validates common properties
*
* @param mixed $value
* @param mixed $schema
* @param string $path
* @param string $i
*/
protected function validateCommonProperties($value, $schema = null, $path = null, $i = "")
{
}
/**
* Validate allOf, anyOf, and oneOf properties
*
* @param mixed $value
* @param mixed $schema
* @param string $path
* @param string $i
*/
protected function validateOfProperties($value, $schema, $path, $i = "")
{
}
/**
* Validate dependencies
*
* @param mixed $value
* @param mixed $dependencies
* @param string $path
* @param string $i
*/
protected function validateDependencies($value, $dependencies, $path, $i = "")
{
}
protected function validateUri($schema, $schemaUri = null)
{
}
}
/**
* The EnumConstraint Constraints, validates an element against a given set of possibilities
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
*/
class EnumConstraint extends \JsonSchema\Constraints\Constraint
{
/**
* {@inheritDoc}
*/
public function check($element, $schema = null, $path = null, $i = null)
{
}
}
/**
* The ObjectConstraint Constraints, validates an object against a given schema
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
*/
class ObjectConstraint extends \JsonSchema\Constraints\Constraint
{
/**
* {@inheritDoc}
*/
function check($element, $definition = null, $path = null, $additionalProp = null, $patternProperties = null)
{
}
public function validatePatternProperties($element, $path, $patternProperties)
{
}
/**
* Validates the element properties
*
* @param \stdClass $element Element to validate
* @param array $matches Matches from patternProperties (if any)
* @param \stdClass $objectDefinition ObjectConstraint definition
* @param string $path Path to test?
* @param mixed $additionalProp Additional properties
*/
public function validateElement($element, $matches, $objectDefinition = null, $path = null, $additionalProp = null)
{
}
/**
* Validates the definition properties
*
* @param \stdClass $element Element to validate
* @param \stdClass $objectDefinition ObjectConstraint definition
* @param string $path Path?
*/
public function validateDefinition($element, $objectDefinition = null, $path = null)
{
}
/**
* retrieves a property from an object or array
*
* @param mixed $element Element to validate
* @param string $property Property to retrieve
* @param mixed $fallback Default value if property is not found
*
* @return mixed
*/
protected function getProperty($element, $property, $fallback = null)
{
}
}
/**
* Factory for centralize constraint initialization.
*/
class Factory
{
/**
* @var UriRetriever $uriRetriever
*/
protected $uriRetriever;
/**
* @var array $constraintMap
*/
protected $constraintMap = array('array' => 'JsonSchema\\Constraints\\CollectionConstraint', 'collection' => 'JsonSchema\\Constraints\\CollectionConstraint', 'object' => 'JsonSchema\\Constraints\\ObjectConstraint', 'type' => 'JsonSchema\\Constraints\\TypeConstraint', 'undefined' => 'JsonSchema\\Constraints\\UndefinedConstraint', 'string' => 'JsonSchema\\Constraints\\StringConstraint', 'number' => 'JsonSchema\\Constraints\\NumberConstraint', 'enum' => 'JsonSchema\\Constraints\\EnumConstraint', 'format' => 'JsonSchema\\Constraints\\FormatConstraint', 'schema' => 'JsonSchema\\Constraints\\SchemaConstraint', 'validator' => 'JsonSchema\\Validator');
/**
* @param UriRetriever $uriRetriever
*/
public function __construct(\JsonSchema\Uri\UriRetriever $uriRetriever = null)
{
}
/**
* @return UriRetriever
*/
public function getUriRetriever()
{
}
/**
* @param string $name
* @param string $class
* @return Factory
*/
public function setConstraintClass($name, $class)
{
}
/**
* Create a constraint instance for the given constraint name.
*
* @param string $constraintName
* @return ConstraintInterface|ObjectConstraint
* @throws InvalidArgumentException if is not possible create the constraint instance.
*/
public function createInstanceFor($constraintName)
{
}
}
/**
* The NumberConstraint Constraints, validates an number against a given schema
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
*/
class NumberConstraint extends \JsonSchema\Constraints\Constraint
{
/**
* {@inheritDoc}
*/
public function check($element, $schema = null, $path = null, $i = null)
{
}
}
/**
* The SchemaConstraint Constraints, validates an element against a given schema
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
*/
class SchemaConstraint extends \JsonSchema\Constraints\Constraint
{
/**
* {@inheritDoc}
*/
public function check($element, $schema = null, $path = null, $i = null)
{
}
}
/**
* Validates against the "format" property
*
* @author Justin Rainbow <justin.rainbow@gmail.com>
* @link http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5.23
*/
class FormatConstraint extends \JsonSchema\Constraints\Constraint
{
/**
* {@inheritDoc}
*/
public function check($element, $schema = null, $path = null, $i = null)
{
}
protected function validateDateTime($datetime, $format)
{
}
protected function validateRegex($regex)
{
}
protected function validateColor($color)
{
}
protected function validateStyle($style)
{
}
protected function validatePhone($phone)
{
}
protected function validateHostname($host)
{
}
}
/**
* The CollectionConstraint Constraints, validates an array against a given schema
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
*/
class CollectionConstraint extends \JsonSchema\Constraints\Constraint
{
/**
* {@inheritDoc}
*/
public function check($value, $schema = null, $path = null, $i = null)
{
}
/**
* Validates the items
*
* @param array $value
* @param \stdClass $schema
* @param string $path
* @param string $i
*/
protected function validateItems($value, $schema = null, $path = null, $i = null)
{
}
}
/**
* The TypeConstraint Constraints, validates an element against a given type
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
*/
class TypeConstraint extends \JsonSchema\Constraints\Constraint
{
/**
* @var array|string[] type wordings for validation error messages
*/
static $wording = array(
'integer' => 'an integer',
'number' => 'a number',
'boolean' => 'a boolean',
'object' => 'an object',
'array' => 'an array',
'string' => 'a string',
'null' => 'a null',
'any' => NULL,
// validation of 'any' is always true so is not needed in message wording
0 => NULL,
);
/**
* {@inheritDoc}
*/
public function check($value = null, $schema = null, $path = null, $i = null)
{
}
/**
* Verifies that a given value is of a certain type
*
* @param mixed $value Value to validate
* @param string $type TypeConstraint to check against
*
* @return boolean
*
* @throws InvalidArgumentException
*/
protected function validateType($value, $type)
{
}
}
/**
* The StringConstraint Constraints, validates an string against a given schema
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
*/
class StringConstraint extends \JsonSchema\Constraints\Constraint
{
/**
* {@inheritDoc}
*/
public function check($element, $schema = null, $path = null, $i = null)
{
}
}
}
namespace JsonSchema\Exception {
/**
* Wrapper for the InvalidSchemaMediaType
*/
class InvalidSchemaMediaTypeException extends \RuntimeException
{
}
/**
* Wrapper for the UriResolverException
*/
class UriResolverException extends \RuntimeException
{
}
/**
* Wrapper for the ResourceNotFoundException
*/
class ResourceNotFoundException extends \RuntimeException
{
}
/**
* Wrapper for the JsonDecodingException
*/
class JsonDecodingException extends \RuntimeException
{
public function __construct($code = JSON_ERROR_NONE, \Exception $previous = null)
{
}
}
/**
* Wrapper for the InvalidArgumentException
*/
class InvalidArgumentException extends \InvalidArgumentException
{
}
/**
* Wrapper for the InvalidSourceUriException
*/
class InvalidSourceUriException extends \JsonSchema\Exception\InvalidArgumentException
{
}
}
namespace JsonSchema {
/**
* A JsonSchema Constraint
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Bruno Prieto Reis <bruno.p.reis@gmail.com>
* @see README.md
*/
class Validator extends \JsonSchema\Constraints\Constraint
{
const SCHEMA_MEDIA_TYPE = 'application/schema+json';
/**
* Validates the given data against the schema and returns an object containing the results
* Both the php object and the schema are supposed to be a result of a json_decode call.
* The validation works as defined by the schema proposal in http://json-schema.org
*
* {@inheritDoc}
*/
public function check($value, $schema = null, $path = null, $i = null)
{
}
}
}
namespace Duo {
/*
* https://duo.com/docs/duoweb
*/
class Web
{
const DUO_PREFIX = "TX";
const APP_PREFIX = "APP";
const AUTH_PREFIX = "AUTH";
const DUO_EXPIRE = 300;
const APP_EXPIRE = 3600;
const IKEY_LEN = 20;
const SKEY_LEN = 40;
const AKEY_LEN = 40;
// if this changes you have to change ERR_AKEY
const ERR_USER = 'ERR|The username passed to sign_request() is invalid.';
const ERR_IKEY = 'ERR|The Duo integration key passed to sign_request() is invalid.';
const ERR_SKEY = 'ERR|The Duo secret key passed to sign_request() is invalid.';
const ERR_AKEY = 'ERR|The application secret key passed to sign_request() must be at least 40 characters.';
public static function signRequest($ikey, $skey, $akey, $username, $time = null)
{
}
public static function verifyResponse($ikey, $skey, $akey, $sig_response, $time = null)
{
}
}
}
namespace Punic {
/**
* Numbers helpers.
*/
class Phone
{
/**
* Retrieve the list of the country calling codes for a specific country.
*
* @param string $territoryCode The country identifier ('001' for global systems, for instance satellite communications like Iridium)
*
* @return array Returns the list of country calling codes found for the specified country (eg: for 'US' you'll get array('1'))
*/
public static function getPrefixesForTerritory($territoryCode)
{
}
/**
* Retrieve the list of territory codes for a specific prefix.
*
* @param string $prefix The country calling code (for instance: '1')
*
* @return array Returns the list of territories for which the specified prefix is applicable (eg: for '1' you'll get array('US', 'AG', 'AI', 'CA', ...))
*/
public static function getTerritoriesForPrefix($prefix)
{
}
/**
* Retrieve the max length of the country calling codes.
*
* @return int
*/
public static function getMaxPrefixLength()
{
}
}
/**
* An exception raised by and associated to Punic.
*/
class Exception extends \Exception
{
/**
* Exception code for the \Punic\Exception\NotImplemented exception.
*
* @var int
*/
const NOT_IMPLEMENTED = 10000;
/**
* Exception code for the \Punic\Exception\InvalidLocale exception.
*
* @var int
*/
const INVALID_LOCALE = 10001;
/**
* Exception code for the \Punic\Exception\InvalidDataFile exception.
*
* @var int
*/
const INVALID_DATAFILE = 10002;
/**
* Exception code for the \Punic\Exception\DataFolderNotFound exception.
*
* @var int
*/
const DATA_FOLDER_NOT_FOUND = 10003;
/**
* Exception code for the \Punic\Exception\DataFileNotFound exception.
*
* @var int
*/
const DATA_FILE_NOT_FOUND = 10004;
/**
* Exception code for the \Punic\Exception\DataFileNotReadable exception.
*
* @var int
*/
const DATA_FILE_NOT_READABLE = 10005;
/**
* Exception code for the \Punic\Exception\BadDataFileContents exception.
*
* @var int
*/
const BAD_DATA_FILE_CONTENTS = 10006;
/**
* Exception code for the \Punic\Exception\BadArgumentType exception.
*
* @var int
*/
const BAD_ARGUMENT_TYPE = 10007;
/**
* Exception code for the \Punic\Exception\ValueNotInList exception.
*
* @var int
*/
const VALUE_NOT_IN_LIST = 10008;
/**
* Initializes the instance.
*
* @param string $message The exception message
* @param int $code The exception code
* @param \Exception $previous The previous exception used for the exception chaining
*/
public function __construct($message, $code = null, $previous = null)
{
}
}
/**
* Territory-related stuff.
*/
class Territory
{
/**
* Retrieve the name of a territory (country, continent, ...).
*
* @param string $territoryCode The territory code
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns the localized territory name (returns $territoryCode if not found)
*/
public static function getName($territoryCode, $locale = '')
{
}
/**
* Return the list of continents in the form of an array with key=ID, value=name.
*
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return array
*/
public static function getContinents($locale = '')
{
}
/**
* Return the list of countries in the form of an array with key=ID, value=name.
*
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return array
*/
public static function getCountries($locale = '')
{
}
/**
* Return a list of continents and relative countries. The resulting array is in the following form (JSON representation):
* ```json
* {
* "002": {
* "name": "Africa",
* "children": {
* "DZ": {"name": "Algeria"},
* "AO": {"name": "Angola"},
* ...
* }
* },
* "150": {
* "name": "Europe",
* "children": {
* "AL": {"name": "Albania"},
* "AD": {"name": "Andorra"},
* ...
* }
* }
* ...
* }
* ```
* The arrays are sorted by territory name.
*
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return array
*/
public static function getContinentsAndCountries($locale = '')
{
}
/**
* Return a list of some specified territory, structured or not.
* $levels control which data you want to retrieve. It can be one or more of the following values:
* <ul>
* <li>'W': world</li>
* <li>'C': continents</li>
* <li>'S': sub-continents</li>
* <li>'c': countries</li>
* </ul>
* If only one level is specified you'll get a flat list (like the one returned by {@link getContinents}).
* If one or more levels are specified, you'll get a structured list (like the one returned by {@link getContinentsAndCountries}).
*
* @param string $levels A string with one or more of the characters: 'W' (for world), 'C' (for continents), 'S' (for sub-continents), 'c' (for countries)
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return array
*
* @link http://www.unicode.org/cldr/charts/latest/supplemental/territory_containment_un_m_49.html
*
* @throws Exception\BadArgumentType
*/
public static function getList($levels = 'W', $locale = '')
{
}
/**
* Return a list of territory identifiers for which we have some info (languages, population, literacy level, Gross Domestic Product).
*
* @return array The list of territory IDs for which we have some info
*/
public static function getTerritoriesWithInfo()
{
}
/**
* Return the list of languages spoken in a territory.
*
* @param string $territoryCode The territory code
* @param string $filterStatuses Filter language status.
* <ul>
* <li>If empty no filter will be applied</li>
* <li>'o' to include official languages</li>
* <li>'r' to include official regional languages</li>
* <li>'f' to include de facto official languages</li>
* <li>'m' to include official minority languages</li>
* <li>'u' to include unofficial or unknown languages</li>
* </ul>
* @param string $onlyCodes Set to true to retrieve only the language codes. If set to false (default) you'll receive a list of arrays with these keys:
* <ul>
* <li>string id: the language identifier</li>
* <li>string status: 'o' for official; 'r' for official regional; 'f' for de facto official; 'm' for official minority; 'u' for unofficial or unknown</li>
* <li>number population: the amount of people speaking the language (%)</li>
* <li>number|null writing: the amount of people able to write (%). May be null if no data is available</li>
* </ul>
*
* @return array|null Return the languages spoken in the specified territory, as described by the $onlyCodes parameter (or null if $territoryCode is not valid or no data is available)
*/
public static function getLanguages($territoryCode, $filterStatuses = '', $onlyCodes = false)
{
}
/**
* Return the population of a specific territory.
*
* @param string $territoryCode The territory code
*
* @return number|null Return the size of the population of the specified territory (or null if $territoryCode is not valid or no data is available)
*/
public static function getPopulation($territoryCode)
{
}
/**
* Return the literacy level for a specific territory, in %.
*
* @param string $territoryCode The territory code
*
* @return number|null Return the % of literacy lever of the specified territory (or null if $territoryCode is not valid or no data is available)
*/
public static function getLiteracyLevel($territoryCode)
{
}
/**
* Return the GDP (Gross Domestic Product) for a specific territory, in US$.
*
* @param string $territoryCode The territory code
*
* @return number|null Return the GDP of the specified territory (or null if $territoryCode is not valid or no data is available)
*/
public static function getGrossDomesticProduct($territoryCode)
{
}
/**
* Return a list of territory IDs where a specific language is spoken, sorted by the total number of people speaking that language.
*
* @param string $languageID The language identifier
*
* @return array
*/
public static function getTerritoriesForLanguage($languageID)
{
}
/**
* Return the code of the territory that contains a territory.
*
* @param string $childTerritoryCode
*
* @return string Return the parent territory code, or an empty string if $childTerritoryCode is the World (001) or if it's invalid.
*/
public static function getParentTerritoryCode($childTerritoryCode)
{
}
/**
* Retrieve the child territories of a parent territory.
*
* @param string $parentTerritoryCode
* @param bool $expandSubGroups Set to true to expand the sub-groups, false to retrieve them.
*
* @return array Return the list of territory codes that are children of $parentTerritoryCode (if $parentTerritoryCode is invalid you'll get an empty list)
*/
public static function getChildTerritoryCodes($parentTerritoryCode, $expandSubGroups = false)
{
}
protected static function getTerritoryInfo($territoryCode)
{
}
protected static function getStructure()
{
}
protected static function fillStructure($data, $id, $level)
{
}
protected static function finalizeWithNames($data, $list, $flatList)
{
}
protected static function filterStructure($parent, $levels)
{
}
protected static function sort($list)
{
}
}
/**
* Numbers helpers.
*/
class Number
{
/**
* Check if a variable contains a valid number for the specified locale.
*
* @param string $value The string value to check
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return bool
*/
public static function isNumeric($value, $locale = '')
{
}
/**
* Check if a variable contains a valid integer number for the specified locale.
*
* @param string $value The string value to check
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return bool
*/
public static function isInteger($value, $locale = '')
{
}
/**
* Localize a number representation (for instance, converts 1234.5 to '1,234.5' in case of English and to '1.234,5' in case of Italian).
*
* @param numeric $value The string value to convert
* @param int|null $precision The wanted precision (well use {@link http://php.net/manual/function.round.php})
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string $value is not a number, otherwise returns the localized representation of the number
*/
public static function format($value, $precision = null, $locale = '')
{
}
/**
* Convert a localized representation of a number to a number (for instance, converts the string '1,234' to 1234 in case of English and to 1.234 in case of Italian).
*
* @param string $value The string value to convert
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return int|float|null Returns null if $value is not valid, the numeric value otherwise
*/
public static function unformat($value, $locale = '')
{
}
}
/*
* Comments marked as @TZWS have been added because it seems than PHP does
* not support timezones with seconds.
* Furthermore: the Unicode specs (http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table) says the following:
* "The ISO8601 basic format with hours, minutes and optional seconds fields. Note: The seconds field is not supported by the
* ISO8601 specification."
*/
/**
* Date and time related functions.
*/
class Calendar
{
/** @var array */
protected static $timezoneCache;
/** @var string[] */
protected static $weekdayDictionary = array('sun', 'mon', 'tue', 'wed', 'thu', 'fri', 'sat');
/**
* Convert a date/time representation to a {@link http://php.net/manual/class.datetime.php \DateTime} instance.
*
* @param number|\DateTime|string $value An Unix timestamp, a `\DateTime` instance \DateTime or a string accepted by {@link http://php.net/manual/function.strtotime.php strtotime}.
* @param string|\DateTimeZone $toTimezone The timezone to set; leave empty to use the value of $fromTimezone (if it's empty we'll use the default timezone or the timezone associated to $value if it's already a `\DateTime`).
* @param string|\DateTimeZone $fromTimezone The original timezone of $value; leave empty to use the default timezone (or the timezone associated to $value if it's already a `\DateTime`).
*
* @return \DateTime|null Returns null if $value is empty, a `\DateTime` instance otherwise.
*
* @throws \Punic\Exception\BadArgumentType Throws an exception if $value is not empty and can't be converted to a `\DateTime` instance or if $toTimezone is not empty and is not valid.
*
* @example Convert a Unix timestamp to a \DateTime instance with the current time zone:
* ```php
* \Punic\Calendar::toDateTime(1409648286);
* ```
* @example Convert a Unix timestamp to a \DateTime instance with a specific time zone:
* ```php
* \Punic\Calendar::toDateTime(1409648286, 'Europe/Rome');
* \Punic\Calendar::toDateTime(1409648286, new \DateTimeZone('Europe/Rome'));
* ```
* @example Convert a string to a \DateTime instance with the current time zone:
* ```php
* \Punic\Calendar::toDateTime('2014-03-07 13:30');
* ```
* @example Convert a string to a \DateTime instance with a specific time zone:
* ```php
* \Punic\Calendar::toDateTime('2014-03-07 13:30', 'Europe/Rome');
* ```
* Please remark that in this case '2014-03-07 13:30' is converted to a \DateTime instance with the current timezone, and <u>after</u> we change the timezone.
* So, if your system default timezone is 'America/Los_Angeles' (GMT -8), the resulting date/time will be '2014-03-07 22:30 GMT+1' since it'll be converted to 'Europe/Rome' (GMT +1)
*/
public static function toDateTime($value, $toTimezone = '', $fromTimezone = '')
{
}
/**
* Converts a format string from {@link http://php.net/manual/en/function.date.php#refsect1-function.date-parameters PHP's date format} to {@link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Field_Symbol_Table ISO format}.
* The following extra format chunks are introduced:
* - 'P': ISO-8601 numeric representation of the day of the week (same as 'e' but not locale dependent)
* - 'PP': Numeric representation of the day of the week, from 0 (for Sunday) to 6 (for Saturday)
* - 'PPP': English ordinal suffix for the day of the month
* - 'PPPP': The day of the year (starting from 0)
* - 'PPPPP': Number of days in the given month
* - 'PPPPPP': Whether it's a leap year: 1 if it is a leap year, 0 otherwise.
* - 'PPPPPPP': Lowercase Ante meridiem and Post meridiem (English only, for other locales it's the same as 'a')
* - 'PPPPPPPP': Swatch Internet time
* - 'PPPPPPPPP': Microseconds
* - 'PPPPPPPPPP': Whether or not the date is in daylight saving time 1 if Daylight Saving Time, 0 otherwise.
* - 'PPPPPPPPPPP': Timezone offset in seconds
* - 'PPPPPPPPPPPP': RFC 2822 formatted date (Example: 'Thu, 21 Dec 2000 16:01:07 +0200')
* - 'PPPPPPPPPPPPP': Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT).
*
* @param string $format The PHP date/time format string to convert.
*
* @return string Returns the ISO date/time format corresponding to the specified PHP date/time format.
*/
public static function convertPhpToIsoFormat($format)
{
}
/**
* Get the name of an era.
*
* @param number|\DateTime $value The year number or the \DateTime instance for which you want the name of the era.
* @param string $width The format name; it can be 'wide' (eg 'Before Christ'), 'abbreviated' (eg 'BC') or 'narrow' (eg 'B').
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
*
* @return string Returns an empty string if $value is empty, the name of the era otherwise.
*
* @throws \Punic\Exception\BadArgumentType Throws a BadArgumentType exception if $value is not valid.
* @throws \Punic\Exception\ValueNotInList Throws a ValueNotInList exception if $width is not valid.
* @throws \Punic\Exception Throws a generic exception in case of other problems (for instance if you specify an invalid locale).
*/
public static function getEraName($value, $width = 'abbreviated', $locale = '')
{
}
/**
* Get the name of a month.
*
* @param number|\DateTime $value The month number (1-12) or a \DateTime instance for which you want the name of the month.
* @param string $width The format name; it can be 'wide' (eg 'January'), 'abbreviated' (eg 'Jan') or 'narrow' (eg 'J').
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
* @param bool $standAlone Set to true to return the form used independently (such as in calendar header), set to false if the month name will be part of a date.
*
* @return string Returns an empty string if $value is empty, the name of the month otherwise.
*
* @throws \Punic\Exception\BadArgumentType Throws a BadArgumentType exception if $value is not valid.
* @throws \Punic\Exception\ValueNotInList Throws a ValueNotInList exception if $width is not valid.
* @throws \Punic\Exception Throws a generic exception in case of other problems (for instance if you specify an invalid locale).
*/
public static function getMonthName($value, $width = 'wide', $locale = '', $standAlone = false)
{
}
/**
* Get the name of a week day.
*
* @param number|\DateTime $value A week day number (from 0-Sunday to 6-Saturnday) or a \DateTime instance for which you want the name of the day of the week.
* @param string $width The format name; it can be 'wide' (eg 'Sunday'), 'abbreviated' (eg 'Sun'), 'short' (eg 'Su') or 'narrow' (eg 'S').
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
* @param bool $standAlone Set to true to return the form used independently (such as in calendar header), set to false if the week day name will be part of a date.
*
* @return string Returns an empty string if $value is empty, the name of the week day name otherwise.
*
* @throws \Punic\Exception\BadArgumentType Throws a BadArgumentType exception if $value is not valid.
* @throws \Punic\Exception\ValueNotInList Throws a ValueNotInList exception if $width is not valid.
* @throws \Punic\Exception Throws a generic exception in case of other problems (for instance if you specify an invalid locale).
*/
public static function getWeekdayName($value, $width = 'wide', $locale = '', $standAlone = false)
{
}
/**
* Get the name of a quarter.
*
* @param number|\DateTime $value A quarter number (from 1 to 4) or a \DateTime instance for which you want the name of the day of the quarter.
* @param string $width The format name; it can be 'wide' (eg '1st quarter'), 'abbreviated' (eg 'Q1') or 'narrow' (eg '1').
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
* @param bool $standAlone Set to true to return the form used independently (such as in calendar header), set to false if the quarter name will be part of a date.
*
* @return string Returns an empty string if $value is empty, the name of the quarter name otherwise.
*
* @throws \Punic\Exception\BadArgumentType Throws a BadArgumentType exception if $value is not valid.
* @throws \Punic\Exception\ValueNotInList Throws a ValueNotInList exception if $width is not valid.
* @throws \Punic\Exception Throws a generic exception in case of other problems (for instance if you specify an invalid locale).
*/
public static function getQuarterName($value, $width = 'wide', $locale = '', $standAlone = false)
{
}
/**
* Get the name of a day period (AM/PM).
*
* @param number|string|\DateTime $value An hour (from 0 to 23), a standard period name ('am' or 'pm', lower or upper case) a \DateTime instance for which you want the name of the day period.
* @param string $width The format name; it can be 'wide' (eg 'AM'), 'abbreviated' (eg 'AM') or 'narrow' (eg 'a').
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
* @param bool $standAlone Set to true to return the form used independently (such as in calendar header), set to false if the day period name will be part of a date.
*
* @return string Returns an empty string if $value is empty, the name of the day period name otherwise.
*
* @throws \Punic\Exception\BadArgumentType Throws a BadArgumentType exception if $value is not valid.
* @throws \Punic\Exception\ValueNotInList Throws a ValueNotInList exception if $width is not valid.
* @throws \Punic\Exception Throws a generic exception in case of other problems (for instance if you specify an invalid locale).
*/
public static function getDayperiodName($value, $width = 'wide', $locale = '', $standAlone = false)
{
}
/**
* Returns the localized name of a timezone, no location-specific.
*
* @param string|\DateTime|\DateTimeZone $value The php name of a timezone, or a \DateTime instance or a \DateTimeZone instance for which you want the localized timezone name.
* @param string $width The format name; it can be 'long' (eg 'Greenwich Mean Time') or 'short' (eg 'GMT').
* @param string $kind Set to 'daylight' to retrieve the daylight saving time name, set to 'standard' to retrieve the standard time, set to 'generic' to retrieve the generic name, set to '' to determine automatically the dst (if $value is \DateTime) or the generic (otherwise).
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
*
* @return string Returns an empty string if the timezone has not been found (maybe we don't have the data in the specified $width), the timezone name otherwise.
*
* @throws \Punic\Exception Throws a generic exception in case of problems (for instance if you specify an invalid locale).
*/
public static function getTimezoneNameNoLocationSpecific($value, $width = 'long', $kind = '', $locale = '')
{
}
/** @todo I can't find data for this */
public static function getTimezoneNameLocationSpecific($value, $width = 'long', $kind = '', $locale = '')
{
}
/**
* Returns the localized name of an exemplar city for a specific timezone.
*
* @param string|\DateTime|\DateTimeZone $value The php name of a timezone, or a \DateTime instance or a \DateTimeZone instance
* @param bool $returnUnknownIfNotFound true If the exemplar city is not found, shall we return the translation of 'Unknown City'?
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if the exemplar city hasn't been found and $returnUnknownIfNotFound is false
*/
public static function getTimezoneExemplarCity($value, $returnUnknownIfNotFound = true, $locale = '')
{
}
/**
* Returns true if a locale has a 12-hour clock, false if 24-hour clock.
*
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return bool
*
* @throws \Punic\Exception Throws an exception in case of problems
*/
public static function has12HoursClock($locale = '')
{
}
/**
* Retrieve the first weekday for a specific locale (from 0-Sunday to 6-Saturnday).
*
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return int Returns a number from 0 (Sunday) to 7 (Saturnday)
*/
public static function getFirstWeekday($locale = '')
{
}
/**
* Returns the sorted list of weekdays, starting from {@link getFirstWeekday}.
*
* @param string|false $namesWidth If false you'll get only the list of weekday identifiers (for instance: [0, 1, 2, 3, 4, 5, 6]),
* If it's a string it must be one accepted by {@link getWeekdayName}, and you'll get an array like this: [{id: 0, name: 'Monday', ..., {id: 6, name: 'Sunday'}]
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return array
*/
public static function getSortedWeekdays($namesWidth = false, $locale = '')
{
}
/**
* Get the ISO format for a date.
*
* @param string $width The format name; it can be 'full' (eg 'EEEE, MMMM d, y' - 'Wednesday, August 20, 2014'), 'long' (eg 'MMMM d, y' - 'August 20, 2014'), 'medium' (eg 'MMM d, y' - 'August 20, 2014') or 'short' (eg 'M/d/yy' - '8/20/14')
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns the requested ISO format
*
* @throws Exception Throws an exception in case of problems
*
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function getDateFormat($width, $locale = '')
{
}
/**
* Get the ISO format for a time.
*
* @param string $width The format name; it can be 'full' (eg 'h:mm:ss a zzzz' - '11:42:13 AM GMT+2:00'), 'long' (eg 'h:mm:ss a z' - '11:42:13 AM GMT+2:00'), 'medium' (eg 'h:mm:ss a' - '11:42:13 AM') or 'short' (eg 'h:mm a' - '11:42 AM')
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns the requested ISO format
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function getTimeFormat($width, $locale = '')
{
}
/**
* Get the ISO format for a date/time.
*
* @param string $width The format name; it can be 'full', 'long', 'medium', 'short' or a combination for date+time like 'full|short' or a combination for format+date+time like 'full|full|short'
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns the requested ISO format
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function getDatetimeFormat($width, $locale = '')
{
}
protected static function getDatetimeFormatReal($width, $locale = '', $overrideDateFormat = '', $overrideTimeFormat = '')
{
}
/**
* Returns the difference in days between two dates (or between a date and today).
*
* @param \DateTime $dateEnd The first date
* @param \DateTime|null $dateStart The final date (if it has a timezone different than $dateEnd, we'll use the one of $dateEnd)
*
* @return int Returns the diffence $dateEnd - $dateStart in days
*
* @throws Exception\BadArgumentType
*/
public static function getDeltaDays($dateEnd, $dateStart = null)
{
}
/**
* Describe an interval between two dates (eg '2 days and 4 hours').
*
* @param \DateTime $dateEnd The first date
* @param \DateTime|null $dateStart The final date (if it has a timezone different than $dateEnd, we'll use the one of $dateEnd)
* @param int $maxParts The maximim parts (eg with 2 you may have '2 days and 4 hours', with 3 '2 days, 4 hours and 24 minutes')
* @param string $width The format name; it can be 'long' (eg '3 seconds'), 'short' (eg '3 s') or 'narrow' (eg '3s')
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string
*
* @throws Exception\BadArgumentType
*/
public static function describeInterval($dateEnd, $dateStart = null, $maxParts = 2, $width = 'short', $locale = '')
{
}
/**
* Format a date.
*
* @param \DateTime $value The \DateTime instance for which you want the localized textual representation
* @param string $width The format name; it can be 'full' (eg 'EEEE, MMMM d, y' - 'Wednesday, August 20, 2014'), 'long' (eg 'MMMM d, y' - 'August 20, 2014'), 'medium' (eg 'MMM d, y' - 'August 20, 2014') or 'short' (eg 'M/d/yy' - '8/20/14').
* You can also append a caret ('^') or an asterisk ('*') to $width. If so, special day names may be used (like 'Today', 'Yesterday', 'Tomorrow' with '^' and 'today', 'yesterday', 'tomorrow' width '*') instead of the date.
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if $value is empty, the localized textual representation otherwise
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function formatDate($value, $width, $locale = '')
{
}
/**
* Format a date (extended version: various date/time representations - see toDateTime()).
*
* @param number|\DateTime|string $value An Unix timestamp, a `\DateTime` instance or a string accepted by {@link http://php.net/manual/function.strtotime.php strtotime}.
* @param string $width The format name; it can be 'full' (eg 'EEEE, MMMM d, y' - 'Wednesday, August 20, 2014'), 'long' (eg 'MMMM d, y' - 'August 20, 2014'), 'medium' (eg 'MMM d, y' - 'August 20, 2014') or 'short' (eg 'M/d/yy' - '8/20/14')
* You can also append a caret ('^') or an asterisk ('*') to $width. If so, special day names may be used (like 'Today', 'Yesterday', 'Tomorrow' with '^' and 'today', 'yesterday', 'tomorrow' width '*') instead of the date.
* @param string|\DateTimeZone $toTimezone The timezone to set; leave empty to use the default timezone (or the timezone associated to $value if it's already a \DateTime)
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if $value is empty, the localized textual representation otherwise
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @see toDateTime()
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function formatDateEx($value, $width, $toTimezone = '', $locale = '')
{
}
/**
* Format a time.
*
* @param \DateTime $value The \DateTime instance for which you want the localized textual representation
* @param string $width The format name; it can be 'full' (eg 'h:mm:ss a zzzz' - '11:42:13 AM GMT+2:00'), 'long' (eg 'h:mm:ss a z' - '11:42:13 AM GMT+2:00'), 'medium' (eg 'h:mm:ss a' - '11:42:13 AM') or 'short' (eg 'h:mm a' - '11:42 AM')
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if $value is empty, the localized textual representation otherwise
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function formatTime($value, $width, $locale = '')
{
}
/**
* Format a time (extended version: various date/time representations - see toDateTime()).
*
* @param number|\DateTime|string $value An Unix timestamp, a `\DateTime` instance or a string accepted by {@link http://php.net/manual/function.strtotime.php strtotime}.
* @param string $width The format name; it can be 'full' (eg 'h:mm:ss a zzzz' - '11:42:13 AM GMT+2:00'), 'long' (eg 'h:mm:ss a z' - '11:42:13 AM GMT+2:00'), 'medium' (eg 'h:mm:ss a' - '11:42:13 AM') or 'short' (eg 'h:mm a' - '11:42 AM')
* @param string|\DateTimeZone $toTimezone The timezone to set; leave empty to use the default timezone (or the timezone associated to $value if it's already a \DateTime)
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if $value is empty, the localized textual representation otherwise
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @see toDateTime()
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function formatTimeEx($value, $width, $toTimezone = '', $locale = '')
{
}
/**
* Format a date/time.
*
* @param \DateTime $value The \DateTime instance for which you want the localized textual representation
* @param string $width The format name; it can be 'full', 'long', 'medium', 'short' or a combination for date+time like 'full|short' or a combination for format+date+time like 'full|full|short'
* You can also append an asterisk ('*') to the date parh of $width. If so, special day names may be used (like 'Today', 'Yesterday', 'Tomorrow') instead of the date part.
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if $value is empty, the localized textual representation otherwise
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function formatDatetime($value, $width, $locale = '')
{
}
/**
* Format a date/time (extended version: various date/time representations - see toDateTime()).
*
* @param number|\DateTime|string $value An Unix timestamp, a `\DateTime` instance or a string accepted by {@link http://php.net/manual/function.strtotime.php strtotime}.
* @param string $width The format name; it can be 'full', 'long', 'medium', 'short' or a combination for date+time like 'full|short' or a combination for format+date+time like 'full|full|short'
* You can also append an asterisk ('*') to the date parh of $width. If so, special day names may be used (like 'Today', 'Yesterday', 'Tomorrow') instead of the date part.
* @param string|\DateTimeZone $toTimezone The timezone to set; leave empty to use the default timezone (or the timezone associated to $value if it's already a \DateTime)
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if $value is empty, the localized textual representation otherwise
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @see toDateTime()
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function formatDatetimeEx($value, $width, $toTimezone = '', $locale = '')
{
}
/**
* Format a date and/or time.
*
* @param \DateTime $value The \DateTime instance for which you want the localized textual representation
* @param string $format The ISO format that specify how to render the date/time. The following extra format chunks are available:
* - 'P': ISO-8601 numeric representation of the day of the week (same as 'e' but not locale dependent)
* - 'PP': Numeric representation of the day of the week, from 0 (for Sunday) to 6 (for Saturday)
* - 'PPP': English ordinal suffix for the day of the month
* - 'PPPP': The day of the year (starting from 0)
* - 'PPPPP': Number of days in the given month
* - 'PPPPPP': Whether it's a leap year: 1 if it is a leap year, 0 otherwise.
* - 'PPPPPPP': Lowercase Ante meridiem and Post meridiem (English only, for other locales it's the same as 'a')
* - 'PPPPPPPP': Swatch Internet time
* - 'PPPPPPPPP': Microseconds
* - 'PPPPPPPPPP': Whether or not the date is in daylight saving time 1 if Daylight Saving Time, 0 otherwise.
* - 'PPPPPPPPPPP': Timezone offset in seconds
* - 'PPPPPPPPPPPP': RFC 2822 formatted date (Example: 'Thu, 21 Dec 2000 16:01:07 +0200')
* - 'PPPPPPPPPPPPP': Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if $value is empty, the localized textual representation otherwise
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function format($value, $format, $locale = '')
{
}
/**
* Format a date and/or time (extended version: various date/time representations - see toDateTime()).
*
* @param number|\DateTime|string $value An Unix timestamp, a `\DateTime` instance or a string accepted by {@link http://php.net/manual/function.strtotime.php strtotime}.
* @param string $format The ISO format that specify how to render the date/time. The following extra format chunks are valid:
* - 'P': ISO-8601 numeric representation of the day of the week (same as 'e' but not locale dependent)
* - 'PP': Numeric representation of the day of the week, from 0 (for Sunday) to 6 (for Saturday)
* - 'PPP': English ordinal suffix for the day of the month
* - 'PPPP': The day of the year (starting from 0)
* - 'PPPPP': Number of days in the given month
* - 'PPPPPP': Whether it's a leap year: 1 if it is a leap year, 0 otherwise.
* - 'PPPPPPP': Lowercase Ante meridiem and Post meridiem (English only, for other locales it's the same as 'a')
* - 'PPPPPPPP': Swatch Internet time
* - 'PPPPPPPPP': Microseconds
* - 'PPPPPPPPPP': Whether or not the date is in daylight saving time 1 if Daylight Saving Time, 0 otherwise.
* - 'PPPPPPPPPPP': Timezone offset in seconds
* - 'PPPPPPPPPPPP': RFC 2822 formatted date (Example: 'Thu, 21 Dec 2000 16:01:07 +0200')
* - 'PPPPPPPPPPPPP': Seconds since the Unix Epoch (January 1 1970 00:00:00 GMT)
* @param string|\DateTimeZone $toTimezone The timezone to set; leave empty to use the default timezone (or the timezone associated to $value if it's already a \DateTime)
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if $value is empty, the localized textual representation otherwise
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @link http://cldr.unicode.org/translation/date-time-patterns
* @link http://cldr.unicode.org/translation/date-time
* @link http://www.unicode.org/reports/tr35/tr35-dates.html#Date_Format_Patterns
*/
public static function formatEx($value, $format, $toTimezone = '', $locale = '')
{
}
/**
* Retrieve the relative day name (eg 'yesterday', 'tomorrow'), if available.
*
* @param \DateTime $datetime The date for which you want the relative day name
* @param bool $ucFirst Force first letter to be upper case?
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns the relative name if available, otherwise returns an empty string
*/
public static function getDateRelativeName($datetime, $ucFirst = false, $locale = '')
{
}
protected static function decodeDayOfWeek(\DateTime $value, $count, $locale, $standAlone = false)
{
}
protected static function decodeDayOfWeekLocal(\DateTime $value, $count, $locale, $standAlone = false)
{
}
protected static function decodeDayOfWeekLocalAlone(\DateTime $value, $count, $locale)
{
}
protected static function decodeDayOfMonth(\DateTime $value, $count, $locale)
{
}
protected static function decodeMonth(\DateTime $value, $count, $locale, $standAlone = false)
{
}
protected static function decodeMonthAlone(\DateTime $value, $count, $locale)
{
}
protected static function decodeYear(\DateTime $value, $count, $locale)
{
}
protected static function decodeHour12(\DateTime $value, $count, $locale)
{
}
protected static function decodeDayperiod(\DateTime $value, $count, $locale)
{
}
protected static function decodeHour24(\DateTime $value, $count, $locale)
{
}
protected static function decodeHour12From0(\DateTime $value, $count, $locale)
{
}
protected static function decodeHour24From1(\DateTime $value, $count, $locale)
{
}
protected static function decodeMinute(\DateTime $value, $count, $locale)
{
}
protected static function decodeSecond(\DateTime $value, $count, $locale)
{
}
protected static function decodeTimezoneNoLocationSpecific(\DateTime $value, $count, $locale)
{
}
protected static function decodeTimezoneShortGMT(\DateTime $value, $count, $locale)
{
}
protected static function decodeEra(\DateTime $value, $count, $locale)
{
}
protected static function decodeYearWeekOfYear(\DateTime $value, $count, $locale)
{
}
/**
* Note: we assume Gregorian calendar here.
*/
protected static function decodeYearExtended(\DateTime $value, $count, $locale)
{
}
/**
* Note: we assume Gregorian calendar here.
*/
protected static function decodeYearRelatedGregorian(\DateTime $value, $count, $locale)
{
}
protected static function decodeQuarter(\DateTime $value, $count, $locale, $standAlone = false)
{
}
protected static function decodeQuarterAlone(\DateTime $value, $count, $locale)
{
}
protected static function decodeWeekOfYear(\DateTime $value, $count, $locale)
{
}
protected static function decodeDayOfYear(\DateTime $value, $count, $locale)
{
}
protected static function decodeWeekdayInMonth(\DateTime $value, $count, $locale)
{
}
protected static function decodeFranctionsOfSeconds(\DateTime $value, $count, $locale)
{
}
protected static function decodeMsecInDay(\DateTime $value, $count, $locale)
{
}
protected static function decodeTimezoneDelta(\DateTime $value, $count, $locale)
{
}
protected static function decodeTimezoneNoLocationGeneric(\DateTime $value, $count, $locale)
{
}
protected static function decodeTimezoneID(\DateTime $value, $count, $locale)
{
}
protected static function decodeTimezoneWithTime(\DateTime $value, $count, $locale, $zForZero = false)
{
}
protected static function decodeTimezoneWithTimeZ(\DateTime $value, $count, $locale)
{
}
/** @todo */
protected static function decodeWeekOfMonth(\DateTime $value, $count, $locale)
{
}
/** @todo */
protected static function decodeYearCyclicName()
{
}
/** @todo */
protected static function decodeModifiedGiulianDay()
{
}
protected static function getTimezonesAliases($phpTimezoneName)
{
}
protected static function decodePunicExtension(\DateTime $value, $count, $locale)
{
}
protected static function getTimezoneNameFromDatetime(\DateTime $dt)
{
}
protected static function getTimezoneNameFromTimezone(\DateTimeZone $tz)
{
}
}
/**
* Common data helper stuff.
*/
class Data
{
/**
* Let's cache already loaded files (locale-specific).
*
* @var array
*/
protected static $cache = array();
/**
* Let's cache already loaded files (not locale-specific).
*
* @var array
*/
protected static $cacheGeneric = array();
/**
* The current default locale.
*
* @var string
*/
protected static $defaultLocale = 'en_US';
/**
* The fallback locale (used if default locale is not found).
*
* @var string
*/
protected static $fallbackLocale = 'en_US';
/**
* Return the current default locale.
*
* @return string
*/
public static function getDefaultLocale()
{
}
/**
* Return the current default language.
*
* @return string
*/
public static function getDefaultLanguage()
{
}
/**
* Set the current default locale and language.
*
* @param string $locale
*
* @throws \Punic\Exception\InvalidLocale Throws an exception if $locale is not a valid string
*/
public static function setDefaultLocale($locale)
{
}
/**
* Return the current fallback locale (used if default locale is not found).
*
* @return string
*/
public static function getFallbackLocale()
{
}
/**
* Return the current fallback language (used if default locale is not found).
*
* @return string
*/
public static function getFallbackLanguage()
{
}
/**
* Set the current fallback locale and language.
*
* @param string $locale
*
* @throws \Punic\Exception\InvalidLocale Throws an exception if $locale is not a valid string
*/
public static function setFallbackLocale($locale)
{
}
/**
* Get the locale data.
*
* @param string $identifier The data identifier
* @param string $locale The locale identifier (if empty we'll use the current default locale)
*
* @return array
*
* @throws \Punic\Exception Throws an exception in case of problems
*
* @internal
*/
public static function get($identifier, $locale = '')
{
}
/**
* Get the generic data.
*
* @param string $identifier The data identifier
*
* @return array
*
* @throws Exception Throws an exception in case of problems
*
* @internal
*/
public static function getGeneric($identifier)
{
}
/**
* Return a list of available locale identifiers.
*
* @param bool $allowGroups Set to true if you want to retrieve locale groups (eg. 'en-001'), false otherwise
*
* @return array
*/
public static function getAvailableLocales($allowGroups = false)
{
}
/**
* Try to guess the full locale (with script and territory) ID associated to a language.
*
* @param string $language The language identifier (if empty we'll use the current default language)
* @param string $script The script identifier (if $language is empty we'll use the current default script)
*
* @return string Returns an empty string if the territory was not found, the territory ID otherwise
*/
public static function guessFullLocale($language = '', $script = '')
{
}
/**
* Return the terrotory associated to the locale (guess it if it's not present in $locale).
*
* @param string $locale The locale identifier (if empty we'll use the current default locale)
* @param bool $checkFallbackLocale Set to true to check the fallback locale if $locale (or the default locale) don't have an associated territory, false to don't fallback to fallback locale
*
* @return string
*/
public static function getTerritory($locale = '', $checkFallbackLocale = true)
{
}
/**
* @deprecated
*/
protected static function getParentTerritory($territory)
{
}
/**
* @deprecated
*/
protected static function expandTerritoryGroup($parentTerritory)
{
}
/**
* Return the node associated to the locale territory.
*
* @param array $data The parent array for which you want the territory node
* @param string $locale The locale identifier (if empty we'll use the current default locale)
*
* @return mixed Returns null if the node was not found, the node data otherwise
*
* @internal
*/
public static function getTerritoryNode($data, $locale = '')
{
}
/**
* Return the node associated to the language (not locale) territory.
*
* @param array $data The parent array for which you want the language node
* @param string $locale The locale identifier (if empty we'll use the current default locale)
*
* @return mixed Returns null if the node was not found, the node data otherwise
*
* @internal
*/
public static function getLanguageNode($data, $locale = '')
{
}
/**
* Returns the item of an array associated to a locale.
*
* @param array $data The data containing the locale info
* @param string $locale The locale identifier (if empty we'll use the current default locale)
*
* @return mixed Returns null if $data is not an array or it does not contain locale info, the array item otherwise
*
* @internal
*/
public static function getLocaleItem($data, $locale = '')
{
}
/**
* Parse a string representing a locale and extract its components.
*
* @param string $locale
*
* @return null|string[] Return null if $locale is not valid; if $locale is valid returns an array with keys 'language', 'script', 'territory', 'parentLocale'
*
* @internal
*/
public static function explodeLocale($locale)
{
}
/**
* Returns the path of the locale-specific data, looking also for the fallback locale.
*
* @param string $locale The locale for which you want the data folder
*
* @return string Returns an empty string if the folder is not found, the absolute path to the folder otherwise
*/
protected static function getLocaleFolder($locale)
{
}
/**
* Returns a list of locale identifiers associated to a locale.
*
* @param string $locale The locale for which you want the alternatives
* @param string $addFallback Set to true to add the fallback locale to the result, false otherwise
*
* @return array
*/
protected static function getLocaleAlternatives($locale, $addFallback = true)
{
}
}
/**
* Language-related stuff.
*/
class Language
{
/**
* Return all the languages.
*
* @param bool $excludeCountrySpecific Set to false (default) to include also Country-specific languages (eg 'U.S. English' in addition to 'English'), set to true to exclude them
* @param bool $excludeScriptSpecific Set to false (default) to include also script-specific languages (eg 'Simplified Chinese' in addition to 'Chinese'), set to true to exclude them
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return array Return an array, sorted by values, whose keys are the language IDs and the values are the localized language names
*/
public static function getAll($excludeCountrySpecific = false, $excludeScriptSpecific = false, $locale = '')
{
}
/**
* Retrieve the name of a language.
*
* @param string $languageCode The language code. If it contails also a terrotory code (eg: 'en-US'), the result will contain also the territory code (eg 'English (United States)')
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns the localized language name (returns $languageCode if not found)
*/
public static function getName($languageCode, $locale = '')
{
}
}
/**
* Plural helper stuff.
*/
class Plural
{
/**
* Return the list of applicable plural rule for a locale.
*
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return array<string> Returns a list containing some the following values: 'zero', 'one', 'two', 'few', 'many', 'other' ('other' will be always there)
*/
public static function getRules($locale = '')
{
}
/**
* Return the plural rule ('zero', 'one', 'two', 'few', 'many' or 'other') for a number and a locale.
*
* @param string|int|float $number The number to check the plural rule for for
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns one of the following values: 'zero', 'one', 'two', 'few', 'many', 'other'
*
* @throws \Punic\Exception\BadArgumentType Throws a \Punic\Exception\BadArgumentType if $number is not a valid number
* @throws \Exception Throws a \Exception if there were problems calculating the plural rule
*/
public static function getRule($number, $locale = '')
{
}
protected static function inRange($value, $mustBeIncluded)
{
}
}
/**
* Units helper stuff.
*/
class Unit
{
/**
* Format a unit string.
*
* @param int|float|string $number The unit amount
* @param string $unit The unit identifier (eg 'duration/millisecond' or 'millisecond')
* @param string $width The format name; it can be 'long' (eg '3 milliseconds'), 'short' (eg '3 ms') or 'narrow' (eg '3ms'). You can also add a precision specifier ('long,2' or just '2')
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string
*
* @throws Exception\ValueNotInList
*/
public static function format($number, $unit, $width = 'short', $locale = '')
{
}
/**
* Retrieve the measurement systems and their localized names.
*
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return array The array keys are the measurement system codes (eg 'metric', 'US', 'UK'), the values are the localized measurement system names (eg 'Metric', 'US', 'UK' for English)
*/
public static function getMeasurementSystems($locale = '')
{
}
/**
* Retrieve the measurement system for a specific territory.
*
* @param string $territoryCode The territory code (eg. 'US' for 'United States of America').
*
* @return string Return the measurement system code (eg: 'metric') for the specified territory. If $territoryCode is not valid we'll return an empty string.
*/
public static function getMeasurementSystemFor($territoryCode)
{
}
/**
* Returns the list of countries that use a specific measurement system.
*
* @param string $measurementSystem The measurement system identifier ('metric', 'US' or 'UK')
*
* @return array The list of country IDs that use the specified measurement system (if $measurementSystem is invalid you'll get an empty array)
*/
public static function getCountriesWithMeasurementSystem($measurementSystem)
{
}
/**
* Retrieve the standard paper size for a specific territory.
*
* @param string $territoryCode The territory code (eg. 'US' for 'United States of America').
*
* @return string Return the standard paper size (eg: 'A4' or 'US-Letter') for the specified territory. If $territoryCode is not valid we'll return an empty string.
*/
public static function getPaperSizeFor($territoryCode)
{
}
/**
* Returns the list of countries that use a specific paper size by default.
*
* @param string $paperSize The paper size identifier ('A4' or 'US-Letter')
*
* @return array The list of country IDs that use the specified paper size (if $paperSize is invalid you'll get an empty array)
*/
public static function getCountriesWithPaperSize($paperSize)
{
}
}
}
namespace Punic\Exception {
/**
* An exception raised when a function meets an argument of an unsupported type.
*/
class BadArgumentType extends \Punic\Exception
{
protected $argumentValue;
protected $destinationTypeDescription;
/**
* Initializes the instance.
*
* @param mixed $argumentValue The value of the invalid argument
* @param string $destinationTypeDescription The description of the destination type
* @param \Exception $previous The previous exception used for the exception chaining
*/
public function __construct($argumentValue, $destinationTypeDescription, $previous = null)
{
}
/**
* Retrieves the value of the invalid argument.
*
* @return mixed
*/
public function getArgumentValue()
{
}
/**
* Retrieves the destination type (or a list of destination types).
*
* @return string|array<string>
*/
public function getDestinationTypeDescription()
{
}
}
/**
* An exception raised when an data file has been hit.
*/
class InvalidDataFile extends \Punic\Exception
{
protected $identifier;
/**
* Initializes the instance.
*
* @param mixed $identifier The bad data file identifier
* @param \Exception $previous The previous exception used for the exception chaining
*/
public function __construct($identifier, $previous = null)
{
}
/**
* Retrieves the bad data file identifier.
*
* @return mixed
*/
public function getIdentifier()
{
}
}
/**
* An exception raised when an data folder has not been found.
*/
class DataFolderNotFound extends \Punic\Exception
{
protected $locale;
protected $fallbackLocale;
/**
* Initializes the instance.
*
* @param string $locale The preferred locale
* @param string $fallbackLocale The fallback locale
* @param \Exception $previous The previous exception used for the exception chaining
*/
public function __construct($locale, $fallbackLocale, $previous = null)
{
}
/**
* Retrieves the preferred locale.
*
* @return string
*/
public function getLocale()
{
}
/**
* Retrieves the fallback locale.
*
* @return string
*/
public function getFallbackLocale()
{
}
}
/**
* An exception raised when an data file has not been found.
*/
class DataFileNotFound extends \Punic\Exception
{
protected $identifier;
protected $locale;
protected $fallbackLocale;
/**
* Initializes the instance.
*
* @param string $identifier The data file identifier
* @param string $locale The preferred locale (if the data file is locale-specific)
* @param string $fallbackLocale The fallback locale (if the data file is locale-specific)
* @param \Exception $previous The previous exception used for the exception chaining
*/
public function __construct($identifier, $locale = '', $fallbackLocale = '', $previous = null)
{
}
/**
* Retrieves the bad data file identifier.
*
* @return string
*/
public function getIdentifier()
{
}
/**
* Retrieves the preferred locale.
*
* @return string
*/
public function getLocale()
{
}
/**
* Retrieves the fallback locale.
*
* @return string
*/
public function getFallbackLocale()
{
}
}
/**
* An exception raised when a function meets an argument of an unsupported type.
*/
class NotImplemented extends \Punic\Exception
{
protected $function;
/**
* Initializes the instance.
*
* @param string $function The function/method that's not implemented
* @param \Exception $previous The previous exception used for the exception chaining
*/
public function __construct($function, $previous = null)
{
}
/**
* Retrieves the name of the not implemented function/method.
*
* @return string
*/
public function getFunction()
{
}
}
/**
* An exception raised when an data file was not read.
*/
class DataFileNotReadable extends \Punic\Exception
{
protected $dataFilePath;
/**
* Initializes the instance.
*
* @param string $dataFilePath The path to the unreadable file
* @param \Exception $previous The previous exception used for the exception chaining
*/
public function __construct($dataFilePath, $previous = null)
{
}
/**
* Retrieves the path to the unreadable file.
*
* @return string
*/
public function getDataFilePath()
{
}
}
/**
* An exception raised when an data file contains malformed data.
*/
class BadDataFileContents extends \Punic\Exception
{
protected $dataFilePath;
protected $dataFileContents;
/**
* Initializes the instance.
*
* @param string $dataFilePath The path to the file with bad contents
* @param string $dataFileContents The malformed of the file
* @param \Exception $previous The previous exception used for the exception chaining
*/
public function __construct($dataFilePath, $dataFileContents, $previous = null)
{
}
/**
* Retrieves the path to the data file.
*
* @return string
*/
public function getDataFilePath()
{
}
/**
* Retrieves the malformed contents of the file.
*
* @return string
*/
public function getDataFileContents()
{
}
}
/**
* An exception raised when an invalid locale specification has been hit.
*/
class InvalidLocale extends \Punic\Exception
{
protected $locale;
/**
* Initializes the instance.
*
* @param mixed $locale The bad locale
* @param \Exception $previous The previous exception used for the exception chaining
*/
public function __construct($locale, $previous = null)
{
}
/**
* Retrieves the bad locale.
*
* @return mixed
*/
public function getLocale()
{
}
}
/**
* An exception raised when a function meets an argument of an unsupported type.
*/
class ValueNotInList extends \Punic\Exception
{
protected $value;
protected $allowedValues;
/**
* Initializes the instance.
*
* @param string|numeric $value The invalid value
* @param array<string|numeric> $allowedValues The list of valid values
* @param \Exception $previous The previous exception used for the exception chaining
*/
public function __construct($value, $allowedValues, $previous = null)
{
}
/**
* Retrieves the invalid value.
*
* @return mixed
*/
public function getValue()
{
}
/**
* Retrieves the list of valid values.
*
* @return array<string|numeric>
*/
public function getAllowedValues()
{
}
}
}
namespace Punic {
/**
* Various helper stuff.
*/
class Misc
{
/**
* Concatenates a list of items returning a localized string (for instance: array(1, 2, 3) will result in '1, 2, and 3' for English or '1, 2 e 3' for Italian).
*
* @param array $list The list to concatenate
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if $list is not an array of it it's empty, the joined items otherwise.
*/
public static function join($list, $locale = '')
{
}
/**
* Concatenates a list of unit items returning a localized string (for instance: array('3 ft', '2 in') will result in '3 ft, 2 in'.
*
* @param array $list The list to concatenate
* @param string $width The preferred width ('' for default, or 'short' or 'narrow')
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Returns an empty string if $list is not an array of it it's empty, the joined items otherwise.
*/
public static function joinUnits($list, $width = '', $locale = '')
{
}
protected static function joinInternal($list, $keys, $locale)
{
}
/**
* Fix the case of a string.
*
* @param string $string The string whose case needs to be fixed
* @param string $case How to fix case. Allowed values:
* <li>`'titlecase-words'` all words in the phrase should be title case</li>
* <li>`'titlecase-firstword'` the first word should be title case</li>
* <li>`'lowercase-words'` all words in the phrase should be lower case</li>
* </ul>
*
* @return string
*
* @link http://cldr.unicode.org/development/development-process/design-proposals/consistent-casing
*/
public static function fixCase($string, $case)
{
}
/**
* Parse the browser HTTP_ACCEPT_LANGUAGE header and return the found locales, sorted in descending order by the quality values.
*
* @param bool $ignoreCache Set to true if you want to ignore the cache
*
* @return array Array keys are the found locales, array values are the relative quality value (from 0 to 1)
*/
public static function getBrowserLocales($ignoreCache = false)
{
}
/**
* Parse the value of an HTTP_ACCEPT_LANGUAGE header and return the found locales, sorted in descending order by the quality values.
*
* @param string $httpAcceptLanguages
*
* @return array Array keys are the found locales, array values are the relative quality value (from 0 to 1)
*/
public static function parseHttpAcceptLanguage($httpAcceptLanguages)
{
}
/**
* Retrieve the character order (right-to-left or left-to-right).
*
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Return 'left-to-right' or 'right-to-left'
*/
public static function getCharacterOrder($locale = '')
{
}
/**
* Retrieve the line order (top-to-bottom or bottom-to-top).
*
* @param string $locale The locale to use. If empty we'll use the default locale set in \Punic\Data
*
* @return string Return 'top-to-bottom' or 'bottom-to-top'
*/
public static function getLineOrder($locale = '')
{
}
}
/**
* Currency-related stuff.
*/
class Currency
{
/**
* Returns all the currencies.
*
* @param bool $alsoUnused Set to true to receive also currencies not currently used by any country, false otherwise
* @param bool $alsoNotTender Set to true to receive also currencies that aren't legal tender in any country
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
*
* @return array Array keys are the currency code, array values are the currency name. It's sorted by currency values
*/
public static function getAllCurrencies($alsoUnused = false, $alsoNotTender = false, $locale = '')
{
}
/**
* Returns the name of a currency given its code.
*
* @param string $currencyCode The currency code
* @param null|number|string The quantity identifier. Allowed values:
* <ul>
* <li>`null` to return the standard name, not associated to any quantity</li>
* <li>`number` to return the name following the plural rule for the specified quantity</li>
* <li>string `'zero'|'one'|'two'|'few'|'many'|'other'` the plural rule
* </ul>
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
*
* @return string Returns an empty string if $currencyCode is not valid, the localized currency name otherwise
*/
public static function getName($currencyCode, $quantity = null, $locale = '')
{
}
/**
* Returns the name of a currency given its code.
*
* @param string $currencyCode The currency code
* @param string $which Which symbol flavor do you prefer? 'narrow' for narrow symbols, 'alt' for alternative. Other values: standard/default symbol
* @param string $locale The locale to use. If empty we'll use the default locale set with {@link \Punic\Data::setDefaultLocale()}.
*
* @return string Returns an empty string if $currencyCode is not valid, the localized currency name otherwise
*/
public static function getSymbol($currencyCode, $which = '', $locale = '')
{
}
/**
* Return the history for the currencies used in a territory.
*
* @param string $territoryCode The territoy code
*
* @return array Return a list of items with these keys:
* <ul>
* <li>string `currency`: the currency code (always present)</li>
* <li>string `from`: start date of the currency validity in the territory (not present if no start date) - Format is YYYY-MM-DD</li>
* <li>string `to`: end date of the currency validity in the territory (not present if no end date) - Format is YYYY-MM-DD</li>
* <li>bool `tender`: true if the currency was or is legal tender, false otherwise (always present)</li>
* </ul>
*/
public static function getCurrencyHistoryForTerritory($territoryCode)
{
}
/**
* Return the currency to be used in a territory.
*
* @param string $territoryCode The territoy code
*
* @return string Returns an empty string if $territoryCode is not valid or we don't have info about it, the currency code otherwise
*/
public static function getCurrencyForTerritory($territoryCode)
{
}
protected static function getLocaleData($currencyCode, $locale)
{
}
}
/**
* Various helper stuff.
*/
class Comparer
{
/**
* Initializes the instance.
*
* @param string $locale
* @param bool $caseSensitive
*/
public function __construct($locale = null, $caseSensitive = false)
{
}
/**
* Compare two strings.
*
* @param string $a
* @param string $b
*
* @return int
*/
public function compare($a, $b)
{
}
/**
* @param array $array
* @param bool $keepKeys
*
* @return array
*/
public function sort(&$array, $keepKeys = false)
{
}
}
}
namespace Composer\Semver\Constraint {
interface ConstraintInterface
{
/**
* @param ConstraintInterface $provider
*
* @return bool
*/
public function matches(\Composer\Semver\Constraint\ConstraintInterface $provider);
/**
* @return string
*/
public function getPrettyString();
/**
* @return string
*/
public function __toString();
}
/**
* Base constraint class.
*/
abstract class AbstractConstraint implements \Composer\Semver\Constraint\ConstraintInterface
{
/** @var string */
protected $prettyString;
/**
* @param ConstraintInterface $provider
*
* @return bool
*/
public function matches(\Composer\Semver\Constraint\ConstraintInterface $provider)
{
}
/**
* @param string $prettyString
*/
public function setPrettyString($prettyString)
{
}
/**
* @return string
*/
public function getPrettyString()
{
}
// implementations must implement a method of this format:
// not declared abstract here because type hinting violates parameter coherence (TODO right word?)
// public function matchSpecific(<SpecificConstraintType> $provider);
}
/**
* Defines a constraint.
*/
class Constraint implements \Composer\Semver\Constraint\ConstraintInterface
{
/* operator integer values */
const OP_EQ = 0;
const OP_LT = 1;
const OP_LE = 2;
const OP_GT = 3;
const OP_GE = 4;
const OP_NE = 5;
/** @var string */
protected $operator;
/** @var string */
protected $version;
/** @var string */
protected $prettyString;
/**
* @param ConstraintInterface $provider
*
* @return bool
*/
public function matches(\Composer\Semver\Constraint\ConstraintInterface $provider)
{
}
/**
* @param string $prettyString
*/
public function setPrettyString($prettyString)
{
}
/**
* @return string
*/
public function getPrettyString()
{
}
/**
* Get all supported comparison operators.
*
* @return array
*/
public static function getSupportedOperators()
{
}
/**
* Sets operator and version to compare with.
*
* @param string $operator
* @param string $version
*
* @throws \InvalidArgumentException if invalid operator is given.
*/
public function __construct($operator, $version)
{
}
/**
* @param string $a
* @param string $b
* @param string $operator
* @param bool $compareBranches
*
* @throws \InvalidArgumentException if invalid operator is given.
*
* @return bool
*/
public function versionCompare($a, $b, $operator, $compareBranches = false)
{
}
/**
* @param Constraint $provider
* @param bool $compareBranches
*
* @return bool
*/
public function matchSpecific(\Composer\Semver\Constraint\Constraint $provider, $compareBranches = false)
{
}
/**
* @return string
*/
public function __toString()
{
}
}
/**
* Defines a conjunctive or disjunctive set of constraints.
*/
class MultiConstraint implements \Composer\Semver\Constraint\ConstraintInterface
{
/** @var ConstraintInterface[] */
protected $constraints;
/** @var string */
protected $prettyString;
/** @var bool */
protected $conjunctive;
/**
* @param ConstraintInterface[] $constraints A set of constraints
* @param bool $conjunctive Whether the constraints should be treated as conjunctive or disjunctive
*/
public function __construct(array $constraints, $conjunctive = true)
{
}
/**
* @return ConstraintInterface[]
*/
public function getConstraints()
{
}
/**
* @return bool
*/
public function isConjunctive()
{
}
/**
* @return bool
*/
public function isDisjunctive()
{
}
/**
* @param ConstraintInterface $provider
*
* @return bool
*/
public function matches(\Composer\Semver\Constraint\ConstraintInterface $provider)
{
}
/**
* @param string $prettyString
*/
public function setPrettyString($prettyString)
{
}
/**
* @return string
*/
public function getPrettyString()
{
}
/**
* @return string
*/
public function __toString()
{
}
}
/**
* Defines the absence of a constraint.
*/
class EmptyConstraint implements \Composer\Semver\Constraint\ConstraintInterface
{
/** @var string */
protected $prettyString;
/**
* @param ConstraintInterface $provider
*
* @return bool
*/
public function matches(\Composer\Semver\Constraint\ConstraintInterface $provider)
{
}
/**
* @param $prettyString
*/
public function setPrettyString($prettyString)
{
}
/**
* @return string
*/
public function getPrettyString()
{
}
/**
* @return string
*/
public function __toString()
{
}
}
}
namespace Composer\Semver {
class Comparator
{
/**
* Evaluates the expression: $version1 > $version2.
*
* @param string $version1
* @param string $version2
*
* @return bool
*/
public static function greaterThan($version1, $version2)
{
}
/**
* Evaluates the expression: $version1 >= $version2.
*
* @param string $version1
* @param string $version2
*
* @return bool
*/
public static function greaterThanOrEqualTo($version1, $version2)
{
}
/**
* Evaluates the expression: $version1 < $version2.
*
* @param string $version1
* @param string $version2
*
* @return bool
*/
public static function lessThan($version1, $version2)
{
}
/**
* Evaluates the expression: $version1 <= $version2.
*
* @param string $version1
* @param string $version2
*
* @return bool
*/
public static function lessThanOrEqualTo($version1, $version2)
{
}
/**
* Evaluates the expression: $version1 == $version2.
*
* @param string $version1
* @param string $version2
*
* @return bool
*/
public static function equalTo($version1, $version2)
{
}
/**
* Evaluates the expression: $version1 != $version2.
*
* @param string $version1
* @param string $version2
*
* @return bool
*/
public static function notEqualTo($version1, $version2)
{
}
/**
* Evaluates the expression: $version1 $operator $version2.
*
* @param string $version1
* @param string $operator
* @param string $version2
*
* @return bool
*/
public static function compare($version1, $operator, $version2)
{
}
}
/**
* Version parser.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class VersionParser
{
/**
* Returns the stability of a version.
*
* @param string $version
*
* @return string
*/
public static function parseStability($version)
{
}
/**
* @param string $stability
*
* @return string
*/
public static function normalizeStability($stability)
{
}
/**
* Normalizes a version string to be able to perform comparisons on it.
*
* @param string $version
* @param string $fullVersion optional complete version string to give more context
*
* @throws \UnexpectedValueException
*
* @return string
*/
public function normalize($version, $fullVersion = null)
{
}
/**
* Extract numeric prefix from alias, if it is in numeric format, suitable for version comparison.
*
* @param string $branch Branch name (e.g. 2.1.x-dev)
*
* @return string|false Numeric prefix if present (e.g. 2.1.) or false
*/
public function parseNumericAliasPrefix($branch)
{
}
/**
* Normalizes a branch name to be able to perform comparisons on it.
*
* @param string $name
*
* @return string
*/
public function normalizeBranch($name)
{
}
/**
* Parses a constraint string into MultiConstraint and/or Constraint objects.
*
* @param string $constraints
*
* @return ConstraintInterface
*/
public function parseConstraints($constraints)
{
}
}
class Semver
{
const SORT_ASC = 1;
const SORT_DESC = -1;
/**
* Determine if given version satisfies given constraints.
*
* @param string $version
* @param string $constraints
*
* @return bool
*/
public static function satisfies($version, $constraints)
{
}
/**
* Return all versions that satisfy given constraints.
*
* @param array $versions
* @param string $constraints
*
* @return array
*/
public static function satisfiedBy(array $versions, $constraints)
{
}
/**
* Sort given array of versions.
*
* @param array $versions
*
* @return array
*/
public static function sort(array $versions)
{
}
/**
* Sort given array of versions in reverse.
*
* @param array $versions
*
* @return array
*/
public static function rsort(array $versions)
{
}
}
}
namespace Composer\SelfUpdate {
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class Keys
{
public static function fingerprint($path)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class Versions
{
public function __construct(\Composer\Config $config, \Composer\Util\RemoteFilesystem $rfs)
{
}
public function getChannel()
{
}
public function setChannel($channel)
{
}
public function getLatest()
{
}
}
}
namespace Composer {
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Konstantin Kudryashiv <ever.zet@gmail.com>
* @author Nils Adermann <naderman@naderman.de>
*/
class Composer
{
const VERSION = '1.0.3';
const BRANCH_ALIAS_VERSION = '';
const RELEASE_DATE = '2016-04-29 16:30:15';
/**
* @param Package\RootPackageInterface $package
* @return void
*/
public function setPackage(\Composer\Package\RootPackageInterface $package)
{
}
/**
* @return Package\RootPackageInterface
*/
public function getPackage()
{
}
/**
* @param Config $config
*/
public function setConfig(\Composer\Config $config)
{
}
/**
* @return Config
*/
public function getConfig()
{
}
/**
* @param Package\Locker $locker
*/
public function setLocker(\Composer\Package\Locker $locker)
{
}
/**
* @return Package\Locker
*/
public function getLocker()
{
}
/**
* @param Repository\RepositoryManager $manager
*/
public function setRepositoryManager(\Composer\Repository\RepositoryManager $manager)
{
}
/**
* @return Repository\RepositoryManager
*/
public function getRepositoryManager()
{
}
/**
* @param Downloader\DownloadManager $manager
*/
public function setDownloadManager(\Composer\Downloader\DownloadManager $manager)
{
}
/**
* @return Downloader\DownloadManager
*/
public function getDownloadManager()
{
}
/**
* @param Installer\InstallationManager $manager
*/
public function setInstallationManager(\Composer\Installer\InstallationManager $manager)
{
}
/**
* @return Installer\InstallationManager
*/
public function getInstallationManager()
{
}
/**
* @param Plugin\PluginManager $manager
*/
public function setPluginManager(\Composer\Plugin\PluginManager $manager)
{
}
/**
* @return Plugin\PluginManager
*/
public function getPluginManager()
{
}
/**
* @param EventDispatcher $eventDispatcher
*/
public function setEventDispatcher(\Composer\EventDispatcher\EventDispatcher $eventDispatcher)
{
}
/**
* @return EventDispatcher
*/
public function getEventDispatcher()
{
}
/**
* @param Autoload\AutoloadGenerator $autoloadGenerator
*/
public function setAutoloadGenerator(\Composer\Autoload\AutoloadGenerator $autoloadGenerator)
{
}
/**
* @return Autoload\AutoloadGenerator
*/
public function getAutoloadGenerator()
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class Config
{
const RELATIVE_PATHS = 1;
public static $defaultConfig = array(
'process-timeout' => 300,
'use-include-path' => false,
'preferred-install' => 'auto',
'notify-on-install' => true,
'github-protocols' => array('https', 'ssh', 'git'),
'vendor-dir' => 'vendor',
'bin-dir' => '{$vendor-dir}/bin',
'cache-dir' => '{$home}/cache',
'data-dir' => '{$home}',
'cache-files-dir' => '{$cache-dir}/files',
'cache-repo-dir' => '{$cache-dir}/repo',
'cache-vcs-dir' => '{$cache-dir}/vcs',
'cache-ttl' => 15552000,
// 6 months
'cache-files-ttl' => null,
// fallback to cache-ttl
'cache-files-maxsize' => '300MiB',
'bin-compat' => 'auto',
'discard-changes' => false,
'autoloader-suffix' => null,
'sort-packages' => false,
'optimize-autoloader' => false,
'classmap-authoritative' => false,
'prepend-autoloader' => true,
'github-domains' => array('github.com'),
'bitbucket-expose-hostname' => true,
'disable-tls' => false,
'secure-http' => true,
'cafile' => null,
'capath' => null,
'github-expose-hostname' => true,
'gitlab-domains' => array('gitlab.com'),
'store-auths' => 'prompt',
'platform' => array(),
'archive-format' => 'tar',
'archive-dir' => '.',
);
public static $defaultRepositories = array('packagist' => array('type' => 'composer', 'url' => 'https?://packagist.org', 'allow_ssl_downgrade' => true));
/**
* @param bool $useEnvironment Use COMPOSER_ environment variables to replace config settings
* @param string $baseDir Optional base directory of the config
*/
public function __construct($useEnvironment = true, $baseDir = null)
{
}
public function setConfigSource(\Composer\Config\ConfigSourceInterface $source)
{
}
public function getConfigSource()
{
}
public function setAuthConfigSource(\Composer\Config\ConfigSourceInterface $source)
{
}
public function getAuthConfigSource()
{
}
/**
* Merges new config values with the existing ones (overriding)
*
* @param array $config
*/
public function merge($config)
{
}
/**
* @return array
*/
public function getRepositories()
{
}
/**
* Returns a setting
*
* @param string $key
* @param int $flags Options (see class constants)
* @throws \RuntimeException
* @return mixed
*/
public function get($key, $flags = 0)
{
}
public function all($flags = 0)
{
}
public function raw()
{
}
/**
* Checks whether a setting exists
*
* @param string $key
* @return bool
*/
public function has($key)
{
}
/**
* Validates that the passed URL is allowed to be used by current config, or throws an exception.
*
* @param string $url
*/
public function prohibitUrlByConfig($url)
{
}
}
}
namespace Composer\Autoload {
/**
* @author Igor Wiedler <igor@wiedler.ch>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class AutoloadGenerator
{
public function __construct(\Composer\EventDispatcher\EventDispatcher $eventDispatcher, \Composer\IO\IOInterface $io = null)
{
}
public function setDevMode($devMode = true)
{
}
/**
* Whether or not generated autoloader considers the class map
* authoritative.
*
* @param bool $classMapAuthoritative
*/
public function setClassMapAuthoritative($classMapAuthoritative)
{
}
/**
* Set whether to run scripts or not
*
* @param bool $runScripts
*/
public function setRunScripts($runScripts = true)
{
}
public function dump(\Composer\Config $config, \Composer\Repository\InstalledRepositoryInterface $localRepo, \Composer\Package\PackageInterface $mainPackage, \Composer\Installer\InstallationManager $installationManager, $targetDir, $scanPsr0Packages = false, $suffix = '')
{
}
public function buildPackageMap(\Composer\Installer\InstallationManager $installationManager, \Composer\Package\PackageInterface $mainPackage, array $packages)
{
}
/**
* @param PackageInterface $package
*
* @throws \InvalidArgumentException Throws an exception, if the package has illegal settings.
*/
protected function validatePackage(\Composer\Package\PackageInterface $package)
{
}
/**
* Compiles an ordered list of namespace => path mappings
*
* @param array $packageMap array of array(package, installDir-relative-to-composer.json)
* @param PackageInterface $mainPackage root package instance
* @return array array('psr-0' => array('Ns\\Foo' => array('installDir')))
*/
public function parseAutoloads(array $packageMap, \Composer\Package\PackageInterface $mainPackage)
{
}
/**
* Registers an autoloader based on an autoload map returned by parseAutoloads
*
* @param array $autoloads see parseAutoloads return value
* @return ClassLoader
*/
public function createLoader(array $autoloads)
{
}
protected function getIncludePathsFile(array $packageMap, \Composer\Util\Filesystem $filesystem, $basePath, $vendorPath, $vendorPathCode, $appBaseDirCode)
{
}
protected function getIncludeFilesFile(array $files, \Composer\Util\Filesystem $filesystem, $basePath, $vendorPath, $vendorPathCode, $appBaseDirCode)
{
}
protected function getPathCode(\Composer\Util\Filesystem $filesystem, $basePath, $vendorPath, $path)
{
}
protected function getAutoloadFile($vendorPathToTargetDirCode, $suffix)
{
}
protected function getAutoloadRealFile($useClassMap, $useIncludePath, $targetDirLoader, $useIncludeFiles, $vendorPathCode, $appBaseDirCode, $suffix, $useGlobalIncludePath, $prependAutoloader)
{
}
protected function parseAutoloadsType(array $packageMap, $type, \Composer\Package\PackageInterface $mainPackage)
{
}
protected function getFileIdentifier(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* Sorts packages by dependency weight
*
* Packages of equal weight retain the original order
*
* @param array $packageMap
* @return array
*/
protected function sortPackageMap(array $packageMap)
{
}
/**
* Copy file using stream_copy_to_stream to work around https://bugs.php.net/bug.php?id=6463
*
* @param string $source
* @param string $target
*/
protected function safeCopy($source, $target)
{
}
}
/**
* ClassMapGenerator
*
* @author Gyula Sallai <salla016@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ClassMapGenerator
{
/**
* Generate a class map file
*
* @param \Traversable $dirs Directories or a single path to search in
* @param string $file The name of the class map file
*/
public static function dump($dirs, $file)
{
}
/**
* Iterate over all files in the given directory searching for classes
*
* @param \Iterator|string $path The path to search in or an iterator
* @param string $blacklist Regex that matches against the file path that exclude from the classmap.
* @param IOInterface $io IO object
* @param string $namespace Optional namespace prefix to filter by
*
* @throws \RuntimeException When the path is neither an existing file nor directory
* @return array A class map array
*/
public static function createMap($path, $blacklist = null, \Composer\IO\IOInterface $io = null, $namespace = null)
{
}
}
}
namespace Composer\Repository {
/**
* Repository interface.
*
* @author Nils Adermann <naderman@naderman.de>
* @author Konstantin Kudryashov <ever.zet@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
interface RepositoryInterface extends \Countable
{
const SEARCH_FULLTEXT = 0;
const SEARCH_NAME = 1;
/**
* Checks if specified package registered (installed).
*
* @param PackageInterface $package package instance
*
* @return bool
*/
public function hasPackage(\Composer\Package\PackageInterface $package);
/**
* Searches for the first match of a package by name and version.
*
* @param string $name package name
* @param string|\Composer\Semver\Constraint\ConstraintInterface $constraint package version or version constraint to match against
*
* @return PackageInterface|null
*/
public function findPackage($name, $constraint);
/**
* Searches for all packages matching a name and optionally a version.
*
* @param string $name package name
* @param string|\Composer\Semver\Constraint\ConstraintInterface $constraint package version or version constraint to match against
*
* @return PackageInterface[]
*/
public function findPackages($name, $constraint = null);
/**
* Returns list of registered packages.
*
* @return PackageInterface[]
*/
public function getPackages();
/**
* Searches the repository for packages containing the query
*
* @param string $query search query
* @param int $mode a set of SEARCH_* constants to search on, implementations should do a best effort only
* @return array[] an array of array('name' => '...', 'description' => '...')
*/
public function search($query, $mode = 0);
}
/**
* Writable repository interface.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
interface WritableRepositoryInterface extends \Composer\Repository\RepositoryInterface
{
/**
* Writes repository (f.e. to the disc).
*/
public function write();
/**
* Adds package to the repository.
*
* @param PackageInterface $package package instance
*/
public function addPackage(\Composer\Package\PackageInterface $package);
/**
* Removes package from the repository.
*
* @param PackageInterface $package package instance
*/
public function removePackage(\Composer\Package\PackageInterface $package);
/**
* Get unique packages (at most one package of each name), with aliases resolved and removed.
*
* @return PackageInterface[]
*/
public function getCanonicalPackages();
/**
* Forces a reload of all packages.
*/
public function reload();
}
/**
* Installable repository interface.
*
* Just used to tag installed repositories so the base classes can act differently on Alias packages
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
interface InstalledRepositoryInterface extends \Composer\Repository\WritableRepositoryInterface
{
}
/**
* Common ancestor class for generic repository functionality.
*
* @author Niels Keurentjes <niels.keurentjes@omines.com>
*/
abstract class BaseRepository implements \Composer\Repository\RepositoryInterface
{
/**
* Returns a list of links causing the requested needle packages to be installed, as an associative array with the
* dependent's name as key, and an array containing in order the PackageInterface and Link describing the relationship
* as values. If recursive lookup was requested a third value is returned containing an identically formed array up
* to the root package. That third value will be false in case a circular recursion was detected.
*
* @param string|string[] $needle The package name(s) to inspect.
* @param ConstraintInterface|null $constraint Optional constraint to filter by.
* @param bool $invert Whether to invert matches to discover reasons for the package *NOT* to be installed.
* @param bool $recurse Whether to recursively expand the requirement tree up to the root package.
* @param string[] $packagesFound Used internally when recurring
* @return array An associative array of arrays as described above.
*/
public function getDependents($needle, $constraint = null, $invert = false, $recurse = true, $packagesFound = null)
{
}
}
/**
* A repository implementation that simply stores packages in an array
*
* @author Nils Adermann <naderman@naderman.de>
*/
class ArrayRepository extends \Composer\Repository\BaseRepository
{
/** @var PackageInterface[] */
protected $packages;
public function __construct(array $packages = array())
{
}
/**
* {@inheritDoc}
*/
public function findPackage($name, $constraint)
{
}
/**
* {@inheritDoc}
*/
public function findPackages($name, $constraint = null)
{
}
/**
* {@inheritDoc}
*/
public function search($query, $mode = 0)
{
}
/**
* {@inheritDoc}
*/
public function hasPackage(\Composer\Package\PackageInterface $package)
{
}
/**
* Adds a new package to the repository
*
* @param PackageInterface $package
*/
public function addPackage(\Composer\Package\PackageInterface $package)
{
}
protected function createAliasPackage(\Composer\Package\PackageInterface $package, $alias, $prettyAlias)
{
}
/**
* Removes package from repository.
*
* @param PackageInterface $package package instance
*/
public function removePackage(\Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function getPackages()
{
}
/**
* Returns the number of packages in this repository
*
* @return int Number of packages
*/
public function count()
{
}
/**
* Initializes the packages array. Mostly meant as an extension point.
*/
protected function initialize()
{
}
}
/**
* Writable array repository.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class WritableArrayRepository extends \Composer\Repository\ArrayRepository implements \Composer\Repository\WritableRepositoryInterface
{
/**
* {@inheritDoc}
*/
public function write()
{
}
/**
* {@inheritDoc}
*/
public function reload()
{
}
/**
* {@inheritDoc}
*/
public function getCanonicalPackages()
{
}
}
/**
* Installed array repository.
*
* This is used for serving the RootPackage inside an in-memory InstalledRepository
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class InstalledArrayRepository extends \Composer\Repository\WritableArrayRepository implements \Composer\Repository\InstalledRepositoryInterface
{
}
/**
* Configurable repository interface.
*
* @author Lukas Homza <lukashomz@gmail.com>
*/
interface ConfigurableRepositoryInterface
{
public function getRepoConfig();
}
/**
* Builds list of package from PEAR channel.
*
* Packages read from channel are named as 'pear-{channelName}/{packageName}'
* and has aliased as 'pear-{channelAlias}/{packageName}'
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class PearRepository extends \Composer\Repository\ArrayRepository implements \Composer\Repository\ConfigurableRepositoryInterface
{
public function __construct(array $repoConfig, \Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $dispatcher = null, \Composer\Util\RemoteFilesystem $rfs = null)
{
}
public function getRepoConfig()
{
}
protected function initialize()
{
}
}
/**
* Repositories manager.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Konstantin Kudryashov <ever.zet@gmail.com>
* @author François Pluchino <francois.pluchino@opendisplay.com>
*/
class RepositoryManager
{
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $eventDispatcher = null, \Composer\Util\RemoteFilesystem $rfs = null)
{
}
/**
* Searches for a package by it's name and version in managed repositories.
*
* @param string $name package name
* @param string|\Composer\Semver\Constraint\ConstraintInterface $constraint package version or version constraint to match against
*
* @return PackageInterface|null
*/
public function findPackage($name, $constraint)
{
}
/**
* Searches for all packages matching a name and optionally a version in managed repositories.
*
* @param string $name package name
* @param string|\Composer\Semver\Constraint\ConstraintInterface $constraint package version or version constraint to match against
*
* @return array
*/
public function findPackages($name, $constraint)
{
}
/**
* Adds repository
*
* @param RepositoryInterface $repository repository instance
*/
public function addRepository(\Composer\Repository\RepositoryInterface $repository)
{
}
/**
* Adds a repository to the beginning of the chain
*
* This is useful when injecting additional repositories that should trump Packagist, e.g. from a plugin.
*
* @param RepositoryInterface $repository repository instance
*/
public function prependRepository(\Composer\Repository\RepositoryInterface $repository)
{
}
/**
* Returns a new repository for a specific installation type.
*
* @param string $type repository type
* @param array $config repository configuration
* @throws \InvalidArgumentException if repository for provided type is not registered
* @return RepositoryInterface
*/
public function createRepository($type, $config)
{
}
/**
* Stores repository class for a specific installation type.
*
* @param string $type installation type
* @param string $class class name of the repo implementation
*/
public function setRepositoryClass($type, $class)
{
}
/**
* Returns all repositories, except local one.
*
* @return array
*/
public function getRepositories()
{
}
/**
* Sets local repository for the project.
*
* @param WritableRepositoryInterface $repository repository instance
*/
public function setLocalRepository(\Composer\Repository\WritableRepositoryInterface $repository)
{
}
/**
* Returns local repository for the project.
*
* @return WritableRepositoryInterface
*/
public function getLocalRepository()
{
}
}
}
namespace Composer\Repository\Pear {
/**
* PEAR channel info
*
* @author Alexey Prilipko <palex@farpost.com>
*/
class ChannelInfo
{
/**
* @param string $name
* @param string $alias
* @param PackageInfo[] $packages
*/
public function __construct($name, $alias, array $packages)
{
}
/**
* Name of the channel
*
* @return string
*/
public function getName()
{
}
/**
* Alias of the channel
*
* @return string
*/
public function getAlias()
{
}
/**
* List of channel packages
*
* @return PackageInfo[]
*/
public function getPackages()
{
}
}
/**
* Base PEAR Channel reader.
*
* Provides xml namespaces and red
*
* @author Alexey Prilipko <palex@farpost.com>
*/
abstract class BaseChannelReader
{
/**
* PEAR REST Interface namespaces
*/
const CHANNEL_NS = 'http://pear.php.net/channel-1.0';
const ALL_CATEGORIES_NS = 'http://pear.php.net/dtd/rest.allcategories';
const CATEGORY_PACKAGES_INFO_NS = 'http://pear.php.net/dtd/rest.categorypackageinfo';
const ALL_PACKAGES_NS = 'http://pear.php.net/dtd/rest.allpackages';
const ALL_RELEASES_NS = 'http://pear.php.net/dtd/rest.allreleases';
const PACKAGE_INFO_NS = 'http://pear.php.net/dtd/rest.package';
protected function __construct(\Composer\Util\RemoteFilesystem $rfs)
{
}
/**
* Read content from remote filesystem.
*
* @param $origin string server
* @param $path string relative path to content
* @throws \UnexpectedValueException
* @return \SimpleXMLElement
*/
protected function requestContent($origin, $path)
{
}
/**
* Read xml content from remote filesystem
*
* @param $origin string server
* @param $path string relative path to content
* @throws \UnexpectedValueException
* @return \SimpleXMLElement
*/
protected function requestXml($origin, $path)
{
}
}
/**
* Read PEAR packages using REST 1.1 interface
*
* At version 1.1 package descriptions read from:
* {baseUrl}/c/categories.xml
* {baseUrl}/c/{category}/packagesinfo.xml
*
* @author Alexey Prilipko <palex@farpost.com>
*/
class ChannelRest11Reader extends \Composer\Repository\Pear\BaseChannelReader
{
public function __construct($rfs)
{
}
/**
* Reads package descriptions using PEAR Rest 1.1 interface
*
* @param $baseUrl string base Url interface
*
* @return PackageInfo[]
*/
public function read($baseUrl)
{
}
}
/**
* PEAR package release info
*
* @author Alexey Prilipko <palex@farpost.com>
*/
class ReleaseInfo
{
/**
* @param string $stability
* @param DependencyInfo $dependencyInfo
*/
public function __construct($stability, $dependencyInfo)
{
}
/**
* @return DependencyInfo release dependencies
*/
public function getDependencyInfo()
{
}
/**
* @return string release stability
*/
public function getStability()
{
}
}
/**
* Read PEAR packages using REST 1.0 interface
*
* @author Alexey Prilipko <palex@farpost.com>
*/
class PackageDependencyParser
{
/**
* Builds dependency information. It detects used package.xml format.
*
* @param $depArray array
* @return DependencyInfo
*/
public function buildDependencyInfo($depArray)
{
}
}
/**
* PEAR Package info
*
* @author Alexey Prilipko <palex@farpost.com>
*/
class PackageInfo
{
/**
* @param string $channelName
* @param string $packageName
* @param string $license
* @param string $shortDescription
* @param string $description
* @param ReleaseInfo[] $releases associative array maps release version to release info
*/
public function __construct($channelName, $packageName, $license, $shortDescription, $description, $releases)
{
}
/**
* @return string the package channel name
*/
public function getChannelName()
{
}
/**
* @return string the package name
*/
public function getPackageName()
{
}
/**
* @return string the package description
*/
public function getDescription()
{
}
/**
* @return string the package short description
*/
public function getShortDescription()
{
}
/**
* @return string the package license
*/
public function getLicense()
{
}
/**
* @return ReleaseInfo[]
*/
public function getReleases()
{
}
}
/**
* PEAR Channel package reader.
*
* Reads channel packages info from and builds Package's
*
* @author Alexey Prilipko <palex@farpost.com>
*/
class ChannelReader extends \Composer\Repository\Pear\BaseChannelReader
{
public function __construct(\Composer\Util\RemoteFilesystem $rfs)
{
}
/**
* Reads PEAR channel through REST interface and builds list of packages
*
* @param $url string PEAR Channel url
* @throws \UnexpectedValueException
* @return ChannelInfo
*/
public function read($url)
{
}
}
/**
* PEAR package release dependency info
*
* @author Alexey Prilipko <palex@farpost.com>
*/
class DependencyConstraint
{
/**
* @param string $type
* @param string $constraint
* @param string $channelName
* @param string $packageName
*/
public function __construct($type, $constraint, $channelName, $packageName)
{
}
public function getChannelName()
{
}
public function getConstraint()
{
}
public function getPackageName()
{
}
public function getType()
{
}
}
/**
* Read PEAR packages using REST 1.0 interface
*
* At version 1.0 package descriptions read from:
* {baseUrl}/p/packages.xml
* {baseUrl}/p/{package}/info.xml
* {baseUrl}/p/{package}/allreleases.xml
* {baseUrl}/p/{package}/deps.{version}.txt
*
* @author Alexey Prilipko <palex@farpost.com>
*/
class ChannelRest10Reader extends \Composer\Repository\Pear\BaseChannelReader
{
public function __construct($rfs)
{
}
/**
* Reads package descriptions using PEAR Rest 1.0 interface
*
* @param $baseUrl string base Url interface
*
* @return PackageInfo[]
*/
public function read($baseUrl)
{
}
}
/**
* PEAR package release dependency info
*
* @author Alexey Prilipko <palex@farpost.com>
*/
class DependencyInfo
{
/**
* @param DependencyConstraint[] $requires list of requires/conflicts/replaces
* @param array $optionals [groupName => DependencyConstraint[]] list of optional groups
*/
public function __construct($requires, $optionals)
{
}
/**
* @return DependencyConstraint[] list of requires/conflicts/replaces
*/
public function getRequires()
{
}
/**
* @return array [groupName => DependencyConstraint[]] list of optional groups
*/
public function getOptionals()
{
}
}
}
namespace Composer\Repository {
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class PlatformRepository extends \Composer\Repository\ArrayRepository
{
const PLATFORM_PACKAGE_REGEX = '{^(?:php(?:-64bit)?|hhvm|(?:ext|lib)-[^/]+)$}i';
public function __construct(array $packages = array(), array $overrides = array())
{
}
protected function initialize()
{
}
/**
* {@inheritDoc}
*/
public function addPackage(\Composer\Package\PackageInterface $package)
{
}
}
/**
* Thrown when a security problem, like a broken or missing signature
*
* @author Eric Daspet <edaspet@survol.fr>
*/
class RepositorySecurityException extends \Exception
{
}
/**
* Package repository.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class PackageRepository extends \Composer\Repository\ArrayRepository
{
/**
* Initializes filesystem repository.
*
* @param array $config package definition
*/
public function __construct(array $config)
{
}
/**
* Initializes repository (reads file, or remote address).
*/
protected function initialize()
{
}
}
/**
* Filesystem repository.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class FilesystemRepository extends \Composer\Repository\WritableArrayRepository
{
/**
* Initializes filesystem repository.
*
* @param JsonFile $repositoryFile repository json file
*/
public function __construct(\Composer\Json\JsonFile $repositoryFile)
{
}
/**
* Initializes repository (reads file, or remote address).
*/
protected function initialize()
{
}
public function reload()
{
}
/**
* Writes writable repository.
*/
public function write()
{
}
}
/**
* Installed filesystem repository.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class InstalledFilesystemRepository extends \Composer\Repository\FilesystemRepository implements \Composer\Repository\InstalledRepositoryInterface
{
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class RepositoryFactory
{
/**
* @param IOInterface $io
* @param Config $config
* @param string $repository
* @param bool $allowFilesystem
* @return array|mixed
*/
public static function configFromString(\Composer\IO\IOInterface $io, \Composer\Config $config, $repository, $allowFilesystem = false)
{
}
/**
* @param IOInterface $io
* @param Config $config
* @param string $repository
* @param bool $allowFilesystem
* @return RepositoryInterface
*/
public static function fromString(\Composer\IO\IOInterface $io, \Composer\Config $config, $repository, $allowFilesystem = false)
{
}
/**
* @param IOInterface $io
* @param Config $config
* @param array $repoConfig
* @return RepositoryInterface
*/
public static function createRepo(\Composer\IO\IOInterface $io, \Composer\Config $config, array $repoConfig)
{
}
/**
* @param IOInterface|null $io
* @param Config|null $config
* @param RepositoryManager|null $rm
* @return RepositoryInterface[]
*/
public static function defaultRepos(\Composer\IO\IOInterface $io = null, \Composer\Config $config = null, \Composer\Repository\RepositoryManager $rm = null)
{
}
/**
* @param IOInterface $io
* @param Config $config
* @param EventDispatcher $eventDispatcher
* @param RemoteFilesystem $rfs
* @return RepositoryManager
*/
public static function manager(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $eventDispatcher = null, \Composer\Util\RemoteFilesystem $rfs = null)
{
}
}
}
namespace Composer\Repository\Vcs {
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
interface VcsDriverInterface
{
/**
* Initializes the driver (git clone, svn checkout, fetch info etc)
*/
public function initialize();
/**
* Return the composer.json file information
*
* @param string $identifier Any identifier to a specific branch/tag/commit
* @return array containing all infos from the composer.json file
*/
public function getComposerInformation($identifier);
/**
* Return the root identifier (trunk, master, default/tip ..)
*
* @return string Identifier
*/
public function getRootIdentifier();
/**
* Return list of branches in the repository
*
* @return array Branch names as keys, identifiers as values
*/
public function getBranches();
/**
* Return list of tags in the repository
*
* @return array Tag names as keys, identifiers as values
*/
public function getTags();
/**
* @param string $identifier Any identifier to a specific branch/tag/commit
* @return array With type, url reference and shasum keys.
*/
public function getDist($identifier);
/**
* @param string $identifier Any identifier to a specific branch/tag/commit
* @return array With type, url and reference keys.
*/
public function getSource($identifier);
/**
* Return the URL of the repository
*
* @return string
*/
public function getUrl();
/**
* Return true if the repository has a composer file for a given identifier,
* false otherwise.
*
* @param string $identifier Any identifier to a specific branch/tag/commit
* @return bool Whether the repository has a composer file for a given identifier.
*/
public function hasComposerFile($identifier);
/**
* Performs any cleanup necessary as the driver is not longer needed
*/
public function cleanup();
/**
* Checks if this driver can handle a given url
*
* @param IOInterface $io IO instance
* @param Config $config current $config
* @param string $url URL to validate/check
* @param bool $deep unless true, only shallow checks (url matching typically) should be done
* @return bool
*/
public static function supports(\Composer\IO\IOInterface $io, \Composer\Config $config, $url, $deep = false);
}
/**
* A driver implementation for driver with authentication interaction.
*
* @author François Pluchino <francois.pluchino@opendisplay.com>
*/
abstract class VcsDriver implements \Composer\Repository\Vcs\VcsDriverInterface
{
/** @var string */
protected $url;
/** @var string */
protected $originUrl;
/** @var array */
protected $repoConfig;
/** @var IOInterface */
protected $io;
/** @var Config */
protected $config;
/** @var ProcessExecutor */
protected $process;
/** @var RemoteFilesystem */
protected $remoteFilesystem;
/**
* Constructor.
*
* @param array $repoConfig The repository configuration
* @param IOInterface $io The IO instance
* @param Config $config The composer configuration
* @param ProcessExecutor $process Process instance, injectable for mocking
* @param RemoteFilesystem $remoteFilesystem Remote Filesystem, injectable for mocking
*/
public final function __construct(array $repoConfig, \Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\Util\ProcessExecutor $process = null, \Composer\Util\RemoteFilesystem $remoteFilesystem = null)
{
}
/**
* {@inheritDoc}
*/
public function hasComposerFile($identifier)
{
}
/**
* Get the https or http protocol depending on SSL support.
*
* Call this only if you know that the server supports both.
*
* @return string The correct type of protocol
*/
protected function getScheme()
{
}
/**
* Get the remote content.
*
* @param string $url The URL of content
*
* @return mixed The result
*/
protected function getContents($url)
{
}
/**
* {@inheritDoc}
*/
public function cleanup()
{
}
}
/**
* @author Per Bernhardt <plb@webfactory.de>
*/
class GitBitbucketDriver extends \Composer\Repository\Vcs\VcsDriver implements \Composer\Repository\Vcs\VcsDriverInterface
{
protected $cache;
protected $owner;
protected $repository;
protected $tags;
protected $branches;
protected $rootIdentifier;
protected $infoCache = array();
/**
* {@inheritDoc}
*/
public function initialize()
{
}
/**
* {@inheritDoc}
*/
public function getRootIdentifier()
{
}
/**
* {@inheritDoc}
*/
public function getUrl()
{
}
/**
* {@inheritDoc}
*/
public function getSource($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getDist($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getComposerInformation($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getTags()
{
}
/**
* {@inheritDoc}
*/
public function getBranches()
{
}
/**
* {@inheritDoc}
*/
public static function supports(\Composer\IO\IOInterface $io, \Composer\Config $config, $url, $deep = false)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Till Klampaeckel <till@php.net>
*/
class SvnDriver extends \Composer\Repository\Vcs\VcsDriver
{
/**
* @var Cache
*/
protected $cache;
protected $baseUrl;
protected $tags;
protected $branches;
protected $rootIdentifier;
protected $infoCache = array();
protected $trunkPath = 'trunk';
protected $branchesPath = 'branches';
protected $tagsPath = 'tags';
protected $packagePath = '';
protected $cacheCredentials = true;
/**
* {@inheritDoc}
*/
public function initialize()
{
}
/**
* {@inheritDoc}
*/
public function getRootIdentifier()
{
}
/**
* {@inheritDoc}
*/
public function getUrl()
{
}
/**
* {@inheritDoc}
*/
public function getSource($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getDist($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getComposerInformation($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getTags()
{
}
/**
* {@inheritDoc}
*/
public function getBranches()
{
}
/**
* {@inheritDoc}
*/
public static function supports(\Composer\IO\IOInterface $io, \Composer\Config $config, $url, $deep = false)
{
}
/**
* An absolute path (leading '/') is converted to a file:// url.
*
* @param string $url
*
* @return string
*/
protected static function normalizeUrl($url)
{
}
/**
* Execute an SVN command and try to fix up the process with credentials
* if necessary.
*
* @param string $command The svn command to run.
* @param string $url The SVN URL.
* @throws \RuntimeException
* @return string
*/
protected function execute($command, $url)
{
}
/**
* Build the identifier respecting "package-path" config option
*
* @param string $baseDir The path to trunk/branch/tag
* @param int $revision The revision mark to add to identifier
*
* @return string
*/
protected function buildIdentifier($baseDir, $revision)
{
}
}
/**
* Driver for GitLab API, use the Git driver for local checkouts.
*
* @author Henrik Bjørnskov <henrik@bjrnskov.dk>
* @author Jérôme Tamarelle <jerome@tamarelle.net>
*/
class GitLabDriver extends \Composer\Repository\Vcs\VcsDriver
{
/**
* Git Driver
*
* @var GitDriver
*/
protected $gitDriver;
const URL_REGEX = '#^(?:(?P<scheme>https?)://(?P<domain>.+?)/|git@(?P<domain2>[^:]+):)(?P<owner>[^/]+)/(?P<repo>[^/]+?)(?:\\.git|/)?$#';
/**
* Extracts information from the repository url.
* SSH urls uses https by default.
*
* {@inheritDoc}
*/
public function initialize()
{
}
/**
* Updates the RemoteFilesystem instance.
* Mainly useful for tests.
*
* @internal
*/
public function setRemoteFilesystem(\Composer\Util\RemoteFilesystem $remoteFilesystem)
{
}
/**
* Fetches the composer.json file from the project by a identifier.
*
* if specific keys arent present it will try and infer them by default values.
*
* {@inheritDoc}
*/
public function getComposerInformation($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getRepositoryUrl()
{
}
/**
* {@inheritDoc}
*/
public function getUrl()
{
}
/**
* {@inheritDoc}
*/
public function getDist($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getSource($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getRootIdentifier()
{
}
/**
* {@inheritDoc}
*/
public function getBranches()
{
}
/**
* {@inheritDoc}
*/
public function getTags()
{
}
/**
* Fetches composer.json file from the repository through api.
*
* @param string $identifier
*
* @return array
*/
protected function fetchComposerFile($identifier)
{
}
/**
* @return string Base URL for GitLab API v3
*/
public function getApiUrl()
{
}
/**
* @param string $type
*
* @return string[] where keys are named references like tags or branches and the value a sha
*/
protected function getReferences($type)
{
}
protected function fetchProject()
{
}
protected function attemptCloneFallback()
{
}
/**
* Generate an SSH URL
*
* @return string
*/
protected function generateSshUrl()
{
}
protected function setupGitDriver($url)
{
}
/**
* {@inheritDoc}
*/
protected function getContents($url, $fetchingRepoData = false)
{
}
/**
* Uses the config `gitlab-domains` to see if the driver supports the url for the
* repository given.
*
* {@inheritDoc}
*/
public static function supports(\Composer\IO\IOInterface $io, \Composer\Config $config, $url, $deep = false)
{
}
}
/**
* @author Per Bernhardt <plb@webfactory.de>
*/
class HgBitbucketDriver extends \Composer\Repository\Vcs\VcsDriver
{
protected $cache;
protected $owner;
protected $repository;
protected $tags;
protected $branches;
protected $rootIdentifier;
protected $infoCache = array();
/**
* {@inheritDoc}
*/
public function initialize()
{
}
/**
* {@inheritDoc}
*/
public function getRootIdentifier()
{
}
/**
* {@inheritDoc}
*/
public function getUrl()
{
}
/**
* {@inheritDoc}
*/
public function getSource($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getDist($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getComposerInformation($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getTags()
{
}
/**
* {@inheritDoc}
*/
public function getBranches()
{
}
/**
* {@inheritDoc}
*/
public static function supports(\Composer\IO\IOInterface $io, \Composer\Config $config, $url, $deep = false)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class GitHubDriver extends \Composer\Repository\Vcs\VcsDriver
{
protected $cache;
protected $owner;
protected $repository;
protected $tags;
protected $branches;
protected $rootIdentifier;
protected $hasIssues;
protected $infoCache = array();
protected $isPrivate = false;
/**
* Git Driver
*
* @var GitDriver
*/
protected $gitDriver;
/**
* {@inheritDoc}
*/
public function initialize()
{
}
public function getRepositoryUrl()
{
}
/**
* {@inheritDoc}
*/
public function getRootIdentifier()
{
}
/**
* {@inheritDoc}
*/
public function getUrl()
{
}
/**
* {@inheritDoc}
*/
protected function getApiUrl()
{
}
/**
* {@inheritDoc}
*/
public function getSource($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getDist($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getComposerInformation($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getTags()
{
}
/**
* {@inheritDoc}
*/
public function getBranches()
{
}
/**
* {@inheritDoc}
*/
public static function supports(\Composer\IO\IOInterface $io, \Composer\Config $config, $url, $deep = false)
{
}
/**
* Generate an SSH URL
*
* @return string
*/
protected function generateSshUrl()
{
}
/**
* {@inheritDoc}
*/
protected function getContents($url, $fetchingRepoData = false)
{
}
/**
* Extract ratelimit from response.
*
* @param array $headers Headers from Composer\Downloader\TransportException.
*
* @return array Associative array with the keys limit and reset.
*/
protected function getRateLimit(array $headers)
{
}
/**
* Fetch root identifier from GitHub
*
* @throws TransportException
*/
protected function fetchRootIdentifier()
{
}
protected function attemptCloneFallback()
{
}
protected function setupGitDriver($url)
{
}
protected function getNextPage()
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class GitDriver extends \Composer\Repository\Vcs\VcsDriver
{
protected $cache;
protected $tags;
protected $branches;
protected $rootIdentifier;
protected $repoDir;
protected $infoCache = array();
/**
* {@inheritDoc}
*/
public function initialize()
{
}
/**
* {@inheritDoc}
*/
public function getRootIdentifier()
{
}
/**
* {@inheritDoc}
*/
public function getUrl()
{
}
/**
* {@inheritDoc}
*/
public function getSource($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getDist($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getComposerInformation($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getTags()
{
}
/**
* {@inheritDoc}
*/
public function getBranches()
{
}
/**
* {@inheritDoc}
*/
public static function supports(\Composer\IO\IOInterface $io, \Composer\Config $config, $url, $deep = false)
{
}
}
/**
* @author Per Bernhardt <plb@webfactory.de>
*/
class HgDriver extends \Composer\Repository\Vcs\VcsDriver
{
protected $tags;
protected $branches;
protected $rootIdentifier;
protected $repoDir;
protected $infoCache = array();
/**
* {@inheritDoc}
*/
public function initialize()
{
}
/**
* {@inheritDoc}
*/
public function getRootIdentifier()
{
}
/**
* {@inheritDoc}
*/
public function getUrl()
{
}
/**
* {@inheritDoc}
*/
public function getSource($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getDist($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getComposerInformation($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getTags()
{
}
/**
* {@inheritDoc}
*/
public function getBranches()
{
}
/**
* {@inheritDoc}
*/
public static function supports(\Composer\IO\IOInterface $io, \Composer\Config $config, $url, $deep = false)
{
}
}
/**
* @author Matt Whittom <Matt.Whittom@veteransunited.com>
*/
class PerforceDriver extends \Composer\Repository\Vcs\VcsDriver
{
protected $depot;
protected $branch;
protected $perforce;
protected $composerInfo;
protected $composerInfoIdentifier;
/**
* {@inheritDoc}
*/
public function initialize()
{
}
/**
* {@inheritDoc}
*/
public function getComposerInformation($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getRootIdentifier()
{
}
/**
* {@inheritDoc}
*/
public function getBranches()
{
}
/**
* {@inheritDoc}
*/
public function getTags()
{
}
/**
* {@inheritDoc}
*/
public function getDist($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getSource($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getUrl()
{
}
/**
* {@inheritDoc}
*/
public function hasComposerFile($identifier)
{
}
/**
* {@inheritDoc}
*/
public function getContents($url)
{
}
/**
* {@inheritDoc}
*/
public static function supports(\Composer\IO\IOInterface $io, \Composer\Config $config, $url, $deep = false)
{
}
/**
* {@inheritDoc}
*/
public function cleanup()
{
}
public function getDepot()
{
}
public function getBranch()
{
}
}
}
namespace Composer\Repository {
/**
* Composite repository.
*
* @author Beau Simensen <beau@dflydev.com>
*/
class CompositeRepository extends \Composer\Repository\BaseRepository
{
/**
* Constructor
* @param array $repositories
*/
public function __construct(array $repositories)
{
}
/**
* Returns all the wrapped repositories
*
* @return array
*/
public function getRepositories()
{
}
/**
* {@inheritdoc}
*/
public function hasPackage(\Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritdoc}
*/
public function findPackage($name, $constraint)
{
}
/**
* {@inheritdoc}
*/
public function findPackages($name, $constraint = null)
{
}
/**
* {@inheritdoc}
*/
public function search($query, $mode = 0)
{
}
/**
* {@inheritdoc}
*/
public function getPackages()
{
}
/**
* {@inheritdoc}
*/
public function removePackage(\Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritdoc}
*/
public function count()
{
}
/**
* Add a repository.
* @param RepositoryInterface $repository
*/
public function addRepository(\Composer\Repository\RepositoryInterface $repository)
{
}
}
/**
* Exception thrown when a package repository is utterly broken
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class InvalidRepositoryException extends \Exception
{
}
/**
* This repository allows installing local packages that are not necessarily under their own VCS.
*
* The local packages will be symlinked when possible, else they will be copied.
*
* @code
* "require": {
* "<vendor>/<local-package>": "*"
* },
* "repositories": [
* {
* "type": "path",
* "url": "../../relative/path/to/package/"
* },
* {
* "type": "path",
* "url": "/absolute/path/to/package/"
* },
* {
* "type": "path",
* "url": "/absolute/path/to/several/packages/*"
* },
* {
* "type": "path",
* "url": "../../relative/path/to/package/",
* "options": {
* "symlink": false
* }
* },
* ]
* @endcode
*
* @author Samuel Roze <samuel.roze@gmail.com>
* @author Johann Reinke <johann.reinke@gmail.com>
*/
class PathRepository extends \Composer\Repository\ArrayRepository implements \Composer\Repository\ConfigurableRepositoryInterface
{
/**
* Initializes path repository.
*
* @param array $repoConfig
* @param IOInterface $io
* @param Config $config
*/
public function __construct(array $repoConfig, \Composer\IO\IOInterface $io, \Composer\Config $config)
{
}
public function getRepoConfig()
{
}
/**
* Initializes path repository.
*
* This method will basically read the folder and add the found package.
*/
protected function initialize()
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class VcsRepository extends \Composer\Repository\ArrayRepository implements \Composer\Repository\ConfigurableRepositoryInterface
{
protected $url;
protected $packageName;
protected $verbose;
protected $io;
protected $config;
protected $versionParser;
protected $type;
protected $loader;
protected $repoConfig;
protected $branchErrorOccurred = false;
public function __construct(array $repoConfig, \Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $dispatcher = null, array $drivers = null)
{
}
public function getRepoConfig()
{
}
public function setLoader(\Composer\Package\Loader\LoaderInterface $loader)
{
}
public function getDriver()
{
}
public function hadInvalidBranches()
{
}
protected function initialize()
{
}
protected function preProcess(\Composer\Repository\Vcs\VcsDriverInterface $driver, array $data, $identifier)
{
}
}
/**
* @author Serge Smertin <serg.smertin@gmail.com>
*/
class ArtifactRepository extends \Composer\Repository\ArrayRepository implements \Composer\Repository\ConfigurableRepositoryInterface
{
/** @var LoaderInterface */
protected $loader;
protected $lookup;
protected $repoConfig;
public function __construct(array $repoConfig, \Composer\IO\IOInterface $io)
{
}
public function getRepoConfig()
{
}
protected function initialize()
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ComposerRepository extends \Composer\Repository\ArrayRepository implements \Composer\Repository\ConfigurableRepositoryInterface
{
protected $config;
protected $repoConfig;
protected $options;
protected $url;
protected $baseUrl;
protected $io;
protected $rfs;
protected $cache;
protected $notifyUrl;
protected $searchUrl;
protected $hasProviders = false;
protected $providersUrl;
protected $lazyProvidersUrl;
protected $providerListing;
protected $providers = array();
protected $providersByUid = array();
protected $loader;
protected $rootAliases;
protected $allowSslDowngrade = false;
protected $eventDispatcher;
protected $sourceMirrors;
protected $distMirrors;
public function __construct(array $repoConfig, \Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $eventDispatcher = null, \Composer\Util\RemoteFilesystem $rfs = null)
{
}
public function getRepoConfig()
{
}
public function setRootAliases(array $rootAliases)
{
}
/**
* {@inheritDoc}
*/
public function findPackage($name, $constraint)
{
}
/**
* {@inheritDoc}
*/
public function findPackages($name, $constraint = null)
{
}
public function getPackages()
{
}
/**
* {@inheritDoc}
*/
public function search($query, $mode = 0)
{
}
public function getProviderNames()
{
}
protected function configurePackageTransportOptions(\Composer\Package\PackageInterface $package)
{
}
public function hasProviders()
{
}
public function resetPackageIds()
{
}
/**
* @param Pool $pool
* @param string $name package name
* @param bool $bypassFilters If set to true, this bypasses the stability filtering, and forces a recompute without cache
* @return array|mixed
*/
public function whatProvides(\Composer\DependencyResolver\Pool $pool, $name, $bypassFilters = false)
{
}
/**
* {@inheritDoc}
*/
protected function initialize()
{
}
/**
* Adds a new package to the repository
*
* @param PackageInterface $package
*/
public function addPackage(\Composer\Package\PackageInterface $package)
{
}
protected function loadRootServerFile()
{
}
protected function canonicalizeUrl($url)
{
}
protected function loadDataFromServer()
{
}
protected function loadProviderListings($data)
{
}
protected function loadIncludes($data)
{
}
protected function createPackage(array $data, $class = 'Composer\\Package\\CompletePackage')
{
}
protected function fetchFile($filename, $cacheKey = null, $sha256 = null, $storeLastModifiedTime = false)
{
}
protected function fetchFileIfLastModified($filename, $cacheKey, $lastModifiedTime)
{
}
}
}
namespace Composer {
/**
* The Compiler class compiles composer into a phar
*
* @author Fabien Potencier <fabien@symfony.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class Compiler
{
/**
* Compiles composer into a single phar file
*
* @param string $pharFile The full path to the file to create
* @throws \RuntimeException
*/
public function compile($pharFile = 'composer.phar')
{
}
}
}
namespace Composer\Util {
/**
* Composer mirror utilities
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ComposerMirror
{
public static function processUrl($mirrorUrl, $packageName, $version, $reference, $type)
{
}
public static function processGitUrl($mirrorUrl, $packageName, $url, $type)
{
}
public static function processHgUrl($mirrorUrl, $packageName, $url, $type)
{
}
}
/**
* Allows the creation of a basic context supporting http proxy
*
* @author Jordan Alliot <jordan.alliot@gmail.com>
* @author Markus Tacker <m@coderbyheart.de>
*/
final class StreamContextFactory
{
/**
* Creates a context supporting HTTP proxies
*
* @param string $url URL the context is to be used for
* @param array $defaultOptions Options to merge with the default
* @param array $defaultParams Parameters to specify on the context
* @throws \RuntimeException if https proxy required and OpenSSL uninstalled
* @return resource Default context
*/
public static function getContext($url, array $defaultOptions = array(), array $defaultParams = array())
{
}
}
/**
* @author Chris Smith <chris@cs278.org>
*/
final class TlsHelper
{
/**
* Match hostname against a certificate.
*
* @param mixed $certificate X.509 certificate
* @param string $hostname Hostname in the URL
* @param string $cn Set to the common name of the certificate iff match found
*
* @return bool
*/
public static function checkCertificateHost($certificate, $hostname, &$cn = null)
{
}
/**
* Extract DNS names out of an X.509 certificate.
*
* @param mixed $certificate X.509 certificate
*
* @return array|null
*/
public static function getCertificateNames($certificate)
{
}
/**
* Get the certificate pin.
*
* By Kevin McArthur of StormTide Digital Studios Inc.
* @KevinSMcArthur / https://github.com/StormTide
*
* See http://tools.ietf.org/html/draft-ietf-websec-key-pinning-02
*
* This method was adapted from Sslurp.
* https://github.com/EvanDotPro/Sslurp
*
* (c) Evan Coury <me@evancoury.com>
*
* For the full copyright and license information, please see below:
*
* Copyright (c) 2013, Evan Coury
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without modification,
* are permitted provided that the following conditions are met:
*
* * Redistributions of source code must retain the above copyright notice,
* this list of conditions and the following disclaimer.
*
* * Redistributions in binary form must reproduce the above copyright notice,
* this list of conditions and the following disclaimer in the documentation
* and/or other materials provided with the distribution.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
* ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
* WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
* DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR
* ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
* (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
* LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
* ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
* (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/
public static function getCertificateFingerprint($certificate)
{
}
/**
* Test if it is safe to use the PHP function openssl_x509_parse().
*
* This checks if OpenSSL extensions is vulnerable to remote code execution
* via the exploit documented as CVE-2013-6420.
*
* @return bool
*/
public static function isOpensslParseSafe()
{
}
}
/**
* Tests URLs against no_proxy patterns.
*/
class NoProxyPattern
{
/**
* @var string[]
*/
protected $rules = array();
/**
* @param string $pattern no_proxy pattern
*/
public function __construct($pattern)
{
}
/**
* Test a URL against the stored pattern.
*
* @param string $url
*
* @return true if the URL matches one of the rules.
*/
public function test($url)
{
}
}
/**
* @author François Pluchino <francois.pluchino@opendisplay.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Nils Adermann <naderman@naderman.de>
*/
class RemoteFilesystem
{
/**
* Constructor.
*
* @param IOInterface $io The IO instance
* @param Config $config The config
* @param array $options The options
* @param bool $disableTls
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config = null, array $options = array(), $disableTls = false)
{
}
/**
* Copy the remote file in local.
*
* @param string $originUrl The origin URL
* @param string $fileUrl The file URL
* @param string $fileName the local filename
* @param bool $progress Display the progression
* @param array $options Additional context options
*
* @return bool true
*/
public function copy($originUrl, $fileUrl, $fileName, $progress = true, $options = array())
{
}
/**
* Get the content.
*
* @param string $originUrl The origin URL
* @param string $fileUrl The file URL
* @param bool $progress Display the progression
* @param array $options Additional context options
*
* @return bool|string The content
*/
public function getContents($originUrl, $fileUrl, $progress = true, $options = array())
{
}
/**
* Retrieve the options set in the constructor
*
* @return array Options
*/
public function getOptions()
{
}
/**
* Merges new options
*
* @return array $options
*/
public function setOptions(array $options)
{
}
public function isTlsDisabled()
{
}
/**
* Returns the headers of the last request
*
* @return array
*/
public function getLastHeaders()
{
}
/**
* @param array $headers array of returned headers like from getLastHeaders()
* @param string $name header name (case insensitive)
* @return string|null
*/
public function findHeaderValue(array $headers, $name)
{
}
/**
* @param array $headers array of returned headers like from getLastHeaders()
* @return int|null
*/
public function findStatusCode(array $headers)
{
}
/**
* Get file content or copy action.
*
* @param string $originUrl The origin URL
* @param string $fileUrl The file URL
* @param array $additionalOptions context options
* @param string $fileName the local filename
* @param bool $progress Display the progression
*
* @throws TransportException|\Exception
* @throws TransportException When the file could not be downloaded
*
* @return bool|string
*/
protected function get($originUrl, $fileUrl, $additionalOptions = array(), $fileName = null, $progress = true)
{
}
/**
* Get notification action.
*
* @param int $notificationCode The notification code
* @param int $severity The severity level
* @param string $message The message
* @param int $messageCode The message code
* @param int $bytesTransferred The loaded size
* @param int $bytesMax The total size
* @throws TransportException
*/
protected function callbackGet($notificationCode, $severity, $message, $messageCode, $bytesTransferred, $bytesMax)
{
}
protected function promptAuthAndRetry($httpStatus, $reason = null)
{
}
protected function getOptionsForUrl($originUrl, $additionalOptions)
{
}
}
/**
* Temporarily suppress PHP error reporting, usually warnings and below.
*
* @author Niels Keurentjes <niels.keurentjes@omines.com>
*/
class Silencer
{
/**
* Suppresses given mask or errors.
*
* @param int|null $mask Error levels to suppress, default value NULL indicates all warnings and below.
* @return int The old error reporting level.
*/
public static function suppress($mask = null)
{
}
/**
* Restores a single state.
*/
public static function restore()
{
}
/**
* Calls a specified function while silencing warnings and below.
*
* Future improvement: when PHP requirements are raised add Callable type hint (5.4) and variadic parameters (5.6)
*
* @param callable $callable Function to execute.
* @throws \Exception Any exceptions from the callback are rethrown.
* @return mixed Return value of the callback.
*/
public static function call($callable)
{
}
}
/**
* @author Roshan Gautam <roshan.gautam@hotmail.com>
*/
class GitLab
{
protected $io;
protected $config;
protected $process;
protected $remoteFilesystem;
/**
* Constructor.
*
* @param IOInterface $io The IO instance
* @param Config $config The composer configuration
* @param ProcessExecutor $process Process instance, injectable for mocking
* @param RemoteFilesystem $remoteFilesystem Remote Filesystem, injectable for mocking
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\Util\ProcessExecutor $process = null, \Composer\Util\RemoteFilesystem $remoteFilesystem = null)
{
}
/**
* Attempts to authorize a GitLab domain via OAuth.
*
* @param string $originUrl The host this GitLab instance is located at
*
* @return bool true on success
*/
public function authorizeOAuth($originUrl)
{
}
/**
* Authorizes a GitLab domain interactively via OAuth.
*
* @param string $scheme Scheme used in the origin URL
* @param string $originUrl The host this GitLab instance is located at
* @param string $message The reason this authorization is required
*
* @throws \RuntimeException
* @throws TransportException|\Exception
*
* @return bool true on success
*/
public function authorizeOAuthInteractively($scheme, $originUrl, $message = null)
{
}
}
/**
* Convert PHP errors into exceptions
*
* @author Artem Lopata <biozshock@gmail.com>
*/
class ErrorHandler
{
/**
* Error handler
*
* @param int $level Level of the error raised
* @param string $message Error message
* @param string $file Filename that the error was raised in
* @param int $line Line number the error was raised at
*
* @static
* @throws \ErrorException
*/
public static function handle($level, $message, $file, $line)
{
}
/**
* Register error handler.
*
* @param IOInterface|null $io
*/
public static function register(\Composer\IO\IOInterface $io = null)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class Filesystem
{
public function __construct(\Composer\Util\ProcessExecutor $executor = null)
{
}
public function remove($file)
{
}
/**
* Checks if a directory is empty
*
* @param string $dir
* @return bool
*/
public function isDirEmpty($dir)
{
}
public function emptyDirectory($dir, $ensureDirectoryExists = true)
{
}
/**
* Recursively remove a directory
*
* Uses the process component if proc_open is enabled on the PHP
* installation.
*
* @param string $directory
* @throws \RuntimeException
* @return bool
*/
public function removeDirectory($directory)
{
}
/**
* Recursively delete directory using PHP iterators.
*
* Uses a CHILD_FIRST RecursiveIteratorIterator to sort files
* before directories, creating a single non-recursive loop
* to delete files/directories in the correct order.
*
* @param string $directory
* @return bool
*/
public function removeDirectoryPhp($directory)
{
}
public function ensureDirectoryExists($directory)
{
}
/**
* Attempts to unlink a file and in case of failure retries after 350ms on windows
*
* @param string $path
* @throws \RuntimeException
* @return bool
*/
public function unlink($path)
{
}
/**
* Attempts to rmdir a file and in case of failure retries after 350ms on windows
*
* @param string $path
* @throws \RuntimeException
* @return bool
*/
public function rmdir($path)
{
}
/**
* Copy then delete is a non-atomic version of {@link rename}.
*
* Some systems can't rename and also don't have proc_open,
* which requires this solution.
*
* @param string $source
* @param string $target
*/
public function copyThenRemove($source, $target)
{
}
public function rename($source, $target)
{
}
/**
* Returns the shortest path from $from to $to
*
* @param string $from
* @param string $to
* @param bool $directories if true, the source/target are considered to be directories
* @throws \InvalidArgumentException
* @return string
*/
public function findShortestPath($from, $to, $directories = false)
{
}
/**
* Returns PHP code that, when executed in $from, will return the path to $to
*
* @param string $from
* @param string $to
* @param bool $directories if true, the source/target are considered to be directories
* @throws \InvalidArgumentException
* @return string
*/
public function findShortestPathCode($from, $to, $directories = false)
{
}
/**
* Checks if the given path is absolute
*
* @param string $path
* @return bool
*/
public function isAbsolutePath($path)
{
}
/**
* Returns size of a file or directory specified by path. If a directory is
* given, it's size will be computed recursively.
*
* @param string $path Path to the file or directory
* @throws \RuntimeException
* @return int
*/
public function size($path)
{
}
/**
* Normalize a path. This replaces backslashes with slashes, removes ending
* slash and collapses redundant separators and up-level references.
*
* @param string $path Path to the file or directory
* @return string
*/
public function normalizePath($path)
{
}
/**
* Return if the given path is local
*
* @param string $path
* @return bool
*/
public static function isLocalPath($path)
{
}
public static function getPlatformPath($path)
{
}
protected function directorySize($directory)
{
}
protected function getProcess()
{
}
/**
* Creates a relative symlink from $link to $target
*
* @param string $target The path of the binary file to be symlinked
* @param string $link The path where the symlink should be created
* @return bool
*/
public function relativeSymlink($target, $link)
{
}
/**
* return true if that directory is a symlink.
*
* @param string $directory
*
* @return bool
*/
public function isSymlinkedDirectory($directory)
{
}
/**
* Creates an NTFS junction.
*
* @param string $target
* @param string $junction
*/
public function junction($target, $junction)
{
}
/**
* Returns whether the target directory is a Windows NTFS Junction.
*
* @param string $junction Path to check.
* @return bool
*/
public function isJunction($junction)
{
}
/**
* Removes a Windows NTFS junction.
*
* @param string $junction
* @return bool
*/
public function removeJunction($junction)
{
}
}
}
namespace Composer\Spdx {
class SpdxLicenses
{
/** @var string */
const LICENSES_FILE = 'spdx-licenses.json';
/** @var string */
const EXCEPTIONS_FILE = 'spdx-exceptions.json';
public function __construct()
{
}
/**
* Returns license metadata by license identifier.
*
* This function adds a link to the full license text to the license metadata.
* The array returned is in the form of:
*
* [ 0 => full name (string), 1 => osi certified, 2 => link to license text (string) ]
*
* @param string $identifier
*
* @return array|null
*/
public function getLicenseByIdentifier($identifier)
{
}
/**
* Returns license exception metadata by license exception identifier.
*
* This function adds a link to the full license exception text to the license exception metadata.
* The array returned is in the form of:
*
* [ 0 => full name (string), 1 => link to license text (string) ]
*
* @param string $identifier
*
* @return array|null
*/
public function getExceptionByIdentifier($identifier)
{
}
/**
* Returns the short identifier of a license (or license exception) by full name.
*
* @param string $name
*
* @return string|null
*/
public function getIdentifierByName($name)
{
}
/**
* Returns the OSI Approved status for a license by identifier.
*
* @param string $identifier
*
* @return bool
*/
public function isOsiApprovedByIdentifier($identifier)
{
}
/**
* @param array|string $license
*
* @throws \InvalidArgumentException
*
* @return bool
*/
public function validate($license)
{
}
/**
* @return string
*/
public static function getResourcesDir()
{
}
}
}
namespace Composer\Util {
/**
* @deprecated use Composer\Spdx\SpdxLicenses instead
*/
class SpdxLicense extends \Composer\Spdx\SpdxLicenses
{
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class Git
{
/** @var IOInterface */
protected $io;
/** @var Config */
protected $config;
/** @var ProcessExecutor */
protected $process;
/** @var Filesystem */
protected $filesystem;
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\Util\ProcessExecutor $process, \Composer\Util\Filesystem $fs)
{
}
public function runCommand($commandCallable, $url, $cwd, $initialClone = false)
{
}
public static function cleanEnv()
{
}
public static function getGitHubDomainsRegex(\Composer\Config $config)
{
}
public static function sanitizeUrl($message)
{
}
}
/**
* Platform helper for uniform platform-specific tests.
*
* @author Niels Keurentjes <niels.keurentjes@omines.com>
*/
class Platform
{
/**
* @return bool Whether the host machine is running a Windows OS
*/
public static function isWindows()
{
}
/**
* @param string $str
* @return int return a guaranteed binary length of the string, regardless of silly mbstring configs
*/
public static function strlen($str)
{
}
}
/**
* @author Paul Wenke <wenke.paul@gmail.com>
*/
class Bitbucket
{
/**
* Constructor.
*
* @param IOInterface $io The IO instance
* @param Config $config The composer configuration
* @param ProcessExecutor $process Process instance, injectable for mocking
* @param RemoteFilesystem $remoteFilesystem Remote Filesystem, injectable for mocking
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\Util\ProcessExecutor $process = null, \Composer\Util\RemoteFilesystem $remoteFilesystem = null)
{
}
/**
* @return array
*/
public function getToken()
{
}
/**
* Attempts to authorize a Bitbucket domain via OAuth
*
* @param string $originUrl The host this Bitbucket instance is located at
* @return bool true on success
*/
public function authorizeOAuth($originUrl)
{
}
/**
* Authorizes a Bitbucket domain interactively via OAuth
*
* @param string $originUrl The host this Bitbucket instance is located at
* @param string $message The reason this authorization is required
* @throws \RuntimeException
* @throws TransportException|\Exception
* @return bool true on success
*/
public function authorizeOAuthInteractively($originUrl, $message = null)
{
}
/**
* Retrieves an access token from Bitbucket.
*
* @param string $originUrl
* @param string $consumerKey
* @param string $consumerSecret
* @return array
*/
public function requestToken($originUrl, $consumerKey, $consumerSecret)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class AuthHelper
{
protected $io;
protected $config;
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config)
{
}
public function storeAuth($originUrl, $storeAuth)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class GitHub
{
protected $io;
protected $config;
protected $process;
protected $remoteFilesystem;
/**
* Constructor.
*
* @param IOInterface $io The IO instance
* @param Config $config The composer configuration
* @param ProcessExecutor $process Process instance, injectable for mocking
* @param RemoteFilesystem $remoteFilesystem Remote Filesystem, injectable for mocking
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\Util\ProcessExecutor $process = null, \Composer\Util\RemoteFilesystem $remoteFilesystem = null)
{
}
/**
* Attempts to authorize a GitHub domain via OAuth
*
* @param string $originUrl The host this GitHub instance is located at
* @return bool true on success
*/
public function authorizeOAuth($originUrl)
{
}
/**
* Authorizes a GitHub domain interactively via OAuth
*
* @param string $originUrl The host this GitHub instance is located at
* @param string $message The reason this authorization is required
* @throws \RuntimeException
* @throws TransportException|\Exception
* @return bool true on success
*/
public function authorizeOAuthInteractively($originUrl, $message = null)
{
}
}
/**
* @author Robert Schönthal <seroscho@googlemail.com>
*/
class ProcessExecutor
{
protected static $timeout = 300;
protected $captureOutput;
protected $errorOutput;
protected $io;
public function __construct(\Composer\IO\IOInterface $io = null)
{
}
/**
* runs a process on the commandline
*
* @param string $command the command to execute
* @param mixed $output the output will be written into this var if passed by ref
* if a callable is passed it will be used as output handler
* @param string $cwd the working directory
* @return int statuscode
*/
public function execute($command, &$output = null, $cwd = null)
{
}
public function splitLines($output)
{
}
/**
* Get any error output from the last command
*
* @return string
*/
public function getErrorOutput()
{
}
public function outputHandler($type, $buffer)
{
}
public static function getTimeout()
{
}
public static function setTimeout($timeout)
{
}
/**
* Escapes a string to be used as a shell argument.
*
* @param string $argument The argument that will be escaped
*
* @return string The escaped argument
*/
public static function escape($argument)
{
}
}
/**
* @author Till Klampaeckel <till@php.net>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class Svn
{
const MAX_QTY_AUTH_TRIES = 5;
/**
* @var array
*/
protected $credentials;
/**
* @var bool
*/
protected $hasAuth;
/**
* @var \Composer\IO\IOInterface
*/
protected $io;
/**
* @var string
*/
protected $url;
/**
* @var bool
*/
protected $cacheCredentials = true;
/**
* @var ProcessExecutor
*/
protected $process;
/**
* @var int
*/
protected $qtyAuthTries = 0;
/**
* @var \Composer\Config
*/
protected $config;
/**
* @param string $url
* @param \Composer\IO\IOInterface $io
* @param Config $config
* @param ProcessExecutor $process
*/
public function __construct($url, \Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\Util\ProcessExecutor $process = null)
{
}
public static function cleanEnv()
{
}
/**
* Execute an SVN command and try to fix up the process with credentials
* if necessary.
*
* @param string $command SVN command to run
* @param string $url SVN url
* @param string $cwd Working directory
* @param string $path Target for a checkout
* @param bool $verbose Output all output to the user
*
* @throws \RuntimeException
* @return string
*/
public function execute($command, $url, $cwd = null, $path = null, $verbose = false)
{
}
/**
* @param bool $cacheCredentials
*/
public function setCacheCredentials($cacheCredentials)
{
}
/**
* Repositories requests credentials, let's put them in.
*
* @throws \RuntimeException
* @return \Composer\Util\Svn
*/
protected function doAuthDance()
{
}
/**
* A method to create the svn commands run.
*
* @param string $cmd Usually 'svn ls' or something like that.
* @param string $url Repo URL.
* @param string $path Target for a checkout
*
* @return string
*/
protected function getCommand($cmd, $url, $path = null)
{
}
/**
* Return the credential string for the svn command.
*
* Adds --no-auth-cache when credentials are present.
*
* @return string
*/
protected function getCredentialString()
{
}
/**
* Get the password for the svn command. Can be empty.
*
* @throws \LogicException
* @return string
*/
protected function getPassword()
{
}
/**
* Get the username for the svn command.
*
* @throws \LogicException
* @return string
*/
protected function getUsername()
{
}
/**
* Detect Svn Auth.
*
* @return bool
*/
protected function hasAuth()
{
}
/**
* Return the no-auth-cache switch.
*
* @return string
*/
protected function getAuthCache()
{
}
}
/**
* Validates a composer configuration.
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ConfigValidator
{
public function __construct(\Composer\IO\IOInterface $io)
{
}
/**
* Validates the config, and returns the result.
*
* @param string $file The path to the file
* @param int $arrayLoaderValidationFlags Flags for ArrayLoader validation
*
* @return array a triple containing the errors, publishable errors, and warnings
*/
public function validate($file, $arrayLoaderValidationFlags = \Composer\Package\Loader\ValidatingArrayLoader::CHECK_ALL)
{
}
}
/**
* @author Matt Whittom <Matt.Whittom@veteransunited.com>
*/
class Perforce
{
protected $path;
protected $p4Depot;
protected $p4Client;
protected $p4User;
protected $p4Password;
protected $p4Port;
protected $p4Stream;
protected $p4ClientSpec;
protected $p4DepotType;
protected $p4Branch;
protected $process;
protected $uniquePerforceClientName;
protected $windowsFlag;
protected $commandResult;
protected $io;
protected $filesystem;
public function __construct($repoConfig, $port, $path, \Composer\Util\ProcessExecutor $process, $isWindows, \Composer\IO\IOInterface $io)
{
}
public static function create($repoConfig, $port, $path, \Composer\Util\ProcessExecutor $process, \Composer\IO\IOInterface $io)
{
}
public static function checkServerExists($url, \Composer\Util\ProcessExecutor $processExecutor)
{
}
public function initialize($repoConfig)
{
}
public function initializeDepotAndBranch($depot, $branch)
{
}
public function generateUniquePerforceClientName()
{
}
public function cleanupClientSpec()
{
}
protected function executeCommand($command)
{
}
public function getClient()
{
}
protected function getPath()
{
}
public function initializePath($path)
{
}
protected function getPort()
{
}
public function setStream($stream)
{
}
public function isStream()
{
}
public function getStream()
{
}
public function getStreamWithoutLabel($stream)
{
}
public function getP4ClientSpec()
{
}
public function getUser()
{
}
public function setUser($user)
{
}
public function queryP4User()
{
}
protected function getP4variable($name)
{
}
public function queryP4Password()
{
}
public function generateP4Command($command, $useClient = true)
{
}
public function isLoggedIn()
{
}
public function connectClient()
{
}
public function syncCodeBase($sourceReference)
{
}
public function writeClientSpecToFile($spec)
{
}
public function writeP4ClientSpec()
{
}
protected function read($pipe, $name)
{
}
public function windowsLogin($password)
{
}
public function p4Login()
{
}
public function getComposerInformation($identifier)
{
}
public function getComposerInformationFromPath($composerJson)
{
}
public function getComposerInformationFromLabel($identifier, $index)
{
}
public function getBranches()
{
}
public function getTags()
{
}
public function checkStream()
{
}
/**
* @param $reference
* @return mixed|null
*/
protected function getChangeList($reference)
{
}
/**
* @param $fromReference
* @param $toReference
* @return mixed|null
*/
public function getCommitLogs($fromReference, $toReference)
{
}
public function getFilesystem()
{
}
public function setFilesystem(\Composer\Util\Filesystem $fs)
{
}
}
}
namespace Composer {
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Beau Simensen <beau@dflydev.com>
* @author Konstantin Kudryashov <ever.zet@gmail.com>
* @author Nils Adermann <naderman@naderman.de>
*/
class Installer
{
/**
* @var IOInterface
*/
protected $io;
/**
* @var Config
*/
protected $config;
/**
* @var RootPackageInterface
*/
protected $package;
/**
* @var DownloadManager
*/
protected $downloadManager;
/**
* @var RepositoryManager
*/
protected $repositoryManager;
/**
* @var Locker
*/
protected $locker;
/**
* @var InstallationManager
*/
protected $installationManager;
/**
* @var EventDispatcher
*/
protected $eventDispatcher;
/**
* @var AutoloadGenerator
*/
protected $autoloadGenerator;
protected $preferSource = false;
protected $preferDist = false;
protected $optimizeAutoloader = false;
protected $classMapAuthoritative = false;
protected $devMode = false;
protected $dryRun = false;
protected $verbose = false;
protected $update = false;
protected $dumpAutoloader = true;
protected $runScripts = true;
protected $ignorePlatformReqs = false;
protected $preferStable = false;
protected $preferLowest = false;
/**
* Array of package names/globs flagged for update
*
* @var array|null
*/
protected $updateWhitelist = null;
protected $whitelistDependencies = false;
/**
* @var SuggestedPackagesReporter
*/
protected $suggestedPackagesReporter;
/**
* @var RepositoryInterface
*/
protected $additionalInstalledRepository;
/**
* Constructor
*
* @param IOInterface $io
* @param Config $config
* @param RootPackageInterface $package
* @param DownloadManager $downloadManager
* @param RepositoryManager $repositoryManager
* @param Locker $locker
* @param InstallationManager $installationManager
* @param EventDispatcher $eventDispatcher
* @param AutoloadGenerator $autoloadGenerator
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\Package\RootPackageInterface $package, \Composer\Downloader\DownloadManager $downloadManager, \Composer\Repository\RepositoryManager $repositoryManager, \Composer\Package\Locker $locker, \Composer\Installer\InstallationManager $installationManager, \Composer\EventDispatcher\EventDispatcher $eventDispatcher, \Composer\Autoload\AutoloadGenerator $autoloadGenerator)
{
}
/**
* Run installation (or update)
*
* @throws \Exception
* @return int 0 on success or a positive error code on failure
*/
public function run()
{
}
/**
* @param RepositoryInterface $localRepo
* @param RepositoryInterface $installedRepo
* @param PlatformRepository $platformRepo
* @param array $aliases
* @param bool $withDevReqs
* @return int
*/
protected function doInstall($localRepo, $installedRepo, $platformRepo, $aliases, $withDevReqs)
{
}
/**
* Create Installer
*
* @param IOInterface $io
* @param Composer $composer
* @return Installer
*/
public static function create(\Composer\IO\IOInterface $io, \Composer\Composer $composer)
{
}
/**
* @param RepositoryInterface $additionalInstalledRepository
* @return $this
*/
public function setAdditionalInstalledRepository(\Composer\Repository\RepositoryInterface $additionalInstalledRepository)
{
}
/**
* Whether to run in drymode or not
*
* @param bool $dryRun
* @return Installer
*/
public function setDryRun($dryRun = true)
{
}
/**
* Checks, if this is a dry run (simulation mode).
*
* @return bool
*/
public function isDryRun()
{
}
/**
* prefer source installation
*
* @param bool $preferSource
* @return Installer
*/
public function setPreferSource($preferSource = true)
{
}
/**
* prefer dist installation
*
* @param bool $preferDist
* @return Installer
*/
public function setPreferDist($preferDist = true)
{
}
/**
* Whether or not generated autoloader are optimized
*
* @param bool $optimizeAutoloader
* @return Installer
*/
public function setOptimizeAutoloader($optimizeAutoloader = false)
{
}
/**
* Whether or not generated autoloader considers the class map
* authoritative.
*
* @param bool $classMapAuthoritative
* @return Installer
*/
public function setClassMapAuthoritative($classMapAuthoritative = false)
{
}
/**
* update packages
*
* @param bool $update
* @return Installer
*/
public function setUpdate($update = true)
{
}
/**
* enables dev packages
*
* @param bool $devMode
* @return Installer
*/
public function setDevMode($devMode = true)
{
}
/**
* set whether to run autoloader or not
*
* @param bool $dumpAutoloader
* @return Installer
*/
public function setDumpAutoloader($dumpAutoloader = true)
{
}
/**
* set whether to run scripts or not
*
* @param bool $runScripts
* @return Installer
*/
public function setRunScripts($runScripts = true)
{
}
/**
* set the config instance
*
* @param Config $config
* @return Installer
*/
public function setConfig(\Composer\Config $config)
{
}
/**
* run in verbose mode
*
* @param bool $verbose
* @return Installer
*/
public function setVerbose($verbose = true)
{
}
/**
* Checks, if running in verbose mode.
*
* @return bool
*/
public function isVerbose()
{
}
/**
* set ignore Platform Package requirements
*
* @param bool $ignorePlatformReqs
* @return Installer
*/
public function setIgnorePlatformRequirements($ignorePlatformReqs = false)
{
}
/**
* restrict the update operation to a few packages, all other packages
* that are already installed will be kept at their current version
*
* @param array $packages
* @return Installer
*/
public function setUpdateWhitelist(array $packages)
{
}
/**
* Should dependencies of whitelisted packages be updated recursively?
*
* @param bool $updateDependencies
* @return Installer
*/
public function setWhitelistDependencies($updateDependencies = true)
{
}
/**
* Should packages be preferred in a stable version when updating?
*
* @param bool $preferStable
* @return Installer
*/
public function setPreferStable($preferStable = true)
{
}
/**
* Should packages be preferred in a lowest version when updating?
*
* @param bool $preferLowest
* @return Installer
*/
public function setPreferLowest($preferLowest = true)
{
}
/**
* Disables plugins.
*
* Call this if you want to ensure that third-party code never gets
* executed. The default is to automatically install, and execute
* custom third-party installers.
*
* @return Installer
*/
public function disablePlugins()
{
}
/**
* @param SuggestedPackagesReporter $suggestedPackagesReporter
* @return Installer
*/
public function setSuggestedPackagesReporter(\Composer\Installer\SuggestedPackagesReporter $suggestedPackagesReporter)
{
}
}
}
namespace Composer\EventDispatcher {
/**
* The base event class
*
* @author Nils Adermann <naderman@naderman.de>
*/
class Event
{
/**
* @var string This event's name
*/
protected $name;
/**
* @var array Arguments passed by the user, these will be forwarded to CLI script handlers
*/
protected $args;
/**
* @var array Flags usable in PHP script handlers
*/
protected $flags;
/**
* Constructor.
*
* @param string $name The event name
* @param array $args Arguments passed by the user
* @param array $flags Optional flags to pass data not as argument
*/
public function __construct($name, array $args = array(), array $flags = array())
{
}
/**
* Returns the event's name.
*
* @return string The event name
*/
public function getName()
{
}
/**
* Returns the event's arguments.
*
* @return array The event arguments
*/
public function getArguments()
{
}
/**
* Returns the event's flags.
*
* @return array The event flags
*/
public function getFlags()
{
}
/**
* Checks if stopPropagation has been called
*
* @return bool Whether propagation has been stopped
*/
public function isPropagationStopped()
{
}
/**
* Prevents the event from being passed to further listeners
*/
public function stopPropagation()
{
}
}
}
namespace Composer\Script {
/**
* The script event class
*
* @author François Pluchino <francois.pluchino@opendisplay.com>
* @author Nils Adermann <naderman@naderman.de>
*/
class Event extends \Composer\EventDispatcher\Event
{
/**
* Constructor.
*
* @param string $name The event name
* @param Composer $composer The composer object
* @param IOInterface $io The IOInterface object
* @param bool $devMode Whether or not we are in dev mode
* @param array $args Arguments passed by the user
* @param array $flags Optional flags to pass data not as argument
*/
public function __construct($name, \Composer\Composer $composer, \Composer\IO\IOInterface $io, $devMode = false, array $args = array(), array $flags = array())
{
}
/**
* Returns the composer instance.
*
* @return Composer
*/
public function getComposer()
{
}
/**
* Returns the IO instance.
*
* @return IOInterface
*/
public function getIO()
{
}
/**
* Return the dev mode flag
*
* @return bool
*/
public function isDevMode()
{
}
}
/**
* The Command Event.
*
* @deprecated use Composer\Script\Event instead
*/
class CommandEvent extends \Composer\Script\Event
{
}
/**
* The Script Events.
*
* @author François Pluchino <francois.pluchino@opendisplay.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ScriptEvents
{
/**
* The PRE_INSTALL_CMD event occurs before the install command is executed.
*
* The event listener method receives a Composer\Script\CommandEvent instance.
*
* @var string
*/
const PRE_INSTALL_CMD = 'pre-install-cmd';
/**
* The POST_INSTALL_CMD event occurs after the install command is executed.
*
* The event listener method receives a Composer\Script\CommandEvent instance.
*
* @var string
*/
const POST_INSTALL_CMD = 'post-install-cmd';
/**
* The PRE_UPDATE_CMD event occurs before the update command is executed.
*
* The event listener method receives a Composer\Script\CommandEvent instance.
*
* @var string
*/
const PRE_UPDATE_CMD = 'pre-update-cmd';
/**
* The POST_UPDATE_CMD event occurs after the update command is executed.
*
* The event listener method receives a Composer\Script\CommandEvent instance.
*
* @var string
*/
const POST_UPDATE_CMD = 'post-update-cmd';
/**
* The PRE_STATUS_CMD event occurs before the status command is executed.
*
* The event listener method receives a Composer\Script\CommandEvent instance.
*
* @var string
*/
const PRE_STATUS_CMD = 'pre-status-cmd';
/**
* The POST_STATUS_CMD event occurs after the status command is executed.
*
* The event listener method receives a Composer\Script\CommandEvent instance.
*
* @var string
*/
const POST_STATUS_CMD = 'post-status-cmd';
/**
* The PRE_AUTOLOAD_DUMP event occurs before the autoload file is generated.
*
* The event listener method receives a Composer\Script\Event instance.
*
* @var string
*/
const PRE_AUTOLOAD_DUMP = 'pre-autoload-dump';
/**
* The POST_AUTOLOAD_DUMP event occurs after the autoload file has been generated.
*
* The event listener method receives a Composer\Script\Event instance.
*
* @var string
*/
const POST_AUTOLOAD_DUMP = 'post-autoload-dump';
/**
* The POST_ROOT_PACKAGE_INSTALL event occurs after the root package has been installed.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @var string
*/
const POST_ROOT_PACKAGE_INSTALL = 'post-root-package-install';
/**
* The POST_CREATE_PROJECT event occurs after the create-project command has been executed.
* Note: Event occurs after POST_INSTALL_CMD
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @var string
*/
const POST_CREATE_PROJECT_CMD = 'post-create-project-cmd';
/**
* The PRE_ARCHIVE_CMD event occurs before the update command is executed.
*
* The event listener method receives a Composer\Script\CommandEvent instance.
*
* @var string
*/
const PRE_ARCHIVE_CMD = 'pre-archive-cmd';
/**
* The POST_ARCHIVE_CMD event occurs after the status command is executed.
*
* The event listener method receives a Composer\Script\CommandEvent instance.
*
* @var string
*/
const POST_ARCHIVE_CMD = 'post-archive-cmd';
/** Deprecated constants below */
/**
* The PRE_PACKAGE_INSTALL event occurs before a package is installed.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @deprecated Use Composer\Installer\PackageEvents::PRE_PACKAGE_INSTALL instead.
* @var string
*/
const PRE_PACKAGE_INSTALL = 'pre-package-install';
/**
* The POST_PACKAGE_INSTALL event occurs after a package is installed.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @deprecated Use Composer\Installer\PackageEvents::POST_PACKAGE_INSTALL instead.
* @var string
*/
const POST_PACKAGE_INSTALL = 'post-package-install';
/**
* The PRE_PACKAGE_UPDATE event occurs before a package is updated.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @deprecated Use Composer\Installer\PackageEvents::PRE_PACKAGE_UPDATE instead.
* @var string
*/
const PRE_PACKAGE_UPDATE = 'pre-package-update';
/**
* The POST_PACKAGE_UPDATE event occurs after a package is updated.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @deprecated Use Composer\Installer\PackageEvents::POST_PACKAGE_UPDATE instead.
* @var string
*/
const POST_PACKAGE_UPDATE = 'post-package-update';
/**
* The PRE_PACKAGE_UNINSTALL event occurs before a package has been uninstalled.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @deprecated Use Composer\Installer\PackageEvents::PRE_PACKAGE_UNINSTALL instead.
* @var string
*/
const PRE_PACKAGE_UNINSTALL = 'pre-package-uninstall';
/**
* The POST_PACKAGE_UNINSTALL event occurs after a package has been uninstalled.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @deprecated Use Composer\Installer\PackageEvents::POST_PACKAGE_UNINSTALL instead.
* @var string
*/
const POST_PACKAGE_UNINSTALL = 'post-package-uninstall';
}
}
namespace Composer\Installer {
/**
* An event for all installer.
*
* @author François Pluchino <francois.pluchino@gmail.com>
*/
class InstallerEvent extends \Composer\EventDispatcher\Event
{
/**
* Constructor.
*
* @param string $eventName
* @param Composer $composer
* @param IOInterface $io
* @param bool $devMode
* @param PolicyInterface $policy
* @param Pool $pool
* @param CompositeRepository $installedRepo
* @param Request $request
* @param OperationInterface[] $operations
*/
public function __construct($eventName, \Composer\Composer $composer, \Composer\IO\IOInterface $io, $devMode, \Composer\DependencyResolver\PolicyInterface $policy, \Composer\DependencyResolver\Pool $pool, \Composer\Repository\CompositeRepository $installedRepo, \Composer\DependencyResolver\Request $request, array $operations = array())
{
}
/**
* @return Composer
*/
public function getComposer()
{
}
/**
* @return IOInterface
*/
public function getIO()
{
}
/**
* @return bool
*/
public function isDevMode()
{
}
/**
* @return PolicyInterface
*/
public function getPolicy()
{
}
/**
* @return Pool
*/
public function getPool()
{
}
/**
* @return CompositeRepository
*/
public function getInstalledRepo()
{
}
/**
* @return Request
*/
public function getRequest()
{
}
/**
* @return OperationInterface[]
*/
public function getOperations()
{
}
}
/**
* The Package Event.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class PackageEvent extends \Composer\Installer\InstallerEvent
{
/**
* Constructor.
*
* @param string $eventName
* @param Composer $composer
* @param IOInterface $io
* @param bool $devMode
* @param PolicyInterface $policy
* @param Pool $pool
* @param CompositeRepository $installedRepo
* @param Request $request
* @param OperationInterface[] $operations
* @param OperationInterface $operation
*/
public function __construct($eventName, \Composer\Composer $composer, \Composer\IO\IOInterface $io, $devMode, \Composer\DependencyResolver\PolicyInterface $policy, \Composer\DependencyResolver\Pool $pool, \Composer\Repository\CompositeRepository $installedRepo, \Composer\DependencyResolver\Request $request, array $operations, \Composer\DependencyResolver\Operation\OperationInterface $operation)
{
}
/**
* Returns the package instance.
*
* @return OperationInterface
*/
public function getOperation()
{
}
}
}
namespace Composer\Script {
/**
* The Package Event.
*
* @deprecated Use Composer\Installer\PackageEvent instead
*/
class PackageEvent extends \Composer\Installer\PackageEvent
{
}
}
namespace Composer {
/**
* Creates a configured instance of composer.
*
* @author Ryan Weaver <ryan@knplabs.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Igor Wiedler <igor@wiedler.ch>
* @author Nils Adermann <naderman@naderman.de>
*/
class Factory
{
/**
* @throws \RuntimeException
* @return string
*/
protected static function getHomeDir()
{
}
/**
* @param string $home
* @return string
*/
protected static function getCacheDir($home)
{
}
/**
* @param string $home
* @return string
*/
protected static function getDataDir($home)
{
}
/**
* @param IOInterface|null $io
* @return Config
*/
public static function createConfig(\Composer\IO\IOInterface $io = null, $cwd = null)
{
}
public static function getComposerFile()
{
}
public static function createAdditionalStyles()
{
}
/**
* @deprecated Use Composer\Repository\RepositoryFactory::defaultRepos instead
*/
public static function createDefaultRepositories(\Composer\IO\IOInterface $io = null, \Composer\Config $config = null, \Composer\Repository\RepositoryManager $rm = null)
{
}
/**
* Creates a Composer instance
*
* @param IOInterface $io IO instance
* @param array|string|null $localConfig either a configuration array or a filename to read from, if null it will
* read from the default filename
* @param bool $disablePlugins Whether plugins should not be loaded
* @param bool $fullLoad Whether to initialize everything or only main project stuff (used when loading the global composer)
* @throws \InvalidArgumentException
* @throws \UnexpectedValueException
* @return Composer
*/
public function createComposer(\Composer\IO\IOInterface $io, $localConfig = null, $disablePlugins = false, $cwd = null, $fullLoad = true)
{
}
/**
* @param Repository\RepositoryManager $rm
* @param string $vendorDir
*/
protected function addLocalRepository(\Composer\IO\IOInterface $io, \Composer\Repository\RepositoryManager $rm, $vendorDir)
{
}
/**
* @param Config $config
* @return Composer|null
*/
protected function createGlobalComposer(\Composer\IO\IOInterface $io, \Composer\Config $config, $disablePlugins)
{
}
/**
* @param IO\IOInterface $io
* @param Config $config
* @param EventDispatcher $eventDispatcher
* @return Downloader\DownloadManager
*/
public function createDownloadManager(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $eventDispatcher = null, \Composer\Util\RemoteFilesystem $rfs = null)
{
}
/**
* @param Config $config The configuration
* @param Downloader\DownloadManager $dm Manager use to download sources
* @return Archiver\ArchiveManager
*/
public function createArchiveManager(\Composer\Config $config, \Composer\Downloader\DownloadManager $dm = null)
{
}
/**
* @param IOInterface $io
* @param Composer $composer
* @param Composer $globalComposer
* @param bool $disablePlugins
* @return Plugin\PluginManager
*/
protected function createPluginManager(\Composer\IO\IOInterface $io, \Composer\Composer $composer, \Composer\Composer $globalComposer = null, $disablePlugins = false)
{
}
/**
* @return Installer\InstallationManager
*/
protected function createInstallationManager()
{
}
/**
* @param Installer\InstallationManager $im
* @param Composer $composer
* @param IO\IOInterface $io
*/
protected function createDefaultInstallers(\Composer\Installer\InstallationManager $im, \Composer\Composer $composer, \Composer\IO\IOInterface $io)
{
}
/**
* @param WritableRepositoryInterface $repo repository to purge packages from
* @param Installer\InstallationManager $im manager to check whether packages are still installed
*/
protected function purgePackages(\Composer\Repository\WritableRepositoryInterface $repo, \Composer\Installer\InstallationManager $im)
{
}
/**
* @param IOInterface $io IO instance
* @param mixed $config either a configuration array or a filename to read from, if null it will read from
* the default filename
* @param bool $disablePlugins Whether plugins should not be loaded
* @return Composer
*/
public static function create(\Composer\IO\IOInterface $io, $config = null, $disablePlugins = false)
{
}
/**
* @param IOInterface $io IO instance
* @param Config $config Config instance
* @param array $options Array of options passed directly to RemoteFilesystem constructor
* @return RemoteFilesystem
*/
public static function createRemoteFilesystem(\Composer\IO\IOInterface $io, \Composer\Config $config = null, $options = array())
{
}
}
}
namespace Composer\Console {
/**
* The console application that handles the commands
*
* @author Ryan Weaver <ryan@knplabs.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author François Pluchino <francois.pluchino@opendisplay.com>
*/
class Application extends \Symfony\Component\Console\Application
{
/**
* @var Composer
*/
protected $composer;
/**
* @var IOInterface
*/
protected $io;
public function __construct()
{
}
/**
* {@inheritDoc}
*/
public function run(\Symfony\Component\Console\Input\InputInterface $input = null, \Symfony\Component\Console\Output\OutputInterface $output = null)
{
}
/**
* {@inheritDoc}
*/
public function doRun(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* @param bool $required
* @param bool $disablePlugins
* @throws JsonValidationException
* @return \Composer\Composer
*/
public function getComposer($required = true, $disablePlugins = false)
{
}
/**
* Removes the cached composer instance
*/
public function resetComposer()
{
}
/**
* @return IOInterface
*/
public function getIO()
{
}
public function getHelp()
{
}
/**
* Initializes all the composer commands.
*/
protected function getDefaultCommands()
{
}
/**
* {@inheritDoc}
*/
public function getLongVersion()
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultInputDefinition()
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class HtmlOutputFormatter extends \Symfony\Component\Console\Formatter\OutputFormatter
{
/**
* @param array $styles Array of "name => FormatterStyle" instances
*/
public function __construct(array $styles = array())
{
}
public function format($message)
{
}
}
}
namespace Composer\Downloader {
/**
* DVCS Downloader interface.
*
* @author James Titcumb <james@asgrim.com>
*/
interface DvcsDownloaderInterface
{
/**
* Checks for unpushed changes to a current branch
*
* @param PackageInterface $package package directory
* @param string $path package directory
* @return string|null changes or null
*/
public function getUnpushedChanges(\Composer\Package\PackageInterface $package, $path);
}
/**
* Downloader interface.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
interface DownloaderInterface
{
/**
* Returns installation source (either source or dist).
*
* @return string "source" or "dist"
*/
public function getInstallationSource();
/**
* Downloads specific package into specific folder.
*
* @param PackageInterface $package package instance
* @param string $path download path
*/
public function download(\Composer\Package\PackageInterface $package, $path);
/**
* Updates specific package in specific folder from initial to target version.
*
* @param PackageInterface $initial initial package
* @param PackageInterface $target updated package
* @param string $path download path
*/
public function update(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target, $path);
/**
* Removes specific package from specific folder.
*
* @param PackageInterface $package package instance
* @param string $path download path
*/
public function remove(\Composer\Package\PackageInterface $package, $path);
/**
* Sets whether to output download progress information or not
*
* @param bool $outputProgress
* @return DownloaderInterface
*/
public function setOutputProgress($outputProgress);
}
/**
* ChangeReport interface.
*
* @author Sascha Egerer <sascha.egerer@dkd.de>
*/
interface ChangeReportInterface
{
/**
* Checks for changes to the local copy
*
* @param PackageInterface $package package instance
* @param string $path package directory
* @return string|null changes or null
*/
public function getLocalChanges(\Composer\Package\PackageInterface $package, $path);
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
abstract class VcsDownloader implements \Composer\Downloader\DownloaderInterface, \Composer\Downloader\ChangeReportInterface
{
/** @var IOInterface */
protected $io;
/** @var Config */
protected $config;
/** @var ProcessExecutor */
protected $process;
/** @var Filesystem */
protected $filesystem;
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\Util\ProcessExecutor $process = null, \Composer\Util\Filesystem $fs = null)
{
}
/**
* {@inheritDoc}
*/
public function getInstallationSource()
{
}
/**
* {@inheritDoc}
*/
public function download(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* {@inheritDoc}
*/
public function update(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target, $path)
{
}
/**
* {@inheritDoc}
*/
public function remove(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* Download progress information is not available for all VCS downloaders.
* {@inheritDoc}
*/
public function setOutputProgress($outputProgress)
{
}
/**
* Prompt the user to check if changes should be stashed/removed or the operation aborted
*
* @param PackageInterface $package
* @param string $path
* @param bool $update if true (update) the changes can be stashed and reapplied after an update,
* if false (remove) the changes should be assumed to be lost if the operation is not aborted
* @throws \RuntimeException in case the operation must be aborted
*/
protected function cleanChanges(\Composer\Package\PackageInterface $package, $path, $update)
{
}
/**
* Guarantee that no changes have been made to the local copy
*
* @param string $path
* @throws \RuntimeException in case the operation must be aborted or the patch does not apply cleanly
*/
protected function reapplyChanges($path)
{
}
/**
* Downloads specific package into specific folder.
*
* @param PackageInterface $package package instance
* @param string $path download path
* @param string $url package url
*/
protected abstract function doDownload(\Composer\Package\PackageInterface $package, $path, $url);
/**
* Updates specific package in specific folder from initial to target version.
*
* @param PackageInterface $initial initial package
* @param PackageInterface $target updated package
* @param string $path download path
* @param string $url package url
*/
protected abstract function doUpdate(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target, $path, $url);
/**
* Fetches the commit logs between two commits
*
* @param string $fromReference the source reference
* @param string $toReference the target reference
* @param string $path the package path
* @return string
*/
protected abstract function getCommitLogs($fromReference, $toReference, $path);
/**
* Checks if VCS metadata repository has been initialized
* repository example: .git|.svn|.hg
*
* @param string $path
* @return bool
*/
protected abstract function hasMetadataRepository($path);
}
/**
* @author Per Bernhardt <plb@webfactory.de>
*/
class HgDownloader extends \Composer\Downloader\VcsDownloader
{
/**
* {@inheritDoc}
*/
public function doDownload(\Composer\Package\PackageInterface $package, $path, $url)
{
}
/**
* {@inheritDoc}
*/
public function doUpdate(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target, $path, $url)
{
}
/**
* {@inheritDoc}
*/
public function getLocalChanges(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* {@inheritDoc}
*/
protected function getCommitLogs($fromReference, $toReference, $path)
{
}
/**
* {@inheritDoc}
*/
protected function hasMetadataRepository($path)
{
}
}
/**
* @author Ben Bieker <mail@ben-bieker.de>
* @author Till Klampaeckel <till@php.net>
*/
class SvnDownloader extends \Composer\Downloader\VcsDownloader
{
protected $cacheCredentials = true;
/**
* {@inheritDoc}
*/
public function doDownload(\Composer\Package\PackageInterface $package, $path, $url)
{
}
/**
* {@inheritDoc}
*/
public function doUpdate(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target, $path, $url)
{
}
/**
* {@inheritDoc}
*/
public function getLocalChanges(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* Execute an SVN command and try to fix up the process with credentials
* if necessary.
*
* @param string $baseUrl Base URL of the repository
* @param string $command SVN command to run
* @param string $url SVN url
* @param string $cwd Working directory
* @param string $path Target for a checkout
* @throws \RuntimeException
* @return string
*/
protected function execute($baseUrl, $command, $url, $cwd = null, $path = null)
{
}
/**
* {@inheritDoc}
*/
protected function cleanChanges(\Composer\Package\PackageInterface $package, $path, $update)
{
}
/**
* {@inheritDoc}
*/
protected function getCommitLogs($fromReference, $toReference, $path)
{
}
protected function discardChanges($path)
{
}
/**
* {@inheritDoc}
*/
protected function hasMetadataRepository($path)
{
}
}
/**
* Extractor for pear packages.
*
* Composer cannot rely on tar files structure when place it inside package target dir. Correct source files
* disposition must be read from package.xml
* This extract pear package source files to target dir.
*
* @author Alexey Prilipko <palex@farpost.com>
*/
class PearPackageExtractor
{
public function __construct($file)
{
}
/**
* Installs PEAR source files according to package.xml definitions and removes extracted files
*
* @param string $target target install location. all source installation would be performed relative to target path.
* @param array $roles types of files to install. default role for PEAR source files are 'php'.
* @param array $vars used for replacement tasks
* @throws \RuntimeException
* @throws \UnexpectedValueException
*/
public function extractTo($target, array $roles = array('php' => '/', 'script' => '/bin'), $vars = array())
{
}
}
/**
* Downloaders manager.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
class DownloadManager
{
/**
* Initializes download manager.
*
* @param IOInterface $io The Input Output Interface
* @param bool $preferSource prefer downloading from source
* @param Filesystem|null $filesystem custom Filesystem object
*/
public function __construct(\Composer\IO\IOInterface $io, $preferSource = false, \Composer\Util\Filesystem $filesystem = null)
{
}
/**
* Makes downloader prefer source installation over the dist.
*
* @param bool $preferSource prefer downloading from source
* @return DownloadManager
*/
public function setPreferSource($preferSource)
{
}
/**
* Makes downloader prefer dist installation over the source.
*
* @param bool $preferDist prefer downloading from dist
* @return DownloadManager
*/
public function setPreferDist($preferDist)
{
}
/**
* Sets fine tuned preference settings for package level source/dist selection.
*
* @param array $preferences array of preferences by package patterns
* @return DownloadManager
*/
public function setPreferences(array $preferences)
{
}
/**
* Sets whether to output download progress information for all registered
* downloaders
*
* @param bool $outputProgress
* @return DownloadManager
*/
public function setOutputProgress($outputProgress)
{
}
/**
* Sets installer downloader for a specific installation type.
*
* @param string $type installation type
* @param DownloaderInterface $downloader downloader instance
* @return DownloadManager
*/
public function setDownloader($type, \Composer\Downloader\DownloaderInterface $downloader)
{
}
/**
* Returns downloader for a specific installation type.
*
* @param string $type installation type
* @throws \InvalidArgumentException if downloader for provided type is not registered
* @return DownloaderInterface
*/
public function getDownloader($type)
{
}
/**
* Returns downloader for already installed package.
*
* @param PackageInterface $package package instance
* @throws \InvalidArgumentException if package has no installation source specified
* @throws \LogicException if specific downloader used to load package with
* wrong type
* @return DownloaderInterface|null
*/
public function getDownloaderForInstalledPackage(\Composer\Package\PackageInterface $package)
{
}
/**
* Downloads package into target dir.
*
* @param PackageInterface $package package instance
* @param string $targetDir target dir
* @param bool $preferSource prefer installation from source
*
* @throws \InvalidArgumentException if package have no urls to download from
* @throws \RuntimeException
*/
public function download(\Composer\Package\PackageInterface $package, $targetDir, $preferSource = null)
{
}
/**
* Updates package from initial to target version.
*
* @param PackageInterface $initial initial package version
* @param PackageInterface $target target package version
* @param string $targetDir target dir
*
* @throws \InvalidArgumentException if initial package is not installed
*/
public function update(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target, $targetDir)
{
}
/**
* Removes package from target dir.
*
* @param PackageInterface $package package instance
* @param string $targetDir target dir
*/
public function remove(\Composer\Package\PackageInterface $package, $targetDir)
{
}
/**
* Determines the install preference of a package
*
* @param PackageInterface $package package instance
*
* @return string
*/
protected function resolvePackageInstallPreference(\Composer\Package\PackageInterface $package)
{
}
}
/**
* Base downloader for files
*
* @author Kirill chEbba Chebunin <iam@chebba.org>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author François Pluchino <francois.pluchino@opendisplay.com>
* @author Nils Adermann <naderman@naderman.de>
*/
class FileDownloader implements \Composer\Downloader\DownloaderInterface
{
protected $io;
protected $config;
protected $rfs;
protected $filesystem;
protected $cache;
protected $outputProgress = true;
/**
* Constructor.
*
* @param IOInterface $io The IO instance
* @param Config $config The config
* @param EventDispatcher $eventDispatcher The event dispatcher
* @param Cache $cache Optional cache instance
* @param RemoteFilesystem $rfs The remote filesystem
* @param Filesystem $filesystem The filesystem
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $eventDispatcher = null, \Composer\Cache $cache = null, \Composer\Util\RemoteFilesystem $rfs = null, \Composer\Util\Filesystem $filesystem = null)
{
}
/**
* {@inheritDoc}
*/
public function getInstallationSource()
{
}
/**
* {@inheritDoc}
*/
public function download(\Composer\Package\PackageInterface $package, $path)
{
}
protected function doDownload(\Composer\Package\PackageInterface $package, $path, $url)
{
}
/**
* {@inheritDoc}
*/
public function setOutputProgress($outputProgress)
{
}
protected function clearLastCacheWrite(\Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function update(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target, $path)
{
}
/**
* {@inheritDoc}
*/
public function remove(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* Gets file name for specific package
*
* @param PackageInterface $package package instance
* @param string $path download path
* @return string file name
*/
protected function getFileName(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* Process the download url
*
* @param PackageInterface $package package the url is coming from
* @param string $url download url
* @throws \RuntimeException If any problem with the url
* @return string url
*/
protected function processUrl(\Composer\Package\PackageInterface $package, $url)
{
}
}
/**
* Base downloader for archives
*
* @author Kirill chEbba Chebunin <iam@chebba.org>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author François Pluchino <francois.pluchino@opendisplay.com>
*/
abstract class ArchiveDownloader extends \Composer\Downloader\FileDownloader
{
/**
* {@inheritDoc}
*/
public function download(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* {@inheritdoc}
*/
protected function getFileName(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* {@inheritdoc}
*/
protected function processUrl(\Composer\Package\PackageInterface $package, $url)
{
}
/**
* Extract file to directory
*
* @param string $file Extracted file
* @param string $path Directory
*
* @throws \UnexpectedValueException If can not extract downloaded file to path
*/
protected abstract function extract($file, $path);
}
/**
* GZip archive downloader.
*
* @author Pavel Puchkin <i@neoascetic.me>
*/
class GzipDownloader extends \Composer\Downloader\ArchiveDownloader
{
protected $process;
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $eventDispatcher = null, \Composer\Cache $cache = null, \Composer\Util\ProcessExecutor $process = null, \Composer\Util\RemoteFilesystem $rfs = null)
{
}
protected function extract($file, $path)
{
}
/**
* {@inheritdoc}
*/
protected function getFileName(\Composer\Package\PackageInterface $package, $path)
{
}
}
/**
* Downloader for phar files
*
* @author Kirill chEbba Chebunin <iam@chebba.org>
*/
class PharDownloader extends \Composer\Downloader\ArchiveDownloader
{
/**
* {@inheritDoc}
*/
protected function extract($file, $path)
{
}
}
/**
* @author Matt Whittom <Matt.Whittom@veteransunited.com>
*/
class PerforceDownloader extends \Composer\Downloader\VcsDownloader
{
/** @var Perforce */
protected $perforce;
/**
* {@inheritDoc}
*/
public function doDownload(\Composer\Package\PackageInterface $package, $path, $url)
{
}
public function initPerforce(\Composer\Package\PackageInterface $package, $path, $url)
{
}
/**
* {@inheritDoc}
*/
public function doUpdate(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target, $path, $url)
{
}
/**
* {@inheritDoc}
*/
public function getLocalChanges(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* {@inheritDoc}
*/
protected function getCommitLogs($fromReference, $toReference, $path)
{
}
public function setPerforce($perforce)
{
}
/**
* {@inheritDoc}
*/
protected function hasMetadataRepository($path)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class TransportException extends \RuntimeException
{
protected $headers;
protected $response;
protected $statusCode;
public function setHeaders($headers)
{
}
public function getHeaders()
{
}
public function setResponse($response)
{
}
public function getResponse()
{
}
public function setStatusCode($statusCode)
{
}
public function getStatusCode()
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class GitDownloader extends \Composer\Downloader\VcsDownloader implements \Composer\Downloader\DvcsDownloaderInterface
{
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\Util\ProcessExecutor $process = null, \Composer\Util\Filesystem $fs = null)
{
}
/**
* {@inheritDoc}
*/
public function doDownload(\Composer\Package\PackageInterface $package, $path, $url)
{
}
/**
* {@inheritDoc}
*/
public function doUpdate(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target, $path, $url)
{
}
/**
* {@inheritDoc}
*/
public function getLocalChanges(\Composer\Package\PackageInterface $package, $path)
{
}
public function getUnpushedChanges(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* {@inheritDoc}
*/
protected function cleanChanges(\Composer\Package\PackageInterface $package, $path, $update)
{
}
/**
* {@inheritDoc}
*/
protected function reapplyChanges($path)
{
}
/**
* Updates the given path to the given commit ref
*
* @param string $path
* @param string $reference
* @param string $branch
* @param \DateTime $date
* @throws \RuntimeException
* @return null|string if a string is returned, it is the commit reference that was checked out if the original could not be found
*/
protected function updateToCommit($path, $reference, $branch, $date)
{
}
protected function setPushUrl($path, $url)
{
}
/**
* {@inheritDoc}
*/
protected function getCommitLogs($fromReference, $toReference, $path)
{
}
/**
* @param $path
* @throws \RuntimeException
*/
protected function discardChanges($path)
{
}
/**
* @param $path
* @throws \RuntimeException
*/
protected function stashChanges($path)
{
}
/**
* @param $path
* @throws \RuntimeException
*/
protected function viewDiff($path)
{
}
protected function normalizePath($path)
{
}
/**
* {@inheritDoc}
*/
protected function hasMetadataRepository($path)
{
}
}
/**
* RAR archive downloader.
*
* Based on previous work by Jordi Boggiano ({@see ZipDownloader}).
*
* @author Derrick Nelson <drrcknlsn@gmail.com>
*/
class RarDownloader extends \Composer\Downloader\ArchiveDownloader
{
protected $process;
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $eventDispatcher = null, \Composer\Cache $cache = null, \Composer\Util\ProcessExecutor $process = null, \Composer\Util\RemoteFilesystem $rfs = null)
{
}
protected function extract($file, $path)
{
}
}
/**
* Exception thrown when issues exist on local filesystem
*
* @author Javier Spagnoletti <jspagnoletti@javierspagnoletti.com.ar>
*/
class FilesystemException extends \Exception
{
public function __construct($message = '', $code = 0, \Exception $previous = null)
{
}
}
/**
* Download a package from a local path.
*
* @author Samuel Roze <samuel.roze@gmail.com>
* @author Johann Reinke <johann.reinke@gmail.com>
*/
class PathDownloader extends \Composer\Downloader\FileDownloader
{
const STRATEGY_SYMLINK = 10;
const STRATEGY_MIRROR = 20;
/**
* {@inheritdoc}
*/
public function download(\Composer\Package\PackageInterface $package, $path)
{
}
/**
* {@inheritDoc}
*/
public function remove(\Composer\Package\PackageInterface $package, $path)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ZipDownloader extends \Composer\Downloader\ArchiveDownloader
{
protected $process;
protected static $hasSystemUnzip;
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $eventDispatcher = null, \Composer\Cache $cache = null, \Composer\Util\ProcessExecutor $process = null, \Composer\Util\RemoteFilesystem $rfs = null)
{
}
/**
* {@inheritDoc}
*/
public function download(\Composer\Package\PackageInterface $package, $path)
{
}
protected function extract($file, $path)
{
}
/**
* Give a meaningful error message to the user.
*
* @param int $retval
* @param string $file
* @return string
*/
protected function getErrorMessage($retval, $file)
{
}
}
/**
* Downloader for tar files: tar, tar.gz or tar.bz2
*
* @author Kirill chEbba Chebunin <iam@chebba.org>
*/
class TarDownloader extends \Composer\Downloader\ArchiveDownloader
{
/**
* {@inheritDoc}
*/
protected function extract($file, $path)
{
}
}
/**
* Xz archive downloader.
*
* @author Pavel Puchkin <i@neoascetic.me>
* @author Pierre Rudloff <contact@rudloff.pro>
*/
class XzDownloader extends \Composer\Downloader\ArchiveDownloader
{
protected $process;
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config, \Composer\EventDispatcher\EventDispatcher $eventDispatcher = null, \Composer\Cache $cache = null, \Composer\Util\ProcessExecutor $process = null, \Composer\Util\RemoteFilesystem $rfs = null)
{
}
protected function extract($file, $path)
{
}
/**
* {@inheritdoc}
*/
protected function getFileName(\Composer\Package\PackageInterface $package, $path)
{
}
}
}
namespace Composer\Command {
/**
* Base class for Composer commands
*
* @author Ryan Weaver <ryan@knplabs.com>
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
abstract class BaseCommand extends \Symfony\Component\Console\Command\Command
{
/**
* @param bool $required
* @param bool $disablePlugins
* @throws \RuntimeException
* @return Composer
*/
public function getComposer($required = true, $disablePlugins = false)
{
}
/**
* @param Composer $composer
*/
public function setComposer(\Composer\Composer $composer)
{
}
/**
* Removes the cached composer instance
*/
public function resetComposer()
{
}
/**
* @return IOInterface
*/
public function getIO()
{
}
/**
* @param IOInterface $io
*/
public function setIO(\Composer\IO\IOInterface $io)
{
}
/**
* {@inheritDoc}
*/
protected function initialize(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Robert Schönthal <seroscho@googlemail.com>
*/
class SearchCommand extends \Composer\Command\BaseCommand
{
protected $matches;
protected $lowMatches = array();
protected $tokens;
protected $output;
protected $onlyName;
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Fabien Potencier <fabien.potencier@gmail.com>
*/
class RunScriptCommand extends \Composer\Command\BaseCommand
{
/**
* @var array Array with command events
*/
protected $scriptEvents = array(\Composer\Script\ScriptEvents::PRE_INSTALL_CMD, \Composer\Script\ScriptEvents::POST_INSTALL_CMD, \Composer\Script\ScriptEvents::PRE_UPDATE_CMD, \Composer\Script\ScriptEvents::POST_UPDATE_CMD, \Composer\Script\ScriptEvents::PRE_STATUS_CMD, \Composer\Script\ScriptEvents::POST_STATUS_CMD, \Composer\Script\ScriptEvents::POST_ROOT_PACKAGE_INSTALL, \Composer\Script\ScriptEvents::POST_CREATE_PROJECT_CMD, \Composer\Script\ScriptEvents::PRE_ARCHIVE_CMD, \Composer\Script\ScriptEvents::POST_ARCHIVE_CMD, \Composer\Script\ScriptEvents::PRE_AUTOLOAD_DUMP, \Composer\Script\ScriptEvents::POST_AUTOLOAD_DUMP);
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
protected function listScripts()
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class DumpAutoloadCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* Base implementation for commands mapping dependency relationships.
*
* @author Niels Keurentjes <niels.keurentjes@omines.com>
*/
class BaseDependencyCommand extends \Composer\Command\BaseCommand
{
const ARGUMENT_PACKAGE = 'package';
const ARGUMENT_CONSTRAINT = 'constraint';
const OPTION_RECURSIVE = 'recursive';
const OPTION_TREE = 'tree';
protected $colors;
/**
* Set common options and arguments.
*/
protected function configure()
{
}
/**
* Execute the command.
*
* @param InputInterface $input
* @param OutputInterface $output
* @param bool $inverted Whether to invert matching process (why-not vs why behaviour)
* @return int|null Exit code of the operation.
*/
protected function doExecute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output, $inverted = false)
{
}
/**
* Assembles and prints a bottom-up table of the dependencies.
*
* @param OutputInterface $output
* @param array $results
*/
protected function printTable(\Symfony\Component\Console\Output\OutputInterface $output, $results)
{
}
/**
* Init styles for tree
*
* @param OutputInterface $output
*/
protected function initStyles(\Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* Recursively prints a tree of the selected results.
*
* @param array $results Results to be printed at this level.
* @param string $prefix Prefix of the current tree level.
* @param int $level Current level of recursion.
*/
protected function printTree($results, $prefix = '', $level = 1)
{
}
}
/**
* @author Niels Keurentjes <niels.keurentjes@omines.com>
*/
class DependsCommand extends \Composer\Command\BaseDependencyCommand
{
/**
* Configure command metadata.
*/
protected function configure()
{
}
/**
* Execute the function.
*
* @param InputInterface $input
* @param OutputInterface $output
* @return int|null
*/
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class AboutCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class GlobalCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
public function run(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Tiago Ribeiro <tiago.ribeiro@seegno.com>
* @author Rui Marinho <rui.marinho@seegno.com>
*/
class StatusCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* Creates an archive of a package for distribution.
*
* @author Nils Adermann <naderman@naderman.de>
*/
class ArchiveCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
protected function archive(\Composer\IO\IOInterface $io, \Composer\Config $config, $packageName = null, $version = null, $format = 'tar', $dest = '.', $fileName = null)
{
}
protected function selectPackage(\Composer\IO\IOInterface $io, $packageName, $version = null)
{
}
}
/**
* @author Pierre du Plessis <pdples@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class RemoveCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
class SuggestsCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* Install a package as new project into new directory.
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Tobias Munk <schmunk@usrbin.de>
* @author Nils Adermann <naderman@naderman.de>
*/
class CreateProjectCommand extends \Composer\Command\BaseCommand
{
/**
* @var SuggestedPackagesReporter
*/
protected $suggestedPackagesReporter;
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
public function installProject(\Composer\IO\IOInterface $io, \Composer\Config $config, \Symfony\Component\Console\Input\InputInterface $input, $packageName, $directory = null, $packageVersion = null, $stability = 'stable', $preferSource = false, $preferDist = false, $installDevPackages = false, $repository = null, $disablePlugins = false, $noScripts = false, $keepVcs = false, $noProgress = false, $noInstall = false, $ignorePlatformReqs = false)
{
}
protected function installRootPackage(\Composer\IO\IOInterface $io, \Composer\Config $config, $packageName, $directory = null, $packageVersion = null, $stability = 'stable', $preferSource = false, $preferDist = false, $installDevPackages = false, $repository = null, $disablePlugins = false, $noScripts = false, $keepVcs = false, $noProgress = false, $ignorePlatformReqs = false)
{
}
protected function createDownloadManager(\Composer\IO\IOInterface $io, \Composer\Config $config)
{
}
protected function createInstallationManager()
{
}
/**
* Updated preferSource or preferDist based on the preferredInstall config option
* @param Config $config
* @param InputInterface $input
* @param bool $preferSource
* @param bool $preferDist
* @param bool $keepVcsRequiresPreferSource
*/
protected function updatePreferredOptions(\Composer\Config $config, \Symfony\Component\Console\Input\InputInterface $input, &$preferSource, &$preferDist, $keepVcsRequiresPreferSource = false)
{
}
}
/**
* @author Davey Shafik <me@daveyshafik.com>
*/
class ExecCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ScriptAliasCommand extends \Composer\Command\BaseCommand
{
public function __construct($script)
{
}
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Ryan Weaver <ryan@knplabs.com>
* @author Konstantin Kudryashov <ever.zet@gmail.com>
* @author Nils Adermann <naderman@naderman.de>
*/
class InstallCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class DiagnoseCommand extends \Composer\Command\BaseCommand
{
/** @var RemoteFileSystem */
protected $rfs;
/** @var ProcessExecutor */
protected $process;
/** @var int */
protected $failures = 0;
protected function configure()
{
}
/**
* {@inheritdoc}
*/
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Robert Schönthal <seroscho@googlemail.com>
*/
class HomeCommand extends \Composer\Command\BaseCommand
{
/**
* {@inheritDoc}
*/
protected function configure()
{
}
/**
* {@inheritDoc}
*/
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Nils Adermann <naderman@naderman.de>
*/
class UpdateCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Joshua Estes <Joshua.Estes@iostudio.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ConfigCommand extends \Composer\Command\BaseCommand
{
/**
* @var Config
*/
protected $config;
/**
* @var JsonFile
*/
protected $configFile;
/**
* @var JsonConfigSource
*/
protected $configSource;
/**
* @var JsonFile
*/
protected $authConfigFile;
/**
* @var JsonConfigSource
*/
protected $authConfigSource;
/**
* {@inheritDoc}
*/
protected function configure()
{
}
/**
* {@inheritDoc}
*/
protected function initialize(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* {@inheritDoc}
*/
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* Display the contents of the file in a pretty formatted way
*
* @param array $contents
* @param array $rawContents
* @param OutputInterface $output
* @param string|null $k
*/
protected function listConfiguration(array $contents, array $rawContents, \Symfony\Component\Console\Output\OutputInterface $output, $k = null)
{
}
}
/**
* @author Justin Rainbow <justin.rainbow@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class InitCommand extends \Composer\Command\BaseCommand
{
/** @var CompositeRepository */
protected $repos;
/**
* {@inheritdoc}
*/
protected function configure()
{
}
/**
* {@inheritdoc}
*/
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* {@inheritdoc}
*/
protected function interact(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* @private
* @param string $author
* @return array
*/
public function parseAuthorString($author)
{
}
protected function findPackages($name)
{
}
protected function getRepos()
{
}
protected function determineRequirements(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output, $requires = array(), $phpVersion = null)
{
}
protected function formatAuthors($author)
{
}
protected function formatRequirements(array $requirements)
{
}
protected function getGitConfig()
{
}
/**
* Checks the local .gitignore file for the Composer vendor directory.
*
* Tested patterns include:
* "/$vendor"
* "$vendor"
* "$vendor/"
* "/$vendor/"
* "/$vendor/*"
* "$vendor/*"
*
* @param string $ignoreFile
* @param string $vendor
*
* @return bool
*/
protected function hasVendorIgnore($ignoreFile, $vendor = 'vendor')
{
}
protected function normalizeRequirements(array $requirements)
{
}
protected function addVendorIgnore($ignoreFile, $vendor = '/vendor/')
{
}
protected function isValidEmail($email)
{
}
}
/**
* @author Jérémy Romey <jeremy@free-agent.fr>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class RequireCommand extends \Composer\Command\InitCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
protected function interact(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author David Neilsen <petah.p@gmail.com>
*/
class ClearCacheCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Jérémy Romey <jeremyFreeAgent>
*/
class ShowCommand extends \Composer\Command\BaseCommand
{
/** @var VersionParser */
protected $versionParser;
protected $colors;
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* finds a package by name and version if provided
*
* @param RepositoryInterface $installedRepo
* @param RepositoryInterface $repos
* @param string $name
* @param ConstraintInterface|string $version
* @throws \InvalidArgumentException
* @return array array(CompletePackageInterface, array of versions)
*/
protected function getPackage(\Composer\Repository\RepositoryInterface $installedRepo, \Composer\Repository\RepositoryInterface $repos, $name, $version = null)
{
}
/**
* Prints package metadata.
*
* @param CompletePackageInterface $package
* @param array $versions
* @param RepositoryInterface $installedRepo
*/
protected function printMeta(\Composer\Package\CompletePackageInterface $package, array $versions, \Composer\Repository\RepositoryInterface $installedRepo)
{
}
/**
* Prints all available versions of this package and highlights the installed one if any.
*
* @param CompletePackageInterface $package
* @param array $versions
* @param RepositoryInterface $installedRepo
*/
protected function printVersions(\Composer\Package\CompletePackageInterface $package, array $versions, \Composer\Repository\RepositoryInterface $installedRepo)
{
}
/**
* print link objects
*
* @param CompletePackageInterface $package
* @param string $linkType
* @param string $title
*/
protected function printLinks(\Composer\Package\CompletePackageInterface $package, $linkType, $title = null)
{
}
/**
* Prints the licenses of a package with metadata
*
* @param CompletePackageInterface $package
*/
protected function printLicenses(\Composer\Package\CompletePackageInterface $package)
{
}
/**
* Init styles for tree
*
* @param OutputInterface $output
*/
protected function initStyles(\Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* Display the tree
*
* @param PackageInterface|string $package
* @param RepositoryInterface $installedRepo
* @param RepositoryInterface $distantRepos
*/
protected function displayPackageTree(\Composer\Package\PackageInterface $package, \Composer\Repository\RepositoryInterface $installedRepo, \Composer\Repository\RepositoryInterface $distantRepos)
{
}
/**
* Display a package tree
*
* @param string $name
* @param PackageInterface|string $package
* @param RepositoryInterface $installedRepo
* @param RepositoryInterface $distantRepos
* @param array $packagesInTree
* @param string $previousTreeBar
* @param int $level
*/
protected function displayTree($name, $package, \Composer\Repository\RepositoryInterface $installedRepo, \Composer\Repository\RepositoryInterface $distantRepos, array $packagesInTree, $previousTreeBar = '├', $level = 1)
{
}
}
/**
* @author Igor Wiedler <igor@wiedler.ch>
* @author Kevin Ran <kran@adobe.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class SelfUpdateCommand extends \Composer\Command\BaseCommand
{
const HOMEPAGE = 'getcomposer.org';
const OLD_INSTALL_EXT = '-old.phar';
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
protected function fetchKeys(\Composer\IO\IOInterface $io, \Composer\Config $config)
{
}
protected function rollback(\Symfony\Component\Console\Output\OutputInterface $output, $rollbackDir, $localFilename)
{
}
/**
* @param string $localFilename
* @param string $newFilename
* @param string $backupTarget
* @throws \Exception
* @return \UnexpectedValueException|\PharException|null
*/
protected function setLocalPhar($localFilename, $newFilename, $backupTarget = null)
{
}
protected function cleanBackups($rollbackDir, $except = null)
{
}
protected function getLastBackupVersion($rollbackDir)
{
}
protected function getOldInstallationFinder($rollbackDir)
{
}
}
/**
* @author Benoît Merlet <benoit.merlet@gmail.com>
*/
class LicensesCommand extends \Composer\Command\BaseCommand
{
protected function configure()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* Adds packages to the package list
*
* @param array $packages the list of packages to add
* @param array $bucket the list to add packages to
* @return array
*/
public function appendPackages(array $packages, array $bucket)
{
}
}
/**
* ValidateCommand
*
* @author Robert Schönthal <seroscho@googlemail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ValidateCommand extends \Composer\Command\BaseCommand
{
/**
* configure
*/
protected function configure()
{
}
/**
* @param InputInterface $input
* @param OutputInterface $output
*
* @return int
*/
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
/**
* @author Niels Keurentjes <niels.keurentjes@omines.com>
*/
class ProhibitsCommand extends \Composer\Command\BaseDependencyCommand
{
/**
* Configure command metadata.
*/
protected function configure()
{
}
/**
* Execute the function.
*
* @param InputInterface $input
* @param OutputInterface $output
* @return int|null
*/
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
}
namespace Composer\IO {
/**
* The Input/Output helper interface.
*
* @author François Pluchino <francois.pluchino@opendisplay.com>
*/
interface IOInterface
{
const QUIET = 1;
const NORMAL = 2;
const VERBOSE = 4;
const VERY_VERBOSE = 8;
const DEBUG = 16;
/**
* Is this input means interactive?
*
* @return bool
*/
public function isInteractive();
/**
* Is this output verbose?
*
* @return bool
*/
public function isVerbose();
/**
* Is the output very verbose?
*
* @return bool
*/
public function isVeryVerbose();
/**
* Is the output in debug verbosity?
*
* @return bool
*/
public function isDebug();
/**
* Is this output decorated?
*
* @return bool
*/
public function isDecorated();
/**
* Writes a message to the output.
*
* @param string|array $messages The message as an array of lines or a single string
* @param bool $newline Whether to add a newline or not
* @param int $verbosity Verbosity level from the VERBOSITY_* constants
*/
public function write($messages, $newline = true, $verbosity = self::NORMAL);
/**
* Writes a message to the error output.
*
* @param string|array $messages The message as an array of lines or a single string
* @param bool $newline Whether to add a newline or not
* @param int $verbosity Verbosity level from the VERBOSITY_* constants
*/
public function writeError($messages, $newline = true, $verbosity = self::NORMAL);
/**
* Overwrites a previous message to the output.
*
* @param string|array $messages The message as an array of lines or a single string
* @param bool $newline Whether to add a newline or not
* @param int $size The size of line
* @param int $verbosity Verbosity level from the VERBOSITY_* constants
*/
public function overwrite($messages, $newline = true, $size = null, $verbosity = self::NORMAL);
/**
* Overwrites a previous message to the error output.
*
* @param string|array $messages The message as an array of lines or a single string
* @param bool $newline Whether to add a newline or not
* @param int $size The size of line
* @param int $verbosity Verbosity level from the VERBOSITY_* constants
*/
public function overwriteError($messages, $newline = true, $size = null, $verbosity = self::NORMAL);
/**
* Asks a question to the user.
*
* @param string|array $question The question to ask
* @param string $default The default answer if none is given by the user
*
* @throws \RuntimeException If there is no data to read in the input stream
* @return string The user answer
*/
public function ask($question, $default = null);
/**
* Asks a confirmation to the user.
*
* The question will be asked until the user answers by nothing, yes, or no.
*
* @param string|array $question The question to ask
* @param bool $default The default answer if the user enters nothing
*
* @return bool true if the user has confirmed, false otherwise
*/
public function askConfirmation($question, $default = true);
/**
* Asks for a value and validates the response.
*
* The validator receives the data to validate. It must return the
* validated data when the data is valid and throw an exception
* otherwise.
*
* @param string|array $question The question to ask
* @param callback $validator A PHP callback
* @param null|int $attempts Max number of times to ask before giving up (default of null means infinite)
* @param mixed $default The default answer if none is given by the user
*
* @throws \Exception When any of the validators return an error
* @return mixed
*/
public function askAndValidate($question, $validator, $attempts = null, $default = null);
/**
* Asks a question to the user and hide the answer.
*
* @param string $question The question to ask
*
* @return string The answer
*/
public function askAndHideAnswer($question);
/**
* Asks the user to select a value.
*
* @param string|array $question The question to ask
* @param array $choices List of choices to pick from
* @param bool|string $default The default answer if the user enters nothing
* @param bool|int $attempts Max number of times to ask before giving up (false by default, which means infinite)
* @param string $errorMessage Message which will be shown if invalid value from choice list would be picked
* @param bool $multiselect Select more than one value separated by comma
*
* @throws \InvalidArgumentException
* @return int|string|array The selected value or values (the key of the choices array)
*/
public function select($question, $choices, $default, $attempts = false, $errorMessage = 'Value "%s" is invalid', $multiselect = false);
/**
* Get all authentication information entered.
*
* @return array The map of authentication data
*/
public function getAuthentications();
/**
* Verify if the repository has a authentication information.
*
* @param string $repositoryName The unique name of repository
*
* @return bool
*/
public function hasAuthentication($repositoryName);
/**
* Get the username and password of repository.
*
* @param string $repositoryName The unique name of repository
*
* @return array The 'username' and 'password'
*/
public function getAuthentication($repositoryName);
/**
* Set the authentication information for the repository.
*
* @param string $repositoryName The unique name of repository
* @param string $username The username
* @param string $password The password
*/
public function setAuthentication($repositoryName, $username, $password = null);
/**
* Loads authentications from a config instance
*
* @param Config $config
*/
public function loadConfiguration(\Composer\Config $config);
}
abstract class BaseIO implements \Composer\IO\IOInterface
{
protected $authentications = array();
/**
* {@inheritDoc}
*/
public function getAuthentications()
{
}
/**
* {@inheritDoc}
*/
public function hasAuthentication($repositoryName)
{
}
/**
* {@inheritDoc}
*/
public function getAuthentication($repositoryName)
{
}
/**
* {@inheritDoc}
*/
public function setAuthentication($repositoryName, $username, $password = null)
{
}
/**
* Check for overwrite and set the authentication information for the repository.
*
* @param string $repositoryName The unique name of repository
* @param string $username The username
* @param string $password The password
*/
protected function checkAndSetAuthentication($repositoryName, $username, $password = null)
{
}
/**
* {@inheritDoc}
*/
public function loadConfiguration(\Composer\Config $config)
{
}
}
/**
* The Input/Output helper.
*
* @author François Pluchino <francois.pluchino@opendisplay.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ConsoleIO extends \Composer\IO\BaseIO
{
/** @var InputInterface */
protected $input;
/** @var OutputInterface */
protected $output;
/** @var HelperSet */
protected $helperSet;
/** @var string */
protected $lastMessage;
/** @var string */
protected $lastMessageErr;
/**
* Constructor.
*
* @param InputInterface $input The input instance
* @param OutputInterface $output The output instance
* @param HelperSet $helperSet The helperSet instance
*/
public function __construct(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output, \Symfony\Component\Console\Helper\HelperSet $helperSet)
{
}
/**
* @param float $startTime
*/
public function enableDebugging($startTime)
{
}
/**
* {@inheritDoc}
*/
public function isInteractive()
{
}
/**
* {@inheritDoc}
*/
public function isDecorated()
{
}
/**
* {@inheritDoc}
*/
public function isVerbose()
{
}
/**
* {@inheritDoc}
*/
public function isVeryVerbose()
{
}
/**
* {@inheritDoc}
*/
public function isDebug()
{
}
/**
* {@inheritDoc}
*/
public function write($messages, $newline = true, $verbosity = self::NORMAL)
{
}
/**
* {@inheritDoc}
*/
public function writeError($messages, $newline = true, $verbosity = self::NORMAL)
{
}
/**
* {@inheritDoc}
*/
public function overwrite($messages, $newline = true, $size = null, $verbosity = self::NORMAL)
{
}
/**
* {@inheritDoc}
*/
public function overwriteError($messages, $newline = true, $size = null, $verbosity = self::NORMAL)
{
}
/**
* {@inheritDoc}
*/
public function ask($question, $default = null)
{
}
/**
* {@inheritDoc}
*/
public function askConfirmation($question, $default = true)
{
}
/**
* {@inheritDoc}
*/
public function askAndValidate($question, $validator, $attempts = null, $default = null)
{
}
/**
* {@inheritDoc}
*/
public function askAndHideAnswer($question)
{
}
/**
* {@inheritDoc}
*/
public function select($question, $choices, $default, $attempts = false, $errorMessage = 'Value "%s" is invalid', $multiselect = false)
{
}
}
/**
* IOInterface that is not interactive and never writes the output
*
* @author Christophe Coevoet <stof@notk.org>
*/
class NullIO extends \Composer\IO\BaseIO
{
/**
* {@inheritDoc}
*/
public function isInteractive()
{
}
/**
* {@inheritDoc}
*/
public function isVerbose()
{
}
/**
* {@inheritDoc}
*/
public function isVeryVerbose()
{
}
/**
* {@inheritDoc}
*/
public function isDebug()
{
}
/**
* {@inheritDoc}
*/
public function isDecorated()
{
}
/**
* {@inheritDoc}
*/
public function write($messages, $newline = true, $verbosity = self::NORMAL)
{
}
/**
* {@inheritDoc}
*/
public function writeError($messages, $newline = true, $verbosity = self::NORMAL)
{
}
/**
* {@inheritDoc}
*/
public function overwrite($messages, $newline = true, $size = 80, $verbosity = self::NORMAL)
{
}
/**
* {@inheritDoc}
*/
public function overwriteError($messages, $newline = true, $size = 80, $verbosity = self::NORMAL)
{
}
/**
* {@inheritDoc}
*/
public function ask($question, $default = null)
{
}
/**
* {@inheritDoc}
*/
public function askConfirmation($question, $default = true)
{
}
/**
* {@inheritDoc}
*/
public function askAndValidate($question, $validator, $attempts = false, $default = null)
{
}
/**
* {@inheritDoc}
*/
public function askAndHideAnswer($question)
{
}
/**
* {@inheritDoc}
*/
public function select($question, $choices, $default, $attempts = false, $errorMessage = 'Value "%s" is invalid', $multiselect = false)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class BufferIO extends \Composer\IO\ConsoleIO
{
/**
* @param string $input
* @param int $verbosity
* @param OutputFormatterInterface|null $formatter
*/
public function __construct($input = '', $verbosity = \Symfony\Component\Console\Output\StreamOutput::VERBOSITY_NORMAL, \Symfony\Component\Console\Formatter\OutputFormatterInterface $formatter = null)
{
}
public function getOutput()
{
}
}
}
namespace Composer\Plugin {
/**
* The Plugin Events.
*
* @author Nils Adermann <naderman@naderman.de>
*/
class PluginEvents
{
/**
* The COMMAND event occurs as a command begins
*
* The event listener method receives a
* Composer\Plugin\CommandEvent instance.
*
* @var string
*/
const COMMAND = 'command';
/**
* The PRE_FILE_DOWNLOAD event occurs before downloading a file
*
* The event listener method receives a
* Composer\Plugin\PreFileDownloadEvent instance.
*
* @var string
*/
const PRE_FILE_DOWNLOAD = 'pre-file-download';
}
/**
* Plugin interface
*
* @author Nils Adermann <naderman@naderman.de>
*/
interface PluginInterface
{
/**
* Version number of the internal composer-plugin-api package
*
* @var string
*/
const PLUGIN_API_VERSION = '1.0.0';
/**
* Apply plugin modifications to Composer
*
* @param Composer $composer
* @param IOInterface $io
*/
public function activate(\Composer\Composer $composer, \Composer\IO\IOInterface $io);
}
/**
* An event for all commands.
*
* @author Nils Adermann <naderman@naderman.de>
*/
class CommandEvent extends \Composer\EventDispatcher\Event
{
/**
* Constructor.
*
* @param string $name The event name
* @param string $commandName The command name
* @param InputInterface $input
* @param OutputInterface $output
* @param array $args Arguments passed by the user
* @param array $flags Optional flags to pass data not as argument
*/
public function __construct($name, $commandName, $input, $output, array $args = array(), array $flags = array())
{
}
/**
* Returns the command input interface
*
* @return InputInterface
*/
public function getInput()
{
}
/**
* Retrieves the command output interface
*
* @return OutputInterface
*/
public function getOutput()
{
}
/**
* Retrieves the name of the command being run
*
* @return string
*/
public function getCommandName()
{
}
}
/**
* The pre file download event.
*
* @author Nils Adermann <naderman@naderman.de>
*/
class PreFileDownloadEvent extends \Composer\EventDispatcher\Event
{
/**
* Constructor.
*
* @param string $name The event name
* @param RemoteFilesystem $rfs
* @param string $processedUrl
*/
public function __construct($name, \Composer\Util\RemoteFilesystem $rfs, $processedUrl)
{
}
/**
* Returns the remote filesystem
*
* @return RemoteFilesystem
*/
public function getRemoteFilesystem()
{
}
/**
* Sets the remote filesystem
*
* @param RemoteFilesystem $rfs
*/
public function setRemoteFilesystem(\Composer\Util\RemoteFilesystem $rfs)
{
}
/**
* Retrieves the processed URL this remote filesystem will be used for
*
* @return string
*/
public function getProcessedUrl()
{
}
}
}
namespace Composer\Plugin\Capability {
/**
* Marker interface for Plugin capabilities.
* Every new Capability which is added to the Plugin API must implement this interface.
*
* @api
*/
interface Capability
{
}
}
namespace Composer\Plugin {
/**
* Plugin manager
*
* @author Nils Adermann <naderman@naderman.de>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class PluginManager
{
protected $composer;
protected $io;
protected $globalComposer;
protected $versionParser;
protected $disablePlugins = false;
protected $plugins = array();
protected $registeredPlugins = array();
/**
* Initializes plugin manager
*
* @param IOInterface $io
* @param Composer $composer
* @param Composer $globalComposer
* @param bool $disablePlugins
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Composer $composer, \Composer\Composer $globalComposer = null, $disablePlugins = false)
{
}
/**
* Loads all plugins from currently installed plugin packages
*/
public function loadInstalledPlugins()
{
}
/**
* Gets all currently active plugin instances
*
* @return array plugins
*/
public function getPlugins()
{
}
/**
* Gets global composer or null when main composer is not fully loaded
*
* @return Composer|null
*/
public function getGlobalComposer()
{
}
/**
* Register a plugin package, activate it etc.
*
* If it's of type composer-installer it is registered as an installer
* instead for BC
*
* @param PackageInterface $package
* @param bool $failOnMissingClasses By default this silently skips plugins that can not be found, but if set to true it fails with an exception
*
* @throws \UnexpectedValueException
*/
public function registerPackage(\Composer\Package\PackageInterface $package, $failOnMissingClasses = false)
{
}
/**
* Returns the version of the internal composer-plugin-api package.
*
* @return string
*/
protected function getPluginApiVersion()
{
}
/**
* @param PluginInterface $plugin
* @param string $capability
* @throws \RuntimeException On empty or non-string implementation class name value
* @return null|string The fully qualified class of the implementation or null if Plugin is not of Capable type or does not provide it
*/
protected function getCapabilityImplementationClassName(\Composer\Plugin\PluginInterface $plugin, $capability)
{
}
/**
* @param PluginInterface $plugin
* @param string $capabilityClassName The fully qualified name of the API interface which the plugin may provide
* an implementation of.
* @param array $ctorArgs Arguments passed to Capability's constructor.
* Keeping it an array will allow future values to be passed w\o changing the signature.
* @return null|Capability
*/
public function getPluginCapability(\Composer\Plugin\PluginInterface $plugin, $capabilityClassName, array $ctorArgs = array())
{
}
}
/**
* Plugins which need to expose various implementations
* of the Composer Plugin Capabilities must have their
* declared Plugin class implementing this interface.
*
* @api
*/
interface Capable
{
/**
* Method by which a Plugin announces its API implementations, through an array
* with a special structure.
*
* The key must be a string, representing a fully qualified class/interface name
* which Composer Plugin API exposes.
* The value must be a string as well, representing the fully qualified class name
* of the implementing class.
*
* @tutorial
*
* return array(
* 'Composer\Plugin\Capability\CommandProvider' => 'My\CommandProvider',
* 'Composer\Plugin\Capability\Validator' => 'My\Validator',
* );
*
* @return string[]
*/
public function getCapabilities();
}
}
namespace Composer\DependencyResolver {
/**
* @author Nils Adermann <naderman@naderman.de>
*/
class SolverProblemsException extends \RuntimeException
{
protected $problems;
protected $installedMap;
public function __construct(array $problems, array $installedMap)
{
}
protected function createMessage()
{
}
public function getProblems()
{
}
}
/**
* @author Nils Adermann <naderman@naderman.de>
*/
class RuleSet implements \IteratorAggregate, \Countable
{
// highest priority => lowest number
const TYPE_PACKAGE = 0;
const TYPE_JOB = 1;
const TYPE_LEARNED = 4;
/**
* READ-ONLY: Lookup table for rule id to rule object
*
* @var Rule[]
*/
public $ruleById;
protected static $types = array(255 => 'UNKNOWN', self::TYPE_PACKAGE => 'PACKAGE', self::TYPE_JOB => 'JOB', self::TYPE_LEARNED => 'LEARNED');
protected $rules;
protected $nextRuleId;
protected $rulesByHash;
public function __construct()
{
}
public function add(\Composer\DependencyResolver\Rule $rule, $type)
{
}
public function count()
{
}
public function ruleById($id)
{
}
public function getRules()
{
}
public function getIterator()
{
}
public function getIteratorFor($types)
{
}
public function getIteratorWithout($types)
{
}
public function getTypes()
{
}
public function containsEqual($rule)
{
}
public function getPrettyString(\Composer\DependencyResolver\Pool $pool = null)
{
}
public function __toString()
{
}
}
/**
* @author Nils Adermann <naderman@naderman.de>
*/
interface PolicyInterface
{
public function versionCompare(\Composer\Package\PackageInterface $a, \Composer\Package\PackageInterface $b, $operator);
public function findUpdatePackages(\Composer\DependencyResolver\Pool $pool, array $installedMap, \Composer\Package\PackageInterface $package);
public function selectPreferredPackages(\Composer\DependencyResolver\Pool $pool, array $installedMap, array $literals, $requiredPackage = null);
}
/**
* @author Nils Adermann <naderman@naderman.de>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class DefaultPolicy implements \Composer\DependencyResolver\PolicyInterface
{
public function __construct($preferStable = false, $preferLowest = false)
{
}
public function versionCompare(\Composer\Package\PackageInterface $a, \Composer\Package\PackageInterface $b, $operator)
{
}
public function findUpdatePackages(\Composer\DependencyResolver\Pool $pool, array $installedMap, \Composer\Package\PackageInterface $package, $mustMatchName = false)
{
}
public function getPriority(\Composer\DependencyResolver\Pool $pool, \Composer\Package\PackageInterface $package)
{
}
public function selectPreferredPackages(\Composer\DependencyResolver\Pool $pool, array $installedMap, array $literals, $requiredPackage = null)
{
}
protected function groupLiteralsByNamePreferInstalled(\Composer\DependencyResolver\Pool $pool, array $installedMap, $literals)
{
}
/**
* @protected
*/
public function compareByPriorityPreferInstalled(\Composer\DependencyResolver\Pool $pool, array $installedMap, \Composer\Package\PackageInterface $a, \Composer\Package\PackageInterface $b, $requiredPackage = null, $ignoreReplace = false)
{
}
/**
* Checks if source replaces a package with the same name as target.
*
* Replace constraints are ignored. This method should only be used for
* prioritisation, not for actual constraint verification.
*
* @param PackageInterface $source
* @param PackageInterface $target
* @return bool
*/
protected function replaces(\Composer\Package\PackageInterface $source, \Composer\Package\PackageInterface $target)
{
}
protected function pruneToBestVersion(\Composer\DependencyResolver\Pool $pool, $literals)
{
}
/**
* Assumes that installed packages come first and then all highest priority packages
*/
protected function pruneToHighestPriorityOrInstalled(\Composer\DependencyResolver\Pool $pool, array $installedMap, array $literals)
{
}
/**
* Assumes that locally aliased (in root package requires) packages take priority over branch-alias ones
*
* If no package is a local alias, nothing happens
*/
protected function pruneRemoteAliases(\Composer\DependencyResolver\Pool $pool, array $literals)
{
}
}
/**
* An extension of SplDoublyLinkedList with seek and removal of current element
*
* SplDoublyLinkedList only allows deleting a particular offset and has no
* method to set the internal iterator to a particular offset.
*
* @author Nils Adermann <naderman@naderman.de>
*/
class RuleWatchChain extends \SplDoublyLinkedList
{
protected $offset = 0;
/**
* Moves the internal iterator to the specified offset
*
* @param int $offset The offset to seek to.
*/
public function seek($offset)
{
}
/**
* Removes the current element from the list
*
* As SplDoublyLinkedList only allows deleting a particular offset and
* incorrectly sets the internal iterator if you delete the current value
* this method sets the internal iterator back to the following element
* using the seek method.
*/
public function remove()
{
}
}
/**
* @author Nils Adermann <naderman@naderman.de>
*/
class SolverBugException extends \RuntimeException
{
public function __construct($message)
{
}
}
/**
* Stores decisions on installing, removing or keeping packages
*
* @author Nils Adermann <naderman@naderman.de>
*/
class Decisions implements \Iterator, \Countable
{
const DECISION_LITERAL = 0;
const DECISION_REASON = 1;
protected $pool;
protected $decisionMap;
protected $decisionQueue = array();
public function __construct($pool)
{
}
public function decide($literal, $level, $why)
{
}
public function satisfy($literal)
{
}
public function conflict($literal)
{
}
public function decided($literalOrPackageId)
{
}
public function undecided($literalOrPackageId)
{
}
public function decidedInstall($literalOrPackageId)
{
}
public function decisionLevel($literalOrPackageId)
{
}
public function decisionRule($literalOrPackageId)
{
}
public function atOffset($queueOffset)
{
}
public function validOffset($queueOffset)
{
}
public function lastReason()
{
}
public function lastLiteral()
{
}
public function reset()
{
}
public function resetToOffset($offset)
{
}
public function revertLast()
{
}
public function count()
{
}
public function rewind()
{
}
public function current()
{
}
public function key()
{
}
public function next()
{
}
public function valid()
{
}
public function isEmpty()
{
}
protected function addDecision($literal, $level)
{
}
}
/**
* @author Nils Adermann <naderman@naderman.de>
*/
class Solver
{
const BRANCH_LITERALS = 0;
const BRANCH_LEVEL = 1;
/** @var PolicyInterface */
protected $policy;
/** @var Pool */
protected $pool;
/** @var RepositoryInterface */
protected $installed;
/** @var Ruleset */
protected $rules;
/** @var RuleSetGenerator */
protected $ruleSetGenerator;
/** @var array */
protected $jobs;
/** @var int[] */
protected $updateMap = array();
/** @var RuleWatchGraph */
protected $watchGraph;
/** @var Decisions */
protected $decisions;
/** @var int[] */
protected $installedMap;
/** @var int */
protected $propagateIndex;
/** @var array[] */
protected $branches = array();
/** @var Problem[] */
protected $problems = array();
/** @var array */
protected $learnedPool = array();
/** @var array */
protected $learnedWhy = array();
/** @var IOInterface */
protected $io;
/**
* @param PolicyInterface $policy
* @param Pool $pool
* @param RepositoryInterface $installed
* @param IOInterface $io
*/
public function __construct(\Composer\DependencyResolver\PolicyInterface $policy, \Composer\DependencyResolver\Pool $pool, \Composer\Repository\RepositoryInterface $installed, \Composer\IO\IOInterface $io)
{
}
/**
* @return int
*/
public function getRuleSetSize()
{
}
protected function setupInstalledMap()
{
}
/**
* @param bool $ignorePlatformReqs
*/
protected function checkForRootRequireProblems($ignorePlatformReqs)
{
}
/**
* @param Request $request
* @param bool $ignorePlatformReqs
* @return array
*/
public function solve(\Composer\DependencyResolver\Request $request, $ignorePlatformReqs = false)
{
}
/**
* Makes a decision and propagates it to all rules.
*
* Evaluates each term affected by the decision (linked through watches)
* If we find unit rules we make new decisions based on them
*
* @param int $level
* @return Rule|null A rule on conflict, otherwise null.
*/
protected function propagate($level)
{
}
/**
* @param int $level
* @param Rule $rule
* @return array
*/
protected function analyze($level, \Composer\DependencyResolver\Rule $rule)
{
}
}
}
namespace Composer\DependencyResolver\Operation {
/**
* Solver operation interface.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
interface OperationInterface
{
/**
* Returns job type.
*
* @return string
*/
public function getJobType();
/**
* Returns operation reason.
*
* @return string
*/
public function getReason();
/**
* Serializes the operation in a human readable format
*
* @return string
*/
public function __toString();
}
/**
* Abstract solver operation class.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
abstract class SolverOperation implements \Composer\DependencyResolver\Operation\OperationInterface
{
protected $reason;
/**
* Initializes operation.
*
* @param string $reason operation reason
*/
public function __construct($reason = null)
{
}
/**
* Returns operation reason.
*
* @return string
*/
public function getReason()
{
}
protected function formatVersion(\Composer\Package\PackageInterface $package)
{
}
}
/**
* Solver update operation.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
class UpdateOperation extends \Composer\DependencyResolver\Operation\SolverOperation
{
protected $initialPackage;
protected $targetPackage;
/**
* Initializes update operation.
*
* @param PackageInterface $initial initial package
* @param PackageInterface $target target package (updated)
* @param string $reason update reason
*/
public function __construct(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target, $reason = null)
{
}
/**
* Returns initial package.
*
* @return PackageInterface
*/
public function getInitialPackage()
{
}
/**
* Returns target package.
*
* @return PackageInterface
*/
public function getTargetPackage()
{
}
/**
* Returns job type.
*
* @return string
*/
public function getJobType()
{
}
/**
* {@inheritDoc}
*/
public function __toString()
{
}
}
/**
* Solver uninstall operation.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
class UninstallOperation extends \Composer\DependencyResolver\Operation\SolverOperation
{
protected $package;
/**
* Initializes operation.
*
* @param PackageInterface $package package instance
* @param string $reason operation reason
*/
public function __construct(\Composer\Package\PackageInterface $package, $reason = null)
{
}
/**
* Returns package instance.
*
* @return PackageInterface
*/
public function getPackage()
{
}
/**
* Returns job type.
*
* @return string
*/
public function getJobType()
{
}
/**
* {@inheritDoc}
*/
public function __toString()
{
}
}
/**
* Solver install operation.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
class InstallOperation extends \Composer\DependencyResolver\Operation\SolverOperation
{
protected $package;
/**
* Initializes operation.
*
* @param PackageInterface $package package instance
* @param string $reason operation reason
*/
public function __construct(\Composer\Package\PackageInterface $package, $reason = null)
{
}
/**
* Returns package instance.
*
* @return PackageInterface
*/
public function getPackage()
{
}
/**
* Returns job type.
*
* @return string
*/
public function getJobType()
{
}
/**
* {@inheritDoc}
*/
public function __toString()
{
}
}
/**
* Solver install operation.
*
* @author Nils Adermann <naderman@naderman.de>
*/
class MarkAliasUninstalledOperation extends \Composer\DependencyResolver\Operation\SolverOperation
{
protected $package;
/**
* Initializes operation.
*
* @param AliasPackage $package package instance
* @param string $reason operation reason
*/
public function __construct(\Composer\Package\AliasPackage $package, $reason = null)
{
}
/**
* Returns package instance.
*
* @return PackageInterface
*/
public function getPackage()
{
}
/**
* Returns job type.
*
* @return string
*/
public function getJobType()
{
}
/**
* {@inheritDoc}
*/
public function __toString()
{
}
}
/**
* Solver install operation.
*
* @author Nils Adermann <naderman@naderman.de>
*/
class MarkAliasInstalledOperation extends \Composer\DependencyResolver\Operation\SolverOperation
{
protected $package;
/**
* Initializes operation.
*
* @param AliasPackage $package package instance
* @param string $reason operation reason
*/
public function __construct(\Composer\Package\AliasPackage $package, $reason = null)
{
}
/**
* Returns package instance.
*
* @return PackageInterface
*/
public function getPackage()
{
}
/**
* Returns job type.
*
* @return string
*/
public function getJobType()
{
}
/**
* {@inheritDoc}
*/
public function __toString()
{
}
}
}
namespace Composer\DependencyResolver {
/**
* The RuleWatchGraph efficiently propagates decisions to other rules
*
* All rules generated for solving a SAT problem should be inserted into the
* graph. When a decision on a literal is made, the graph can be used to
* propagate the decision to all other rules involving the literal, leading to
* other trivial decisions resulting from unit clauses.
*
* @author Nils Adermann <naderman@naderman.de>
*/
class RuleWatchGraph
{
protected $watchChains = array();
/**
* Inserts a rule node into the appropriate chains within the graph
*
* The node is prepended to the watch chains for each of the two literals it
* watches.
*
* Assertions are skipped because they only depend on a single package and
* have no alternative literal that could be true, so there is no need to
* watch changes in any literals.
*
* @param RuleWatchNode $node The rule node to be inserted into the graph
*/
public function insert(\Composer\DependencyResolver\RuleWatchNode $node)
{
}
/**
* Propagates a decision on a literal to all rules watching the literal
*
* If a decision, e.g. +A has been made, then all rules containing -A, e.g.
* (-A|+B|+C) now need to satisfy at least one of the other literals, so
* that the rule as a whole becomes true, since with +A applied the rule
* is now (false|+B|+C) so essentially (+B|+C).
*
* This means that all rules watching the literal -A need to be updated to
* watch 2 other literals which can still be satisfied instead. So literals
* that conflict with previously made decisions are not an option.
*
* Alternatively it can occur that a unit clause results: e.g. if in the
* above example the rule was (-A|+B), then A turning true means that
* B must now be decided true as well.
*
* @param int $decidedLiteral The literal which was decided (A in our example)
* @param int $level The level at which the decision took place and at which
* all resulting decisions should be made.
* @param Decisions $decisions Used to check previous decisions and to
* register decisions resulting from propagation
* @return Rule|null If a conflict is found the conflicting rule is returned
*/
public function propagateLiteral($decidedLiteral, $level, $decisions)
{
}
/**
* Moves a rule node from one watch chain to another
*
* The rule node's watched literals are updated accordingly.
*
* @param $fromLiteral mixed A literal the node used to watch
* @param $toLiteral mixed A literal the node should watch now
* @param $node mixed The rule node to be moved
*/
protected function moveWatch($fromLiteral, $toLiteral, $node)
{
}
}
/**
* @author Nils Adermann <naderman@naderman.de>
*/
class RuleSetIterator implements \Iterator
{
protected $rules;
protected $types;
protected $currentOffset;
protected $currentType;
protected $currentTypeOffset;
public function __construct(array $rules)
{
}
public function current()
{
}
public function key()
{
}
public function next()
{
}
public function rewind()
{
}
public function valid()
{
}
}
/**
* @author Nils Adermann <naderman@naderman.de>
*/
class Request
{
protected $jobs;
public function __construct()
{
}
public function install($packageName, \Composer\Semver\Constraint\ConstraintInterface $constraint = null)
{
}
public function update($packageName, \Composer\Semver\Constraint\ConstraintInterface $constraint = null)
{
}
public function remove($packageName, \Composer\Semver\Constraint\ConstraintInterface $constraint = null)
{
}
/**
* Mark an existing package as being installed and having to remain installed
*
* These jobs will not be tempered with by the solver
*
* @param string $packageName
* @param ConstraintInterface|null $constraint
*/
public function fix($packageName, \Composer\Semver\Constraint\ConstraintInterface $constraint = null)
{
}
protected function addJob($packageName, $cmd, \Composer\Semver\Constraint\ConstraintInterface $constraint = null, $fixed = false)
{
}
public function updateAll()
{
}
public function getJobs()
{
}
}
/**
* @author Nils Adermann <naderman@naderman.de>
*/
class RuleSetGenerator
{
protected $policy;
protected $pool;
protected $rules;
protected $jobs;
protected $installedMap;
protected $whitelistedMap;
protected $addedMap;
public function __construct(\Composer\DependencyResolver\PolicyInterface $policy, \Composer\DependencyResolver\Pool $pool)
{
}
/**
* Creates a new rule for the requirements of a package
*
* This rule is of the form (-A|B|C), where B and C are the providers of
* one requirement of the package A.
*
* @param PackageInterface $package The package with a requirement
* @param array $providers The providers of the requirement
* @param int $reason A RULE_* constant describing the
* reason for generating this rule
* @param mixed $reasonData Any data, e.g. the requirement name,
* that goes with the reason
* @return Rule The generated rule or null if tautological
*/
protected function createRequireRule(\Composer\Package\PackageInterface $package, array $providers, $reason, $reasonData = null)
{
}
/**
* Creates a rule to install at least one of a set of packages
*
* The rule is (A|B|C) with A, B and C different packages. If the given
* set of packages is empty an impossible rule is generated.
*
* @param array $packages The set of packages to choose from
* @param int $reason A RULE_* constant describing the reason for
* generating this rule
* @param array $job The job this rule was created from
* @return Rule The generated rule
*/
protected function createInstallOneOfRule(array $packages, $reason, $job)
{
}
/**
* Creates a rule to remove a package
*
* The rule for a package A is (-A).
*
* @param PackageInterface $package The package to be removed
* @param int $reason A RULE_* constant describing the
* reason for generating this rule
* @param array $job The job this rule was created from
* @return Rule The generated rule
*/
protected function createRemoveRule(\Composer\Package\PackageInterface $package, $reason, $job)
{
}
/**
* Creates a rule for two conflicting packages
*
* The rule for conflicting packages A and B is (-A|-B). A is called the issuer
* and B the provider.
*
* @param PackageInterface $issuer The package declaring the conflict
* @param PackageInterface $provider The package causing the conflict
* @param int $reason A RULE_* constant describing the
* reason for generating this rule
* @param mixed $reasonData Any data, e.g. the package name, that
* goes with the reason
* @return Rule The generated rule
*/
protected function createConflictRule(\Composer\Package\PackageInterface $issuer, \Composer\Package\PackageInterface $provider, $reason, $reasonData = null)
{
}
protected function whitelistFromPackage(\Composer\Package\PackageInterface $package)
{
}
protected function addRulesForPackage(\Composer\Package\PackageInterface $package, $ignorePlatformReqs)
{
}
protected function obsoleteImpossibleForAlias($package, $provider)
{
}
protected function whitelistFromJobs()
{
}
protected function addRulesForJobs($ignorePlatformReqs)
{
}
public function getRulesFor($jobs, $installedMap, $ignorePlatformReqs = false)
{
}
}
/**
* @author Nils Adermann <naderman@naderman.de>
*/
class Rule
{
// reason constants
const RULE_INTERNAL_ALLOW_UPDATE = 1;
const RULE_JOB_INSTALL = 2;
const RULE_JOB_REMOVE = 3;
const RULE_PACKAGE_CONFLICT = 6;
const RULE_PACKAGE_REQUIRES = 7;
const RULE_PACKAGE_OBSOLETES = 8;
const RULE_INSTALLED_PACKAGE_OBSOLETES = 9;
const RULE_PACKAGE_SAME_NAME = 10;
const RULE_PACKAGE_IMPLICIT_OBSOLETES = 11;
const RULE_LEARNED = 12;
const RULE_PACKAGE_ALIAS = 13;
// bitfield defs
const BITFIELD_TYPE = 0;
const BITFIELD_REASON = 8;
const BITFIELD_DISABLED = 16;
/**
* READ-ONLY: The literals this rule consists of.
* @var array
*/
public $literals;
protected $bitfield;
protected $reasonData;
/**
* @param array $literals
* @param int $reason A RULE_* constant describing the reason for generating this rule
* @param Link|PackageInterface $reasonData
* @param array $job The job this rule was created from
*/
public function __construct(array $literals, $reason, $reasonData, $job = null)
{
}
public function getHash()
{
}
public function getJob()
{
}
public function getReason()
{
}
public function getReasonData()
{
}
public function getRequiredPackage()
{
}
/**
* Checks if this rule is equal to another one
*
* Ignores whether either of the rules is disabled.
*
* @param Rule $rule The rule to check against
* @return bool Whether the rules are equal
*/
public function equals(\Composer\DependencyResolver\Rule $rule)
{
}
public function setType($type)
{
}
public function getType()
{
}
public function disable()
{
}
public function enable()
{
}
public function isDisabled()
{
}
public function isEnabled()
{
}
public function isAssertion()
{
}
public function getPrettyString(\Composer\DependencyResolver\Pool $pool, array $installedMap = array())
{
}
protected function formatPackagesUnique($pool, array $packages)
{
}
/**
* Formats a rule as a string of the format (Literal1|Literal2|...)
*
* @return string
*/
public function __toString()
{
}
}
/**
* @author Nils Adermann <naderman@naderman.de>
*/
class Transaction
{
protected $policy;
protected $pool;
protected $installedMap;
protected $decisions;
protected $transaction;
public function __construct($policy, $pool, $installedMap, $decisions)
{
}
public function getOperations()
{
}
protected function transactionFromMaps($installMap, $updateMap, $uninstallMap)
{
}
protected function findRootPackages($installMap, $updateMap)
{
}
protected function findUpdates()
{
}
protected function install($package, $reason)
{
}
protected function update($from, $to, $reason)
{
}
protected function uninstall($package, $reason)
{
}
protected function markAliasInstalled($package, $reason)
{
}
protected function markAliasUninstalled($package, $reason)
{
}
}
/**
* A package pool contains repositories that provide packages.
*
* @author Nils Adermann <naderman@naderman.de>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class Pool implements \Countable
{
const MATCH_NAME = -1;
const MATCH_NONE = 0;
const MATCH = 1;
const MATCH_PROVIDE = 2;
const MATCH_REPLACE = 3;
const MATCH_FILTERED = 4;
protected $repositories = array();
protected $providerRepos = array();
protected $packages = array();
protected $packageByName = array();
protected $packageByExactName = array();
protected $acceptableStabilities;
protected $stabilityFlags;
protected $versionParser;
protected $providerCache = array();
protected $filterRequires;
protected $whitelist = null;
protected $id = 1;
public function __construct($minimumStability = 'stable', array $stabilityFlags = array(), array $filterRequires = array())
{
}
public function setWhitelist($whitelist)
{
}
/**
* Adds a repository and its packages to this package pool
*
* @param RepositoryInterface $repo A package repository
* @param array $rootAliases
*/
public function addRepository(\Composer\Repository\RepositoryInterface $repo, $rootAliases = array())
{
}
public function getPriority(\Composer\Repository\RepositoryInterface $repo)
{
}
/**
* Retrieves the package object for a given package id.
*
* @param int $id
* @return PackageInterface
*/
public function packageById($id)
{
}
/**
* Returns how many packages have been loaded into the pool
*/
public function count()
{
}
/**
* Searches all packages providing the given package name and match the constraint
*
* @param string $name The package name to be searched for
* @param ConstraintInterface $constraint A constraint that all returned
* packages must match or null to return all
* @param bool $mustMatchName Whether the name of returned packages
* must match the given name
* @param bool $bypassFilters If enabled, filterRequires and stability matching is ignored
* @return PackageInterface[] A set of packages
*/
public function whatProvides($name, \Composer\Semver\Constraint\ConstraintInterface $constraint = null, $mustMatchName = false, $bypassFilters = false)
{
}
public function literalToPackage($literal)
{
}
public function literalToPrettyString($literal, $installedMap)
{
}
public function isPackageAcceptable($name, $stability)
{
}
}
/**
* Wrapper around a Rule which keeps track of the two literals it watches
*
* Used by RuleWatchGraph to store rules in two RuleWatchChains.
*
* @author Nils Adermann <naderman@naderman.de>
*/
class RuleWatchNode
{
public $watch1;
public $watch2;
protected $rule;
/**
* Creates a new node watching the first and second literals of the rule.
*
* @param Rule $rule The rule to wrap
*/
public function __construct($rule)
{
}
/**
* Places the second watch on the rule's literal, decided at the highest level
*
* Useful for learned rules where the literal for the highest rule is most
* likely to quickly lead to further decisions.
*
* @param Decisions $decisions The decisions made so far by the solver
*/
public function watch2OnHighest(\Composer\DependencyResolver\Decisions $decisions)
{
}
/**
* Returns the rule this node wraps
*
* @return Rule
*/
public function getRule()
{
}
/**
* Given one watched literal, this method returns the other watched literal
*
* @param int $literal The watched literal that should not be returned
* @return int A literal
*/
public function getOtherWatch($literal)
{
}
/**
* Moves a watch from one literal to another
*
* @param int $from The previously watched literal
* @param int $to The literal to be watched now
*/
public function moveWatch($from, $to)
{
}
}
/**
* Represents a problem detected while solving dependencies
*
* @author Nils Adermann <naderman@naderman.de>
*/
class Problem
{
/**
* A map containing the id of each rule part of this problem as a key
* @var array
*/
protected $reasonSeen;
/**
* A set of reasons for the problem, each is a rule or a job and a rule
* @var array
*/
protected $reasons = array();
protected $section = 0;
protected $pool;
public function __construct(\Composer\DependencyResolver\Pool $pool)
{
}
/**
* Add a rule as a reason
*
* @param Rule $rule A rule which is a reason for this problem
*/
public function addRule(\Composer\DependencyResolver\Rule $rule)
{
}
/**
* Retrieve all reasons for this problem
*
* @return array The problem's reasons
*/
public function getReasons()
{
}
/**
* A human readable textual representation of the problem's reasons
*
* @param array $installedMap A map of all installed packages
* @return string
*/
public function getPrettyString(array $installedMap = array())
{
}
/**
* Store a reason descriptor but ignore duplicates
*
* @param string $id A canonical identifier for the reason
* @param string $reason The reason descriptor
*/
protected function addReason($id, $reason)
{
}
public function nextSection()
{
}
/**
* Turns a job into a human readable description
*
* @param array $job
* @return string
*/
protected function jobToText($job)
{
}
protected function getPackageList($packages)
{
}
/**
* Turns a constraint into text usable in a sentence describing a job
*
* @param \Composer\Semver\Constraint\ConstraintInterface $constraint
* @return string
*/
protected function constraintToText($constraint)
{
}
}
}
namespace Composer\Config {
/**
* Configuration Source Interface
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Beau Simensen <beau@dflydev.com>
*/
interface ConfigSourceInterface
{
/**
* Add a repository
*
* @param string $name Name
* @param array $config Configuration
*/
public function addRepository($name, $config);
/**
* Remove a repository
*
* @param string $name
*/
public function removeRepository($name);
/**
* Add a config setting
*
* @param string $name Name
* @param string $value Value
*/
public function addConfigSetting($name, $value);
/**
* Remove a config setting
*
* @param string $name
*/
public function removeConfigSetting($name);
/**
* Add a package link
*
* @param string $type Type (require, require-dev, provide, suggest, replace, conflict)
* @param string $name Name
* @param string $value Value
*/
public function addLink($type, $name, $value);
/**
* Remove a package link
*
* @param string $type Type (require, require-dev, provide, suggest, replace, conflict)
* @param string $name Name
*/
public function removeLink($type, $name);
/**
* Gives a user-friendly name to this source (file path or so)
*
* @return string
*/
public function getName();
}
/**
* JSON Configuration Source
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Beau Simensen <beau@dflydev.com>
*/
class JsonConfigSource implements \Composer\Config\ConfigSourceInterface
{
/**
* Constructor
*
* @param JsonFile $file
* @param bool $authConfig
*/
public function __construct(\Composer\Json\JsonFile $file, $authConfig = false)
{
}
/**
* {@inheritdoc}
*/
public function getName()
{
}
/**
* {@inheritdoc}
*/
public function addRepository($name, $config)
{
}
/**
* {@inheritdoc}
*/
public function removeRepository($name)
{
}
/**
* {@inheritdoc}
*/
public function addConfigSetting($name, $value)
{
}
/**
* {@inheritdoc}
*/
public function removeConfigSetting($name)
{
}
/**
* {@inheritdoc}
*/
public function addLink($type, $name, $value)
{
}
/**
* {@inheritdoc}
*/
public function removeLink($type, $name)
{
}
protected function manipulateJson($method, $args, $fallback)
{
}
}
}
namespace Composer\EventDispatcher {
/**
* The Event Dispatcher.
*
* Example in command:
* $dispatcher = new EventDispatcher($this->getComposer(), $this->getApplication()->getIO());
* // ...
* $dispatcher->dispatch(ScriptEvents::POST_INSTALL_CMD);
* // ...
*
* @author François Pluchino <francois.pluchino@opendisplay.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Nils Adermann <naderman@naderman.de>
*/
class EventDispatcher
{
protected $composer;
protected $io;
protected $loader;
protected $process;
protected $listeners;
/**
* Constructor.
*
* @param Composer $composer The composer instance
* @param IOInterface $io The IOInterface instance
* @param ProcessExecutor $process
*/
public function __construct(\Composer\Composer $composer, \Composer\IO\IOInterface $io, \Composer\Util\ProcessExecutor $process = null)
{
}
/**
* Dispatch an event
*
* @param string $eventName An event name
* @param Event $event
* @return int return code of the executed script if any, for php scripts a false return
* value is changed to 1, anything else to 0
*/
public function dispatch($eventName, \Composer\EventDispatcher\Event $event = null)
{
}
/**
* Dispatch a script event.
*
* @param string $eventName The constant in ScriptEvents
* @param bool $devMode
* @param array $additionalArgs Arguments passed by the user
* @param array $flags Optional flags to pass data not as argument
* @return int return code of the executed script if any, for php scripts a false return
* value is changed to 1, anything else to 0
*/
public function dispatchScript($eventName, $devMode = false, $additionalArgs = array(), $flags = array())
{
}
/**
* Dispatch a package event.
*
* @param string $eventName The constant in PackageEvents
* @param bool $devMode Whether or not we are in dev mode
* @param PolicyInterface $policy The policy
* @param Pool $pool The pool
* @param CompositeRepository $installedRepo The installed repository
* @param Request $request The request
* @param array $operations The list of operations
* @param OperationInterface $operation The package being installed/updated/removed
*
* @return int return code of the executed script if any, for php scripts a false return
* value is changed to 1, anything else to 0
*/
public function dispatchPackageEvent($eventName, $devMode, \Composer\DependencyResolver\PolicyInterface $policy, \Composer\DependencyResolver\Pool $pool, \Composer\Repository\CompositeRepository $installedRepo, \Composer\DependencyResolver\Request $request, array $operations, \Composer\DependencyResolver\Operation\OperationInterface $operation)
{
}
/**
* Dispatch a installer event.
*
* @param string $eventName The constant in InstallerEvents
* @param bool $devMode Whether or not we are in dev mode
* @param PolicyInterface $policy The policy
* @param Pool $pool The pool
* @param CompositeRepository $installedRepo The installed repository
* @param Request $request The request
* @param array $operations The list of operations
*
* @return int return code of the executed script if any, for php scripts a false return
* value is changed to 1, anything else to 0
*/
public function dispatchInstallerEvent($eventName, $devMode, \Composer\DependencyResolver\PolicyInterface $policy, \Composer\DependencyResolver\Pool $pool, \Composer\Repository\CompositeRepository $installedRepo, \Composer\DependencyResolver\Request $request, array $operations = array())
{
}
/**
* Triggers the listeners of an event.
*
* @param Event $event The event object to pass to the event handlers/listeners.
* @throws \RuntimeException|\Exception
* @return int return code of the executed script if any, for php scripts a false return
* value is changed to 1, anything else to 0
*/
protected function doDispatch(\Composer\EventDispatcher\Event $event)
{
}
/**
* @param string $className
* @param string $methodName
* @param Event $event Event invoking the PHP callable
*/
protected function executeEventPhpScript($className, $methodName, \Composer\EventDispatcher\Event $event)
{
}
/**
* @param mixed $target
* @param Event $event
* @return Event|CommandEvent
*/
protected function checkListenerExpectedEvent($target, \Composer\EventDispatcher\Event $event)
{
}
/**
* Add a listener for a particular event
*
* @param string $eventName The event name - typically a constant
* @param Callable $listener A callable expecting an event argument
* @param int $priority A higher value represents a higher priority
*/
public function addListener($eventName, $listener, $priority = 0)
{
}
/**
* Adds object methods as listeners for the events in getSubscribedEvents
*
* @see EventSubscriberInterface
*
* @param EventSubscriberInterface $subscriber
*/
public function addSubscriber(\Composer\EventDispatcher\EventSubscriberInterface $subscriber)
{
}
/**
* Retrieves all listeners for a given event
*
* @param Event $event
* @return array All listeners: callables and scripts
*/
protected function getListeners(\Composer\EventDispatcher\Event $event)
{
}
/**
* Checks if an event has listeners registered
*
* @param Event $event
* @return bool
*/
public function hasEventListeners(\Composer\EventDispatcher\Event $event)
{
}
/**
* Finds all listeners defined as scripts in the package
*
* @param Event $event Event object
* @return array Listeners
*/
protected function getScriptListeners(\Composer\EventDispatcher\Event $event)
{
}
/**
* Checks if string given references a class path and method
*
* @param string $callable
* @return bool
*/
protected function isPhpScript($callable)
{
}
/**
* Checks if string given references a composer run-script
*
* @param string $callable
* @return bool
*/
protected function isComposerScript($callable)
{
}
/**
* Push an event to the stack of active event
*
* @param Event $event
* @throws \RuntimeException
* @return number
*/
protected function pushEvent(\Composer\EventDispatcher\Event $event)
{
}
/**
* Pops the active event from the stack
*
* @return mixed
*/
protected function popEvent()
{
}
}
/**
* An EventSubscriber knows which events it is interested in.
*
* If an EventSubscriber is added to an EventDispatcher, the manager invokes
* {@link getSubscribedEvents} and registers the subscriber as a listener for all
* returned events.
*
* @author Guilherme Blanco <guilhermeblanco@hotmail.com>
* @author Jonathan Wage <jonwage@gmail.com>
* @author Roman Borschel <roman@code-factory.org>
* @author Bernhard Schussek <bschussek@gmail.com>
*/
interface EventSubscriberInterface
{
/**
* Returns an array of event names this subscriber wants to listen to.
*
* The array keys are event names and the value can be:
*
* * The method name to call (priority defaults to 0)
* * An array composed of the method name to call and the priority
* * An array of arrays composed of the method names to call and respective
* priorities, or 0 if unset
*
* For instance:
*
* * array('eventName' => 'methodName')
* * array('eventName' => array('methodName', $priority))
* * array('eventName' => array(array('methodName1', $priority), array('methodName2'))
*
* @return array The event names to listen to
*/
public static function getSubscribedEvents();
}
}
namespace Composer\Json {
/**
* Formats json strings used for php < 5.4 because the json_encode doesn't
* supports the flags JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE
* in these versions
*
* @author Konstantin Kudryashiv <ever.zet@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class JsonFormatter
{
/**
* This code is based on the function found at:
* http://recursive-design.com/blog/2008/03/11/format-json-with-php/
*
* Originally licensed under MIT by Dave Perrett <mail@recursive-design.com>
*
*
* @param string $json
* @param bool $unescapeUnicode Un escape unicode
* @param bool $unescapeSlashes Un escape slashes
* @return string
*/
public static function format($json, $unescapeUnicode, $unescapeSlashes)
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class JsonValidationException extends \Exception
{
protected $errors;
public function __construct($message, $errors = array(), \Exception $previous = null)
{
}
public function getErrors()
{
}
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class JsonManipulator
{
public function __construct($contents)
{
}
public function getContents()
{
}
public function addLink($type, $package, $constraint, $sortPackages = false)
{
}
public function addRepository($name, $config)
{
}
public function removeRepository($name)
{
}
public function addConfigSetting($name, $value)
{
}
public function removeConfigSetting($name)
{
}
public function addSubNode($mainNode, $name, $value)
{
}
public function removeSubNode($mainNode, $name)
{
}
public function addMainKey($key, $content)
{
}
public function format($data, $depth = 0)
{
}
protected function detectIndenting()
{
}
protected function pregMatch($re, $str, &$matches = array())
{
}
}
/**
* Reads/writes json files.
*
* @author Konstantin Kudryashiv <ever.zet@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class JsonFile
{
const LAX_SCHEMA = 1;
const STRICT_SCHEMA = 2;
const JSON_UNESCAPED_SLASHES = 64;
const JSON_PRETTY_PRINT = 128;
const JSON_UNESCAPED_UNICODE = 256;
/**
* Initializes json file reader/parser.
*
* @param string $path path to a lockfile
* @param RemoteFilesystem $rfs required for loading http/https json files
* @param IOInterface $io
* @throws \InvalidArgumentException
*/
public function __construct($path, \Composer\Util\RemoteFilesystem $rfs = null, \Composer\IO\IOInterface $io = null)
{
}
/**
* @return string
*/
public function getPath()
{
}
/**
* Checks whether json file exists.
*
* @return bool
*/
public function exists()
{
}
/**
* Reads json file.
*
* @throws \RuntimeException
* @return mixed
*/
public function read()
{
}
/**
* Writes json file.
*
* @param array $hash writes hash into json file
* @param int $options json_encode options (defaults to JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)
* @throws \UnexpectedValueException|\Exception
*/
public function write(array $hash, $options = 448)
{
}
/**
* Validates the schema of the current json file according to composer-schema.json rules
*
* @param int $schema a JsonFile::*_SCHEMA constant
* @throws JsonValidationException
* @return bool true on success
*/
public function validateSchema($schema = self::STRICT_SCHEMA)
{
}
/**
* Encodes an array into (optionally pretty-printed) JSON
*
* @param mixed $data Data to encode into a formatted JSON string
* @param int $options json_encode options (defaults to JSON_UNESCAPED_SLASHES | JSON_PRETTY_PRINT | JSON_UNESCAPED_UNICODE)
* @return string Encoded json
*/
public static function encode($data, $options = 448)
{
}
/**
* Parses json string and returns hash.
*
* @param string $json json string
* @param string $file the json file
*
* @return mixed
*/
public static function parseJson($json, $file = null)
{
}
/**
* Validates the syntax of a JSON string
*
* @param string $json
* @param string $file
* @throws \UnexpectedValueException
* @throws JsonValidationException
* @throws ParsingException
* @return bool true on success
*/
protected static function validateSyntax($json, $file = null)
{
}
}
}
namespace Composer\Installer {
/**
* Interface for the package installation manager.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
interface InstallerInterface
{
/**
* Decides if the installer supports the given type
*
* @param string $packageType
* @return bool
*/
public function supports($packageType);
/**
* Checks that provided package is installed.
*
* @param InstalledRepositoryInterface $repo repository in which to check
* @param PackageInterface $package package instance
*
* @return bool
*/
public function isInstalled(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package);
/**
* Installs specific package.
*
* @param InstalledRepositoryInterface $repo repository in which to check
* @param PackageInterface $package package instance
*/
public function install(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package);
/**
* Updates specific package.
*
* @param InstalledRepositoryInterface $repo repository in which to check
* @param PackageInterface $initial already installed package version
* @param PackageInterface $target updated version
*
* @throws InvalidArgumentException if $initial package is not installed
*/
public function update(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target);
/**
* Uninstalls specific package.
*
* @param InstalledRepositoryInterface $repo repository in which to check
* @param PackageInterface $package package instance
*/
public function uninstall(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package);
/**
* Returns the installation path of a package
*
* @param PackageInterface $package
* @return string path
*/
public function getInstallPath(\Composer\Package\PackageInterface $package);
}
/**
* Metapackage installation manager.
*
* @author Martin Hasoň <martin.hason@gmail.com>
*/
class MetapackageInstaller implements \Composer\Installer\InstallerInterface
{
/**
* {@inheritDoc}
*/
public function supports($packageType)
{
}
/**
* {@inheritDoc}
*/
public function isInstalled(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function install(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function update(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target)
{
}
/**
* {@inheritDoc}
*/
public function uninstall(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function getInstallPath(\Composer\Package\PackageInterface $package)
{
}
}
/**
* Package operation manager.
*
* @author Konstantin Kudryashov <ever.zet@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Nils Adermann <naderman@naderman.de>
*/
class InstallationManager
{
public function reset()
{
}
/**
* Adds installer
*
* @param InstallerInterface $installer installer instance
*/
public function addInstaller(\Composer\Installer\InstallerInterface $installer)
{
}
/**
* Removes installer
*
* @param InstallerInterface $installer installer instance
*/
public function removeInstaller(\Composer\Installer\InstallerInterface $installer)
{
}
/**
* Disables plugins.
*
* We prevent any plugins from being instantiated by simply
* deactivating the installer for them. This ensure that no third-party
* code is ever executed.
*/
public function disablePlugins()
{
}
/**
* Returns installer for a specific package type.
*
* @param string $type package type
*
* @throws \InvalidArgumentException if installer for provided type is not registered
* @return InstallerInterface
*/
public function getInstaller($type)
{
}
/**
* Checks whether provided package is installed in one of the registered installers.
*
* @param InstalledRepositoryInterface $repo repository in which to check
* @param PackageInterface $package package instance
*
* @return bool
*/
public function isPackageInstalled(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* Executes solver operation.
*
* @param RepositoryInterface $repo repository in which to check
* @param OperationInterface $operation operation instance
*/
public function execute(\Composer\Repository\RepositoryInterface $repo, \Composer\DependencyResolver\Operation\OperationInterface $operation)
{
}
/**
* Executes install operation.
*
* @param RepositoryInterface $repo repository in which to check
* @param InstallOperation $operation operation instance
*/
public function install(\Composer\Repository\RepositoryInterface $repo, \Composer\DependencyResolver\Operation\InstallOperation $operation)
{
}
/**
* Executes update operation.
*
* @param RepositoryInterface $repo repository in which to check
* @param UpdateOperation $operation operation instance
*/
public function update(\Composer\Repository\RepositoryInterface $repo, \Composer\DependencyResolver\Operation\UpdateOperation $operation)
{
}
/**
* Uninstalls package.
*
* @param RepositoryInterface $repo repository in which to check
* @param UninstallOperation $operation operation instance
*/
public function uninstall(\Composer\Repository\RepositoryInterface $repo, \Composer\DependencyResolver\Operation\UninstallOperation $operation)
{
}
/**
* Executes markAliasInstalled operation.
*
* @param RepositoryInterface $repo repository in which to check
* @param MarkAliasInstalledOperation $operation operation instance
*/
public function markAliasInstalled(\Composer\Repository\RepositoryInterface $repo, \Composer\DependencyResolver\Operation\MarkAliasInstalledOperation $operation)
{
}
/**
* Executes markAlias operation.
*
* @param RepositoryInterface $repo repository in which to check
* @param MarkAliasUninstalledOperation $operation operation instance
*/
public function markAliasUninstalled(\Composer\Repository\RepositoryInterface $repo, \Composer\DependencyResolver\Operation\MarkAliasUninstalledOperation $operation)
{
}
/**
* Returns the installation path of a package
*
* @param PackageInterface $package
* @return string path
*/
public function getInstallPath(\Composer\Package\PackageInterface $package)
{
}
public function notifyInstalls(\Composer\IO\IOInterface $io)
{
}
}
/**
* The Installer Events.
*
* @author François Pluchino <francois.pluchino@gmail.com>
*/
class InstallerEvents
{
/**
* The PRE_DEPENDENCIES_SOLVING event occurs as a installer begins
* resolve operations.
*
* The event listener method receives a
* Composer\Installer\InstallerEvent instance.
*
* @var string
*/
const PRE_DEPENDENCIES_SOLVING = 'pre-dependencies-solving';
/**
* The POST_DEPENDENCIES_SOLVING event occurs as a installer after
* resolve operations.
*
* The event listener method receives a
* Composer\Installer\InstallerEvent instance.
*
* @var string
*/
const POST_DEPENDENCIES_SOLVING = 'post-dependencies-solving';
}
/**
* Utility to handle installation of package "bin"/binaries
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Konstantin Kudryashov <ever.zet@gmail.com>
* @author Helmut Hummel <info@helhum.io>
*/
class BinaryInstaller
{
protected $binDir;
protected $binCompat;
protected $io;
protected $filesystem;
/**
* @param IOInterface $io
* @param string $binDir
* @param string $binCompat
* @param Filesystem $filesystem
*/
public function __construct(\Composer\IO\IOInterface $io, $binDir, $binCompat, \Composer\Util\Filesystem $filesystem = null)
{
}
public function installBinaries(\Composer\Package\PackageInterface $package, $installPath)
{
}
public function removeBinaries(\Composer\Package\PackageInterface $package)
{
}
protected function getBinaries(\Composer\Package\PackageInterface $package)
{
}
protected function installFullBinaries($binPath, $link, $bin, \Composer\Package\PackageInterface $package)
{
}
protected function installSymlinkBinaries($binPath, $link)
{
}
protected function installUnixyProxyBinaries($binPath, $link)
{
}
protected function initializeBinDir()
{
}
protected function generateWindowsProxyCode($bin, $link)
{
}
protected function generateUnixyProxyCode($bin, $link)
{
}
}
/**
* Utility to handle installation of package "bin"/binaries for PEAR packages
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class PearBinaryInstaller extends \Composer\Installer\BinaryInstaller
{
/**
* @param IOInterface $io
* @param string $binDir
* @param string $vendorDir
* @param string $binCompat
* @param Filesystem $filesystem
* @param PearInstaller $installer
*/
public function __construct(\Composer\IO\IOInterface $io, $binDir, $vendorDir, $binCompat, \Composer\Util\Filesystem $filesystem, \Composer\Installer\PearInstaller $installer)
{
}
protected function getBinaries(\Composer\Package\PackageInterface $package)
{
}
protected function initializeBinDir()
{
}
protected function generateWindowsProxyCode($bin, $link)
{
}
}
/**
* Package Events.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class PackageEvents
{
/**
* The PRE_PACKAGE_INSTALL event occurs before a package is installed.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @var string
*/
const PRE_PACKAGE_INSTALL = 'pre-package-install';
/**
* The POST_PACKAGE_INSTALL event occurs after a package is installed.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @var string
*/
const POST_PACKAGE_INSTALL = 'post-package-install';
/**
* The PRE_PACKAGE_UPDATE event occurs before a package is updated.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @var string
*/
const PRE_PACKAGE_UPDATE = 'pre-package-update';
/**
* The POST_PACKAGE_UPDATE event occurs after a package is updated.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @var string
*/
const POST_PACKAGE_UPDATE = 'post-package-update';
/**
* The PRE_PACKAGE_UNINSTALL event occurs before a package has been uninstalled.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @var string
*/
const PRE_PACKAGE_UNINSTALL = 'pre-package-uninstall';
/**
* The POST_PACKAGE_UNINSTALL event occurs after a package has been uninstalled.
*
* The event listener method receives a Composer\Script\PackageEvent instance.
*
* @var string
*/
const POST_PACKAGE_UNINSTALL = 'post-package-uninstall';
}
/**
* Package installation manager.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
class LibraryInstaller implements \Composer\Installer\InstallerInterface
{
protected $composer;
protected $vendorDir;
protected $binDir;
protected $downloadManager;
protected $io;
protected $type;
protected $filesystem;
protected $binCompat;
protected $binaryInstaller;
/**
* Initializes library installer.
*
* @param IOInterface $io
* @param Composer $composer
* @param string $type
* @param Filesystem $filesystem
* @param BinaryInstaller $binaryInstaller
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Composer $composer, $type = 'library', \Composer\Util\Filesystem $filesystem = null, \Composer\Installer\BinaryInstaller $binaryInstaller = null)
{
}
/**
* {@inheritDoc}
*/
public function supports($packageType)
{
}
/**
* {@inheritDoc}
*/
public function isInstalled(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function install(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function update(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target)
{
}
/**
* {@inheritDoc}
*/
public function uninstall(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function getInstallPath(\Composer\Package\PackageInterface $package)
{
}
/**
* Returns the base path of the package without target-dir path
*
* It is used for BC as getInstallPath tends to be overridden by
* installer plugins but not getPackageBasePath
*
* @param PackageInterface $package
* @return string
*/
protected function getPackageBasePath(\Composer\Package\PackageInterface $package)
{
}
protected function installCode(\Composer\Package\PackageInterface $package)
{
}
protected function updateCode(\Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target)
{
}
protected function removeCode(\Composer\Package\PackageInterface $package)
{
}
protected function initializeVendorDir()
{
}
}
/**
* Add suggested packages from different places to output them in the end.
*
* @author Haralan Dobrev <hkdobrev@gmail.com>
*/
class SuggestedPackagesReporter
{
/**
* @var array
*/
protected $suggestedPackages = array();
public function __construct(\Composer\IO\IOInterface $io)
{
}
/**
* @return array Suggested packages with source, target and reason keys.
*/
public function getPackages()
{
}
/**
* Add suggested packages to be listed after install
*
* Could be used to add suggested packages both from the installer
* or from CreateProjectCommand.
*
* @param string $source Source package which made the suggestion
* @param string $target Target package to be suggested
* @param string $reason Reason the target package to be suggested
* @return SuggestedPackagesReporter
*/
public function addPackage($source, $target, $reason)
{
}
/**
* Add all suggestions from a package.
*
* @param PackageInterface $package
* @return SuggestedPackagesReporter
*/
public function addSuggestionsFromPackage(\Composer\Package\PackageInterface $package)
{
}
/**
* Output suggested packages.
* Do not list the ones already installed if installed repository provided.
*
* @param RepositoryInterface $installedRepo Installed packages
* @return SuggestedPackagesReporter
*/
public function output(\Composer\Repository\RepositoryInterface $installedRepo = null)
{
}
}
/**
* Does not install anything but marks packages installed in the repo
*
* Useful for dry runs
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class NoopInstaller implements \Composer\Installer\InstallerInterface
{
/**
* {@inheritDoc}
*/
public function supports($packageType)
{
}
/**
* {@inheritDoc}
*/
public function isInstalled(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function install(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function update(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target)
{
}
/**
* {@inheritDoc}
*/
public function uninstall(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function getInstallPath(\Composer\Package\PackageInterface $package)
{
}
}
/**
* Project Installer is used to install a single package into a directory as
* root project.
*
* @author Benjamin Eberlei <kontakt@beberlei.de>
*/
class ProjectInstaller implements \Composer\Installer\InstallerInterface
{
public function __construct($installPath, \Composer\Downloader\DownloadManager $dm)
{
}
/**
* Decides if the installer supports the given type
*
* @param string $packageType
* @return bool
*/
public function supports($packageType)
{
}
/**
* {@inheritDoc}
*/
public function isInstalled(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function install(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function update(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target)
{
}
/**
* {@inheritDoc}
*/
public function uninstall(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* Returns the installation path of a package
*
* @param PackageInterface $package
* @return string path
*/
public function getInstallPath(\Composer\Package\PackageInterface $package)
{
}
}
/**
* Package installation manager.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Konstantin Kudryashov <ever.zet@gmail.com>
*/
class PearInstaller extends \Composer\Installer\LibraryInstaller
{
/**
* Initializes library installer.
*
* @param IOInterface $io io instance
* @param Composer $composer
* @param string $type package type that this installer handles
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Composer $composer, $type = 'pear-library')
{
}
/**
* {@inheritDoc}
*/
public function update(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target)
{
}
protected function installCode(\Composer\Package\PackageInterface $package)
{
}
}
/**
* Installer for plugin packages
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Nils Adermann <naderman@naderman.de>
*/
class PluginInstaller extends \Composer\Installer\LibraryInstaller
{
/**
* Initializes Plugin installer.
*
* @param IOInterface $io
* @param Composer $composer
* @param string $type
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Composer $composer, $type = 'library')
{
}
/**
* {@inheritDoc}
*/
public function supports($packageType)
{
}
/**
* {@inheritDoc}
*/
public function install(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $package)
{
}
/**
* {@inheritDoc}
*/
public function update(\Composer\Repository\InstalledRepositoryInterface $repo, \Composer\Package\PackageInterface $initial, \Composer\Package\PackageInterface $target)
{
}
}
}
namespace Composer {
/**
* Reads/writes to a filesystem cache
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class Cache
{
/**
* @param IOInterface $io
* @param string $cacheDir location of the cache
* @param string $whitelist List of characters that are allowed in path names (used in a regex character class)
* @param Filesystem $filesystem optional filesystem instance
*/
public function __construct(\Composer\IO\IOInterface $io, $cacheDir, $whitelist = 'a-z0-9.', \Composer\Util\Filesystem $filesystem = null)
{
}
public function isEnabled()
{
}
public function getRoot()
{
}
public function read($file)
{
}
public function write($file, $contents)
{
}
/**
* Copy a file into the cache
*/
public function copyFrom($file, $source)
{
}
/**
* Copy a file out of the cache
*/
public function copyTo($file, $target)
{
}
public function gcIsNecessary()
{
}
public function remove($file)
{
}
public function gc($ttl, $maxSize)
{
}
public function sha1($file)
{
}
public function sha256($file)
{
}
protected function getFinder()
{
}
}
}
namespace Composer\Package {
/**
* Defines the essential information a package has that is used during solving/installation
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
interface PackageInterface
{
/**
* Returns the package's name without version info, thus not a unique identifier
*
* @return string package name
*/
public function getName();
/**
* Returns the package's pretty (i.e. with proper case) name
*
* @return string package name
*/
public function getPrettyName();
/**
* Returns a set of names that could refer to this package
*
* No version or release type information should be included in any of the
* names. Provided or replaced package names need to be returned as well.
*
* @return array An array of strings referring to this package
*/
public function getNames();
/**
* Allows the solver to set an id for this package to refer to it.
*
* @param int $id
*/
public function setId($id);
/**
* Retrieves the package's id set through setId
*
* @return int The previously set package id
*/
public function getId();
/**
* Returns whether the package is a development virtual package or a concrete one
*
* @return bool
*/
public function isDev();
/**
* Returns the package type, e.g. library
*
* @return string The package type
*/
public function getType();
/**
* Returns the package targetDir property
*
* @return string The package targetDir
*/
public function getTargetDir();
/**
* Returns the package extra data
*
* @return array The package extra data
*/
public function getExtra();
/**
* Sets source from which this package was installed (source/dist).
*
* @param string $type source/dist
*/
public function setInstallationSource($type);
/**
* Returns source from which this package was installed (source/dist).
*
* @return string source/dist
*/
public function getInstallationSource();
/**
* Returns the repository type of this package, e.g. git, svn
*
* @return string The repository type
*/
public function getSourceType();
/**
* Returns the repository url of this package, e.g. git://github.com/naderman/composer.git
*
* @return string The repository url
*/
public function getSourceUrl();
/**
* Returns the repository urls of this package including mirrors, e.g. git://github.com/naderman/composer.git
*
* @return array
*/
public function getSourceUrls();
/**
* Returns the repository reference of this package, e.g. master, 1.0.0 or a commit hash for git
*
* @return string The repository reference
*/
public function getSourceReference();
/**
* Returns the source mirrors of this package
*
* @return array|null
*/
public function getSourceMirrors();
/**
* Returns the type of the distribution archive of this version, e.g. zip, tarball
*
* @return string The repository type
*/
public function getDistType();
/**
* Returns the url of the distribution archive of this version
*
* @return string
*/
public function getDistUrl();
/**
* Returns the urls of the distribution archive of this version, including mirrors
*
* @return array
*/
public function getDistUrls();
/**
* Returns the reference of the distribution archive of this version, e.g. master, 1.0.0 or a commit hash for git
*
* @return string
*/
public function getDistReference();
/**
* Returns the sha1 checksum for the distribution archive of this version
*
* @return string
*/
public function getDistSha1Checksum();
/**
* Returns the dist mirrors of this package
*
* @return array|null
*/
public function getDistMirrors();
/**
* Returns the version of this package
*
* @return string version
*/
public function getVersion();
/**
* Returns the pretty (i.e. non-normalized) version string of this package
*
* @return string version
*/
public function getPrettyVersion();
/**
* Returns the pretty version string plus a git or hg commit hash of this package
*
* @see getPrettyVersion
*
* @param bool $truncate If the source reference is a sha1 hash, truncate it
* @return string version
*/
public function getFullPrettyVersion($truncate = true);
/**
* Returns the release date of the package
*
* @return \DateTime
*/
public function getReleaseDate();
/**
* Returns the stability of this package: one of (dev, alpha, beta, RC, stable)
*
* @return string
*/
public function getStability();
/**
* Returns a set of links to packages which need to be installed before
* this package can be installed
*
* @return Link[] An array of package links defining required packages
*/
public function getRequires();
/**
* Returns a set of links to packages which must not be installed at the
* same time as this package
*
* @return Link[] An array of package links defining conflicting packages
*/
public function getConflicts();
/**
* Returns a set of links to virtual packages that are provided through
* this package
*
* @return Link[] An array of package links defining provided packages
*/
public function getProvides();
/**
* Returns a set of links to packages which can alternatively be
* satisfied by installing this package
*
* @return Link[] An array of package links defining replaced packages
*/
public function getReplaces();
/**
* Returns a set of links to packages which are required to develop
* this package. These are installed if in dev mode.
*
* @return Link[] An array of package links defining packages required for development
*/
public function getDevRequires();
/**
* Returns a set of package names and reasons why they are useful in
* combination with this package.
*
* @return array An array of package suggestions with descriptions
*/
public function getSuggests();
/**
* Returns an associative array of autoloading rules
*
* {"<type>": {"<namespace": "<directory>"}}
*
* Type is either "psr-4", "psr-0", "classmap" or "files". Namespaces are mapped to
* directories for autoloading using the type specified.
*
* @return array Mapping of autoloading rules
*/
public function getAutoload();
/**
* Returns an associative array of dev autoloading rules
*
* {"<type>": {"<namespace": "<directory>"}}
*
* Type is either "psr-4", "psr-0", "classmap" or "files". Namespaces are mapped to
* directories for autoloading using the type specified.
*
* @return array Mapping of dev autoloading rules
*/
public function getDevAutoload();
/**
* Returns a list of directories which should get added to PHP's
* include path.
*
* @return array
*/
public function getIncludePaths();
/**
* Stores a reference to the repository that owns the package
*
* @param RepositoryInterface $repository
*/
public function setRepository(\Composer\Repository\RepositoryInterface $repository);
/**
* Returns a reference to the repository that owns the package
*
* @return RepositoryInterface
*/
public function getRepository();
/**
* Returns the package binaries
*
* @return array
*/
public function getBinaries();
/**
* Returns package unique name, constructed from name and version.
*
* @return string
*/
public function getUniqueName();
/**
* Returns the package notification url
*
* @return string
*/
public function getNotificationUrl();
/**
* Converts the package into a readable and unique string
*
* @return string
*/
public function __toString();
/**
* Converts the package into a pretty readable string
*
* @return string
*/
public function getPrettyString();
/**
* Returns a list of patterns to exclude from package archives
*
* @return array
*/
public function getArchiveExcludes();
/**
* Returns a list of options to download package dist files
*
* @return array
*/
public function getTransportOptions();
}
/**
* Defines package metadata that is not necessarily needed for solving and installing packages
*
* @author Nils Adermann <naderman@naderman.de>
*/
interface CompletePackageInterface extends \Composer\Package\PackageInterface
{
/**
* Returns the scripts of this package
*
* @return array array('script name' => array('listeners'))
*/
public function getScripts();
/**
* Returns an array of repositories
*
* {"<type>": {<config key/values>}}
*
* @return array Repositories
*/
public function getRepositories();
/**
* Returns the package license, e.g. MIT, BSD, GPL
*
* @return array The package licenses
*/
public function getLicense();
/**
* Returns an array of keywords relating to the package
*
* @return array
*/
public function getKeywords();
/**
* Returns the package description
*
* @return string
*/
public function getDescription();
/**
* Returns the package homepage
*
* @return string
*/
public function getHomepage();
/**
* Returns an array of authors of the package
*
* Each item can contain name/homepage/email keys
*
* @return array
*/
public function getAuthors();
/**
* Returns the support information
*
* @return array
*/
public function getSupport();
/**
* Returns if the package is abandoned or not
*
* @return bool
*/
public function isAbandoned();
/**
* If the package is abandoned and has a suggested replacement, this method returns it
*
* @return string
*/
public function getReplacementPackage();
}
/**
* Defines additional fields that are only needed for the root package
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
interface RootPackageInterface extends \Composer\Package\CompletePackageInterface
{
/**
* Returns a set of package names and their aliases
*
* @return array
*/
public function getAliases();
/**
* Returns the minimum stability of the package
*
* @return string
*/
public function getMinimumStability();
/**
* Returns the stability flags to apply to dependencies
*
* array('foo/bar' => 'dev')
*
* @return array
*/
public function getStabilityFlags();
/**
* Returns a set of package names and source references that must be enforced on them
*
* array('foo/bar' => 'abcd1234')
*
* @return array
*/
public function getReferences();
/**
* Returns true if the root package prefers picking stable packages over unstable ones
*
* @return bool
*/
public function getPreferStable();
/**
* Set the required packages
*
* @param Link[] $requires A set of package links
*/
public function setRequires(array $requires);
/**
* Set the recommended packages
*
* @param Link[] $devRequires A set of package links
*/
public function setDevRequires(array $devRequires);
/**
* Set the conflicting packages
*
* @param Link[] $conflicts A set of package links
*/
public function setConflicts(array $conflicts);
/**
* Set the provided virtual packages
*
* @param Link[] $provides A set of package links
*/
public function setProvides(array $provides);
/**
* Set the packages this one replaces
*
* @param Link[] $replaces A set of package links
*/
public function setReplaces(array $replaces);
/**
* Set the repositories
*
* @param array $repositories
*/
public function setRepositories($repositories);
/**
* Set the autoload mapping
*
* @param array $autoload Mapping of autoloading rules
*/
public function setAutoload(array $autoload);
/**
* Set the dev autoload mapping
*
* @param array $devAutoload Mapping of dev autoloading rules
*/
public function setDevAutoload(array $devAutoload);
/**
* Set the stabilityFlags
*
* @param array $stabilityFlags
*/
public function setStabilityFlags(array $stabilityFlags);
/**
* Set the suggested packages
*
* @param array $suggests A set of package names/comments
*/
public function setSuggests(array $suggests);
/**
* @param array $extra
*/
public function setExtra(array $extra);
}
}
namespace Composer\Package\LinkConstraint {
/**
* @deprecated use Composer\Semver\Constraint\ConstraintInterface instead
*/
interface LinkConstraintInterface extends \Composer\Semver\Constraint\ConstraintInterface
{
}
/**
* @deprecated use Composer\Semver\Constraint\Constraint instead
*/
class VersionConstraint extends \Composer\Semver\Constraint\Constraint implements \Composer\Package\LinkConstraint\LinkConstraintInterface
{
}
/**
* @deprecated use Composer\Semver\Constraint\AbstractConstraint instead
*/
abstract class SpecificConstraint extends \Composer\Semver\Constraint\AbstractConstraint implements \Composer\Package\LinkConstraint\LinkConstraintInterface
{
}
/**
* @deprecated use Composer\Semver\Constraint\MultiConstraint instead
*/
class MultiConstraint extends \Composer\Semver\Constraint\MultiConstraint implements \Composer\Package\LinkConstraint\LinkConstraintInterface
{
}
/**
* @deprecated use Composer\Semver\Constraint\EmptyConstraint instead
*/
class EmptyConstraint extends \Composer\Semver\Constraint\EmptyConstraint implements \Composer\Package\LinkConstraint\LinkConstraintInterface
{
}
}
namespace Composer\Package\Version {
/**
* Selects the best possible version for a package
*
* @author Ryan Weaver <ryan@knpuniversity.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class VersionSelector
{
public function __construct(\Composer\DependencyResolver\Pool $pool)
{
}
/**
* Given a package name and optional version, returns the latest PackageInterface
* that matches.
*
* @param string $packageName
* @param string $targetPackageVersion
* @param string $targetPhpVersion
* @param string $preferredStability
* @return PackageInterface|bool
*/
public function findBestCandidate($packageName, $targetPackageVersion = null, $targetPhpVersion = null, $preferredStability = 'stable')
{
}
/**
* Given a concrete version, this returns a ~ constraint (when possible)
* that should be used, for example, in composer.json.
*
* For example:
* * 1.2.1 -> ^1.2
* * 1.2 -> ^1.2
* * v3.2.1 -> ^3.2
* * 2.0-beta.1 -> ^2.0@beta
* * dev-master -> ^2.1@dev (dev version with alias)
* * dev-master -> dev-master (dev versions are untouched)
*
* @param PackageInterface $package
* @return string
*/
public function findRecommendedRequireVersion(\Composer\Package\PackageInterface $package)
{
}
}
class VersionParser extends \Composer\Semver\VersionParser
{
/**
* {@inheritDoc}
*/
public function parseConstraints($constraints)
{
}
/**
* Parses an array of strings representing package/version pairs.
*
* The parsing results in an array of arrays, each of which
* contain a 'name' key with value and optionally a 'version' key with value.
*
* @param array $pairs a set of package/version pairs separated by ":", "=" or " "
*
* @return array[] array of arrays containing a name and (if provided) a version
*/
public function parseNameVersionPairs(array $pairs)
{
}
}
/**
* Try to guess the current version number based on different VCS configuration.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Samuel Roze <samuel.roze@gmail.com>
*/
class VersionGuesser
{
/**
* @param Config $config
* @param ProcessExecutor $process
* @param SemverVersionParser $versionParser
*/
public function __construct(\Composer\Config $config, \Composer\Util\ProcessExecutor $process, \Composer\Semver\VersionParser $versionParser)
{
}
/**
* @param array $packageConfig
* @param string $path Path to guess into
*
* @return array versionData, 'version' and 'commit' keys
*/
public function guessVersion(array $packageConfig, $path)
{
}
}
}
namespace Composer\Package\Dumper {
/**
* @author Konstantin Kudryashiv <ever.zet@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ArrayDumper
{
public function dump(\Composer\Package\PackageInterface $package)
{
}
}
}
namespace Composer\Package {
/**
* Reads/writes project lockfile (composer.lock).
*
* @author Konstantin Kudryashiv <ever.zet@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class Locker
{
/**
* Initializes packages locker.
*
* @param IOInterface $io
* @param JsonFile $lockFile lockfile loader
* @param RepositoryManager $repositoryManager repository manager instance
* @param InstallationManager $installationManager installation manager instance
* @param string $composerFileContents The contents of the composer file
*/
public function __construct(\Composer\IO\IOInterface $io, \Composer\Json\JsonFile $lockFile, \Composer\Repository\RepositoryManager $repositoryManager, \Composer\Installer\InstallationManager $installationManager, $composerFileContents)
{
}
/**
* Returns the md5 hash of the sorted content of the composer file.
*
* @param string $composerFileContents The contents of the composer file.
*
* @return string
*/
public static function getContentHash($composerFileContents)
{
}
/**
* Checks whether locker were been locked (lockfile found).
*
* @return bool
*/
public function isLocked()
{
}
/**
* Checks whether the lock file is still up to date with the current hash
*
* @return bool
*/
public function isFresh()
{
}
/**
* Searches and returns an array of locked packages, retrieved from registered repositories.
*
* @param bool $withDevReqs true to retrieve the locked dev packages
* @throws \RuntimeException
* @return \Composer\Repository\RepositoryInterface
*/
public function getLockedRepository($withDevReqs = false)
{
}
/**
* Returns the platform requirements stored in the lock file
*
* @param bool $withDevReqs if true, the platform requirements from the require-dev block are also returned
* @return \Composer\Package\Link[]
*/
public function getPlatformRequirements($withDevReqs = false)
{
}
public function getMinimumStability()
{
}
public function getStabilityFlags()
{
}
public function getPreferStable()
{
}
public function getPreferLowest()
{
}
public function getPlatformOverrides()
{
}
public function getAliases()
{
}
public function getLockData()
{
}
/**
* Locks provided data into lockfile.
*
* @param array $packages array of packages
* @param mixed $devPackages array of dev packages or null if installed without --dev
* @param array $platformReqs array of package name => constraint for required platform packages
* @param mixed $platformDevReqs array of package name => constraint for dev-required platform packages
* @param array $aliases array of aliases
* @param string $minimumStability
* @param array $stabilityFlags
* @param bool $preferStable
* @param bool $preferLowest
* @param array $platformOverrides
*
* @return bool
*/
public function setLockData(array $packages, $devPackages, array $platformReqs, $platformDevReqs, array $aliases, $minimumStability, array $stabilityFlags, $preferStable, $preferLowest, array $platformOverrides)
{
}
}
/**
* Base class for packages providing name storage and default match implementation
*
* @author Nils Adermann <naderman@naderman.de>
*/
abstract class BasePackage implements \Composer\Package\PackageInterface
{
public static $supportedLinkTypes = array('require' => array('description' => 'requires', 'method' => 'requires'), 'conflict' => array('description' => 'conflicts', 'method' => 'conflicts'), 'provide' => array('description' => 'provides', 'method' => 'provides'), 'replace' => array('description' => 'replaces', 'method' => 'replaces'), 'require-dev' => array('description' => 'requires (for development)', 'method' => 'devRequires'));
const STABILITY_STABLE = 0;
const STABILITY_RC = 5;
const STABILITY_BETA = 10;
const STABILITY_ALPHA = 15;
const STABILITY_DEV = 20;
public static $stabilities = array('stable' => self::STABILITY_STABLE, 'RC' => self::STABILITY_RC, 'beta' => self::STABILITY_BETA, 'alpha' => self::STABILITY_ALPHA, 'dev' => self::STABILITY_DEV);
/**
* READ-ONLY: The package id, public for fast access in dependency solver
* @var int
*/
public $id;
protected $name;
protected $prettyName;
protected $repository;
protected $transportOptions;
/**
* All descendants' constructors should call this parent constructor
*
* @param string $name The package's name
*/
public function __construct($name)
{
}
/**
* {@inheritDoc}
*/
public function getName()
{
}
/**
* {@inheritDoc}
*/
public function getPrettyName()
{
}
/**
* {@inheritDoc}
*/
public function getNames()
{
}
/**
* {@inheritDoc}
*/
public function setId($id)
{
}
/**
* {@inheritDoc}
*/
public function getId()
{
}
/**
* {@inheritDoc}
*/
public function setRepository(\Composer\Repository\RepositoryInterface $repository)
{
}
/**
* {@inheritDoc}
*/
public function getRepository()
{
}
/**
* {@inheritDoc}
*/
public function getTransportOptions()
{
}
/**
* Configures the list of options to download package dist files
*
* @param array $options
*/
public function setTransportOptions(array $options)
{
}
/**
* checks if this package is a platform package
*
* @return bool
*/
public function isPlatform()
{
}
/**
* Returns package unique name, constructed from name, version and release type.
*
* @return string
*/
public function getUniqueName()
{
}
public function equals(\Composer\Package\PackageInterface $package)
{
}
/**
* Converts the package into a readable and unique string
*
* @return string
*/
public function __toString()
{
}
public function getPrettyString()
{
}
/**
* {@inheritDoc}
*/
public function getFullPrettyVersion($truncate = true)
{
}
public function getStabilityPriority()
{
}
public function __clone()
{
}
}
/**
* Core package definitions that are needed to resolve dependencies and install packages
*
* @author Nils Adermann <naderman@naderman.de>
*/
class Package extends \Composer\Package\BasePackage
{
protected $type;
protected $targetDir;
protected $installationSource;
protected $sourceType;
protected $sourceUrl;
protected $sourceReference;
protected $sourceMirrors;
protected $distType;
protected $distUrl;
protected $distReference;
protected $distSha1Checksum;
protected $distMirrors;
protected $version;
protected $prettyVersion;
protected $releaseDate;
protected $extra = array();
protected $binaries = array();
protected $dev;
protected $stability;
protected $notificationUrl;
/** @var Link[] */
protected $requires = array();
/** @var Link[] */
protected $conflicts = array();
/** @var Link[] */
protected $provides = array();
/** @var Link[] */
protected $replaces = array();
/** @var Link[] */
protected $devRequires = array();
protected $suggests = array();
protected $autoload = array();
protected $devAutoload = array();
protected $includePaths = array();
protected $archiveExcludes = array();
/**
* Creates a new in memory package.
*
* @param string $name The package's name
* @param string $version The package's version
* @param string $prettyVersion The package's non-normalized version
*/
public function __construct($name, $version, $prettyVersion)
{
}
/**
* {@inheritDoc}
*/
public function isDev()
{
}
/**
* @param string $type
*/
public function setType($type)
{
}
/**
* {@inheritDoc}
*/
public function getType()
{
}
/**
* {@inheritDoc}
*/
public function getStability()
{
}
/**
* @param string $targetDir
*/
public function setTargetDir($targetDir)
{
}
/**
* {@inheritDoc}
*/
public function getTargetDir()
{
}
/**
* @param array $extra
*/
public function setExtra(array $extra)
{
}
/**
* {@inheritDoc}
*/
public function getExtra()
{
}
/**
* @param array $binaries
*/
public function setBinaries(array $binaries)
{
}
/**
* {@inheritDoc}
*/
public function getBinaries()
{
}
/**
* {@inheritDoc}
*/
public function setInstallationSource($type)
{
}
/**
* {@inheritDoc}
*/
public function getInstallationSource()
{
}
/**
* @param string $type
*/
public function setSourceType($type)
{
}
/**
* {@inheritDoc}
*/
public function getSourceType()
{
}
/**
* @param string $url
*/
public function setSourceUrl($url)
{
}
/**
* {@inheritDoc}
*/
public function getSourceUrl()
{
}
/**
* @param string $reference
*/
public function setSourceReference($reference)
{
}
/**
* {@inheritDoc}
*/
public function getSourceReference()
{
}
/**
* @param array|null $mirrors
*/
public function setSourceMirrors($mirrors)
{
}
/**
* {@inheritDoc}
*/
public function getSourceMirrors()
{
}
/**
* {@inheritDoc}
*/
public function getSourceUrls()
{
}
/**
* @param string $type
*/
public function setDistType($type)
{
}
/**
* {@inheritDoc}
*/
public function getDistType()
{
}
/**
* @param string $url
*/
public function setDistUrl($url)
{
}
/**
* {@inheritDoc}
*/
public function getDistUrl()
{
}
/**
* @param string $reference
*/
public function setDistReference($reference)
{
}
/**
* {@inheritDoc}
*/
public function getDistReference()
{
}
/**
* @param string $sha1checksum
*/
public function setDistSha1Checksum($sha1checksum)
{
}
/**
* {@inheritDoc}
*/
public function getDistSha1Checksum()
{
}
/**
* @param array|null $mirrors
*/
public function setDistMirrors($mirrors)
{
}
/**
* {@inheritDoc}
*/
public function getDistMirrors()
{
}
/**
* {@inheritDoc}
*/
public function getDistUrls()
{
}
/**
* {@inheritDoc}
*/
public function getVersion()
{
}
/**
* {@inheritDoc}
*/
public function getPrettyVersion()
{
}
/**
* Set the releaseDate
*
* @param \DateTime $releaseDate
*/
public function setReleaseDate(\DateTime $releaseDate)
{
}
/**
* {@inheritDoc}
*/
public function getReleaseDate()
{
}
/**
* Set the required packages
*
* @param Link[] $requires A set of package links
*/
public function setRequires(array $requires)
{
}
/**
* {@inheritDoc}
*/
public function getRequires()
{
}
/**
* Set the conflicting packages
*
* @param Link[] $conflicts A set of package links
*/
public function setConflicts(array $conflicts)
{
}
/**
* {@inheritDoc}
*/
public function getConflicts()
{
}
/**
* Set the provided virtual packages
*
* @param Link[] $provides A set of package links
*/
public function setProvides(array $provides)
{
}
/**
* {@inheritDoc}
*/
public function getProvides()
{
}
/**
* Set the packages this one replaces
*
* @param Link[] $replaces A set of package links
*/
public function setReplaces(array $replaces)
{
}
/**
* {@inheritDoc}
*/
public function getReplaces()
{
}
/**
* Set the recommended packages
*
* @param Link[] $devRequires A set of package links
*/
public function setDevRequires(array $devRequires)
{
}
/**
* {@inheritDoc}
*/
public function getDevRequires()
{
}
/**
* Set the suggested packages
*
* @param array $suggests A set of package names/comments
*/
public function setSuggests(array $suggests)
{
}
/**
* {@inheritDoc}
*/
public function getSuggests()
{
}
/**
* Set the autoload mapping
*
* @param array $autoload Mapping of autoloading rules
*/
public function setAutoload(array $autoload)
{
}
/**
* {@inheritDoc}
*/
public function getAutoload()
{
}
/**
* Set the dev autoload mapping
*
* @param array $devAutoload Mapping of dev autoloading rules
*/
public function setDevAutoload(array $devAutoload)
{
}
/**
* {@inheritDoc}
*/
public function getDevAutoload()
{
}
/**
* Sets the list of paths added to PHP's include path.
*
* @param array $includePaths List of directories.
*/
public function setIncludePaths(array $includePaths)
{
}
/**
* {@inheritDoc}
*/
public function getIncludePaths()
{
}
/**
* Sets the notification URL
*
* @param string $notificationUrl
*/
public function setNotificationUrl($notificationUrl)
{
}
/**
* {@inheritDoc}
*/
public function getNotificationUrl()
{
}
/**
* Sets a list of patterns to be excluded from archives
*
* @param array $excludes
*/
public function setArchiveExcludes(array $excludes)
{
}
/**
* {@inheritDoc}
*/
public function getArchiveExcludes()
{
}
/**
* Replaces current version and pretty version with passed values.
* It also sets stability.
*
* @param string $version The package's normalized version
* @param string $prettyVersion The package's non-normalized version
*/
public function replaceVersion($version, $prettyVersion)
{
}
protected function getUrls($url, $mirrors, $ref, $type, $urlType)
{
}
}
/**
* Package containing additional metadata that is not used by the solver
*
* @author Nils Adermann <naderman@naderman.de>
*/
class CompletePackage extends \Composer\Package\Package implements \Composer\Package\CompletePackageInterface
{
protected $repositories;
protected $license = array();
protected $keywords;
protected $authors;
protected $description;
protected $homepage;
protected $scripts = array();
protected $support = array();
protected $abandoned = false;
/**
* @param array $scripts
*/
public function setScripts(array $scripts)
{
}
/**
* {@inheritDoc}
*/
public function getScripts()
{
}
/**
* Set the repositories
*
* @param array $repositories
*/
public function setRepositories($repositories)
{
}
/**
* {@inheritDoc}
*/
public function getRepositories()
{
}
/**
* Set the license
*
* @param array $license
*/
public function setLicense(array $license)
{
}
/**
* {@inheritDoc}
*/
public function getLicense()
{
}
/**
* Set the keywords
*
* @param array $keywords
*/
public function setKeywords(array $keywords)
{
}
/**
* {@inheritDoc}
*/
public function getKeywords()
{
}
/**
* Set the authors
*
* @param array $authors
*/
public function setAuthors(array $authors)
{
}
/**
* {@inheritDoc}
*/
public function getAuthors()
{
}
/**
* Set the description
*
* @param string $description
*/
public function setDescription($description)
{
}
/**
* {@inheritDoc}
*/
public function getDescription()
{
}
/**
* Set the homepage
*
* @param string $homepage
*/
public function setHomepage($homepage)
{
}
/**
* {@inheritDoc}
*/
public function getHomepage()
{
}
/**
* Set the support information
*
* @param array $support
*/
public function setSupport(array $support)
{
}
/**
* {@inheritDoc}
*/
public function getSupport()
{
}
/**
* @return bool
*/
public function isAbandoned()
{
}
/**
* @param bool|string $abandoned
*/
public function setAbandoned($abandoned)
{
}
/**
* If the package is abandoned and has a suggested replacement, this method returns it
*
* @return string|null
*/
public function getReplacementPackage()
{
}
}
/**
* Represents a link between two packages, represented by their names
*
* @author Nils Adermann <naderman@naderman.de>
*/
class Link
{
/**
* @var string
*/
protected $source;
/**
* @var string
*/
protected $target;
/**
* @var ConstraintInterface|null
*/
protected $constraint;
/**
* @var string
*/
protected $description;
/**
* @var string|null
*/
protected $prettyConstraint;
/**
* Creates a new package link.
*
* @param string $source
* @param string $target
* @param ConstraintInterface|null $constraint Constraint applying to the target of this link
* @param string $description Used to create a descriptive string representation
* @param string|null $prettyConstraint
*/
public function __construct($source, $target, \Composer\Semver\Constraint\ConstraintInterface $constraint = null, $description = 'relates to', $prettyConstraint = null)
{
}
/**
* @return string
*/
public function getDescription()
{
}
/**
* @return string
*/
public function getSource()
{
}
/**
* @return string
*/
public function getTarget()
{
}
/**
* @return ConstraintInterface|null
*/
public function getConstraint()
{
}
/**
* @throws \UnexpectedValueException If no pretty constraint was provided
* @return string
*/
public function getPrettyConstraint()
{
}
/**
* @return string
*/
public function __toString()
{
}
/**
* @param PackageInterface $sourcePackage
* @return string
*/
public function getPrettyString(\Composer\Package\PackageInterface $sourcePackage)
{
}
}
}
namespace Composer\Package\Loader {
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class InvalidPackageException extends \Exception
{
public function __construct(array $errors, array $warnings, array $data)
{
}
public function getData()
{
}
public function getErrors()
{
}
public function getWarnings()
{
}
}
/**
* Defines a loader that takes an array to create package instances
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
interface LoaderInterface
{
/**
* Converts a package from an array to a real instance
*
* @param array $package Package config
* @param string $class Package class to use
* @return \Composer\Package\PackageInterface
*/
public function load(array $package, $class = 'Composer\\Package\\CompletePackage');
}
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ValidatingArrayLoader implements \Composer\Package\Loader\LoaderInterface
{
const CHECK_ALL = 1;
const CHECK_UNBOUND_CONSTRAINTS = 1;
public function __construct(\Composer\Package\Loader\LoaderInterface $loader, $strictName = true, \Composer\Package\Version\VersionParser $parser = null, $flags = 0)
{
}
public function load(array $config, $class = 'Composer\\Package\\CompletePackage')
{
}
public function getWarnings()
{
}
public function getErrors()
{
}
}
/**
* @author Konstantin Kudryashiv <ever.zet@gmail.com>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ArrayLoader implements \Composer\Package\Loader\LoaderInterface
{
protected $versionParser;
protected $loadOptions;
public function __construct(\Composer\Semver\VersionParser $parser = null, $loadOptions = false)
{
}
public function load(array $config, $class = 'Composer\\Package\\CompletePackage')
{
}
/**
* @param string $source source package name
* @param string $sourceVersion source package version (pretty version ideally)
* @param string $description link description (e.g. requires, replaces, ..)
* @param array $links array of package name => constraint mappings
* @return Link[]
*/
public function parseLinks($source, $sourceVersion, $description, $links)
{
}
/**
* Retrieves a branch alias (dev-master => 1.0.x-dev for example) if it exists
*
* @param array $config the entire package config
* @return string|null normalized version of the branch alias or null if there is none
*/
public function getBranchAlias(array $config)
{
}
}
/**
* ArrayLoader built for the sole purpose of loading the root package
*
* Sets additional defaults and loads repositories
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class RootPackageLoader extends \Composer\Package\Loader\ArrayLoader
{
public function __construct(\Composer\Repository\RepositoryManager $manager, \Composer\Config $config, \Composer\Package\Version\VersionParser $parser = null, \Composer\Package\Version\VersionGuesser $versionGuesser = null)
{
}
/**
* @param array $config package data
* @param string $class FQCN to be instantiated
* @param string $cwd cwd of the root package to be used to guess the version if it is not provided
* @return RootPackageInterface
*/
public function load(array $config, $class = 'Composer\\Package\\RootPackage', $cwd = null)
{
}
}
/**
* @author Konstantin Kudryashiv <ever.zet@gmail.com>
*/
class JsonLoader
{
public function __construct(\Composer\Package\Loader\LoaderInterface $loader)
{
}
/**
* @param string|JsonFile $json A filename, json string or JsonFile instance to load the package from
* @return \Composer\Package\PackageInterface
*/
public function load($json)
{
}
}
}
namespace Composer\Package {
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class AliasPackage extends \Composer\Package\BasePackage implements \Composer\Package\CompletePackageInterface
{
protected $version;
protected $prettyVersion;
protected $dev;
protected $rootPackageAlias = false;
protected $stability;
/** @var PackageInterface */
protected $aliasOf;
/** @var Link[] */
protected $requires;
/** @var Link[] */
protected $devRequires;
/** @var Link[] */
protected $conflicts;
/** @var Link[] */
protected $provides;
/** @var Link[] */
protected $replaces;
/**
* All descendants' constructors should call this parent constructor
*
* @param PackageInterface $aliasOf The package this package is an alias of
* @param string $version The version the alias must report
* @param string $prettyVersion The alias's non-normalized version
*/
public function __construct(\Composer\Package\PackageInterface $aliasOf, $version, $prettyVersion)
{
}
/**
* @return PackageInterface
*/
public function getAliasOf()
{
}
/**
* {@inheritDoc}
*/
public function getVersion()
{
}
/**
* {@inheritDoc}
*/
public function getStability()
{
}
/**
* {@inheritDoc}
*/
public function getPrettyVersion()
{
}
/**
* {@inheritDoc}
*/
public function isDev()
{
}
/**
* {@inheritDoc}
*/
public function getRequires()
{
}
/**
* {@inheritDoc}
*/
public function getConflicts()
{
}
/**
* {@inheritDoc}
*/
public function getProvides()
{
}
/**
* {@inheritDoc}
*/
public function getReplaces()
{
}
/**
* {@inheritDoc}
*/
public function getDevRequires()
{
}
/**
* Stores whether this is an alias created by an aliasing in the requirements of the root package or not
*
* Use by the policy for sorting manually aliased packages first, see #576
*
* @param bool $value
*
* @return mixed
*/
public function setRootPackageAlias($value)
{
}
/**
* @see setRootPackageAlias
* @return bool
*/
public function isRootPackageAlias()
{
}
/**
* @param Link[] $links
* @param string $linkType
*
* @return Link[]
*/
protected function replaceSelfVersionDependencies(array $links, $linkType)
{
}
/***************************************
* Wrappers around the aliased package *
***************************************/
public function getType()
{
}
public function getTargetDir()
{
}
public function getExtra()
{
}
public function setInstallationSource($type)
{
}
public function getInstallationSource()
{
}
public function getSourceType()
{
}
public function getSourceUrl()
{
}
public function getSourceUrls()
{
}
public function getSourceReference()
{
}
public function setSourceReference($reference)
{
}
public function setSourceMirrors($mirrors)
{
}
public function getSourceMirrors()
{
}
public function getDistType()
{
}
public function getDistUrl()
{
}
public function getDistUrls()
{
}
public function getDistReference()
{
}
public function setDistReference($reference)
{
}
public function getDistSha1Checksum()
{
}
public function setTransportOptions(array $options)
{
}
public function getTransportOptions()
{
}
public function setDistMirrors($mirrors)
{
}
public function getDistMirrors()
{
}
public function getScripts()
{
}
public function getLicense()
{
}
public function getAutoload()
{
}
public function getDevAutoload()
{
}
public function getIncludePaths()
{
}
public function getRepositories()
{
}
public function getReleaseDate()
{
}
public function getBinaries()
{
}
public function getKeywords()
{
}
public function getDescription()
{
}
public function getHomepage()
{
}
public function getSuggests()
{
}
public function getAuthors()
{
}
public function getSupport()
{
}
public function getNotificationUrl()
{
}
public function getArchiveExcludes()
{
}
public function isAbandoned()
{
}
public function getReplacementPackage()
{
}
public function __toString()
{
}
}
/**
* The root package represents the project's composer.json and contains additional metadata
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class RootPackage extends \Composer\Package\CompletePackage implements \Composer\Package\RootPackageInterface
{
protected $minimumStability = 'stable';
protected $preferStable = false;
protected $stabilityFlags = array();
protected $references = array();
protected $aliases = array();
/**
* Set the minimumStability
*
* @param string $minimumStability
*/
public function setMinimumStability($minimumStability)
{
}
/**
* {@inheritDoc}
*/
public function getMinimumStability()
{
}
/**
* Set the stabilityFlags
*
* @param array $stabilityFlags
*/
public function setStabilityFlags(array $stabilityFlags)
{
}
/**
* {@inheritDoc}
*/
public function getStabilityFlags()
{
}
/**
* Set the preferStable
*
* @param bool $preferStable
*/
public function setPreferStable($preferStable)
{
}
/**
* {@inheritDoc}
*/
public function getPreferStable()
{
}
/**
* Set the references
*
* @param array $references
*/
public function setReferences(array $references)
{
}
/**
* {@inheritDoc}
*/
public function getReferences()
{
}
/**
* Set the aliases
*
* @param array $aliases
*/
public function setAliases(array $aliases)
{
}
/**
* {@inheritDoc}
*/
public function getAliases()
{
}
}
}
namespace Composer\Package\Archiver {
/**
* @author Nils Adermann <naderman@naderman.de>
*/
abstract class BaseExcludeFilter
{
/**
* @var string
*/
protected $sourcePath;
/**
* @var array
*/
protected $excludePatterns;
/**
* @param string $sourcePath Directory containing sources to be filtered
*/
public function __construct($sourcePath)
{
}
/**
* Checks the given path against all exclude patterns in this filter
*
* Negated patterns overwrite exclude decisions of previous filters.
*
* @param string $relativePath The file's path relative to the sourcePath
* @param bool $exclude Whether a previous filter wants to exclude this file
*
* @return bool Whether the file should be excluded
*/
public function filter($relativePath, $exclude)
{
}
/**
* Processes a file containing exclude rules of different formats per line
*
* @param array $lines A set of lines to be parsed
* @param callback $lineParser The parser to be used on each line
*
* @return array Exclude patterns to be used in filter()
*/
protected function parseLines(array $lines, $lineParser)
{
}
/**
* Generates a set of exclude patterns for filter() from gitignore rules
*
* @param array $rules A list of exclude rules in gitignore syntax
*
* @return array Exclude patterns
*/
protected function generatePatterns($rules)
{
}
/**
* Generates an exclude pattern for filter() from a gitignore rule
*
* @param string $rule An exclude rule in gitignore syntax
*
* @return array An exclude pattern
*/
protected function generatePattern($rule)
{
}
}
/**
* An exclude filter that processes gitignore and gitattributes
*
* It respects export-ignore git attributes
*
* @author Nils Adermann <naderman@naderman.de>
*/
class GitExcludeFilter extends \Composer\Package\Archiver\BaseExcludeFilter
{
/**
* Parses .gitignore and .gitattributes files if they exist
*
* @param string $sourcePath
*/
public function __construct($sourcePath)
{
}
/**
* Callback line parser which process gitignore lines
*
* @param string $line A line from .gitignore
*
* @return array An exclude pattern for filter()
*/
public function parseGitIgnoreLine($line)
{
}
/**
* Callback parser which finds export-ignore rules in git attribute lines
*
* @param string $line A line from .gitattributes
*
* @return array An exclude pattern for filter()
*/
public function parseGitAttributesLine($line)
{
}
}
/**
* @author Till Klampaeckel <till@php.net>
* @author Matthieu Moquet <matthieu@moquet.net>
* @author Nils Adermann <naderman@naderman.de>
*/
interface ArchiverInterface
{
/**
* Create an archive from the sources.
*
* @param string $sources The sources directory
* @param string $target The target file
* @param string $format The format used for archive
* @param array $excludes A list of patterns for files to exclude
*
* @return string The path to the written archive file
*/
public function archive($sources, $target, $format, array $excludes = array());
/**
* Format supported by the archiver.
*
* @param string $format The archive format
* @param string $sourceType The source type (git, svn, hg, etc.)
*
* @return bool true if the format is supported by the archiver
*/
public function supports($format, $sourceType);
}
/**
* A Symfony Finder wrapper which locates files that should go into archives
*
* Handles .gitignore, .gitattributes and .hgignore files as well as composer's
* own exclude rules from composer.json
*
* @author Nils Adermann <naderman@naderman.de>
*/
class ArchivableFilesFinder extends \FilterIterator
{
/**
* @var Finder
*/
protected $finder;
/**
* Initializes the internal Symfony Finder with appropriate filters
*
* @param string $sources Path to source files to be archived
* @param array $excludes Composer's own exclude rules from composer.json
*/
public function __construct($sources, array $excludes)
{
}
public function accept()
{
}
}
/**
* @author Matthieu Moquet <matthieu@moquet.net>
* @author Till Klampaeckel <till@php.net>
*/
class ArchiveManager
{
protected $downloadManager;
protected $archivers = array();
/**
* @var bool
*/
protected $overwriteFiles = true;
/**
* @param DownloadManager $downloadManager A manager used to download package sources
*/
public function __construct(\Composer\Downloader\DownloadManager $downloadManager)
{
}
/**
* @param ArchiverInterface $archiver
*/
public function addArchiver(\Composer\Package\Archiver\ArchiverInterface $archiver)
{
}
/**
* Set whether existing archives should be overwritten
*
* @param bool $overwriteFiles New setting
*
* @return $this
*/
public function setOverwriteFiles($overwriteFiles)
{
}
/**
* Generate a distinct filename for a particular version of a package.
*
* @param PackageInterface $package The package to get a name for
*
* @return string A filename without an extension
*/
public function getPackageFilename(\Composer\Package\PackageInterface $package)
{
}
/**
* Create an archive of the specified package.
*
* @param PackageInterface $package The package to archive
* @param string $format The format of the archive (zip, tar, ...)
* @param string $targetDir The directory where to build the archive
* @param string|null $fileName The relative file name to use for the archive, or null to generate
* the package name. Note that the format will be appended to this name
* @throws \InvalidArgumentException
* @throws \RuntimeException
* @return string The path of the created archive
*/
public function archive(\Composer\Package\PackageInterface $package, $format, $targetDir, $fileName = null)
{
}
}
/**
* An exclude filter that processes hgignore files
*
* @author Nils Adermann <naderman@naderman.de>
*/
class HgExcludeFilter extends \Composer\Package\Archiver\BaseExcludeFilter
{
const HG_IGNORE_REGEX = 1;
const HG_IGNORE_GLOB = 2;
/**
* Either HG_IGNORE_REGEX or HG_IGNORE_GLOB
* @var int
*/
protected $patternMode;
/**
* Parses .hgignore file if it exist
*
* @param string $sourcePath
*/
public function __construct($sourcePath)
{
}
/**
* Callback line parser which process hgignore lines
*
* @param string $line A line from .hgignore
*
* @return array An exclude pattern for filter()
*/
public function parseHgIgnoreLine($line)
{
}
/**
* Generates an exclude pattern for filter() from a hg glob expression
*
* @param string $line A line from .hgignore in glob mode
*
* @return array An exclude pattern for filter()
*/
protected function patternFromGlob($line)
{
}
/**
* Generates an exclude pattern for filter() from a hg regexp expression
*
* @param string $line A line from .hgignore in regexp mode
*
* @return array An exclude pattern for filter()
*/
public function patternFromRegex($line)
{
}
}
/**
* An exclude filter which processes composer's own exclude rules
*
* @author Nils Adermann <naderman@naderman.de>
*/
class ComposerExcludeFilter extends \Composer\Package\Archiver\BaseExcludeFilter
{
/**
* @param string $sourcePath Directory containing sources to be filtered
* @param array $excludeRules An array of exclude rules from composer.json
*/
public function __construct($sourcePath, array $excludeRules)
{
}
}
/**
* @author Jan Prieser <jan@prieser.net>
*/
class ZipArchiver implements \Composer\Package\Archiver\ArchiverInterface
{
protected static $formats = array('zip' => 1);
/**
* {@inheritdoc}
*/
public function archive($sources, $target, $format, array $excludes = array())
{
}
/**
* {@inheritdoc}
*/
public function supports($format, $sourceType)
{
}
}
/**
* @author Till Klampaeckel <till@php.net>
* @author Nils Adermann <naderman@naderman.de>
* @author Matthieu Moquet <matthieu@moquet.net>
*/
class PharArchiver implements \Composer\Package\Archiver\ArchiverInterface
{
protected static $formats = array('zip' => \Phar::ZIP, 'tar' => \Phar::TAR, 'tar.gz' => \Phar::TAR, 'tar.bz2' => \Phar::TAR);
protected static $compressFormats = array('tar.gz' => \Phar::GZ, 'tar.bz2' => \Phar::BZ2);
/**
* {@inheritdoc}
*/
public function archive($sources, $target, $format, array $excludes = array())
{
}
/**
* {@inheritdoc}
*/
public function supports($format, $sourceType)
{
}
}
}
namespace Composer\Package {
/**
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class RootAliasPackage extends \Composer\Package\AliasPackage implements \Composer\Package\RootPackageInterface
{
public function __construct(\Composer\Package\RootPackageInterface $aliasOf, $version, $prettyVersion)
{
}
/**
* {@inheritDoc}
*/
public function getAliases()
{
}
/**
* {@inheritDoc}
*/
public function getMinimumStability()
{
}
/**
* {@inheritDoc}
*/
public function getStabilityFlags()
{
}
/**
* {@inheritDoc}
*/
public function getReferences()
{
}
/**
* {@inheritDoc}
*/
public function getPreferStable()
{
}
/**
* {@inheritDoc}
*/
public function setRequires(array $require)
{
}
/**
* {@inheritDoc}
*/
public function setDevRequires(array $devRequire)
{
}
/**
* {@inheritDoc}
*/
public function setConflicts(array $conflicts)
{
}
/**
* {@inheritDoc}
*/
public function setProvides(array $provides)
{
}
/**
* {@inheritDoc}
*/
public function setReplaces(array $replaces)
{
}
/**
* {@inheritDoc}
*/
public function setRepositories($repositories)
{
}
/**
* {@inheritDoc}
*/
public function setAutoload(array $autoload)
{
}
/**
* {@inheritDoc}
*/
public function setDevAutoload(array $devAutoload)
{
}
/**
* {@inheritDoc}
*/
public function setStabilityFlags(array $stabilityFlags)
{
}
/**
* {@inheritDoc}
*/
public function setSuggests(array $suggests)
{
}
/**
* {@inheritDoc}
*/
public function setExtra(array $extra)
{
}
public function __clone()
{
}
}
}
namespace {
// autoload_real.php @generated by Composer
class ComposerAutoloaderInit6e39317df62e454a09c32111d5b6d46f
{
public static function loadClassLoader($class)
{
}
public static function getLoader()
{
}
}
}
namespace Composer\Spdx {
/**
* The SPDX Licenses Updater scrapes licenses from the spdx website
* and updates the "res/*.json" file accordingly.
*
* The class is used by the update script "bin/update-spdx-licenses".
*/
class SpdxLicensesUpdater
{
/**
* @param string $file
* @param string $url
*/
public function dumpLicenses($file = null, $url = 'https://spdx.org/licenses/index.html')
{
}
/**
* @param string $file
* @param string $url
*/
public function dumpExceptions($file = null, $url = 'https://spdx.org/licenses/exceptions-index.html')
{
}
}
}
namespace Composer\Autoload {
class ComposerStaticInit6e39317df62e454a09c32111d5b6d46f
{
public static $files = array('ad155f8f1cf0d418fe49e248db8c661b' => __DIR__ . '/..' . '/react/promise/src/functions_include.php', '0e6d7bf4a5811bfa5cf40c5ccd6fae6a' => __DIR__ . '/..' . '/symfony/polyfill-mbstring/bootstrap.php', 'a0edc8309cc5e1d60e3047b5df6b7052' => __DIR__ . '/..' . '/guzzlehttp/psr7/src/functions_include.php', '5255c38a0faeba867671b61dfda6d864' => __DIR__ . '/..' . '/paragonie/random_compat/lib/random.php', 'c964ee0ededf28c96ebd9db5099ef910' => __DIR__ . '/..' . '/guzzlehttp/promises/src/functions_include.php', '72579e7bd17821bb1321b87411366eae' => __DIR__ . '/..' . '/illuminate/support/helpers.php', 'e40631d46120a9c38ea139981f8dab26' => __DIR__ . '/..' . '/ircmaxell/password-compat/lib/password.php', 'b067bc7112e384b61c701452d53a14a8' => __DIR__ . '/..' . '/mtdowling/jmespath.php/src/JmesPath.php', '8a9dc1de0ca7e01f3e08231539562f61' => __DIR__ . '/..' . '/aws/aws-sdk-php/src/functions.php', '3e2471375464aac821502deb0ac64275' => __DIR__ . '/..' . '/symfony/polyfill-php54/bootstrap.php', 'edc6464955a37aa4d5fbf39d40fb6ee7' => __DIR__ . '/..' . '/symfony/polyfill-php55/bootstrap.php', 'decc78cc4436b1292c6c0d151b19445c' => __DIR__ . '/..' . '/phpseclib/phpseclib/phpseclib/bootstrap.php', '253c157292f75eb38082b5acb06f3f01' => __DIR__ . '/..' . '/nikic/fast-route/src/functions.php', '2cffec82183ee1cea088009cef9a6fc3' => __DIR__ . '/..' . '/ezyang/htmlpurifier/library/HTMLPurifier.composer.php', 'c65d09b6820da036953a371c8c73a9b1' => __DIR__ . '/..' . '/facebook/graph-sdk/src/Facebook/polyfills.php', 'aa75ea0761a2f40c1f3b32ad314f86c4' => __DIR__ . '/..' . '/phpseclib/mcrypt_compat/lib/mcrypt.php', 'f084d01b0a599f67676cffef638aa95b' => __DIR__ . '/..' . '/smarty/smarty/libs/bootstrap.php', 'def43f6c87e4f8dfd0c9e1b1bab14fe8' => __DIR__ . '/..' . '/symfony/polyfill-iconv/bootstrap.php', 'f239dbcecbaa0e5f4dfcbe823d65013a' => __DIR__ . '/../..' . '/modules/autoload.php');
public static $prefixLengthsPsr4 = array('p' => array('phpseclib\\' => 10), 'm' => array('mindplay\\middleman\\' => 19), 'Z' => array('Zend\\Diactoros\\' => 15), 'W' => array('Whoops\\' => 7, 'WHMCS\\' => 6), 'S' => array('Symfony\\Polyfill\\Php55\\' => 23, 'Symfony\\Polyfill\\Php54\\' => 23, 'Symfony\\Polyfill\\Mbstring\\' => 26, 'Symfony\\Polyfill\\Iconv\\' => 23, 'Symfony\\Component\\Yaml\\' => 23, 'Symfony\\Component\\Translation\\' => 30, 'Symfony\\Component\\Process\\' => 26, 'Symfony\\Component\\HttpFoundation\\' => 33, 'Symfony\\Component\\Finder\\' => 25, 'Symfony\\Component\\Filesystem\\' => 29, 'Symfony\\Component\\DependencyInjection\\' => 38, 'Symfony\\Component\\Console\\' => 26, 'Symfony\\Component\\Config\\' => 25, 'Stripe\\' => 7, 'Seld\\PharUtils\\' => 15, 'Seld\\JsonLint\\' => 14, 'Seld\\CliPrompt\\' => 15), 'R' => array('React\\Promise\\' => 14, 'ReCaptcha\\' => 10, 'Ramsey\\Uuid\\' => 12), 'P' => array('Punic\\' => 6, 'Psr\\Log\\' => 8, 'Psr\\Http\\Message\\' => 17, 'Psr\\Container\\' => 14, 'Psr\\Cache\\' => 10, 'PhpMyAdmin\\SqlParser\\' => 21, 'PhpImap\\' => 8, 'PHPMailer\\PHPMailer\\' => 20), 'M' => array('Monolog\\' => 8, 'Middlewares\\Utils\\' => 18, 'Middlewares\\' => 12), 'L' => array('League\\Plates\\' => 14, 'League\\Flysystem\\AwsS3v3\\' => 25, 'League\\Flysystem\\' => 17, 'League\\CLImate\\' => 15), 'K' => array('Knp\\Menu\\' => 9), 'J' => array('JsonSchema\\' => 11, 'JmesPath\\' => 9), 'I' => array('Interop\\Http\\ServerMiddleware\\' => 30, 'Interop\\Http\\Factory\\' => 21, 'Interop\\Container\\' => 18, 'Illuminate\\Validation\\' => 22, 'Illuminate\\Support\\' => 19, 'Illuminate\\Events\\' => 18, 'Illuminate\\Database\\' => 20, 'Illuminate\\Contracts\\' => 21, 'Illuminate\\Container\\' => 21, 'Illuminate\\Console\\' => 19), 'G' => array('GuzzleHttp\\Stream\\' => 18, 'GuzzleHttp\\Ring\\' => 16, 'GuzzleHttp\\Psr7\\' => 16, 'GuzzleHttp\\Promise\\' => 19, 'GuzzleHttp\\' => 11, 'Google\\Auth\\' => 12, 'GoetasWebservices\\Xsd\\XsdToPhpRuntime\\' => 38), 'F' => array('Firebase\\JWT\\' => 13, 'FastRoute\\' => 10, 'Facebook\\' => 9), 'D' => array('Duo\\' => 4, 'Doctrine\\Instantiator\\' => 22, 'Doctrine\\Common\\Annotations\\' => 28), 'C' => array('Composer\\Spdx\\' => 14, 'Composer\\Semver\\' => 16, 'Composer\\' => 9, 'Carbon\\' => 7), 'A' => array('Aws\\' => 4, 'Abraham\\TwitterOAuth\\' => 21));
public static $prefixDirsPsr4 = array('phpseclib\\' => array(0 => __DIR__ . '/..' . '/phpseclib/phpseclib/phpseclib'), 'mindplay\\middleman\\' => array(0 => __DIR__ . '/..' . '/mindplay/middleman/src'), 'Zend\\Diactoros\\' => array(0 => __DIR__ . '/..' . '/zendframework/zend-diactoros/src'), 'Whoops\\' => array(0 => __DIR__ . '/..' . '/filp/whoops/src/Whoops'), 'WHMCS\\' => array(0 => __DIR__ . '/..' . '/whmcs/whmcs-foundation/lib'), 'Symfony\\Polyfill\\Php55\\' => array(0 => __DIR__ . '/..' . '/symfony/polyfill-php55'), 'Symfony\\Polyfill\\Php54\\' => array(0 => __DIR__ . '/..' . '/symfony/polyfill-php54'), 'Symfony\\Polyfill\\Mbstring\\' => array(0 => __DIR__ . '/..' . '/symfony/polyfill-mbstring'), 'Symfony\\Polyfill\\Iconv\\' => array(0 => __DIR__ . '/..' . '/symfony/polyfill-iconv'), 'Symfony\\Component\\Yaml\\' => array(0 => __DIR__ . '/..' . '/symfony/yaml'), 'Symfony\\Component\\Translation\\' => array(0 => __DIR__ . '/..' . '/symfony/translation'), 'Symfony\\Component\\Process\\' => array(0 => __DIR__ . '/..' . '/symfony/process'), 'Symfony\\Component\\HttpFoundation\\' => array(0 => __DIR__ . '/..' . '/symfony/http-foundation'), 'Symfony\\Component\\Finder\\' => array(0 => __DIR__ . '/..' . '/symfony/finder'), 'Symfony\\Component\\Filesystem\\' => array(0 => __DIR__ . '/..' . '/symfony/filesystem'), 'Symfony\\Component\\DependencyInjection\\' => array(0 => __DIR__ . '/..' . '/symfony/dependency-injection'), 'Symfony\\Component\\Console\\' => array(0 => __DIR__ . '/..' . '/symfony/console'), 'Symfony\\Component\\Config\\' => array(0 => __DIR__ . '/..' . '/symfony/config'), 'Stripe\\' => array(0 => __DIR__ . '/..' . '/stripe/stripe-php/lib'), 'Seld\\PharUtils\\' => array(0 => __DIR__ . '/..' . '/seld/phar-utils/src'), 'Seld\\JsonLint\\' => array(0 => __DIR__ . '/..' . '/seld/jsonlint/src/Seld/JsonLint'), 'Seld\\CliPrompt\\' => array(0 => __DIR__ . '/..' . '/seld/cli-prompt/src'), 'React\\Promise\\' => array(0 => __DIR__ . '/..' . '/react/promise/src'), 'ReCaptcha\\' => array(0 => __DIR__ . '/..' . '/google/recaptcha/src/ReCaptcha'), 'Ramsey\\Uuid\\' => array(0 => __DIR__ . '/..' . '/ramsey/uuid/src'), 'Punic\\' => array(0 => __DIR__ . '/..' . '/punic/punic/code'), 'Psr\\Log\\' => array(0 => __DIR__ . '/..' . '/psr/log/Psr/Log'), 'Psr\\Http\\Message\\' => array(0 => __DIR__ . '/..' . '/psr/http-message/src'), 'Psr\\Container\\' => array(0 => __DIR__ . '/..' . '/psr/container/src'), 'Psr\\Cache\\' => array(0 => __DIR__ . '/..' . '/psr/cache/src'), 'PhpMyAdmin\\SqlParser\\' => array(0 => __DIR__ . '/..' . '/phpmyadmin/sql-parser/src'), 'PhpImap\\' => array(0 => __DIR__ . '/..' . '/php-imap/php-imap/src/PhpImap'), 'PHPMailer\\PHPMailer\\' => array(0 => __DIR__ . '/..' . '/phpmailer/phpmailer/src'), 'Monolog\\' => array(0 => __DIR__ . '/..' . '/monolog/monolog/src/Monolog'), 'Middlewares\\Utils\\' => array(0 => __DIR__ . '/..' . '/middlewares/utils/src'), 'Middlewares\\' => array(0 => __DIR__ . '/..' . '/middlewares/fast-route/src'), 'League\\Plates\\' => array(0 => __DIR__ . '/..' . '/league/plates/src'), 'League\\Flysystem\\AwsS3v3\\' => array(0 => __DIR__ . '/..' . '/league/flysystem-aws-s3-v3/src'), 'League\\Flysystem\\' => array(0 => __DIR__ . '/..' . '/league/flysystem/src'), 'League\\CLImate\\' => array(0 => __DIR__ . '/..' . '/league/climate/src'), 'Knp\\Menu\\' => array(0 => __DIR__ . '/..' . '/knplabs/knp-menu/src/Knp/Menu'), 'JsonSchema\\' => array(0 => __DIR__ . '/..' . '/justinrainbow/json-schema/src/JsonSchema'), 'JmesPath\\' => array(0 => __DIR__ . '/..' . '/mtdowling/jmespath.php/src'), 'Interop\\Http\\ServerMiddleware\\' => array(0 => __DIR__ . '/..' . '/http-interop/http-middleware/src'), 'Interop\\Http\\Factory\\' => array(0 => __DIR__ . '/..' . '/http-interop/http-factory/src'), 'Interop\\Container\\' => array(0 => __DIR__ . '/..' . '/container-interop/container-interop/src/Interop/Container'), 'Illuminate\\Validation\\' => array(0 => __DIR__ . '/..' . '/illuminate/validation'), 'Illuminate\\Support\\' => array(0 => __DIR__ . '/..' . '/illuminate/support'), 'Illuminate\\Events\\' => array(0 => __DIR__ . '/..' . '/illuminate/events'), 'Illuminate\\Database\\' => array(0 => __DIR__ . '/..' . '/illuminate/database'), 'Illuminate\\Contracts\\' => array(0 => __DIR__ . '/..' . '/illuminate/contracts'), 'Illuminate\\Container\\' => array(0 => __DIR__ . '/..' . '/illuminate/container'), 'Illuminate\\Console\\' => array(0 => __DIR__ . '/..' . '/illuminate/console'), 'GuzzleHttp\\Stream\\' => array(0 => __DIR__ . '/..' . '/guzzlehttp/streams/src'), 'GuzzleHttp\\Ring\\' => array(0 => __DIR__ . '/..' . '/guzzlehttp/ringphp/src'), 'GuzzleHttp\\Psr7\\' => array(0 => __DIR__ . '/..' . '/guzzlehttp/psr7/src'), 'GuzzleHttp\\Promise\\' => array(0 => __DIR__ . '/..' . '/guzzlehttp/promises/src'), 'GuzzleHttp\\' => array(0 => __DIR__ . '/..' . '/guzzlehttp/guzzle/src'), 'Google\\Auth\\' => array(0 => __DIR__ . '/..' . '/google/auth/src'), 'GoetasWebservices\\Xsd\\XsdToPhpRuntime\\' => array(0 => __DIR__ . '/..' . '/goetas-webservices/xsd2php-runtime/src'), 'Firebase\\JWT\\' => array(0 => __DIR__ . '/..' . '/firebase/php-jwt/src'), 'FastRoute\\' => array(0 => __DIR__ . '/..' . '/nikic/fast-route/src'), 'Facebook\\' => array(0 => __DIR__ . '/..' . '/facebook/graph-sdk/src/Facebook'), 'Duo\\' => array(0 => __DIR__ . '/..' . '/duosecurity/duo_php/src'), 'Doctrine\\Instantiator\\' => array(0 => __DIR__ . '/..' . '/doctrine/instantiator/src/Doctrine/Instantiator'), 'Doctrine\\Common\\Annotations\\' => array(0 => __DIR__ . '/..' . '/doctrine/annotations/lib/Doctrine/Common/Annotations'), 'Composer\\Spdx\\' => array(0 => __DIR__ . '/..' . '/composer/spdx-licenses/src'), 'Composer\\Semver\\' => array(0 => __DIR__ . '/..' . '/composer/semver/src'), 'Composer\\' => array(0 => __DIR__ . '/..' . '/composer/composer/src/Composer'), 'Carbon\\' => array(0 => __DIR__ . '/..' . '/nesbot/carbon/src/Carbon'), 'Aws\\' => array(0 => __DIR__ . '/..' . '/aws/aws-sdk-php/src'), 'Abraham\\TwitterOAuth\\' => array(0 => __DIR__ . '/..' . '/abraham/twitteroauth/src'));
public static $fallbackDirsPsr4 = array(0 => __DIR__ . '/..' . '/bitpay/php-client/src');
public static $prefixesPsr0 = array('P' => array('PhpOption\\' => array(0 => __DIR__ . '/..' . '/phpoption/phpoption/src'), 'PhpCollection' => array(0 => __DIR__ . '/..' . '/phpcollection/phpcollection/src')), 'O' => array('OAuth2\\HttpFoundationBridge' => array(0 => __DIR__ . '/..' . '/bshaffer/oauth2-server-httpfoundation-bridge/src'), 'OAuth2' => array(0 => __DIR__ . '/..' . '/bshaffer/oauth2-server-php/src')), 'M' => array('Michelf' => array(0 => __DIR__ . '/..' . '/michelf/php-markdown'), 'Metadata\\' => array(0 => __DIR__ . '/..' . '/jms/metadata/src')), 'J' => array('JMS\\Serializer' => array(0 => __DIR__ . '/..' . '/jms/serializer/src'), 'JMS\\' => array(0 => __DIR__ . '/..' . '/jms/parser-lib/src')), 'H' => array('HTMLPurifier' => array(0 => __DIR__ . '/..' . '/ezyang/htmlpurifier/library')), 'G' => array('Google_' => array(0 => __DIR__ . '/..' . '/google/apiclient/src')), 'D' => array('Doctrine\\Common\\Lexer\\' => array(0 => __DIR__ . '/..' . '/doctrine/lexer/lib'), 'Doctrine\\Common\\Inflector\\' => array(0 => __DIR__ . '/..' . '/doctrine/inflector/lib')));
public static $classMap = array('AuthorizeNetAIM' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetAIM.php', 'AuthorizeNetAIM_Response' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetAIM.php', 'AuthorizeNetARB' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetARB.php', 'AuthorizeNetARB_Response' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetARB.php', 'AuthorizeNetAddress' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetBankAccount' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetCIM' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetCIM.php', 'AuthorizeNetCIM_Response' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetCIM.php', 'AuthorizeNetCP' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetCP.php', 'AuthorizeNetCP_Response' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetCP.php', 'AuthorizeNetCreditCard' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetCustomer' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetDPM' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetDPM.php', 'AuthorizeNetException' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetException.php', 'AuthorizeNetGetSubscriptionList' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetLineItem' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetPayment' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetPaymentProfile' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetRequest.php', 'AuthorizeNetResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetResponse.php', 'AuthorizeNetSIM' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetSIM.php', 'AuthorizeNetSIM_Form' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetSIM.php', 'AuthorizeNetSOAP' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetSOAP.php', 'AuthorizeNetSubscriptionListPaging' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetSubscriptionListSorting' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetTD' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetTD.php', 'AuthorizeNetTD_Response' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/AuthorizeNetTD.php', 'AuthorizeNetTransaction' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'AuthorizeNetXMLResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetXMLResponse.php', 'AuthorizeNet_Subscription' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/shared/AuthorizeNetTypes.php', 'CallbackFilterIterator' => __DIR__ . '/..' . '/symfony/polyfill-php54/Resources/stubs/CallbackFilterIterator.php', 'Datamatrix' => __DIR__ . '/..' . '/tecnickcom/tcpdf/include/barcodes/datamatrix.php', 'Google\\Auth\\ApplicationDefaultCredentials' => __DIR__ . '/..' . '/google/auth/src/ApplicationDefaultCredentials.php', 'Google\\Auth\\CacheTrait' => __DIR__ . '/..' . '/google/auth/src/CacheTrait.php', 'Google\\Auth\\Cache\\InvalidArgumentException' => __DIR__ . '/..' . '/google/auth/src/Cache/InvalidArgumentException.php', 'Google\\Auth\\Cache\\Item' => __DIR__ . '/..' . '/google/auth/src/Cache/Item.php', 'Google\\Auth\\Cache\\MemoryCacheItemPool' => __DIR__ . '/..' . '/google/auth/src/Cache/MemoryCacheItemPool.php', 'Google\\Auth\\CredentialsLoader' => __DIR__ . '/..' . '/google/auth/src/CredentialsLoader.php', 'Google\\Auth\\Credentials\\AppIdentityCredentials' => __DIR__ . '/..' . '/google/auth/src/Credentials/AppIdentityCredentials.php', 'Google\\Auth\\Credentials\\GCECredentials' => __DIR__ . '/..' . '/google/auth/src/Credentials/GCECredentials.php', 'Google\\Auth\\Credentials\\IAMCredentials' => __DIR__ . '/..' . '/google/auth/src/Credentials/IAMCredentials.php', 'Google\\Auth\\Credentials\\ServiceAccountCredentials' => __DIR__ . '/..' . '/google/auth/src/Credentials/ServiceAccountCredentials.php', 'Google\\Auth\\Credentials\\ServiceAccountJwtAccessCredentials' => __DIR__ . '/..' . '/google/auth/src/Credentials/ServiceAccountJwtAccessCredentials.php', 'Google\\Auth\\Credentials\\UserRefreshCredentials' => __DIR__ . '/..' . '/google/auth/src/Credentials/UserRefreshCredentials.php', 'Google\\Auth\\FetchAuthTokenCache' => __DIR__ . '/..' . '/google/auth/src/FetchAuthTokenCache.php', 'Google\\Auth\\FetchAuthTokenInterface' => __DIR__ . '/..' . '/google/auth/src/FetchAuthTokenInterface.php', 'Google\\Auth\\HttpHandler\\Guzzle5HttpHandler' => __DIR__ . '/..' . '/google/auth/src/HttpHandler/Guzzle5HttpHandler.php', 'Google\\Auth\\HttpHandler\\Guzzle6HttpHandler' => __DIR__ . '/..' . '/google/auth/src/HttpHandler/Guzzle6HttpHandler.php', 'Google\\Auth\\HttpHandler\\HttpHandlerFactory' => __DIR__ . '/..' . '/google/auth/src/HttpHandler/HttpHandlerFactory.php', 'Google\\Auth\\Middleware\\AuthTokenMiddleware' => __DIR__ . '/..' . '/google/auth/src/Middleware/AuthTokenMiddleware.php', 'Google\\Auth\\Middleware\\ScopedAccessTokenMiddleware' => __DIR__ . '/..' . '/google/auth/src/Middleware/ScopedAccessTokenMiddleware.php', 'Google\\Auth\\Middleware\\SimpleMiddleware' => __DIR__ . '/..' . '/google/auth/src/Middleware/SimpleMiddleware.php', 'Google\\Auth\\OAuth2' => __DIR__ . '/..' . '/google/auth/src/OAuth2.php', 'Google\\Auth\\Subscriber\\AuthTokenSubscriber' => __DIR__ . '/..' . '/google/auth/src/Subscriber/AuthTokenSubscriber.php', 'Google\\Auth\\Subscriber\\ScopedAccessTokenSubscriber' => __DIR__ . '/..' . '/google/auth/src/Subscriber/ScopedAccessTokenSubscriber.php', 'Google\\Auth\\Subscriber\\SimpleSubscriber' => __DIR__ . '/..' . '/google/auth/src/Subscriber/SimpleSubscriber.php', 'Google_Service_Exception' => __DIR__ . '/..' . '/google/apiclient/src/Google/Service/Exception.php', 'Google_Service_Resource' => __DIR__ . '/..' . '/google/apiclient/src/Google/Service/Resource.php', 'PDF417' => __DIR__ . '/..' . '/tecnickcom/tcpdf/include/barcodes/pdf417.php', 'QRcode' => __DIR__ . '/..' . '/tecnickcom/tcpdf/include/barcodes/qrcode.php', 'RecursiveCallbackFilterIterator' => __DIR__ . '/..' . '/symfony/polyfill-php54/Resources/stubs/RecursiveCallbackFilterIterator.php', 'SessionHandlerInterface' => __DIR__ . '/..' . '/symfony/polyfill-php54/Resources/stubs/SessionHandlerInterface.php', 'TCPDF' => __DIR__ . '/..' . '/tecnickcom/tcpdf/tcpdf.php', 'TCPDF2DBarcode' => __DIR__ . '/..' . '/tecnickcom/tcpdf/tcpdf_barcodes_2d.php', 'TCPDFBarcode' => __DIR__ . '/..' . '/tecnickcom/tcpdf/tcpdf_barcodes_1d.php', 'TCPDF_COLORS' => __DIR__ . '/..' . '/tecnickcom/tcpdf/include/tcpdf_colors.php', 'TCPDF_FILTERS' => __DIR__ . '/..' . '/tecnickcom/tcpdf/include/tcpdf_filters.php', 'TCPDF_FONTS' => __DIR__ . '/..' . '/tecnickcom/tcpdf/include/tcpdf_fonts.php', 'TCPDF_FONT_DATA' => __DIR__ . '/..' . '/tecnickcom/tcpdf/include/tcpdf_font_data.php', 'TCPDF_IMAGES' => __DIR__ . '/..' . '/tecnickcom/tcpdf/include/tcpdf_images.php', 'TCPDF_IMPORT' => __DIR__ . '/..' . '/tecnickcom/tcpdf/tcpdf_import.php', 'TCPDF_PARSER' => __DIR__ . '/..' . '/tecnickcom/tcpdf/tcpdf_parser.php', 'TCPDF_STATIC' => __DIR__ . '/..' . '/tecnickcom/tcpdf/include/tcpdf_static.php', 'mindplay\\readable' => __DIR__ . '/..' . '/mindplay/readable/src/readable.php', 'net\\authorize\\api\\constants\\ANetEnvironment' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/constants/ANetEnvironment.php', 'net\\authorize\\api\\contract\\v1\\ANetApiRequestType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ANetApiRequestType.php', 'net\\authorize\\api\\contract\\v1\\ANetApiResponseType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ANetApiResponseType.php', 'net\\authorize\\api\\contract\\v1\\ARBCancelSubscriptionRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBCancelSubscriptionRequest.php', 'net\\authorize\\api\\contract\\v1\\ARBCancelSubscriptionResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBCancelSubscriptionResponse.php', 'net\\authorize\\api\\contract\\v1\\ARBCreateSubscriptionRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBCreateSubscriptionRequest.php', 'net\\authorize\\api\\contract\\v1\\ARBCreateSubscriptionResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBCreateSubscriptionResponse.php', 'net\\authorize\\api\\contract\\v1\\ARBGetSubscriptionListRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBGetSubscriptionListRequest.php', 'net\\authorize\\api\\contract\\v1\\ARBGetSubscriptionListResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBGetSubscriptionListResponse.php', 'net\\authorize\\api\\contract\\v1\\ARBGetSubscriptionListSortingType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBGetSubscriptionListSortingType.php', 'net\\authorize\\api\\contract\\v1\\ARBGetSubscriptionRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBGetSubscriptionRequest.php', 'net\\authorize\\api\\contract\\v1\\ARBGetSubscriptionResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBGetSubscriptionResponse.php', 'net\\authorize\\api\\contract\\v1\\ARBGetSubscriptionStatusRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBGetSubscriptionStatusRequest.php', 'net\\authorize\\api\\contract\\v1\\ARBGetSubscriptionStatusResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBGetSubscriptionStatusResponse.php', 'net\\authorize\\api\\contract\\v1\\ARBSubscriptionMaskedType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBSubscriptionMaskedType.php', 'net\\authorize\\api\\contract\\v1\\ARBSubscriptionType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBSubscriptionType.php', 'net\\authorize\\api\\contract\\v1\\ARBUpdateSubscriptionRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBUpdateSubscriptionRequest.php', 'net\\authorize\\api\\contract\\v1\\ARBUpdateSubscriptionResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ARBUpdateSubscriptionResponse.php', 'net\\authorize\\api\\contract\\v1\\ArbTransactionType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ArbTransactionType.php', 'net\\authorize\\api\\contract\\v1\\ArrayOfSettingType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ArrayOfSettingType.php', 'net\\authorize\\api\\contract\\v1\\AuDeleteType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/AuDeleteType.php', 'net\\authorize\\api\\contract\\v1\\AuDetailsType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/AuDetailsType.php', 'net\\authorize\\api\\contract\\v1\\AuResponseType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/AuResponseType.php', 'net\\authorize\\api\\contract\\v1\\AuUpdateType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/AuUpdateType.php', 'net\\authorize\\api\\contract\\v1\\AuthenticateTestRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/AuthenticateTestRequest.php', 'net\\authorize\\api\\contract\\v1\\AuthenticateTestResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/AuthenticateTestResponse.php', 'net\\authorize\\api\\contract\\v1\\BankAccountMaskedType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/BankAccountMaskedType.php', 'net\\authorize\\api\\contract\\v1\\BankAccountType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/BankAccountType.php', 'net\\authorize\\api\\contract\\v1\\BatchDetailsType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/BatchDetailsType.php', 'net\\authorize\\api\\contract\\v1\\BatchStatisticType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/BatchStatisticType.php', 'net\\authorize\\api\\contract\\v1\\CardArtType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CardArtType.php', 'net\\authorize\\api\\contract\\v1\\CcAuthenticationType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CcAuthenticationType.php', 'net\\authorize\\api\\contract\\v1\\CreateCustomerPaymentProfileRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateCustomerPaymentProfileRequest.php', 'net\\authorize\\api\\contract\\v1\\CreateCustomerPaymentProfileResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateCustomerPaymentProfileResponse.php', 'net\\authorize\\api\\contract\\v1\\CreateCustomerProfileFromTransactionRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateCustomerProfileFromTransactionRequest.php', 'net\\authorize\\api\\contract\\v1\\CreateCustomerProfileRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateCustomerProfileRequest.php', 'net\\authorize\\api\\contract\\v1\\CreateCustomerProfileResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateCustomerProfileResponse.php', 'net\\authorize\\api\\contract\\v1\\CreateCustomerProfileTransactionRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateCustomerProfileTransactionRequest.php', 'net\\authorize\\api\\contract\\v1\\CreateCustomerProfileTransactionResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateCustomerProfileTransactionResponse.php', 'net\\authorize\\api\\contract\\v1\\CreateCustomerShippingAddressRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateCustomerShippingAddressRequest.php', 'net\\authorize\\api\\contract\\v1\\CreateCustomerShippingAddressResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateCustomerShippingAddressResponse.php', 'net\\authorize\\api\\contract\\v1\\CreateProfileResponseType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateProfileResponseType.php', 'net\\authorize\\api\\contract\\v1\\CreateTransactionRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateTransactionRequest.php', 'net\\authorize\\api\\contract\\v1\\CreateTransactionResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreateTransactionResponse.php', 'net\\authorize\\api\\contract\\v1\\CreditCardMaskedType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreditCardMaskedType.php', 'net\\authorize\\api\\contract\\v1\\CreditCardSimpleType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreditCardSimpleType.php', 'net\\authorize\\api\\contract\\v1\\CreditCardTrackType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreditCardTrackType.php', 'net\\authorize\\api\\contract\\v1\\CreditCardType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CreditCardType.php', 'net\\authorize\\api\\contract\\v1\\CustomerAddressExType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerAddressExType.php', 'net\\authorize\\api\\contract\\v1\\CustomerAddressType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerAddressType.php', 'net\\authorize\\api\\contract\\v1\\CustomerDataType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerDataType.php', 'net\\authorize\\api\\contract\\v1\\CustomerPaymentProfileBaseType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerPaymentProfileBaseType.php', 'net\\authorize\\api\\contract\\v1\\CustomerPaymentProfileExType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerPaymentProfileExType.php', 'net\\authorize\\api\\contract\\v1\\CustomerPaymentProfileListItemType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerPaymentProfileListItemType.php', 'net\\authorize\\api\\contract\\v1\\CustomerPaymentProfileMaskedType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerPaymentProfileMaskedType.php', 'net\\authorize\\api\\contract\\v1\\CustomerPaymentProfileSortingType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerPaymentProfileSortingType.php', 'net\\authorize\\api\\contract\\v1\\CustomerPaymentProfileType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerPaymentProfileType.php', 'net\\authorize\\api\\contract\\v1\\CustomerProfileBaseType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerProfileBaseType.php', 'net\\authorize\\api\\contract\\v1\\CustomerProfileExType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerProfileExType.php', 'net\\authorize\\api\\contract\\v1\\CustomerProfileIdType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerProfileIdType.php', 'net\\authorize\\api\\contract\\v1\\CustomerProfileInfoExType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerProfileInfoExType.php', 'net\\authorize\\api\\contract\\v1\\CustomerProfileMaskedType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerProfileMaskedType.php', 'net\\authorize\\api\\contract\\v1\\CustomerProfilePaymentType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerProfilePaymentType.php', 'net\\authorize\\api\\contract\\v1\\CustomerProfileSummaryType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerProfileSummaryType.php', 'net\\authorize\\api\\contract\\v1\\CustomerProfileType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerProfileType.php', 'net\\authorize\\api\\contract\\v1\\CustomerType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/CustomerType.php', 'net\\authorize\\api\\contract\\v1\\DecryptPaymentDataRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/DecryptPaymentDataRequest.php', 'net\\authorize\\api\\contract\\v1\\DecryptPaymentDataResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/DecryptPaymentDataResponse.php', 'net\\authorize\\api\\contract\\v1\\DeleteCustomerPaymentProfileRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/DeleteCustomerPaymentProfileRequest.php', 'net\\authorize\\api\\contract\\v1\\DeleteCustomerPaymentProfileResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/DeleteCustomerPaymentProfileResponse.php', 'net\\authorize\\api\\contract\\v1\\DeleteCustomerProfileRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/DeleteCustomerProfileRequest.php', 'net\\authorize\\api\\contract\\v1\\DeleteCustomerProfileResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/DeleteCustomerProfileResponse.php', 'net\\authorize\\api\\contract\\v1\\DeleteCustomerShippingAddressRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/DeleteCustomerShippingAddressRequest.php', 'net\\authorize\\api\\contract\\v1\\DeleteCustomerShippingAddressResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/DeleteCustomerShippingAddressResponse.php', 'net\\authorize\\api\\contract\\v1\\DriversLicenseMaskedType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/DriversLicenseMaskedType.php', 'net\\authorize\\api\\contract\\v1\\DriversLicenseType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/DriversLicenseType.php', 'net\\authorize\\api\\contract\\v1\\EmailSettingsType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/EmailSettingsType.php', 'net\\authorize\\api\\contract\\v1\\EmvTagType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/EmvTagType.php', 'net\\authorize\\api\\contract\\v1\\EncryptedTrackDataType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/EncryptedTrackDataType.php', 'net\\authorize\\api\\contract\\v1\\EnumCollection' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/EnumCollection.php', 'net\\authorize\\api\\contract\\v1\\ErrorResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ErrorResponse.php', 'net\\authorize\\api\\contract\\v1\\ExtendedAmountType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ExtendedAmountType.php', 'net\\authorize\\api\\contract\\v1\\FDSFilterType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/FDSFilterType.php', 'net\\authorize\\api\\contract\\v1\\FingerPrintType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/FingerPrintType.php', 'net\\authorize\\api\\contract\\v1\\FraudInformationType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/FraudInformationType.php', 'net\\authorize\\api\\contract\\v1\\GetAUJobDetailsRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetAUJobDetailsRequest.php', 'net\\authorize\\api\\contract\\v1\\GetAUJobDetailsResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetAUJobDetailsResponse.php', 'net\\authorize\\api\\contract\\v1\\GetAUJobSummaryRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetAUJobSummaryRequest.php', 'net\\authorize\\api\\contract\\v1\\GetAUJobSummaryResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetAUJobSummaryResponse.php', 'net\\authorize\\api\\contract\\v1\\GetBatchStatisticsRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetBatchStatisticsRequest.php', 'net\\authorize\\api\\contract\\v1\\GetBatchStatisticsResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetBatchStatisticsResponse.php', 'net\\authorize\\api\\contract\\v1\\GetCustomerPaymentProfileListRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetCustomerPaymentProfileListRequest.php', 'net\\authorize\\api\\contract\\v1\\GetCustomerPaymentProfileListResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetCustomerPaymentProfileListResponse.php', 'net\\authorize\\api\\contract\\v1\\GetCustomerPaymentProfileRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetCustomerPaymentProfileRequest.php', 'net\\authorize\\api\\contract\\v1\\GetCustomerPaymentProfileResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetCustomerPaymentProfileResponse.php', 'net\\authorize\\api\\contract\\v1\\GetCustomerProfileIdsRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetCustomerProfileIdsRequest.php', 'net\\authorize\\api\\contract\\v1\\GetCustomerProfileIdsResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetCustomerProfileIdsResponse.php', 'net\\authorize\\api\\contract\\v1\\GetCustomerProfileRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetCustomerProfileRequest.php', 'net\\authorize\\api\\contract\\v1\\GetCustomerProfileResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetCustomerProfileResponse.php', 'net\\authorize\\api\\contract\\v1\\GetCustomerShippingAddressRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetCustomerShippingAddressRequest.php', 'net\\authorize\\api\\contract\\v1\\GetCustomerShippingAddressResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetCustomerShippingAddressResponse.php', 'net\\authorize\\api\\contract\\v1\\GetHostedPaymentPageRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetHostedPaymentPageRequest.php', 'net\\authorize\\api\\contract\\v1\\GetHostedPaymentPageResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetHostedPaymentPageResponse.php', 'net\\authorize\\api\\contract\\v1\\GetHostedProfilePageRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetHostedProfilePageRequest.php', 'net\\authorize\\api\\contract\\v1\\GetHostedProfilePageResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetHostedProfilePageResponse.php', 'net\\authorize\\api\\contract\\v1\\GetMerchantDetailsRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetMerchantDetailsRequest.php', 'net\\authorize\\api\\contract\\v1\\GetMerchantDetailsResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetMerchantDetailsResponse.php', 'net\\authorize\\api\\contract\\v1\\GetSettledBatchListRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetSettledBatchListRequest.php', 'net\\authorize\\api\\contract\\v1\\GetSettledBatchListResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetSettledBatchListResponse.php', 'net\\authorize\\api\\contract\\v1\\GetTransactionDetailsRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetTransactionDetailsRequest.php', 'net\\authorize\\api\\contract\\v1\\GetTransactionDetailsResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetTransactionDetailsResponse.php', 'net\\authorize\\api\\contract\\v1\\GetTransactionListForCustomerRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetTransactionListForCustomerRequest.php', 'net\\authorize\\api\\contract\\v1\\GetTransactionListRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetTransactionListRequest.php', 'net\\authorize\\api\\contract\\v1\\GetTransactionListResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetTransactionListResponse.php', 'net\\authorize\\api\\contract\\v1\\GetUnsettledTransactionListRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetUnsettledTransactionListRequest.php', 'net\\authorize\\api\\contract\\v1\\GetUnsettledTransactionListResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/GetUnsettledTransactionListResponse.php', 'net\\authorize\\api\\contract\\v1\\HeldTransactionRequestType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/HeldTransactionRequestType.php', 'net\\authorize\\api\\contract\\v1\\ImpersonationAuthenticationType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ImpersonationAuthenticationType.php', 'net\\authorize\\api\\contract\\v1\\IsAliveRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/IsAliveRequest.php', 'net\\authorize\\api\\contract\\v1\\IsAliveResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/IsAliveResponse.php', 'net\\authorize\\api\\contract\\v1\\KeyBlockType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/KeyBlockType.php', 'net\\authorize\\api\\contract\\v1\\KeyManagementSchemeType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/KeyManagementSchemeType.php', 'net\\authorize\\api\\contract\\v1\\KeyManagementSchemeType\\DUKPTAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/KeyManagementSchemeType/DUKPTAType.php', 'net\\authorize\\api\\contract\\v1\\KeyManagementSchemeType\\DUKPTAType\\DeviceInfoAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/KeyManagementSchemeType/DUKPTAType/DeviceInfoAType.php', 'net\\authorize\\api\\contract\\v1\\KeyManagementSchemeType\\DUKPTAType\\EncryptedDataAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/KeyManagementSchemeType/DUKPTAType/EncryptedDataAType.php', 'net\\authorize\\api\\contract\\v1\\KeyManagementSchemeType\\DUKPTAType\\ModeAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/KeyManagementSchemeType/DUKPTAType/ModeAType.php', 'net\\authorize\\api\\contract\\v1\\KeyValueType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/KeyValueType.php', 'net\\authorize\\api\\contract\\v1\\LineItemType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/LineItemType.php', 'net\\authorize\\api\\contract\\v1\\ListOfAUDetailsType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ListOfAUDetailsType.php', 'net\\authorize\\api\\contract\\v1\\LogoutRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/LogoutRequest.php', 'net\\authorize\\api\\contract\\v1\\LogoutResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/LogoutResponse.php', 'net\\authorize\\api\\contract\\v1\\MerchantAuthenticationType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/MerchantAuthenticationType.php', 'net\\authorize\\api\\contract\\v1\\MerchantContactType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/MerchantContactType.php', 'net\\authorize\\api\\contract\\v1\\MessagesType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/MessagesType.php', 'net\\authorize\\api\\contract\\v1\\MessagesType\\MessageAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/MessagesType/MessageAType.php', 'net\\authorize\\api\\contract\\v1\\MobileDeviceLoginRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/MobileDeviceLoginRequest.php', 'net\\authorize\\api\\contract\\v1\\MobileDeviceLoginResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/MobileDeviceLoginResponse.php', 'net\\authorize\\api\\contract\\v1\\MobileDeviceRegistrationRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/MobileDeviceRegistrationRequest.php', 'net\\authorize\\api\\contract\\v1\\MobileDeviceRegistrationResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/MobileDeviceRegistrationResponse.php', 'net\\authorize\\api\\contract\\v1\\MobileDeviceType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/MobileDeviceType.php', 'net\\authorize\\api\\contract\\v1\\NameAndAddressType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/NameAndAddressType.php', 'net\\authorize\\api\\contract\\v1\\OpaqueDataType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/OpaqueDataType.php', 'net\\authorize\\api\\contract\\v1\\OrderExType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/OrderExType.php', 'net\\authorize\\api\\contract\\v1\\OrderType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/OrderType.php', 'net\\authorize\\api\\contract\\v1\\PagingType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PagingType.php', 'net\\authorize\\api\\contract\\v1\\PayPalType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PayPalType.php', 'net\\authorize\\api\\contract\\v1\\PaymentDetailsType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PaymentDetailsType.php', 'net\\authorize\\api\\contract\\v1\\PaymentEmvType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PaymentEmvType.php', 'net\\authorize\\api\\contract\\v1\\PaymentMaskedType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PaymentMaskedType.php', 'net\\authorize\\api\\contract\\v1\\PaymentProfileType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PaymentProfileType.php', 'net\\authorize\\api\\contract\\v1\\PaymentScheduleType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PaymentScheduleType.php', 'net\\authorize\\api\\contract\\v1\\PaymentScheduleType\\IntervalAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PaymentScheduleType/IntervalAType.php', 'net\\authorize\\api\\contract\\v1\\PaymentSimpleType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PaymentSimpleType.php', 'net\\authorize\\api\\contract\\v1\\PaymentType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PaymentType.php', 'net\\authorize\\api\\contract\\v1\\PermissionType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/PermissionType.php', 'net\\authorize\\api\\contract\\v1\\ProcessorType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ProcessorType.php', 'net\\authorize\\api\\contract\\v1\\ProfileTransAmountType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ProfileTransAmountType.php', 'net\\authorize\\api\\contract\\v1\\ProfileTransAuthCaptureType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ProfileTransAuthCaptureType.php', 'net\\authorize\\api\\contract\\v1\\ProfileTransAuthOnlyType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ProfileTransAuthOnlyType.php', 'net\\authorize\\api\\contract\\v1\\ProfileTransCaptureOnlyType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ProfileTransCaptureOnlyType.php', 'net\\authorize\\api\\contract\\v1\\ProfileTransOrderType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ProfileTransOrderType.php', 'net\\authorize\\api\\contract\\v1\\ProfileTransPriorAuthCaptureType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ProfileTransPriorAuthCaptureType.php', 'net\\authorize\\api\\contract\\v1\\ProfileTransRefundType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ProfileTransRefundType.php', 'net\\authorize\\api\\contract\\v1\\ProfileTransVoidType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ProfileTransVoidType.php', 'net\\authorize\\api\\contract\\v1\\ProfileTransactionType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ProfileTransactionType.php', 'net\\authorize\\api\\contract\\v1\\ReturnedItemType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ReturnedItemType.php', 'net\\authorize\\api\\contract\\v1\\SecurePaymentContainerErrorType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SecurePaymentContainerErrorType.php', 'net\\authorize\\api\\contract\\v1\\SecurePaymentContainerRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SecurePaymentContainerRequest.php', 'net\\authorize\\api\\contract\\v1\\SecurePaymentContainerResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SecurePaymentContainerResponse.php', 'net\\authorize\\api\\contract\\v1\\SendCustomerTransactionReceiptRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SendCustomerTransactionReceiptRequest.php', 'net\\authorize\\api\\contract\\v1\\SendCustomerTransactionReceiptResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SendCustomerTransactionReceiptResponse.php', 'net\\authorize\\api\\contract\\v1\\SettingType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SettingType.php', 'net\\authorize\\api\\contract\\v1\\SolutionType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SolutionType.php', 'net\\authorize\\api\\contract\\v1\\SubMerchantType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SubMerchantType.php', 'net\\authorize\\api\\contract\\v1\\SubscriptionCustomerProfileType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SubscriptionCustomerProfileType.php', 'net\\authorize\\api\\contract\\v1\\SubscriptionDetailType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SubscriptionDetailType.php', 'net\\authorize\\api\\contract\\v1\\SubscriptionPaymentType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/SubscriptionPaymentType.php', 'net\\authorize\\api\\contract\\v1\\TokenMaskedType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TokenMaskedType.php', 'net\\authorize\\api\\contract\\v1\\TransRetailInfoType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransRetailInfoType.php', 'net\\authorize\\api\\contract\\v1\\TransactionDetailsType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionDetailsType.php', 'net\\authorize\\api\\contract\\v1\\TransactionDetailsType\\EmvDetailsAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionDetailsType/EmvDetailsAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionDetailsType\\EmvDetailsAType\\TagAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionDetailsType/EmvDetailsAType/TagAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionListSortingType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionListSortingType.php', 'net\\authorize\\api\\contract\\v1\\TransactionRequestType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionRequestType.php', 'net\\authorize\\api\\contract\\v1\\TransactionRequestType\\UserFieldsAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionRequestType/UserFieldsAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\EmvResponseAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/EmvResponseAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\EmvResponseAType\\TagsAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/EmvResponseAType/TagsAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\ErrorsAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/ErrorsAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\ErrorsAType\\ErrorAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/ErrorsAType/ErrorAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\MessagesAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/MessagesAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\MessagesAType\\MessageAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/MessagesAType/MessageAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\PrePaidCardAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/PrePaidCardAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\SecureAcceptanceAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/SecureAcceptanceAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\SplitTenderPaymentsAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/SplitTenderPaymentsAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\SplitTenderPaymentsAType\\SplitTenderPaymentAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/SplitTenderPaymentsAType/SplitTenderPaymentAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionResponseType\\UserFieldsAType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionResponseType/UserFieldsAType.php', 'net\\authorize\\api\\contract\\v1\\TransactionSummaryType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/TransactionSummaryType.php', 'net\\authorize\\api\\contract\\v1\\UpdateCustomerPaymentProfileRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UpdateCustomerPaymentProfileRequest.php', 'net\\authorize\\api\\contract\\v1\\UpdateCustomerPaymentProfileResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UpdateCustomerPaymentProfileResponse.php', 'net\\authorize\\api\\contract\\v1\\UpdateCustomerProfileRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UpdateCustomerProfileRequest.php', 'net\\authorize\\api\\contract\\v1\\UpdateCustomerProfileResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UpdateCustomerProfileResponse.php', 'net\\authorize\\api\\contract\\v1\\UpdateCustomerShippingAddressRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UpdateCustomerShippingAddressRequest.php', 'net\\authorize\\api\\contract\\v1\\UpdateCustomerShippingAddressResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UpdateCustomerShippingAddressResponse.php', 'net\\authorize\\api\\contract\\v1\\UpdateHeldTransactionRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UpdateHeldTransactionRequest.php', 'net\\authorize\\api\\contract\\v1\\UpdateHeldTransactionResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UpdateHeldTransactionResponse.php', 'net\\authorize\\api\\contract\\v1\\UpdateSplitTenderGroupRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UpdateSplitTenderGroupRequest.php', 'net\\authorize\\api\\contract\\v1\\UpdateSplitTenderGroupResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UpdateSplitTenderGroupResponse.php', 'net\\authorize\\api\\contract\\v1\\UserFieldType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/UserFieldType.php', 'net\\authorize\\api\\contract\\v1\\ValidateCustomerPaymentProfileRequest' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ValidateCustomerPaymentProfileRequest.php', 'net\\authorize\\api\\contract\\v1\\ValidateCustomerPaymentProfileResponse' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/ValidateCustomerPaymentProfileResponse.php', 'net\\authorize\\api\\contract\\v1\\WebCheckOutDataType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/contract/v1/WebCheckOutDataType.php', 'net\\authorize\\api\\controller\\ARBCancelSubscriptionController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/ARBCancelSubscriptionController.php', 'net\\authorize\\api\\controller\\ARBCreateSubscriptionController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/ARBCreateSubscriptionController.php', 'net\\authorize\\api\\controller\\ARBGetSubscriptionController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/ARBGetSubscriptionController.php', 'net\\authorize\\api\\controller\\ARBGetSubscriptionListController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/ARBGetSubscriptionListController.php', 'net\\authorize\\api\\controller\\ARBGetSubscriptionStatusController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/ARBGetSubscriptionStatusController.php', 'net\\authorize\\api\\controller\\ARBUpdateSubscriptionController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/ARBUpdateSubscriptionController.php', 'net\\authorize\\api\\controller\\AuthenticateTestController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/AuthenticateTestController.php', 'net\\authorize\\api\\controller\\CreateCustomerPaymentProfileController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/CreateCustomerPaymentProfileController.php', 'net\\authorize\\api\\controller\\CreateCustomerProfileController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/CreateCustomerProfileController.php', 'net\\authorize\\api\\controller\\CreateCustomerProfileFromTransactionController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/CreateCustomerProfileFromTransactionController.php', 'net\\authorize\\api\\controller\\CreateCustomerProfileTransactionController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/CreateCustomerProfileTransactionController.php', 'net\\authorize\\api\\controller\\CreateCustomerShippingAddressController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/CreateCustomerShippingAddressController.php', 'net\\authorize\\api\\controller\\CreateTransactionController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/CreateTransactionController.php', 'net\\authorize\\api\\controller\\DecryptPaymentDataController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/DecryptPaymentDataController.php', 'net\\authorize\\api\\controller\\DeleteCustomerPaymentProfileController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/DeleteCustomerPaymentProfileController.php', 'net\\authorize\\api\\controller\\DeleteCustomerProfileController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/DeleteCustomerProfileController.php', 'net\\authorize\\api\\controller\\DeleteCustomerShippingAddressController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/DeleteCustomerShippingAddressController.php', 'net\\authorize\\api\\controller\\GetAUJobDetailsController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetAUJobDetailsController.php', 'net\\authorize\\api\\controller\\GetAUJobSummaryController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetAUJobSummaryController.php', 'net\\authorize\\api\\controller\\GetBatchStatisticsController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetBatchStatisticsController.php', 'net\\authorize\\api\\controller\\GetCustomerPaymentProfileController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetCustomerPaymentProfileController.php', 'net\\authorize\\api\\controller\\GetCustomerPaymentProfileListController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetCustomerPaymentProfileListController.php', 'net\\authorize\\api\\controller\\GetCustomerProfileController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetCustomerProfileController.php', 'net\\authorize\\api\\controller\\GetCustomerProfileIdsController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetCustomerProfileIdsController.php', 'net\\authorize\\api\\controller\\GetCustomerShippingAddressController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetCustomerShippingAddressController.php', 'net\\authorize\\api\\controller\\GetHostedPaymentPageController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetHostedPaymentPageController.php', 'net\\authorize\\api\\controller\\GetHostedProfilePageController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetHostedProfilePageController.php', 'net\\authorize\\api\\controller\\GetMerchantDetailsController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetMerchantDetailsController.php', 'net\\authorize\\api\\controller\\GetSettledBatchListController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetSettledBatchListController.php', 'net\\authorize\\api\\controller\\GetTransactionDetailsController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetTransactionDetailsController.php', 'net\\authorize\\api\\controller\\GetTransactionListController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetTransactionListController.php', 'net\\authorize\\api\\controller\\GetTransactionListForCustomerController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetTransactionListForCustomerController.php', 'net\\authorize\\api\\controller\\GetUnsettledTransactionListController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/GetUnsettledTransactionListController.php', 'net\\authorize\\api\\controller\\IsAliveController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/IsAliveController.php', 'net\\authorize\\api\\controller\\LogoutController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/LogoutController.php', 'net\\authorize\\api\\controller\\MobileDeviceLoginController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/MobileDeviceLoginController.php', 'net\\authorize\\api\\controller\\MobileDeviceRegistrationController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/MobileDeviceRegistrationController.php', 'net\\authorize\\api\\controller\\SecurePaymentContainerController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/SecurePaymentContainerController.php', 'net\\authorize\\api\\controller\\SendCustomerTransactionReceiptController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/SendCustomerTransactionReceiptController.php', 'net\\authorize\\api\\controller\\UpdateCustomerPaymentProfileController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/UpdateCustomerPaymentProfileController.php', 'net\\authorize\\api\\controller\\UpdateCustomerProfileController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/UpdateCustomerProfileController.php', 'net\\authorize\\api\\controller\\UpdateCustomerShippingAddressController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/UpdateCustomerShippingAddressController.php', 'net\\authorize\\api\\controller\\UpdateHeldTransactionController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/UpdateHeldTransactionController.php', 'net\\authorize\\api\\controller\\UpdateSplitTenderGroupController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/UpdateSplitTenderGroupController.php', 'net\\authorize\\api\\controller\\ValidateCustomerPaymentProfileController' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/ValidateCustomerPaymentProfileController.php', 'net\\authorize\\api\\controller\\base\\ApiOperationBase' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/base/ApiOperationBase.php', 'net\\authorize\\api\\controller\\base\\IApiOperation' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/api/controller/base/IApiOperation.php', 'net\\authorize\\util\\ANetSensitiveFields' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/util/ANetSensitiveFields.php', 'net\\authorize\\util\\Helpers' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/util/Helpers.php', 'net\\authorize\\util\\HttpClient' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/util/HttpClient.php', 'net\\authorize\\util\\Log' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/util/Log.php', 'net\\authorize\\util\\LogFactory' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/util/LogFactory.php', 'net\\authorize\\util\\SensitiveDataConfigType' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/util/SensitiveDataConfigType.php', 'net\\authorize\\util\\SensitiveTag' => __DIR__ . '/..' . '/authorizenet/authorizenet/lib/net/authorize/util/SensitiveTag.php', 'phlyLabs_Net_IDNA' => __DIR__ . '/..' . '/phlylabs/net/IDNA.php');
public static function getInitializer(\Composer\Autoload\ClassLoader $loader)
{
}
}
}
namespace Monolog {
/**
* Monolog error handler
*
* A facility to enable logging of runtime errors, exceptions and fatal errors.
*
* Quick setup: <code>ErrorHandler::register($logger);</code>
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class ErrorHandler
{
public function __construct(\Psr\Log\LoggerInterface $logger)
{
}
/**
* Registers a new ErrorHandler for a given Logger
*
* By default it will handle errors, exceptions and fatal errors
*
* @param LoggerInterface $logger
* @param array|false $errorLevelMap an array of E_* constant to LogLevel::* constant mapping, or false to disable error handling
* @param int|false $exceptionLevel a LogLevel::* constant, or false to disable exception handling
* @param int|false $fatalLevel a LogLevel::* constant, or false to disable fatal error handling
* @return ErrorHandler
*/
public static function register(\Psr\Log\LoggerInterface $logger, $errorLevelMap = array(), $exceptionLevel = null, $fatalLevel = null)
{
}
public function registerExceptionHandler($level = null, $callPrevious = true)
{
}
public function registerErrorHandler(array $levelMap = array(), $callPrevious = true, $errorTypes = -1)
{
}
public function registerFatalHandler($level = null, $reservedMemorySize = 20)
{
}
protected function defaultErrorLevelMap()
{
}
/**
* @private
*/
public function handleException($e)
{
}
/**
* @private
*/
public function handleError($code, $message, $file = '', $line = 0, $context = array())
{
}
/**
* @private
*/
public function handleFatalError()
{
}
}
/**
* Monolog log registry
*
* Allows to get `Logger` instances in the global scope
* via static method calls on this class.
*
* <code>
* $application = new Monolog\Logger('application');
* $api = new Monolog\Logger('api');
*
* Monolog\Registry::addLogger($application);
* Monolog\Registry::addLogger($api);
*
* function testLogger()
* {
* Monolog\Registry::api()->addError('Sent to $api Logger instance');
* Monolog\Registry::application()->addError('Sent to $application Logger instance');
* }
* </code>
*
* @author Tomas Tatarko <tomas@tatarko.sk>
*/
class Registry
{
/**
* Adds new logging channel to the registry
*
* @param Logger $logger Instance of the logging channel
* @param string|null $name Name of the logging channel ($logger->getName() by default)
* @param bool $overwrite Overwrite instance in the registry if the given name already exists?
* @throws \InvalidArgumentException If $overwrite set to false and named Logger instance already exists
*/
public static function addLogger(\Monolog\Logger $logger, $name = null, $overwrite = false)
{
}
/**
* Checks if such logging channel exists by name or instance
*
* @param string|Logger $logger Name or logger instance
*/
public static function hasLogger($logger)
{
}
/**
* Removes instance from registry by name or instance
*
* @param string|Logger $logger Name or logger instance
*/
public static function removeLogger($logger)
{
}
/**
* Clears the registry
*/
public static function clear()
{
}
/**
* Gets Logger instance from the registry
*
* @param string $name Name of the requested Logger instance
* @throws \InvalidArgumentException If named Logger instance is not in the registry
* @return Logger Requested instance of Logger
*/
public static function getInstance($name)
{
}
/**
* Gets Logger instance from the registry via static method call
*
* @param string $name Name of the requested Logger instance
* @param array $arguments Arguments passed to static method call
* @throws \InvalidArgumentException If named Logger instance is not in the registry
* @return Logger Requested instance of Logger
*/
public static function __callStatic($name, $arguments)
{
}
}
}
namespace Monolog\Handler {
/**
* Interface that all Monolog Handlers must implement
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
interface HandlerInterface
{
/**
* Checks whether the given record will be handled by this handler.
*
* This is mostly done for performance reasons, to avoid calling processors for nothing.
*
* Handlers should still check the record levels within handle(), returning false in isHandling()
* is no guarantee that handle() will not be called, and isHandling() might not be called
* for a given record.
*
* @param array $record Partial log record containing only a level key
*
* @return Boolean
*/
public function isHandling(array $record);
/**
* Handles a record.
*
* All records may be passed to this method, and the handler should discard
* those that it does not want to handle.
*
* The return value of this function controls the bubbling process of the handler stack.
* Unless the bubbling is interrupted (by returning true), the Logger class will keep on
* calling further handlers in the stack with a given log record.
*
* @param array $record The record to handle
* @return Boolean true means that this handler handled the record, and that bubbling is not permitted.
* false means the record was either not processed or that this handler allows bubbling.
*/
public function handle(array $record);
/**
* Handles a set of records at once.
*
* @param array $records The records to handle (an array of record arrays)
*/
public function handleBatch(array $records);
/**
* Adds a processor in the stack.
*
* @param callable $callback
* @return self
*/
public function pushProcessor($callback);
/**
* Removes the processor on top of the stack and returns it.
*
* @return callable
*/
public function popProcessor();
/**
* Sets the formatter.
*
* @param FormatterInterface $formatter
* @return self
*/
public function setFormatter(\Monolog\Formatter\FormatterInterface $formatter);
/**
* Gets the formatter.
*
* @return FormatterInterface
*/
public function getFormatter();
}
/**
* This simple wrapper class can be used to extend handlers functionality.
*
* Example: A filtering handle. Inherit from this class, override isHandling() like this
*
* public function isHandling(array $record)
* {
* if ($record meets certain conditions) {
* return false;
* }
* return $this->handler->isHandling($record);
* }
*
* @author Alexey Karapetov <alexey@karapetov.com>
*/
class HandlerWrapper implements \Monolog\Handler\HandlerInterface
{
/**
* HandlerWrapper constructor.
* @param HandlerInterface $handler
*/
public function __construct(\Monolog\Handler\HandlerInterface $handler)
{
}
/**
* {@inheritdoc}
*/
public function isHandling(array $record)
{
}
/**
* {@inheritdoc}
*/
public function handle(array $record)
{
}
/**
* {@inheritdoc}
*/
public function handleBatch(array $records)
{
}
/**
* {@inheritdoc}
*/
public function pushProcessor($callback)
{
}
/**
* {@inheritdoc}
*/
public function popProcessor()
{
}
/**
* {@inheritdoc}
*/
public function setFormatter(\Monolog\Formatter\FormatterInterface $formatter)
{
}
/**
* {@inheritdoc}
*/
public function getFormatter()
{
}
}
}
namespace Monolog\Handler\SyslogUdp {
class UdpSocket
{
const DATAGRAM_MAX_LENGTH = 65023;
protected $ip;
protected $port;
protected $socket;
public function __construct($ip, $port = 514)
{
}
public function write($line, $header = "")
{
}
public function close()
{
}
protected function send($chunk)
{
}
protected function assembleMessage($line, $header)
{
}
}
}
namespace Monolog\Handler {
/**
* Base Handler class providing the Handler structure
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
abstract class AbstractHandler implements \Monolog\Handler\HandlerInterface
{
protected $level = \Monolog\Logger::DEBUG;
protected $bubble = true;
/**
* @var FormatterInterface
*/
protected $formatter;
protected $processors = array();
/**
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
public function isHandling(array $record)
{
}
/**
* {@inheritdoc}
*/
public function handleBatch(array $records)
{
}
/**
* Closes the handler.
*
* This will be called automatically when the object is destroyed
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function pushProcessor($callback)
{
}
/**
* {@inheritdoc}
*/
public function popProcessor()
{
}
/**
* {@inheritdoc}
*/
public function setFormatter(\Monolog\Formatter\FormatterInterface $formatter)
{
}
/**
* {@inheritdoc}
*/
public function getFormatter()
{
}
/**
* Sets minimum logging level at which this handler will be triggered.
*
* @param int|string $level Level or level name
* @return self
*/
public function setLevel($level)
{
}
/**
* Gets minimum logging level at which this handler will be triggered.
*
* @return int
*/
public function getLevel()
{
}
/**
* Sets the bubbling behavior.
*
* @param Boolean $bubble true means that this handler allows bubbling.
* false means that bubbling is not permitted.
* @return self
*/
public function setBubble($bubble)
{
}
/**
* Gets the bubbling behavior.
*
* @return Boolean true means that this handler allows bubbling.
* false means that bubbling is not permitted.
*/
public function getBubble()
{
}
public function __destruct()
{
}
/**
* Gets the default formatter.
*
* @return FormatterInterface
*/
protected function getDefaultFormatter()
{
}
}
/**
* Base Handler class providing the Handler structure
*
* Classes extending it should (in most cases) only implement write($record)
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Christophe Coevoet <stof@notk.org>
*/
abstract class AbstractProcessingHandler extends \Monolog\Handler\AbstractHandler
{
/**
* {@inheritdoc}
*/
public function handle(array $record)
{
}
/**
* Writes the record down to the log of the implementing handler
*
* @param array $record
* @return void
*/
protected abstract function write(array $record);
/**
* Processes a record.
*
* @param array $record
* @return array
*/
protected function processRecord(array $record)
{
}
}
/**
* Base class for all mail handlers
*
* @author Gyula Sallai
*/
abstract class MailHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* {@inheritdoc}
*/
public function handleBatch(array $records)
{
}
/**
* Send a mail with the given content
*
* @param string $content formatted email body to be sent
* @param array $records the array of log records that formed this content
*/
protected abstract function send($content, array $records);
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
}
/**
* MandrillHandler uses cURL to send the emails to the Mandrill API
*
* @author Adam Nicholson <adamnicholson10@gmail.com>
*/
class MandrillHandler extends \Monolog\Handler\MailHandler
{
protected $message;
protected $apiKey;
/**
* @param string $apiKey A valid Mandrill API key
* @param callable|\Swift_Message $message An example message for real messages, only the body will be replaced
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($apiKey, $message, $level = \Monolog\Logger::ERROR, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
protected function send($content, array $records)
{
}
}
/**
* Simple FirePHP Handler (http://www.firephp.org/), which uses the Wildfire protocol.
*
* @author Eric Clemmons (@ericclemmons) <eric@uxdriven.com>
*/
class FirePHPHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* WildFire JSON header message format
*/
const PROTOCOL_URI = 'http://meta.wildfirehq.org/Protocol/JsonStream/0.2';
/**
* FirePHP structure for parsing messages & their presentation
*/
const STRUCTURE_URI = 'http://meta.firephp.org/Wildfire/Structure/FirePHP/FirebugConsole/0.1';
/**
* Must reference a "known" plugin, otherwise headers won't display in FirePHP
*/
const PLUGIN_URI = 'http://meta.firephp.org/Wildfire/Plugin/FirePHP/Library-FirePHPCore/0.3';
/**
* Header prefix for Wildfire to recognize & parse headers
*/
const HEADER_PREFIX = 'X-Wf';
/**
* Whether or not Wildfire vendor-specific headers have been generated & sent yet
*/
protected static $initialized = false;
/**
* Shared static message index between potentially multiple handlers
* @var int
*/
protected static $messageIndex = 1;
protected static $sendHeaders = true;
/**
* Base header creation function used by init headers & record headers
*
* @param array $meta Wildfire Plugin, Protocol & Structure Indexes
* @param string $message Log message
* @return array Complete header string ready for the client as key and message as value
*/
protected function createHeader(array $meta, $message)
{
}
/**
* Creates message header from record
*
* @see createHeader()
* @param array $record
* @return string
*/
protected function createRecordHeader(array $record)
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
/**
* Wildfire initialization headers to enable message parsing
*
* @see createHeader()
* @see sendHeader()
* @return array
*/
protected function getInitHeaders()
{
}
/**
* Send header string to the client
*
* @param string $header
* @param string $content
*/
protected function sendHeader($header, $content)
{
}
/**
* Creates & sends header for a record, ensuring init headers have been sent prior
*
* @see sendHeader()
* @see sendInitHeaders()
* @param array $record
*/
protected function write(array $record)
{
}
/**
* Verifies if the headers are accepted by the current user agent
*
* @return Boolean
*/
protected function headersAccepted()
{
}
/**
* BC getter for the sendHeaders property that has been made static
*/
public function __get($property)
{
}
/**
* BC setter for the sendHeaders property that has been made static
*/
public function __set($property, $value)
{
}
}
/**
* Common syslog functionality
*/
abstract class AbstractSyslogHandler extends \Monolog\Handler\AbstractProcessingHandler
{
protected $facility;
/**
* Translates Monolog log levels to syslog log priorities.
*/
protected $logLevels = array(\Monolog\Logger::DEBUG => LOG_DEBUG, \Monolog\Logger::INFO => LOG_INFO, \Monolog\Logger::NOTICE => LOG_NOTICE, \Monolog\Logger::WARNING => LOG_WARNING, \Monolog\Logger::ERROR => LOG_ERR, \Monolog\Logger::CRITICAL => LOG_CRIT, \Monolog\Logger::ALERT => LOG_ALERT, \Monolog\Logger::EMERGENCY => LOG_EMERG);
/**
* List of valid log facility names.
*/
protected $facilities = array('auth' => LOG_AUTH, 'authpriv' => LOG_AUTHPRIV, 'cron' => LOG_CRON, 'daemon' => LOG_DAEMON, 'kern' => LOG_KERN, 'lpr' => LOG_LPR, 'mail' => LOG_MAIL, 'news' => LOG_NEWS, 'syslog' => LOG_SYSLOG, 'user' => LOG_USER, 'uucp' => LOG_UUCP);
/**
* @param mixed $facility
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($facility = LOG_USER, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
protected function getDefaultFormatter()
{
}
}
/**
* A Handler for logging to a remote syslogd server.
*
* @author Jesper Skovgaard Nielsen <nulpunkt@gmail.com>
*/
class SyslogUdpHandler extends \Monolog\Handler\AbstractSyslogHandler
{
protected $socket;
/**
* @param string $host
* @param int $port
* @param mixed $facility
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($host, $port = 514, $facility = LOG_USER, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
protected function write(array $record)
{
}
public function close()
{
}
/**
* Make common syslog header (see rfc5424)
*/
protected function makeCommonSyslogHeader($severity)
{
}
/**
* Inject your own socket, mainly used for testing
*/
public function setSocket($socket)
{
}
}
/**
* Sampling handler
*
* A sampled event stream can be useful for logging high frequency events in
* a production environment where you only need an idea of what is happening
* and are not concerned with capturing every occurrence. Since the decision to
* handle or not handle a particular event is determined randomly, the
* resulting sampled log is not guaranteed to contain 1/N of the events that
* occurred in the application, but based on the Law of large numbers, it will
* tend to be close to this ratio with a large number of attempts.
*
* @author Bryan Davis <bd808@wikimedia.org>
* @author Kunal Mehta <legoktm@gmail.com>
*/
class SamplingHandler extends \Monolog\Handler\AbstractHandler
{
/**
* @var callable|HandlerInterface $handler
*/
protected $handler;
/**
* @var int $factor
*/
protected $factor;
/**
* @param callable|HandlerInterface $handler Handler or factory callable($record, $fingersCrossedHandler).
* @param int $factor Sample factor
*/
public function __construct($handler, $factor)
{
}
public function isHandling(array $record)
{
}
public function handle(array $record)
{
}
}
/**
* Stores to any socket - uses fsockopen() or pfsockopen().
*
* @author Pablo de Leon Belloc <pablolb@gmail.com>
* @see http://php.net/manual/en/function.fsockopen.php
*/
class SocketHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* @param string $connectionString Socket connection string
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($connectionString, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* Connect (if necessary) and write to the socket
*
* @param array $record
*
* @throws \UnexpectedValueException
* @throws \RuntimeException
*/
protected function write(array $record)
{
}
/**
* We will not close a PersistentSocket instance so it can be reused in other requests.
*/
public function close()
{
}
/**
* Close socket, if open
*/
public function closeSocket()
{
}
/**
* Set socket connection to nbe persistent. It only has effect before the connection is initiated.
*
* @param bool $persistent
*/
public function setPersistent($persistent)
{
}
/**
* Set connection timeout. Only has effect before we connect.
*
* @param float $seconds
*
* @see http://php.net/manual/en/function.fsockopen.php
*/
public function setConnectionTimeout($seconds)
{
}
/**
* Set write timeout. Only has effect before we connect.
*
* @param float $seconds
*
* @see http://php.net/manual/en/function.stream-set-timeout.php
*/
public function setTimeout($seconds)
{
}
/**
* Set writing timeout. Only has effect during connection in the writing cycle.
*
* @param float $seconds 0 for no timeout
*/
public function setWritingTimeout($seconds)
{
}
/**
* Get current connection string
*
* @return string
*/
public function getConnectionString()
{
}
/**
* Get persistent setting
*
* @return bool
*/
public function isPersistent()
{
}
/**
* Get current connection timeout setting
*
* @return float
*/
public function getConnectionTimeout()
{
}
/**
* Get current in-transfer timeout
*
* @return float
*/
public function getTimeout()
{
}
/**
* Get current local writing timeout
*
* @return float
*/
public function getWritingTimeout()
{
}
/**
* Check to see if the socket is currently available.
*
* UDP might appear to be connected but might fail when writing. See http://php.net/fsockopen for details.
*
* @return bool
*/
public function isConnected()
{
}
/**
* Wrapper to allow mocking
*/
protected function pfsockopen()
{
}
/**
* Wrapper to allow mocking
*/
protected function fsockopen()
{
}
/**
* Wrapper to allow mocking
*
* @see http://php.net/manual/en/function.stream-set-timeout.php
*/
protected function streamSetTimeout()
{
}
/**
* Wrapper to allow mocking
*/
protected function fwrite($data)
{
}
/**
* Wrapper to allow mocking
*/
protected function streamGetMetadata()
{
}
protected function generateDataStream($record)
{
}
/**
* @return resource|null
*/
protected function getResource()
{
}
}
/**
* Sends notifications through Slack API
*
* @author Greg Kedzierski <greg@gregkedzierski.com>
* @see https://api.slack.com/
*/
class SlackHandler extends \Monolog\Handler\SocketHandler
{
/**
* @param string $token Slack API token
* @param string $channel Slack channel (encoded ID or name)
* @param string $username Name of a bot
* @param bool $useAttachment Whether the message should be added to Slack as attachment (plain text otherwise)
* @param string|null $iconEmoji The emoji name to use (or null)
* @param int $level The minimum logging level at which this handler will be triggered
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
* @param bool $useShortAttachment Whether the the context/extra messages added to Slack as attachments are in a short style
* @param bool $includeContextAndExtra Whether the attachment should include context and extra data
* @throws MissingExtensionException If no OpenSSL PHP extension configured
*/
public function __construct($token, $channel, $username = 'Monolog', $useAttachment = true, $iconEmoji = null, $level = \Monolog\Logger::CRITICAL, $bubble = true, $useShortAttachment = false, $includeContextAndExtra = false)
{
}
/**
* {@inheritdoc}
*
* @param array $record
* @return string
*/
protected function generateDataStream($record)
{
}
/**
* Prepares content data
*
* @param array $record
* @return array
*/
protected function prepareContentData($record)
{
}
/**
* {@inheritdoc}
*
* @param array $record
*/
protected function write(array $record)
{
}
/**
* Returned a Slack message attachment color associated with
* provided level.
*
* @param int $level
* @return string
*/
protected function getAttachmentColor($level)
{
}
/**
* Stringifies an array of key/value pairs to be used in attachment fields
*
* @param array $fields
* @return string
*/
protected function stringify($fields)
{
}
}
/**
* Logs to syslog service.
*
* usage example:
*
* $log = new Logger('application');
* $syslog = new SyslogHandler('myfacility', 'local6');
* $formatter = new LineFormatter("%channel%.%level_name%: %message% %extra%");
* $syslog->setFormatter($formatter);
* $log->pushHandler($syslog);
*
* @author Sven Paulus <sven@karlsruhe.org>
*/
class SyslogHandler extends \Monolog\Handler\AbstractSyslogHandler
{
protected $ident;
protected $logopts;
/**
* @param string $ident
* @param mixed $facility
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
* @param int $logopts Option flags for the openlog() call, defaults to LOG_PID
*/
public function __construct($ident, $facility = LOG_USER, $level = \Monolog\Logger::DEBUG, $bubble = true, $logopts = LOG_PID)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
}
/**
* CouchDB handler
*
* @author Markus Bachmann <markus.bachmann@bachi.biz>
*/
class CouchDBHandler extends \Monolog\Handler\AbstractProcessingHandler
{
public function __construct(array $options = array(), $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritDoc}
*/
protected function write(array $record)
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
}
/**
* Exception can be thrown if an extension for an handler is missing
*
* @author Christian Bergau <cbergau86@gmail.com>
*/
class MissingExtensionException extends \Exception
{
}
/**
* CouchDB handler for Doctrine CouchDB ODM
*
* @author Markus Bachmann <markus.bachmann@bachi.biz>
*/
class DoctrineCouchDBHandler extends \Monolog\Handler\AbstractProcessingHandler
{
public function __construct(\Doctrine\CouchDB\CouchDBClient $client, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritDoc}
*/
protected function write(array $record)
{
}
protected function getDefaultFormatter()
{
}
}
}
namespace Monolog\Handler\FingersCrossed {
/**
* Interface for activation strategies for the FingersCrossedHandler.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
interface ActivationStrategyInterface
{
/**
* Returns whether the given record activates the handler.
*
* @param array $record
* @return Boolean
*/
public function isHandlerActivated(array $record);
}
/**
* Error level based activation strategy.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
class ErrorLevelActivationStrategy implements \Monolog\Handler\FingersCrossed\ActivationStrategyInterface
{
public function __construct($actionLevel)
{
}
public function isHandlerActivated(array $record)
{
}
}
/**
* Channel and Error level based monolog activation strategy. Allows to trigger activation
* based on level per channel. e.g. trigger activation on level 'ERROR' by default, except
* for records of the 'sql' channel; those should trigger activation on level 'WARN'.
*
* Example:
*
* <code>
* $activationStrategy = new ChannelLevelActivationStrategy(
* Logger::CRITICAL,
* array(
* 'request' => Logger::ALERT,
* 'sensitive' => Logger::ERROR,
* )
* );
* $handler = new FingersCrossedHandler(new StreamHandler('php://stderr'), $activationStrategy);
* </code>
*
* @author Mike Meessen <netmikey@gmail.com>
*/
class ChannelLevelActivationStrategy implements \Monolog\Handler\FingersCrossed\ActivationStrategyInterface
{
/**
* @param int $defaultActionLevel The default action level to be used if the record's category doesn't match any
* @param array $channelToActionLevel An array that maps channel names to action levels.
*/
public function __construct($defaultActionLevel, $channelToActionLevel = array())
{
}
public function isHandlerActivated(array $record)
{
}
}
}
namespace Monolog\Handler {
/**
* Proxies log messages to an existing PSR-3 compliant logger.
*
* @author Michael Moussa <michael.moussa@gmail.com>
*/
class PsrHandler extends \Monolog\Handler\AbstractHandler
{
/**
* PSR-3 compliant logger
*
* @var LoggerInterface
*/
protected $logger;
/**
* @param LoggerInterface $logger The underlying PSR-3 compliant logger to which messages will be proxied
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct(\Psr\Log\LoggerInterface $logger, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritDoc}
*/
public function handle(array $record)
{
}
}
}
namespace Monolog\Handler\Curl {
class Util
{
/**
* Executes a CURL request with optional retries and exception on failure
*
* @param resource $ch curl handler
* @throws \RuntimeException
*/
public static function execute($ch, $retries = 5, $closeAfterDone = true)
{
}
}
}
namespace Monolog\Handler {
/**
* Handler sending logs to Zend Monitor
*
* @author Christian Bergau <cbergau86@gmail.com>
*/
class ZendMonitorHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* Monolog level / ZendMonitor Custom Event priority map
*
* @var array
*/
protected $levelMap = array(\Monolog\Logger::DEBUG => 1, \Monolog\Logger::INFO => 2, \Monolog\Logger::NOTICE => 3, \Monolog\Logger::WARNING => 4, \Monolog\Logger::ERROR => 5, \Monolog\Logger::CRITICAL => 6, \Monolog\Logger::ALERT => 7, \Monolog\Logger::EMERGENCY => 0);
/**
* Construct
*
* @param int $level
* @param bool $bubble
* @throws MissingExtensionException
*/
public function __construct($level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
/**
* Write a record to Zend Monitor
*
* @param int $level
* @param string $message
* @param array $formatted
*/
protected function writeZendMonitorCustomEvent($level, $message, $formatted)
{
}
/**
* {@inheritdoc}
*/
public function getDefaultFormatter()
{
}
/**
* Get the level map
*
* @return array
*/
public function getLevelMap()
{
}
}
/**
* SwiftMailerHandler uses Swift_Mailer to send the emails
*
* @author Gyula Sallai
*/
class SwiftMailerHandler extends \Monolog\Handler\MailHandler
{
protected $mailer;
/**
* @param \Swift_Mailer $mailer The mailer to use
* @param callable|\Swift_Message $message An example message for real messages, only the body will be replaced
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct(\Swift_Mailer $mailer, $message, $level = \Monolog\Logger::ERROR, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
protected function send($content, array $records)
{
}
/**
* Creates instance of Swift_Message to be sent
*
* @param string $content formatted email body to be sent
* @param array $records Log records that formed the content
* @return \Swift_Message
*/
protected function buildMessage($content, array $records)
{
}
/**
* BC getter, to be removed in 2.0
*/
public function __get($name)
{
}
}
/**
* @author Robert Kaufmann III <rok3@rok3.me>
*/
class LogEntriesHandler extends \Monolog\Handler\SocketHandler
{
/**
* @var string
*/
protected $logToken;
/**
* @param string $token Log token supplied by LogEntries
* @param bool $useSSL Whether or not SSL encryption should be used.
* @param int $level The minimum logging level to trigger this handler
* @param bool $bubble Whether or not messages that are handled should bubble up the stack.
*
* @throws MissingExtensionException If SSL encryption is set to true and OpenSSL is missing
*/
public function __construct($token, $useSSL = true, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritdoc}
*
* @param array $record
* @return string
*/
protected function generateDataStream($record)
{
}
}
/**
* Sends errors to Rollbar
*
* If the context data contains a `payload` key, that is used as an array
* of payload options to RollbarNotifier's report_message/report_exception methods.
*
* @author Paul Statezny <paulstatezny@gmail.com>
*/
class RollbarHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* Rollbar notifier
*
* @var RollbarNotifier
*/
protected $rollbarNotifier;
/**
* @param RollbarNotifier $rollbarNotifier RollbarNotifier object constructed with valid token
* @param int $level The minimum logging level at which this handler will be triggered
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct(\RollbarNotifier $rollbarNotifier, $level = \Monolog\Logger::ERROR, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
}
/**
* Sends logs to Fleep.io using Webhook integrations
*
* You'll need a Fleep.io account to use this handler.
*
* @see https://fleep.io/integrations/webhooks/ Fleep Webhooks Documentation
* @author Ando Roots <ando@sqroot.eu>
*/
class FleepHookHandler extends \Monolog\Handler\SocketHandler
{
const FLEEP_HOST = 'fleep.io';
const FLEEP_HOOK_URI = '/hook/';
/**
* @var string Webhook token (specifies the conversation where logs are sent)
*/
protected $token;
/**
* Construct a new Fleep.io Handler.
*
* For instructions on how to create a new web hook in your conversations
* see https://fleep.io/integrations/webhooks/
*
* @param string $token Webhook token
* @param bool|int $level The minimum logging level at which this handler will be triggered
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
* @throws MissingExtensionException
*/
public function __construct($token, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* Returns the default formatter to use with this handler
*
* Overloaded to remove empty context and extra arrays from the end of the log message.
*
* @return LineFormatter
*/
protected function getDefaultFormatter()
{
}
/**
* Handles a log record
*
* @param array $record
*/
public function write(array $record)
{
}
/**
* {@inheritdoc}
*
* @param array $record
* @return string
*/
protected function generateDataStream($record)
{
}
}
/**
* Stores to any stream resource
*
* Can be used to store into php://stderr, remote and local files, etc.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class StreamHandler extends \Monolog\Handler\AbstractProcessingHandler
{
protected $stream;
protected $url;
protected $filePermission;
protected $useLocking;
/**
* @param resource|string $stream
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
* @param int|null $filePermission Optional file permissions (default (0644) are only for owner read/write)
* @param Boolean $useLocking Try to lock log file before doing any writes
*
* @throws \Exception If a missing directory is not buildable
* @throws \InvalidArgumentException If stream is not a resource or string
*/
public function __construct($stream, $level = \Monolog\Logger::DEBUG, $bubble = true, $filePermission = null, $useLocking = false)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
}
/**
* Handler sending logs to the ChromePHP extension (http://www.chromephp.com/)
*
* This also works out of the box with Firefox 43+
*
* @author Christophe Coevoet <stof@notk.org>
*/
class ChromePHPHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* Version of the extension
*/
const VERSION = '4.0';
/**
* Header name
*/
const HEADER_NAME = 'X-ChromeLogger-Data';
protected static $initialized = false;
/**
* Tracks whether we sent too much data
*
* Chrome limits the headers to 256KB, so when we sent 240KB we stop sending
*
* @var Boolean
*/
protected static $overflowed = false;
protected static $json = array('version' => self::VERSION, 'columns' => array('label', 'log', 'backtrace', 'type'), 'rows' => array());
protected static $sendHeaders = true;
/**
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
public function handleBatch(array $records)
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
/**
* Creates & sends header for a record
*
* @see sendHeader()
* @see send()
* @param array $record
*/
protected function write(array $record)
{
}
/**
* Sends the log header
*
* @see sendHeader()
*/
protected function send()
{
}
/**
* Send header string to the client
*
* @param string $header
* @param string $content
*/
protected function sendHeader($header, $content)
{
}
/**
* Verifies if the headers are accepted by the current user agent
*
* @return Boolean
*/
protected function headersAccepted()
{
}
/**
* BC getter for the sendHeaders property that has been made static
*/
public function __get($property)
{
}
/**
* BC setter for the sendHeaders property that has been made static
*/
public function __set($property, $value)
{
}
}
/**
* Forwards records to multiple handlers
*
* @author Lenar Lõhmus <lenar@city.ee>
*/
class GroupHandler extends \Monolog\Handler\AbstractHandler
{
protected $handlers;
/**
* @param array $handlers Array of Handlers.
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct(array $handlers, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
public function isHandling(array $record)
{
}
/**
* {@inheritdoc}
*/
public function handle(array $record)
{
}
/**
* {@inheritdoc}
*/
public function handleBatch(array $records)
{
}
/**
* {@inheritdoc}
*/
public function setFormatter(\Monolog\Formatter\FormatterInterface $formatter)
{
}
}
/**
* Forwards records to multiple handlers suppressing failures of each handler
* and continuing through to give every handler a chance to succeed.
*
* @author Craig D'Amelio <craig@damelio.ca>
*/
class WhatFailureGroupHandler extends \Monolog\Handler\GroupHandler
{
/**
* {@inheritdoc}
*/
public function handle(array $record)
{
}
/**
* {@inheritdoc}
*/
public function handleBatch(array $records)
{
}
}
/**
* Handler to send messages to a Graylog2 (http://www.graylog2.org) server
*
* @author Matt Lehner <mlehner@gmail.com>
* @author Benjamin Zikarsky <benjamin@zikarsky.de>
*/
class GelfHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* @var Publisher the publisher object that sends the message to the server
*/
protected $publisher;
/**
* @param PublisherInterface|IMessagePublisher|Publisher $publisher a publisher object
* @param int $level The minimum logging level at which this handler will be triggered
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($publisher, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
}
/**
* Handler sending logs to browser's javascript console with no browser extension required
*
* @author Olivier Poitrey <rs@dailymotion.com>
*/
class BrowserConsoleHandler extends \Monolog\Handler\AbstractProcessingHandler
{
protected static $initialized = false;
protected static $records = array();
/**
* {@inheritDoc}
*
* Formatted output may contain some formatting markers to be transferred to `console.log` using the %c format.
*
* Example of formatted string:
*
* You can do [[blue text]]{color: blue} or [[green background]]{background-color: green; color: white}
*/
protected function getDefaultFormatter()
{
}
/**
* {@inheritDoc}
*/
protected function write(array $record)
{
}
/**
* Convert records to javascript console commands and send it to the browser.
* This method is automatically called on PHP shutdown if output is HTML or Javascript.
*/
public static function send()
{
}
/**
* Forget all logged records
*/
public static function reset()
{
}
/**
* Wrapper for register_shutdown_function to allow overriding
*/
protected function registerShutdownFunction()
{
}
/**
* Wrapper for echo to allow overriding
*
* @param string $str
*/
protected static function writeOutput($str)
{
}
/**
* Checks the format of the response
*
* If Content-Type is set to application/javascript or text/javascript -> js
* If Content-Type is set to text/html, or is unset -> html
* If Content-Type is anything else -> unknown
*
* @return string One of 'js', 'html' or 'unknown'
*/
protected static function getResponseFormat()
{
}
}
class AmqpHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* @var AMQPExchange|AMQPChannel $exchange
*/
protected $exchange;
/**
* @var string
*/
protected $exchangeName;
/**
* @param AMQPExchange|AMQPChannel $exchange AMQPExchange (php AMQP ext) or PHP AMQP lib channel, ready for use
* @param string $exchangeName
* @param int $level
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($exchange, $exchangeName = 'log', $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritDoc}
*/
protected function write(array $record)
{
}
/**
* {@inheritDoc}
*/
public function handleBatch(array $records)
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
}
/**
* Sends errors to Loggly.
*
* @author Przemek Sobstel <przemek@sobstel.org>
* @author Adam Pancutt <adam@pancutt.com>
* @author Gregory Barchard <gregory@barchard.net>
*/
class LogglyHandler extends \Monolog\Handler\AbstractProcessingHandler
{
const HOST = 'logs-01.loggly.com';
const ENDPOINT_SINGLE = 'inputs';
const ENDPOINT_BATCH = 'bulk';
protected $token;
protected $tag = array();
public function __construct($token, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
public function setTag($tag)
{
}
public function addTag($tag)
{
}
protected function write(array $record)
{
}
public function handleBatch(array $records)
{
}
protected function send($data, $endpoint)
{
}
protected function getDefaultFormatter()
{
}
}
/**
* Monolog handler for Google Chrome extension "PHP Console"
*
* Display PHP error/debug log messages in Google Chrome console and notification popups, executes PHP code remotely
*
* Usage:
* 1. Install Google Chrome extension https://chrome.google.com/webstore/detail/php-console/nfhmhhlpfleoednkpnnnkolmclajemef
* 2. See overview https://github.com/barbushin/php-console#overview
* 3. Install PHP Console library https://github.com/barbushin/php-console#installation
* 4. Example (result will looks like http://i.hizliresim.com/vg3Pz4.png)
*
* $logger = new \Monolog\Logger('all', array(new \Monolog\Handler\PHPConsoleHandler()));
* \Monolog\ErrorHandler::register($logger);
* echo $undefinedVar;
* $logger->addDebug('SELECT * FROM users', array('db', 'time' => 0.012));
* PC::debug($_SERVER); // PHP Console debugger for any type of vars
*
* @author Sergey Barbushin https://www.linkedin.com/in/barbushin
*/
class PHPConsoleHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* @param array $options See \Monolog\Handler\PHPConsoleHandler::$options for more details
* @param Connector|null $connector Instance of \PhpConsole\Connector class (optional)
* @param int $level
* @param bool $bubble
* @throws Exception
*/
public function __construct(array $options = array(), \PhpConsole\Connector $connector = null, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
public function getConnector()
{
}
public function getOptions()
{
}
public function handle(array $record)
{
}
/**
* Writes the record down to the log of the implementing handler
*
* @param array $record
* @return void
*/
protected function write(array $record)
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
}
/**
* NativeMailerHandler uses the mail() function to send the emails
*
* @author Christophe Coevoet <stof@notk.org>
* @author Mark Garrett <mark@moderndeveloperllc.com>
*/
class NativeMailerHandler extends \Monolog\Handler\MailHandler
{
/**
* The email addresses to which the message will be sent
* @var array
*/
protected $to;
/**
* The subject of the email
* @var string
*/
protected $subject;
/**
* Optional headers for the message
* @var array
*/
protected $headers = array();
/**
* Optional parameters for the message
* @var array
*/
protected $parameters = array();
/**
* The wordwrap length for the message
* @var int
*/
protected $maxColumnWidth;
/**
* The Content-type for the message
* @var string
*/
protected $contentType = 'text/plain';
/**
* The encoding for the message
* @var string
*/
protected $encoding = 'utf-8';
/**
* @param string|array $to The receiver of the mail
* @param string $subject The subject of the mail
* @param string $from The sender of the mail
* @param int $level The minimum logging level at which this handler will be triggered
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
* @param int $maxColumnWidth The maximum column width that the message lines will have
*/
public function __construct($to, $subject, $from, $level = \Monolog\Logger::ERROR, $bubble = true, $maxColumnWidth = 70)
{
}
/**
* Add headers to the message
*
* @param string|array $headers Custom added headers
* @return self
*/
public function addHeader($headers)
{
}
/**
* Add parameters to the message
*
* @param string|array $parameters Custom added parameters
* @return self
*/
public function addParameter($parameters)
{
}
/**
* {@inheritdoc}
*/
protected function send($content, array $records)
{
}
/**
* @return string $contentType
*/
public function getContentType()
{
}
/**
* @return string $encoding
*/
public function getEncoding()
{
}
/**
* @param string $contentType The content type of the email - Defaults to text/plain. Use text/html for HTML
* messages.
* @return self
*/
public function setContentType($contentType)
{
}
/**
* @param string $encoding
* @return self
*/
public function setEncoding($encoding)
{
}
}
/**
* Stores logs to files that are rotated every day and a limited number of files are kept.
*
* This rotation is only intended to be used as a workaround. Using logrotate to
* handle the rotation is strongly encouraged when you can use it.
*
* @author Christophe Coevoet <stof@notk.org>
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class RotatingFileHandler extends \Monolog\Handler\StreamHandler
{
protected $filename;
protected $maxFiles;
protected $mustRotate;
protected $nextRotation;
protected $filenameFormat;
protected $dateFormat;
/**
* @param string $filename
* @param int $maxFiles The maximal amount of files to keep (0 means unlimited)
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
* @param int|null $filePermission Optional file permissions (default (0644) are only for owner read/write)
* @param Boolean $useLocking Try to lock log file before doing any writes
*/
public function __construct($filename, $maxFiles = 0, $level = \Monolog\Logger::DEBUG, $bubble = true, $filePermission = null, $useLocking = false)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
public function setFilenameFormat($filenameFormat, $dateFormat)
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
/**
* Rotates the files.
*/
protected function rotate()
{
}
protected function getTimedFilename()
{
}
protected function getGlobPattern()
{
}
}
/**
* Buffers all records until a certain level is reached
*
* The advantage of this approach is that you don't get any clutter in your log files.
* Only requests which actually trigger an error (or whatever your actionLevel is) will be
* in the logs, but they will contain all records, not only those above the level threshold.
*
* You can find the various activation strategies in the
* Monolog\Handler\FingersCrossed\ namespace.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class FingersCrossedHandler extends \Monolog\Handler\AbstractHandler
{
protected $handler;
protected $activationStrategy;
protected $buffering = true;
protected $bufferSize;
protected $buffer = array();
protected $stopBuffering;
protected $passthruLevel;
/**
* @param callable|HandlerInterface $handler Handler or factory callable($record, $fingersCrossedHandler).
* @param int|ActivationStrategyInterface $activationStrategy Strategy which determines when this handler takes action
* @param int $bufferSize How many entries should be buffered at most, beyond that the oldest items are removed from the buffer.
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
* @param Boolean $stopBuffering Whether the handler should stop buffering after being triggered (default true)
* @param int $passthruLevel Minimum level to always flush to handler on close, even if strategy not triggered
*/
public function __construct($handler, $activationStrategy = null, $bufferSize = 0, $bubble = true, $stopBuffering = true, $passthruLevel = null)
{
}
/**
* {@inheritdoc}
*/
public function isHandling(array $record)
{
}
/**
* {@inheritdoc}
*/
public function handle(array $record)
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* Resets the state of the handler. Stops forwarding records to the wrapped handler.
*/
public function reset()
{
}
/**
* Clears the buffer without flushing any messages down to the wrapped handler.
*
* It also resets the handler to its initial buffering state.
*/
public function clear()
{
}
}
/**
* Stores to PHP error_log() handler.
*
* @author Elan Ruusamäe <glen@delfi.ee>
*/
class ErrorLogHandler extends \Monolog\Handler\AbstractProcessingHandler
{
const OPERATING_SYSTEM = 0;
const SAPI = 4;
protected $messageType;
protected $expandNewlines;
/**
* @param int $messageType Says where the error should go.
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
* @param Boolean $expandNewlines If set to true, newlines in the message will be expanded to be take multiple log entries
*/
public function __construct($messageType = self::OPERATING_SYSTEM, $level = \Monolog\Logger::DEBUG, $bubble = true, $expandNewlines = false)
{
}
/**
* @return array With all available types
*/
public static function getAvailableTypes()
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
}
/**
* Handler to send messages to a Sentry (https://github.com/getsentry/sentry) server
* using raven-php (https://github.com/getsentry/raven-php)
*
* @author Marc Abramowitz <marc@marc-abramowitz.com>
*/
class RavenHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* @var Raven_Client the client object that sends the message to the server
*/
protected $ravenClient;
/**
* @var LineFormatter The formatter to use for the logs generated via handleBatch()
*/
protected $batchFormatter;
/**
* @param Raven_Client $ravenClient
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct(\Raven_Client $ravenClient, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
public function handleBatch(array $records)
{
}
/**
* Sets the formatter for the logs generated by handleBatch().
*
* @param FormatterInterface $formatter
*/
public function setBatchFormatter(\Monolog\Formatter\FormatterInterface $formatter)
{
}
/**
* Gets the formatter for the logs generated by handleBatch().
*
* @return FormatterInterface
*/
public function getBatchFormatter()
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
/**
* Gets the default formatter for the logs generated by handleBatch().
*
* @return FormatterInterface
*/
protected function getDefaultBatchFormatter()
{
}
/**
* Gets extra parameters supported by Raven that can be found in "extra" and "context"
*
* @return array
*/
protected function getExtraParameters()
{
}
/**
* @param string $value
*/
public function setRelease($value)
{
}
}
/**
* Logs to Cube.
*
* @link http://square.github.com/cube/
* @author Wan Chen <kami@kamisama.me>
*/
class CubeHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* Create a Cube handler
*
* @throws \UnexpectedValueException when given url is not a valid url.
* A valid url must consist of three parts : protocol://host:port
* Only valid protocols used by Cube are http and udp
*/
public function __construct($url, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* Establish a connection to an UDP socket
*
* @throws \LogicException when unable to connect to the socket
* @throws MissingExtensionException when there is no socket extension
*/
protected function connectUdp()
{
}
/**
* Establish a connection to a http server
* @throws \LogicException when no curl extension
*/
protected function connectHttp()
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
}
/**
* Logs to a Redis key using rpush
*
* usage example:
*
* $log = new Logger('application');
* $redis = new RedisHandler(new Predis\Client("tcp://localhost:6379"), "logs", "prod");
* $log->pushHandler($redis);
*
* @author Thomas Tourlourat <thomas@tourlourat.com>
*/
class RedisHandler extends \Monolog\Handler\AbstractProcessingHandler
{
protected $capSize;
/**
* @param \Predis\Client|\Redis $redis The redis instance
* @param string $key The key name to push records to
* @param int $level The minimum logging level at which this handler will be triggered
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
* @param int $capSize Number of entries to limit list size to
*/
public function __construct($redis, $key, $level = \Monolog\Logger::DEBUG, $bubble = true, $capSize = false)
{
}
/**
* {@inheritDoc}
*/
protected function write(array $record)
{
}
/**
* Write and cap the collection
* Writes the record to the redis list and caps its
*
* @param array $record associative record array
* @return void
*/
protected function writeCapped(array $record)
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
}
/**
* Sends notifications through the pushover api to mobile phones
*
* @author Sebastian Göttschkes <sebastian.goettschkes@googlemail.com>
* @see https://www.pushover.net/api
*/
class PushoverHandler extends \Monolog\Handler\SocketHandler
{
/**
* @param string $token Pushover api token
* @param string|array $users Pushover user id or array of ids the message will be sent to
* @param string $title Title sent to the Pushover API
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
* @param Boolean $useSSL Whether to connect via SSL. Required when pushing messages to users that are not
* the pushover.net app owner. OpenSSL is required for this option.
* @param int $highPriorityLevel The minimum logging level at which this handler will start
* sending "high priority" requests to the Pushover API
* @param int $emergencyLevel The minimum logging level at which this handler will start
* sending "emergency" requests to the Pushover API
* @param int $retry The retry parameter specifies how often (in seconds) the Pushover servers will send the same notification to the user.
* @param int $expire The expire parameter specifies how many seconds your notification will continue to be retried for (every retry seconds).
*/
public function __construct($token, $users, $title = null, $level = \Monolog\Logger::CRITICAL, $bubble = true, $useSSL = true, $highPriorityLevel = \Monolog\Logger::CRITICAL, $emergencyLevel = \Monolog\Logger::EMERGENCY, $retry = 30, $expire = 25200)
{
}
protected function generateDataStream($record)
{
}
protected function write(array $record)
{
}
public function setHighPriorityLevel($value)
{
}
public function setEmergencyLevel($value)
{
}
/**
* Use the formatted message?
* @param bool $value
*/
public function useFormattedMessage($value)
{
}
}
/**
* Sends notifications through the hipchat api to a hipchat room
*
* Notes:
* API token - HipChat API token
* Room - HipChat Room Id or name, where messages are sent
* Name - Name used to send the message (from)
* notify - Should the message trigger a notification in the clients
* version - The API version to use (HipChatHandler::API_V1 | HipChatHandler::API_V2)
*
* @author Rafael Dohms <rafael@doh.ms>
* @see https://www.hipchat.com/docs/api
*/
class HipChatHandler extends \Monolog\Handler\SocketHandler
{
/**
* Use API version 1
*/
const API_V1 = 'v1';
/**
* Use API version v2
*/
const API_V2 = 'v2';
/**
* The maximum allowed length for the name used in the "from" field.
*/
const MAXIMUM_NAME_LENGTH = 15;
/**
* The maximum allowed length for the message.
*/
const MAXIMUM_MESSAGE_LENGTH = 9500;
/**
* @param string $token HipChat API Token
* @param string $room The room that should be alerted of the message (Id or Name)
* @param string $name Name used in the "from" field.
* @param bool $notify Trigger a notification in clients or not
* @param int $level The minimum logging level at which this handler will be triggered
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
* @param bool $useSSL Whether to connect via SSL.
* @param string $format The format of the messages (default to text, can be set to html if you have html in the messages)
* @param string $host The HipChat server hostname.
* @param string $version The HipChat API version (default HipChatHandler::API_V1)
*/
public function __construct($token, $room, $name = 'Monolog', $notify = false, $level = \Monolog\Logger::CRITICAL, $bubble = true, $useSSL = true, $format = 'text', $host = 'api.hipchat.com', $version = self::API_V1)
{
}
/**
* {@inheritdoc}
*
* @param array $record
* @return string
*/
protected function generateDataStream($record)
{
}
/**
* Assigns a color to each level of log records.
*
* @param int $level
* @return string
*/
protected function getAlertColor($level)
{
}
/**
* {@inheritdoc}
*
* @param array $record
*/
protected function write(array $record)
{
}
/**
* {@inheritdoc}
*/
public function handleBatch(array $records)
{
}
}
/**
* Logs to a MongoDB database.
*
* usage example:
*
* $log = new Logger('application');
* $mongodb = new MongoDBHandler(new \Mongo("mongodb://localhost:27017"), "logs", "prod");
* $log->pushHandler($mongodb);
*
* @author Thomas Tourlourat <thomas@tourlourat.com>
*/
class MongoDBHandler extends \Monolog\Handler\AbstractProcessingHandler
{
protected $mongoCollection;
public function __construct($mongo, $database, $collection, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
protected function write(array $record)
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
}
/**
* Blackhole
*
* Any record it can handle will be thrown away. This can be used
* to put on top of an existing stack to override it temporarily.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class NullHandler extends \Monolog\Handler\AbstractHandler
{
/**
* @param int $level The minimum logging level at which this handler will be triggered
*/
public function __construct($level = \Monolog\Logger::DEBUG)
{
}
/**
* {@inheritdoc}
*/
public function handle(array $record)
{
}
}
/**
* Used for testing purposes.
*
* It records all records and gives you access to them for verification.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*
* @method bool hasEmergency($record)
* @method bool hasAlert($record)
* @method bool hasCritical($record)
* @method bool hasError($record)
* @method bool hasWarning($record)
* @method bool hasNotice($record)
* @method bool hasInfo($record)
* @method bool hasDebug($record)
*
* @method bool hasEmergencyRecords()
* @method bool hasAlertRecords()
* @method bool hasCriticalRecords()
* @method bool hasErrorRecords()
* @method bool hasWarningRecords()
* @method bool hasNoticeRecords()
* @method bool hasInfoRecords()
* @method bool hasDebugRecords()
*
* @method bool hasEmergencyThatContains($message)
* @method bool hasAlertThatContains($message)
* @method bool hasCriticalThatContains($message)
* @method bool hasErrorThatContains($message)
* @method bool hasWarningThatContains($message)
* @method bool hasNoticeThatContains($message)
* @method bool hasInfoThatContains($message)
* @method bool hasDebugThatContains($message)
*
* @method bool hasEmergencyThatMatches($message)
* @method bool hasAlertThatMatches($message)
* @method bool hasCriticalThatMatches($message)
* @method bool hasErrorThatMatches($message)
* @method bool hasWarningThatMatches($message)
* @method bool hasNoticeThatMatches($message)
* @method bool hasInfoThatMatches($message)
* @method bool hasDebugThatMatches($message)
*
* @method bool hasEmergencyThatPasses($message)
* @method bool hasAlertThatPasses($message)
* @method bool hasCriticalThatPasses($message)
* @method bool hasErrorThatPasses($message)
* @method bool hasWarningThatPasses($message)
* @method bool hasNoticeThatPasses($message)
* @method bool hasInfoThatPasses($message)
* @method bool hasDebugThatPasses($message)
*/
class TestHandler extends \Monolog\Handler\AbstractProcessingHandler
{
protected $records = array();
protected $recordsByLevel = array();
public function getRecords()
{
}
protected function hasRecordRecords($level)
{
}
protected function hasRecord($record, $level)
{
}
public function hasRecordThatContains($message, $level)
{
}
public function hasRecordThatMatches($regex, $level)
{
}
public function hasRecordThatPasses($predicate, $level)
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
public function __call($method, $args)
{
}
}
/**
* Buffers all records until closing the handler and then pass them as batch.
*
* This is useful for a MailHandler to send only one mail per request instead of
* sending one per log message.
*
* @author Christophe Coevoet <stof@notk.org>
*/
class BufferHandler extends \Monolog\Handler\AbstractHandler
{
protected $handler;
protected $bufferSize = 0;
protected $bufferLimit;
protected $flushOnOverflow;
protected $buffer = array();
protected $initialized = false;
/**
* @param HandlerInterface $handler Handler.
* @param int $bufferLimit How many entries should be buffered at most, beyond that the oldest items are removed from the buffer.
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
* @param Boolean $flushOnOverflow If true, the buffer is flushed when the max size has been reached, by default oldest entries are discarded
*/
public function __construct(\Monolog\Handler\HandlerInterface $handler, $bufferLimit = 0, $level = \Monolog\Logger::DEBUG, $bubble = true, $flushOnOverflow = false)
{
}
/**
* {@inheritdoc}
*/
public function handle(array $record)
{
}
public function flush()
{
}
public function __destruct()
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* Clears the buffer without flushing any messages down to the wrapped handler.
*/
public function clear()
{
}
}
/**
* Elastic Search handler
*
* Usage example:
*
* $client = new \Elastica\Client();
* $options = array(
* 'index' => 'elastic_index_name',
* 'type' => 'elastic_doc_type',
* );
* $handler = new ElasticSearchHandler($client, $options);
* $log = new Logger('application');
* $log->pushHandler($handler);
*
* @author Jelle Vink <jelle.vink@gmail.com>
*/
class ElasticSearchHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* @var Client
*/
protected $client;
/**
* @var array Handler config options
*/
protected $options = array();
/**
* @param Client $client Elastica Client object
* @param array $options Handler configuration
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct(\Elastica\Client $client, array $options = array(), $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritDoc}
*/
protected function write(array $record)
{
}
/**
* {@inheritdoc}
*/
public function setFormatter(\Monolog\Formatter\FormatterInterface $formatter)
{
}
/**
* Getter options
* @return array
*/
public function getOptions()
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
/**
* {@inheritdoc}
*/
public function handleBatch(array $records)
{
}
/**
* Use Elasticsearch bulk API to send list of documents
* @param array $documents
* @throws \RuntimeException
*/
protected function bulkSend(array $documents)
{
}
}
/**
* Class to record a log on a NewRelic application.
* Enabling New Relic High Security mode may prevent capture of useful information.
*
* @see https://docs.newrelic.com/docs/agents/php-agent
* @see https://docs.newrelic.com/docs/accounts-partnerships/accounts/security/high-security
*/
class NewRelicHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* Name of the New Relic application that will receive logs from this handler.
*
* @var string
*/
protected $appName;
/**
* Name of the current transaction
*
* @var string
*/
protected $transactionName;
/**
* Some context and extra data is passed into the handler as arrays of values. Do we send them as is
* (useful if we are using the API), or explode them for display on the NewRelic RPM website?
*
* @var bool
*/
protected $explodeArrays;
/**
* {@inheritDoc}
*
* @param string $appName
* @param bool $explodeArrays
* @param string $transactionName
*/
public function __construct($level = \Monolog\Logger::ERROR, $bubble = true, $appName = null, $explodeArrays = false, $transactionName = null)
{
}
/**
* {@inheritDoc}
*/
protected function write(array $record)
{
}
/**
* Checks whether the NewRelic extension is enabled in the system.
*
* @return bool
*/
protected function isNewRelicEnabled()
{
}
/**
* Returns the appname where this log should be sent. Each log can override the default appname, set in this
* handler's constructor, by providing the appname in it's context.
*
* @param array $context
* @return null|string
*/
protected function getAppName(array $context)
{
}
/**
* Returns the name of the current transaction. Each log can override the default transaction name, set in this
* handler's constructor, by providing the transaction_name in it's context
*
* @param array $context
*
* @return null|string
*/
protected function getTransactionName(array $context)
{
}
/**
* Sets the NewRelic application that should receive this log.
*
* @param string $appName
*/
protected function setNewRelicAppName($appName)
{
}
/**
* Overwrites the name of the current transaction
*
* @param string $transactionName
*/
protected function setNewRelicTransactionName($transactionName)
{
}
/**
* @param string $key
* @param mixed $value
*/
protected function setNewRelicParameter($key, $value)
{
}
/**
* {@inheritDoc}
*/
protected function getDefaultFormatter()
{
}
}
/**
* Amazon DynamoDB handler (http://aws.amazon.com/dynamodb/)
*
* @link https://github.com/aws/aws-sdk-php/
* @author Andrew Lawson <adlawson@gmail.com>
*/
class DynamoDbHandler extends \Monolog\Handler\AbstractProcessingHandler
{
const DATE_FORMAT = 'Y-m-d\\TH:i:s.uO';
/**
* @var DynamoDbClient
*/
protected $client;
/**
* @var string
*/
protected $table;
/**
* @param DynamoDbClient $client
* @param string $table
* @param int $level
* @param bool $bubble
*/
public function __construct(\Aws\DynamoDb\DynamoDbClient $client, $table, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
protected function write(array $record)
{
}
/**
* @param array $record
* @return array
*/
protected function filterEmptyFields(array $record)
{
}
/**
* {@inheritdoc}
*/
protected function getDefaultFormatter()
{
}
}
/**
* Sends notifications through the Flowdock push API
*
* This must be configured with a FlowdockFormatter instance via setFormatter()
*
* Notes:
* API token - Flowdock API token
*
* @author Dominik Liebler <liebler.dominik@gmail.com>
* @see https://www.flowdock.com/api/push
*/
class FlowdockHandler extends \Monolog\Handler\SocketHandler
{
/**
* @var string
*/
protected $apiToken;
/**
* @param string $apiToken
* @param bool|int $level The minimum logging level at which this handler will be triggered
* @param bool $bubble Whether the messages that are handled can bubble up the stack or not
*
* @throws MissingExtensionException if OpenSSL is missing
*/
public function __construct($apiToken, $level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
public function setFormatter(\Monolog\Formatter\FormatterInterface $formatter)
{
}
/**
* Gets the default formatter.
*
* @return FormatterInterface
*/
protected function getDefaultFormatter()
{
}
/**
* {@inheritdoc}
*
* @param array $record
*/
protected function write(array $record)
{
}
/**
* {@inheritdoc}
*
* @param array $record
* @return string
*/
protected function generateDataStream($record)
{
}
}
/**
* IFTTTHandler uses cURL to trigger IFTTT Maker actions
*
* Register a secret key and trigger/event name at https://ifttt.com/maker
*
* value1 will be the channel from monolog's Logger constructor,
* value2 will be the level name (ERROR, WARNING, ..)
* value3 will be the log record's message
*
* @author Nehal Patel <nehal@nehalpatel.me>
*/
class IFTTTHandler extends \Monolog\Handler\AbstractProcessingHandler
{
/**
* @param string $eventName The name of the IFTTT Maker event that should be triggered
* @param string $secretKey A valid IFTTT secret key
* @param int $level The minimum logging level at which this handler will be triggered
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($eventName, $secretKey, $level = \Monolog\Logger::ERROR, $bubble = true)
{
}
/**
* {@inheritdoc}
*/
public function write(array $record)
{
}
}
/**
* Simple handler wrapper that filters records based on a list of levels
*
* It can be configured with an exact list of levels to allow, or a min/max level.
*
* @author Hennadiy Verkh
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class FilterHandler extends \Monolog\Handler\AbstractHandler
{
/**
* Handler or factory callable($record, $this)
*
* @var callable|\Monolog\Handler\HandlerInterface
*/
protected $handler;
/**
* Minimum level for logs that are passed to handler
*
* @var int[]
*/
protected $acceptedLevels;
/**
* Whether the messages that are handled can bubble up the stack or not
*
* @var Boolean
*/
protected $bubble;
/**
* @param callable|HandlerInterface $handler Handler or factory callable($record, $this).
* @param int|array $minLevelOrList A list of levels to accept or a minimum level if maxLevel is provided
* @param int $maxLevel Maximum level to accept, only used if $minLevelOrList is not an array
* @param Boolean $bubble Whether the messages that are handled can bubble up the stack or not
*/
public function __construct($handler, $minLevelOrList = \Monolog\Logger::DEBUG, $maxLevel = \Monolog\Logger::EMERGENCY, $bubble = true)
{
}
/**
* @return array
*/
public function getAcceptedLevels()
{
}
/**
* @param int|string|array $minLevelOrList A list of levels to accept or a minimum level or level name if maxLevel is provided
* @param int|string $maxLevel Maximum level or level name to accept, only used if $minLevelOrList is not an array
*/
public function setAcceptedLevels($minLevelOrList = \Monolog\Logger::DEBUG, $maxLevel = \Monolog\Logger::EMERGENCY)
{
}
/**
* {@inheritdoc}
*/
public function isHandling(array $record)
{
}
/**
* {@inheritdoc}
*/
public function handle(array $record)
{
}
/**
* {@inheritdoc}
*/
public function handleBatch(array $records)
{
}
}
}
namespace Monolog {
/**
* Monolog log channel
*
* It contains a stack of Handlers and a stack of Processors,
* and uses them to store records that are added to it.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class Logger implements \Psr\Log\LoggerInterface
{
/**
* Detailed debug information
*/
const DEBUG = 100;
/**
* Interesting events
*
* Examples: User logs in, SQL logs.
*/
const INFO = 200;
/**
* Uncommon events
*/
const NOTICE = 250;
/**
* Exceptional occurrences that are not errors
*
* Examples: Use of deprecated APIs, poor use of an API,
* undesirable things that are not necessarily wrong.
*/
const WARNING = 300;
/**
* Runtime errors
*/
const ERROR = 400;
/**
* Critical conditions
*
* Example: Application component unavailable, unexpected exception.
*/
const CRITICAL = 500;
/**
* Action must be taken immediately
*
* Example: Entire website down, database unavailable, etc.
* This should trigger the SMS alerts and wake you up.
*/
const ALERT = 550;
/**
* Urgent alert.
*/
const EMERGENCY = 600;
/**
* Monolog API version
*
* This is only bumped when API breaks are done and should
* follow the major version of the library
*
* @var int
*/
const API = 1;
/**
* Logging levels from syslog protocol defined in RFC 5424
*
* @var array $levels Logging levels
*/
protected static $levels = array(self::DEBUG => 'DEBUG', self::INFO => 'INFO', self::NOTICE => 'NOTICE', self::WARNING => 'WARNING', self::ERROR => 'ERROR', self::CRITICAL => 'CRITICAL', self::ALERT => 'ALERT', self::EMERGENCY => 'EMERGENCY');
/**
* @var \DateTimeZone
*/
protected static $timezone;
/**
* @var string
*/
protected $name;
/**
* The handler stack
*
* @var HandlerInterface[]
*/
protected $handlers;
/**
* Processors that will process all log records
*
* To process records of a single handler instead, add the processor on that specific handler
*
* @var callable[]
*/
protected $processors;
/**
* @var bool
*/
protected $microsecondTimestamps = true;
/**
* @param string $name The logging channel
* @param HandlerInterface[] $handlers Optional stack of handlers, the first one in the array is called first, etc.
* @param callable[] $processors Optional array of processors
*/
public function __construct($name, array $handlers = array(), array $processors = array())
{
}
/**
* @return string
*/
public function getName()
{
}
/**
* Return a new cloned instance with the name changed
*
* @return static
*/
public function withName($name)
{
}
/**
* Pushes a handler on to the stack.
*
* @param HandlerInterface $handler
* @return $this
*/
public function pushHandler(\Monolog\Handler\HandlerInterface $handler)
{
}
/**
* Pops a handler from the stack
*
* @return HandlerInterface
*/
public function popHandler()
{
}
/**
* Set handlers, replacing all existing ones.
*
* If a map is passed, keys will be ignored.
*
* @param HandlerInterface[] $handlers
* @return $this
*/
public function setHandlers(array $handlers)
{
}
/**
* @return HandlerInterface[]
*/
public function getHandlers()
{
}
/**
* Adds a processor on to the stack.
*
* @param callable $callback
* @return $this
*/
public function pushProcessor($callback)
{
}
/**
* Removes the processor on top of the stack and returns it.
*
* @return callable
*/
public function popProcessor()
{
}
/**
* @return callable[]
*/
public function getProcessors()
{
}
/**
* Control the use of microsecond resolution timestamps in the 'datetime'
* member of new records.
*
* Generating microsecond resolution timestamps by calling
* microtime(true), formatting the result via sprintf() and then parsing
* the resulting string via \DateTime::createFromFormat() can incur
* a measurable runtime overhead vs simple usage of DateTime to capture
* a second resolution timestamp in systems which generate a large number
* of log events.
*
* @param bool $micro True to use microtime() to create timestamps
*/
public function useMicrosecondTimestamps($micro)
{
}
/**
* Adds a log record.
*
* @param int $level The logging level
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function addRecord($level, $message, array $context = array())
{
}
/**
* Adds a log record at the DEBUG level.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function addDebug($message, array $context = array())
{
}
/**
* Adds a log record at the INFO level.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function addInfo($message, array $context = array())
{
}
/**
* Adds a log record at the NOTICE level.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function addNotice($message, array $context = array())
{
}
/**
* Adds a log record at the WARNING level.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function addWarning($message, array $context = array())
{
}
/**
* Adds a log record at the ERROR level.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function addError($message, array $context = array())
{
}
/**
* Adds a log record at the CRITICAL level.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function addCritical($message, array $context = array())
{
}
/**
* Adds a log record at the ALERT level.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function addAlert($message, array $context = array())
{
}
/**
* Adds a log record at the EMERGENCY level.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function addEmergency($message, array $context = array())
{
}
/**
* Gets all supported logging levels.
*
* @return array Assoc array with human-readable level names => level codes.
*/
public static function getLevels()
{
}
/**
* Gets the name of the logging level.
*
* @param int $level
* @return string
*/
public static function getLevelName($level)
{
}
/**
* Converts PSR-3 levels to Monolog ones if necessary
*
* @param string|int Level number (monolog) or name (PSR-3)
* @return int
*/
public static function toMonologLevel($level)
{
}
/**
* Checks whether the Logger has a handler that listens on the given level
*
* @param int $level
* @return Boolean
*/
public function isHandling($level)
{
}
/**
* Adds a log record at an arbitrary level.
*
* This method allows for compatibility with common interfaces.
*
* @param mixed $level The log level
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function log($level, $message, array $context = array())
{
}
/**
* Adds a log record at the DEBUG level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function debug($message, array $context = array())
{
}
/**
* Adds a log record at the INFO level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function info($message, array $context = array())
{
}
/**
* Adds a log record at the NOTICE level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function notice($message, array $context = array())
{
}
/**
* Adds a log record at the WARNING level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function warn($message, array $context = array())
{
}
/**
* Adds a log record at the WARNING level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function warning($message, array $context = array())
{
}
/**
* Adds a log record at the ERROR level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function err($message, array $context = array())
{
}
/**
* Adds a log record at the ERROR level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function error($message, array $context = array())
{
}
/**
* Adds a log record at the CRITICAL level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function crit($message, array $context = array())
{
}
/**
* Adds a log record at the CRITICAL level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function critical($message, array $context = array())
{
}
/**
* Adds a log record at the ALERT level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function alert($message, array $context = array())
{
}
/**
* Adds a log record at the EMERGENCY level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function emerg($message, array $context = array())
{
}
/**
* Adds a log record at the EMERGENCY level.
*
* This method allows for compatibility with common interfaces.
*
* @param string $message The log message
* @param array $context The log context
* @return Boolean Whether the record has been processed
*/
public function emergency($message, array $context = array())
{
}
/**
* Set the timezone to be used for the timestamp of log records.
*
* This is stored globally for all Logger instances
*
* @param \DateTimeZone $tz Timezone object
*/
public static function setTimezone(\DateTimeZone $tz)
{
}
}
}
namespace Monolog\Formatter {
/**
* Interface for formatters
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
interface FormatterInterface
{
/**
* Formats a log record.
*
* @param array $record A record to format
* @return mixed The formatted record
*/
public function format(array $record);
/**
* Formats a set of log records.
*
* @param array $records A set of records to format
* @return mixed The formatted set of records
*/
public function formatBatch(array $records);
}
/**
* Normalizes incoming records to remove objects/resources so it's easier to dump to various targets
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class NormalizerFormatter implements \Monolog\Formatter\FormatterInterface
{
const SIMPLE_DATE = "Y-m-d H:i:s";
protected $dateFormat;
/**
* @param string $dateFormat The format of the timestamp: one supported by DateTime::format
*/
public function __construct($dateFormat = null)
{
}
/**
* {@inheritdoc}
*/
public function format(array $record)
{
}
/**
* {@inheritdoc}
*/
public function formatBatch(array $records)
{
}
protected function normalize($data)
{
}
protected function normalizeException($e)
{
}
/**
* Return the JSON representation of a value
*
* @param mixed $data
* @param bool $ignoreErrors
* @throws \RuntimeException if encoding fails and errors are not ignored
* @return string
*/
protected function toJson($data, $ignoreErrors = false)
{
}
/**
* Detect invalid UTF-8 string characters and convert to valid UTF-8.
*
* Valid UTF-8 input will be left unmodified, but strings containing
* invalid UTF-8 codepoints will be reencoded as UTF-8 with an assumed
* original encoding of ISO-8859-15. This conversion may result in
* incorrect output if the actual encoding was not ISO-8859-15, but it
* will be clean UTF-8 output and will not rely on expensive and fragile
* detection algorithms.
*
* Function converts the input in place in the passed variable so that it
* can be used as a callback for array_walk_recursive.
*
* @param mixed &$data Input to check and convert if needed
* @private
*/
public function detectAndCleanUtf8(&$data)
{
}
}
/**
* Format a log message into an Elastica Document
*
* @author Jelle Vink <jelle.vink@gmail.com>
*/
class ElasticaFormatter extends \Monolog\Formatter\NormalizerFormatter
{
/**
* @var string Elastic search index name
*/
protected $index;
/**
* @var string Elastic search document type
*/
protected $type;
/**
* @param string $index Elastic Search index name
* @param string $type Elastic Search document type
*/
public function __construct($index, $type)
{
}
/**
* {@inheritdoc}
*/
public function format(array $record)
{
}
/**
* Getter index
* @return string
*/
public function getIndex()
{
}
/**
* Getter type
* @return string
*/
public function getType()
{
}
/**
* Convert a log message into an Elastica Document
*
* @param array $record Log message
* @return Document
*/
protected function getDocument($record)
{
}
}
/**
* Encodes whatever record data is passed to it as json
*
* This can be useful to log to databases or remote APIs
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class JsonFormatter extends \Monolog\Formatter\NormalizerFormatter
{
const BATCH_MODE_JSON = 1;
const BATCH_MODE_NEWLINES = 2;
protected $batchMode;
protected $appendNewline;
/**
* @var bool
*/
protected $includeStacktraces = false;
/**
* @param int $batchMode
*/
public function __construct($batchMode = self::BATCH_MODE_JSON, $appendNewline = true)
{
}
/**
* The batch mode option configures the formatting style for
* multiple records. By default, multiple records will be
* formatted as a JSON-encoded array. However, for
* compatibility with some API endpoints, alternative styles
* are available.
*
* @return int
*/
public function getBatchMode()
{
}
/**
* True if newlines are appended to every formatted record
*
* @return bool
*/
public function isAppendingNewlines()
{
}
/**
* {@inheritdoc}
*/
public function format(array $record)
{
}
/**
* {@inheritdoc}
*/
public function formatBatch(array $records)
{
}
/**
* @param bool $include
*/
public function includeStacktraces($include = true)
{
}
/**
* Return a JSON-encoded array of records.
*
* @param array $records
* @return string
*/
protected function formatBatchJson(array $records)
{
}
/**
* Use new lines to separate records instead of a
* JSON-encoded array.
*
* @param array $records
* @return string
*/
protected function formatBatchNewlines(array $records)
{
}
/**
* Normalizes given $data.
*
* @param mixed $data
*
* @return mixed
*/
protected function normalize($data)
{
}
/**
* Normalizes given exception with or without its own stack trace based on
* `includeStacktraces` property.
*
* @param Exception|Throwable $e
*
* @return array
*/
protected function normalizeException($e)
{
}
}
/**
* Formats incoming records into an HTML table
*
* This is especially useful for html email logging
*
* @author Tiago Brito <tlfbrito@gmail.com>
*/
class HtmlFormatter extends \Monolog\Formatter\NormalizerFormatter
{
/**
* Translates Monolog log levels to html color priorities.
*/
protected $logLevels = array(\Monolog\Logger::DEBUG => '#cccccc', \Monolog\Logger::INFO => '#468847', \Monolog\Logger::NOTICE => '#3a87ad', \Monolog\Logger::WARNING => '#c09853', \Monolog\Logger::ERROR => '#f0ad4e', \Monolog\Logger::CRITICAL => '#FF7708', \Monolog\Logger::ALERT => '#C12A19', \Monolog\Logger::EMERGENCY => '#000000');
/**
* @param string $dateFormat The format of the timestamp: one supported by DateTime::format
*/
public function __construct($dateFormat = null)
{
}
/**
* Formats a log record.
*
* @param array $record A record to format
* @return mixed The formatted record
*/
public function format(array $record)
{
}
/**
* Formats a set of log records.
*
* @param array $records A set of records to format
* @return mixed The formatted set of records
*/
public function formatBatch(array $records)
{
}
protected function convertToString($data)
{
}
}
/**
* Serializes a log message to Logstash Event Format
*
* @see http://logstash.net/
* @see https://github.com/logstash/logstash/blob/master/lib/logstash/event.rb
*
* @author Tim Mower <timothy.mower@gmail.com>
*/
class LogstashFormatter extends \Monolog\Formatter\NormalizerFormatter
{
const V0 = 0;
const V1 = 1;
/**
* @var string the name of the system for the Logstash log message, used to fill the @source field
*/
protected $systemName;
/**
* @var string an application name for the Logstash log message, used to fill the @type field
*/
protected $applicationName;
/**
* @var string a prefix for 'extra' fields from the Monolog record (optional)
*/
protected $extraPrefix;
/**
* @var string a prefix for 'context' fields from the Monolog record (optional)
*/
protected $contextPrefix;
/**
* @var int logstash format version to use
*/
protected $version;
/**
* @param string $applicationName the application that sends the data, used as the "type" field of logstash
* @param string $systemName the system/machine name, used as the "source" field of logstash, defaults to the hostname of the machine
* @param string $extraPrefix prefix for extra keys inside logstash "fields"
* @param string $contextPrefix prefix for context keys inside logstash "fields", defaults to ctxt_
* @param int $version the logstash format version to use, defaults to 0
*/
public function __construct($applicationName, $systemName = null, $extraPrefix = null, $contextPrefix = 'ctxt_', $version = self::V0)
{
}
/**
* {@inheritdoc}
*/
public function format(array $record)
{
}
protected function formatV0(array $record)
{
}
protected function formatV1(array $record)
{
}
}
/**
* Formats data into an associative array of scalar values.
* Objects and arrays will be JSON encoded.
*
* @author Andrew Lawson <adlawson@gmail.com>
*/
class ScalarFormatter extends \Monolog\Formatter\NormalizerFormatter
{
/**
* {@inheritdoc}
*/
public function format(array $record)
{
}
/**
* @param mixed $value
* @return mixed
*/
protected function normalizeValue($value)
{
}
}
/**
* Formats incoming records into a one-line string
*
* This is especially useful for logging to files
*
* @author Jordi Boggiano <j.boggiano@seld.be>
* @author Christophe Coevoet <stof@notk.org>
*/
class LineFormatter extends \Monolog\Formatter\NormalizerFormatter
{
const SIMPLE_FORMAT = "[%datetime%] %channel%.%level_name%: %message% %context% %extra%\n";
protected $format;
protected $allowInlineLineBreaks;
protected $ignoreEmptyContextAndExtra;
protected $includeStacktraces;
/**
* @param string $format The format of the message
* @param string $dateFormat The format of the timestamp: one supported by DateTime::format
* @param bool $allowInlineLineBreaks Whether to allow inline line breaks in log entries
* @param bool $ignoreEmptyContextAndExtra
*/
public function __construct($format = null, $dateFormat = null, $allowInlineLineBreaks = false, $ignoreEmptyContextAndExtra = false)
{
}
public function includeStacktraces($include = true)
{
}
public function allowInlineLineBreaks($allow = true)
{
}
public function ignoreEmptyContextAndExtra($ignore = true)
{
}
/**
* {@inheritdoc}
*/
public function format(array $record)
{
}
public function formatBatch(array $records)
{
}
public function stringify($value)
{
}
protected function normalizeException($e)
{
}
protected function convertToString($data)
{
}
protected function replaceNewlines($str)
{
}
}
/**
* formats the record to be used in the FlowdockHandler
*
* @author Dominik Liebler <liebler.dominik@gmail.com>
*/
class FlowdockFormatter implements \Monolog\Formatter\FormatterInterface
{
/**
* @param string $source
* @param string $sourceEmail
*/
public function __construct($source, $sourceEmail)
{
}
/**
* {@inheritdoc}
*/
public function format(array $record)
{
}
/**
* {@inheritdoc}
*/
public function formatBatch(array $records)
{
}
/**
* @param string $message
*
* @return string
*/
public function getShortMessage($message)
{
}
}
/**
* Formats a record for use with the MongoDBHandler.
*
* @author Florian Plattner <me@florianplattner.de>
*/
class MongoDBFormatter implements \Monolog\Formatter\FormatterInterface
{
/**
* @param int $maxNestingLevel 0 means infinite nesting, the $record itself is level 1, $record['context'] is 2
* @param bool $exceptionTraceAsString set to false to log exception traces as a sub documents instead of strings
*/
public function __construct($maxNestingLevel = 3, $exceptionTraceAsString = true)
{
}
/**
* {@inheritDoc}
*/
public function format(array $record)
{
}
/**
* {@inheritDoc}
*/
public function formatBatch(array $records)
{
}
protected function formatArray(array $record, $nestingLevel = 0)
{
}
protected function formatObject($value, $nestingLevel)
{
}
protected function formatException(\Exception $exception, $nestingLevel)
{
}
protected function formatDate(\DateTime $value, $nestingLevel)
{
}
}
/**
* Formats a log message according to the ChromePHP array format
*
* @author Christophe Coevoet <stof@notk.org>
*/
class ChromePHPFormatter implements \Monolog\Formatter\FormatterInterface
{
/**
* {@inheritdoc}
*/
public function format(array $record)
{
}
public function formatBatch(array $records)
{
}
}
/**
* Serializes a log message according to Wildfire's header requirements
*
* @author Eric Clemmons (@ericclemmons) <eric@uxdriven.com>
* @author Christophe Coevoet <stof@notk.org>
* @author Kirill chEbba Chebunin <iam@chebba.org>
*/
class WildfireFormatter extends \Monolog\Formatter\NormalizerFormatter
{
const TABLE = 'table';
/**
* {@inheritdoc}
*/
public function format(array $record)
{
}
public function formatBatch(array $records)
{
}
protected function normalize($data)
{
}
}
/**
* Serializes a log message to GELF
* @see http://www.graylog2.org/about/gelf
*
* @author Matt Lehner <mlehner@gmail.com>
*/
class GelfMessageFormatter extends \Monolog\Formatter\NormalizerFormatter
{
const MAX_LENGTH = 32766;
/**
* @var string the name of the system for the Gelf log message
*/
protected $systemName;
/**
* @var string a prefix for 'extra' fields from the Monolog record (optional)
*/
protected $extraPrefix;
/**
* @var string a prefix for 'context' fields from the Monolog record (optional)
*/
protected $contextPrefix;
public function __construct($systemName = null, $extraPrefix = null, $contextPrefix = 'ctxt_')
{
}
/**
* {@inheritdoc}
*/
public function format(array $record)
{
}
}
/**
* Class FluentdFormatter
*
* Serializes a log message to Fluentd unix socket protocol
*
* Fluentd config:
*
* <source>
* type unix
* path /var/run/td-agent/td-agent.sock
* </source>
*
* Monolog setup:
*
* $logger = new Monolog\Logger('fluent.tag');
* $fluentHandler = new Monolog\Handler\SocketHandler('unix:///var/run/td-agent/td-agent.sock');
* $fluentHandler->setFormatter(new Monolog\Formatter\FluentdFormatter());
* $logger->pushHandler($fluentHandler);
*
* @author Andrius Putna <fordnox@gmail.com>
*/
class FluentdFormatter implements \Monolog\Formatter\FormatterInterface
{
/**
* @var bool $levelTag should message level be a part of the fluentd tag
*/
protected $levelTag = false;
public function __construct($levelTag = false)
{
}
public function isUsingLevelsInTag()
{
}
public function format(array $record)
{
}
public function formatBatch(array $records)
{
}
}
/**
* Encodes message information into JSON in a format compatible with Loggly.
*
* @author Adam Pancutt <adam@pancutt.com>
*/
class LogglyFormatter extends \Monolog\Formatter\JsonFormatter
{
/**
* Overrides the default batch mode to new lines for compatibility with the
* Loggly bulk API.
*
* @param int $batchMode
*/
public function __construct($batchMode = self::BATCH_MODE_NEWLINES, $appendNewline = false)
{
}
/**
* Appends the 'timestamp' parameter for indexing by Loggly.
*
* @see https://www.loggly.com/docs/automated-parsing/#json
* @see \Monolog\Formatter\JsonFormatter::format()
*/
public function format(array $record)
{
}
}
}
namespace Monolog\Processor {
/**
* Adds a tags array into record
*
* @author Martijn Riemers
*/
class TagProcessor
{
public function __construct(array $tags = array())
{
}
public function addTags(array $tags = array())
{
}
public function setTags(array $tags = array())
{
}
public function __invoke(array $record)
{
}
}
/**
* Processes a record's message according to PSR-3 rules
*
* It replaces {foo} with the value from $context['foo']
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class PsrLogMessageProcessor
{
/**
* @param array $record
* @return array
*/
public function __invoke(array $record)
{
}
}
/**
* Adds value of getmypid into records
*
* @author Andreas Hörnicke
*/
class ProcessIdProcessor
{
/**
* @param array $record
* @return array
*/
public function __invoke(array $record)
{
}
}
/**
* Some methods that are common for all memory processors
*
* @author Rob Jensen
*/
abstract class MemoryProcessor
{
/**
* @var bool If true, get the real size of memory allocated from system. Else, only the memory used by emalloc() is reported.
*/
protected $realUsage;
/**
* @var bool If true, then format memory size to human readable string (MB, KB, B depending on size)
*/
protected $useFormatting;
/**
* @param bool $realUsage Set this to true to get the real size of memory allocated from system.
* @param bool $useFormatting If true, then format memory size to human readable string (MB, KB, B depending on size)
*/
public function __construct($realUsage = true, $useFormatting = true)
{
}
/**
* Formats bytes into a human readable string if $this->useFormatting is true, otherwise return $bytes as is
*
* @param int $bytes
* @return string|int Formatted string if $this->useFormatting is true, otherwise return $bytes as is
*/
protected function formatBytes($bytes)
{
}
}
/**
* Injects memory_get_usage in all records
*
* @see Monolog\Processor\MemoryProcessor::__construct() for options
* @author Rob Jensen
*/
class MemoryUsageProcessor extends \Monolog\Processor\MemoryProcessor
{
/**
* @param array $record
* @return array
*/
public function __invoke(array $record)
{
}
}
/**
* Injects url/method and remote IP of the current web request in all records
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class WebProcessor
{
/**
* @var array|\ArrayAccess
*/
protected $serverData;
/**
* Default fields
*
* Array is structured as [key in record.extra => key in $serverData]
*
* @var array
*/
protected $extraFields = array('url' => 'REQUEST_URI', 'ip' => 'REMOTE_ADDR', 'http_method' => 'REQUEST_METHOD', 'server' => 'SERVER_NAME', 'referrer' => 'HTTP_REFERER');
/**
* @param array|\ArrayAccess $serverData Array or object w/ ArrayAccess that provides access to the $_SERVER data
* @param array|null $extraFields Field names and the related key inside $serverData to be added. If not provided it defaults to: url, ip, http_method, server, referrer
*/
public function __construct($serverData = null, array $extraFields = null)
{
}
/**
* @param array $record
* @return array
*/
public function __invoke(array $record)
{
}
/**
* @param string $extraName
* @param string $serverName
* @return $this
*/
public function addExtraField($extraName, $serverName)
{
}
}
/**
* Injects Git branch and Git commit SHA in all records
*
* @author Nick Otter
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class GitProcessor
{
public function __construct($level = \Monolog\Logger::DEBUG)
{
}
/**
* @param array $record
* @return array
*/
public function __invoke(array $record)
{
}
}
/**
* Injects line/file:class/function where the log message came from
*
* Warning: This only works if the handler processes the logs directly.
* If you put the processor on a handler that is behind a FingersCrossedHandler
* for example, the processor will only be called once the trigger level is reached,
* and all the log records will have the same file/line/.. data from the call that
* triggered the FingersCrossedHandler.
*
* @author Jordi Boggiano <j.boggiano@seld.be>
*/
class IntrospectionProcessor
{
public function __construct($level = \Monolog\Logger::DEBUG, array $skipClassesPartials = array(), $skipStackFramesCount = 0)
{
}
/**
* @param array $record
* @return array
*/
public function __invoke(array $record)
{
}
}
/**
* Adds a unique identifier into records
*
* @author Simon Mönch <sm@webfactory.de>
*/
class UidProcessor
{
public function __construct($length = 7)
{
}
public function __invoke(array $record)
{
}
/**
* @return string
*/
public function getUid()
{
}
}
/**
* Injects memory_get_peak_usage in all records
*
* @see Monolog\Processor\MemoryProcessor::__construct() for options
* @author Rob Jensen
*/
class MemoryPeakUsageProcessor extends \Monolog\Processor\MemoryProcessor
{
/**
* @param array $record
* @return array
*/
public function __invoke(array $record)
{
}
}
}
namespace Psr\Http\Message {
/**
* HTTP messages consist of requests from a client to a server and responses
* from a server to a client. This interface defines the methods common to
* each.
*
* Messages are considered immutable; all methods that might change state MUST
* be implemented such that they retain the internal state of the current
* message and return an instance that contains the changed state.
*
* @link http://www.ietf.org/rfc/rfc7230.txt
* @link http://www.ietf.org/rfc/rfc7231.txt
*/
interface MessageInterface
{
/**
* Retrieves the HTTP protocol version as a string.
*
* The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
*
* @return string HTTP protocol version.
*/
public function getProtocolVersion();
/**
* Return an instance with the specified HTTP protocol version.
*
* The version string MUST contain only the HTTP version number (e.g.,
* "1.1", "1.0").
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new protocol version.
*
* @param string $version HTTP protocol version
* @return static
*/
public function withProtocolVersion($version);
/**
* Retrieves all message header values.
*
* The keys represent the header name as it will be sent over the wire, and
* each value is an array of strings associated with the header.
*
* // Represent the headers as a string
* foreach ($message->getHeaders() as $name => $values) {
* echo $name . ": " . implode(", ", $values);
* }
*
* // Emit headers iteratively:
* foreach ($message->getHeaders() as $name => $values) {
* foreach ($values as $value) {
* header(sprintf('%s: %s', $name, $value), false);
* }
* }
*
* While header names are not case-sensitive, getHeaders() will preserve the
* exact case in which headers were originally specified.
*
* @return string[][] Returns an associative array of the message's headers. Each
* key MUST be a header name, and each value MUST be an array of strings
* for that header.
*/
public function getHeaders();
/**
* Checks if a header exists by the given case-insensitive name.
*
* @param string $name Case-insensitive header field name.
* @return bool Returns true if any header names match the given header
* name using a case-insensitive string comparison. Returns false if
* no matching header name is found in the message.
*/
public function hasHeader($name);
/**
* Retrieves a message header value by the given case-insensitive name.
*
* This method returns an array of all the header values of the given
* case-insensitive header name.
*
* If the header does not appear in the message, this method MUST return an
* empty array.
*
* @param string $name Case-insensitive header field name.
* @return string[] An array of string values as provided for the given
* header. If the header does not appear in the message, this method MUST
* return an empty array.
*/
public function getHeader($name);
/**
* Retrieves a comma-separated string of the values for a single header.
*
* This method returns all of the header values of the given
* case-insensitive header name as a string concatenated together using
* a comma.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* If the header does not appear in the message, this method MUST return
* an empty string.
*
* @param string $name Case-insensitive header field name.
* @return string A string of values as provided for the given header
* concatenated together using a comma. If the header does not appear in
* the message, this method MUST return an empty string.
*/
public function getHeaderLine($name);
/**
* Return an instance with the provided value replacing the specified header.
*
* While header names are case-insensitive, the casing of the header will
* be preserved by this function, and returned from getHeaders().
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new and/or updated header and value.
*
* @param string $name Case-insensitive header field name.
* @param string|string[] $value Header value(s).
* @return static
* @throws \InvalidArgumentException for invalid header names or values.
*/
public function withHeader($name, $value);
/**
* Return an instance with the specified header appended with the given value.
*
* Existing values for the specified header will be maintained. The new
* value(s) will be appended to the existing list. If the header did not
* exist previously, it will be added.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new header and/or value.
*
* @param string $name Case-insensitive header field name to add.
* @param string|string[] $value Header value(s).
* @return static
* @throws \InvalidArgumentException for invalid header names or values.
*/
public function withAddedHeader($name, $value);
/**
* Return an instance without the specified header.
*
* Header resolution MUST be done without case-sensitivity.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that removes
* the named header.
*
* @param string $name Case-insensitive header field name to remove.
* @return static
*/
public function withoutHeader($name);
/**
* Gets the body of the message.
*
* @return StreamInterface Returns the body as a stream.
*/
public function getBody();
/**
* Return an instance with the specified message body.
*
* The body MUST be a StreamInterface object.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return a new instance that has the
* new body stream.
*
* @param StreamInterface $body Body.
* @return static
* @throws \InvalidArgumentException When the body is not valid.
*/
public function withBody(\Psr\Http\Message\StreamInterface $body);
}
/**
* Representation of an outgoing, server-side response.
*
* Per the HTTP specification, this interface includes properties for
* each of the following:
*
* - Protocol version
* - Status code and reason phrase
* - Headers
* - Message body
*
* Responses are considered immutable; all methods that might change state MUST
* be implemented such that they retain the internal state of the current
* message and return an instance that contains the changed state.
*/
interface ResponseInterface extends \Psr\Http\Message\MessageInterface
{
/**
* Gets the response status code.
*
* The status code is a 3-digit integer result code of the server's attempt
* to understand and satisfy the request.
*
* @return int Status code.
*/
public function getStatusCode();
/**
* Return an instance with the specified status code and, optionally, reason phrase.
*
* If no reason phrase is specified, implementations MAY choose to default
* to the RFC 7231 or IANA recommended reason phrase for the response's
* status code.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* updated status and reason phrase.
*
* @link http://tools.ietf.org/html/rfc7231#section-6
* @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
* @param int $code The 3-digit integer result code to set.
* @param string $reasonPhrase The reason phrase to use with the
* provided status code; if none is provided, implementations MAY
* use the defaults as suggested in the HTTP specification.
* @return static
* @throws \InvalidArgumentException For invalid status code arguments.
*/
public function withStatus($code, $reasonPhrase = '');
/**
* Gets the response reason phrase associated with the status code.
*
* Because a reason phrase is not a required element in a response
* status line, the reason phrase value MAY be null. Implementations MAY
* choose to return the default RFC 7231 recommended reason phrase (or those
* listed in the IANA HTTP Status Code Registry) for the response's
* status code.
*
* @link http://tools.ietf.org/html/rfc7231#section-6
* @link http://www.iana.org/assignments/http-status-codes/http-status-codes.xhtml
* @return string Reason phrase; must return an empty string if none present.
*/
public function getReasonPhrase();
}
/**
* Representation of an outgoing, client-side request.
*
* Per the HTTP specification, this interface includes properties for
* each of the following:
*
* - Protocol version
* - HTTP method
* - URI
* - Headers
* - Message body
*
* During construction, implementations MUST attempt to set the Host header from
* a provided URI if no Host header is provided.
*
* Requests are considered immutable; all methods that might change state MUST
* be implemented such that they retain the internal state of the current
* message and return an instance that contains the changed state.
*/
interface RequestInterface extends \Psr\Http\Message\MessageInterface
{
/**
* Retrieves the message's request target.
*
* Retrieves the message's request-target either as it will appear (for
* clients), as it appeared at request (for servers), or as it was
* specified for the instance (see withRequestTarget()).
*
* In most cases, this will be the origin-form of the composed URI,
* unless a value was provided to the concrete implementation (see
* withRequestTarget() below).
*
* If no URI is available, and no request-target has been specifically
* provided, this method MUST return the string "/".
*
* @return string
*/
public function getRequestTarget();
/**
* Return an instance with the specific request-target.
*
* If the request needs a non-origin-form request-target — e.g., for
* specifying an absolute-form, authority-form, or asterisk-form —
* this method may be used to create an instance with the specified
* request-target, verbatim.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* changed request target.
*
* @link http://tools.ietf.org/html/rfc7230#section-5.3 (for the various
* request-target forms allowed in request messages)
* @param mixed $requestTarget
* @return static
*/
public function withRequestTarget($requestTarget);
/**
* Retrieves the HTTP method of the request.
*
* @return string Returns the request method.
*/
public function getMethod();
/**
* Return an instance with the provided HTTP method.
*
* While HTTP method names are typically all uppercase characters, HTTP
* method names are case-sensitive and thus implementations SHOULD NOT
* modify the given string.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* changed request method.
*
* @param string $method Case-sensitive method.
* @return static
* @throws \InvalidArgumentException for invalid HTTP methods.
*/
public function withMethod($method);
/**
* Retrieves the URI instance.
*
* This method MUST return a UriInterface instance.
*
* @link http://tools.ietf.org/html/rfc3986#section-4.3
* @return UriInterface Returns a UriInterface instance
* representing the URI of the request.
*/
public function getUri();
/**
* Returns an instance with the provided URI.
*
* This method MUST update the Host header of the returned request by
* default if the URI contains a host component. If the URI does not
* contain a host component, any pre-existing Host header MUST be carried
* over to the returned request.
*
* You can opt-in to preserving the original state of the Host header by
* setting `$preserveHost` to `true`. When `$preserveHost` is set to
* `true`, this method interacts with the Host header in the following ways:
*
* - If the Host header is missing or empty, and the new URI contains
* a host component, this method MUST update the Host header in the returned
* request.
* - If the Host header is missing or empty, and the new URI does not contain a
* host component, this method MUST NOT update the Host header in the returned
* request.
* - If a Host header is present and non-empty, this method MUST NOT update
* the Host header in the returned request.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new UriInterface instance.
*
* @link http://tools.ietf.org/html/rfc3986#section-4.3
* @param UriInterface $uri New request URI to use.
* @param bool $preserveHost Preserve the original state of the Host header.
* @return static
*/
public function withUri(\Psr\Http\Message\UriInterface $uri, $preserveHost = false);
}
/**
* Representation of an incoming, server-side HTTP request.
*
* Per the HTTP specification, this interface includes properties for
* each of the following:
*
* - Protocol version
* - HTTP method
* - URI
* - Headers
* - Message body
*
* Additionally, it encapsulates all data as it has arrived to the
* application from the CGI and/or PHP environment, including:
*
* - The values represented in $_SERVER.
* - Any cookies provided (generally via $_COOKIE)
* - Query string arguments (generally via $_GET, or as parsed via parse_str())
* - Upload files, if any (as represented by $_FILES)
* - Deserialized body parameters (generally from $_POST)
*
* $_SERVER values MUST be treated as immutable, as they represent application
* state at the time of request; as such, no methods are provided to allow
* modification of those values. The other values provide such methods, as they
* can be restored from $_SERVER or the request body, and may need treatment
* during the application (e.g., body parameters may be deserialized based on
* content type).
*
* Additionally, this interface recognizes the utility of introspecting a
* request to derive and match additional parameters (e.g., via URI path
* matching, decrypting cookie values, deserializing non-form-encoded body
* content, matching authorization headers to users, etc). These parameters
* are stored in an "attributes" property.
*
* Requests are considered immutable; all methods that might change state MUST
* be implemented such that they retain the internal state of the current
* message and return an instance that contains the changed state.
*/
interface ServerRequestInterface extends \Psr\Http\Message\RequestInterface
{
/**
* Retrieve server parameters.
*
* Retrieves data related to the incoming request environment,
* typically derived from PHP's $_SERVER superglobal. The data IS NOT
* REQUIRED to originate from $_SERVER.
*
* @return array
*/
public function getServerParams();
/**
* Retrieve cookies.
*
* Retrieves cookies sent by the client to the server.
*
* The data MUST be compatible with the structure of the $_COOKIE
* superglobal.
*
* @return array
*/
public function getCookieParams();
/**
* Return an instance with the specified cookies.
*
* The data IS NOT REQUIRED to come from the $_COOKIE superglobal, but MUST
* be compatible with the structure of $_COOKIE. Typically, this data will
* be injected at instantiation.
*
* This method MUST NOT update the related Cookie header of the request
* instance, nor related values in the server params.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* updated cookie values.
*
* @param array $cookies Array of key/value pairs representing cookies.
* @return static
*/
public function withCookieParams(array $cookies);
/**
* Retrieve query string arguments.
*
* Retrieves the deserialized query string arguments, if any.
*
* Note: the query params might not be in sync with the URI or server
* params. If you need to ensure you are only getting the original
* values, you may need to parse the query string from `getUri()->getQuery()`
* or from the `QUERY_STRING` server param.
*
* @return array
*/
public function getQueryParams();
/**
* Return an instance with the specified query string arguments.
*
* These values SHOULD remain immutable over the course of the incoming
* request. They MAY be injected during instantiation, such as from PHP's
* $_GET superglobal, or MAY be derived from some other value such as the
* URI. In cases where the arguments are parsed from the URI, the data
* MUST be compatible with what PHP's parse_str() would return for
* purposes of how duplicate query parameters are handled, and how nested
* sets are handled.
*
* Setting query string arguments MUST NOT change the URI stored by the
* request, nor the values in the server params.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* updated query string arguments.
*
* @param array $query Array of query string arguments, typically from
* $_GET.
* @return static
*/
public function withQueryParams(array $query);
/**
* Retrieve normalized file upload data.
*
* This method returns upload metadata in a normalized tree, with each leaf
* an instance of Psr\Http\Message\UploadedFileInterface.
*
* These values MAY be prepared from $_FILES or the message body during
* instantiation, or MAY be injected via withUploadedFiles().
*
* @return array An array tree of UploadedFileInterface instances; an empty
* array MUST be returned if no data is present.
*/
public function getUploadedFiles();
/**
* Create a new instance with the specified uploaded files.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* updated body parameters.
*
* @param array $uploadedFiles An array tree of UploadedFileInterface instances.
* @return static
* @throws \InvalidArgumentException if an invalid structure is provided.
*/
public function withUploadedFiles(array $uploadedFiles);
/**
* Retrieve any parameters provided in the request body.
*
* If the request Content-Type is either application/x-www-form-urlencoded
* or multipart/form-data, and the request method is POST, this method MUST
* return the contents of $_POST.
*
* Otherwise, this method may return any results of deserializing
* the request body content; as parsing returns structured content, the
* potential types MUST be arrays or objects only. A null value indicates
* the absence of body content.
*
* @return null|array|object The deserialized body parameters, if any.
* These will typically be an array or object.
*/
public function getParsedBody();
/**
* Return an instance with the specified body parameters.
*
* These MAY be injected during instantiation.
*
* If the request Content-Type is either application/x-www-form-urlencoded
* or multipart/form-data, and the request method is POST, use this method
* ONLY to inject the contents of $_POST.
*
* The data IS NOT REQUIRED to come from $_POST, but MUST be the results of
* deserializing the request body content. Deserialization/parsing returns
* structured data, and, as such, this method ONLY accepts arrays or objects,
* or a null value if nothing was available to parse.
*
* As an example, if content negotiation determines that the request data
* is a JSON payload, this method could be used to create a request
* instance with the deserialized parameters.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* updated body parameters.
*
* @param null|array|object $data The deserialized body data. This will
* typically be in an array or object.
* @return static
* @throws \InvalidArgumentException if an unsupported argument type is
* provided.
*/
public function withParsedBody($data);
/**
* Retrieve attributes derived from the request.
*
* The request "attributes" may be used to allow injection of any
* parameters derived from the request: e.g., the results of path
* match operations; the results of decrypting cookies; the results of
* deserializing non-form-encoded message bodies; etc. Attributes
* will be application and request specific, and CAN be mutable.
*
* @return array Attributes derived from the request.
*/
public function getAttributes();
/**
* Retrieve a single derived request attribute.
*
* Retrieves a single derived request attribute as described in
* getAttributes(). If the attribute has not been previously set, returns
* the default value as provided.
*
* This method obviates the need for a hasAttribute() method, as it allows
* specifying a default value to return if the attribute is not found.
*
* @see getAttributes()
* @param string $name The attribute name.
* @param mixed $default Default value to return if the attribute does not exist.
* @return mixed
*/
public function getAttribute($name, $default = null);
/**
* Return an instance with the specified derived request attribute.
*
* This method allows setting a single derived request attribute as
* described in getAttributes().
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* updated attribute.
*
* @see getAttributes()
* @param string $name The attribute name.
* @param mixed $value The value of the attribute.
* @return static
*/
public function withAttribute($name, $value);
/**
* Return an instance that removes the specified derived request attribute.
*
* This method allows removing a single derived request attribute as
* described in getAttributes().
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that removes
* the attribute.
*
* @see getAttributes()
* @param string $name The attribute name.
* @return static
*/
public function withoutAttribute($name);
}
/**
* Describes a data stream.
*
* Typically, an instance will wrap a PHP stream; this interface provides
* a wrapper around the most common operations, including serialization of
* the entire stream to a string.
*/
interface StreamInterface
{
/**
* Reads all data from the stream into a string, from the beginning to end.
*
* This method MUST attempt to seek to the beginning of the stream before
* reading data and read the stream until the end is reached.
*
* Warning: This could attempt to load a large amount of data into memory.
*
* This method MUST NOT raise an exception in order to conform with PHP's
* string casting operations.
*
* @see http://php.net/manual/en/language.oop5.magic.php#object.tostring
* @return string
*/
public function __toString();
/**
* Closes the stream and any underlying resources.
*
* @return void
*/
public function close();
/**
* Separates any underlying resources from the stream.
*
* After the stream has been detached, the stream is in an unusable state.
*
* @return resource|null Underlying PHP stream, if any
*/
public function detach();
/**
* Get the size of the stream if known.
*
* @return int|null Returns the size in bytes if known, or null if unknown.
*/
public function getSize();
/**
* Returns the current position of the file read/write pointer
*
* @return int Position of the file pointer
* @throws \RuntimeException on error.
*/
public function tell();
/**
* Returns true if the stream is at the end of the stream.
*
* @return bool
*/
public function eof();
/**
* Returns whether or not the stream is seekable.
*
* @return bool
*/
public function isSeekable();
/**
* Seek to a position in the stream.
*
* @link http://www.php.net/manual/en/function.fseek.php
* @param int $offset Stream offset
* @param int $whence Specifies how the cursor position will be calculated
* based on the seek offset. Valid values are identical to the built-in
* PHP $whence values for `fseek()`. SEEK_SET: Set position equal to
* offset bytes SEEK_CUR: Set position to current location plus offset
* SEEK_END: Set position to end-of-stream plus offset.
* @throws \RuntimeException on failure.
*/
public function seek($offset, $whence = SEEK_SET);
/**
* Seek to the beginning of the stream.
*
* If the stream is not seekable, this method will raise an exception;
* otherwise, it will perform a seek(0).
*
* @see seek()
* @link http://www.php.net/manual/en/function.fseek.php
* @throws \RuntimeException on failure.
*/
public function rewind();
/**
* Returns whether or not the stream is writable.
*
* @return bool
*/
public function isWritable();
/**
* Write data to the stream.
*
* @param string $string The string that is to be written.
* @return int Returns the number of bytes written to the stream.
* @throws \RuntimeException on failure.
*/
public function write($string);
/**
* Returns whether or not the stream is readable.
*
* @return bool
*/
public function isReadable();
/**
* Read data from the stream.
*
* @param int $length Read up to $length bytes from the object and return
* them. Fewer than $length bytes may be returned if underlying stream
* call returns fewer bytes.
* @return string Returns the data read from the stream, or an empty string
* if no bytes are available.
* @throws \RuntimeException if an error occurs.
*/
public function read($length);
/**
* Returns the remaining contents in a string
*
* @return string
* @throws \RuntimeException if unable to read or an error occurs while
* reading.
*/
public function getContents();
/**
* Get stream metadata as an associative array or retrieve a specific key.
*
* The keys returned are identical to the keys returned from PHP's
* stream_get_meta_data() function.
*
* @link http://php.net/manual/en/function.stream-get-meta-data.php
* @param string $key Specific metadata to retrieve.
* @return array|mixed|null Returns an associative array if no key is
* provided. Returns a specific key value if a key is provided and the
* value is found, or null if the key is not found.
*/
public function getMetadata($key = null);
}
/**
* Value object representing a file uploaded through an HTTP request.
*
* Instances of this interface are considered immutable; all methods that
* might change state MUST be implemented such that they retain the internal
* state of the current instance and return an instance that contains the
* changed state.
*/
interface UploadedFileInterface
{
/**
* Retrieve a stream representing the uploaded file.
*
* This method MUST return a StreamInterface instance, representing the
* uploaded file. The purpose of this method is to allow utilizing native PHP
* stream functionality to manipulate the file upload, such as
* stream_copy_to_stream() (though the result will need to be decorated in a
* native PHP stream wrapper to work with such functions).
*
* If the moveTo() method has been called previously, this method MUST raise
* an exception.
*
* @return StreamInterface Stream representation of the uploaded file.
* @throws \RuntimeException in cases when no stream is available or can be
* created.
*/
public function getStream();
/**
* Move the uploaded file to a new location.
*
* Use this method as an alternative to move_uploaded_file(). This method is
* guaranteed to work in both SAPI and non-SAPI environments.
* Implementations must determine which environment they are in, and use the
* appropriate method (move_uploaded_file(), rename(), or a stream
* operation) to perform the operation.
*
* $targetPath may be an absolute path, or a relative path. If it is a
* relative path, resolution should be the same as used by PHP's rename()
* function.
*
* The original file or stream MUST be removed on completion.
*
* If this method is called more than once, any subsequent calls MUST raise
* an exception.
*
* When used in an SAPI environment where $_FILES is populated, when writing
* files via moveTo(), is_uploaded_file() and move_uploaded_file() SHOULD be
* used to ensure permissions and upload status are verified correctly.
*
* If you wish to move to a stream, use getStream(), as SAPI operations
* cannot guarantee writing to stream destinations.
*
* @see http://php.net/is_uploaded_file
* @see http://php.net/move_uploaded_file
* @param string $targetPath Path to which to move the uploaded file.
* @throws \InvalidArgumentException if the $targetPath specified is invalid.
* @throws \RuntimeException on any error during the move operation, or on
* the second or subsequent call to the method.
*/
public function moveTo($targetPath);
/**
* Retrieve the file size.
*
* Implementations SHOULD return the value stored in the "size" key of
* the file in the $_FILES array if available, as PHP calculates this based
* on the actual size transmitted.
*
* @return int|null The file size in bytes or null if unknown.
*/
public function getSize();
/**
* Retrieve the error associated with the uploaded file.
*
* The return value MUST be one of PHP's UPLOAD_ERR_XXX constants.
*
* If the file was uploaded successfully, this method MUST return
* UPLOAD_ERR_OK.
*
* Implementations SHOULD return the value stored in the "error" key of
* the file in the $_FILES array.
*
* @see http://php.net/manual/en/features.file-upload.errors.php
* @return int One of PHP's UPLOAD_ERR_XXX constants.
*/
public function getError();
/**
* Retrieve the filename sent by the client.
*
* Do not trust the value returned by this method. A client could send
* a malicious filename with the intention to corrupt or hack your
* application.
*
* Implementations SHOULD return the value stored in the "name" key of
* the file in the $_FILES array.
*
* @return string|null The filename sent by the client or null if none
* was provided.
*/
public function getClientFilename();
/**
* Retrieve the media type sent by the client.
*
* Do not trust the value returned by this method. A client could send
* a malicious media type with the intention to corrupt or hack your
* application.
*
* Implementations SHOULD return the value stored in the "type" key of
* the file in the $_FILES array.
*
* @return string|null The media type sent by the client or null if none
* was provided.
*/
public function getClientMediaType();
}
/**
* Value object representing a URI.
*
* This interface is meant to represent URIs according to RFC 3986 and to
* provide methods for most common operations. Additional functionality for
* working with URIs can be provided on top of the interface or externally.
* Its primary use is for HTTP requests, but may also be used in other
* contexts.
*
* Instances of this interface are considered immutable; all methods that
* might change state MUST be implemented such that they retain the internal
* state of the current instance and return an instance that contains the
* changed state.
*
* Typically the Host header will be also be present in the request message.
* For server-side requests, the scheme will typically be discoverable in the
* server parameters.
*
* @link http://tools.ietf.org/html/rfc3986 (the URI specification)
*/
interface UriInterface
{
/**
* Retrieve the scheme component of the URI.
*
* If no scheme is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.1.
*
* The trailing ":" character is not part of the scheme and MUST NOT be
* added.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.1
* @return string The URI scheme.
*/
public function getScheme();
/**
* Retrieve the authority component of the URI.
*
* If no authority information is present, this method MUST return an empty
* string.
*
* The authority syntax of the URI is:
*
* <pre>
* [user-info@]host[:port]
* </pre>
*
* If the port component is not set or is the standard port for the current
* scheme, it SHOULD NOT be included.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.2
* @return string The URI authority, in "[user-info@]host[:port]" format.
*/
public function getAuthority();
/**
* Retrieve the user information component of the URI.
*
* If no user information is present, this method MUST return an empty
* string.
*
* If a user is present in the URI, this will return that value;
* additionally, if the password is also present, it will be appended to the
* user value, with a colon (":") separating the values.
*
* The trailing "@" character is not part of the user information and MUST
* NOT be added.
*
* @return string The URI user information, in "username[:password]" format.
*/
public function getUserInfo();
/**
* Retrieve the host component of the URI.
*
* If no host is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.2.2.
*
* @see http://tools.ietf.org/html/rfc3986#section-3.2.2
* @return string The URI host.
*/
public function getHost();
/**
* Retrieve the port component of the URI.
*
* If a port is present, and it is non-standard for the current scheme,
* this method MUST return it as an integer. If the port is the standard port
* used with the current scheme, this method SHOULD return null.
*
* If no port is present, and no scheme is present, this method MUST return
* a null value.
*
* If no port is present, but a scheme is present, this method MAY return
* the standard port for that scheme, but SHOULD return null.
*
* @return null|int The URI port.
*/
public function getPort();
/**
* Retrieve the path component of the URI.
*
* The path can either be empty or absolute (starting with a slash) or
* rootless (not starting with a slash). Implementations MUST support all
* three syntaxes.
*
* Normally, the empty path "" and absolute path "/" are considered equal as
* defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
* do this normalization because in contexts with a trimmed base path, e.g.
* the front controller, this difference becomes significant. It's the task
* of the user to handle both "" and "/".
*
* The value returned MUST be percent-encoded, but MUST NOT double-encode
* any characters. To determine what characters to encode, please refer to
* RFC 3986, Sections 2 and 3.3.
*
* As an example, if the value should include a slash ("/") not intended as
* delimiter between path segments, that value MUST be passed in encoded
* form (e.g., "%2F") to the instance.
*
* @see https://tools.ietf.org/html/rfc3986#section-2
* @see https://tools.ietf.org/html/rfc3986#section-3.3
* @return string The URI path.
*/
public function getPath();
/**
* Retrieve the query string of the URI.
*
* If no query string is present, this method MUST return an empty string.
*
* The leading "?" character is not part of the query and MUST NOT be
* added.
*
* The value returned MUST be percent-encoded, but MUST NOT double-encode
* any characters. To determine what characters to encode, please refer to
* RFC 3986, Sections 2 and 3.4.
*
* As an example, if a value in a key/value pair of the query string should
* include an ampersand ("&") not intended as a delimiter between values,
* that value MUST be passed in encoded form (e.g., "%26") to the instance.
*
* @see https://tools.ietf.org/html/rfc3986#section-2
* @see https://tools.ietf.org/html/rfc3986#section-3.4
* @return string The URI query string.
*/
public function getQuery();
/**
* Retrieve the fragment component of the URI.
*
* If no fragment is present, this method MUST return an empty string.
*
* The leading "#" character is not part of the fragment and MUST NOT be
* added.
*
* The value returned MUST be percent-encoded, but MUST NOT double-encode
* any characters. To determine what characters to encode, please refer to
* RFC 3986, Sections 2 and 3.5.
*
* @see https://tools.ietf.org/html/rfc3986#section-2
* @see https://tools.ietf.org/html/rfc3986#section-3.5
* @return string The URI fragment.
*/
public function getFragment();
/**
* Return an instance with the specified scheme.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified scheme.
*
* Implementations MUST support the schemes "http" and "https" case
* insensitively, and MAY accommodate other schemes if required.
*
* An empty scheme is equivalent to removing the scheme.
*
* @param string $scheme The scheme to use with the new instance.
* @return static A new instance with the specified scheme.
* @throws \InvalidArgumentException for invalid or unsupported schemes.
*/
public function withScheme($scheme);
/**
* Return an instance with the specified user information.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified user information.
*
* Password is optional, but the user information MUST include the
* user; an empty string for the user is equivalent to removing user
* information.
*
* @param string $user The user name to use for authority.
* @param null|string $password The password associated with $user.
* @return static A new instance with the specified user information.
*/
public function withUserInfo($user, $password = null);
/**
* Return an instance with the specified host.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified host.
*
* An empty host value is equivalent to removing the host.
*
* @param string $host The hostname to use with the new instance.
* @return static A new instance with the specified host.
* @throws \InvalidArgumentException for invalid hostnames.
*/
public function withHost($host);
/**
* Return an instance with the specified port.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified port.
*
* Implementations MUST raise an exception for ports outside the
* established TCP and UDP port ranges.
*
* A null value provided for the port is equivalent to removing the port
* information.
*
* @param null|int $port The port to use with the new instance; a null value
* removes the port information.
* @return static A new instance with the specified port.
* @throws \InvalidArgumentException for invalid ports.
*/
public function withPort($port);
/**
* Return an instance with the specified path.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified path.
*
* The path can either be empty or absolute (starting with a slash) or
* rootless (not starting with a slash). Implementations MUST support all
* three syntaxes.
*
* If the path is intended to be domain-relative rather than path relative then
* it must begin with a slash ("/"). Paths not starting with a slash ("/")
* are assumed to be relative to some base path known to the application or
* consumer.
*
* Users can provide both encoded and decoded path characters.
* Implementations ensure the correct encoding as outlined in getPath().
*
* @param string $path The path to use with the new instance.
* @return static A new instance with the specified path.
* @throws \InvalidArgumentException for invalid paths.
*/
public function withPath($path);
/**
* Return an instance with the specified query string.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified query string.
*
* Users can provide both encoded and decoded query characters.
* Implementations ensure the correct encoding as outlined in getQuery().
*
* An empty query string value is equivalent to removing the query string.
*
* @param string $query The query string to use with the new instance.
* @return static A new instance with the specified query string.
* @throws \InvalidArgumentException for invalid query strings.
*/
public function withQuery($query);
/**
* Return an instance with the specified URI fragment.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified URI fragment.
*
* Users can provide both encoded and decoded fragment characters.
* Implementations ensure the correct encoding as outlined in getFragment().
*
* An empty fragment value is equivalent to removing the fragment.
*
* @param string $fragment The fragment to use with the new instance.
* @return static A new instance with the specified fragment.
*/
public function withFragment($fragment);
/**
* Return the string representation as a URI reference.
*
* Depending on which components of the URI are present, the resulting
* string is either a full URI or relative reference according to RFC 3986,
* Section 4.1. The method concatenates the various components of the URI,
* using the appropriate delimiters:
*
* - If a scheme is present, it MUST be suffixed by ":".
* - If an authority is present, it MUST be prefixed by "//".
* - The path can be concatenated without delimiters. But there are two
* cases where the path has to be adjusted to make the URI reference
* valid as PHP does not allow to throw an exception in __toString():
* - If the path is rootless and an authority is present, the path MUST
* be prefixed by "/".
* - If the path is starting with more than one "/" and no authority is
* present, the starting slashes MUST be reduced to one.
* - If a query is present, it MUST be prefixed by "?".
* - If a fragment is present, it MUST be prefixed by "#".
*
* @see http://tools.ietf.org/html/rfc3986#section-4.1
* @return string
*/
public function __toString();
}
}
namespace Psr\Log\Test {
class DummyTest
{
public function __toString()
{
}
}
}
namespace GuzzleHttp\Stream {
/**
* Describes a stream instance.
*/
interface StreamInterface
{
/**
* Attempts to seek to the beginning of the stream and reads all data into
* a string until the end of the stream is reached.
*
* Warning: This could attempt to load a large amount of data into memory.
*
* @return string
*/
public function __toString();
/**
* Closes the stream and any underlying resources.
*/
public function close();
/**
* Separates any underlying resources from the stream.
*
* After the underlying resource has been detached, the stream object is in
* an unusable state. If you wish to use a Stream object as a PHP stream
* but keep the Stream object in a consistent state, use
* {@see GuzzleHttp\Stream\GuzzleStreamWrapper::getResource}.
*
* @return resource|null Returns the underlying PHP stream resource or null
* if the Stream object did not utilize an underlying
* stream resource.
*/
public function detach();
/**
* Replaces the underlying stream resource with the provided stream.
*
* Use this method to replace the underlying stream with another; as an
* example, in server-side code, if you decide to return a file, you
* would replace the original content-oriented stream with the file
* stream.
*
* Any internal state such as caching of cursor position should be reset
* when attach() is called, as the stream has changed.
*
* @param resource $stream
*
* @return void
*/
public function attach($stream);
/**
* Get the size of the stream if known
*
* @return int|null Returns the size in bytes if known, or null if unknown
*/
public function getSize();
/**
* Returns the current position of the file read/write pointer
*
* @return int|bool Returns the position of the file pointer or false on error
*/
public function tell();
/**
* Returns true if the stream is at the end of the stream.
*
* @return bool
*/
public function eof();
/**
* Returns whether or not the stream is seekable
*
* @return bool
*/
public function isSeekable();
/**
* Seek to a position in the stream
*
* @param int $offset Stream offset
* @param int $whence Specifies how the cursor position will be calculated
* based on the seek offset. Valid values are identical
* to the built-in PHP $whence values for `fseek()`.
* SEEK_SET: Set position equal to offset bytes
* SEEK_CUR: Set position to current location plus offset
* SEEK_END: Set position to end-of-stream plus offset
*
* @return bool Returns true on success or false on failure
* @link http://www.php.net/manual/en/function.fseek.php
*/
public function seek($offset, $whence = SEEK_SET);
/**
* Returns whether or not the stream is writable
*
* @return bool
*/
public function isWritable();
/**
* Write data to the stream
*
* @param string $string The string that is to be written.
*
* @return int|bool Returns the number of bytes written to the stream on
* success returns false on failure (e.g., broken pipe,
* writer needs to slow down, buffer is full, etc.)
*/
public function write($string);
/**
* Returns whether or not the stream is readable
*
* @return bool
*/
public function isReadable();
/**
* Read data from the stream
*
* @param int $length Read up to $length bytes from the object and return
* them. Fewer than $length bytes may be returned if
* underlying stream call returns fewer bytes.
*
* @return string Returns the data read from the stream.
*/
public function read($length);
/**
* Returns the remaining contents of the stream as a string.
*
* Note: this could potentially load a large amount of data into memory.
*
* @return string
*/
public function getContents();
/**
* Get stream metadata as an associative array or retrieve a specific key.
*
* The keys returned are identical to the keys returned from PHP's
* stream_get_meta_data() function.
*
* @param string $key Specific metadata to retrieve.
*
* @return array|mixed|null Returns an associative array if no key is
* no key is provided. Returns a specific key
* value if a key is provided and the value is
* found, or null if the key is not found.
* @see http://php.net/manual/en/function.stream-get-meta-data.php
*/
public function getMetadata($key = null);
}
/**
* Stream decorator trait
* @property StreamInterface stream
*/
trait StreamDecoratorTrait
{
/**
* @param StreamInterface $stream Stream to decorate
*/
public function __construct(\GuzzleHttp\Stream\StreamInterface $stream)
{
}
/**
* Magic method used to create a new stream if streams are not added in
* the constructor of a decorator (e.g., LazyOpenStream).
*/
public function __get($name)
{
}
public function __toString()
{
}
public function getContents()
{
}
/**
* Allow decorators to implement custom methods
*
* @param string $method Missing method name
* @param array $args Method arguments
*
* @return mixed
*/
public function __call($method, array $args)
{
}
public function close()
{
}
public function getMetadata($key = null)
{
}
public function detach()
{
}
public function attach($stream)
{
}
public function getSize()
{
}
public function eof()
{
}
public function tell()
{
}
public function isReadable()
{
}
public function isWritable()
{
}
public function isSeekable()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function read($length)
{
}
public function write($string)
{
}
/**
* Implement in subclasses to dynamically create streams when requested.
*
* @return StreamInterface
* @throws \BadMethodCallException
*/
protected function createStream()
{
}
}
/**
* Decorator used to return only a subset of a stream
*/
class LimitStream implements \GuzzleHttp\Stream\StreamInterface
{
use \GuzzleHttp\Stream\StreamDecoratorTrait;
/**
* @param StreamInterface $stream Stream to wrap
* @param int $limit Total number of bytes to allow to be read
* from the stream. Pass -1 for no limit.
* @param int|null $offset Position to seek to before reading (only
* works on seekable streams).
*/
public function __construct(\GuzzleHttp\Stream\StreamInterface $stream, $limit = -1, $offset = 0)
{
}
public function eof()
{
}
/**
* Returns the size of the limited subset of data
* {@inheritdoc}
*/
public function getSize()
{
}
/**
* Allow for a bounded seek on the read limited stream
* {@inheritdoc}
*/
public function seek($offset, $whence = SEEK_SET)
{
}
/**
* Give a relative tell()
* {@inheritdoc}
*/
public function tell()
{
}
/**
* Set the offset to start limiting from
*
* @param int $offset Offset to seek to and begin byte limiting from
*
* @return self
* @throws SeekException
*/
public function setOffset($offset)
{
}
/**
* Set the limit of bytes that the decorator allows to be read from the
* stream.
*
* @param int $limit Number of bytes to allow to be read from the stream.
* Use -1 for no limit.
* @return self
*/
public function setLimit($limit)
{
}
public function read($length)
{
}
}
/**
* Static utility class because PHP's autoloaders don't support the concept
* of namespaced function autoloading.
*/
class Utils
{
/**
* Safely opens a PHP stream resource using a filename.
*
* When fopen fails, PHP normally raises a warning. This function adds an
* error handler that checks for errors and throws an exception instead.
*
* @param string $filename File to open
* @param string $mode Mode used to open the file
*
* @return resource
* @throws \RuntimeException if the file cannot be opened
*/
public static function open($filename, $mode)
{
}
/**
* Copy the contents of a stream into a string until the given number of
* bytes have been read.
*
* @param StreamInterface $stream Stream to read
* @param int $maxLen Maximum number of bytes to read. Pass -1
* to read the entire stream.
* @return string
*/
public static function copyToString(\GuzzleHttp\Stream\StreamInterface $stream, $maxLen = -1)
{
}
/**
* Copy the contents of a stream into another stream until the given number
* of bytes have been read.
*
* @param StreamInterface $source Stream to read from
* @param StreamInterface $dest Stream to write to
* @param int $maxLen Maximum number of bytes to read. Pass -1
* to read the entire stream.
*/
public static function copyToStream(\GuzzleHttp\Stream\StreamInterface $source, \GuzzleHttp\Stream\StreamInterface $dest, $maxLen = -1)
{
}
/**
* Calculate a hash of a Stream
*
* @param StreamInterface $stream Stream to calculate the hash for
* @param string $algo Hash algorithm (e.g. md5, crc32, etc)
* @param bool $rawOutput Whether or not to use raw output
*
* @return string Returns the hash of the stream
* @throws SeekException
*/
public static function hash(\GuzzleHttp\Stream\StreamInterface $stream, $algo, $rawOutput = false)
{
}
/**
* Read a line from the stream up to the maximum allowed buffer length
*
* @param StreamInterface $stream Stream to read from
* @param int $maxLength Maximum buffer length
*
* @return string|bool
*/
public static function readline(\GuzzleHttp\Stream\StreamInterface $stream, $maxLength = null)
{
}
/**
* Alias of GuzzleHttp\Stream\Stream::factory.
*
* @param mixed $resource Resource to create
* @param array $options Associative array of stream options defined in
* {@see \GuzzleHttp\Stream\Stream::__construct}
*
* @return StreamInterface
*
* @see GuzzleHttp\Stream\Stream::factory
* @see GuzzleHttp\Stream\Stream::__construct
*/
public static function create($resource, array $options = [])
{
}
}
/**
* Reads from multiple streams, one after the other.
*
* This is a read-only stream decorator.
*/
class AppendStream implements \GuzzleHttp\Stream\StreamInterface
{
/**
* @param StreamInterface[] $streams Streams to decorate. Each stream must
* be readable.
*/
public function __construct(array $streams = [])
{
}
public function __toString()
{
}
/**
* Add a stream to the AppendStream
*
* @param StreamInterface $stream Stream to append. Must be readable.
*
* @throws \InvalidArgumentException if the stream is not readable
*/
public function addStream(\GuzzleHttp\Stream\StreamInterface $stream)
{
}
public function getContents()
{
}
/**
* Closes each attached stream.
*
* {@inheritdoc}
*/
public function close()
{
}
/**
* Detaches each attached stream
*
* {@inheritdoc}
*/
public function detach()
{
}
public function attach($stream)
{
}
public function tell()
{
}
/**
* Tries to calculate the size by adding the size of each stream.
*
* If any of the streams do not return a valid number, then the size of the
* append stream cannot be determined and null is returned.
*
* {@inheritdoc}
*/
public function getSize()
{
}
public function eof()
{
}
/**
* Attempts to seek to the given position. Only supports SEEK_SET.
*
* {@inheritdoc}
*/
public function seek($offset, $whence = SEEK_SET)
{
}
/**
* Reads from all of the appended streams until the length is met or EOF.
*
* {@inheritdoc}
*/
public function read($length)
{
}
public function isReadable()
{
}
public function isWritable()
{
}
public function isSeekable()
{
}
public function write($string)
{
}
public function getMetadata($key = null)
{
}
}
/**
* Does not store any data written to it.
*/
class NullStream implements \GuzzleHttp\Stream\StreamInterface
{
public function __toString()
{
}
public function getContents()
{
}
public function close()
{
}
public function detach()
{
}
public function attach($stream)
{
}
public function getSize()
{
}
public function isReadable()
{
}
public function isWritable()
{
}
public function isSeekable()
{
}
public function eof()
{
}
public function tell()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function read($length)
{
}
public function write($string)
{
}
public function getMetadata($key = null)
{
}
}
/**
* Stream decorator that can cache previously read bytes from a sequentially
* read stream.
*/
class CachingStream implements \GuzzleHttp\Stream\StreamInterface
{
use \GuzzleHttp\Stream\StreamDecoratorTrait;
/**
* We will treat the buffer object as the body of the stream
*
* @param StreamInterface $stream Stream to cache
* @param StreamInterface $target Optionally specify where data is cached
*/
public function __construct(\GuzzleHttp\Stream\StreamInterface $stream, \GuzzleHttp\Stream\StreamInterface $target = null)
{
}
public function getSize()
{
}
/**
* {@inheritdoc}
* @throws SeekException When seeking with SEEK_END or when seeking
* past the total size of the buffer stream
*/
public function seek($offset, $whence = SEEK_SET)
{
}
public function read($length)
{
}
public function write($string)
{
}
public function eof()
{
}
/**
* Close both the remote stream and buffer stream
*/
public function close()
{
}
}
/**
* Uses PHP's zlib.inflate filter to inflate deflate or gzipped content.
*
* This stream decorator skips the first 10 bytes of the given stream to remove
* the gzip header, converts the provided stream to a PHP stream resource,
* then appends the zlib.inflate filter. The stream is then converted back
* to a Guzzle stream resource to be used as a Guzzle stream.
*
* @link http://tools.ietf.org/html/rfc1952
* @link http://php.net/manual/en/filters.compression.php
*/
class InflateStream implements \GuzzleHttp\Stream\StreamInterface
{
use \GuzzleHttp\Stream\StreamDecoratorTrait;
public function __construct(\GuzzleHttp\Stream\StreamInterface $stream)
{
}
}
/**
* Provides a buffer stream that can be written to to fill a buffer, and read
* from to remove bytes from the buffer.
*
* This stream returns a "hwm" metadata value that tells upstream consumers
* what the configured high water mark of the stream is, or the maximum
* preferred size of the buffer.
*
* @package GuzzleHttp\Stream
*/
class BufferStream implements \GuzzleHttp\Stream\StreamInterface
{
/**
* @param int $hwm High water mark, representing the preferred maximum
* buffer size. If the size of the buffer exceeds the high
* water mark, then calls to write will continue to succeed
* but will return false to inform writers to slow down
* until the buffer has been drained by reading from it.
*/
public function __construct($hwm = 16384)
{
}
public function __toString()
{
}
public function getContents()
{
}
public function close()
{
}
public function detach()
{
}
public function attach($stream)
{
}
public function getSize()
{
}
public function isReadable()
{
}
public function isWritable()
{
}
public function isSeekable()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function eof()
{
}
public function tell()
{
}
/**
* Reads data from the buffer.
*/
public function read($length)
{
}
/**
* Writes data to the buffer.
*/
public function write($string)
{
}
public function getMetadata($key = null)
{
}
}
/**
* Provides a read only stream that pumps data from a PHP callable.
*
* When invoking the provided callable, the PumpStream will pass the amount of
* data requested to read to the callable. The callable can choose to ignore
* this value and return fewer or more bytes than requested. Any extra data
* returned by the provided callable is buffered internally until drained using
* the read() function of the PumpStream. The provided callable MUST return
* false when there is no more data to read.
*/
class PumpStream implements \GuzzleHttp\Stream\StreamInterface
{
/**
* @param callable $source Source of the stream data. The callable MAY
* accept an integer argument used to control the
* amount of data to return. The callable MUST
* return a string when called, or false on error
* or EOF.
* @param array $options Stream options:
* - metadata: Hash of metadata to use with stream.
* - size: Size of the stream, if known.
*/
public function __construct(callable $source, array $options = [])
{
}
public function __toString()
{
}
public function close()
{
}
public function detach()
{
}
public function attach($stream)
{
}
public function getSize()
{
}
public function tell()
{
}
public function eof()
{
}
public function isSeekable()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function isWritable()
{
}
public function write($string)
{
}
public function isReadable()
{
}
public function read($length)
{
}
public function getContents()
{
}
public function getMetadata($key = null)
{
}
}
/**
* Converts Guzzle streams into PHP stream resources.
*/
class GuzzleStreamWrapper
{
/** @var resource */
public $context;
/**
* Returns a resource representing the stream.
*
* @param StreamInterface $stream The stream to get a resource for
*
* @return resource
* @throws \InvalidArgumentException if stream is not readable or writable
*/
public static function getResource(\GuzzleHttp\Stream\StreamInterface $stream)
{
}
/**
* Registers the stream wrapper if needed
*/
public static function register()
{
}
public function stream_open($path, $mode, $options, &$opened_path)
{
}
public function stream_read($count)
{
}
public function stream_write($data)
{
}
public function stream_tell()
{
}
public function stream_eof()
{
}
public function stream_seek($offset, $whence)
{
}
public function stream_stat()
{
}
}
/**
* Represents an asynchronous read-only stream that supports a drain event and
* pumping data from a source stream.
*
* The AsyncReadStream can be used as a completely asynchronous stream, meaning
* the data you can read from the stream will immediately return only
* the data that is currently buffered.
*
* AsyncReadStream can also be used in a "blocking" manner if a "pump" function
* is provided. When a caller requests more bytes than are available in the
* buffer, then the pump function is used to block until the requested number
* of bytes are available or the remote source stream has errored, closed, or
* timed-out. This behavior isn't strictly "blocking" because the pump function
* can send other transfers while waiting on the desired buffer size to be
* ready for reading (e.g., continue to tick an event loop).
*
* @unstable This class is subject to change.
*/
class AsyncReadStream implements \GuzzleHttp\Stream\StreamInterface
{
use \GuzzleHttp\Stream\StreamDecoratorTrait;
/**
* In order to utilize high water marks to tell writers to slow down, the
* provided stream must answer to the "hwm" stream metadata variable,
* providing the high water mark. If no "hwm" metadata value is available,
* then the "drain" functionality is not utilized.
*
* This class accepts an associative array of configuration options.
*
* - drain: (callable) Function to invoke when the stream has drained,
* meaning the buffer is now writable again because the size of the
* buffer is at an acceptable level (e.g., below the high water mark).
* The function accepts a single argument, the buffer stream object that
* has drained.
* - pump: (callable) A function that accepts the number of bytes to read
* from the source stream. This function will block until all of the data
* that was requested has been read, EOF of the source stream, or the
* source stream is closed.
* - size: (int) The expected size in bytes of the data that will be read
* (if known up-front).
*
* @param StreamInterface $buffer Buffer that contains the data that has
* been read by the event loop.
* @param array $config Associative array of options.
*
* @throws \InvalidArgumentException if the buffer is not readable and
* writable.
*/
public function __construct(\GuzzleHttp\Stream\StreamInterface $buffer, array $config = [])
{
}
/**
* Factory method used to create new async stream and an underlying buffer
* if no buffer is provided.
*
* This function accepts the same options as AsyncReadStream::__construct,
* but added the following key value pairs:
*
* - buffer: (StreamInterface) Buffer used to buffer data. If none is
* provided, a default buffer is created.
* - hwm: (int) High water mark to use if a buffer is created on your
* behalf.
* - max_buffer: (int) If provided, wraps the utilized buffer in a
* DroppingStream decorator to ensure that buffer does not exceed a given
* length. When exceeded, the stream will begin dropping data. Set the
* max_buffer to 0, to use a NullStream which does not store data.
* - write: (callable) A function that is invoked when data is written
* to the underlying buffer. The function accepts the buffer as the first
* argument, and the data being written as the second. The function MUST
* return the number of bytes that were written or false to let writers
* know to slow down.
* - drain: (callable) See constructor documentation.
* - pump: (callable) See constructor documentation.
*
* @param array $options Associative array of options.
*
* @return array Returns an array containing the buffer used to buffer
* data, followed by the ready to use AsyncReadStream object.
*/
public static function create(array $options = [])
{
}
public function getSize()
{
}
public function isWritable()
{
}
public function write($string)
{
}
public function read($length)
{
}
}
/**
* This interface is deprecated and should no longer be used. Just use
* StreamInterface now that the getMetadata method has been added to
* StreamInterface.
*
* @deprecated
*/
interface MetadataStreamInterface extends \GuzzleHttp\Stream\StreamInterface
{
}
/**
* Stream decorator that prevents a stream from being seeked
*/
class NoSeekStream implements \GuzzleHttp\Stream\StreamInterface
{
use \GuzzleHttp\Stream\StreamDecoratorTrait;
public function seek($offset, $whence = SEEK_SET)
{
}
public function isSeekable()
{
}
public function attach($stream)
{
}
}
/**
* PHP stream implementation
*/
class Stream implements \GuzzleHttp\Stream\StreamInterface
{
/**
* Create a new stream based on the input type.
*
* This factory accepts the same associative array of options as described
* in the constructor.
*
* @param resource|string|StreamInterface $resource Entity body data
* @param array $options Additional options
*
* @return Stream
* @throws \InvalidArgumentException if the $resource arg is not valid.
*/
public static function factory($resource = '', array $options = [])
{
}
/**
* This constructor accepts an associative array of options.
*
* - size: (int) If a read stream would otherwise have an indeterminate
* size, but the size is known due to foreknownledge, then you can
* provide that size, in bytes.
* - metadata: (array) Any additional metadata to return when the metadata
* of the stream is accessed.
*
* @param resource $stream Stream resource to wrap.
* @param array $options Associative array of options.
*
* @throws \InvalidArgumentException if the stream is not a stream resource
*/
public function __construct($stream, $options = [])
{
}
/**
* Closes the stream when the destructed
*/
public function __destruct()
{
}
public function __toString()
{
}
public function getContents()
{
}
public function close()
{
}
public function detach()
{
}
public function attach($stream)
{
}
public function getSize()
{
}
public function isReadable()
{
}
public function isWritable()
{
}
public function isSeekable()
{
}
public function eof()
{
}
public function tell()
{
}
public function setSize($size)
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function read($length)
{
}
public function write($string)
{
}
public function getMetadata($key = null)
{
}
}
/**
* Stream decorator that begins dropping data once the size of the underlying
* stream becomes too full.
*/
class DroppingStream implements \GuzzleHttp\Stream\StreamInterface
{
use \GuzzleHttp\Stream\StreamDecoratorTrait;
/**
* @param StreamInterface $stream Underlying stream to decorate.
* @param int $maxLength Maximum size before dropping data.
*/
public function __construct(\GuzzleHttp\Stream\StreamInterface $stream, $maxLength)
{
}
public function write($string)
{
}
}
}
namespace GuzzleHttp\Stream\Exception {
class CannotAttachException extends \RuntimeException
{
}
/**
* Exception thrown when a seek fails on a stream.
*/
class SeekException extends \RuntimeException
{
public function __construct(\GuzzleHttp\Stream\StreamInterface $stream, $pos = 0, $msg = '')
{
}
/**
* @return StreamInterface
*/
public function getStream()
{
}
}
}
namespace GuzzleHttp\Stream {
/**
* Compose stream implementations based on a hash of functions.
*
* Allows for easy testing and extension of a provided stream without needing
* to create a concrete class for a simple extension point.
*/
class FnStream implements \GuzzleHttp\Stream\StreamInterface
{
/**
* @param array $methods Hash of method name to a callable.
*/
public function __construct(array $methods)
{
}
/**
* Lazily determine which methods are not implemented.
* @throws \BadMethodCallException
*/
public function __get($name)
{
}
/**
* The close method is called on the underlying stream only if possible.
*/
public function __destruct()
{
}
/**
* Adds custom functionality to an underlying stream by intercepting
* specific method calls.
*
* @param StreamInterface $stream Stream to decorate
* @param array $methods Hash of method name to a closure
*
* @return FnStream
*/
public static function decorate(\GuzzleHttp\Stream\StreamInterface $stream, array $methods)
{
}
public function __toString()
{
}
public function close()
{
}
public function detach()
{
}
public function attach($stream)
{
}
public function getSize()
{
}
public function tell()
{
}
public function eof()
{
}
public function isSeekable()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function isWritable()
{
}
public function write($string)
{
}
public function isReadable()
{
}
public function read($length)
{
}
public function getContents()
{
}
public function getMetadata($key = null)
{
}
}
/**
* Lazily reads or writes to a file that is opened only after an IO operation
* take place on the stream.
*/
class LazyOpenStream implements \GuzzleHttp\Stream\StreamInterface
{
use \GuzzleHttp\Stream\StreamDecoratorTrait;
/**
* @param string $filename File to lazily open
* @param string $mode fopen mode to use when opening the stream
*/
public function __construct($filename, $mode)
{
}
/**
* Creates the underlying stream lazily when required.
*
* @return StreamInterface
*/
protected function createStream()
{
}
}
}
namespace GuzzleHttp\Promise {
/**
* Interface used with classes that return a promise.
*/
interface PromisorInterface
{
/**
* Returns a promise.
*
* @return PromiseInterface
*/
public function promise();
}
/**
* Represents a promise that iterates over many promises and invokes
* side-effect functions in the process.
*/
class EachPromise implements \GuzzleHttp\Promise\PromisorInterface
{
/**
* Configuration hash can include the following key value pairs:
*
* - fulfilled: (callable) Invoked when a promise fulfills. The function
* is invoked with three arguments: the fulfillment value, the index
* position from the iterable list of the promise, and the aggregate
* promise that manages all of the promises. The aggregate promise may
* be resolved from within the callback to short-circuit the promise.
* - rejected: (callable) Invoked when a promise is rejected. The
* function is invoked with three arguments: the rejection reason, the
* index position from the iterable list of the promise, and the
* aggregate promise that manages all of the promises. The aggregate
* promise may be resolved from within the callback to short-circuit
* the promise.
* - concurrency: (integer) Pass this configuration option to limit the
* allowed number of outstanding concurrently executing promises,
* creating a capped pool of promises. There is no limit by default.
*
* @param mixed $iterable Promises or values to iterate.
* @param array $config Configuration options
*/
public function __construct($iterable, array $config = [])
{
}
public function promise()
{
}
}
interface TaskQueueInterface
{
/**
* Returns true if the queue is empty.
*
* @return bool
*/
public function isEmpty();
/**
* Adds a task to the queue that will be executed the next time run is
* called.
*
* @param callable $task
*/
public function add(callable $task);
/**
* Execute all of the pending task in the queue.
*/
public function run();
}
/**
* A promise represents the eventual result of an asynchronous operation.
*
* The primary way of interacting with a promise is through its then method,
* which registers callbacks to receive either a promise’s eventual value or
* the reason why the promise cannot be fulfilled.
*
* @link https://promisesaplus.com/
*/
interface PromiseInterface
{
const PENDING = 'pending';
const FULFILLED = 'fulfilled';
const REJECTED = 'rejected';
/**
* Appends fulfillment and rejection handlers to the promise, and returns
* a new promise resolving to the return value of the called handler.
*
* @param callable $onFulfilled Invoked when the promise fulfills.
* @param callable $onRejected Invoked when the promise is rejected.
*
* @return PromiseInterface
*/
public function then(callable $onFulfilled = null, callable $onRejected = null);
/**
* Appends a rejection handler callback to the promise, and returns a new
* promise resolving to the return value of the callback if it is called,
* or to its original fulfillment value if the promise is instead
* fulfilled.
*
* @param callable $onRejected Invoked when the promise is rejected.
*
* @return PromiseInterface
*/
public function otherwise(callable $onRejected);
/**
* Get the state of the promise ("pending", "rejected", or "fulfilled").
*
* The three states can be checked against the constants defined on
* PromiseInterface: PENDING, FULFILLED, and REJECTED.
*
* @return string
*/
public function getState();
/**
* Resolve the promise with the given value.
*
* @param mixed $value
* @throws \RuntimeException if the promise is already resolved.
*/
public function resolve($value);
/**
* Reject the promise with the given reason.
*
* @param mixed $reason
* @throws \RuntimeException if the promise is already resolved.
*/
public function reject($reason);
/**
* Cancels the promise if possible.
*
* @link https://github.com/promises-aplus/cancellation-spec/issues/7
*/
public function cancel();
/**
* Waits until the promise completes if possible.
*
* Pass $unwrap as true to unwrap the result of the promise, either
* returning the resolved value or throwing the rejected exception.
*
* If the promise cannot be waited on, then the promise will be rejected.
*
* @param bool $unwrap
*
* @return mixed
* @throws \LogicException if the promise has no wait function or if the
* promise does not settle after waiting.
*/
public function wait($unwrap = true);
}
/**
* Promises/A+ implementation that avoids recursion when possible.
*
* @link https://promisesaplus.com/
*/
class Promise implements \GuzzleHttp\Promise\PromiseInterface
{
/**
* @param callable $waitFn Fn that when invoked resolves the promise.
* @param callable $cancelFn Fn that when invoked cancels the promise.
*/
public function __construct(callable $waitFn = null, callable $cancelFn = null)
{
}
public function then(callable $onFulfilled = null, callable $onRejected = null)
{
}
public function otherwise(callable $onRejected)
{
}
public function wait($unwrap = true)
{
}
public function getState()
{
}
public function cancel()
{
}
public function resolve($value)
{
}
public function reject($reason)
{
}
}
/**
* Creates a promise that is resolved using a generator that yields values or
* promises (somewhat similar to C#'s async keyword).
*
* When called, the coroutine function will start an instance of the generator
* and returns a promise that is fulfilled with its final yielded value.
*
* Control is returned back to the generator when the yielded promise settles.
* This can lead to less verbose code when doing lots of sequential async calls
* with minimal processing in between.
*
* use GuzzleHttp\Promise;
*
* function createPromise($value) {
* return new Promise\FulfilledPromise($value);
* }
*
* $promise = Promise\coroutine(function () {
* $value = (yield createPromise('a'));
* try {
* $value = (yield createPromise($value . 'b'));
* } catch (\Exception $e) {
* // The promise was rejected.
* }
* yield $value . 'c';
* });
*
* // Outputs "abc"
* $promise->then(function ($v) { echo $v; });
*
* @param callable $generatorFn Generator function to wrap into a promise.
*
* @return Promise
* @link https://github.com/petkaantonov/bluebird/blob/master/API.md#generators inspiration
*/
final class Coroutine implements \GuzzleHttp\Promise\PromiseInterface
{
public function __construct(callable $generatorFn)
{
}
public function then(callable $onFulfilled = null, callable $onRejected = null)
{
}
public function otherwise(callable $onRejected)
{
}
public function wait($unwrap = true)
{
}
public function getState()
{
}
public function resolve($value)
{
}
public function reject($reason)
{
}
public function cancel()
{
}
/**
* @internal
*/
public function _handleSuccess($value)
{
}
/**
* @internal
*/
public function _handleFailure($reason)
{
}
}
/**
* A special exception that is thrown when waiting on a rejected promise.
*
* The reason value is available via the getReason() method.
*/
class RejectionException extends \RuntimeException
{
/**
* @param mixed $reason Rejection reason.
* @param string $description Optional description
*/
public function __construct($reason, $description = null)
{
}
/**
* Returns the rejection reason.
*
* @return mixed
*/
public function getReason()
{
}
}
/**
* A promise that has been rejected.
*
* Thenning off of this promise will invoke the onRejected callback
* immediately and ignore other callbacks.
*/
class RejectedPromise implements \GuzzleHttp\Promise\PromiseInterface
{
public function __construct($reason)
{
}
public function then(callable $onFulfilled = null, callable $onRejected = null)
{
}
public function otherwise(callable $onRejected)
{
}
public function wait($unwrap = true, $defaultDelivery = null)
{
}
public function getState()
{
}
public function resolve($value)
{
}
public function reject($reason)
{
}
public function cancel()
{
}
}
/**
* A promise that has been fulfilled.
*
* Thenning off of this promise will invoke the onFulfilled callback
* immediately and ignore other callbacks.
*/
class FulfilledPromise implements \GuzzleHttp\Promise\PromiseInterface
{
public function __construct($value)
{
}
public function then(callable $onFulfilled = null, callable $onRejected = null)
{
}
public function otherwise(callable $onRejected)
{
}
public function wait($unwrap = true, $defaultDelivery = null)
{
}
public function getState()
{
}
public function resolve($value)
{
}
public function reject($reason)
{
}
public function cancel()
{
}
}
/**
* Exception that is set as the reason for a promise that has been cancelled.
*/
class CancellationException extends \GuzzleHttp\Promise\RejectionException
{
}
/**
* A task queue that executes tasks in a FIFO order.
*
* This task queue class is used to settle promises asynchronously and
* maintains a constant stack size. You can use the task queue asynchronously
* by calling the `run()` function of the global task queue in an event loop.
*
* GuzzleHttp\Promise\queue()->run();
*/
class TaskQueue implements \GuzzleHttp\Promise\TaskQueueInterface
{
public function __construct($withShutdown = true)
{
}
public function isEmpty()
{
}
public function add(callable $task)
{
}
public function run()
{
}
/**
* The task queue will be run and exhausted by default when the process
* exits IFF the exit is not the result of a PHP E_ERROR error.
*
* You can disable running the automatic shutdown of the queue by calling
* this function. If you disable the task queue shutdown process, then you
* MUST either run the task queue (as a result of running your event loop
* or manually using the run() method) or wait on each outstanding promise.
*
* Note: This shutdown will occur before any destructors are triggered.
*/
public function disableShutdown()
{
}
}
/**
* Exception thrown when too many errors occur in the some() or any() methods.
*/
class AggregateException extends \GuzzleHttp\Promise\RejectionException
{
public function __construct($msg, array $reasons)
{
}
}
}
namespace GuzzleHttp\Psr7 {
/**
* Trait implementing functionality common to requests and responses.
*/
trait MessageTrait
{
/** @var array Map of all registered headers, as original name => array of values */
private $headers = [];
/** @var array Map of lowercase header name => original name at registration */
private $headerNames = [];
/** @var string */
private $protocol = '1.1';
/** @var StreamInterface */
private $stream;
public function getProtocolVersion()
{
}
public function withProtocolVersion($version)
{
}
public function getHeaders()
{
}
public function hasHeader($header)
{
}
public function getHeader($header)
{
}
public function getHeaderLine($header)
{
}
public function withHeader($header, $value)
{
}
public function withAddedHeader($header, $value)
{
}
public function withoutHeader($header)
{
}
public function getBody()
{
}
public function withBody(\Psr\Http\Message\StreamInterface $body)
{
}
private function setHeaders(array $headers)
{
}
/**
* Trims whitespace from the header values.
*
* Spaces and tabs ought to be excluded by parsers when extracting the field value from a header field.
*
* header-field = field-name ":" OWS field-value OWS
* OWS = *( SP / HTAB )
*
* @param string[] $values Header values
*
* @return string[] Trimmed header values
*
* @see https://tools.ietf.org/html/rfc7230#section-3.2.4
*/
private function trimHeaderValues(array $values)
{
}
}
/**
* Stream decorator trait
* @property StreamInterface stream
*/
trait StreamDecoratorTrait
{
/**
* @param StreamInterface $stream Stream to decorate
*/
public function __construct(\Psr\Http\Message\StreamInterface $stream)
{
}
/**
* Magic method used to create a new stream if streams are not added in
* the constructor of a decorator (e.g., LazyOpenStream).
*
* @param string $name Name of the property (allows "stream" only).
*
* @return StreamInterface
*/
public function __get($name)
{
}
public function __toString()
{
}
public function getContents()
{
}
/**
* Allow decorators to implement custom methods
*
* @param string $method Missing method name
* @param array $args Method arguments
*
* @return mixed
*/
public function __call($method, array $args)
{
}
public function close()
{
}
public function getMetadata($key = null)
{
}
public function detach()
{
}
public function getSize()
{
}
public function eof()
{
}
public function tell()
{
}
public function isReadable()
{
}
public function isWritable()
{
}
public function isSeekable()
{
}
public function rewind()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function read($length)
{
}
public function write($string)
{
}
/**
* Implement in subclasses to dynamically create streams when requested.
*
* @return StreamInterface
* @throws \BadMethodCallException
*/
protected function createStream()
{
}
}
/**
* Decorator used to return only a subset of a stream
*/
class LimitStream implements \Psr\Http\Message\StreamInterface
{
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
/**
* @param StreamInterface $stream Stream to wrap
* @param int $limit Total number of bytes to allow to be read
* from the stream. Pass -1 for no limit.
* @param int $offset Position to seek to before reading (only
* works on seekable streams).
*/
public function __construct(\Psr\Http\Message\StreamInterface $stream, $limit = -1, $offset = 0)
{
}
public function eof()
{
}
/**
* Returns the size of the limited subset of data
* {@inheritdoc}
*/
public function getSize()
{
}
/**
* Allow for a bounded seek on the read limited stream
* {@inheritdoc}
*/
public function seek($offset, $whence = SEEK_SET)
{
}
/**
* Give a relative tell()
* {@inheritdoc}
*/
public function tell()
{
}
/**
* Set the offset to start limiting from
*
* @param int $offset Offset to seek to and begin byte limiting from
*
* @throws \RuntimeException if the stream cannot be seeked.
*/
public function setOffset($offset)
{
}
/**
* Set the limit of bytes that the decorator allows to be read from the
* stream.
*
* @param int $limit Number of bytes to allow to be read from the stream.
* Use -1 for no limit.
*/
public function setLimit($limit)
{
}
public function read($length)
{
}
}
/**
* Reads from multiple streams, one after the other.
*
* This is a read-only stream decorator.
*/
class AppendStream implements \Psr\Http\Message\StreamInterface
{
/**
* @param StreamInterface[] $streams Streams to decorate. Each stream must
* be readable.
*/
public function __construct(array $streams = [])
{
}
public function __toString()
{
}
/**
* Add a stream to the AppendStream
*
* @param StreamInterface $stream Stream to append. Must be readable.
*
* @throws \InvalidArgumentException if the stream is not readable
*/
public function addStream(\Psr\Http\Message\StreamInterface $stream)
{
}
public function getContents()
{
}
/**
* Closes each attached stream.
*
* {@inheritdoc}
*/
public function close()
{
}
/**
* Detaches each attached stream
*
* {@inheritdoc}
*/
public function detach()
{
}
public function tell()
{
}
/**
* Tries to calculate the size by adding the size of each stream.
*
* If any of the streams do not return a valid number, then the size of the
* append stream cannot be determined and null is returned.
*
* {@inheritdoc}
*/
public function getSize()
{
}
public function eof()
{
}
public function rewind()
{
}
/**
* Attempts to seek to the given position. Only supports SEEK_SET.
*
* {@inheritdoc}
*/
public function seek($offset, $whence = SEEK_SET)
{
}
/**
* Reads from all of the appended streams until the length is met or EOF.
*
* {@inheritdoc}
*/
public function read($length)
{
}
public function isReadable()
{
}
public function isWritable()
{
}
public function isSeekable()
{
}
public function write($string)
{
}
public function getMetadata($key = null)
{
}
}
/**
* Resolves a URI reference in the context of a base URI and the opposite way.
*
* @author Tobias Schultze
*
* @link https://tools.ietf.org/html/rfc3986#section-5
*/
final class UriResolver
{
/**
* Removes dot segments from a path and returns the new path.
*
* @param string $path
*
* @return string
* @link http://tools.ietf.org/html/rfc3986#section-5.2.4
*/
public static function removeDotSegments($path)
{
}
/**
* Converts the relative URI into a new URI that is resolved against the base URI.
*
* @param UriInterface $base Base URI
* @param UriInterface $rel Relative URI
*
* @return UriInterface
* @link http://tools.ietf.org/html/rfc3986#section-5.2
*/
public static function resolve(\Psr\Http\Message\UriInterface $base, \Psr\Http\Message\UriInterface $rel)
{
}
/**
* Returns the target URI as a relative reference from the base URI.
*
* This method is the counterpart to resolve():
*
* (string) $target === (string) UriResolver::resolve($base, UriResolver::relativize($base, $target))
*
* One use-case is to use the current request URI as base URI and then generate relative links in your documents
* to reduce the document size or offer self-contained downloadable document archives.
*
* $base = new Uri('http://example.com/a/b/');
* echo UriResolver::relativize($base, new Uri('http://example.com/a/b/c')); // prints 'c'.
* echo UriResolver::relativize($base, new Uri('http://example.com/a/x/y')); // prints '../x/y'.
* echo UriResolver::relativize($base, new Uri('http://example.com/a/b/?q')); // prints '?q'.
* echo UriResolver::relativize($base, new Uri('http://example.org/a/b/')); // prints '//example.org/a/b/'.
*
* This method also accepts a target that is already relative and will try to relativize it further. Only a
* relative-path reference will be returned as-is.
*
* echo UriResolver::relativize($base, new Uri('/a/b/c')); // prints 'c' as well
*
* @param UriInterface $base Base URI
* @param UriInterface $target Target URI
*
* @return UriInterface The relative URI reference
*/
public static function relativize(\Psr\Http\Message\UriInterface $base, \Psr\Http\Message\UriInterface $target)
{
}
}
/**
* PSR-7 URI implementation.
*
* @author Michael Dowling
* @author Tobias Schultze
* @author Matthew Weier O'Phinney
*/
class Uri implements \Psr\Http\Message\UriInterface
{
/**
* Absolute http and https URIs require a host per RFC 7230 Section 2.7
* but in generic URIs the host can be empty. So for http(s) URIs
* we apply this default host when no host is given yet to form a
* valid URI.
*/
const HTTP_DEFAULT_HOST = 'localhost';
/**
* @param string $uri URI to parse
*/
public function __construct($uri = '')
{
}
public function __toString()
{
}
/**
* Composes a URI reference string from its various components.
*
* Usually this method does not need to be called manually but instead is used indirectly via
* `Psr\Http\Message\UriInterface::__toString`.
*
* PSR-7 UriInterface treats an empty component the same as a missing component as
* getQuery(), getFragment() etc. always return a string. This explains the slight
* difference to RFC 3986 Section 5.3.
*
* Another adjustment is that the authority separator is added even when the authority is missing/empty
* for the "file" scheme. This is because PHP stream functions like `file_get_contents` only work with
* `file:///myfile` but not with `file:/myfile` although they are equivalent according to RFC 3986. But
* `file:///` is the more common syntax for the file scheme anyway (Chrome for example redirects to
* that format).
*
* @param string $scheme
* @param string $authority
* @param string $path
* @param string $query
* @param string $fragment
*
* @return string
*
* @link https://tools.ietf.org/html/rfc3986#section-5.3
*/
public static function composeComponents($scheme, $authority, $path, $query, $fragment)
{
}
/**
* Whether the URI has the default port of the current scheme.
*
* `Psr\Http\Message\UriInterface::getPort` may return null or the standard port. This method can be used
* independently of the implementation.
*
* @param UriInterface $uri
*
* @return bool
*/
public static function isDefaultPort(\Psr\Http\Message\UriInterface $uri)
{
}
/**
* Whether the URI is absolute, i.e. it has a scheme.
*
* An instance of UriInterface can either be an absolute URI or a relative reference. This method returns true
* if it is the former. An absolute URI has a scheme. A relative reference is used to express a URI relative
* to another URI, the base URI. Relative references can be divided into several forms:
* - network-path references, e.g. '//example.com/path'
* - absolute-path references, e.g. '/path'
* - relative-path references, e.g. 'subpath'
*
* @param UriInterface $uri
*
* @return bool
* @see Uri::isNetworkPathReference
* @see Uri::isAbsolutePathReference
* @see Uri::isRelativePathReference
* @link https://tools.ietf.org/html/rfc3986#section-4
*/
public static function isAbsolute(\Psr\Http\Message\UriInterface $uri)
{
}
/**
* Whether the URI is a network-path reference.
*
* A relative reference that begins with two slash characters is termed an network-path reference.
*
* @param UriInterface $uri
*
* @return bool
* @link https://tools.ietf.org/html/rfc3986#section-4.2
*/
public static function isNetworkPathReference(\Psr\Http\Message\UriInterface $uri)
{
}
/**
* Whether the URI is a absolute-path reference.
*
* A relative reference that begins with a single slash character is termed an absolute-path reference.
*
* @param UriInterface $uri
*
* @return bool
* @link https://tools.ietf.org/html/rfc3986#section-4.2
*/
public static function isAbsolutePathReference(\Psr\Http\Message\UriInterface $uri)
{
}
/**
* Whether the URI is a relative-path reference.
*
* A relative reference that does not begin with a slash character is termed a relative-path reference.
*
* @param UriInterface $uri
*
* @return bool
* @link https://tools.ietf.org/html/rfc3986#section-4.2
*/
public static function isRelativePathReference(\Psr\Http\Message\UriInterface $uri)
{
}
/**
* Whether the URI is a same-document reference.
*
* A same-document reference refers to a URI that is, aside from its fragment
* component, identical to the base URI. When no base URI is given, only an empty
* URI reference (apart from its fragment) is considered a same-document reference.
*
* @param UriInterface $uri The URI to check
* @param UriInterface|null $base An optional base URI to compare against
*
* @return bool
* @link https://tools.ietf.org/html/rfc3986#section-4.4
*/
public static function isSameDocumentReference(\Psr\Http\Message\UriInterface $uri, \Psr\Http\Message\UriInterface $base = null)
{
}
/**
* Removes dot segments from a path and returns the new path.
*
* @param string $path
*
* @return string
*
* @deprecated since version 1.4. Use UriResolver::removeDotSegments instead.
* @see UriResolver::removeDotSegments
*/
public static function removeDotSegments($path)
{
}
/**
* Converts the relative URI into a new URI that is resolved against the base URI.
*
* @param UriInterface $base Base URI
* @param string|UriInterface $rel Relative URI
*
* @return UriInterface
*
* @deprecated since version 1.4. Use UriResolver::resolve instead.
* @see UriResolver::resolve
*/
public static function resolve(\Psr\Http\Message\UriInterface $base, $rel)
{
}
/**
* Creates a new URI with a specific query string value removed.
*
* Any existing query string values that exactly match the provided key are
* removed.
*
* @param UriInterface $uri URI to use as a base.
* @param string $key Query string key to remove.
*
* @return UriInterface
*/
public static function withoutQueryValue(\Psr\Http\Message\UriInterface $uri, $key)
{
}
/**
* Creates a new URI with a specific query string value.
*
* Any existing query string values that exactly match the provided key are
* removed and replaced with the given key value pair.
*
* A value of null will set the query string key without a value, e.g. "key"
* instead of "key=value".
*
* @param UriInterface $uri URI to use as a base.
* @param string $key Key to set.
* @param string|null $value Value to set
*
* @return UriInterface
*/
public static function withQueryValue(\Psr\Http\Message\UriInterface $uri, $key, $value)
{
}
/**
* Creates a URI from a hash of `parse_url` components.
*
* @param array $parts
*
* @return UriInterface
* @link http://php.net/manual/en/function.parse-url.php
*
* @throws \InvalidArgumentException If the components do not form a valid URI.
*/
public static function fromParts(array $parts)
{
}
public function getScheme()
{
}
public function getAuthority()
{
}
public function getUserInfo()
{
}
public function getHost()
{
}
public function getPort()
{
}
public function getPath()
{
}
public function getQuery()
{
}
public function getFragment()
{
}
public function withScheme($scheme)
{
}
public function withUserInfo($user, $password = null)
{
}
public function withHost($host)
{
}
public function withPort($port)
{
}
public function withPath($path)
{
}
public function withQuery($query)
{
}
public function withFragment($fragment)
{
}
}
/**
* PSR-7 request implementation.
*/
class Request implements \Psr\Http\Message\RequestInterface
{
use \GuzzleHttp\Psr7\MessageTrait;
/**
* @param string $method HTTP method
* @param string|UriInterface $uri URI
* @param array $headers Request headers
* @param string|null|resource|StreamInterface $body Request body
* @param string $version Protocol version
*/
public function __construct($method, $uri, array $headers = [], $body = null, $version = '1.1')
{
}
public function getRequestTarget()
{
}
public function withRequestTarget($requestTarget)
{
}
public function getMethod()
{
}
public function withMethod($method)
{
}
public function getUri()
{
}
public function withUri(\Psr\Http\Message\UriInterface $uri, $preserveHost = false)
{
}
}
/**
* Stream decorator that can cache previously read bytes from a sequentially
* read stream.
*/
class CachingStream implements \Psr\Http\Message\StreamInterface
{
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
/**
* We will treat the buffer object as the body of the stream
*
* @param StreamInterface $stream Stream to cache
* @param StreamInterface $target Optionally specify where data is cached
*/
public function __construct(\Psr\Http\Message\StreamInterface $stream, \Psr\Http\Message\StreamInterface $target = null)
{
}
public function getSize()
{
}
public function rewind()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function read($length)
{
}
public function write($string)
{
}
public function eof()
{
}
/**
* Close both the remote stream and buffer stream
*/
public function close()
{
}
}
/**
* Uses PHP's zlib.inflate filter to inflate deflate or gzipped content.
*
* This stream decorator skips the first 10 bytes of the given stream to remove
* the gzip header, converts the provided stream to a PHP stream resource,
* then appends the zlib.inflate filter. The stream is then converted back
* to a Guzzle stream resource to be used as a Guzzle stream.
*
* @link http://tools.ietf.org/html/rfc1952
* @link http://php.net/manual/en/filters.compression.php
*/
class InflateStream implements \Psr\Http\Message\StreamInterface
{
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
public function __construct(\Psr\Http\Message\StreamInterface $stream)
{
}
}
/**
* Provides a buffer stream that can be written to to fill a buffer, and read
* from to remove bytes from the buffer.
*
* This stream returns a "hwm" metadata value that tells upstream consumers
* what the configured high water mark of the stream is, or the maximum
* preferred size of the buffer.
*/
class BufferStream implements \Psr\Http\Message\StreamInterface
{
/**
* @param int $hwm High water mark, representing the preferred maximum
* buffer size. If the size of the buffer exceeds the high
* water mark, then calls to write will continue to succeed
* but will return false to inform writers to slow down
* until the buffer has been drained by reading from it.
*/
public function __construct($hwm = 16384)
{
}
public function __toString()
{
}
public function getContents()
{
}
public function close()
{
}
public function detach()
{
}
public function getSize()
{
}
public function isReadable()
{
}
public function isWritable()
{
}
public function isSeekable()
{
}
public function rewind()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function eof()
{
}
public function tell()
{
}
/**
* Reads data from the buffer.
*/
public function read($length)
{
}
/**
* Writes data to the buffer.
*/
public function write($string)
{
}
public function getMetadata($key = null)
{
}
}
/**
* Provides a read only stream that pumps data from a PHP callable.
*
* When invoking the provided callable, the PumpStream will pass the amount of
* data requested to read to the callable. The callable can choose to ignore
* this value and return fewer or more bytes than requested. Any extra data
* returned by the provided callable is buffered internally until drained using
* the read() function of the PumpStream. The provided callable MUST return
* false when there is no more data to read.
*/
class PumpStream implements \Psr\Http\Message\StreamInterface
{
/**
* @param callable $source Source of the stream data. The callable MAY
* accept an integer argument used to control the
* amount of data to return. The callable MUST
* return a string when called, or false on error
* or EOF.
* @param array $options Stream options:
* - metadata: Hash of metadata to use with stream.
* - size: Size of the stream, if known.
*/
public function __construct(callable $source, array $options = [])
{
}
public function __toString()
{
}
public function close()
{
}
public function detach()
{
}
public function getSize()
{
}
public function tell()
{
}
public function eof()
{
}
public function isSeekable()
{
}
public function rewind()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function isWritable()
{
}
public function write($string)
{
}
public function isReadable()
{
}
public function read($length)
{
}
public function getContents()
{
}
public function getMetadata($key = null)
{
}
}
/**
* Stream that when read returns bytes for a streaming multipart or
* multipart/form-data stream.
*/
class MultipartStream implements \Psr\Http\Message\StreamInterface
{
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
/**
* @param array $elements Array of associative arrays, each containing a
* required "name" key mapping to the form field,
* name, a required "contents" key mapping to a
* StreamInterface/resource/string, an optional
* "headers" associative array of custom headers,
* and an optional "filename" key mapping to a
* string to send as the filename in the part.
* @param string $boundary You can optionally provide a specific boundary
*
* @throws \InvalidArgumentException
*/
public function __construct(array $elements = [], $boundary = null)
{
}
/**
* Get the boundary
*
* @return string
*/
public function getBoundary()
{
}
public function isWritable()
{
}
/**
* Create the aggregate stream that will be used to upload the POST data
*/
protected function createStream(array $elements)
{
}
}
/**
* Server-side HTTP request
*
* Extends the Request definition to add methods for accessing incoming data,
* specifically server parameters, cookies, matched path parameters, query
* string arguments, body parameters, and upload file information.
*
* "Attributes" are discovered via decomposing the request (and usually
* specifically the URI path), and typically will be injected by the application.
*
* Requests are considered immutable; all methods that might change state are
* implemented such that they retain the internal state of the current
* message and return a new instance that contains the changed state.
*/
class ServerRequest extends \GuzzleHttp\Psr7\Request implements \Psr\Http\Message\ServerRequestInterface
{
/**
* @param string $method HTTP method
* @param string|UriInterface $uri URI
* @param array $headers Request headers
* @param string|null|resource|StreamInterface $body Request body
* @param string $version Protocol version
* @param array $serverParams Typically the $_SERVER superglobal
*/
public function __construct($method, $uri, array $headers = [], $body = null, $version = '1.1', array $serverParams = [])
{
}
/**
* Return an UploadedFile instance array.
*
* @param array $files A array which respect $_FILES structure
* @throws InvalidArgumentException for unrecognized values
* @return array
*/
public static function normalizeFiles(array $files)
{
}
/**
* Return a ServerRequest populated with superglobals:
* $_GET
* $_POST
* $_COOKIE
* $_FILES
* $_SERVER
*
* @return ServerRequestInterface
*/
public static function fromGlobals()
{
}
/**
* Get a Uri populated with values from $_SERVER.
*
* @return UriInterface
*/
public static function getUriFromGlobals()
{
}
/**
* {@inheritdoc}
*/
public function getServerParams()
{
}
/**
* {@inheritdoc}
*/
public function getUploadedFiles()
{
}
/**
* {@inheritdoc}
*/
public function withUploadedFiles(array $uploadedFiles)
{
}
/**
* {@inheritdoc}
*/
public function getCookieParams()
{
}
/**
* {@inheritdoc}
*/
public function withCookieParams(array $cookies)
{
}
/**
* {@inheritdoc}
*/
public function getQueryParams()
{
}
/**
* {@inheritdoc}
*/
public function withQueryParams(array $query)
{
}
/**
* {@inheritdoc}
*/
public function getParsedBody()
{
}
/**
* {@inheritdoc}
*/
public function withParsedBody($data)
{
}
/**
* {@inheritdoc}
*/
public function getAttributes()
{
}
/**
* {@inheritdoc}
*/
public function getAttribute($attribute, $default = null)
{
}
/**
* {@inheritdoc}
*/
public function withAttribute($attribute, $value)
{
}
/**
* {@inheritdoc}
*/
public function withoutAttribute($attribute)
{
}
}
class UploadedFile implements \Psr\Http\Message\UploadedFileInterface
{
/**
* @param StreamInterface|string|resource $streamOrFile
* @param int $size
* @param int $errorStatus
* @param string|null $clientFilename
* @param string|null $clientMediaType
*/
public function __construct($streamOrFile, $size, $errorStatus, $clientFilename = null, $clientMediaType = null)
{
}
/**
* @return boolean
*/
public function isMoved()
{
}
/**
* {@inheritdoc}
* @throws RuntimeException if the upload was not successful.
*/
public function getStream()
{
}
/**
* {@inheritdoc}
*
* @see http://php.net/is_uploaded_file
* @see http://php.net/move_uploaded_file
* @param string $targetPath Path to which to move the uploaded file.
* @throws RuntimeException if the upload was not successful.
* @throws InvalidArgumentException if the $path specified is invalid.
* @throws RuntimeException on any error during the move operation, or on
* the second or subsequent call to the method.
*/
public function moveTo($targetPath)
{
}
/**
* {@inheritdoc}
*
* @return int|null The file size in bytes or null if unknown.
*/
public function getSize()
{
}
/**
* {@inheritdoc}
*
* @see http://php.net/manual/en/features.file-upload.errors.php
* @return int One of PHP's UPLOAD_ERR_XXX constants.
*/
public function getError()
{
}
/**
* {@inheritdoc}
*
* @return string|null The filename sent by the client or null if none
* was provided.
*/
public function getClientFilename()
{
}
/**
* {@inheritdoc}
*/
public function getClientMediaType()
{
}
}
/**
* Stream decorator that prevents a stream from being seeked
*/
class NoSeekStream implements \Psr\Http\Message\StreamInterface
{
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
public function seek($offset, $whence = SEEK_SET)
{
}
public function isSeekable()
{
}
}
/**
* Provides methods to normalize and compare URIs.
*
* @author Tobias Schultze
*
* @link https://tools.ietf.org/html/rfc3986#section-6
*/
final class UriNormalizer
{
/**
* Default normalizations which only include the ones that preserve semantics.
*
* self::CAPITALIZE_PERCENT_ENCODING | self::DECODE_UNRESERVED_CHARACTERS | self::CONVERT_EMPTY_PATH |
* self::REMOVE_DEFAULT_HOST | self::REMOVE_DEFAULT_PORT | self::REMOVE_DOT_SEGMENTS
*/
const PRESERVING_NORMALIZATIONS = 63;
/**
* All letters within a percent-encoding triplet (e.g., "%3A") are case-insensitive, and should be capitalized.
*
* Example: http://example.org/a%c2%b1b → http://example.org/a%C2%B1b
*/
const CAPITALIZE_PERCENT_ENCODING = 1;
/**
* Decodes percent-encoded octets of unreserved characters.
*
* For consistency, percent-encoded octets in the ranges of ALPHA (%41–%5A and %61–%7A), DIGIT (%30–%39),
* hyphen (%2D), period (%2E), underscore (%5F), or tilde (%7E) should not be created by URI producers and,
* when found in a URI, should be decoded to their corresponding unreserved characters by URI normalizers.
*
* Example: http://example.org/%7Eusern%61me/ → http://example.org/~username/
*/
const DECODE_UNRESERVED_CHARACTERS = 2;
/**
* Converts the empty path to "/" for http and https URIs.
*
* Example: http://example.org → http://example.org/
*/
const CONVERT_EMPTY_PATH = 4;
/**
* Removes the default host of the given URI scheme from the URI.
*
* Only the "file" scheme defines the default host "localhost".
* All of `file:/myfile`, `file:///myfile`, and `file://localhost/myfile`
* are equivalent according to RFC 3986. The first format is not accepted
* by PHPs stream functions and thus already normalized implicitly to the
* second format in the Uri class. See `GuzzleHttp\Psr7\Uri::composeComponents`.
*
* Example: file://localhost/myfile → file:///myfile
*/
const REMOVE_DEFAULT_HOST = 8;
/**
* Removes the default port of the given URI scheme from the URI.
*
* Example: http://example.org:80/ → http://example.org/
*/
const REMOVE_DEFAULT_PORT = 16;
/**
* Removes unnecessary dot-segments.
*
* Dot-segments in relative-path references are not removed as it would
* change the semantics of the URI reference.
*
* Example: http://example.org/../a/b/../c/./d.html → http://example.org/a/c/d.html
*/
const REMOVE_DOT_SEGMENTS = 32;
/**
* Paths which include two or more adjacent slashes are converted to one.
*
* Webservers usually ignore duplicate slashes and treat those URIs equivalent.
* But in theory those URIs do not need to be equivalent. So this normalization
* may change the semantics. Encoded slashes (%2F) are not removed.
*
* Example: http://example.org//foo///bar.html → http://example.org/foo/bar.html
*/
const REMOVE_DUPLICATE_SLASHES = 64;
/**
* Sort query parameters with their values in alphabetical order.
*
* However, the order of parameters in a URI may be significant (this is not defined by the standard).
* So this normalization is not safe and may change the semantics of the URI.
*
* Example: ?lang=en&article=fred → ?article=fred&lang=en
*
* Note: The sorting is neither locale nor Unicode aware (the URI query does not get decoded at all) as the
* purpose is to be able to compare URIs in a reproducible way, not to have the params sorted perfectly.
*/
const SORT_QUERY_PARAMETERS = 128;
/**
* Returns a normalized URI.
*
* The scheme and host component are already normalized to lowercase per PSR-7 UriInterface.
* This methods adds additional normalizations that can be configured with the $flags parameter.
*
* PSR-7 UriInterface cannot distinguish between an empty component and a missing component as
* getQuery(), getFragment() etc. always return a string. This means the URIs "/?#" and "/" are
* treated equivalent which is not necessarily true according to RFC 3986. But that difference
* is highly uncommon in reality. So this potential normalization is implied in PSR-7 as well.
*
* @param UriInterface $uri The URI to normalize
* @param int $flags A bitmask of normalizations to apply, see constants
*
* @return UriInterface The normalized URI
* @link https://tools.ietf.org/html/rfc3986#section-6.2
*/
public static function normalize(\Psr\Http\Message\UriInterface $uri, $flags = self::PRESERVING_NORMALIZATIONS)
{
}
/**
* Whether two URIs can be considered equivalent.
*
* Both URIs are normalized automatically before comparison with the given $normalizations bitmask. The method also
* accepts relative URI references and returns true when they are equivalent. This of course assumes they will be
* resolved against the same base URI. If this is not the case, determination of equivalence or difference of
* relative references does not mean anything.
*
* @param UriInterface $uri1 An URI to compare
* @param UriInterface $uri2 An URI to compare
* @param int $normalizations A bitmask of normalizations to apply, see constants
*
* @return bool
* @link https://tools.ietf.org/html/rfc3986#section-6.1
*/
public static function isEquivalent(\Psr\Http\Message\UriInterface $uri1, \Psr\Http\Message\UriInterface $uri2, $normalizations = self::PRESERVING_NORMALIZATIONS)
{
}
}
/**
* Converts Guzzle streams into PHP stream resources.
*/
class StreamWrapper
{
/** @var resource */
public $context;
/**
* Returns a resource representing the stream.
*
* @param StreamInterface $stream The stream to get a resource for
*
* @return resource
* @throws \InvalidArgumentException if stream is not readable or writable
*/
public static function getResource(\Psr\Http\Message\StreamInterface $stream)
{
}
/**
* Registers the stream wrapper if needed
*/
public static function register()
{
}
public function stream_open($path, $mode, $options, &$opened_path)
{
}
public function stream_read($count)
{
}
public function stream_write($data)
{
}
public function stream_tell()
{
}
public function stream_eof()
{
}
public function stream_seek($offset, $whence)
{
}
public function stream_stat()
{
}
}
/**
* PHP stream implementation.
*
* @var $stream
*/
class Stream implements \Psr\Http\Message\StreamInterface
{
/**
* This constructor accepts an associative array of options.
*
* - size: (int) If a read stream would otherwise have an indeterminate
* size, but the size is known due to foreknowledge, then you can
* provide that size, in bytes.
* - metadata: (array) Any additional metadata to return when the metadata
* of the stream is accessed.
*
* @param resource $stream Stream resource to wrap.
* @param array $options Associative array of options.
*
* @throws \InvalidArgumentException if the stream is not a stream resource
*/
public function __construct($stream, $options = [])
{
}
public function __get($name)
{
}
/**
* Closes the stream when the destructed
*/
public function __destruct()
{
}
public function __toString()
{
}
public function getContents()
{
}
public function close()
{
}
public function detach()
{
}
public function getSize()
{
}
public function isReadable()
{
}
public function isWritable()
{
}
public function isSeekable()
{
}
public function eof()
{
}
public function tell()
{
}
public function rewind()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function read($length)
{
}
public function write($string)
{
}
public function getMetadata($key = null)
{
}
}
/**
* Stream decorator that begins dropping data once the size of the underlying
* stream becomes too full.
*/
class DroppingStream implements \Psr\Http\Message\StreamInterface
{
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
/**
* @param StreamInterface $stream Underlying stream to decorate.
* @param int $maxLength Maximum size before dropping data.
*/
public function __construct(\Psr\Http\Message\StreamInterface $stream, $maxLength)
{
}
public function write($string)
{
}
}
/**
* Compose stream implementations based on a hash of functions.
*
* Allows for easy testing and extension of a provided stream without needing
* to create a concrete class for a simple extension point.
*/
class FnStream implements \Psr\Http\Message\StreamInterface
{
/**
* @param array $methods Hash of method name to a callable.
*/
public function __construct(array $methods)
{
}
/**
* Lazily determine which methods are not implemented.
* @throws \BadMethodCallException
*/
public function __get($name)
{
}
/**
* The close method is called on the underlying stream only if possible.
*/
public function __destruct()
{
}
/**
* Adds custom functionality to an underlying stream by intercepting
* specific method calls.
*
* @param StreamInterface $stream Stream to decorate
* @param array $methods Hash of method name to a closure
*
* @return FnStream
*/
public static function decorate(\Psr\Http\Message\StreamInterface $stream, array $methods)
{
}
public function __toString()
{
}
public function close()
{
}
public function detach()
{
}
public function getSize()
{
}
public function tell()
{
}
public function eof()
{
}
public function isSeekable()
{
}
public function rewind()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function isWritable()
{
}
public function write($string)
{
}
public function isReadable()
{
}
public function read($length)
{
}
public function getContents()
{
}
public function getMetadata($key = null)
{
}
}
/**
* PSR-7 response implementation.
*/
class Response implements \Psr\Http\Message\ResponseInterface
{
use \GuzzleHttp\Psr7\MessageTrait;
/**
* @param int $status Status code
* @param array $headers Response headers
* @param string|null|resource|StreamInterface $body Response body
* @param string $version Protocol version
* @param string|null $reason Reason phrase (when empty a default will be used based on the status code)
*/
public function __construct($status = 200, array $headers = [], $body = null, $version = '1.1', $reason = null)
{
}
public function getStatusCode()
{
}
public function getReasonPhrase()
{
}
public function withStatus($code, $reasonPhrase = '')
{
}
}
/**
* Lazily reads or writes to a file that is opened only after an IO operation
* take place on the stream.
*/
class LazyOpenStream implements \Psr\Http\Message\StreamInterface
{
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
/**
* @param string $filename File to lazily open
* @param string $mode fopen mode to use when opening the stream
*/
public function __construct($filename, $mode)
{
}
/**
* Creates the underlying stream lazily when required.
*
* @return StreamInterface
*/
protected function createStream()
{
}
}
}
namespace GuzzleHttp\Ring\Future {
/**
* Represents the result of a computation that may not have completed yet.
*
* You can use the future in a blocking manner using the wait() function, or
* you can use a promise from the future to receive the result when the future
* has been resolved.
*
* When the future is dereferenced using wait(), the result of the computation
* is cached and returned for subsequent calls to wait(). If the result of the
* computation has not yet completed when wait() is called, the call to wait()
* will block until the future has completed.
*/
interface FutureInterface extends \React\Promise\PromiseInterface, \React\Promise\PromisorInterface
{
/**
* Returns the result of the future either from cache or by blocking until
* it is complete.
*
* This method must block until the future has a result or is cancelled.
* Throwing an exception in the wait() method will mark the future as
* realized and will throw the exception each time wait() is called.
* Throwing an instance of GuzzleHttp\Ring\CancelledException will mark
* the future as realized, will not throw immediately, but will throw the
* exception if the future's wait() method is called again.
*
* @return mixed
*/
public function wait();
/**
* Cancels the future, if possible.
*/
public function cancel();
}
/**
* Future that provides array-like access.
*/
interface FutureArrayInterface extends \GuzzleHttp\Ring\Future\FutureInterface, \ArrayAccess, \Countable, \IteratorAggregate
{
}
/**
* Represents a future value that has been resolved or rejected.
*/
class CompletedFutureValue implements \GuzzleHttp\Ring\Future\FutureInterface
{
protected $result;
protected $error;
/**
* @param mixed $result Resolved result
* @param \Exception $e Error. Pass a GuzzleHttp\Ring\Exception\CancelledFutureAccessException
* to mark the future as cancelled.
*/
public function __construct($result, \Exception $e = null)
{
}
public function wait()
{
}
public function cancel()
{
}
public function promise()
{
}
public function then(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
}
/**
* Represents a future array that has been completed successfully.
*/
class CompletedFutureArray extends \GuzzleHttp\Ring\Future\CompletedFutureValue implements \GuzzleHttp\Ring\Future\FutureArrayInterface
{
public function __construct(array $result)
{
}
public function offsetExists($offset)
{
}
public function offsetGet($offset)
{
}
public function offsetSet($offset, $value)
{
}
public function offsetUnset($offset)
{
}
public function count()
{
}
public function getIterator()
{
}
}
/**
* Implements common future functionality built on top of promises.
*/
trait BaseFutureTrait
{
/** @var callable */
private $waitfn;
/** @var callable */
private $cancelfn;
/** @var PromiseInterface */
private $wrappedPromise;
/** @var \Exception Error encountered. */
private $error;
/** @var mixed Result of the future */
private $result;
private $isRealized = false;
/**
* @param PromiseInterface $promise Promise to shadow with the future.
* @param callable $wait Function that blocks until the deferred
* computation has been resolved. This
* function MUST resolve the deferred value
* associated with the supplied promise.
* @param callable $cancel If possible and reasonable, provide a
* function that can be used to cancel the
* future from completing.
*/
public function __construct(\React\Promise\PromiseInterface $promise, callable $wait = null, callable $cancel = null)
{
}
public function wait()
{
}
public function promise()
{
}
public function then(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function cancel()
{
}
private function addShadow()
{
}
private function invokeWait()
{
}
}
/**
* Implements common future functionality that is triggered when the result
* property is accessed via a magic __get method.
*
* @property mixed $_value Actual data used by the future. Accessing this
* property will cause the future to block if needed.
*/
trait MagicFutureTrait
{
use \GuzzleHttp\Ring\Future\BaseFutureTrait;
/**
* This function handles retrieving the dereferenced result when requested.
*
* @param string $name Should always be "data" or an exception is thrown.
*
* @return mixed Returns the dereferenced data.
* @throws \RuntimeException
* @throws \GuzzleHttp\Ring\Exception\CancelledException
*/
public function __get($name)
{
}
}
/**
* Represents a future array value that when dereferenced returns an array.
*/
class FutureArray implements \GuzzleHttp\Ring\Future\FutureArrayInterface
{
use \GuzzleHttp\Ring\Future\MagicFutureTrait;
public function offsetExists($offset)
{
}
public function offsetGet($offset)
{
}
public function offsetSet($offset, $value)
{
}
public function offsetUnset($offset)
{
}
public function count()
{
}
public function getIterator()
{
}
}
/**
* Represents a future value that responds to wait() to retrieve the promised
* value, but can also return promises that are delivered the value when it is
* available.
*/
class FutureValue implements \GuzzleHttp\Ring\Future\FutureInterface
{
use \GuzzleHttp\Ring\Future\BaseFutureTrait;
}
}
namespace GuzzleHttp\Ring\Client {
/**
* HTTP handler that uses cURL easy handles as a transport layer.
*
* Requires PHP 5.5+
*
* When using the CurlHandler, custom curl options can be specified as an
* associative array of curl option constants mapping to values in the
* **curl** key of the "client" key of the request.
*/
class CurlHandler
{
/**
* Accepts an associative array of options:
*
* - factory: Optional callable factory used to create cURL handles.
* The callable is passed a request hash when invoked, and returns an
* array of the curl handle, headers resource, and body resource.
* - max_handles: Maximum number of idle handles (defaults to 5).
*
* @param array $options Array of options to use with the handler
*/
public function __construct(array $options = [])
{
}
public function __destruct()
{
}
/**
* @param array $request
*
* @return CompletedFutureArray
*/
public function __invoke(array $request)
{
}
/**
* @internal
*
* @param array $request
*
* @return array
*/
public function _invokeAsArray(array $request)
{
}
}
/**
* Creates curl resources from a request
*/
class CurlFactory
{
/**
* Creates a cURL handle, header resource, and body resource based on a
* transaction.
*
* @param array $request Request hash
* @param null|resource $handle Optionally provide a curl handle to modify
*
* @return array Returns an array of the curl handle, headers array, and
* response body handle.
* @throws \RuntimeException when an option cannot be applied
*/
public function __invoke(array $request, $handle = null)
{
}
/**
* Creates a response hash from a cURL result.
*
* @param callable $handler Handler that was used.
* @param array $request Request that sent.
* @param array $response Response hash to update.
* @param array $headers Headers received during transfer.
* @param resource $body Body fopen response.
*
* @return array
*/
public static function createResponse(callable $handler, array $request, array $response, array $headers, $body)
{
}
}
/**
* RingPHP client handler that uses PHP's HTTP stream wrapper.
*/
class StreamHandler
{
public function __construct(array $options = [])
{
}
public function __invoke(array $request)
{
}
}
/**
* Ring handler that returns a canned response or evaluated function result.
*/
class MockHandler
{
/**
* Provide an array or future to always return the same value. Provide a
* callable that accepts a request object and returns an array or future
* to dynamically create a response.
*
* @param array|FutureArrayInterface|callable $result Mock return value.
*/
public function __construct($result)
{
}
public function __invoke(array $request)
{
}
}
/**
* Provides basic middleware wrappers.
*
* If a middleware is more complex than a few lines of code, then it should
* be implemented in a class rather than a static method.
*/
class Middleware
{
/**
* Sends future requests to a future compatible handler while sending all
* other requests to a default handler.
*
* When the "future" option is not provided on a request, any future responses
* are automatically converted to synchronous responses and block.
*
* @param callable $default Handler used for non-streaming responses
* @param callable $future Handler used for future responses
*
* @return callable Returns the composed handler.
*/
public static function wrapFuture(callable $default, callable $future)
{
}
/**
* Sends streaming requests to a streaming compatible handler while sendin
* all other requests to a default handler.
*
* This, for example, could be useful for taking advantage of the
* performance benefits of curl while still supporting true streaming
* through the StreamHandler.
*
* @param callable $default Handler used for non-streaming responses
* @param callable $streaming Handler used for streaming responses
*
* @return callable Returns the composed handler.
*/
public static function wrapStreaming(callable $default, callable $streaming)
{
}
}
/**
* Returns an asynchronous response using curl_multi_* functions.
*
* This handler supports future responses and the "delay" request client
* option that can be used to delay before sending a request.
*
* When using the CurlMultiHandler, custom curl options can be specified as an
* associative array of curl option constants mapping to values in the
* **curl** key of the "client" key of the request.
*
* @property resource $_mh Internal use only. Lazy loaded multi-handle.
*/
class CurlMultiHandler
{
/**
* This handler accepts the following options:
*
* - mh: An optional curl_multi resource
* - handle_factory: An optional callable used to generate curl handle
* resources. the callable accepts a request hash and returns an array
* of the handle, headers file resource, and the body resource.
* - select_timeout: Optional timeout (in seconds) to block before timing
* out while selecting curl handles. Defaults to 1 second.
* - max_handles: Optional integer representing the maximum number of
* open requests. When this number is reached, the queued futures are
* flushed.
*
* @param array $options
*/
public function __construct(array $options = [])
{
}
public function __get($name)
{
}
public function __destruct()
{
}
public function __invoke(array $request)
{
}
/**
* Runs until all outstanding connections have completed.
*/
public function execute()
{
}
}
/**
* Client specific utility functions.
*/
class ClientUtils
{
/**
* Returns the default cacert bundle for the current system.
*
* First, the openssl.cafile and curl.cainfo php.ini settings are checked.
* If those settings are not configured, then the common locations for
* bundles found on Red Hat, CentOS, Fedora, Ubuntu, Debian, FreeBSD, OS X
* and Windows are checked. If any of these file locations are found on
* disk, they will be utilized.
*
* Note: the result of this function is cached for subsequent calls.
*
* @return string
* @throws \RuntimeException if no bundle can be found.
*/
public static function getDefaultCaBundle()
{
}
const CA_ERR = "\nNo system CA bundle could be found in any of the the common system locations.\nPHP versions earlier than 5.6 are not properly configured to use the system's\nCA bundle by default. In order to verify peer certificates, you will need to\nsupply the path on disk to a certificate bundle to the 'verify' request\noption: http://docs.guzzlephp.org/en/5.3/clients.html#verify. If you do not\nneed a specific certificate bundle, then Mozilla provides a commonly used CA\nbundle which can be downloaded here (provided by the maintainer of cURL):\nhttps://raw.githubusercontent.com/bagder/ca-bundle/master/ca-bundle.crt. Once\nyou have a CA bundle available on disk, you can set the 'openssl.cafile' PHP\nini setting to point to the path to the file, allowing you to omit the 'verify'\nrequest option. See http://curl.haxx.se/docs/sslcerts.html for more\ninformation.";
}
}
namespace GuzzleHttp\Ring {
/**
* Provides core functionality of Ring handlers and middleware.
*/
class Core
{
/**
* Returns a function that calls all of the provided functions, in order,
* passing the arguments provided to the composed function to each function.
*
* @param callable[] $functions Array of functions to proxy to.
*
* @return callable
*/
public static function callArray(array $functions)
{
}
/**
* Gets an array of header line values from a message for a specific header
*
* This method searches through the "headers" key of a message for a header
* using a case-insensitive search.
*
* @param array $message Request or response hash.
* @param string $header Header to retrieve
*
* @return array
*/
public static function headerLines($message, $header)
{
}
/**
* Gets a header value from a message as a string or null
*
* This method searches through the "headers" key of a message for a header
* using a case-insensitive search. The lines of the header are imploded
* using commas into a single string return value.
*
* @param array $message Request or response hash.
* @param string $header Header to retrieve
*
* @return string|null Returns the header string if found, or null if not.
*/
public static function header($message, $header)
{
}
/**
* Returns the first header value from a message as a string or null. If
* a header line contains multiple values separated by a comma, then this
* function will return the first value in the list.
*
* @param array $message Request or response hash.
* @param string $header Header to retrieve
*
* @return string|null Returns the value as a string if found.
*/
public static function firstHeader($message, $header)
{
}
/**
* Returns true if a message has the provided case-insensitive header.
*
* @param array $message Request or response hash.
* @param string $header Header to check
*
* @return bool
*/
public static function hasHeader($message, $header)
{
}
/**
* Parses an array of header lines into an associative array of headers.
*
* @param array $lines Header lines array of strings in the following
* format: "Name: Value"
* @return array
*/
public static function headersFromLines($lines)
{
}
/**
* Removes a header from a message using a case-insensitive comparison.
*
* @param array $message Message that contains 'headers'
* @param string $header Header to remove
*
* @return array
*/
public static function removeHeader(array $message, $header)
{
}
/**
* Replaces any existing case insensitive headers with the given value.
*
* @param array $message Message that contains 'headers'
* @param string $header Header to set.
* @param array $value Value to set.
*
* @return array
*/
public static function setHeader(array $message, $header, array $value)
{
}
/**
* Creates a URL string from a request.
*
* If the "url" key is present on the request, it is returned, otherwise
* the url is built up based on the scheme, host, uri, and query_string
* request values.
*
* @param array $request Request to get the URL from
*
* @return string Returns the request URL as a string.
* @throws \InvalidArgumentException if no Host header is present.
*/
public static function url(array $request)
{
}
/**
* Reads the body of a message into a string.
*
* @param array|FutureArrayInterface $message Array containing a "body" key
*
* @return null|string Returns the body as a string or null if not set.
* @throws \InvalidArgumentException if a request body is invalid.
*/
public static function body($message)
{
}
/**
* Rewind the body of the provided message if possible.
*
* @param array $message Message that contains a 'body' field.
*
* @return bool Returns true on success, false on failure
*/
public static function rewindBody($message)
{
}
/**
* Debug function used to describe the provided value type and class.
*
* @param mixed $input
*
* @return string Returns a string containing the type of the variable and
* if a class is provided, the class name.
*/
public static function describeType($input)
{
}
/**
* Sleep for the specified amount of time specified in the request's
* ['client']['delay'] option if present.
*
* This function should only be used when a non-blocking sleep is not
* possible.
*
* @param array $request Request to sleep
*/
public static function doSleep(array $request)
{
}
/**
* Returns a proxied future that modifies the dereferenced value of another
* future using a promise.
*
* @param FutureArrayInterface $future Future to wrap with a new future
* @param callable $onFulfilled Invoked when the future fulfilled
* @param callable $onRejected Invoked when the future rejected
* @param callable $onProgress Invoked when the future progresses
*
* @return FutureArray
*/
public static function proxy(\GuzzleHttp\Ring\Future\FutureArrayInterface $future, callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
/**
* Returns a debug stream based on the provided variable.
*
* @param mixed $value Optional value
*
* @return resource
*/
public static function getDebugResource($value = null)
{
}
}
}
namespace GuzzleHttp\Ring\Exception {
/**
* Marker interface for cancelled exceptions.
*/
interface CancelledException
{
}
class RingException extends \RuntimeException
{
}
/**
* Occurs when the connection failed.
*/
class ConnectException extends \GuzzleHttp\Ring\Exception\RingException
{
}
class CancelledFutureAccessException extends \GuzzleHttp\Ring\Exception\RingException implements \GuzzleHttp\Ring\Exception\CancelledException
{
}
}
namespace GuzzleHttp\Event {
/**
* Holds an event emitter
*/
interface HasEmitterInterface
{
/**
* Get the event emitter of the object
*
* @return EmitterInterface
*/
public function getEmitter();
}
}
namespace GuzzleHttp {
/**
* Client interface for sending HTTP requests
*/
interface ClientInterface extends \GuzzleHttp\Event\HasEmitterInterface
{
const VERSION = '5.3.1';
/**
* Create and return a new {@see RequestInterface} object.
*
* Use an absolute path to override the base path of the client, or a
* relative path to append to the base path of the client. The URL can
* contain the query string as well. Use an array to provide a URL
* template and additional variables to use in the URL template expansion.
*
* @param string $method HTTP method
* @param string|array|Url $url URL or URI template
* @param array $options Array of request options to apply.
*
* @return RequestInterface
*/
public function createRequest($method, $url = null, array $options = []);
/**
* Send a GET request
*
* @param string|array|Url $url URL or URI template
* @param array $options Array of request options to apply.
*
* @return ResponseInterface
* @throws RequestException When an error is encountered
*/
public function get($url = null, $options = []);
/**
* Send a HEAD request
*
* @param string|array|Url $url URL or URI template
* @param array $options Array of request options to apply.
*
* @return ResponseInterface
* @throws RequestException When an error is encountered
*/
public function head($url = null, array $options = []);
/**
* Send a DELETE request
*
* @param string|array|Url $url URL or URI template
* @param array $options Array of request options to apply.
*
* @return ResponseInterface
* @throws RequestException When an error is encountered
*/
public function delete($url = null, array $options = []);
/**
* Send a PUT request
*
* @param string|array|Url $url URL or URI template
* @param array $options Array of request options to apply.
*
* @return ResponseInterface
* @throws RequestException When an error is encountered
*/
public function put($url = null, array $options = []);
/**
* Send a PATCH request
*
* @param string|array|Url $url URL or URI template
* @param array $options Array of request options to apply.
*
* @return ResponseInterface
* @throws RequestException When an error is encountered
*/
public function patch($url = null, array $options = []);
/**
* Send a POST request
*
* @param string|array|Url $url URL or URI template
* @param array $options Array of request options to apply.
*
* @return ResponseInterface
* @throws RequestException When an error is encountered
*/
public function post($url = null, array $options = []);
/**
* Send an OPTIONS request
*
* @param string|array|Url $url URL or URI template
* @param array $options Array of request options to apply.
*
* @return ResponseInterface
* @throws RequestException When an error is encountered
*/
public function options($url = null, array $options = []);
/**
* Sends a single request
*
* @param RequestInterface $request Request to send
*
* @return \GuzzleHttp\Message\ResponseInterface
* @throws \LogicException When the handler does not populate a response
* @throws RequestException When an error is encountered
*/
public function send(\GuzzleHttp\Message\RequestInterface $request);
/**
* Get default request options of the client.
*
* @param string|null $keyOrPath The Path to a particular default request
* option to retrieve or pass null to retrieve all default request
* options. The syntax uses "/" to denote a path through nested PHP
* arrays. For example, "headers/content-type".
*
* @return mixed
*/
public function getDefaultOption($keyOrPath = null);
/**
* Set a default request option on the client so that any request created
* by the client will use the provided default value unless overridden
* explicitly when creating a request.
*
* @param string|null $keyOrPath The Path to a particular configuration
* value to set. The syntax uses a path notation that allows you to
* specify nested configuration values (e.g., 'headers/content-type').
* @param mixed $value Default request option value to set
*/
public function setDefaultOption($keyOrPath, $value);
/**
* Get the base URL of the client.
*
* @return string Returns the base URL if present
*/
public function getBaseUrl();
}
}
namespace GuzzleHttp\Event {
/**
* Trait that implements the methods of HasEmitterInterface
*/
trait HasEmitterTrait
{
/** @var EmitterInterface */
private $emitter;
public function getEmitter()
{
}
}
}
namespace GuzzleHttp {
/**
* HTTP client
*/
class Client implements \GuzzleHttp\ClientInterface
{
use \GuzzleHttp\Event\HasEmitterTrait;
/**
* Clients accept an array of constructor parameters.
*
* Here's an example of creating a client using an URI template for the
* client's base_url and an array of default request options to apply
* to each request:
*
* $client = new Client([
* 'base_url' => [
* 'http://www.foo.com/{version}/',
* ['version' => '123']
* ],
* 'defaults' => [
* 'timeout' => 10,
* 'allow_redirects' => false,
* 'proxy' => '192.168.16.1:10'
* ]
* ]);
*
* @param array $config Client configuration settings
* - base_url: Base URL of the client that is merged into relative URLs.
* Can be a string or an array that contains a URI template followed
* by an associative array of expansion variables to inject into the
* URI template.
* - handler: callable RingPHP handler used to transfer requests
* - message_factory: Factory used to create request and response object
* - defaults: Default request options to apply to each request
* - emitter: Event emitter used for request events
* - fsm: (internal use only) The request finite state machine. A
* function that accepts a transaction and optional final state. The
* function is responsible for transitioning a request through its
* lifecycle events.
*/
public function __construct(array $config = [])
{
}
public function getDefaultOption($keyOrPath = null)
{
}
public function setDefaultOption($keyOrPath, $value)
{
}
public function getBaseUrl()
{
}
public function createRequest($method, $url = null, array $options = [])
{
}
public function get($url = null, $options = [])
{
}
public function head($url = null, array $options = [])
{
}
public function delete($url = null, array $options = [])
{
}
public function put($url = null, array $options = [])
{
}
public function patch($url = null, array $options = [])
{
}
public function post($url = null, array $options = [])
{
}
public function options($url = null, array $options = [])
{
}
public function send(\GuzzleHttp\Message\RequestInterface $request)
{
}
/**
* Get an array of default options to apply to the client
*
* @return array
*/
protected function getDefaultOptions()
{
}
/**
* @deprecated Use {@see GuzzleHttp\Pool} instead.
* @see GuzzleHttp\Pool
*/
public function sendAll($requests, array $options = [])
{
}
/**
* @deprecated Use GuzzleHttp\Utils::getDefaultHandler
*/
public static function getDefaultHandler()
{
}
/**
* @deprecated Use GuzzleHttp\Utils::getDefaultUserAgent
*/
public static function getDefaultUserAgent()
{
}
}
/**
* An object that can be represented as an array
*/
interface ToArrayInterface
{
/**
* Get the array representation of an object
*
* @return array
*/
public function toArray();
}
}
namespace GuzzleHttp\Event {
/**
* Base event interface used when dispatching events to listeners using an
* event emitter.
*/
interface EventInterface
{
/**
* Returns whether or not stopPropagation was called on the event.
*
* @return bool
* @see Event::stopPropagation
*/
public function isPropagationStopped();
/**
* Stops the propagation of the event, preventing subsequent listeners
* registered to the same event from being invoked.
*/
public function stopPropagation();
}
/**
* Basic event class that can be extended.
*/
abstract class AbstractEvent implements \GuzzleHttp\Event\EventInterface
{
public function isPropagationStopped()
{
}
public function stopPropagation()
{
}
}
/**
* Base class for request events, providing a request and client getter.
*/
abstract class AbstractRequestEvent extends \GuzzleHttp\Event\AbstractEvent
{
/** @var Transaction */
protected $transaction;
/**
* @param Transaction $transaction
*/
public function __construct(\GuzzleHttp\Transaction $transaction)
{
}
/**
* Get the HTTP client associated with the event.
*
* @return ClientInterface
*/
public function getClient()
{
}
/**
* Get the request object
*
* @return RequestInterface
*/
public function getRequest()
{
}
/**
* Get the number of transaction retries.
*
* @return int
*/
public function getRetryCount()
{
}
/**
* @return Transaction
*/
public function getTransaction()
{
}
}
/**
* Event that contains transfer statistics, and can be intercepted.
*/
abstract class AbstractTransferEvent extends \GuzzleHttp\Event\AbstractRequestEvent
{
/**
* Get all transfer information as an associative array if no $name
* argument is supplied, or gets a specific transfer statistic if
* a $name attribute is supplied (e.g., 'total_time').
*
* @param string $name Name of the transfer stat to retrieve
*
* @return mixed|null|array
*/
public function getTransferInfo($name = null)
{
}
/**
* Returns true/false if a response is available.
*
* @return bool
*/
public function hasResponse()
{
}
/**
* Get the response.
*
* @return ResponseInterface|null
*/
public function getResponse()
{
}
/**
* Intercept the request and associate a response
*
* @param ResponseInterface $response Response to set
*/
public function intercept(\GuzzleHttp\Message\ResponseInterface $response)
{
}
}
/**
* Abstract request event that can be retried.
*/
class AbstractRetryableEvent extends \GuzzleHttp\Event\AbstractTransferEvent
{
/**
* Mark the request as needing a retry and stop event propagation.
*
* This action allows you to retry a request without emitting the "end"
* event multiple times for a given request. When retried, the request
* emits a before event and is then sent again using the client that sent
* the original request.
*
* When retrying, it is important to limit the number of retries you allow
* to prevent infinite loops.
*
* This action can only be taken during the "complete" and "error" events.
*
* @param int $afterDelay If specified, the amount of time in milliseconds
* to delay before retrying. Note that this must
* be supported by the underlying RingPHP handler
* to work properly. Set to 0 or provide no value
* to retry immediately.
*/
public function retry($afterDelay = 0)
{
}
}
/**
* Event emitted when an error occurs while sending a request.
*
* This event MAY be emitted multiple times. You MAY intercept the exception
* and inject a response into the event to rescue the request using the
* intercept() method of the event.
*
* This event allows the request to be retried using the "retry" method of the
* event.
*/
class ErrorEvent extends \GuzzleHttp\Event\AbstractRetryableEvent
{
/**
* Get the exception that was encountered
*
* @return RequestException
*/
public function getException()
{
}
}
/**
* Trait that provides methods for extract event listeners specified in an array
* and attaching them to an emitter owned by the object or one of its direct
* dependencies.
*/
trait ListenerAttacherTrait
{
/**
* Attaches event listeners and properly sets their priorities and whether
* or not they are are only executed once.
*
* @param HasEmitterInterface $object Object that has the event emitter.
* @param array $listeners Array of hashes representing event
* event listeners. Each item contains
* "name", "fn", "priority", & "once".
*/
private function attachListeners(\GuzzleHttp\Event\HasEmitterInterface $object, array $listeners)
{
}
/**
* Extracts the allowed events from the provided array, and ignores anything
* else in the array. The event listener must be specified as a callable or
* as an array of event listener data ("name", "fn", "priority", "once").
*
* @param array $source Array containing callables or hashes of data to be
* prepared as event listeners.
* @param array $events Names of events to look for in the provided $source
* array. Other keys are ignored.
* @return array
*/
private function prepareListeners(array $source, array $events)
{
}
/**
* Creates a complete event listener definition from the provided array of
* listener data. Also works recursively if more than one listeners are
* contained in the provided array.
*
* @param string $name Name of the event the listener is for.
* @param array|callable $data Event listener data to prepare.
* @param array $listeners Array of listeners, passed by reference.
*
* @throws \InvalidArgumentException if the event data is malformed.
*/
private function buildListener($name, $data, &$listeners)
{
}
}
/**
* Guzzle event emitter.
*/
interface EmitterInterface
{
/**
* Binds a listener to a specific event.
*
* @param string $eventName Name of the event to bind to.
* @param callable $listener Listener to invoke when triggered.
* @param int|string $priority The higher this value, the earlier an event
* listener will be triggered in the chain (defaults to 0). You can
* pass "first" or "last" to dynamically specify the event priority
* based on the current event priorities associated with the given
* event name in the emitter. Use "first" to set the priority to the
* current highest priority plus one. Use "last" to set the priority to
* the current lowest event priority minus one.
*/
public function on($eventName, callable $listener, $priority = 0);
/**
* Binds a listener to a specific event. After the listener is triggered
* once, it is removed as a listener.
*
* @param string $eventName Name of the event to bind to.
* @param callable $listener Listener to invoke when triggered.
* @param int $priority The higher this value, the earlier an event
* listener will be triggered in the chain (defaults to 0)
*/
public function once($eventName, callable $listener, $priority = 0);
/**
* Removes an event listener from the specified event.
*
* @param string $eventName The event to remove a listener from
* @param callable $listener The listener to remove
*/
public function removeListener($eventName, callable $listener);
/**
* Gets the listeners of a specific event or all listeners if no event is
* specified.
*
* @param string $eventName The name of the event. Pass null (the default)
* to retrieve all listeners.
*
* @return array The event listeners for the specified event, or all event
* listeners by event name. The format of the array when retrieving a
* specific event list is an array of callables. The format of the array
* when retrieving all listeners is an associative array of arrays of
* callables.
*/
public function listeners($eventName = null);
/**
* Checks if the emitter has listeners by the given name.
*
* @param string $eventName The name of the event to check.
*
* @return bool
*/
public function hasListeners($eventName);
/**
* Emits an event to all registered listeners.
*
* Each event that is bound to the emitted eventName receives a
* EventInterface, the name of the event, and the event emitter.
*
* @param string $eventName The name of the event to dispatch.
* @param EventInterface $event The event to pass to the event handlers/listeners.
*
* @return EventInterface Returns the provided event object
*/
public function emit($eventName, \GuzzleHttp\Event\EventInterface $event);
/**
* Attaches an event subscriber.
*
* The subscriber is asked for all the events it is interested in and added
* as an event listener for each event.
*
* @param SubscriberInterface $subscriber Subscriber to attach.
*/
public function attach(\GuzzleHttp\Event\SubscriberInterface $subscriber);
/**
* Detaches an event subscriber.
*
* @param SubscriberInterface $subscriber Subscriber to detach.
*/
public function detach(\GuzzleHttp\Event\SubscriberInterface $subscriber);
}
/**
* Guzzle event emitter.
*
* Some of this class is based on the Symfony EventDispatcher component, which
* ships with the following license:
*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*
* @link https://github.com/symfony/symfony/tree/master/src/Symfony/Component/EventDispatcher
*/
class Emitter implements \GuzzleHttp\Event\EmitterInterface
{
public function on($eventName, callable $listener, $priority = 0)
{
}
public function once($eventName, callable $listener, $priority = 0)
{
}
public function removeListener($eventName, callable $listener)
{
}
public function listeners($eventName = null)
{
}
public function hasListeners($eventName)
{
}
public function emit($eventName, \GuzzleHttp\Event\EventInterface $event)
{
}
public function attach(\GuzzleHttp\Event\SubscriberInterface $subscriber)
{
}
public function detach(\GuzzleHttp\Event\SubscriberInterface $subscriber)
{
}
}
/**
* Event object emitted when upload or download progress is made.
*
* You can access the progress values using their corresponding public
* properties:
*
* - $downloadSize: The number of bytes that will be downloaded (if known)
* - $downloaded: The number of bytes that have been downloaded
* - $uploadSize: The number of bytes that will be uploaded (if known)
* - $uploaded: The number of bytes that have been uploaded
*/
class ProgressEvent extends \GuzzleHttp\Event\AbstractRequestEvent
{
/** @var int Amount of data to be downloaded */
public $downloadSize;
/** @var int Amount of data that has been downloaded */
public $downloaded;
/** @var int Amount of data to upload */
public $uploadSize;
/** @var int Amount of data that has been uploaded */
public $uploaded;
/**
* @param Transaction $transaction Transaction being sent.
* @param int $downloadSize Amount of data to download (if known)
* @param int $downloaded Amount of data that has been downloaded
* @param int $uploadSize Amount of data to upload (if known)
* @param int $uploaded Amount of data that had been uploaded
*/
public function __construct(\GuzzleHttp\Transaction $transaction, $downloadSize, $downloaded, $uploadSize, $uploaded)
{
}
}
/**
* Contains methods used to manage the request event lifecycle.
*/
final class RequestEvents
{
// Generic event priorities
const EARLY = 10000;
const LATE = -10000;
// "before" priorities
const PREPARE_REQUEST = -100;
const SIGN_REQUEST = -10000;
// "complete" and "error" response priorities
const VERIFY_RESPONSE = 100;
const REDIRECT_RESPONSE = 200;
/**
* Converts an array of event options into a formatted array of valid event
* configuration.
*
* @param array $options Event array to convert
* @param array $events Event names to convert in the options array.
* @param mixed $handler Event handler to utilize
*
* @return array
* @throws \InvalidArgumentException if the event config is invalid
* @internal
*/
public static function convertEventArray(array $options, array $events, $handler)
{
}
}
/**
* Event object emitted after a request has been completed.
*
* This event MAY be emitted multiple times for a single request. You MAY
* change the Response associated with the request using the intercept()
* method of the event.
*
* This event allows the request to be retried if necessary using the retry()
* method of the event.
*/
class CompleteEvent extends \GuzzleHttp\Event\AbstractRetryableEvent
{
}
/**
* SubscriberInterface provides an array of events to an
* EventEmitterInterface when it is registered. The emitter then binds the
* listeners specified by the EventSubscriber.
*
* This interface is based on the SubscriberInterface of the Symfony.
* @link https://github.com/symfony/symfony/tree/master/src/Symfony/Component/EventDispatcher
*/
interface SubscriberInterface
{
/**
* Returns an array of event names this subscriber wants to listen to.
*
* The returned array keys MUST map to an event name. Each array value
* MUST be an array in which the first element is the name of a function
* on the EventSubscriber OR an array of arrays in the aforementioned
* format. The second element in the array is optional, and if specified,
* designates the event priority.
*
* For example, the following are all valid:
*
* - ['eventName' => ['methodName']]
* - ['eventName' => ['methodName', $priority]]
* - ['eventName' => [['methodName'], ['otherMethod']]
* - ['eventName' => [['methodName'], ['otherMethod', $priority]]
* - ['eventName' => [['methodName', $priority], ['otherMethod', $priority]]
*
* @return array
*/
public function getEvents();
}
/**
* Event object emitted before a request is sent.
*
* This event MAY be emitted multiple times (i.e., if a request is retried).
* You MAY change the Response associated with the request using the
* intercept() method of the event.
*/
class BeforeEvent extends \GuzzleHttp\Event\AbstractRequestEvent
{
/**
* Intercept the request and associate a response
*
* @param ResponseInterface $response Response to set
*/
public function intercept(\GuzzleHttp\Message\ResponseInterface $response)
{
}
}
/**
* A terminal event that is emitted when a request transaction has ended.
*
* This event is emitted for both successful responses and responses that
* encountered an exception. You need to check if an exception is present
* in your listener to know the difference.
*
* You MAY intercept the response associated with the event if needed, but keep
* in mind that the "complete" event will not be triggered as a result.
*/
class EndEvent extends \GuzzleHttp\Event\AbstractTransferEvent
{
/**
* Get the exception that was encountered (if any).
*
* This method should be used to check if the request was sent successfully
* or if it encountered errors.
*
* @return \Exception|null
*/
public function getException()
{
}
}
}
namespace GuzzleHttp {
/**
* Expands URI templates. Userland implementation of PECL uri_template.
*
* @link http://tools.ietf.org/html/rfc6570
*/
class UriTemplate
{
public function expand($template, array $variables)
{
}
}
/**
* Utility methods used throughout Guzzle.
*/
final class Utils
{
/**
* Gets a value from an array using a path syntax to retrieve nested data.
*
* This method does not allow for keys that contain "/". You must traverse
* the array manually or using something more advanced like JMESPath to
* work with keys that contain "/".
*
* // Get the bar key of a set of nested arrays.
* // This is equivalent to $collection['foo']['baz']['bar'] but won't
* // throw warnings for missing keys.
* GuzzleHttp\get_path($data, 'foo/baz/bar');
*
* @param array $data Data to retrieve values from
* @param string $path Path to traverse and retrieve a value from
*
* @return mixed|null
*/
public static function getPath($data, $path)
{
}
/**
* Set a value in a nested array key. Keys will be created as needed to set
* the value.
*
* This function does not support keys that contain "/" or "[]" characters
* because these are special tokens used when traversing the data structure.
* A value may be prepended to an existing array by using "[]" as the final
* key of a path.
*
* GuzzleHttp\get_path($data, 'foo/baz'); // null
* GuzzleHttp\set_path($data, 'foo/baz/[]', 'a');
* GuzzleHttp\set_path($data, 'foo/baz/[]', 'b');
* GuzzleHttp\get_path($data, 'foo/baz');
* // Returns ['a', 'b']
*
* @param array $data Data to modify by reference
* @param string $path Path to set
* @param mixed $value Value to set at the key
*
* @throws \RuntimeException when trying to setPath using a nested path
* that travels through a scalar value.
*/
public static function setPath(&$data, $path, $value)
{
}
/**
* Expands a URI template
*
* @param string $template URI template
* @param array $variables Template variables
*
* @return string
*/
public static function uriTemplate($template, array $variables)
{
}
/**
* Wrapper for JSON decode that implements error detection with helpful
* error messages.
*
* @param string $json JSON data to parse
* @param bool $assoc When true, returned objects will be converted
* into associative arrays.
* @param int $depth User specified recursion depth.
* @param int $options Bitmask of JSON decode options.
*
* @return mixed
* @throws \InvalidArgumentException if the JSON cannot be parsed.
* @link http://www.php.net/manual/en/function.json-decode.php
*/
public static function jsonDecode($json, $assoc = false, $depth = 512, $options = 0)
{
}
/**
* Get the default User-Agent string to use with Guzzle
*
* @return string
*/
public static function getDefaultUserAgent()
{
}
/**
* Create a default handler to use based on the environment
*
* @throws \RuntimeException if no viable Handler is available.
*/
public static function getDefaultHandler()
{
}
}
}
namespace GuzzleHttp\Cookie {
/**
* Set-Cookie object
*/
class SetCookie implements \GuzzleHttp\ToArrayInterface
{
/**
* Create a new SetCookie object from a string
*
* @param string $cookie Set-Cookie header string
*
* @return self
*/
public static function fromString($cookie)
{
}
/**
* @param array $data Array of cookie data provided by a Cookie parser
*/
public function __construct(array $data = [])
{
}
public function __toString()
{
}
public function toArray()
{
}
/**
* Get the cookie name
*
* @return string
*/
public function getName()
{
}
/**
* Set the cookie name
*
* @param string $name Cookie name
*/
public function setName($name)
{
}
/**
* Get the cookie value
*
* @return string
*/
public function getValue()
{
}
/**
* Set the cookie value
*
* @param string $value Cookie value
*/
public function setValue($value)
{
}
/**
* Get the domain
*
* @return string|null
*/
public function getDomain()
{
}
/**
* Set the domain of the cookie
*
* @param string $domain
*/
public function setDomain($domain)
{
}
/**
* Get the path
*
* @return string
*/
public function getPath()
{
}
/**
* Set the path of the cookie
*
* @param string $path Path of the cookie
*/
public function setPath($path)
{
}
/**
* Maximum lifetime of the cookie in seconds
*
* @return int|null
*/
public function getMaxAge()
{
}
/**
* Set the max-age of the cookie
*
* @param int $maxAge Max age of the cookie in seconds
*/
public function setMaxAge($maxAge)
{
}
/**
* The UNIX timestamp when the cookie Expires
*
* @return mixed
*/
public function getExpires()
{
}
/**
* Set the unix timestamp for which the cookie will expire
*
* @param int $timestamp Unix timestamp
*/
public function setExpires($timestamp)
{
}
/**
* Get whether or not this is a secure cookie
*
* @return null|bool
*/
public function getSecure()
{
}
/**
* Set whether or not the cookie is secure
*
* @param bool $secure Set to true or false if secure
*/
public function setSecure($secure)
{
}
/**
* Get whether or not this is a session cookie
*
* @return null|bool
*/
public function getDiscard()
{
}
/**
* Set whether or not this is a session cookie
*
* @param bool $discard Set to true or false if this is a session cookie
*/
public function setDiscard($discard)
{
}
/**
* Get whether or not this is an HTTP only cookie
*
* @return bool
*/
public function getHttpOnly()
{
}
/**
* Set whether or not this is an HTTP only cookie
*
* @param bool $httpOnly Set to true or false if this is HTTP only
*/
public function setHttpOnly($httpOnly)
{
}
/**
* Check if the cookie matches a path value
*
* @param string $path Path to check against
*
* @return bool
*/
public function matchesPath($path)
{
}
/**
* Check if the cookie matches a domain value
*
* @param string $domain Domain to check against
*
* @return bool
*/
public function matchesDomain($domain)
{
}
/**
* Check if the cookie is expired
*
* @return bool
*/
public function isExpired()
{
}
/**
* Check if the cookie is valid according to RFC 6265
*
* @return bool|string Returns true if valid or an error message if invalid
*/
public function validate()
{
}
}
/**
* Stores HTTP cookies.
*
* It extracts cookies from HTTP requests, and returns them in HTTP responses.
* CookieJarInterface instances automatically expire contained cookies when
* necessary. Subclasses are also responsible for storing and retrieving
* cookies from a file, database, etc.
*
* @link http://docs.python.org/2/library/cookielib.html Inspiration
*/
interface CookieJarInterface extends \Countable, \IteratorAggregate
{
/**
* Add a Cookie header to a request.
*
* If no matching cookies are found in the cookie jar, then no Cookie
* header is added to the request.
*
* @param RequestInterface $request Request object to update
*/
public function addCookieHeader(\GuzzleHttp\Message\RequestInterface $request);
/**
* Extract cookies from an HTTP response and store them in the CookieJar.
*
* @param RequestInterface $request Request that was sent
* @param ResponseInterface $response Response that was received
*/
public function extractCookies(\GuzzleHttp\Message\RequestInterface $request, \GuzzleHttp\Message\ResponseInterface $response);
/**
* Sets a cookie in the cookie jar.
*
* @param SetCookie $cookie Cookie to set.
*
* @return bool Returns true on success or false on failure
*/
public function setCookie(\GuzzleHttp\Cookie\SetCookie $cookie);
/**
* Remove cookies currently held in the cookie jar.
*
* Invoking this method without arguments will empty the whole cookie jar.
* If given a $domain argument only cookies belonging to that domain will
* be removed. If given a $domain and $path argument, cookies belonging to
* the specified path within that domain are removed. If given all three
* arguments, then the cookie with the specified name, path and domain is
* removed.
*
* @param string $domain Clears cookies matching a domain
* @param string $path Clears cookies matching a domain and path
* @param string $name Clears cookies matching a domain, path, and name
*
* @return CookieJarInterface
*/
public function clear($domain = null, $path = null, $name = null);
/**
* Discard all sessions cookies.
*
* Removes cookies that don't have an expire field or a have a discard
* field set to true. To be called when the user agent shuts down according
* to RFC 2965.
*/
public function clearSessionCookies();
}
/**
* Cookie jar that stores cookies an an array
*/
class CookieJar implements \GuzzleHttp\Cookie\CookieJarInterface, \GuzzleHttp\ToArrayInterface
{
/**
* @param bool $strictMode Set to true to throw exceptions when invalid
* cookies are added to the cookie jar.
* @param array $cookieArray Array of SetCookie objects or a hash of arrays
* that can be used with the SetCookie constructor
*/
public function __construct($strictMode = false, $cookieArray = [])
{
}
/**
* Create a new Cookie jar from an associative array and domain.
*
* @param array $cookies Cookies to create the jar from
* @param string $domain Domain to set the cookies to
*
* @return self
*/
public static function fromArray(array $cookies, $domain)
{
}
/**
* Quote the cookie value if it is not already quoted and it contains
* problematic characters.
*
* @param string $value Value that may or may not need to be quoted
*
* @return string
*/
public static function getCookieValue($value)
{
}
public function toArray()
{
}
public function clear($domain = null, $path = null, $name = null)
{
}
public function clearSessionCookies()
{
}
public function setCookie(\GuzzleHttp\Cookie\SetCookie $cookie)
{
}
public function count()
{
}
public function getIterator()
{
}
public function extractCookies(\GuzzleHttp\Message\RequestInterface $request, \GuzzleHttp\Message\ResponseInterface $response)
{
}
public function addCookieHeader(\GuzzleHttp\Message\RequestInterface $request)
{
}
}
/**
* Persists cookies in the client session
*/
class SessionCookieJar extends \GuzzleHttp\Cookie\CookieJar
{
/**
* Create a new SessionCookieJar object
*
* @param string $sessionKey Session key name to store the cookie data in session
*/
public function __construct($sessionKey)
{
}
/**
* Saves cookies to session when shutting down
*/
public function __destruct()
{
}
/**
* Save cookies to the client session
*/
public function save()
{
}
/**
* Load the contents of the client session into the data array
*/
protected function load()
{
}
}
/**
* Persists non-session cookies using a JSON formatted file
*/
class FileCookieJar extends \GuzzleHttp\Cookie\CookieJar
{
/**
* Create a new FileCookieJar object
*
* @param string $cookieFile File to store the cookie data
*
* @throws \RuntimeException if the file cannot be found or created
*/
public function __construct($cookieFile)
{
}
/**
* Saves the file when shutting down
*/
public function __destruct()
{
}
/**
* Saves the cookies to a file.
*
* @param string $filename File to save
* @throws \RuntimeException if the file cannot be found or created
*/
public function save($filename)
{
}
/**
* Load cookies from a JSON formatted file.
*
* Old cookies are kept unless overwritten by newly loaded ones.
*
* @param string $filename Cookie file to load.
* @throws \RuntimeException if the file cannot be loaded.
*/
public function load($filename)
{
}
}
}
namespace GuzzleHttp {
/**
* Parses and generates URLs based on URL parts
*/
class Url
{
/**
* Factory method to create a new URL from a URL string
*
* @param string $url Full URL used to create a Url object
*
* @return Url
* @throws \InvalidArgumentException
*/
public static function fromString($url)
{
}
/**
* Build a URL from parse_url parts. The generated URL will be a relative
* URL if a scheme or host are not provided.
*
* @param array $parts Array of parse_url parts
*
* @return string
*/
public static function buildUrl(array $parts)
{
}
/**
* Create a new URL from URL parts
*
* @param string $scheme Scheme of the URL
* @param string $host Host of the URL
* @param string $username Username of the URL
* @param string $password Password of the URL
* @param int $port Port of the URL
* @param string $path Path of the URL
* @param Query|array|string $query Query string of the URL
* @param string $fragment Fragment of the URL
*/
public function __construct($scheme, $host, $username = null, $password = null, $port = null, $path = null, $query = null, $fragment = null)
{
}
/**
* Clone the URL
*/
public function __clone()
{
}
/**
* Returns the URL as a URL string
*
* @return string
*/
public function __toString()
{
}
/**
* Get the parts of the URL as an array
*
* @return array
*/
public function getParts()
{
}
/**
* Set the host of the request.
*
* @param string $host Host to set (e.g. www.yahoo.com, yahoo.com)
*
* @return Url
*/
public function setHost($host)
{
}
/**
* Get the host part of the URL
*
* @return string
*/
public function getHost()
{
}
/**
* Set the scheme part of the URL (http, https, ftp, etc.)
*
* @param string $scheme Scheme to set
*/
public function setScheme($scheme)
{
}
/**
* Get the scheme part of the URL
*
* @return string
*/
public function getScheme()
{
}
/**
* Set the port part of the URL
*
* @param int $port Port to set
*/
public function setPort($port)
{
}
/**
* Get the port part of the URl.
*
* If no port was set, this method will return the default port for the
* scheme of the URI.
*
* @return int|null
*/
public function getPort()
{
}
/**
* Set the path part of the URL.
*
* The provided URL is URL encoded as necessary.
*
* @param string $path Path string to set
*/
public function setPath($path)
{
}
/**
* Removes dot segments from a URL
* @link http://tools.ietf.org/html/rfc3986#section-5.2.4
*/
public function removeDotSegments()
{
}
/**
* Add a relative path to the currently set path.
*
* @param string $relativePath Relative path to add
*/
public function addPath($relativePath)
{
}
/**
* Get the path part of the URL
*
* @return string
*/
public function getPath()
{
}
/**
* Get the path segments of the URL as an array
*
* @return array
*/
public function getPathSegments()
{
}
/**
* Set the password part of the URL
*
* @param string $password Password to set
*/
public function setPassword($password)
{
}
/**
* Get the password part of the URL
*
* @return null|string
*/
public function getPassword()
{
}
/**
* Set the username part of the URL
*
* @param string $username Username to set
*/
public function setUsername($username)
{
}
/**
* Get the username part of the URl
*
* @return null|string
*/
public function getUsername()
{
}
/**
* Get the query part of the URL as a Query object
*
* @return Query
*/
public function getQuery()
{
}
/**
* Set the query part of the URL.
*
* You may provide a query string as a string and pass $rawString as true
* to provide a query string that is not parsed until a call to getQuery()
* is made. Setting a raw query string will still encode invalid characters
* in a query string.
*
* @param Query|string|array $query Query string value to set. Can
* be a string that will be parsed into a Query object, an array
* of key value pairs, or a Query object.
* @param bool $rawString Set to true when providing a raw query string.
*
* @throws \InvalidArgumentException
*/
public function setQuery($query, $rawString = false)
{
}
/**
* Get the fragment part of the URL
*
* @return null|string
*/
public function getFragment()
{
}
/**
* Set the fragment part of the URL
*
* @param string $fragment Fragment to set
*/
public function setFragment($fragment)
{
}
/**
* Check if this is an absolute URL
*
* @return bool
*/
public function isAbsolute()
{
}
/**
* Combine the URL with another URL and return a new URL instance.
*
* Follows the rules specific in RFC 3986 section 5.4.
*
* @param string $url Relative URL to combine with
*
* @return Url
* @throws \InvalidArgumentException
* @link http://tools.ietf.org/html/rfc3986#section-5.4
*/
public function combine($url)
{
}
/**
* Encodes the path part of a URL without double-encoding percent-encoded
* key value pairs.
*
* @param string $path Path to encode
*
* @return string
*/
public static function encodePath($path)
{
}
}
/**
* Responsible for transitioning requests through lifecycle events.
*/
class RequestFsm
{
public function __construct(callable $handler, \GuzzleHttp\Message\MessageFactoryInterface $messageFactory, $maxTransitions = 200)
{
}
/**
* Runs the state machine until a terminal state is entered or the
* optionally supplied $finalState is entered.
*
* @param Transaction $trans Transaction being transitioned.
*
* @throws \Exception if a terminal state throws an exception.
*/
public function __invoke(\GuzzleHttp\Transaction $trans)
{
}
}
/**
* Represents the relationship between a client, request, and response.
*
* You can access the request, response, and client using their corresponding
* public properties.
*/
class Transaction
{
/**
* HTTP client used to transfer the request.
*
* @var ClientInterface
*/
public $client;
/**
* The request that is being sent.
*
* @var RequestInterface
*/
public $request;
/**
* The response associated with the transaction. A response will not be
* present when a networking error occurs or an error occurs before sending
* the request.
*
* @var ResponseInterface|null
*/
public $response;
/**
* Exception associated with the transaction. If this exception is present
* when processing synchronous or future commands, then it is thrown. When
* intercepting a failed transaction, you MUST set this value to null in
* order to prevent the exception from being thrown.
*
* @var \Exception
*/
public $exception;
/**
* Associative array of handler specific transfer statistics and custom
* key value pair information. When providing similar information, handlers
* should follow the same key value pair naming conventions as PHP's
* curl_getinfo() (http://php.net/manual/en/function.curl-getinfo.php).
*
* @var array
*/
public $transferInfo = [];
/**
* The number of transaction retries.
*
* @var int
*/
public $retries = 0;
/**
* The transaction's current state.
*
* @var string
*/
public $state;
/**
* Whether or not this is a future transaction. This value should not be
* changed after the future is constructed.
*
* @var bool
*/
public $future;
/**
* The number of state transitions that this transaction has been through.
*
* @var int
* @internal This is for internal use only. If you modify this, then you
* are asking for trouble.
*/
public $_transitionCount = 0;
/**
* @param ClientInterface $client Client that is used to send the requests
* @param RequestInterface $request Request to send
* @param bool $future Whether or not this is a future request.
*/
public function __construct(\GuzzleHttp\ClientInterface $client, \GuzzleHttp\Message\RequestInterface $request, $future = false)
{
}
}
/**
* Sends and iterator of requests concurrently using a capped pool size.
*
* The Pool object implements FutureInterface, meaning it can be used later
* when necessary, the requests provided to the pool can be cancelled, and
* you can check the state of the pool to know if it has been dereferenced
* (sent) or has been cancelled.
*
* When sending the pool, keep in mind that no results are returned: callers
* are expected to handle results asynchronously using Guzzle's event system.
* When requests complete, more are added to the pool to ensure that the
* requested pool size is always filled as much as possible.
*
* IMPORTANT: Do not provide a pool size greater that what the utilized
* underlying RingPHP handler can support. This will result is extremely poor
* performance.
*/
class Pool implements \GuzzleHttp\Ring\Future\FutureInterface
{
use \GuzzleHttp\Event\ListenerAttacherTrait;
/**
* The option values for 'before', 'complete', 'error' and 'end' can be a
* callable, an associative array containing event data, or an array of
* event data arrays. Event data arrays contain the following keys:
*
* - fn: callable to invoke that receives the event
* - priority: Optional event priority (defaults to 0)
* - once: Set to true so that the event is removed after it is triggered
*
* @param ClientInterface $client Client used to send the requests.
* @param array|\Iterator $requests Requests to send in parallel
* @param array $options Associative array of options
* - pool_size: (callable|int) Maximum number of requests to send
* concurrently, or a callback that receives
* the current queue size and returns the
* number of new requests to send
* - before: (callable|array) Receives a BeforeEvent
* - complete: (callable|array) Receives a CompleteEvent
* - error: (callable|array) Receives a ErrorEvent
* - end: (callable|array) Receives an EndEvent
*/
public function __construct(\GuzzleHttp\ClientInterface $client, $requests, array $options = [])
{
}
/**
* Sends multiple requests in parallel and returns an array of responses
* and exceptions that uses the same ordering as the provided requests.
*
* IMPORTANT: This method keeps every request and response in memory, and
* as such, is NOT recommended when sending a large number or an
* indeterminate number of requests concurrently.
*
* @param ClientInterface $client Client used to send the requests
* @param array|\Iterator $requests Requests to send in parallel
* @param array $options Passes through the options available in
* {@see GuzzleHttp\Pool::__construct}
*
* @return BatchResults Returns a container for the results.
* @throws \InvalidArgumentException if the event format is incorrect.
*/
public static function batch(\GuzzleHttp\ClientInterface $client, $requests, array $options = [])
{
}
/**
* Creates a Pool and immediately sends the requests.
*
* @param ClientInterface $client Client used to send the requests
* @param array|\Iterator $requests Requests to send in parallel
* @param array $options Passes through the options available in
* {@see GuzzleHttp\Pool::__construct}
*/
public static function send(\GuzzleHttp\ClientInterface $client, $requests, array $options = [])
{
}
public function wait()
{
}
/**
* {@inheritdoc}
*
* Attempt to cancel all outstanding requests (requests that are queued for
* dereferencing). Returns true if all outstanding requests can be
* cancelled.
*
* @return bool
*/
public function cancel()
{
}
/**
* Returns a promise that is invoked when the pool completed. There will be
* no passed value.
*
* {@inheritdoc}
*/
public function then(callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function promise()
{
}
public function _trackRetries(\GuzzleHttp\Event\BeforeEvent $e)
{
}
}
/**
* Trait implementing ToArrayInterface, \ArrayAccess, \Countable,
* \IteratorAggregate, and some path style methods.
*/
trait HasDataTrait
{
/** @var array */
protected $data = [];
public function getIterator()
{
}
public function offsetGet($offset)
{
}
public function offsetSet($offset, $value)
{
}
public function offsetExists($offset)
{
}
public function offsetUnset($offset)
{
}
public function toArray()
{
}
public function count()
{
}
/**
* Get a value from the collection using a path syntax to retrieve nested
* data.
*
* @param string $path Path to traverse and retrieve a value from
*
* @return mixed|null
*/
public function getPath($path)
{
}
/**
* Set a value into a nested array key. Keys will be created as needed to
* set the value.
*
* @param string $path Path to set
* @param mixed $value Value to set at the key
*
* @throws \RuntimeException when trying to setPath using a nested path
* that travels through a scalar value
*/
public function setPath($path, $value)
{
}
}
/**
* Key value pair collection object
*/
class Collection implements \ArrayAccess, \IteratorAggregate, \Countable, \GuzzleHttp\ToArrayInterface
{
use \GuzzleHttp\HasDataTrait;
/**
* @param array $data Associative array of data to set
*/
public function __construct(array $data = [])
{
}
/**
* Create a new collection from an array, validate the keys, and add default
* values where missing
*
* @param array $config Configuration values to apply.
* @param array $defaults Default parameters
* @param array $required Required parameter names
*
* @return self
* @throws \InvalidArgumentException if a parameter is missing
*/
public static function fromConfig(array $config = [], array $defaults = [], array $required = [])
{
}
/**
* Removes all key value pairs
*/
public function clear()
{
}
/**
* Get a specific key value.
*
* @param string $key Key to retrieve.
*
* @return mixed|null Value of the key or NULL
*/
public function get($key)
{
}
/**
* Set a key value pair
*
* @param string $key Key to set
* @param mixed $value Value to set
*/
public function set($key, $value)
{
}
/**
* Add a value to a key. If a key of the same name has already been added,
* the key value will be converted into an array and the new value will be
* pushed to the end of the array.
*
* @param string $key Key to add
* @param mixed $value Value to add to the key
*/
public function add($key, $value)
{
}
/**
* Remove a specific key value pair
*
* @param string $key A key to remove
*/
public function remove($key)
{
}
/**
* Get all keys in the collection
*
* @return array
*/
public function getKeys()
{
}
/**
* Returns whether or not the specified key is present.
*
* @param string $key The key for which to check the existence.
*
* @return bool
*/
public function hasKey($key)
{
}
/**
* Checks if any keys contains a certain value
*
* @param string $value Value to search for
*
* @return mixed Returns the key if the value was found FALSE if the value
* was not found.
*/
public function hasValue($value)
{
}
/**
* Replace the data of the object with the value of an array
*
* @param array $data Associative array of data
*/
public function replace(array $data)
{
}
/**
* Add and merge in a Collection or array of key value pair data.
*
* @param Collection|array $data Associative array of key value pair data
*/
public function merge($data)
{
}
/**
* Overwrite key value pairs in this collection with all of the data from
* an array or collection.
*
* @param array|\Traversable $data Values to override over this config
*/
public function overwriteWith($data)
{
}
/**
* Returns a Collection containing all the elements of the collection after
* applying the callback function to each one.
*
* The callable should accept three arguments:
* - (string) $key
* - (string) $value
* - (array) $context
*
* The callable must return a the altered or unaltered value.
*
* @param callable $closure Map function to apply
* @param array $context Context to pass to the callable
*
* @return Collection
*/
public function map(callable $closure, array $context = [])
{
}
/**
* Iterates over each key value pair in the collection passing them to the
* callable. If the callable returns true, the current value from input is
* returned into the result Collection.
*
* The callable must accept two arguments:
* - (string) $key
* - (string) $value
*
* @param callable $closure Evaluation function
*
* @return Collection
*/
public function filter(callable $closure)
{
}
}
/**
* Manages query string variables and can aggregate them into a string
*/
class Query extends \GuzzleHttp\Collection
{
const RFC3986 = 'RFC3986';
const RFC1738 = 'RFC1738';
/**
* Parse a query string into a Query object
*
* $urlEncoding is used to control how the query string is parsed and how
* it is ultimately serialized. The value can be set to one of the
* following:
*
* - true: (default) Parse query strings using RFC 3986 while still
* converting "+" to " ".
* - false: Disables URL decoding of the input string and URL encoding when
* the query string is serialized.
* - 'RFC3986': Use RFC 3986 URL encoding/decoding
* - 'RFC1738': Use RFC 1738 URL encoding/decoding
*
* @param string $query Query string to parse
* @param bool|string $urlEncoding Controls how the input string is decoded
* and encoded.
* @return self
*/
public static function fromString($query, $urlEncoding = true)
{
}
/**
* Convert the query string parameters to a query string string
*
* @return string
*/
public function __toString()
{
}
/**
* Controls how multi-valued query string parameters are aggregated into a
* string.
*
* $query->setAggregator($query::duplicateAggregator());
*
* @param callable $aggregator Callable used to convert a deeply nested
* array of query string variables into a flattened array of key value
* pairs. The callable accepts an array of query data and returns a
* flattened array of key value pairs where each value is an array of
* strings.
*/
public function setAggregator(callable $aggregator)
{
}
/**
* Specify how values are URL encoded
*
* @param string|bool $type One of 'RFC1738', 'RFC3986', or false to disable encoding
*
* @throws \InvalidArgumentException
*/
public function setEncodingType($type)
{
}
/**
* Query string aggregator that does not aggregate nested query string
* values and allows duplicates in the resulting array.
*
* Example: http://test.com?q=1&q=2
*
* @return callable
*/
public static function duplicateAggregator()
{
}
/**
* Aggregates nested query string variables using the same technique as
* ``http_build_query()``.
*
* @param bool $numericIndices Pass false to not include numeric indices
* when multi-values query string parameters are present.
*
* @return callable
*/
public static function phpAggregator($numericIndices = true)
{
}
/**
* Easily create query aggregation functions by providing a key prefix
* function to this query string array walker.
*
* @param array $query Query string to walk
* @param string $keyPrefix Key prefix (start with '')
* @param callable $prefixer Function used to create a key prefix
*
* @return array
*/
public static function walkQuery(array $query, $keyPrefix, callable $prefixer)
{
}
}
}
namespace GuzzleHttp\Message {
/**
* Request and response message interface
*/
interface MessageInterface
{
/**
* Get a string representation of the message
*
* @return string
*/
public function __toString();
/**
* Get the HTTP protocol version of the message
*
* @return string
*/
public function getProtocolVersion();
/**
* Sets the body of the message.
*
* The body MUST be a StreamInterface object. Setting the body to null MUST
* remove the existing body.
*
* @param StreamInterface|null $body Body.
*/
public function setBody(\GuzzleHttp\Stream\StreamInterface $body = null);
/**
* Get the body of the message
*
* @return StreamInterface|null
*/
public function getBody();
/**
* Gets all message headers.
*
* The keys represent the header name as it will be sent over the wire, and
* each value is an array of strings associated with the header.
*
* // Represent the headers as a string
* foreach ($message->getHeaders() as $name => $values) {
* echo $name . ": " . implode(", ", $values);
* }
*
* @return array Returns an associative array of the message's headers.
*/
public function getHeaders();
/**
* Retrieve a header by the given case-insensitive name.
*
* @param string $header Case-insensitive header name.
*
* @return string
*/
public function getHeader($header);
/**
* Retrieves a header by the given case-insensitive name as an array of strings.
*
* @param string $header Case-insensitive header name.
*
* @return string[]
*/
public function getHeaderAsArray($header);
/**
* Checks if a header exists by the given case-insensitive name.
*
* @param string $header Case-insensitive header name.
*
* @return bool Returns true if any header names match the given header
* name using a case-insensitive string comparison. Returns false if
* no matching header name is found in the message.
*/
public function hasHeader($header);
/**
* Remove a specific header by case-insensitive name.
*
* @param string $header Case-insensitive header name.
*/
public function removeHeader($header);
/**
* Appends a header value to any existing values associated with the
* given header name.
*
* @param string $header Header name to add
* @param string $value Value of the header
*/
public function addHeader($header, $value);
/**
* Merges in an associative array of headers.
*
* Each array key MUST be a string representing the case-insensitive name
* of a header. Each value MUST be either a string or an array of strings.
* For each value, the value is appended to any existing header of the same
* name, or, if a header does not already exist by the given name, then the
* header is added.
*
* @param array $headers Associative array of headers to add to the message
*/
public function addHeaders(array $headers);
/**
* Sets a header, replacing any existing values of any headers with the
* same case-insensitive name.
*
* The header values MUST be a string or an array of strings.
*
* @param string $header Header name
* @param string|array $value Header value(s)
*/
public function setHeader($header, $value);
/**
* Sets headers, replacing any headers that have already been set on the
* message.
*
* The array keys MUST be a string. The array values must be either a
* string or an array of strings.
*
* @param array $headers Headers to set.
*/
public function setHeaders(array $headers);
}
/**
* Represents an HTTP response message.
*/
interface ResponseInterface extends \GuzzleHttp\Message\MessageInterface
{
/**
* Gets the response Status-Code.
*
* The Status-Code is a 3-digit integer result code of the server's attempt
* to understand and satisfy the request.
*
* @return int Status code.
*/
public function getStatusCode();
/**
* Sets the status code of this response.
*
* @param int $code The 3-digit integer result code to set.
*/
public function setStatusCode($code);
/**
* Gets the response Reason-Phrase, a short textual description of the
* Status-Code.
*
* Because a Reason-Phrase is not a required element in response
* Status-Line, the Reason-Phrase value MAY be null. Implementations MAY
* choose to return the default RFC 2616 recommended reason phrase for the
* response's Status-Code.
*
* @return string|null Reason phrase, or null if unknown.
*/
public function getReasonPhrase();
/**
* Sets the Reason-Phrase of the response.
*
* If no Reason-Phrase is specified, implementations MAY choose to default
* to the RFC 2616 recommended reason phrase for the response's Status-Code.
*
* @param string $phrase The Reason-Phrase to set.
*/
public function setReasonPhrase($phrase);
/**
* Get the effective URL that resulted in this response (e.g. the last
* redirect URL).
*
* @return string
*/
public function getEffectiveUrl();
/**
* Set the effective URL that resulted in this response (e.g. the last
* redirect URL).
*
* @param string $url Effective URL
*/
public function setEffectiveUrl($url);
/**
* Parse the JSON response body and return the JSON decoded data.
*
* @param array $config Associative array of configuration settings used
* to control how the JSON data is parsed. Concrete implementations MAY
* add further configuration settings as needed, but they MUST implement
* functionality for the following options:
*
* - object: Set to true to parse JSON objects as PHP objects rather
* than associative arrays. Defaults to false.
* - big_int_strings: When set to true, large integers are converted to
* strings rather than floats. Defaults to false.
*
* Implementations are free to add further configuration settings as
* needed.
*
* @return mixed Returns the JSON decoded data based on the provided
* parse settings.
* @throws \RuntimeException if the response body is not in JSON format
*/
public function json(array $config = []);
/**
* Parse the XML response body and return a \SimpleXMLElement.
*
* In order to prevent XXE attacks, this method disables loading external
* entities. If you rely on external entities, then you must parse the
* XML response manually by accessing the response body directly.
*
* @param array $config Associative array of configuration settings used
* to control how the XML is parsed. Concrete implementations MAY add
* further configuration settings as needed, but they MUST implement
* functionality for the following options:
*
* - ns: Set to a string to represent the namespace prefix or URI
* - ns_is_prefix: Set to true to specify that the NS is a prefix rather
* than a URI (defaults to false).
* - libxml_options: Bitwise OR of the libxml option constants
* listed at http://php.net/manual/en/libxml.constants.php
* (defaults to LIBXML_NONET)
*
* @return \SimpleXMLElement
* @throws \RuntimeException if the response body is not in XML format
* @link http://websec.io/2012/08/27/Preventing-XXE-in-PHP.html
*/
public function xml(array $config = []);
}
/**
* Represents a response that has not been fulfilled.
*
* When created, you must provide a function that is used to dereference the
* future result and return it's value. The function has no arguments and MUST
* return an instance of a {@see GuzzleHttp\Message\ResponseInterface} object.
*
* You can optionally provide a function in the constructor that can be used to
* cancel the future from completing if possible. This function has no
* arguments and returns a boolean value representing whether or not the
* response could be cancelled.
*
* @property ResponseInterface $_value
*/
class FutureResponse implements \GuzzleHttp\Message\ResponseInterface, \GuzzleHttp\Ring\Future\FutureInterface
{
use \GuzzleHttp\Ring\Future\MagicFutureTrait;
/**
* Returns a FutureResponse that wraps another future.
*
* @param FutureInterface $future Future to wrap with a new future
* @param callable $onFulfilled Invoked when the future fulfilled
* @param callable $onRejected Invoked when the future rejected
* @param callable $onProgress Invoked when the future progresses
*
* @return FutureResponse
*/
public static function proxy(\GuzzleHttp\Ring\Future\FutureInterface $future, callable $onFulfilled = null, callable $onRejected = null, callable $onProgress = null)
{
}
public function getStatusCode()
{
}
public function setStatusCode($code)
{
}
public function getReasonPhrase()
{
}
public function setReasonPhrase($phrase)
{
}
public function getEffectiveUrl()
{
}
public function setEffectiveUrl($url)
{
}
public function json(array $config = [])
{
}
public function xml(array $config = [])
{
}
public function __toString()
{
}
public function getProtocolVersion()
{
}
public function setBody(\GuzzleHttp\Stream\StreamInterface $body = null)
{
}
public function getBody()
{
}
public function getHeaders()
{
}
public function getHeader($header)
{
}
public function getHeaderAsArray($header)
{
}
public function hasHeader($header)
{
}
public function removeHeader($header)
{
}
public function addHeader($header, $value)
{
}
public function addHeaders(array $headers)
{
}
public function setHeader($header, $value)
{
}
public function setHeaders(array $headers)
{
}
}
/**
* Applies headers to a request.
*
* This interface can be used with Guzzle streams to apply body specific
* headers to a request during the PREPARE_REQUEST priority of the before event
*
* NOTE: a body that implements this interface will prevent a default
* content-type from being added to a request during the before event. If you
* want a default content-type to be added, then it will need to be done
* manually (e.g., using {@see GuzzleHttp\Mimetypes}).
*/
interface AppliesHeadersInterface
{
/**
* Apply headers to a request appropriate for the current state of the
* object.
*
* @param RequestInterface $request Request
*/
public function applyRequestHeaders(\GuzzleHttp\Message\RequestInterface $request);
}
/**
* Generic HTTP request interface
*/
interface RequestInterface extends \GuzzleHttp\Message\MessageInterface, \GuzzleHttp\Event\HasEmitterInterface
{
/**
* Sets the request URL.
*
* The URL MUST be a string, or an object that implements the
* `__toString()` method.
*
* @param string $url Request URL.
*
* @throws \InvalidArgumentException If the URL is invalid.
*/
public function setUrl($url);
/**
* Gets the request URL as a string.
*
* @return string Returns the URL as a string.
*/
public function getUrl();
/**
* Get the resource part of the the request, including the path, query
* string, and fragment.
*
* @return string
*/
public function getResource();
/**
* Get the collection of key value pairs that will be used as the query
* string in the request.
*
* @return Query
*/
public function getQuery();
/**
* Set the query string used by the request
*
* @param array|Query $query Query to set
*/
public function setQuery($query);
/**
* Get the HTTP method of the request.
*
* @return string
*/
public function getMethod();
/**
* Set the HTTP method of the request.
*
* @param string $method HTTP method
*/
public function setMethod($method);
/**
* Get the URI scheme of the request (http, https, etc.).
*
* @return string
*/
public function getScheme();
/**
* Set the URI scheme of the request (http, https, etc.).
*
* @param string $scheme Scheme to set
*/
public function setScheme($scheme);
/**
* Get the port scheme of the request (e.g., 80, 443, etc.).
*
* @return int
*/
public function getPort();
/**
* Set the port of the request.
*
* Setting a port modifies the Host header of a request as necessary.
*
* @param int $port Port to set
*/
public function setPort($port);
/**
* Get the host of the request.
*
* @return string
*/
public function getHost();
/**
* Set the host of the request including an optional port.
*
* Including a port in the host argument will explicitly change the port of
* the request. If no port is found, the default port of the current
* request scheme will be utilized.
*
* @param string $host Host to set (e.g. www.yahoo.com, www.yahoo.com:80)
*/
public function setHost($host);
/**
* Get the path of the request (e.g. '/', '/index.html').
*
* @return string
*/
public function getPath();
/**
* Set the path of the request (e.g. '/', '/index.html').
*
* @param string|array $path Path to set or array of segments to implode
*/
public function setPath($path);
/**
* Get the request's configuration options.
*
* @return \GuzzleHttp\Collection
*/
public function getConfig();
}
abstract class AbstractMessage implements \GuzzleHttp\Message\MessageInterface
{
public function __toString()
{
}
public function getProtocolVersion()
{
}
public function getBody()
{
}
public function setBody(\GuzzleHttp\Stream\StreamInterface $body = null)
{
}
public function addHeader($header, $value)
{
}
public function addHeaders(array $headers)
{
}
public function getHeader($header)
{
}
public function getHeaderAsArray($header)
{
}
public function getHeaders()
{
}
public function setHeader($header, $value)
{
}
public function setHeaders(array $headers)
{
}
public function hasHeader($header)
{
}
public function removeHeader($header)
{
}
/**
* Parse an array of header values containing ";" separated data into an
* array of associative arrays representing the header key value pair
* data of the header. When a parameter does not contain a value, but just
* contains a key, this function will inject a key with a '' string value.
*
* @param MessageInterface $message That contains the header
* @param string $header Header to retrieve from the message
*
* @return array Returns the parsed header values.
*/
public static function parseHeader(\GuzzleHttp\Message\MessageInterface $message, $header)
{
}
/**
* Converts an array of header values that may contain comma separated
* headers into an array of headers with no comma separated values.
*
* @param MessageInterface $message That contains the header
* @param string $header Header to retrieve from the message
*
* @return array Returns the normalized header field values.
*/
public static function normalizeHeader(\GuzzleHttp\Message\MessageInterface $message, $header)
{
}
/**
* Gets the start-line and headers of a message as a string
*
* @param MessageInterface $message
*
* @return string
*/
public static function getStartLineAndHeaders(\GuzzleHttp\Message\MessageInterface $message)
{
}
/**
* Gets the headers of a message as a string
*
* @param MessageInterface $message
*
* @return string
*/
public static function getHeadersAsString(\GuzzleHttp\Message\MessageInterface $message)
{
}
/**
* Gets the start line of a message
*
* @param MessageInterface $message
*
* @return string
* @throws \InvalidArgumentException
*/
public static function getStartLine(\GuzzleHttp\Message\MessageInterface $message)
{
}
/**
* Accepts and modifies the options provided to the message in the
* constructor.
*
* Can be overridden in subclasses as necessary.
*
* @param array $options Options array passed by reference.
*/
protected function handleOptions(array &$options)
{
}
}
/**
* HTTP request class to send requests
*/
class Request extends \GuzzleHttp\Message\AbstractMessage implements \GuzzleHttp\Message\RequestInterface
{
use \GuzzleHttp\Event\HasEmitterTrait;
/**
* @param string $method HTTP method
* @param string|Url $url HTTP URL to connect to. The URI scheme,
* host header, and URI are parsed from the full URL. If query string
* parameters are present they will be parsed as well.
* @param array|Collection $headers HTTP headers
* @param mixed $body Body to send with the request
* @param array $options Array of options to use with the request
* - emitter: Event emitter to use with the request
*/
public function __construct($method, $url, $headers = [], $body = null, array $options = [])
{
}
public function __clone()
{
}
public function setUrl($url)
{
}
public function getUrl()
{
}
public function setQuery($query)
{
}
public function getQuery()
{
}
public function setMethod($method)
{
}
public function getMethod()
{
}
public function getScheme()
{
}
public function setScheme($scheme)
{
}
public function getPort()
{
}
public function setPort($port)
{
}
public function getHost()
{
}
public function setHost($host)
{
}
public function getPath()
{
}
public function setPath($path)
{
}
public function getResource()
{
}
public function getConfig()
{
}
protected function handleOptions(array &$options)
{
}
}
/**
* Request and response parser used by Guzzle
*/
class MessageParser
{
/**
* Parse an HTTP request message into an associative array of parts.
*
* @param string $message HTTP request to parse
*
* @return array|bool Returns false if the message is invalid
*/
public function parseRequest($message)
{
}
/**
* Parse an HTTP response message into an associative array of parts.
*
* @param string $message HTTP response to parse
*
* @return array|bool Returns false if the message is invalid
*/
public function parseResponse($message)
{
}
}
/**
* Request and response factory
*/
interface MessageFactoryInterface
{
/**
* Creates a response
*
* @param string $statusCode HTTP status code
* @param array $headers Response headers
* @param mixed $body Response body
* @param array $options Response options
* - protocol_version: HTTP protocol version
* - header_factory: Factory used to create headers
* - And any other options used by a concrete message implementation
*
* @return ResponseInterface
*/
public function createResponse($statusCode, array $headers = [], $body = null, array $options = []);
/**
* Create a new request based on the HTTP method.
*
* This method accepts an associative array of request options. Below is a
* brief description of each parameter. See
* http://docs.guzzlephp.org/en/latest/clients.html#request-options for a much more
* in-depth description of each parameter.
*
* - headers: Associative array of headers to add to the request
* - body: string|resource|array|StreamInterface request body to send
* - json: mixed Uploads JSON encoded data using an application/json Content-Type header.
* - query: Associative array of query string values to add to the request
* - auth: array|string HTTP auth settings (user, pass[, type="basic"])
* - version: The HTTP protocol version to use with the request
* - cookies: true|false|CookieJarInterface To enable or disable cookies
* - allow_redirects: true|false|array Controls HTTP redirects
* - save_to: string|resource|StreamInterface Where the response is saved
* - events: Associative array of event names to callables or arrays
* - subscribers: Array of event subscribers to add to the request
* - exceptions: Specifies whether or not exceptions are thrown for HTTP protocol errors
* - timeout: Timeout of the request in seconds. Use 0 to wait indefinitely
* - connect_timeout: Number of seconds to wait while trying to connect. (0 to wait indefinitely)
* - verify: SSL validation. True/False or the path to a PEM file
* - cert: Path a SSL cert or array of (path, pwd)
* - ssl_key: Path to a private SSL key or array of (path, pwd)
* - proxy: Specify an HTTP proxy or hash of protocols to proxies
* - debug: Set to true or a resource to view handler specific debug info
* - stream: Set to true to stream a response body rather than download it all up front
* - expect: true/false/integer Controls the "Expect: 100-Continue" header
* - config: Associative array of request config collection options
* - decode_content: true/false/string to control decoding content-encoding responses
*
* @param string $method HTTP method (GET, POST, PUT, etc.)
* @param string|Url $url HTTP URL to connect to
* @param array $options Array of options to apply to the request
*
* @return RequestInterface
* @link http://docs.guzzlephp.org/en/latest/clients.html#request-options
*/
public function createRequest($method, $url, array $options = []);
}
/**
* Default HTTP request factory used to create Request and Response objects.
*/
class MessageFactory implements \GuzzleHttp\Message\MessageFactoryInterface
{
use \GuzzleHttp\Event\ListenerAttacherTrait;
/**
* @param array $customOptions Associative array of custom request option
* names mapping to functions used to apply
* the option. The function accepts the request
* and the option value to apply.
*/
public function __construct(array $customOptions = [])
{
}
public function createResponse($statusCode, array $headers = [], $body = null, array $options = [])
{
}
public function createRequest($method, $url, array $options = [])
{
}
/**
* Create a request or response object from an HTTP message string
*
* @param string $message Message to parse
*
* @return RequestInterface|ResponseInterface
* @throws \InvalidArgumentException if unable to parse a message
*/
public function fromMessage($message)
{
}
/**
* Apply POST fields and files to a request to attempt to give an accurate
* representation.
*
* @param RequestInterface $request Request to update
* @param array $body Body to apply
*/
protected function addPostData(\GuzzleHttp\Message\RequestInterface $request, array $body)
{
}
protected function applyOptions(\GuzzleHttp\Message\RequestInterface $request, array $options = [])
{
}
}
/**
* Guzzle HTTP response object
*/
class Response extends \GuzzleHttp\Message\AbstractMessage implements \GuzzleHttp\Message\ResponseInterface
{
/**
* @param int|string $statusCode The response status code (e.g. 200)
* @param array $headers The response headers
* @param StreamInterface $body The body of the response
* @param array $options Response message options
* - reason_phrase: Set a custom reason phrase
* - protocol_version: Set a custom protocol version
*/
public function __construct($statusCode, array $headers = [], \GuzzleHttp\Stream\StreamInterface $body = null, array $options = [])
{
}
public function getStatusCode()
{
}
public function setStatusCode($code)
{
}
public function getReasonPhrase()
{
}
public function setReasonPhrase($phrase)
{
}
public function json(array $config = [])
{
}
public function xml(array $config = [])
{
}
public function getEffectiveUrl()
{
}
public function setEffectiveUrl($url)
{
}
/**
* Accepts and modifies the options provided to the response in the
* constructor.
*
* @param array $options Options array passed by reference.
*/
protected function handleOptions(array &$options = [])
{
}
}
}
namespace GuzzleHttp {
/**
* Parses query strings into a Query object.
*
* While parsing, the parser will attempt to determine the most appropriate
* query string aggregator to use when serializing the parsed query string
* object back into a string. The hope is that parsing then serializing a
* query string should be a lossless operation.
*
* @internal Use Query::fromString()
*/
class QueryParser
{
/**
* Parse a query string into a Query object.
*
* @param Query $query Query object to populate
* @param string $str Query string to parse
* @param bool|string $urlEncoding How the query string is encoded
*/
public function parseInto(\GuzzleHttp\Query $query, $str, $urlEncoding = true)
{
}
}
/**
* Provides mappings of file extensions to mimetypes
* @link http://svn.apache.org/repos/asf/httpd/httpd/branches/1.3.x/conf/mime.types
*/
class Mimetypes
{
/** @var self */
protected static $instance;
/** @var array Mapping of extension to mimetype */
protected $mimetypes = array('3dml' => 'text/vnd.in3d.3dml', '3g2' => 'video/3gpp2', '3gp' => 'video/3gpp', '7z' => 'application/x-7z-compressed', 'aab' => 'application/x-authorware-bin', 'aac' => 'audio/x-aac', 'aam' => 'application/x-authorware-map', 'aas' => 'application/x-authorware-seg', 'abw' => 'application/x-abiword', 'ac' => 'application/pkix-attr-cert', 'acc' => 'application/vnd.americandynamics.acc', 'ace' => 'application/x-ace-compressed', 'acu' => 'application/vnd.acucobol', 'acutc' => 'application/vnd.acucorp', 'adp' => 'audio/adpcm', 'aep' => 'application/vnd.audiograph', 'afm' => 'application/x-font-type1', 'afp' => 'application/vnd.ibm.modcap', 'ahead' => 'application/vnd.ahead.space', 'ai' => 'application/postscript', 'aif' => 'audio/x-aiff', 'aifc' => 'audio/x-aiff', 'aiff' => 'audio/x-aiff', 'air' => 'application/vnd.adobe.air-application-installer-package+zip', 'ait' => 'application/vnd.dvb.ait', 'ami' => 'application/vnd.amiga.ami', 'apk' => 'application/vnd.android.package-archive', 'application' => 'application/x-ms-application', 'apr' => 'application/vnd.lotus-approach', 'asa' => 'text/plain', 'asax' => 'application/octet-stream', 'asc' => 'application/pgp-signature', 'ascx' => 'text/plain', 'asf' => 'video/x-ms-asf', 'ashx' => 'text/plain', 'asm' => 'text/x-asm', 'asmx' => 'text/plain', 'aso' => 'application/vnd.accpac.simply.aso', 'asp' => 'text/plain', 'aspx' => 'text/plain', 'asx' => 'video/x-ms-asf', 'atc' => 'application/vnd.acucorp', 'atom' => 'application/atom+xml', 'atomcat' => 'application/atomcat+xml', 'atomsvc' => 'application/atomsvc+xml', 'atx' => 'application/vnd.antix.game-component', 'au' => 'audio/basic', 'avi' => 'video/x-msvideo', 'aw' => 'application/applixware', 'axd' => 'text/plain', 'azf' => 'application/vnd.airzip.filesecure.azf', 'azs' => 'application/vnd.airzip.filesecure.azs', 'azw' => 'application/vnd.amazon.ebook', 'bat' => 'application/x-msdownload', 'bcpio' => 'application/x-bcpio', 'bdf' => 'application/x-font-bdf', 'bdm' => 'application/vnd.syncml.dm+wbxml', 'bed' => 'application/vnd.realvnc.bed', 'bh2' => 'application/vnd.fujitsu.oasysprs', 'bin' => 'application/octet-stream', 'bmi' => 'application/vnd.bmi', 'bmp' => 'image/bmp', 'book' => 'application/vnd.framemaker', 'box' => 'application/vnd.previewsystems.box', 'boz' => 'application/x-bzip2', 'bpk' => 'application/octet-stream', 'btif' => 'image/prs.btif', 'bz' => 'application/x-bzip', 'bz2' => 'application/x-bzip2', 'c' => 'text/x-c', 'c11amc' => 'application/vnd.cluetrust.cartomobile-config', 'c11amz' => 'application/vnd.cluetrust.cartomobile-config-pkg', 'c4d' => 'application/vnd.clonk.c4group', 'c4f' => 'application/vnd.clonk.c4group', 'c4g' => 'application/vnd.clonk.c4group', 'c4p' => 'application/vnd.clonk.c4group', 'c4u' => 'application/vnd.clonk.c4group', 'cab' => 'application/vnd.ms-cab-compressed', 'car' => 'application/vnd.curl.car', 'cat' => 'application/vnd.ms-pki.seccat', 'cc' => 'text/x-c', 'cct' => 'application/x-director', 'ccxml' => 'application/ccxml+xml', 'cdbcmsg' => 'application/vnd.contact.cmsg', 'cdf' => 'application/x-netcdf', 'cdkey' => 'application/vnd.mediastation.cdkey', 'cdmia' => 'application/cdmi-capability', 'cdmic' => 'application/cdmi-container', 'cdmid' => 'application/cdmi-domain', 'cdmio' => 'application/cdmi-object', 'cdmiq' => 'application/cdmi-queue', 'cdx' => 'chemical/x-cdx', 'cdxml' => 'application/vnd.chemdraw+xml', 'cdy' => 'application/vnd.cinderella', 'cer' => 'application/pkix-cert', 'cfc' => 'application/x-coldfusion', 'cfm' => 'application/x-coldfusion', 'cgm' => 'image/cgm', 'chat' => 'application/x-chat', 'chm' => 'application/vnd.ms-htmlhelp', 'chrt' => 'application/vnd.kde.kchart', 'cif' => 'chemical/x-cif', 'cii' => 'application/vnd.anser-web-certificate-issue-initiation', 'cil' => 'application/vnd.ms-artgalry', 'cla' => 'application/vnd.claymore', 'class' => 'application/java-vm', 'clkk' => 'application/vnd.crick.clicker.keyboard', 'clkp' => 'application/vnd.crick.clicker.palette', 'clkt' => 'application/vnd.crick.clicker.template', 'clkw' => 'application/vnd.crick.clicker.wordbank', 'clkx' => 'application/vnd.crick.clicker', 'clp' => 'application/x-msclip', 'cmc' => 'application/vnd.cosmocaller', 'cmdf' => 'chemical/x-cmdf', 'cml' => 'chemical/x-cml', 'cmp' => 'application/vnd.yellowriver-custom-menu', 'cmx' => 'image/x-cmx', 'cod' => 'application/vnd.rim.cod', 'com' => 'application/x-msdownload', 'conf' => 'text/plain', 'cpio' => 'application/x-cpio', 'cpp' => 'text/x-c', 'cpt' => 'application/mac-compactpro', 'crd' => 'application/x-mscardfile', 'crl' => 'application/pkix-crl', 'crt' => 'application/x-x509-ca-cert', 'cryptonote' => 'application/vnd.rig.cryptonote', 'cs' => 'text/plain', 'csh' => 'application/x-csh', 'csml' => 'chemical/x-csml', 'csp' => 'application/vnd.commonspace', 'css' => 'text/css', 'cst' => 'application/x-director', 'csv' => 'text/csv', 'cu' => 'application/cu-seeme', 'curl' => 'text/vnd.curl', 'cww' => 'application/prs.cww', 'cxt' => 'application/x-director', 'cxx' => 'text/x-c', 'dae' => 'model/vnd.collada+xml', 'daf' => 'application/vnd.mobius.daf', 'dataless' => 'application/vnd.fdsn.seed', 'davmount' => 'application/davmount+xml', 'dcr' => 'application/x-director', 'dcurl' => 'text/vnd.curl.dcurl', 'dd2' => 'application/vnd.oma.dd2+xml', 'ddd' => 'application/vnd.fujixerox.ddd', 'deb' => 'application/x-debian-package', 'def' => 'text/plain', 'deploy' => 'application/octet-stream', 'der' => 'application/x-x509-ca-cert', 'dfac' => 'application/vnd.dreamfactory', 'dic' => 'text/x-c', 'dir' => 'application/x-director', 'dis' => 'application/vnd.mobius.dis', 'dist' => 'application/octet-stream', 'distz' => 'application/octet-stream', 'djv' => 'image/vnd.djvu', 'djvu' => 'image/vnd.djvu', 'dll' => 'application/x-msdownload', 'dmg' => 'application/octet-stream', 'dms' => 'application/octet-stream', 'dna' => 'application/vnd.dna', 'doc' => 'application/msword', 'docm' => 'application/vnd.ms-word.document.macroenabled.12', 'docx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.document', 'dot' => 'application/msword', 'dotm' => 'application/vnd.ms-word.template.macroenabled.12', 'dotx' => 'application/vnd.openxmlformats-officedocument.wordprocessingml.template', 'dp' => 'application/vnd.osgi.dp', 'dpg' => 'application/vnd.dpgraph', 'dra' => 'audio/vnd.dra', 'dsc' => 'text/prs.lines.tag', 'dssc' => 'application/dssc+der', 'dtb' => 'application/x-dtbook+xml', 'dtd' => 'application/xml-dtd', 'dts' => 'audio/vnd.dts', 'dtshd' => 'audio/vnd.dts.hd', 'dump' => 'application/octet-stream', 'dvi' => 'application/x-dvi', 'dwf' => 'model/vnd.dwf', 'dwg' => 'image/vnd.dwg', 'dxf' => 'image/vnd.dxf', 'dxp' => 'application/vnd.spotfire.dxp', 'dxr' => 'application/x-director', 'ecelp4800' => 'audio/vnd.nuera.ecelp4800', 'ecelp7470' => 'audio/vnd.nuera.ecelp7470', 'ecelp9600' => 'audio/vnd.nuera.ecelp9600', 'ecma' => 'application/ecmascript', 'edm' => 'application/vnd.novadigm.edm', 'edx' => 'application/vnd.novadigm.edx', 'efif' => 'application/vnd.picsel', 'ei6' => 'application/vnd.pg.osasli', 'elc' => 'application/octet-stream', 'eml' => 'message/rfc822', 'emma' => 'application/emma+xml', 'eol' => 'audio/vnd.digital-winds', 'eot' => 'application/vnd.ms-fontobject', 'eps' => 'application/postscript', 'epub' => 'application/epub+zip', 'es3' => 'application/vnd.eszigno3+xml', 'esf' => 'application/vnd.epson.esf', 'et3' => 'application/vnd.eszigno3+xml', 'etx' => 'text/x-setext', 'exe' => 'application/x-msdownload', 'exi' => 'application/exi', 'ext' => 'application/vnd.novadigm.ext', 'ez' => 'application/andrew-inset', 'ez2' => 'application/vnd.ezpix-album', 'ez3' => 'application/vnd.ezpix-package', 'f' => 'text/x-fortran', 'f4v' => 'video/x-f4v', 'f77' => 'text/x-fortran', 'f90' => 'text/x-fortran', 'fbs' => 'image/vnd.fastbidsheet', 'fcs' => 'application/vnd.isac.fcs', 'fdf' => 'application/vnd.fdf', 'fe_launch' => 'application/vnd.denovo.fcselayout-link', 'fg5' => 'application/vnd.fujitsu.oasysgp', 'fgd' => 'application/x-director', 'fh' => 'image/x-freehand', 'fh4' => 'image/x-freehand', 'fh5' => 'image/x-freehand', 'fh7' => 'image/x-freehand', 'fhc' => 'image/x-freehand', 'fig' => 'application/x-xfig', 'fli' => 'video/x-fli', 'flo' => 'application/vnd.micrografx.flo', 'flv' => 'video/x-flv', 'flw' => 'application/vnd.kde.kivio', 'flx' => 'text/vnd.fmi.flexstor', 'fly' => 'text/vnd.fly', 'fm' => 'application/vnd.framemaker', 'fnc' => 'application/vnd.frogans.fnc', 'for' => 'text/x-fortran', 'fpx' => 'image/vnd.fpx', 'frame' => 'application/vnd.framemaker', 'fsc' => 'application/vnd.fsc.weblaunch', 'fst' => 'image/vnd.fst', 'ftc' => 'application/vnd.fluxtime.clip', 'fti' => 'application/vnd.anser-web-funds-transfer-initiation', 'fvt' => 'video/vnd.fvt', 'fxp' => 'application/vnd.adobe.fxp', 'fxpl' => 'application/vnd.adobe.fxp', 'fzs' => 'application/vnd.fuzzysheet', 'g2w' => 'application/vnd.geoplan', 'g3' => 'image/g3fax', 'g3w' => 'application/vnd.geospace', 'gac' => 'application/vnd.groove-account', 'gdl' => 'model/vnd.gdl', 'geo' => 'application/vnd.dynageo', 'gex' => 'application/vnd.geometry-explorer', 'ggb' => 'application/vnd.geogebra.file', 'ggt' => 'application/vnd.geogebra.tool', 'ghf' => 'application/vnd.groove-help', 'gif' => 'image/gif', 'gim' => 'application/vnd.groove-identity-message', 'gmx' => 'application/vnd.gmx', 'gnumeric' => 'application/x-gnumeric', 'gph' => 'application/vnd.flographit', 'gqf' => 'application/vnd.grafeq', 'gqs' => 'application/vnd.grafeq', 'gram' => 'application/srgs', 'gre' => 'application/vnd.geometry-explorer', 'grv' => 'application/vnd.groove-injector', 'grxml' => 'application/srgs+xml', 'gsf' => 'application/x-font-ghostscript', 'gtar' => 'application/x-gtar', 'gtm' => 'application/vnd.groove-tool-message', 'gtw' => 'model/vnd.gtw', 'gv' => 'text/vnd.graphviz', 'gxt' => 'application/vnd.geonext', 'h' => 'text/x-c', 'h261' => 'video/h261', 'h263' => 'video/h263', 'h264' => 'video/h264', 'hal' => 'application/vnd.hal+xml', 'hbci' => 'application/vnd.hbci', 'hdf' => 'application/x-hdf', 'hh' => 'text/x-c', 'hlp' => 'application/winhlp', 'hpgl' => 'application/vnd.hp-hpgl', 'hpid' => 'application/vnd.hp-hpid', 'hps' => 'application/vnd.hp-hps', 'hqx' => 'application/mac-binhex40', 'hta' => 'application/octet-stream', 'htc' => 'text/html', 'htke' => 'application/vnd.kenameaapp', 'htm' => 'text/html', 'html' => 'text/html', 'hvd' => 'application/vnd.yamaha.hv-dic', 'hvp' => 'application/vnd.yamaha.hv-voice', 'hvs' => 'application/vnd.yamaha.hv-script', 'i2g' => 'application/vnd.intergeo', 'icc' => 'application/vnd.iccprofile', 'ice' => 'x-conference/x-cooltalk', 'icm' => 'application/vnd.iccprofile', 'ico' => 'image/x-icon', 'ics' => 'text/calendar', 'ief' => 'image/ief', 'ifb' => 'text/calendar', 'ifm' => 'application/vnd.shana.informed.formdata', 'iges' => 'model/iges', 'igl' => 'application/vnd.igloader', 'igm' => 'application/vnd.insors.igm', 'igs' => 'model/iges', 'igx' => 'application/vnd.micrografx.igx', 'iif' => 'application/vnd.shana.informed.interchange', 'imp' => 'application/vnd.accpac.simply.imp', 'ims' => 'application/vnd.ms-ims', 'in' => 'text/plain', 'ini' => 'text/plain', 'ipfix' => 'application/ipfix', 'ipk' => 'application/vnd.shana.informed.package', 'irm' => 'application/vnd.ibm.rights-management', 'irp' => 'application/vnd.irepository.package+xml', 'iso' => 'application/octet-stream', 'itp' => 'application/vnd.shana.informed.formtemplate', 'ivp' => 'application/vnd.immervision-ivp', 'ivu' => 'application/vnd.immervision-ivu', 'jad' => 'text/vnd.sun.j2me.app-descriptor', 'jam' => 'application/vnd.jam', 'jar' => 'application/java-archive', 'java' => 'text/x-java-source', 'jisp' => 'application/vnd.jisp', 'jlt' => 'application/vnd.hp-jlyt', 'jnlp' => 'application/x-java-jnlp-file', 'joda' => 'application/vnd.joost.joda-archive', 'jpe' => 'image/jpeg', 'jpeg' => 'image/jpeg', 'jpg' => 'image/jpeg', 'jpgm' => 'video/jpm', 'jpgv' => 'video/jpeg', 'jpm' => 'video/jpm', 'js' => 'text/javascript', 'json' => 'application/json', 'kar' => 'audio/midi', 'karbon' => 'application/vnd.kde.karbon', 'kfo' => 'application/vnd.kde.kformula', 'kia' => 'application/vnd.kidspiration', 'kml' => 'application/vnd.google-earth.kml+xml', 'kmz' => 'application/vnd.google-earth.kmz', 'kne' => 'application/vnd.kinar', 'knp' => 'application/vnd.kinar', 'kon' => 'application/vnd.kde.kontour', 'kpr' => 'application/vnd.kde.kpresenter', 'kpt' => 'application/vnd.kde.kpresenter', 'ksp' => 'application/vnd.kde.kspread', 'ktr' => 'application/vnd.kahootz', 'ktx' => 'image/ktx', 'ktz' => 'application/vnd.kahootz', 'kwd' => 'application/vnd.kde.kword', 'kwt' => 'application/vnd.kde.kword', 'lasxml' => 'application/vnd.las.las+xml', 'latex' => 'application/x-latex', 'lbd' => 'application/vnd.llamagraphics.life-balance.desktop', 'lbe' => 'application/vnd.llamagraphics.life-balance.exchange+xml', 'les' => 'application/vnd.hhe.lesson-player', 'lha' => 'application/octet-stream', 'link66' => 'application/vnd.route66.link66+xml', 'list' => 'text/plain', 'list3820' => 'application/vnd.ibm.modcap', 'listafp' => 'application/vnd.ibm.modcap', 'log' => 'text/plain', 'lostxml' => 'application/lost+xml', 'lrf' => 'application/octet-stream', 'lrm' => 'application/vnd.ms-lrm', 'ltf' => 'application/vnd.frogans.ltf', 'lvp' => 'audio/vnd.lucent.voice', 'lwp' => 'application/vnd.lotus-wordpro', 'lzh' => 'application/octet-stream', 'm13' => 'application/x-msmediaview', 'm14' => 'application/x-msmediaview', 'm1v' => 'video/mpeg', 'm21' => 'application/mp21', 'm2a' => 'audio/mpeg', 'm2v' => 'video/mpeg', 'm3a' => 'audio/mpeg', 'm3u' => 'audio/x-mpegurl', 'm3u8' => 'application/vnd.apple.mpegurl', 'm4a' => 'audio/mp4', 'm4u' => 'video/vnd.mpegurl', 'm4v' => 'video/mp4', 'ma' => 'application/mathematica', 'mads' => 'application/mads+xml', 'mag' => 'application/vnd.ecowin.chart', 'maker' => 'application/vnd.framemaker', 'man' => 'text/troff', 'mathml' => 'application/mathml+xml', 'mb' => 'application/mathematica', 'mbk' => 'application/vnd.mobius.mbk', 'mbox' => 'application/mbox', 'mc1' => 'application/vnd.medcalcdata', 'mcd' => 'application/vnd.mcd', 'mcurl' => 'text/vnd.curl.mcurl', 'mdb' => 'application/x-msaccess', 'mdi' => 'image/vnd.ms-modi', 'me' => 'text/troff', 'mesh' => 'model/mesh', 'meta4' => 'application/metalink4+xml', 'mets' => 'application/mets+xml', 'mfm' => 'application/vnd.mfmp', 'mgp' => 'application/vnd.osgeo.mapguide.package', 'mgz' => 'application/vnd.proteus.magazine', 'mid' => 'audio/midi', 'midi' => 'audio/midi', 'mif' => 'application/vnd.mif', 'mime' => 'message/rfc822', 'mj2' => 'video/mj2', 'mjp2' => 'video/mj2', 'mlp' => 'application/vnd.dolby.mlp', 'mmd' => 'application/vnd.chipnuts.karaoke-mmd', 'mmf' => 'application/vnd.smaf', 'mmr' => 'image/vnd.fujixerox.edmics-mmr', 'mny' => 'application/x-msmoney', 'mobi' => 'application/x-mobipocket-ebook', 'mods' => 'application/mods+xml', 'mov' => 'video/quicktime', 'movie' => 'video/x-sgi-movie', 'mp2' => 'audio/mpeg', 'mp21' => 'application/mp21', 'mp2a' => 'audio/mpeg', 'mp3' => 'audio/mpeg', 'mp4' => 'video/mp4', 'mp4a' => 'audio/mp4', 'mp4s' => 'application/mp4', 'mp4v' => 'video/mp4', 'mpc' => 'application/vnd.mophun.certificate', 'mpe' => 'video/mpeg', 'mpeg' => 'video/mpeg', 'mpg' => 'video/mpeg', 'mpg4' => 'video/mp4', 'mpga' => 'audio/mpeg', 'mpkg' => 'application/vnd.apple.installer+xml', 'mpm' => 'application/vnd.blueice.multipass', 'mpn' => 'application/vnd.mophun.application', 'mpp' => 'application/vnd.ms-project', 'mpt' => 'application/vnd.ms-project', 'mpy' => 'application/vnd.ibm.minipay', 'mqy' => 'application/vnd.mobius.mqy', 'mrc' => 'application/marc', 'mrcx' => 'application/marcxml+xml', 'ms' => 'text/troff', 'mscml' => 'application/mediaservercontrol+xml', 'mseed' => 'application/vnd.fdsn.mseed', 'mseq' => 'application/vnd.mseq', 'msf' => 'application/vnd.epson.msf', 'msh' => 'model/mesh', 'msi' => 'application/x-msdownload', 'msl' => 'application/vnd.mobius.msl', 'msty' => 'application/vnd.muvee.style', 'mts' => 'model/vnd.mts', 'mus' => 'application/vnd.musician', 'musicxml' => 'application/vnd.recordare.musicxml+xml', 'mvb' => 'application/x-msmediaview', 'mwf' => 'application/vnd.mfer', 'mxf' => 'application/mxf', 'mxl' => 'application/vnd.recordare.musicxml', 'mxml' => 'application/xv+xml', 'mxs' => 'application/vnd.triscape.mxs', 'mxu' => 'video/vnd.mpegurl', 'n-gage' => 'application/vnd.nokia.n-gage.symbian.install', 'n3' => 'text/n3', 'nb' => 'application/mathematica', 'nbp' => 'application/vnd.wolfram.player', 'nc' => 'application/x-netcdf', 'ncx' => 'application/x-dtbncx+xml', 'ngdat' => 'application/vnd.nokia.n-gage.data', 'nlu' => 'application/vnd.neurolanguage.nlu', 'nml' => 'application/vnd.enliven', 'nnd' => 'application/vnd.noblenet-directory', 'nns' => 'application/vnd.noblenet-sealer', 'nnw' => 'application/vnd.noblenet-web', 'npx' => 'image/vnd.net-fpx', 'nsf' => 'application/vnd.lotus-notes', 'oa2' => 'application/vnd.fujitsu.oasys2', 'oa3' => 'application/vnd.fujitsu.oasys3', 'oas' => 'application/vnd.fujitsu.oasys', 'obd' => 'application/x-msbinder', 'oda' => 'application/oda', 'odb' => 'application/vnd.oasis.opendocument.database', 'odc' => 'application/vnd.oasis.opendocument.chart', 'odf' => 'application/vnd.oasis.opendocument.formula', 'odft' => 'application/vnd.oasis.opendocument.formula-template', 'odg' => 'application/vnd.oasis.opendocument.graphics', 'odi' => 'application/vnd.oasis.opendocument.image', 'odm' => 'application/vnd.oasis.opendocument.text-master', 'odp' => 'application/vnd.oasis.opendocument.presentation', 'ods' => 'application/vnd.oasis.opendocument.spreadsheet', 'odt' => 'application/vnd.oasis.opendocument.text', 'oga' => 'audio/ogg', 'ogg' => 'audio/ogg', 'ogv' => 'video/ogg', 'ogx' => 'application/ogg', 'onepkg' => 'application/onenote', 'onetmp' => 'application/onenote', 'onetoc' => 'application/onenote', 'onetoc2' => 'application/onenote', 'opf' => 'application/oebps-package+xml', 'oprc' => 'application/vnd.palm', 'org' => 'application/vnd.lotus-organizer', 'osf' => 'application/vnd.yamaha.openscoreformat', 'osfpvg' => 'application/vnd.yamaha.openscoreformat.osfpvg+xml', 'otc' => 'application/vnd.oasis.opendocument.chart-template', 'otf' => 'application/x-font-otf', 'otg' => 'application/vnd.oasis.opendocument.graphics-template', 'oth' => 'application/vnd.oasis.opendocument.text-web', 'oti' => 'application/vnd.oasis.opendocument.image-template', 'otp' => 'application/vnd.oasis.opendocument.presentation-template', 'ots' => 'application/vnd.oasis.opendocument.spreadsheet-template', 'ott' => 'application/vnd.oasis.opendocument.text-template', 'oxt' => 'application/vnd.openofficeorg.extension', 'p' => 'text/x-pascal', 'p10' => 'application/pkcs10', 'p12' => 'application/x-pkcs12', 'p7b' => 'application/x-pkcs7-certificates', 'p7c' => 'application/pkcs7-mime', 'p7m' => 'application/pkcs7-mime', 'p7r' => 'application/x-pkcs7-certreqresp', 'p7s' => 'application/pkcs7-signature', 'p8' => 'application/pkcs8', 'pas' => 'text/x-pascal', 'paw' => 'application/vnd.pawaafile', 'pbd' => 'application/vnd.powerbuilder6', 'pbm' => 'image/x-portable-bitmap', 'pcf' => 'application/x-font-pcf', 'pcl' => 'application/vnd.hp-pcl', 'pclxl' => 'application/vnd.hp-pclxl', 'pct' => 'image/x-pict', 'pcurl' => 'application/vnd.curl.pcurl', 'pcx' => 'image/x-pcx', 'pdb' => 'application/vnd.palm', 'pdf' => 'application/pdf', 'pfa' => 'application/x-font-type1', 'pfb' => 'application/x-font-type1', 'pfm' => 'application/x-font-type1', 'pfr' => 'application/font-tdpfr', 'pfx' => 'application/x-pkcs12', 'pgm' => 'image/x-portable-graymap', 'pgn' => 'application/x-chess-pgn', 'pgp' => 'application/pgp-encrypted', 'php' => 'text/x-php', 'phps' => 'application/x-httpd-phps', 'pic' => 'image/x-pict', 'pkg' => 'application/octet-stream', 'pki' => 'application/pkixcmp', 'pkipath' => 'application/pkix-pkipath', 'plb' => 'application/vnd.3gpp.pic-bw-large', 'plc' => 'application/vnd.mobius.plc', 'plf' => 'application/vnd.pocketlearn', 'pls' => 'application/pls+xml', 'pml' => 'application/vnd.ctc-posml', 'png' => 'image/png', 'pnm' => 'image/x-portable-anymap', 'portpkg' => 'application/vnd.macports.portpkg', 'pot' => 'application/vnd.ms-powerpoint', 'potm' => 'application/vnd.ms-powerpoint.template.macroenabled.12', 'potx' => 'application/vnd.openxmlformats-officedocument.presentationml.template', 'ppam' => 'application/vnd.ms-powerpoint.addin.macroenabled.12', 'ppd' => 'application/vnd.cups-ppd', 'ppm' => 'image/x-portable-pixmap', 'pps' => 'application/vnd.ms-powerpoint', 'ppsm' => 'application/vnd.ms-powerpoint.slideshow.macroenabled.12', 'ppsx' => 'application/vnd.openxmlformats-officedocument.presentationml.slideshow', 'ppt' => 'application/vnd.ms-powerpoint', 'pptm' => 'application/vnd.ms-powerpoint.presentation.macroenabled.12', 'pptx' => 'application/vnd.openxmlformats-officedocument.presentationml.presentation', 'pqa' => 'application/vnd.palm', 'prc' => 'application/x-mobipocket-ebook', 'pre' => 'application/vnd.lotus-freelance', 'prf' => 'application/pics-rules', 'ps' => 'application/postscript', 'psb' => 'application/vnd.3gpp.pic-bw-small', 'psd' => 'image/vnd.adobe.photoshop', 'psf' => 'application/x-font-linux-psf', 'pskcxml' => 'application/pskc+xml', 'ptid' => 'application/vnd.pvi.ptid1', 'pub' => 'application/x-mspublisher', 'pvb' => 'application/vnd.3gpp.pic-bw-var', 'pwn' => 'application/vnd.3m.post-it-notes', 'pya' => 'audio/vnd.ms-playready.media.pya', 'pyv' => 'video/vnd.ms-playready.media.pyv', 'qam' => 'application/vnd.epson.quickanime', 'qbo' => 'application/vnd.intu.qbo', 'qfx' => 'application/vnd.intu.qfx', 'qps' => 'application/vnd.publishare-delta-tree', 'qt' => 'video/quicktime', 'qwd' => 'application/vnd.quark.quarkxpress', 'qwt' => 'application/vnd.quark.quarkxpress', 'qxb' => 'application/vnd.quark.quarkxpress', 'qxd' => 'application/vnd.quark.quarkxpress', 'qxl' => 'application/vnd.quark.quarkxpress', 'qxt' => 'application/vnd.quark.quarkxpress', 'ra' => 'audio/x-pn-realaudio', 'ram' => 'audio/x-pn-realaudio', 'rar' => 'application/x-rar-compressed', 'ras' => 'image/x-cmu-raster', 'rb' => 'text/plain', 'rcprofile' => 'application/vnd.ipunplugged.rcprofile', 'rdf' => 'application/rdf+xml', 'rdz' => 'application/vnd.data-vision.rdz', 'rep' => 'application/vnd.businessobjects', 'res' => 'application/x-dtbresource+xml', 'resx' => 'text/xml', 'rgb' => 'image/x-rgb', 'rif' => 'application/reginfo+xml', 'rip' => 'audio/vnd.rip', 'rl' => 'application/resource-lists+xml', 'rlc' => 'image/vnd.fujixerox.edmics-rlc', 'rld' => 'application/resource-lists-diff+xml', 'rm' => 'application/vnd.rn-realmedia', 'rmi' => 'audio/midi', 'rmp' => 'audio/x-pn-realaudio-plugin', 'rms' => 'application/vnd.jcp.javame.midlet-rms', 'rnc' => 'application/relax-ng-compact-syntax', 'roff' => 'text/troff', 'rp9' => 'application/vnd.cloanto.rp9', 'rpss' => 'application/vnd.nokia.radio-presets', 'rpst' => 'application/vnd.nokia.radio-preset', 'rq' => 'application/sparql-query', 'rs' => 'application/rls-services+xml', 'rsd' => 'application/rsd+xml', 'rss' => 'application/rss+xml', 'rtf' => 'application/rtf', 'rtx' => 'text/richtext', 's' => 'text/x-asm', 'saf' => 'application/vnd.yamaha.smaf-audio', 'sbml' => 'application/sbml+xml', 'sc' => 'application/vnd.ibm.secure-container', 'scd' => 'application/x-msschedule', 'scm' => 'application/vnd.lotus-screencam', 'scq' => 'application/scvp-cv-request', 'scs' => 'application/scvp-cv-response', 'scurl' => 'text/vnd.curl.scurl', 'sda' => 'application/vnd.stardivision.draw', 'sdc' => 'application/vnd.stardivision.calc', 'sdd' => 'application/vnd.stardivision.impress', 'sdkd' => 'application/vnd.solent.sdkm+xml', 'sdkm' => 'application/vnd.solent.sdkm+xml', 'sdp' => 'application/sdp', 'sdw' => 'application/vnd.stardivision.writer', 'see' => 'application/vnd.seemail', 'seed' => 'application/vnd.fdsn.seed', 'sema' => 'application/vnd.sema', 'semd' => 'application/vnd.semd', 'semf' => 'application/vnd.semf', 'ser' => 'application/java-serialized-object', 'setpay' => 'application/set-payment-initiation', 'setreg' => 'application/set-registration-initiation', 'sfd-hdstx' => 'application/vnd.hydrostatix.sof-data', 'sfs' => 'application/vnd.spotfire.sfs', 'sgl' => 'application/vnd.stardivision.writer-global', 'sgm' => 'text/sgml', 'sgml' => 'text/sgml', 'sh' => 'application/x-sh', 'shar' => 'application/x-shar', 'shf' => 'application/shf+xml', 'sig' => 'application/pgp-signature', 'silo' => 'model/mesh', 'sis' => 'application/vnd.symbian.install', 'sisx' => 'application/vnd.symbian.install', 'sit' => 'application/x-stuffit', 'sitx' => 'application/x-stuffitx', 'skd' => 'application/vnd.koan', 'skm' => 'application/vnd.koan', 'skp' => 'application/vnd.koan', 'skt' => 'application/vnd.koan', 'sldm' => 'application/vnd.ms-powerpoint.slide.macroenabled.12', 'sldx' => 'application/vnd.openxmlformats-officedocument.presentationml.slide', 'slt' => 'application/vnd.epson.salt', 'sm' => 'application/vnd.stepmania.stepchart', 'smf' => 'application/vnd.stardivision.math', 'smi' => 'application/smil+xml', 'smil' => 'application/smil+xml', 'snd' => 'audio/basic', 'snf' => 'application/x-font-snf', 'so' => 'application/octet-stream', 'spc' => 'application/x-pkcs7-certificates', 'spf' => 'application/vnd.yamaha.smaf-phrase', 'spl' => 'application/x-futuresplash', 'spot' => 'text/vnd.in3d.spot', 'spp' => 'application/scvp-vp-response', 'spq' => 'application/scvp-vp-request', 'spx' => 'audio/ogg', 'src' => 'application/x-wais-source', 'sru' => 'application/sru+xml', 'srx' => 'application/sparql-results+xml', 'sse' => 'application/vnd.kodak-descriptor', 'ssf' => 'application/vnd.epson.ssf', 'ssml' => 'application/ssml+xml', 'st' => 'application/vnd.sailingtracker.track', 'stc' => 'application/vnd.sun.xml.calc.template', 'std' => 'application/vnd.sun.xml.draw.template', 'stf' => 'application/vnd.wt.stf', 'sti' => 'application/vnd.sun.xml.impress.template', 'stk' => 'application/hyperstudio', 'stl' => 'application/vnd.ms-pki.stl', 'str' => 'application/vnd.pg.format', 'stw' => 'application/vnd.sun.xml.writer.template', 'sub' => 'image/vnd.dvb.subtitle', 'sus' => 'application/vnd.sus-calendar', 'susp' => 'application/vnd.sus-calendar', 'sv4cpio' => 'application/x-sv4cpio', 'sv4crc' => 'application/x-sv4crc', 'svc' => 'application/vnd.dvb.service', 'svd' => 'application/vnd.svd', 'svg' => 'image/svg+xml', 'svgz' => 'image/svg+xml', 'swa' => 'application/x-director', 'swf' => 'application/x-shockwave-flash', 'swi' => 'application/vnd.aristanetworks.swi', 'sxc' => 'application/vnd.sun.xml.calc', 'sxd' => 'application/vnd.sun.xml.draw', 'sxg' => 'application/vnd.sun.xml.writer.global', 'sxi' => 'application/vnd.sun.xml.impress', 'sxm' => 'application/vnd.sun.xml.math', 'sxw' => 'application/vnd.sun.xml.writer', 't' => 'text/troff', 'tao' => 'application/vnd.tao.intent-module-archive', 'tar' => 'application/x-tar', 'tcap' => 'application/vnd.3gpp2.tcap', 'tcl' => 'application/x-tcl', 'teacher' => 'application/vnd.smart.teacher', 'tei' => 'application/tei+xml', 'teicorpus' => 'application/tei+xml', 'tex' => 'application/x-tex', 'texi' => 'application/x-texinfo', 'texinfo' => 'application/x-texinfo', 'text' => 'text/plain', 'tfi' => 'application/thraud+xml', 'tfm' => 'application/x-tex-tfm', 'thmx' => 'application/vnd.ms-officetheme', 'tif' => 'image/tiff', 'tiff' => 'image/tiff', 'tmo' => 'application/vnd.tmobile-livetv', 'torrent' => 'application/x-bittorrent', 'tpl' => 'application/vnd.groove-tool-template', 'tpt' => 'application/vnd.trid.tpt', 'tr' => 'text/troff', 'tra' => 'application/vnd.trueapp', 'trm' => 'application/x-msterminal', 'tsd' => 'application/timestamped-data', 'tsv' => 'text/tab-separated-values', 'ttc' => 'application/x-font-ttf', 'ttf' => 'application/x-font-ttf', 'ttl' => 'text/turtle', 'twd' => 'application/vnd.simtech-mindmapper', 'twds' => 'application/vnd.simtech-mindmapper', 'txd' => 'application/vnd.genomatix.tuxedo', 'txf' => 'application/vnd.mobius.txf', 'txt' => 'text/plain', 'u32' => 'application/x-authorware-bin', 'udeb' => 'application/x-debian-package', 'ufd' => 'application/vnd.ufdl', 'ufdl' => 'application/vnd.ufdl', 'umj' => 'application/vnd.umajin', 'unityweb' => 'application/vnd.unity', 'uoml' => 'application/vnd.uoml+xml', 'uri' => 'text/uri-list', 'uris' => 'text/uri-list', 'urls' => 'text/uri-list', 'ustar' => 'application/x-ustar', 'utz' => 'application/vnd.uiq.theme', 'uu' => 'text/x-uuencode', 'uva' => 'audio/vnd.dece.audio', 'uvd' => 'application/vnd.dece.data', 'uvf' => 'application/vnd.dece.data', 'uvg' => 'image/vnd.dece.graphic', 'uvh' => 'video/vnd.dece.hd', 'uvi' => 'image/vnd.dece.graphic', 'uvm' => 'video/vnd.dece.mobile', 'uvp' => 'video/vnd.dece.pd', 'uvs' => 'video/vnd.dece.sd', 'uvt' => 'application/vnd.dece.ttml+xml', 'uvu' => 'video/vnd.uvvu.mp4', 'uvv' => 'video/vnd.dece.video', 'uvva' => 'audio/vnd.dece.audio', 'uvvd' => 'application/vnd.dece.data', 'uvvf' => 'application/vnd.dece.data', 'uvvg' => 'image/vnd.dece.graphic', 'uvvh' => 'video/vnd.dece.hd', 'uvvi' => 'image/vnd.dece.graphic', 'uvvm' => 'video/vnd.dece.mobile', 'uvvp' => 'video/vnd.dece.pd', 'uvvs' => 'video/vnd.dece.sd', 'uvvt' => 'application/vnd.dece.ttml+xml', 'uvvu' => 'video/vnd.uvvu.mp4', 'uvvv' => 'video/vnd.dece.video', 'uvvx' => 'application/vnd.dece.unspecified', 'uvx' => 'application/vnd.dece.unspecified', 'vcd' => 'application/x-cdlink', 'vcf' => 'text/x-vcard', 'vcg' => 'application/vnd.groove-vcard', 'vcs' => 'text/x-vcalendar', 'vcx' => 'application/vnd.vcx', 'vis' => 'application/vnd.visionary', 'viv' => 'video/vnd.vivo', 'vor' => 'application/vnd.stardivision.writer', 'vox' => 'application/x-authorware-bin', 'vrml' => 'model/vrml', 'vsd' => 'application/vnd.visio', 'vsf' => 'application/vnd.vsf', 'vss' => 'application/vnd.visio', 'vst' => 'application/vnd.visio', 'vsw' => 'application/vnd.visio', 'vtu' => 'model/vnd.vtu', 'vxml' => 'application/voicexml+xml', 'w3d' => 'application/x-director', 'wad' => 'application/x-doom', 'wav' => 'audio/x-wav', 'wax' => 'audio/x-ms-wax', 'wbmp' => 'image/vnd.wap.wbmp', 'wbs' => 'application/vnd.criticaltools.wbs+xml', 'wbxml' => 'application/vnd.wap.wbxml', 'wcm' => 'application/vnd.ms-works', 'wdb' => 'application/vnd.ms-works', 'weba' => 'audio/webm', 'webm' => 'video/webm', 'webp' => 'image/webp', 'wg' => 'application/vnd.pmi.widget', 'wgt' => 'application/widget', 'wks' => 'application/vnd.ms-works', 'wm' => 'video/x-ms-wm', 'wma' => 'audio/x-ms-wma', 'wmd' => 'application/x-ms-wmd', 'wmf' => 'application/x-msmetafile', 'wml' => 'text/vnd.wap.wml', 'wmlc' => 'application/vnd.wap.wmlc', 'wmls' => 'text/vnd.wap.wmlscript', 'wmlsc' => 'application/vnd.wap.wmlscriptc', 'wmv' => 'video/x-ms-wmv', 'wmx' => 'video/x-ms-wmx', 'wmz' => 'application/x-ms-wmz', 'woff' => 'application/x-font-woff', 'wpd' => 'application/vnd.wordperfect', 'wpl' => 'application/vnd.ms-wpl', 'wps' => 'application/vnd.ms-works', 'wqd' => 'application/vnd.wqd', 'wri' => 'application/x-mswrite', 'wrl' => 'model/vrml', 'wsdl' => 'application/wsdl+xml', 'wspolicy' => 'application/wspolicy+xml', 'wtb' => 'application/vnd.webturbo', 'wvx' => 'video/x-ms-wvx', 'x32' => 'application/x-authorware-bin', 'x3d' => 'application/vnd.hzn-3d-crossword', 'xap' => 'application/x-silverlight-app', 'xar' => 'application/vnd.xara', 'xbap' => 'application/x-ms-xbap', 'xbd' => 'application/vnd.fujixerox.docuworks.binder', 'xbm' => 'image/x-xbitmap', 'xdf' => 'application/xcap-diff+xml', 'xdm' => 'application/vnd.syncml.dm+xml', 'xdp' => 'application/vnd.adobe.xdp+xml', 'xdssc' => 'application/dssc+xml', 'xdw' => 'application/vnd.fujixerox.docuworks', 'xenc' => 'application/xenc+xml', 'xer' => 'application/patch-ops-error+xml', 'xfdf' => 'application/vnd.adobe.xfdf', 'xfdl' => 'application/vnd.xfdl', 'xht' => 'application/xhtml+xml', 'xhtml' => 'application/xhtml+xml', 'xhvml' => 'application/xv+xml', 'xif' => 'image/vnd.xiff', 'xla' => 'application/vnd.ms-excel', 'xlam' => 'application/vnd.ms-excel.addin.macroenabled.12', 'xlc' => 'application/vnd.ms-excel', 'xlm' => 'application/vnd.ms-excel', 'xls' => 'application/vnd.ms-excel', 'xlsb' => 'application/vnd.ms-excel.sheet.binary.macroenabled.12', 'xlsm' => 'application/vnd.ms-excel.sheet.macroenabled.12', 'xlsx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.sheet', 'xlt' => 'application/vnd.ms-excel', 'xltm' => 'application/vnd.ms-excel.template.macroenabled.12', 'xltx' => 'application/vnd.openxmlformats-officedocument.spreadsheetml.template', 'xlw' => 'application/vnd.ms-excel', 'xml' => 'application/xml', 'xo' => 'application/vnd.olpc-sugar', 'xop' => 'application/xop+xml', 'xpi' => 'application/x-xpinstall', 'xpm' => 'image/x-xpixmap', 'xpr' => 'application/vnd.is-xpr', 'xps' => 'application/vnd.ms-xpsdocument', 'xpw' => 'application/vnd.intercon.formnet', 'xpx' => 'application/vnd.intercon.formnet', 'xsl' => 'application/xml', 'xslt' => 'application/xslt+xml', 'xsm' => 'application/vnd.syncml+xml', 'xspf' => 'application/xspf+xml', 'xul' => 'application/vnd.mozilla.xul+xml', 'xvm' => 'application/xv+xml', 'xvml' => 'application/xv+xml', 'xwd' => 'image/x-xwindowdump', 'xyz' => 'chemical/x-xyz', 'yaml' => 'text/yaml', 'yang' => 'application/yang', 'yin' => 'application/yin+xml', 'yml' => 'text/yaml', 'zaz' => 'application/vnd.zzazz.deck+xml', 'zip' => 'application/zip', 'zir' => 'application/vnd.zul', 'zirz' => 'application/vnd.zul', 'zmm' => 'application/vnd.handheld-entertainment+xml');
/**
* Get a singleton instance of the class
*
* @return self
* @codeCoverageIgnore
*/
public static function getInstance()
{
}
/**
* Get a mimetype value from a file extension
*
* @param string $extension File extension
*
* @return string|null
*
*/
public function fromExtension($extension)
{
}
/**
* Get a mimetype from a filename
*
* @param string $filename Filename to generate a mimetype from
*
* @return string|null
*/
public function fromFilename($filename)
{
}
}
/**
* Provides the bridge between Guzzle requests and responses and Guzzle Ring.
*/
class RingBridge
{
/**
* Creates a Ring request from a request object.
*
* This function does not hook up the "then" and "progress" events that
* would be required for actually sending a Guzzle request through a
* RingPHP handler.
*
* @param RequestInterface $request Request to convert.
*
* @return array Converted Guzzle Ring request.
*/
public static function createRingRequest(\GuzzleHttp\Message\RequestInterface $request)
{
}
/**
* Creates a Ring request from a request object AND prepares the callbacks.
*
* @param Transaction $trans Transaction to update.
*
* @return array Converted Guzzle Ring request.
*/
public static function prepareRingRequest(\GuzzleHttp\Transaction $trans)
{
}
/**
* Handles the process of processing a response received from a ring
* handler. The created response is added to the transaction, and the
* transaction stat is set appropriately.
*
* @param Transaction $trans Owns request and response.
* @param array $response Ring response array
* @param MessageFactoryInterface $messageFactory Creates response objects.
*/
public static function completeRingResponse(\GuzzleHttp\Transaction $trans, array $response, \GuzzleHttp\Message\MessageFactoryInterface $messageFactory)
{
}
/**
* Creates a Guzzle request object using a ring request array.
*
* @param array $request Ring request
*
* @return Request
* @throws \InvalidArgumentException for incomplete requests.
*/
public static function fromRingRequest(array $request)
{
}
/**
* Get an exception that can be used when a RingPHP handler does not
* populate a response.
*
* @param RequestInterface $request
*
* @return RequestException
*/
public static function getNoRingResponseException(\GuzzleHttp\Message\RequestInterface $request)
{
}
}
}
namespace GuzzleHttp\Post {
/**
* Post file upload interface
*/
interface PostFileInterface
{
/**
* Get the name of the form field
*
* @return string
*/
public function getName();
/**
* Get the full path to the file
*
* @return string
*/
public function getFilename();
/**
* Get the content
*
* @return StreamInterface
*/
public function getContent();
/**
* Gets all POST file headers.
*
* The keys represent the header name as it will be sent over the wire, and
* each value is a string.
*
* @return array Returns an associative array of the file's headers.
*/
public function getHeaders();
}
/**
* Post file upload
*/
class PostFile implements \GuzzleHttp\Post\PostFileInterface
{
/**
* @param string $name Name of the form field
* @param mixed $content Data to send
* @param string|null $filename Filename content-disposition attribute
* @param array $headers Array of headers to set on the file
* (can override any default headers)
* @throws \RuntimeException when filename is not passed or can't be determined
*/
public function __construct($name, $content, $filename = null, array $headers = [])
{
}
public function getName()
{
}
public function getFilename()
{
}
public function getContent()
{
}
public function getHeaders()
{
}
}
/**
* Represents a POST body that is sent as either a multipart/form-data stream
* or application/x-www-urlencoded stream.
*/
interface PostBodyInterface extends \GuzzleHttp\Stream\StreamInterface, \Countable, \GuzzleHttp\Message\AppliesHeadersInterface
{
/**
* Set a specific field
*
* @param string $name Name of the field to set
* @param string|array $value Value to set
*/
public function setField($name, $value);
/**
* Set the aggregation strategy that will be used to turn multi-valued
* fields into a string.
*
* The aggregation function accepts a deeply nested array of query string
* values and returns a flattened associative array of key value pairs.
*
* @param callable $aggregator
*/
public function setAggregator(callable $aggregator);
/**
* Set to true to force a multipart upload even if there are no files.
*
* @param bool $force Set to true to force multipart uploads or false to
* remove this flag.
*/
public function forceMultipartUpload($force);
/**
* Replace all existing form fields with an array of fields
*
* @param array $fields Associative array of fields to set
*/
public function replaceFields(array $fields);
/**
* Get a specific field by name
*
* @param string $name Name of the POST field to retrieve
*
* @return string|null
*/
public function getField($name);
/**
* Remove a field by name
*
* @param string $name Name of the field to remove
*/
public function removeField($name);
/**
* Returns an associative array of names to values or a query string.
*
* @param bool $asString Set to true to retrieve the fields as a query
* string.
*
* @return array|string
*/
public function getFields($asString = false);
/**
* Returns true if a field is set
*
* @param string $name Name of the field to set
*
* @return bool
*/
public function hasField($name);
/**
* Get all of the files
*
* @return array Returns an array of PostFileInterface objects
*/
public function getFiles();
/**
* Get a POST file by name.
*
* @param string $name Name of the POST file to retrieve
*
* @return PostFileInterface|null
*/
public function getFile($name);
/**
* Add a file to the POST
*
* @param PostFileInterface $file File to add
*/
public function addFile(\GuzzleHttp\Post\PostFileInterface $file);
/**
* Remove all files from the collection
*/
public function clearFiles();
}
/**
* Holds POST fields and files and creates a streaming body when read methods
* are called on the object.
*/
class PostBody implements \GuzzleHttp\Post\PostBodyInterface
{
/**
* Applies request headers to a request based on the POST state
*
* @param RequestInterface $request Request to update
*/
public function applyRequestHeaders(\GuzzleHttp\Message\RequestInterface $request)
{
}
public function forceMultipartUpload($force)
{
}
public function setAggregator(callable $aggregator)
{
}
public function setField($name, $value)
{
}
public function replaceFields(array $fields)
{
}
public function getField($name)
{
}
public function removeField($name)
{
}
public function getFields($asString = false)
{
}
public function hasField($name)
{
}
public function getFile($name)
{
}
public function getFiles()
{
}
public function addFile(\GuzzleHttp\Post\PostFileInterface $file)
{
}
public function clearFiles()
{
}
/**
* Returns the numbers of fields + files
*
* @return int
*/
public function count()
{
}
public function __toString()
{
}
public function getContents($maxLength = -1)
{
}
public function close()
{
}
public function detach()
{
}
public function attach($stream)
{
}
public function eof()
{
}
public function tell()
{
}
public function isSeekable()
{
}
public function isReadable()
{
}
public function isWritable()
{
}
public function getSize()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function read($length)
{
}
public function write($string)
{
}
public function getMetadata($key = null)
{
}
/**
* Get the aggregator used to join multi-valued field parameters
*
* @return callable
*/
protected final function getAggregator()
{
}
}
/**
* Stream that when read returns bytes for a streaming multipart/form-data body
*/
class MultipartBody implements \GuzzleHttp\Stream\StreamInterface
{
use \GuzzleHttp\Stream\StreamDecoratorTrait;
/**
* @param array $fields Associative array of field names to values where
* each value is a string or array of strings.
* @param array $files Associative array of PostFileInterface objects
* @param string $boundary You can optionally provide a specific boundary
* @throws \InvalidArgumentException
*/
public function __construct(array $fields = [], array $files = [], $boundary = null)
{
}
/**
* Get the boundary
*
* @return string
*/
public function getBoundary()
{
}
public function isWritable()
{
}
/**
* Create the aggregate stream that will be used to upload the POST data
*/
protected function createStream(array $fields, array $files)
{
}
}
}
namespace GuzzleHttp {
/**
* Represents the result of a batch operation. This result container is
* iterable, countable, and you can can get a result by value using the
* getResult function.
*
* Successful results are anything other than exceptions. Failure results are
* exceptions.
*
* @package GuzzleHttp
*/
class BatchResults implements \Countable, \IteratorAggregate, \ArrayAccess
{
/**
* @param \SplObjectStorage $hash Hash of key objects to result values.
*/
public function __construct(\SplObjectStorage $hash)
{
}
/**
* Get the keys that are available on the batch result.
*
* @return array
*/
public function getKeys()
{
}
/**
* Gets a result from the container for the given object. When getting
* results for a batch of requests, provide the request object.
*
* @param object $forObject Object to retrieve the result for.
*
* @return mixed|null
*/
public function getResult($forObject)
{
}
/**
* Get an array of successful results.
*
* @return array
*/
public function getSuccessful()
{
}
/**
* Get an array of failed results.
*
* @return array
*/
public function getFailures()
{
}
/**
* Allows iteration over all batch result values.
*
* @return \ArrayIterator
*/
public function getIterator()
{
}
/**
* Counts the number of elements in the batch result.
*
* @return int
*/
public function count()
{
}
/**
* Checks if the batch contains a specific numerical array index.
*
* @param int $key Index to access
*
* @return bool
*/
public function offsetExists($key)
{
}
/**
* Allows access of the batch using a numerical array index.
*
* @param int $key Index to access.
*
* @return mixed|null
*/
public function offsetGet($key)
{
}
public function offsetUnset($key)
{
}
public function offsetSet($key, $value)
{
}
}
}
namespace GuzzleHttp\Exception {
class TransferException extends \RuntimeException
{
}
/**
* Exception when a client is unable to parse the response body as XML or JSON
*/
class ParseException extends \GuzzleHttp\Exception\TransferException
{
public function __construct($message = '', \GuzzleHttp\Message\ResponseInterface $response = null, \Exception $previous = null)
{
}
/**
* Get the associated response
*
* @return ResponseInterface|null
*/
public function getResponse()
{
}
}
/**
* HTTP Request exception
*/
class RequestException extends \GuzzleHttp\Exception\TransferException
{
public function __construct($message, \GuzzleHttp\Message\RequestInterface $request, \GuzzleHttp\Message\ResponseInterface $response = null, \Exception $previous = null)
{
}
/**
* Wrap non-RequestExceptions with a RequestException
*
* @param RequestInterface $request
* @param \Exception $e
*
* @return RequestException
*/
public static function wrapException(\GuzzleHttp\Message\RequestInterface $request, \Exception $e)
{
}
/**
* Factory method to create a new exception with a normalized error message
*
* @param RequestInterface $request Request
* @param ResponseInterface $response Response received
* @param \Exception $previous Previous exception
*
* @return self
*/
public static function create(\GuzzleHttp\Message\RequestInterface $request, \GuzzleHttp\Message\ResponseInterface $response = null, \Exception $previous = null)
{
}
/**
* Get the request that caused the exception
*
* @return RequestInterface
*/
public function getRequest()
{
}
/**
* Get the associated response
*
* @return ResponseInterface|null
*/
public function getResponse()
{
}
/**
* Check if a response was received
*
* @return bool
*/
public function hasResponse()
{
}
}
class TooManyRedirectsException extends \GuzzleHttp\Exception\RequestException
{
}
class CouldNotRewindStreamException extends \GuzzleHttp\Exception\RequestException
{
}
/**
* Exception when an HTTP error occurs (4xx or 5xx error)
*/
class BadResponseException extends \GuzzleHttp\Exception\RequestException
{
}
/**
* Exception when a server error is encountered (5xx codes)
*/
class ServerException extends \GuzzleHttp\Exception\BadResponseException
{
}
class ConnectException extends \GuzzleHttp\Exception\RequestException
{
}
/**
* Exception when a client is unable to parse the response body as XML
*/
class XmlParseException extends \GuzzleHttp\Exception\ParseException
{
/** @var \LibXMLError */
protected $error;
public function __construct($message = '', \GuzzleHttp\Message\ResponseInterface $response = null, \Exception $previous = null, \LibXMLError $error = null)
{
}
/**
* Get the associated error
*
* @return \LibXMLError|null
*/
public function getError()
{
}
}
class StateException extends \GuzzleHttp\Exception\TransferException
{
}
/**
* Exception when a client error is encountered (4xx codes)
*/
class ClientException extends \GuzzleHttp\Exception\BadResponseException
{
}
}
namespace GuzzleHttp\Subscriber {
/**
* Throws exceptions when a 4xx or 5xx response is received
*/
class HttpError implements \GuzzleHttp\Event\SubscriberInterface
{
public function getEvents()
{
}
/**
* Throw a RequestException on an HTTP protocol error
*
* @param CompleteEvent $event Emitted event
* @throws RequestException
*/
public function onComplete(\GuzzleHttp\Event\CompleteEvent $event)
{
}
}
/**
* Subscriber used to implement HTTP redirects.
*
* **Request options**
*
* - redirect: Associative array containing the 'max', 'strict', and 'referer'
* keys.
*
* - max: Maximum number of redirects allowed per-request
* - strict: You can use strict redirects by setting this value to ``true``.
* Strict redirects adhere to strict RFC compliant redirection (e.g.,
* redirect POST with POST) vs doing what most clients do (e.g., redirect
* POST request with a GET request).
* - referer: Set to true to automatically add the "Referer" header when a
* redirect request is sent.
* - protocols: Array of allowed protocols. Defaults to 'http' and 'https'.
* When a redirect attempts to utilize a protocol that is not white listed,
* an exception is thrown.
*/
class Redirect implements \GuzzleHttp\Event\SubscriberInterface
{
public function getEvents()
{
}
/**
* Rewind the entity body of the request if needed
*
* @param RequestInterface $redirectRequest
* @throws CouldNotRewindStreamException
*/
public static function rewindEntityBody(\GuzzleHttp\Message\RequestInterface $redirectRequest)
{
}
/**
* Called when a request receives a redirect response
*
* @param CompleteEvent $event Event emitted
* @throws TooManyRedirectsException
*/
public function onComplete(\GuzzleHttp\Event\CompleteEvent $event)
{
}
}
/**
* Adds, extracts, and persists cookies between HTTP requests
*/
class Cookie implements \GuzzleHttp\Event\SubscriberInterface
{
/**
* @param CookieJarInterface $cookieJar Cookie jar used to hold cookies
*/
public function __construct(\GuzzleHttp\Cookie\CookieJarInterface $cookieJar = null)
{
}
public function getEvents()
{
}
/**
* Get the cookie cookieJar
*
* @return CookieJarInterface
*/
public function getCookieJar()
{
}
public function onBefore(\GuzzleHttp\Event\BeforeEvent $event)
{
}
public function onComplete(\GuzzleHttp\Event\CompleteEvent $event)
{
}
}
/**
* Queues mock responses or exceptions and delivers mock responses or
* exceptions in a fifo order.
*/
class Mock implements \GuzzleHttp\Event\SubscriberInterface, \Countable
{
/**
* @param array $items Array of responses or exceptions to queue
* @param bool $readBodies Set to false to not consume the entity body of
* a request when a mock is served.
*/
public function __construct(array $items = [], $readBodies = true)
{
}
public function getEvents()
{
}
/**
* @throws \OutOfBoundsException|\Exception
*/
public function onBefore(\GuzzleHttp\Event\BeforeEvent $event)
{
}
public function count()
{
}
/**
* Add a response to the end of the queue
*
* @param string|ResponseInterface $response Response or path to response file
*
* @return self
* @throws \InvalidArgumentException if a string or Response is not passed
*/
public function addResponse($response)
{
}
/**
* Add an exception to the end of the queue
*
* @param RequestException $e Exception to throw when the request is executed
*
* @return self
*/
public function addException(\GuzzleHttp\Exception\RequestException $e)
{
}
/**
* Add multiple items to the queue
*
* @param array $items Items to add
*/
public function addMultiple(array $items)
{
}
/**
* Clear the queue
*/
public function clearQueue()
{
}
}
/**
* Prepares requests with a body before sending
*
* **Request Options**
*
* - expect: Set to true to enable the "Expect: 100-Continue" header for a
* request that send a body. Set to false to disable "Expect: 100-Continue".
* Set to a number so that the size of the payload must be greater than the
* number in order to send the Expect header. Setting to a number will send
* the Expect header for all requests in which the size of the payload cannot
* be determined or where the body is not rewindable.
*/
class Prepare implements \GuzzleHttp\Event\SubscriberInterface
{
public function getEvents()
{
}
public function onBefore(\GuzzleHttp\Event\BeforeEvent $event)
{
}
}
/**
* Maintains a list of requests and responses sent using a request or client
*/
class History implements \GuzzleHttp\Event\SubscriberInterface, \IteratorAggregate, \Countable
{
public function __construct($limit = 10)
{
}
public function getEvents()
{
}
/**
* Convert to a string that contains all request and response headers
*
* @return string
*/
public function __toString()
{
}
public function onComplete(\GuzzleHttp\Event\CompleteEvent $event)
{
}
public function onError(\GuzzleHttp\Event\ErrorEvent $event)
{
}
/**
* Returns an Iterator that yields associative array values where each
* associative array contains the following key value pairs:
*
* - request: Representing the actual request that was received.
* - sent_request: A clone of the request that will not be mutated.
* - response: The response that was received (if available).
*
* @return \Iterator
*/
public function getIterator()
{
}
/**
* Get all of the requests sent through the plugin.
*
* Requests can be modified after they are logged by the history
* subscriber. By default this method will return the actual request
* instances that were received. Pass true to this method if you wish to
* get copies of the requests that represent the request state when it was
* initially logged by the history subscriber.
*
* @param bool $asSent Set to true to get clones of the requests that have
* not been mutated since the request was received by
* the history subscriber.
*
* @return RequestInterface[]
*/
public function getRequests($asSent = false)
{
}
/**
* Get the number of requests in the history
*
* @return int
*/
public function count()
{
}
/**
* Get the last request sent.
*
* Requests can be modified after they are logged by the history
* subscriber. By default this method will return the actual request
* instance that was received. Pass true to this method if you wish to get
* a copy of the request that represents the request state when it was
* initially logged by the history subscriber.
*
* @param bool $asSent Set to true to get a clone of the last request that
* has not been mutated since the request was received
* by the history subscriber.
*
* @return RequestInterface
*/
public function getLastRequest($asSent = false)
{
}
/**
* Get the last response in the history
*
* @return ResponseInterface|null
*/
public function getLastResponse()
{
}
/**
* Clears the history
*/
public function clear()
{
}
}
}
namespace PhpMyAdmin\SqlParser {
class Translator
{
/**
* Loads transator.
*/
public static function load()
{
}
/**
* Translates a string.
*
* @param string $msgid String to be translated
*
* @return string translated string (or original, if not found)
*/
public static function gettext($msgid)
{
}
}
/**
* A component (of a statement) is a part of a statement that is common to
* multiple query types.
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
abstract class Component
{
/**
* Parses the tokens contained in the given list in the context of the given
* parser.
*
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @throws \Exception not implemented yet
*
* @return mixed
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* Builds the string representation of a component of this type.
*
* In other words, this function represents the inverse function of
* `static::parse`.
*
* @param mixed $component the component to be built
* @param array $options parameters for building
*
* @throws \Exception not implemented yet
*
* @return string
*/
public static function build($component, array $options = array())
{
}
/**
* Builds the string representation of a component of this type.
*
* @see static::build
*
* @return string
*/
public function __toString()
{
}
}
/**
* Holds the configuration of the context that is currently used.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
abstract class Context
{
/**
* The maximum length of a keyword.
*
* @see static::$TOKEN_KEYWORD
*
* @var int
*/
const KEYWORD_MAX_LENGTH = 30;
/**
* The maximum length of a label.
*
* @see static::$TOKEN_LABEL
* Ref: https://dev.mysql.com/doc/refman/5.7/en/statement-labels.html
*
* @var int
*/
const LABEL_MAX_LENGTH = 16;
/**
* The maximum length of an operator.
*
* @see static::$TOKEN_OPERATOR
*
* @var int
*/
const OPERATOR_MAX_LENGTH = 4;
/**
* The name of the default content.
*
* @var string
*/
public static $defaultContext = '\\PhpMyAdmin\\SqlParser\\Contexts\\ContextMySql50700';
/**
* The name of the loaded context.
*
* @var string
*/
public static $loadedContext = '\\PhpMyAdmin\\SqlParser\\Contexts\\ContextMySql50700';
/**
* The prefix concatenated to the context name when an incomplete class name
* is specified.
*
* @var string
*/
public static $contextPrefix = '\\PhpMyAdmin\\SqlParser\\Contexts\\Context';
/**
* List of keywords.
*
* Because, PHP's associative arrays are basically hash tables, it is more
* efficient to store keywords as keys instead of values.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* Elements are sorted by flags, length and keyword.
*
* @var array
*/
public static $KEYWORDS = array();
/**
* List of operators and their flags.
*
* @var array
*/
public static $OPERATORS = array(
// Some operators (*, =) may have ambiguous flags, because they depend on
// the context they are being used in.
// For example: 1. SELECT * FROM table; # SQL specific (wildcard)
// SELECT 2 * 3; # arithmetic
// 2. SELECT * FROM table WHERE foo = 'bar';
// SET @i = 0;
// @see Token::FLAG_OPERATOR_ARITHMETIC
'%' => 1,
'*' => 1,
'+' => 1,
'-' => 1,
'/' => 1,
// @see Token::FLAG_OPERATOR_LOGICAL
'!' => 2,
'!=' => 2,
'&&' => 2,
'<' => 2,
'<=' => 2,
'<=>' => 2,
'<>' => 2,
'=' => 2,
'>' => 2,
'>=' => 2,
'||' => 2,
// @see Token::FLAG_OPERATOR_BITWISE
'&' => 4,
'<<' => 4,
'>>' => 4,
'^' => 4,
'|' => 4,
'~' => 4,
// @see Token::FLAG_OPERATOR_ASSIGNMENT
':=' => 8,
// @see Token::FLAG_OPERATOR_SQL
'(' => 16,
')' => 16,
'.' => 16,
',' => 16,
';' => 16,
);
/**
* The mode of the MySQL server that will be used in lexing, parsing and
* building the statements.
*
* @var int
*/
public static $MODE = 0;
/*
* Server SQL Modes
* https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html
*/
// Compatibility mode for Microsoft's SQL server.
// This is the equivalent of ANSI_QUOTES.
const SQL_MODE_COMPAT_MYSQL = 2;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_allow_invalid_dates
const SQL_MODE_ALLOW_INVALID_DATES = 1;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_ansi_quotes
const SQL_MODE_ANSI_QUOTES = 2;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_error_for_division_by_zero
const SQL_MODE_ERROR_FOR_DIVISION_BY_ZERO = 4;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_high_not_precedence
const SQL_MODE_HIGH_NOT_PRECEDENCE = 8;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_ignore_space
const SQL_MODE_IGNORE_SPACE = 16;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_auto_create_user
const SQL_MODE_NO_AUTO_CREATE_USER = 32;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_auto_value_on_zero
const SQL_MODE_NO_AUTO_VALUE_ON_ZERO = 64;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_backslash_escapes
const SQL_MODE_NO_BACKSLASH_ESCAPES = 128;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_dir_in_create
const SQL_MODE_NO_DIR_IN_CREATE = 256;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_dir_in_create
const SQL_MODE_NO_ENGINE_SUBSTITUTION = 512;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_field_options
const SQL_MODE_NO_FIELD_OPTIONS = 1024;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_key_options
const SQL_MODE_NO_KEY_OPTIONS = 2048;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_table_options
const SQL_MODE_NO_TABLE_OPTIONS = 4096;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_unsigned_subtraction
const SQL_MODE_NO_UNSIGNED_SUBTRACTION = 8192;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_zero_date
const SQL_MODE_NO_ZERO_DATE = 16384;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_no_zero_in_date
const SQL_MODE_NO_ZERO_IN_DATE = 32768;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_only_full_group_by
const SQL_MODE_ONLY_FULL_GROUP_BY = 65536;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_pipes_as_concat
const SQL_MODE_PIPES_AS_CONCAT = 131072;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_real_as_float
const SQL_MODE_REAL_AS_FLOAT = 262144;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_strict_all_tables
const SQL_MODE_STRICT_ALL_TABLES = 524288;
// https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sqlmode_strict_trans_tables
const SQL_MODE_STRICT_TRANS_TABLES = 1048576;
// Custom modes.
// The table and column names and any other field that must be escaped will
// not be.
// Reserved keywords are being escaped regardless this mode is used or not.
const SQL_MODE_NO_ENCLOSING_QUOTES = 1073741824;
/*
* Combination SQL Modes
* https://dev.mysql.com/doc/refman/5.0/en/sql-mode.html#sql-mode-combo
*/
// REAL_AS_FLOAT, PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE
const SQL_MODE_ANSI = 393234;
// PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, NO_KEY_OPTIONS,
// NO_TABLE_OPTIONS, NO_FIELD_OPTIONS,
const SQL_MODE_DB2 = 138258;
// PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, NO_KEY_OPTIONS,
// NO_TABLE_OPTIONS, NO_FIELD_OPTIONS, NO_AUTO_CREATE_USER
const SQL_MODE_MAXDB = 138290;
// PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, NO_KEY_OPTIONS,
// NO_TABLE_OPTIONS, NO_FIELD_OPTIONS
const SQL_MODE_MSSQL = 138258;
// PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, NO_KEY_OPTIONS,
// NO_TABLE_OPTIONS, NO_FIELD_OPTIONS, NO_AUTO_CREATE_USER
const SQL_MODE_ORACLE = 138290;
// PIPES_AS_CONCAT, ANSI_QUOTES, IGNORE_SPACE, NO_KEY_OPTIONS,
// NO_TABLE_OPTIONS, NO_FIELD_OPTIONS
const SQL_MODE_POSTGRESQL = 138258;
// STRICT_TRANS_TABLES, STRICT_ALL_TABLES, NO_ZERO_IN_DATE, NO_ZERO_DATE,
// ERROR_FOR_DIVISION_BY_ZERO, NO_AUTO_CREATE_USER
const SQL_MODE_TRADITIONAL = 1622052;
// -------------------------------------------------------------------------
// Keyword.
/**
* Checks if the given string is a keyword.
*
* @param string $str string to be checked
* @param bool $isReserved checks if the keyword is reserved
*
* @return int
*/
public static function isKeyword($str, $isReserved = false)
{
}
// -------------------------------------------------------------------------
// Operator.
/**
* Checks if the given string is an operator.
*
* @param string $str string to be checked
*
* @return int the appropriate flag for the operator
*/
public static function isOperator($str)
{
}
// -------------------------------------------------------------------------
// Whitespace.
/**
* Checks if the given character is a whitespace.
*
* @param string $str string to be checked
*
* @return bool
*/
public static function isWhitespace($str)
{
}
// -------------------------------------------------------------------------
// Comment.
/**
* Checks if the given string is the beginning of a whitespace.
*
* @param string $str string to be checked
* @param mixed $end
*
* @return int the appropriate flag for the comment type
*/
public static function isComment($str, $end = false)
{
}
// -------------------------------------------------------------------------
// Bool.
/**
* Checks if the given string is a boolean value.
* This actually check only for `TRUE` and `FALSE` because `1` or `0` are
* actually numbers and are parsed by specific methods.
*
* @param string $str string to be checked
*
* @return bool
*/
public static function isBool($str)
{
}
// -------------------------------------------------------------------------
// Number.
/**
* Checks if the given character can be a part of a number.
*
* @param string $str string to be checked
*
* @return bool
*/
public static function isNumber($str)
{
}
// -------------------------------------------------------------------------
// Symbol.
/**
* Checks if the given character is the beginning of a symbol. A symbol
* can be either a variable or a field name.
*
* @param string $str string to be checked
*
* @return int the appropriate flag for the symbol type
*/
public static function isSymbol($str)
{
}
// -------------------------------------------------------------------------
// String.
/**
* Checks if the given character is the beginning of a string.
*
* @param string $str string to be checked
*
* @return int the appropriate flag for the string type
*/
public static function isString($str)
{
}
// -------------------------------------------------------------------------
// Delimiter.
/**
* Checks if the given character can be a separator for two lexeme.
*
* @param string $str string to be checked
*
* @return bool
*/
public static function isSeparator($str)
{
}
/**
* Loads the specified context.
*
* Contexts may be used by accessing the context directly.
*
* @param string $context name of the context or full class name that
* defines the context
*
* @throws LoaderException if the specified context doesn't exist
*/
public static function load($context = '')
{
}
/**
* Loads the context with the closest version to the one specified.
*
* The closest context is found by replacing last digits with zero until one
* is loaded successfully.
*
* @see Context::load()
*
* @param string $context name of the context or full class name that
* defines the context
*
* @return string The loaded context. `null` if no context was loaded.
*/
public static function loadClosest($context = '')
{
}
/**
* Sets the SQL mode.
*
* @param string $mode The list of modes. If empty, the mode is reset.
*/
public static function setMode($mode = '')
{
}
/**
* Escapes the symbol by adding surrounding backticks.
*
* @param array|string $str the string to be escaped
* @param string $quote quote to be used when escaping
*
* @return string
*/
public static function escape($str, $quote = '`')
{
}
}
}
namespace PhpMyAdmin\SqlParser\Contexts {
/**
* Context for MySQL 5.1.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextMySql50100 extends \PhpMyAdmin\SqlParser\Context
{
/**
* List of keywords.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* @var array
*/
public static $KEYWORDS = array('AT' => 1, 'DO' => 1, 'IO' => 1, 'NO' => 1, 'XA' => 1, 'ANY' => 1, 'BDB' => 1, 'CPU' => 1, 'END' => 1, 'IPC' => 1, 'NDB' => 1, 'NEW' => 1, 'ONE' => 1, 'ROW' => 1, 'BOOL' => 1, 'BYTE' => 1, 'CODE' => 1, 'CUBE' => 1, 'DATA' => 1, 'DISK' => 1, 'ENDS' => 1, 'FAST' => 1, 'FILE' => 1, 'FULL' => 1, 'GOTO' => 1, 'HASH' => 1, 'HELP' => 1, 'HOST' => 1, 'LAST' => 1, 'LESS' => 1, 'LIST' => 1, 'LOGS' => 1, 'MODE' => 1, 'NAME' => 1, 'NEXT' => 1, 'NONE' => 1, 'OPEN' => 1, 'PAGE' => 1, 'PORT' => 1, 'PREV' => 1, 'ROWS' => 1, 'SOME' => 1, 'STOP' => 1, 'THAN' => 1, 'TYPE' => 1, 'VIEW' => 1, 'WAIT' => 1, 'WORK' => 1, 'X509' => 1, 'AFTER' => 1, 'BEGIN' => 1, 'BLOCK' => 1, 'BTREE' => 1, 'CACHE' => 1, 'CHAIN' => 1, 'CLOSE' => 1, 'EVENT' => 1, 'EVERY' => 1, 'FIRST' => 1, 'FIXED' => 1, 'FLUSH' => 1, 'FOUND' => 1, 'HOSTS' => 1, 'LABEL' => 1, 'LEVEL' => 1, 'LOCAL' => 1, 'LOCKS' => 1, 'MERGE' => 1, 'MUTEX' => 1, 'NAMES' => 1, 'NCHAR' => 1, 'OWNER' => 1, 'PHASE' => 1, 'QUERY' => 1, 'QUICK' => 1, 'RAID0' => 1, 'RESET' => 1, 'RTREE' => 1, 'SHARE' => 1, 'SLAVE' => 1, 'START' => 1, 'SUPER' => 1, 'SWAPS' => 1, 'TYPES' => 1, 'UNTIL' => 1, 'VALUE' => 1, 'ACTION' => 1, 'BACKUP' => 1, 'BINLOG' => 1, 'CIPHER' => 1, 'CLIENT' => 1, 'COMMIT' => 1, 'ENABLE' => 1, 'ENGINE' => 1, 'ERRORS' => 1, 'ESCAPE' => 1, 'EVENTS' => 1, 'FAULTS' => 1, 'FIELDS' => 1, 'GLOBAL' => 1, 'GRANTS' => 1, 'IMPORT' => 1, 'INNODB' => 1, 'ISSUER' => 1, 'LEAVES' => 1, 'MASTER' => 1, 'MEDIUM' => 1, 'MEMORY' => 1, 'MODIFY' => 1, 'OFFSET' => 1, 'PARSER' => 1, 'PLUGIN' => 1, 'RELOAD' => 1, 'REMOVE' => 1, 'REPAIR' => 1, 'RESUME' => 1, 'ROLLUP' => 1, 'SERVER' => 1, 'SIGNED' => 1, 'SIMPLE' => 1, 'SOCKET' => 1, 'SONAME' => 1, 'SOUNDS' => 1, 'SOURCE' => 1, 'STARTS' => 1, 'STATUS' => 1, 'STRING' => 1, 'TABLES' => 1, 'AUTHORS' => 1, 'CHANGED' => 1, 'COLUMNS' => 1, 'COMMENT' => 1, 'COMPACT' => 1, 'CONTEXT' => 1, 'DEFINER' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DYNAMIC' => 1, 'ENGINES' => 1, 'EXECUTE' => 1, 'HANDLER' => 1, 'INDEXES' => 1, 'INSTALL' => 1, 'INVOKER' => 1, 'LOGFILE' => 1, 'MIGRATE' => 1, 'NO_WAIT' => 1, 'OPTIONS' => 1, 'PARTIAL' => 1, 'PLUGINS' => 1, 'PREPARE' => 1, 'PROFILE' => 1, 'REBUILD' => 1, 'RECOVER' => 1, 'RESTORE' => 1, 'RETURNS' => 1, 'ROUTINE' => 1, 'SESSION' => 1, 'STORAGE' => 1, 'STRIPED' => 1, 'SUBJECT' => 1, 'SUSPEND' => 1, 'UNICODE' => 1, 'UNKNOWN' => 1, 'UPGRADE' => 1, 'USE_FRM' => 1, 'VIRTUAL' => 1, 'WRAPPER' => 1, 'CASCADED' => 1, 'CHECKSUM' => 1, 'DATAFILE' => 1, 'DUMPFILE' => 1, 'EXTENDED' => 1, 'FUNCTION' => 1, 'INNOBASE' => 1, 'LANGUAGE' => 1, 'MAXVALUE' => 1, 'MAX_ROWS' => 1, 'MAX_SIZE' => 1, 'MIN_ROWS' => 1, 'NATIONAL' => 1, 'NVARCHAR' => 1, 'ONE_SHOT' => 1, 'PRESERVE' => 1, 'PROFILES' => 1, 'REDOFILE' => 1, 'ROLLBACK' => 1, 'SCHEDULE' => 1, 'SECURITY' => 1, 'SHUTDOWN' => 1, 'SNAPSHOT' => 1, 'SWITCHES' => 1, 'TRIGGERS' => 1, 'UNDOFILE' => 1, 'WARNINGS' => 1, 'AGGREGATE' => 1, 'ALGORITHM' => 1, 'COMMITTED' => 1, 'DIRECTORY' => 1, 'DUPLICATE' => 1, 'EXPANSION' => 1, 'IO_THREAD' => 1, 'ISOLATION' => 1, 'NODEGROUP' => 1, 'PACK_KEYS' => 1, 'PARTITION' => 1, 'RAID_TYPE' => 1, 'READ_ONLY' => 1, 'REDUNDANT' => 1, 'SAVEPOINT' => 1, 'SCHEDULER' => 1, 'SQL_CACHE' => 1, 'TEMPORARY' => 1, 'TEMPTABLE' => 1, 'UNDEFINED' => 1, 'UNINSTALL' => 1, 'VARIABLES' => 1, 'BERKELEYDB' => 1, 'COMPLETION' => 1, 'COMPRESSED' => 1, 'CONCURRENT' => 1, 'CONNECTION' => 1, 'CONSISTENT' => 1, 'DEALLOCATE' => 1, 'IDENTIFIED' => 1, 'MASTER_SSL' => 1, 'NDBCLUSTER' => 1, 'PARTITIONS' => 1, 'PERSISTENT' => 1, 'PRIVILEGES' => 1, 'REORGANISE' => 1, 'REORGANIZE' => 1, 'REPEATABLE' => 1, 'ROW_FORMAT' => 1, 'SQL_THREAD' => 1, 'TABLESPACE' => 1, 'EXTENT_SIZE' => 1, 'FRAC_SECOND' => 1, 'MASTER_HOST' => 1, 'MASTER_PORT' => 1, 'MASTER_USER' => 1, 'PROCESSLIST' => 1, 'RAID_CHUNKS' => 1, 'REPLICATION' => 1, 'SQL_TSI_DAY' => 1, 'TRANSACTION' => 1, 'UNCOMMITTED' => 1, 'CONTRIBUTORS' => 1, 'DES_KEY_FILE' => 1, 'INITIAL_SIZE' => 1, 'PARTITIONING' => 1, 'RELAY_THREAD' => 1, 'SERIALIZABLE' => 1, 'SQL_NO_CACHE' => 1, 'SQL_TSI_HOUR' => 1, 'SQL_TSI_WEEK' => 1, 'SQL_TSI_YEAR' => 1, 'SUBPARTITION' => 1, 'INSERT_METHOD' => 1, 'MASTER_SSL_CA' => 1, 'PAGE_CHECKSUM' => 1, 'RELAY_LOG_POS' => 1, 'SQL_TSI_MONTH' => 1, 'SUBPARTITIONS' => 1, 'TRANSACTIONAL' => 1, 'AUTO_INCREMENT' => 1, 'AVG_ROW_LENGTH' => 1, 'KEY_BLOCK_SIZE' => 1, 'MASTER_LOG_POS' => 1, 'MASTER_SSL_KEY' => 1, 'RAID_CHUNKSIZE' => 1, 'RELAY_LOG_FILE' => 1, 'SQL_TSI_MINUTE' => 1, 'SQL_TSI_SECOND' => 1, 'TABLE_CHECKSUM' => 1, 'USER_RESOURCES' => 1, 'AUTOEXTEND_SIZE' => 1, 'DELAY_KEY_WRITE' => 1, 'MASTER_LOG_FILE' => 1, 'MASTER_PASSWORD' => 1, 'MASTER_SSL_CERT' => 1, 'SQL_TSI_QUARTER' => 1, 'MASTER_SERVER_ID' => 1, 'REDO_BUFFER_SIZE' => 1, 'UNDO_BUFFER_SIZE' => 1, 'MASTER_SSL_CAPATH' => 1, 'MASTER_SSL_CIPHER' => 1, 'SQL_BUFFER_RESULT' => 1, 'SQL_TSI_FRAC_SECOND' => 1, 'MASTER_CONNECT_RETRY' => 1, 'MAX_QUERIES_PER_HOUR' => 1, 'MAX_UPDATES_PER_HOUR' => 1, 'MAX_USER_CONNECTIONS' => 1, 'MAX_CONNECTIONS_PER_HOUR' => 1, 'AS' => 3, 'BY' => 3, 'IS' => 3, 'ON' => 3, 'OR' => 3, 'TO' => 3, 'ADD' => 3, 'ALL' => 3, 'AND' => 3, 'ASC' => 3, 'DEC' => 3, 'DIV' => 3, 'FOR' => 3, 'NOT' => 3, 'OUT' => 3, 'SQL' => 3, 'SSL' => 3, 'USE' => 3, 'XOR' => 3, 'BOTH' => 3, 'CALL' => 3, 'CASE' => 3, 'DESC' => 3, 'DROP' => 3, 'DUAL' => 3, 'EACH' => 3, 'ELSE' => 3, 'EXIT' => 3, 'FROM' => 3, 'INT1' => 3, 'INT2' => 3, 'INT3' => 3, 'INT4' => 3, 'INT8' => 3, 'INTO' => 3, 'JOIN' => 3, 'KEYS' => 3, 'KILL' => 3, 'LIKE' => 3, 'LOAD' => 3, 'LOCK' => 3, 'LONG' => 3, 'LOOP' => 3, 'NULL' => 3, 'READ' => 3, 'SHOW' => 3, 'THEN' => 3, 'TRUE' => 3, 'UNDO' => 3, 'WHEN' => 3, 'WITH' => 3, 'ALTER' => 3, 'CHECK' => 3, 'CROSS' => 3, 'FALSE' => 3, 'FETCH' => 3, 'FORCE' => 3, 'GRANT' => 3, 'GROUP' => 3, 'INNER' => 3, 'INOUT' => 3, 'LEAVE' => 3, 'LIMIT' => 3, 'LINES' => 3, 'ORDER' => 3, 'OUTER' => 3, 'PURGE' => 3, 'RANGE' => 3, 'READS' => 3, 'RLIKE' => 3, 'TABLE' => 3, 'UNION' => 3, 'USAGE' => 3, 'USING' => 3, 'WHERE' => 3, 'WHILE' => 3, 'WRITE' => 3, 'BEFORE' => 3, 'CHANGE' => 3, 'COLUMN' => 3, 'CREATE' => 3, 'CURSOR' => 3, 'DELETE' => 3, 'ELSEIF' => 3, 'EXISTS' => 3, 'FLOAT4' => 3, 'FLOAT8' => 3, 'HAVING' => 3, 'IGNORE' => 3, 'INFILE' => 3, 'LINEAR' => 3, 'OPTION' => 3, 'REGEXP' => 3, 'RENAME' => 3, 'RETURN' => 3, 'REVOKE' => 3, 'SELECT' => 3, 'UNLOCK' => 3, 'UPDATE' => 3, 'ANALYZE' => 3, 'BETWEEN' => 3, 'CASCADE' => 3, 'COLLATE' => 3, 'DECLARE' => 3, 'DELAYED' => 3, 'ESCAPED' => 3, 'EXPLAIN' => 3, 'FOREIGN' => 3, 'ITERATE' => 3, 'LEADING' => 3, 'NATURAL' => 3, 'OUTFILE' => 3, 'PRIMARY' => 3, 'RELEASE' => 3, 'REQUIRE' => 3, 'SCHEMAS' => 3, 'TRIGGER' => 3, 'VARYING' => 3, 'CONTINUE' => 3, 'DAY_HOUR' => 3, 'DESCRIBE' => 3, 'DISTINCT' => 3, 'ENCLOSED' => 3, 'MODIFIES' => 3, 'OPTIMIZE' => 3, 'RESTRICT' => 3, 'SPECIFIC' => 3, 'SQLSTATE' => 3, 'STARTING' => 3, 'TRAILING' => 3, 'UNSIGNED' => 3, 'ZEROFILL' => 3, 'CONDITION' => 3, 'DATABASES' => 3, 'MIDDLEINT' => 3, 'PRECISION' => 3, 'PROCEDURE' => 3, 'SENSITIVE' => 3, 'SEPARATOR' => 3, 'ACCESSIBLE' => 3, 'ASENSITIVE' => 3, 'CONSTRAINT' => 3, 'DAY_MINUTE' => 3, 'DAY_SECOND' => 3, 'OPTIONALLY' => 3, 'READ_WRITE' => 3, 'REFERENCES' => 3, 'SQLWARNING' => 3, 'TERMINATED' => 3, 'YEAR_MONTH' => 3, 'DISTINCTROW' => 3, 'HOUR_MINUTE' => 3, 'HOUR_SECOND' => 3, 'INSENSITIVE' => 3, 'LOW_PRIORITY' => 3, 'SQLEXCEPTION' => 3, 'VARCHARACTER' => 3, 'DETERMINISTIC' => 3, 'HIGH_PRIORITY' => 3, 'MINUTE_SECOND' => 3, 'STRAIGHT_JOIN' => 3, 'SQL_BIG_RESULT' => 3, 'DAY_MICROSECOND' => 3, 'HOUR_MICROSECOND' => 3, 'SQL_SMALL_RESULT' => 3, 'MINUTE_MICROSECOND' => 3, 'NO_WRITE_TO_BINLOG' => 3, 'SECOND_MICROSECOND' => 3, 'SQL_CALC_FOUND_ROWS' => 3, 'MASTER_SSL_VERIFY_SERVER_CERT' => 3, 'GROUP BY' => 7, 'NOT NULL' => 7, 'ORDER BY' => 7, 'SET NULL' => 7, 'AND CHAIN' => 7, 'FULL JOIN' => 7, 'IF EXISTS' => 7, 'LEFT JOIN' => 7, 'LESS THAN' => 7, 'LOAD DATA' => 7, 'NO ACTION' => 7, 'ON DELETE' => 7, 'ON UPDATE' => 7, 'UNION ALL' => 7, 'CROSS JOIN' => 7, 'ESCAPED BY' => 7, 'FOR UPDATE' => 7, 'INNER JOIN' => 7, 'LINEAR KEY' => 7, 'NO RELEASE' => 7, 'OR REPLACE' => 7, 'RIGHT JOIN' => 7, 'ENCLOSED BY' => 7, 'LINEAR HASH' => 7, 'STARTING BY' => 7, 'AND NO CHAIN' => 7, 'FOR EACH ROW' => 7, 'NATURAL JOIN' => 7, 'PARTITION BY' => 7, 'SET PASSWORD' => 7, 'SQL SECURITY' => 7, 'CHARACTER SET' => 7, 'IF NOT EXISTS' => 7, 'TERMINATED BY' => 7, 'DATA DIRECTORY' => 7, 'UNION DISTINCT' => 7, 'DEFAULT CHARSET' => 7, 'DEFAULT COLLATE' => 7, 'FULL OUTER JOIN' => 7, 'INDEX DIRECTORY' => 7, 'LEFT OUTER JOIN' => 7, 'SUBPARTITION BY' => 7, 'GENERATED ALWAYS' => 7, 'RIGHT OUTER JOIN' => 7, 'NATURAL LEFT JOIN' => 7, 'START TRANSACTION' => 7, 'LOCK IN SHARE MODE' => 7, 'NATURAL RIGHT JOIN' => 7, 'SELECT TRANSACTION' => 7, 'DEFAULT CHARACTER SET' => 7, 'NATURAL LEFT OUTER JOIN' => 7, 'NATURAL RIGHT OUTER JOIN' => 7, 'WITH CONSISTENT SNAPSHOT' => 7, 'BIT' => 9, 'XML' => 9, 'ENUM' => 9, 'JSON' => 9, 'TEXT' => 9, 'ARRAY' => 9, 'SERIAL' => 9, 'BOOLEAN' => 9, 'DATETIME' => 9, 'GEOMETRY' => 9, 'MULTISET' => 9, 'MULTILINEPOINT' => 9, 'MULTILINEPOLYGON' => 9, 'INT' => 11, 'SET' => 11, 'BLOB' => 11, 'REAL' => 11, 'FLOAT' => 11, 'BIGINT' => 11, 'DOUBLE' => 11, 'DECIMAL' => 11, 'INTEGER' => 11, 'NUMERIC' => 11, 'TINYINT' => 11, 'VARCHAR' => 11, 'LONGBLOB' => 11, 'LONGTEXT' => 11, 'SMALLINT' => 11, 'TINYBLOB' => 11, 'TINYTEXT' => 11, 'CHARACTER' => 11, 'MEDIUMINT' => 11, 'VARBINARY' => 11, 'MEDIUMBLOB' => 11, 'MEDIUMTEXT' => 11, 'BINARY VARYING' => 15, 'KEY' => 19, 'INDEX' => 19, 'UNIQUE' => 19, 'SPATIAL' => 19, 'FULLTEXT' => 19, 'INDEX KEY' => 23, 'UNIQUE KEY' => 23, 'FOREIGN KEY' => 23, 'PRIMARY KEY' => 23, 'SPATIAL KEY' => 23, 'FULLTEXT KEY' => 23, 'UNIQUE INDEX' => 23, 'SPATIAL INDEX' => 23, 'FULLTEXT INDEX' => 23, 'X' => 33, 'Y' => 33, 'LN' => 33, 'PI' => 33, 'ABS' => 33, 'AVG' => 33, 'BIN' => 33, 'COS' => 33, 'COT' => 33, 'DAY' => 33, 'ELT' => 33, 'EXP' => 33, 'HEX' => 33, 'LOG' => 33, 'MAX' => 33, 'MD5' => 33, 'MID' => 33, 'MIN' => 33, 'NOW' => 33, 'OCT' => 33, 'ORD' => 33, 'POW' => 33, 'SHA' => 33, 'SIN' => 33, 'STD' => 33, 'SUM' => 33, 'TAN' => 33, 'ACOS' => 33, 'AREA' => 33, 'ASIN' => 33, 'ATAN' => 33, 'CAST' => 33, 'CEIL' => 33, 'CONV' => 33, 'HOUR' => 33, 'LOG2' => 33, 'LPAD' => 33, 'RAND' => 33, 'RPAD' => 33, 'SHA1' => 33, 'SIGN' => 33, 'SQRT' => 33, 'SRID' => 33, 'TRIM' => 33, 'USER' => 33, 'UUID' => 33, 'WEEK' => 33, 'ASCII' => 33, 'ASWKB' => 33, 'ASWKT' => 33, 'ATAN2' => 33, 'COUNT' => 33, 'CRC32' => 33, 'DECOD' => 33, 'FIELD' => 33, 'FLOOR' => 33, 'INSTR' => 33, 'LCASE' => 33, 'LEAST' => 33, 'LOG10' => 33, 'LOWER' => 33, 'LTRIM' => 33, 'MONTH' => 33, 'POWER' => 33, 'QUOTE' => 33, 'ROUND' => 33, 'RTRIM' => 33, 'SLEEP' => 33, 'SPACE' => 33, 'UCASE' => 33, 'UNHEX' => 33, 'UPPER' => 33, 'ASTEXT' => 33, 'BIT_OR' => 33, 'CONCAT' => 33, 'ENCODE' => 33, 'EQUALS' => 33, 'FORMAT' => 33, 'IFNULL' => 33, 'ISNULL' => 33, 'LENGTH' => 33, 'LOCATE' => 33, 'MINUTE' => 33, 'NULLIF' => 33, 'POINTN' => 33, 'SECOND' => 33, 'STDDEV' => 33, 'STRCMP' => 33, 'SUBSTR' => 33, 'WITHIN' => 33, 'ADDDATE' => 33, 'ADDTIME' => 33, 'AGAINST' => 33, 'BIT_AND' => 33, 'BIT_XOR' => 33, 'CEILING' => 33, 'CHARSET' => 33, 'CROSSES' => 33, 'CURDATE' => 33, 'CURTIME' => 33, 'DAYNAME' => 33, 'DEGREES' => 33, 'ENCRYPT' => 33, 'EXTRACT' => 33, 'GLENGTH' => 33, 'ISEMPTY' => 33, 'QUARTER' => 33, 'RADIANS' => 33, 'REVERSE' => 33, 'SOUNDEX' => 33, 'SUBDATE' => 33, 'SUBTIME' => 33, 'SYSDATE' => 33, 'TOUCHES' => 33, 'TO_DAYS' => 33, 'VAR_POP' => 33, 'VERSION' => 33, 'WEEKDAY' => 33, 'ASBINARY' => 33, 'CENTROID' => 33, 'COALESCE' => 33, 'COMPRESS' => 33, 'CONTAINS' => 33, 'DATEDIFF' => 33, 'DATE_ADD' => 33, 'DATE_SUB' => 33, 'DISJOINT' => 33, 'ENDPOINT' => 33, 'ENVELOPE' => 33, 'GET_LOCK' => 33, 'GREATEST' => 33, 'ISCLOSED' => 33, 'ISSIMPLE' => 33, 'MAKEDATE' => 33, 'MAKETIME' => 33, 'MAKE_SET' => 33, 'MBREQUAL' => 33, 'OVERLAPS' => 33, 'PASSWORD' => 33, 'POSITION' => 33, 'TIMEDIFF' => 33, 'TRUNCATE' => 33, 'VARIANCE' => 33, 'VAR_SAMP' => 33, 'YEARWEEK' => 33, 'BENCHMARK' => 33, 'BIT_COUNT' => 33, 'COLLATION' => 33, 'CONCAT_WS' => 33, 'DAYOFWEEK' => 33, 'DAYOFYEAR' => 33, 'DIMENSION' => 33, 'FROM_DAYS' => 33, 'GEOMETRYN' => 33, 'INET_ATON' => 33, 'INET_NTOA' => 33, 'LOAD_FILE' => 33, 'MBRWITHIN' => 33, 'MONTHNAME' => 33, 'NUMPOINTS' => 33, 'ROW_COUNT' => 33, 'SUBSTRING' => 33, 'UPDATEXML' => 33, 'BIT_LENGTH' => 33, 'CONVERT_TZ' => 33, 'DAYOFMONTH' => 33, 'EXPORT_SET' => 33, 'FOUND_ROWS' => 33, 'GET_FORMAT' => 33, 'INTERSECTS' => 33, 'MBRTOUCHES' => 33, 'MULTIPOINT' => 33, 'NAME_CONST' => 33, 'PERIOD_ADD' => 33, 'STARTPOINT' => 33, 'STDDEV_POP' => 33, 'UNCOMPRESS' => 33, 'UUID_SHORT' => 33, 'WEEKOFYEAR' => 33, 'AES_DECRYPT' => 33, 'AES_ENCRYPT' => 33, 'CHAR_LENGTH' => 33, 'DATE_FORMAT' => 33, 'DES_DECRYPT' => 33, 'DES_ENCRYPT' => 33, 'FIND_IN_SET' => 33, 'GEOMFROMWKB' => 33, 'LINEFROMWKB' => 33, 'MBRCONTAINS' => 33, 'MBRDISJOINT' => 33, 'MBROVERLAPS' => 33, 'MICROSECOND' => 33, 'PERIOD_DIFF' => 33, 'POLYFROMWKB' => 33, 'SEC_TO_TIME' => 33, 'STDDEV_SAMP' => 33, 'STR_TO_DATE' => 33, 'SYSTEM_USER' => 33, 'TIME_FORMAT' => 33, 'TIME_TO_SEC' => 33, 'COERCIBILITY' => 33, 'EXTERIORRING' => 33, 'EXTRACTVALUE' => 33, 'GEOMETRYTYPE' => 33, 'GEOMFROMTEXT' => 33, 'GROUP_CONCAT' => 33, 'IS_FREE_LOCK' => 33, 'IS_USED_LOCK' => 33, 'LINEFROMTEXT' => 33, 'MLINEFROMWKB' => 33, 'MPOLYFROMWKB' => 33, 'MULTIPOLYGON' => 33, 'OCTET_LENGTH' => 33, 'OLD_PASSWORD' => 33, 'POINTFROMWKB' => 33, 'POLYFROMTEXT' => 33, 'RELEASE_LOCK' => 33, 'SESSION_USER' => 33, 'TIMESTAMPADD' => 33, 'CONNECTION_ID' => 33, 'FROM_UNIXTIME' => 33, 'INTERIORRINGN' => 33, 'MBRINTERSECTS' => 33, 'MLINEFROMTEXT' => 33, 'MPOINTFROMWKB' => 33, 'MPOLYFROMTEXT' => 33, 'NUMGEOMETRIES' => 33, 'POINTFROMTEXT' => 33, 'TIMESTAMPDIFF' => 33, 'LAST_INSERT_ID' => 33, 'MPOINTFROMTEXT' => 33, 'POLYGONFROMWKB' => 33, 'UNIX_TIMESTAMP' => 33, 'GEOMCOLLFROMWKB' => 33, 'MASTER_POS_WAIT' => 33, 'POLYGONFROMTEXT' => 33, 'SUBSTRING_INDEX' => 33, 'CHARACTER_LENGTH' => 33, 'GEOMCOLLFROMTEXT' => 33, 'GEOMETRYFROMTEXT' => 33, 'NUMINTERIORRINGS' => 33, 'LINESTRINGFROMWKB' => 33, 'MULTIPOINTFROMWKB' => 33, 'MULTIPOINTFROMTEXT' => 33, 'MULTIPOLYGONFROMWKB' => 33, 'UNCOMPRESSED_LENGTH' => 33, 'MULTIPOLYGONFROMTEXT' => 33, 'MULTILINESTRINGFROMWKB' => 33, 'MULTILINESTRINGFROMTEXT' => 33, 'GEOMETRYCOLLECTIONFROMWKB' => 33, 'GEOMETRYCOLLECTIONFROMTEXT' => 33, 'IF' => 35, 'IN' => 35, 'MOD' => 35, 'LEFT' => 35, 'MATCH' => 35, 'RIGHT' => 35, 'INSERT' => 35, 'REPEAT' => 35, 'SCHEMA' => 35, 'VALUES' => 35, 'CONVERT' => 35, 'DEFAULT' => 35, 'REPLACE' => 35, 'DATABASE' => 35, 'UTC_DATE' => 35, 'UTC_TIME' => 35, 'LOCALTIME' => 35, 'CURRENT_DATE' => 35, 'CURRENT_TIME' => 35, 'CURRENT_USER' => 35, 'UTC_TIMESTAMP' => 35, 'LOCALTIMESTAMP' => 35, 'CURRENT_TIMESTAMP' => 35, 'NOT IN' => 39, 'DATE' => 41, 'TIME' => 41, 'YEAR' => 41, 'POINT' => 41, 'POLYGON' => 41, 'TIMESTAMP' => 41, 'LINESTRING' => 41, 'MULTILINESTRING' => 41, 'GEOMETRYCOLLECTION' => 41, 'CHAR' => 43, 'BINARY' => 43, 'INTERVAL' => 43);
}
/**
* Context for MariaDB 10.3.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextMariaDb100300 extends \PhpMyAdmin\SqlParser\Context
{
/**
* List of keywords.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* @var array
*/
public static $KEYWORDS = array('AT' => 1, 'DO' => 1, 'IO' => 1, 'NO' => 1, 'XA' => 1, 'ANY' => 1, 'CPU' => 1, 'END' => 1, 'IPC' => 1, 'NDB' => 1, 'NEW' => 1, 'ONE' => 1, 'ROW' => 1, 'XID' => 1, 'BOOL' => 1, 'BYTE' => 1, 'CODE' => 1, 'CUBE' => 1, 'DATA' => 1, 'DISK' => 1, 'ENDS' => 1, 'FAST' => 1, 'FILE' => 1, 'FULL' => 1, 'HASH' => 1, 'HELP' => 1, 'HOST' => 1, 'LAST' => 1, 'LESS' => 1, 'LIST' => 1, 'LOGS' => 1, 'MODE' => 1, 'NAME' => 1, 'NEXT' => 1, 'NONE' => 1, 'ONLY' => 1, 'OPEN' => 1, 'PAGE' => 1, 'PORT' => 1, 'PREV' => 1, 'SLOW' => 1, 'SOME' => 1, 'STOP' => 1, 'THAN' => 1, 'TYPE' => 1, 'VIEW' => 1, 'WAIT' => 1, 'WORK' => 1, 'X509' => 1, 'AFTER' => 1, 'BEGIN' => 1, 'BLOCK' => 1, 'BTREE' => 1, 'CACHE' => 1, 'CHAIN' => 1, 'CLOSE' => 1, 'ERROR' => 1, 'EVENT' => 1, 'EVERY' => 1, 'FIRST' => 1, 'FIXED' => 1, 'FLUSH' => 1, 'FOUND' => 1, 'HOSTS' => 1, 'LEVEL' => 1, 'LOCAL' => 1, 'LOCKS' => 1, 'MERGE' => 1, 'MUTEX' => 1, 'NAMES' => 1, 'NCHAR' => 1, 'NEVER' => 1, 'OWNER' => 1, 'PHASE' => 1, 'PROXY' => 1, 'QUERY' => 1, 'QUICK' => 1, 'RELAY' => 1, 'RESET' => 1, 'RTREE' => 1, 'SHARE' => 1, 'SLAVE' => 1, 'START' => 1, 'SUPER' => 1, 'SWAPS' => 1, 'TYPES' => 1, 'UNTIL' => 1, 'VALUE' => 1, 'ACTION' => 1, 'ALWAYS' => 1, 'BACKUP' => 1, 'BINLOG' => 1, 'CIPHER' => 1, 'CLIENT' => 1, 'COMMIT' => 1, 'ENABLE' => 1, 'ENGINE' => 1, 'ERRORS' => 1, 'ESCAPE' => 1, 'EVENTS' => 1, 'EXPIRE' => 1, 'EXPORT' => 1, 'FAULTS' => 1, 'FIELDS' => 1, 'FILTER' => 1, 'GLOBAL' => 1, 'GRANTS' => 1, 'IMPORT' => 1, 'ISSUER' => 1, 'LEAVES' => 1, 'MASTER' => 1, 'MEDIUM' => 1, 'MEMORY' => 1, 'MODIFY' => 1, 'NUMBER' => 1, 'OFFSET' => 1, 'PARSER' => 1, 'PLUGIN' => 1, 'RELOAD' => 1, 'REMOVE' => 1, 'REPAIR' => 1, 'RESUME' => 1, 'ROLLUP' => 1, 'SERVER' => 1, 'SIGNED' => 1, 'SIMPLE' => 1, 'SOCKET' => 1, 'SONAME' => 1, 'SOUNDS' => 1, 'SOURCE' => 1, 'STARTS' => 1, 'STATUS' => 1, 'STRING' => 1, 'TABLES' => 1, 'ACCOUNT' => 1, 'ANALYSE' => 1, 'CHANGED' => 1, 'CHANNEL' => 1, 'COLUMNS' => 1, 'COMMENT' => 1, 'COMPACT' => 1, 'CONTEXT' => 1, 'CURRENT' => 1, 'DEFINER' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DYNAMIC' => 1, 'ENGINES' => 1, 'EXECUTE' => 1, 'FOLLOWS' => 1, 'GENERAL' => 1, 'HANDLER' => 1, 'INDEXES' => 1, 'INSTALL' => 1, 'INVOKER' => 1, 'LOGFILE' => 1, 'MIGRATE' => 1, 'NO_WAIT' => 1, 'OPTIONS' => 1, 'PARTIAL' => 1, 'PLUGINS' => 1, 'PREPARE' => 1, 'PROFILE' => 1, 'REBUILD' => 1, 'RECOVER' => 1, 'RESTORE' => 1, 'RETURNS' => 1, 'ROUTINE' => 1, 'SESSION' => 1, 'STACKED' => 1, 'STORAGE' => 1, 'SUBJECT' => 1, 'SUSPEND' => 1, 'UNICODE' => 1, 'UNKNOWN' => 1, 'UPGRADE' => 1, 'USE_FRM' => 1, 'WITHOUT' => 1, 'WRAPPER' => 1, 'CASCADED' => 1, 'CHECKSUM' => 1, 'DATAFILE' => 1, 'DUMPFILE' => 1, 'EXCHANGE' => 1, 'EXTENDED' => 1, 'FUNCTION' => 1, 'LANGUAGE' => 1, 'MAX_ROWS' => 1, 'MAX_SIZE' => 1, 'MIN_ROWS' => 1, 'NATIONAL' => 1, 'NVARCHAR' => 1, 'PRECEDES' => 1, 'PRESERVE' => 1, 'PROFILES' => 1, 'REDOFILE' => 1, 'RELAYLOG' => 1, 'ROLLBACK' => 1, 'SCHEDULE' => 1, 'SECURITY' => 1, 'SEQUENCE' => 1, 'SHUTDOWN' => 1, 'SNAPSHOT' => 1, 'SWITCHES' => 1, 'TRIGGERS' => 1, 'UNDOFILE' => 1, 'WARNINGS' => 1, 'AGGREGATE' => 1, 'ALGORITHM' => 1, 'COMMITTED' => 1, 'DIRECTORY' => 1, 'DUPLICATE' => 1, 'EXPANSION' => 1, 'IO_THREAD' => 1, 'ISOLATION' => 1, 'NODEGROUP' => 1, 'PACK_KEYS' => 1, 'READ_ONLY' => 1, 'REDUNDANT' => 1, 'SAVEPOINT' => 1, 'SQL_CACHE' => 1, 'TEMPORARY' => 1, 'TEMPTABLE' => 1, 'UNDEFINED' => 1, 'UNINSTALL' => 1, 'VARIABLES' => 1, 'COMPLETION' => 1, 'COMPRESSED' => 1, 'CONCURRENT' => 1, 'CONNECTION' => 1, 'CONSISTENT' => 1, 'DEALLOCATE' => 1, 'IDENTIFIED' => 1, 'MASTER_SSL' => 1, 'NDBCLUSTER' => 1, 'PARTITIONS' => 1, 'PERSISTENT' => 1, 'PLUGIN_DIR' => 1, 'PRIVILEGES' => 1, 'REORGANIZE' => 1, 'REPEATABLE' => 1, 'ROW_FORMAT' => 1, 'SQL_THREAD' => 1, 'TABLESPACE' => 1, 'TABLE_NAME' => 1, 'VALIDATION' => 1, 'COLUMN_NAME' => 1, 'COMPRESSION' => 1, 'CURSOR_NAME' => 1, 'DIAGNOSTICS' => 1, 'EXTENT_SIZE' => 1, 'MASTER_HOST' => 1, 'MASTER_PORT' => 1, 'MASTER_USER' => 1, 'MYSQL_ERRNO' => 1, 'NONBLOCKING' => 1, 'PROCESSLIST' => 1, 'REPLICATION' => 1, 'SCHEMA_NAME' => 1, 'SQL_TSI_DAY' => 1, 'TRANSACTION' => 1, 'UNCOMMITTED' => 1, 'CATALOG_NAME' => 1, 'CLASS_ORIGIN' => 1, 'DEFAULT_AUTH' => 1, 'DES_KEY_FILE' => 1, 'INITIAL_SIZE' => 1, 'MASTER_DELAY' => 1, 'MESSAGE_TEXT' => 1, 'PARTITIONING' => 1, 'RELAY_THREAD' => 1, 'SERIALIZABLE' => 1, 'SQL_NO_CACHE' => 1, 'SQL_TSI_HOUR' => 1, 'SQL_TSI_WEEK' => 1, 'SQL_TSI_YEAR' => 1, 'SUBPARTITION' => 1, 'COLUMN_FORMAT' => 1, 'INSERT_METHOD' => 1, 'MASTER_SSL_CA' => 1, 'RELAY_LOG_POS' => 1, 'SQL_TSI_MONTH' => 1, 'SUBPARTITIONS' => 1, 'AUTO_INCREMENT' => 1, 'AVG_ROW_LENGTH' => 1, 'KEY_BLOCK_SIZE' => 1, 'MASTER_LOG_POS' => 1, 'MASTER_SSL_CRL' => 1, 'MASTER_SSL_KEY' => 1, 'RELAY_LOG_FILE' => 1, 'SQL_TSI_MINUTE' => 1, 'SQL_TSI_SECOND' => 1, 'TABLE_CHECKSUM' => 1, 'USER_RESOURCES' => 1, 'AUTOEXTEND_SIZE' => 1, 'CONSTRAINT_NAME' => 1, 'DELAY_KEY_WRITE' => 1, 'FILE_BLOCK_SIZE' => 1, 'MASTER_LOG_FILE' => 1, 'MASTER_PASSWORD' => 1, 'MASTER_SSL_CERT' => 1, 'PARSE_GCOL_EXPR' => 1, 'REPLICATE_DO_DB' => 1, 'SQL_AFTER_GTIDS' => 1, 'SQL_TSI_QUARTER' => 1, 'SUBCLASS_ORIGIN' => 1, 'MASTER_SERVER_ID' => 1, 'REDO_BUFFER_SIZE' => 1, 'SQL_BEFORE_GTIDS' => 1, 'STATS_PERSISTENT' => 1, 'UNDO_BUFFER_SIZE' => 1, 'CONSTRAINT_SCHEMA' => 1, 'GROUP_REPLICATION' => 1, 'IGNORE_SERVER_IDS' => 1, 'MASTER_SSL_CAPATH' => 1, 'MASTER_SSL_CIPHER' => 1, 'RETURNED_SQLSTATE' => 1, 'SQL_BUFFER_RESULT' => 1, 'STATS_AUTO_RECALC' => 1, 'CONSTRAINT_CATALOG' => 1, 'MASTER_RETRY_COUNT' => 1, 'MASTER_SSL_CRLPATH' => 1, 'MAX_STATEMENT_TIME' => 1, 'REPLICATE_DO_TABLE' => 1, 'SQL_AFTER_MTS_GAPS' => 1, 'STATS_SAMPLE_PAGES' => 1, 'REPLICATE_IGNORE_DB' => 1, 'MASTER_AUTO_POSITION' => 1, 'MASTER_CONNECT_RETRY' => 1, 'MAX_QUERIES_PER_HOUR' => 1, 'MAX_UPDATES_PER_HOUR' => 1, 'MAX_USER_CONNECTIONS' => 1, 'REPLICATE_REWRITE_DB' => 1, 'REPLICATE_IGNORE_TABLE' => 1, 'MASTER_HEARTBEAT_PERIOD' => 1, 'REPLICATE_WILD_DO_TABLE' => 1, 'MAX_CONNECTIONS_PER_HOUR' => 1, 'REPLICATE_WILD_IGNORE_TABLE' => 1, 'AS' => 3, 'BY' => 3, 'IS' => 3, 'ON' => 3, 'OR' => 3, 'TO' => 3, 'ADD' => 3, 'ALL' => 3, 'AND' => 3, 'ASC' => 3, 'DEC' => 3, 'DIV' => 3, 'FOR' => 3, 'GET' => 3, 'NOT' => 3, 'OUT' => 3, 'SQL' => 3, 'SSL' => 3, 'USE' => 3, 'XOR' => 3, 'BOTH' => 3, 'CALL' => 3, 'CASE' => 3, 'DESC' => 3, 'DROP' => 3, 'DUAL' => 3, 'EACH' => 3, 'ELSE' => 3, 'EXIT' => 3, 'FROM' => 3, 'INT1' => 3, 'INT2' => 3, 'INT3' => 3, 'INT4' => 3, 'INT8' => 3, 'INTO' => 3, 'JOIN' => 3, 'KEYS' => 3, 'KILL' => 3, 'LIKE' => 3, 'LOAD' => 3, 'LOCK' => 3, 'LONG' => 3, 'LOOP' => 3, 'NULL' => 3, 'READ' => 3, 'ROWS' => 3, 'SHOW' => 3, 'THEN' => 3, 'TRUE' => 3, 'UNDO' => 3, 'WHEN' => 3, 'WITH' => 3, 'ALTER' => 3, 'CHECK' => 3, 'CROSS' => 3, 'FALSE' => 3, 'FETCH' => 3, 'FORCE' => 3, 'GRANT' => 3, 'GROUP' => 3, 'INNER' => 3, 'INOUT' => 3, 'LEAVE' => 3, 'LIMIT' => 3, 'LINES' => 3, 'ORDER' => 3, 'OUTER' => 3, 'PURGE' => 3, 'RANGE' => 3, 'READS' => 3, 'RLIKE' => 3, 'TABLE' => 3, 'UNION' => 3, 'USAGE' => 3, 'USING' => 3, 'WHERE' => 3, 'WHILE' => 3, 'WRITE' => 3, 'BEFORE' => 3, 'CHANGE' => 3, 'COLUMN' => 3, 'CREATE' => 3, 'CURSOR' => 3, 'DELETE' => 3, 'ELSEIF' => 3, 'EXCEPT' => 3, 'EXISTS' => 3, 'FLOAT4' => 3, 'FLOAT8' => 3, 'HAVING' => 3, 'IGNORE' => 3, 'INFILE' => 3, 'LINEAR' => 3, 'OPTION' => 3, 'REGEXP' => 3, 'RENAME' => 3, 'RETURN' => 3, 'REVOKE' => 3, 'SELECT' => 3, 'SIGNAL' => 3, 'STORED' => 3, 'UNLOCK' => 3, 'UPDATE' => 3, 'ANALYZE' => 3, 'BETWEEN' => 3, 'CASCADE' => 3, 'COLLATE' => 3, 'DECLARE' => 3, 'DELAYED' => 3, 'ESCAPED' => 3, 'EXPLAIN' => 3, 'FOREIGN' => 3, 'ITERATE' => 3, 'LEADING' => 3, 'NATURAL' => 3, 'OUTFILE' => 3, 'PRIMARY' => 3, 'RELEASE' => 3, 'REQUIRE' => 3, 'SCHEMAS' => 3, 'TRIGGER' => 3, 'VARYING' => 3, 'VIRTUAL' => 3, 'CONTINUE' => 3, 'DAY_HOUR' => 3, 'DESCRIBE' => 3, 'DISTINCT' => 3, 'ENCLOSED' => 3, 'MAXVALUE' => 3, 'MODIFIES' => 3, 'OPTIMIZE' => 3, 'RESIGNAL' => 3, 'RESTRICT' => 3, 'SPECIFIC' => 3, 'SQLSTATE' => 3, 'STARTING' => 3, 'TRAILING' => 3, 'UNSIGNED' => 3, 'ZEROFILL' => 3, 'CONDITION' => 3, 'DATABASES' => 3, 'GENERATED' => 3, 'INTERSECT' => 3, 'MIDDLEINT' => 3, 'PARTITION' => 3, 'PRECISION' => 3, 'PROCEDURE' => 3, 'RECURSIVE' => 3, 'SENSITIVE' => 3, 'SEPARATOR' => 3, 'ACCESSIBLE' => 3, 'ASENSITIVE' => 3, 'CONSTRAINT' => 3, 'DAY_MINUTE' => 3, 'DAY_SECOND' => 3, 'OPTIONALLY' => 3, 'READ_WRITE' => 3, 'REFERENCES' => 3, 'SQLWARNING' => 3, 'TERMINATED' => 3, 'YEAR_MONTH' => 3, 'DISTINCTROW' => 3, 'HOUR_MINUTE' => 3, 'HOUR_SECOND' => 3, 'INSENSITIVE' => 3, 'MASTER_BIND' => 3, 'LOW_PRIORITY' => 3, 'SQLEXCEPTION' => 3, 'VARCHARACTER' => 3, 'DETERMINISTIC' => 3, 'HIGH_PRIORITY' => 3, 'MINUTE_SECOND' => 3, 'STRAIGHT_JOIN' => 3, 'IO_AFTER_GTIDS' => 3, 'SQL_BIG_RESULT' => 3, 'DAY_MICROSECOND' => 3, 'IO_BEFORE_GTIDS' => 3, 'OPTIMIZER_COSTS' => 3, 'HOUR_MICROSECOND' => 3, 'SQL_SMALL_RESULT' => 3, 'MINUTE_MICROSECOND' => 3, 'NO_WRITE_TO_BINLOG' => 3, 'SECOND_MICROSECOND' => 3, 'SQL_CALC_FOUND_ROWS' => 3, 'MASTER_SSL_VERIFY_SERVER_CERT' => 3, 'GROUP BY' => 7, 'NOT NULL' => 7, 'ORDER BY' => 7, 'SET NULL' => 7, 'AND CHAIN' => 7, 'FULL JOIN' => 7, 'IF EXISTS' => 7, 'LEFT JOIN' => 7, 'LESS THAN' => 7, 'LOAD DATA' => 7, 'NO ACTION' => 7, 'ON DELETE' => 7, 'ON UPDATE' => 7, 'UNION ALL' => 7, 'CROSS JOIN' => 7, 'ESCAPED BY' => 7, 'FOR UPDATE' => 7, 'INNER JOIN' => 7, 'LINEAR KEY' => 7, 'NO RELEASE' => 7, 'OR REPLACE' => 7, 'RIGHT JOIN' => 7, 'ENCLOSED BY' => 7, 'LINEAR HASH' => 7, 'STARTING BY' => 7, 'AND NO CHAIN' => 7, 'FOR EACH ROW' => 7, 'NATURAL JOIN' => 7, 'PARTITION BY' => 7, 'SET PASSWORD' => 7, 'SQL SECURITY' => 7, 'CHARACTER SET' => 7, 'IF NOT EXISTS' => 7, 'TERMINATED BY' => 7, 'DATA DIRECTORY' => 7, 'UNION DISTINCT' => 7, 'DEFAULT CHARSET' => 7, 'DEFAULT COLLATE' => 7, 'FULL OUTER JOIN' => 7, 'INDEX DIRECTORY' => 7, 'LEFT OUTER JOIN' => 7, 'SUBPARTITION BY' => 7, 'GENERATED ALWAYS' => 7, 'RIGHT OUTER JOIN' => 7, 'NATURAL LEFT JOIN' => 7, 'START TRANSACTION' => 7, 'LOCK IN SHARE MODE' => 7, 'NATURAL RIGHT JOIN' => 7, 'SELECT TRANSACTION' => 7, 'DEFAULT CHARACTER SET' => 7, 'NATURAL LEFT OUTER JOIN' => 7, 'NATURAL RIGHT OUTER JOIN' => 7, 'WITH CONSISTENT SNAPSHOT' => 7, 'BIT' => 9, 'XML' => 9, 'ENUM' => 9, 'JSON' => 9, 'TEXT' => 9, 'ARRAY' => 9, 'SERIAL' => 9, 'BOOLEAN' => 9, 'DATETIME' => 9, 'GEOMETRY' => 9, 'MULTISET' => 9, 'MULTILINEPOINT' => 9, 'MULTILINEPOLYGON' => 9, 'INT' => 11, 'SET' => 11, 'BLOB' => 11, 'REAL' => 11, 'FLOAT' => 11, 'BIGINT' => 11, 'DOUBLE' => 11, 'DECIMAL' => 11, 'INTEGER' => 11, 'NUMERIC' => 11, 'TINYINT' => 11, 'VARCHAR' => 11, 'LONGBLOB' => 11, 'LONGTEXT' => 11, 'SMALLINT' => 11, 'TINYBLOB' => 11, 'TINYTEXT' => 11, 'CHARACTER' => 11, 'MEDIUMINT' => 11, 'VARBINARY' => 11, 'MEDIUMBLOB' => 11, 'MEDIUMTEXT' => 11, 'BINARY VARYING' => 15, 'KEY' => 19, 'INDEX' => 19, 'UNIQUE' => 19, 'SPATIAL' => 19, 'FULLTEXT' => 19, 'INDEX KEY' => 23, 'UNIQUE KEY' => 23, 'FOREIGN KEY' => 23, 'PRIMARY KEY' => 23, 'SPATIAL KEY' => 23, 'FULLTEXT KEY' => 23, 'UNIQUE INDEX' => 23, 'SPATIAL INDEX' => 23, 'FULLTEXT INDEX' => 23, 'X' => 33, 'Y' => 33, 'LN' => 33, 'PI' => 33, 'ABS' => 33, 'AVG' => 33, 'BIN' => 33, 'COS' => 33, 'COT' => 33, 'DAY' => 33, 'ELT' => 33, 'EXP' => 33, 'HEX' => 33, 'LOG' => 33, 'MAX' => 33, 'MD5' => 33, 'MID' => 33, 'MIN' => 33, 'NOW' => 33, 'OCT' => 33, 'ORD' => 33, 'POW' => 33, 'SHA' => 33, 'SIN' => 33, 'STD' => 33, 'SUM' => 33, 'TAN' => 33, 'ACOS' => 33, 'AREA' => 33, 'ASIN' => 33, 'ATAN' => 33, 'CAST' => 33, 'CEIL' => 33, 'CONV' => 33, 'HOUR' => 33, 'LOG2' => 33, 'LPAD' => 33, 'RAND' => 33, 'RPAD' => 33, 'SHA1' => 33, 'SHA2' => 33, 'SIGN' => 33, 'SQRT' => 33, 'SRID' => 33, 'ST_X' => 33, 'ST_Y' => 33, 'TRIM' => 33, 'USER' => 33, 'UUID' => 33, 'WEEK' => 33, 'ASCII' => 33, 'ASWKB' => 33, 'ASWKT' => 33, 'ATAN2' => 33, 'COUNT' => 33, 'CRC32' => 33, 'FIELD' => 33, 'FLOOR' => 33, 'INSTR' => 33, 'LCASE' => 33, 'LEAST' => 33, 'LOG10' => 33, 'LOWER' => 33, 'LTRIM' => 33, 'MONTH' => 33, 'POWER' => 33, 'QUOTE' => 33, 'ROUND' => 33, 'RTRIM' => 33, 'SLEEP' => 33, 'SPACE' => 33, 'UCASE' => 33, 'UNHEX' => 33, 'UPPER' => 33, 'ASTEXT' => 33, 'BIT_OR' => 33, 'BUFFER' => 33, 'CONCAT' => 33, 'DECODE' => 33, 'ENCODE' => 33, 'EQUALS' => 33, 'FORMAT' => 33, 'IFNULL' => 33, 'ISNULL' => 33, 'LENGTH' => 33, 'LOCATE' => 33, 'MINUTE' => 33, 'NULLIF' => 33, 'POINTN' => 33, 'SECOND' => 33, 'STDDEV' => 33, 'STRCMP' => 33, 'SUBSTR' => 33, 'WITHIN' => 33, 'ADDDATE' => 33, 'ADDTIME' => 33, 'AGAINST' => 33, 'BIT_AND' => 33, 'BIT_XOR' => 33, 'CEILING' => 33, 'CHARSET' => 33, 'CROSSES' => 33, 'CURDATE' => 33, 'CURTIME' => 33, 'DAYNAME' => 33, 'DEGREES' => 33, 'ENCRYPT' => 33, 'EXTRACT' => 33, 'GLENGTH' => 33, 'ISEMPTY' => 33, 'IS_IPV4' => 33, 'IS_IPV6' => 33, 'QUARTER' => 33, 'RADIANS' => 33, 'REVERSE' => 33, 'SOUNDEX' => 33, 'ST_AREA' => 33, 'ST_SRID' => 33, 'SUBDATE' => 33, 'SUBTIME' => 33, 'SYSDATE' => 33, 'TOUCHES' => 33, 'TO_DAYS' => 33, 'VAR_POP' => 33, 'VERSION' => 33, 'WEEKDAY' => 33, 'ASBINARY' => 33, 'CENTROID' => 33, 'COALESCE' => 33, 'COMPRESS' => 33, 'CONTAINS' => 33, 'DATEDIFF' => 33, 'DATE_ADD' => 33, 'DATE_SUB' => 33, 'DISJOINT' => 33, 'DISTANCE' => 33, 'ENDPOINT' => 33, 'ENVELOPE' => 33, 'GET_LOCK' => 33, 'GREATEST' => 33, 'ISCLOSED' => 33, 'ISSIMPLE' => 33, 'JSON_SET' => 33, 'MAKEDATE' => 33, 'MAKETIME' => 33, 'MAKE_SET' => 33, 'MBREQUAL' => 33, 'OVERLAPS' => 33, 'PASSWORD' => 33, 'POSITION' => 33, 'ST_ASWKB' => 33, 'ST_ASWKT' => 33, 'ST_UNION' => 33, 'TIMEDIFF' => 33, 'TRUNCATE' => 33, 'VARIANCE' => 33, 'VAR_SAMP' => 33, 'YEARWEEK' => 33, 'ANY_VALUE' => 33, 'BENCHMARK' => 33, 'BIT_COUNT' => 33, 'COLLATION' => 33, 'CONCAT_WS' => 33, 'DAYOFWEEK' => 33, 'DAYOFYEAR' => 33, 'DIMENSION' => 33, 'FROM_DAYS' => 33, 'GEOMETRYN' => 33, 'INET_ATON' => 33, 'INET_NTOA' => 33, 'JSON_KEYS' => 33, 'JSON_TYPE' => 33, 'LOAD_FILE' => 33, 'MBRCOVERS' => 33, 'MBREQUALS' => 33, 'MBRWITHIN' => 33, 'MONTHNAME' => 33, 'NUMPOINTS' => 33, 'ROW_COUNT' => 33, 'ST_ASTEXT' => 33, 'ST_BUFFER' => 33, 'ST_EQUALS' => 33, 'ST_LENGTH' => 33, 'ST_POINTN' => 33, 'ST_WITHIN' => 33, 'SUBSTRING' => 33, 'TO_BASE64' => 33, 'UPDATEXML' => 33, 'BIT_LENGTH' => 33, 'CONVERT_TZ' => 33, 'CONVEXHULL' => 33, 'DAYOFMONTH' => 33, 'EXPORT_SET' => 33, 'FOUND_ROWS' => 33, 'GET_FORMAT' => 33, 'INET6_ATON' => 33, 'INET6_NTOA' => 33, 'INTERSECTS' => 33, 'JSON_ARRAY' => 33, 'JSON_DEPTH' => 33, 'JSON_MERGE' => 33, 'JSON_QUOTE' => 33, 'JSON_VALID' => 33, 'MBRTOUCHES' => 33, 'MULTIPOINT' => 33, 'NAME_CONST' => 33, 'PERIOD_ADD' => 33, 'STARTPOINT' => 33, 'STDDEV_POP' => 33, 'ST_CROSSES' => 33, 'ST_GEOHASH' => 33, 'ST_ISEMPTY' => 33, 'ST_ISVALID' => 33, 'ST_TOUCHES' => 33, 'TO_SECONDS' => 33, 'UNCOMPRESS' => 33, 'UUID_SHORT' => 33, 'WEEKOFYEAR' => 33, 'AES_DECRYPT' => 33, 'AES_ENCRYPT' => 33, 'CHAR_LENGTH' => 33, 'DATE_FORMAT' => 33, 'DES_DECRYPT' => 33, 'DES_ENCRYPT' => 33, 'FIND_IN_SET' => 33, 'FROM_BASE64' => 33, 'GEOMFROMWKB' => 33, 'GTID_SUBSET' => 33, 'JSON_INSERT' => 33, 'JSON_LENGTH' => 33, 'JSON_OBJECT' => 33, 'JSON_PRETTY' => 33, 'JSON_REMOVE' => 33, 'JSON_SEARCH' => 33, 'LINEFROMWKB' => 33, 'MBRCONTAINS' => 33, 'MBRDISJOINT' => 33, 'MBROVERLAPS' => 33, 'MICROSECOND' => 33, 'PERIOD_DIFF' => 33, 'POLYFROMWKB' => 33, 'SEC_TO_TIME' => 33, 'STDDEV_SAMP' => 33, 'STR_TO_DATE' => 33, 'ST_ASBINARY' => 33, 'ST_CENTROID' => 33, 'ST_CONTAINS' => 33, 'ST_DISJOINT' => 33, 'ST_DISTANCE' => 33, 'ST_ENDPOINT' => 33, 'ST_ENVELOPE' => 33, 'ST_ISCLOSED' => 33, 'ST_ISSIMPLE' => 33, 'ST_OVERLAPS' => 33, 'ST_SIMPLIFY' => 33, 'ST_VALIDATE' => 33, 'SYSTEM_USER' => 33, 'TIME_FORMAT' => 33, 'TIME_TO_SEC' => 33, 'COERCIBILITY' => 33, 'EXTERIORRING' => 33, 'EXTRACTVALUE' => 33, 'GEOMETRYTYPE' => 33, 'GEOMFROMTEXT' => 33, 'GROUP_CONCAT' => 33, 'IS_FREE_LOCK' => 33, 'IS_USED_LOCK' => 33, 'JSON_EXTRACT' => 33, 'JSON_REPLACE' => 33, 'JSON_UNQUOTE' => 33, 'LINEFROMTEXT' => 33, 'MBRCOVEREDBY' => 33, 'MLINEFROMWKB' => 33, 'MPOLYFROMWKB' => 33, 'MULTIPOLYGON' => 33, 'OCTET_LENGTH' => 33, 'OLD_PASSWORD' => 33, 'POINTFROMWKB' => 33, 'POLYFROMTEXT' => 33, 'RANDOM_BYTES' => 33, 'RELEASE_LOCK' => 33, 'SESSION_USER' => 33, 'ST_ASGEOJSON' => 33, 'ST_DIMENSION' => 33, 'ST_GEOMETRYN' => 33, 'ST_NUMPOINTS' => 33, 'TIMESTAMPADD' => 33, 'CONNECTION_ID' => 33, 'FROM_UNIXTIME' => 33, 'GTID_SUBTRACT' => 33, 'INTERIORRINGN' => 33, 'JSON_CONTAINS' => 33, 'MBRINTERSECTS' => 33, 'MLINEFROMTEXT' => 33, 'MPOINTFROMWKB' => 33, 'MPOLYFROMTEXT' => 33, 'NUMGEOMETRIES' => 33, 'POINTFROMTEXT' => 33, 'ST_CONVEXHULL' => 33, 'ST_DIFFERENCE' => 33, 'ST_INTERSECTS' => 33, 'ST_STARTPOINT' => 33, 'TIMESTAMPDIFF' => 33, 'WEIGHT_STRING' => 33, 'IS_IPV4_COMPAT' => 33, 'IS_IPV4_MAPPED' => 33, 'LAST_INSERT_ID' => 33, 'MPOINTFROMTEXT' => 33, 'POLYGONFROMWKB' => 33, 'ST_GEOMFROMWKB' => 33, 'ST_LINEFROMWKB' => 33, 'ST_POLYFROMWKB' => 33, 'UNIX_TIMESTAMP' => 33, 'GEOMCOLLFROMWKB' => 33, 'MASTER_POS_WAIT' => 33, 'POLYGONFROMTEXT' => 33, 'ST_EXTERIORRING' => 33, 'ST_GEOMETRYTYPE' => 33, 'ST_GEOMFROMTEXT' => 33, 'ST_INTERSECTION' => 33, 'ST_LINEFROMTEXT' => 33, 'ST_MAKEENVELOPE' => 33, 'ST_MLINEFROMWKB' => 33, 'ST_MPOLYFROMWKB' => 33, 'ST_POINTFROMWKB' => 33, 'ST_POLYFROMTEXT' => 33, 'SUBSTRING_INDEX' => 33, 'CHARACTER_LENGTH' => 33, 'GEOMCOLLFROMTEXT' => 33, 'GEOMETRYFROMTEXT' => 33, 'JSON_MERGE_PATCH' => 33, 'NUMINTERIORRINGS' => 33, 'ST_INTERIORRINGN' => 33, 'ST_MLINEFROMTEXT' => 33, 'ST_MPOINTFROMWKB' => 33, 'ST_MPOLYFROMTEXT' => 33, 'ST_NUMGEOMETRIES' => 33, 'ST_POINTFROMTEXT' => 33, 'ST_SYMDIFFERENCE' => 33, 'JSON_ARRAY_APPEND' => 33, 'JSON_ARRAY_INSERT' => 33, 'JSON_STORAGE_FREE' => 33, 'JSON_STORAGE_SIZE' => 33, 'LINESTRINGFROMWKB' => 33, 'MULTIPOINTFROMWKB' => 33, 'RELEASE_ALL_LOCKS' => 33, 'ST_LATFROMGEOHASH' => 33, 'ST_MPOINTFROMTEXT' => 33, 'ST_POLYGONFROMWKB' => 33, 'JSON_CONTAINS_PATH' => 33, 'MULTIPOINTFROMTEXT' => 33, 'ST_BUFFER_STRATEGY' => 33, 'ST_DISTANCE_SPHERE' => 33, 'ST_GEOMCOLLFROMTXT' => 33, 'ST_GEOMCOLLFROMWKB' => 33, 'ST_GEOMFROMGEOJSON' => 33, 'ST_LONGFROMGEOHASH' => 33, 'ST_POLYGONFROMTEXT' => 33, 'JSON_MERGE_PRESERVE' => 33, 'MULTIPOLYGONFROMWKB' => 33, 'ST_GEOMCOLLFROMTEXT' => 33, 'ST_GEOMETRYFROMTEXT' => 33, 'ST_NUMINTERIORRINGS' => 33, 'ST_POINTFROMGEOHASH' => 33, 'UNCOMPRESSED_LENGTH' => 33, 'MULTIPOLYGONFROMTEXT' => 33, 'ST_LINESTRINGFROMWKB' => 33, 'ST_MULTIPOINTFROMWKB' => 33, 'ST_MULTIPOINTFROMTEXT' => 33, 'MULTILINESTRINGFROMWKB' => 33, 'ST_MULTIPOLYGONFROMWKB' => 33, 'MULTILINESTRINGFROMTEXT' => 33, 'ST_MULTIPOLYGONFROMTEXT' => 33, 'GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_MULTILINESTRINGFROMWKB' => 33, 'GEOMETRYCOLLECTIONFROMTEXT' => 33, 'ST_MULTILINESTRINGFROMTEXT' => 33, 'VALIDATE_PASSWORD_STRENGTH' => 33, 'WAIT_FOR_EXECUTED_GTID_SET' => 33, 'ST_GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_GEOMETRYCOLLECTIONFROMTEXT' => 33, 'WAIT_UNTIL_SQL_THREAD_AFTER_GTIDS' => 33, 'IF' => 35, 'IN' => 35, 'MOD' => 35, 'LEFT' => 35, 'MATCH' => 35, 'RIGHT' => 35, 'INSERT' => 35, 'REPEAT' => 35, 'SCHEMA' => 35, 'VALUES' => 35, 'CONVERT' => 35, 'DEFAULT' => 35, 'REPLACE' => 35, 'DATABASE' => 35, 'UTC_DATE' => 35, 'UTC_TIME' => 35, 'LOCALTIME' => 35, 'CURRENT_DATE' => 35, 'CURRENT_TIME' => 35, 'CURRENT_USER' => 35, 'UTC_TIMESTAMP' => 35, 'LOCALTIMESTAMP' => 35, 'CURRENT_TIMESTAMP' => 35, 'NOT IN' => 39, 'DATE' => 41, 'TIME' => 41, 'YEAR' => 41, 'POINT' => 41, 'POLYGON' => 41, 'TIMESTAMP' => 41, 'LINESTRING' => 41, 'MULTILINESTRING' => 41, 'GEOMETRYCOLLECTION' => 41, 'CHAR' => 43, 'BINARY' => 43, 'INTERVAL' => 43);
}
/**
* Context for MySQL 5.0.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextMySql50000 extends \PhpMyAdmin\SqlParser\Context
{
/**
* List of keywords.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* @var array
*/
public static $KEYWORDS = array('DO' => 1, 'IO' => 1, 'NO' => 1, 'XA' => 1, 'ANY' => 1, 'BDB' => 1, 'CPU' => 1, 'END' => 1, 'IPC' => 1, 'NDB' => 1, 'NEW' => 1, 'ONE' => 1, 'ROW' => 1, 'BOOL' => 1, 'BYTE' => 1, 'CODE' => 1, 'CUBE' => 1, 'DATA' => 1, 'FAST' => 1, 'FILE' => 1, 'FULL' => 1, 'HASH' => 1, 'HELP' => 1, 'LAST' => 1, 'LOGS' => 1, 'MODE' => 1, 'NAME' => 1, 'NEXT' => 1, 'NONE' => 1, 'OPEN' => 1, 'PAGE' => 1, 'PREV' => 1, 'ROWS' => 1, 'SOME' => 1, 'STOP' => 1, 'TYPE' => 1, 'VIEW' => 1, 'WORK' => 1, 'X509' => 1, 'AFTER' => 1, 'BEGIN' => 1, 'BLOCK' => 1, 'BTREE' => 1, 'CACHE' => 1, 'CHAIN' => 1, 'CLOSE' => 1, 'FIRST' => 1, 'FIXED' => 1, 'FLUSH' => 1, 'FOUND' => 1, 'HOSTS' => 1, 'LEVEL' => 1, 'LOCAL' => 1, 'LOCKS' => 1, 'MERGE' => 1, 'MUTEX' => 1, 'NAMES' => 1, 'NCHAR' => 1, 'PHASE' => 1, 'QUERY' => 1, 'QUICK' => 1, 'RAID0' => 1, 'RESET' => 1, 'RTREE' => 1, 'SHARE' => 1, 'SLAVE' => 1, 'START' => 1, 'SUPER' => 1, 'SWAPS' => 1, 'TYPES' => 1, 'UNTIL' => 1, 'VALUE' => 1, 'ACTION' => 1, 'BACKUP' => 1, 'BINLOG' => 1, 'CIPHER' => 1, 'CLIENT' => 1, 'COMMIT' => 1, 'ENABLE' => 1, 'ENGINE' => 1, 'ERRORS' => 1, 'ESCAPE' => 1, 'EVENTS' => 1, 'FAULTS' => 1, 'FIELDS' => 1, 'GLOBAL' => 1, 'GRANTS' => 1, 'IMPORT' => 1, 'INNODB' => 1, 'ISSUER' => 1, 'LEAVES' => 1, 'MASTER' => 1, 'MEDIUM' => 1, 'MEMORY' => 1, 'MODIFY' => 1, 'OFFSET' => 1, 'RELOAD' => 1, 'REPAIR' => 1, 'RESUME' => 1, 'ROLLUP' => 1, 'SIGNED' => 1, 'SIMPLE' => 1, 'SOUNDS' => 1, 'SOURCE' => 1, 'STATUS' => 1, 'STRING' => 1, 'TABLES' => 1, 'CHANGED' => 1, 'COLUMNS' => 1, 'COMMENT' => 1, 'COMPACT' => 1, 'CONTEXT' => 1, 'DEFINER' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DYNAMIC' => 1, 'ENGINES' => 1, 'EXECUTE' => 1, 'HANDLER' => 1, 'INDEXES' => 1, 'INVOKER' => 1, 'MIGRATE' => 1, 'PARTIAL' => 1, 'PREPARE' => 1, 'PROFILE' => 1, 'RECOVER' => 1, 'RESTORE' => 1, 'RETURNS' => 1, 'ROUTINE' => 1, 'SESSION' => 1, 'STORAGE' => 1, 'STRIPED' => 1, 'SUBJECT' => 1, 'SUSPEND' => 1, 'UNICODE' => 1, 'UNKNOWN' => 1, 'UPGRADE' => 1, 'USE_FRM' => 1, 'VIRTUAL' => 1, 'CASCADED' => 1, 'CHECKSUM' => 1, 'DUMPFILE' => 1, 'EXTENDED' => 1, 'FUNCTION' => 1, 'INNOBASE' => 1, 'LANGUAGE' => 1, 'MAX_ROWS' => 1, 'MIN_ROWS' => 1, 'NATIONAL' => 1, 'NVARCHAR' => 1, 'ONE_SHOT' => 1, 'PROFILES' => 1, 'ROLLBACK' => 1, 'SECURITY' => 1, 'SHUTDOWN' => 1, 'SNAPSHOT' => 1, 'SWITCHES' => 1, 'TRIGGERS' => 1, 'WARNINGS' => 1, 'AGGREGATE' => 1, 'ALGORITHM' => 1, 'COMMITTED' => 1, 'DIRECTORY' => 1, 'DUPLICATE' => 1, 'EXPANSION' => 1, 'IO_THREAD' => 1, 'ISOLATION' => 1, 'PACK_KEYS' => 1, 'RAID_TYPE' => 1, 'REDUNDANT' => 1, 'SAVEPOINT' => 1, 'SQL_CACHE' => 1, 'TEMPORARY' => 1, 'TEMPTABLE' => 1, 'UNDEFINED' => 1, 'VARIABLES' => 1, 'BERKELEYDB' => 1, 'COMPRESSED' => 1, 'CONCURRENT' => 1, 'CONNECTION' => 1, 'CONSISTENT' => 1, 'DEALLOCATE' => 1, 'IDENTIFIED' => 1, 'MASTER_SSL' => 1, 'NDBCLUSTER' => 1, 'PARTITIONS' => 1, 'PERSISTENT' => 1, 'PRIVILEGES' => 1, 'REPEATABLE' => 1, 'ROW_FORMAT' => 1, 'SQL_THREAD' => 1, 'TABLESPACE' => 1, 'FRAC_SECOND' => 1, 'MASTER_HOST' => 1, 'MASTER_PORT' => 1, 'MASTER_USER' => 1, 'PROCESSLIST' => 1, 'RAID_CHUNKS' => 1, 'REPLICATION' => 1, 'SQL_TSI_DAY' => 1, 'TRANSACTION' => 1, 'UNCOMMITTED' => 1, 'DES_KEY_FILE' => 1, 'RELAY_THREAD' => 1, 'SERIALIZABLE' => 1, 'SQL_NO_CACHE' => 1, 'SQL_TSI_HOUR' => 1, 'SQL_TSI_WEEK' => 1, 'SQL_TSI_YEAR' => 1, 'INSERT_METHOD' => 1, 'MASTER_SSL_CA' => 1, 'RELAY_LOG_POS' => 1, 'SQL_TSI_MONTH' => 1, 'SUBPARTITIONS' => 1, 'AUTO_INCREMENT' => 1, 'AVG_ROW_LENGTH' => 1, 'MASTER_LOG_POS' => 1, 'MASTER_SSL_KEY' => 1, 'RAID_CHUNKSIZE' => 1, 'RELAY_LOG_FILE' => 1, 'SQL_TSI_MINUTE' => 1, 'SQL_TSI_SECOND' => 1, 'USER_RESOURCES' => 1, 'DELAY_KEY_WRITE' => 1, 'MASTER_LOG_FILE' => 1, 'MASTER_PASSWORD' => 1, 'MASTER_SSL_CERT' => 1, 'SQL_TSI_QUARTER' => 1, 'MASTER_SERVER_ID' => 1, 'MASTER_SSL_CAPATH' => 1, 'MASTER_SSL_CIPHER' => 1, 'SQL_BUFFER_RESULT' => 1, 'SQL_TSI_FRAC_SECOND' => 1, 'MASTER_CONNECT_RETRY' => 1, 'MAX_QUERIES_PER_HOUR' => 1, 'MAX_UPDATES_PER_HOUR' => 1, 'MAX_USER_CONNECTIONS' => 1, 'MAX_CONNECTIONS_PER_HOUR' => 1, 'AS' => 3, 'BY' => 3, 'IS' => 3, 'ON' => 3, 'OR' => 3, 'TO' => 3, 'ADD' => 3, 'ALL' => 3, 'AND' => 3, 'ASC' => 3, 'DEC' => 3, 'DIV' => 3, 'FOR' => 3, 'NOT' => 3, 'OUT' => 3, 'SQL' => 3, 'SSL' => 3, 'USE' => 3, 'XOR' => 3, 'BOTH' => 3, 'CALL' => 3, 'CASE' => 3, 'DESC' => 3, 'DROP' => 3, 'DUAL' => 3, 'EACH' => 3, 'ELSE' => 3, 'EXIT' => 3, 'FROM' => 3, 'INT1' => 3, 'INT2' => 3, 'INT3' => 3, 'INT4' => 3, 'INT8' => 3, 'INTO' => 3, 'JOIN' => 3, 'KEYS' => 3, 'KILL' => 3, 'LIKE' => 3, 'LOAD' => 3, 'LOCK' => 3, 'LONG' => 3, 'LOOP' => 3, 'NULL' => 3, 'READ' => 3, 'SHOW' => 3, 'THEN' => 3, 'TRUE' => 3, 'UNDO' => 3, 'WHEN' => 3, 'WITH' => 3, 'ALTER' => 3, 'CHECK' => 3, 'CROSS' => 3, 'FALSE' => 3, 'FETCH' => 3, 'FORCE' => 3, 'GRANT' => 3, 'GROUP' => 3, 'INNER' => 3, 'INOUT' => 3, 'LEAVE' => 3, 'LIMIT' => 3, 'LINES' => 3, 'ORDER' => 3, 'OUTER' => 3, 'PURGE' => 3, 'READS' => 3, 'RLIKE' => 3, 'TABLE' => 3, 'UNION' => 3, 'USAGE' => 3, 'USING' => 3, 'WHERE' => 3, 'WHILE' => 3, 'WRITE' => 3, 'BEFORE' => 3, 'CHANGE' => 3, 'COLUMN' => 3, 'CREATE' => 3, 'CURSOR' => 3, 'DELETE' => 3, 'ELSEIF' => 3, 'EXISTS' => 3, 'FLOAT4' => 3, 'FLOAT8' => 3, 'HAVING' => 3, 'IGNORE' => 3, 'INFILE' => 3, 'OPTION' => 3, 'REGEXP' => 3, 'RENAME' => 3, 'RETURN' => 3, 'REVOKE' => 3, 'SELECT' => 3, 'SONAME' => 3, 'UNLOCK' => 3, 'UPDATE' => 3, 'ANALYZE' => 3, 'BETWEEN' => 3, 'CASCADE' => 3, 'COLLATE' => 3, 'DECLARE' => 3, 'DELAYED' => 3, 'ESCAPED' => 3, 'EXPLAIN' => 3, 'FOREIGN' => 3, 'ITERATE' => 3, 'LEADING' => 3, 'NATURAL' => 3, 'OUTFILE' => 3, 'PRIMARY' => 3, 'RELEASE' => 3, 'REQUIRE' => 3, 'SCHEMAS' => 3, 'TRIGGER' => 3, 'VARYING' => 3, 'CONTINUE' => 3, 'DAY_HOUR' => 3, 'DESCRIBE' => 3, 'DISTINCT' => 3, 'ENCLOSED' => 3, 'MODIFIES' => 3, 'OPTIMIZE' => 3, 'RESTRICT' => 3, 'SPECIFIC' => 3, 'SQLSTATE' => 3, 'STARTING' => 3, 'TRAILING' => 3, 'UNSIGNED' => 3, 'ZEROFILL' => 3, 'CONDITION' => 3, 'DATABASES' => 3, 'MIDDLEINT' => 3, 'PRECISION' => 3, 'PROCEDURE' => 3, 'SENSITIVE' => 3, 'SEPARATOR' => 3, 'ASENSITIVE' => 3, 'CONSTRAINT' => 3, 'DAY_MINUTE' => 3, 'DAY_SECOND' => 3, 'OPTIONALLY' => 3, 'REFERENCES' => 3, 'SQLWARNING' => 3, 'TERMINATED' => 3, 'YEAR_MONTH' => 3, 'DISTINCTROW' => 3, 'HOUR_MINUTE' => 3, 'HOUR_SECOND' => 3, 'INSENSITIVE' => 3, 'LOW_PRIORITY' => 3, 'SQLEXCEPTION' => 3, 'VARCHARACTER' => 3, 'DETERMINISTIC' => 3, 'HIGH_PRIORITY' => 3, 'MINUTE_SECOND' => 3, 'STRAIGHT_JOIN' => 3, 'SQL_BIG_RESULT' => 3, 'DAY_MICROSECOND' => 3, 'HOUR_MICROSECOND' => 3, 'SQL_SMALL_RESULT' => 3, 'MINUTE_MICROSECOND' => 3, 'NO_WRITE_TO_BINLOG' => 3, 'SECOND_MICROSECOND' => 3, 'SQL_CALC_FOUND_ROWS' => 3, 'GROUP BY' => 7, 'NOT NULL' => 7, 'ORDER BY' => 7, 'SET NULL' => 7, 'AND CHAIN' => 7, 'FULL JOIN' => 7, 'IF EXISTS' => 7, 'LEFT JOIN' => 7, 'LESS THAN' => 7, 'LOAD DATA' => 7, 'NO ACTION' => 7, 'ON DELETE' => 7, 'ON UPDATE' => 7, 'UNION ALL' => 7, 'CROSS JOIN' => 7, 'ESCAPED BY' => 7, 'FOR UPDATE' => 7, 'INNER JOIN' => 7, 'LINEAR KEY' => 7, 'NO RELEASE' => 7, 'OR REPLACE' => 7, 'RIGHT JOIN' => 7, 'ENCLOSED BY' => 7, 'LINEAR HASH' => 7, 'STARTING BY' => 7, 'AND NO CHAIN' => 7, 'FOR EACH ROW' => 7, 'NATURAL JOIN' => 7, 'PARTITION BY' => 7, 'SET PASSWORD' => 7, 'SQL SECURITY' => 7, 'CHARACTER SET' => 7, 'IF NOT EXISTS' => 7, 'TERMINATED BY' => 7, 'DATA DIRECTORY' => 7, 'UNION DISTINCT' => 7, 'DEFAULT CHARSET' => 7, 'DEFAULT COLLATE' => 7, 'FULL OUTER JOIN' => 7, 'INDEX DIRECTORY' => 7, 'LEFT OUTER JOIN' => 7, 'SUBPARTITION BY' => 7, 'GENERATED ALWAYS' => 7, 'RIGHT OUTER JOIN' => 7, 'NATURAL LEFT JOIN' => 7, 'START TRANSACTION' => 7, 'LOCK IN SHARE MODE' => 7, 'NATURAL RIGHT JOIN' => 7, 'SELECT TRANSACTION' => 7, 'DEFAULT CHARACTER SET' => 7, 'NATURAL LEFT OUTER JOIN' => 7, 'NATURAL RIGHT OUTER JOIN' => 7, 'WITH CONSISTENT SNAPSHOT' => 7, 'BIT' => 9, 'XML' => 9, 'ENUM' => 9, 'JSON' => 9, 'TEXT' => 9, 'ARRAY' => 9, 'SERIAL' => 9, 'BOOLEAN' => 9, 'DATETIME' => 9, 'GEOMETRY' => 9, 'MULTISET' => 9, 'MULTILINEPOINT' => 9, 'MULTILINEPOLYGON' => 9, 'INT' => 11, 'SET' => 11, 'BLOB' => 11, 'REAL' => 11, 'FLOAT' => 11, 'BIGINT' => 11, 'DOUBLE' => 11, 'DECIMAL' => 11, 'INTEGER' => 11, 'NUMERIC' => 11, 'TINYINT' => 11, 'VARCHAR' => 11, 'LONGBLOB' => 11, 'LONGTEXT' => 11, 'SMALLINT' => 11, 'TINYBLOB' => 11, 'TINYTEXT' => 11, 'CHARACTER' => 11, 'MEDIUMINT' => 11, 'VARBINARY' => 11, 'MEDIUMBLOB' => 11, 'MEDIUMTEXT' => 11, 'BINARY VARYING' => 15, 'KEY' => 19, 'INDEX' => 19, 'UNIQUE' => 19, 'SPATIAL' => 19, 'FULLTEXT' => 19, 'INDEX KEY' => 23, 'UNIQUE KEY' => 23, 'FOREIGN KEY' => 23, 'PRIMARY KEY' => 23, 'SPATIAL KEY' => 23, 'FULLTEXT KEY' => 23, 'UNIQUE INDEX' => 23, 'SPATIAL INDEX' => 23, 'FULLTEXT INDEX' => 23, 'X' => 33, 'Y' => 33, 'LN' => 33, 'PI' => 33, 'ABS' => 33, 'AVG' => 33, 'BIN' => 33, 'COS' => 33, 'COT' => 33, 'DAY' => 33, 'ELT' => 33, 'EXP' => 33, 'HEX' => 33, 'LOG' => 33, 'MAX' => 33, 'MD5' => 33, 'MID' => 33, 'MIN' => 33, 'NOW' => 33, 'OCT' => 33, 'ORD' => 33, 'POW' => 33, 'SIN' => 33, 'STD' => 33, 'SUM' => 33, 'TAN' => 33, 'ACOS' => 33, 'AREA' => 33, 'ASIN' => 33, 'ATAN' => 33, 'CAST' => 33, 'CEIL' => 33, 'CONV' => 33, 'HOUR' => 33, 'LOG2' => 33, 'LPAD' => 33, 'RAND' => 33, 'RPAD' => 33, 'SHA1' => 33, 'SIGN' => 33, 'SQRT' => 33, 'SRID' => 33, 'TRIM' => 33, 'USER' => 33, 'UUID' => 33, 'WEEK' => 33, 'ASCII' => 33, 'ATAN2' => 33, 'COUNT' => 33, 'CRC32' => 33, 'FIELD' => 33, 'FLOOR' => 33, 'INSTR' => 33, 'LCASE' => 33, 'LEAST' => 33, 'LOG10' => 33, 'LOWER' => 33, 'LTRIM' => 33, 'MONTH' => 33, 'POWER' => 33, 'QUOTE' => 33, 'ROUND' => 33, 'RTRIM' => 33, 'SLEEP' => 33, 'SPACE' => 33, 'UCASE' => 33, 'UNHEX' => 33, 'UPPER' => 33, 'ASTEXT' => 33, 'BIT_OR' => 33, 'CONCAT' => 33, 'DECODE' => 33, 'ENCODE' => 33, 'EQUALS' => 33, 'FORMAT' => 33, 'IFNULL' => 33, 'ISNULL' => 33, 'LENGTH' => 33, 'LOCATE' => 33, 'MINUTE' => 33, 'NULLIF' => 33, 'POINTN' => 33, 'SECOND' => 33, 'STDDEV' => 33, 'STRCMP' => 33, 'SUBSTR' => 33, 'WITHIN' => 33, 'ADDDATE' => 33, 'ADDTIME' => 33, 'AGAINST' => 33, 'BIT_AND' => 33, 'BIT_XOR' => 33, 'CEILING' => 33, 'CHARSET' => 33, 'CROSSES' => 33, 'CURDATE' => 33, 'CURTIME' => 33, 'DAYNAME' => 33, 'DEGREES' => 33, 'ENCRYPT' => 33, 'EXTRACT' => 33, 'GLENGTH' => 33, 'ISEMPTY' => 33, 'QUARTER' => 33, 'RADIANS' => 33, 'REVERSE' => 33, 'SOUNDEX' => 33, 'SUBDATE' => 33, 'SUBTIME' => 33, 'SYSDATE' => 33, 'TOUCHES' => 33, 'TO_DAYS' => 33, 'VAR_POP' => 33, 'VERSION' => 33, 'WEEKDAY' => 33, 'ASBINARY' => 33, 'CENTROID' => 33, 'COALESCE' => 33, 'COMPRESS' => 33, 'CONTAINS' => 33, 'DATEDIFF' => 33, 'DATE_ADD' => 33, 'DATE_SUB' => 33, 'DISJOINT' => 33, 'ENDPOINT' => 33, 'ENVELOPE' => 33, 'GET_LOCK' => 33, 'GREATEST' => 33, 'ISCLOSED' => 33, 'ISSIMPLE' => 33, 'MAKEDATE' => 33, 'MAKETIME' => 33, 'MAKE_SET' => 33, 'MBREQUAL' => 33, 'OVERLAPS' => 33, 'PASSWORD' => 33, 'POSITION' => 33, 'TIMEDIFF' => 33, 'TRUNCATE' => 33, 'VARIANCE' => 33, 'VAR_SAMP' => 33, 'YEARWEEK' => 33, 'BENCHMARK' => 33, 'BIT_COUNT' => 33, 'COLLATION' => 33, 'CONCAT_WS' => 33, 'DAYOFWEEK' => 33, 'DAYOFYEAR' => 33, 'DIMENSION' => 33, 'FROM_DAYS' => 33, 'GEOMETRYN' => 33, 'INET_ATON' => 33, 'INET_NTOA' => 33, 'LOAD_FILE' => 33, 'MBRWITHIN' => 33, 'MONTHNAME' => 33, 'NUMPOINTS' => 33, 'ROW_COUNT' => 33, 'SUBSTRING' => 33, 'BIT_LENGTH' => 33, 'CONVERT_TZ' => 33, 'DAYOFMONTH' => 33, 'EXPORT_SET' => 33, 'FOUND_ROWS' => 33, 'GET_FORMAT' => 33, 'INTERSECTS' => 33, 'MBRTOUCHES' => 33, 'MULTIPOINT' => 33, 'NAME_CONST' => 33, 'PERIOD_ADD' => 33, 'STARTPOINT' => 33, 'STDDEV_POP' => 33, 'UNCOMPRESS' => 33, 'WEEKOFYEAR' => 33, 'AES_DECRYPT' => 33, 'AES_ENCRYPT' => 33, 'CHAR_LENGTH' => 33, 'DATE_FORMAT' => 33, 'DES_DECRYPT' => 33, 'DES_ENCRYPT' => 33, 'FIND_IN_SET' => 33, 'GEOMFROMWKB' => 33, 'LINEFROMWKB' => 33, 'MBRCONTAINS' => 33, 'MBRDISJOINT' => 33, 'MBROVERLAPS' => 33, 'MICROSECOND' => 33, 'PERIOD_DIFF' => 33, 'POLYFROMWKB' => 33, 'SEC_TO_TIME' => 33, 'STDDEV_SAMP' => 33, 'STR_TO_DATE' => 33, 'SYSTEM_USER' => 33, 'TIME_FORMAT' => 33, 'TIME_TO_SEC' => 33, 'COERCIBILITY' => 33, 'EXTERIORRING' => 33, 'GEOMETRYTYPE' => 33, 'GEOMFROMTEXT' => 33, 'GROUP_CONCAT' => 33, 'IS_FREE_LOCK' => 33, 'IS_USED_LOCK' => 33, 'LINEFROMTEXT' => 33, 'MLINEFROMWKB' => 33, 'MPOLYFROMWKB' => 33, 'MULTIPOLYGON' => 33, 'OCTET_LENGTH' => 33, 'OLD_PASSWORD' => 33, 'POINTFROMWKB' => 33, 'POLYFROMTEXT' => 33, 'RELEASE_LOCK' => 33, 'SESSION_USER' => 33, 'TIMESTAMPADD' => 33, 'CONNECTION_ID' => 33, 'FROM_UNIXTIME' => 33, 'INTERIORRINGN' => 33, 'MBRINTERSECTS' => 33, 'MLINEFROMTEXT' => 33, 'MPOINTFROMWKB' => 33, 'MPOLYFROMTEXT' => 33, 'NUMGEOMETRIES' => 33, 'POINTFROMTEXT' => 33, 'TIMESTAMPDIFF' => 33, 'LAST_INSERT_ID' => 33, 'MPOINTFROMTEXT' => 33, 'UNIX_TIMESTAMP' => 33, 'GEOMCOLLFROMWKB' => 33, 'MASTER_POS_WAIT' => 33, 'SUBSTRING_INDEX' => 33, 'CHARACTER_LENGTH' => 33, 'GEOMCOLLFROMTEXT' => 33, 'NUMINTERIORRINGS' => 33, 'UNCOMPRESSED_LENGTH' => 33, 'IF' => 35, 'IN' => 35, 'MOD' => 35, 'LEFT' => 35, 'MATCH' => 35, 'RIGHT' => 35, 'INSERT' => 35, 'REPEAT' => 35, 'SCHEMA' => 35, 'VALUES' => 35, 'CONVERT' => 35, 'DEFAULT' => 35, 'REPLACE' => 35, 'DATABASE' => 35, 'UTC_DATE' => 35, 'UTC_TIME' => 35, 'LOCALTIME' => 35, 'CURRENT_DATE' => 35, 'CURRENT_TIME' => 35, 'CURRENT_USER' => 35, 'UTC_TIMESTAMP' => 35, 'LOCALTIMESTAMP' => 35, 'CURRENT_TIMESTAMP' => 35, 'NOT IN' => 39, 'DATE' => 41, 'TIME' => 41, 'YEAR' => 41, 'POINT' => 41, 'POLYGON' => 41, 'TIMESTAMP' => 41, 'LINESTRING' => 41, 'MULTILINESTRING' => 41, 'GEOMETRYCOLLECTION' => 41, 'CHAR' => 43, 'BINARY' => 43, 'INTERVAL' => 43);
}
/**
* Context for MariaDB 10.1.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextMariaDb100100 extends \PhpMyAdmin\SqlParser\Context
{
/**
* List of keywords.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* @var array
*/
public static $KEYWORDS = array('AT' => 1, 'DO' => 1, 'IO' => 1, 'NO' => 1, 'XA' => 1, 'ANY' => 1, 'CPU' => 1, 'END' => 1, 'IPC' => 1, 'NDB' => 1, 'NEW' => 1, 'ONE' => 1, 'ROW' => 1, 'XID' => 1, 'BOOL' => 1, 'BYTE' => 1, 'CODE' => 1, 'CUBE' => 1, 'DATA' => 1, 'DISK' => 1, 'ENDS' => 1, 'FAST' => 1, 'FILE' => 1, 'FULL' => 1, 'HASH' => 1, 'HELP' => 1, 'HOST' => 1, 'LAST' => 1, 'LESS' => 1, 'LIST' => 1, 'LOGS' => 1, 'MODE' => 1, 'NAME' => 1, 'NEXT' => 1, 'NONE' => 1, 'ONLY' => 1, 'OPEN' => 1, 'PAGE' => 1, 'PORT' => 1, 'PREV' => 1, 'ROWS' => 1, 'SLOW' => 1, 'SOME' => 1, 'STOP' => 1, 'THAN' => 1, 'TYPE' => 1, 'VIEW' => 1, 'WAIT' => 1, 'WORK' => 1, 'X509' => 1, 'AFTER' => 1, 'BEGIN' => 1, 'BLOCK' => 1, 'BTREE' => 1, 'CACHE' => 1, 'CHAIN' => 1, 'CLOSE' => 1, 'ERROR' => 1, 'EVENT' => 1, 'EVERY' => 1, 'FIRST' => 1, 'FIXED' => 1, 'FLUSH' => 1, 'FOUND' => 1, 'HOSTS' => 1, 'LEVEL' => 1, 'LOCAL' => 1, 'LOCKS' => 1, 'MERGE' => 1, 'MUTEX' => 1, 'NAMES' => 1, 'NCHAR' => 1, 'NEVER' => 1, 'OWNER' => 1, 'PHASE' => 1, 'PROXY' => 1, 'QUERY' => 1, 'QUICK' => 1, 'RELAY' => 1, 'RESET' => 1, 'RTREE' => 1, 'SHARE' => 1, 'SLAVE' => 1, 'START' => 1, 'SUPER' => 1, 'SWAPS' => 1, 'TYPES' => 1, 'UNTIL' => 1, 'VALUE' => 1, 'ACTION' => 1, 'ALWAYS' => 1, 'BACKUP' => 1, 'BINLOG' => 1, 'CIPHER' => 1, 'CLIENT' => 1, 'COMMIT' => 1, 'ENABLE' => 1, 'ENGINE' => 1, 'ERRORS' => 1, 'ESCAPE' => 1, 'EVENTS' => 1, 'EXPIRE' => 1, 'EXPORT' => 1, 'FAULTS' => 1, 'FIELDS' => 1, 'FILTER' => 1, 'GLOBAL' => 1, 'GRANTS' => 1, 'IMPORT' => 1, 'ISSUER' => 1, 'LEAVES' => 1, 'MASTER' => 1, 'MEDIUM' => 1, 'MEMORY' => 1, 'MODIFY' => 1, 'NUMBER' => 1, 'OFFSET' => 1, 'PARSER' => 1, 'PLUGIN' => 1, 'RELOAD' => 1, 'REMOVE' => 1, 'REPAIR' => 1, 'RESUME' => 1, 'ROLLUP' => 1, 'SERVER' => 1, 'SIGNED' => 1, 'SIMPLE' => 1, 'SOCKET' => 1, 'SONAME' => 1, 'SOUNDS' => 1, 'SOURCE' => 1, 'STARTS' => 1, 'STATUS' => 1, 'STRING' => 1, 'TABLES' => 1, 'ACCOUNT' => 1, 'ANALYSE' => 1, 'CHANGED' => 1, 'CHANNEL' => 1, 'COLUMNS' => 1, 'COMMENT' => 1, 'COMPACT' => 1, 'CONTEXT' => 1, 'CURRENT' => 1, 'DEFINER' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DYNAMIC' => 1, 'ENGINES' => 1, 'EXECUTE' => 1, 'FOLLOWS' => 1, 'GENERAL' => 1, 'HANDLER' => 1, 'INDEXES' => 1, 'INSTALL' => 1, 'INVOKER' => 1, 'LOGFILE' => 1, 'MIGRATE' => 1, 'NO_WAIT' => 1, 'OPTIONS' => 1, 'PARTIAL' => 1, 'PLUGINS' => 1, 'PREPARE' => 1, 'PROFILE' => 1, 'REBUILD' => 1, 'RECOVER' => 1, 'RESTORE' => 1, 'RETURNS' => 1, 'ROUTINE' => 1, 'SESSION' => 1, 'STACKED' => 1, 'STORAGE' => 1, 'SUBJECT' => 1, 'SUSPEND' => 1, 'UNICODE' => 1, 'UNKNOWN' => 1, 'UPGRADE' => 1, 'USE_FRM' => 1, 'WITHOUT' => 1, 'WRAPPER' => 1, 'CASCADED' => 1, 'CHECKSUM' => 1, 'DATAFILE' => 1, 'DUMPFILE' => 1, 'EXCHANGE' => 1, 'EXTENDED' => 1, 'FUNCTION' => 1, 'LANGUAGE' => 1, 'MAX_ROWS' => 1, 'MAX_SIZE' => 1, 'MIN_ROWS' => 1, 'NATIONAL' => 1, 'NVARCHAR' => 1, 'PRECEDES' => 1, 'PRESERVE' => 1, 'PROFILES' => 1, 'REDOFILE' => 1, 'RELAYLOG' => 1, 'ROLLBACK' => 1, 'SCHEDULE' => 1, 'SECURITY' => 1, 'SHUTDOWN' => 1, 'SNAPSHOT' => 1, 'SWITCHES' => 1, 'TRIGGERS' => 1, 'UNDOFILE' => 1, 'WARNINGS' => 1, 'AGGREGATE' => 1, 'ALGORITHM' => 1, 'COMMITTED' => 1, 'DIRECTORY' => 1, 'DUPLICATE' => 1, 'EXPANSION' => 1, 'IO_THREAD' => 1, 'ISOLATION' => 1, 'NODEGROUP' => 1, 'PACK_KEYS' => 1, 'READ_ONLY' => 1, 'REDUNDANT' => 1, 'SAVEPOINT' => 1, 'SQL_CACHE' => 1, 'TEMPORARY' => 1, 'TEMPTABLE' => 1, 'UNDEFINED' => 1, 'UNINSTALL' => 1, 'VARIABLES' => 1, 'COMPLETION' => 1, 'COMPRESSED' => 1, 'CONCURRENT' => 1, 'CONNECTION' => 1, 'CONSISTENT' => 1, 'DEALLOCATE' => 1, 'IDENTIFIED' => 1, 'MASTER_SSL' => 1, 'NDBCLUSTER' => 1, 'PARTITIONS' => 1, 'PERSISTENT' => 1, 'PLUGIN_DIR' => 1, 'PRIVILEGES' => 1, 'REORGANIZE' => 1, 'REPEATABLE' => 1, 'ROW_FORMAT' => 1, 'SQL_THREAD' => 1, 'TABLESPACE' => 1, 'TABLE_NAME' => 1, 'VALIDATION' => 1, 'COLUMN_NAME' => 1, 'COMPRESSION' => 1, 'CURSOR_NAME' => 1, 'DIAGNOSTICS' => 1, 'EXTENT_SIZE' => 1, 'MASTER_HOST' => 1, 'MASTER_PORT' => 1, 'MASTER_USER' => 1, 'MYSQL_ERRNO' => 1, 'NONBLOCKING' => 1, 'PROCESSLIST' => 1, 'REPLICATION' => 1, 'SCHEMA_NAME' => 1, 'SQL_TSI_DAY' => 1, 'TRANSACTION' => 1, 'UNCOMMITTED' => 1, 'CATALOG_NAME' => 1, 'CLASS_ORIGIN' => 1, 'DEFAULT_AUTH' => 1, 'DES_KEY_FILE' => 1, 'INITIAL_SIZE' => 1, 'MASTER_DELAY' => 1, 'MESSAGE_TEXT' => 1, 'PARTITIONING' => 1, 'RELAY_THREAD' => 1, 'SERIALIZABLE' => 1, 'SQL_NO_CACHE' => 1, 'SQL_TSI_HOUR' => 1, 'SQL_TSI_WEEK' => 1, 'SQL_TSI_YEAR' => 1, 'SUBPARTITION' => 1, 'COLUMN_FORMAT' => 1, 'INSERT_METHOD' => 1, 'MASTER_SSL_CA' => 1, 'RELAY_LOG_POS' => 1, 'SQL_TSI_MONTH' => 1, 'SUBPARTITIONS' => 1, 'AUTO_INCREMENT' => 1, 'AVG_ROW_LENGTH' => 1, 'KEY_BLOCK_SIZE' => 1, 'MASTER_LOG_POS' => 1, 'MASTER_SSL_CRL' => 1, 'MASTER_SSL_KEY' => 1, 'RELAY_LOG_FILE' => 1, 'SQL_TSI_MINUTE' => 1, 'SQL_TSI_SECOND' => 1, 'TABLE_CHECKSUM' => 1, 'USER_RESOURCES' => 1, 'AUTOEXTEND_SIZE' => 1, 'CONSTRAINT_NAME' => 1, 'DELAY_KEY_WRITE' => 1, 'FILE_BLOCK_SIZE' => 1, 'MASTER_LOG_FILE' => 1, 'MASTER_PASSWORD' => 1, 'MASTER_SSL_CERT' => 1, 'PARSE_GCOL_EXPR' => 1, 'REPLICATE_DO_DB' => 1, 'SQL_AFTER_GTIDS' => 1, 'SQL_TSI_QUARTER' => 1, 'SUBCLASS_ORIGIN' => 1, 'MASTER_SERVER_ID' => 1, 'REDO_BUFFER_SIZE' => 1, 'SQL_BEFORE_GTIDS' => 1, 'STATS_PERSISTENT' => 1, 'UNDO_BUFFER_SIZE' => 1, 'CONSTRAINT_SCHEMA' => 1, 'GROUP_REPLICATION' => 1, 'IGNORE_SERVER_IDS' => 1, 'MASTER_SSL_CAPATH' => 1, 'MASTER_SSL_CIPHER' => 1, 'RETURNED_SQLSTATE' => 1, 'SQL_BUFFER_RESULT' => 1, 'STATS_AUTO_RECALC' => 1, 'CONSTRAINT_CATALOG' => 1, 'MASTER_RETRY_COUNT' => 1, 'MASTER_SSL_CRLPATH' => 1, 'MAX_STATEMENT_TIME' => 1, 'REPLICATE_DO_TABLE' => 1, 'SQL_AFTER_MTS_GAPS' => 1, 'STATS_SAMPLE_PAGES' => 1, 'REPLICATE_IGNORE_DB' => 1, 'MASTER_AUTO_POSITION' => 1, 'MASTER_CONNECT_RETRY' => 1, 'MAX_QUERIES_PER_HOUR' => 1, 'MAX_UPDATES_PER_HOUR' => 1, 'MAX_USER_CONNECTIONS' => 1, 'REPLICATE_REWRITE_DB' => 1, 'REPLICATE_IGNORE_TABLE' => 1, 'MASTER_HEARTBEAT_PERIOD' => 1, 'REPLICATE_WILD_DO_TABLE' => 1, 'MAX_CONNECTIONS_PER_HOUR' => 1, 'REPLICATE_WILD_IGNORE_TABLE' => 1, 'AS' => 3, 'BY' => 3, 'IS' => 3, 'ON' => 3, 'OR' => 3, 'TO' => 3, 'ADD' => 3, 'ALL' => 3, 'AND' => 3, 'ASC' => 3, 'DEC' => 3, 'DIV' => 3, 'FOR' => 3, 'GET' => 3, 'NOT' => 3, 'OUT' => 3, 'SQL' => 3, 'SSL' => 3, 'USE' => 3, 'XOR' => 3, 'BOTH' => 3, 'CALL' => 3, 'CASE' => 3, 'DESC' => 3, 'DROP' => 3, 'DUAL' => 3, 'EACH' => 3, 'ELSE' => 3, 'EXIT' => 3, 'FROM' => 3, 'INT1' => 3, 'INT2' => 3, 'INT3' => 3, 'INT4' => 3, 'INT8' => 3, 'INTO' => 3, 'JOIN' => 3, 'KEYS' => 3, 'KILL' => 3, 'LIKE' => 3, 'LOAD' => 3, 'LOCK' => 3, 'LONG' => 3, 'LOOP' => 3, 'NULL' => 3, 'READ' => 3, 'SHOW' => 3, 'THEN' => 3, 'TRUE' => 3, 'UNDO' => 3, 'WHEN' => 3, 'WITH' => 3, 'ALTER' => 3, 'CHECK' => 3, 'CROSS' => 3, 'FALSE' => 3, 'FETCH' => 3, 'FORCE' => 3, 'GRANT' => 3, 'GROUP' => 3, 'INNER' => 3, 'INOUT' => 3, 'LEAVE' => 3, 'LIMIT' => 3, 'LINES' => 3, 'ORDER' => 3, 'OUTER' => 3, 'PURGE' => 3, 'RANGE' => 3, 'READS' => 3, 'RLIKE' => 3, 'TABLE' => 3, 'UNION' => 3, 'USAGE' => 3, 'USING' => 3, 'WHERE' => 3, 'WHILE' => 3, 'WRITE' => 3, 'BEFORE' => 3, 'CHANGE' => 3, 'COLUMN' => 3, 'CREATE' => 3, 'CURSOR' => 3, 'DELETE' => 3, 'ELSEIF' => 3, 'EXISTS' => 3, 'FLOAT4' => 3, 'FLOAT8' => 3, 'HAVING' => 3, 'IGNORE' => 3, 'INFILE' => 3, 'LINEAR' => 3, 'OPTION' => 3, 'REGEXP' => 3, 'RENAME' => 3, 'RETURN' => 3, 'REVOKE' => 3, 'SELECT' => 3, 'SIGNAL' => 3, 'STORED' => 3, 'UNLOCK' => 3, 'UPDATE' => 3, 'ANALYZE' => 3, 'BETWEEN' => 3, 'CASCADE' => 3, 'COLLATE' => 3, 'DECLARE' => 3, 'DELAYED' => 3, 'ESCAPED' => 3, 'EXPLAIN' => 3, 'FOREIGN' => 3, 'ITERATE' => 3, 'LEADING' => 3, 'NATURAL' => 3, 'OUTFILE' => 3, 'PRIMARY' => 3, 'RELEASE' => 3, 'REQUIRE' => 3, 'SCHEMAS' => 3, 'TRIGGER' => 3, 'VARYING' => 3, 'VIRTUAL' => 3, 'CONTINUE' => 3, 'DAY_HOUR' => 3, 'DESCRIBE' => 3, 'DISTINCT' => 3, 'ENCLOSED' => 3, 'MAXVALUE' => 3, 'MODIFIES' => 3, 'OPTIMIZE' => 3, 'RESIGNAL' => 3, 'RESTRICT' => 3, 'SPECIFIC' => 3, 'SQLSTATE' => 3, 'STARTING' => 3, 'TRAILING' => 3, 'UNSIGNED' => 3, 'ZEROFILL' => 3, 'CONDITION' => 3, 'DATABASES' => 3, 'GENERATED' => 3, 'MIDDLEINT' => 3, 'PARTITION' => 3, 'PRECISION' => 3, 'PROCEDURE' => 3, 'SENSITIVE' => 3, 'SEPARATOR' => 3, 'ACCESSIBLE' => 3, 'ASENSITIVE' => 3, 'CONSTRAINT' => 3, 'DAY_MINUTE' => 3, 'DAY_SECOND' => 3, 'OPTIONALLY' => 3, 'READ_WRITE' => 3, 'REFERENCES' => 3, 'SQLWARNING' => 3, 'TERMINATED' => 3, 'YEAR_MONTH' => 3, 'DISTINCTROW' => 3, 'HOUR_MINUTE' => 3, 'HOUR_SECOND' => 3, 'INSENSITIVE' => 3, 'MASTER_BIND' => 3, 'LOW_PRIORITY' => 3, 'SQLEXCEPTION' => 3, 'VARCHARACTER' => 3, 'DETERMINISTIC' => 3, 'HIGH_PRIORITY' => 3, 'MINUTE_SECOND' => 3, 'STRAIGHT_JOIN' => 3, 'IO_AFTER_GTIDS' => 3, 'SQL_BIG_RESULT' => 3, 'DAY_MICROSECOND' => 3, 'IO_BEFORE_GTIDS' => 3, 'OPTIMIZER_COSTS' => 3, 'HOUR_MICROSECOND' => 3, 'SQL_SMALL_RESULT' => 3, 'MINUTE_MICROSECOND' => 3, 'NO_WRITE_TO_BINLOG' => 3, 'SECOND_MICROSECOND' => 3, 'SQL_CALC_FOUND_ROWS' => 3, 'MASTER_SSL_VERIFY_SERVER_CERT' => 3, 'GROUP BY' => 7, 'NOT NULL' => 7, 'ORDER BY' => 7, 'SET NULL' => 7, 'AND CHAIN' => 7, 'FULL JOIN' => 7, 'IF EXISTS' => 7, 'LEFT JOIN' => 7, 'LESS THAN' => 7, 'LOAD DATA' => 7, 'NO ACTION' => 7, 'ON DELETE' => 7, 'ON UPDATE' => 7, 'UNION ALL' => 7, 'CROSS JOIN' => 7, 'ESCAPED BY' => 7, 'FOR UPDATE' => 7, 'INNER JOIN' => 7, 'LINEAR KEY' => 7, 'NO RELEASE' => 7, 'OR REPLACE' => 7, 'RIGHT JOIN' => 7, 'ENCLOSED BY' => 7, 'LINEAR HASH' => 7, 'STARTING BY' => 7, 'AND NO CHAIN' => 7, 'FOR EACH ROW' => 7, 'NATURAL JOIN' => 7, 'PARTITION BY' => 7, 'SET PASSWORD' => 7, 'SQL SECURITY' => 7, 'CHARACTER SET' => 7, 'IF NOT EXISTS' => 7, 'TERMINATED BY' => 7, 'DATA DIRECTORY' => 7, 'UNION DISTINCT' => 7, 'DEFAULT CHARSET' => 7, 'DEFAULT COLLATE' => 7, 'FULL OUTER JOIN' => 7, 'INDEX DIRECTORY' => 7, 'LEFT OUTER JOIN' => 7, 'SUBPARTITION BY' => 7, 'GENERATED ALWAYS' => 7, 'RIGHT OUTER JOIN' => 7, 'NATURAL LEFT JOIN' => 7, 'START TRANSACTION' => 7, 'LOCK IN SHARE MODE' => 7, 'NATURAL RIGHT JOIN' => 7, 'SELECT TRANSACTION' => 7, 'DEFAULT CHARACTER SET' => 7, 'NATURAL LEFT OUTER JOIN' => 7, 'NATURAL RIGHT OUTER JOIN' => 7, 'WITH CONSISTENT SNAPSHOT' => 7, 'BIT' => 9, 'XML' => 9, 'ENUM' => 9, 'JSON' => 9, 'TEXT' => 9, 'ARRAY' => 9, 'SERIAL' => 9, 'BOOLEAN' => 9, 'DATETIME' => 9, 'GEOMETRY' => 9, 'MULTISET' => 9, 'MULTILINEPOINT' => 9, 'MULTILINEPOLYGON' => 9, 'INT' => 11, 'SET' => 11, 'BLOB' => 11, 'REAL' => 11, 'FLOAT' => 11, 'BIGINT' => 11, 'DOUBLE' => 11, 'DECIMAL' => 11, 'INTEGER' => 11, 'NUMERIC' => 11, 'TINYINT' => 11, 'VARCHAR' => 11, 'LONGBLOB' => 11, 'LONGTEXT' => 11, 'SMALLINT' => 11, 'TINYBLOB' => 11, 'TINYTEXT' => 11, 'CHARACTER' => 11, 'MEDIUMINT' => 11, 'VARBINARY' => 11, 'MEDIUMBLOB' => 11, 'MEDIUMTEXT' => 11, 'BINARY VARYING' => 15, 'KEY' => 19, 'INDEX' => 19, 'UNIQUE' => 19, 'SPATIAL' => 19, 'FULLTEXT' => 19, 'INDEX KEY' => 23, 'UNIQUE KEY' => 23, 'FOREIGN KEY' => 23, 'PRIMARY KEY' => 23, 'SPATIAL KEY' => 23, 'FULLTEXT KEY' => 23, 'UNIQUE INDEX' => 23, 'SPATIAL INDEX' => 23, 'FULLTEXT INDEX' => 23, 'X' => 33, 'Y' => 33, 'LN' => 33, 'PI' => 33, 'ABS' => 33, 'AVG' => 33, 'BIN' => 33, 'COS' => 33, 'COT' => 33, 'DAY' => 33, 'ELT' => 33, 'EXP' => 33, 'HEX' => 33, 'LOG' => 33, 'MAX' => 33, 'MD5' => 33, 'MID' => 33, 'MIN' => 33, 'NOW' => 33, 'OCT' => 33, 'ORD' => 33, 'POW' => 33, 'SHA' => 33, 'SIN' => 33, 'STD' => 33, 'SUM' => 33, 'TAN' => 33, 'ACOS' => 33, 'AREA' => 33, 'ASIN' => 33, 'ATAN' => 33, 'CAST' => 33, 'CEIL' => 33, 'CONV' => 33, 'HOUR' => 33, 'LOG2' => 33, 'LPAD' => 33, 'RAND' => 33, 'RPAD' => 33, 'SHA1' => 33, 'SHA2' => 33, 'SIGN' => 33, 'SQRT' => 33, 'SRID' => 33, 'ST_X' => 33, 'ST_Y' => 33, 'TRIM' => 33, 'USER' => 33, 'UUID' => 33, 'WEEK' => 33, 'ASCII' => 33, 'ASWKB' => 33, 'ASWKT' => 33, 'ATAN2' => 33, 'COUNT' => 33, 'CRC32' => 33, 'FIELD' => 33, 'FLOOR' => 33, 'INSTR' => 33, 'LCASE' => 33, 'LEAST' => 33, 'LOG10' => 33, 'LOWER' => 33, 'LTRIM' => 33, 'MONTH' => 33, 'POWER' => 33, 'QUOTE' => 33, 'ROUND' => 33, 'RTRIM' => 33, 'SLEEP' => 33, 'SPACE' => 33, 'UCASE' => 33, 'UNHEX' => 33, 'UPPER' => 33, 'ASTEXT' => 33, 'BIT_OR' => 33, 'BUFFER' => 33, 'CONCAT' => 33, 'DECODE' => 33, 'ENCODE' => 33, 'EQUALS' => 33, 'FORMAT' => 33, 'IFNULL' => 33, 'ISNULL' => 33, 'LENGTH' => 33, 'LOCATE' => 33, 'MINUTE' => 33, 'NULLIF' => 33, 'POINTN' => 33, 'SECOND' => 33, 'STDDEV' => 33, 'STRCMP' => 33, 'SUBSTR' => 33, 'WITHIN' => 33, 'ADDDATE' => 33, 'ADDTIME' => 33, 'AGAINST' => 33, 'BIT_AND' => 33, 'BIT_XOR' => 33, 'CEILING' => 33, 'CHARSET' => 33, 'CROSSES' => 33, 'CURDATE' => 33, 'CURTIME' => 33, 'DAYNAME' => 33, 'DEGREES' => 33, 'ENCRYPT' => 33, 'EXTRACT' => 33, 'GLENGTH' => 33, 'ISEMPTY' => 33, 'IS_IPV4' => 33, 'IS_IPV6' => 33, 'QUARTER' => 33, 'RADIANS' => 33, 'REVERSE' => 33, 'SOUNDEX' => 33, 'ST_AREA' => 33, 'ST_SRID' => 33, 'SUBDATE' => 33, 'SUBTIME' => 33, 'SYSDATE' => 33, 'TOUCHES' => 33, 'TO_DAYS' => 33, 'VAR_POP' => 33, 'VERSION' => 33, 'WEEKDAY' => 33, 'ASBINARY' => 33, 'CENTROID' => 33, 'COALESCE' => 33, 'COMPRESS' => 33, 'CONTAINS' => 33, 'DATEDIFF' => 33, 'DATE_ADD' => 33, 'DATE_SUB' => 33, 'DISJOINT' => 33, 'DISTANCE' => 33, 'ENDPOINT' => 33, 'ENVELOPE' => 33, 'GET_LOCK' => 33, 'GREATEST' => 33, 'ISCLOSED' => 33, 'ISSIMPLE' => 33, 'JSON_SET' => 33, 'MAKEDATE' => 33, 'MAKETIME' => 33, 'MAKE_SET' => 33, 'MBREQUAL' => 33, 'OVERLAPS' => 33, 'PASSWORD' => 33, 'POSITION' => 33, 'ST_ASWKB' => 33, 'ST_ASWKT' => 33, 'ST_UNION' => 33, 'TIMEDIFF' => 33, 'TRUNCATE' => 33, 'VARIANCE' => 33, 'VAR_SAMP' => 33, 'YEARWEEK' => 33, 'ANY_VALUE' => 33, 'BENCHMARK' => 33, 'BIT_COUNT' => 33, 'COLLATION' => 33, 'CONCAT_WS' => 33, 'DAYOFWEEK' => 33, 'DAYOFYEAR' => 33, 'DIMENSION' => 33, 'FROM_DAYS' => 33, 'GEOMETRYN' => 33, 'INET_ATON' => 33, 'INET_NTOA' => 33, 'JSON_KEYS' => 33, 'JSON_TYPE' => 33, 'LOAD_FILE' => 33, 'MBRCOVERS' => 33, 'MBREQUALS' => 33, 'MBRWITHIN' => 33, 'MONTHNAME' => 33, 'NUMPOINTS' => 33, 'ROW_COUNT' => 33, 'ST_ASTEXT' => 33, 'ST_BUFFER' => 33, 'ST_EQUALS' => 33, 'ST_LENGTH' => 33, 'ST_POINTN' => 33, 'ST_WITHIN' => 33, 'SUBSTRING' => 33, 'TO_BASE64' => 33, 'UPDATEXML' => 33, 'BIT_LENGTH' => 33, 'CONVERT_TZ' => 33, 'CONVEXHULL' => 33, 'DAYOFMONTH' => 33, 'EXPORT_SET' => 33, 'FOUND_ROWS' => 33, 'GET_FORMAT' => 33, 'INET6_ATON' => 33, 'INET6_NTOA' => 33, 'INTERSECTS' => 33, 'JSON_ARRAY' => 33, 'JSON_DEPTH' => 33, 'JSON_MERGE' => 33, 'JSON_QUOTE' => 33, 'JSON_VALID' => 33, 'MBRTOUCHES' => 33, 'MULTIPOINT' => 33, 'NAME_CONST' => 33, 'PERIOD_ADD' => 33, 'STARTPOINT' => 33, 'STDDEV_POP' => 33, 'ST_CROSSES' => 33, 'ST_GEOHASH' => 33, 'ST_ISEMPTY' => 33, 'ST_ISVALID' => 33, 'ST_TOUCHES' => 33, 'TO_SECONDS' => 33, 'UNCOMPRESS' => 33, 'UUID_SHORT' => 33, 'WEEKOFYEAR' => 33, 'AES_DECRYPT' => 33, 'AES_ENCRYPT' => 33, 'CHAR_LENGTH' => 33, 'DATE_FORMAT' => 33, 'DES_DECRYPT' => 33, 'DES_ENCRYPT' => 33, 'FIND_IN_SET' => 33, 'FROM_BASE64' => 33, 'GEOMFROMWKB' => 33, 'GTID_SUBSET' => 33, 'JSON_INSERT' => 33, 'JSON_LENGTH' => 33, 'JSON_OBJECT' => 33, 'JSON_PRETTY' => 33, 'JSON_REMOVE' => 33, 'JSON_SEARCH' => 33, 'LINEFROMWKB' => 33, 'MBRCONTAINS' => 33, 'MBRDISJOINT' => 33, 'MBROVERLAPS' => 33, 'MICROSECOND' => 33, 'PERIOD_DIFF' => 33, 'POLYFROMWKB' => 33, 'SEC_TO_TIME' => 33, 'STDDEV_SAMP' => 33, 'STR_TO_DATE' => 33, 'ST_ASBINARY' => 33, 'ST_CENTROID' => 33, 'ST_CONTAINS' => 33, 'ST_DISJOINT' => 33, 'ST_DISTANCE' => 33, 'ST_ENDPOINT' => 33, 'ST_ENVELOPE' => 33, 'ST_ISCLOSED' => 33, 'ST_ISSIMPLE' => 33, 'ST_OVERLAPS' => 33, 'ST_SIMPLIFY' => 33, 'ST_VALIDATE' => 33, 'SYSTEM_USER' => 33, 'TIME_FORMAT' => 33, 'TIME_TO_SEC' => 33, 'COERCIBILITY' => 33, 'EXTERIORRING' => 33, 'EXTRACTVALUE' => 33, 'GEOMETRYTYPE' => 33, 'GEOMFROMTEXT' => 33, 'GROUP_CONCAT' => 33, 'IS_FREE_LOCK' => 33, 'IS_USED_LOCK' => 33, 'JSON_EXTRACT' => 33, 'JSON_REPLACE' => 33, 'JSON_UNQUOTE' => 33, 'LINEFROMTEXT' => 33, 'MBRCOVEREDBY' => 33, 'MLINEFROMWKB' => 33, 'MPOLYFROMWKB' => 33, 'MULTIPOLYGON' => 33, 'OCTET_LENGTH' => 33, 'OLD_PASSWORD' => 33, 'POINTFROMWKB' => 33, 'POLYFROMTEXT' => 33, 'RANDOM_BYTES' => 33, 'RELEASE_LOCK' => 33, 'SESSION_USER' => 33, 'ST_ASGEOJSON' => 33, 'ST_DIMENSION' => 33, 'ST_GEOMETRYN' => 33, 'ST_NUMPOINTS' => 33, 'TIMESTAMPADD' => 33, 'CONNECTION_ID' => 33, 'FROM_UNIXTIME' => 33, 'GTID_SUBTRACT' => 33, 'INTERIORRINGN' => 33, 'JSON_CONTAINS' => 33, 'MBRINTERSECTS' => 33, 'MLINEFROMTEXT' => 33, 'MPOINTFROMWKB' => 33, 'MPOLYFROMTEXT' => 33, 'NUMGEOMETRIES' => 33, 'POINTFROMTEXT' => 33, 'ST_CONVEXHULL' => 33, 'ST_DIFFERENCE' => 33, 'ST_INTERSECTS' => 33, 'ST_STARTPOINT' => 33, 'TIMESTAMPDIFF' => 33, 'WEIGHT_STRING' => 33, 'IS_IPV4_COMPAT' => 33, 'IS_IPV4_MAPPED' => 33, 'LAST_INSERT_ID' => 33, 'MPOINTFROMTEXT' => 33, 'POLYGONFROMWKB' => 33, 'ST_GEOMFROMWKB' => 33, 'ST_LINEFROMWKB' => 33, 'ST_POLYFROMWKB' => 33, 'UNIX_TIMESTAMP' => 33, 'GEOMCOLLFROMWKB' => 33, 'MASTER_POS_WAIT' => 33, 'POLYGONFROMTEXT' => 33, 'ST_EXTERIORRING' => 33, 'ST_GEOMETRYTYPE' => 33, 'ST_GEOMFROMTEXT' => 33, 'ST_INTERSECTION' => 33, 'ST_LINEFROMTEXT' => 33, 'ST_MAKEENVELOPE' => 33, 'ST_MLINEFROMWKB' => 33, 'ST_MPOLYFROMWKB' => 33, 'ST_POINTFROMWKB' => 33, 'ST_POLYFROMTEXT' => 33, 'SUBSTRING_INDEX' => 33, 'CHARACTER_LENGTH' => 33, 'GEOMCOLLFROMTEXT' => 33, 'GEOMETRYFROMTEXT' => 33, 'JSON_MERGE_PATCH' => 33, 'NUMINTERIORRINGS' => 33, 'ST_INTERIORRINGN' => 33, 'ST_MLINEFROMTEXT' => 33, 'ST_MPOINTFROMWKB' => 33, 'ST_MPOLYFROMTEXT' => 33, 'ST_NUMGEOMETRIES' => 33, 'ST_POINTFROMTEXT' => 33, 'ST_SYMDIFFERENCE' => 33, 'JSON_ARRAY_APPEND' => 33, 'JSON_ARRAY_INSERT' => 33, 'JSON_STORAGE_FREE' => 33, 'JSON_STORAGE_SIZE' => 33, 'LINESTRINGFROMWKB' => 33, 'MULTIPOINTFROMWKB' => 33, 'RELEASE_ALL_LOCKS' => 33, 'ST_LATFROMGEOHASH' => 33, 'ST_MPOINTFROMTEXT' => 33, 'ST_POLYGONFROMWKB' => 33, 'JSON_CONTAINS_PATH' => 33, 'MULTIPOINTFROMTEXT' => 33, 'ST_BUFFER_STRATEGY' => 33, 'ST_DISTANCE_SPHERE' => 33, 'ST_GEOMCOLLFROMTXT' => 33, 'ST_GEOMCOLLFROMWKB' => 33, 'ST_GEOMFROMGEOJSON' => 33, 'ST_LONGFROMGEOHASH' => 33, 'ST_POLYGONFROMTEXT' => 33, 'JSON_MERGE_PRESERVE' => 33, 'MULTIPOLYGONFROMWKB' => 33, 'ST_GEOMCOLLFROMTEXT' => 33, 'ST_GEOMETRYFROMTEXT' => 33, 'ST_NUMINTERIORRINGS' => 33, 'ST_POINTFROMGEOHASH' => 33, 'UNCOMPRESSED_LENGTH' => 33, 'MULTIPOLYGONFROMTEXT' => 33, 'ST_LINESTRINGFROMWKB' => 33, 'ST_MULTIPOINTFROMWKB' => 33, 'ST_MULTIPOINTFROMTEXT' => 33, 'MULTILINESTRINGFROMWKB' => 33, 'ST_MULTIPOLYGONFROMWKB' => 33, 'MULTILINESTRINGFROMTEXT' => 33, 'ST_MULTIPOLYGONFROMTEXT' => 33, 'GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_MULTILINESTRINGFROMWKB' => 33, 'GEOMETRYCOLLECTIONFROMTEXT' => 33, 'ST_MULTILINESTRINGFROMTEXT' => 33, 'VALIDATE_PASSWORD_STRENGTH' => 33, 'WAIT_FOR_EXECUTED_GTID_SET' => 33, 'ST_GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_GEOMETRYCOLLECTIONFROMTEXT' => 33, 'WAIT_UNTIL_SQL_THREAD_AFTER_GTIDS' => 33, 'IF' => 35, 'IN' => 35, 'MOD' => 35, 'LEFT' => 35, 'MATCH' => 35, 'RIGHT' => 35, 'INSERT' => 35, 'REPEAT' => 35, 'SCHEMA' => 35, 'VALUES' => 35, 'CONVERT' => 35, 'DEFAULT' => 35, 'REPLACE' => 35, 'DATABASE' => 35, 'UTC_DATE' => 35, 'UTC_TIME' => 35, 'LOCALTIME' => 35, 'CURRENT_DATE' => 35, 'CURRENT_TIME' => 35, 'CURRENT_USER' => 35, 'UTC_TIMESTAMP' => 35, 'LOCALTIMESTAMP' => 35, 'CURRENT_TIMESTAMP' => 35, 'NOT IN' => 39, 'DATE' => 41, 'TIME' => 41, 'YEAR' => 41, 'POINT' => 41, 'POLYGON' => 41, 'TIMESTAMP' => 41, 'LINESTRING' => 41, 'MULTILINESTRING' => 41, 'GEOMETRYCOLLECTION' => 41, 'CHAR' => 43, 'BINARY' => 43, 'INTERVAL' => 43);
}
/**
* Context for MariaDB 10.0.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextMariaDb100000 extends \PhpMyAdmin\SqlParser\Context
{
/**
* List of keywords.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* @var array
*/
public static $KEYWORDS = array('AT' => 1, 'DO' => 1, 'IO' => 1, 'NO' => 1, 'XA' => 1, 'ANY' => 1, 'CPU' => 1, 'END' => 1, 'IPC' => 1, 'NDB' => 1, 'NEW' => 1, 'ONE' => 1, 'ROW' => 1, 'BOOL' => 1, 'BYTE' => 1, 'CODE' => 1, 'CUBE' => 1, 'DATA' => 1, 'DISK' => 1, 'ENDS' => 1, 'FAST' => 1, 'FILE' => 1, 'FULL' => 1, 'HASH' => 1, 'HELP' => 1, 'HOST' => 1, 'LAST' => 1, 'LESS' => 1, 'LIST' => 1, 'LOGS' => 1, 'MODE' => 1, 'NAME' => 1, 'NEXT' => 1, 'NONE' => 1, 'OPEN' => 1, 'PAGE' => 1, 'PORT' => 1, 'PREV' => 1, 'ROWS' => 1, 'SLOW' => 1, 'SOME' => 1, 'STOP' => 1, 'THAN' => 1, 'TYPE' => 1, 'VIEW' => 1, 'WAIT' => 1, 'WORK' => 1, 'X509' => 1, 'AFTER' => 1, 'BEGIN' => 1, 'BLOCK' => 1, 'BTREE' => 1, 'CACHE' => 1, 'CHAIN' => 1, 'CLOSE' => 1, 'ERROR' => 1, 'EVENT' => 1, 'EVERY' => 1, 'FIRST' => 1, 'FIXED' => 1, 'FLUSH' => 1, 'FOUND' => 1, 'HOSTS' => 1, 'LEVEL' => 1, 'LOCAL' => 1, 'LOCKS' => 1, 'MERGE' => 1, 'MUTEX' => 1, 'NAMES' => 1, 'NCHAR' => 1, 'OWNER' => 1, 'PHASE' => 1, 'PROXY' => 1, 'QUERY' => 1, 'QUICK' => 1, 'RELAY' => 1, 'RESET' => 1, 'RTREE' => 1, 'SHARE' => 1, 'SLAVE' => 1, 'START' => 1, 'SUPER' => 1, 'SWAPS' => 1, 'TYPES' => 1, 'UNTIL' => 1, 'VALUE' => 1, 'ACTION' => 1, 'BACKUP' => 1, 'BINLOG' => 1, 'CIPHER' => 1, 'CLIENT' => 1, 'COMMIT' => 1, 'ENABLE' => 1, 'ENGINE' => 1, 'ERRORS' => 1, 'ESCAPE' => 1, 'EVENTS' => 1, 'FAULTS' => 1, 'FIELDS' => 1, 'GLOBAL' => 1, 'GRANTS' => 1, 'IMPORT' => 1, 'INNODB' => 1, 'ISSUER' => 1, 'LEAVES' => 1, 'MASTER' => 1, 'MEDIUM' => 1, 'MEMORY' => 1, 'MODIFY' => 1, 'OFFSET' => 1, 'PARSER' => 1, 'PLUGIN' => 1, 'RELOAD' => 1, 'REMOVE' => 1, 'REPAIR' => 1, 'RESUME' => 1, 'ROLLUP' => 1, 'SERVER' => 1, 'SIGNED' => 1, 'SIMPLE' => 1, 'SOCKET' => 1, 'SONAME' => 1, 'SOUNDS' => 1, 'SOURCE' => 1, 'STARTS' => 1, 'STATUS' => 1, 'STRING' => 1, 'TABLES' => 1, 'AUTHORS' => 1, 'CHANGED' => 1, 'COLUMNS' => 1, 'COMMENT' => 1, 'COMPACT' => 1, 'CONTEXT' => 1, 'DEFINER' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DYNAMIC' => 1, 'ENGINES' => 1, 'EXECUTE' => 1, 'GENERAL' => 1, 'HANDLER' => 1, 'INDEXES' => 1, 'INSTALL' => 1, 'INVOKER' => 1, 'LOGFILE' => 1, 'MIGRATE' => 1, 'NO_WAIT' => 1, 'OPTIONS' => 1, 'PARTIAL' => 1, 'PLUGINS' => 1, 'PREPARE' => 1, 'PROFILE' => 1, 'REBUILD' => 1, 'RECOVER' => 1, 'RESTORE' => 1, 'RETURNS' => 1, 'ROUTINE' => 1, 'SESSION' => 1, 'STORAGE' => 1, 'SUBJECT' => 1, 'SUSPEND' => 1, 'UNICODE' => 1, 'UNKNOWN' => 1, 'UPGRADE' => 1, 'USE_FRM' => 1, 'VIRTUAL' => 1, 'WRAPPER' => 1, 'CASCADED' => 1, 'CHECKSUM' => 1, 'DATAFILE' => 1, 'DUMPFILE' => 1, 'EXTENDED' => 1, 'FUNCTION' => 1, 'INNOBASE' => 1, 'LANGUAGE' => 1, 'MAX_ROWS' => 1, 'MAX_SIZE' => 1, 'MIN_ROWS' => 1, 'NATIONAL' => 1, 'NVARCHAR' => 1, 'ONE_SHOT' => 1, 'PRESERVE' => 1, 'PROFILES' => 1, 'REDOFILE' => 1, 'RELAYLOG' => 1, 'ROLLBACK' => 1, 'SCHEDULE' => 1, 'SECURITY' => 1, 'SHUTDOWN' => 1, 'SNAPSHOT' => 1, 'SWITCHES' => 1, 'TRIGGERS' => 1, 'UNDOFILE' => 1, 'WARNINGS' => 1, 'AGGREGATE' => 1, 'ALGORITHM' => 1, 'COMMITTED' => 1, 'DIRECTORY' => 1, 'DUPLICATE' => 1, 'EXPANSION' => 1, 'IO_THREAD' => 1, 'ISOLATION' => 1, 'NODEGROUP' => 1, 'PACK_KEYS' => 1, 'READ_ONLY' => 1, 'REDUNDANT' => 1, 'SAVEPOINT' => 1, 'SQL_CACHE' => 1, 'TEMPORARY' => 1, 'TEMPTABLE' => 1, 'UNDEFINED' => 1, 'UNINSTALL' => 1, 'VARIABLES' => 1, 'COMPLETION' => 1, 'COMPRESSED' => 1, 'CONCURRENT' => 1, 'CONNECTION' => 1, 'CONSISTENT' => 1, 'DEALLOCATE' => 1, 'IDENTIFIED' => 1, 'MASTER_SSL' => 1, 'NDBCLUSTER' => 1, 'PARTITIONS' => 1, 'PERSISTENT' => 1, 'PRIVILEGES' => 1, 'REORGANIZE' => 1, 'REPEATABLE' => 1, 'ROW_FORMAT' => 1, 'SQL_THREAD' => 1, 'TABLESPACE' => 1, 'TABLE_NAME' => 1, 'COLUMN_NAME' => 1, 'CURSOR_NAME' => 1, 'EXTENT_SIZE' => 1, 'FRAC_SECOND' => 1, 'MASTER_HOST' => 1, 'MASTER_PORT' => 1, 'MASTER_USER' => 1, 'MYSQL_ERRNO' => 1, 'PROCESSLIST' => 1, 'REPLICATION' => 1, 'SCHEMA_NAME' => 1, 'SQL_TSI_DAY' => 1, 'TRANSACTION' => 1, 'UNCOMMITTED' => 1, 'CATALOG_NAME' => 1, 'CLASS_ORIGIN' => 1, 'CONTRIBUTORS' => 1, 'DES_KEY_FILE' => 1, 'INITIAL_SIZE' => 1, 'MESSAGE_TEXT' => 1, 'PARTITIONING' => 1, 'RELAY_THREAD' => 1, 'SERIALIZABLE' => 1, 'SQL_NO_CACHE' => 1, 'SQL_TSI_HOUR' => 1, 'SQL_TSI_WEEK' => 1, 'SQL_TSI_YEAR' => 1, 'SUBPARTITION' => 1, 'INSERT_METHOD' => 1, 'MASTER_SSL_CA' => 1, 'RELAY_LOG_POS' => 1, 'SQL_TSI_MONTH' => 1, 'SUBPARTITIONS' => 1, 'AUTO_INCREMENT' => 1, 'AVG_ROW_LENGTH' => 1, 'KEY_BLOCK_SIZE' => 1, 'MASTER_LOG_POS' => 1, 'MASTER_SSL_KEY' => 1, 'RELAY_LOG_FILE' => 1, 'SQL_TSI_MINUTE' => 1, 'SQL_TSI_SECOND' => 1, 'TABLE_CHECKSUM' => 1, 'USER_RESOURCES' => 1, 'AUTOEXTEND_SIZE' => 1, 'CONSTRAINT_NAME' => 1, 'DELAY_KEY_WRITE' => 1, 'MASTER_LOG_FILE' => 1, 'MASTER_PASSWORD' => 1, 'MASTER_SSL_CERT' => 1, 'SQL_TSI_QUARTER' => 1, 'SUBCLASS_ORIGIN' => 1, 'MASTER_SERVER_ID' => 1, 'REDO_BUFFER_SIZE' => 1, 'UNDO_BUFFER_SIZE' => 1, 'CONSTRAINT_SCHEMA' => 1, 'IGNORE_SERVER_IDS' => 1, 'MASTER_SSL_CAPATH' => 1, 'MASTER_SSL_CIPHER' => 1, 'SQL_BUFFER_RESULT' => 1, 'CONSTRAINT_CATALOG' => 1, 'SQL_TSI_FRAC_SECOND' => 1, 'MASTER_CONNECT_RETRY' => 1, 'MAX_QUERIES_PER_HOUR' => 1, 'MAX_UPDATES_PER_HOUR' => 1, 'MAX_USER_CONNECTIONS' => 1, 'MASTER_HEARTBEAT_PERIOD' => 1, 'MAX_CONNECTIONS_PER_HOUR' => 1, 'AS' => 3, 'BY' => 3, 'IS' => 3, 'ON' => 3, 'OR' => 3, 'TO' => 3, 'ADD' => 3, 'ALL' => 3, 'AND' => 3, 'ASC' => 3, 'DEC' => 3, 'DIV' => 3, 'FOR' => 3, 'NOT' => 3, 'OUT' => 3, 'SQL' => 3, 'SSL' => 3, 'USE' => 3, 'XOR' => 3, 'BOTH' => 3, 'CALL' => 3, 'CASE' => 3, 'DESC' => 3, 'DROP' => 3, 'DUAL' => 3, 'EACH' => 3, 'ELSE' => 3, 'EXIT' => 3, 'FROM' => 3, 'INT1' => 3, 'INT2' => 3, 'INT3' => 3, 'INT4' => 3, 'INT8' => 3, 'INTO' => 3, 'JOIN' => 3, 'KEYS' => 3, 'KILL' => 3, 'LIKE' => 3, 'LOAD' => 3, 'LOCK' => 3, 'LONG' => 3, 'LOOP' => 3, 'NULL' => 3, 'READ' => 3, 'SHOW' => 3, 'THEN' => 3, 'TRUE' => 3, 'UNDO' => 3, 'WHEN' => 3, 'WITH' => 3, 'ALTER' => 3, 'CHECK' => 3, 'CROSS' => 3, 'FALSE' => 3, 'FETCH' => 3, 'FORCE' => 3, 'GRANT' => 3, 'GROUP' => 3, 'INNER' => 3, 'INOUT' => 3, 'LEAVE' => 3, 'LIMIT' => 3, 'LINES' => 3, 'ORDER' => 3, 'OUTER' => 3, 'PURGE' => 3, 'RANGE' => 3, 'READS' => 3, 'RLIKE' => 3, 'TABLE' => 3, 'UNION' => 3, 'USAGE' => 3, 'USING' => 3, 'WHERE' => 3, 'WHILE' => 3, 'WRITE' => 3, 'BEFORE' => 3, 'CHANGE' => 3, 'COLUMN' => 3, 'CREATE' => 3, 'CURSOR' => 3, 'DELETE' => 3, 'ELSEIF' => 3, 'EXISTS' => 3, 'FLOAT4' => 3, 'FLOAT8' => 3, 'HAVING' => 3, 'IGNORE' => 3, 'INFILE' => 3, 'LINEAR' => 3, 'OPTION' => 3, 'REGEXP' => 3, 'RENAME' => 3, 'RETURN' => 3, 'REVOKE' => 3, 'SELECT' => 3, 'SIGNAL' => 3, 'UNLOCK' => 3, 'UPDATE' => 3, 'ANALYZE' => 3, 'BETWEEN' => 3, 'CASCADE' => 3, 'COLLATE' => 3, 'DECLARE' => 3, 'DELAYED' => 3, 'ESCAPED' => 3, 'EXPLAIN' => 3, 'FOREIGN' => 3, 'ITERATE' => 3, 'LEADING' => 3, 'NATURAL' => 3, 'OUTFILE' => 3, 'PRIMARY' => 3, 'RELEASE' => 3, 'REQUIRE' => 3, 'SCHEMAS' => 3, 'TRIGGER' => 3, 'VARYING' => 3, 'CONTINUE' => 3, 'DAY_HOUR' => 3, 'DESCRIBE' => 3, 'DISTINCT' => 3, 'ENCLOSED' => 3, 'MAXVALUE' => 3, 'MODIFIES' => 3, 'OPTIMIZE' => 3, 'RESIGNAL' => 3, 'RESTRICT' => 3, 'SPECIFIC' => 3, 'SQLSTATE' => 3, 'STARTING' => 3, 'TRAILING' => 3, 'UNSIGNED' => 3, 'ZEROFILL' => 3, 'CONDITION' => 3, 'DATABASES' => 3, 'MIDDLEINT' => 3, 'PARTITION' => 3, 'PRECISION' => 3, 'PROCEDURE' => 3, 'SENSITIVE' => 3, 'SEPARATOR' => 3, 'ACCESSIBLE' => 3, 'ASENSITIVE' => 3, 'CONSTRAINT' => 3, 'DAY_MINUTE' => 3, 'DAY_SECOND' => 3, 'OPTIONALLY' => 3, 'READ_WRITE' => 3, 'REFERENCES' => 3, 'SQLWARNING' => 3, 'TERMINATED' => 3, 'YEAR_MONTH' => 3, 'DISTINCTROW' => 3, 'HOUR_MINUTE' => 3, 'HOUR_SECOND' => 3, 'INSENSITIVE' => 3, 'LOW_PRIORITY' => 3, 'SQLEXCEPTION' => 3, 'VARCHARACTER' => 3, 'DETERMINISTIC' => 3, 'HIGH_PRIORITY' => 3, 'MINUTE_SECOND' => 3, 'STRAIGHT_JOIN' => 3, 'SQL_BIG_RESULT' => 3, 'DAY_MICROSECOND' => 3, 'HOUR_MICROSECOND' => 3, 'SQL_SMALL_RESULT' => 3, 'MINUTE_MICROSECOND' => 3, 'NO_WRITE_TO_BINLOG' => 3, 'SECOND_MICROSECOND' => 3, 'SQL_CALC_FOUND_ROWS' => 3, 'MASTER_SSL_VERIFY_SERVER_CERT' => 3, 'GROUP BY' => 7, 'NOT NULL' => 7, 'ORDER BY' => 7, 'SET NULL' => 7, 'AND CHAIN' => 7, 'FULL JOIN' => 7, 'IF EXISTS' => 7, 'LEFT JOIN' => 7, 'LESS THAN' => 7, 'LOAD DATA' => 7, 'NO ACTION' => 7, 'ON DELETE' => 7, 'ON UPDATE' => 7, 'UNION ALL' => 7, 'CROSS JOIN' => 7, 'ESCAPED BY' => 7, 'FOR UPDATE' => 7, 'INNER JOIN' => 7, 'LINEAR KEY' => 7, 'NO RELEASE' => 7, 'OR REPLACE' => 7, 'RIGHT JOIN' => 7, 'ENCLOSED BY' => 7, 'LINEAR HASH' => 7, 'STARTING BY' => 7, 'AND NO CHAIN' => 7, 'FOR EACH ROW' => 7, 'NATURAL JOIN' => 7, 'PARTITION BY' => 7, 'SET PASSWORD' => 7, 'SQL SECURITY' => 7, 'CHARACTER SET' => 7, 'IF NOT EXISTS' => 7, 'TERMINATED BY' => 7, 'DATA DIRECTORY' => 7, 'UNION DISTINCT' => 7, 'DEFAULT CHARSET' => 7, 'DEFAULT COLLATE' => 7, 'FULL OUTER JOIN' => 7, 'INDEX DIRECTORY' => 7, 'LEFT OUTER JOIN' => 7, 'SUBPARTITION BY' => 7, 'GENERATED ALWAYS' => 7, 'RIGHT OUTER JOIN' => 7, 'NATURAL LEFT JOIN' => 7, 'START TRANSACTION' => 7, 'LOCK IN SHARE MODE' => 7, 'NATURAL RIGHT JOIN' => 7, 'SELECT TRANSACTION' => 7, 'DEFAULT CHARACTER SET' => 7, 'NATURAL LEFT OUTER JOIN' => 7, 'NATURAL RIGHT OUTER JOIN' => 7, 'WITH CONSISTENT SNAPSHOT' => 7, 'BIT' => 9, 'XML' => 9, 'ENUM' => 9, 'JSON' => 9, 'TEXT' => 9, 'ARRAY' => 9, 'SERIAL' => 9, 'BOOLEAN' => 9, 'DATETIME' => 9, 'GEOMETRY' => 9, 'MULTISET' => 9, 'MULTILINEPOINT' => 9, 'MULTILINEPOLYGON' => 9, 'INT' => 11, 'SET' => 11, 'BLOB' => 11, 'REAL' => 11, 'FLOAT' => 11, 'BIGINT' => 11, 'DOUBLE' => 11, 'DECIMAL' => 11, 'INTEGER' => 11, 'NUMERIC' => 11, 'TINYINT' => 11, 'VARCHAR' => 11, 'LONGBLOB' => 11, 'LONGTEXT' => 11, 'SMALLINT' => 11, 'TINYBLOB' => 11, 'TINYTEXT' => 11, 'CHARACTER' => 11, 'MEDIUMINT' => 11, 'VARBINARY' => 11, 'MEDIUMBLOB' => 11, 'MEDIUMTEXT' => 11, 'BINARY VARYING' => 15, 'KEY' => 19, 'INDEX' => 19, 'UNIQUE' => 19, 'SPATIAL' => 19, 'FULLTEXT' => 19, 'INDEX KEY' => 23, 'UNIQUE KEY' => 23, 'FOREIGN KEY' => 23, 'PRIMARY KEY' => 23, 'SPATIAL KEY' => 23, 'FULLTEXT KEY' => 23, 'UNIQUE INDEX' => 23, 'SPATIAL INDEX' => 23, 'FULLTEXT INDEX' => 23, 'X' => 33, 'Y' => 33, 'LN' => 33, 'PI' => 33, 'ABS' => 33, 'AVG' => 33, 'BIN' => 33, 'COS' => 33, 'COT' => 33, 'DAY' => 33, 'ELT' => 33, 'EXP' => 33, 'HEX' => 33, 'LOG' => 33, 'MAX' => 33, 'MD5' => 33, 'MID' => 33, 'MIN' => 33, 'NOW' => 33, 'OCT' => 33, 'ORD' => 33, 'POW' => 33, 'SHA' => 33, 'SIN' => 33, 'STD' => 33, 'SUM' => 33, 'TAN' => 33, 'ACOS' => 33, 'AREA' => 33, 'ASIN' => 33, 'ATAN' => 33, 'CAST' => 33, 'CEIL' => 33, 'CONV' => 33, 'HOUR' => 33, 'LOG2' => 33, 'LPAD' => 33, 'RAND' => 33, 'RPAD' => 33, 'SHA1' => 33, 'SHA2' => 33, 'SIGN' => 33, 'SQRT' => 33, 'SRID' => 33, 'TRIM' => 33, 'USER' => 33, 'UUID' => 33, 'WEEK' => 33, 'ASCII' => 33, 'ASWKB' => 33, 'ASWKT' => 33, 'ATAN2' => 33, 'COUNT' => 33, 'CRC32' => 33, 'FIELD' => 33, 'FLOOR' => 33, 'INSTR' => 33, 'LCASE' => 33, 'LEAST' => 33, 'LOG10' => 33, 'LOWER' => 33, 'LTRIM' => 33, 'MONTH' => 33, 'POWER' => 33, 'QUOTE' => 33, 'ROUND' => 33, 'RTRIM' => 33, 'SLEEP' => 33, 'SPACE' => 33, 'UCASE' => 33, 'UNHEX' => 33, 'UPPER' => 33, 'ASTEXT' => 33, 'BIT_OR' => 33, 'CONCAT' => 33, 'DECODE' => 33, 'ENCODE' => 33, 'EQUALS' => 33, 'FORMAT' => 33, 'IFNULL' => 33, 'ISNULL' => 33, 'LENGTH' => 33, 'LOCATE' => 33, 'MINUTE' => 33, 'NULLIF' => 33, 'POINTN' => 33, 'SECOND' => 33, 'STDDEV' => 33, 'STRCMP' => 33, 'SUBSTR' => 33, 'WITHIN' => 33, 'ADDDATE' => 33, 'ADDTIME' => 33, 'AGAINST' => 33, 'BIT_AND' => 33, 'BIT_XOR' => 33, 'CEILING' => 33, 'CHARSET' => 33, 'CROSSES' => 33, 'CURDATE' => 33, 'CURTIME' => 33, 'DAYNAME' => 33, 'DEGREES' => 33, 'ENCRYPT' => 33, 'EXTRACT' => 33, 'GLENGTH' => 33, 'ISEMPTY' => 33, 'QUARTER' => 33, 'RADIANS' => 33, 'REVERSE' => 33, 'SOUNDEX' => 33, 'SUBDATE' => 33, 'SUBTIME' => 33, 'SYSDATE' => 33, 'TOUCHES' => 33, 'TO_DAYS' => 33, 'VAR_POP' => 33, 'VERSION' => 33, 'WEEKDAY' => 33, 'ASBINARY' => 33, 'CENTROID' => 33, 'COALESCE' => 33, 'COMPRESS' => 33, 'CONTAINS' => 33, 'DATEDIFF' => 33, 'DATE_ADD' => 33, 'DATE_SUB' => 33, 'DISJOINT' => 33, 'ENDPOINT' => 33, 'ENVELOPE' => 33, 'GET_LOCK' => 33, 'GREATEST' => 33, 'ISCLOSED' => 33, 'ISSIMPLE' => 33, 'MAKEDATE' => 33, 'MAKETIME' => 33, 'MAKE_SET' => 33, 'MBREQUAL' => 33, 'OVERLAPS' => 33, 'PASSWORD' => 33, 'POSITION' => 33, 'TIMEDIFF' => 33, 'TRUNCATE' => 33, 'VARIANCE' => 33, 'VAR_SAMP' => 33, 'YEARWEEK' => 33, 'BENCHMARK' => 33, 'BIT_COUNT' => 33, 'COLLATION' => 33, 'CONCAT_WS' => 33, 'DAYOFWEEK' => 33, 'DAYOFYEAR' => 33, 'DIMENSION' => 33, 'FROM_DAYS' => 33, 'GEOMETRYN' => 33, 'INET_ATON' => 33, 'INET_NTOA' => 33, 'LOAD_FILE' => 33, 'MBRWITHIN' => 33, 'MONTHNAME' => 33, 'NUMPOINTS' => 33, 'ROW_COUNT' => 33, 'SUBSTRING' => 33, 'UPDATEXML' => 33, 'BIT_LENGTH' => 33, 'CONVERT_TZ' => 33, 'DAYOFMONTH' => 33, 'EXPORT_SET' => 33, 'FOUND_ROWS' => 33, 'GET_FORMAT' => 33, 'INTERSECTS' => 33, 'MBRTOUCHES' => 33, 'MULTIPOINT' => 33, 'NAME_CONST' => 33, 'PERIOD_ADD' => 33, 'STARTPOINT' => 33, 'STDDEV_POP' => 33, 'TO_SECONDS' => 33, 'UNCOMPRESS' => 33, 'UUID_SHORT' => 33, 'WEEKOFYEAR' => 33, 'AES_DECRYPT' => 33, 'AES_ENCRYPT' => 33, 'CHAR_LENGTH' => 33, 'DATE_FORMAT' => 33, 'DES_DECRYPT' => 33, 'DES_ENCRYPT' => 33, 'FIND_IN_SET' => 33, 'GEOMFROMWKB' => 33, 'LINEFROMWKB' => 33, 'MBRCONTAINS' => 33, 'MBRDISJOINT' => 33, 'MBROVERLAPS' => 33, 'MICROSECOND' => 33, 'PERIOD_DIFF' => 33, 'POLYFROMWKB' => 33, 'SEC_TO_TIME' => 33, 'STDDEV_SAMP' => 33, 'STR_TO_DATE' => 33, 'SYSTEM_USER' => 33, 'TIME_FORMAT' => 33, 'TIME_TO_SEC' => 33, 'COERCIBILITY' => 33, 'EXTERIORRING' => 33, 'EXTRACTVALUE' => 33, 'GEOMETRYTYPE' => 33, 'GEOMFROMTEXT' => 33, 'GROUP_CONCAT' => 33, 'IS_FREE_LOCK' => 33, 'IS_USED_LOCK' => 33, 'LINEFROMTEXT' => 33, 'MLINEFROMWKB' => 33, 'MPOLYFROMWKB' => 33, 'MULTIPOLYGON' => 33, 'OCTET_LENGTH' => 33, 'OLD_PASSWORD' => 33, 'POINTFROMWKB' => 33, 'POLYFROMTEXT' => 33, 'RELEASE_LOCK' => 33, 'SESSION_USER' => 33, 'TIMESTAMPADD' => 33, 'CONNECTION_ID' => 33, 'FROM_UNIXTIME' => 33, 'INTERIORRINGN' => 33, 'MBRINTERSECTS' => 33, 'MLINEFROMTEXT' => 33, 'MPOINTFROMWKB' => 33, 'MPOLYFROMTEXT' => 33, 'NUMGEOMETRIES' => 33, 'POINTFROMTEXT' => 33, 'TIMESTAMPDIFF' => 33, 'LAST_INSERT_ID' => 33, 'MPOINTFROMTEXT' => 33, 'POLYGONFROMWKB' => 33, 'UNIX_TIMESTAMP' => 33, 'GEOMCOLLFROMWKB' => 33, 'MASTER_POS_WAIT' => 33, 'POLYGONFROMTEXT' => 33, 'SUBSTRING_INDEX' => 33, 'CHARACTER_LENGTH' => 33, 'GEOMCOLLFROMTEXT' => 33, 'GEOMETRYFROMTEXT' => 33, 'NUMINTERIORRINGS' => 33, 'LINESTRINGFROMWKB' => 33, 'MULTIPOINTFROMWKB' => 33, 'MULTIPOINTFROMTEXT' => 33, 'MULTIPOLYGONFROMWKB' => 33, 'UNCOMPRESSED_LENGTH' => 33, 'MULTIPOLYGONFROMTEXT' => 33, 'MULTILINESTRINGFROMWKB' => 33, 'MULTILINESTRINGFROMTEXT' => 33, 'GEOMETRYCOLLECTIONFROMWKB' => 33, 'GEOMETRYCOLLECTIONFROMTEXT' => 33, 'IF' => 35, 'IN' => 35, 'MOD' => 35, 'LEFT' => 35, 'MATCH' => 35, 'RIGHT' => 35, 'INSERT' => 35, 'REPEAT' => 35, 'SCHEMA' => 35, 'VALUES' => 35, 'CONVERT' => 35, 'DEFAULT' => 35, 'REPLACE' => 35, 'DATABASE' => 35, 'UTC_DATE' => 35, 'UTC_TIME' => 35, 'LOCALTIME' => 35, 'CURRENT_DATE' => 35, 'CURRENT_TIME' => 35, 'CURRENT_USER' => 35, 'UTC_TIMESTAMP' => 35, 'LOCALTIMESTAMP' => 35, 'CURRENT_TIMESTAMP' => 35, 'NOT IN' => 39, 'DATE' => 41, 'TIME' => 41, 'YEAR' => 41, 'POINT' => 41, 'POLYGON' => 41, 'TIMESTAMP' => 41, 'LINESTRING' => 41, 'MULTILINESTRING' => 41, 'GEOMETRYCOLLECTION' => 41, 'CHAR' => 43, 'BINARY' => 43, 'INTERVAL' => 43);
}
/**
* Context for MariaDB 10.2.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextMariaDb100200 extends \PhpMyAdmin\SqlParser\Context
{
/**
* List of keywords.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* @var array
*/
public static $KEYWORDS = array('AT' => 1, 'DO' => 1, 'IO' => 1, 'NO' => 1, 'XA' => 1, 'ANY' => 1, 'CPU' => 1, 'END' => 1, 'IPC' => 1, 'NDB' => 1, 'NEW' => 1, 'ONE' => 1, 'ROW' => 1, 'XID' => 1, 'BOOL' => 1, 'BYTE' => 1, 'CODE' => 1, 'CUBE' => 1, 'DATA' => 1, 'DISK' => 1, 'ENDS' => 1, 'FAST' => 1, 'FILE' => 1, 'FULL' => 1, 'HASH' => 1, 'HELP' => 1, 'HOST' => 1, 'LAST' => 1, 'LESS' => 1, 'LIST' => 1, 'LOGS' => 1, 'MODE' => 1, 'NAME' => 1, 'NEXT' => 1, 'NONE' => 1, 'ONLY' => 1, 'OPEN' => 1, 'PAGE' => 1, 'PORT' => 1, 'PREV' => 1, 'SLOW' => 1, 'SOME' => 1, 'STOP' => 1, 'THAN' => 1, 'TYPE' => 1, 'VIEW' => 1, 'WAIT' => 1, 'WORK' => 1, 'X509' => 1, 'AFTER' => 1, 'BEGIN' => 1, 'BLOCK' => 1, 'BTREE' => 1, 'CACHE' => 1, 'CHAIN' => 1, 'CLOSE' => 1, 'ERROR' => 1, 'EVENT' => 1, 'EVERY' => 1, 'FIRST' => 1, 'FIXED' => 1, 'FLUSH' => 1, 'FOUND' => 1, 'HOSTS' => 1, 'LEVEL' => 1, 'LOCAL' => 1, 'LOCKS' => 1, 'MERGE' => 1, 'MUTEX' => 1, 'NAMES' => 1, 'NCHAR' => 1, 'NEVER' => 1, 'OWNER' => 1, 'PHASE' => 1, 'PROXY' => 1, 'QUERY' => 1, 'QUICK' => 1, 'RELAY' => 1, 'RESET' => 1, 'RTREE' => 1, 'SHARE' => 1, 'SLAVE' => 1, 'START' => 1, 'SUPER' => 1, 'SWAPS' => 1, 'TYPES' => 1, 'UNTIL' => 1, 'VALUE' => 1, 'ACTION' => 1, 'ALWAYS' => 1, 'BACKUP' => 1, 'BINLOG' => 1, 'CIPHER' => 1, 'CLIENT' => 1, 'COMMIT' => 1, 'ENABLE' => 1, 'ENGINE' => 1, 'ERRORS' => 1, 'ESCAPE' => 1, 'EVENTS' => 1, 'EXPIRE' => 1, 'EXPORT' => 1, 'FAULTS' => 1, 'FIELDS' => 1, 'FILTER' => 1, 'GLOBAL' => 1, 'GRANTS' => 1, 'IMPORT' => 1, 'ISSUER' => 1, 'LEAVES' => 1, 'MASTER' => 1, 'MEDIUM' => 1, 'MEMORY' => 1, 'MODIFY' => 1, 'NUMBER' => 1, 'OFFSET' => 1, 'PARSER' => 1, 'PLUGIN' => 1, 'RELOAD' => 1, 'REMOVE' => 1, 'REPAIR' => 1, 'RESUME' => 1, 'ROLLUP' => 1, 'SERVER' => 1, 'SIGNED' => 1, 'SIMPLE' => 1, 'SOCKET' => 1, 'SONAME' => 1, 'SOUNDS' => 1, 'SOURCE' => 1, 'STARTS' => 1, 'STATUS' => 1, 'STRING' => 1, 'TABLES' => 1, 'ACCOUNT' => 1, 'ANALYSE' => 1, 'CHANGED' => 1, 'CHANNEL' => 1, 'COLUMNS' => 1, 'COMMENT' => 1, 'COMPACT' => 1, 'CONTEXT' => 1, 'CURRENT' => 1, 'DEFINER' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DYNAMIC' => 1, 'ENGINES' => 1, 'EXECUTE' => 1, 'FOLLOWS' => 1, 'GENERAL' => 1, 'HANDLER' => 1, 'INDEXES' => 1, 'INSTALL' => 1, 'INVOKER' => 1, 'LOGFILE' => 1, 'MIGRATE' => 1, 'NO_WAIT' => 1, 'OPTIONS' => 1, 'PARTIAL' => 1, 'PLUGINS' => 1, 'PREPARE' => 1, 'PROFILE' => 1, 'REBUILD' => 1, 'RECOVER' => 1, 'RESTORE' => 1, 'RETURNS' => 1, 'ROUTINE' => 1, 'SESSION' => 1, 'STACKED' => 1, 'STORAGE' => 1, 'SUBJECT' => 1, 'SUSPEND' => 1, 'UNICODE' => 1, 'UNKNOWN' => 1, 'UPGRADE' => 1, 'USE_FRM' => 1, 'WITHOUT' => 1, 'WRAPPER' => 1, 'CASCADED' => 1, 'CHECKSUM' => 1, 'DATAFILE' => 1, 'DUMPFILE' => 1, 'EXCHANGE' => 1, 'EXTENDED' => 1, 'FUNCTION' => 1, 'LANGUAGE' => 1, 'MAX_ROWS' => 1, 'MAX_SIZE' => 1, 'MIN_ROWS' => 1, 'NATIONAL' => 1, 'NVARCHAR' => 1, 'PRECEDES' => 1, 'PRESERVE' => 1, 'PROFILES' => 1, 'REDOFILE' => 1, 'RELAYLOG' => 1, 'ROLLBACK' => 1, 'SCHEDULE' => 1, 'SECURITY' => 1, 'SHUTDOWN' => 1, 'SNAPSHOT' => 1, 'SWITCHES' => 1, 'TRIGGERS' => 1, 'UNDOFILE' => 1, 'WARNINGS' => 1, 'AGGREGATE' => 1, 'ALGORITHM' => 1, 'COMMITTED' => 1, 'DIRECTORY' => 1, 'DUPLICATE' => 1, 'EXPANSION' => 1, 'IO_THREAD' => 1, 'ISOLATION' => 1, 'NODEGROUP' => 1, 'PACK_KEYS' => 1, 'READ_ONLY' => 1, 'REDUNDANT' => 1, 'SAVEPOINT' => 1, 'SQL_CACHE' => 1, 'TEMPORARY' => 1, 'TEMPTABLE' => 1, 'UNDEFINED' => 1, 'UNINSTALL' => 1, 'VARIABLES' => 1, 'COMPLETION' => 1, 'COMPRESSED' => 1, 'CONCURRENT' => 1, 'CONNECTION' => 1, 'CONSISTENT' => 1, 'DEALLOCATE' => 1, 'IDENTIFIED' => 1, 'MASTER_SSL' => 1, 'NDBCLUSTER' => 1, 'PARTITIONS' => 1, 'PERSISTENT' => 1, 'PLUGIN_DIR' => 1, 'PRIVILEGES' => 1, 'REORGANIZE' => 1, 'REPEATABLE' => 1, 'ROW_FORMAT' => 1, 'SQL_THREAD' => 1, 'TABLESPACE' => 1, 'TABLE_NAME' => 1, 'VALIDATION' => 1, 'COLUMN_NAME' => 1, 'COMPRESSION' => 1, 'CURSOR_NAME' => 1, 'DIAGNOSTICS' => 1, 'EXTENT_SIZE' => 1, 'MASTER_HOST' => 1, 'MASTER_PORT' => 1, 'MASTER_USER' => 1, 'MYSQL_ERRNO' => 1, 'NONBLOCKING' => 1, 'PROCESSLIST' => 1, 'REPLICATION' => 1, 'SCHEMA_NAME' => 1, 'SQL_TSI_DAY' => 1, 'TRANSACTION' => 1, 'UNCOMMITTED' => 1, 'CATALOG_NAME' => 1, 'CLASS_ORIGIN' => 1, 'DEFAULT_AUTH' => 1, 'DES_KEY_FILE' => 1, 'INITIAL_SIZE' => 1, 'MASTER_DELAY' => 1, 'MESSAGE_TEXT' => 1, 'PARTITIONING' => 1, 'RELAY_THREAD' => 1, 'SERIALIZABLE' => 1, 'SQL_NO_CACHE' => 1, 'SQL_TSI_HOUR' => 1, 'SQL_TSI_WEEK' => 1, 'SQL_TSI_YEAR' => 1, 'SUBPARTITION' => 1, 'COLUMN_FORMAT' => 1, 'INSERT_METHOD' => 1, 'MASTER_SSL_CA' => 1, 'RELAY_LOG_POS' => 1, 'SQL_TSI_MONTH' => 1, 'SUBPARTITIONS' => 1, 'AUTO_INCREMENT' => 1, 'AVG_ROW_LENGTH' => 1, 'KEY_BLOCK_SIZE' => 1, 'MASTER_LOG_POS' => 1, 'MASTER_SSL_CRL' => 1, 'MASTER_SSL_KEY' => 1, 'RELAY_LOG_FILE' => 1, 'SQL_TSI_MINUTE' => 1, 'SQL_TSI_SECOND' => 1, 'TABLE_CHECKSUM' => 1, 'USER_RESOURCES' => 1, 'AUTOEXTEND_SIZE' => 1, 'CONSTRAINT_NAME' => 1, 'DELAY_KEY_WRITE' => 1, 'FILE_BLOCK_SIZE' => 1, 'MASTER_LOG_FILE' => 1, 'MASTER_PASSWORD' => 1, 'MASTER_SSL_CERT' => 1, 'PARSE_GCOL_EXPR' => 1, 'REPLICATE_DO_DB' => 1, 'SQL_AFTER_GTIDS' => 1, 'SQL_TSI_QUARTER' => 1, 'SUBCLASS_ORIGIN' => 1, 'MASTER_SERVER_ID' => 1, 'REDO_BUFFER_SIZE' => 1, 'SQL_BEFORE_GTIDS' => 1, 'STATS_PERSISTENT' => 1, 'UNDO_BUFFER_SIZE' => 1, 'CONSTRAINT_SCHEMA' => 1, 'GROUP_REPLICATION' => 1, 'IGNORE_SERVER_IDS' => 1, 'MASTER_SSL_CAPATH' => 1, 'MASTER_SSL_CIPHER' => 1, 'RETURNED_SQLSTATE' => 1, 'SQL_BUFFER_RESULT' => 1, 'STATS_AUTO_RECALC' => 1, 'CONSTRAINT_CATALOG' => 1, 'MASTER_RETRY_COUNT' => 1, 'MASTER_SSL_CRLPATH' => 1, 'MAX_STATEMENT_TIME' => 1, 'REPLICATE_DO_TABLE' => 1, 'SQL_AFTER_MTS_GAPS' => 1, 'STATS_SAMPLE_PAGES' => 1, 'REPLICATE_IGNORE_DB' => 1, 'MASTER_AUTO_POSITION' => 1, 'MASTER_CONNECT_RETRY' => 1, 'MAX_QUERIES_PER_HOUR' => 1, 'MAX_UPDATES_PER_HOUR' => 1, 'MAX_USER_CONNECTIONS' => 1, 'REPLICATE_REWRITE_DB' => 1, 'REPLICATE_IGNORE_TABLE' => 1, 'MASTER_HEARTBEAT_PERIOD' => 1, 'REPLICATE_WILD_DO_TABLE' => 1, 'MAX_CONNECTIONS_PER_HOUR' => 1, 'REPLICATE_WILD_IGNORE_TABLE' => 1, 'AS' => 3, 'BY' => 3, 'IS' => 3, 'ON' => 3, 'OR' => 3, 'TO' => 3, 'ADD' => 3, 'ALL' => 3, 'AND' => 3, 'ASC' => 3, 'DEC' => 3, 'DIV' => 3, 'FOR' => 3, 'GET' => 3, 'NOT' => 3, 'OUT' => 3, 'SQL' => 3, 'SSL' => 3, 'USE' => 3, 'XOR' => 3, 'BOTH' => 3, 'CALL' => 3, 'CASE' => 3, 'DESC' => 3, 'DROP' => 3, 'DUAL' => 3, 'EACH' => 3, 'ELSE' => 3, 'EXIT' => 3, 'FROM' => 3, 'INT1' => 3, 'INT2' => 3, 'INT3' => 3, 'INT4' => 3, 'INT8' => 3, 'INTO' => 3, 'JOIN' => 3, 'KEYS' => 3, 'KILL' => 3, 'LIKE' => 3, 'LOAD' => 3, 'LOCK' => 3, 'LONG' => 3, 'LOOP' => 3, 'NULL' => 3, 'READ' => 3, 'ROWS' => 3, 'SHOW' => 3, 'THEN' => 3, 'TRUE' => 3, 'UNDO' => 3, 'WHEN' => 3, 'WITH' => 3, 'ALTER' => 3, 'CHECK' => 3, 'CROSS' => 3, 'FALSE' => 3, 'FETCH' => 3, 'FORCE' => 3, 'GRANT' => 3, 'GROUP' => 3, 'INNER' => 3, 'INOUT' => 3, 'LEAVE' => 3, 'LIMIT' => 3, 'LINES' => 3, 'ORDER' => 3, 'OUTER' => 3, 'PURGE' => 3, 'RANGE' => 3, 'READS' => 3, 'RLIKE' => 3, 'TABLE' => 3, 'UNION' => 3, 'USAGE' => 3, 'USING' => 3, 'WHERE' => 3, 'WHILE' => 3, 'WRITE' => 3, 'BEFORE' => 3, 'CHANGE' => 3, 'COLUMN' => 3, 'CREATE' => 3, 'CURSOR' => 3, 'DELETE' => 3, 'ELSEIF' => 3, 'EXISTS' => 3, 'FLOAT4' => 3, 'FLOAT8' => 3, 'HAVING' => 3, 'IGNORE' => 3, 'INFILE' => 3, 'LINEAR' => 3, 'OPTION' => 3, 'REGEXP' => 3, 'RENAME' => 3, 'RETURN' => 3, 'REVOKE' => 3, 'SELECT' => 3, 'SIGNAL' => 3, 'STORED' => 3, 'UNLOCK' => 3, 'UPDATE' => 3, 'ANALYZE' => 3, 'BETWEEN' => 3, 'CASCADE' => 3, 'COLLATE' => 3, 'DECLARE' => 3, 'DELAYED' => 3, 'ESCAPED' => 3, 'EXPLAIN' => 3, 'FOREIGN' => 3, 'ITERATE' => 3, 'LEADING' => 3, 'NATURAL' => 3, 'OUTFILE' => 3, 'PRIMARY' => 3, 'RELEASE' => 3, 'REQUIRE' => 3, 'SCHEMAS' => 3, 'TRIGGER' => 3, 'VARYING' => 3, 'VIRTUAL' => 3, 'CONTINUE' => 3, 'DAY_HOUR' => 3, 'DESCRIBE' => 3, 'DISTINCT' => 3, 'ENCLOSED' => 3, 'MAXVALUE' => 3, 'MODIFIES' => 3, 'OPTIMIZE' => 3, 'RESIGNAL' => 3, 'RESTRICT' => 3, 'SPECIFIC' => 3, 'SQLSTATE' => 3, 'STARTING' => 3, 'TRAILING' => 3, 'UNSIGNED' => 3, 'ZEROFILL' => 3, 'CONDITION' => 3, 'DATABASES' => 3, 'GENERATED' => 3, 'MIDDLEINT' => 3, 'PARTITION' => 3, 'PRECISION' => 3, 'PROCEDURE' => 3, 'RECURSIVE' => 3, 'SENSITIVE' => 3, 'SEPARATOR' => 3, 'ACCESSIBLE' => 3, 'ASENSITIVE' => 3, 'CONSTRAINT' => 3, 'DAY_MINUTE' => 3, 'DAY_SECOND' => 3, 'OPTIONALLY' => 3, 'READ_WRITE' => 3, 'REFERENCES' => 3, 'SQLWARNING' => 3, 'TERMINATED' => 3, 'YEAR_MONTH' => 3, 'DISTINCTROW' => 3, 'HOUR_MINUTE' => 3, 'HOUR_SECOND' => 3, 'INSENSITIVE' => 3, 'MASTER_BIND' => 3, 'LOW_PRIORITY' => 3, 'SQLEXCEPTION' => 3, 'VARCHARACTER' => 3, 'DETERMINISTIC' => 3, 'HIGH_PRIORITY' => 3, 'MINUTE_SECOND' => 3, 'STRAIGHT_JOIN' => 3, 'IO_AFTER_GTIDS' => 3, 'SQL_BIG_RESULT' => 3, 'DAY_MICROSECOND' => 3, 'IO_BEFORE_GTIDS' => 3, 'OPTIMIZER_COSTS' => 3, 'HOUR_MICROSECOND' => 3, 'SQL_SMALL_RESULT' => 3, 'MINUTE_MICROSECOND' => 3, 'NO_WRITE_TO_BINLOG' => 3, 'SECOND_MICROSECOND' => 3, 'SQL_CALC_FOUND_ROWS' => 3, 'MASTER_SSL_VERIFY_SERVER_CERT' => 3, 'GROUP BY' => 7, 'NOT NULL' => 7, 'ORDER BY' => 7, 'SET NULL' => 7, 'AND CHAIN' => 7, 'FULL JOIN' => 7, 'IF EXISTS' => 7, 'LEFT JOIN' => 7, 'LESS THAN' => 7, 'LOAD DATA' => 7, 'NO ACTION' => 7, 'ON DELETE' => 7, 'ON UPDATE' => 7, 'UNION ALL' => 7, 'CROSS JOIN' => 7, 'ESCAPED BY' => 7, 'FOR UPDATE' => 7, 'INNER JOIN' => 7, 'LINEAR KEY' => 7, 'NO RELEASE' => 7, 'OR REPLACE' => 7, 'RIGHT JOIN' => 7, 'ENCLOSED BY' => 7, 'LINEAR HASH' => 7, 'STARTING BY' => 7, 'AND NO CHAIN' => 7, 'FOR EACH ROW' => 7, 'NATURAL JOIN' => 7, 'PARTITION BY' => 7, 'SET PASSWORD' => 7, 'SQL SECURITY' => 7, 'CHARACTER SET' => 7, 'IF NOT EXISTS' => 7, 'TERMINATED BY' => 7, 'DATA DIRECTORY' => 7, 'UNION DISTINCT' => 7, 'DEFAULT CHARSET' => 7, 'DEFAULT COLLATE' => 7, 'FULL OUTER JOIN' => 7, 'INDEX DIRECTORY' => 7, 'LEFT OUTER JOIN' => 7, 'SUBPARTITION BY' => 7, 'GENERATED ALWAYS' => 7, 'RIGHT OUTER JOIN' => 7, 'NATURAL LEFT JOIN' => 7, 'START TRANSACTION' => 7, 'LOCK IN SHARE MODE' => 7, 'NATURAL RIGHT JOIN' => 7, 'SELECT TRANSACTION' => 7, 'DEFAULT CHARACTER SET' => 7, 'NATURAL LEFT OUTER JOIN' => 7, 'NATURAL RIGHT OUTER JOIN' => 7, 'WITH CONSISTENT SNAPSHOT' => 7, 'BIT' => 9, 'XML' => 9, 'ENUM' => 9, 'JSON' => 9, 'TEXT' => 9, 'ARRAY' => 9, 'SERIAL' => 9, 'BOOLEAN' => 9, 'DATETIME' => 9, 'GEOMETRY' => 9, 'MULTISET' => 9, 'MULTILINEPOINT' => 9, 'MULTILINEPOLYGON' => 9, 'INT' => 11, 'SET' => 11, 'BLOB' => 11, 'REAL' => 11, 'FLOAT' => 11, 'BIGINT' => 11, 'DOUBLE' => 11, 'DECIMAL' => 11, 'INTEGER' => 11, 'NUMERIC' => 11, 'TINYINT' => 11, 'VARCHAR' => 11, 'LONGBLOB' => 11, 'LONGTEXT' => 11, 'SMALLINT' => 11, 'TINYBLOB' => 11, 'TINYTEXT' => 11, 'CHARACTER' => 11, 'MEDIUMINT' => 11, 'VARBINARY' => 11, 'MEDIUMBLOB' => 11, 'MEDIUMTEXT' => 11, 'BINARY VARYING' => 15, 'KEY' => 19, 'INDEX' => 19, 'UNIQUE' => 19, 'SPATIAL' => 19, 'FULLTEXT' => 19, 'INDEX KEY' => 23, 'UNIQUE KEY' => 23, 'FOREIGN KEY' => 23, 'PRIMARY KEY' => 23, 'SPATIAL KEY' => 23, 'FULLTEXT KEY' => 23, 'UNIQUE INDEX' => 23, 'SPATIAL INDEX' => 23, 'FULLTEXT INDEX' => 23, 'X' => 33, 'Y' => 33, 'LN' => 33, 'PI' => 33, 'ABS' => 33, 'AVG' => 33, 'BIN' => 33, 'COS' => 33, 'COT' => 33, 'DAY' => 33, 'ELT' => 33, 'EXP' => 33, 'HEX' => 33, 'LOG' => 33, 'MAX' => 33, 'MD5' => 33, 'MID' => 33, 'MIN' => 33, 'NOW' => 33, 'OCT' => 33, 'ORD' => 33, 'POW' => 33, 'SHA' => 33, 'SIN' => 33, 'STD' => 33, 'SUM' => 33, 'TAN' => 33, 'ACOS' => 33, 'AREA' => 33, 'ASIN' => 33, 'ATAN' => 33, 'CAST' => 33, 'CEIL' => 33, 'CONV' => 33, 'HOUR' => 33, 'LOG2' => 33, 'LPAD' => 33, 'RAND' => 33, 'RPAD' => 33, 'SHA1' => 33, 'SHA2' => 33, 'SIGN' => 33, 'SQRT' => 33, 'SRID' => 33, 'ST_X' => 33, 'ST_Y' => 33, 'TRIM' => 33, 'USER' => 33, 'UUID' => 33, 'WEEK' => 33, 'ASCII' => 33, 'ASWKB' => 33, 'ASWKT' => 33, 'ATAN2' => 33, 'COUNT' => 33, 'CRC32' => 33, 'FIELD' => 33, 'FLOOR' => 33, 'INSTR' => 33, 'LCASE' => 33, 'LEAST' => 33, 'LOG10' => 33, 'LOWER' => 33, 'LTRIM' => 33, 'MONTH' => 33, 'POWER' => 33, 'QUOTE' => 33, 'ROUND' => 33, 'RTRIM' => 33, 'SLEEP' => 33, 'SPACE' => 33, 'UCASE' => 33, 'UNHEX' => 33, 'UPPER' => 33, 'ASTEXT' => 33, 'BIT_OR' => 33, 'BUFFER' => 33, 'CONCAT' => 33, 'DECODE' => 33, 'ENCODE' => 33, 'EQUALS' => 33, 'FORMAT' => 33, 'IFNULL' => 33, 'ISNULL' => 33, 'LENGTH' => 33, 'LOCATE' => 33, 'MINUTE' => 33, 'NULLIF' => 33, 'POINTN' => 33, 'SECOND' => 33, 'STDDEV' => 33, 'STRCMP' => 33, 'SUBSTR' => 33, 'WITHIN' => 33, 'ADDDATE' => 33, 'ADDTIME' => 33, 'AGAINST' => 33, 'BIT_AND' => 33, 'BIT_XOR' => 33, 'CEILING' => 33, 'CHARSET' => 33, 'CROSSES' => 33, 'CURDATE' => 33, 'CURTIME' => 33, 'DAYNAME' => 33, 'DEGREES' => 33, 'ENCRYPT' => 33, 'EXTRACT' => 33, 'GLENGTH' => 33, 'ISEMPTY' => 33, 'IS_IPV4' => 33, 'IS_IPV6' => 33, 'QUARTER' => 33, 'RADIANS' => 33, 'REVERSE' => 33, 'SOUNDEX' => 33, 'ST_AREA' => 33, 'ST_SRID' => 33, 'SUBDATE' => 33, 'SUBTIME' => 33, 'SYSDATE' => 33, 'TOUCHES' => 33, 'TO_DAYS' => 33, 'VAR_POP' => 33, 'VERSION' => 33, 'WEEKDAY' => 33, 'ASBINARY' => 33, 'CENTROID' => 33, 'COALESCE' => 33, 'COMPRESS' => 33, 'CONTAINS' => 33, 'DATEDIFF' => 33, 'DATE_ADD' => 33, 'DATE_SUB' => 33, 'DISJOINT' => 33, 'DISTANCE' => 33, 'ENDPOINT' => 33, 'ENVELOPE' => 33, 'GET_LOCK' => 33, 'GREATEST' => 33, 'ISCLOSED' => 33, 'ISSIMPLE' => 33, 'JSON_SET' => 33, 'MAKEDATE' => 33, 'MAKETIME' => 33, 'MAKE_SET' => 33, 'MBREQUAL' => 33, 'OVERLAPS' => 33, 'PASSWORD' => 33, 'POSITION' => 33, 'ST_ASWKB' => 33, 'ST_ASWKT' => 33, 'ST_UNION' => 33, 'TIMEDIFF' => 33, 'TRUNCATE' => 33, 'VARIANCE' => 33, 'VAR_SAMP' => 33, 'YEARWEEK' => 33, 'ANY_VALUE' => 33, 'BENCHMARK' => 33, 'BIT_COUNT' => 33, 'COLLATION' => 33, 'CONCAT_WS' => 33, 'DAYOFWEEK' => 33, 'DAYOFYEAR' => 33, 'DIMENSION' => 33, 'FROM_DAYS' => 33, 'GEOMETRYN' => 33, 'INET_ATON' => 33, 'INET_NTOA' => 33, 'JSON_KEYS' => 33, 'JSON_TYPE' => 33, 'LOAD_FILE' => 33, 'MBRCOVERS' => 33, 'MBREQUALS' => 33, 'MBRWITHIN' => 33, 'MONTHNAME' => 33, 'NUMPOINTS' => 33, 'ROW_COUNT' => 33, 'ST_ASTEXT' => 33, 'ST_BUFFER' => 33, 'ST_EQUALS' => 33, 'ST_LENGTH' => 33, 'ST_POINTN' => 33, 'ST_WITHIN' => 33, 'SUBSTRING' => 33, 'TO_BASE64' => 33, 'UPDATEXML' => 33, 'BIT_LENGTH' => 33, 'CONVERT_TZ' => 33, 'CONVEXHULL' => 33, 'DAYOFMONTH' => 33, 'EXPORT_SET' => 33, 'FOUND_ROWS' => 33, 'GET_FORMAT' => 33, 'INET6_ATON' => 33, 'INET6_NTOA' => 33, 'INTERSECTS' => 33, 'JSON_ARRAY' => 33, 'JSON_DEPTH' => 33, 'JSON_MERGE' => 33, 'JSON_QUOTE' => 33, 'JSON_VALID' => 33, 'MBRTOUCHES' => 33, 'MULTIPOINT' => 33, 'NAME_CONST' => 33, 'PERIOD_ADD' => 33, 'STARTPOINT' => 33, 'STDDEV_POP' => 33, 'ST_CROSSES' => 33, 'ST_GEOHASH' => 33, 'ST_ISEMPTY' => 33, 'ST_ISVALID' => 33, 'ST_TOUCHES' => 33, 'TO_SECONDS' => 33, 'UNCOMPRESS' => 33, 'UUID_SHORT' => 33, 'WEEKOFYEAR' => 33, 'AES_DECRYPT' => 33, 'AES_ENCRYPT' => 33, 'CHAR_LENGTH' => 33, 'DATE_FORMAT' => 33, 'DES_DECRYPT' => 33, 'DES_ENCRYPT' => 33, 'FIND_IN_SET' => 33, 'FROM_BASE64' => 33, 'GEOMFROMWKB' => 33, 'GTID_SUBSET' => 33, 'JSON_INSERT' => 33, 'JSON_LENGTH' => 33, 'JSON_OBJECT' => 33, 'JSON_PRETTY' => 33, 'JSON_REMOVE' => 33, 'JSON_SEARCH' => 33, 'LINEFROMWKB' => 33, 'MBRCONTAINS' => 33, 'MBRDISJOINT' => 33, 'MBROVERLAPS' => 33, 'MICROSECOND' => 33, 'PERIOD_DIFF' => 33, 'POLYFROMWKB' => 33, 'SEC_TO_TIME' => 33, 'STDDEV_SAMP' => 33, 'STR_TO_DATE' => 33, 'ST_ASBINARY' => 33, 'ST_CENTROID' => 33, 'ST_CONTAINS' => 33, 'ST_DISJOINT' => 33, 'ST_DISTANCE' => 33, 'ST_ENDPOINT' => 33, 'ST_ENVELOPE' => 33, 'ST_ISCLOSED' => 33, 'ST_ISSIMPLE' => 33, 'ST_OVERLAPS' => 33, 'ST_SIMPLIFY' => 33, 'ST_VALIDATE' => 33, 'SYSTEM_USER' => 33, 'TIME_FORMAT' => 33, 'TIME_TO_SEC' => 33, 'COERCIBILITY' => 33, 'EXTERIORRING' => 33, 'EXTRACTVALUE' => 33, 'GEOMETRYTYPE' => 33, 'GEOMFROMTEXT' => 33, 'GROUP_CONCAT' => 33, 'IS_FREE_LOCK' => 33, 'IS_USED_LOCK' => 33, 'JSON_EXTRACT' => 33, 'JSON_REPLACE' => 33, 'JSON_UNQUOTE' => 33, 'LINEFROMTEXT' => 33, 'MBRCOVEREDBY' => 33, 'MLINEFROMWKB' => 33, 'MPOLYFROMWKB' => 33, 'MULTIPOLYGON' => 33, 'OCTET_LENGTH' => 33, 'OLD_PASSWORD' => 33, 'POINTFROMWKB' => 33, 'POLYFROMTEXT' => 33, 'RANDOM_BYTES' => 33, 'RELEASE_LOCK' => 33, 'SESSION_USER' => 33, 'ST_ASGEOJSON' => 33, 'ST_DIMENSION' => 33, 'ST_GEOMETRYN' => 33, 'ST_NUMPOINTS' => 33, 'TIMESTAMPADD' => 33, 'CONNECTION_ID' => 33, 'FROM_UNIXTIME' => 33, 'GTID_SUBTRACT' => 33, 'INTERIORRINGN' => 33, 'JSON_CONTAINS' => 33, 'MBRINTERSECTS' => 33, 'MLINEFROMTEXT' => 33, 'MPOINTFROMWKB' => 33, 'MPOLYFROMTEXT' => 33, 'NUMGEOMETRIES' => 33, 'POINTFROMTEXT' => 33, 'ST_CONVEXHULL' => 33, 'ST_DIFFERENCE' => 33, 'ST_INTERSECTS' => 33, 'ST_STARTPOINT' => 33, 'TIMESTAMPDIFF' => 33, 'WEIGHT_STRING' => 33, 'IS_IPV4_COMPAT' => 33, 'IS_IPV4_MAPPED' => 33, 'LAST_INSERT_ID' => 33, 'MPOINTFROMTEXT' => 33, 'POLYGONFROMWKB' => 33, 'ST_GEOMFROMWKB' => 33, 'ST_LINEFROMWKB' => 33, 'ST_POLYFROMWKB' => 33, 'UNIX_TIMESTAMP' => 33, 'GEOMCOLLFROMWKB' => 33, 'MASTER_POS_WAIT' => 33, 'POLYGONFROMTEXT' => 33, 'ST_EXTERIORRING' => 33, 'ST_GEOMETRYTYPE' => 33, 'ST_GEOMFROMTEXT' => 33, 'ST_INTERSECTION' => 33, 'ST_LINEFROMTEXT' => 33, 'ST_MAKEENVELOPE' => 33, 'ST_MLINEFROMWKB' => 33, 'ST_MPOLYFROMWKB' => 33, 'ST_POINTFROMWKB' => 33, 'ST_POLYFROMTEXT' => 33, 'SUBSTRING_INDEX' => 33, 'CHARACTER_LENGTH' => 33, 'GEOMCOLLFROMTEXT' => 33, 'GEOMETRYFROMTEXT' => 33, 'JSON_MERGE_PATCH' => 33, 'NUMINTERIORRINGS' => 33, 'ST_INTERIORRINGN' => 33, 'ST_MLINEFROMTEXT' => 33, 'ST_MPOINTFROMWKB' => 33, 'ST_MPOLYFROMTEXT' => 33, 'ST_NUMGEOMETRIES' => 33, 'ST_POINTFROMTEXT' => 33, 'ST_SYMDIFFERENCE' => 33, 'JSON_ARRAY_APPEND' => 33, 'JSON_ARRAY_INSERT' => 33, 'JSON_STORAGE_FREE' => 33, 'JSON_STORAGE_SIZE' => 33, 'LINESTRINGFROMWKB' => 33, 'MULTIPOINTFROMWKB' => 33, 'RELEASE_ALL_LOCKS' => 33, 'ST_LATFROMGEOHASH' => 33, 'ST_MPOINTFROMTEXT' => 33, 'ST_POLYGONFROMWKB' => 33, 'JSON_CONTAINS_PATH' => 33, 'MULTIPOINTFROMTEXT' => 33, 'ST_BUFFER_STRATEGY' => 33, 'ST_DISTANCE_SPHERE' => 33, 'ST_GEOMCOLLFROMTXT' => 33, 'ST_GEOMCOLLFROMWKB' => 33, 'ST_GEOMFROMGEOJSON' => 33, 'ST_LONGFROMGEOHASH' => 33, 'ST_POLYGONFROMTEXT' => 33, 'JSON_MERGE_PRESERVE' => 33, 'MULTIPOLYGONFROMWKB' => 33, 'ST_GEOMCOLLFROMTEXT' => 33, 'ST_GEOMETRYFROMTEXT' => 33, 'ST_NUMINTERIORRINGS' => 33, 'ST_POINTFROMGEOHASH' => 33, 'UNCOMPRESSED_LENGTH' => 33, 'MULTIPOLYGONFROMTEXT' => 33, 'ST_LINESTRINGFROMWKB' => 33, 'ST_MULTIPOINTFROMWKB' => 33, 'ST_MULTIPOINTFROMTEXT' => 33, 'MULTILINESTRINGFROMWKB' => 33, 'ST_MULTIPOLYGONFROMWKB' => 33, 'MULTILINESTRINGFROMTEXT' => 33, 'ST_MULTIPOLYGONFROMTEXT' => 33, 'GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_MULTILINESTRINGFROMWKB' => 33, 'GEOMETRYCOLLECTIONFROMTEXT' => 33, 'ST_MULTILINESTRINGFROMTEXT' => 33, 'VALIDATE_PASSWORD_STRENGTH' => 33, 'WAIT_FOR_EXECUTED_GTID_SET' => 33, 'ST_GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_GEOMETRYCOLLECTIONFROMTEXT' => 33, 'WAIT_UNTIL_SQL_THREAD_AFTER_GTIDS' => 33, 'IF' => 35, 'IN' => 35, 'MOD' => 35, 'LEFT' => 35, 'MATCH' => 35, 'RIGHT' => 35, 'INSERT' => 35, 'REPEAT' => 35, 'SCHEMA' => 35, 'VALUES' => 35, 'CONVERT' => 35, 'DEFAULT' => 35, 'REPLACE' => 35, 'DATABASE' => 35, 'UTC_DATE' => 35, 'UTC_TIME' => 35, 'LOCALTIME' => 35, 'CURRENT_DATE' => 35, 'CURRENT_TIME' => 35, 'CURRENT_USER' => 35, 'UTC_TIMESTAMP' => 35, 'LOCALTIMESTAMP' => 35, 'CURRENT_TIMESTAMP' => 35, 'NOT IN' => 39, 'DATE' => 41, 'TIME' => 41, 'YEAR' => 41, 'POINT' => 41, 'POLYGON' => 41, 'TIMESTAMP' => 41, 'LINESTRING' => 41, 'MULTILINESTRING' => 41, 'GEOMETRYCOLLECTION' => 41, 'CHAR' => 43, 'BINARY' => 43, 'INTERVAL' => 43);
}
/**
* Context for MySQL 5.7.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextMySql50700 extends \PhpMyAdmin\SqlParser\Context
{
/**
* List of keywords.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* @var array
*/
public static $KEYWORDS = array('AT' => 1, 'DO' => 1, 'IO' => 1, 'NO' => 1, 'XA' => 1, 'ANY' => 1, 'CPU' => 1, 'END' => 1, 'IPC' => 1, 'NDB' => 1, 'NEW' => 1, 'ONE' => 1, 'ROW' => 1, 'XID' => 1, 'BOOL' => 1, 'BYTE' => 1, 'CODE' => 1, 'CUBE' => 1, 'DATA' => 1, 'DISK' => 1, 'ENDS' => 1, 'FAST' => 1, 'FILE' => 1, 'FULL' => 1, 'HASH' => 1, 'HELP' => 1, 'HOST' => 1, 'LAST' => 1, 'LESS' => 1, 'LIST' => 1, 'LOGS' => 1, 'MODE' => 1, 'NAME' => 1, 'NEXT' => 1, 'NONE' => 1, 'ONLY' => 1, 'OPEN' => 1, 'PAGE' => 1, 'PORT' => 1, 'PREV' => 1, 'ROWS' => 1, 'SLOW' => 1, 'SOME' => 1, 'STOP' => 1, 'THAN' => 1, 'TYPE' => 1, 'VIEW' => 1, 'WAIT' => 1, 'WORK' => 1, 'X509' => 1, 'AFTER' => 1, 'BEGIN' => 1, 'BLOCK' => 1, 'BTREE' => 1, 'CACHE' => 1, 'CHAIN' => 1, 'CLOSE' => 1, 'ERROR' => 1, 'EVENT' => 1, 'EVERY' => 1, 'FIRST' => 1, 'FIXED' => 1, 'FLUSH' => 1, 'FOUND' => 1, 'HOSTS' => 1, 'LEVEL' => 1, 'LOCAL' => 1, 'LOCKS' => 1, 'MERGE' => 1, 'MUTEX' => 1, 'NAMES' => 1, 'NCHAR' => 1, 'NEVER' => 1, 'OWNER' => 1, 'PHASE' => 1, 'PROXY' => 1, 'QUERY' => 1, 'QUICK' => 1, 'RELAY' => 1, 'RESET' => 1, 'RTREE' => 1, 'SHARE' => 1, 'SLAVE' => 1, 'START' => 1, 'SUPER' => 1, 'SWAPS' => 1, 'TYPES' => 1, 'UNTIL' => 1, 'VALUE' => 1, 'ACTION' => 1, 'ALWAYS' => 1, 'BACKUP' => 1, 'BINLOG' => 1, 'CIPHER' => 1, 'CLIENT' => 1, 'COMMIT' => 1, 'ENABLE' => 1, 'ENGINE' => 1, 'ERRORS' => 1, 'ESCAPE' => 1, 'EVENTS' => 1, 'EXPIRE' => 1, 'EXPORT' => 1, 'FAULTS' => 1, 'FIELDS' => 1, 'FILTER' => 1, 'GLOBAL' => 1, 'GRANTS' => 1, 'IMPORT' => 1, 'ISSUER' => 1, 'LEAVES' => 1, 'MASTER' => 1, 'MEDIUM' => 1, 'MEMORY' => 1, 'MODIFY' => 1, 'NUMBER' => 1, 'OFFSET' => 1, 'PARSER' => 1, 'PLUGIN' => 1, 'RELOAD' => 1, 'REMOVE' => 1, 'REPAIR' => 1, 'RESUME' => 1, 'ROLLUP' => 1, 'SERVER' => 1, 'SIGNED' => 1, 'SIMPLE' => 1, 'SOCKET' => 1, 'SONAME' => 1, 'SOUNDS' => 1, 'SOURCE' => 1, 'STARTS' => 1, 'STATUS' => 1, 'STRING' => 1, 'TABLES' => 1, 'ACCOUNT' => 1, 'ANALYSE' => 1, 'CHANGED' => 1, 'CHANNEL' => 1, 'COLUMNS' => 1, 'COMMENT' => 1, 'COMPACT' => 1, 'CONTEXT' => 1, 'CURRENT' => 1, 'DEFINER' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DYNAMIC' => 1, 'ENGINES' => 1, 'EXECUTE' => 1, 'FOLLOWS' => 1, 'GENERAL' => 1, 'HANDLER' => 1, 'INDEXES' => 1, 'INSTALL' => 1, 'INVOKER' => 1, 'LOGFILE' => 1, 'MIGRATE' => 1, 'NO_WAIT' => 1, 'OPTIONS' => 1, 'PARTIAL' => 1, 'PLUGINS' => 1, 'PREPARE' => 1, 'PROFILE' => 1, 'REBUILD' => 1, 'RECOVER' => 1, 'RESTORE' => 1, 'RETURNS' => 1, 'ROUTINE' => 1, 'SESSION' => 1, 'STACKED' => 1, 'STORAGE' => 1, 'SUBJECT' => 1, 'SUSPEND' => 1, 'UNICODE' => 1, 'UNKNOWN' => 1, 'UPGRADE' => 1, 'USE_FRM' => 1, 'WITHOUT' => 1, 'WRAPPER' => 1, 'CASCADED' => 1, 'CHECKSUM' => 1, 'DATAFILE' => 1, 'DUMPFILE' => 1, 'EXCHANGE' => 1, 'EXTENDED' => 1, 'FUNCTION' => 1, 'LANGUAGE' => 1, 'MAX_ROWS' => 1, 'MAX_SIZE' => 1, 'MIN_ROWS' => 1, 'NATIONAL' => 1, 'NVARCHAR' => 1, 'PRECEDES' => 1, 'PRESERVE' => 1, 'PROFILES' => 1, 'REDOFILE' => 1, 'RELAYLOG' => 1, 'ROLLBACK' => 1, 'SCHEDULE' => 1, 'SECURITY' => 1, 'SHUTDOWN' => 1, 'SNAPSHOT' => 1, 'SWITCHES' => 1, 'TRIGGERS' => 1, 'UNDOFILE' => 1, 'WARNINGS' => 1, 'AGGREGATE' => 1, 'ALGORITHM' => 1, 'COMMITTED' => 1, 'DIRECTORY' => 1, 'DUPLICATE' => 1, 'EXPANSION' => 1, 'IO_THREAD' => 1, 'ISOLATION' => 1, 'NODEGROUP' => 1, 'PACK_KEYS' => 1, 'READ_ONLY' => 1, 'REDUNDANT' => 1, 'SAVEPOINT' => 1, 'SQL_CACHE' => 1, 'TEMPORARY' => 1, 'TEMPTABLE' => 1, 'UNDEFINED' => 1, 'UNINSTALL' => 1, 'VARIABLES' => 1, 'COMPLETION' => 1, 'COMPRESSED' => 1, 'CONCURRENT' => 1, 'CONNECTION' => 1, 'CONSISTENT' => 1, 'DEALLOCATE' => 1, 'IDENTIFIED' => 1, 'MASTER_SSL' => 1, 'NDBCLUSTER' => 1, 'PARTITIONS' => 1, 'PERSISTENT' => 1, 'PLUGIN_DIR' => 1, 'PRIVILEGES' => 1, 'REORGANIZE' => 1, 'REPEATABLE' => 1, 'ROW_FORMAT' => 1, 'SQL_THREAD' => 1, 'TABLESPACE' => 1, 'TABLE_NAME' => 1, 'VALIDATION' => 1, 'COLUMN_NAME' => 1, 'COMPRESSION' => 1, 'CURSOR_NAME' => 1, 'DIAGNOSTICS' => 1, 'EXTENT_SIZE' => 1, 'MASTER_HOST' => 1, 'MASTER_PORT' => 1, 'MASTER_USER' => 1, 'MYSQL_ERRNO' => 1, 'NONBLOCKING' => 1, 'PROCESSLIST' => 1, 'REPLICATION' => 1, 'SCHEMA_NAME' => 1, 'SQL_TSI_DAY' => 1, 'TRANSACTION' => 1, 'UNCOMMITTED' => 1, 'CATALOG_NAME' => 1, 'CLASS_ORIGIN' => 1, 'DEFAULT_AUTH' => 1, 'DES_KEY_FILE' => 1, 'INITIAL_SIZE' => 1, 'MASTER_DELAY' => 1, 'MESSAGE_TEXT' => 1, 'PARTITIONING' => 1, 'RELAY_THREAD' => 1, 'SERIALIZABLE' => 1, 'SQL_NO_CACHE' => 1, 'SQL_TSI_HOUR' => 1, 'SQL_TSI_WEEK' => 1, 'SQL_TSI_YEAR' => 1, 'SUBPARTITION' => 1, 'COLUMN_FORMAT' => 1, 'INSERT_METHOD' => 1, 'MASTER_SSL_CA' => 1, 'RELAY_LOG_POS' => 1, 'SQL_TSI_MONTH' => 1, 'SUBPARTITIONS' => 1, 'AUTO_INCREMENT' => 1, 'AVG_ROW_LENGTH' => 1, 'KEY_BLOCK_SIZE' => 1, 'MASTER_LOG_POS' => 1, 'MASTER_SSL_CRL' => 1, 'MASTER_SSL_KEY' => 1, 'RELAY_LOG_FILE' => 1, 'SQL_TSI_MINUTE' => 1, 'SQL_TSI_SECOND' => 1, 'TABLE_CHECKSUM' => 1, 'USER_RESOURCES' => 1, 'AUTOEXTEND_SIZE' => 1, 'CONSTRAINT_NAME' => 1, 'DELAY_KEY_WRITE' => 1, 'FILE_BLOCK_SIZE' => 1, 'MASTER_LOG_FILE' => 1, 'MASTER_PASSWORD' => 1, 'MASTER_SSL_CERT' => 1, 'PARSE_GCOL_EXPR' => 1, 'REPLICATE_DO_DB' => 1, 'SQL_AFTER_GTIDS' => 1, 'SQL_TSI_QUARTER' => 1, 'SUBCLASS_ORIGIN' => 1, 'MASTER_SERVER_ID' => 1, 'REDO_BUFFER_SIZE' => 1, 'SQL_BEFORE_GTIDS' => 1, 'STATS_PERSISTENT' => 1, 'UNDO_BUFFER_SIZE' => 1, 'CONSTRAINT_SCHEMA' => 1, 'GROUP_REPLICATION' => 1, 'IGNORE_SERVER_IDS' => 1, 'MASTER_SSL_CAPATH' => 1, 'MASTER_SSL_CIPHER' => 1, 'RETURNED_SQLSTATE' => 1, 'SQL_BUFFER_RESULT' => 1, 'STATS_AUTO_RECALC' => 1, 'CONSTRAINT_CATALOG' => 1, 'MASTER_RETRY_COUNT' => 1, 'MASTER_SSL_CRLPATH' => 1, 'MAX_STATEMENT_TIME' => 1, 'REPLICATE_DO_TABLE' => 1, 'SQL_AFTER_MTS_GAPS' => 1, 'STATS_SAMPLE_PAGES' => 1, 'REPLICATE_IGNORE_DB' => 1, 'MASTER_AUTO_POSITION' => 1, 'MASTER_CONNECT_RETRY' => 1, 'MAX_QUERIES_PER_HOUR' => 1, 'MAX_UPDATES_PER_HOUR' => 1, 'MAX_USER_CONNECTIONS' => 1, 'REPLICATE_REWRITE_DB' => 1, 'REPLICATE_IGNORE_TABLE' => 1, 'MASTER_HEARTBEAT_PERIOD' => 1, 'REPLICATE_WILD_DO_TABLE' => 1, 'MAX_CONNECTIONS_PER_HOUR' => 1, 'REPLICATE_WILD_IGNORE_TABLE' => 1, 'AS' => 3, 'BY' => 3, 'IS' => 3, 'ON' => 3, 'OR' => 3, 'TO' => 3, 'ADD' => 3, 'ALL' => 3, 'AND' => 3, 'ASC' => 3, 'DEC' => 3, 'DIV' => 3, 'FOR' => 3, 'GET' => 3, 'NOT' => 3, 'OUT' => 3, 'SQL' => 3, 'SSL' => 3, 'USE' => 3, 'XOR' => 3, 'BOTH' => 3, 'CALL' => 3, 'CASE' => 3, 'DESC' => 3, 'DROP' => 3, 'DUAL' => 3, 'EACH' => 3, 'ELSE' => 3, 'EXIT' => 3, 'FROM' => 3, 'INT1' => 3, 'INT2' => 3, 'INT3' => 3, 'INT4' => 3, 'INT8' => 3, 'INTO' => 3, 'JOIN' => 3, 'KEYS' => 3, 'KILL' => 3, 'LIKE' => 3, 'LOAD' => 3, 'LOCK' => 3, 'LONG' => 3, 'LOOP' => 3, 'NULL' => 3, 'READ' => 3, 'SHOW' => 3, 'THEN' => 3, 'TRUE' => 3, 'UNDO' => 3, 'WHEN' => 3, 'WITH' => 3, 'ALTER' => 3, 'CHECK' => 3, 'CROSS' => 3, 'FALSE' => 3, 'FETCH' => 3, 'FORCE' => 3, 'GRANT' => 3, 'GROUP' => 3, 'INNER' => 3, 'INOUT' => 3, 'LEAVE' => 3, 'LIMIT' => 3, 'LINES' => 3, 'ORDER' => 3, 'OUTER' => 3, 'PURGE' => 3, 'RANGE' => 3, 'READS' => 3, 'RLIKE' => 3, 'TABLE' => 3, 'UNION' => 3, 'USAGE' => 3, 'USING' => 3, 'WHERE' => 3, 'WHILE' => 3, 'WRITE' => 3, 'BEFORE' => 3, 'CHANGE' => 3, 'COLUMN' => 3, 'CREATE' => 3, 'CURSOR' => 3, 'DELETE' => 3, 'ELSEIF' => 3, 'EXISTS' => 3, 'FLOAT4' => 3, 'FLOAT8' => 3, 'HAVING' => 3, 'IGNORE' => 3, 'INFILE' => 3, 'LINEAR' => 3, 'OPTION' => 3, 'REGEXP' => 3, 'RENAME' => 3, 'RETURN' => 3, 'REVOKE' => 3, 'SELECT' => 3, 'SIGNAL' => 3, 'STORED' => 3, 'UNLOCK' => 3, 'UPDATE' => 3, 'ANALYZE' => 3, 'BETWEEN' => 3, 'CASCADE' => 3, 'COLLATE' => 3, 'DECLARE' => 3, 'DELAYED' => 3, 'ESCAPED' => 3, 'EXPLAIN' => 3, 'FOREIGN' => 3, 'ITERATE' => 3, 'LEADING' => 3, 'NATURAL' => 3, 'OUTFILE' => 3, 'PRIMARY' => 3, 'RELEASE' => 3, 'REQUIRE' => 3, 'SCHEMAS' => 3, 'TRIGGER' => 3, 'VARYING' => 3, 'VIRTUAL' => 3, 'CONTINUE' => 3, 'DAY_HOUR' => 3, 'DESCRIBE' => 3, 'DISTINCT' => 3, 'ENCLOSED' => 3, 'MAXVALUE' => 3, 'MODIFIES' => 3, 'OPTIMIZE' => 3, 'RESIGNAL' => 3, 'RESTRICT' => 3, 'SPECIFIC' => 3, 'SQLSTATE' => 3, 'STARTING' => 3, 'TRAILING' => 3, 'UNSIGNED' => 3, 'ZEROFILL' => 3, 'CONDITION' => 3, 'DATABASES' => 3, 'GENERATED' => 3, 'MIDDLEINT' => 3, 'PARTITION' => 3, 'PRECISION' => 3, 'PROCEDURE' => 3, 'SENSITIVE' => 3, 'SEPARATOR' => 3, 'ACCESSIBLE' => 3, 'ASENSITIVE' => 3, 'CONSTRAINT' => 3, 'DAY_MINUTE' => 3, 'DAY_SECOND' => 3, 'OPTIONALLY' => 3, 'READ_WRITE' => 3, 'REFERENCES' => 3, 'SQLWARNING' => 3, 'TERMINATED' => 3, 'YEAR_MONTH' => 3, 'DISTINCTROW' => 3, 'HOUR_MINUTE' => 3, 'HOUR_SECOND' => 3, 'INSENSITIVE' => 3, 'MASTER_BIND' => 3, 'LOW_PRIORITY' => 3, 'SQLEXCEPTION' => 3, 'VARCHARACTER' => 3, 'DETERMINISTIC' => 3, 'HIGH_PRIORITY' => 3, 'MINUTE_SECOND' => 3, 'STRAIGHT_JOIN' => 3, 'IO_AFTER_GTIDS' => 3, 'SQL_BIG_RESULT' => 3, 'DAY_MICROSECOND' => 3, 'IO_BEFORE_GTIDS' => 3, 'OPTIMIZER_COSTS' => 3, 'HOUR_MICROSECOND' => 3, 'SQL_SMALL_RESULT' => 3, 'MINUTE_MICROSECOND' => 3, 'NO_WRITE_TO_BINLOG' => 3, 'SECOND_MICROSECOND' => 3, 'SQL_CALC_FOUND_ROWS' => 3, 'MASTER_SSL_VERIFY_SERVER_CERT' => 3, 'GROUP BY' => 7, 'NOT NULL' => 7, 'ORDER BY' => 7, 'SET NULL' => 7, 'AND CHAIN' => 7, 'FULL JOIN' => 7, 'IF EXISTS' => 7, 'LEFT JOIN' => 7, 'LESS THAN' => 7, 'LOAD DATA' => 7, 'NO ACTION' => 7, 'ON DELETE' => 7, 'ON UPDATE' => 7, 'UNION ALL' => 7, 'CROSS JOIN' => 7, 'ESCAPED BY' => 7, 'FOR UPDATE' => 7, 'INNER JOIN' => 7, 'LINEAR KEY' => 7, 'NO RELEASE' => 7, 'OR REPLACE' => 7, 'RIGHT JOIN' => 7, 'ENCLOSED BY' => 7, 'LINEAR HASH' => 7, 'STARTING BY' => 7, 'AND NO CHAIN' => 7, 'FOR EACH ROW' => 7, 'NATURAL JOIN' => 7, 'PARTITION BY' => 7, 'SET PASSWORD' => 7, 'SQL SECURITY' => 7, 'CHARACTER SET' => 7, 'IF NOT EXISTS' => 7, 'TERMINATED BY' => 7, 'DATA DIRECTORY' => 7, 'UNION DISTINCT' => 7, 'DEFAULT CHARSET' => 7, 'DEFAULT COLLATE' => 7, 'FULL OUTER JOIN' => 7, 'INDEX DIRECTORY' => 7, 'LEFT OUTER JOIN' => 7, 'SUBPARTITION BY' => 7, 'GENERATED ALWAYS' => 7, 'RIGHT OUTER JOIN' => 7, 'NATURAL LEFT JOIN' => 7, 'START TRANSACTION' => 7, 'LOCK IN SHARE MODE' => 7, 'NATURAL RIGHT JOIN' => 7, 'SELECT TRANSACTION' => 7, 'DEFAULT CHARACTER SET' => 7, 'NATURAL LEFT OUTER JOIN' => 7, 'NATURAL RIGHT OUTER JOIN' => 7, 'WITH CONSISTENT SNAPSHOT' => 7, 'BIT' => 9, 'XML' => 9, 'ENUM' => 9, 'JSON' => 9, 'TEXT' => 9, 'ARRAY' => 9, 'SERIAL' => 9, 'BOOLEAN' => 9, 'DATETIME' => 9, 'GEOMETRY' => 9, 'MULTISET' => 9, 'MULTILINEPOINT' => 9, 'MULTILINEPOLYGON' => 9, 'INT' => 11, 'SET' => 11, 'BLOB' => 11, 'REAL' => 11, 'FLOAT' => 11, 'BIGINT' => 11, 'DOUBLE' => 11, 'DECIMAL' => 11, 'INTEGER' => 11, 'NUMERIC' => 11, 'TINYINT' => 11, 'VARCHAR' => 11, 'LONGBLOB' => 11, 'LONGTEXT' => 11, 'SMALLINT' => 11, 'TINYBLOB' => 11, 'TINYTEXT' => 11, 'CHARACTER' => 11, 'MEDIUMINT' => 11, 'VARBINARY' => 11, 'MEDIUMBLOB' => 11, 'MEDIUMTEXT' => 11, 'BINARY VARYING' => 15, 'KEY' => 19, 'INDEX' => 19, 'UNIQUE' => 19, 'SPATIAL' => 19, 'FULLTEXT' => 19, 'INDEX KEY' => 23, 'UNIQUE KEY' => 23, 'FOREIGN KEY' => 23, 'PRIMARY KEY' => 23, 'SPATIAL KEY' => 23, 'FULLTEXT KEY' => 23, 'UNIQUE INDEX' => 23, 'SPATIAL INDEX' => 23, 'FULLTEXT INDEX' => 23, 'X' => 33, 'Y' => 33, 'LN' => 33, 'PI' => 33, 'ABS' => 33, 'AVG' => 33, 'BIN' => 33, 'COS' => 33, 'COT' => 33, 'DAY' => 33, 'ELT' => 33, 'EXP' => 33, 'HEX' => 33, 'LOG' => 33, 'MAX' => 33, 'MD5' => 33, 'MID' => 33, 'MIN' => 33, 'NOW' => 33, 'OCT' => 33, 'ORD' => 33, 'POW' => 33, 'SHA' => 33, 'SIN' => 33, 'STD' => 33, 'SUM' => 33, 'TAN' => 33, 'ACOS' => 33, 'AREA' => 33, 'ASIN' => 33, 'ATAN' => 33, 'CAST' => 33, 'CEIL' => 33, 'CONV' => 33, 'HOUR' => 33, 'LOG2' => 33, 'LPAD' => 33, 'RAND' => 33, 'RPAD' => 33, 'SHA1' => 33, 'SHA2' => 33, 'SIGN' => 33, 'SQRT' => 33, 'SRID' => 33, 'ST_X' => 33, 'ST_Y' => 33, 'TRIM' => 33, 'USER' => 33, 'UUID' => 33, 'WEEK' => 33, 'ASCII' => 33, 'ASWKB' => 33, 'ASWKT' => 33, 'ATAN2' => 33, 'COUNT' => 33, 'CRC32' => 33, 'FIELD' => 33, 'FLOOR' => 33, 'INSTR' => 33, 'LCASE' => 33, 'LEAST' => 33, 'LOG10' => 33, 'LOWER' => 33, 'LTRIM' => 33, 'MONTH' => 33, 'POWER' => 33, 'QUOTE' => 33, 'ROUND' => 33, 'RTRIM' => 33, 'SLEEP' => 33, 'SPACE' => 33, 'UCASE' => 33, 'UNHEX' => 33, 'UPPER' => 33, 'ASTEXT' => 33, 'BIT_OR' => 33, 'BUFFER' => 33, 'CONCAT' => 33, 'DECODE' => 33, 'ENCODE' => 33, 'EQUALS' => 33, 'FORMAT' => 33, 'IFNULL' => 33, 'ISNULL' => 33, 'LENGTH' => 33, 'LOCATE' => 33, 'MINUTE' => 33, 'NULLIF' => 33, 'POINTN' => 33, 'SECOND' => 33, 'STDDEV' => 33, 'STRCMP' => 33, 'SUBSTR' => 33, 'WITHIN' => 33, 'ADDDATE' => 33, 'ADDTIME' => 33, 'AGAINST' => 33, 'BIT_AND' => 33, 'BIT_XOR' => 33, 'CEILING' => 33, 'CHARSET' => 33, 'CROSSES' => 33, 'CURDATE' => 33, 'CURTIME' => 33, 'DAYNAME' => 33, 'DEGREES' => 33, 'ENCRYPT' => 33, 'EXTRACT' => 33, 'GLENGTH' => 33, 'ISEMPTY' => 33, 'IS_IPV4' => 33, 'IS_IPV6' => 33, 'QUARTER' => 33, 'RADIANS' => 33, 'REVERSE' => 33, 'SOUNDEX' => 33, 'ST_AREA' => 33, 'ST_SRID' => 33, 'SUBDATE' => 33, 'SUBTIME' => 33, 'SYSDATE' => 33, 'TOUCHES' => 33, 'TO_DAYS' => 33, 'VAR_POP' => 33, 'VERSION' => 33, 'WEEKDAY' => 33, 'ASBINARY' => 33, 'CENTROID' => 33, 'COALESCE' => 33, 'COMPRESS' => 33, 'CONTAINS' => 33, 'DATEDIFF' => 33, 'DATE_ADD' => 33, 'DATE_SUB' => 33, 'DISJOINT' => 33, 'DISTANCE' => 33, 'ENDPOINT' => 33, 'ENVELOPE' => 33, 'GET_LOCK' => 33, 'GREATEST' => 33, 'ISCLOSED' => 33, 'ISSIMPLE' => 33, 'JSON_SET' => 33, 'MAKEDATE' => 33, 'MAKETIME' => 33, 'MAKE_SET' => 33, 'MBREQUAL' => 33, 'OVERLAPS' => 33, 'PASSWORD' => 33, 'POSITION' => 33, 'ST_ASWKB' => 33, 'ST_ASWKT' => 33, 'ST_UNION' => 33, 'TIMEDIFF' => 33, 'TRUNCATE' => 33, 'VARIANCE' => 33, 'VAR_SAMP' => 33, 'YEARWEEK' => 33, 'ANY_VALUE' => 33, 'BENCHMARK' => 33, 'BIT_COUNT' => 33, 'COLLATION' => 33, 'CONCAT_WS' => 33, 'DAYOFWEEK' => 33, 'DAYOFYEAR' => 33, 'DIMENSION' => 33, 'FROM_DAYS' => 33, 'GEOMETRYN' => 33, 'INET_ATON' => 33, 'INET_NTOA' => 33, 'JSON_KEYS' => 33, 'JSON_TYPE' => 33, 'LOAD_FILE' => 33, 'MBRCOVERS' => 33, 'MBREQUALS' => 33, 'MBRWITHIN' => 33, 'MONTHNAME' => 33, 'NUMPOINTS' => 33, 'ROW_COUNT' => 33, 'ST_ASTEXT' => 33, 'ST_BUFFER' => 33, 'ST_EQUALS' => 33, 'ST_LENGTH' => 33, 'ST_POINTN' => 33, 'ST_WITHIN' => 33, 'SUBSTRING' => 33, 'TO_BASE64' => 33, 'UPDATEXML' => 33, 'BIT_LENGTH' => 33, 'CONVERT_TZ' => 33, 'CONVEXHULL' => 33, 'DAYOFMONTH' => 33, 'EXPORT_SET' => 33, 'FOUND_ROWS' => 33, 'GET_FORMAT' => 33, 'INET6_ATON' => 33, 'INET6_NTOA' => 33, 'INTERSECTS' => 33, 'JSON_ARRAY' => 33, 'JSON_DEPTH' => 33, 'JSON_MERGE' => 33, 'JSON_QUOTE' => 33, 'JSON_VALID' => 33, 'MBRTOUCHES' => 33, 'MULTIPOINT' => 33, 'NAME_CONST' => 33, 'PERIOD_ADD' => 33, 'STARTPOINT' => 33, 'STDDEV_POP' => 33, 'ST_CROSSES' => 33, 'ST_GEOHASH' => 33, 'ST_ISEMPTY' => 33, 'ST_ISVALID' => 33, 'ST_TOUCHES' => 33, 'TO_SECONDS' => 33, 'UNCOMPRESS' => 33, 'UUID_SHORT' => 33, 'WEEKOFYEAR' => 33, 'AES_DECRYPT' => 33, 'AES_ENCRYPT' => 33, 'CHAR_LENGTH' => 33, 'DATE_FORMAT' => 33, 'DES_DECRYPT' => 33, 'DES_ENCRYPT' => 33, 'FIND_IN_SET' => 33, 'FROM_BASE64' => 33, 'GEOMFROMWKB' => 33, 'GTID_SUBSET' => 33, 'JSON_INSERT' => 33, 'JSON_LENGTH' => 33, 'JSON_OBJECT' => 33, 'JSON_PRETTY' => 33, 'JSON_REMOVE' => 33, 'JSON_SEARCH' => 33, 'LINEFROMWKB' => 33, 'MBRCONTAINS' => 33, 'MBRDISJOINT' => 33, 'MBROVERLAPS' => 33, 'MICROSECOND' => 33, 'PERIOD_DIFF' => 33, 'POLYFROMWKB' => 33, 'SEC_TO_TIME' => 33, 'STDDEV_SAMP' => 33, 'STR_TO_DATE' => 33, 'ST_ASBINARY' => 33, 'ST_CENTROID' => 33, 'ST_CONTAINS' => 33, 'ST_DISJOINT' => 33, 'ST_DISTANCE' => 33, 'ST_ENDPOINT' => 33, 'ST_ENVELOPE' => 33, 'ST_ISCLOSED' => 33, 'ST_ISSIMPLE' => 33, 'ST_OVERLAPS' => 33, 'ST_SIMPLIFY' => 33, 'ST_VALIDATE' => 33, 'SYSTEM_USER' => 33, 'TIME_FORMAT' => 33, 'TIME_TO_SEC' => 33, 'COERCIBILITY' => 33, 'EXTERIORRING' => 33, 'EXTRACTVALUE' => 33, 'GEOMETRYTYPE' => 33, 'GEOMFROMTEXT' => 33, 'GROUP_CONCAT' => 33, 'IS_FREE_LOCK' => 33, 'IS_USED_LOCK' => 33, 'JSON_EXTRACT' => 33, 'JSON_REPLACE' => 33, 'JSON_UNQUOTE' => 33, 'LINEFROMTEXT' => 33, 'MBRCOVEREDBY' => 33, 'MLINEFROMWKB' => 33, 'MPOLYFROMWKB' => 33, 'MULTIPOLYGON' => 33, 'OCTET_LENGTH' => 33, 'OLD_PASSWORD' => 33, 'POINTFROMWKB' => 33, 'POLYFROMTEXT' => 33, 'RANDOM_BYTES' => 33, 'RELEASE_LOCK' => 33, 'SESSION_USER' => 33, 'ST_ASGEOJSON' => 33, 'ST_DIMENSION' => 33, 'ST_GEOMETRYN' => 33, 'ST_NUMPOINTS' => 33, 'TIMESTAMPADD' => 33, 'CONNECTION_ID' => 33, 'FROM_UNIXTIME' => 33, 'GTID_SUBTRACT' => 33, 'INTERIORRINGN' => 33, 'JSON_CONTAINS' => 33, 'MBRINTERSECTS' => 33, 'MLINEFROMTEXT' => 33, 'MPOINTFROMWKB' => 33, 'MPOLYFROMTEXT' => 33, 'NUMGEOMETRIES' => 33, 'POINTFROMTEXT' => 33, 'ST_CONVEXHULL' => 33, 'ST_DIFFERENCE' => 33, 'ST_INTERSECTS' => 33, 'ST_STARTPOINT' => 33, 'TIMESTAMPDIFF' => 33, 'WEIGHT_STRING' => 33, 'IS_IPV4_COMPAT' => 33, 'IS_IPV4_MAPPED' => 33, 'LAST_INSERT_ID' => 33, 'MPOINTFROMTEXT' => 33, 'POLYGONFROMWKB' => 33, 'ST_GEOMFROMWKB' => 33, 'ST_LINEFROMWKB' => 33, 'ST_POLYFROMWKB' => 33, 'UNIX_TIMESTAMP' => 33, 'GEOMCOLLFROMWKB' => 33, 'MASTER_POS_WAIT' => 33, 'POLYGONFROMTEXT' => 33, 'ST_EXTERIORRING' => 33, 'ST_GEOMETRYTYPE' => 33, 'ST_GEOMFROMTEXT' => 33, 'ST_INTERSECTION' => 33, 'ST_LINEFROMTEXT' => 33, 'ST_MAKEENVELOPE' => 33, 'ST_MLINEFROMWKB' => 33, 'ST_MPOLYFROMWKB' => 33, 'ST_POINTFROMWKB' => 33, 'ST_POLYFROMTEXT' => 33, 'SUBSTRING_INDEX' => 33, 'CHARACTER_LENGTH' => 33, 'GEOMCOLLFROMTEXT' => 33, 'GEOMETRYFROMTEXT' => 33, 'JSON_MERGE_PATCH' => 33, 'NUMINTERIORRINGS' => 33, 'ST_INTERIORRINGN' => 33, 'ST_MLINEFROMTEXT' => 33, 'ST_MPOINTFROMWKB' => 33, 'ST_MPOLYFROMTEXT' => 33, 'ST_NUMGEOMETRIES' => 33, 'ST_POINTFROMTEXT' => 33, 'ST_SYMDIFFERENCE' => 33, 'JSON_ARRAY_APPEND' => 33, 'JSON_ARRAY_INSERT' => 33, 'JSON_STORAGE_FREE' => 33, 'JSON_STORAGE_SIZE' => 33, 'LINESTRINGFROMWKB' => 33, 'MULTIPOINTFROMWKB' => 33, 'RELEASE_ALL_LOCKS' => 33, 'ST_LATFROMGEOHASH' => 33, 'ST_MPOINTFROMTEXT' => 33, 'ST_POLYGONFROMWKB' => 33, 'JSON_CONTAINS_PATH' => 33, 'MULTIPOINTFROMTEXT' => 33, 'ST_BUFFER_STRATEGY' => 33, 'ST_DISTANCE_SPHERE' => 33, 'ST_GEOMCOLLFROMTXT' => 33, 'ST_GEOMCOLLFROMWKB' => 33, 'ST_GEOMFROMGEOJSON' => 33, 'ST_LONGFROMGEOHASH' => 33, 'ST_POLYGONFROMTEXT' => 33, 'JSON_MERGE_PRESERVE' => 33, 'MULTIPOLYGONFROMWKB' => 33, 'ST_GEOMCOLLFROMTEXT' => 33, 'ST_GEOMETRYFROMTEXT' => 33, 'ST_NUMINTERIORRINGS' => 33, 'ST_POINTFROMGEOHASH' => 33, 'UNCOMPRESSED_LENGTH' => 33, 'MULTIPOLYGONFROMTEXT' => 33, 'ST_LINESTRINGFROMWKB' => 33, 'ST_MULTIPOINTFROMWKB' => 33, 'ST_MULTIPOINTFROMTEXT' => 33, 'MULTILINESTRINGFROMWKB' => 33, 'ST_MULTIPOLYGONFROMWKB' => 33, 'MULTILINESTRINGFROMTEXT' => 33, 'ST_MULTIPOLYGONFROMTEXT' => 33, 'GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_MULTILINESTRINGFROMWKB' => 33, 'GEOMETRYCOLLECTIONFROMTEXT' => 33, 'ST_MULTILINESTRINGFROMTEXT' => 33, 'VALIDATE_PASSWORD_STRENGTH' => 33, 'WAIT_FOR_EXECUTED_GTID_SET' => 33, 'ST_GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_GEOMETRYCOLLECTIONFROMTEXT' => 33, 'WAIT_UNTIL_SQL_THREAD_AFTER_GTIDS' => 33, 'IF' => 35, 'IN' => 35, 'MOD' => 35, 'LEFT' => 35, 'MATCH' => 35, 'RIGHT' => 35, 'INSERT' => 35, 'REPEAT' => 35, 'SCHEMA' => 35, 'VALUES' => 35, 'CONVERT' => 35, 'DEFAULT' => 35, 'REPLACE' => 35, 'DATABASE' => 35, 'UTC_DATE' => 35, 'UTC_TIME' => 35, 'LOCALTIME' => 35, 'CURRENT_DATE' => 35, 'CURRENT_TIME' => 35, 'CURRENT_USER' => 35, 'UTC_TIMESTAMP' => 35, 'LOCALTIMESTAMP' => 35, 'CURRENT_TIMESTAMP' => 35, 'NOT IN' => 39, 'DATE' => 41, 'TIME' => 41, 'YEAR' => 41, 'POINT' => 41, 'POLYGON' => 41, 'TIMESTAMP' => 41, 'LINESTRING' => 41, 'MULTILINESTRING' => 41, 'GEOMETRYCOLLECTION' => 41, 'CHAR' => 43, 'BINARY' => 43, 'INTERVAL' => 43);
}
/**
* Context for MySQL 5.5.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextMySql50500 extends \PhpMyAdmin\SqlParser\Context
{
/**
* List of keywords.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* @var array
*/
public static $KEYWORDS = array('AT' => 1, 'DO' => 1, 'IO' => 1, 'NO' => 1, 'XA' => 1, 'ANY' => 1, 'CPU' => 1, 'END' => 1, 'IPC' => 1, 'NDB' => 1, 'NEW' => 1, 'ONE' => 1, 'ROW' => 1, 'BOOL' => 1, 'BYTE' => 1, 'CODE' => 1, 'CUBE' => 1, 'DATA' => 1, 'DISK' => 1, 'ENDS' => 1, 'FAST' => 1, 'FILE' => 1, 'FULL' => 1, 'HASH' => 1, 'HELP' => 1, 'HOST' => 1, 'LAST' => 1, 'LESS' => 1, 'LIST' => 1, 'LOGS' => 1, 'MODE' => 1, 'NAME' => 1, 'NEXT' => 1, 'NONE' => 1, 'OPEN' => 1, 'PAGE' => 1, 'PORT' => 1, 'PREV' => 1, 'ROWS' => 1, 'SLOW' => 1, 'SOME' => 1, 'STOP' => 1, 'THAN' => 1, 'TYPE' => 1, 'VIEW' => 1, 'WAIT' => 1, 'WORK' => 1, 'X509' => 1, 'AFTER' => 1, 'BEGIN' => 1, 'BLOCK' => 1, 'BTREE' => 1, 'CACHE' => 1, 'CHAIN' => 1, 'CLOSE' => 1, 'ERROR' => 1, 'EVENT' => 1, 'EVERY' => 1, 'FIRST' => 1, 'FIXED' => 1, 'FLUSH' => 1, 'FOUND' => 1, 'HOSTS' => 1, 'LEVEL' => 1, 'LOCAL' => 1, 'LOCKS' => 1, 'MERGE' => 1, 'MUTEX' => 1, 'NAMES' => 1, 'NCHAR' => 1, 'OWNER' => 1, 'PHASE' => 1, 'PROXY' => 1, 'QUERY' => 1, 'QUICK' => 1, 'RELAY' => 1, 'RESET' => 1, 'RTREE' => 1, 'SHARE' => 1, 'SLAVE' => 1, 'START' => 1, 'SUPER' => 1, 'SWAPS' => 1, 'TYPES' => 1, 'UNTIL' => 1, 'VALUE' => 1, 'ACTION' => 1, 'BACKUP' => 1, 'BINLOG' => 1, 'CIPHER' => 1, 'CLIENT' => 1, 'COMMIT' => 1, 'ENABLE' => 1, 'ENGINE' => 1, 'ERRORS' => 1, 'ESCAPE' => 1, 'EVENTS' => 1, 'FAULTS' => 1, 'FIELDS' => 1, 'GLOBAL' => 1, 'GRANTS' => 1, 'IMPORT' => 1, 'INNODB' => 1, 'ISSUER' => 1, 'LEAVES' => 1, 'MASTER' => 1, 'MEDIUM' => 1, 'MEMORY' => 1, 'MODIFY' => 1, 'OFFSET' => 1, 'PARSER' => 1, 'PLUGIN' => 1, 'RELOAD' => 1, 'REMOVE' => 1, 'REPAIR' => 1, 'RESUME' => 1, 'ROLLUP' => 1, 'SERVER' => 1, 'SIGNED' => 1, 'SIMPLE' => 1, 'SOCKET' => 1, 'SONAME' => 1, 'SOUNDS' => 1, 'SOURCE' => 1, 'STARTS' => 1, 'STATUS' => 1, 'STRING' => 1, 'TABLES' => 1, 'AUTHORS' => 1, 'CHANGED' => 1, 'COLUMNS' => 1, 'COMMENT' => 1, 'COMPACT' => 1, 'CONTEXT' => 1, 'DEFINER' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DYNAMIC' => 1, 'ENGINES' => 1, 'EXECUTE' => 1, 'GENERAL' => 1, 'HANDLER' => 1, 'INDEXES' => 1, 'INSTALL' => 1, 'INVOKER' => 1, 'LOGFILE' => 1, 'MIGRATE' => 1, 'NO_WAIT' => 1, 'OPTIONS' => 1, 'PARTIAL' => 1, 'PLUGINS' => 1, 'PREPARE' => 1, 'PROFILE' => 1, 'REBUILD' => 1, 'RECOVER' => 1, 'RESTORE' => 1, 'RETURNS' => 1, 'ROUTINE' => 1, 'SESSION' => 1, 'STORAGE' => 1, 'SUBJECT' => 1, 'SUSPEND' => 1, 'UNICODE' => 1, 'UNKNOWN' => 1, 'UPGRADE' => 1, 'USE_FRM' => 1, 'VIRTUAL' => 1, 'WRAPPER' => 1, 'CASCADED' => 1, 'CHECKSUM' => 1, 'DATAFILE' => 1, 'DUMPFILE' => 1, 'EXTENDED' => 1, 'FUNCTION' => 1, 'INNOBASE' => 1, 'LANGUAGE' => 1, 'MAX_ROWS' => 1, 'MAX_SIZE' => 1, 'MIN_ROWS' => 1, 'NATIONAL' => 1, 'NVARCHAR' => 1, 'ONE_SHOT' => 1, 'PRESERVE' => 1, 'PROFILES' => 1, 'REDOFILE' => 1, 'RELAYLOG' => 1, 'ROLLBACK' => 1, 'SCHEDULE' => 1, 'SECURITY' => 1, 'SHUTDOWN' => 1, 'SNAPSHOT' => 1, 'SWITCHES' => 1, 'TRIGGERS' => 1, 'UNDOFILE' => 1, 'WARNINGS' => 1, 'AGGREGATE' => 1, 'ALGORITHM' => 1, 'COMMITTED' => 1, 'DIRECTORY' => 1, 'DUPLICATE' => 1, 'EXPANSION' => 1, 'IO_THREAD' => 1, 'ISOLATION' => 1, 'NODEGROUP' => 1, 'PACK_KEYS' => 1, 'PARTITION' => 1, 'READ_ONLY' => 1, 'REDUNDANT' => 1, 'SAVEPOINT' => 1, 'SQL_CACHE' => 1, 'TEMPORARY' => 1, 'TEMPTABLE' => 1, 'UNDEFINED' => 1, 'UNINSTALL' => 1, 'VARIABLES' => 1, 'COMPLETION' => 1, 'COMPRESSED' => 1, 'CONCURRENT' => 1, 'CONNECTION' => 1, 'CONSISTENT' => 1, 'DEALLOCATE' => 1, 'IDENTIFIED' => 1, 'MASTER_SSL' => 1, 'NDBCLUSTER' => 1, 'PARTITIONS' => 1, 'PERSISTENT' => 1, 'PRIVILEGES' => 1, 'REORGANIZE' => 1, 'REPEATABLE' => 1, 'ROW_FORMAT' => 1, 'SQL_THREAD' => 1, 'TABLESPACE' => 1, 'TABLE_NAME' => 1, 'COLUMN_NAME' => 1, 'CURSOR_NAME' => 1, 'EXTENT_SIZE' => 1, 'FRAC_SECOND' => 1, 'MASTER_HOST' => 1, 'MASTER_PORT' => 1, 'MASTER_USER' => 1, 'MYSQL_ERRNO' => 1, 'PROCESSLIST' => 1, 'REPLICATION' => 1, 'SCHEMA_NAME' => 1, 'SQL_TSI_DAY' => 1, 'TRANSACTION' => 1, 'UNCOMMITTED' => 1, 'CATALOG_NAME' => 1, 'CLASS_ORIGIN' => 1, 'CONTRIBUTORS' => 1, 'DES_KEY_FILE' => 1, 'INITIAL_SIZE' => 1, 'MESSAGE_TEXT' => 1, 'PARTITIONING' => 1, 'RELAY_THREAD' => 1, 'SERIALIZABLE' => 1, 'SQL_NO_CACHE' => 1, 'SQL_TSI_HOUR' => 1, 'SQL_TSI_WEEK' => 1, 'SQL_TSI_YEAR' => 1, 'SUBPARTITION' => 1, 'INSERT_METHOD' => 1, 'MASTER_SSL_CA' => 1, 'RELAY_LOG_POS' => 1, 'SQL_TSI_MONTH' => 1, 'SUBPARTITIONS' => 1, 'AUTO_INCREMENT' => 1, 'AVG_ROW_LENGTH' => 1, 'KEY_BLOCK_SIZE' => 1, 'MASTER_LOG_POS' => 1, 'MASTER_SSL_KEY' => 1, 'RELAY_LOG_FILE' => 1, 'SQL_TSI_MINUTE' => 1, 'SQL_TSI_SECOND' => 1, 'TABLE_CHECKSUM' => 1, 'USER_RESOURCES' => 1, 'AUTOEXTEND_SIZE' => 1, 'CONSTRAINT_NAME' => 1, 'DELAY_KEY_WRITE' => 1, 'MASTER_LOG_FILE' => 1, 'MASTER_PASSWORD' => 1, 'MASTER_SSL_CERT' => 1, 'SQL_TSI_QUARTER' => 1, 'SUBCLASS_ORIGIN' => 1, 'MASTER_SERVER_ID' => 1, 'REDO_BUFFER_SIZE' => 1, 'UNDO_BUFFER_SIZE' => 1, 'CONSTRAINT_SCHEMA' => 1, 'IGNORE_SERVER_IDS' => 1, 'MASTER_SSL_CAPATH' => 1, 'MASTER_SSL_CIPHER' => 1, 'SQL_BUFFER_RESULT' => 1, 'CONSTRAINT_CATALOG' => 1, 'SQL_TSI_FRAC_SECOND' => 1, 'MASTER_CONNECT_RETRY' => 1, 'MAX_QUERIES_PER_HOUR' => 1, 'MAX_UPDATES_PER_HOUR' => 1, 'MAX_USER_CONNECTIONS' => 1, 'MASTER_HEARTBEAT_PERIOD' => 1, 'MAX_CONNECTIONS_PER_HOUR' => 1, 'AS' => 3, 'BY' => 3, 'IS' => 3, 'ON' => 3, 'OR' => 3, 'TO' => 3, 'ADD' => 3, 'ALL' => 3, 'AND' => 3, 'ASC' => 3, 'DEC' => 3, 'DIV' => 3, 'FOR' => 3, 'NOT' => 3, 'OUT' => 3, 'SQL' => 3, 'SSL' => 3, 'USE' => 3, 'XOR' => 3, 'BOTH' => 3, 'CALL' => 3, 'CASE' => 3, 'DESC' => 3, 'DROP' => 3, 'DUAL' => 3, 'EACH' => 3, 'ELSE' => 3, 'EXIT' => 3, 'FROM' => 3, 'INT1' => 3, 'INT2' => 3, 'INT3' => 3, 'INT4' => 3, 'INT8' => 3, 'INTO' => 3, 'JOIN' => 3, 'KEYS' => 3, 'KILL' => 3, 'LIKE' => 3, 'LOAD' => 3, 'LOCK' => 3, 'LONG' => 3, 'LOOP' => 3, 'NULL' => 3, 'READ' => 3, 'SHOW' => 3, 'THEN' => 3, 'TRUE' => 3, 'UNDO' => 3, 'WHEN' => 3, 'WITH' => 3, 'ALTER' => 3, 'CHECK' => 3, 'CROSS' => 3, 'FALSE' => 3, 'FETCH' => 3, 'FORCE' => 3, 'GRANT' => 3, 'GROUP' => 3, 'INNER' => 3, 'INOUT' => 3, 'LEAVE' => 3, 'LIMIT' => 3, 'LINES' => 3, 'ORDER' => 3, 'OUTER' => 3, 'PURGE' => 3, 'RANGE' => 3, 'READS' => 3, 'RLIKE' => 3, 'TABLE' => 3, 'UNION' => 3, 'USAGE' => 3, 'USING' => 3, 'WHERE' => 3, 'WHILE' => 3, 'WRITE' => 3, 'BEFORE' => 3, 'CHANGE' => 3, 'COLUMN' => 3, 'CREATE' => 3, 'CURSOR' => 3, 'DELETE' => 3, 'ELSEIF' => 3, 'EXISTS' => 3, 'FLOAT4' => 3, 'FLOAT8' => 3, 'HAVING' => 3, 'IGNORE' => 3, 'INFILE' => 3, 'LINEAR' => 3, 'OPTION' => 3, 'REGEXP' => 3, 'RENAME' => 3, 'RETURN' => 3, 'REVOKE' => 3, 'SELECT' => 3, 'SIGNAL' => 3, 'UNLOCK' => 3, 'UPDATE' => 3, 'ANALYZE' => 3, 'BETWEEN' => 3, 'CASCADE' => 3, 'COLLATE' => 3, 'DECLARE' => 3, 'DELAYED' => 3, 'ESCAPED' => 3, 'EXPLAIN' => 3, 'FOREIGN' => 3, 'ITERATE' => 3, 'LEADING' => 3, 'NATURAL' => 3, 'OUTFILE' => 3, 'PRIMARY' => 3, 'RELEASE' => 3, 'REQUIRE' => 3, 'SCHEMAS' => 3, 'TRIGGER' => 3, 'VARYING' => 3, 'CONTINUE' => 3, 'DAY_HOUR' => 3, 'DESCRIBE' => 3, 'DISTINCT' => 3, 'ENCLOSED' => 3, 'MAXVALUE' => 3, 'MODIFIES' => 3, 'OPTIMIZE' => 3, 'RESIGNAL' => 3, 'RESTRICT' => 3, 'SPECIFIC' => 3, 'SQLSTATE' => 3, 'STARTING' => 3, 'TRAILING' => 3, 'UNSIGNED' => 3, 'ZEROFILL' => 3, 'CONDITION' => 3, 'DATABASES' => 3, 'MIDDLEINT' => 3, 'PRECISION' => 3, 'PROCEDURE' => 3, 'SENSITIVE' => 3, 'SEPARATOR' => 3, 'ACCESSIBLE' => 3, 'ASENSITIVE' => 3, 'CONSTRAINT' => 3, 'DAY_MINUTE' => 3, 'DAY_SECOND' => 3, 'OPTIONALLY' => 3, 'READ_WRITE' => 3, 'REFERENCES' => 3, 'SQLWARNING' => 3, 'TERMINATED' => 3, 'YEAR_MONTH' => 3, 'DISTINCTROW' => 3, 'HOUR_MINUTE' => 3, 'HOUR_SECOND' => 3, 'INSENSITIVE' => 3, 'LOW_PRIORITY' => 3, 'SQLEXCEPTION' => 3, 'VARCHARACTER' => 3, 'DETERMINISTIC' => 3, 'HIGH_PRIORITY' => 3, 'MINUTE_SECOND' => 3, 'STRAIGHT_JOIN' => 3, 'SQL_BIG_RESULT' => 3, 'DAY_MICROSECOND' => 3, 'HOUR_MICROSECOND' => 3, 'SQL_SMALL_RESULT' => 3, 'MINUTE_MICROSECOND' => 3, 'NO_WRITE_TO_BINLOG' => 3, 'SECOND_MICROSECOND' => 3, 'SQL_CALC_FOUND_ROWS' => 3, 'MASTER_SSL_VERIFY_SERVER_CERT' => 3, 'GROUP BY' => 7, 'NOT NULL' => 7, 'ORDER BY' => 7, 'SET NULL' => 7, 'AND CHAIN' => 7, 'FULL JOIN' => 7, 'IF EXISTS' => 7, 'LEFT JOIN' => 7, 'LESS THAN' => 7, 'LOAD DATA' => 7, 'NO ACTION' => 7, 'ON DELETE' => 7, 'ON UPDATE' => 7, 'UNION ALL' => 7, 'CROSS JOIN' => 7, 'ESCAPED BY' => 7, 'FOR UPDATE' => 7, 'INNER JOIN' => 7, 'LINEAR KEY' => 7, 'NO RELEASE' => 7, 'OR REPLACE' => 7, 'RIGHT JOIN' => 7, 'ENCLOSED BY' => 7, 'LINEAR HASH' => 7, 'STARTING BY' => 7, 'AND NO CHAIN' => 7, 'FOR EACH ROW' => 7, 'NATURAL JOIN' => 7, 'PARTITION BY' => 7, 'SET PASSWORD' => 7, 'SQL SECURITY' => 7, 'CHARACTER SET' => 7, 'IF NOT EXISTS' => 7, 'TERMINATED BY' => 7, 'DATA DIRECTORY' => 7, 'UNION DISTINCT' => 7, 'DEFAULT CHARSET' => 7, 'DEFAULT COLLATE' => 7, 'FULL OUTER JOIN' => 7, 'INDEX DIRECTORY' => 7, 'LEFT OUTER JOIN' => 7, 'SUBPARTITION BY' => 7, 'GENERATED ALWAYS' => 7, 'RIGHT OUTER JOIN' => 7, 'NATURAL LEFT JOIN' => 7, 'START TRANSACTION' => 7, 'LOCK IN SHARE MODE' => 7, 'NATURAL RIGHT JOIN' => 7, 'SELECT TRANSACTION' => 7, 'DEFAULT CHARACTER SET' => 7, 'NATURAL LEFT OUTER JOIN' => 7, 'NATURAL RIGHT OUTER JOIN' => 7, 'WITH CONSISTENT SNAPSHOT' => 7, 'BIT' => 9, 'XML' => 9, 'ENUM' => 9, 'JSON' => 9, 'TEXT' => 9, 'ARRAY' => 9, 'SERIAL' => 9, 'BOOLEAN' => 9, 'DATETIME' => 9, 'GEOMETRY' => 9, 'MULTISET' => 9, 'MULTILINEPOINT' => 9, 'MULTILINEPOLYGON' => 9, 'INT' => 11, 'SET' => 11, 'BLOB' => 11, 'REAL' => 11, 'FLOAT' => 11, 'BIGINT' => 11, 'DOUBLE' => 11, 'DECIMAL' => 11, 'INTEGER' => 11, 'NUMERIC' => 11, 'TINYINT' => 11, 'VARCHAR' => 11, 'LONGBLOB' => 11, 'LONGTEXT' => 11, 'SMALLINT' => 11, 'TINYBLOB' => 11, 'TINYTEXT' => 11, 'CHARACTER' => 11, 'MEDIUMINT' => 11, 'VARBINARY' => 11, 'MEDIUMBLOB' => 11, 'MEDIUMTEXT' => 11, 'BINARY VARYING' => 15, 'KEY' => 19, 'INDEX' => 19, 'UNIQUE' => 19, 'SPATIAL' => 19, 'FULLTEXT' => 19, 'INDEX KEY' => 23, 'UNIQUE KEY' => 23, 'FOREIGN KEY' => 23, 'PRIMARY KEY' => 23, 'SPATIAL KEY' => 23, 'FULLTEXT KEY' => 23, 'UNIQUE INDEX' => 23, 'SPATIAL INDEX' => 23, 'FULLTEXT INDEX' => 23, 'X' => 33, 'Y' => 33, 'LN' => 33, 'PI' => 33, 'ABS' => 33, 'AVG' => 33, 'BIN' => 33, 'COS' => 33, 'COT' => 33, 'DAY' => 33, 'ELT' => 33, 'EXP' => 33, 'HEX' => 33, 'LOG' => 33, 'MAX' => 33, 'MD5' => 33, 'MID' => 33, 'MIN' => 33, 'NOW' => 33, 'OCT' => 33, 'ORD' => 33, 'POW' => 33, 'SHA' => 33, 'SIN' => 33, 'STD' => 33, 'SUM' => 33, 'TAN' => 33, 'ACOS' => 33, 'AREA' => 33, 'ASIN' => 33, 'ATAN' => 33, 'CAST' => 33, 'CEIL' => 33, 'CONV' => 33, 'HOUR' => 33, 'LOG2' => 33, 'LPAD' => 33, 'RAND' => 33, 'RPAD' => 33, 'SHA1' => 33, 'SHA2' => 33, 'SIGN' => 33, 'SQRT' => 33, 'SRID' => 33, 'TRIM' => 33, 'USER' => 33, 'UUID' => 33, 'WEEK' => 33, 'ASCII' => 33, 'ASWKB' => 33, 'ASWKT' => 33, 'ATAN2' => 33, 'COUNT' => 33, 'CRC32' => 33, 'FIELD' => 33, 'FLOOR' => 33, 'INSTR' => 33, 'LCASE' => 33, 'LEAST' => 33, 'LOG10' => 33, 'LOWER' => 33, 'LTRIM' => 33, 'MONTH' => 33, 'POWER' => 33, 'QUOTE' => 33, 'ROUND' => 33, 'RTRIM' => 33, 'SLEEP' => 33, 'SPACE' => 33, 'UCASE' => 33, 'UNHEX' => 33, 'UPPER' => 33, 'ASTEXT' => 33, 'BIT_OR' => 33, 'CONCAT' => 33, 'DECODE' => 33, 'ENCODE' => 33, 'EQUALS' => 33, 'FORMAT' => 33, 'IFNULL' => 33, 'ISNULL' => 33, 'LENGTH' => 33, 'LOCATE' => 33, 'MINUTE' => 33, 'NULLIF' => 33, 'POINTN' => 33, 'SECOND' => 33, 'STDDEV' => 33, 'STRCMP' => 33, 'SUBSTR' => 33, 'WITHIN' => 33, 'ADDDATE' => 33, 'ADDTIME' => 33, 'AGAINST' => 33, 'BIT_AND' => 33, 'BIT_XOR' => 33, 'CEILING' => 33, 'CHARSET' => 33, 'CROSSES' => 33, 'CURDATE' => 33, 'CURTIME' => 33, 'DAYNAME' => 33, 'DEGREES' => 33, 'ENCRYPT' => 33, 'EXTRACT' => 33, 'GLENGTH' => 33, 'ISEMPTY' => 33, 'QUARTER' => 33, 'RADIANS' => 33, 'REVERSE' => 33, 'SOUNDEX' => 33, 'SUBDATE' => 33, 'SUBTIME' => 33, 'SYSDATE' => 33, 'TOUCHES' => 33, 'TO_DAYS' => 33, 'VAR_POP' => 33, 'VERSION' => 33, 'WEEKDAY' => 33, 'ASBINARY' => 33, 'CENTROID' => 33, 'COALESCE' => 33, 'COMPRESS' => 33, 'CONTAINS' => 33, 'DATEDIFF' => 33, 'DATE_ADD' => 33, 'DATE_SUB' => 33, 'DISJOINT' => 33, 'ENDPOINT' => 33, 'ENVELOPE' => 33, 'GET_LOCK' => 33, 'GREATEST' => 33, 'ISCLOSED' => 33, 'ISSIMPLE' => 33, 'MAKEDATE' => 33, 'MAKETIME' => 33, 'MAKE_SET' => 33, 'MBREQUAL' => 33, 'OVERLAPS' => 33, 'PASSWORD' => 33, 'POSITION' => 33, 'TIMEDIFF' => 33, 'TRUNCATE' => 33, 'VARIANCE' => 33, 'VAR_SAMP' => 33, 'YEARWEEK' => 33, 'BENCHMARK' => 33, 'BIT_COUNT' => 33, 'COLLATION' => 33, 'CONCAT_WS' => 33, 'DAYOFWEEK' => 33, 'DAYOFYEAR' => 33, 'DIMENSION' => 33, 'FROM_DAYS' => 33, 'GEOMETRYN' => 33, 'INET_ATON' => 33, 'INET_NTOA' => 33, 'LOAD_FILE' => 33, 'MBRWITHIN' => 33, 'MONTHNAME' => 33, 'NUMPOINTS' => 33, 'ROW_COUNT' => 33, 'SUBSTRING' => 33, 'UPDATEXML' => 33, 'BIT_LENGTH' => 33, 'CONVERT_TZ' => 33, 'DAYOFMONTH' => 33, 'EXPORT_SET' => 33, 'FOUND_ROWS' => 33, 'GET_FORMAT' => 33, 'INTERSECTS' => 33, 'MBRTOUCHES' => 33, 'MULTIPOINT' => 33, 'NAME_CONST' => 33, 'PERIOD_ADD' => 33, 'STARTPOINT' => 33, 'STDDEV_POP' => 33, 'TO_SECONDS' => 33, 'UNCOMPRESS' => 33, 'UUID_SHORT' => 33, 'WEEKOFYEAR' => 33, 'AES_DECRYPT' => 33, 'AES_ENCRYPT' => 33, 'CHAR_LENGTH' => 33, 'DATE_FORMAT' => 33, 'DES_DECRYPT' => 33, 'DES_ENCRYPT' => 33, 'FIND_IN_SET' => 33, 'GEOMFROMWKB' => 33, 'LINEFROMWKB' => 33, 'MBRCONTAINS' => 33, 'MBRDISJOINT' => 33, 'MBROVERLAPS' => 33, 'MICROSECOND' => 33, 'PERIOD_DIFF' => 33, 'POLYFROMWKB' => 33, 'SEC_TO_TIME' => 33, 'STDDEV_SAMP' => 33, 'STR_TO_DATE' => 33, 'SYSTEM_USER' => 33, 'TIME_FORMAT' => 33, 'TIME_TO_SEC' => 33, 'COERCIBILITY' => 33, 'EXTERIORRING' => 33, 'EXTRACTVALUE' => 33, 'GEOMETRYTYPE' => 33, 'GEOMFROMTEXT' => 33, 'GROUP_CONCAT' => 33, 'IS_FREE_LOCK' => 33, 'IS_USED_LOCK' => 33, 'LINEFROMTEXT' => 33, 'MLINEFROMWKB' => 33, 'MPOLYFROMWKB' => 33, 'MULTIPOLYGON' => 33, 'OCTET_LENGTH' => 33, 'OLD_PASSWORD' => 33, 'POINTFROMWKB' => 33, 'POLYFROMTEXT' => 33, 'RELEASE_LOCK' => 33, 'SESSION_USER' => 33, 'TIMESTAMPADD' => 33, 'CONNECTION_ID' => 33, 'FROM_UNIXTIME' => 33, 'INTERIORRINGN' => 33, 'MBRINTERSECTS' => 33, 'MLINEFROMTEXT' => 33, 'MPOINTFROMWKB' => 33, 'MPOLYFROMTEXT' => 33, 'NUMGEOMETRIES' => 33, 'POINTFROMTEXT' => 33, 'TIMESTAMPDIFF' => 33, 'LAST_INSERT_ID' => 33, 'MPOINTFROMTEXT' => 33, 'POLYGONFROMWKB' => 33, 'UNIX_TIMESTAMP' => 33, 'GEOMCOLLFROMWKB' => 33, 'MASTER_POS_WAIT' => 33, 'POLYGONFROMTEXT' => 33, 'SUBSTRING_INDEX' => 33, 'CHARACTER_LENGTH' => 33, 'GEOMCOLLFROMTEXT' => 33, 'GEOMETRYFROMTEXT' => 33, 'NUMINTERIORRINGS' => 33, 'LINESTRINGFROMWKB' => 33, 'MULTIPOINTFROMWKB' => 33, 'MULTIPOINTFROMTEXT' => 33, 'MULTIPOLYGONFROMWKB' => 33, 'UNCOMPRESSED_LENGTH' => 33, 'MULTIPOLYGONFROMTEXT' => 33, 'MULTILINESTRINGFROMWKB' => 33, 'MULTILINESTRINGFROMTEXT' => 33, 'GEOMETRYCOLLECTIONFROMWKB' => 33, 'GEOMETRYCOLLECTIONFROMTEXT' => 33, 'IF' => 35, 'IN' => 35, 'MOD' => 35, 'LEFT' => 35, 'MATCH' => 35, 'RIGHT' => 35, 'INSERT' => 35, 'REPEAT' => 35, 'SCHEMA' => 35, 'VALUES' => 35, 'CONVERT' => 35, 'DEFAULT' => 35, 'REPLACE' => 35, 'DATABASE' => 35, 'UTC_DATE' => 35, 'UTC_TIME' => 35, 'LOCALTIME' => 35, 'CURRENT_DATE' => 35, 'CURRENT_TIME' => 35, 'CURRENT_USER' => 35, 'UTC_TIMESTAMP' => 35, 'LOCALTIMESTAMP' => 35, 'CURRENT_TIMESTAMP' => 35, 'NOT IN' => 39, 'DATE' => 41, 'TIME' => 41, 'YEAR' => 41, 'POINT' => 41, 'POLYGON' => 41, 'TIMESTAMP' => 41, 'LINESTRING' => 41, 'MULTILINESTRING' => 41, 'GEOMETRYCOLLECTION' => 41, 'CHAR' => 43, 'BINARY' => 43, 'INTERVAL' => 43);
}
/**
* Context for MySQL 8.0.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextMySql80000 extends \PhpMyAdmin\SqlParser\Context
{
/**
* List of keywords.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* @var array
*/
public static $KEYWORDS = array('AT' => 1, 'DO' => 1, 'IO' => 1, 'NO' => 1, 'XA' => 1, 'ANY' => 1, 'CPU' => 1, 'END' => 1, 'IPC' => 1, 'NDB' => 1, 'NEW' => 1, 'ONE' => 1, 'ROW' => 1, 'XID' => 1, 'BOOL' => 1, 'BYTE' => 1, 'CODE' => 1, 'CUBE' => 1, 'DATA' => 1, 'DISK' => 1, 'ENDS' => 1, 'FAST' => 1, 'FILE' => 1, 'FULL' => 1, 'HASH' => 1, 'HELP' => 1, 'HOST' => 1, 'LAST' => 1, 'LESS' => 1, 'LIST' => 1, 'LOGS' => 1, 'MODE' => 1, 'NAME' => 1, 'NEXT' => 1, 'NONE' => 1, 'ONLY' => 1, 'OPEN' => 1, 'PAGE' => 1, 'PORT' => 1, 'PREV' => 1, 'ROWS' => 1, 'SLOW' => 1, 'SOME' => 1, 'STOP' => 1, 'THAN' => 1, 'TYPE' => 1, 'VIEW' => 1, 'WAIT' => 1, 'WORK' => 1, 'X509' => 1, 'AFTER' => 1, 'BEGIN' => 1, 'BLOCK' => 1, 'BTREE' => 1, 'CACHE' => 1, 'CHAIN' => 1, 'CLOSE' => 1, 'ERROR' => 1, 'EVENT' => 1, 'EVERY' => 1, 'FIRST' => 1, 'FIXED' => 1, 'FLUSH' => 1, 'FOUND' => 1, 'HOSTS' => 1, 'LEVEL' => 1, 'LOCAL' => 1, 'LOCKS' => 1, 'MERGE' => 1, 'MUTEX' => 1, 'NAMES' => 1, 'NCHAR' => 1, 'NEVER' => 1, 'OWNER' => 1, 'PHASE' => 1, 'PROXY' => 1, 'QUERY' => 1, 'QUICK' => 1, 'RELAY' => 1, 'RESET' => 1, 'RTREE' => 1, 'SHARE' => 1, 'SLAVE' => 1, 'START' => 1, 'SUPER' => 1, 'SWAPS' => 1, 'TYPES' => 1, 'UNTIL' => 1, 'VALUE' => 1, 'ACTION' => 1, 'ALWAYS' => 1, 'BACKUP' => 1, 'BINLOG' => 1, 'CIPHER' => 1, 'CLIENT' => 1, 'COMMIT' => 1, 'ENABLE' => 1, 'ENGINE' => 1, 'ERRORS' => 1, 'ESCAPE' => 1, 'EVENTS' => 1, 'EXPIRE' => 1, 'EXPORT' => 1, 'FAULTS' => 1, 'FIELDS' => 1, 'FILTER' => 1, 'GLOBAL' => 1, 'GRANTS' => 1, 'IMPORT' => 1, 'ISSUER' => 1, 'LEAVES' => 1, 'MASTER' => 1, 'MEDIUM' => 1, 'MEMORY' => 1, 'MODIFY' => 1, 'NUMBER' => 1, 'OFFSET' => 1, 'PARSER' => 1, 'PLUGIN' => 1, 'RELOAD' => 1, 'REMOVE' => 1, 'REPAIR' => 1, 'RESUME' => 1, 'ROLLUP' => 1, 'SERVER' => 1, 'SIGNED' => 1, 'SIMPLE' => 1, 'SOCKET' => 1, 'SONAME' => 1, 'SOUNDS' => 1, 'SOURCE' => 1, 'STARTS' => 1, 'STATUS' => 1, 'STRING' => 1, 'TABLES' => 1, 'ACCOUNT' => 1, 'ANALYSE' => 1, 'CHANGED' => 1, 'CHANNEL' => 1, 'COLUMNS' => 1, 'COMMENT' => 1, 'COMPACT' => 1, 'CONTEXT' => 1, 'CURRENT' => 1, 'DEFINER' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DYNAMIC' => 1, 'ENGINES' => 1, 'EXECUTE' => 1, 'FOLLOWS' => 1, 'GENERAL' => 1, 'HANDLER' => 1, 'INDEXES' => 1, 'INSTALL' => 1, 'INVOKER' => 1, 'LOGFILE' => 1, 'MIGRATE' => 1, 'NO_WAIT' => 1, 'OPTIONS' => 1, 'PARTIAL' => 1, 'PLUGINS' => 1, 'PREPARE' => 1, 'PROFILE' => 1, 'REBUILD' => 1, 'RECOVER' => 1, 'RESTORE' => 1, 'RETURNS' => 1, 'ROUTINE' => 1, 'SESSION' => 1, 'STACKED' => 1, 'STORAGE' => 1, 'SUBJECT' => 1, 'SUSPEND' => 1, 'UNICODE' => 1, 'UNKNOWN' => 1, 'UPGRADE' => 1, 'USE_FRM' => 1, 'WITHOUT' => 1, 'WRAPPER' => 1, 'CASCADED' => 1, 'CHECKSUM' => 1, 'DATAFILE' => 1, 'DUMPFILE' => 1, 'EXCHANGE' => 1, 'EXTENDED' => 1, 'FUNCTION' => 1, 'LANGUAGE' => 1, 'MAX_ROWS' => 1, 'MAX_SIZE' => 1, 'MIN_ROWS' => 1, 'NATIONAL' => 1, 'NVARCHAR' => 1, 'PRECEDES' => 1, 'PRESERVE' => 1, 'PROFILES' => 1, 'REDOFILE' => 1, 'RELAYLOG' => 1, 'ROLLBACK' => 1, 'SCHEDULE' => 1, 'SECURITY' => 1, 'SHUTDOWN' => 1, 'SNAPSHOT' => 1, 'SWITCHES' => 1, 'TRIGGERS' => 1, 'UNDOFILE' => 1, 'WARNINGS' => 1, 'AGGREGATE' => 1, 'ALGORITHM' => 1, 'COMMITTED' => 1, 'DIRECTORY' => 1, 'DUPLICATE' => 1, 'EXPANSION' => 1, 'IO_THREAD' => 1, 'ISOLATION' => 1, 'NODEGROUP' => 1, 'PACK_KEYS' => 1, 'READ_ONLY' => 1, 'REDUNDANT' => 1, 'SAVEPOINT' => 1, 'SQL_CACHE' => 1, 'TEMPORARY' => 1, 'TEMPTABLE' => 1, 'UNDEFINED' => 1, 'UNINSTALL' => 1, 'VARIABLES' => 1, 'COMPLETION' => 1, 'COMPRESSED' => 1, 'CONCURRENT' => 1, 'CONNECTION' => 1, 'CONSISTENT' => 1, 'DEALLOCATE' => 1, 'IDENTIFIED' => 1, 'MASTER_SSL' => 1, 'NDBCLUSTER' => 1, 'PARTITIONS' => 1, 'PERSISTENT' => 1, 'PLUGIN_DIR' => 1, 'PRIVILEGES' => 1, 'REORGANIZE' => 1, 'REPEATABLE' => 1, 'ROW_FORMAT' => 1, 'SQL_THREAD' => 1, 'TABLESPACE' => 1, 'TABLE_NAME' => 1, 'VALIDATION' => 1, 'COLUMN_NAME' => 1, 'COMPRESSION' => 1, 'CURSOR_NAME' => 1, 'DIAGNOSTICS' => 1, 'EXTENT_SIZE' => 1, 'MASTER_HOST' => 1, 'MASTER_PORT' => 1, 'MASTER_USER' => 1, 'MYSQL_ERRNO' => 1, 'NONBLOCKING' => 1, 'PROCESSLIST' => 1, 'REPLICATION' => 1, 'SCHEMA_NAME' => 1, 'SQL_TSI_DAY' => 1, 'TRANSACTION' => 1, 'UNCOMMITTED' => 1, 'CATALOG_NAME' => 1, 'CLASS_ORIGIN' => 1, 'DEFAULT_AUTH' => 1, 'DES_KEY_FILE' => 1, 'INITIAL_SIZE' => 1, 'MASTER_DELAY' => 1, 'MESSAGE_TEXT' => 1, 'PARTITIONING' => 1, 'RELAY_THREAD' => 1, 'SERIALIZABLE' => 1, 'SQL_NO_CACHE' => 1, 'SQL_TSI_HOUR' => 1, 'SQL_TSI_WEEK' => 1, 'SQL_TSI_YEAR' => 1, 'SUBPARTITION' => 1, 'COLUMN_FORMAT' => 1, 'INSERT_METHOD' => 1, 'MASTER_SSL_CA' => 1, 'RELAY_LOG_POS' => 1, 'SQL_TSI_MONTH' => 1, 'SUBPARTITIONS' => 1, 'AUTO_INCREMENT' => 1, 'AVG_ROW_LENGTH' => 1, 'KEY_BLOCK_SIZE' => 1, 'MASTER_LOG_POS' => 1, 'MASTER_SSL_CRL' => 1, 'MASTER_SSL_KEY' => 1, 'RELAY_LOG_FILE' => 1, 'SQL_TSI_MINUTE' => 1, 'SQL_TSI_SECOND' => 1, 'TABLE_CHECKSUM' => 1, 'USER_RESOURCES' => 1, 'AUTOEXTEND_SIZE' => 1, 'CONSTRAINT_NAME' => 1, 'DELAY_KEY_WRITE' => 1, 'FILE_BLOCK_SIZE' => 1, 'MASTER_LOG_FILE' => 1, 'MASTER_PASSWORD' => 1, 'MASTER_SSL_CERT' => 1, 'PARSE_GCOL_EXPR' => 1, 'REPLICATE_DO_DB' => 1, 'SQL_AFTER_GTIDS' => 1, 'SQL_TSI_QUARTER' => 1, 'SUBCLASS_ORIGIN' => 1, 'MASTER_SERVER_ID' => 1, 'REDO_BUFFER_SIZE' => 1, 'SQL_BEFORE_GTIDS' => 1, 'STATS_PERSISTENT' => 1, 'UNDO_BUFFER_SIZE' => 1, 'CONSTRAINT_SCHEMA' => 1, 'GROUP_REPLICATION' => 1, 'IGNORE_SERVER_IDS' => 1, 'MASTER_SSL_CAPATH' => 1, 'MASTER_SSL_CIPHER' => 1, 'RETURNED_SQLSTATE' => 1, 'SQL_BUFFER_RESULT' => 1, 'STATS_AUTO_RECALC' => 1, 'CONSTRAINT_CATALOG' => 1, 'MASTER_RETRY_COUNT' => 1, 'MASTER_SSL_CRLPATH' => 1, 'MAX_STATEMENT_TIME' => 1, 'REPLICATE_DO_TABLE' => 1, 'SQL_AFTER_MTS_GAPS' => 1, 'STATS_SAMPLE_PAGES' => 1, 'REPLICATE_IGNORE_DB' => 1, 'MASTER_AUTO_POSITION' => 1, 'MASTER_CONNECT_RETRY' => 1, 'MAX_QUERIES_PER_HOUR' => 1, 'MAX_UPDATES_PER_HOUR' => 1, 'MAX_USER_CONNECTIONS' => 1, 'REPLICATE_REWRITE_DB' => 1, 'REPLICATE_IGNORE_TABLE' => 1, 'MASTER_HEARTBEAT_PERIOD' => 1, 'REPLICATE_WILD_DO_TABLE' => 1, 'MAX_CONNECTIONS_PER_HOUR' => 1, 'REPLICATE_WILD_IGNORE_TABLE' => 1, 'AS' => 3, 'BY' => 3, 'IS' => 3, 'ON' => 3, 'OR' => 3, 'TO' => 3, 'ADD' => 3, 'ALL' => 3, 'AND' => 3, 'ASC' => 3, 'DEC' => 3, 'DIV' => 3, 'FOR' => 3, 'GET' => 3, 'NOT' => 3, 'OUT' => 3, 'SQL' => 3, 'SSL' => 3, 'USE' => 3, 'XOR' => 3, 'BOTH' => 3, 'CALL' => 3, 'CASE' => 3, 'DESC' => 3, 'DROP' => 3, 'DUAL' => 3, 'EACH' => 3, 'ELSE' => 3, 'EXIT' => 3, 'FROM' => 3, 'INT1' => 3, 'INT2' => 3, 'INT3' => 3, 'INT4' => 3, 'INT8' => 3, 'INTO' => 3, 'JOIN' => 3, 'KEYS' => 3, 'KILL' => 3, 'LIKE' => 3, 'LOAD' => 3, 'LOCK' => 3, 'LONG' => 3, 'LOOP' => 3, 'NULL' => 3, 'READ' => 3, 'SHOW' => 3, 'THEN' => 3, 'TRUE' => 3, 'UNDO' => 3, 'WHEN' => 3, 'WITH' => 3, 'ALTER' => 3, 'CHECK' => 3, 'CROSS' => 3, 'FALSE' => 3, 'FETCH' => 3, 'FORCE' => 3, 'GRANT' => 3, 'GROUP' => 3, 'INNER' => 3, 'INOUT' => 3, 'LEAVE' => 3, 'LIMIT' => 3, 'LINES' => 3, 'ORDER' => 3, 'OUTER' => 3, 'PURGE' => 3, 'RANGE' => 3, 'READS' => 3, 'RLIKE' => 3, 'TABLE' => 3, 'UNION' => 3, 'USAGE' => 3, 'USING' => 3, 'WHERE' => 3, 'WHILE' => 3, 'WRITE' => 3, 'BEFORE' => 3, 'CHANGE' => 3, 'COLUMN' => 3, 'CREATE' => 3, 'CURSOR' => 3, 'DELETE' => 3, 'ELSEIF' => 3, 'EXISTS' => 3, 'FLOAT4' => 3, 'FLOAT8' => 3, 'HAVING' => 3, 'IGNORE' => 3, 'INFILE' => 3, 'LINEAR' => 3, 'OPTION' => 3, 'REGEXP' => 3, 'RENAME' => 3, 'RETURN' => 3, 'REVOKE' => 3, 'SELECT' => 3, 'SIGNAL' => 3, 'STORED' => 3, 'UNLOCK' => 3, 'UPDATE' => 3, 'ANALYZE' => 3, 'BETWEEN' => 3, 'CASCADE' => 3, 'COLLATE' => 3, 'DECLARE' => 3, 'DELAYED' => 3, 'ESCAPED' => 3, 'EXPLAIN' => 3, 'FOREIGN' => 3, 'ITERATE' => 3, 'LEADING' => 3, 'NATURAL' => 3, 'OUTFILE' => 3, 'PRIMARY' => 3, 'RELEASE' => 3, 'REQUIRE' => 3, 'SCHEMAS' => 3, 'TRIGGER' => 3, 'VARYING' => 3, 'VIRTUAL' => 3, 'CONTINUE' => 3, 'DAY_HOUR' => 3, 'DESCRIBE' => 3, 'DISTINCT' => 3, 'ENCLOSED' => 3, 'MAXVALUE' => 3, 'MODIFIES' => 3, 'OPTIMIZE' => 3, 'RESIGNAL' => 3, 'RESTRICT' => 3, 'SPECIFIC' => 3, 'SQLSTATE' => 3, 'STARTING' => 3, 'TRAILING' => 3, 'UNSIGNED' => 3, 'ZEROFILL' => 3, 'CONDITION' => 3, 'DATABASES' => 3, 'GENERATED' => 3, 'MIDDLEINT' => 3, 'PARTITION' => 3, 'PRECISION' => 3, 'PROCEDURE' => 3, 'SENSITIVE' => 3, 'SEPARATOR' => 3, 'ACCESSIBLE' => 3, 'ASENSITIVE' => 3, 'CONSTRAINT' => 3, 'DAY_MINUTE' => 3, 'DAY_SECOND' => 3, 'OPTIONALLY' => 3, 'READ_WRITE' => 3, 'REFERENCES' => 3, 'SQLWARNING' => 3, 'TERMINATED' => 3, 'YEAR_MONTH' => 3, 'DISTINCTROW' => 3, 'HOUR_MINUTE' => 3, 'HOUR_SECOND' => 3, 'INSENSITIVE' => 3, 'MASTER_BIND' => 3, 'LOW_PRIORITY' => 3, 'SQLEXCEPTION' => 3, 'VARCHARACTER' => 3, 'DETERMINISTIC' => 3, 'HIGH_PRIORITY' => 3, 'MINUTE_SECOND' => 3, 'STRAIGHT_JOIN' => 3, 'IO_AFTER_GTIDS' => 3, 'SQL_BIG_RESULT' => 3, 'DAY_MICROSECOND' => 3, 'IO_BEFORE_GTIDS' => 3, 'OPTIMIZER_COSTS' => 3, 'HOUR_MICROSECOND' => 3, 'SQL_SMALL_RESULT' => 3, 'MINUTE_MICROSECOND' => 3, 'NO_WRITE_TO_BINLOG' => 3, 'SECOND_MICROSECOND' => 3, 'SQL_CALC_FOUND_ROWS' => 3, 'MASTER_SSL_VERIFY_SERVER_CERT' => 3, 'GROUP BY' => 7, 'NOT NULL' => 7, 'ORDER BY' => 7, 'SET NULL' => 7, 'AND CHAIN' => 7, 'FULL JOIN' => 7, 'IF EXISTS' => 7, 'LEFT JOIN' => 7, 'LESS THAN' => 7, 'LOAD DATA' => 7, 'NO ACTION' => 7, 'ON DELETE' => 7, 'ON UPDATE' => 7, 'UNION ALL' => 7, 'CROSS JOIN' => 7, 'ESCAPED BY' => 7, 'FOR UPDATE' => 7, 'INNER JOIN' => 7, 'LINEAR KEY' => 7, 'NO RELEASE' => 7, 'OR REPLACE' => 7, 'RIGHT JOIN' => 7, 'ENCLOSED BY' => 7, 'LINEAR HASH' => 7, 'STARTING BY' => 7, 'AND NO CHAIN' => 7, 'FOR EACH ROW' => 7, 'NATURAL JOIN' => 7, 'PARTITION BY' => 7, 'SET PASSWORD' => 7, 'SQL SECURITY' => 7, 'CHARACTER SET' => 7, 'IF NOT EXISTS' => 7, 'TERMINATED BY' => 7, 'DATA DIRECTORY' => 7, 'UNION DISTINCT' => 7, 'DEFAULT CHARSET' => 7, 'DEFAULT COLLATE' => 7, 'FULL OUTER JOIN' => 7, 'INDEX DIRECTORY' => 7, 'LEFT OUTER JOIN' => 7, 'SUBPARTITION BY' => 7, 'GENERATED ALWAYS' => 7, 'RIGHT OUTER JOIN' => 7, 'NATURAL LEFT JOIN' => 7, 'START TRANSACTION' => 7, 'LOCK IN SHARE MODE' => 7, 'NATURAL RIGHT JOIN' => 7, 'SELECT TRANSACTION' => 7, 'DEFAULT CHARACTER SET' => 7, 'NATURAL LEFT OUTER JOIN' => 7, 'NATURAL RIGHT OUTER JOIN' => 7, 'WITH CONSISTENT SNAPSHOT' => 7, 'BIT' => 9, 'XML' => 9, 'ENUM' => 9, 'JSON' => 9, 'TEXT' => 9, 'ARRAY' => 9, 'SERIAL' => 9, 'BOOLEAN' => 9, 'DATETIME' => 9, 'GEOMETRY' => 9, 'MULTISET' => 9, 'MULTILINEPOINT' => 9, 'MULTILINEPOLYGON' => 9, 'INT' => 11, 'SET' => 11, 'BLOB' => 11, 'REAL' => 11, 'FLOAT' => 11, 'BIGINT' => 11, 'DOUBLE' => 11, 'DECIMAL' => 11, 'INTEGER' => 11, 'NUMERIC' => 11, 'TINYINT' => 11, 'VARCHAR' => 11, 'LONGBLOB' => 11, 'LONGTEXT' => 11, 'SMALLINT' => 11, 'TINYBLOB' => 11, 'TINYTEXT' => 11, 'CHARACTER' => 11, 'MEDIUMINT' => 11, 'VARBINARY' => 11, 'MEDIUMBLOB' => 11, 'MEDIUMTEXT' => 11, 'BINARY VARYING' => 15, 'KEY' => 19, 'INDEX' => 19, 'UNIQUE' => 19, 'SPATIAL' => 19, 'FULLTEXT' => 19, 'INDEX KEY' => 23, 'UNIQUE KEY' => 23, 'FOREIGN KEY' => 23, 'PRIMARY KEY' => 23, 'SPATIAL KEY' => 23, 'FULLTEXT KEY' => 23, 'UNIQUE INDEX' => 23, 'SPATIAL INDEX' => 23, 'FULLTEXT INDEX' => 23, 'X' => 33, 'Y' => 33, 'LN' => 33, 'PI' => 33, 'ABS' => 33, 'AVG' => 33, 'BIN' => 33, 'COS' => 33, 'COT' => 33, 'DAY' => 33, 'ELT' => 33, 'EXP' => 33, 'HEX' => 33, 'LOG' => 33, 'MAX' => 33, 'MD5' => 33, 'MID' => 33, 'MIN' => 33, 'NOW' => 33, 'OCT' => 33, 'ORD' => 33, 'POW' => 33, 'SHA' => 33, 'SIN' => 33, 'STD' => 33, 'SUM' => 33, 'TAN' => 33, 'ACOS' => 33, 'AREA' => 33, 'ASIN' => 33, 'ATAN' => 33, 'CAST' => 33, 'CEIL' => 33, 'CONV' => 33, 'HOUR' => 33, 'LOG2' => 33, 'LPAD' => 33, 'RAND' => 33, 'RPAD' => 33, 'SHA1' => 33, 'SHA2' => 33, 'SIGN' => 33, 'SQRT' => 33, 'SRID' => 33, 'ST_X' => 33, 'ST_Y' => 33, 'TRIM' => 33, 'USER' => 33, 'UUID' => 33, 'WEEK' => 33, 'ASCII' => 33, 'ASWKB' => 33, 'ASWKT' => 33, 'ATAN2' => 33, 'COUNT' => 33, 'CRC32' => 33, 'FIELD' => 33, 'FLOOR' => 33, 'INSTR' => 33, 'LCASE' => 33, 'LEAST' => 33, 'LOG10' => 33, 'LOWER' => 33, 'LTRIM' => 33, 'MONTH' => 33, 'POWER' => 33, 'QUOTE' => 33, 'ROUND' => 33, 'RTRIM' => 33, 'SLEEP' => 33, 'SPACE' => 33, 'UCASE' => 33, 'UNHEX' => 33, 'UPPER' => 33, 'ASTEXT' => 33, 'BIT_OR' => 33, 'BUFFER' => 33, 'CONCAT' => 33, 'DECODE' => 33, 'ENCODE' => 33, 'EQUALS' => 33, 'FORMAT' => 33, 'IFNULL' => 33, 'ISNULL' => 33, 'LENGTH' => 33, 'LOCATE' => 33, 'MINUTE' => 33, 'NULLIF' => 33, 'POINTN' => 33, 'SECOND' => 33, 'STDDEV' => 33, 'STRCMP' => 33, 'SUBSTR' => 33, 'WITHIN' => 33, 'ADDDATE' => 33, 'ADDTIME' => 33, 'AGAINST' => 33, 'BIT_AND' => 33, 'BIT_XOR' => 33, 'CEILING' => 33, 'CHARSET' => 33, 'CROSSES' => 33, 'CURDATE' => 33, 'CURTIME' => 33, 'DAYNAME' => 33, 'DEGREES' => 33, 'ENCRYPT' => 33, 'EXTRACT' => 33, 'GLENGTH' => 33, 'ISEMPTY' => 33, 'IS_IPV4' => 33, 'IS_IPV6' => 33, 'IS_UUID' => 33, 'QUARTER' => 33, 'RADIANS' => 33, 'REVERSE' => 33, 'SOUNDEX' => 33, 'ST_AREA' => 33, 'ST_SRID' => 33, 'SUBDATE' => 33, 'SUBTIME' => 33, 'SYSDATE' => 33, 'TOUCHES' => 33, 'TO_DAYS' => 33, 'VAR_POP' => 33, 'VERSION' => 33, 'WEEKDAY' => 33, 'ASBINARY' => 33, 'CENTROID' => 33, 'COALESCE' => 33, 'COMPRESS' => 33, 'CONTAINS' => 33, 'DATEDIFF' => 33, 'DATE_ADD' => 33, 'DATE_SUB' => 33, 'DISJOINT' => 33, 'DISTANCE' => 33, 'ENDPOINT' => 33, 'ENVELOPE' => 33, 'GET_LOCK' => 33, 'GREATEST' => 33, 'ISCLOSED' => 33, 'ISSIMPLE' => 33, 'JSON_SET' => 33, 'MAKEDATE' => 33, 'MAKETIME' => 33, 'MAKE_SET' => 33, 'MBREQUAL' => 33, 'OVERLAPS' => 33, 'PASSWORD' => 33, 'POSITION' => 33, 'ST_ASWKB' => 33, 'ST_ASWKT' => 33, 'ST_UNION' => 33, 'TIMEDIFF' => 33, 'TRUNCATE' => 33, 'VARIANCE' => 33, 'VAR_SAMP' => 33, 'YEARWEEK' => 33, 'ANY_VALUE' => 33, 'BENCHMARK' => 33, 'BIT_COUNT' => 33, 'COLLATION' => 33, 'CONCAT_WS' => 33, 'DAYOFWEEK' => 33, 'DAYOFYEAR' => 33, 'DIMENSION' => 33, 'FROM_DAYS' => 33, 'GEOMETRYN' => 33, 'INET_ATON' => 33, 'INET_NTOA' => 33, 'JSON_KEYS' => 33, 'JSON_TYPE' => 33, 'LOAD_FILE' => 33, 'MBRCOVERS' => 33, 'MBREQUALS' => 33, 'MBRWITHIN' => 33, 'MONTHNAME' => 33, 'NUMPOINTS' => 33, 'ROW_COUNT' => 33, 'ST_ASTEXT' => 33, 'ST_BUFFER' => 33, 'ST_EQUALS' => 33, 'ST_LENGTH' => 33, 'ST_POINTN' => 33, 'ST_WITHIN' => 33, 'SUBSTRING' => 33, 'TO_BASE64' => 33, 'UPDATEXML' => 33, 'BIT_LENGTH' => 33, 'CONVERT_TZ' => 33, 'CONVEXHULL' => 33, 'DAYOFMONTH' => 33, 'EXPORT_SET' => 33, 'FOUND_ROWS' => 33, 'GET_FORMAT' => 33, 'INET6_ATON' => 33, 'INET6_NTOA' => 33, 'INTERSECTS' => 33, 'JSON_ARRAY' => 33, 'JSON_DEPTH' => 33, 'JSON_MERGE' => 33, 'JSON_QUOTE' => 33, 'JSON_VALID' => 33, 'MBRTOUCHES' => 33, 'MULTIPOINT' => 33, 'NAME_CONST' => 33, 'PERIOD_ADD' => 33, 'STARTPOINT' => 33, 'STDDEV_POP' => 33, 'ST_CROSSES' => 33, 'ST_GEOHASH' => 33, 'ST_ISEMPTY' => 33, 'ST_ISVALID' => 33, 'ST_TOUCHES' => 33, 'TO_SECONDS' => 33, 'UNCOMPRESS' => 33, 'UUID_SHORT' => 33, 'WEEKOFYEAR' => 33, 'AES_DECRYPT' => 33, 'AES_ENCRYPT' => 33, 'BIN_TO_UUID' => 33, 'CHAR_LENGTH' => 33, 'DATE_FORMAT' => 33, 'DES_DECRYPT' => 33, 'DES_ENCRYPT' => 33, 'FIND_IN_SET' => 33, 'FROM_BASE64' => 33, 'GEOMFROMWKB' => 33, 'GTID_SUBSET' => 33, 'JSON_INSERT' => 33, 'JSON_LENGTH' => 33, 'JSON_OBJECT' => 33, 'JSON_PRETTY' => 33, 'JSON_REMOVE' => 33, 'JSON_SEARCH' => 33, 'LINEFROMWKB' => 33, 'MBRCONTAINS' => 33, 'MBRDISJOINT' => 33, 'MBROVERLAPS' => 33, 'MICROSECOND' => 33, 'PERIOD_DIFF' => 33, 'POLYFROMWKB' => 33, 'SEC_TO_TIME' => 33, 'STDDEV_SAMP' => 33, 'STR_TO_DATE' => 33, 'ST_ASBINARY' => 33, 'ST_CENTROID' => 33, 'ST_CONTAINS' => 33, 'ST_DISJOINT' => 33, 'ST_DISTANCE' => 33, 'ST_ENDPOINT' => 33, 'ST_ENVELOPE' => 33, 'ST_ISCLOSED' => 33, 'ST_ISSIMPLE' => 33, 'ST_OVERLAPS' => 33, 'ST_SIMPLIFY' => 33, 'ST_VALIDATE' => 33, 'SYSTEM_USER' => 33, 'TIME_FORMAT' => 33, 'TIME_TO_SEC' => 33, 'UUID_TO_BIN' => 33, 'COERCIBILITY' => 33, 'EXTERIORRING' => 33, 'EXTRACTVALUE' => 33, 'GEOMETRYTYPE' => 33, 'GEOMFROMTEXT' => 33, 'GROUP_CONCAT' => 33, 'IS_FREE_LOCK' => 33, 'IS_USED_LOCK' => 33, 'JSON_EXTRACT' => 33, 'JSON_REPLACE' => 33, 'JSON_UNQUOTE' => 33, 'LINEFROMTEXT' => 33, 'MBRCOVEREDBY' => 33, 'MLINEFROMWKB' => 33, 'MPOLYFROMWKB' => 33, 'MULTIPOLYGON' => 33, 'OCTET_LENGTH' => 33, 'OLD_PASSWORD' => 33, 'POINTFROMWKB' => 33, 'POLYFROMTEXT' => 33, 'RANDOM_BYTES' => 33, 'RELEASE_LOCK' => 33, 'SESSION_USER' => 33, 'ST_ASGEOJSON' => 33, 'ST_DIMENSION' => 33, 'ST_GEOMETRYN' => 33, 'ST_NUMPOINTS' => 33, 'TIMESTAMPADD' => 33, 'CONNECTION_ID' => 33, 'FROM_UNIXTIME' => 33, 'GTID_SUBTRACT' => 33, 'INTERIORRINGN' => 33, 'JSON_CONTAINS' => 33, 'MBRINTERSECTS' => 33, 'MLINEFROMTEXT' => 33, 'MPOINTFROMWKB' => 33, 'MPOLYFROMTEXT' => 33, 'NUMGEOMETRIES' => 33, 'POINTFROMTEXT' => 33, 'ST_CONVEXHULL' => 33, 'ST_DIFFERENCE' => 33, 'ST_INTERSECTS' => 33, 'ST_STARTPOINT' => 33, 'TIMESTAMPDIFF' => 33, 'WEIGHT_STRING' => 33, 'IS_IPV4_COMPAT' => 33, 'IS_IPV4_MAPPED' => 33, 'LAST_INSERT_ID' => 33, 'MPOINTFROMTEXT' => 33, 'POLYGONFROMWKB' => 33, 'ST_GEOMFROMWKB' => 33, 'ST_LINEFROMWKB' => 33, 'ST_POLYFROMWKB' => 33, 'UNIX_TIMESTAMP' => 33, 'GEOMCOLLFROMWKB' => 33, 'MASTER_POS_WAIT' => 33, 'POLYGONFROMTEXT' => 33, 'ST_EXTERIORRING' => 33, 'ST_GEOMETRYTYPE' => 33, 'ST_GEOMFROMTEXT' => 33, 'ST_INTERSECTION' => 33, 'ST_LINEFROMTEXT' => 33, 'ST_MAKEENVELOPE' => 33, 'ST_MLINEFROMWKB' => 33, 'ST_MPOLYFROMWKB' => 33, 'ST_POINTFROMWKB' => 33, 'ST_POLYFROMTEXT' => 33, 'SUBSTRING_INDEX' => 33, 'CHARACTER_LENGTH' => 33, 'GEOMCOLLFROMTEXT' => 33, 'GEOMETRYFROMTEXT' => 33, 'JSON_MERGE_PATCH' => 33, 'NUMINTERIORRINGS' => 33, 'ST_INTERIORRINGN' => 33, 'ST_MLINEFROMTEXT' => 33, 'ST_MPOINTFROMWKB' => 33, 'ST_MPOLYFROMTEXT' => 33, 'ST_NUMGEOMETRIES' => 33, 'ST_POINTFROMTEXT' => 33, 'ST_SYMDIFFERENCE' => 33, 'JSON_ARRAY_APPEND' => 33, 'JSON_ARRAY_INSERT' => 33, 'JSON_STORAGE_FREE' => 33, 'JSON_STORAGE_SIZE' => 33, 'LINESTRINGFROMWKB' => 33, 'MULTIPOINTFROMWKB' => 33, 'RELEASE_ALL_LOCKS' => 33, 'ST_LATFROMGEOHASH' => 33, 'ST_MPOINTFROMTEXT' => 33, 'ST_POLYGONFROMWKB' => 33, 'JSON_CONTAINS_PATH' => 33, 'MULTIPOINTFROMTEXT' => 33, 'ST_BUFFER_STRATEGY' => 33, 'ST_DISTANCE_SPHERE' => 33, 'ST_GEOMCOLLFROMTXT' => 33, 'ST_GEOMCOLLFROMWKB' => 33, 'ST_GEOMFROMGEOJSON' => 33, 'ST_LONGFROMGEOHASH' => 33, 'ST_POLYGONFROMTEXT' => 33, 'JSON_MERGE_PRESERVE' => 33, 'MULTIPOLYGONFROMWKB' => 33, 'ST_GEOMCOLLFROMTEXT' => 33, 'ST_GEOMETRYFROMTEXT' => 33, 'ST_NUMINTERIORRINGS' => 33, 'ST_POINTFROMGEOHASH' => 33, 'UNCOMPRESSED_LENGTH' => 33, 'MULTIPOLYGONFROMTEXT' => 33, 'ST_LINESTRINGFROMWKB' => 33, 'ST_MULTIPOINTFROMWKB' => 33, 'ST_MULTIPOINTFROMTEXT' => 33, 'MULTILINESTRINGFROMWKB' => 33, 'ST_MULTIPOLYGONFROMWKB' => 33, 'MULTILINESTRINGFROMTEXT' => 33, 'ST_MULTIPOLYGONFROMTEXT' => 33, 'GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_MULTILINESTRINGFROMWKB' => 33, 'GEOMETRYCOLLECTIONFROMTEXT' => 33, 'ST_MULTILINESTRINGFROMTEXT' => 33, 'VALIDATE_PASSWORD_STRENGTH' => 33, 'WAIT_FOR_EXECUTED_GTID_SET' => 33, 'ST_GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_GEOMETRYCOLLECTIONFROMTEXT' => 33, 'WAIT_UNTIL_SQL_THREAD_AFTER_GTIDS' => 33, 'IF' => 35, 'IN' => 35, 'MOD' => 35, 'LEFT' => 35, 'MATCH' => 35, 'RIGHT' => 35, 'INSERT' => 35, 'REPEAT' => 35, 'SCHEMA' => 35, 'VALUES' => 35, 'CONVERT' => 35, 'DEFAULT' => 35, 'REPLACE' => 35, 'DATABASE' => 35, 'UTC_DATE' => 35, 'UTC_TIME' => 35, 'LOCALTIME' => 35, 'CURRENT_DATE' => 35, 'CURRENT_TIME' => 35, 'CURRENT_USER' => 35, 'UTC_TIMESTAMP' => 35, 'LOCALTIMESTAMP' => 35, 'CURRENT_TIMESTAMP' => 35, 'NOT IN' => 39, 'DATE' => 41, 'TIME' => 41, 'YEAR' => 41, 'POINT' => 41, 'POLYGON' => 41, 'TIMESTAMP' => 41, 'LINESTRING' => 41, 'MULTILINESTRING' => 41, 'GEOMETRYCOLLECTION' => 41, 'CHAR' => 43, 'BINARY' => 43, 'INTERVAL' => 43);
}
/**
* Context for MySQL 5.6.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextMySql50600 extends \PhpMyAdmin\SqlParser\Context
{
/**
* List of keywords.
*
* The value associated to each keyword represents its flags.
*
* @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED
* Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY
* Token::FLAG_KEYWORD_FUNCTION
*
* @var array
*/
public static $KEYWORDS = array('AT' => 1, 'DO' => 1, 'IO' => 1, 'NO' => 1, 'XA' => 1, 'ANY' => 1, 'CPU' => 1, 'END' => 1, 'IPC' => 1, 'NDB' => 1, 'NEW' => 1, 'ONE' => 1, 'ROW' => 1, 'BOOL' => 1, 'BYTE' => 1, 'CODE' => 1, 'CUBE' => 1, 'DATA' => 1, 'DISK' => 1, 'ENDS' => 1, 'FAST' => 1, 'FILE' => 1, 'FULL' => 1, 'HASH' => 1, 'HELP' => 1, 'HOST' => 1, 'LAST' => 1, 'LESS' => 1, 'LIST' => 1, 'LOGS' => 1, 'MODE' => 1, 'NAME' => 1, 'NEXT' => 1, 'NONE' => 1, 'ONLY' => 1, 'OPEN' => 1, 'PAGE' => 1, 'PORT' => 1, 'PREV' => 1, 'ROWS' => 1, 'SLOW' => 1, 'SOME' => 1, 'STOP' => 1, 'THAN' => 1, 'TYPE' => 1, 'VIEW' => 1, 'WAIT' => 1, 'WORK' => 1, 'X509' => 1, 'AFTER' => 1, 'BEGIN' => 1, 'BLOCK' => 1, 'BTREE' => 1, 'CACHE' => 1, 'CHAIN' => 1, 'CLOSE' => 1, 'ERROR' => 1, 'EVENT' => 1, 'EVERY' => 1, 'FIRST' => 1, 'FIXED' => 1, 'FLUSH' => 1, 'FOUND' => 1, 'HOSTS' => 1, 'LEVEL' => 1, 'LOCAL' => 1, 'LOCKS' => 1, 'MERGE' => 1, 'MUTEX' => 1, 'NAMES' => 1, 'NCHAR' => 1, 'OWNER' => 1, 'PHASE' => 1, 'PROXY' => 1, 'QUERY' => 1, 'QUICK' => 1, 'RELAY' => 1, 'RESET' => 1, 'RTREE' => 1, 'SHARE' => 1, 'SLAVE' => 1, 'START' => 1, 'SUPER' => 1, 'SWAPS' => 1, 'TYPES' => 1, 'UNTIL' => 1, 'VALUE' => 1, 'ACTION' => 1, 'BACKUP' => 1, 'BINLOG' => 1, 'CIPHER' => 1, 'CLIENT' => 1, 'COMMIT' => 1, 'ENABLE' => 1, 'ENGINE' => 1, 'ERRORS' => 1, 'ESCAPE' => 1, 'EVENTS' => 1, 'EXPIRE' => 1, 'EXPORT' => 1, 'FAULTS' => 1, 'FIELDS' => 1, 'GLOBAL' => 1, 'GRANTS' => 1, 'IMPORT' => 1, 'ISSUER' => 1, 'LEAVES' => 1, 'MASTER' => 1, 'MEDIUM' => 1, 'MEMORY' => 1, 'MODIFY' => 1, 'NUMBER' => 1, 'OFFSET' => 1, 'PARSER' => 1, 'PLUGIN' => 1, 'RELOAD' => 1, 'REMOVE' => 1, 'REPAIR' => 1, 'RESUME' => 1, 'ROLLUP' => 1, 'SERVER' => 1, 'SIGNED' => 1, 'SIMPLE' => 1, 'SOCKET' => 1, 'SONAME' => 1, 'SOUNDS' => 1, 'SOURCE' => 1, 'STARTS' => 1, 'STATUS' => 1, 'STRING' => 1, 'TABLES' => 1, 'ANALYSE' => 1, 'AUTHORS' => 1, 'CHANGED' => 1, 'COLUMNS' => 1, 'COMMENT' => 1, 'COMPACT' => 1, 'CONTEXT' => 1, 'CURRENT' => 1, 'DEFINER' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DYNAMIC' => 1, 'ENGINES' => 1, 'EXECUTE' => 1, 'GENERAL' => 1, 'HANDLER' => 1, 'INDEXES' => 1, 'INSTALL' => 1, 'INVOKER' => 1, 'LOGFILE' => 1, 'MIGRATE' => 1, 'NO_WAIT' => 1, 'OPTIONS' => 1, 'PARTIAL' => 1, 'PLUGINS' => 1, 'PREPARE' => 1, 'PROFILE' => 1, 'REBUILD' => 1, 'RECOVER' => 1, 'RESTORE' => 1, 'RETURNS' => 1, 'ROUTINE' => 1, 'SESSION' => 1, 'STORAGE' => 1, 'SUBJECT' => 1, 'SUSPEND' => 1, 'UNICODE' => 1, 'UNKNOWN' => 1, 'UPGRADE' => 1, 'USE_FRM' => 1, 'VIRTUAL' => 1, 'WRAPPER' => 1, 'CASCADED' => 1, 'CHECKSUM' => 1, 'DATAFILE' => 1, 'DUMPFILE' => 1, 'EXCHANGE' => 1, 'EXTENDED' => 1, 'FUNCTION' => 1, 'LANGUAGE' => 1, 'MAX_ROWS' => 1, 'MAX_SIZE' => 1, 'MIN_ROWS' => 1, 'NATIONAL' => 1, 'NVARCHAR' => 1, 'ONE_SHOT' => 1, 'PRESERVE' => 1, 'PROFILES' => 1, 'REDOFILE' => 1, 'RELAYLOG' => 1, 'ROLLBACK' => 1, 'SCHEDULE' => 1, 'SECURITY' => 1, 'SHUTDOWN' => 1, 'SNAPSHOT' => 1, 'SWITCHES' => 1, 'TRIGGERS' => 1, 'UNDOFILE' => 1, 'WARNINGS' => 1, 'AGGREGATE' => 1, 'ALGORITHM' => 1, 'COMMITTED' => 1, 'DIRECTORY' => 1, 'DUPLICATE' => 1, 'EXPANSION' => 1, 'IO_THREAD' => 1, 'ISOLATION' => 1, 'NODEGROUP' => 1, 'PACK_KEYS' => 1, 'READ_ONLY' => 1, 'REDUNDANT' => 1, 'SAVEPOINT' => 1, 'SQL_CACHE' => 1, 'TEMPORARY' => 1, 'TEMPTABLE' => 1, 'UNDEFINED' => 1, 'UNINSTALL' => 1, 'VARIABLES' => 1, 'COMPLETION' => 1, 'COMPRESSED' => 1, 'CONCURRENT' => 1, 'CONNECTION' => 1, 'CONSISTENT' => 1, 'DEALLOCATE' => 1, 'IDENTIFIED' => 1, 'MASTER_SSL' => 1, 'NDBCLUSTER' => 1, 'PARTITIONS' => 1, 'PERSISTENT' => 1, 'PLUGIN_DIR' => 1, 'PRIVILEGES' => 1, 'REORGANIZE' => 1, 'REPEATABLE' => 1, 'ROW_FORMAT' => 1, 'SQL_THREAD' => 1, 'TABLESPACE' => 1, 'TABLE_NAME' => 1, 'COLUMN_NAME' => 1, 'CURSOR_NAME' => 1, 'DIAGNOSTICS' => 1, 'EXTENT_SIZE' => 1, 'MASTER_HOST' => 1, 'MASTER_PORT' => 1, 'MASTER_USER' => 1, 'MYSQL_ERRNO' => 1, 'PROCESSLIST' => 1, 'REPLICATION' => 1, 'SCHEMA_NAME' => 1, 'SQL_TSI_DAY' => 1, 'TRANSACTION' => 1, 'UNCOMMITTED' => 1, 'CATALOG_NAME' => 1, 'CLASS_ORIGIN' => 1, 'CONTRIBUTORS' => 1, 'DEFAULT_AUTH' => 1, 'DES_KEY_FILE' => 1, 'INITIAL_SIZE' => 1, 'MASTER_DELAY' => 1, 'MESSAGE_TEXT' => 1, 'PARTITIONING' => 1, 'RELAY_THREAD' => 1, 'SERIALIZABLE' => 1, 'SQL_NO_CACHE' => 1, 'SQL_TSI_HOUR' => 1, 'SQL_TSI_WEEK' => 1, 'SQL_TSI_YEAR' => 1, 'SUBPARTITION' => 1, 'COLUMN_FORMAT' => 1, 'INSERT_METHOD' => 1, 'MASTER_SSL_CA' => 1, 'RELAY_LOG_POS' => 1, 'SQL_TSI_MONTH' => 1, 'SUBPARTITIONS' => 1, 'AUTO_INCREMENT' => 1, 'AVG_ROW_LENGTH' => 1, 'KEY_BLOCK_SIZE' => 1, 'MASTER_LOG_POS' => 1, 'MASTER_SSL_CRL' => 1, 'MASTER_SSL_KEY' => 1, 'RELAY_LOG_FILE' => 1, 'SQL_TSI_MINUTE' => 1, 'SQL_TSI_SECOND' => 1, 'TABLE_CHECKSUM' => 1, 'USER_RESOURCES' => 1, 'AUTOEXTEND_SIZE' => 1, 'CONSTRAINT_NAME' => 1, 'DELAY_KEY_WRITE' => 1, 'MASTER_LOG_FILE' => 1, 'MASTER_PASSWORD' => 1, 'MASTER_SSL_CERT' => 1, 'SQL_AFTER_GTIDS' => 1, 'SQL_TSI_QUARTER' => 1, 'SUBCLASS_ORIGIN' => 1, 'MASTER_SERVER_ID' => 1, 'REDO_BUFFER_SIZE' => 1, 'SQL_BEFORE_GTIDS' => 1, 'STATS_PERSISTENT' => 1, 'UNDO_BUFFER_SIZE' => 1, 'CONSTRAINT_SCHEMA' => 1, 'IGNORE_SERVER_IDS' => 1, 'MASTER_SSL_CAPATH' => 1, 'MASTER_SSL_CIPHER' => 1, 'RETURNED_SQLSTATE' => 1, 'SQL_BUFFER_RESULT' => 1, 'STATS_AUTO_RECALC' => 1, 'CONSTRAINT_CATALOG' => 1, 'MASTER_RETRY_COUNT' => 1, 'MASTER_SSL_CRLPATH' => 1, 'SQL_AFTER_MTS_GAPS' => 1, 'STATS_SAMPLE_PAGES' => 1, 'MASTER_AUTO_POSITION' => 1, 'MASTER_CONNECT_RETRY' => 1, 'MAX_QUERIES_PER_HOUR' => 1, 'MAX_UPDATES_PER_HOUR' => 1, 'MAX_USER_CONNECTIONS' => 1, 'MASTER_HEARTBEAT_PERIOD' => 1, 'MAX_CONNECTIONS_PER_HOUR' => 1, 'AS' => 3, 'BY' => 3, 'IS' => 3, 'ON' => 3, 'OR' => 3, 'TO' => 3, 'ADD' => 3, 'ALL' => 3, 'AND' => 3, 'ASC' => 3, 'DEC' => 3, 'DIV' => 3, 'FOR' => 3, 'GET' => 3, 'NOT' => 3, 'OUT' => 3, 'SQL' => 3, 'SSL' => 3, 'USE' => 3, 'XOR' => 3, 'BOTH' => 3, 'CALL' => 3, 'CASE' => 3, 'DESC' => 3, 'DROP' => 3, 'DUAL' => 3, 'EACH' => 3, 'ELSE' => 3, 'EXIT' => 3, 'FROM' => 3, 'INT1' => 3, 'INT2' => 3, 'INT3' => 3, 'INT4' => 3, 'INT8' => 3, 'INTO' => 3, 'JOIN' => 3, 'KEYS' => 3, 'KILL' => 3, 'LIKE' => 3, 'LOAD' => 3, 'LOCK' => 3, 'LONG' => 3, 'LOOP' => 3, 'NULL' => 3, 'READ' => 3, 'SHOW' => 3, 'THEN' => 3, 'TRUE' => 3, 'UNDO' => 3, 'WHEN' => 3, 'WITH' => 3, 'ALTER' => 3, 'CHECK' => 3, 'CROSS' => 3, 'FALSE' => 3, 'FETCH' => 3, 'FORCE' => 3, 'GRANT' => 3, 'GROUP' => 3, 'INNER' => 3, 'INOUT' => 3, 'LEAVE' => 3, 'LIMIT' => 3, 'LINES' => 3, 'ORDER' => 3, 'OUTER' => 3, 'PURGE' => 3, 'RANGE' => 3, 'READS' => 3, 'RLIKE' => 3, 'TABLE' => 3, 'UNION' => 3, 'USAGE' => 3, 'USING' => 3, 'WHERE' => 3, 'WHILE' => 3, 'WRITE' => 3, 'BEFORE' => 3, 'CHANGE' => 3, 'COLUMN' => 3, 'CREATE' => 3, 'CURSOR' => 3, 'DELETE' => 3, 'ELSEIF' => 3, 'EXISTS' => 3, 'FLOAT4' => 3, 'FLOAT8' => 3, 'HAVING' => 3, 'IGNORE' => 3, 'INFILE' => 3, 'LINEAR' => 3, 'OPTION' => 3, 'REGEXP' => 3, 'RENAME' => 3, 'RETURN' => 3, 'REVOKE' => 3, 'SELECT' => 3, 'SIGNAL' => 3, 'UNLOCK' => 3, 'UPDATE' => 3, 'ANALYZE' => 3, 'BETWEEN' => 3, 'CASCADE' => 3, 'COLLATE' => 3, 'DECLARE' => 3, 'DELAYED' => 3, 'ESCAPED' => 3, 'EXPLAIN' => 3, 'FOREIGN' => 3, 'ITERATE' => 3, 'LEADING' => 3, 'NATURAL' => 3, 'OUTFILE' => 3, 'PRIMARY' => 3, 'RELEASE' => 3, 'REQUIRE' => 3, 'SCHEMAS' => 3, 'TRIGGER' => 3, 'VARYING' => 3, 'CONTINUE' => 3, 'DAY_HOUR' => 3, 'DESCRIBE' => 3, 'DISTINCT' => 3, 'ENCLOSED' => 3, 'MAXVALUE' => 3, 'MODIFIES' => 3, 'OPTIMIZE' => 3, 'RESIGNAL' => 3, 'RESTRICT' => 3, 'SPECIFIC' => 3, 'SQLSTATE' => 3, 'STARTING' => 3, 'TRAILING' => 3, 'UNSIGNED' => 3, 'ZEROFILL' => 3, 'CONDITION' => 3, 'DATABASES' => 3, 'MIDDLEINT' => 3, 'PARTITION' => 3, 'PRECISION' => 3, 'PROCEDURE' => 3, 'SENSITIVE' => 3, 'SEPARATOR' => 3, 'ACCESSIBLE' => 3, 'ASENSITIVE' => 3, 'CONSTRAINT' => 3, 'DAY_MINUTE' => 3, 'DAY_SECOND' => 3, 'OPTIONALLY' => 3, 'READ_WRITE' => 3, 'REFERENCES' => 3, 'SQLWARNING' => 3, 'TERMINATED' => 3, 'YEAR_MONTH' => 3, 'DISTINCTROW' => 3, 'HOUR_MINUTE' => 3, 'HOUR_SECOND' => 3, 'INSENSITIVE' => 3, 'MASTER_BIND' => 3, 'LOW_PRIORITY' => 3, 'SQLEXCEPTION' => 3, 'VARCHARACTER' => 3, 'DETERMINISTIC' => 3, 'HIGH_PRIORITY' => 3, 'MINUTE_SECOND' => 3, 'STRAIGHT_JOIN' => 3, 'IO_AFTER_GTIDS' => 3, 'SQL_BIG_RESULT' => 3, 'DAY_MICROSECOND' => 3, 'IO_BEFORE_GTIDS' => 3, 'HOUR_MICROSECOND' => 3, 'SQL_SMALL_RESULT' => 3, 'MINUTE_MICROSECOND' => 3, 'NO_WRITE_TO_BINLOG' => 3, 'SECOND_MICROSECOND' => 3, 'SQL_CALC_FOUND_ROWS' => 3, 'MASTER_SSL_VERIFY_SERVER_CERT' => 3, 'GROUP BY' => 7, 'NOT NULL' => 7, 'ORDER BY' => 7, 'SET NULL' => 7, 'AND CHAIN' => 7, 'FULL JOIN' => 7, 'IF EXISTS' => 7, 'LEFT JOIN' => 7, 'LESS THAN' => 7, 'LOAD DATA' => 7, 'NO ACTION' => 7, 'ON DELETE' => 7, 'ON UPDATE' => 7, 'UNION ALL' => 7, 'CROSS JOIN' => 7, 'ESCAPED BY' => 7, 'FOR UPDATE' => 7, 'INNER JOIN' => 7, 'LINEAR KEY' => 7, 'NO RELEASE' => 7, 'OR REPLACE' => 7, 'RIGHT JOIN' => 7, 'ENCLOSED BY' => 7, 'LINEAR HASH' => 7, 'STARTING BY' => 7, 'AND NO CHAIN' => 7, 'FOR EACH ROW' => 7, 'NATURAL JOIN' => 7, 'PARTITION BY' => 7, 'SET PASSWORD' => 7, 'SQL SECURITY' => 7, 'CHARACTER SET' => 7, 'IF NOT EXISTS' => 7, 'TERMINATED BY' => 7, 'DATA DIRECTORY' => 7, 'UNION DISTINCT' => 7, 'DEFAULT CHARSET' => 7, 'DEFAULT COLLATE' => 7, 'FULL OUTER JOIN' => 7, 'INDEX DIRECTORY' => 7, 'LEFT OUTER JOIN' => 7, 'SUBPARTITION BY' => 7, 'GENERATED ALWAYS' => 7, 'RIGHT OUTER JOIN' => 7, 'NATURAL LEFT JOIN' => 7, 'START TRANSACTION' => 7, 'LOCK IN SHARE MODE' => 7, 'NATURAL RIGHT JOIN' => 7, 'SELECT TRANSACTION' => 7, 'DEFAULT CHARACTER SET' => 7, 'NATURAL LEFT OUTER JOIN' => 7, 'NATURAL RIGHT OUTER JOIN' => 7, 'WITH CONSISTENT SNAPSHOT' => 7, 'BIT' => 9, 'XML' => 9, 'ENUM' => 9, 'JSON' => 9, 'TEXT' => 9, 'ARRAY' => 9, 'SERIAL' => 9, 'BOOLEAN' => 9, 'DATETIME' => 9, 'GEOMETRY' => 9, 'MULTISET' => 9, 'MULTILINEPOINT' => 9, 'MULTILINEPOLYGON' => 9, 'INT' => 11, 'SET' => 11, 'BLOB' => 11, 'REAL' => 11, 'FLOAT' => 11, 'BIGINT' => 11, 'DOUBLE' => 11, 'DECIMAL' => 11, 'INTEGER' => 11, 'NUMERIC' => 11, 'TINYINT' => 11, 'VARCHAR' => 11, 'LONGBLOB' => 11, 'LONGTEXT' => 11, 'SMALLINT' => 11, 'TINYBLOB' => 11, 'TINYTEXT' => 11, 'CHARACTER' => 11, 'MEDIUMINT' => 11, 'VARBINARY' => 11, 'MEDIUMBLOB' => 11, 'MEDIUMTEXT' => 11, 'BINARY VARYING' => 15, 'KEY' => 19, 'INDEX' => 19, 'UNIQUE' => 19, 'SPATIAL' => 19, 'FULLTEXT' => 19, 'INDEX KEY' => 23, 'UNIQUE KEY' => 23, 'FOREIGN KEY' => 23, 'PRIMARY KEY' => 23, 'SPATIAL KEY' => 23, 'FULLTEXT KEY' => 23, 'UNIQUE INDEX' => 23, 'SPATIAL INDEX' => 23, 'FULLTEXT INDEX' => 23, 'X' => 33, 'Y' => 33, 'LN' => 33, 'PI' => 33, 'ABS' => 33, 'AVG' => 33, 'BIN' => 33, 'COS' => 33, 'COT' => 33, 'DAY' => 33, 'ELT' => 33, 'EXP' => 33, 'HEX' => 33, 'LOG' => 33, 'MAX' => 33, 'MD5' => 33, 'MID' => 33, 'MIN' => 33, 'NOW' => 33, 'OCT' => 33, 'ORD' => 33, 'POW' => 33, 'SHA' => 33, 'SIN' => 33, 'STD' => 33, 'SUM' => 33, 'TAN' => 33, 'ACOS' => 33, 'AREA' => 33, 'ASIN' => 33, 'ATAN' => 33, 'CAST' => 33, 'CEIL' => 33, 'CONV' => 33, 'HOUR' => 33, 'LOG2' => 33, 'LPAD' => 33, 'RAND' => 33, 'RPAD' => 33, 'SHA1' => 33, 'SHA2' => 33, 'SIGN' => 33, 'SQRT' => 33, 'SRID' => 33, 'ST_X' => 33, 'ST_Y' => 33, 'TRIM' => 33, 'USER' => 33, 'UUID' => 33, 'WEEK' => 33, 'ASCII' => 33, 'ASWKB' => 33, 'ASWKT' => 33, 'ATAN2' => 33, 'COUNT' => 33, 'CRC32' => 33, 'FIELD' => 33, 'FLOOR' => 33, 'INSTR' => 33, 'LCASE' => 33, 'LEAST' => 33, 'LOG10' => 33, 'LOWER' => 33, 'LTRIM' => 33, 'MONTH' => 33, 'POWER' => 33, 'QUOTE' => 33, 'ROUND' => 33, 'RTRIM' => 33, 'SLEEP' => 33, 'SPACE' => 33, 'UCASE' => 33, 'UNHEX' => 33, 'UPPER' => 33, 'ASTEXT' => 33, 'BIT_OR' => 33, 'BUFFER' => 33, 'CONCAT' => 33, 'DECODE' => 33, 'ENCODE' => 33, 'EQUALS' => 33, 'FORMAT' => 33, 'IFNULL' => 33, 'ISNULL' => 33, 'LENGTH' => 33, 'LOCATE' => 33, 'MINUTE' => 33, 'NULLIF' => 33, 'POINTN' => 33, 'SECOND' => 33, 'STDDEV' => 33, 'STRCMP' => 33, 'SUBSTR' => 33, 'WITHIN' => 33, 'ADDDATE' => 33, 'ADDTIME' => 33, 'AGAINST' => 33, 'BIT_AND' => 33, 'BIT_XOR' => 33, 'CEILING' => 33, 'CHARSET' => 33, 'CROSSES' => 33, 'CURDATE' => 33, 'CURTIME' => 33, 'DAYNAME' => 33, 'DEGREES' => 33, 'ENCRYPT' => 33, 'EXTRACT' => 33, 'GLENGTH' => 33, 'ISEMPTY' => 33, 'IS_IPV4' => 33, 'IS_IPV6' => 33, 'QUARTER' => 33, 'RADIANS' => 33, 'REVERSE' => 33, 'SOUNDEX' => 33, 'ST_AREA' => 33, 'ST_SRID' => 33, 'SUBDATE' => 33, 'SUBTIME' => 33, 'SYSDATE' => 33, 'TOUCHES' => 33, 'TO_DAYS' => 33, 'VAR_POP' => 33, 'VERSION' => 33, 'WEEKDAY' => 33, 'ASBINARY' => 33, 'CENTROID' => 33, 'COALESCE' => 33, 'COMPRESS' => 33, 'CONTAINS' => 33, 'DATEDIFF' => 33, 'DATE_ADD' => 33, 'DATE_SUB' => 33, 'DISJOINT' => 33, 'ENDPOINT' => 33, 'ENVELOPE' => 33, 'GET_LOCK' => 33, 'GREATEST' => 33, 'ISCLOSED' => 33, 'ISSIMPLE' => 33, 'MAKEDATE' => 33, 'MAKETIME' => 33, 'MAKE_SET' => 33, 'MBREQUAL' => 33, 'OVERLAPS' => 33, 'PASSWORD' => 33, 'POSITION' => 33, 'ST_ASWKB' => 33, 'ST_ASWKT' => 33, 'ST_UNION' => 33, 'TIMEDIFF' => 33, 'TRUNCATE' => 33, 'VARIANCE' => 33, 'VAR_SAMP' => 33, 'YEARWEEK' => 33, 'BENCHMARK' => 33, 'BIT_COUNT' => 33, 'COLLATION' => 33, 'CONCAT_WS' => 33, 'DAYOFWEEK' => 33, 'DAYOFYEAR' => 33, 'DIMENSION' => 33, 'FROM_DAYS' => 33, 'GEOMETRYN' => 33, 'INET_ATON' => 33, 'INET_NTOA' => 33, 'LOAD_FILE' => 33, 'MBRWITHIN' => 33, 'MONTHNAME' => 33, 'NUMPOINTS' => 33, 'ROW_COUNT' => 33, 'ST_ASTEXT' => 33, 'ST_BUFFER' => 33, 'ST_EQUALS' => 33, 'ST_POINTN' => 33, 'ST_WITHIN' => 33, 'SUBSTRING' => 33, 'TO_BASE64' => 33, 'UPDATEXML' => 33, 'BIT_LENGTH' => 33, 'CONVERT_TZ' => 33, 'DAYOFMONTH' => 33, 'EXPORT_SET' => 33, 'FOUND_ROWS' => 33, 'GET_FORMAT' => 33, 'INET6_ATON' => 33, 'INET6_NTOA' => 33, 'INTERSECTS' => 33, 'MBRTOUCHES' => 33, 'MULTIPOINT' => 33, 'NAME_CONST' => 33, 'PERIOD_ADD' => 33, 'STARTPOINT' => 33, 'STDDEV_POP' => 33, 'ST_CROSSES' => 33, 'ST_ISEMPTY' => 33, 'ST_TOUCHES' => 33, 'TO_SECONDS' => 33, 'UNCOMPRESS' => 33, 'UUID_SHORT' => 33, 'WEEKOFYEAR' => 33, 'AES_DECRYPT' => 33, 'AES_ENCRYPT' => 33, 'CHAR_LENGTH' => 33, 'DATE_FORMAT' => 33, 'DES_DECRYPT' => 33, 'DES_ENCRYPT' => 33, 'FIND_IN_SET' => 33, 'FROM_BASE64' => 33, 'GEOMFROMWKB' => 33, 'GTID_SUBSET' => 33, 'LINEFROMWKB' => 33, 'MBRCONTAINS' => 33, 'MBRDISJOINT' => 33, 'MBROVERLAPS' => 33, 'MICROSECOND' => 33, 'PERIOD_DIFF' => 33, 'POLYFROMWKB' => 33, 'SEC_TO_TIME' => 33, 'STDDEV_SAMP' => 33, 'STR_TO_DATE' => 33, 'ST_ASBINARY' => 33, 'ST_CENTROID' => 33, 'ST_CONTAINS' => 33, 'ST_DISJOINT' => 33, 'ST_DISTANCE' => 33, 'ST_ENDPOINT' => 33, 'ST_ENVELOPE' => 33, 'ST_ISCLOSED' => 33, 'ST_ISSIMPLE' => 33, 'ST_OVERLAPS' => 33, 'SYSTEM_USER' => 33, 'TIME_FORMAT' => 33, 'TIME_TO_SEC' => 33, 'COERCIBILITY' => 33, 'EXTERIORRING' => 33, 'EXTRACTVALUE' => 33, 'GEOMETRYTYPE' => 33, 'GEOMFROMTEXT' => 33, 'GROUP_CONCAT' => 33, 'IS_FREE_LOCK' => 33, 'IS_USED_LOCK' => 33, 'LINEFROMTEXT' => 33, 'MLINEFROMWKB' => 33, 'MPOLYFROMWKB' => 33, 'MULTIPOLYGON' => 33, 'OCTET_LENGTH' => 33, 'OLD_PASSWORD' => 33, 'POINTFROMWKB' => 33, 'POLYFROMTEXT' => 33, 'RANDOM_BYTES' => 33, 'RELEASE_LOCK' => 33, 'SESSION_USER' => 33, 'ST_DIMENSION' => 33, 'ST_GEOMETRYN' => 33, 'ST_NUMPOINTS' => 33, 'TIMESTAMPADD' => 33, 'CONNECTION_ID' => 33, 'CREATE_DIGEST' => 33, 'FROM_UNIXTIME' => 33, 'GTID_SUBTRACT' => 33, 'INTERIORRINGN' => 33, 'MBRINTERSECTS' => 33, 'MLINEFROMTEXT' => 33, 'MPOINTFROMWKB' => 33, 'MPOLYFROMTEXT' => 33, 'NUMGEOMETRIES' => 33, 'POINTFROMTEXT' => 33, 'ST_DIFFERENCE' => 33, 'ST_INTERSECTS' => 33, 'ST_STARTPOINT' => 33, 'TIMESTAMPDIFF' => 33, 'WEIGHT_STRING' => 33, 'IS_IPV4_COMPAT' => 33, 'IS_IPV4_MAPPED' => 33, 'LAST_INSERT_ID' => 33, 'MPOINTFROMTEXT' => 33, 'POLYGONFROMWKB' => 33, 'ST_GEOMFROMWKB' => 33, 'ST_LINEFROMWKB' => 33, 'ST_POLYFROMWKB' => 33, 'UNIX_TIMESTAMP' => 33, 'ASYMMETRIC_SIGN' => 33, 'GEOMCOLLFROMWKB' => 33, 'MASTER_POS_WAIT' => 33, 'POLYGONFROMTEXT' => 33, 'ST_EXTERIORRING' => 33, 'ST_GEOMETRYTYPE' => 33, 'ST_GEOMFROMTEXT' => 33, 'ST_INTERSECTION' => 33, 'ST_LINEFROMTEXT' => 33, 'ST_POINTFROMWKB' => 33, 'ST_POLYFROMTEXT' => 33, 'SUBSTRING_INDEX' => 33, 'CHARACTER_LENGTH' => 33, 'GEOMCOLLFROMTEXT' => 33, 'GEOMETRYFROMTEXT' => 33, 'NUMINTERIORRINGS' => 33, 'ST_INTERIORRINGN' => 33, 'ST_NUMGEOMETRIES' => 33, 'ST_POINTFROMTEXT' => 33, 'ST_SYMDIFFERENCE' => 33, 'ASYMMETRIC_DERIVE' => 33, 'ASYMMETRIC_VERIFY' => 33, 'LINESTRINGFROMWKB' => 33, 'MULTIPOINTFROMWKB' => 33, 'ST_POLYGONFROMWKB' => 33, 'ASYMMETRIC_DECRYPT' => 33, 'ASYMMETRIC_ENCRYPT' => 33, 'MULTIPOINTFROMTEXT' => 33, 'ST_GEOMCOLLFROMTXT' => 33, 'ST_GEOMCOLLFROMWKB' => 33, 'ST_POLYGONFROMTEXT' => 33, 'MULTIPOLYGONFROMWKB' => 33, 'ST_GEOMCOLLFROMTEXT' => 33, 'ST_GEOMETRYFROMTEXT' => 33, 'ST_NUMINTERIORRINGS' => 33, 'UNCOMPRESSED_LENGTH' => 33, 'CREATE_DH_PARAMETERS' => 33, 'MULTIPOLYGONFROMTEXT' => 33, 'ST_LINESTRINGFROMWKB' => 33, 'MULTILINESTRINGFROMWKB' => 33, 'MULTILINESTRINGFROMTEXT' => 33, 'CREATE_ASYMMETRIC_PUB_KEY' => 33, 'GEOMETRYCOLLECTIONFROMWKB' => 33, 'CREATE_ASYMMETRIC_PRIV_KEY' => 33, 'GEOMETRYCOLLECTIONFROMTEXT' => 33, 'VALIDATE_PASSWORD_STRENGTH' => 33, 'SQL_THREAD_WAIT_AFTER_GTIDS' => 33, 'ST_GEOMETRYCOLLECTIONFROMWKB' => 33, 'ST_GEOMETRYCOLLECTIONFROMTEXT' => 33, 'WAIT_UNTIL_SQL_THREAD_AFTER_GTIDS' => 33, 'IF' => 35, 'IN' => 35, 'MOD' => 35, 'LEFT' => 35, 'MATCH' => 35, 'RIGHT' => 35, 'INSERT' => 35, 'REPEAT' => 35, 'SCHEMA' => 35, 'VALUES' => 35, 'CONVERT' => 35, 'DEFAULT' => 35, 'REPLACE' => 35, 'DATABASE' => 35, 'UTC_DATE' => 35, 'UTC_TIME' => 35, 'LOCALTIME' => 35, 'CURRENT_DATE' => 35, 'CURRENT_TIME' => 35, 'CURRENT_USER' => 35, 'UTC_TIMESTAMP' => 35, 'LOCALTIMESTAMP' => 35, 'CURRENT_TIMESTAMP' => 35, 'NOT IN' => 39, 'DATE' => 41, 'TIME' => 41, 'YEAR' => 41, 'POINT' => 41, 'POLYGON' => 41, 'TIMESTAMP' => 41, 'LINESTRING' => 41, 'MULTILINESTRING' => 41, 'GEOMETRYCOLLECTION' => 41, 'CHAR' => 43, 'BINARY' => 43, 'INTERVAL' => 43);
}
}
namespace PhpMyAdmin\SqlParser\Exceptions {
/**
* Exception thrown by the parser.
*
* @category Exceptions
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ParserException extends \Exception
{
/**
* The token that produced this error.
*
* @var Token
*/
public $token;
/**
* Constructor.
*
* @param string $msg the message of this exception
* @param Token $token the token that produced this exception
* @param int $code the code of this error
*/
public function __construct($msg = '', \PhpMyAdmin\SqlParser\Token $token = null, $code = 0)
{
}
}
/**
* Exception thrown by the lexer.
*
* @category Exceptions
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class LoaderException extends \Exception
{
/**
* The failed load name.
*
* @var string
*/
public $name;
/**
* Constructor.
*
* @param string $msg the message of this exception
* @param string $ch the character that produced this exception
* @param int $pos the position of the character
* @param int $code the code of this error
* @param mixed $name
*/
public function __construct($msg = '', $name = '', $code = 0)
{
}
}
/**
* Exception thrown by the lexer.
*
* @category Exceptions
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class LexerException extends \Exception
{
/**
* The character that produced this error.
*
* @var string
*/
public $ch;
/**
* The index of the character that produced this error.
*
* @var int
*/
public $pos;
/**
* Constructor.
*
* @param string $msg the message of this exception
* @param string $ch the character that produced this exception
* @param int $pos the position of the character
* @param int $code the code of this error
*/
public function __construct($msg = '', $ch = '', $pos = 0, $code = 0)
{
}
}
}
namespace PhpMyAdmin\SqlParser\Utils {
/**
* Table utilities.
*
* @category Statement
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Table
{
/**
* Gets the foreign keys of the table.
*
* @param CreateStatement $statement the statement to be processed
*
* @return array
*/
public static function getForeignKeys($statement)
{
}
/**
* Gets fields of the table.
*
* @param CreateStatement $statement the statement to be processed
*
* @return array
*/
public static function getFields($statement)
{
}
}
/**
* Utilities that are used for formatting queries.
*
* @category Misc
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Formatter
{
/**
* The formatting options.
*
* @var array
*/
public $options;
/**
* Clauses that are usually short.
*
* These clauses share the line with the next clause.
*
* E.g. if INSERT was not here, the formatter would produce:
*
* INSERT
* INTO foo
* VALUES(0, 0, 0),(1, 1, 1);
*
* Instead of:
*
* INSERT INTO foo
* VALUES(0, 0, 0),(1, 1, 1)
*
* @var array
*/
public static $SHORT_CLAUSES = array('CREATE' => true, 'INSERT' => true);
/**
* Clauses that must be inlined.
*
* These clauses usually are short and it's nicer to have them inline.
*
* @var array
*/
public static $INLINE_CLAUSES = array('CREATE' => true, 'INTO' => true, 'LIMIT' => true, 'PARTITION BY' => true, 'PARTITION' => true, 'PROCEDURE' => true, 'SUBPARTITION BY' => true, 'VALUES' => true);
/**
* Constructor.
*
* @param array $options the formatting options
*/
public function __construct(array $options = array())
{
}
/**
* The default formatting options.
*
* @return array
*/
protected function getDefaultOptions()
{
}
/**
* The styles used for HTML formatting.
* array($type, $flags, $span, $callback).
*
* @return array
*/
protected function getDefaultFormats()
{
}
/**
* Formats the given list of tokens.
*
* @param TokensList $list the list of tokens
*
* @return string
*/
public function formatList($list)
{
}
public function escapeConsole($string)
{
}
/**
* Tries to print the query and returns the result.
*
* @param Token $token the token to be printed
*
* @return string
*/
public function toString($token)
{
}
/**
* Formats a query.
*
* @param string $query The query to be formatted
* @param array $options the formatting options
*
* @return string the formatted string
*/
public static function format($query, array $options = array())
{
}
/**
* Computes the length of a group.
*
* A group is delimited by a pair of brackets.
*
* @param TokensList $list the list of tokens
*
* @return int
*/
public static function getGroupLength($list)
{
}
/**
* Checks if a token is a statement or a clause inside a statement.
*
* @param Token $token the token to be checked
*
* @return int|bool
*/
public static function isClause($token)
{
}
}
/**
* Buffer query utilities.
*
* Implements a specialized lexer used to extract statements from large inputs
* that are being buffered. After each statement has been extracted, a lexer or
* a parser may be used.
*
* @category Lexer
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class BufferedQuery
{
// Constants that describe the current status of the parser.
// A string is being parsed.
const STATUS_STRING = 16;
// 0001 0000
const STATUS_STRING_SINGLE_QUOTES = 17;
// 0001 0001
const STATUS_STRING_DOUBLE_QUOTES = 18;
// 0001 0010
const STATUS_STRING_BACKTICK = 20;
// 0001 0100
// A comment is being parsed.
const STATUS_COMMENT = 32;
// 0010 0000
const STATUS_COMMENT_BASH = 33;
// 0010 0001
const STATUS_COMMENT_C = 34;
// 0010 0010
const STATUS_COMMENT_SQL = 36;
// 0010 0100
/**
* The query that is being processed.
*
* This field can be modified just by appending to it!
*
* @var string
*/
public $query = '';
/**
* The options of this parser.
*
* @var array
*/
public $options = array();
/**
* The last delimiter used.
*
* @var string
*/
public $delimiter;
/**
* The length of the delimiter.
*
* @var int
*/
public $delimiterLen;
/**
* The current status of the parser.
*
* @var int
*/
public $status;
/**
* The last incomplete query that was extracted.
*
* @var string
*/
public $current = '';
/**
* Constructor.
*
* @param string $query the query to be parsed
* @param array $options the options of this parser
*/
public function __construct($query = '', array $options = array())
{
}
/**
* Sets the delimiter.
*
* Used to update the length of it too.
*
* @param string $delimiter
*/
public function setDelimiter($delimiter)
{
}
/**
* Extracts a statement from the buffer.
*
* @param bool $end whether the end of the buffer was reached
*
* @return string
*/
public function extract($end = false)
{
}
}
/**
* Token utilities.
*
* @category Token
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Tokens
{
/**
* Checks if a pattern is a match for the specified token.
*
* @param Token $token the token to be matched
* @param array $pattern the pattern to be matches
*
* @return bool
*/
public static function match(\PhpMyAdmin\SqlParser\Token $token, array $pattern)
{
}
public static function replaceTokens($list, array $find, array $replace)
{
}
}
/**
* Statement utilities.
*
* @category Statement
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Query
{
/**
* Functions that set the flag `is_func`.
*
* @var array
*/
public static $FUNCTIONS = array('SUM', 'AVG', 'STD', 'STDDEV', 'MIN', 'MAX', 'BIT_OR', 'BIT_AND');
public static $ALLFLAGS = array(
/*
* select ... DISTINCT ...
*/
'distinct' => false,
/*
* drop ... DATABASE ...
*/
'drop_database' => false,
/*
* ... GROUP BY ...
*/
'group' => false,
/*
* ... HAVING ...
*/
'having' => false,
/*
* INSERT ...
* or
* REPLACE ...
* or
* DELETE ...
*/
'is_affected' => false,
/*
* select ... PROCEDURE ANALYSE( ... ) ...
*/
'is_analyse' => false,
/*
* select COUNT( ... ) ...
*/
'is_count' => false,
/*
* DELETE ...
*/
'is_delete' => false,
// @deprecated; use `querytype`
/*
* EXPLAIN ...
*/
'is_explain' => false,
// @deprecated; use `querytype`
/*
* select ... INTO OUTFILE ...
*/
'is_export' => false,
/*
* select FUNC( ... ) ...
*/
'is_func' => false,
/*
* select ... GROUP BY ...
* or
* select ... HAVING ...
*/
'is_group' => false,
/*
* INSERT ...
* or
* REPLACE ...
* or
* LOAD DATA ...
*/
'is_insert' => false,
/*
* ANALYZE ...
* or
* CHECK ...
* or
* CHECKSUM ...
* or
* OPTIMIZE ...
* or
* REPAIR ...
*/
'is_maint' => false,
/*
* CALL ...
*/
'is_procedure' => false,
/*
* REPLACE ...
*/
'is_replace' => false,
// @deprecated; use `querytype`
/*
* SELECT ...
*/
'is_select' => false,
// @deprecated; use `querytype`
/*
* SHOW ...
*/
'is_show' => false,
// @deprecated; use `querytype`
/*
* Contains a subquery.
*/
'is_subquery' => false,
/*
* ... JOIN ...
*/
'join' => false,
/*
* ... LIMIT ...
*/
'limit' => false,
/*
* TODO
*/
'offset' => false,
/*
* ... ORDER ...
*/
'order' => false,
/*
* The type of the query (which is usually the first keyword of
* the statement).
*/
'querytype' => false,
/*
* Whether a page reload is required.
*/
'reload' => false,
/*
* SELECT ... FROM ...
*/
'select_from' => false,
/*
* ... UNION ...
*/
'union' => false,
);
/**
* Gets an array with flags this statement has.
*
* @param Statement|null $statement the statement to be processed
* @param bool $all if `false`, false values will not be included
*
* @return array
*/
public static function getFlags($statement, $all = false)
{
}
/**
* Parses a query and gets all information about it.
*
* @param string $query the query to be parsed
*
* @return array The array returned is the one returned by
* `static::getFlags()`, with the following keys added:
* - parser - the parser used to analyze the query;
* - statement - the first statement resulted from parsing;
* - select_tables - the real name of the tables selected;
* if there are no table names in the `SELECT`
* expressions, the table names are fetched from the
* `FROM` expressions
* - select_expr - selected expressions
*/
public static function getAll($query)
{
}
/**
* Gets a list of all tables used in this statement.
*
* @param Statement $statement statement to be scanned
*
* @return array
*/
public static function getTables($statement)
{
}
/**
* Gets a specific clause.
*
* @param Statement $statement the parsed query that has to be modified
* @param TokensList $list the list of tokens
* @param string $clause the clause to be returned
* @param int|string $type The type of the search.
* If int,
* -1 for everything that was before
* 0 only for the clause
* 1 for everything after
* If string, the name of the first clause that
* should not be included.
* @param bool $skipFirst whether to skip the first keyword in clause
*
* @return string
*/
public static function getClause($statement, $list, $clause, $type = 0, $skipFirst = true)
{
}
/**
* Builds a query by rebuilding the statement from the tokens list supplied
* and replaces a clause.
*
* It is a very basic version of a query builder.
*
* @param Statement $statement the parsed query that has to be modified
* @param TokensList $list the list of tokens
* @param string $old The type of the clause that should be
* replaced. This can be an entire clause.
* @param string $new The new clause. If this parameter is omitted
* it is considered to be equal with `$old`.
* @param bool $onlyType whether only the type of the clause should
* be replaced or the entire clause
*
* @return string
*/
public static function replaceClause($statement, $list, $old, $new = null, $onlyType = false)
{
}
/**
* Builds a query by rebuilding the statement from the tokens list supplied
* and replaces multiple clauses.
*
* @param Statement $statement the parsed query that has to be modified
* @param TokensList $list the list of tokens
* @param array $ops Clauses to be replaced. Contains multiple
* arrays having two values: array($old, $new).
* Clauses must be sorted.
*
* @return string
*/
public static function replaceClauses($statement, $list, array $ops)
{
}
/**
* Gets the first full statement in the query.
*
* @param string $query the query to be analyzed
* @param string $delimiter the delimiter to be used
*
* @return array array containing the first full query, the
* remaining part of the query and the last
* delimiter
*/
public static function getFirstStatement($query, $delimiter = null)
{
}
/**
* Gets a starting offset of a specific clause.
*
* @param Statement $statement the parsed query that has to be modified
* @param TokensList $list the list of tokens
* @param string $clause the clause to be returned
*
* @return int
*/
public static function getClauseStartOffset($statement, $list, $clause)
{
}
}
/**
* Miscellaneous utilities.
*
* @category Misc
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Misc
{
/**
* Gets a list of all aliases and their original names.
*
* @param SelectStatement $statement the statement to be processed
* @param string $database the name of the database
*
* @return array
*/
public static function getAliases($statement, $database)
{
}
}
/**
* Routine utilities.
*
* @category Routines
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Routine
{
/**
* Parses a parameter of a routine.
*
* @param string $param parameter's definition
*
* @return array
*/
public static function getReturnType($param)
{
}
/**
* Parses a parameter of a routine.
*
* @param string $param parameter's definition
*
* @return array
*/
public static function getParameter($param)
{
}
/**
* Gets the parameters of a routine from the parse tree.
*
* @param CreateStatement $statement the statement to be processed
*
* @return array
*/
public static function getParameters($statement)
{
}
}
/**
* Error related utilities.
*
* @category Exceptions
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Error
{
/**
* Gets the errors of a lexer and a parser.
*
* @param array $objs objects from where the errors will be extracted
*
* @return array Each element of the array represents an error.
* `$err[0]` holds the error message.
* `$err[1]` holds the error code.
* `$err[2]` holds the string that caused the issue.
* `$err[3]` holds the position of the string.
* (i.e. `array($msg, $code, $str, $pos)`)
*/
public static function get($objs)
{
}
/**
* Formats the specified errors.
*
* @param array $errors the errors to be formatted
* @param string $format The format of an error.
* '$1$d' is replaced by the position of this error.
* '$2$s' is replaced by the error message.
* '$3$d' is replaced by the error code.
* '$4$s' is replaced by the string that caused the
* issue.
* '$5$d' is replaced by the position of the string.
*
* @return array
*/
public static function format($errors, $format = '#%1$d: %2$s (near "%4$s" at position %5$d)')
{
}
}
/**
* CLI interface.
*
* @category Exceptions
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class CLI
{
public function mergeLongOpts(&$params, &$longopts)
{
}
public function usageHighlight()
{
}
public function getopt($opt, $long)
{
}
public function parseHighlight()
{
}
public function runHighlight()
{
}
public function usageLint()
{
}
public function parseLint()
{
}
public function runLint()
{
}
public function usageTokenize()
{
}
public function parseTokenize()
{
}
public function runTokenize()
{
}
}
}
namespace PhpMyAdmin\SqlParser {
/**
* Implements array-like access for UTF-8 strings.
*
* In this library, this class should be used to parse UTF-8 queries.
*
* @category Misc
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class UtfString implements \ArrayAccess
{
/**
* The raw, multi-byte string.
*
* @var string
*/
public $str = '';
/**
* The index of current byte.
*
* For ASCII strings, the byte index is equal to the character index.
*
* @var int
*/
public $byteIdx = 0;
/**
* The index of current character.
*
* For non-ASCII strings, some characters occupy more than one byte and
* the character index will have a lower value than the byte index.
*
* @var int
*/
public $charIdx = 0;
/**
* The length of the string (in bytes).
*
* @var int
*/
public $byteLen = 0;
/**
* The length of the string (in characters).
*
* @var int
*/
public $charLen = 0;
/**
* Constructor.
*
* @param string $str the string
*/
public function __construct($str)
{
}
/**
* Checks if the given offset exists.
*
* @param int $offset the offset to be checked
*
* @return bool
*/
public function offsetExists($offset)
{
}
/**
* Gets the character at given offset.
*
* @param int $offset the offset to be returned
*
* @return string
*/
public function offsetGet($offset)
{
}
/**
* Sets the value of a character.
*
* @param int $offset the offset to be set
* @param string $value the value to be set
*
* @throws \Exception not implemented
*/
public function offsetSet($offset, $value)
{
}
/**
* Unsets an index.
*
* @param int $offset the value to be unset
*
* @throws \Exception not implemented
*/
public function offsetUnset($offset)
{
}
/**
* Gets the length of an UTF-8 character.
*
* According to RFC 3629, a UTF-8 character can have at most 4 bytes.
* However, this implementation supports UTF-8 characters containing up to 6
* bytes.
*
* @param string $byte the byte to be analyzed
*
* @see https://tools.ietf.org/html/rfc3629
*
* @return int
*/
public static function getCharLength($byte)
{
}
/**
* Returns the length in characters of the string.
*
* @return int
*/
public function length()
{
}
/**
* Returns the contained string.
*
* @return string
*/
public function __toString()
{
}
}
class Core
{
/**
* Whether errors should throw exceptions or just be stored.
*
* @var bool
*
* @see static::$errors
*/
public $strict = false;
/**
* List of errors that occurred during lexing.
*
* Usually, the lexing does not stop once an error occurred because that
* error might be false positive or a partial result (even a bad one)
* might be needed.
*
* @var Exception[]
*
* @see Core::error()
*/
public $errors = array();
/**
* Creates a new error log.
*
* @param \Exception $error the error exception
*
* @throws \Exception throws the exception, if strict mode is enabled
*/
public function error($error)
{
}
}
/**
* A structure representing a lexeme that explicitly indicates its
* categorization for the purpose of parsing.
*
* @category Tokens
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Token
{
// Types of tokens (a vague description of a token's purpose).
/**
* This type is used when the token is invalid or its type cannot be
* determined because of the ambiguous context. Further analysis might be
* required to detect its type.
*
* @var int
*/
const TYPE_NONE = 0;
/**
* SQL specific keywords: SELECT, UPDATE, INSERT, etc.
*
* @var int
*/
const TYPE_KEYWORD = 1;
/**
* Any type of legal operator.
*
* Arithmetic operators: +, -, *, /, etc.
* Logical operators: ===, <>, !==, etc.
* Bitwise operators: &, |, ^, etc.
* Assignment operators: =, +=, -=, etc.
* SQL specific operators: . (e.g. .. WHERE database.table ..),
* * (e.g. SELECT * FROM ..)
*
* @var int
*/
const TYPE_OPERATOR = 2;
/**
* Spaces, tabs, new lines, etc.
*
* @var int
*/
const TYPE_WHITESPACE = 3;
/**
* Any type of legal comment.
*
* Bash (#), C (/* *\/) or SQL (--) comments:
*
* -- SQL-comment
*
* #Bash-like comment
*
* /*C-like comment*\/
*
* or:
*
* /*C-like
* comment*\/
*
* Backslashes were added to respect PHP's comments syntax.
*
* @var int
*/
const TYPE_COMMENT = 4;
/**
* Boolean values: true or false.
*
* @var int
*/
const TYPE_BOOL = 5;
/**
* Numbers: 4, 0x8, 15.16, 23e42, etc.
*
* @var int
*/
const TYPE_NUMBER = 6;
/**
* Literal strings: 'string', "test".
* Some of these strings are actually symbols.
*
* @var int
*/
const TYPE_STRING = 7;
/**
* Database, table names, variables, etc.
* For example: ```SELECT `foo`, `bar` FROM `database`.`table`;```.
*
* @var int
*/
const TYPE_SYMBOL = 8;
/**
* Delimits an unknown string.
* For example: ```SELECT * FROM test;```, `test` is a delimiter.
*
* @var int
*/
const TYPE_DELIMITER = 9;
/**
* Labels in LOOP statement, ITERATE statement etc.
* For example (only for begin label):
* begin_label: BEGIN [statement_list] END [end_label]
* begin_label: LOOP [statement_list] END LOOP [end_label]
* begin_label: REPEAT [statement_list] ... END REPEAT [end_label]
* begin_label: WHILE ... DO [statement_list] END WHILE [end_label].
*
* @var int
*/
const TYPE_LABEL = 10;
// Flags that describe the tokens in more detail.
// All keywords must have flag 1 so `Context::isKeyword` method doesn't
// require strict comparison.
const FLAG_KEYWORD_RESERVED = 2;
const FLAG_KEYWORD_COMPOSED = 4;
const FLAG_KEYWORD_DATA_TYPE = 8;
const FLAG_KEYWORD_KEY = 16;
const FLAG_KEYWORD_FUNCTION = 32;
// Numbers related flags.
const FLAG_NUMBER_HEX = 1;
const FLAG_NUMBER_FLOAT = 2;
const FLAG_NUMBER_APPROXIMATE = 4;
const FLAG_NUMBER_NEGATIVE = 8;
const FLAG_NUMBER_BINARY = 16;
// Strings related flags.
const FLAG_STRING_SINGLE_QUOTES = 1;
const FLAG_STRING_DOUBLE_QUOTES = 2;
// Comments related flags.
const FLAG_COMMENT_BASH = 1;
const FLAG_COMMENT_C = 2;
const FLAG_COMMENT_SQL = 4;
const FLAG_COMMENT_MYSQL_CMD = 8;
// Operators related flags.
const FLAG_OPERATOR_ARITHMETIC = 1;
const FLAG_OPERATOR_LOGICAL = 2;
const FLAG_OPERATOR_BITWISE = 4;
const FLAG_OPERATOR_ASSIGNMENT = 8;
const FLAG_OPERATOR_SQL = 16;
// Symbols related flags.
const FLAG_SYMBOL_VARIABLE = 1;
const FLAG_SYMBOL_BACKTICK = 2;
const FLAG_SYMBOL_USER = 4;
const FLAG_SYMBOL_SYSTEM = 8;
const FLAG_SYMBOL_PARAMETER = 16;
/**
* The token it its raw string representation.
*
* @var string
*/
public $token;
/**
* The value this token contains (i.e. token after some evaluation).
*
* @var mixed
*/
public $value;
/**
* The keyword value this token contains, always uppercase.
*
* @var mixed
*/
public $keyword;
/**
* The type of this token.
*
* @var int
*/
public $type;
/**
* The flags of this token.
*
* @var int
*/
public $flags;
/**
* The position in the initial string where this token started.
*
* The position is counted in chars, not bytes, so you should
* use mb_* functions to properly handle utf-8 multibyte chars.
*
* @var int
*/
public $position;
/**
* Constructor.
*
* @param string $token the value of the token
* @param int $type the type of the token
* @param int $flags the flags of the token
*/
public function __construct($token, $type = 0, $flags = 0)
{
}
/**
* Does little processing to the token to extract a value.
*
* If no processing can be done it will return the initial string.
*
* @return mixed
*/
public function extract()
{
}
/**
* Converts the token into an inline token by replacing tabs and new lines.
*
* @return string
*/
public function getInlineToken()
{
}
}
/**
* Abstract statement definition.
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
abstract class Statement
{
/**
* Options for this statement.
*
* The option would be the key and the value can be an integer or an array.
*
* The integer represents only the index used.
*
* The array may have two keys: `0` is used to represent the index used and
* `1` is the type of the option (which may be 'var' or 'var='). Both
* options mean they expect a value after the option (e.g. `A = B` or `A B`,
* in which case `A` is the key and `B` is the value). The only difference
* is in the building process. `var` options are built as `A B` and `var=`
* options are built as `A = B`
*
* Two options that can be used together must have different values for
* indexes, else, when they will be used together, an error will occur.
*
* @var array
*/
public static $OPTIONS = array();
/**
* The clauses of this statement, in order.
*
* The value attributed to each clause is used by the builder and it may
* have one of the following values:
*
* - 1 = 01 - add the clause only
* - 2 = 10 - add the keyword
* - 3 = 11 - add both the keyword and the clause
*
* @var array
*/
public static $CLAUSES = array();
/**
* The options of this query.
*
* @var OptionsArray
*
* @see static::$OPTIONS
*/
public $options;
/**
* The index of the first token used in this statement.
*
* @var int
*/
public $first;
/**
* The index of the last token used in this statement.
*
* @var int
*/
public $last;
/**
* Constructor.
*
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*/
public function __construct(\PhpMyAdmin\SqlParser\Parser $parser = null, \PhpMyAdmin\SqlParser\TokensList $list = null)
{
}
/**
* Builds the string representation of this statement.
*
* @return string
*/
public function build()
{
}
/**
* Parses the statements defined by the tokens list.
*
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*/
public function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list)
{
}
/**
* Function called before the token is processed.
*
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
* @param Token $token the token that is being parsed
*/
public function before(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, \PhpMyAdmin\SqlParser\Token $token)
{
}
/**
* Function called after the token was processed.
*
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
* @param Token $token the token that is being parsed
*/
public function after(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, \PhpMyAdmin\SqlParser\Token $token)
{
}
/**
* Gets the clauses of this statement.
*
* @return array
*/
public function getClauses()
{
}
/**
* Builds the string representation of this statement.
*
* @see static::build
*
* @return string
*/
public function __toString()
{
}
/**
* Validates the order of the clauses in parsed statement
* Ideally this should be called after successfully
* completing the parsing of each statement.
*
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*
* @return bool
*/
public function validateClauseOrder($parser, $list)
{
}
}
/**
* A structure representing a list of tokens.
*
* @category Tokens
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class TokensList implements \ArrayAccess
{
/**
* The array of tokens.
*
* @var array
*/
public $tokens = array();
/**
* The count of tokens.
*
* @var int
*/
public $count = 0;
/**
* The index of the next token to be returned.
*
* @var int
*/
public $idx = 0;
/**
* Constructor.
*
* @param array $tokens the initial array of tokens
* @param int $count the count of tokens in the initial array
*/
public function __construct(array $tokens = array(), $count = -1)
{
}
/**
* Builds an array of tokens by merging their raw value.
*
* @param string|Token[]|TokensList $list the tokens to be built
*
* @return string
*/
public static function build($list)
{
}
/**
* Adds a new token.
*
* @param Token $token token to be added in list
*/
public function add(\PhpMyAdmin\SqlParser\Token $token)
{
}
/**
* Gets the next token. Skips any irrelevant token (whitespaces and
* comments).
*
* @return Token
*/
public function getNext()
{
}
/**
* Gets the next token.
*
* @param int $type the type
*
* @return Token
*/
public function getNextOfType($type)
{
}
/**
* Gets the next token.
*
* @param int $type the type of the token
* @param string $value the value of the token
*
* @return Token
*/
public function getNextOfTypeAndValue($type, $value)
{
}
/**
* Sets an value inside the container.
*
* @param int $offset the offset to be set
* @param Token $value the token to be saved
*/
public function offsetSet($offset, $value)
{
}
/**
* Gets a value from the container.
*
* @param int $offset the offset to be returned
*
* @return Token
*/
public function offsetGet($offset)
{
}
/**
* Checks if an offset was previously set.
*
* @param int $offset the offset to be checked
*
* @return bool
*/
public function offsetExists($offset)
{
}
/**
* Unsets the value of an offset.
*
* @param int $offset the offset to be unset
*/
public function offsetUnset($offset)
{
}
}
/**
* Performs lexical analysis over a SQL statement and splits it in multiple
* tokens.
*
* The output of the lexer is affected by the context of the SQL statement.
*
* @category Lexer
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*
* @see Context
*/
class Lexer extends \PhpMyAdmin\SqlParser\Core
{
/**
* A list of methods that are used in lexing the SQL query.
*
* @var array
*/
public static $PARSER_METHODS = array(
// It is best to put the parsers in order of their complexity
// (ascending) and their occurrence rate (descending).
//
// Conflicts:
//
// 1. `parseDelimiter`, `parseUnknown`, `parseKeyword`, `parseNumber`
// They fight over delimiter. The delimiter may be a keyword, a
// number or almost any character which makes the delimiter one of
// the first tokens that must be parsed.
//
// 1. `parseNumber` and `parseOperator`
// They fight over `+` and `-`.
//
// 2. `parseComment` and `parseOperator`
// They fight over `/` (as in ```/*comment*/``` or ```a / b```)
//
// 3. `parseBool` and `parseKeyword`
// They fight over `TRUE` and `FALSE`.
//
// 4. `parseKeyword` and `parseUnknown`
// They fight over words. `parseUnknown` does not know about
// keywords.
'parseDelimiter',
'parseWhitespace',
'parseNumber',
'parseComment',
'parseOperator',
'parseBool',
'parseString',
'parseSymbol',
'parseKeyword',
'parseLabel',
'parseUnknown',
);
/**
* The string to be parsed.
*
* @var string|UtfString
*/
public $str = '';
/**
* The length of `$str`.
*
* By storing its length, a lot of time is saved, because parsing methods
* would call `strlen` everytime.
*
* @var int
*/
public $len = 0;
/**
* The index of the last parsed character.
*
* @var int
*/
public $last = 0;
/**
* Tokens extracted from given strings.
*
* @var TokensList
*/
public $list;
/**
* The default delimiter. This is used, by default, in all new instances.
*
* @var string
*/
public static $DEFAULT_DELIMITER = ';';
/**
* Statements delimiter.
* This may change during lexing.
*
* @var string
*/
public $delimiter;
/**
* The length of the delimiter.
*
* Because `parseDelimiter` can be called a lot, it would perform a lot of
* calls to `strlen`, which might affect performance when the delimiter is
* big.
*
* @var int
*/
public $delimiterLen;
/**
* Gets the tokens list parsed by a new instance of a lexer.
*
* @param string|UtfString $str the query to be lexed
* @param bool $strict whether strict mode should be
* enabled or not
* @param string $delimiter the delimiter to be used
*
* @return TokensList
*/
public static function getTokens($str, $strict = false, $delimiter = null)
{
}
/**
* Constructor.
*
* @param string|UtfString $str the query to be lexed
* @param bool $strict whether strict mode should be
* enabled or not
* @param string $delimiter the delimiter to be used
*/
public function __construct($str, $strict = false, $delimiter = null)
{
}
/**
* Sets the delimiter.
*
* @param string $delimiter the new delimiter
*/
public function setDelimiter($delimiter)
{
}
/**
* Parses the string and extracts lexemes.
*/
public function lex()
{
}
/**
* Creates a new error log.
*
* @param string $msg the error message
* @param string $str the character that produced the error
* @param int $pos the position of the character
* @param int $code the code of the error
*
* @throws LexerException throws the exception, if strict mode is enabled
*/
public function error($msg, $str = '', $pos = 0, $code = 0)
{
}
/**
* Parses a keyword.
*
* @return null|Token
*/
public function parseKeyword()
{
}
/**
* Parses a label.
*
* @return null|Token
*/
public function parseLabel()
{
}
/**
* Parses an operator.
*
* @return null|Token
*/
public function parseOperator()
{
}
/**
* Parses a whitespace.
*
* @return null|Token
*/
public function parseWhitespace()
{
}
/**
* Parses a comment.
*
* @return null|Token
*/
public function parseComment()
{
}
/**
* Parses a boolean.
*
* @return null|Token
*/
public function parseBool()
{
}
/**
* Parses a number.
*
* @return null|Token
*/
public function parseNumber()
{
}
/**
* Parses a string.
*
* @param string $quote additional starting symbol
*
* @return null|Token
*/
public function parseString($quote = '')
{
}
/**
* Parses a symbol.
*
* @return null|Token
*/
public function parseSymbol()
{
}
/**
* Parses unknown parts of the query.
*
* @return null|Token
*/
public function parseUnknown()
{
}
/**
* Parses the delimiter of the query.
*
* @return null|Token
*/
public function parseDelimiter()
{
}
}
}
namespace PhpMyAdmin\SqlParser\Components {
/**
* The definition of a parameter of a function or procedure.
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ParameterDefinition extends \PhpMyAdmin\SqlParser\Component
{
/**
* The name of the new column.
*
* @var string
*/
public $name;
/**
* Parameter's direction (IN, OUT or INOUT).
*
* @var string
*/
public $inOut;
/**
* The data type of thew new column.
*
* @var DataType
*/
public $type;
/**
* Constructor.
*
* @param string $name parameter's name
* @param string $inOut parameter's directional type (IN / OUT or None)
* @param DataType $type parameter's type
*/
public function __construct($name = null, $inOut = null, $type = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return ParameterDefinition[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param ParameterDefinition[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses a data type.
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class DataType extends \PhpMyAdmin\SqlParser\Component
{
/**
* All data type options.
*
* @var array
*/
public static $DATA_TYPE_OPTIONS = array('BINARY' => 1, 'CHARACTER SET' => array(2, 'var'), 'CHARSET' => array(2, 'var'), 'COLLATE' => array(3, 'var'), 'UNSIGNED' => 4, 'ZEROFILL' => 5);
/**
* The name of the data type.
*
* @var string
*/
public $name;
/**
* The parameters of this data type.
*
* Some data types have no parameters.
* Numeric types might have parameters for the maximum number of digits,
* precision, etc.
* String types might have parameters for the maximum length stored.
* `ENUM` and `SET` have parameters for possible values.
*
* For more information, check the MySQL manual.
*
* @var array
*/
public $parameters = array();
/**
* The options of this data type.
*
* @var OptionsArray
*/
public $options;
/**
* Constructor.
*
* @param string $name the name of this data type
* @param array $parameters the parameters (size or possible values)
* @param OptionsArray $options the options of this data type
*/
public function __construct($name = null, array $parameters = array(), $options = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return DataType
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param DataType $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses a list of options.
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class OptionsArray extends \PhpMyAdmin\SqlParser\Component
{
/**
* ArrayObj of selected options.
*
* @var array
*/
public $options = array();
/**
* Constructor.
*
* @param array $options The array of options. Options that have a value
* must be an array with at least two keys `name` and
* `expr` or `value`.
*/
public function __construct(array $options = array())
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return OptionsArray
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param OptionsArray $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
/**
* Checks if it has the specified option and returns it value or true.
*
* @param string $key the key to be checked
* @param bool $getExpr Gets the expression instead of the value.
* The value is the processed form of the expression.
*
* @return mixed
*/
public function has($key, $getExpr = false)
{
}
/**
* Removes the option from the array.
*
* @param string $key the key to be removed
*
* @return bool whether the key was found and deleted or not
*/
public function remove($key)
{
}
/**
* Merges the specified options with these ones. Values with same ID will be
* replaced.
*
* @param array|OptionsArray $options the options to be merged
*/
public function merge($options)
{
}
/**
* Checks tf there are no options set.
*
* @return bool
*/
public function isEmpty()
{
}
}
/**
* `JOIN` keyword parser.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class JoinKeyword extends \PhpMyAdmin\SqlParser\Component
{
/**
* Types of join.
*
* @var array
*/
public static $JOINS = array('CROSS JOIN' => 'CROSS', 'FULL JOIN' => 'FULL', 'FULL OUTER JOIN' => 'FULL', 'INNER JOIN' => 'INNER', 'JOIN' => 'JOIN', 'LEFT JOIN' => 'LEFT', 'LEFT OUTER JOIN' => 'LEFT', 'RIGHT JOIN' => 'RIGHT', 'RIGHT OUTER JOIN' => 'RIGHT', 'NATURAL JOIN' => 'NATURAL', 'NATURAL LEFT JOIN' => 'NATURAL LEFT', 'NATURAL RIGHT JOIN' => 'NATURAL RIGHT', 'NATURAL LEFT OUTER JOIN' => 'NATURAL LEFT OUTER', 'NATURAL RIGHT OUTER JOIN' => 'NATURAL RIGHT OUTER', 'STRAIGHT_JOIN' => 'STRAIGHT');
/**
* Type of this join.
*
* @see static::$JOINS
*
* @var string
*/
public $type;
/**
* Join expression.
*
* @var Expression
*/
public $expr;
/**
* Join conditions.
*
* @var Condition[]
*/
public $on;
/**
* Columns in Using clause.
*
* @var ArrayObj
*/
public $using;
/**
* Constructor.
*
* @param string $type Join type
* @param Expression $expr join expression
* @param Condition[] $on join conditions
* @param ArrayObj $using columns joined
*
* @see JoinKeyword::$JOINS
*/
public function __construct($type = null, $expr = null, $on = null, $using = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return JoinKeyword[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param JoinKeyword[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses a reference to an expression (column, table or database name, function
* call, mathematical expression, etc.).
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Expression extends \PhpMyAdmin\SqlParser\Component
{
/**
* The name of this database.
*
* @var string
*/
public $database;
/**
* The name of this table.
*
* @var string
*/
public $table;
/**
* The name of the column.
*
* @var string
*/
public $column;
/**
* The sub-expression.
*
* @var string
*/
public $expr = '';
/**
* The alias of this expression.
*
* @var string
*/
public $alias;
/**
* The name of the function.
*
* @var mixed
*/
public $function;
/**
* The type of subquery.
*
* @var string
*/
public $subquery;
/**
* Constructor.
*
* Syntax:
* new Expression('expr')
* new Expression('expr', 'alias')
* new Expression('database', 'table', 'column')
* new Expression('database', 'table', 'column', 'alias')
*
* If the database, table or column name is not required, pass an empty
* string.
*
* @param string $database The name of the database or the the expression.
* the the expression.
* @param string $table The name of the table or the alias of the expression.
* the alias of the expression.
* @param string $column the name of the column
* @param string $alias the name of the alias
*/
public function __construct($database = null, $table = null, $column = null, $alias = null)
{
}
/**
* Possible options:.
*
* `field`
*
* First field to be filled.
* If this is not specified, it takes the value of `parseField`.
*
* `parseField`
*
* Specifies the type of the field parsed. It may be `database`,
* `table` or `column`. These expressions may not include
* parentheses.
*
* `breakOnAlias`
*
* If not empty, breaks when the alias occurs (it is not included).
*
* `breakOnParentheses`
*
* If not empty, breaks when the first parentheses occurs.
*
* `parenthesesDelimited`
*
* If not empty, breaks after last parentheses occurred.
*
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return Expression
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param Expression|Expression[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* `VALUES` keyword parser.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Array2d extends \PhpMyAdmin\SqlParser\Component
{
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return ArrayObj[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param ArrayObj[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses the create definition of a partition.
*
* Used for parsing `CREATE TABLE` statement.
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class PartitionDefinition extends \PhpMyAdmin\SqlParser\Component
{
/**
* All field options.
*
* @var array
*/
public static $OPTIONS = array('STORAGE ENGINE' => array(1, 'var'), 'ENGINE' => array(1, 'var'), 'COMMENT' => array(2, 'var'), 'DATA DIRECTORY' => array(3, 'var'), 'INDEX DIRECTORY' => array(4, 'var'), 'MAX_ROWS' => array(5, 'var'), 'MIN_ROWS' => array(6, 'var'), 'TABLESPACE' => array(7, 'var'), 'NODEGROUP' => array(8, 'var'));
/**
* Whether this entry is a subpartition or a partition.
*
* @var bool
*/
public $isSubpartition;
/**
* The name of this partition.
*
* @var string
*/
public $name;
/**
* The type of this partition (what follows the `VALUES` keyword).
*
* @var string
*/
public $type;
/**
* The expression used to defined this partition.
*
* @var Expression|string
*/
public $expr;
/**
* The subpartitions of this partition.
*
* @var PartitionDefinition[]
*/
public $subpartitions;
/**
* The options of this field.
*
* @var OptionsArray
*/
public $options;
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return PartitionDefinition
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param PartitionDefinition|PartitionDefinition[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* `UNION` keyword builder.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class UnionKeyword extends \PhpMyAdmin\SqlParser\Component
{
/**
* @param UnionKeyword[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses a reference to a CASE expression.
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class CaseExpression extends \PhpMyAdmin\SqlParser\Component
{
/**
* The value to be compared.
*
* @var Expression
*/
public $value;
/**
* The conditions in WHEN clauses.
*
* @var array
*/
public $conditions;
/**
* The results matching with the WHEN clauses.
*
* @var array
*/
public $results;
/**
* The values to be compared against.
*
* @var array
*/
public $compare_values;
/**
* The result in ELSE section of expr.
*
* @var Expression
*/
public $else_result;
/**
* The sub-expression.
*
* @var string
*/
public $expr = '';
/**
* Constructor.
*/
public function __construct()
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
*
* @return CaseExpression
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param CaseExpression $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* `ORDER BY` keyword parser.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class OrderKeyword extends \PhpMyAdmin\SqlParser\Component
{
/**
* The expression that is used for ordering.
*
* @var Expression
*/
public $expr;
/**
* The order type.
*
* @var string
*/
public $type;
/**
* Constructor.
*
* @param Expression $expr the expression that we are sorting by
* @param string $type the sorting type
*/
public function __construct($expr = null, $type = 'ASC')
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return OrderKeyword[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param OrderKeyword|OrderKeyword[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses an alter operation.
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class AlterOperation extends \PhpMyAdmin\SqlParser\Component
{
/**
* All database options.
*
* @var array
*/
public static $DB_OPTIONS = array('CHARACTER SET' => array(1, 'var'), 'CHARSET' => array(1, 'var'), 'DEFAULT CHARACTER SET' => array(1, 'var'), 'DEFAULT CHARSET' => array(1, 'var'), 'UPGRADE' => array(1, 'var'), 'COLLATE' => array(2, 'var'), 'DEFAULT COLLATE' => array(2, 'var'));
/**
* All table options.
*
* @var array
*/
public static $TABLE_OPTIONS = array('ENGINE' => array(1, 'var='), 'AUTO_INCREMENT' => array(1, 'var='), 'AVG_ROW_LENGTH' => array(1, 'var'), 'MAX_ROWS' => array(1, 'var'), 'ROW_FORMAT' => array(1, 'var'), 'COMMENT' => array(1, 'var'), 'ADD' => 1, 'ALTER' => 1, 'ANALYZE' => 1, 'CHANGE' => 1, 'CHECK' => 1, 'COALESCE' => 1, 'CONVERT' => 1, 'DISABLE' => 1, 'DISCARD' => 1, 'DROP' => 1, 'ENABLE' => 1, 'IMPORT' => 1, 'MODIFY' => 1, 'OPTIMIZE' => 1, 'ORDER' => 1, 'PARTITION' => 1, 'REBUILD' => 1, 'REMOVE' => 1, 'RENAME' => 1, 'REORGANIZE' => 1, 'REPAIR' => 1, 'UPGRADE' => 1, 'COLUMN' => 2, 'CONSTRAINT' => 2, 'DEFAULT' => 2, 'TO' => 2, 'BY' => 2, 'FOREIGN' => 2, 'FULLTEXT' => 2, 'KEY' => 2, 'KEYS' => 2, 'PARTITIONING' => 2, 'PRIMARY KEY' => 2, 'SPATIAL' => 2, 'TABLESPACE' => 2, 'INDEX' => 2);
/**
* All view options.
*
* @var array
*/
public static $VIEW_OPTIONS = array('AS' => 1);
/**
* Options of this operation.
*
* @var OptionsArray
*/
public $options;
/**
* The altered field.
*
* @var Expression
*/
public $field;
/**
* Unparsed tokens.
*
* @var Token[]|string
*/
public $unknown = array();
/**
* Constructor.
*
* @param OptionsArray $options options of alter operation
* @param Expression $field altered field
* @param array $unknown unparsed tokens found at the end of operation
*/
public function __construct($options = null, $field = null, $unknown = array())
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return AlterOperation
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param AlterOperation $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses the definition of a key.
*
* Used for parsing `CREATE TABLE` statement.
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Key extends \PhpMyAdmin\SqlParser\Component
{
/**
* All key options.
*
* @var array
*/
public static $KEY_OPTIONS = array('KEY_BLOCK_SIZE' => array(1, 'var'), 'USING' => array(2, 'var'), 'WITH PARSER' => array(3, 'var'), 'COMMENT' => array(4, 'var='));
/**
* The name of this key.
*
* @var string
*/
public $name;
/**
* Columns.
*
* @var array
*/
public $columns;
/**
* The type of this key.
*
* @var string
*/
public $type;
/**
* The options of this key.
*
* @var OptionsArray
*/
public $options;
/**
* Constructor.
*
* @param string $name the name of the key
* @param array $columns the columns covered by this key
* @param string $type the type of this key
* @param OptionsArray $options the options of this key
*/
public function __construct($name = null, array $columns = array(), $type = null, $options = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return Key
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param Key $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* `LIMIT` keyword parser.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Limit extends \PhpMyAdmin\SqlParser\Component
{
/**
* The number of rows skipped.
*
* @var int
*/
public $offset;
/**
* The number of rows to be returned.
*
* @var int
*/
public $rowCount;
/**
* Constructor.
*
* @param int $rowCount the row count
* @param int $offset the offset
*/
public function __construct($rowCount = 0, $offset = 0)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return Limit
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param Limit $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* `GROUP BY` keyword parser.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class GroupKeyword extends \PhpMyAdmin\SqlParser\Component
{
/**
* The expression that is used for grouping.
*
* @var Expression
*/
public $expr;
/**
* Constructor.
*
* @param Expression $expr the expression that we are sorting by
*/
public function __construct($expr = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return GroupKeyword[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param GroupKeyword|GroupKeyword[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* `RENAME TABLE` keyword parser.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class RenameOperation extends \PhpMyAdmin\SqlParser\Component
{
/**
* The old table name.
*
* @var Expression
*/
public $old;
/**
* The new table name.
*
* @var Expression
*/
public $new;
/**
* Constructor.
*
* @param Expression $old old expression
* @param Expression $new new expression containing new name
*/
public function __construct($old = null, $new = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return RenameOperation[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param RenameOperation $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses the create definition of a column or a key.
*
* Used for parsing `CREATE TABLE` statement.
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class CreateDefinition extends \PhpMyAdmin\SqlParser\Component
{
/**
* All field options.
*
* @var array
*/
public static $FIELD_OPTIONS = array(
// Tells the `OptionsArray` to not sort the options.
// See the note below.
'_UNSORTED' => true,
'NOT NULL' => 1,
'NULL' => 1,
'DEFAULT' => array(2, 'expr', array('breakOnAlias' => true)),
/* Following are not according to grammar, but MySQL happily accepts
* these at any location */
'CHARSET' => array(2, 'var'),
'COLLATE' => array(3, 'var'),
'AUTO_INCREMENT' => 3,
'PRIMARY' => 4,
'PRIMARY KEY' => 4,
'UNIQUE' => 4,
'UNIQUE KEY' => 4,
'COMMENT' => array(5, 'var'),
'COLUMN_FORMAT' => array(6, 'var'),
'ON UPDATE' => array(7, 'expr'),
// Generated columns options.
'GENERATED ALWAYS' => 8,
'AS' => array(9, 'expr', array('parenthesesDelimited' => true)),
'VIRTUAL' => 10,
'PERSISTENT' => 11,
'STORED' => 11,
);
/**
* The name of the new column.
*
* @var string
*/
public $name;
/**
* Whether this field is a constraint or not.
*
* @var bool
*/
public $isConstraint;
/**
* The data type of thew new column.
*
* @var DataType
*/
public $type;
/**
* The key.
*
* @var Key
*/
public $key;
/**
* The table that is referenced.
*
* @var Reference
*/
public $references;
/**
* The options of this field.
*
* @var OptionsArray
*/
public $options;
/**
* Constructor.
*
* @param string $name the name of the field
* @param OptionsArray $options the options of this field
* @param DataType|Key $type the data type of this field or the key
* @param bool $isConstraint whether this field is a constraint or not
* @param Reference $references references
*/
public function __construct($name = null, $options = null, $type = null, $isConstraint = false, $references = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return CreateDefinition[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param CreateDefinition|CreateDefinition[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* `REFERENCES` keyword parser.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Reference extends \PhpMyAdmin\SqlParser\Component
{
/**
* All references options.
*
* @var array
*/
public static $REFERENCES_OPTIONS = array('MATCH' => array(1, 'var'), 'ON DELETE' => array(2, 'var'), 'ON UPDATE' => array(3, 'var'));
/**
* The referenced table.
*
* @var Expression
*/
public $table;
/**
* The referenced columns.
*
* @var array
*/
public $columns;
/**
* The options of the referencing.
*
* @var OptionsArray
*/
public $options;
/**
* Constructor.
*
* @param Expression $table the name of the table referenced
* @param array $columns the columns referenced
* @param OptionsArray $options the options
*/
public function __construct($table = null, array $columns = array(), $options = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return Reference
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param Reference $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* `SET` keyword parser.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class SetOperation extends \PhpMyAdmin\SqlParser\Component
{
/**
* The name of the column that is being updated.
*
* @var string
*/
public $column;
/**
* The new value.
*
* @var string
*/
public $value;
/**
* Constructor.
*
* @param string $column Field's name..
* @param string $value new value
*/
public function __construct($column = null, $value = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return SetOperation[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param SetOperation|SetOperation[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* `WHERE` keyword parser.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Condition extends \PhpMyAdmin\SqlParser\Component
{
/**
* Logical operators that can be used to delimit expressions.
*
* @var array
*/
public static $DELIMITERS = array('&&', '||', 'AND', 'OR', 'XOR');
/**
* List of allowed reserved keywords in conditions.
*
* @var array
*/
public static $ALLOWED_KEYWORDS = array('ALL' => 1, 'AND' => 1, 'BETWEEN' => 1, 'EXISTS' => 1, 'IF' => 1, 'IN' => 1, 'INTERVAL' => 1, 'IS' => 1, 'LIKE' => 1, 'MATCH' => 1, 'NOT IN' => 1, 'NOT NULL' => 1, 'NOT' => 1, 'NULL' => 1, 'OR' => 1, 'REGEXP' => 1, 'RLIKE' => 1, 'XOR' => 1);
/**
* Identifiers recognized.
*
* @var array
*/
public $identifiers = array();
/**
* Whether this component is an operator.
*
* @var bool
*/
public $isOperator = false;
/**
* The condition.
*
* @var string
*/
public $expr;
/**
* Constructor.
*
* @param string $expr the condition or the operator
*/
public function __construct($expr = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return Condition[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param Condition[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* `INTO` keyword parser.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class IntoKeyword extends \PhpMyAdmin\SqlParser\Component
{
/**
* FIELDS/COLUMNS Options for `SELECT...INTO` statements.
*
* @var array
*/
public static $FIELDS_OPTIONS = array('TERMINATED BY' => array(1, 'expr'), 'OPTIONALLY' => 2, 'ENCLOSED BY' => array(3, 'expr'), 'ESCAPED BY' => array(4, 'expr'));
/**
* LINES Options for `SELECT...INTO` statements.
*
* @var array
*/
public static $LINES_OPTIONS = array('STARTING BY' => array(1, 'expr'), 'TERMINATED BY' => array(2, 'expr'));
/**
* Type of target (OUTFILE or SYMBOL).
*
* @var string
*/
public $type;
/**
* The destination, which can be a table or a file.
*
* @var string|Expression
*/
public $dest;
/**
* The name of the columns.
*
* @var array
*/
public $columns;
/**
* The values to be selected into (SELECT .. INTO @var1).
*
* @var Expression[]
*/
public $values;
/**
* Options for FIELDS/COLUMNS keyword.
*
* @var OptionsArray
*
* @see static::$FIELDS_OPTIONS
*/
public $fields_options;
/**
* Whether to use `FIELDS` or `COLUMNS` while building.
*
* @var bool
*/
public $fields_keyword;
/**
* Options for OPTIONS keyword.
*
* @var OptionsArray
*
* @see static::$LINES_OPTIONS
*/
public $lines_options;
/**
* Constructor.
*
* @param string $type type of destination (may be OUTFILE)
* @param string|Expression $dest actual destination
* @param array $columns column list of destination
* @param array $values selected fields
* @param OptionsArray $fields_options options for FIELDS/COLUMNS keyword
* @param OptionsArray $fields_keyword options for OPTINOS keyword
*/
public function __construct($type = null, $dest = null, $columns = null, $values = null, $fields_options = null, $fields_keyword = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return IntoKeyword
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
public function parseFileOptions(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, $keyword = 'FIELDS')
{
}
/**
* @param IntoKeyword $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses a list of expressions delimited by a comma.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ExpressionArray extends \PhpMyAdmin\SqlParser\Component
{
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return Expression[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param ExpressionArray[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses an array.
*
* @category Components
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ArrayObj extends \PhpMyAdmin\SqlParser\Component
{
/**
* The array that contains the unprocessed value of each token.
*
* @var array
*/
public $raw = array();
/**
* The array that contains the processed value of each token.
*
* @var array
*/
public $values = array();
/**
* Constructor.
*
* @param array $raw the unprocessed values
* @param array $values the processed values
*/
public function __construct(array $raw = array(), array $values = array())
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return ArrayObj|Component[]
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param ArrayObj|ArrayObj[] $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
/**
* Parses a function call.
*
* @category Keywords
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class FunctionCall extends \PhpMyAdmin\SqlParser\Component
{
/**
* The name of this function.
*
* @var string
*/
public $name;
/**
* The list of parameters.
*
* @var ArrayObj
*/
public $parameters;
/**
* Constructor.
*
* @param string $name the name of the function to be called
* @param array|ArrayObj $parameters the parameters of this function
*/
public function __construct($name = null, $parameters = null)
{
}
/**
* @param Parser $parser the parser that serves as context
* @param TokensList $list the list of tokens that are being parsed
* @param array $options parameters for parsing
*
* @return FunctionCall
*/
public static function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, array $options = array())
{
}
/**
* @param FunctionCall $component the component to be built
* @param array $options parameters for building
*
* @return string
*/
public static function build($component, array $options = array())
{
}
}
}
namespace PhpMyAdmin\SqlParser {
/**
* Takes multiple tokens (contained in a Lexer instance) as input and builds a
* parse tree.
*
* @category Parser
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class Parser extends \PhpMyAdmin\SqlParser\Core
{
/**
* Array of classes that are used in parsing the SQL statements.
*
* @var array
*/
public static $STATEMENT_PARSERS = array(
// MySQL Utility Statements
'DESCRIBE' => 'PhpMyAdmin\\SqlParser\\Statements\\ExplainStatement',
'DESC' => 'PhpMyAdmin\\SqlParser\\Statements\\ExplainStatement',
'EXPLAIN' => 'PhpMyAdmin\\SqlParser\\Statements\\ExplainStatement',
'FLUSH' => '',
'GRANT' => '',
'HELP' => '',
'SET PASSWORD' => '',
'STATUS' => '',
'USE' => '',
// Table Maintenance Statements
// https://dev.mysql.com/doc/refman/5.7/en/table-maintenance-sql.html
'ANALYZE' => 'PhpMyAdmin\\SqlParser\\Statements\\AnalyzeStatement',
'BACKUP' => 'PhpMyAdmin\\SqlParser\\Statements\\BackupStatement',
'CHECK' => 'PhpMyAdmin\\SqlParser\\Statements\\CheckStatement',
'CHECKSUM' => 'PhpMyAdmin\\SqlParser\\Statements\\ChecksumStatement',
'OPTIMIZE' => 'PhpMyAdmin\\SqlParser\\Statements\\OptimizeStatement',
'REPAIR' => 'PhpMyAdmin\\SqlParser\\Statements\\RepairStatement',
'RESTORE' => 'PhpMyAdmin\\SqlParser\\Statements\\RestoreStatement',
// Database Administration Statements
// https://dev.mysql.com/doc/refman/5.7/en/sql-syntax-server-administration.html
'SET' => 'PhpMyAdmin\\SqlParser\\Statements\\SetStatement',
'SHOW' => 'PhpMyAdmin\\SqlParser\\Statements\\ShowStatement',
// Data Definition Statements.
// https://dev.mysql.com/doc/refman/5.7/en/sql-syntax-data-definition.html
'ALTER' => 'PhpMyAdmin\\SqlParser\\Statements\\AlterStatement',
'CREATE' => 'PhpMyAdmin\\SqlParser\\Statements\\CreateStatement',
'DROP' => 'PhpMyAdmin\\SqlParser\\Statements\\DropStatement',
'RENAME' => 'PhpMyAdmin\\SqlParser\\Statements\\RenameStatement',
'TRUNCATE' => 'PhpMyAdmin\\SqlParser\\Statements\\TruncateStatement',
// Data Manipulation Statements.
// https://dev.mysql.com/doc/refman/5.7/en/sql-syntax-data-manipulation.html
'CALL' => 'PhpMyAdmin\\SqlParser\\Statements\\CallStatement',
'DELETE' => 'PhpMyAdmin\\SqlParser\\Statements\\DeleteStatement',
'DO' => '',
'HANDLER' => '',
'INSERT' => 'PhpMyAdmin\\SqlParser\\Statements\\InsertStatement',
'LOAD DATA' => 'PhpMyAdmin\\SqlParser\\Statements\\LoadStatement',
'REPLACE' => 'PhpMyAdmin\\SqlParser\\Statements\\ReplaceStatement',
'SELECT' => 'PhpMyAdmin\\SqlParser\\Statements\\SelectStatement',
'UPDATE' => 'PhpMyAdmin\\SqlParser\\Statements\\UpdateStatement',
// Prepared Statements.
// https://dev.mysql.com/doc/refman/5.7/en/sql-syntax-prepared-statements.html
'DEALLOCATE' => '',
'EXECUTE' => '',
'PREPARE' => '',
// Transactional and Locking Statements
// https://dev.mysql.com/doc/refman/5.7/en/commit.html
'BEGIN' => 'PhpMyAdmin\\SqlParser\\Statements\\TransactionStatement',
'COMMIT' => 'PhpMyAdmin\\SqlParser\\Statements\\TransactionStatement',
'ROLLBACK' => 'PhpMyAdmin\\SqlParser\\Statements\\TransactionStatement',
'START TRANSACTION' => 'PhpMyAdmin\\SqlParser\\Statements\\TransactionStatement',
);
/**
* Array of classes that are used in parsing SQL components.
*
* @var array
*/
public static $KEYWORD_PARSERS = array(
// This is not a proper keyword and was added here to help the
// formatter.
'PARTITION BY' => array(),
'SUBPARTITION BY' => array(),
// This is not a proper keyword and was added here to help the
// builder.
'_OPTIONS' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\OptionsArray', 'field' => 'options'),
'_END_OPTIONS' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\OptionsArray', 'field' => 'end_options'),
'INTERSECT' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\UnionKeyword', 'field' => 'union'),
'EXCEPT' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\UnionKeyword', 'field' => 'union'),
'UNION' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\UnionKeyword', 'field' => 'union'),
'UNION ALL' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\UnionKeyword', 'field' => 'union'),
'UNION DISTINCT' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\UnionKeyword', 'field' => 'union'),
// Actual clause parsers.
'ALTER' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\Expression', 'field' => 'table', 'options' => array('parseField' => 'table')),
'ANALYZE' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'tables', 'options' => array('parseField' => 'table')),
'BACKUP' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'tables', 'options' => array('parseField' => 'table')),
'CALL' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\FunctionCall', 'field' => 'call'),
'CHECK' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'tables', 'options' => array('parseField' => 'table')),
'CHECKSUM' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'tables', 'options' => array('parseField' => 'table')),
'CROSS JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'DROP' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'fields', 'options' => array('parseField' => 'table')),
'FROM' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'from', 'options' => array('field' => 'table')),
'GROUP BY' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\GroupKeyword', 'field' => 'group'),
'HAVING' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\Condition', 'field' => 'having'),
'INTO' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\IntoKeyword', 'field' => 'into'),
'JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'LEFT JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'LEFT OUTER JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'ON' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\Expression', 'field' => 'table', 'options' => array('parseField' => 'table')),
'RIGHT JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'RIGHT OUTER JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'INNER JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'FULL JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'FULL OUTER JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'NATURAL JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'NATURAL LEFT JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'NATURAL RIGHT JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'NATURAL LEFT OUTER JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'NATURAL RIGHT OUTER JOIN' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\JoinKeyword', 'field' => 'join'),
'LIMIT' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\Limit', 'field' => 'limit'),
'OPTIMIZE' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'tables', 'options' => array('parseField' => 'table')),
'ORDER BY' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\OrderKeyword', 'field' => 'order'),
'PARTITION' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ArrayObj', 'field' => 'partition'),
'PROCEDURE' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\FunctionCall', 'field' => 'procedure'),
'RENAME' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\RenameOperation', 'field' => 'renames'),
'REPAIR' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'tables', 'options' => array('parseField' => 'table')),
'RESTORE' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'tables', 'options' => array('parseField' => 'table')),
'SET' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\SetOperation', 'field' => 'set'),
'SELECT' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'expr'),
'TRUNCATE' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\Expression', 'field' => 'table', 'options' => array('parseField' => 'table')),
'UPDATE' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\ExpressionArray', 'field' => 'tables', 'options' => array('parseField' => 'table')),
'VALUE' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\Array2d', 'field' => 'values'),
'VALUES' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\Array2d', 'field' => 'values'),
'WHERE' => array('class' => 'PhpMyAdmin\\SqlParser\\Components\\Condition', 'field' => 'where'),
);
/**
* The list of tokens that are parsed.
*
* @var TokensList
*/
public $list;
/**
* List of statements parsed.
*
* @var Statement[]
*/
public $statements = array();
/**
* The number of opened brackets.
*
* @var int
*/
public $brackets = 0;
/**
* Constructor.
*
* @param string|UtfString|TokensList $list the list of tokens to be parsed
* @param bool $strict whether strict mode should be enabled or not
*/
public function __construct($list = null, $strict = false)
{
}
/**
* Builds the parse trees.
*/
public function parse()
{
}
/**
* Creates a new error log.
*
* @param string $msg the error message
* @param Token $token the token that produced the error
* @param int $code the code of the error
*
* @throws ParserException throws the exception, if strict mode is enabled
*/
public function error($msg, \PhpMyAdmin\SqlParser\Token $token = null, $code = 0)
{
}
}
}
namespace PhpMyAdmin\SqlParser\Statements {
/**
* `DROP` statement.
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class DropStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options of this statement.
*
* @var array
*/
public static $OPTIONS = array('DATABASE' => 1, 'EVENT' => 1, 'FUNCTION' => 1, 'INDEX' => 1, 'LOGFILE' => 1, 'PROCEDURE' => 1, 'SCHEMA' => 1, 'SERVER' => 1, 'TABLE' => 1, 'VIEW' => 1, 'TABLESPACE' => 1, 'TRIGGER' => 1, 'TEMPORARY' => 2, 'IF EXISTS' => 3);
/**
* The clauses of this statement, in order.
*
* @see Statement::$CLAUSES
*
* @var array
*/
public static $CLAUSES = array(
'DROP' => array('DROP', 2),
// Used for options.
'_OPTIONS' => array('_OPTIONS', 1),
// Used for select expressions.
'DROP_' => array('DROP', 1),
'ON' => array('ON', 3),
);
/**
* Dropped elements.
*
* @var Expression[]
*/
public $fields;
/**
* Table of the dropped index.
*
* @var Expression
*/
public $table;
}
/**
* Transaction statement.
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class TransactionStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* START TRANSACTION and BEGIN.
*
* @var int
*/
const TYPE_BEGIN = 1;
/**
* COMMIT and ROLLBACK.
*
* @var int
*/
const TYPE_END = 2;
/**
* The type of this query.
*
* @var int
*/
public $type;
/**
* The list of statements in this transaction.
*
* @var Statement[]
*/
public $statements;
/**
* The ending transaction statement which may be a `COMMIT` or a `ROLLBACK`.
*
* @var TransactionStatement
*/
public $end;
/**
* Options for this query.
*
* @var array
*/
public static $OPTIONS = array('START TRANSACTION' => 1, 'BEGIN' => 1, 'COMMIT' => 1, 'ROLLBACK' => 1, 'WITH CONSISTENT SNAPSHOT' => 2, 'WORK' => 2, 'AND NO CHAIN' => 3, 'AND CHAIN' => 3, 'RELEASE' => 4, 'NO RELEASE' => 4);
/**
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*/
public function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list)
{
}
/**
* @return string
*/
public function build()
{
}
}
/**
* Maintenance statement.
*
* They follow the syntax:
* STMT [some options] tbl_name [, tbl_name] ... [some more options]
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class MaintenanceStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Tables maintained.
*
* @var Expression[]
*/
public $tables;
/**
* Function called after the token was processed.
*
* Parses the additional options from the end.
*
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
* @param Token $token the token that is being parsed
*/
public function after(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, \PhpMyAdmin\SqlParser\Token $token)
{
}
}
/**
* `BACKUP` statement.
*
* BACKUP TABLE tbl_name [, tbl_name] ... TO '/path/to/backup/directory'
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class BackupStatement extends \PhpMyAdmin\SqlParser\Statements\MaintenanceStatement
{
/**
* Options of this statement.
*
* @var array
*/
public static $OPTIONS = array('TABLE' => 1, 'NO_WRITE_TO_BINLOG' => 2, 'LOCAL' => 3, 'TO' => array(4, 'var'));
}
/**
* `UPDATE` statement.
*
* UPDATE [LOW_PRIORITY] [IGNORE] table_reference
* SET col_name1={expr1|DEFAULT} [, col_name2={expr2|DEFAULT}] ...
* [WHERE where_condition]
* [ORDER BY ...]
* [LIMIT row_count]
*
* or
*
* UPDATE [LOW_PRIORITY] [IGNORE] table_references
* SET col_name1={expr1|DEFAULT} [, col_name2={expr2|DEFAULT}] ...
* [WHERE where_condition]
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class UpdateStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options for `UPDATE` statements and their slot ID.
*
* @var array
*/
public static $OPTIONS = array('LOW_PRIORITY' => 1, 'IGNORE' => 2);
/**
* The clauses of this statement, in order.
*
* @see Statement::$CLAUSES
*
* @var array
*/
public static $CLAUSES = array(
'UPDATE' => array('UPDATE', 2),
// Used for options.
'_OPTIONS' => array('_OPTIONS', 1),
// Used for updated tables.
'_UPDATE' => array('UPDATE', 1),
'SET' => array('SET', 3),
'WHERE' => array('WHERE', 3),
'ORDER BY' => array('ORDER BY', 3),
'LIMIT' => array('LIMIT', 3),
);
/**
* Tables used as sources for this statement.
*
* @var Expression[]
*/
public $tables;
/**
* The updated values.
*
* @var SetOperation[]
*/
public $set;
/**
* Conditions used for filtering each row of the result set.
*
* @var Condition[]
*/
public $where;
/**
* Specifies the order of the rows in the result set.
*
* @var OrderKeyword[]
*/
public $order;
/**
* Conditions used for limiting the size of the result set.
*
* @var Limit
*/
public $limit;
}
/**
* `DELETE` statement.
*
* DELETE [LOW_PRIORITY] [QUICK] [IGNORE] FROM tbl_name
* [PARTITION (partition_name,...)]
* [WHERE where_condition]
* [ORDER BY ...]
* [LIMIT row_count]
*
* Multi-table syntax
*
* DELETE [LOW_PRIORITY] [QUICK] [IGNORE]
* tbl_name[.*] [, tbl_name[.*]] ...
* FROM table_references
* [WHERE where_condition]
*
* OR
*
* DELETE [LOW_PRIORITY] [QUICK] [IGNORE]
* FROM tbl_name[.*] [, tbl_name[.*]] ...
* USING table_references
* [WHERE where_condition]
*
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class DeleteStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options for `DELETE` statements.
*
* @var array
*/
public static $OPTIONS = array('LOW_PRIORITY' => 1, 'QUICK' => 2, 'IGNORE' => 3);
/**
* The clauses of this statement, in order.
*
* @see Statement::$CLAUSES
*
* @var array
*/
public static $CLAUSES = array(
'DELETE' => array('DELETE', 2),
// Used for options.
'_OPTIONS' => array('_OPTIONS', 1),
'FROM' => array('FROM', 3),
'PARTITION' => array('PARTITION', 3),
'USING' => array('USING', 3),
'WHERE' => array('WHERE', 3),
'ORDER BY' => array('ORDER BY', 3),
'LIMIT' => array('LIMIT', 3),
);
/**
* Table(s) used as sources for this statement.
*
* @var Expression[]
*/
public $from;
/**
* Joins.
*
* @var JoinKeyword[]
*/
public $join;
/**
* Tables used as sources for this statement.
*
* @var Expression[]
*/
public $using;
/**
* Columns used in this statement.
*
* @var Expression[]
*/
public $columns;
/**
* Partitions used as source for this statement.
*
* @var ArrayObj
*/
public $partition;
/**
* Conditions used for filtering each row of the result set.
*
* @var Condition[]
*/
public $where;
/**
* Specifies the order of the rows in the result set.
*
* @var OrderKeyword[]
*/
public $order;
/**
* Conditions used for limiting the size of the result set.
*
* @var Limit
*/
public $limit;
/**
* @return string
*/
public function build()
{
}
/**
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*/
public function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list)
{
}
}
/**
* `SELECT` statement.
*
* SELECT
* [ALL | DISTINCT | DISTINCTROW ]
* [HIGH_PRIORITY]
* [MAX_STATEMENT_TIME = N]
* [STRAIGHT_JOIN]
* [SQL_SMALL_RESULT] [SQL_BIG_RESULT] [SQL_BUFFER_RESULT]
* [SQL_CACHE | SQL_NO_CACHE] [SQL_CALC_FOUND_ROWS]
* select_expr [, select_expr ...]
* [FROM table_references
* [PARTITION partition_list]
* [WHERE where_condition]
* [GROUP BY {col_name | expr | position}
* [ASC | DESC], ... [WITH ROLLUP]]
* [HAVING where_condition]
* [ORDER BY {col_name | expr | position}
* [ASC | DESC], ...]
* [LIMIT {[offset,] row_count | row_count OFFSET offset}]
* [PROCEDURE procedure_name(argument_list)]
* [INTO OUTFILE 'file_name'
* [CHARACTER SET charset_name]
* export_options
* | INTO DUMPFILE 'file_name'
* | INTO var_name [, var_name]]
* [FOR UPDATE | LOCK IN SHARE MODE]]
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class SelectStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options for `SELECT` statements and their slot ID.
*
* @var array
*/
public static $OPTIONS = array('ALL' => 1, 'DISTINCT' => 1, 'DISTINCTROW' => 1, 'HIGH_PRIORITY' => 2, 'MAX_STATEMENT_TIME' => array(3, 'var='), 'STRAIGHT_JOIN' => 4, 'SQL_SMALL_RESULT' => 5, 'SQL_BIG_RESULT' => 6, 'SQL_BUFFER_RESULT' => 7, 'SQL_CACHE' => 8, 'SQL_NO_CACHE' => 8, 'SQL_CALC_FOUND_ROWS' => 9);
public static $END_OPTIONS = array('FOR UPDATE' => 1, 'LOCK IN SHARE MODE' => 1);
/**
* The clauses of this statement, in order.
*
* @see Statement::$CLAUSES
*
* @var array
*/
public static $CLAUSES = array(
'SELECT' => array('SELECT', 2),
// Used for options.
'_OPTIONS' => array('_OPTIONS', 1),
// Used for selected expressions.
'_SELECT' => array('SELECT', 1),
'INTO' => array('INTO', 3),
'FROM' => array('FROM', 3),
'PARTITION' => array('PARTITION', 3),
'JOIN' => array('JOIN', 1),
'FULL JOIN' => array('FULL JOIN', 1),
'INNER JOIN' => array('INNER JOIN', 1),
'LEFT JOIN' => array('LEFT JOIN', 1),
'LEFT OUTER JOIN' => array('LEFT OUTER JOIN', 1),
'RIGHT JOIN' => array('RIGHT JOIN', 1),
'RIGHT OUTER JOIN' => array('RIGHT OUTER JOIN', 1),
'NATURAL JOIN' => array('NATURAL JOIN', 1),
'NATURAL LEFT JOIN' => array('NATURAL LEFT JOIN', 1),
'NATURAL RIGHT JOIN' => array('NATURAL RIGHT JOIN', 1),
'NATURAL LEFT OUTER JOIN' => array('NATURAL LEFT OUTER JOIN', 1),
'NATURAL RIGHT OUTER JOIN' => array('NATURAL RIGHT JOIN', 1),
'WHERE' => array('WHERE', 3),
'GROUP BY' => array('GROUP BY', 3),
'HAVING' => array('HAVING', 3),
'ORDER BY' => array('ORDER BY', 3),
'LIMIT' => array('LIMIT', 3),
'PROCEDURE' => array('PROCEDURE', 3),
'UNION' => array('UNION', 1),
'EXCEPT' => array('EXCEPT', 1),
'INTERSECT' => array('INTERSECT', 1),
'_END_OPTIONS' => array('_END_OPTIONS', 1),
);
/**
* Expressions that are being selected by this statement.
*
* @var Expression[]
*/
public $expr = array();
/**
* Tables used as sources for this statement.
*
* @var Expression[]
*/
public $from = array();
/**
* Partitions used as source for this statement.
*
* @var ArrayObj
*/
public $partition;
/**
* Conditions used for filtering each row of the result set.
*
* @var Condition[]
*/
public $where;
/**
* Conditions used for grouping the result set.
*
* @var OrderKeyword[]
*/
public $group;
/**
* Conditions used for filtering the result set.
*
* @var Condition[]
*/
public $having;
/**
* Specifies the order of the rows in the result set.
*
* @var OrderKeyword[]
*/
public $order;
/**
* Conditions used for limiting the size of the result set.
*
* @var Limit
*/
public $limit;
/**
* Procedure that should process the data in the result set.
*
* @var FunctionCall
*/
public $procedure;
/**
* Destination of this result set.
*
* @var IntoKeyword
*/
public $into;
/**
* Joins.
*
* @var JoinKeyword[]
*/
public $join;
/**
* Unions.
*
* @var SelectStatement[]
*/
public $union = array();
/**
* The end options of this query.
*
* @var OptionsArray
*
* @see static::$END_OPTIONS
*/
public $end_options;
/**
* Gets the clauses of this statement.
*
* @return array
*/
public function getClauses()
{
}
}
/**
* `SET` statement.
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class SetStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* The clauses of this statement, in order.
*
* @see Statement::$CLAUSES
*
* @var array
*/
public static $CLAUSES = array('SET' => array('SET', 3));
/**
* Possible exceptions in SET statment.
*
* @var array
*/
public static $OPTIONS = array('CHARSET' => array(3, 'var'), 'CHARACTER SET' => array(3, 'var'), 'NAMES' => array(3, 'var'), 'PASSWORD' => array(3, 'expr'));
/**
* Options used in current statement.
*
* @var OptionsArray[]
*/
public $options;
/**
* The updated values.
*
* @var SetOperation[]
*/
public $set;
/**
* @return string
*/
public function build()
{
}
}
/**
* `REPLACE` statement.
*
* REPLACE [LOW_PRIORITY | DELAYED]
* [INTO] tbl_name [(col_name,...)]
* {VALUES | VALUE} ({expr | DEFAULT},...),(...),...
*
* or
*
* REPLACE [LOW_PRIORITY | DELAYED]
* [INTO] tbl_name
* SET col_name={expr | DEFAULT}, ...
*
* or
*
* REPLACE [LOW_PRIORITY | DELAYED]
* [INTO] tbl_name
* [PARTITION (partition_name,...)]
* [(col_name,...)]
* SELECT ...
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ReplaceStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options for `REPLACE` statements and their slot ID.
*
* @var array
*/
public static $OPTIONS = array('LOW_PRIORITY' => 1, 'DELAYED' => 1);
/**
* Tables used as target for this statement.
*
* @var IntoKeyword
*/
public $into;
/**
* Values to be replaced.
*
* @var Array2d
*/
public $values;
/**
* If SET clause is present
* holds the SetOperation.
*
* @var SetOperation[]
*/
public $set;
/**
* If SELECT clause is present
* holds the SelectStatement.
*
* @var SelectStatement
*/
public $select;
/**
* @return string
*/
public function build()
{
}
/**
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*/
public function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list)
{
}
}
/**
* `RESTORE` statement.
*
* RESTORE TABLE tbl_name [, tbl_name] ... FROM '/path/to/backup/directory'
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class RestoreStatement extends \PhpMyAdmin\SqlParser\Statements\MaintenanceStatement
{
/**
* Options of this statement.
*
* @var array
*/
public static $OPTIONS = array('TABLE' => 1, 'FROM' => array(2, 'var'));
}
/**
* `REPAIR` statement.
*
* REPAIR [NO_WRITE_TO_BINLOG | LOCAL] TABLE
* tbl_name [, tbl_name] ...
* [QUICK] [EXTENDED] [USE_FRM]
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class RepairStatement extends \PhpMyAdmin\SqlParser\Statements\MaintenanceStatement
{
/**
* Options of this statement.
*
* @var array
*/
public static $OPTIONS = array('TABLE' => 1, 'NO_WRITE_TO_BINLOG' => 2, 'LOCAL' => 3, 'QUICK' => 4, 'EXTENDED' => 5, 'USE_FRM' => 6);
}
/**
* `TRUNCATE` statement.
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class TruncateStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options for `TRUNCATE` statements.
*
* @var array
*/
public static $OPTIONS = array('TABLE' => 1);
/**
* The name of the truncated table.
*
* @var Expression
*/
public $table;
}
/**
* `CALL` statement.
*
* CALL sp_name([parameter[,...]])
*
* or
*
* CALL sp_name[()]
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class CallStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* The name of the function and its parameters.
*
* @var FunctionCall
*/
public $call;
}
/**
* `CREATE` statement.
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class CreateStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options for `CREATE` statements.
*
* @var array
*/
public static $OPTIONS = array(
// CREATE TABLE
'TEMPORARY' => 1,
// CREATE VIEW
'OR REPLACE' => array(2, 'var='),
'ALGORITHM' => array(3, 'var='),
// `DEFINER` is also used for `CREATE FUNCTION / PROCEDURE`
'DEFINER' => array(4, 'expr='),
'SQL SECURITY' => array(5, 'var'),
'DATABASE' => 6,
'EVENT' => 6,
'FUNCTION' => 6,
'INDEX' => 6,
'UNIQUE INDEX' => 6,
'FULLTEXT INDEX' => 6,
'SPATIAL INDEX' => 6,
'PROCEDURE' => 6,
'SERVER' => 6,
'TABLE' => 6,
'TABLESPACE' => 6,
'TRIGGER' => 6,
'USER' => 6,
'VIEW' => 6,
// CREATE TABLE
'IF NOT EXISTS' => 7,
);
/**
* All database options.
*
* @var array
*/
public static $DB_OPTIONS = array('CHARACTER SET' => array(1, 'var='), 'CHARSET' => array(1, 'var='), 'DEFAULT CHARACTER SET' => array(1, 'var='), 'DEFAULT CHARSET' => array(1, 'var='), 'DEFAULT COLLATE' => array(2, 'var='), 'COLLATE' => array(2, 'var='));
/**
* All table options.
*
* @var array
*/
public static $TABLE_OPTIONS = array('ENGINE' => array(1, 'var='), 'AUTO_INCREMENT' => array(2, 'var='), 'AVG_ROW_LENGTH' => array(3, 'var'), 'CHARACTER SET' => array(4, 'var='), 'CHARSET' => array(4, 'var='), 'DEFAULT CHARACTER SET' => array(4, 'var='), 'DEFAULT CHARSET' => array(4, 'var='), 'CHECKSUM' => array(5, 'var'), 'DEFAULT COLLATE' => array(6, 'var='), 'COLLATE' => array(6, 'var='), 'COMMENT' => array(7, 'var='), 'CONNECTION' => array(8, 'var'), 'DATA DIRECTORY' => array(9, 'var'), 'DELAY_KEY_WRITE' => array(10, 'var'), 'INDEX DIRECTORY' => array(11, 'var'), 'INSERT_METHOD' => array(12, 'var'), 'KEY_BLOCK_SIZE' => array(13, 'var'), 'MAX_ROWS' => array(14, 'var'), 'MIN_ROWS' => array(15, 'var'), 'PACK_KEYS' => array(16, 'var'), 'PASSWORD' => array(17, 'var'), 'ROW_FORMAT' => array(18, 'var'), 'TABLESPACE' => array(19, 'var'), 'STORAGE' => array(20, 'var'), 'UNION' => array(21, 'var'));
/**
* All function options.
*
* @var array
*/
public static $FUNC_OPTIONS = array('COMMENT' => array(1, 'var='), 'LANGUAGE SQL' => 2, 'DETERMINISTIC' => 3, 'NOT DETERMINISTIC' => 3, 'CONTAINS SQL' => 4, 'NO SQL' => 4, 'READS SQL DATA' => 4, 'MODIFIES SQL DATA' => 4, 'SQL SECURITY DEFINER' => array(5, 'var'));
/**
* All trigger options.
*
* @var array
*/
public static $TRIGGER_OPTIONS = array('BEFORE' => 1, 'AFTER' => 1, 'INSERT' => 2, 'UPDATE' => 2, 'DELETE' => 2);
/**
* The name of the entity that is created.
*
* Used by all `CREATE` statements.
*
* @var Expression
*/
public $name;
/**
* The options of the entity (table, procedure, function, etc.).
*
* Used by `CREATE TABLE`, `CREATE FUNCTION` and `CREATE PROCEDURE`.
*
* @var OptionsArray
*
* @see static::$TABLE_OPTIONS
* @see static::$FUNC_OPTIONS
* @see static::$TRIGGER_OPTIONS
*/
public $entityOptions;
/**
* If `CREATE TABLE`, a list of columns and keys.
* If `CREATE VIEW`, a list of columns.
*
* Used by `CREATE TABLE` and `CREATE VIEW`.
*
* @var CreateDefinition[]|ArrayObj
*/
public $fields;
/**
* If `CREATE TABLE ... SELECT`.
*
* Used by `CREATE TABLE`
*
* @var SelectStatement
*/
public $select;
/**
* If `CREATE TABLE ... LIKE`.
*
* Used by `CREATE TABLE`
*
* @var Expression
*/
public $like;
/**
* Expression used for partitioning.
*
* @var string
*/
public $partitionBy;
/**
* The number of partitions.
*
* @var int
*/
public $partitionsNum;
/**
* Expression used for subpartitioning.
*
* @var string
*/
public $subpartitionBy;
/**
* The number of subpartitions.
*
* @var int
*/
public $subpartitionsNum;
/**
* The partition of the new table.
*
* @var PartitionDefinition[]
*/
public $partitions;
/**
* If `CREATE TRIGGER` the name of the table.
*
* Used by `CREATE TRIGGER`.
*
* @var Expression
*/
public $table;
/**
* The return data type of this routine.
*
* Used by `CREATE FUNCTION`.
*
* @var DataType
*/
public $return;
/**
* The parameters of this routine.
*
* Used by `CREATE FUNCTION` and `CREATE PROCEDURE`.
*
* @var ParameterDefinition[]
*/
public $parameters;
/**
* The body of this function or procedure. For views, it is the select
* statement that gets the.
*
* Used by `CREATE FUNCTION`, `CREATE PROCEDURE` and `CREATE VIEW`.
*
* @var Token[]|string
*/
public $body = array();
/**
* @return string
*/
public function build()
{
}
/**
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*/
public function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list)
{
}
}
/**
* `ANALYZE` statement.
*
* ANALYZE [NO_WRITE_TO_BINLOG | LOCAL] TABLE
* tbl_name [, tbl_name] ...
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class AnalyzeStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options of this statement.
*
* @var array
*/
public static $OPTIONS = array('TABLE' => 1, 'NO_WRITE_TO_BINLOG' => 2, 'LOCAL' => 3);
/**
* Analyzed tables.
*
* @var Expression[]
*/
public $tables;
}
/**
* `LOAD` statement.
*
* LOAD DATA [LOW_PRIORITY | CONCURRENT] [LOCAL] INFILE 'file_name'
* [REPLACE | IGNORE]
* INTO TABLE tbl_name
* [PARTITION (partition_name,...)]
* [CHARACTER SET charset_name]
* [{FIELDS | COLUMNS}
* [TERMINATED BY 'string']
* [[OPTIONALLY] ENCLOSED BY 'char']
* [ESCAPED BY 'char']
* ]
* [LINES
* [STARTING BY 'string']
* [TERMINATED BY 'string']
* ]
* [IGNORE number {LINES | ROWS}]
* [(col_name_or_user_var,...)]
* [SET col_name = expr,...]
*
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class LoadStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options for `LOAD` statements and their slot ID.
*
* @var array
*/
public static $OPTIONS = array('LOW_PRIORITY' => 1, 'CONCURRENT' => 1, 'LOCAL' => 2);
/**
* FIELDS/COLUMNS Options for `LOAD DATA...INFILE` statements.
*
* @var array
*/
public static $FIELDS_OPTIONS = array('TERMINATED BY' => array(1, 'expr'), 'OPTIONALLY' => 2, 'ENCLOSED BY' => array(3, 'expr'), 'ESCAPED BY' => array(4, 'expr'));
/**
* LINES Options for `LOAD DATA...INFILE` statements.
*
* @var array
*/
public static $LINES_OPTIONS = array('STARTING BY' => array(1, 'expr'), 'TERMINATED BY' => array(2, 'expr'));
/**
* File name being used to load data.
*
* @var Expression
*/
public $file_name;
/**
* Table used as destination for this statement.
*
* @var Expression
*/
public $table;
/**
* Partitions used as source for this statement.
*
* @var ArrayObj
*/
public $partition;
/**
* Character set used in this statement.
*
* @var Expression
*/
public $charset_name;
/**
* Options for FIELDS/COLUMNS keyword.
*
* @var OptionsArray
*
* @see static::$FIELDS_OPTIONS
*/
public $fields_options;
/**
* Whether to use `FIELDS` or `COLUMNS` while building.
*
* @var string
*/
public $fields_keyword;
/**
* Options for OPTIONS keyword.
*
* @var OptionsArray
*
* @see static::$LINES_OPTIONS
*/
public $lines_options;
/**
* Column names or user variables.
*
* @var Expression[]
*/
public $col_name_or_user_var;
/**
* SET clause's updated values(optional).
*
* @var SetOperation[]
*/
public $set;
/**
* Ignore 'number' LINES/ROWS.
*
* @var Expression
*/
public $ignore_number;
/**
* REPLACE/IGNORE Keyword.
*
* @var string
*/
public $replace_ignore;
/**
* LINES/ROWS Keyword.
*
* @var string
*/
public $lines_rows;
/**
* @return string
*/
public function build()
{
}
/**
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*/
public function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list)
{
}
public function parseFileOptions(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, $keyword = 'FIELDS')
{
}
public function parseKeywordsAccordingToState($parser, $list, $state)
{
}
}
/**
* `CHECKSUM` statement.
*
* CHECKSUM TABLE tbl_name [, tbl_name] ... [ QUICK | EXTENDED ]
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ChecksumStatement extends \PhpMyAdmin\SqlParser\Statements\MaintenanceStatement
{
/**
* Options of this statement.
*
* @var array
*/
public static $OPTIONS = array('TABLE' => 1, 'QUICK' => 2, 'EXTENDED' => 3);
}
/**
* Not implemented (yet) statements.
*
* The `after` function makes the parser jump straight to the first delimiter.
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class NotImplementedStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* The part of the statement that can't be parsed.
*
* @var Token[]
*/
public $unknown = array();
/**
* @return string
*/
public function build()
{
}
/**
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*/
public function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list)
{
}
}
/**
* `CHECK` statement.
*
* CHECK TABLE tbl_name [, tbl_name] ... [option] ...
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class CheckStatement extends \PhpMyAdmin\SqlParser\Statements\MaintenanceStatement
{
/**
* Options of this statement.
*
* @var array
*/
public static $OPTIONS = array('TABLE' => 1, 'FOR UPGRADE' => 2, 'QUICK' => 3, 'FAST' => 4, 'MEDIUM' => 5, 'EXTENDED' => 6, 'CHANGED' => 7);
}
/**
* `INSERT` statement.
*
* INSERT [LOW_PRIORITY | DELAYED | HIGH_PRIORITY] [IGNORE]
* [INTO] tbl_name
* [PARTITION (partition_name,...)]
* [(col_name,...)]
* {VALUES | VALUE} ({expr | DEFAULT},...),(...),...
* [ ON DUPLICATE KEY UPDATE
* col_name=expr
* [, col_name=expr] ... ]
*
* or
*
* INSERT [LOW_PRIORITY | DELAYED | HIGH_PRIORITY] [IGNORE]
* [INTO] tbl_name
* [PARTITION (partition_name,...)]
* SET col_name={expr | DEFAULT}, ...
* [ ON DUPLICATE KEY UPDATE
* col_name=expr
* [, col_name=expr] ... ]
*
* or
*
* INSERT [LOW_PRIORITY | HIGH_PRIORITY] [IGNORE]
* [INTO] tbl_name
* [PARTITION (partition_name,...)]
* [(col_name,...)]
* SELECT ...
* [ ON DUPLICATE KEY UPDATE
* col_name=expr
* [, col_name=expr] ... ]
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class InsertStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options for `INSERT` statements.
*
* @var array
*/
public static $OPTIONS = array('LOW_PRIORITY' => 1, 'DELAYED' => 2, 'HIGH_PRIORITY' => 3, 'IGNORE' => 4);
/**
* Tables used as target for this statement.
*
* @var IntoKeyword
*/
public $into;
/**
* Values to be inserted.
*
* @var ArrayObj[]|null
*/
public $values;
/**
* If SET clause is present
* holds the SetOperation.
*
* @var SetOperation[]
*/
public $set;
/**
* If SELECT clause is present
* holds the SelectStatement.
*
* @var SelectStatement
*/
public $select;
/**
* If ON DUPLICATE KEY UPDATE clause is present
* holds the SetOperation.
*
* @var SetOperation[]
*/
public $onDuplicateSet;
/**
* @return string
*/
public function build()
{
}
/**
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*/
public function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list)
{
}
}
/**
* `EXPLAIN` statement.
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ExplainStatement extends \PhpMyAdmin\SqlParser\Statements\NotImplementedStatement
{
}
/**
* `SHOW` statement.
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ShowStatement extends \PhpMyAdmin\SqlParser\Statements\NotImplementedStatement
{
/**
* Options of this statement.
*
* @var array
*/
public static $OPTIONS = array('CREATE' => 1, 'AUTHORS' => 2, 'BINARY' => 2, 'BINLOG' => 2, 'CHARACTER' => 2, 'CODE' => 2, 'COLLATION' => 2, 'COLUMNS' => 2, 'CONTRIBUTORS' => 2, 'DATABASE' => 2, 'DATABASES' => 2, 'ENGINE' => 2, 'ENGINES' => 2, 'ERRORS' => 2, 'EVENT' => 2, 'EVENTS' => 2, 'FUNCTION' => 2, 'GRANTS' => 2, 'HOSTS' => 2, 'INDEX' => 2, 'INNODB' => 2, 'LOGS' => 2, 'MASTER' => 2, 'OPEN' => 2, 'PLUGINS' => 2, 'PRIVILEGES' => 2, 'PROCEDURE' => 2, 'PROCESSLIST' => 2, 'PROFILE' => 2, 'PROFILES' => 2, 'SCHEDULER' => 2, 'SET' => 2, 'SLAVE' => 2, 'STATUS' => 2, 'TABLE' => 2, 'TABLES' => 2, 'TRIGGER' => 2, 'TRIGGERS' => 2, 'VARIABLES' => 2, 'VIEW' => 2, 'WARNINGS' => 2);
}
/**
* `OPTIMIZE` statement.
*
* OPTIMIZE [NO_WRITE_TO_BINLOG | LOCAL] TABLE
* tbl_name [, tbl_name] ...
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class OptimizeStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Options of this statement.
*
* @var array
*/
public static $OPTIONS = array('TABLE' => 1, 'NO_WRITE_TO_BINLOG' => 2, 'LOCAL' => 3);
/**
* Optimized tables.
*
* @var Expression[]
*/
public $tables;
}
/**
* `ALTER` statement.
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class AlterStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* Table affected.
*
* @var Expression
*/
public $table;
/**
* Column affected by this statement.
*
* @var AlterOperation[]
*/
public $altered = array();
/**
* Options of this statement.
*
* @var array
*/
public static $OPTIONS = array('ONLINE' => 1, 'OFFLINE' => 1, 'IGNORE' => 2, 'DATABASE' => 3, 'EVENT' => 3, 'FUNCTION' => 3, 'PROCEDURE' => 3, 'SERVER' => 3, 'TABLE' => 3, 'TABLESPACE' => 3, 'VIEW' => 3);
/**
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
*/
public function parse(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list)
{
}
/**
* @return string
*/
public function build()
{
}
}
/**
* `RENAME` statement.
*
* RENAME TABLE tbl_name TO new_tbl_name
* [, tbl_name2 TO new_tbl_name2] ...
*
* @category Statements
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class RenameStatement extends \PhpMyAdmin\SqlParser\Statement
{
/**
* The old and new names of the tables.
*
* @var RenameOperation[]
*/
public $renames;
/**
* Function called before the token is processed.
*
* Skips the `TABLE` keyword after `RENAME`.
*
* @param Parser $parser the instance that requests parsing
* @param TokensList $list the list of tokens to be parsed
* @param Token $token the token that is being parsed
*/
public function before(\PhpMyAdmin\SqlParser\Parser $parser, \PhpMyAdmin\SqlParser\TokensList $list, \PhpMyAdmin\SqlParser\Token $token)
{
}
}
}
namespace PhpMyAdmin\SqlParser\Tools {
/**
* Used for test generation.
*
* @category Tests
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class TestGenerator
{
/**
* Generates a test's data.
*
* @param string $query the query to be analyzed
* @param string $type test's type (may be `lexer` or `parser`)
*
* @return array
*/
public static function generate($query, $type = 'parser')
{
}
/**
* Builds a test.
*
* Reads the input file, generates the data and writes it back.
*
* @param string $type the type of this test
* @param string $input the input file
* @param string $output the output file
* @param string $debug the debug file
*/
public static function build($type, $input, $output, $debug = null)
{
}
/**
* Generates recursively all tests preserving the directory structure.
*
* @param string $input the input directory
* @param string $output the output directory
* @param null|mixed $debug
*/
public static function buildAll($input, $output, $debug = null)
{
}
}
/**
* Used for context generation.
*
* @category Contexts
*
* @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+
*/
class ContextGenerator
{
/**
* Labels and flags that may be used when defining keywords.
*
* @var array
*/
public static $LABELS_FLAGS = array(
'(R)' => 2,
// reserved
'(D)' => 8,
// data type
'(K)' => 16,
// keyword
'(F)' => 32,
);
/**
* Documentation links for each context.
*
* @var array
*/
public static $LINKS = array('MySql50000' => 'https://dev.mysql.com/doc/refman/5.0/en/keywords.html', 'MySql50100' => 'https://dev.mysql.com/doc/refman/5.1/en/keywords.html', 'MySql50500' => 'https://dev.mysql.com/doc/refman/5.5/en/keywords.html', 'MySql50600' => 'https://dev.mysql.com/doc/refman/5.6/en/keywords.html', 'MySql50700' => 'https://dev.mysql.com/doc/refman/5.7/en/keywords.html', 'MySql80000' => 'https://dev.mysql.com/doc/refman/8.0/en/keywords.html', 'MariaDb100000' => 'https://mariadb.com/kb/en/the-mariadb-library/reserved-words/', 'MariaDb100100' => 'https://mariadb.com/kb/en/the-mariadb-library/reserved-words/', 'MariaDb100200' => 'https://mariadb.com/kb/en/the-mariadb-library/reserved-words/', 'MariaDb100300' => 'https://mariadb.com/kb/en/the-mariadb-library/reserved-words/');
/**
* The template of a context.
*
* Parameters:
* 1 - name
* 2 - class
* 3 - link
* 4 - keywords array
*
* @var string
*/
const TEMPLATE = '<?php' . "\n" . '' . "\n" . '/**' . "\n" . ' * Context for %1$s.' . "\n" . ' *' . "\n" . ' * This file was auto-generated.' . "\n" . ' *' . "\n" . ' * @see %3$s' . "\n" . ' */' . "\n" . '' . "\n" . 'namespace PhpMyAdmin\\SqlParser\\Contexts;' . "\n" . '' . "\n" . 'use PhpMyAdmin\\SqlParser\\Context;' . "\n" . 'use PhpMyAdmin\\SqlParser\\Token;' . "\n" . '' . "\n" . '/**' . "\n" . ' * Context for %1$s.' . "\n" . ' *' . "\n" . ' * @category Contexts' . "\n" . ' *' . "\n" . ' * @license https://www.gnu.org/licenses/gpl-2.0.txt GPL-2.0+' . "\n" . ' */' . "\n" . 'class %2$s extends Context' . "\n" . '{' . "\n" . ' /**' . "\n" . ' * List of keywords.' . "\n" . ' *' . "\n" . ' * The value associated to each keyword represents its flags.' . "\n" . ' *' . "\n" . ' * @see Token::FLAG_KEYWORD_RESERVED Token::FLAG_KEYWORD_COMPOSED' . "\n" . ' * Token::FLAG_KEYWORD_DATA_TYPE Token::FLAG_KEYWORD_KEY' . "\n" . ' * Token::FLAG_KEYWORD_FUNCTION' . "\n" . ' *' . "\n" . ' * @var array' . "\n" . ' */' . "\n" . ' public static $KEYWORDS = array(' . "\n" . '%4$s' . ' );' . "\n" . '}' . "\n";
/**
* Sorts an array of words.
*
* @param array $arr
*
* @return array
*/
public static function sortWords(array &$arr)
{
}
/**
* Reads a list of words and sorts it by type, length and keyword.
*
* @param string[] $files
*
* @return array
*/
public static function readWords(array $files)
{
}
/**
* Prints an array of a words in PHP format.
*
* @param array $words the list of words to be formatted
* @param int $spaces the number of spaces that starts every line
* @param int $line the length of a line
*
* @return string
*/
public static function printWords($words, $spaces = 8, $line = 80)
{
}
/**
* Generates a context's class.
*
* @param array $options the options that are used in generating this context
*
* @return string
*/
public static function generate($options)
{
}
/**
* Formats context name.
*
* @param string $name name to format
*
* @return string
*/
public static function formatName($name)
{
}
/**
* Builds a test.
*
* Reads the input file, generates the data and writes it back.
*
* @param string $input the input file
* @param string $output the output directory
*/
public static function build($input, $output)
{
}
/**
* Generates recursively all tests preserving the directory structure.
*
* @param string $input the input directory
* @param string $output the output directory
*/
public static function buildAll($input, $output)
{
}
}
}
namespace Illuminate\Database {
class QueryException extends \PDOException
{
/**
* The SQL for the query.
*
* @var string
*/
protected $sql;
/**
* The bindings for the query.
*
* @var array
*/
protected $bindings;
/**
* Create a new query exception instance.
*
* @param string $sql
* @param array $bindings
* @param \Exception $previous
* @return void
*/
public function __construct($sql, array $bindings, $previous)
{
}
/**
* Format the SQL error message.
*
* @param string $sql
* @param array $bindings
* @param \Exception $previous
* @return string
*/
protected function formatMessage($sql, $bindings, $previous)
{
}
/**
* Get the SQL for the query.
*
* @return string
*/
public function getSql()
{
}
/**
* Get the bindings for the query.
*
* @return array
*/
public function getBindings()
{
}
}
}
namespace Illuminate\Database\Schema {
class Builder
{
/**
* The database connection instance.
*
* @var \Illuminate\Database\Connection
*/
protected $connection;
/**
* The schema grammar instance.
*
* @var \Illuminate\Database\Schema\Grammars\Grammar
*/
protected $grammar;
/**
* The Blueprint resolver callback.
*
* @var \Closure
*/
protected $resolver;
/**
* Create a new database Schema manager.
*
* @param \Illuminate\Database\Connection $connection
* @return void
*/
public function __construct(\Illuminate\Database\Connection $connection)
{
}
/**
* Determine if the given table exists.
*
* @param string $table
* @return bool
*/
public function hasTable($table)
{
}
/**
* Determine if the given table has a given column.
*
* @param string $table
* @param string $column
* @return bool
*/
public function hasColumn($table, $column)
{
}
/**
* Determine if the given table has given columns.
*
* @param string $table
* @param array $columns
* @return bool
*/
public function hasColumns($table, array $columns)
{
}
/**
* Get the data type for the given column name.
*
* @param string $table
* @param string $column
* @return string
*/
public function getColumnType($table, $column)
{
}
/**
* Get the column listing for a given table.
*
* @param string $table
* @return array
*/
public function getColumnListing($table)
{
}
/**
* Modify a table on the schema.
*
* @param string $table
* @param \Closure $callback
* @return \Illuminate\Database\Schema\Blueprint
*/
public function table($table, \Closure $callback)
{
}
/**
* Create a new table on the schema.
*
* @param string $table
* @param \Closure $callback
* @return \Illuminate\Database\Schema\Blueprint
*/
public function create($table, \Closure $callback)
{
}
/**
* Drop a table from the schema.
*
* @param string $table
* @return \Illuminate\Database\Schema\Blueprint
*/
public function drop($table)
{
}
/**
* Drop a table from the schema if it exists.
*
* @param string $table
* @return \Illuminate\Database\Schema\Blueprint
*/
public function dropIfExists($table)
{
}
/**
* Rename a table on the schema.
*
* @param string $from
* @param string $to
* @return \Illuminate\Database\Schema\Blueprint
*/
public function rename($from, $to)
{
}
/**
* Enable foreign key constraints.
*
* @return bool
*/
public function enableForeignKeyConstraints()
{
}
/**
* Disable foreign key constraints.
*
* @return bool
*/
public function disableForeignKeyConstraints()
{
}
/**
* Execute the blueprint to build / modify the table.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @return void
*/
protected function build(\Illuminate\Database\Schema\Blueprint $blueprint)
{
}
/**
* Create a new command set with a Closure.
*
* @param string $table
* @param \Closure|null $callback
* @return \Illuminate\Database\Schema\Blueprint
*/
protected function createBlueprint($table, \Closure $callback = null)
{
}
/**
* Get the database connection instance.
*
* @return \Illuminate\Database\Connection
*/
public function getConnection()
{
}
/**
* Set the database connection instance.
*
* @param \Illuminate\Database\Connection $connection
* @return $this
*/
public function setConnection(\Illuminate\Database\Connection $connection)
{
}
/**
* Set the Schema Blueprint resolver callback.
*
* @param \Closure $resolver
* @return void
*/
public function blueprintResolver(\Closure $resolver)
{
}
}
class PostgresBuilder extends \Illuminate\Database\Schema\Builder
{
/**
* Determine if the given table exists.
*
* @param string $table
* @return bool
*/
public function hasTable($table)
{
}
}
class Blueprint
{
/**
* The table the blueprint describes.
*
* @var string
*/
protected $table;
/**
* The columns that should be added to the table.
*
* @var array
*/
protected $columns = [];
/**
* The commands that should be run for the table.
*
* @var array
*/
protected $commands = [];
/**
* The storage engine that should be used for the table.
*
* @var string
*/
public $engine;
/**
* The default character set that should be used for the table.
*/
public $charset;
/**
* The collation that should be used for the table.
*/
public $collation;
/**
* Whether to make the table temporary.
*
* @var bool
*/
public $temporary = false;
/**
* Create a new schema blueprint.
*
* @param string $table
* @param \Closure|null $callback
* @return void
*/
public function __construct($table, \Closure $callback = null)
{
}
/**
* Execute the blueprint against the database.
*
* @param \Illuminate\Database\Connection $connection
* @param \Illuminate\Database\Schema\Grammars\Grammar $grammar
* @return void
*/
public function build(\Illuminate\Database\Connection $connection, \Illuminate\Database\Schema\Grammars\Grammar $grammar)
{
}
/**
* Get the raw SQL statements for the blueprint.
*
* @param \Illuminate\Database\Connection $connection
* @param \Illuminate\Database\Schema\Grammars\Grammar $grammar
* @return array
*/
public function toSql(\Illuminate\Database\Connection $connection, \Illuminate\Database\Schema\Grammars\Grammar $grammar)
{
}
/**
* Add the commands that are implied by the blueprint.
*
* @return void
*/
protected function addImpliedCommands()
{
}
/**
* Add the index commands fluently specified on columns.
*
* @return void
*/
protected function addFluentIndexes()
{
}
/**
* Determine if the blueprint has a create command.
*
* @return bool
*/
protected function creating()
{
}
/**
* Indicate that the table needs to be created.
*
* @return \Illuminate\Support\Fluent
*/
public function create()
{
}
/**
* Indicate that the table needs to be temporary.
*
* @return void
*/
public function temporary()
{
}
/**
* Indicate that the table should be dropped.
*
* @return \Illuminate\Support\Fluent
*/
public function drop()
{
}
/**
* Indicate that the table should be dropped if it exists.
*
* @return \Illuminate\Support\Fluent
*/
public function dropIfExists()
{
}
/**
* Indicate that the given columns should be dropped.
*
* @param array|mixed $columns
* @return \Illuminate\Support\Fluent
*/
public function dropColumn($columns)
{
}
/**
* Indicate that the given columns should be renamed.
*
* @param string $from
* @param string $to
* @return \Illuminate\Support\Fluent
*/
public function renameColumn($from, $to)
{
}
/**
* Indicate that the given primary key should be dropped.
*
* @param string|array $index
* @return \Illuminate\Support\Fluent
*/
public function dropPrimary($index = null)
{
}
/**
* Indicate that the given unique key should be dropped.
*
* @param string|array $index
* @return \Illuminate\Support\Fluent
*/
public function dropUnique($index)
{
}
/**
* Indicate that the given index should be dropped.
*
* @param string|array $index
* @return \Illuminate\Support\Fluent
*/
public function dropIndex($index)
{
}
/**
* Indicate that the given foreign key should be dropped.
*
* @param string|array $index
* @return \Illuminate\Support\Fluent
*/
public function dropForeign($index)
{
}
/**
* Indicate that the timestamp columns should be dropped.
*
* @return void
*/
public function dropTimestamps()
{
}
/**
* Indicate that the timestamp columns should be dropped.
*
* @return void
*/
public function dropTimestampsTz()
{
}
/**
* Indicate that the soft delete column should be dropped.
*
* @return void
*/
public function dropSoftDeletes()
{
}
/**
* Indicate that the remember token column should be dropped.
*
* @return void
*/
public function dropRememberToken()
{
}
/**
* Rename the table to a given name.
*
* @param string $to
* @return \Illuminate\Support\Fluent
*/
public function rename($to)
{
}
/**
* Specify the primary key(s) for the table.
*
* @param string|array $columns
* @param string $name
* @return \Illuminate\Support\Fluent
*/
public function primary($columns, $name = null)
{
}
/**
* Specify a unique index for the table.
*
* @param string|array $columns
* @param string $name
* @return \Illuminate\Support\Fluent
*/
public function unique($columns, $name = null)
{
}
/**
* Specify an index for the table.
*
* @param string|array $columns
* @param string $name
* @return \Illuminate\Support\Fluent
*/
public function index($columns, $name = null)
{
}
/**
* Specify a foreign key for the table.
*
* @param string|array $columns
* @param string $name
* @return \Illuminate\Support\Fluent
*/
public function foreign($columns, $name = null)
{
}
/**
* Create a new auto-incrementing integer (4-byte) column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function increments($column)
{
}
/**
* Create a new auto-incrementing small integer (2-byte) column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function smallIncrements($column)
{
}
/**
* Create a new auto-incrementing medium integer (3-byte) column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function mediumIncrements($column)
{
}
/**
* Create a new auto-incrementing big integer (8-byte) column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function bigIncrements($column)
{
}
/**
* Create a new char column on the table.
*
* @param string $column
* @param int $length
* @return \Illuminate\Support\Fluent
*/
public function char($column, $length = 255)
{
}
/**
* Create a new string column on the table.
*
* @param string $column
* @param int $length
* @return \Illuminate\Support\Fluent
*/
public function string($column, $length = 255)
{
}
/**
* Create a new text column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function text($column)
{
}
/**
* Create a new medium text column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function mediumText($column)
{
}
/**
* Create a new long text column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function longText($column)
{
}
/**
* Create a new integer (4-byte) column on the table.
*
* @param string $column
* @param bool $autoIncrement
* @param bool $unsigned
* @return \Illuminate\Support\Fluent
*/
public function integer($column, $autoIncrement = false, $unsigned = false)
{
}
/**
* Create a new tiny integer (1-byte) column on the table.
*
* @param string $column
* @param bool $autoIncrement
* @param bool $unsigned
* @return \Illuminate\Support\Fluent
*/
public function tinyInteger($column, $autoIncrement = false, $unsigned = false)
{
}
/**
* Create a new small integer (2-byte) column on the table.
*
* @param string $column
* @param bool $autoIncrement
* @param bool $unsigned
* @return \Illuminate\Support\Fluent
*/
public function smallInteger($column, $autoIncrement = false, $unsigned = false)
{
}
/**
* Create a new medium integer (3-byte) column on the table.
*
* @param string $column
* @param bool $autoIncrement
* @param bool $unsigned
* @return \Illuminate\Support\Fluent
*/
public function mediumInteger($column, $autoIncrement = false, $unsigned = false)
{
}
/**
* Create a new big integer (8-byte) column on the table.
*
* @param string $column
* @param bool $autoIncrement
* @param bool $unsigned
* @return \Illuminate\Support\Fluent
*/
public function bigInteger($column, $autoIncrement = false, $unsigned = false)
{
}
/**
* Create a new unsigned tiny integer (1-byte) column on the table.
*
* @param string $column
* @param bool $autoIncrement
* @return \Illuminate\Support\Fluent
*/
public function unsignedTinyInteger($column, $autoIncrement = false)
{
}
/**
* Create a new unsigned small integer (2-byte) column on the table.
*
* @param string $column
* @param bool $autoIncrement
* @return \Illuminate\Support\Fluent
*/
public function unsignedSmallInteger($column, $autoIncrement = false)
{
}
/**
* Create a new unsigned medium integer (3-byte) column on the table.
*
* @param string $column
* @param bool $autoIncrement
* @return \Illuminate\Support\Fluent
*/
public function unsignedMediumInteger($column, $autoIncrement = false)
{
}
/**
* Create a new unsigned integer (4-byte) column on the table.
*
* @param string $column
* @param bool $autoIncrement
* @return \Illuminate\Support\Fluent
*/
public function unsignedInteger($column, $autoIncrement = false)
{
}
/**
* Create a new unsigned big integer (8-byte) column on the table.
*
* @param string $column
* @param bool $autoIncrement
* @return \Illuminate\Support\Fluent
*/
public function unsignedBigInteger($column, $autoIncrement = false)
{
}
/**
* Create a new float column on the table.
*
* @param string $column
* @param int $total
* @param int $places
* @return \Illuminate\Support\Fluent
*/
public function float($column, $total = 8, $places = 2)
{
}
/**
* Create a new double column on the table.
*
* @param string $column
* @param int|null $total
* @param int|null $places
* @return \Illuminate\Support\Fluent
*/
public function double($column, $total = null, $places = null)
{
}
/**
* Create a new decimal column on the table.
*
* @param string $column
* @param int $total
* @param int $places
* @return \Illuminate\Support\Fluent
*/
public function decimal($column, $total = 8, $places = 2)
{
}
/**
* Create a new boolean column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function boolean($column)
{
}
/**
* Create a new enum column on the table.
*
* @param string $column
* @param array $allowed
* @return \Illuminate\Support\Fluent
*/
public function enum($column, array $allowed)
{
}
/**
* Create a new json column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function json($column)
{
}
/**
* Create a new jsonb column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function jsonb($column)
{
}
/**
* Create a new date column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function date($column)
{
}
/**
* Create a new date-time column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function dateTime($column)
{
}
/**
* Create a new date-time column (with time zone) on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function dateTimeTz($column)
{
}
/**
* Create a new time column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function time($column)
{
}
/**
* Create a new time column (with time zone) on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function timeTz($column)
{
}
/**
* Create a new timestamp column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function timestamp($column)
{
}
/**
* Create a new timestamp (with time zone) column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function timestampTz($column)
{
}
/**
* Add nullable creation and update timestamps to the table.
*
* Alias for self::timestamps().
*
* @return void
*/
public function nullableTimestamps()
{
}
/**
* Add nullable creation and update timestamps to the table.
*
* @return void
*/
public function timestamps()
{
}
/**
* Add creation and update timestampTz columns to the table.
*
* @return void
*/
public function timestampsTz()
{
}
/**
* Add a "deleted at" timestamp for the table.
*
* @return \Illuminate\Support\Fluent
*/
public function softDeletes()
{
}
/**
* Create a new binary column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function binary($column)
{
}
/**
* Create a new uuid column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function uuid($column)
{
}
/**
* Create a new IP address column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function ipAddress($column)
{
}
/**
* Create a new MAC address column on the table.
*
* @param string $column
* @return \Illuminate\Support\Fluent
*/
public function macAddress($column)
{
}
/**
* Add the proper columns for a polymorphic table.
*
* @param string $name
* @param string|null $indexName
* @return void
*/
public function morphs($name, $indexName = null)
{
}
/**
* Adds the `remember_token` column to the table.
*
* @return \Illuminate\Support\Fluent
*/
public function rememberToken()
{
}
/**
* Create a new drop index command on the blueprint.
*
* @param string $command
* @param string $type
* @param string|array $index
* @return \Illuminate\Support\Fluent
*/
protected function dropIndexCommand($command, $type, $index)
{
}
/**
* Add a new index command to the blueprint.
*
* @param string $type
* @param string|array $columns
* @param string $index
* @return \Illuminate\Support\Fluent
*/
protected function indexCommand($type, $columns, $index)
{
}
/**
* Create a default index name for the table.
*
* @param string $type
* @param array $columns
* @return string
*/
protected function createIndexName($type, array $columns)
{
}
/**
* Add a new column to the blueprint.
*
* @param string $type
* @param string $name
* @param array $parameters
* @return \Illuminate\Support\Fluent
*/
public function addColumn($type, $name, array $parameters = [])
{
}
/**
* Remove a column from the schema blueprint.
*
* @param string $name
* @return $this
*/
public function removeColumn($name)
{
}
/**
* Add a new command to the blueprint.
*
* @param string $name
* @param array $parameters
* @return \Illuminate\Support\Fluent
*/
protected function addCommand($name, array $parameters = [])
{
}
/**
* Create a new Fluent command.
*
* @param string $name
* @param array $parameters
* @return \Illuminate\Support\Fluent
*/
protected function createCommand($name, array $parameters = [])
{
}
/**
* Get the table the blueprint describes.
*
* @return string
*/
public function getTable()
{
}
/**
* Get the columns on the blueprint.
*
* @return array
*/
public function getColumns()
{
}
/**
* Get the commands on the blueprint.
*
* @return array
*/
public function getCommands()
{
}
/**
* Get the columns on the blueprint that should be added.
*
* @return array
*/
public function getAddedColumns()
{
}
/**
* Get the columns on the blueprint that should be changed.
*
* @return array
*/
public function getChangedColumns()
{
}
}
class MySqlBuilder extends \Illuminate\Database\Schema\Builder
{
/**
* Determine if the given table exists.
*
* @param string $table
* @return bool
*/
public function hasTable($table)
{
}
/**
* Get the column listing for a given table.
*
* @param string $table
* @return array
*/
public function getColumnListing($table)
{
}
}
}
namespace Illuminate\Database {
abstract class Grammar
{
/**
* The grammar table prefix.
*
* @var string
*/
protected $tablePrefix = '';
/**
* Wrap an array of values.
*
* @param array $values
* @return array
*/
public function wrapArray(array $values)
{
}
/**
* Wrap a table in keyword identifiers.
*
* @param \Illuminate\Database\Query\Expression|string $table
* @return string
*/
public function wrapTable($table)
{
}
/**
* Wrap a value in keyword identifiers.
*
* @param \Illuminate\Database\Query\Expression|string $value
* @param bool $prefixAlias
* @return string
*/
public function wrap($value, $prefixAlias = false)
{
}
/**
* Wrap a single string in keyword identifiers.
*
* @param string $value
* @return string
*/
protected function wrapValue($value)
{
}
/**
* Convert an array of column names into a delimited string.
*
* @param array $columns
* @return string
*/
public function columnize(array $columns)
{
}
/**
* Create query parameter place-holders for an array.
*
* @param array $values
* @return string
*/
public function parameterize(array $values)
{
}
/**
* Get the appropriate query parameter place-holder for a value.
*
* @param mixed $value
* @return string
*/
public function parameter($value)
{
}
/**
* Get the value of a raw expression.
*
* @param \Illuminate\Database\Query\Expression $expression
* @return string
*/
public function getValue($expression)
{
}
/**
* Determine if the given value is a raw expression.
*
* @param mixed $value
* @return bool
*/
public function isExpression($value)
{
}
/**
* Get the format for database stored dates.
*
* @return string
*/
public function getDateFormat()
{
}
/**
* Get the grammar's table prefix.
*
* @return string
*/
public function getTablePrefix()
{
}
/**
* Set the grammar's table prefix.
*
* @param string $prefix
* @return $this
*/
public function setTablePrefix($prefix)
{
}
}
}
namespace Illuminate\Database\Schema\Grammars {
abstract class Grammar extends \Illuminate\Database\Grammar
{
/**
* Compile a rename column command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @param \Illuminate\Database\Connection $connection
* @return array
*/
public function compileRenameColumn(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command, \Illuminate\Database\Connection $connection)
{
}
/**
* Get a new column instance with the new column name.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @param \Doctrine\DBAL\Schema\Column $column
* @param \Doctrine\DBAL\Schema\AbstractSchemaManager $schema
* @return \Doctrine\DBAL\Schema\TableDiff
*/
protected function getRenamedDiff(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command, \Doctrine\DBAL\Schema\Column $column, \Doctrine\DBAL\Schema\AbstractSchemaManager $schema)
{
}
/**
* Set the renamed columns on the table diff.
*
* @param \Doctrine\DBAL\Schema\TableDiff $tableDiff
* @param \Illuminate\Support\Fluent $command
* @param \Doctrine\DBAL\Schema\Column $column
* @return \Doctrine\DBAL\Schema\TableDiff
*/
protected function setRenamedColumns(\Doctrine\DBAL\Schema\TableDiff $tableDiff, \Illuminate\Support\Fluent $command, \Doctrine\DBAL\Schema\Column $column)
{
}
/**
* Compile a foreign key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileForeign(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile the blueprint's column definitions.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @return array
*/
protected function getColumns(\Illuminate\Database\Schema\Blueprint $blueprint)
{
}
/**
* Add the column modifiers to the definition.
*
* @param string $sql
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function addModifiers($sql, \Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the primary key command if it exists on the blueprint.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param string $name
* @return \Illuminate\Support\Fluent|null
*/
protected function getCommandByName(\Illuminate\Database\Schema\Blueprint $blueprint, $name)
{
}
/**
* Get all of the commands with a given name.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param string $name
* @return array
*/
protected function getCommandsByName(\Illuminate\Database\Schema\Blueprint $blueprint, $name)
{
}
/**
* Get the SQL for the column data type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function getType(\Illuminate\Support\Fluent $column)
{
}
/**
* Add a prefix to an array of values.
*
* @param string $prefix
* @param array $values
* @return array
*/
public function prefixArray($prefix, array $values)
{
}
/**
* Wrap a table in keyword identifiers.
*
* @param mixed $table
* @return string
*/
public function wrapTable($table)
{
}
/**
* {@inheritdoc}
*/
public function wrap($value, $prefixAlias = false)
{
}
/**
* Format a value so that it can be used in "default" clauses.
*
* @param mixed $value
* @return string
*/
protected function getDefaultValue($value)
{
}
/**
* Create an empty Doctrine DBAL TableDiff from the Blueprint.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Doctrine\DBAL\Schema\AbstractSchemaManager $schema
* @return \Doctrine\DBAL\Schema\TableDiff
*/
protected function getDoctrineTableDiff(\Illuminate\Database\Schema\Blueprint $blueprint, \Doctrine\DBAL\Schema\AbstractSchemaManager $schema)
{
}
/**
* Compile a change column command into a series of SQL statements.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @param \Illuminate\Database\Connection $connection
* @return array
*
* @throws \RuntimeException
*/
public function compileChange(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command, \Illuminate\Database\Connection $connection)
{
}
/**
* Get the Doctrine table difference for the given changes.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Doctrine\DBAL\Schema\AbstractSchemaManager $schema
* @return \Doctrine\DBAL\Schema\TableDiff|bool
*/
protected function getChangedDiff(\Illuminate\Database\Schema\Blueprint $blueprint, \Doctrine\DBAL\Schema\AbstractSchemaManager $schema)
{
}
/**
* Get a copy of the given Doctrine table after making the column changes.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Doctrine\DBAL\Schema\Table $table
* @return \Doctrine\DBAL\Schema\TableDiff
*/
protected function getTableWithColumnChanges(\Illuminate\Database\Schema\Blueprint $blueprint, \Doctrine\DBAL\Schema\Table $table)
{
}
/**
* Get the Doctrine column instance for a column change.
*
* @param \Doctrine\DBAL\Schema\Table $table
* @param \Illuminate\Support\Fluent $fluent
* @return \Doctrine\DBAL\Schema\Column
*/
protected function getDoctrineColumnForChange(\Doctrine\DBAL\Schema\Table $table, \Illuminate\Support\Fluent $fluent)
{
}
/**
* Get the Doctrine column change options.
*
* @param \Illuminate\Support\Fluent $fluent
* @return array
*/
protected function getDoctrineColumnChangeOptions(\Illuminate\Support\Fluent $fluent)
{
}
/**
* Get the doctrine column type.
*
* @param string $type
* @return \Doctrine\DBAL\Types\Type
*/
protected function getDoctrineColumnType($type)
{
}
/**
* Calculate the proper column length to force the Doctrine text type.
*
* @param string $type
* @return int
*/
protected function calculateDoctrineTextLength($type)
{
}
/**
* Get the matching Doctrine option for a given Fluent attribute name.
*
* @param string $attribute
* @return string|null
*/
protected function mapFluentOptionToDoctrine($attribute)
{
}
/**
* Get the matching Doctrine value for a given Fluent attribute.
*
* @param string $option
* @param mixed $value
* @return mixed
*/
protected function mapFluentValueToDoctrine($option, $value)
{
}
}
class PostgresGrammar extends \Illuminate\Database\Schema\Grammars\Grammar
{
/**
* The possible column modifiers.
*
* @var array
*/
protected $modifiers = ['Increment', 'Nullable', 'Default'];
/**
* The columns available as serials.
*
* @var array
*/
protected $serials = ['bigInteger', 'integer', 'mediumInteger', 'smallInteger', 'tinyInteger'];
/**
* Compile the query to determine if a table exists.
*
* @return string
*/
public function compileTableExists()
{
}
/**
* Compile the query to determine the list of columns.
*
* @param string $table
* @return string
*/
public function compileColumnExists($table)
{
}
/**
* Compile a create table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileCreate(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a column addition command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileAdd(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a primary key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compilePrimary(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a unique key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileUnique(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a plain index key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileIndex(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDrop(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop table (if exists) command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropIfExists(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop column command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropColumn(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop primary key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropPrimary(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop unique key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropUnique(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop index command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropIndex(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop foreign key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropForeign(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile the command to enable foreign key constraints.
*
* @return string
*/
public function compileEnableForeignKeyConstraints()
{
}
/**
* Compile the command to disable foreign key constraints.
*
* @return string
*/
public function compileDisableForeignKeyConstraints()
{
}
/**
* Compile a rename table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileRename(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Create the column definition for a char type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeChar(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a string type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeString(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a medium text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMediumText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a long text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeLongText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a big integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBigInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a medium integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMediumInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a tiny integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTinyInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a small integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeSmallInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a float type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeFloat(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a double type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDouble(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a decimal type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDecimal(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a boolean type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBoolean(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for an enum type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeEnum(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a json type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeJson(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a jsonb type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeJsonb(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDate(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date-time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDateTime(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date-time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDateTimeTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTime(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimeTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a timestamp type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimestamp(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a timestamp type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimestampTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a binary type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBinary(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a uuid type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeUuid(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for an IP address type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeIpAddress(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a MAC address type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMacAddress(\Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a nullable column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyNullable(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a default column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyDefault(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for an auto-increment column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyIncrement(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
}
class MySqlGrammar extends \Illuminate\Database\Schema\Grammars\Grammar
{
/**
* The possible column modifiers.
*
* @var array
*/
protected $modifiers = ['VirtualAs', 'StoredAs', 'Unsigned', 'Charset', 'Collate', 'Nullable', 'Default', 'Increment', 'Comment', 'After', 'First'];
/**
* The possible column serials.
*
* @var array
*/
protected $serials = ['bigInteger', 'integer', 'mediumInteger', 'smallInteger', 'tinyInteger'];
/**
* Compile the query to determine the list of tables.
*
* @return string
*/
public function compileTableExists()
{
}
/**
* Compile the query to determine the list of columns.
*
* @return string
*/
public function compileColumnExists()
{
}
/**
* Compile a create table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @param \Illuminate\Database\Connection $connection
* @return string
*/
public function compileCreate(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command, \Illuminate\Database\Connection $connection)
{
}
/**
* Append the character set specifications to a command.
*
* @param string $sql
* @param \Illuminate\Database\Connection $connection
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @return string
*/
protected function compileCreateEncoding($sql, \Illuminate\Database\Connection $connection, \Illuminate\Database\Schema\Blueprint $blueprint)
{
}
/**
* Compile an add column command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileAdd(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a primary key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compilePrimary(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a unique key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileUnique(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a plain index key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileIndex(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile an index creation command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @param string $type
* @return string
*/
protected function compileKey(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command, $type)
{
}
/**
* Compile a drop table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDrop(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop table (if exists) command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropIfExists(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop column command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropColumn(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop primary key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropPrimary(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop unique key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropUnique(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop index command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropIndex(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop foreign key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropForeign(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a rename table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileRename(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile the command to enable foreign key constraints.
*
* @return string
*/
public function compileEnableForeignKeyConstraints()
{
}
/**
* Compile the command to disable foreign key constraints.
*
* @return string
*/
public function compileDisableForeignKeyConstraints()
{
}
/**
* Create the column definition for a char type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeChar(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a string type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeString(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a medium text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMediumText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a long text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeLongText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a big integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBigInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a medium integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMediumInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a tiny integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTinyInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a small integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeSmallInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a float type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeFloat(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a double type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDouble(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a decimal type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDecimal(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a boolean type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBoolean(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for an enum type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeEnum(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a json type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeJson(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a jsonb type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeJsonb(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDate(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date-time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDateTime(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date-time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDateTimeTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTime(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimeTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a timestamp type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimestamp(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a timestamp type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimestampTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a binary type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBinary(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a uuid type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeUuid(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for an IP address type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeIpAddress(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a MAC address type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMacAddress(\Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a generated virtual column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyVirtualAs(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a generated stored column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyStoredAs(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for an unsigned column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyUnsigned(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a character set column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyCharset(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a collation column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyCollate(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a nullable column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyNullable(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a default column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyDefault(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for an auto-increment column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyIncrement(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a "first" column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyFirst(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for an "after" column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyAfter(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a "comment" column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyComment(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Wrap a single string in keyword identifiers.
*
* @param string $value
* @return string
*/
protected function wrapValue($value)
{
}
}
class SQLiteGrammar extends \Illuminate\Database\Schema\Grammars\Grammar
{
/**
* The possible column modifiers.
*
* @var array
*/
protected $modifiers = ['Nullable', 'Default', 'Increment'];
/**
* The columns available as serials.
*
* @var array
*/
protected $serials = ['bigInteger', 'integer', 'mediumInteger', 'smallInteger', 'tinyInteger'];
/**
* Compile the query to determine if a table exists.
*
* @return string
*/
public function compileTableExists()
{
}
/**
* Compile the query to determine the list of columns.
*
* @param string $table
* @return string
*/
public function compileColumnExists($table)
{
}
/**
* Compile a create table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileCreate(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Get the foreign key syntax for a table creation statement.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @return string|null
*/
protected function addForeignKeys(\Illuminate\Database\Schema\Blueprint $blueprint)
{
}
/**
* Get the SQL for the foreign key.
*
* @param \Illuminate\Support\Fluent $foreign
* @return string
*/
protected function getForeignKey($foreign)
{
}
/**
* Get the primary key syntax for a table creation statement.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @return string|null
*/
protected function addPrimaryKeys(\Illuminate\Database\Schema\Blueprint $blueprint)
{
}
/**
* Compile alter table commands for adding columns.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return array
*/
public function compileAdd(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a unique key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileUnique(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a plain index key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileIndex(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a foreign key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileForeign(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDrop(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop table (if exists) command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropIfExists(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop column command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @param \Illuminate\Database\Connection $connection
* @return array
*/
public function compileDropColumn(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command, \Illuminate\Database\Connection $connection)
{
}
/**
* Compile a drop unique key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropUnique(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop index command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropIndex(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a rename table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileRename(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile the command to enable foreign key constraints.
*
* @return string
*/
public function compileEnableForeignKeyConstraints()
{
}
/**
* Compile the command to disable foreign key constraints.
*
* @return string
*/
public function compileDisableForeignKeyConstraints()
{
}
/**
* Create the column definition for a char type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeChar(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a string type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeString(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a medium text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMediumText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a long text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeLongText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a big integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBigInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a medium integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMediumInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a tiny integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTinyInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a small integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeSmallInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a float type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeFloat(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a double type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDouble(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a decimal type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDecimal(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a boolean type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBoolean(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for an enum type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeEnum(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a json type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeJson(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a jsonb type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeJsonb(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDate(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date-time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDateTime(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date-time type.
*
* Note: "SQLite does not have a storage class set aside for storing dates and/or times."
* @link https://www.sqlite.org/datatype3.html
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDateTimeTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTime(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimeTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a timestamp type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimestamp(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a timestamp type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimestampTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a binary type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBinary(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a uuid type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeUuid(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for an IP address type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeIpAddress(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a MAC address type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMacAddress(\Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a nullable column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyNullable(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a default column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyDefault(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for an auto-increment column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyIncrement(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
}
class SqlServerGrammar extends \Illuminate\Database\Schema\Grammars\Grammar
{
/**
* The possible column modifiers.
*
* @var array
*/
protected $modifiers = ['Increment', 'Nullable', 'Default'];
/**
* The columns available as serials.
*
* @var array
*/
protected $serials = ['tinyInteger', 'smallInteger', 'mediumInteger', 'integer', 'bigInteger'];
/**
* Compile the query to determine if a table exists.
*
* @return string
*/
public function compileTableExists()
{
}
/**
* Compile the query to determine the list of columns.
*
* @param string $table
* @return string
*/
public function compileColumnExists($table)
{
}
/**
* Compile a create table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileCreate(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a column addition table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileAdd(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a primary key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compilePrimary(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a unique key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileUnique(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a plain index key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileIndex(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDrop(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop table (if exists) command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropIfExists(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop column command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropColumn(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop primary key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropPrimary(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop unique key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropUnique(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop index command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropIndex(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a drop foreign key command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileDropForeign(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile a rename table command.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $command
* @return string
*/
public function compileRename(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $command)
{
}
/**
* Compile the command to enable foreign key constraints.
*
* @return string
*/
public function compileEnableForeignKeyConstraints()
{
}
/**
* Compile the command to disable foreign key constraints.
*
* @return string
*/
public function compileDisableForeignKeyConstraints()
{
}
/**
* Create the column definition for a char type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeChar(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a string type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeString(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a medium text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMediumText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a long text type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeLongText(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a big integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBigInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a medium integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMediumInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a tiny integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTinyInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a small integer type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeSmallInteger(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a float type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeFloat(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a double type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDouble(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a decimal type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDecimal(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a boolean type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBoolean(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for an enum type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeEnum(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a json type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeJson(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a jsonb type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeJsonb(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDate(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date-time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDateTime(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a date-time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeDateTimeTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTime(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a time type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimeTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a timestamp type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimestamp(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a timestamp type.
*
* @link https://msdn.microsoft.com/en-us/library/bb630289(v=sql.120).aspx
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeTimestampTz(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a binary type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeBinary(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a uuid type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeUuid(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for an IP address type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeIpAddress(\Illuminate\Support\Fluent $column)
{
}
/**
* Create the column definition for a MAC address type.
*
* @param \Illuminate\Support\Fluent $column
* @return string
*/
protected function typeMacAddress(\Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a nullable column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyNullable(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for a default column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyDefault(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
/**
* Get the SQL for an auto-increment column modifier.
*
* @param \Illuminate\Database\Schema\Blueprint $blueprint
* @param \Illuminate\Support\Fluent $column
* @return string|null
*/
protected function modifyIncrement(\Illuminate\Database\Schema\Blueprint $blueprint, \Illuminate\Support\Fluent $column)
{
}
}
}
namespace Illuminate\Support\Traits {
trait CapsuleManagerTrait
{
/**
* The current globally used instance.
*
* @var object
*/
protected static $instance;
/**
* The container instance.
*
* @var \Illuminate\Contracts\Container\Container
*/
protected $container;
/**
* Setup the IoC container instance.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
protected function setupContainer(\Illuminate\Contracts\Container\Container $container)
{
}
/**
* Make this capsule instance available globally.
*
* @return void
*/
public function setAsGlobal()
{
}
/**
* Get the IoC container instance.
*
* @return \Illuminate\Contracts\Container\Container
*/
public function getContainer()
{
}
/**
* Set the IoC container instance.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
public function setContainer(\Illuminate\Contracts\Container\Container $container)
{
}
}
}
namespace Illuminate\Database\Capsule {
class Manager
{
use \Illuminate\Support\Traits\CapsuleManagerTrait;
/**
* The database manager instance.
*
* @var \Illuminate\Database\DatabaseManager
*/
protected $manager;
/**
* Create a new database capsule manager.
*
* @param \Illuminate\Container\Container|null $container
* @return void
*/
public function __construct(\Illuminate\Container\Container $container = null)
{
}
/**
* Setup the default database configuration options.
*
* @return void
*/
protected function setupDefaultConfiguration()
{
}
/**
* Build the database manager instance.
*
* @return void
*/
protected function setupManager()
{
}
/**
* Get a connection instance from the global manager.
*
* @param string $connection
* @return \Illuminate\Database\Connection
*/
public static function connection($connection = null)
{
}
/**
* Get a fluent query builder instance.
*
* @param string $table
* @param string $connection
* @return \Illuminate\Database\Query\Builder
*/
public static function table($table, $connection = null)
{
}
/**
* Get a schema builder instance.
*
* @param string $connection
* @return \Illuminate\Database\Schema\Builder
*/
public static function schema($connection = null)
{
}
/**
* Get a registered connection instance.
*
* @param string $name
* @return \Illuminate\Database\Connection
*/
public function getConnection($name = null)
{
}
/**
* Register a connection with the manager.
*
* @param array $config
* @param string $name
* @return void
*/
public function addConnection(array $config, $name = 'default')
{
}
/**
* Bootstrap Eloquent so it is ready for usage.
*
* @return void
*/
public function bootEloquent()
{
}
/**
* Set the fetch mode for the database connections.
*
* @param int $fetchMode
* @return $this
*/
public function setFetchMode($fetchMode)
{
}
/**
* Get the database manager instance.
*
* @return \Illuminate\Database\DatabaseManager
*/
public function getDatabaseManager()
{
}
/**
* Get the current event dispatcher instance.
*
* @return \Illuminate\Contracts\Events\Dispatcher|null
*/
public function getEventDispatcher()
{
}
/**
* Set the event dispatcher instance to be used by connections.
*
* @param \Illuminate\Contracts\Events\Dispatcher $dispatcher
* @return void
*/
public function setEventDispatcher(\Illuminate\Contracts\Events\Dispatcher $dispatcher)
{
}
/**
* Dynamically pass methods to the default connection.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public static function __callStatic($method, $parameters)
{
}
}
}
namespace Illuminate\Support {
abstract class ServiceProvider
{
/**
* The application instance.
*
* @var \Illuminate\Contracts\Foundation\Application
*/
protected $app;
/**
* Indicates if loading of the provider is deferred.
*
* @var bool
*/
protected $defer = false;
/**
* The paths that should be published.
*
* @var array
*/
protected static $publishes = [];
/**
* The paths that should be published by group.
*
* @var array
*/
protected static $publishGroups = [];
/**
* Create a new service provider instance.
*
* @param \Illuminate\Contracts\Foundation\Application $app
* @return void
*/
public function __construct($app)
{
}
/**
* Register the service provider.
*
* @return void
*/
public abstract function register();
/**
* Merge the given configuration with the existing configuration.
*
* @param string $path
* @param string $key
* @return void
*/
protected function mergeConfigFrom($path, $key)
{
}
/**
* Register a view file namespace.
*
* @param string $path
* @param string $namespace
* @return void
*/
protected function loadViewsFrom($path, $namespace)
{
}
/**
* Register a translation file namespace.
*
* @param string $path
* @param string $namespace
* @return void
*/
protected function loadTranslationsFrom($path, $namespace)
{
}
/**
* Register paths to be published by the publish command.
*
* @param array $paths
* @param string $group
* @return void
*/
protected function publishes(array $paths, $group = null)
{
}
/**
* Get the paths to publish.
*
* @param string $provider
* @param string $group
* @return array
*/
public static function pathsToPublish($provider = null, $group = null)
{
}
/**
* Register the package's custom Artisan commands.
*
* @param array|mixed $commands
* @return void
*/
public function commands($commands)
{
}
/**
* Get the services provided by the provider.
*
* @return array
*/
public function provides()
{
}
/**
* Get the events that trigger this service provider to register.
*
* @return array
*/
public function when()
{
}
/**
* Determine if the provider is deferred.
*
* @return bool
*/
public function isDeferred()
{
}
/**
* Get a list of files that should be compiled for the package.
*
* @return array
*/
public static function compiles()
{
}
/**
* Dynamically handle missing method calls.
*
* @param string $method
* @param array $parameters
* @return mixed
*
* @throws \BadMethodCallException
*/
public function __call($method, $parameters)
{
}
}
}
namespace Illuminate\Database {
class DatabaseServiceProvider extends \Illuminate\Support\ServiceProvider
{
/**
* Bootstrap the application events.
*
* @return void
*/
public function boot()
{
}
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
}
/**
* Register the Eloquent factory instance in the container.
*
* @return void
*/
protected function registerEloquentFactory()
{
}
/**
* Register the queueable entity resolver implementation.
*
* @return void
*/
protected function registerQueueableEntityResolver()
{
}
}
interface ConnectionInterface
{
/**
* Begin a fluent query against a database table.
*
* @param string $table
* @return \Illuminate\Database\Query\Builder
*/
public function table($table);
/**
* Get a new raw query expression.
*
* @param mixed $value
* @return \Illuminate\Database\Query\Expression
*/
public function raw($value);
/**
* Run a select statement and return a single result.
*
* @param string $query
* @param array $bindings
* @return mixed
*/
public function selectOne($query, $bindings = []);
/**
* Run a select statement against the database.
*
* @param string $query
* @param array $bindings
* @return array
*/
public function select($query, $bindings = []);
/**
* Run an insert statement against the database.
*
* @param string $query
* @param array $bindings
* @return bool
*/
public function insert($query, $bindings = []);
/**
* Run an update statement against the database.
*
* @param string $query
* @param array $bindings
* @return int
*/
public function update($query, $bindings = []);
/**
* Run a delete statement against the database.
*
* @param string $query
* @param array $bindings
* @return int
*/
public function delete($query, $bindings = []);
/**
* Execute an SQL statement and return the boolean result.
*
* @param string $query
* @param array $bindings
* @return bool
*/
public function statement($query, $bindings = []);
/**
* Run an SQL statement and get the number of rows affected.
*
* @param string $query
* @param array $bindings
* @return int
*/
public function affectingStatement($query, $bindings = []);
/**
* Run a raw, unprepared query against the PDO connection.
*
* @param string $query
* @return bool
*/
public function unprepared($query);
/**
* Prepare the query bindings for execution.
*
* @param array $bindings
* @return array
*/
public function prepareBindings(array $bindings);
/**
* Execute a Closure within a transaction.
*
* @param \Closure $callback
* @return mixed
*
* @throws \Throwable
*/
public function transaction(\Closure $callback);
/**
* Start a new database transaction.
*
* @return void
*/
public function beginTransaction();
/**
* Commit the active database transaction.
*
* @return void
*/
public function commit();
/**
* Rollback the active database transaction.
*
* @return void
*/
public function rollBack();
/**
* Get the number of active transactions.
*
* @return int
*/
public function transactionLevel();
/**
* Execute the given callback in "dry run" mode.
*
* @param \Closure $callback
* @return array
*/
public function pretend(\Closure $callback);
}
trait DetectsLostConnections
{
/**
* Determine if the given exception was caused by a lost connection.
*
* @param \Exception $e
* @return bool
*/
protected function causedByLostConnection(\Exception $e)
{
}
}
class Connection implements \Illuminate\Database\ConnectionInterface
{
use \Illuminate\Database\DetectsLostConnections;
/**
* The active PDO connection.
*
* @var PDO
*/
protected $pdo;
/**
* The active PDO connection used for reads.
*
* @var PDO
*/
protected $readPdo;
/**
* The reconnector instance for the connection.
*
* @var callable
*/
protected $reconnector;
/**
* The query grammar implementation.
*
* @var \Illuminate\Database\Query\Grammars\Grammar
*/
protected $queryGrammar;
/**
* The schema grammar implementation.
*
* @var \Illuminate\Database\Schema\Grammars\Grammar
*/
protected $schemaGrammar;
/**
* The query post processor implementation.
*
* @var \Illuminate\Database\Query\Processors\Processor
*/
protected $postProcessor;
/**
* The event dispatcher instance.
*
* @var \Illuminate\Contracts\Events\Dispatcher
*/
protected $events;
/**
* The default fetch mode of the connection.
*
* @var int
*/
protected $fetchMode = \PDO::FETCH_OBJ;
/**
* The argument for the fetch mode.
*
* @var mixed
*/
protected $fetchArgument;
/**
* The constructor arguments for the PDO::FETCH_CLASS fetch mode.
*
* @var array
*/
protected $fetchConstructorArgument = [];
/**
* The number of active transactions.
*
* @var int
*/
protected $transactions = 0;
/**
* All of the queries run against the connection.
*
* @var array
*/
protected $queryLog = [];
/**
* Indicates whether queries are being logged.
*
* @var bool
*/
protected $loggingQueries = false;
/**
* Indicates if the connection is in a "dry run".
*
* @var bool
*/
protected $pretending = false;
/**
* The name of the connected database.
*
* @var string
*/
protected $database;
/**
* The instance of Doctrine connection.
*
* @var \Doctrine\DBAL\Connection
*/
protected $doctrineConnection;
/**
* The table prefix for the connection.
*
* @var string
*/
protected $tablePrefix = '';
/**
* The database connection configuration options.
*
* @var array
*/
protected $config = [];
/**
* Create a new database connection instance.
*
* @param \PDO|\Closure $pdo
* @param string $database
* @param string $tablePrefix
* @param array $config
* @return void
*/
public function __construct($pdo, $database = '', $tablePrefix = '', array $config = [])
{
}
/**
* Set the query grammar to the default implementation.
*
* @return void
*/
public function useDefaultQueryGrammar()
{
}
/**
* Get the default query grammar instance.
*
* @return \Illuminate\Database\Query\Grammars\Grammar
*/
protected function getDefaultQueryGrammar()
{
}
/**
* Set the schema grammar to the default implementation.
*
* @return void
*/
public function useDefaultSchemaGrammar()
{
}
/**
* Get the default schema grammar instance.
*
* @return \Illuminate\Database\Schema\Grammars\Grammar
*/
protected function getDefaultSchemaGrammar()
{
}
/**
* Set the query post processor to the default implementation.
*
* @return void
*/
public function useDefaultPostProcessor()
{
}
/**
* Get the default post processor instance.
*
* @return \Illuminate\Database\Query\Processors\Processor
*/
protected function getDefaultPostProcessor()
{
}
/**
* Get a schema builder instance for the connection.
*
* @return \Illuminate\Database\Schema\Builder
*/
public function getSchemaBuilder()
{
}
/**
* Begin a fluent query against a database table.
*
* @param string $table
* @return \Illuminate\Database\Query\Builder
*/
public function table($table)
{
}
/**
* Get a new query builder instance.
*
* @return \Illuminate\Database\Query\Builder
*/
public function query()
{
}
/**
* Get a new raw query expression.
*
* @param mixed $value
* @return \Illuminate\Database\Query\Expression
*/
public function raw($value)
{
}
/**
* Run a select statement and return a single result.
*
* @param string $query
* @param array $bindings
* @return mixed
*/
public function selectOne($query, $bindings = [])
{
}
/**
* Run a select statement against the database.
*
* @param string $query
* @param array $bindings
* @return array
*/
public function selectFromWriteConnection($query, $bindings = [])
{
}
/**
* Run a select statement against the database.
*
* @param string $query
* @param array $bindings
* @param bool $useReadPdo
* @return array
*/
public function select($query, $bindings = [], $useReadPdo = true)
{
}
/**
* Run a select statement against the database and returns a generator.
*
* @param string $query
* @param array $bindings
* @param bool $useReadPdo
* @return \Generator
*/
public function cursor($query, $bindings = [], $useReadPdo = true)
{
}
/**
* Get the PDO connection to use for a select query.
*
* @param bool $useReadPdo
* @return \PDO
*/
protected function getPdoForSelect($useReadPdo = true)
{
}
/**
* Run an insert statement against the database.
*
* @param string $query
* @param array $bindings
* @return bool
*/
public function insert($query, $bindings = [])
{
}
/**
* Run an update statement against the database.
*
* @param string $query
* @param array $bindings
* @return int
*/
public function update($query, $bindings = [])
{
}
/**
* Run a delete statement against the database.
*
* @param string $query
* @param array $bindings
* @return int
*/
public function delete($query, $bindings = [])
{
}
/**
* Execute an SQL statement and return the boolean result.
*
* @param string $query
* @param array $bindings
* @return bool
*/
public function statement($query, $bindings = [])
{
}
/**
* Run an SQL statement and get the number of rows affected.
*
* @param string $query
* @param array $bindings
* @return int
*/
public function affectingStatement($query, $bindings = [])
{
}
/**
* Run a raw, unprepared query against the PDO connection.
*
* @param string $query
* @return bool
*/
public function unprepared($query)
{
}
/**
* Prepare the query bindings for execution.
*
* @param array $bindings
* @return array
*/
public function prepareBindings(array $bindings)
{
}
/**
* Execute a Closure within a transaction.
*
* @param \Closure $callback
* @return mixed
*
* @throws \Exception|\Throwable
*/
public function transaction(\Closure $callback)
{
}
/**
* Start a new database transaction.
*
* @return void
* @throws Exception
*/
public function beginTransaction()
{
}
/**
* Commit the active database transaction.
*
* @return void
*/
public function commit()
{
}
/**
* Rollback the active database transaction.
*
* @return void
*/
public function rollBack()
{
}
/**
* Get the number of active transactions.
*
* @return int
*/
public function transactionLevel()
{
}
/**
* Execute the given callback in "dry run" mode.
*
* @param \Closure $callback
* @return array
*/
public function pretend(\Closure $callback)
{
}
/**
* Run a SQL statement and log its execution context.
*
* @param string $query
* @param array $bindings
* @param \Closure $callback
* @return mixed
*
* @throws \Illuminate\Database\QueryException
*/
protected function run($query, $bindings, \Closure $callback)
{
}
/**
* Run a SQL statement.
*
* @param string $query
* @param array $bindings
* @param \Closure $callback
* @return mixed
*
* @throws \Illuminate\Database\QueryException
*/
protected function runQueryCallback($query, $bindings, \Closure $callback)
{
}
/**
* Handle a query exception that occurred during query execution.
*
* @param \Illuminate\Database\QueryException $e
* @param string $query
* @param array $bindings
* @param \Closure $callback
* @return mixed
*
* @throws \Illuminate\Database\QueryException
*/
protected function tryAgainIfCausedByLostConnection(\Illuminate\Database\QueryException $e, $query, $bindings, \Closure $callback)
{
}
/**
* Disconnect from the underlying PDO connection.
*
* @return void
*/
public function disconnect()
{
}
/**
* Reconnect to the database.
*
* @return void
*
* @throws \LogicException
*/
public function reconnect()
{
}
/**
* Reconnect to the database if a PDO connection is missing.
*
* @return void
*/
protected function reconnectIfMissingConnection()
{
}
/**
* Log a query in the connection's query log.
*
* @param string $query
* @param array $bindings
* @param float|null $time
* @return void
*/
public function logQuery($query, $bindings, $time = null)
{
}
/**
* Register a database query listener with the connection.
*
* @param \Closure $callback
* @return void
*/
public function listen(\Closure $callback)
{
}
/**
* Fire an event for this connection.
*
* @param string $event
* @return void
*/
protected function fireConnectionEvent($event)
{
}
/**
* Get the elapsed time since a given starting point.
*
* @param int $start
* @return float
*/
protected function getElapsedTime($start)
{
}
/**
* Is Doctrine available?
*
* @return bool
*/
public function isDoctrineAvailable()
{
}
/**
* Get a Doctrine Schema Column instance.
*
* @param string $table
* @param string $column
* @return \Doctrine\DBAL\Schema\Column
*/
public function getDoctrineColumn($table, $column)
{
}
/**
* Get the Doctrine DBAL schema manager for the connection.
*
* @return \Doctrine\DBAL\Schema\AbstractSchemaManager
*/
public function getDoctrineSchemaManager()
{
}
/**
* Get the Doctrine DBAL database connection instance.
*
* @return \Doctrine\DBAL\Connection
*/
public function getDoctrineConnection()
{
}
/**
* Get the current PDO connection.
*
* @return \PDO
*/
public function getPdo()
{
}
/**
* Get the current PDO connection used for reading.
*
* @return \PDO
*/
public function getReadPdo()
{
}
/**
* Set the PDO connection.
*
* @param \PDO|null $pdo
* @return $this
*
* @throws \RuntimeException
*/
public function setPdo($pdo)
{
}
/**
* Set the PDO connection used for reading.
*
* @param \PDO|null $pdo
* @return $this
*/
public function setReadPdo($pdo)
{
}
/**
* Set the reconnect instance on the connection.
*
* @param callable $reconnector
* @return $this
*/
public function setReconnector(callable $reconnector)
{
}
/**
* Get the database connection name.
*
* @return string|null
*/
public function getName()
{
}
/**
* Get an option from the configuration options.
*
* @param string $option
* @return mixed
*/
public function getConfig($option)
{
}
/**
* Get the PDO driver name.
*
* @return string
*/
public function getDriverName()
{
}
/**
* Get the query grammar used by the connection.
*
* @return \Illuminate\Database\Query\Grammars\Grammar
*/
public function getQueryGrammar()
{
}
/**
* Set the query grammar used by the connection.
*
* @param \Illuminate\Database\Query\Grammars\Grammar $grammar
* @return void
*/
public function setQueryGrammar(\Illuminate\Database\Query\Grammars\Grammar $grammar)
{
}
/**
* Get the schema grammar used by the connection.
*
* @return \Illuminate\Database\Schema\Grammars\Grammar
*/
public function getSchemaGrammar()
{
}
/**
* Set the schema grammar used by the connection.
*
* @param \Illuminate\Database\Schema\Grammars\Grammar $grammar
* @return void
*/
public function setSchemaGrammar(\Illuminate\Database\Schema\Grammars\Grammar $grammar)
{
}
/**
* Get the query post processor used by the connection.
*
* @return \Illuminate\Database\Query\Processors\Processor
*/
public function getPostProcessor()
{
}
/**
* Set the query post processor used by the connection.
*
* @param \Illuminate\Database\Query\Processors\Processor $processor
* @return void
*/
public function setPostProcessor(\Illuminate\Database\Query\Processors\Processor $processor)
{
}
/**
* Get the event dispatcher used by the connection.
*
* @return \Illuminate\Contracts\Events\Dispatcher
*/
public function getEventDispatcher()
{
}
/**
* Set the event dispatcher instance on the connection.
*
* @param \Illuminate\Contracts\Events\Dispatcher $events
* @return void
*/
public function setEventDispatcher(\Illuminate\Contracts\Events\Dispatcher $events)
{
}
/**
* Determine if the connection in a "dry run".
*
* @return bool
*/
public function pretending()
{
}
/**
* Get the default fetch mode for the connection.
*
* @return int
*/
public function getFetchMode()
{
}
/**
* Get the fetch argument to be applied when selecting.
*
* @return mixed
*/
public function getFetchArgument()
{
}
/**
* Get custom constructor arguments for the PDO::FETCH_CLASS fetch mode.
*
* @return array
*/
public function getFetchConstructorArgument()
{
}
/**
* Set the default fetch mode for the connection, and optional arguments for the given fetch mode.
*
* @param int $fetchMode
* @param mixed $fetchArgument
* @param array $fetchConstructorArgument
* @return int
*/
public function setFetchMode($fetchMode, $fetchArgument = null, array $fetchConstructorArgument = [])
{
}
/**
* Get the connection query log.
*
* @return array
*/
public function getQueryLog()
{
}
/**
* Clear the query log.
*
* @return void
*/
public function flushQueryLog()
{
}
/**
* Enable the query log on the connection.
*
* @return void
*/
public function enableQueryLog()
{
}
/**
* Disable the query log on the connection.
*
* @return void
*/
public function disableQueryLog()
{
}
/**
* Determine whether we're logging queries.
*
* @return bool
*/
public function logging()
{
}
/**
* Get the name of the connected database.
*
* @return string
*/
public function getDatabaseName()
{
}
/**
* Set the name of the connected database.
*
* @param string $database
* @return string
*/
public function setDatabaseName($database)
{
}
/**
* Get the table prefix for the connection.
*
* @return string
*/
public function getTablePrefix()
{
}
/**
* Set the table prefix in use by the connection.
*
* @param string $prefix
* @return void
*/
public function setTablePrefix($prefix)
{
}
/**
* Set the table prefix and return the grammar.
*
* @param \Illuminate\Database\Grammar $grammar
* @return \Illuminate\Database\Grammar
*/
public function withTablePrefix(\Illuminate\Database\Grammar $grammar)
{
}
}
class MySqlConnection extends \Illuminate\Database\Connection
{
/**
* Get a schema builder instance for the connection.
*
* @return \Illuminate\Database\Schema\MySqlBuilder
*/
public function getSchemaBuilder()
{
}
/**
* Get the default query grammar instance.
*
* @return \Illuminate\Database\Query\Grammars\MySqlGrammar
*/
protected function getDefaultQueryGrammar()
{
}
/**
* Get the default schema grammar instance.
*
* @return \Illuminate\Database\Schema\Grammars\MySqlGrammar
*/
protected function getDefaultSchemaGrammar()
{
}
/**
* Get the default post processor instance.
*
* @return \Illuminate\Database\Query\Processors\MySqlProcessor
*/
protected function getDefaultPostProcessor()
{
}
/**
* Get the Doctrine DBAL driver.
*
* @return \Doctrine\DBAL\Driver\PDOMySql\Driver
*/
protected function getDoctrineDriver()
{
}
}
}
namespace Illuminate\Database\Eloquent {
interface Scope
{
/**
* Apply the scope to a given Eloquent query builder.
*
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Database\Eloquent\Model $model
* @return void
*/
public function apply(\Illuminate\Database\Eloquent\Builder $builder, \Illuminate\Database\Eloquent\Model $model);
}
}
namespace Illuminate\Contracts\Queue {
interface EntityResolver
{
/**
* Resolve the entity for the given ID.
*
* @param string $type
* @param mixed $id
* @return mixed
*/
public function resolve($type, $id);
}
}
namespace Illuminate\Database\Eloquent {
class QueueEntityResolver implements \Illuminate\Contracts\Queue\EntityResolver
{
/**
* Resolve the entity for the given ID.
*
* @param string $type
* @param mixed $id
* @return mixed
*
* @throws \Illuminate\Contracts\Queue\EntityNotFoundException
*/
public function resolve($type, $id)
{
}
}
class FactoryBuilder
{
/**
* The model definitions in the container.
*
* @var array
*/
protected $definitions;
/**
* The model being built.
*
* @var string
*/
protected $class;
/**
* The name of the model being built.
*
* @var string
*/
protected $name = 'default';
/**
* The number of models to build.
*
* @var int
*/
protected $amount = 1;
/**
* The Faker instance for the builder.
*
* @var \Faker\Generator
*/
protected $faker;
/**
* Create an new builder instance.
*
* @param string $class
* @param string $name
* @param array $definitions
* @param \Faker\Generator $faker
* @return void
*/
public function __construct($class, $name, array $definitions, \Faker\Generator $faker)
{
}
/**
* Set the amount of models you wish to create / make.
*
* @param int $amount
* @return $this
*/
public function times($amount)
{
}
/**
* Create a collection of models and persist them to the database.
*
* @param array $attributes
* @return mixed
*/
public function create(array $attributes = [])
{
}
/**
* Create a collection of models.
*
* @param array $attributes
* @return mixed
*/
public function make(array $attributes = [])
{
}
/**
* Make an instance of the model with the given attributes.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Model
*
* @throws \InvalidArgumentException
*/
protected function makeInstance(array $attributes = [])
{
}
/**
* Evaluate any Closure attributes on the attribute array.
*
* @param array $attributes
* @return array
*/
protected function callClosureAttributes(array $attributes)
{
}
}
class ModelNotFoundException extends \RuntimeException
{
/**
* Name of the affected Eloquent model.
*
* @var string
*/
protected $model;
/**
* Set the affected Eloquent model.
*
* @param string $model
* @return $this
*/
public function setModel($model)
{
}
/**
* Get the affected Eloquent model.
*
* @return string
*/
public function getModel()
{
}
}
class MassAssignmentException extends \RuntimeException
{
//
}
class SoftDeletingScope implements \Illuminate\Database\Eloquent\Scope
{
/**
* All of the extensions to be added to the builder.
*
* @var array
*/
protected $extensions = ['ForceDelete', 'Restore', 'WithTrashed', 'OnlyTrashed'];
/**
* Apply the scope to a given Eloquent query builder.
*
* @param \Illuminate\Database\Eloquent\Builder $builder
* @param \Illuminate\Database\Eloquent\Model $model
* @return void
*/
public function apply(\Illuminate\Database\Eloquent\Builder $builder, \Illuminate\Database\Eloquent\Model $model)
{
}
/**
* Extend the query builder with the needed functions.
*
* @param \Illuminate\Database\Eloquent\Builder $builder
* @return void
*/
public function extend(\Illuminate\Database\Eloquent\Builder $builder)
{
}
/**
* Get the "deleted at" column for the builder.
*
* @param \Illuminate\Database\Eloquent\Builder $builder
* @return string
*/
protected function getDeletedAtColumn(\Illuminate\Database\Eloquent\Builder $builder)
{
}
/**
* Add the force delete extension to the builder.
*
* @param \Illuminate\Database\Eloquent\Builder $builder
* @return void
*/
protected function addForceDelete(\Illuminate\Database\Eloquent\Builder $builder)
{
}
/**
* Add the restore extension to the builder.
*
* @param \Illuminate\Database\Eloquent\Builder $builder
* @return void
*/
protected function addRestore(\Illuminate\Database\Eloquent\Builder $builder)
{
}
/**
* Add the with-trashed extension to the builder.
*
* @param \Illuminate\Database\Eloquent\Builder $builder
* @return void
*/
protected function addWithTrashed(\Illuminate\Database\Eloquent\Builder $builder)
{
}
/**
* Add the only-trashed extension to the builder.
*
* @param \Illuminate\Database\Eloquent\Builder $builder
* @return void
*/
protected function addOnlyTrashed(\Illuminate\Database\Eloquent\Builder $builder)
{
}
}
class Factory implements \ArrayAccess
{
/**
* The Faker instance for the builder.
*
* @var \Faker\Generator
*/
protected $faker;
/**
* Create a new factory instance.
*
* @param \Faker\Generator $faker
* @return void
*/
public function __construct(\Faker\Generator $faker)
{
}
/**
* The model definitions in the container.
*
* @var array
*/
protected $definitions = [];
/**
* Create a new factory container.
*
* @param \Faker\Generator $faker
* @param string|null $pathToFactories
* @return static
*/
public static function construct(\Faker\Generator $faker, $pathToFactories = null)
{
}
/**
* Define a class with a given short-name.
*
* @param string $class
* @param string $name
* @param callable $attributes
* @return void
*/
public function defineAs($class, $name, callable $attributes)
{
}
/**
* Define a class with a given set of attributes.
*
* @param string $class
* @param callable $attributes
* @param string $name
* @return void
*/
public function define($class, callable $attributes, $name = 'default')
{
}
/**
* Create an instance of the given model and persist it to the database.
*
* @param string $class
* @param array $attributes
* @return mixed
*/
public function create($class, array $attributes = [])
{
}
/**
* Create an instance of the given model and type and persist it to the database.
*
* @param string $class
* @param string $name
* @param array $attributes
* @return mixed
*/
public function createAs($class, $name, array $attributes = [])
{
}
/**
* Load factories from path.
*
* @param string $path
* @return $this
*/
public function load($path)
{
}
/**
* Create an instance of the given model.
*
* @param string $class
* @param array $attributes
* @return mixed
*/
public function make($class, array $attributes = [])
{
}
/**
* Create an instance of the given model and type.
*
* @param string $class
* @param string $name
* @param array $attributes
* @return mixed
*/
public function makeAs($class, $name, array $attributes = [])
{
}
/**
* Get the raw attribute array for a given named model.
*
* @param string $class
* @param string $name
* @param array $attributes
* @return array
*/
public function rawOf($class, $name, array $attributes = [])
{
}
/**
* Get the raw attribute array for a given model.
*
* @param string $class
* @param array $attributes
* @param string $name
* @return array
*/
public function raw($class, array $attributes = [], $name = 'default')
{
}
/**
* Create a builder for the given model.
*
* @param string $class
* @param string $name
* @return \Illuminate\Database\Eloquent\FactoryBuilder
*/
public function of($class, $name = 'default')
{
}
/**
* Determine if the given offset exists.
*
* @param string $offset
* @return bool
*/
public function offsetExists($offset)
{
}
/**
* Get the value of the given offset.
*
* @param string $offset
* @return mixed
*/
public function offsetGet($offset)
{
}
/**
* Set the given offset to the given value.
*
* @param string $offset
* @param callable $value
* @return void
*/
public function offsetSet($offset, $value)
{
}
/**
* Unset the value at the given offset.
*
* @param string $offset
* @return void
*/
public function offsetUnset($offset)
{
}
}
/**
* @deprecated since version 5.2. Use Illuminate\Database\Eloquent\Scope.
*/
interface ScopeInterface extends \Illuminate\Database\Eloquent\Scope
{
}
class Builder
{
/**
* The base query builder instance.
*
* @var \Illuminate\Database\Query\Builder
*/
protected $query;
/**
* The model being queried.
*
* @var \Illuminate\Database\Eloquent\Model
*/
protected $model;
/**
* The relationships that should be eager loaded.
*
* @var array
*/
protected $eagerLoad = [];
/**
* All of the registered builder macros.
*
* @var array
*/
protected $macros = [];
/**
* A replacement for the typical delete function.
*
* @var \Closure
*/
protected $onDelete;
/**
* The methods that should be returned from query builder.
*
* @var array
*/
protected $passthru = ['insert', 'insertGetId', 'getBindings', 'toSql', 'exists', 'count', 'min', 'max', 'avg', 'sum', 'getConnection'];
/**
* Applied global scopes.
*
* @var array
*/
protected $scopes = [];
/**
* Removed global scopes.
*
* @var array
*/
protected $removedScopes = [];
/**
* Create a new Eloquent query builder instance.
*
* @param \Illuminate\Database\Query\Builder $query
* @return void
*/
public function __construct(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Register a new global scope.
*
* @param string $identifier
* @param \Illuminate\Database\Eloquent\Scope|\Closure $scope
* @return $this
*/
public function withGlobalScope($identifier, $scope)
{
}
/**
* Remove a registered global scope.
*
* @param \Illuminate\Database\Eloquent\Scope|string $scope
* @return $this
*/
public function withoutGlobalScope($scope)
{
}
/**
* Remove all or passed registered global scopes.
*
* @param array|null $scopes
* @return $this
*/
public function withoutGlobalScopes(array $scopes = null)
{
}
/**
* Get an array of global scopes that were removed from the query.
*
* @return array
*/
public function removedScopes()
{
}
/**
* Find a model by its primary key.
*
* @param mixed $id
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection|static[]|static|null
*/
public function find($id, $columns = ['*'])
{
}
/**
* Find multiple models by their primary keys.
*
* @param array $ids
* @param array $columns
* @return \Illuminate\Database\Eloquent\Collection
*/
public function findMany($ids, $columns = ['*'])
{
}
/**
* Find a model by its primary key or throw an exception.
*
* @param mixed $id
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection
*
* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
*/
public function findOrFail($id, $columns = ['*'])
{
}
/**
* Find a model by its primary key or return fresh model instance.
*
* @param mixed $id
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model
*/
public function findOrNew($id, $columns = ['*'])
{
}
/**
* Get the first record matching the attributes or instantiate it.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Model
*/
public function firstOrNew(array $attributes)
{
}
/**
* Get the first record matching the attributes or create it.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Model
*/
public function firstOrCreate(array $attributes)
{
}
/**
* Create or update a record matching the attributes, and fill it with values.
*
* @param array $attributes
* @param array $values
* @return \Illuminate\Database\Eloquent\Model
*/
public function updateOrCreate(array $attributes, array $values = [])
{
}
/**
* Execute the query and get the first result.
*
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model|static|null
*/
public function first($columns = ['*'])
{
}
/**
* Execute the query and get the first result or throw an exception.
*
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model|static
*
* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
*/
public function firstOrFail($columns = ['*'])
{
}
/**
* Execute the query as a "select" statement.
*
* @param array $columns
* @return \Illuminate\Database\Eloquent\Collection|static[]
*/
public function get($columns = ['*'])
{
}
/**
* Get a single column's value from the first result of a query.
*
* @param string $column
* @return mixed
*/
public function value($column)
{
}
/**
* Get a generator for the given query.
*
* @return \Generator
*/
public function cursor()
{
}
/**
* Chunk the results of the query.
*
* @param int $count
* @param callable $callback
* @return bool
*/
public function chunk($count, callable $callback)
{
}
/**
* Chunk the results of a query by comparing numeric IDs.
*
* @param int $count
* @param callable $callback
* @param string $column
* @return bool
*/
public function chunkById($count, callable $callback, $column = 'id')
{
}
/**
* Execute a callback over each item while chunking.
*
* @param callable $callback
* @param int $count
* @return bool
*/
public function each(callable $callback, $count = 1000)
{
}
/**
* Get an array with the values of a given column.
*
* @param string $column
* @param string|null $key
* @return \Illuminate\Support\Collection
*/
public function pluck($column, $key = null)
{
}
/**
* Alias for the "pluck" method.
*
* @param string $column
* @param string $key
* @return \Illuminate\Support\Collection
*
* @deprecated since version 5.2. Use the "pluck" method directly.
*/
public function lists($column, $key = null)
{
}
/**
* Paginate the given query.
*
* @param int $perPage
* @param array $columns
* @param string $pageName
* @param int|null $page
* @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
*
* @throws \InvalidArgumentException
*/
public function paginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
{
}
/**
* Paginate the given query into a simple paginator.
*
* @param int $perPage
* @param array $columns
* @param string $pageName
* @param int|null $page
* @return \Illuminate\Contracts\Pagination\Paginator
*/
public function simplePaginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
{
}
/**
* Update a record in the database.
*
* @param array $values
* @return int
*/
public function update(array $values)
{
}
/**
* Increment a column's value by a given amount.
*
* @param string $column
* @param int $amount
* @param array $extra
* @return int
*/
public function increment($column, $amount = 1, array $extra = [])
{
}
/**
* Decrement a column's value by a given amount.
*
* @param string $column
* @param int $amount
* @param array $extra
* @return int
*/
public function decrement($column, $amount = 1, array $extra = [])
{
}
/**
* Add the "updated at" column to an array of values.
*
* @param array $values
* @return array
*/
protected function addUpdatedAtColumn(array $values)
{
}
/**
* Delete a record from the database.
*
* @return mixed
*/
public function delete()
{
}
/**
* Run the default delete function on the builder.
*
* @return mixed
*/
public function forceDelete()
{
}
/**
* Register a replacement for the default delete function.
*
* @param \Closure $callback
* @return void
*/
public function onDelete(\Closure $callback)
{
}
/**
* Get the hydrated models without eager loading.
*
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model[]
*/
public function getModels($columns = ['*'])
{
}
/**
* Eager load the relationships for the models.
*
* @param array $models
* @return array
*/
public function eagerLoadRelations(array $models)
{
}
/**
* Eagerly load the relationship on a set of models.
*
* @param array $models
* @param string $name
* @param \Closure $constraints
* @return array
*/
protected function loadRelation(array $models, $name, \Closure $constraints)
{
}
/**
* Get the relation instance for the given relation name.
*
* @param string $name
* @return \Illuminate\Database\Eloquent\Relations\Relation
*/
public function getRelation($name)
{
}
/**
* Get the deeply nested relations for a given top-level relation.
*
* @param string $relation
* @return array
*/
public function nestedRelations($relation)
{
}
/**
* Determine if the relationship is nested.
*
* @param string $name
* @param string $relation
* @return bool
*/
protected function isNested($name, $relation)
{
}
/**
* Apply the callback's query changes if the given "value" is true.
*
* @param bool $value
* @param \Closure $callback
* @return $this
*/
public function when($value, $callback)
{
}
/**
* Add a basic where clause to the query.
*
* @param string $column
* @param string $operator
* @param mixed $value
* @param string $boolean
* @return $this
*/
public function where($column, $operator = null, $value = null, $boolean = 'and')
{
}
/**
* Add an "or where" clause to the query.
*
* @param string $column
* @param string $operator
* @param mixed $value
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function orWhere($column, $operator = null, $value = null)
{
}
/**
* Add a relationship count / exists condition to the query.
*
* @param string $relation
* @param string $operator
* @param int $count
* @param string $boolean
* @param \Closure|null $callback
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function has($relation, $operator = '>=', $count = 1, $boolean = 'and', \Closure $callback = null)
{
}
/**
* Add nested relationship count / exists conditions to the query.
*
* @param string $relations
* @param string $operator
* @param int $count
* @param string $boolean
* @param \Closure|null $callback
* @return \Illuminate\Database\Eloquent\Builder|static
*/
protected function hasNested($relations, $operator = '>=', $count = 1, $boolean = 'and', $callback = null)
{
}
/**
* Add a relationship count / exists condition to the query.
*
* @param string $relation
* @param string $boolean
* @param \Closure|null $callback
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function doesntHave($relation, $boolean = 'and', \Closure $callback = null)
{
}
/**
* Add a relationship count / exists condition to the query with where clauses.
*
* @param string $relation
* @param \Closure $callback
* @param string $operator
* @param int $count
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function whereHas($relation, \Closure $callback, $operator = '>=', $count = 1)
{
}
/**
* Add a relationship count / exists condition to the query with where clauses.
*
* @param string $relation
* @param \Closure|null $callback
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function whereDoesntHave($relation, \Closure $callback = null)
{
}
/**
* Add a relationship count / exists condition to the query with an "or".
*
* @param string $relation
* @param string $operator
* @param int $count
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function orHas($relation, $operator = '>=', $count = 1)
{
}
/**
* Add a relationship count / exists condition to the query with where clauses and an "or".
*
* @param string $relation
* @param \Closure $callback
* @param string $operator
* @param int $count
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function orWhereHas($relation, \Closure $callback, $operator = '>=', $count = 1)
{
}
/**
* Add the "has" condition where clause to the query.
*
* @param \Illuminate\Database\Eloquent\Builder $hasQuery
* @param \Illuminate\Database\Eloquent\Relations\Relation $relation
* @param string $operator
* @param int $count
* @param string $boolean
* @return \Illuminate\Database\Eloquent\Builder|static
*/
protected function addHasWhere(\Illuminate\Database\Eloquent\Builder $hasQuery, \Illuminate\Database\Eloquent\Relations\Relation $relation, $operator, $count, $boolean)
{
}
/**
* Check if we can run an "exists" query to optimize performance.
*
* @param string $operator
* @param int $count
* @return bool
*/
protected function shouldRunExistsQuery($operator, $count)
{
}
/**
* Add a sub query count clause to the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param string $operator
* @param int $count
* @param string $boolean
* @return $this
*/
protected function whereCountQuery(\Illuminate\Database\Query\Builder $query, $operator = '>=', $count = 1, $boolean = 'and')
{
}
/**
* Merge the constraints from a relation query to the current query.
*
* @param \Illuminate\Database\Eloquent\Builder $relation
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function mergeModelDefinedRelationConstraints(\Illuminate\Database\Eloquent\Builder $relation)
{
}
/**
* Get the "has relation" base query instance.
*
* @param string $relation
* @return \Illuminate\Database\Eloquent\Relations\Relation
*/
protected function getHasRelationQuery($relation)
{
}
/**
* Set the relationships that should be eager loaded.
*
* @param mixed $relations
* @return $this
*/
public function with($relations)
{
}
/**
* Add subselect queries to count the relations.
*
* @param mixed $relations
* @return $this
*/
public function withCount($relations)
{
}
/**
* Parse a list of relations into individuals.
*
* @param array $relations
* @return array
*/
protected function parseWithRelations(array $relations)
{
}
/**
* Parse the nested relationships in a relation.
*
* @param string $name
* @param array $results
* @return array
*/
protected function parseNestedWith($name, $results)
{
}
/**
* Apply the given scope on the current builder instance.
*
* @param callable $scope
* @param array $parameters
* @return mixed
*/
protected function callScope(callable $scope, $parameters = [])
{
}
/**
* Apply the scopes to the Eloquent builder instance and return it.
*
* @return \Illuminate\Database\Eloquent\Builder|static
*/
public function applyScopes()
{
}
/**
* Nest where conditions by slicing them at the given where count.
*
* @param \Illuminate\Database\Query\Builder $query
* @param int $originalWhereCount
* @return void
*/
protected function nestWheresForScope(\Illuminate\Database\Query\Builder $query, $originalWhereCount)
{
}
/**
* Slice where conditions at the given offset and add them to the query as a nested condition.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $wheres
* @param int $offset
* @param int $length
* @return void
*/
protected function addNestedWhereSlice(\Illuminate\Database\Query\Builder $query, $wheres, $offset, $length = null)
{
}
/**
* Create a where array with nested where conditions.
*
* @param array $whereSlice
* @return array
*/
protected function nestWhereSlice($whereSlice)
{
}
/**
* Get the underlying query builder instance.
*
* @return \Illuminate\Database\Query\Builder|static
*/
public function getQuery()
{
}
/**
* Get a base query builder instance.
*
* @return \Illuminate\Database\Query\Builder
*/
public function toBase()
{
}
/**
* Set the underlying query builder instance.
*
* @param \Illuminate\Database\Query\Builder $query
* @return $this
*/
public function setQuery($query)
{
}
/**
* Get the relationships being eagerly loaded.
*
* @return array
*/
public function getEagerLoads()
{
}
/**
* Set the relationships being eagerly loaded.
*
* @param array $eagerLoad
* @return $this
*/
public function setEagerLoads(array $eagerLoad)
{
}
/**
* Get the model instance being queried.
*
* @return \Illuminate\Database\Eloquent\Model
*/
public function getModel()
{
}
/**
* Set a model instance for the model being queried.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @return $this
*/
public function setModel(\Illuminate\Database\Eloquent\Model $model)
{
}
/**
* Extend the builder with a given callback.
*
* @param string $name
* @param \Closure $callback
* @return void
*/
public function macro($name, \Closure $callback)
{
}
/**
* Get the given macro by name.
*
* @param string $name
* @return \Closure
*/
public function getMacro($name)
{
}
/**
* Dynamically handle calls into the query instance.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public function __call($method, $parameters)
{
}
/**
* Force a clone of the underlying query builder when cloning.
*
* @return void
*/
public function __clone()
{
}
}
trait SoftDeletes
{
/**
* Indicates if the model is currently force deleting.
*
* @var bool
*/
protected $forceDeleting = false;
/**
* Boot the soft deleting trait for a model.
*
* @return void
*/
public static function bootSoftDeletes()
{
}
/**
* Force a hard delete on a soft deleted model.
*
* @return bool|null
*/
public function forceDelete()
{
}
/**
* Perform the actual delete query on this model instance.
*
* @return mixed
*/
protected function performDeleteOnModel()
{
}
/**
* Perform the actual delete query on this model instance.
*
* @return void
*/
protected function runSoftDelete()
{
}
/**
* Restore a soft-deleted model instance.
*
* @return bool|null
*/
public function restore()
{
}
/**
* Determine if the model instance has been soft-deleted.
*
* @return bool
*/
public function trashed()
{
}
/**
* Register a restoring model event with the dispatcher.
*
* @param \Closure|string $callback
* @return void
*/
public static function restoring($callback)
{
}
/**
* Register a restored model event with the dispatcher.
*
* @param \Closure|string $callback
* @return void
*/
public static function restored($callback)
{
}
/**
* Get the name of the "deleted at" column.
*
* @return string
*/
public function getDeletedAtColumn()
{
}
/**
* Get the fully qualified "deleted at" column.
*
* @return string
*/
public function getQualifiedDeletedAtColumn()
{
}
}
}
namespace Illuminate\Contracts\Queue {
interface QueueableCollection
{
/**
* Get the type of the entities being queued.
*
* @return string|null
*/
public function getQueueableClass();
/**
* Get the identifiers for all of the entities.
*
* @return array
*/
public function getQueueableIds();
}
}
namespace Illuminate\Support\Traits {
trait Macroable
{
/**
* The registered string macros.
*
* @var array
*/
protected static $macros = [];
/**
* Register a custom macro.
*
* @param string $name
* @param callable $macro
* @return void
*/
public static function macro($name, callable $macro)
{
}
/**
* Checks if macro is registered.
*
* @param string $name
* @return bool
*/
public static function hasMacro($name)
{
}
/**
* Dynamically handle calls to the class.
*
* @param string $method
* @param array $parameters
* @return mixed
*
* @throws \BadMethodCallException
*/
public static function __callStatic($method, $parameters)
{
}
/**
* Dynamically handle calls to the class.
*
* @param string $method
* @param array $parameters
* @return mixed
*
* @throws \BadMethodCallException
*/
public function __call($method, $parameters)
{
}
}
}
namespace Illuminate\Support {
class Collection implements \ArrayAccess, \Illuminate\Contracts\Support\Arrayable, \Countable, \IteratorAggregate, \Illuminate\Contracts\Support\Jsonable, \JsonSerializable
{
use \Illuminate\Support\Traits\Macroable;
/**
* The items contained in the collection.
*
* @var array
*/
protected $items = [];
/**
* Create a new collection.
*
* @param mixed $items
* @return void
*/
public function __construct($items = [])
{
}
/**
* Create a new collection instance if the value isn't one already.
*
* @param mixed $items
* @return static
*/
public static function make($items = [])
{
}
/**
* Get all of the items in the collection.
*
* @return array
*/
public function all()
{
}
/**
* Get the average value of a given key.
*
* @param string|null $key
* @return mixed
*/
public function avg($key = null)
{
}
/**
* Alias for the "avg" method.
*
* @param string|null $key
* @return mixed
*/
public function average($key = null)
{
}
/**
* Collapse the collection of items into a single array.
*
* @return static
*/
public function collapse()
{
}
/**
* Determine if an item exists in the collection.
*
* @param mixed $key
* @param mixed $value
* @return bool
*/
public function contains($key, $value = null)
{
}
/**
* Get the items in the collection that are not present in the given items.
*
* @param mixed $items
* @return static
*/
public function diff($items)
{
}
/**
* Get the items in the collection whose keys are not present in the given items.
*
* @param mixed $items
* @return static
*/
public function diffKeys($items)
{
}
/**
* Execute a callback over each item.
*
* @param callable $callback
* @return $this
*/
public function each(callable $callback)
{
}
/**
* Create a new collection consisting of every n-th element.
*
* @param int $step
* @param int $offset
* @return static
*/
public function every($step, $offset = 0)
{
}
/**
* Get all items except for those with the specified keys.
*
* @param mixed $keys
* @return static
*/
public function except($keys)
{
}
/**
* Run a filter over each of the items.
*
* @param callable|null $callback
* @return static
*/
public function filter(callable $callback = null)
{
}
/**
* Filter items by the given key value pair.
*
* @param string $key
* @param mixed $value
* @param bool $strict
* @return static
*/
public function where($key, $value, $strict = false)
{
}
/**
* Filter items by the given key value pair using loose comparison.
*
* @param string $key
* @param mixed $value
* @return static
*/
public function whereLoose($key, $value)
{
}
/**
* Filter items by the given key value pair.
*
* @param string $key
* @param array $values
* @param bool $strict
* @return static
*/
public function whereIn($key, array $values, $strict = false)
{
}
/**
* Filter items by the given key value pair using loose comparison.
*
* @param string $key
* @param array $values
* @return static
*/
public function whereInLoose($key, array $values)
{
}
/**
* Get the first item from the collection.
*
* @param callable|null $callback
* @param mixed $default
* @return mixed
*/
public function first(callable $callback = null, $default = null)
{
}
/**
* Get a flattened array of the items in the collection.
*
* @param int $depth
* @return static
*/
public function flatten($depth = INF)
{
}
/**
* Flip the items in the collection.
*
* @return static
*/
public function flip()
{
}
/**
* Remove an item from the collection by key.
*
* @param string|array $keys
* @return $this
*/
public function forget($keys)
{
}
/**
* Get an item from the collection by key.
*
* @param mixed $key
* @param mixed $default
* @return mixed
*/
public function get($key, $default = null)
{
}
/**
* Group an associative array by a field or using a callback.
*
* @param callable|string $groupBy
* @param bool $preserveKeys
* @return static
*/
public function groupBy($groupBy, $preserveKeys = false)
{
}
/**
* Key an associative array by a field or using a callback.
*
* @param callable|string $keyBy
* @return static
*/
public function keyBy($keyBy)
{
}
/**
* Determine if an item exists in the collection by key.
*
* @param mixed $key
* @return bool
*/
public function has($key)
{
}
/**
* Concatenate values of a given key as a string.
*
* @param string $value
* @param string $glue
* @return string
*/
public function implode($value, $glue = null)
{
}
/**
* Intersect the collection with the given items.
*
* @param mixed $items
* @return static
*/
public function intersect($items)
{
}
/**
* Determine if the collection is empty or not.
*
* @return bool
*/
public function isEmpty()
{
}
/**
* Determine if the given value is callable, but not a string.
*
* @param mixed $value
* @return bool
*/
protected function useAsCallable($value)
{
}
/**
* Get the keys of the collection items.
*
* @return static
*/
public function keys()
{
}
/**
* Get the last item from the collection.
*
* @param callable|null $callback
* @param mixed $default
* @return mixed
*/
public function last(callable $callback = null, $default = null)
{
}
/**
* Get the values of a given key.
*
* @param string $value
* @param string|null $key
* @return static
*/
public function pluck($value, $key = null)
{
}
/**
* Alias for the "pluck" method.
*
* @param string $value
* @param string|null $key
* @return static
*
* @deprecated since version 5.2. Use the "pluck" method directly.
*/
public function lists($value, $key = null)
{
}
/**
* Run a map over each of the items.
*
* @param callable $callback
* @return static
*/
public function map(callable $callback)
{
}
/**
* Map a collection and flatten the result by a single level.
*
* @param callable $callback
* @return static
*/
public function flatMap(callable $callback)
{
}
/**
* Get the max value of a given key.
*
* @param string|null $key
* @return mixed
*/
public function max($key = null)
{
}
/**
* Merge the collection with the given items.
*
* @param mixed $items
* @return static
*/
public function merge($items)
{
}
/**
* Create a collection by using this collection for keys and another for its values.
*
* @param mixed $values
* @return static
*/
public function combine($values)
{
}
/**
* Union the collection with the given items.
*
* @param mixed $items
* @return static
*/
public function union($items)
{
}
/**
* Get the min value of a given key.
*
* @param string|null $key
* @return mixed
*/
public function min($key = null)
{
}
/**
* Get the items with the specified keys.
*
* @param mixed $keys
* @return static
*/
public function only($keys)
{
}
/**
* "Paginate" the collection by slicing it into a smaller collection.
*
* @param int $page
* @param int $perPage
* @return static
*/
public function forPage($page, $perPage)
{
}
/**
* Get and remove the last item from the collection.
*
* @return mixed
*/
public function pop()
{
}
/**
* Push an item onto the beginning of the collection.
*
* @param mixed $value
* @param mixed $key
* @return $this
*/
public function prepend($value, $key = null)
{
}
/**
* Push an item onto the end of the collection.
*
* @param mixed $value
* @return $this
*/
public function push($value)
{
}
/**
* Get and remove an item from the collection.
*
* @param mixed $key
* @param mixed $default
* @return mixed
*/
public function pull($key, $default = null)
{
}
/**
* Put an item in the collection by key.
*
* @param mixed $key
* @param mixed $value
* @return $this
*/
public function put($key, $value)
{
}
/**
* Get one or more items randomly from the collection.
*
* @param int $amount
* @return mixed
*
* @throws \InvalidArgumentException
*/
public function random($amount = 1)
{
}
/**
* Reduce the collection to a single value.
*
* @param callable $callback
* @param mixed $initial
* @return mixed
*/
public function reduce(callable $callback, $initial = null)
{
}
/**
* Create a collection of all elements that do not pass a given truth test.
*
* @param callable|mixed $callback
* @return static
*/
public function reject($callback)
{
}
/**
* Reverse items order.
*
* @return static
*/
public function reverse()
{
}
/**
* Search the collection for a given value and return the corresponding key if successful.
*
* @param mixed $value
* @param bool $strict
* @return mixed
*/
public function search($value, $strict = false)
{
}
/**
* Get and remove the first item from the collection.
*
* @return mixed
*/
public function shift()
{
}
/**
* Shuffle the items in the collection.
*
* @return static
*/
public function shuffle()
{
}
/**
* Slice the underlying collection array.
*
* @param int $offset
* @param int $length
* @return static
*/
public function slice($offset, $length = null)
{
}
/**
* Chunk the underlying collection array.
*
* @param int $size
* @return static
*/
public function chunk($size)
{
}
/**
* Sort through each item with a callback.
*
* @param callable|null $callback
* @return static
*/
public function sort(callable $callback = null)
{
}
/**
* Sort the collection using the given callback.
*
* @param callable|string $callback
* @param int $options
* @param bool $descending
* @return static
*/
public function sortBy($callback, $options = SORT_REGULAR, $descending = false)
{
}
/**
* Sort the collection in descending order using the given callback.
*
* @param callable|string $callback
* @param int $options
* @return static
*/
public function sortByDesc($callback, $options = SORT_REGULAR)
{
}
/**
* Splice a portion of the underlying collection array.
*
* @param int $offset
* @param int|null $length
* @param mixed $replacement
* @return static
*/
public function splice($offset, $length = null, $replacement = [])
{
}
/**
* Get the sum of the given values.
*
* @param callable|string|null $callback
* @return mixed
*/
public function sum($callback = null)
{
}
/**
* Take the first or last {$limit} items.
*
* @param int $limit
* @return static
*/
public function take($limit)
{
}
/**
* Transform each item in the collection using a callback.
*
* @param callable $callback
* @return $this
*/
public function transform(callable $callback)
{
}
/**
* Return only unique items from the collection array.
*
* @param string|callable|null $key
* @return static
*/
public function unique($key = null)
{
}
/**
* Reset the keys on the underlying array.
*
* @return static
*/
public function values()
{
}
/**
* Get a value retrieving callback.
*
* @param string $value
* @return callable
*/
protected function valueRetriever($value)
{
}
/**
* Zip the collection together with one or more arrays.
*
* e.g. new Collection([1, 2, 3])->zip([4, 5, 6]);
* => [[1, 4], [2, 5], [3, 6]]
*
* @param mixed ...$items
* @return static
*/
public function zip($items)
{
}
/**
* Get the collection of items as a plain array.
*
* @return array
*/
public function toArray()
{
}
/**
* Convert the object into something JSON serializable.
*
* @return array
*/
public function jsonSerialize()
{
}
/**
* Get the collection of items as JSON.
*
* @param int $options
* @return string
*/
public function toJson($options = 0)
{
}
/**
* Get an iterator for the items.
*
* @return \ArrayIterator
*/
public function getIterator()
{
}
/**
* Get a CachingIterator instance.
*
* @param int $flags
* @return \CachingIterator
*/
public function getCachingIterator($flags = \CachingIterator::CALL_TOSTRING)
{
}
/**
* Count the number of items in the collection.
*
* @return int
*/
public function count()
{
}
/**
* Determine if an item exists at an offset.
*
* @param mixed $key
* @return bool
*/
public function offsetExists($key)
{
}
/**
* Get an item at a given offset.
*
* @param mixed $key
* @return mixed
*/
public function offsetGet($key)
{
}
/**
* Set the item at a given offset.
*
* @param mixed $key
* @param mixed $value
* @return void
*/
public function offsetSet($key, $value)
{
}
/**
* Unset the item at a given offset.
*
* @param string $key
* @return void
*/
public function offsetUnset($key)
{
}
/**
* Convert the collection to its string representation.
*
* @return string
*/
public function __toString()
{
}
/**
* Results array of items from Collection or Arrayable.
*
* @param mixed $items
* @return array
*/
protected function getArrayableItems($items)
{
}
}
}
namespace Illuminate\Database\Eloquent {
class Collection extends \Illuminate\Support\Collection implements \Illuminate\Contracts\Queue\QueueableCollection
{
/**
* Find a model in the collection by key.
*
* @param mixed $key
* @param mixed $default
* @return \Illuminate\Database\Eloquent\Model
*/
public function find($key, $default = null)
{
}
/**
* Load a set of relationships onto the collection.
*
* @param mixed $relations
* @return $this
*/
public function load($relations)
{
}
/**
* Add an item to the collection.
*
* @param mixed $item
* @return $this
*/
public function add($item)
{
}
/**
* Determine if a key exists in the collection.
*
* @param mixed $key
* @param mixed $value
* @return bool
*/
public function contains($key, $value = null)
{
}
/**
* Get the array of primary keys.
*
* @return array
*/
public function modelKeys()
{
}
/**
* Merge the collection with the given items.
*
* @param \ArrayAccess|array $items
* @return static
*/
public function merge($items)
{
}
/**
* Diff the collection with the given items.
*
* @param \ArrayAccess|array $items
* @return static
*/
public function diff($items)
{
}
/**
* Intersect the collection with the given items.
*
* @param \ArrayAccess|array $items
* @return static
*/
public function intersect($items)
{
}
/**
* Return only unique items from the collection.
*
* @param string|callable|null $key
* @return static
*/
public function unique($key = null)
{
}
/**
* Returns only the models from the collection with the specified keys.
*
* @param mixed $keys
* @return static
*/
public function only($keys)
{
}
/**
* Returns all models in the collection except the models with specified keys.
*
* @param mixed $keys
* @return static
*/
public function except($keys)
{
}
/**
* Make the given, typically visible, attributes hidden across the entire collection.
*
* @param array|string $attributes
* @return $this
*/
public function makeHidden($attributes)
{
}
/**
* Make the given, typically hidden, attributes visible across the entire collection.
*
* @param array|string $attributes
* @return $this
*/
public function makeVisible($attributes)
{
}
/**
* Make the given, typically hidden, attributes visible across the entire collection.
*
* @param array|string $attributes
* @return $this
*
* @deprecated since version 5.2. Use the "makeVisible" method directly.
*/
public function withHidden($attributes)
{
}
/**
* Get a dictionary keyed by primary keys.
*
* @param \ArrayAccess|array|null $items
* @return array
*/
public function getDictionary($items = null)
{
}
/**
* The following methods are intercepted to always return base collections.
*/
/**
* Get an array with the values of a given key.
*
* @param string $value
* @param string|null $key
* @return \Illuminate\Support\Collection
*/
public function pluck($value, $key = null)
{
}
/**
* Get the keys of the collection items.
*
* @return \Illuminate\Support\Collection
*/
public function keys()
{
}
/**
* Zip the collection together with one or more arrays.
*
* @param mixed ...$items
* @return \Illuminate\Support\Collection
*/
public function zip($items)
{
}
/**
* Collapse the collection of items into a single array.
*
* @return \Illuminate\Support\Collection
*/
public function collapse()
{
}
/**
* Get a flattened array of the items in the collection.
*
* @param int $depth
* @return \Illuminate\Support\Collection
*/
public function flatten($depth = INF)
{
}
/**
* Flip the items in the collection.
*
* @return \Illuminate\Support\Collection
*/
public function flip()
{
}
/**
* Get the type of the entities being queued.
*
* @return string|null
*/
public function getQueueableClass()
{
}
/**
* Get the identifiers for all of the entities.
*
* @return array
*/
public function getQueueableIds()
{
}
/**
* Get a base Support collection instance from this collection.
*
* @return \Illuminate\Support\Collection
*/
public function toBase()
{
}
}
}
namespace Illuminate\Database\Eloquent\Relations {
abstract class Relation
{
/**
* The Eloquent query builder instance.
*
* @var \Illuminate\Database\Eloquent\Builder
*/
protected $query;
/**
* The parent model instance.
*
* @var \Illuminate\Database\Eloquent\Model
*/
protected $parent;
/**
* The related model instance.
*
* @var \Illuminate\Database\Eloquent\Model
*/
protected $related;
/**
* Indicates if the relation is adding constraints.
*
* @var bool
*/
protected static $constraints = true;
/**
* An array to map class names to their morph names in database.
*
* @var array
*/
protected static $morphMap = [];
/**
* Create a new relation instance.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Model $parent
* @return void
*/
public function __construct(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Model $parent)
{
}
/**
* Set the base constraints on the relation query.
*
* @return void
*/
public abstract function addConstraints();
/**
* Set the constraints for an eager load of the relation.
*
* @param array $models
* @return void
*/
public abstract function addEagerConstraints(array $models);
/**
* Initialize the relation on a set of models.
*
* @param array $models
* @param string $relation
* @return array
*/
public abstract function initRelation(array $models, $relation);
/**
* Match the eagerly loaded results to their parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public abstract function match(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation);
/**
* Get the results of the relationship.
*
* @return mixed
*/
public abstract function getResults();
/**
* Get the relationship for eager loading.
*
* @return \Illuminate\Database\Eloquent\Collection
*/
public function getEager()
{
}
/**
* Touch all of the related models for the relationship.
*
* @return void
*/
public function touch()
{
}
/**
* Run a raw update against the base query.
*
* @param array $attributes
* @return int
*/
public function rawUpdate(array $attributes = [])
{
}
/**
* Add the constraints for a relationship count query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationCountQuery(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent)
{
}
/**
* Add the constraints for a relationship query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationQuery(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent, $columns = ['*'])
{
}
/**
* Run a callback with constraints disabled on the relation.
*
* @param \Closure $callback
* @return mixed
*/
public static function noConstraints(\Closure $callback)
{
}
/**
* Get all of the primary keys for an array of models.
*
* @param array $models
* @param string $key
* @return array
*/
protected function getKeys(array $models, $key = null)
{
}
/**
* Get the underlying query for the relation.
*
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getQuery()
{
}
/**
* Get the base query builder driving the Eloquent builder.
*
* @return \Illuminate\Database\Query\Builder
*/
public function getBaseQuery()
{
}
/**
* Get the parent model of the relation.
*
* @return \Illuminate\Database\Eloquent\Model
*/
public function getParent()
{
}
/**
* Get the fully qualified parent key name.
*
* @return string
*/
public function getQualifiedParentKeyName()
{
}
/**
* Get the related model of the relation.
*
* @return \Illuminate\Database\Eloquent\Model
*/
public function getRelated()
{
}
/**
* Get the name of the "created at" column.
*
* @return string
*/
public function createdAt()
{
}
/**
* Get the name of the "updated at" column.
*
* @return string
*/
public function updatedAt()
{
}
/**
* Get the name of the related model's "updated at" column.
*
* @return string
*/
public function relatedUpdatedAt()
{
}
/**
* Wrap the given value with the parent query's grammar.
*
* @param string $value
* @return string
*/
public function wrap($value)
{
}
/**
* Set or get the morph map for polymorphic relations.
*
* @param array|null $map
* @param bool $merge
* @return array
*/
public static function morphMap(array $map = null, $merge = true)
{
}
/**
* Builds a table-keyed array from model class names.
*
* @param string[]|null $models
* @return array|null
*/
protected static function buildMorphMapFromModels(array $models = null)
{
}
/**
* Handle dynamic method calls to the relationship.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public function __call($method, $parameters)
{
}
/**
* Force a clone of the underlying query builder when cloning.
*
* @return void
*/
public function __clone()
{
}
}
class BelongsToMany extends \Illuminate\Database\Eloquent\Relations\Relation
{
/**
* The intermediate table for the relation.
*
* @var string
*/
protected $table;
/**
* The foreign key of the parent model.
*
* @var string
*/
protected $foreignKey;
/**
* The associated key of the relation.
*
* @var string
*/
protected $otherKey;
/**
* The "name" of the relationship.
*
* @var string
*/
protected $relationName;
/**
* The pivot table columns to retrieve.
*
* @var array
*/
protected $pivotColumns = [];
/**
* Any pivot table restrictions.
*
* @var array
*/
protected $pivotWheres = [];
/**
* The custom pivot table column for the created_at timestamp.
*
* @var string
*/
protected $pivotCreatedAt;
/**
* The custom pivot table column for the updated_at timestamp.
*
* @var string
*/
protected $pivotUpdatedAt;
/**
* The count of self joins.
*
* @var int
*/
protected static $selfJoinCount = 0;
/**
* Create a new belongs to many relationship instance.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Model $parent
* @param string $table
* @param string $foreignKey
* @param string $otherKey
* @param string $relationName
* @return void
*/
public function __construct(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Model $parent, $table, $foreignKey, $otherKey, $relationName = null)
{
}
/**
* Get the results of the relationship.
*
* @return mixed
*/
public function getResults()
{
}
/**
* Set a where clause for a pivot table column.
*
* @param string $column
* @param string $operator
* @param mixed $value
* @param string $boolean
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function wherePivot($column, $operator = null, $value = null, $boolean = 'and')
{
}
/**
* Set a "where in" clause for a pivot table column.
*
* @param string $column
* @param mixed $values
* @param string $boolean
* @param bool $not
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function wherePivotIn($column, $values, $boolean = 'and', $not = false)
{
}
/**
* Set an "or where" clause for a pivot table column.
*
* @param string $column
* @param string $operator
* @param mixed $value
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function orWherePivot($column, $operator = null, $value = null)
{
}
/**
* Set an "or where in" clause for a pivot table column.
*
* @param string $column
* @param mixed $values
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function orWherePivotIn($column, $values)
{
}
/**
* Execute the query and get the first result.
*
* @param array $columns
* @return mixed
*/
public function first($columns = ['*'])
{
}
/**
* Execute the query and get the first result or throw an exception.
*
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model|static
*
* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
*/
public function firstOrFail($columns = ['*'])
{
}
/**
* Execute the query as a "select" statement.
*
* @param array $columns
* @return \Illuminate\Database\Eloquent\Collection
*/
public function get($columns = ['*'])
{
}
/**
* Get a paginator for the "select" statement.
*
* @param int $perPage
* @param array $columns
* @param string $pageName
* @param int|null $page
* @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
*/
public function paginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
{
}
/**
* Paginate the given query into a simple paginator.
*
* @param int $perPage
* @param array $columns
* @param string $pageName
* @return \Illuminate\Contracts\Pagination\Paginator
*/
public function simplePaginate($perPage = null, $columns = ['*'], $pageName = 'page')
{
}
/**
* Chunk the results of the query.
*
* @param int $count
* @param callable $callback
* @return bool
*/
public function chunk($count, callable $callback)
{
}
/**
* Hydrate the pivot table relationship on the models.
*
* @param array $models
* @return void
*/
protected function hydratePivotRelation(array $models)
{
}
/**
* Get the pivot attributes from a model.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @return array
*/
protected function cleanPivotAttributes(\Illuminate\Database\Eloquent\Model $model)
{
}
/**
* Set the base constraints on the relation query.
*
* @return void
*/
public function addConstraints()
{
}
/**
* Add the constraints for a relationship query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationQuery(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent, $columns = ['*'])
{
}
/**
* Add the constraints for a relationship query on the same table.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationQueryForSelfJoin(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent, $columns = ['*'])
{
}
/**
* Get a relationship join table hash.
*
* @return string
*/
public function getRelationCountHash()
{
}
/**
* Set the select clause for the relation query.
*
* @param array $columns
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
protected function getSelectColumns(array $columns = ['*'])
{
}
/**
* Get the pivot columns for the relation.
*
* @return array
*/
protected function getAliasedPivotColumns()
{
}
/**
* Determine whether the given column is defined as a pivot column.
*
* @param string $column
* @return bool
*/
protected function hasPivotColumn($column)
{
}
/**
* Set the join clause for the relation query.
*
* @param \Illuminate\Database\Eloquent\Builder|null $query
* @return $this
*/
protected function setJoin($query = null)
{
}
/**
* Set the where clause for the relation query.
*
* @return $this
*/
protected function setWhere()
{
}
/**
* Set the constraints for an eager load of the relation.
*
* @param array $models
* @return void
*/
public function addEagerConstraints(array $models)
{
}
/**
* Initialize the relation on a set of models.
*
* @param array $models
* @param string $relation
* @return array
*/
public function initRelation(array $models, $relation)
{
}
/**
* Match the eagerly loaded results to their parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public function match(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation)
{
}
/**
* Build model dictionary keyed by the relation's foreign key.
*
* @param \Illuminate\Database\Eloquent\Collection $results
* @return array
*/
protected function buildDictionary(\Illuminate\Database\Eloquent\Collection $results)
{
}
/**
* Touch all of the related models for the relationship.
*
* E.g.: Touch all roles associated with this user.
*
* @return void
*/
public function touch()
{
}
/**
* Get all of the IDs for the related models.
*
* @return \Illuminate\Support\Collection
*/
public function getRelatedIds()
{
}
/**
* Save a new model and attach it to the parent model.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @param array $joining
* @param bool $touch
* @return \Illuminate\Database\Eloquent\Model
*/
public function save(\Illuminate\Database\Eloquent\Model $model, array $joining = [], $touch = true)
{
}
/**
* Save an array of new models and attach them to the parent model.
*
* @param \Illuminate\Support\Collection|array $models
* @param array $joinings
* @return array
*/
public function saveMany($models, array $joinings = [])
{
}
/**
* Find a related model by its primary key.
*
* @param mixed $id
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection|null
*/
public function find($id, $columns = ['*'])
{
}
/**
* Find multiple related models by their primary keys.
*
* @param mixed $ids
* @param array $columns
* @return \Illuminate\Database\Eloquent\Collection
*/
public function findMany($ids, $columns = ['*'])
{
}
/**
* Find a related model by its primary key or throw an exception.
*
* @param mixed $id
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection
*
* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
*/
public function findOrFail($id, $columns = ['*'])
{
}
/**
* Find a related model by its primary key or return new instance of the related model.
*
* @param mixed $id
* @param array $columns
* @return \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model
*/
public function findOrNew($id, $columns = ['*'])
{
}
/**
* Get the first related model record matching the attributes or instantiate it.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Model
*/
public function firstOrNew(array $attributes)
{
}
/**
* Get the first related record matching the attributes or create it.
*
* @param array $attributes
* @param array $joining
* @param bool $touch
* @return \Illuminate\Database\Eloquent\Model
*/
public function firstOrCreate(array $attributes, array $joining = [], $touch = true)
{
}
/**
* Create or update a related record matching the attributes, and fill it with values.
*
* @param array $attributes
* @param array $values
* @param array $joining
* @param bool $touch
* @return \Illuminate\Database\Eloquent\Model
*/
public function updateOrCreate(array $attributes, array $values = [], array $joining = [], $touch = true)
{
}
/**
* Create a new instance of the related model.
*
* @param array $attributes
* @param array $joining
* @param bool $touch
* @return \Illuminate\Database\Eloquent\Model
*/
public function create(array $attributes, array $joining = [], $touch = true)
{
}
/**
* Create an array of new instances of the related models.
*
* @param array $records
* @param array $joinings
* @return array
*/
public function createMany(array $records, array $joinings = [])
{
}
/**
* Sync the intermediate tables with a list of IDs or collection of models.
*
* @param \Illuminate\Database\Eloquent\Collection|array $ids
* @param bool $detaching
* @return array
*/
public function sync($ids, $detaching = true)
{
}
/**
* Format the sync list so that it is keyed by ID.
*
* @param array $records
* @return array
*/
protected function formatSyncList(array $records)
{
}
/**
* Attach all of the IDs that aren't in the current array.
*
* @param array $records
* @param array $current
* @param bool $touch
* @return array
*/
protected function attachNew(array $records, array $current, $touch = true)
{
}
/**
* Update an existing pivot record on the table.
*
* @param mixed $id
* @param array $attributes
* @param bool $touch
* @return int
*/
public function updateExistingPivot($id, array $attributes, $touch = true)
{
}
/**
* Attach a model to the parent.
*
* @param mixed $id
* @param array $attributes
* @param bool $touch
* @return void
*/
public function attach($id, array $attributes = [], $touch = true)
{
}
/**
* Create an array of records to insert into the pivot table.
*
* @param array $ids
* @param array $attributes
* @return array
*/
protected function createAttachRecords($ids, array $attributes)
{
}
/**
* Create a full attachment record payload.
*
* @param int $key
* @param mixed $value
* @param array $attributes
* @param bool $timed
* @return array
*/
protected function attacher($key, $value, $attributes, $timed)
{
}
/**
* Get the attach record ID and extra attributes.
*
* @param mixed $key
* @param mixed $value
* @param array $attributes
* @return array
*/
protected function getAttachId($key, $value, array $attributes)
{
}
/**
* Create a new pivot attachment record.
*
* @param int $id
* @param bool $timed
* @return array
*/
protected function createAttachRecord($id, $timed)
{
}
/**
* Set the creation and update timestamps on an attach record.
*
* @param array $record
* @param bool $exists
* @return array
*/
protected function setTimestampsOnAttach(array $record, $exists = false)
{
}
/**
* Detach models from the relationship.
*
* @param int|array $ids
* @param bool $touch
* @return int
*/
public function detach($ids = [], $touch = true)
{
}
/**
* If we're touching the parent model, touch.
*
* @return void
*/
public function touchIfTouching()
{
}
/**
* Determine if we should touch the parent on sync.
*
* @return bool
*/
protected function touchingParent()
{
}
/**
* Attempt to guess the name of the inverse of the relation.
*
* @return string
*/
protected function guessInverseRelation()
{
}
/**
* Create a new query builder for the pivot table.
*
* @return \Illuminate\Database\Query\Builder
*/
protected function newPivotQuery()
{
}
/**
* Get a new plain query builder for the pivot table.
*
* @return \Illuminate\Database\Query\Builder
*/
public function newPivotStatement()
{
}
/**
* Get a new pivot statement for a given "other" ID.
*
* @param mixed $id
* @return \Illuminate\Database\Query\Builder
*/
public function newPivotStatementForId($id)
{
}
/**
* Create a new pivot model instance.
*
* @param array $attributes
* @param bool $exists
* @return \Illuminate\Database\Eloquent\Relations\Pivot
*/
public function newPivot(array $attributes = [], $exists = false)
{
}
/**
* Create a new existing pivot model instance.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Relations\Pivot
*/
public function newExistingPivot(array $attributes = [])
{
}
/**
* Set the columns on the pivot table to retrieve.
*
* @param array|mixed $columns
* @return $this
*/
public function withPivot($columns)
{
}
/**
* Specify that the pivot table has creation and update timestamps.
*
* @param mixed $createdAt
* @param mixed $updatedAt
* @return \Illuminate\Database\Eloquent\Relations\BelongsToMany
*/
public function withTimestamps($createdAt = null, $updatedAt = null)
{
}
/**
* Get the name of the "created at" column.
*
* @return string
*/
public function createdAt()
{
}
/**
* Get the name of the "updated at" column.
*
* @return string
*/
public function updatedAt()
{
}
/**
* Get the related model's updated at column name.
*
* @return string
*/
public function getRelatedFreshUpdate()
{
}
/**
* Get the key for comparing against the parent key in "has" query.
*
* @return string
*/
public function getHasCompareKey()
{
}
/**
* Get the fully qualified foreign key for the relation.
*
* @return string
*/
public function getForeignKey()
{
}
/**
* Get the fully qualified "other key" for the relation.
*
* @return string
*/
public function getOtherKey()
{
}
/**
* Get the intermediate table for the relationship.
*
* @return string
*/
public function getTable()
{
}
/**
* Get the relationship name for the relationship.
*
* @return string
*/
public function getRelationName()
{
}
}
class MorphToMany extends \Illuminate\Database\Eloquent\Relations\BelongsToMany
{
/**
* The type of the polymorphic relation.
*
* @var string
*/
protected $morphType;
/**
* The class name of the morph type constraint.
*
* @var string
*/
protected $morphClass;
/**
* Indicates if we are connecting the inverse of the relation.
*
* This primarily affects the morphClass constraint.
*
* @var bool
*/
protected $inverse;
/**
* Create a new morph to many relationship instance.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Model $parent
* @param string $name
* @param string $table
* @param string $foreignKey
* @param string $otherKey
* @param string $relationName
* @param bool $inverse
* @return void
*/
public function __construct(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Model $parent, $name, $table, $foreignKey, $otherKey, $relationName = null, $inverse = false)
{
}
/**
* Set the where clause for the relation query.
*
* @return $this
*/
protected function setWhere()
{
}
/**
* Add the constraints for a relationship count query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationQuery(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent, $columns = ['*'])
{
}
/**
* Set the constraints for an eager load of the relation.
*
* @param array $models
* @return void
*/
public function addEagerConstraints(array $models)
{
}
/**
* Create a new pivot attachment record.
*
* @param int $id
* @param bool $timed
* @return array
*/
protected function createAttachRecord($id, $timed)
{
}
/**
* Create a new query builder for the pivot table.
*
* @return \Illuminate\Database\Query\Builder
*/
protected function newPivotQuery()
{
}
/**
* Create a new pivot model instance.
*
* @param array $attributes
* @param bool $exists
* @return \Illuminate\Database\Eloquent\Relations\Pivot
*/
public function newPivot(array $attributes = [], $exists = false)
{
}
/**
* Get the foreign key "type" name.
*
* @return string
*/
public function getMorphType()
{
}
/**
* Get the class name of the parent model.
*
* @return string
*/
public function getMorphClass()
{
}
}
abstract class HasOneOrMany extends \Illuminate\Database\Eloquent\Relations\Relation
{
/**
* The foreign key of the parent model.
*
* @var string
*/
protected $foreignKey;
/**
* The local key of the parent model.
*
* @var string
*/
protected $localKey;
/**
* The count of self joins.
*
* @var int
*/
protected static $selfJoinCount = 0;
/**
* Create a new has one or many relationship instance.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Model $parent
* @param string $foreignKey
* @param string $localKey
* @return void
*/
public function __construct(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Model $parent, $foreignKey, $localKey)
{
}
/**
* Set the base constraints on the relation query.
*
* @return void
*/
public function addConstraints()
{
}
/**
* Add the constraints for a relationship query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationQuery(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent, $columns = ['*'])
{
}
/**
* Add the constraints for a relationship query on the same table.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationQueryForSelfRelation(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent, $columns = ['*'])
{
}
/**
* Get a relationship join table hash.
*
* @return string
*/
public function getRelationCountHash()
{
}
/**
* Set the constraints for an eager load of the relation.
*
* @param array $models
* @return void
*/
public function addEagerConstraints(array $models)
{
}
/**
* Match the eagerly loaded results to their single parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public function matchOne(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation)
{
}
/**
* Match the eagerly loaded results to their many parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public function matchMany(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation)
{
}
/**
* Match the eagerly loaded results to their many parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @param string $type
* @return array
*/
protected function matchOneOrMany(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation, $type)
{
}
/**
* Get the value of a relationship by one or many type.
*
* @param array $dictionary
* @param string $key
* @param string $type
* @return mixed
*/
protected function getRelationValue(array $dictionary, $key, $type)
{
}
/**
* Build model dictionary keyed by the relation's foreign key.
*
* @param \Illuminate\Database\Eloquent\Collection $results
* @return array
*/
protected function buildDictionary(\Illuminate\Database\Eloquent\Collection $results)
{
}
/**
* Attach a model instance to the parent model.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @return \Illuminate\Database\Eloquent\Model
*/
public function save(\Illuminate\Database\Eloquent\Model $model)
{
}
/**
* Attach a collection of models to the parent instance.
*
* @param \Traversable|array $models
* @return \Traversable|array
*/
public function saveMany($models)
{
}
/**
* Find a model by its primary key or return new instance of the related model.
*
* @param mixed $id
* @param array $columns
* @return \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model
*/
public function findOrNew($id, $columns = ['*'])
{
}
/**
* Get the first related model record matching the attributes or instantiate it.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Model
*/
public function firstOrNew(array $attributes)
{
}
/**
* Get the first related record matching the attributes or create it.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Model
*/
public function firstOrCreate(array $attributes)
{
}
/**
* Create or update a related record matching the attributes, and fill it with values.
*
* @param array $attributes
* @param array $values
* @return \Illuminate\Database\Eloquent\Model
*/
public function updateOrCreate(array $attributes, array $values = [])
{
}
/**
* Create a new instance of the related model.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Model
*/
public function create(array $attributes)
{
}
/**
* Create an array of new instances of the related model.
*
* @param array $records
* @return array
*/
public function createMany(array $records)
{
}
/**
* Perform an update on all the related models.
*
* @param array $attributes
* @return int
*/
public function update(array $attributes)
{
}
/**
* Get the key for comparing against the parent key in "has" query.
*
* @return string
*/
public function getHasCompareKey()
{
}
/**
* Get the foreign key for the relationship.
*
* @return string
*/
public function getForeignKey()
{
}
/**
* Get the plain foreign key.
*
* @return string
*/
public function getPlainForeignKey()
{
}
/**
* Get the key value of the parent's local key.
*
* @return mixed
*/
public function getParentKey()
{
}
/**
* Get the fully qualified parent key name.
*
* @return string
*/
public function getQualifiedParentKeyName()
{
}
}
class HasOne extends \Illuminate\Database\Eloquent\Relations\HasOneOrMany
{
/**
* Get the results of the relationship.
*
* @return mixed
*/
public function getResults()
{
}
/**
* Initialize the relation on a set of models.
*
* @param array $models
* @param string $relation
* @return array
*/
public function initRelation(array $models, $relation)
{
}
/**
* Match the eagerly loaded results to their parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public function match(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation)
{
}
}
class HasMany extends \Illuminate\Database\Eloquent\Relations\HasOneOrMany
{
/**
* Get the results of the relationship.
*
* @return mixed
*/
public function getResults()
{
}
/**
* Initialize the relation on a set of models.
*
* @param array $models
* @param string $relation
* @return array
*/
public function initRelation(array $models, $relation)
{
}
/**
* Match the eagerly loaded results to their parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public function match(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation)
{
}
}
class HasManyThrough extends \Illuminate\Database\Eloquent\Relations\Relation
{
/**
* The distance parent model instance.
*
* @var \Illuminate\Database\Eloquent\Model
*/
protected $farParent;
/**
* The near key on the relationship.
*
* @var string
*/
protected $firstKey;
/**
* The far key on the relationship.
*
* @var string
*/
protected $secondKey;
/**
* The local key on the relationship.
*
* @var string
*/
protected $localKey;
/**
* Create a new has many through relationship instance.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Model $farParent
* @param \Illuminate\Database\Eloquent\Model $parent
* @param string $firstKey
* @param string $secondKey
* @param string $localKey
* @return void
*/
public function __construct(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Model $farParent, \Illuminate\Database\Eloquent\Model $parent, $firstKey, $secondKey, $localKey)
{
}
/**
* Set the base constraints on the relation query.
*
* @return void
*/
public function addConstraints()
{
}
/**
* Add the constraints for a relationship query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationQuery(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent, $columns = ['*'])
{
}
/**
* Set the join clause on the query.
*
* @param \Illuminate\Database\Eloquent\Builder|null $query
* @return void
*/
protected function setJoin(\Illuminate\Database\Eloquent\Builder $query = null)
{
}
/**
* Determine whether close parent of the relation uses Soft Deletes.
*
* @return bool
*/
public function parentSoftDeletes()
{
}
/**
* Set the constraints for an eager load of the relation.
*
* @param array $models
* @return void
*/
public function addEagerConstraints(array $models)
{
}
/**
* Initialize the relation on a set of models.
*
* @param array $models
* @param string $relation
* @return array
*/
public function initRelation(array $models, $relation)
{
}
/**
* Match the eagerly loaded results to their parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public function match(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation)
{
}
/**
* Build model dictionary keyed by the relation's foreign key.
*
* @param \Illuminate\Database\Eloquent\Collection $results
* @return array
*/
protected function buildDictionary(\Illuminate\Database\Eloquent\Collection $results)
{
}
/**
* Get the results of the relationship.
*
* @return mixed
*/
public function getResults()
{
}
/**
* Execute the query and get the first related model.
*
* @param array $columns
* @return mixed
*/
public function first($columns = ['*'])
{
}
/**
* Execute the query and get the first result or throw an exception.
*
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model|static
*
* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
*/
public function firstOrFail($columns = ['*'])
{
}
/**
* Find a related model by its primary key.
*
* @param mixed $id
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection|null
*/
public function find($id, $columns = ['*'])
{
}
/**
* Find multiple related models by their primary keys.
*
* @param mixed $ids
* @param array $columns
* @return \Illuminate\Database\Eloquent\Collection
*/
public function findMany($ids, $columns = ['*'])
{
}
/**
* Find a related model by its primary key or throw an exception.
*
* @param mixed $id
* @param array $columns
* @return \Illuminate\Database\Eloquent\Model|\Illuminate\Database\Eloquent\Collection
*
* @throws \Illuminate\Database\Eloquent\ModelNotFoundException
*/
public function findOrFail($id, $columns = ['*'])
{
}
/**
* Execute the query as a "select" statement.
*
* @param array $columns
* @return \Illuminate\Database\Eloquent\Collection
*/
public function get($columns = ['*'])
{
}
/**
* Set the select clause for the relation query.
*
* @param array $columns
* @return array
*/
protected function getSelectColumns(array $columns = ['*'])
{
}
/**
* Get a paginator for the "select" statement.
*
* @param int $perPage
* @param array $columns
* @param string $pageName
* @param int $page
* @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
*/
public function paginate($perPage = null, $columns = ['*'], $pageName = 'page', $page = null)
{
}
/**
* Paginate the given query into a simple paginator.
*
* @param int $perPage
* @param array $columns
* @param string $pageName
* @return \Illuminate\Contracts\Pagination\Paginator
*/
public function simplePaginate($perPage = null, $columns = ['*'], $pageName = 'page')
{
}
/**
* Get the key for comparing against the parent key in "has" query.
*
* @return string
*/
public function getHasCompareKey()
{
}
/**
* Get the qualified foreign key on the related model.
*
* @return string
*/
public function getForeignKey()
{
}
/**
* Get the qualified foreign key on the "through" model.
*
* @return string
*/
public function getThroughKey()
{
}
}
class Pivot extends \Illuminate\Database\Eloquent\Model
{
/**
* The parent model of the relationship.
*
* @var \Illuminate\Database\Eloquent\Model
*/
protected $parent;
/**
* The name of the foreign key column.
*
* @var string
*/
protected $foreignKey;
/**
* The name of the "other key" column.
*
* @var string
*/
protected $otherKey;
/**
* The attributes that aren't mass assignable.
*
* @var array
*/
protected $guarded = [];
/**
* Create a new pivot model instance.
*
* @param \Illuminate\Database\Eloquent\Model $parent
* @param array $attributes
* @param string $table
* @param bool $exists
* @return void
*/
public function __construct(\Illuminate\Database\Eloquent\Model $parent, $attributes, $table, $exists = false)
{
}
/**
* Create a new pivot model from raw values returned from a query.
*
* @param \Illuminate\Database\Eloquent\Model $parent
* @param array $attributes
* @param string $table
* @param bool $exists
* @return static
*/
public static function fromRawAttributes(\Illuminate\Database\Eloquent\Model $parent, $attributes, $table, $exists = false)
{
}
/**
* Set the keys for a save update query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @return \Illuminate\Database\Eloquent\Builder
*/
protected function setKeysForSaveQuery(\Illuminate\Database\Eloquent\Builder $query)
{
}
/**
* Delete the pivot model record from the database.
*
* @return int
*/
public function delete()
{
}
/**
* Get the query builder for a delete operation on the pivot.
*
* @return \Illuminate\Database\Eloquent\Builder
*/
protected function getDeleteQuery()
{
}
/**
* Get the foreign key column name.
*
* @return string
*/
public function getForeignKey()
{
}
/**
* Get the "other key" column name.
*
* @return string
*/
public function getOtherKey()
{
}
/**
* Set the key names for the pivot model instance.
*
* @param string $foreignKey
* @param string $otherKey
* @return $this
*/
public function setPivotKeys($foreignKey, $otherKey)
{
}
/**
* Determine if the pivot model has timestamp attributes.
*
* @return bool
*/
public function hasTimestampAttributes()
{
}
/**
* Get the name of the "created at" column.
*
* @return string
*/
public function getCreatedAtColumn()
{
}
/**
* Get the name of the "updated at" column.
*
* @return string
*/
public function getUpdatedAtColumn()
{
}
}
class MorphPivot extends \Illuminate\Database\Eloquent\Relations\Pivot
{
/**
* The type of the polymorphic relation.
*
* Explicitly define this so it's not included in saved attributes.
*
* @var string
*/
protected $morphType;
/**
* The value of the polymorphic relation.
*
* Explicitly define this so it's not included in saved attributes.
*
* @var string
*/
protected $morphClass;
/**
* Set the keys for a save update query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @return \Illuminate\Database\Eloquent\Builder
*/
protected function setKeysForSaveQuery(\Illuminate\Database\Eloquent\Builder $query)
{
}
/**
* Delete the pivot model record from the database.
*
* @return int
*/
public function delete()
{
}
/**
* Set the morph type for the pivot.
*
* @param string $morphType
* @return $this
*/
public function setMorphType($morphType)
{
}
/**
* Set the morph class for the pivot.
*
* @param string $morphClass
* @return \Illuminate\Database\Eloquent\Relations\MorphPivot
*/
public function setMorphClass($morphClass)
{
}
}
class BelongsTo extends \Illuminate\Database\Eloquent\Relations\Relation
{
/**
* The foreign key of the parent model.
*
* @var string
*/
protected $foreignKey;
/**
* The associated key on the parent model.
*
* @var string
*/
protected $otherKey;
/**
* The name of the relationship.
*
* @var string
*/
protected $relation;
/**
* The count of self joins.
*
* @var int
*/
protected static $selfJoinCount = 0;
/**
* Create a new belongs to relationship instance.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Model $parent
* @param string $foreignKey
* @param string $otherKey
* @param string $relation
* @return void
*/
public function __construct(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Model $parent, $foreignKey, $otherKey, $relation)
{
}
/**
* Get the results of the relationship.
*
* @return mixed
*/
public function getResults()
{
}
/**
* Set the base constraints on the relation query.
*
* @return void
*/
public function addConstraints()
{
}
/**
* Add the constraints for a relationship query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationQuery(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent, $columns = ['*'])
{
}
/**
* Add the constraints for a relationship query on the same table.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationQueryForSelfRelation(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent, $columns = ['*'])
{
}
/**
* Get a relationship join table hash.
*
* @return string
*/
public function getRelationCountHash()
{
}
/**
* Set the constraints for an eager load of the relation.
*
* @param array $models
* @return void
*/
public function addEagerConstraints(array $models)
{
}
/**
* Gather the keys from an array of related models.
*
* @param array $models
* @return array
*/
protected function getEagerModelKeys(array $models)
{
}
/**
* Initialize the relation on a set of models.
*
* @param array $models
* @param string $relation
* @return array
*/
public function initRelation(array $models, $relation)
{
}
/**
* Match the eagerly loaded results to their parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public function match(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation)
{
}
/**
* Associate the model instance to the given parent.
*
* @param \Illuminate\Database\Eloquent\Model|int $model
* @return \Illuminate\Database\Eloquent\Model
*/
public function associate($model)
{
}
/**
* Dissociate previously associated model from the given parent.
*
* @return \Illuminate\Database\Eloquent\Model
*/
public function dissociate()
{
}
/**
* Update the parent model on the relationship.
*
* @param array $attributes
* @return mixed
*/
public function update(array $attributes)
{
}
/**
* Get the foreign key of the relationship.
*
* @return string
*/
public function getForeignKey()
{
}
/**
* Get the fully qualified foreign key of the relationship.
*
* @return string
*/
public function getQualifiedForeignKey()
{
}
/**
* Get the associated key of the relationship.
*
* @return string
*/
public function getOtherKey()
{
}
/**
* Get the fully qualified associated key of the relationship.
*
* @return string
*/
public function getQualifiedOtherKeyName()
{
}
}
abstract class MorphOneOrMany extends \Illuminate\Database\Eloquent\Relations\HasOneOrMany
{
/**
* The foreign key type for the relationship.
*
* @var string
*/
protected $morphType;
/**
* The class name of the parent model.
*
* @var string
*/
protected $morphClass;
/**
* Create a new morph one or many relationship instance.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Model $parent
* @param string $type
* @param string $id
* @param string $localKey
* @return void
*/
public function __construct(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Model $parent, $type, $id, $localKey)
{
}
/**
* Set the base constraints on the relation query.
*
* @return void
*/
public function addConstraints()
{
}
/**
* Get the relationship query.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Builder $parent
* @param array|mixed $columns
* @return \Illuminate\Database\Eloquent\Builder
*/
public function getRelationQuery(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Builder $parent, $columns = ['*'])
{
}
/**
* Set the constraints for an eager load of the relation.
*
* @param array $models
* @return void
*/
public function addEagerConstraints(array $models)
{
}
/**
* Attach a model instance to the parent model.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @return \Illuminate\Database\Eloquent\Model
*/
public function save(\Illuminate\Database\Eloquent\Model $model)
{
}
/**
* Find a related model by its primary key or return new instance of the related model.
*
* @param mixed $id
* @param array $columns
* @return \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model
*/
public function findOrNew($id, $columns = ['*'])
{
}
/**
* Get the first related model record matching the attributes or instantiate it.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Model
*/
public function firstOrNew(array $attributes)
{
}
/**
* Get the first related record matching the attributes or create it.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Model
*/
public function firstOrCreate(array $attributes)
{
}
/**
* Create or update a related record matching the attributes, and fill it with values.
*
* @param array $attributes
* @param array $values
* @return \Illuminate\Database\Eloquent\Model
*/
public function updateOrCreate(array $attributes, array $values = [])
{
}
/**
* Create a new instance of the related model.
*
* @param array $attributes
* @return \Illuminate\Database\Eloquent\Model
*/
public function create(array $attributes)
{
}
/**
* Set the foreign ID and type for creating a related model.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @return void
*/
protected function setForeignAttributesForCreate(\Illuminate\Database\Eloquent\Model $model)
{
}
/**
* Get the foreign key "type" name.
*
* @return string
*/
public function getMorphType()
{
}
/**
* Get the plain morph type name without the table.
*
* @return string
*/
public function getPlainMorphType()
{
}
/**
* Get the class name of the parent model.
*
* @return string
*/
public function getMorphClass()
{
}
}
class MorphMany extends \Illuminate\Database\Eloquent\Relations\MorphOneOrMany
{
/**
* Get the results of the relationship.
*
* @return mixed
*/
public function getResults()
{
}
/**
* Initialize the relation on a set of models.
*
* @param array $models
* @param string $relation
* @return array
*/
public function initRelation(array $models, $relation)
{
}
/**
* Match the eagerly loaded results to their parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public function match(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation)
{
}
}
class MorphTo extends \Illuminate\Database\Eloquent\Relations\BelongsTo
{
/**
* The type of the polymorphic relation.
*
* @var string
*/
protected $morphType;
/**
* The models whose relations are being eager loaded.
*
* @var \Illuminate\Database\Eloquent\Collection
*/
protected $models;
/**
* All of the models keyed by ID.
*
* @var array
*/
protected $dictionary = [];
/**
* A buffer of dynamic calls to query macros.
*
* @var array
*/
protected $macroBuffer = [];
/**
* Create a new morph to relationship instance.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @param \Illuminate\Database\Eloquent\Model $parent
* @param string $foreignKey
* @param string $otherKey
* @param string $type
* @param string $relation
* @return void
*/
public function __construct(\Illuminate\Database\Eloquent\Builder $query, \Illuminate\Database\Eloquent\Model $parent, $foreignKey, $otherKey, $type, $relation)
{
}
/**
* Get the results of the relationship.
*
* @return mixed
*/
public function getResults()
{
}
/**
* Set the constraints for an eager load of the relation.
*
* @param array $models
* @return void
*/
public function addEagerConstraints(array $models)
{
}
/**
* Build a dictionary with the models.
*
* @param \Illuminate\Database\Eloquent\Collection $models
* @return void
*/
protected function buildDictionary(\Illuminate\Database\Eloquent\Collection $models)
{
}
/**
* Match the eagerly loaded results to their parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public function match(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation)
{
}
/**
* Associate the model instance to the given parent.
*
* @param \Illuminate\Database\Eloquent\Model $model
* @return \Illuminate\Database\Eloquent\Model
*/
public function associate($model)
{
}
/**
* Dissociate previously associated model from the given parent.
*
* @return \Illuminate\Database\Eloquent\Model
*/
public function dissociate()
{
}
/**
* Get the results of the relationship.
*
* Called via eager load method of Eloquent query builder.
*
* @return mixed
*/
public function getEager()
{
}
/**
* Match the results for a given type to their parents.
*
* @param string $type
* @param \Illuminate\Database\Eloquent\Collection $results
* @return void
*/
protected function matchToMorphParents($type, \Illuminate\Database\Eloquent\Collection $results)
{
}
/**
* Get all of the relation results for a type.
*
* @param string $type
* @return \Illuminate\Database\Eloquent\Collection
*/
protected function getResultsByType($type)
{
}
/**
* Gather all of the foreign keys for a given type.
*
* @param string $type
* @return array
*/
protected function gatherKeysByType($type)
{
}
/**
* Create a new model instance by type.
*
* @param string $type
* @return \Illuminate\Database\Eloquent\Model
*/
public function createModelByType($type)
{
}
/**
* Get the foreign key "type" name.
*
* @return string
*/
public function getMorphType()
{
}
/**
* Get the dictionary used by the relationship.
*
* @return array
*/
public function getDictionary()
{
}
/**
* Replay stored macro calls on the actual related instance.
*
* @param \Illuminate\Database\Eloquent\Builder $query
* @return \Illuminate\Database\Eloquent\Builder
*/
protected function replayMacros(\Illuminate\Database\Eloquent\Builder $query)
{
}
/**
* Handle dynamic method calls to the relationship.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public function __call($method, $parameters)
{
}
}
class MorphOne extends \Illuminate\Database\Eloquent\Relations\MorphOneOrMany
{
/**
* Get the results of the relationship.
*
* @return mixed
*/
public function getResults()
{
}
/**
* Initialize the relation on a set of models.
*
* @param array $models
* @param string $relation
* @return array
*/
public function initRelation(array $models, $relation)
{
}
/**
* Match the eagerly loaded results to their parents.
*
* @param array $models
* @param \Illuminate\Database\Eloquent\Collection $results
* @param string $relation
* @return array
*/
public function match(array $models, \Illuminate\Database\Eloquent\Collection $results, $relation)
{
}
}
}
namespace Illuminate\Database {
interface ConnectionResolverInterface
{
/**
* Get a database connection instance.
*
* @param string $name
* @return \Illuminate\Database\ConnectionInterface
*/
public function connection($name = null);
/**
* Get the default connection name.
*
* @return string
*/
public function getDefaultConnection();
/**
* Set the default connection name.
*
* @param string $name
* @return void
*/
public function setDefaultConnection($name);
}
class DatabaseManager implements \Illuminate\Database\ConnectionResolverInterface
{
/**
* The application instance.
*
* @var \Illuminate\Foundation\Application
*/
protected $app;
/**
* The database connection factory instance.
*
* @var \Illuminate\Database\Connectors\ConnectionFactory
*/
protected $factory;
/**
* The active connection instances.
*
* @var array
*/
protected $connections = [];
/**
* The custom connection resolvers.
*
* @var array
*/
protected $extensions = [];
/**
* Create a new database manager instance.
*
* @param \Illuminate\Foundation\Application $app
* @param \Illuminate\Database\Connectors\ConnectionFactory $factory
* @return void
*/
public function __construct($app, \Illuminate\Database\Connectors\ConnectionFactory $factory)
{
}
/**
* Get a database connection instance.
*
* @param string $name
* @return \Illuminate\Database\Connection
*/
public function connection($name = null)
{
}
/**
* Parse the connection into an array of the name and read / write type.
*
* @param string $name
* @return array
*/
protected function parseConnectionName($name)
{
}
/**
* Disconnect from the given database and remove from local cache.
*
* @param string $name
* @return void
*/
public function purge($name = null)
{
}
/**
* Disconnect from the given database.
*
* @param string $name
* @return void
*/
public function disconnect($name = null)
{
}
/**
* Reconnect to the given database.
*
* @param string $name
* @return \Illuminate\Database\Connection
*/
public function reconnect($name = null)
{
}
/**
* Refresh the PDO connections on a given connection.
*
* @param string $name
* @return \Illuminate\Database\Connection
*/
protected function refreshPdoConnections($name)
{
}
/**
* Make the database connection instance.
*
* @param string $name
* @return \Illuminate\Database\Connection
*/
protected function makeConnection($name)
{
}
/**
* Prepare the database connection instance.
*
* @param \Illuminate\Database\Connection $connection
* @return \Illuminate\Database\Connection
*/
protected function prepare(\Illuminate\Database\Connection $connection)
{
}
/**
* Prepare the read write mode for database connection instance.
*
* @param \Illuminate\Database\Connection $connection
* @param string $type
* @return \Illuminate\Database\Connection
*/
protected function setPdoForType(\Illuminate\Database\Connection $connection, $type = null)
{
}
/**
* Get the configuration for a connection.
*
* @param string $name
* @return array
*
* @throws \InvalidArgumentException
*/
protected function getConfig($name)
{
}
/**
* Get the default connection name.
*
* @return string
*/
public function getDefaultConnection()
{
}
/**
* Set the default connection name.
*
* @param string $name
* @return void
*/
public function setDefaultConnection($name)
{
}
/**
* Get all of the support drivers.
*
* @return array
*/
public function supportedDrivers()
{
}
/**
* Get all of the drivers that are actually available.
*
* @return array
*/
public function availableDrivers()
{
}
/**
* Register an extension connection resolver.
*
* @param string $name
* @param callable $resolver
* @return void
*/
public function extend($name, callable $resolver)
{
}
/**
* Return all of the created connections.
*
* @return array
*/
public function getConnections()
{
}
/**
* Dynamically pass methods to the default connection.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public function __call($method, $parameters)
{
}
}
}
namespace Illuminate\Database\Migrations {
class MigrationCreator
{
/**
* The filesystem instance.
*
* @var \Illuminate\Filesystem\Filesystem
*/
protected $files;
/**
* The registered post create hooks.
*
* @var array
*/
protected $postCreate = [];
/**
* Create a new migration creator instance.
*
* @param \Illuminate\Filesystem\Filesystem $files
* @return void
*/
public function __construct(\Illuminate\Filesystem\Filesystem $files)
{
}
/**
* Create a new migration at the given path.
*
* @param string $name
* @param string $path
* @param string $table
* @param bool $create
* @return string
*/
public function create($name, $path, $table = null, $create = false)
{
}
/**
* Get the migration stub file.
*
* @param string $table
* @param bool $create
* @return string
*/
protected function getStub($table, $create)
{
}
/**
* Populate the place-holders in the migration stub.
*
* @param string $name
* @param string $stub
* @param string $table
* @return string
*/
protected function populateStub($name, $stub, $table)
{
}
/**
* Get the class name of a migration name.
*
* @param string $name
* @return string
*/
protected function getClassName($name)
{
}
/**
* Fire the registered post create hooks.
*
* @return void
*/
protected function firePostCreateHooks()
{
}
/**
* Register a post migration create hook.
*
* @param \Closure $callback
* @return void
*/
public function afterCreate(\Closure $callback)
{
}
/**
* Get the full path name to the migration.
*
* @param string $name
* @param string $path
* @return string
*/
protected function getPath($name, $path)
{
}
/**
* Get the date prefix for the migration.
*
* @return string
*/
protected function getDatePrefix()
{
}
/**
* Get the path to the stubs.
*
* @return string
*/
public function getStubPath()
{
}
/**
* Get the filesystem instance.
*
* @return \Illuminate\Filesystem\Filesystem
*/
public function getFilesystem()
{
}
}
interface MigrationRepositoryInterface
{
/**
* Get the ran migrations for a given package.
*
* @return array
*/
public function getRan();
/**
* Get the last migration batch.
*
* @return array
*/
public function getLast();
/**
* Log that a migration was run.
*
* @param string $file
* @param int $batch
* @return void
*/
public function log($file, $batch);
/**
* Remove a migration from the log.
*
* @param object $migration
* @return void
*/
public function delete($migration);
/**
* Get the next migration batch number.
*
* @return int
*/
public function getNextBatchNumber();
/**
* Create the migration repository data store.
*
* @return void
*/
public function createRepository();
/**
* Determine if the migration repository exists.
*
* @return bool
*/
public function repositoryExists();
/**
* Set the information source to gather data.
*
* @param string $name
* @return void
*/
public function setSource($name);
}
class DatabaseMigrationRepository implements \Illuminate\Database\Migrations\MigrationRepositoryInterface
{
/**
* The database connection resolver instance.
*
* @var \Illuminate\Database\ConnectionResolverInterface
*/
protected $resolver;
/**
* The name of the migration table.
*
* @var string
*/
protected $table;
/**
* The name of the database connection to use.
*
* @var string
*/
protected $connection;
/**
* Create a new database migration repository instance.
*
* @param \Illuminate\Database\ConnectionResolverInterface $resolver
* @param string $table
* @return void
*/
public function __construct(\Illuminate\Database\ConnectionResolverInterface $resolver, $table)
{
}
/**
* Get the ran migrations.
*
* @return array
*/
public function getRan()
{
}
/**
* Get the last migration batch.
*
* @return array
*/
public function getLast()
{
}
/**
* Log that a migration was run.
*
* @param string $file
* @param int $batch
* @return void
*/
public function log($file, $batch)
{
}
/**
* Remove a migration from the log.
*
* @param object $migration
* @return void
*/
public function delete($migration)
{
}
/**
* Get the next migration batch number.
*
* @return int
*/
public function getNextBatchNumber()
{
}
/**
* Get the last migration batch number.
*
* @return int
*/
public function getLastBatchNumber()
{
}
/**
* Create the migration repository data store.
*
* @return void
*/
public function createRepository()
{
}
/**
* Determine if the migration repository exists.
*
* @return bool
*/
public function repositoryExists()
{
}
/**
* Get a query builder for the migration table.
*
* @return \Illuminate\Database\Query\Builder
*/
protected function table()
{
}
/**
* Get the connection resolver instance.
*
* @return \Illuminate\Database\ConnectionResolverInterface
*/
public function getConnectionResolver()
{
}
/**
* Resolve the database connection instance.
*
* @return \Illuminate\Database\Connection
*/
public function getConnection()
{
}
/**
* Set the information source to gather data.
*
* @param string $name
* @return void
*/
public function setSource($name)
{
}
}
abstract class Migration
{
/**
* The name of the database connection to use.
*
* @var string
*/
protected $connection;
/**
* Get the migration connection name.
*
* @return string
*/
public function getConnection()
{
}
}
class Migrator
{
/**
* The migration repository implementation.
*
* @var \Illuminate\Database\Migrations\MigrationRepositoryInterface
*/
protected $repository;
/**
* The filesystem instance.
*
* @var \Illuminate\Filesystem\Filesystem
*/
protected $files;
/**
* The connection resolver instance.
*
* @var \Illuminate\Database\ConnectionResolverInterface
*/
protected $resolver;
/**
* The name of the default connection.
*
* @var string
*/
protected $connection;
/**
* The notes for the current operation.
*
* @var array
*/
protected $notes = [];
/**
* Create a new migrator instance.
*
* @param \Illuminate\Database\Migrations\MigrationRepositoryInterface $repository
* @param \Illuminate\Database\ConnectionResolverInterface $resolver
* @param \Illuminate\Filesystem\Filesystem $files
* @return void
*/
public function __construct(\Illuminate\Database\Migrations\MigrationRepositoryInterface $repository, \Illuminate\Database\ConnectionResolverInterface $resolver, \Illuminate\Filesystem\Filesystem $files)
{
}
/**
* Run the outstanding migrations at a given path.
*
* @param string $path
* @param array $options
* @return void
*/
public function run($path, array $options = [])
{
}
/**
* Run an array of migrations.
*
* @param array $migrations
* @param array $options
* @return void
*/
public function runMigrationList($migrations, array $options = [])
{
}
/**
* Run "up" a migration instance.
*
* @param string $file
* @param int $batch
* @param bool $pretend
* @return void
*/
protected function runUp($file, $batch, $pretend)
{
}
/**
* Rollback the last migration operation.
*
* @param bool $pretend
* @return int
*/
public function rollback($pretend = false)
{
}
/**
* Rolls all of the currently applied migrations back.
*
* @param bool $pretend
* @return int
*/
public function reset($pretend = false)
{
}
/**
* Run "down" a migration instance.
*
* @param object $migration
* @param bool $pretend
* @return void
*/
protected function runDown($migration, $pretend)
{
}
/**
* Get all of the migration files in a given path.
*
* @param string $path
* @return array
*/
public function getMigrationFiles($path)
{
}
/**
* Require in all the migration files in a given path.
*
* @param string $path
* @param array $files
* @return void
*/
public function requireFiles($path, array $files)
{
}
/**
* Pretend to run the migrations.
*
* @param object $migration
* @param string $method
* @return void
*/
protected function pretendToRun($migration, $method)
{
}
/**
* Get all of the queries that would be run for a migration.
*
* @param object $migration
* @param string $method
* @return array
*/
protected function getQueries($migration, $method)
{
}
/**
* Resolve a migration instance from a file.
*
* @param string $file
* @return object
*/
public function resolve($file)
{
}
/**
* Raise a note event for the migrator.
*
* @param string $message
* @return void
*/
protected function note($message)
{
}
/**
* Get the notes for the last operation.
*
* @return array
*/
public function getNotes()
{
}
/**
* Resolve the database connection instance.
*
* @param string $connection
* @return \Illuminate\Database\Connection
*/
public function resolveConnection($connection)
{
}
/**
* Set the default connection name.
*
* @param string $name
* @return void
*/
public function setConnection($name)
{
}
/**
* Get the migration repository instance.
*
* @return \Illuminate\Database\Migrations\MigrationRepositoryInterface
*/
public function getRepository()
{
}
/**
* Determine if the migration repository exists.
*
* @return bool
*/
public function repositoryExists()
{
}
/**
* Get the file system instance.
*
* @return \Illuminate\Filesystem\Filesystem
*/
public function getFilesystem()
{
}
}
}
namespace Illuminate\Console {
class Command extends \Symfony\Component\Console\Command\Command
{
/**
* The Laravel application instance.
*
* @var \Illuminate\Contracts\Foundation\Application
*/
protected $laravel;
/**
* The input interface implementation.
*
* @var \Symfony\Component\Console\Input\InputInterface
*/
protected $input;
/**
* The output interface implementation.
*
* @var \Illuminate\Console\OutputStyle
*/
protected $output;
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature;
/**
* The console command name.
*
* @var string
*/
protected $name;
/**
* The console command description.
*
* @var string
*/
protected $description;
/**
* The default verbosity of output commands.
*
* @var int
*/
protected $verbosity = \Symfony\Component\Console\Output\OutputInterface::VERBOSITY_NORMAL;
/**
* The mapping between human readable verbosity levels and Symfony's OutputInterface.
*
* @var array
*/
protected $verbosityMap = ['v' => \Symfony\Component\Console\Output\OutputInterface::VERBOSITY_VERBOSE, 'vv' => \Symfony\Component\Console\Output\OutputInterface::VERBOSITY_VERY_VERBOSE, 'vvv' => \Symfony\Component\Console\Output\OutputInterface::VERBOSITY_DEBUG, 'quiet' => \Symfony\Component\Console\Output\OutputInterface::VERBOSITY_QUIET, 'normal' => \Symfony\Component\Console\Output\OutputInterface::VERBOSITY_NORMAL];
/**
* Create a new console command instance.
*
* @return void
*/
public function __construct()
{
}
/**
* Configure the console command using a fluent definition.
*
* @return void
*/
protected function configureUsingFluentDefinition()
{
}
/**
* Specify the arguments and options on the command.
*
* @return void
*/
protected function specifyParameters()
{
}
/**
* Run the console command.
*
* @param \Symfony\Component\Console\Input\InputInterface $input
* @param \Symfony\Component\Console\Output\OutputInterface $output
* @return int
*/
public function run(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* Execute the console command.
*
* @param \Symfony\Component\Console\Input\InputInterface $input
* @param \Symfony\Component\Console\Output\OutputInterface $output
* @return mixed
*/
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* Call another console command.
*
* @param string $command
* @param array $arguments
* @return int
*/
public function call($command, array $arguments = [])
{
}
/**
* Call another console command silently.
*
* @param string $command
* @param array $arguments
* @return int
*/
public function callSilent($command, array $arguments = [])
{
}
/**
* Determine if the given argument is present.
*
* @param string|int $name
* @return bool
*/
public function hasArgument($name)
{
}
/**
* Get the value of a command argument.
*
* @param string $key
* @return string|array
*/
public function argument($key = null)
{
}
/**
* Determine if the given option is present.
*
* @param string $name
* @return bool
*/
public function hasOption($name)
{
}
/**
* Get the value of a command option.
*
* @param string $key
* @return string|array
*/
public function option($key = null)
{
}
/**
* Confirm a question with the user.
*
* @param string $question
* @param bool $default
* @return bool
*/
public function confirm($question, $default = false)
{
}
/**
* Prompt the user for input.
*
* @param string $question
* @param string $default
* @return string
*/
public function ask($question, $default = null)
{
}
/**
* Prompt the user for input with auto completion.
*
* @param string $question
* @param array $choices
* @param string $default
* @return string
*/
public function anticipate($question, array $choices, $default = null)
{
}
/**
* Prompt the user for input with auto completion.
*
* @param string $question
* @param array $choices
* @param string $default
* @return string
*/
public function askWithCompletion($question, array $choices, $default = null)
{
}
/**
* Prompt the user for input but hide the answer from the console.
*
* @param string $question
* @param bool $fallback
* @return string
*/
public function secret($question, $fallback = true)
{
}
/**
* Give the user a single choice from an array of answers.
*
* @param string $question
* @param array $choices
* @param string $default
* @param mixed $attempts
* @param bool $multiple
* @return string
*/
public function choice($question, array $choices, $default = null, $attempts = null, $multiple = null)
{
}
/**
* Format input to textual table.
*
* @param array $headers
* @param \Illuminate\Contracts\Support\Arrayable|array $rows
* @param string $style
* @return void
*/
public function table(array $headers, $rows, $style = 'default')
{
}
/**
* Write a string as information output.
*
* @param string $string
* @param null|int|string $verbosity
* @return void
*/
public function info($string, $verbosity = null)
{
}
/**
* Write a string as standard output.
*
* @param string $string
* @param string $style
* @param null|int|string $verbosity
* @return void
*/
public function line($string, $style = null, $verbosity = null)
{
}
/**
* Write a string as comment output.
*
* @param string $string
* @param null|int|string $verbosity
* @return void
*/
public function comment($string, $verbosity = null)
{
}
/**
* Write a string as question output.
*
* @param string $string
* @param null|int|string $verbosity
* @return void
*/
public function question($string, $verbosity = null)
{
}
/**
* Write a string as error output.
*
* @param string $string
* @param null|int|string $verbosity
* @return void
*/
public function error($string, $verbosity = null)
{
}
/**
* Write a string as warning output.
*
* @param string $string
* @param null|int|string $verbosity
* @return void
*/
public function warn($string, $verbosity = null)
{
}
/**
* Get the verbosity level in terms of Symfony's OutputInterface level.
*
* @param string|int $level
* @return int
*/
protected function parseVerbosity($level = null)
{
}
/**
* Set the verbosity level.
*
* @param string|int $level
* @return void
*/
protected function setVerbosity($level)
{
}
/**
* Get the console command arguments.
*
* @return array
*/
protected function getArguments()
{
}
/**
* Get the console command options.
*
* @return array
*/
protected function getOptions()
{
}
/**
* Get the output implementation.
*
* @return \Symfony\Component\Console\Output\OutputInterface
*/
public function getOutput()
{
}
/**
* Get the Laravel application instance.
*
* @return \Illuminate\Contracts\Foundation\Application
*/
public function getLaravel()
{
}
/**
* Set the Laravel application instance.
*
* @param \Illuminate\Contracts\Container\Container $laravel
* @return void
*/
public function setLaravel($laravel)
{
}
}
trait ConfirmableTrait
{
/**
* Confirm before proceeding with the action.
*
* @param string $warning
* @param \Closure|bool|null $callback
* @return bool
*/
public function confirmToProceed($warning = 'Application In Production!', $callback = null)
{
}
/**
* Get the default confirmation callback.
*
* @return \Closure
*/
protected function getDefaultConfirmCallback()
{
}
}
}
namespace Illuminate\Database\Console\Seeds {
class SeedCommand extends \Illuminate\Console\Command
{
use \Illuminate\Console\ConfirmableTrait;
/**
* The console command name.
*
* @var string
*/
protected $name = 'db:seed';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Seed the database with records';
/**
* The connection resolver instance.
*
* @var \Illuminate\Database\ConnectionResolverInterface
*/
protected $resolver;
/**
* Create a new database seed command instance.
*
* @param \Illuminate\Database\ConnectionResolverInterface $resolver
* @return void
*/
public function __construct(\Illuminate\Database\ConnectionResolverInterface $resolver)
{
}
/**
* Execute the console command.
*
* @return void
*/
public function fire()
{
}
/**
* Get a seeder instance from the container.
*
* @return \Illuminate\Database\Seeder
*/
protected function getSeeder()
{
}
/**
* Get the name of the database connection to use.
*
* @return string
*/
protected function getDatabase()
{
}
/**
* Get the console command options.
*
* @return array
*/
protected function getOptions()
{
}
}
}
namespace Illuminate\Console {
abstract class GeneratorCommand extends \Illuminate\Console\Command
{
/**
* The filesystem instance.
*
* @var \Illuminate\Filesystem\Filesystem
*/
protected $files;
/**
* The type of class being generated.
*
* @var string
*/
protected $type;
/**
* Create a new controller creator command instance.
*
* @param \Illuminate\Filesystem\Filesystem $files
* @return void
*/
public function __construct(\Illuminate\Filesystem\Filesystem $files)
{
}
/**
* Get the stub file for the generator.
*
* @return string
*/
protected abstract function getStub();
/**
* Execute the console command.
*
* @return bool|null
*/
public function fire()
{
}
/**
* Determine if the class already exists.
*
* @param string $rawName
* @return bool
*/
protected function alreadyExists($rawName)
{
}
/**
* Get the destination class path.
*
* @param string $name
* @return string
*/
protected function getPath($name)
{
}
/**
* Parse the name and format according to the root namespace.
*
* @param string $name
* @return string
*/
protected function parseName($name)
{
}
/**
* Get the default namespace for the class.
*
* @param string $rootNamespace
* @return string
*/
protected function getDefaultNamespace($rootNamespace)
{
}
/**
* Build the directory for the class if necessary.
*
* @param string $path
* @return string
*/
protected function makeDirectory($path)
{
}
/**
* Build the class with the given name.
*
* @param string $name
* @return string
*/
protected function buildClass($name)
{
}
/**
* Replace the namespace for the given stub.
*
* @param string $stub
* @param string $name
* @return $this
*/
protected function replaceNamespace(&$stub, $name)
{
}
/**
* Get the full namespace name for a given class.
*
* @param string $name
* @return string
*/
protected function getNamespace($name)
{
}
/**
* Replace the class name for the given stub.
*
* @param string $stub
* @param string $name
* @return string
*/
protected function replaceClass($stub, $name)
{
}
/**
* Get the desired class name from the input.
*
* @return string
*/
protected function getNameInput()
{
}
/**
* Get the console command arguments.
*
* @return array
*/
protected function getArguments()
{
}
}
}
namespace Illuminate\Database\Console\Seeds {
class SeederMakeCommand extends \Illuminate\Console\GeneratorCommand
{
/**
* The console command name.
*
* @var string
*/
protected $name = 'make:seeder';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Create a new seeder class';
/**
* The type of class being generated.
*
* @var string
*/
protected $type = 'Seeder';
/**
* The Composer instance.
*
* @var \Illuminate\Support\Composer
*/
protected $composer;
/**
* Create a new command instance.
*
* @param \Illuminate\Filesystem\Filesystem $files
* @param \Illuminate\Support\Composer $composer
* @return void
*/
public function __construct(\Illuminate\Filesystem\Filesystem $files, \Illuminate\Support\Composer $composer)
{
}
/**
* Execute the console command.
*
* @return void
*/
public function fire()
{
}
/**
* Get the stub file for the generator.
*
* @return string
*/
protected function getStub()
{
}
/**
* Get the destination class path.
*
* @param string $name
* @return string
*/
protected function getPath($name)
{
}
/**
* Parse the name and format according to the root namespace.
*
* @param string $name
* @return string
*/
protected function parseName($name)
{
}
}
}
namespace Illuminate\Database\Console\Migrations {
class BaseCommand extends \Illuminate\Console\Command
{
/**
* Get the path to the migration directory.
*
* @return string
*/
protected function getMigrationPath()
{
}
}
class StatusCommand extends \Illuminate\Database\Console\Migrations\BaseCommand
{
/**
* The console command name.
*
* @var string
*/
protected $name = 'migrate:status';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Show the status of each migration';
/**
* The migrator instance.
*
* @var \Illuminate\Database\Migrations\Migrator
*/
protected $migrator;
/**
* Create a new migration rollback command instance.
*
* @param \Illuminate\Database\Migrations\Migrator $migrator
* @return \Illuminate\Database\Console\Migrations\StatusCommand
*/
public function __construct(\Illuminate\Database\Migrations\Migrator $migrator)
{
}
/**
* Execute the console command.
*
* @return void
*/
public function fire()
{
}
/**
* Get all of the migration files.
*
* @param string $path
* @return array
*/
protected function getAllMigrationFiles($path)
{
}
/**
* Get the console command options.
*
* @return array
*/
protected function getOptions()
{
}
}
class RefreshCommand extends \Illuminate\Console\Command
{
use \Illuminate\Console\ConfirmableTrait;
/**
* The console command name.
*
* @var string
*/
protected $name = 'migrate:refresh';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Reset and re-run all migrations';
/**
* Execute the console command.
*
* @return void
*/
public function fire()
{
}
/**
* Determine if the developer has requested database seeding.
*
* @return bool
*/
protected function needsSeeding()
{
}
/**
* Run the database seeder command.
*
* @param string $database
* @return void
*/
protected function runSeeder($database)
{
}
/**
* Get the console command options.
*
* @return array
*/
protected function getOptions()
{
}
}
class MigrateMakeCommand extends \Illuminate\Database\Console\Migrations\BaseCommand
{
/**
* The console command signature.
*
* @var string
*/
protected $signature = 'make:migration {name : The name of the migration.}
{--create= : The table to be created.}
{--table= : The table to migrate.}
{--path= : The location where the migration file should be created.}';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Create a new migration file';
/**
* The migration creator instance.
*
* @var \Illuminate\Database\Migrations\MigrationCreator
*/
protected $creator;
/**
* The Composer instance.
*
* @var \Illuminate\Support\Composer
*/
protected $composer;
/**
* Create a new migration install command instance.
*
* @param \Illuminate\Database\Migrations\MigrationCreator $creator
* @param \Illuminate\Support\Composer $composer
* @return void
*/
public function __construct(\Illuminate\Database\Migrations\MigrationCreator $creator, \Illuminate\Support\Composer $composer)
{
}
/**
* Execute the console command.
*
* @return void
*/
public function fire()
{
}
/**
* Write the migration file to disk.
*
* @param string $name
* @param string $table
* @param bool $create
* @return string
*/
protected function writeMigration($name, $table, $create)
{
}
/**
* Get migration path (either specified by '--path' option or default location).
*
* @return string
*/
protected function getMigrationPath()
{
}
}
class InstallCommand extends \Illuminate\Console\Command
{
/**
* The console command name.
*
* @var string
*/
protected $name = 'migrate:install';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Create the migration repository';
/**
* The repository instance.
*
* @var \Illuminate\Database\Migrations\MigrationRepositoryInterface
*/
protected $repository;
/**
* Create a new migration install command instance.
*
* @param \Illuminate\Database\Migrations\MigrationRepositoryInterface $repository
* @return void
*/
public function __construct(\Illuminate\Database\Migrations\MigrationRepositoryInterface $repository)
{
}
/**
* Execute the console command.
*
* @return void
*/
public function fire()
{
}
/**
* Get the console command options.
*
* @return array
*/
protected function getOptions()
{
}
}
class MigrateCommand extends \Illuminate\Database\Console\Migrations\BaseCommand
{
use \Illuminate\Console\ConfirmableTrait;
/**
* The console command name.
*
* @var string
*/
protected $name = 'migrate';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Run the database migrations';
/**
* The migrator instance.
*
* @var \Illuminate\Database\Migrations\Migrator
*/
protected $migrator;
/**
* Create a new migration command instance.
*
* @param \Illuminate\Database\Migrations\Migrator $migrator
* @return void
*/
public function __construct(\Illuminate\Database\Migrations\Migrator $migrator)
{
}
/**
* Execute the console command.
*
* @return void
*/
public function fire()
{
}
/**
* Prepare the migration database for running.
*
* @return void
*/
protected function prepareDatabase()
{
}
/**
* Get the console command options.
*
* @return array
*/
protected function getOptions()
{
}
}
class ResetCommand extends \Illuminate\Console\Command
{
use \Illuminate\Console\ConfirmableTrait;
/**
* The console command name.
*
* @var string
*/
protected $name = 'migrate:reset';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Rollback all database migrations';
/**
* The migrator instance.
*
* @var \Illuminate\Database\Migrations\Migrator
*/
protected $migrator;
/**
* Create a new migration rollback command instance.
*
* @param \Illuminate\Database\Migrations\Migrator $migrator
* @return void
*/
public function __construct(\Illuminate\Database\Migrations\Migrator $migrator)
{
}
/**
* Execute the console command.
*
* @return void
*/
public function fire()
{
}
/**
* Get the console command options.
*
* @return array
*/
protected function getOptions()
{
}
}
class RollbackCommand extends \Illuminate\Console\Command
{
use \Illuminate\Console\ConfirmableTrait;
/**
* The console command name.
*
* @var string
*/
protected $name = 'migrate:rollback';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Rollback the last database migration';
/**
* The migrator instance.
*
* @var \Illuminate\Database\Migrations\Migrator
*/
protected $migrator;
/**
* Create a new migration rollback command instance.
*
* @param \Illuminate\Database\Migrations\Migrator $migrator
* @return void
*/
public function __construct(\Illuminate\Database\Migrations\Migrator $migrator)
{
}
/**
* Execute the console command.
*
* @return void
*/
public function fire()
{
}
/**
* Get the console command options.
*
* @return array
*/
protected function getOptions()
{
}
}
}
namespace Illuminate\Database\Events {
class QueryExecuted
{
/**
* The SQL query that was executed.
*
* @var string
*/
public $sql;
/**
* The array of query bindings.
*
* @var array
*/
public $bindings;
/**
* The number of milliseconds it took to execute the query.
*
* @var float
*/
public $time;
/**
* The databse connection instance.
*
* @var \Illuminate\Database\Connection
*/
public $connection;
/**
* The database connection name.
*
* @var string
*/
public $connectionName;
/**
* Create a new event instance.
*
* @param string $sql
* @param array $bindings
* @param float $time
* @param
*/
public function __construct($sql, $bindings, $time, $connection)
{
}
}
abstract class ConnectionEvent
{
/**
* The name of the connection.
*
* @var string
*/
public $connectionName;
/**
* The database connection instance.
*
* @var \Illuminate\Database\Connection
*/
public $connection;
/**
* Create a new event instance.
*
* @param \Illuminate\Database\Connection $connection
* @return void
*/
public function __construct($connection)
{
}
}
class TransactionCommitted extends \Illuminate\Database\Events\ConnectionEvent
{
//
}
class TransactionBeginning extends \Illuminate\Database\Events\ConnectionEvent
{
//
}
class TransactionRolledBack extends \Illuminate\Database\Events\ConnectionEvent
{
//
}
}
namespace Illuminate\Database {
class SQLiteConnection extends \Illuminate\Database\Connection
{
/**
* Get the default query grammar instance.
*
* @return \Illuminate\Database\Query\Grammars\SQLiteGrammar
*/
protected function getDefaultQueryGrammar()
{
}
/**
* Get the default schema grammar instance.
*
* @return \Illuminate\Database\Schema\Grammars\SQLiteGrammar
*/
protected function getDefaultSchemaGrammar()
{
}
/**
* Get the default post processor instance.
*
* @return \Illuminate\Database\Query\Processors\SQLiteProcessor
*/
protected function getDefaultPostProcessor()
{
}
/**
* Get the Doctrine DBAL driver.
*
* @return \Doctrine\DBAL\Driver\PDOSqlite\Driver
*/
protected function getDoctrineDriver()
{
}
}
class PostgresConnection extends \Illuminate\Database\Connection
{
/**
* Get a schema builder instance for the connection.
*
* @return \Illuminate\Database\Schema\PostgresBuilder
*/
public function getSchemaBuilder()
{
}
/**
* Get the default query grammar instance.
*
* @return \Illuminate\Database\Query\Grammars\PostgresGrammar
*/
protected function getDefaultQueryGrammar()
{
}
/**
* Get the default schema grammar instance.
*
* @return \Illuminate\Database\Schema\Grammars\PostgresGrammar
*/
protected function getDefaultSchemaGrammar()
{
}
/**
* Get the default post processor instance.
*
* @return \Illuminate\Database\Query\Processors\PostgresProcessor
*/
protected function getDefaultPostProcessor()
{
}
/**
* Get the Doctrine DBAL driver.
*
* @return \Doctrine\DBAL\Driver\PDOPgSql\Driver
*/
protected function getDoctrineDriver()
{
}
}
}
namespace Illuminate\Database\Connectors {
interface ConnectorInterface
{
/**
* Establish a database connection.
*
* @param array $config
* @return \PDO
*/
public function connect(array $config);
}
class Connector
{
use \Illuminate\Database\DetectsLostConnections;
/**
* The default PDO connection options.
*
* @var array
*/
protected $options = [\PDO::ATTR_CASE => \PDO::CASE_NATURAL, \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION, \PDO::ATTR_ORACLE_NULLS => \PDO::NULL_NATURAL, \PDO::ATTR_STRINGIFY_FETCHES => false, \PDO::ATTR_EMULATE_PREPARES => false];
/**
* Get the PDO options based on the configuration.
*
* @param array $config
* @return array
*/
public function getOptions(array $config)
{
}
/**
* Create a new PDO connection.
*
* @param string $dsn
* @param array $config
* @param array $options
* @return \PDO
*/
public function createConnection($dsn, array $config, array $options)
{
}
/**
* Get the default PDO connection options.
*
* @return array
*/
public function getDefaultOptions()
{
}
/**
* Set the default PDO connection options.
*
* @param array $options
* @return void
*/
public function setDefaultOptions(array $options)
{
}
/**
* Handle a exception that occurred during connect execution.
*
* @param \Exception $e
* @param string $dsn
* @param string $username
* @param string $password
* @param array $options
* @return \PDO
*
* @throws \Exception
*/
protected function tryAgainIfCausedByLostConnection(\Exception $e, $dsn, $username, $password, $options)
{
}
}
class MySqlConnector extends \Illuminate\Database\Connectors\Connector implements \Illuminate\Database\Connectors\ConnectorInterface
{
/**
* Establish a database connection.
*
* @param array $config
* @return \PDO
*/
public function connect(array $config)
{
}
/**
* Create a DSN string from a configuration.
*
* Chooses socket or host/port based on the 'unix_socket' config value.
*
* @param array $config
* @return string
*/
protected function getDsn(array $config)
{
}
/**
* Determine if the given configuration array has a UNIX socket value.
*
* @param array $config
* @return bool
*/
protected function configHasSocket(array $config)
{
}
/**
* Get the DSN string for a socket configuration.
*
* @param array $config
* @return string
*/
protected function getSocketDsn(array $config)
{
}
/**
* Get the DSN string for a host / port configuration.
*
* @param array $config
* @return string
*/
protected function getHostDsn(array $config)
{
}
/**
* Set the modes for the connection.
*
* @param \PDO $connection
* @param array $config
* @return void
*/
protected function setModes(\PDO $connection, array $config)
{
}
}
class SQLiteConnector extends \Illuminate\Database\Connectors\Connector implements \Illuminate\Database\Connectors\ConnectorInterface
{
/**
* Establish a database connection.
*
* @param array $config
* @return \PDO
*
* @throws \InvalidArgumentException
*/
public function connect(array $config)
{
}
}
class SqlServerConnector extends \Illuminate\Database\Connectors\Connector implements \Illuminate\Database\Connectors\ConnectorInterface
{
/**
* The PDO connection options.
*
* @var array
*/
protected $options = [\PDO::ATTR_CASE => \PDO::CASE_NATURAL, \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION, \PDO::ATTR_ORACLE_NULLS => \PDO::NULL_NATURAL, \PDO::ATTR_STRINGIFY_FETCHES => false];
/**
* Establish a database connection.
*
* @param array $config
* @return \PDO
*/
public function connect(array $config)
{
}
/**
* Create a DSN string from a configuration.
*
* @param array $config
* @return string
*/
protected function getDsn(array $config)
{
}
/**
* Get the DSN string for a DbLib connection.
*
* @param array $config
* @return string
*/
protected function getDblibDsn(array $config)
{
}
/**
* Determine if the database configuration prefers ODBC.
*
* @param array $config
* @return bool
*/
protected function prefersOdbc(array $config)
{
}
/**
* Get the DSN string for an ODBC connection.
*
* @param array $config
* @return string
*/
protected function getOdbcDsn(array $config)
{
}
/**
* Get the DSN string for a SqlSrv connection.
*
* @param array $config
* @return string
*/
protected function getSqlSrvDsn(array $config)
{
}
/**
* Build a connection string from the given arguments.
*
* @param string $driver
* @param array $arguments
* @return string
*/
protected function buildConnectString($driver, array $arguments)
{
}
/**
* Build a host string from the given configuration.
*
* @param array $config
* @param string $separator
* @return string
*/
protected function buildHostString(array $config, $separator)
{
}
/**
* Get the available PDO drivers.
*
* @return array
*/
protected function getAvailableDrivers()
{
}
}
class PostgresConnector extends \Illuminate\Database\Connectors\Connector implements \Illuminate\Database\Connectors\ConnectorInterface
{
/**
* The default PDO connection options.
*
* @var array
*/
protected $options = [\PDO::ATTR_CASE => \PDO::CASE_NATURAL, \PDO::ATTR_ERRMODE => \PDO::ERRMODE_EXCEPTION, \PDO::ATTR_ORACLE_NULLS => \PDO::NULL_NATURAL, \PDO::ATTR_STRINGIFY_FETCHES => false];
/**
* Establish a database connection.
*
* @param array $config
* @return \PDO
*/
public function connect(array $config)
{
}
/**
* Create a DSN string from a configuration.
*
* @param array $config
* @return string
*/
protected function getDsn(array $config)
{
}
/**
* Format the schema for the DSN.
*
* @param array|string $schema
* @return string
*/
protected function formatSchema($schema)
{
}
}
class ConnectionFactory
{
/**
* The IoC container instance.
*
* @var \Illuminate\Contracts\Container\Container
*/
protected $container;
/**
* Create a new connection factory instance.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
public function __construct(\Illuminate\Contracts\Container\Container $container)
{
}
/**
* Establish a PDO connection based on the configuration.
*
* @param array $config
* @param string $name
* @return \Illuminate\Database\Connection
*/
public function make(array $config, $name = null)
{
}
/**
* Create a single database connection instance.
*
* @param array $config
* @return \Illuminate\Database\Connection
*/
protected function createSingleConnection(array $config)
{
}
/**
* Create a single database connection instance.
*
* @param array $config
* @return \Illuminate\Database\Connection
*/
protected function createReadWriteConnection(array $config)
{
}
/**
* Create a new PDO instance for reading.
*
* @param array $config
* @return \PDO
*/
protected function createReadPdo(array $config)
{
}
/**
* Get the read configuration for a read / write connection.
*
* @param array $config
* @return array
*/
protected function getReadConfig(array $config)
{
}
/**
* Get the read configuration for a read / write connection.
*
* @param array $config
* @return array
*/
protected function getWriteConfig(array $config)
{
}
/**
* Get a read / write level configuration.
*
* @param array $config
* @param string $type
* @return array
*/
protected function getReadWriteConfig(array $config, $type)
{
}
/**
* Merge a configuration for a read / write connection.
*
* @param array $config
* @param array $merge
* @return array
*/
protected function mergeReadWriteConfig(array $config, array $merge)
{
}
/**
* Parse and prepare the database configuration.
*
* @param array $config
* @param string $name
* @return array
*/
protected function parseConfig(array $config, $name)
{
}
/**
* Create a connector instance based on the configuration.
*
* @param array $config
* @return \Illuminate\Database\Connectors\ConnectorInterface
*
* @throws \InvalidArgumentException
*/
public function createConnector(array $config)
{
}
/**
* Create a new connection instance.
*
* @param string $driver
* @param \PDO|\Closure $connection
* @param string $database
* @param string $prefix
* @param array $config
* @return \Illuminate\Database\Connection
*
* @throws \InvalidArgumentException
*/
protected function createConnection($driver, $connection, $database, $prefix = '', array $config = [])
{
}
}
}
namespace Illuminate\Database {
class ConnectionResolver implements \Illuminate\Database\ConnectionResolverInterface
{
/**
* All of the registered connections.
*
* @var array
*/
protected $connections = [];
/**
* The default connection name.
*
* @var string
*/
protected $default;
/**
* Create a new connection resolver instance.
*
* @param array $connections
* @return void
*/
public function __construct(array $connections = [])
{
}
/**
* Get a database connection instance.
*
* @param string $name
* @return \Illuminate\Database\ConnectionInterface
*/
public function connection($name = null)
{
}
/**
* Add a connection to the resolver.
*
* @param string $name
* @param \Illuminate\Database\ConnectionInterface $connection
* @return void
*/
public function addConnection($name, \Illuminate\Database\ConnectionInterface $connection)
{
}
/**
* Check if a connection has been registered.
*
* @param string $name
* @return bool
*/
public function hasConnection($name)
{
}
/**
* Get the default connection name.
*
* @return string
*/
public function getDefaultConnection()
{
}
/**
* Set the default connection name.
*
* @param string $name
* @return void
*/
public function setDefaultConnection($name)
{
}
}
abstract class Seeder
{
/**
* The container instance.
*
* @var \Illuminate\Container\Container
*/
protected $container;
/**
* The console command instance.
*
* @var \Illuminate\Console\Command
*/
protected $command;
/**
* Run the database seeds.
*
* @return void
*/
public abstract function run();
/**
* Seed the given connection from the given path.
*
* @param string $class
* @return void
*/
public function call($class)
{
}
/**
* Resolve an instance of the given seeder class.
*
* @param string $class
* @return \Illuminate\Database\Seeder
*/
protected function resolve($class)
{
}
/**
* Set the IoC container instance.
*
* @param \Illuminate\Container\Container $container
* @return $this
*/
public function setContainer(\Illuminate\Container\Container $container)
{
}
/**
* Set the console command instance.
*
* @param \Illuminate\Console\Command $command
* @return $this
*/
public function setCommand(\Illuminate\Console\Command $command)
{
}
}
class SeedServiceProvider extends \Illuminate\Support\ServiceProvider
{
/**
* Indicates if loading of the provider is deferred.
*
* @var bool
*/
protected $defer = true;
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
}
/**
* Register the seed console command.
*
* @return void
*/
protected function registerSeedCommand()
{
}
/**
* Get the services provided by the provider.
*
* @return array
*/
public function provides()
{
}
}
class MigrationServiceProvider extends \Illuminate\Support\ServiceProvider
{
/**
* Indicates if loading of the provider is deferred.
*
* @var bool
*/
protected $defer = true;
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
}
/**
* Register the migration repository service.
*
* @return void
*/
protected function registerRepository()
{
}
/**
* Register the migrator service.
*
* @return void
*/
protected function registerMigrator()
{
}
/**
* Register the migration creator.
*
* @return void
*/
protected function registerCreator()
{
}
/**
* Register all of the migration commands.
*
* @return void
*/
protected function registerCommands()
{
}
/**
* Register the "migrate" migration command.
*
* @return void
*/
protected function registerMigrateCommand()
{
}
/**
* Register the "rollback" migration command.
*
* @return void
*/
protected function registerRollbackCommand()
{
}
/**
* Register the "reset" migration command.
*
* @return void
*/
protected function registerResetCommand()
{
}
/**
* Register the "refresh" migration command.
*
* @return void
*/
protected function registerRefreshCommand()
{
}
/**
* Register the "make" migration command.
*
* @return void
*/
protected function registerMakeCommand()
{
}
/**
* Register the "status" migration command.
*
* @return void
*/
protected function registerStatusCommand()
{
}
/**
* Register the "install" migration command.
*
* @return void
*/
protected function registerInstallCommand()
{
}
/**
* Get the services provided by the provider.
*
* @return array
*/
public function provides()
{
}
}
}
namespace Illuminate\Database\Query {
class Expression
{
/**
* The value of the expression.
*
* @var mixed
*/
protected $value;
/**
* Create a new raw query expression.
*
* @param mixed $value
* @return void
*/
public function __construct($value)
{
}
/**
* Get the value of the expression.
*
* @return mixed
*/
public function getValue()
{
}
/**
* Get the value of the expression.
*
* @return string
*/
public function __toString()
{
}
}
class JsonExpression extends \Illuminate\Database\Query\Expression
{
/**
* The value of the expression.
*
* @var mixed
*/
protected $value;
/**
* Create a new raw query expression.
*
* @param mixed $value
* @return void
*/
public function __construct($value)
{
}
/**
* Translate the given value into the appropriate JSON binding parameter.
*
* @param mixed $value
* @return string
*/
protected function getJsonBindingParameter($value)
{
}
/**
* Get the value of the expression.
*
* @return mixed
*/
public function getValue()
{
}
/**
* Get the value of the expression.
*
* @return string
*/
public function __toString()
{
}
}
}
namespace Illuminate\Database\Query\Processors {
class Processor
{
/**
* Process the results of a "select" query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $results
* @return array
*/
public function processSelect(\Illuminate\Database\Query\Builder $query, $results)
{
}
/**
* Process an "insert get ID" query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param string $sql
* @param array $values
* @param string $sequence
* @return int
*/
public function processInsertGetId(\Illuminate\Database\Query\Builder $query, $sql, $values, $sequence = null)
{
}
/**
* Process the results of a column listing query.
*
* @param array $results
* @return array
*/
public function processColumnListing($results)
{
}
}
class SqlServerProcessor extends \Illuminate\Database\Query\Processors\Processor
{
/**
* Process an "insert get ID" query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param string $sql
* @param array $values
* @param string $sequence
* @return int
*/
public function processInsertGetId(\Illuminate\Database\Query\Builder $query, $sql, $values, $sequence = null)
{
}
/**
* Process an "insert get ID" query for ODBC.
*
* @param \Illuminate\Database\Connection $connection
* @return int
*/
protected function processInsertGetIdForOdbc($connection)
{
}
/**
* Process the results of a column listing query.
*
* @param array $results
* @return array
*/
public function processColumnListing($results)
{
}
}
class SQLiteProcessor extends \Illuminate\Database\Query\Processors\Processor
{
/**
* Process the results of a column listing query.
*
* @param array $results
* @return array
*/
public function processColumnListing($results)
{
}
}
class PostgresProcessor extends \Illuminate\Database\Query\Processors\Processor
{
/**
* Process an "insert get ID" query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param string $sql
* @param array $values
* @param string $sequence
* @return int
*/
public function processInsertGetId(\Illuminate\Database\Query\Builder $query, $sql, $values, $sequence = null)
{
}
/**
* Process the results of a column listing query.
*
* @param array $results
* @return array
*/
public function processColumnListing($results)
{
}
}
class MySqlProcessor extends \Illuminate\Database\Query\Processors\Processor
{
/**
* Process the results of a column listing query.
*
* @param array $results
* @return array
*/
public function processColumnListing($results)
{
}
}
}
namespace Illuminate\Database\Query {
class Builder
{
use \Illuminate\Support\Traits\Macroable {
__call as macroCall;
}
/**
* The database connection instance.
*
* @var \Illuminate\Database\Connection
*/
protected $connection;
/**
* The database query grammar instance.
*
* @var \Illuminate\Database\Query\Grammars\Grammar
*/
protected $grammar;
/**
* The database query post processor instance.
*
* @var \Illuminate\Database\Query\Processors\Processor
*/
protected $processor;
/**
* The current query value bindings.
*
* @var array
*/
protected $bindings = ['select' => [], 'join' => [], 'where' => [], 'having' => [], 'order' => [], 'union' => []];
/**
* An aggregate function and column to be run.
*
* @var array
*/
public $aggregate;
/**
* The columns that should be returned.
*
* @var array
*/
public $columns;
/**
* Indicates if the query returns distinct results.
*
* @var bool
*/
public $distinct = false;
/**
* The table which the query is targeting.
*
* @var string
*/
public $from;
/**
* The table joins for the query.
*
* @var array
*/
public $joins;
/**
* The where constraints for the query.
*
* @var array
*/
public $wheres = [];
/**
* The groupings for the query.
*
* @var array
*/
public $groups;
/**
* The having constraints for the query.
*
* @var array
*/
public $havings;
/**
* The orderings for the query.
*
* @var array
*/
public $orders;
/**
* The maximum number of records to return.
*
* @var int
*/
public $limit;
/**
* The number of records to skip.
*
* @var int
*/
public $offset;
/**
* The query union statements.
*
* @var array
*/
public $unions;
/**
* The maximum number of union records to return.
*
* @var int
*/
public $unionLimit;
/**
* The number of union records to skip.
*
* @var int
*/
public $unionOffset;
/**
* The orderings for the union query.
*
* @var array
*/
public $unionOrders;
/**
* Indicates whether row locking is being used.
*
* @var string|bool
*/
public $lock;
/**
* The field backups currently in use.
*
* @var array
*/
protected $backups = [];
/**
* The binding backups currently in use.
*
* @var array
*/
protected $bindingBackups = [];
/**
* All of the available clause operators.
*
* @var array
*/
protected $operators = ['=', '<', '>', '<=', '>=', '<>', '!=', 'like', 'like binary', 'not like', 'between', 'ilike', '&', '|', '^', '<<', '>>', 'rlike', 'regexp', 'not regexp', '~', '~*', '!~', '!~*', 'similar to', 'not similar to'];
/**
* Whether use write pdo for select.
*
* @var bool
*/
protected $useWritePdo = false;
/**
* Create a new query builder instance.
*
* @param \Illuminate\Database\ConnectionInterface $connection
* @param \Illuminate\Database\Query\Grammars\Grammar $grammar
* @param \Illuminate\Database\Query\Processors\Processor $processor
* @return void
*/
public function __construct(\Illuminate\Database\ConnectionInterface $connection, \Illuminate\Database\Query\Grammars\Grammar $grammar = null, \Illuminate\Database\Query\Processors\Processor $processor = null)
{
}
/**
* Set the columns to be selected.
*
* @param array|mixed $columns
* @return $this
*/
public function select($columns = ['*'])
{
}
/**
* Add a new "raw" select expression to the query.
*
* @param string $expression
* @param array $bindings
* @return \Illuminate\Database\Query\Builder|static
*/
public function selectRaw($expression, array $bindings = [])
{
}
/**
* Add a subselect expression to the query.
*
* @param \Closure|\Illuminate\Database\Query\Builder|string $query
* @param string $as
* @return \Illuminate\Database\Query\Builder|static
*
* @throws \InvalidArgumentException
*/
public function selectSub($query, $as)
{
}
/**
* Add a new select column to the query.
*
* @param array|mixed $column
* @return $this
*/
public function addSelect($column)
{
}
/**
* Force the query to only return distinct results.
*
* @return $this
*/
public function distinct()
{
}
/**
* Set the table which the query is targeting.
*
* @param string $table
* @return $this
*/
public function from($table)
{
}
/**
* Add a join clause to the query.
*
* @param string $table
* @param string $one
* @param string $operator
* @param string $two
* @param string $type
* @param bool $where
* @return $this
*/
public function join($table, $one, $operator = null, $two = null, $type = 'inner', $where = false)
{
}
/**
* Add a "join where" clause to the query.
*
* @param string $table
* @param string $one
* @param string $operator
* @param string $two
* @param string $type
* @return \Illuminate\Database\Query\Builder|static
*/
public function joinWhere($table, $one, $operator, $two, $type = 'inner')
{
}
/**
* Add a left join to the query.
*
* @param string $table
* @param string $first
* @param string $operator
* @param string $second
* @return \Illuminate\Database\Query\Builder|static
*/
public function leftJoin($table, $first, $operator = null, $second = null)
{
}
/**
* Add a "join where" clause to the query.
*
* @param string $table
* @param string $one
* @param string $operator
* @param string $two
* @return \Illuminate\Database\Query\Builder|static
*/
public function leftJoinWhere($table, $one, $operator, $two)
{
}
/**
* Add a right join to the query.
*
* @param string $table
* @param string $first
* @param string $operator
* @param string $second
* @return \Illuminate\Database\Query\Builder|static
*/
public function rightJoin($table, $first, $operator = null, $second = null)
{
}
/**
* Add a "right join where" clause to the query.
*
* @param string $table
* @param string $one
* @param string $operator
* @param string $two
* @return \Illuminate\Database\Query\Builder|static
*/
public function rightJoinWhere($table, $one, $operator, $two)
{
}
/**
* Add a "cross join" clause to the query.
*
* @param string $table
* @param string $first
* @param string $operator
* @param string $second
* @return \Illuminate\Database\Query\Builder|static
*/
public function crossJoin($table, $first = null, $operator = null, $second = null)
{
}
/**
* Apply the callback's query changes if the given "value" is true.
*
* @param bool $value
* @param \Closure $callback
* @return \Illuminate\Database\Query\Builder
*/
public function when($value, $callback)
{
}
/**
* Add a basic where clause to the query.
*
* @param string|array|\Closure $column
* @param string $operator
* @param mixed $value
* @param string $boolean
* @return $this
*
* @throws \InvalidArgumentException
*/
public function where($column, $operator = null, $value = null, $boolean = 'and')
{
}
/**
* Add an array of where clauses to the query.
*
* @param array $column
* @param string $boolean
* @param string $method
* @return $this
*/
protected function addArrayOfWheres($column, $boolean, $method = 'where')
{
}
/**
* Determine if the given operator and value combination is legal.
*
* @param string $operator
* @param mixed $value
* @return bool
*/
protected function invalidOperatorAndValue($operator, $value)
{
}
/**
* Add an "or where" clause to the query.
*
* @param string $column
* @param string $operator
* @param mixed $value
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhere($column, $operator = null, $value = null)
{
}
/**
* Add a "where" clause comparing two columns to the query.
*
* @param string|array $first
* @param string|null $operator
* @param string|null $second
* @param string|null $boolean
* @return \Illuminate\Database\Query\Builder|static
*/
public function whereColumn($first, $operator = null, $second = null, $boolean = 'and')
{
}
/**
* Add an "or where" clause comparing two columns to the query.
*
* @param string|array $first
* @param string|null $operator
* @param string|null $second
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereColumn($first, $operator = null, $second = null)
{
}
/**
* Add a raw where clause to the query.
*
* @param string $sql
* @param array $bindings
* @param string $boolean
* @return $this
*/
public function whereRaw($sql, array $bindings = [], $boolean = 'and')
{
}
/**
* Add a raw or where clause to the query.
*
* @param string $sql
* @param array $bindings
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereRaw($sql, array $bindings = [])
{
}
/**
* Add a where between statement to the query.
*
* @param string $column
* @param array $values
* @param string $boolean
* @param bool $not
* @return $this
*/
public function whereBetween($column, array $values, $boolean = 'and', $not = false)
{
}
/**
* Add an or where between statement to the query.
*
* @param string $column
* @param array $values
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereBetween($column, array $values)
{
}
/**
* Add a where not between statement to the query.
*
* @param string $column
* @param array $values
* @param string $boolean
* @return \Illuminate\Database\Query\Builder|static
*/
public function whereNotBetween($column, array $values, $boolean = 'and')
{
}
/**
* Add an or where not between statement to the query.
*
* @param string $column
* @param array $values
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereNotBetween($column, array $values)
{
}
/**
* Add a nested where statement to the query.
*
* @param \Closure $callback
* @param string $boolean
* @return \Illuminate\Database\Query\Builder|static
*/
public function whereNested(\Closure $callback, $boolean = 'and')
{
}
/**
* Create a new query instance for nested where condition.
*
* @return \Illuminate\Database\Query\Builder
*/
public function forNestedWhere()
{
}
/**
* Add another query builder as a nested where to the query builder.
*
* @param \Illuminate\Database\Query\Builder|static $query
* @param string $boolean
* @return $this
*/
public function addNestedWhereQuery($query, $boolean = 'and')
{
}
/**
* Add a full sub-select to the query.
*
* @param string $column
* @param string $operator
* @param \Closure $callback
* @param string $boolean
* @return $this
*/
protected function whereSub($column, $operator, \Closure $callback, $boolean)
{
}
/**
* Add an exists clause to the query.
*
* @param \Closure $callback
* @param string $boolean
* @param bool $not
* @return $this
*/
public function whereExists(\Closure $callback, $boolean = 'and', $not = false)
{
}
/**
* Add an or exists clause to the query.
*
* @param \Closure $callback
* @param bool $not
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereExists(\Closure $callback, $not = false)
{
}
/**
* Add a where not exists clause to the query.
*
* @param \Closure $callback
* @param string $boolean
* @return \Illuminate\Database\Query\Builder|static
*/
public function whereNotExists(\Closure $callback, $boolean = 'and')
{
}
/**
* Add a where not exists clause to the query.
*
* @param \Closure $callback
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereNotExists(\Closure $callback)
{
}
/**
* Add an exists clause to the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param string $boolean
* @param bool $not
* @return $this
*/
public function addWhereExistsQuery(\Illuminate\Database\Query\Builder $query, $boolean = 'and', $not = false)
{
}
/**
* Add a "where in" clause to the query.
*
* @param string $column
* @param mixed $values
* @param string $boolean
* @param bool $not
* @return $this
*/
public function whereIn($column, $values, $boolean = 'and', $not = false)
{
}
/**
* Add an "or where in" clause to the query.
*
* @param string $column
* @param mixed $values
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereIn($column, $values)
{
}
/**
* Add a "where not in" clause to the query.
*
* @param string $column
* @param mixed $values
* @param string $boolean
* @return \Illuminate\Database\Query\Builder|static
*/
public function whereNotIn($column, $values, $boolean = 'and')
{
}
/**
* Add an "or where not in" clause to the query.
*
* @param string $column
* @param mixed $values
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereNotIn($column, $values)
{
}
/**
* Add a where in with a sub-select to the query.
*
* @param string $column
* @param \Closure $callback
* @param string $boolean
* @param bool $not
* @return $this
*/
protected function whereInSub($column, \Closure $callback, $boolean, $not)
{
}
/**
* Add a external sub-select to the query.
*
* @param string $column
* @param \Illuminate\Database\Query\Builder|static $query
* @param string $boolean
* @param bool $not
* @return $this
*/
protected function whereInExistingQuery($column, $query, $boolean, $not)
{
}
/**
* Add a "where null" clause to the query.
*
* @param string $column
* @param string $boolean
* @param bool $not
* @return $this
*/
public function whereNull($column, $boolean = 'and', $not = false)
{
}
/**
* Add an "or where null" clause to the query.
*
* @param string $column
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereNull($column)
{
}
/**
* Add a "where not null" clause to the query.
*
* @param string $column
* @param string $boolean
* @return \Illuminate\Database\Query\Builder|static
*/
public function whereNotNull($column, $boolean = 'and')
{
}
/**
* Add an "or where not null" clause to the query.
*
* @param string $column
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereNotNull($column)
{
}
/**
* Add a "where date" statement to the query.
*
* @param string $column
* @param string $operator
* @param int $value
* @param string $boolean
* @return \Illuminate\Database\Query\Builder|static
*/
public function whereDate($column, $operator, $value, $boolean = 'and')
{
}
/**
* Add an "or where date" statement to the query.
*
* @param string $column
* @param string $operator
* @param int $value
* @return \Illuminate\Database\Query\Builder|static
*/
public function orWhereDate($column, $operator, $value)
{
}
/**
* Add a "where day" statement to the query.
*
* @param string $column
* @param string $operator
* @param int $value
* @param string $boolean
* @return \Illuminate\Database\Query\Builder|static
*/
public function whereDay($column, $operator, $value, $boolean = 'and')
{
}
/**
* Add a "where month" statement to the query.
*
* @param string $column
* @param string $operator
* @param int $value
* @param string $boolean
* @return \Illuminate\Database\Query\Builder|static
*/
public function whereMonth($column, $operator, $value, $boolean = 'and')
{
}
/**
* Add a "where year" statement to the query.
*
* @param string $column
* @param string $operator
* @param int $value
* @param string $boolean
* @return \Illuminate\Database\Query\Builder|static
*/
public function whereYear($column, $operator, $value, $boolean = 'and')
{
}
/**
* Add a date based (year, month, day) statement to the query.
*
* @param string $type
* @param string $column
* @param string $operator
* @param int $value
* @param string $boolean
* @return $this
*/
protected function addDateBasedWhere($type, $column, $operator, $value, $boolean = 'and')
{
}
/**
* Handles dynamic "where" clauses to the query.
*
* @param string $method
* @param string $parameters
* @return $this
*/
public function dynamicWhere($method, $parameters)
{
}
/**
* Add a single dynamic where clause statement to the query.
*
* @param string $segment
* @param string $connector
* @param array $parameters
* @param int $index
* @return void
*/
protected function addDynamic($segment, $connector, $parameters, $index)
{
}
/**
* Add a "group by" clause to the query.
*
* @param array|string $column,...
* @return $this
*/
public function groupBy()
{
}
/**
* Add a "having" clause to the query.
*
* @param string $column
* @param string $operator
* @param string $value
* @param string $boolean
* @return $this
*/
public function having($column, $operator = null, $value = null, $boolean = 'and')
{
}
/**
* Add a "or having" clause to the query.
*
* @param string $column
* @param string $operator
* @param string $value
* @return \Illuminate\Database\Query\Builder|static
*/
public function orHaving($column, $operator = null, $value = null)
{
}
/**
* Add a raw having clause to the query.
*
* @param string $sql
* @param array $bindings
* @param string $boolean
* @return $this
*/
public function havingRaw($sql, array $bindings = [], $boolean = 'and')
{
}
/**
* Add a raw or having clause to the query.
*
* @param string $sql
* @param array $bindings
* @return \Illuminate\Database\Query\Builder|static
*/
public function orHavingRaw($sql, array $bindings = [])
{
}
/**
* Add an "order by" clause to the query.
*
* @param string $column
* @param string $direction
* @return $this
*/
public function orderBy($column, $direction = 'asc')
{
}
/**
* Add an "order by" clause for a timestamp to the query.
*
* @param string $column
* @return \Illuminate\Database\Query\Builder|static
*/
public function latest($column = 'created_at')
{
}
/**
* Add an "order by" clause for a timestamp to the query.
*
* @param string $column
* @return \Illuminate\Database\Query\Builder|static
*/
public function oldest($column = 'created_at')
{
}
/**
* Put the query's results in random order.
*
* @param string $seed
* @return $this
*/
public function inRandomOrder($seed = '')
{
}
/**
* Add a raw "order by" clause to the query.
*
* @param string $sql
* @param array $bindings
* @return $this
*/
public function orderByRaw($sql, $bindings = [])
{
}
/**
* Set the "offset" value of the query.
*
* @param int $value
* @return $this
*/
public function offset($value)
{
}
/**
* Alias to set the "offset" value of the query.
*
* @param int $value
* @return \Illuminate\Database\Query\Builder|static
*/
public function skip($value)
{
}
/**
* Set the "limit" value of the query.
*
* @param int $value
* @return $this
*/
public function limit($value)
{
}
/**
* Alias to set the "limit" value of the query.
*
* @param int $value
* @return \Illuminate\Database\Query\Builder|static
*/
public function take($value)
{
}
/**
* Set the limit and offset for a given page.
*
* @param int $page
* @param int $perPage
* @return \Illuminate\Database\Query\Builder|static
*/
public function forPage($page, $perPage = 15)
{
}
/**
* Constrain the query to the next "page" of results after a given ID.
*
* @param int $perPage
* @param int $lastId
* @param string $column
* @return \Illuminate\Database\Query\Builder|static
*/
public function forPageAfterId($perPage = 15, $lastId = 0, $column = 'id')
{
}
/**
* Add a union statement to the query.
*
* @param \Illuminate\Database\Query\Builder|\Closure $query
* @param bool $all
* @return \Illuminate\Database\Query\Builder|static
*/
public function union($query, $all = false)
{
}
/**
* Add a union all statement to the query.
*
* @param \Illuminate\Database\Query\Builder|\Closure $query
* @return \Illuminate\Database\Query\Builder|static
*/
public function unionAll($query)
{
}
/**
* Lock the selected rows in the table.
*
* @param bool $value
* @return $this
*/
public function lock($value = true)
{
}
/**
* Lock the selected rows in the table for updating.
*
* @return \Illuminate\Database\Query\Builder
*/
public function lockForUpdate()
{
}
/**
* Share lock the selected rows in the table.
*
* @return \Illuminate\Database\Query\Builder
*/
public function sharedLock()
{
}
/**
* Get the SQL representation of the query.
*
* @return string
*/
public function toSql()
{
}
/**
* Execute a query for a single record by ID.
*
* @param int $id
* @param array $columns
* @return mixed|static
*/
public function find($id, $columns = ['*'])
{
}
/**
* Get a single column's value from the first result of a query.
*
* @param string $column
* @return mixed
*/
public function value($column)
{
}
/**
* Execute the query and get the first result.
*
* @param array $columns
* @return mixed|static
*/
public function first($columns = ['*'])
{
}
/**
* Execute the query as a "select" statement.
*
* @param array $columns
* @return array|static[]
*/
public function get($columns = ['*'])
{
}
/**
* Run the query as a "select" statement against the connection.
*
* @return array
*/
protected function runSelect()
{
}
/**
* Paginate the given query into a simple paginator.
*
* @param int $perPage
* @param array $columns
* @param string $pageName
* @param int|null $page
* @return \Illuminate\Contracts\Pagination\LengthAwarePaginator
*/
public function paginate($perPage = 15, $columns = ['*'], $pageName = 'page', $page = null)
{
}
/**
* Get a paginator only supporting simple next and previous links.
*
* This is more efficient on larger data-sets, etc.
*
* @param int $perPage
* @param array $columns
* @param string $pageName
* @param int|null $page
* @return \Illuminate\Contracts\Pagination\Paginator
*/
public function simplePaginate($perPage = 15, $columns = ['*'], $pageName = 'page', $page = null)
{
}
/**
* Get the count of the total records for the paginator.
*
* @param array $columns
* @return int
*/
public function getCountForPagination($columns = ['*'])
{
}
/**
* Backup some fields for the pagination count.
*
* @return void
*/
protected function backupFieldsForCount()
{
}
/**
* Remove the column aliases since they will break count queries.
*
* @param array $columns
* @return array
*/
protected function clearSelectAliases(array $columns)
{
}
/**
* Restore some fields after the pagination count.
*
* @return void
*/
protected function restoreFieldsForCount()
{
}
/**
* Get a generator for the given query.
*
* @return \Generator
*/
public function cursor()
{
}
/**
* Chunk the results of the query.
*
* @param int $count
* @param callable $callback
* @return bool
*/
public function chunk($count, callable $callback)
{
}
/**
* Chunk the results of a query by comparing numeric IDs.
*
* @param int $count
* @param callable $callback
* @param string $column
* @return bool
*/
public function chunkById($count, callable $callback, $column = 'id')
{
}
/**
* Execute a callback over each item while chunking.
*
* @param callable $callback
* @param int $count
* @return bool
*
* @throws \RuntimeException
*/
public function each(callable $callback, $count = 1000)
{
}
/**
* Get an array with the values of a given column.
*
* @param string $column
* @param string|null $key
* @return array
*/
public function pluck($column, $key = null)
{
}
/**
* Alias for the "pluck" method.
*
* @param string $column
* @param string|null $key
* @return array
*
* @deprecated since version 5.2. Use the "pluck" method directly.
*/
public function lists($column, $key = null)
{
}
/**
* Strip off the table name or alias from a column identifier.
*
* @param string $column
* @return string|null
*/
protected function stripTableForPluck($column)
{
}
/**
* Concatenate values of a given column as a string.
*
* @param string $column
* @param string $glue
* @return string
*/
public function implode($column, $glue = '')
{
}
/**
* Determine if any rows exist for the current query.
*
* @return bool
*/
public function exists()
{
}
/**
* Retrieve the "count" result of the query.
*
* @param string $columns
* @return int
*/
public function count($columns = '*')
{
}
/**
* Retrieve the minimum value of a given column.
*
* @param string $column
* @return float|int
*/
public function min($column)
{
}
/**
* Retrieve the maximum value of a given column.
*
* @param string $column
* @return float|int
*/
public function max($column)
{
}
/**
* Retrieve the sum of the values of a given column.
*
* @param string $column
* @return float|int
*/
public function sum($column)
{
}
/**
* Retrieve the average of the values of a given column.
*
* @param string $column
* @return float|int
*/
public function avg($column)
{
}
/**
* Alias for the "avg" method.
*
* @param string $column
* @return float|int
*/
public function average($column)
{
}
/**
* Execute an aggregate function on the database.
*
* @param string $function
* @param array $columns
* @return float|int
*/
public function aggregate($function, $columns = ['*'])
{
}
/**
* Insert a new record into the database.
*
* @param array $values
* @return bool
*/
public function insert(array $values)
{
}
/**
* Insert a new record and get the value of the primary key.
*
* @param array $values
* @param string $sequence
* @return int
*/
public function insertGetId(array $values, $sequence = null)
{
}
/**
* Update a record in the database.
*
* @param array $values
* @return int
*/
public function update(array $values)
{
}
/**
* Insert or update a record matching the attributes, and fill it with values.
*
* @param array $attributes
* @param array $values
* @return bool
*/
public function updateOrInsert(array $attributes, array $values = [])
{
}
/**
* Increment a column's value by a given amount.
*
* @param string $column
* @param int $amount
* @param array $extra
* @return int
*/
public function increment($column, $amount = 1, array $extra = [])
{
}
/**
* Decrement a column's value by a given amount.
*
* @param string $column
* @param int $amount
* @param array $extra
* @return int
*/
public function decrement($column, $amount = 1, array $extra = [])
{
}
/**
* Delete a record from the database.
*
* @param mixed $id
* @return int
*/
public function delete($id = null)
{
}
/**
* Run a truncate statement on the table.
*
* @return void
*/
public function truncate()
{
}
/**
* Get a new instance of the query builder.
*
* @return \Illuminate\Database\Query\Builder
*/
public function newQuery()
{
}
/**
* Merge an array of where clauses and bindings.
*
* @param array $wheres
* @param array $bindings
* @return void
*/
public function mergeWheres($wheres, $bindings)
{
}
/**
* Remove all of the expressions from a list of bindings.
*
* @param array $bindings
* @return array
*/
protected function cleanBindings(array $bindings)
{
}
/**
* Create a raw database expression.
*
* @param mixed $value
* @return \Illuminate\Database\Query\Expression
*/
public function raw($value)
{
}
/**
* Get the current query value bindings in a flattened array.
*
* @return array
*/
public function getBindings()
{
}
/**
* Get the raw array of bindings.
*
* @return array
*/
public function getRawBindings()
{
}
/**
* Set the bindings on the query builder.
*
* @param array $bindings
* @param string $type
* @return $this
*
* @throws \InvalidArgumentException
*/
public function setBindings(array $bindings, $type = 'where')
{
}
/**
* Add a binding to the query.
*
* @param mixed $value
* @param string $type
* @return $this
*
* @throws \InvalidArgumentException
*/
public function addBinding($value, $type = 'where')
{
}
/**
* Merge an array of bindings into our bindings.
*
* @param \Illuminate\Database\Query\Builder $query
* @return $this
*/
public function mergeBindings(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Get the database connection instance.
*
* @return \Illuminate\Database\ConnectionInterface
*/
public function getConnection()
{
}
/**
* Get the database query processor instance.
*
* @return \Illuminate\Database\Query\Processors\Processor
*/
public function getProcessor()
{
}
/**
* Get the query grammar instance.
*
* @return \Illuminate\Database\Query\Grammars\Grammar
*/
public function getGrammar()
{
}
/**
* Use the write pdo for query.
*
* @return $this
*/
public function useWritePdo()
{
}
/**
* Handle dynamic method calls into the method.
*
* @param string $method
* @param array $parameters
* @return mixed
*
* @throws \BadMethodCallException
*/
public function __call($method, $parameters)
{
}
}
}
namespace Illuminate\Database\Query\Grammars {
class Grammar extends \Illuminate\Database\Grammar
{
/**
* The grammar specific operators.
*
* @var array
*/
protected $operators = [];
/**
* The components that make up a select clause.
*
* @var array
*/
protected $selectComponents = ['aggregate', 'columns', 'from', 'joins', 'wheres', 'groups', 'havings', 'orders', 'limit', 'offset', 'unions', 'lock'];
/**
* Compile a select query into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
public function compileSelect(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile the components necessary for a select clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @return array
*/
protected function compileComponents(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile an aggregated select clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $aggregate
* @return string
*/
protected function compileAggregate(\Illuminate\Database\Query\Builder $query, $aggregate)
{
}
/**
* Compile the "select *" portion of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $columns
* @return string|null
*/
protected function compileColumns(\Illuminate\Database\Query\Builder $query, $columns)
{
}
/**
* Compile the "from" portion of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param string $table
* @return string
*/
protected function compileFrom(\Illuminate\Database\Query\Builder $query, $table)
{
}
/**
* Compile the "join" portions of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $joins
* @return string
*/
protected function compileJoins(\Illuminate\Database\Query\Builder $query, $joins)
{
}
/**
* Create a join clause constraint segment.
*
* @param array $clause
* @return string
*/
protected function compileJoinConstraint(array $clause)
{
}
/**
* Create a nested join clause constraint segment.
*
* @param array $clause
* @return string
*/
protected function compileNestedJoinConstraint(array $clause)
{
}
/**
* Compile the "where" portions of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
protected function compileWheres(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile a nested where clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereNested(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a where condition with a sub-select.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereSub(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a basic where clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereBasic(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a where clause comparing two columns..
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereColumn(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "between" where clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereBetween(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a where exists clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereExists(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a where exists clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereNotExists(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where in" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereIn(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where not in" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereNotIn(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a where in sub-select clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereInSub(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a where not in sub-select clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereNotInSub(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where null" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereNull(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where not null" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereNotNull(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where date" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereDate(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where day" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereDay(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where month" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereMonth(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where year" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereYear(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a date based where clause.
*
* @param string $type
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function dateBasedWhere($type, \Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a raw where clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereRaw(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile the "group by" portions of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $groups
* @return string
*/
protected function compileGroups(\Illuminate\Database\Query\Builder $query, $groups)
{
}
/**
* Compile the "having" portions of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $havings
* @return string
*/
protected function compileHavings(\Illuminate\Database\Query\Builder $query, $havings)
{
}
/**
* Compile a single having clause.
*
* @param array $having
* @return string
*/
protected function compileHaving(array $having)
{
}
/**
* Compile a basic having clause.
*
* @param array $having
* @return string
*/
protected function compileBasicHaving($having)
{
}
/**
* Compile the "order by" portions of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $orders
* @return string
*/
protected function compileOrders(\Illuminate\Database\Query\Builder $query, $orders)
{
}
/**
* Compile the random statement into SQL.
*
* @param string $seed
* @return string
*/
public function compileRandom($seed)
{
}
/**
* Compile the "limit" portions of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param int $limit
* @return string
*/
protected function compileLimit(\Illuminate\Database\Query\Builder $query, $limit)
{
}
/**
* Compile the "offset" portions of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param int $offset
* @return string
*/
protected function compileOffset(\Illuminate\Database\Query\Builder $query, $offset)
{
}
/**
* Compile the "union" queries attached to the main query.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
protected function compileUnions(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile a single union statement.
*
* @param array $union
* @return string
*/
protected function compileUnion(array $union)
{
}
/**
* Compile an exists statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
public function compileExists(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile an insert statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @return string
*/
public function compileInsert(\Illuminate\Database\Query\Builder $query, array $values)
{
}
/**
* Compile an insert and get ID statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @param string $sequence
* @return string
*/
public function compileInsertGetId(\Illuminate\Database\Query\Builder $query, $values, $sequence)
{
}
/**
* Compile an update statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @return string
*/
public function compileUpdate(\Illuminate\Database\Query\Builder $query, $values)
{
}
/**
* Prepare the bindings for an update statement.
*
* @param array $bindings
* @param array $values
* @return array
*/
public function prepareBindingsForUpdate(array $bindings, array $values)
{
}
/**
* Compile a delete statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
public function compileDelete(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile a truncate table statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return array
*/
public function compileTruncate(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile the lock into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param bool|string $value
* @return string
*/
protected function compileLock(\Illuminate\Database\Query\Builder $query, $value)
{
}
/**
* Determine if the grammar supports savepoints.
*
* @return bool
*/
public function supportsSavepoints()
{
}
/**
* Compile the SQL statement to define a savepoint.
*
* @param string $name
* @return string
*/
public function compileSavepoint($name)
{
}
/**
* Compile the SQL statement to execute a savepoint rollback.
*
* @param string $name
* @return string
*/
public function compileSavepointRollBack($name)
{
}
/**
* Concatenate an array of segments, removing empties.
*
* @param array $segments
* @return string
*/
protected function concatenate($segments)
{
}
/**
* Remove the leading boolean from a statement.
*
* @param string $value
* @return string
*/
protected function removeLeadingBoolean($value)
{
}
/**
* Get the gramar specific operators.
*
* @return array
*/
public function getOperators()
{
}
}
class PostgresGrammar extends \Illuminate\Database\Query\Grammars\Grammar
{
/**
* All of the available clause operators.
*
* @var array
*/
protected $operators = ['=', '<', '>', '<=', '>=', '<>', '!=', 'like', 'not like', 'between', 'ilike', '&', '|', '#', '<<', '>>', '@>', '<@', '?', '?|', '?&', '||', '-', '-', '#-'];
/**
* Compile the lock into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param bool|string $value
* @return string
*/
protected function compileLock(\Illuminate\Database\Query\Builder $query, $value)
{
}
/**
* Compile a "where date" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereDate(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where day" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereDay(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where month" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereMonth(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where year" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereYear(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a date based where clause.
*
* @param string $type
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function dateBasedWhere($type, \Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile an update statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @return string
*/
public function compileUpdate(\Illuminate\Database\Query\Builder $query, $values)
{
}
/**
* Compile the columns for the update statement.
*
* @param array $values
* @return string
*/
protected function compileUpdateColumns($values)
{
}
/**
* Compile the "from" clause for an update with a join.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string|null
*/
protected function compileUpdateFrom(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile the additional where clauses for updates with joins.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
protected function compileUpdateWheres(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile the "join" clauses for an update.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
protected function compileUpdateJoinWheres(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile an insert and get ID statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @param string $sequence
* @return string
*/
public function compileInsertGetId(\Illuminate\Database\Query\Builder $query, $values, $sequence)
{
}
/**
* Compile a truncate table statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return array
*/
public function compileTruncate(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Wrap a single string in keyword identifiers.
*
* @param string $value
* @return string
*/
protected function wrapValue($value)
{
}
/**
* Wrap the given JSON selector.
*
* @param string $value
* @return string
*/
protected function wrapJsonSelector($value)
{
}
/**
* Wrap the attributes of the give JSON path.
*
* @param array $path
* @return array
*/
protected function wrapJsonPathAttributes($path)
{
}
}
class MySqlGrammar extends \Illuminate\Database\Query\Grammars\Grammar
{
/**
* The components that make up a select clause.
*
* @var array
*/
protected $selectComponents = ['aggregate', 'columns', 'from', 'joins', 'wheres', 'groups', 'havings', 'orders', 'limit', 'offset', 'lock'];
/**
* Compile a select query into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
public function compileSelect(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile a single union statement.
*
* @param array $union
* @return string
*/
protected function compileUnion(array $union)
{
}
/**
* Compile the random statement into SQL.
*
* @param string $seed
* @return string
*/
public function compileRandom($seed)
{
}
/**
* Compile the lock into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param bool|string $value
* @return string
*/
protected function compileLock(\Illuminate\Database\Query\Builder $query, $value)
{
}
/**
* Compile an update statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @return string
*/
public function compileUpdate(\Illuminate\Database\Query\Builder $query, $values)
{
}
/**
* Prepares a JSON column being updated using the JSON_SET function.
*
* @param string $key
* @param \Illuminate\Database\JsonExpression $value
* @return string
*/
protected function compileJsonUpdateColumn($key, \Illuminate\Database\Query\JsonExpression $value)
{
}
/**
* Prepare the bindings for an update statement.
*
* @param array $bindings
* @param array $values
* @return array
*/
public function prepareBindingsForUpdate(array $bindings, array $values)
{
}
/**
* Compile a delete statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
public function compileDelete(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Wrap a single string in keyword identifiers.
*
* @param string $value
* @return string
*/
protected function wrapValue($value)
{
}
/**
* Wrap the given JSON selector.
*
* @param string $value
* @return string
*/
protected function wrapJsonSelector($value)
{
}
/**
* Determine if the given string is a JSON selector.
*
* @param string $value
* @return bool
*/
protected function isJsonSelector($value)
{
}
}
class SQLiteGrammar extends \Illuminate\Database\Query\Grammars\Grammar
{
/**
* All of the available clause operators.
*
* @var array
*/
protected $operators = ['=', '<', '>', '<=', '>=', '<>', '!=', 'like', 'not like', 'between', 'ilike', '&', '|', '<<', '>>'];
/**
* Compile an insert statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @return string
*/
public function compileInsert(\Illuminate\Database\Query\Builder $query, array $values)
{
}
/**
* Compile a truncate table statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return array
*/
public function compileTruncate(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile a "where date" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereDate(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where day" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereDay(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where month" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereMonth(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a "where year" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereYear(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Compile a date based where clause.
*
* @param string $type
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function dateBasedWhere($type, \Illuminate\Database\Query\Builder $query, $where)
{
}
}
class SqlServerGrammar extends \Illuminate\Database\Query\Grammars\Grammar
{
/**
* All of the available clause operators.
*
* @var array
*/
protected $operators = ['=', '<', '>', '<=', '>=', '!<', '!>', '<>', '!=', 'like', 'not like', 'between', 'ilike', '&', '&=', '|', '|=', '^', '^='];
/**
* Compile a select query into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
public function compileSelect(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile the "select *" portion of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $columns
* @return string|null
*/
protected function compileColumns(\Illuminate\Database\Query\Builder $query, $columns)
{
}
/**
* Compile the "from" portion of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param string $table
* @return string
*/
protected function compileFrom(\Illuminate\Database\Query\Builder $query, $table)
{
}
/**
* Create a full ANSI offset clause for the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $components
* @return string
*/
protected function compileAnsiOffset(\Illuminate\Database\Query\Builder $query, $components)
{
}
/**
* Compile the over statement for a table expression.
*
* @param string $orderings
* @return string
*/
protected function compileOver($orderings)
{
}
/**
* Compile the limit / offset row constraint for a query.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
protected function compileRowConstraint($query)
{
}
/**
* Compile a common table expression for a query.
*
* @param string $sql
* @param string $constraint
* @return string
*/
protected function compileTableExpression($sql, $constraint)
{
}
/**
* Compile the random statement into SQL.
*
* @param string $seed
* @return string
*/
public function compileRandom($seed)
{
}
/**
* Compile the "limit" portions of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param int $limit
* @return string
*/
protected function compileLimit(\Illuminate\Database\Query\Builder $query, $limit)
{
}
/**
* Compile the "offset" portions of the query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param int $offset
* @return string
*/
protected function compileOffset(\Illuminate\Database\Query\Builder $query, $offset)
{
}
/**
* Compile a truncate table statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return array
*/
public function compileTruncate(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile an exists statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @return string
*/
public function compileExists(\Illuminate\Database\Query\Builder $query)
{
}
/**
* Compile a "where date" clause.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $where
* @return string
*/
protected function whereDate(\Illuminate\Database\Query\Builder $query, $where)
{
}
/**
* Determine if the grammar supports savepoints.
*
* @return bool
*/
public function supportsSavepoints()
{
}
/**
* Get the format for database stored dates.
*
* @return string
*/
public function getDateFormat()
{
}
/**
* Wrap a single string in keyword identifiers.
*
* @param string $value
* @return string
*/
protected function wrapValue($value)
{
}
/**
* Compile an update statement into SQL.
*
* @param \Illuminate\Database\Query\Builder $query
* @param array $values
* @return string
*/
public function compileUpdate(\Illuminate\Database\Query\Builder $query, $values)
{
}
/**
* Wrap a table in keyword identifiers.
*
* @param \Illuminate\Database\Query\Expression|string $table
* @return string
*/
public function wrapTable($table)
{
}
/**
* Wrap a table in keyword identifiers.
*
* @param string $table
* @return string
*/
protected function wrapTableValuedFunction($table)
{
}
}
}
namespace Illuminate\Database\Query {
class JoinClause
{
/**
* The type of join being performed.
*
* @var string
*/
public $type;
/**
* The table the join clause is joining to.
*
* @var string
*/
public $table;
/**
* The "on" clauses for the join.
*
* @var array
*/
public $clauses = [];
/**
* The "on" bindings for the join.
*
* @var array
*/
public $bindings = [];
/**
* Create a new join clause instance.
*
* @param string $type
* @param string $table
* @return void
*/
public function __construct($type, $table)
{
}
/**
* Add an "on" clause to the join.
*
* On clauses can be chained, e.g.
*
* $join->on('contacts.user_id', '=', 'users.id')
* ->on('contacts.info_id', '=', 'info.id')
*
* will produce the following SQL:
*
* on `contacts`.`user_id` = `users`.`id` and `contacts`.`info_id` = `info`.`id`
*
* @param \Closure|string $first
* @param string|null $operator
* @param string|null $second
* @param string $boolean
* @param bool $where
* @return $this
*
* @throws \InvalidArgumentException
*/
public function on($first, $operator = null, $second = null, $boolean = 'and', $where = false)
{
}
/**
* Add an "or on" clause to the join.
*
* @param \Closure|string $first
* @param string|null $operator
* @param string|null $second
* @return \Illuminate\Database\Query\JoinClause
*/
public function orOn($first, $operator = null, $second = null)
{
}
/**
* Add an "on where" clause to the join.
*
* @param \Closure|string $first
* @param string|null $operator
* @param string|null $second
* @param string $boolean
* @return \Illuminate\Database\Query\JoinClause
*/
public function where($first, $operator = null, $second = null, $boolean = 'and')
{
}
/**
* Add an "or on where" clause to the join.
*
* @param \Closure|string $first
* @param string|null $operator
* @param string|null $second
* @return \Illuminate\Database\Query\JoinClause
*/
public function orWhere($first, $operator = null, $second = null)
{
}
/**
* Add an "on where is null" clause to the join.
*
* @param string $column
* @param string $boolean
* @return \Illuminate\Database\Query\JoinClause
*/
public function whereNull($column, $boolean = 'and')
{
}
/**
* Add an "or on where is null" clause to the join.
*
* @param string $column
* @return \Illuminate\Database\Query\JoinClause
*/
public function orWhereNull($column)
{
}
/**
* Add an "on where is not null" clause to the join.
*
* @param string $column
* @param string $boolean
* @return \Illuminate\Database\Query\JoinClause
*/
public function whereNotNull($column, $boolean = 'and')
{
}
/**
* Add an "or on where is not null" clause to the join.
*
* @param string $column
* @return \Illuminate\Database\Query\JoinClause
*/
public function orWhereNotNull($column)
{
}
/**
* Add an "on where in (...)" clause to the join.
*
* @param string $column
* @param array $values
* @return \Illuminate\Database\Query\JoinClause
*/
public function whereIn($column, array $values)
{
}
/**
* Add an "on where not in (...)" clause to the join.
*
* @param string $column
* @param array $values
* @return \Illuminate\Database\Query\JoinClause
*/
public function whereNotIn($column, array $values)
{
}
/**
* Add an "or on where in (...)" clause to the join.
*
* @param string $column
* @param array $values
* @return \Illuminate\Database\Query\JoinClause
*/
public function orWhereIn($column, array $values)
{
}
/**
* Add an "or on where not in (...)" clause to the join.
*
* @param string $column
* @param array $values
* @return \Illuminate\Database\Query\JoinClause
*/
public function orWhereNotIn($column, array $values)
{
}
/**
* Add a nested where statement to the query.
*
* @param \Closure $callback
* @param string $boolean
* @return \Illuminate\Database\Query\JoinClause
*/
public function nest(\Closure $callback, $boolean = 'and')
{
}
}
}
namespace Illuminate\Database {
class SqlServerConnection extends \Illuminate\Database\Connection
{
/**
* Execute a Closure within a transaction.
*
* @param \Closure $callback
* @return mixed
*
* @throws \Exception|\Throwable
*/
public function transaction(\Closure $callback)
{
}
/**
* Get the default query grammar instance.
*
* @return \Illuminate\Database\Query\Grammars\SqlServerGrammar
*/
protected function getDefaultQueryGrammar()
{
}
/**
* Get the default schema grammar instance.
*
* @return \Illuminate\Database\Schema\Grammars\SqlServerGrammar
*/
protected function getDefaultSchemaGrammar()
{
}
/**
* Get the default post processor instance.
*
* @return \Illuminate\Database\Query\Processors\SqlServerProcessor
*/
protected function getDefaultPostProcessor()
{
}
/**
* Get the Doctrine DBAL driver.
*
* @return \Doctrine\DBAL\Driver\PDOSqlsrv\Driver
*/
protected function getDoctrineDriver()
{
}
}
}
namespace Illuminate\Support {
class ViewErrorBag implements \Countable
{
/**
* The array of the view error bags.
*
* @var array
*/
protected $bags = [];
/**
* Checks if a named MessageBag exists in the bags.
*
* @param string $key
* @return bool
*/
public function hasBag($key = 'default')
{
}
/**
* Get a MessageBag instance from the bags.
*
* @param string $key
* @return \Illuminate\Contracts\Support\MessageBag
*/
public function getBag($key)
{
}
/**
* Get all the bags.
*
* @return array
*/
public function getBags()
{
}
/**
* Add a new MessageBag instance to the bags.
*
* @param string $key
* @param \Illuminate\Contracts\Support\MessageBag $bag
* @return $this
*/
public function put($key, \Illuminate\Contracts\Support\MessageBag $bag)
{
}
/**
* Get the number of messages in the default bag.
*
* @return int
*/
public function count()
{
}
/**
* Dynamically call methods on the default bag.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public function __call($method, $parameters)
{
}
/**
* Dynamically access a view error bag.
*
* @param string $key
* @return \Illuminate\Contracts\Support\MessageBag
*/
public function __get($key)
{
}
/**
* Dynamically set a view error bag.
*
* @param string $key
* @param \Illuminate\Contracts\Support\MessageBag $value
* @return void
*/
public function __set($key, $value)
{
}
}
}
namespace Illuminate\Contracts\Support {
interface MessageBag
{
/**
* Get the keys present in the message bag.
*
* @return array
*/
public function keys();
/**
* Add a message to the bag.
*
* @param string $key
* @param string $message
* @return $this
*/
public function add($key, $message);
/**
* Merge a new array of messages into the bag.
*
* @param \Illuminate\Contracts\Support\MessageProvider|array $messages
* @return $this
*/
public function merge($messages);
/**
* Determine if messages exist for a given key.
*
* @param string $key
* @return bool
*/
public function has($key = null);
/**
* Get the first message from the bag for a given key.
*
* @param string $key
* @param string $format
* @return string
*/
public function first($key = null, $format = null);
/**
* Get all of the messages from the bag for a given key.
*
* @param string $key
* @param string $format
* @return array
*/
public function get($key, $format = null);
/**
* Get all of the messages for every key in the bag.
*
* @param string $format
* @return array
*/
public function all($format = null);
/**
* Get the default message format.
*
* @return string
*/
public function getFormat();
/**
* Set the default message format.
*
* @param string $format
* @return $this
*/
public function setFormat($format = ':message');
/**
* Determine if the message bag has any messages.
*
* @return bool
*/
public function isEmpty();
/**
* Get the number of messages in the container.
*
* @return int
*/
public function count();
/**
* Get the instance as an array.
*
* @return array
*/
public function toArray();
}
interface MessageProvider
{
/**
* Get the messages for the instance.
*
* @return \Illuminate\Contracts\Support\MessageBag
*/
public function getMessageBag();
}
}
namespace Illuminate\Support {
class MessageBag implements \Illuminate\Contracts\Support\Arrayable, \Countable, \Illuminate\Contracts\Support\Jsonable, \JsonSerializable, \Illuminate\Contracts\Support\MessageBag, \Illuminate\Contracts\Support\MessageProvider
{
/**
* All of the registered messages.
*
* @var array
*/
protected $messages = [];
/**
* Default format for message output.
*
* @var string
*/
protected $format = ':message';
/**
* Create a new message bag instance.
*
* @param array $messages
* @return void
*/
public function __construct(array $messages = [])
{
}
/**
* Get the keys present in the message bag.
*
* @return array
*/
public function keys()
{
}
/**
* Add a message to the bag.
*
* @param string $key
* @param string $message
* @return $this
*/
public function add($key, $message)
{
}
/**
* Merge a new array of messages into the bag.
*
* @param \Illuminate\Contracts\Support\MessageProvider|array $messages
* @return $this
*/
public function merge($messages)
{
}
/**
* Determine if a key and message combination already exists.
*
* @param string $key
* @param string $message
* @return bool
*/
protected function isUnique($key, $message)
{
}
/**
* Determine if messages exist for a given key.
*
* @param string $key
* @return bool
*/
public function has($key = null)
{
}
/**
* Get the first message from the bag for a given key.
*
* @param string $key
* @param string $format
* @return string
*/
public function first($key = null, $format = null)
{
}
/**
* Get all of the messages from the bag for a given key.
*
* @param string $key
* @param string $format
* @return array
*/
public function get($key, $format = null)
{
}
/**
* Get all of the messages for every key in the bag.
*
* @param string $format
* @return array
*/
public function all($format = null)
{
}
/**
* Get all of the unique messages for every key in the bag.
*
* @param string $format
* @return array
*/
public function unique($format = null)
{
}
/**
* Format an array of messages.
*
* @param array $messages
* @param string $format
* @param string $messageKey
* @return array
*/
protected function transform($messages, $format, $messageKey)
{
}
/**
* Get the appropriate format based on the given format.
*
* @param string $format
* @return string
*/
protected function checkFormat($format)
{
}
/**
* Get the raw messages in the container.
*
* @return array
*/
public function messages()
{
}
/**
* Get the raw messages in the container.
*
* @return array
*/
public function getMessages()
{
}
/**
* Get the messages for the instance.
*
* @return \Illuminate\Support\MessageBag
*/
public function getMessageBag()
{
}
/**
* Get the default message format.
*
* @return string
*/
public function getFormat()
{
}
/**
* Set the default message format.
*
* @param string $format
* @return \Illuminate\Support\MessageBag
*/
public function setFormat($format = ':message')
{
}
/**
* Determine if the message bag has any messages.
*
* @return bool
*/
public function isEmpty()
{
}
/**
* Determine if the message bag has any messages.
*
* @return bool
*/
public function any()
{
}
/**
* Get the number of messages in the container.
*
* @return int
*/
public function count()
{
}
/**
* Get the instance as an array.
*
* @return array
*/
public function toArray()
{
}
/**
* Convert the object into something JSON serializable.
*
* @return array
*/
public function jsonSerialize()
{
}
/**
* Convert the object to its JSON representation.
*
* @param int $options
* @return string
*/
public function toJson($options = 0)
{
}
/**
* Convert the message bag to its string representation.
*
* @return string
*/
public function __toString()
{
}
}
class Composer
{
/**
* The filesystem instance.
*
* @var \Illuminate\Filesystem\Filesystem
*/
protected $files;
/**
* The working path to regenerate from.
*
* @var string
*/
protected $workingPath;
/**
* Create a new Composer manager instance.
*
* @param \Illuminate\Filesystem\Filesystem $files
* @param string|null $workingPath
* @return void
*/
public function __construct(\Illuminate\Filesystem\Filesystem $files, $workingPath = null)
{
}
/**
* Regenerate the Composer autoloader files.
*
* @param string $extra
* @return void
*/
public function dumpAutoloads($extra = '')
{
}
/**
* Regenerate the optimized Composer autoloader files.
*
* @return void
*/
public function dumpOptimized()
{
}
/**
* Get the composer command for the environment.
*
* @return string
*/
protected function findComposer()
{
}
/**
* Get a new Symfony process instance.
*
* @return \Symfony\Component\Process\Process
*/
protected function getProcess()
{
}
/**
* Set the working path used by the class.
*
* @param string $path
* @return $this
*/
public function setWorkingPath($path)
{
}
}
}
namespace Illuminate\Support\Debug {
class HtmlDumper extends \Symfony\Component\VarDumper\Dumper\HtmlDumper
{
/**
* Colour definitions for output.
*
* @var array
*/
protected $styles = ['default' => 'background-color:#fff; color:#222; line-height:1.2em; font-weight:normal; font:12px Monaco, Consolas, monospace; word-wrap: break-word; white-space: pre-wrap; position:relative; z-index:100000', 'num' => 'color:#a71d5d', 'const' => 'color:#795da3', 'str' => 'color:#df5000', 'cchr' => 'color:#222', 'note' => 'color:#a71d5d', 'ref' => 'color:#a0a0a0', 'public' => 'color:#795da3', 'protected' => 'color:#795da3', 'private' => 'color:#795da3', 'meta' => 'color:#b729d9', 'key' => 'color:#df5000', 'index' => 'color:#a71d5d'];
}
class Dumper
{
/**
* Dump a value with elegance.
*
* @param mixed $value
* @return void
*/
public function dump($value)
{
}
}
}
namespace Illuminate\Support {
class Str
{
use \Illuminate\Support\Traits\Macroable;
/**
* The cache of snake-cased words.
*
* @var array
*/
protected static $snakeCache = [];
/**
* The cache of camel-cased words.
*
* @var array
*/
protected static $camelCache = [];
/**
* The cache of studly-cased words.
*
* @var array
*/
protected static $studlyCache = [];
/**
* Transliterate a UTF-8 value to ASCII.
*
* @param string $value
* @return string
*/
public static function ascii($value)
{
}
/**
* Convert a value to camel case.
*
* @param string $value
* @return string
*/
public static function camel($value)
{
}
/**
* Determine if a given string contains a given substring.
*
* @param string $haystack
* @param string|array $needles
* @return bool
*/
public static function contains($haystack, $needles)
{
}
/**
* Determine if a given string ends with a given substring.
*
* @param string $haystack
* @param string|array $needles
* @return bool
*/
public static function endsWith($haystack, $needles)
{
}
/**
* Cap a string with a single instance of a given value.
*
* @param string $value
* @param string $cap
* @return string
*/
public static function finish($value, $cap)
{
}
/**
* Determine if a given string matches a given pattern.
*
* @param string $pattern
* @param string $value
* @return bool
*/
public static function is($pattern, $value)
{
}
/**
* Return the length of the given string.
*
* @param string $value
* @return int
*/
public static function length($value)
{
}
/**
* Limit the number of characters in a string.
*
* @param string $value
* @param int $limit
* @param string $end
* @return string
*/
public static function limit($value, $limit = 100, $end = '...')
{
}
/**
* Convert the given string to lower-case.
*
* @param string $value
* @return string
*/
public static function lower($value)
{
}
/**
* Limit the number of words in a string.
*
* @param string $value
* @param int $words
* @param string $end
* @return string
*/
public static function words($value, $words = 100, $end = '...')
{
}
/**
* Parse a Class@method style callback into class and method.
*
* @param string $callback
* @param string $default
* @return array
*/
public static function parseCallback($callback, $default)
{
}
/**
* Get the plural form of an English word.
*
* @param string $value
* @param int $count
* @return string
*/
public static function plural($value, $count = 2)
{
}
/**
* Generate a more truly "random" alpha-numeric string.
*
* @param int $length
* @return string
*/
public static function random($length = 16)
{
}
/**
* Generate a more truly "random" bytes.
*
* @param int $length
* @return string
*
* @deprecated since version 5.2. Use random_bytes instead.
*/
public static function randomBytes($length = 16)
{
}
/**
* Generate a "random" alpha-numeric string.
*
* Should not be considered sufficient for cryptography, etc.
*
* @param int $length
* @return string
*/
public static function quickRandom($length = 16)
{
}
/**
* Compares two strings using a constant-time algorithm.
*
* Note: This method will leak length information.
*
* Note: Adapted from Symfony\Component\Security\Core\Util\StringUtils.
*
* @param string $knownString
* @param string $userInput
* @return bool
*
* @deprecated since version 5.2. Use hash_equals instead.
*/
public static function equals($knownString, $userInput)
{
}
/**
* Replace the first occurrence of a given value in the string.
*
* @param string $search
* @param string $replace
* @param string $subject
* @return string
*/
public static function replaceFirst($search, $replace, $subject)
{
}
/**
* Replace the last occurrence of a given value in the string.
*
* @param string $search
* @param string $replace
* @param string $subject
* @return string
*/
public static function replaceLast($search, $replace, $subject)
{
}
/**
* Convert the given string to upper-case.
*
* @param string $value
* @return string
*/
public static function upper($value)
{
}
/**
* Convert the given string to title case.
*
* @param string $value
* @return string
*/
public static function title($value)
{
}
/**
* Get the singular form of an English word.
*
* @param string $value
* @return string
*/
public static function singular($value)
{
}
/**
* Generate a URL friendly "slug" from a given string.
*
* @param string $title
* @param string $separator
* @return string
*/
public static function slug($title, $separator = '-')
{
}
/**
* Convert a string to snake case.
*
* @param string $value
* @param string $delimiter
* @return string
*/
public static function snake($value, $delimiter = '_')
{
}
/**
* Determine if a given string starts with a given substring.
*
* @param string $haystack
* @param string|array $needles
* @return bool
*/
public static function startsWith($haystack, $needles)
{
}
/**
* Convert a value to studly caps case.
*
* @param string $value
* @return string
*/
public static function studly($value)
{
}
/**
* Returns the portion of string specified by the start and length parameters.
*
* @param string $string
* @param int $start
* @param int|null $length
* @return string
*/
public static function substr($string, $start, $length = null)
{
}
/**
* Make a string's first character uppercase.
*
* @param string $string
* @return string
*/
public static function ucfirst($string)
{
}
/**
* Returns the replacements for the ascii method.
*
* Note: Adapted from Stringy\Stringy.
*
* @see https://github.com/danielstjules/Stringy/blob/2.3.1/LICENSE.txt
*
* @return array
*/
protected static function charsArray()
{
}
}
class Pluralizer
{
/**
* Uncountable word forms.
*
* @var array
*/
public static $uncountable = ['audio', 'bison', 'chassis', 'compensation', 'coreopsis', 'data', 'deer', 'education', 'equipment', 'fish', 'gold', 'information', 'knowledge', 'love', 'rain', 'money', 'moose', 'nutrition', 'offspring', 'plankton', 'police', 'rice', 'series', 'sheep', 'species', 'swine', 'traffic'];
/**
* Get the plural form of an English word.
*
* @param string $value
* @param int $count
* @return string
*/
public static function plural($value, $count = 2)
{
}
/**
* Get the singular form of an English word.
*
* @param string $value
* @return string
*/
public static function singular($value)
{
}
/**
* Determine if the given value is uncountable.
*
* @param string $value
* @return bool
*/
protected static function uncountable($value)
{
}
/**
* Attempt to match the case on two strings.
*
* @param string $value
* @param string $comparison
* @return string
*/
protected static function matchCase($value, $comparison)
{
}
}
}
namespace Illuminate\Support\Facades {
abstract class Facade
{
/**
* The application instance being facaded.
*
* @var \Illuminate\Contracts\Foundation\Application
*/
protected static $app;
/**
* The resolved object instances.
*
* @var array
*/
protected static $resolvedInstance;
/**
* Hotswap the underlying instance behind the facade.
*
* @param mixed $instance
* @return void
*/
public static function swap($instance)
{
}
/**
* Initiate a mock expectation on the facade.
*
* @param mixed
* @return \Mockery\Expectation
*/
public static function shouldReceive()
{
}
/**
* Create a fresh mock instance for the given class.
*
* @param string $name
* @return \Mockery\Expectation
*/
protected static function createFreshMockInstance($name)
{
}
/**
* Create a fresh mock instance for the given class.
*
* @param string $name
* @return \Mockery\Expectation
*/
protected static function createMockByName($name)
{
}
/**
* Determines whether a mock is set as the instance of the facade.
*
* @return bool
*/
protected static function isMock()
{
}
/**
* Get the mockable class for the bound instance.
*
* @return string|null
*/
protected static function getMockableClass()
{
}
/**
* Get the root object behind the facade.
*
* @return mixed
*/
public static function getFacadeRoot()
{
}
/**
* Get the registered name of the component.
*
* @return string
*
* @throws \RuntimeException
*/
protected static function getFacadeAccessor()
{
}
/**
* Resolve the facade root instance from the container.
*
* @param string|object $name
* @return mixed
*/
protected static function resolveFacadeInstance($name)
{
}
/**
* Clear a resolved facade instance.
*
* @param string $name
* @return void
*/
public static function clearResolvedInstance($name)
{
}
/**
* Clear all of the resolved instances.
*
* @return void
*/
public static function clearResolvedInstances()
{
}
/**
* Get the application instance behind the facade.
*
* @return \Illuminate\Contracts\Foundation\Application
*/
public static function getFacadeApplication()
{
}
/**
* Set the application instance.
*
* @param \Illuminate\Contracts\Foundation\Application $app
* @return void
*/
public static function setFacadeApplication($app)
{
}
/**
* Handle dynamic, static calls to the object.
*
* @param string $method
* @param array $args
* @return mixed
*
* @throws \RuntimeException
*/
public static function __callStatic($method, $args)
{
}
}
/**
* @see \Illuminate\Routing\Router
*/
class Route extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Session\SessionManager
* @see \Illuminate\Session\Store
*/
class Session extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Config\Repository
*/
class Config extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Routing\Redirector
*/
class Redirect extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Auth\Passwords\PasswordBroker
*/
class Password extends \Illuminate\Support\Facades\Facade
{
/**
* Constant representing a successfully sent reminder.
*
* @var string
*/
const RESET_LINK_SENT = 'passwords.sent';
/**
* Constant representing a successfully reset password.
*
* @var string
*/
const PASSWORD_RESET = 'passwords.reset';
/**
* Constant representing the user not found response.
*
* @var string
*/
const INVALID_USER = 'passwords.user';
/**
* Constant representing an invalid password.
*
* @var string
*/
const INVALID_PASSWORD = 'passwords.password';
/**
* Constant representing an invalid token.
*
* @var string
*/
const INVALID_TOKEN = 'passwords.token';
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Encryption\Encrypter
*/
class Crypt extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Cookie\CookieJar
*/
class Cookie extends \Illuminate\Support\Facades\Facade
{
/**
* Determine if a cookie exists on the request.
*
* @param string $key
* @return bool
*/
public static function has($key)
{
}
/**
* Retrieve a cookie from the request.
*
* @param string $key
* @param mixed $default
* @return string
*/
public static function get($key = null, $default = null)
{
}
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\View\Compilers\BladeCompiler
*/
class Blade extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Http\Request
*/
class Request extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Redis\Database
*/
class Redis extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Contracts\Auth\Access\Gate
*/
class Gate extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Http\Request
*/
class Input extends \Illuminate\Support\Facades\Facade
{
/**
* Get an item from the input data.
*
* This method is used for all request verbs (GET, POST, PUT, and DELETE)
*
* @param string $key
* @param mixed $default
* @return mixed
*/
public static function get($key = null, $default = null)
{
}
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Database\DatabaseManager
* @see \Illuminate\Database\Connection
*/
class DB extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Mail\Mailer
*/
class Mail extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Queue\QueueManager
* @see \Illuminate\Queue\Queue
*/
class Queue extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Filesystem\FilesystemManager
*/
class Storage extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\View\Factory
*/
class View extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Auth\AuthManager
* @see \Illuminate\Contracts\Auth\Factory
* @see \Illuminate\Contracts\Auth\Guard
* @see \Illuminate\Contracts\Auth\StatefulGuard
*/
class Auth extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Translation\Translator
*/
class Lang extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Routing\UrlGenerator
*/
class URL extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Foundation\Application
*/
class App extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Database\Schema\Builder
*/
class Schema extends \Illuminate\Support\Facades\Facade
{
/**
* Get a schema builder instance for a connection.
*
* @param string $name
* @return \Illuminate\Database\Schema\Builder
*/
public static function connection($name)
{
}
/**
* Get a schema builder instance for the default connection.
*
* @return \Illuminate\Database\Schema\Builder
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Contracts\Bus\Dispatcher
*/
class Bus extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Contracts\Routing\ResponseFactory
*/
class Response extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Contracts\Console\Kernel
*/
class Artisan extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Filesystem\Filesystem
*/
class File extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Cache\CacheManager
* @see \Illuminate\Cache\Repository
*/
class Cache extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Validation\Factory
*/
class Validator extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Events\Dispatcher
*/
class Event extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Hashing\BcryptHasher
*/
class Hash extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
/**
* @see \Illuminate\Log\Writer
*/
class Log extends \Illuminate\Support\Facades\Facade
{
/**
* Get the registered name of the component.
*
* @return string
*/
protected static function getFacadeAccessor()
{
}
}
}
namespace Illuminate\Support {
class Arr
{
use \Illuminate\Support\Traits\Macroable;
/**
* Determine whether the given value is array accessible.
*
* @param mixed $value
* @return bool
*/
public static function accessible($value)
{
}
/**
* Add an element to an array using "dot" notation if it doesn't exist.
*
* @param array $array
* @param string $key
* @param mixed $value
* @return array
*/
public static function add($array, $key, $value)
{
}
/**
* Build a new array using a callback.
*
* @param array $array
* @param callable $callback
* @return array
*
* @deprecated since version 5.2.
*/
public static function build($array, callable $callback)
{
}
/**
* Collapse an array of arrays into a single array.
*
* @param array $array
* @return array
*/
public static function collapse($array)
{
}
/**
* Divide an array into two arrays. One with keys and the other with values.
*
* @param array $array
* @return array
*/
public static function divide($array)
{
}
/**
* Flatten a multi-dimensional associative array with dots.
*
* @param array $array
* @param string $prepend
* @return array
*/
public static function dot($array, $prepend = '')
{
}
/**
* Get all of the given array except for a specified array of items.
*
* @param array $array
* @param array|string $keys
* @return array
*/
public static function except($array, $keys)
{
}
/**
* Determine if the given key exists in the provided array.
*
* @param \ArrayAccess|array $array
* @param string|int $key
* @return bool
*/
public static function exists($array, $key)
{
}
/**
* Return the first element in an array passing a given truth test.
*
* @param array $array
* @param callable|null $callback
* @param mixed $default
* @return mixed
*/
public static function first($array, callable $callback = null, $default = null)
{
}
/**
* Return the last element in an array passing a given truth test.
*
* @param array $array
* @param callable|null $callback
* @param mixed $default
* @return mixed
*/
public static function last($array, callable $callback = null, $default = null)
{
}
/**
* Flatten a multi-dimensional array into a single level.
*
* @param array $array
* @param int $depth
* @return array
*/
public static function flatten($array, $depth = INF)
{
}
/**
* Remove one or many array items from a given array using "dot" notation.
*
* @param array $array
* @param array|string $keys
* @return void
*/
public static function forget(&$array, $keys)
{
}
/**
* Get an item from an array using "dot" notation.
*
* @param \ArrayAccess|array $array
* @param string $key
* @param mixed $default
* @return mixed
*/
public static function get($array, $key, $default = null)
{
}
/**
* Check if an item exists in an array using "dot" notation.
*
* @param \ArrayAccess|array $array
* @param string $key
* @return bool
*/
public static function has($array, $key)
{
}
/**
* Determines if an array is associative.
*
* An array is "associative" if it doesn't have sequential numerical keys beginning with zero.
*
* @param array $array
* @return bool
*/
public static function isAssoc(array $array)
{
}
/**
* Get a subset of the items from the given array.
*
* @param array $array
* @param array|string $keys
* @return array
*/
public static function only($array, $keys)
{
}
/**
* Pluck an array of values from an array.
*
* @param array $array
* @param string|array $value
* @param string|array|null $key
* @return array
*/
public static function pluck($array, $value, $key = null)
{
}
/**
* Explode the "value" and "key" arguments passed to "pluck".
*
* @param string|array $value
* @param string|array|null $key
* @return array
*/
protected static function explodePluckParameters($value, $key)
{
}
/**
* Push an item onto the beginning of an array.
*
* @param array $array
* @param mixed $value
* @param mixed $key
* @return array
*/
public static function prepend($array, $value, $key = null)
{
}
/**
* Get a value from the array, and remove it.
*
* @param array $array
* @param string $key
* @param mixed $default
* @return mixed
*/
public static function pull(&$array, $key, $default = null)
{
}
/**
* Set an array item to a given value using "dot" notation.
*
* If no key is given to the method, the entire array will be replaced.
*
* @param array $array
* @param string $key
* @param mixed $value
* @return array
*/
public static function set(&$array, $key, $value)
{
}
/**
* Sort the array using the given callback.
*
* @param array $array
* @param callable $callback
* @return array
*/
public static function sort($array, callable $callback)
{
}
/**
* Recursively sort an array by keys and values.
*
* @param array $array
* @return array
*/
public static function sortRecursive($array)
{
}
/**
* Filter the array using the given callback.
*
* @param array $array
* @param callable $callback
* @return array
*/
public static function where($array, callable $callback)
{
}
}
abstract class Manager
{
/**
* The application instance.
*
* @var \Illuminate\Foundation\Application
*/
protected $app;
/**
* The registered custom driver creators.
*
* @var array
*/
protected $customCreators = [];
/**
* The array of created "drivers".
*
* @var array
*/
protected $drivers = [];
/**
* Create a new manager instance.
*
* @param \Illuminate\Foundation\Application $app
* @return void
*/
public function __construct($app)
{
}
/**
* Get the default driver name.
*
* @return string
*/
public abstract function getDefaultDriver();
/**
* Get a driver instance.
*
* @param string $driver
* @return mixed
*/
public function driver($driver = null)
{
}
/**
* Create a new driver instance.
*
* @param string $driver
* @return mixed
*
* @throws \InvalidArgumentException
*/
protected function createDriver($driver)
{
}
/**
* Call a custom driver creator.
*
* @param string $driver
* @return mixed
*/
protected function callCustomCreator($driver)
{
}
/**
* Register a custom driver creator Closure.
*
* @param string $driver
* @param \Closure $callback
* @return $this
*/
public function extend($driver, \Closure $callback)
{
}
/**
* Get all of the created "drivers".
*
* @return array
*/
public function getDrivers()
{
}
/**
* Dynamically call the default driver instance.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public function __call($method, $parameters)
{
}
}
class Fluent implements \ArrayAccess, \Illuminate\Contracts\Support\Arrayable, \Illuminate\Contracts\Support\Jsonable, \JsonSerializable
{
/**
* All of the attributes set on the container.
*
* @var array
*/
protected $attributes = [];
/**
* Create a new fluent container instance.
*
* @param array|object $attributes
* @return void
*/
public function __construct($attributes = [])
{
}
/**
* Get an attribute from the container.
*
* @param string $key
* @param mixed $default
* @return mixed
*/
public function get($key, $default = null)
{
}
/**
* Get the attributes from the container.
*
* @return array
*/
public function getAttributes()
{
}
/**
* Convert the Fluent instance to an array.
*
* @return array
*/
public function toArray()
{
}
/**
* Convert the object into something JSON serializable.
*
* @return array
*/
public function jsonSerialize()
{
}
/**
* Convert the Fluent instance to JSON.
*
* @param int $options
* @return string
*/
public function toJson($options = 0)
{
}
/**
* Determine if the given offset exists.
*
* @param string $offset
* @return bool
*/
public function offsetExists($offset)
{
}
/**
* Get the value for a given offset.
*
* @param string $offset
* @return mixed
*/
public function offsetGet($offset)
{
}
/**
* Set the value at the given offset.
*
* @param string $offset
* @param mixed $value
* @return void
*/
public function offsetSet($offset, $value)
{
}
/**
* Unset the value at the given offset.
*
* @param string $offset
* @return void
*/
public function offsetUnset($offset)
{
}
/**
* Handle dynamic calls to the container to set attributes.
*
* @param string $method
* @param array $parameters
* @return $this
*/
public function __call($method, $parameters)
{
}
/**
* Dynamically retrieve the value of an attribute.
*
* @param string $key
* @return mixed
*/
public function __get($key)
{
}
/**
* Dynamically set the value of an attribute.
*
* @param string $key
* @param mixed $value
* @return void
*/
public function __set($key, $value)
{
}
/**
* Dynamically check if an attribute is set.
*
* @param string $key
* @return bool
*/
public function __isset($key)
{
}
/**
* Dynamically unset an attribute.
*
* @param string $key
* @return void
*/
public function __unset($key)
{
}
}
class AggregateServiceProvider extends \Illuminate\Support\ServiceProvider
{
/**
* The provider class names.
*
* @var array
*/
protected $providers = [];
/**
* An array of the service provider instances.
*
* @var array
*/
protected $instances = [];
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
}
/**
* Get the services provided by the provider.
*
* @return array
*/
public function provides()
{
}
}
class ClassLoader
{
/**
* The registered directories.
*
* @var array
*/
protected static $directories = [];
/**
* Indicates if a ClassLoader has been registered.
*
* @var bool
*/
protected static $registered = false;
/**
* Load the given class file.
*
* @param string $class
* @return bool
*/
public static function load($class)
{
}
/**
* Get the normal file name for a class.
*
* @param string $class
* @return string
*/
public static function normalizeClass($class)
{
}
/**
* Register the given class loader on the auto-loader stack.
*
* @return void
*/
public static function register()
{
}
/**
* Add directories to the class loader.
*
* @param string|array $directories
* @return void
*/
public static function addDirectories($directories)
{
}
/**
* Remove directories from the class loader.
*
* @param string|array $directories
* @return void
*/
public static function removeDirectories($directories = null)
{
}
/**
* Gets all the directories registered with the loader.
*
* @return array
*/
public static function getDirectories()
{
}
}
class NamespacedItemResolver
{
/**
* A cache of the parsed items.
*
* @var array
*/
protected $parsed = [];
/**
* Parse a key into namespace, group, and item.
*
* @param string $key
* @return array
*/
public function parseKey($key)
{
}
/**
* Parse an array of basic segments.
*
* @param array $segments
* @return array
*/
protected function parseBasicSegments(array $segments)
{
}
/**
* Parse an array of namespaced segments.
*
* @param string $key
* @return array
*/
protected function parseNamespacedSegments($key)
{
}
/**
* Set the parsed value of a key.
*
* @param string $key
* @param array $parsed
* @return void
*/
public function setParsedKey($key, $parsed)
{
}
}
}
namespace Illuminate\Contracts\Support {
interface Htmlable
{
/**
* Get content as a string of HTML.
*
* @return string
*/
public function toHtml();
}
}
namespace Illuminate\Support {
class HtmlString implements \Illuminate\Contracts\Support\Htmlable
{
/**
* The HTML string.
*
* @var string
*/
protected $html;
/**
* Create a new HTML string instance.
*
* @param string $html
* @return void
*/
public function __construct($html)
{
}
/**
* Get the the HTML string.
*
* @return string
*/
public function toHtml()
{
}
/**
* Get the the HTML string.
*
* @return string
*/
public function __toString()
{
}
}
}
namespace Illuminate\Contracts\Container {
interface Container
{
/**
* Determine if the given abstract type has been bound.
*
* @param string $abstract
* @return bool
*/
public function bound($abstract);
/**
* Alias a type to a different name.
*
* @param string $abstract
* @param string $alias
* @return void
*/
public function alias($abstract, $alias);
/**
* Assign a set of tags to a given binding.
*
* @param array|string $abstracts
* @param array|mixed ...$tags
* @return void
*/
public function tag($abstracts, $tags);
/**
* Resolve all of the bindings for a given tag.
*
* @param array $tag
* @return array
*/
public function tagged($tag);
/**
* Register a binding with the container.
*
* @param string|array $abstract
* @param \Closure|string|null $concrete
* @param bool $shared
* @return void
*/
public function bind($abstract, $concrete = null, $shared = false);
/**
* Register a binding if it hasn't already been registered.
*
* @param string $abstract
* @param \Closure|string|null $concrete
* @param bool $shared
* @return void
*/
public function bindIf($abstract, $concrete = null, $shared = false);
/**
* Register a shared binding in the container.
*
* @param string|array $abstract
* @param \Closure|string|null $concrete
* @return void
*/
public function singleton($abstract, $concrete = null);
/**
* "Extend" an abstract type in the container.
*
* @param string $abstract
* @param \Closure $closure
* @return void
*
* @throws \InvalidArgumentException
*/
public function extend($abstract, \Closure $closure);
/**
* Register an existing instance as shared in the container.
*
* @param string $abstract
* @param mixed $instance
* @return void
*/
public function instance($abstract, $instance);
/**
* Define a contextual binding.
*
* @param string $concrete
* @return \Illuminate\Contracts\Container\ContextualBindingBuilder
*/
public function when($concrete);
/**
* Resolve the given type from the container.
*
* @param string $abstract
* @param array $parameters
* @return mixed
*/
public function make($abstract, array $parameters = []);
/**
* Call the given Closure / class@method and inject its dependencies.
*
* @param callable|string $callback
* @param array $parameters
* @param string|null $defaultMethod
* @return mixed
*/
public function call($callback, array $parameters = [], $defaultMethod = null);
/**
* Determine if the given abstract type has been resolved.
*
* @param string $abstract
* @return bool
*/
public function resolved($abstract);
/**
* Register a new resolving callback.
*
* @param string $abstract
* @param \Closure|null $callback
* @return void
*/
public function resolving($abstract, \Closure $callback = null);
/**
* Register a new after resolving callback.
*
* @param string $abstract
* @param \Closure|null $callback
* @return void
*/
public function afterResolving($abstract, \Closure $callback = null);
}
}
namespace Illuminate\Container {
class Container implements \ArrayAccess, \Illuminate\Contracts\Container\Container
{
/**
* The current globally available container (if any).
*
* @var static
*/
protected static $instance;
/**
* An array of the types that have been resolved.
*
* @var array
*/
protected $resolved = [];
/**
* The container's bindings.
*
* @var array
*/
protected $bindings = [];
/**
* The container's shared instances.
*
* @var array
*/
protected $instances = [];
/**
* The registered type aliases.
*
* @var array
*/
protected $aliases = [];
/**
* The extension closures for services.
*
* @var array
*/
protected $extenders = [];
/**
* All of the registered tags.
*
* @var array
*/
protected $tags = [];
/**
* The stack of concretions currently being built.
*
* @var array
*/
protected $buildStack = [];
/**
* The contextual binding map.
*
* @var array
*/
public $contextual = [];
/**
* All of the registered rebound callbacks.
*
* @var array
*/
protected $reboundCallbacks = [];
/**
* All of the global resolving callbacks.
*
* @var array
*/
protected $globalResolvingCallbacks = [];
/**
* All of the global after resolving callbacks.
*
* @var array
*/
protected $globalAfterResolvingCallbacks = [];
/**
* All of the resolving callbacks by class type.
*
* @var array
*/
protected $resolvingCallbacks = [];
/**
* All of the after resolving callbacks by class type.
*
* @var array
*/
protected $afterResolvingCallbacks = [];
/**
* Define a contextual binding.
*
* @param string $concrete
* @return \Illuminate\Contracts\Container\ContextualBindingBuilder
*/
public function when($concrete)
{
}
/**
* Determine if the given abstract type has been bound.
*
* @param string $abstract
* @return bool
*/
public function bound($abstract)
{
}
/**
* Determine if the given abstract type has been resolved.
*
* @param string $abstract
* @return bool
*/
public function resolved($abstract)
{
}
/**
* Determine if a given string is an alias.
*
* @param string $name
* @return bool
*/
public function isAlias($name)
{
}
/**
* Register a binding with the container.
*
* @param string|array $abstract
* @param \Closure|string|null $concrete
* @param bool $shared
* @return void
*/
public function bind($abstract, $concrete = null, $shared = false)
{
}
/**
* Get the Closure to be used when building a type.
*
* @param string $abstract
* @param string $concrete
* @return \Closure
*/
protected function getClosure($abstract, $concrete)
{
}
/**
* Add a contextual binding to the container.
*
* @param string $concrete
* @param string $abstract
* @param \Closure|string $implementation
* @return void
*/
public function addContextualBinding($concrete, $abstract, $implementation)
{
}
/**
* Register a binding if it hasn't already been registered.
*
* @param string $abstract
* @param \Closure|string|null $concrete
* @param bool $shared
* @return void
*/
public function bindIf($abstract, $concrete = null, $shared = false)
{
}
/**
* Register a shared binding in the container.
*
* @param string|array $abstract
* @param \Closure|string|null $concrete
* @return void
*/
public function singleton($abstract, $concrete = null)
{
}
/**
* Wrap a Closure such that it is shared.
*
* @param \Closure $closure
* @return \Closure
*/
public function share(\Closure $closure)
{
}
/**
* "Extend" an abstract type in the container.
*
* @param string $abstract
* @param \Closure $closure
* @return void
*
* @throws \InvalidArgumentException
*/
public function extend($abstract, \Closure $closure)
{
}
/**
* Register an existing instance as shared in the container.
*
* @param string $abstract
* @param mixed $instance
* @return void
*/
public function instance($abstract, $instance)
{
}
/**
* Assign a set of tags to a given binding.
*
* @param array|string $abstracts
* @param array|mixed ...$tags
* @return void
*/
public function tag($abstracts, $tags)
{
}
/**
* Resolve all of the bindings for a given tag.
*
* @param string $tag
* @return array
*/
public function tagged($tag)
{
}
/**
* Alias a type to a different name.
*
* @param string $abstract
* @param string $alias
* @return void
*/
public function alias($abstract, $alias)
{
}
/**
* Extract the type and alias from a given definition.
*
* @param array $definition
* @return array
*/
protected function extractAlias(array $definition)
{
}
/**
* Bind a new callback to an abstract's rebind event.
*
* @param string $abstract
* @param \Closure $callback
* @return mixed
*/
public function rebinding($abstract, \Closure $callback)
{
}
/**
* Refresh an instance on the given target and method.
*
* @param string $abstract
* @param mixed $target
* @param string $method
* @return mixed
*/
public function refresh($abstract, $target, $method)
{
}
/**
* Fire the "rebound" callbacks for the given abstract type.
*
* @param string $abstract
* @return void
*/
protected function rebound($abstract)
{
}
/**
* Get the rebound callbacks for a given type.
*
* @param string $abstract
* @return array
*/
protected function getReboundCallbacks($abstract)
{
}
/**
* Wrap the given closure such that its dependencies will be injected when executed.
*
* @param \Closure $callback
* @param array $parameters
* @return \Closure
*/
public function wrap(\Closure $callback, array $parameters = [])
{
}
/**
* Call the given Closure / class@method and inject its dependencies.
*
* @param callable|string $callback
* @param array $parameters
* @param string|null $defaultMethod
* @return mixed
*/
public function call($callback, array $parameters = [], $defaultMethod = null)
{
}
/**
* Determine if the given string is in Class@method syntax.
*
* @param mixed $callback
* @return bool
*/
protected function isCallableWithAtSign($callback)
{
}
/**
* Get all dependencies for a given method.
*
* @param callable|string $callback
* @param array $parameters
* @return array
*/
protected function getMethodDependencies($callback, array $parameters = [])
{
}
/**
* Get the proper reflection instance for the given callback.
*
* @param callable|string $callback
* @return \ReflectionFunctionAbstract
*/
protected function getCallReflector($callback)
{
}
/**
* Get the dependency for the given call parameter.
*
* @param \ReflectionParameter $parameter
* @param array $parameters
* @param array $dependencies
* @return mixed
*/
protected function addDependencyForCallParameter(\ReflectionParameter $parameter, array &$parameters, &$dependencies)
{
}
/**
* Call a string reference to a class using Class@method syntax.
*
* @param string $target
* @param array $parameters
* @param string|null $defaultMethod
* @return mixed
*
* @throws \InvalidArgumentException
*/
protected function callClass($target, array $parameters = [], $defaultMethod = null)
{
}
/**
* Resolve the given type from the container.
*
* @param string $abstract
* @param array $parameters
* @return mixed
*/
public function make($abstract, array $parameters = [])
{
}
/**
* Get the concrete type for a given abstract.
*
* @param string $abstract
* @return mixed $concrete
*/
protected function getConcrete($abstract)
{
}
/**
* Get the contextual concrete binding for the given abstract.
*
* @param string $abstract
* @return string|null
*/
protected function getContextualConcrete($abstract)
{
}
/**
* Normalize the given class name by removing leading slashes.
*
* @param mixed $service
* @return mixed
*/
protected function normalize($service)
{
}
/**
* Get the extender callbacks for a given type.
*
* @param string $abstract
* @return array
*/
protected function getExtenders($abstract)
{
}
/**
* Instantiate a concrete instance of the given type.
*
* @param string $concrete
* @param array $parameters
* @return mixed
*
* @throws \Illuminate\Contracts\Container\BindingResolutionException
*/
public function build($concrete, array $parameters = [])
{
}
/**
* Resolve all of the dependencies from the ReflectionParameters.
*
* @param array $parameters
* @param array $primitives
* @return array
*/
protected function getDependencies(array $parameters, array $primitives = [])
{
}
/**
* Resolve a non-class hinted dependency.
*
* @param \ReflectionParameter $parameter
* @return mixed
*
* @throws \Illuminate\Contracts\Container\BindingResolutionException
*/
protected function resolveNonClass(\ReflectionParameter $parameter)
{
}
/**
* Resolve a class based dependency from the container.
*
* @param \ReflectionParameter $parameter
* @return mixed
*
* @throws \Illuminate\Contracts\Container\BindingResolutionException
*/
protected function resolveClass(\ReflectionParameter $parameter)
{
}
/**
* If extra parameters are passed by numeric ID, rekey them by argument name.
*
* @param array $dependencies
* @param array $parameters
* @return array
*/
protected function keyParametersByArgument(array $dependencies, array $parameters)
{
}
/**
* Register a new resolving callback.
*
* @param string $abstract
* @param \Closure|null $callback
* @return void
*/
public function resolving($abstract, \Closure $callback = null)
{
}
/**
* Register a new after resolving callback for all types.
*
* @param string $abstract
* @param \Closure|null $callback
* @return void
*/
public function afterResolving($abstract, \Closure $callback = null)
{
}
/**
* Register a new resolving callback by type of its first argument.
*
* @param \Closure $callback
* @return void
*/
protected function resolvingCallback(\Closure $callback)
{
}
/**
* Register a new after resolving callback by type of its first argument.
*
* @param \Closure $callback
* @return void
*/
protected function afterResolvingCallback(\Closure $callback)
{
}
/**
* Get the type hint for this closure's first argument.
*
* @param \Closure $callback
* @return mixed
*/
protected function getFunctionHint(\Closure $callback)
{
}
/**
* Fire all of the resolving callbacks.
*
* @param string $abstract
* @param mixed $object
* @return void
*/
protected function fireResolvingCallbacks($abstract, $object)
{
}
/**
* Get all callbacks for a given type.
*
* @param string $abstract
* @param object $object
* @param array $callbacksPerType
*
* @return array
*/
protected function getCallbacksForType($abstract, $object, array $callbacksPerType)
{
}
/**
* Fire an array of callbacks with an object.
*
* @param mixed $object
* @param array $callbacks
* @return void
*/
protected function fireCallbackArray($object, array $callbacks)
{
}
/**
* Determine if a given type is shared.
*
* @param string $abstract
* @return bool
*/
public function isShared($abstract)
{
}
/**
* Determine if the given concrete is buildable.
*
* @param mixed $concrete
* @param string $abstract
* @return bool
*/
protected function isBuildable($concrete, $abstract)
{
}
/**
* Get the alias for an abstract if available.
*
* @param string $abstract
* @return string
*/
protected function getAlias($abstract)
{
}
/**
* Get the container's bindings.
*
* @return array
*/
public function getBindings()
{
}
/**
* Drop all of the stale instances and aliases.
*
* @param string $abstract
* @return void
*/
protected function dropStaleInstances($abstract)
{
}
/**
* Remove a resolved instance from the instance cache.
*
* @param string $abstract
* @return void
*/
public function forgetInstance($abstract)
{
}
/**
* Clear all of the instances from the container.
*
* @return void
*/
public function forgetInstances()
{
}
/**
* Flush the container of all bindings and resolved instances.
*
* @return void
*/
public function flush()
{
}
/**
* Set the globally available instance of the container.
*
* @return static
*/
public static function getInstance()
{
}
/**
* Set the shared instance of the container.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
public static function setInstance(\Illuminate\Contracts\Container\Container $container)
{
}
/**
* Determine if a given offset exists.
*
* @param string $key
* @return bool
*/
public function offsetExists($key)
{
}
/**
* Get the value at a given offset.
*
* @param string $key
* @return mixed
*/
public function offsetGet($key)
{
}
/**
* Set the value at a given offset.
*
* @param string $key
* @param mixed $value
* @return void
*/
public function offsetSet($key, $value)
{
}
/**
* Unset the value at a given offset.
*
* @param string $key
* @return void
*/
public function offsetUnset($key)
{
}
/**
* Dynamically access container services.
*
* @param string $key
* @return mixed
*/
public function __get($key)
{
}
/**
* Dynamically set container services.
*
* @param string $key
* @param mixed $value
* @return void
*/
public function __set($key, $value)
{
}
}
}
namespace Illuminate\Contracts\Container {
interface ContextualBindingBuilder
{
/**
* Define the abstract target that depends on the context.
*
* @param string $abstract
* @return $this
*/
public function needs($abstract);
/**
* Define the implementation for the contextual binding.
*
* @param \Closure|string $implementation
* @return void
*/
public function give($implementation);
}
}
namespace Illuminate\Container {
class ContextualBindingBuilder implements \Illuminate\Contracts\Container\ContextualBindingBuilder
{
/**
* The underlying container instance.
*
* @var \Illuminate\Container\Container
*/
protected $container;
/**
* The concrete instance.
*
* @var string
*/
protected $concrete;
/**
* The abstract target.
*
* @var string
*/
protected $needs;
/**
* Create a new contextual binding builder.
*
* @param \Illuminate\Container\Container $container
* @param string $concrete
* @return void
*/
public function __construct(\Illuminate\Container\Container $container, $concrete)
{
}
/**
* Define the abstract target that depends on the context.
*
* @param string $abstract
* @return $this
*/
public function needs($abstract)
{
}
/**
* Define the implementation for the contextual binding.
*
* @param \Closure|string $implementation
* @return void
*/
public function give($implementation)
{
}
}
}
namespace Illuminate\Contracts\Redis {
interface Database
{
/**
* Run a command against the Redis database.
*
* @param string $method
* @param array $parameters
* @return mixed
*/
public function command($method, array $parameters = []);
}
}
namespace Illuminate\Contracts\Pagination {
interface Presenter
{
/**
* Render the given paginator.
*
* @return \Illuminate\Contracts\Support\Htmlable|string
*/
public function render();
/**
* Determine if the underlying paginator being presented has pages to show.
*
* @return bool
*/
public function hasPages();
}
interface Paginator
{
/**
* Get the URL for a given page.
*
* @param int $page
* @return string
*/
public function url($page);
/**
* Add a set of query string values to the paginator.
*
* @param array|string $key
* @param string|null $value
* @return $this
*/
public function appends($key, $value = null);
/**
* Get / set the URL fragment to be appended to URLs.
*
* @param string|null $fragment
* @return $this|string
*/
public function fragment($fragment = null);
/**
* The the URL for the next page, or null.
*
* @return string|null
*/
public function nextPageUrl();
/**
* Get the URL for the previous page, or null.
*
* @return string|null
*/
public function previousPageUrl();
/**
* Get all of the items being paginated.
*
* @return array
*/
public function items();
/**
* Get the "index" of the first item being paginated.
*
* @return int
*/
public function firstItem();
/**
* Get the "index" of the last item being paginated.
*
* @return int
*/
public function lastItem();
/**
* Determine how many items are being shown per page.
*
* @return int
*/
public function perPage();
/**
* Determine the current page being paginated.
*
* @return int
*/
public function currentPage();
/**
* Determine if there are enough items to split into multiple pages.
*
* @return bool
*/
public function hasPages();
/**
* Determine if there is more items in the data store.
*
* @return bool
*/
public function hasMorePages();
/**
* Determine if the list of items is empty or not.
*
* @return bool
*/
public function isEmpty();
/**
* Render the paginator using a given Presenter.
*
* @param \Illuminate\Contracts\Pagination\Presenter|null $presenter
* @return string
*/
public function render(\Illuminate\Contracts\Pagination\Presenter $presenter = null);
}
interface LengthAwarePaginator extends \Illuminate\Contracts\Pagination\Paginator
{
/**
* Determine the total number of items in the data store.
*
* @return int
*/
public function total();
/**
* Get the page number of the last available page.
*
* @return int
*/
public function lastPage();
}
}
namespace Illuminate\Contracts\Routing {
interface ResponseFactory
{
/**
* Return a new response from the application.
*
* @param string $content
* @param int $status
* @param array $headers
* @return \Illuminate\Http\Response
*/
public function make($content = '', $status = 200, array $headers = []);
/**
* Return a new view response from the application.
*
* @param string $view
* @param array $data
* @param int $status
* @param array $headers
* @return \Illuminate\Http\Response
*/
public function view($view, $data = [], $status = 200, array $headers = []);
/**
* Return a new JSON response from the application.
*
* @param string|array $data
* @param int $status
* @param array $headers
* @param int $options
* @return \Illuminate\Http\JsonResponse
*/
public function json($data = [], $status = 200, array $headers = [], $options = 0);
/**
* Return a new JSONP response from the application.
*
* @param string $callback
* @param string|array $data
* @param int $status
* @param array $headers
* @param int $options
* @return \Illuminate\Http\JsonResponse
*/
public function jsonp($callback, $data = [], $status = 200, array $headers = [], $options = 0);
/**
* Return a new streamed response from the application.
*
* @param \Closure $callback
* @param int $status
* @param array $headers
* @return \Symfony\Component\HttpFoundation\StreamedResponse
*/
public function stream($callback, $status = 200, array $headers = []);
/**
* Create a new file download response.
*
* @param \SplFileInfo|string $file
* @param string $name
* @param array $headers
* @param string|null $disposition
* @return \Symfony\Component\HttpFoundation\BinaryFileResponse
*/
public function download($file, $name = null, array $headers = [], $disposition = 'attachment');
/**
* Create a new redirect response to the given path.
*
* @param string $path
* @param int $status
* @param array $headers
* @param bool|null $secure
* @return \Illuminate\Http\RedirectResponse
*/
public function redirectTo($path, $status = 302, $headers = [], $secure = null);
/**
* Create a new redirect response to a named route.
*
* @param string $route
* @param array $parameters
* @param int $status
* @param array $headers
* @return \Illuminate\Http\RedirectResponse
*/
public function redirectToRoute($route, $parameters = [], $status = 302, $headers = []);
/**
* Create a new redirect response to a controller action.
*
* @param string $action
* @param array $parameters
* @param int $status
* @param array $headers
* @return \Illuminate\Http\RedirectResponse
*/
public function redirectToAction($action, $parameters = [], $status = 302, $headers = []);
/**
* Create a new redirect response, while putting the current URL in the session.
*
* @param string $path
* @param int $status
* @param array $headers
* @param bool|null $secure
* @return \Illuminate\Http\RedirectResponse
*/
public function redirectGuest($path, $status = 302, $headers = [], $secure = null);
/**
* Create a new redirect response to the previously intended location.
*
* @param string $default
* @param int $status
* @param array $headers
* @param bool|null $secure
* @return \Illuminate\Http\RedirectResponse
*/
public function redirectToIntended($default = '/', $status = 302, $headers = [], $secure = null);
}
interface UrlGenerator
{
/**
* Get the current URL for the request.
*
* @return string
*/
public function current();
/**
* Generate a absolute URL to the given path.
*
* @param string $path
* @param mixed $extra
* @param bool $secure
* @return string
*/
public function to($path, $extra = [], $secure = null);
/**
* Generate a secure, absolute URL to the given path.
*
* @param string $path
* @param array $parameters
* @return string
*/
public function secure($path, $parameters = []);
/**
* Generate a URL to an application asset.
*
* @param string $path
* @param bool $secure
* @return string
*/
public function asset($path, $secure = null);
/**
* Get the URL to a named route.
*
* @param string $name
* @param mixed $parameters
* @param bool $absolute
* @return string
*
* @throws \InvalidArgumentException
*/
public function route($name, $parameters = [], $absolute = true);
/**
* Get the URL to a controller action.
*
* @param string $action
* @param mixed $parameters
* @param bool $absolute
* @return string
*/
public function action($action, $parameters = [], $absolute = true);
/**
* Set the root controller namespace.
*
* @param string $rootNamespace
* @return $this
*/
public function setRootControllerNamespace($rootNamespace);
}
interface Registrar
{
/**
* Register a new GET route with the router.
*
* @param string $uri
* @param \Closure|array|string $action
* @return void
*/
public function get($uri, $action);
/**
* Register a new POST route with the router.
*
* @param string $uri
* @param \Closure|array|string $action
* @return void
*/
public function post($uri, $action);
/**
* Register a new PUT route with the router.
*
* @param string $uri
* @param \Closure|array|string $action
* @return void
*/
public function put($uri, $action);
/**
* Register a new DELETE route with the router.
*
* @param string $uri
* @param \Closure|array|string $action
* @return void
*/
public function delete($uri, $action);
/**
* Register a new PATCH route with the router.
*
* @param string $uri
* @param \Closure|array|string $action
* @return void
*/
public function patch($uri, $action);
/**
* Register a new OPTIONS route with the router.
*
* @param string $uri
* @param \Closure|array|string $action
* @return void
*/
public function options($uri, $action);
/**
* Register a new route with the given verbs.
*
* @param array|string $methods
* @param string $uri
* @param \Closure|array|string $action
* @return void
*/
public function match($methods, $uri, $action);
/**
* Route a resource to a controller.
*
* @param string $name
* @param string $controller
* @param array $options
* @return void
*/
public function resource($name, $controller, array $options = []);
/**
* Create a route group with shared attributes.
*
* @param array $attributes
* @param \Closure $callback
* @return void
*/
public function group(array $attributes, \Closure $callback);
}
}
namespace Illuminate\Contracts\View {
interface Factory
{
/**
* Determine if a given view exists.
*
* @param string $view
* @return bool
*/
public function exists($view);
/**
* Get the evaluated view contents for the given path.
*
* @param string $path
* @param array $data
* @param array $mergeData
* @return \Illuminate\Contracts\View\View
*/
public function file($path, $data = [], $mergeData = []);
/**
* Get the evaluated view contents for the given view.
*
* @param string $view
* @param array $data
* @param array $mergeData
* @return \Illuminate\Contracts\View\View
*/
public function make($view, $data = [], $mergeData = []);
/**
* Add a piece of shared data to the environment.
*
* @param array|string $key
* @param mixed $value
* @return mixed
*/
public function share($key, $value = null);
/**
* Register a view composer event.
*
* @param array|string $views
* @param \Closure|string $callback
* @param int|null $priority
* @return array
*/
public function composer($views, $callback, $priority = null);
/**
* Register a view creator event.
*
* @param array|string $views
* @param \Closure|string $callback
* @return array
*/
public function creator($views, $callback);
/**
* Add a new namespace to the loader.
*
* @param string $namespace
* @param string|array $hints
* @return void
*/
public function addNamespace($namespace, $hints);
}
}
namespace Illuminate\Contracts\Support {
interface Renderable
{
/**
* Get the evaluated contents of the object.
*
* @return string
*/
public function render();
}
}
namespace Illuminate\Contracts\View {
interface View extends \Illuminate\Contracts\Support\Renderable
{
/**
* Get the name of the view.
*
* @return string
*/
public function name();
/**
* Add a piece of data to the view.
*
* @param string|array $key
* @param mixed $value
* @return $this
*/
public function with($key, $value = null);
}
}
namespace Illuminate\Contracts\Pipeline {
interface Hub
{
/**
* Send an object through one of the available pipelines.
*
* @param mixed $object
* @param string|null $pipeline
* @return mixed
*/
public function pipe($object, $pipeline = null);
}
interface Pipeline
{
/**
* Set the traveler object being sent on the pipeline.
*
* @param mixed $traveler
* @return $this
*/
public function send($traveler);
/**
* Set the stops of the pipeline.
*
* @param dynamic|array $stops
* @return $this
*/
public function through($stops);
/**
* Set the method to call on the stops.
*
* @param string $method
* @return $this
*/
public function via($method);
/**
* Run the pipeline with a final destination callback.
*
* @param \Closure $destination
* @return mixed
*/
public function then(\Closure $destination);
}
}
namespace Illuminate\Contracts\Debug {
interface ExceptionHandler
{
/**
* Report or log an exception.
*
* @param \Exception $e
* @return void
*/
public function report(\Exception $e);
/**
* Render an exception into an HTTP response.
*
* @param \Illuminate\Http\Request $request
* @param \Exception $e
* @return \Symfony\Component\HttpFoundation\Response
*/
public function render($request, \Exception $e);
/**
* Render an exception to the console.
*
* @param \Symfony\Component\Console\Output\OutputInterface $output
* @param \Exception $e
* @return void
*/
public function renderForConsole($output, \Exception $e);
}
}
namespace Illuminate\Contracts\Cache {
interface Factory
{
/**
* Get a cache store instance by name.
*
* @param string|null $name
* @return mixed
*/
public function store($name = null);
}
interface Store
{
/**
* Retrieve an item from the cache by key.
*
* @param string|array $key
* @return mixed
*/
public function get($key);
/**
* Retrieve multiple items from the cache by key.
*
* Items not found in the cache will have a null value.
*
* @param array $keys
* @return array
*/
public function many(array $keys);
/**
* Store an item in the cache for a given number of minutes.
*
* @param string $key
* @param mixed $value
* @param int $minutes
* @return void
*/
public function put($key, $value, $minutes);
/**
* Store multiple items in the cache for a given number of minutes.
*
* @param array $values
* @param int $minutes
* @return void
*/
public function putMany(array $values, $minutes);
/**
* Increment the value of an item in the cache.
*
* @param string $key
* @param mixed $value
* @return int|bool
*/
public function increment($key, $value = 1);
/**
* Decrement the value of an item in the cache.
*
* @param string $key
* @param mixed $value
* @return int|bool
*/
public function decrement($key, $value = 1);
/**
* Store an item in the cache indefinitely.
*
* @param string $key
* @param mixed $value
* @return void
*/
public function forever($key, $value);
/**
* Remove an item from the cache.
*
* @param string $key
* @return bool
*/
public function forget($key);
/**
* Remove all items from the cache.
*
* @return void
*/
public function flush();
/**
* Get the cache key prefix.
*
* @return string
*/
public function getPrefix();
}
interface Repository
{
/**
* Determine if an item exists in the cache.
*
* @param string $key
* @return bool
*/
public function has($key);
/**
* Retrieve an item from the cache by key.
*
* @param string $key
* @param mixed $default
* @return mixed
*/
public function get($key, $default = null);
/**
* Retrieve an item from the cache and delete it.
*
* @param string $key
* @param mixed $default
* @return mixed
*/
public function pull($key, $default = null);
/**
* Store an item in the cache.
*
* @param string $key
* @param mixed $value
* @param \DateTime|int $minutes
* @return void
*/
public function put($key, $value, $minutes);
/**
* Store an item in the cache if the key does not exist.
*
* @param string $key
* @param mixed $value
* @param \DateTime|int $minutes
* @return bool
*/
public function add($key, $value, $minutes);
/**
* Store an item in the cache indefinitely.
*
* @param string $key
* @param mixed $value
* @return void
*/
public function forever($key, $value);
/**
* Get an item from the cache, or store the default value.
*
* @param string $key
* @param \DateTime|int $minutes
* @param \Closure $callback
* @return mixed
*/
public function remember($key, $minutes, \Closure $callback);
/**
* Get an item from the cache, or store the default value forever.
*
* @param string $key
* @param \Closure $callback
* @return mixed
*/
public function sear($key, \Closure $callback);
/**
* Get an item from the cache, or store the default value forever.
*
* @param string $key
* @param \Closure $callback
* @return mixed
*/
public function rememberForever($key, \Closure $callback);
/**
* Remove an item from the cache.
*
* @param string $key
* @return bool
*/
public function forget($key);
}
}
namespace Illuminate\Contracts\Database {
class ModelIdentifier
{
/**
* The class name of the model.
*
* @var string
*/
public $class;
/**
* The unique identifier of the model.
*
* This may be either a single ID or an array of IDs.
*
* @var mixed
*/
public $id;
/**
* Create a new model identifier.
*
* @param string $class
* @param mixed $id
* @return void
*/
public function __construct($class, $id)
{
}
}
}
namespace Illuminate\Contracts\Cookie {
interface Factory
{
/**
* Create a new cookie instance.
*
* @param string $name
* @param string $value
* @param int $minutes
* @param string $path
* @param string $domain
* @param bool $secure
* @param bool $httpOnly
* @return \Symfony\Component\HttpFoundation\Cookie
*/
public function make($name, $value, $minutes = 0, $path = null, $domain = null, $secure = false, $httpOnly = true);
/**
* Create a cookie that lasts "forever" (five years).
*
* @param string $name
* @param string $value
* @param string $path
* @param string $domain
* @param bool $secure
* @param bool $httpOnly
* @return \Symfony\Component\HttpFoundation\Cookie
*/
public function forever($name, $value, $path = null, $domain = null, $secure = false, $httpOnly = true);
/**
* Expire the given cookie.
*
* @param string $name
* @param string $path
* @param string $domain
* @return \Symfony\Component\HttpFoundation\Cookie
*/
public function forget($name, $path = null, $domain = null);
}
interface QueueingFactory extends \Illuminate\Contracts\Cookie\Factory
{
/**
* Queue a cookie to send with the next response.
*
* @param mixed
* @return void
*/
public function queue();
/**
* Remove a cookie from the queue.
*
* @param string $name
*/
public function unqueue($name);
/**
* Get the cookies which have been queued for the next request.
*
* @return array
*/
public function getQueuedCookies();
}
}
namespace Illuminate\Contracts\Bus {
interface Dispatcher
{
/**
* Dispatch a command to its appropriate handler.
*
* @param mixed $command
* @return mixed
*/
public function dispatch($command);
/**
* Dispatch a command to its appropriate handler in the current process.
*
* @param mixed $command
* @return mixed
*/
public function dispatchNow($command);
/**
* Set the pipes commands should be piped through before dispatching.
*
* @param array $pipes
* @return $this
*/
public function pipeThrough(array $pipes);
}
/**
* @deprecated since version 5.2. Remove from jobs since self-handling is default.
*/
interface SelfHandling
{
//
}
interface QueueingDispatcher extends \Illuminate\Contracts\Bus\Dispatcher
{
/**
* Dispatch a command to its appropriate handler behind a queue.
*
* @param mixed $command
* @return mixed
*/
public function dispatchToQueue($command);
}
}
namespace Illuminate\Contracts\Foundation {
interface Application extends \Illuminate\Contracts\Container\Container
{
/**
* Get the version number of the application.
*
* @return string
*/
public function version();
/**
* Get the base path of the Laravel installation.
*
* @return string
*/
public function basePath();
/**
* Get or check the current application environment.
*
* @param mixed
* @return string
*/
public function environment();
/**
* Determine if the application is currently down for maintenance.
*
* @return bool
*/
public function isDownForMaintenance();
/**
* Register all of the configured providers.
*
* @return void
*/
public function registerConfiguredProviders();
/**
* Register a service provider with the application.
*
* @param \Illuminate\Support\ServiceProvider|string $provider
* @param array $options
* @param bool $force
* @return \Illuminate\Support\ServiceProvider
*/
public function register($provider, $options = [], $force = false);
/**
* Register a deferred provider and service.
*
* @param string $provider
* @param string $service
* @return void
*/
public function registerDeferredProvider($provider, $service = null);
/**
* Boot the application's service providers.
*
* @return void
*/
public function boot();
/**
* Register a new boot listener.
*
* @param mixed $callback
* @return void
*/
public function booting($callback);
/**
* Register a new "booted" listener.
*
* @param mixed $callback
* @return void
*/
public function booted($callback);
/**
* Get the path to the cached "compiled.php" file.
*
* @return string
*/
public function getCachedCompilePath();
/**
* Get the path to the cached services.php file.
*
* @return string
*/
public function getCachedServicesPath();
}
}
namespace Illuminate\Contracts\Validation {
interface ValidatesWhenResolved
{
/**
* Validate the given class instance.
*
* @return void
*/
public function validate();
}
class ValidationException extends \RuntimeException
{
/**
* The message provider implementation.
*
* @var \Illuminate\Contracts\Support\MessageProvider
*/
protected $provider;
/**
* Create a new validation exception instance.
*
* @param \Illuminate\Contracts\Support\MessageProvider $provider
* @return void
*/
public function __construct(\Illuminate\Contracts\Support\MessageProvider $provider)
{
}
/**
* Get the validation error message provider.
*
* @return \Illuminate\Contracts\Support\MessageBag
*/
public function errors()
{
}
/**
* Get the validation error message provider.
*
* @return \Illuminate\Contracts\Support\MessageProvider
*/
public function getMessageProvider()
{
}
}
interface Factory
{
/**
* Create a new Validator instance.
*
* @param array $data
* @param array $rules
* @param array $messages
* @param array $customAttributes
* @return \Illuminate\Contracts\Validation\Validator
*/
public function make(array $data, array $rules, array $messages = [], array $customAttributes = []);
/**
* Register a custom validator extension.
*
* @param string $rule
* @param \Closure|string $extension
* @param string $message
* @return void
*/
public function extend($rule, $extension, $message = null);
/**
* Register a custom implicit validator extension.
*
* @param string $rule
* @param \Closure|string $extension
* @param string $message
* @return void
*/
public function extendImplicit($rule, $extension, $message = null);
/**
* Register a custom implicit validator message replacer.
*
* @param string $rule
* @param \Closure|string $replacer
* @return void
*/
public function replacer($rule, $replacer);
}
class UnauthorizedException extends \RuntimeException
{
//
}
interface Validator extends \Illuminate\Contracts\Support\MessageProvider
{
/**
* Determine if the data fails the validation rules.
*
* @return bool
*/
public function fails();
/**
* Get the failed validation rules.
*
* @return array
*/
public function failed();
/**
* Add conditions to a given field based on a Closure.
*
* @param string $attribute
* @param string|array $rules
* @param callable $callback
* @return void
*/
public function sometimes($attribute, $rules, callable $callback);
/**
* After an after validation callback.
*
* @param callable|string $callback
* @return $this
*/
public function after($callback);
}
}
namespace Illuminate\Contracts\Auth {
interface CanResetPassword
{
/**
* Get the e-mail address where password reset links are sent.
*
* @return string
*/
public function getEmailForPasswordReset();
}
interface Guard
{
/**
* Determine if the current user is authenticated.
*
* @return bool
*/
public function check();
/**
* Determine if the current user is a guest.
*
* @return bool
*/
public function guest();
/**
* Get the currently authenticated user.
*
* @return \Illuminate\Contracts\Auth\Authenticatable|null
*/
public function user();
/**
* Get the ID for the currently authenticated user.
*
* @return int|null
*/
public function id();
/**
* Validate a user's credentials.
*
* @param array $credentials
* @return bool
*/
public function validate(array $credentials = []);
/**
* Set the current user.
*
* @param \Illuminate\Contracts\Auth\Authenticatable $user
* @return void
*/
public function setUser(\Illuminate\Contracts\Auth\Authenticatable $user);
}
interface StatefulGuard extends \Illuminate\Contracts\Auth\Guard
{
/**
* Attempt to authenticate a user using the given credentials.
*
* @param array $credentials
* @param bool $remember
* @param bool $login
* @return bool
*/
public function attempt(array $credentials = [], $remember = false, $login = true);
/**
* Log a user into the application without sessions or cookies.
*
* @param array $credentials
* @return bool
*/
public function once(array $credentials = []);
/**
* Log a user into the application.
*
* @param \Illuminate\Contracts\Auth\Authenticatable $user
* @param bool $remember
* @return void
*/
public function login(\Illuminate\Contracts\Auth\Authenticatable $user, $remember = false);
/**
* Log the given user ID into the application.
*
* @param mixed $id
* @param bool $remember
* @return \Illuminate\Contracts\Auth\Authenticatable
*/
public function loginUsingId($id, $remember = false);
/**
* Log the given user ID into the application without sessions or cookies.
*
* @param mixed $id
* @return bool
*/
public function onceUsingId($id);
/**
* Determine if the user was authenticated via "remember me" cookie.
*
* @return bool
*/
public function viaRemember();
/**
* Log the user out of the application.
*
* @return void
*/
public function logout();
}
interface SupportsBasicAuth
{
/**
* Attempt to authenticate using HTTP Basic Auth.
*
* @param string $field
* @param array $extraConditions
* @return \Symfony\Component\HttpFoundation\Response|null
*/
public function basic($field = 'email', $extraConditions = []);
/**
* Perform a stateless HTTP Basic login attempt.
*
* @param string $field
* @param array $extraConditions
* @return \Symfony\Component\HttpFoundation\Response|null
*/
public function onceBasic($field = 'email', $extraConditions = []);
}
interface Factory
{
/**
* Get a guard instance by name.
*
* @param string|null $name
* @return mixed
*/
public function guard($name = null);
/**
* Set the default guard the factory should serve.
*
* @param string $name
* @return void
*/
public function shouldUse($name);
}
interface UserProvider
{
/**
* Retrieve a user by their unique identifier.
*
* @param mixed $identifier
* @return \Illuminate\Contracts\Auth\Authenticatable|null
*/
public function retrieveById($identifier);
/**
* Retrieve a user by their unique identifier and "remember me" token.
*
* @param mixed $identifier
* @param string $token
* @return \Illuminate\Contracts\Auth\Authenticatable|null
*/
public function retrieveByToken($identifier, $token);
/**
* Update the "remember me" token for the given user in storage.
*
* @param \Illuminate\Contracts\Auth\Authenticatable $user
* @param string $token
* @return void
*/
public function updateRememberToken(\Illuminate\Contracts\Auth\Authenticatable $user, $token);
/**
* Retrieve a user by the given credentials.
*
* @param array $credentials
* @return \Illuminate\Contracts\Auth\Authenticatable|null
*/
public function retrieveByCredentials(array $credentials);
/**
* Validate a user against the given credentials.
*
* @param \Illuminate\Contracts\Auth\Authenticatable $user
* @param array $credentials
* @return bool
*/
public function validateCredentials(\Illuminate\Contracts\Auth\Authenticatable $user, array $credentials);
}
interface Registrar
{
/**
* Get a validator for an incoming registration request.
*
* @param array $data
* @return \Illuminate\Contracts\Validation\Validator
*/
public function validator(array $data);
/**
* Create a new user instance after a valid registration.
*
* @param array $data
* @return \Illuminate\Contracts\Auth\Authenticatable
*/
public function create(array $data);
}
interface Authenticatable
{
/**
* Get the name of the unique identifier for the user.
*
* @return string
*/
public function getAuthIdentifierName();
/**
* Get the unique identifier for the user.
*
* @return mixed
*/
public function getAuthIdentifier();
/**
* Get the password for the user.
*
* @return string
*/
public function getAuthPassword();
/**
* Get the token value for the "remember me" session.
*
* @return string
*/
public function getRememberToken();
/**
* Set the token value for the "remember me" session.
*
* @param string $value
* @return void
*/
public function setRememberToken($value);
/**
* Get the column name for the "remember me" token.
*
* @return string
*/
public function getRememberTokenName();
}
}
namespace Illuminate\Contracts\Auth\Access {
interface Authorizable
{
/**
* Determine if the entity has a given ability.
*
* @param string $ability
* @param array|mixed $arguments
* @return bool
*/
public function can($ability, $arguments = []);
}
interface Gate
{
/**
* Determine if a given ability has been defined.
*
* @param string $ability
* @return bool
*/
public function has($ability);
/**
* Define a new ability.
*
* @param string $ability
* @param callable|string $callback
* @return $this
*/
public function define($ability, $callback);
/**
* Define a policy class for a given class type.
*
* @param string $class
* @param string $policy
* @return $this
*/
public function policy($class, $policy);
/**
* Register a callback to run before all Gate checks.
*
* @param callable $callback
* @return $this
*/
public function before(callable $callback);
/**
* Determine if the given ability should be granted for the current user.
*
* @param string $ability
* @param array|mixed $arguments
* @return bool
*/
public function allows($ability, $arguments = []);
/**
* Determine if the given ability should be denied for the current user.
*
* @param string $ability
* @param array|mixed $arguments
* @return bool
*/
public function denies($ability, $arguments = []);
/**
* Determine if the given ability should be granted.
*
* @param string $ability
* @param array|mixed $arguments
* @return bool
*/
public function check($ability, $arguments = []);
/**
* Get a guard instance for the given user.
*
* @param \Illuminate\Contracts\Auth\Authenticatable|mixed $user
* @return static
*/
public function forUser($user);
}
}
namespace Illuminate\Contracts\Auth {
interface PasswordBroker
{
/**
* Constant representing a successfully sent reminder.
*
* @var string
*/
const RESET_LINK_SENT = 'passwords.sent';
/**
* Constant representing a successfully reset password.
*
* @var string
*/
const PASSWORD_RESET = 'passwords.reset';
/**
* Constant representing the user not found response.
*
* @var string
*/
const INVALID_USER = 'passwords.user';
/**
* Constant representing an invalid password.
*
* @var string
*/
const INVALID_PASSWORD = 'passwords.password';
/**
* Constant representing an invalid token.
*
* @var string
*/
const INVALID_TOKEN = 'passwords.token';
/**
* Send a password reset link to a user.
*
* @param array $credentials
* @param \Closure|null $callback
* @return string
*/
public function sendResetLink(array $credentials, \Closure $callback = null);
/**
* Reset the password for the given token.
*
* @param array $credentials
* @param \Closure $callback
* @return mixed
*/
public function reset(array $credentials, \Closure $callback);
/**
* Set a custom password validator.
*
* @param \Closure $callback
* @return void
*/
public function validator(\Closure $callback);
/**
* Determine if the passwords match for the request.
*
* @param array $credentials
* @return bool
*/
public function validateNewPassword(array $credentials);
}
interface PasswordBrokerFactory
{
/**
* Get a password broker instance by name.
*
* @param string|null $name
* @return mixed
*/
public function broker($name = null);
}
}
namespace Illuminate\Contracts\Console {
interface Application
{
/**
* Call a console application command.
*
* @param string $command
* @param array $parameters
* @return int
*/
public function call($command, array $parameters = []);
/**
* Get the output from the last command.
*
* @return string
*/
public function output();
}
interface Kernel
{
/**
* Handle an incoming console command.
*
* @param \Symfony\Component\Console\Input\InputInterface $input
* @param \Symfony\Component\Console\Output\OutputInterface $output
* @return int
*/
public function handle($input, $output = null);
/**
* Run an Artisan console command by name.
*
* @param string $command
* @param array $parameters
* @return int
*/
public function call($command, array $parameters = []);
/**
* Queue an Artisan console command by name.
*
* @param string $command
* @param array $parameters
* @return int
*/
public function queue($command, array $parameters = []);
/**
* Get all of the commands registered with the console.
*
* @return array
*/
public function all();
/**
* Get the output for the last run command.
*
* @return string
*/
public function output();
}
}
namespace Illuminate\Contracts\Mail {
interface MailQueue
{
/**
* Queue a new e-mail message for sending.
*
* @param string|array $view
* @param array $data
* @param \Closure|string $callback
* @param string $queue
* @return mixed
*/
public function queue($view, array $data, $callback, $queue = null);
/**
* Queue a new e-mail message for sending after (n) seconds.
*
* @param int $delay
* @param string|array $view
* @param array $data
* @param \Closure|string $callback
* @param string $queue
* @return mixed
*/
public function later($delay, $view, array $data, $callback, $queue = null);
}
interface Mailer
{
/**
* Send a new message when only a raw text part.
*
* @param string $text
* @param \Closure|string $callback
* @return int
*/
public function raw($text, $callback);
/**
* Send a new message using a view.
*
* @param string|array $view
* @param array $data
* @param \Closure|string $callback
* @return void
*/
public function send($view, array $data, $callback);
/**
* Get the array of failed recipients.
*
* @return array
*/
public function failures();
}
}
namespace Illuminate\Contracts\Events {
interface Dispatcher
{
/**
* Register an event listener with the dispatcher.
*
* @param string|array $events
* @param mixed $listener
* @param int $priority
* @return void
*/
public function listen($events, $listener, $priority = 0);
/**
* Determine if a given event has listeners.
*
* @param string $eventName
* @return bool
*/
public function hasListeners($eventName);
/**
* Register an event and payload to be fired later.
*
* @param string $event
* @param array $payload
* @return void
*/
public function push($event, $payload = []);
/**
* Register an event subscriber with the dispatcher.
*
* @param object|string $subscriber
* @return void
*/
public function subscribe($subscriber);
/**
* Fire an event until the first non-null response is returned.
*
* @param string $event
* @param array $payload
* @return mixed
*/
public function until($event, $payload = []);
/**
* Flush a set of pushed events.
*
* @param string $event
* @return void
*/
public function flush($event);
/**
* Fire an event and call the listeners.
*
* @param string|object $event
* @param mixed $payload
* @param bool $halt
* @return array|null
*/
public function fire($event, $payload = [], $halt = false);
/**
* Get the event that is currently firing.
*
* @return string
*/
public function firing();
/**
* Remove a set of listeners from the dispatcher.
*
* @param string $event
* @return void
*/
public function forget($event);
/**
* Forget all of the queued listeners.
*
* @return void
*/
public function forgetPushed();
}
}
namespace Illuminate\Contracts\Encryption {
class DecryptException extends \RuntimeException
{
//
}
class EncryptException extends \RuntimeException
{
//
}
interface Encrypter
{
/**
* Encrypt the given value.
*
* @param string $value
* @return string
*/
public function encrypt($value);
/**
* Decrypt the given value.
*
* @param string $payload
* @return string
*/
public function decrypt($payload);
}
}
namespace Illuminate\Contracts\Queue {
interface Job
{
/**
* Fire the job.
*
* @return void
*/
public function fire();
/**
* Delete the job from the queue.
*
* @return void
*/
public function delete();
/**
* Determine if the job has been deleted.
*
* @return bool
*/
public function isDeleted();
/**
* Release the job back into the queue.
*
* @param int $delay
* @return void
*/
public function release($delay = 0);
/**
* Determine if the job has been deleted or released.
*
* @return bool
*/
public function isDeletedOrReleased();
/**
* Get the number of times the job has been attempted.
*
* @return int
*/
public function attempts();
/**
* Get the name of the queued job class.
*
* @return string
*/
public function getName();
/**
* Call the failed method on the job instance.
*
* @return void
*/
public function failed();
/**
* Get the name of the queue the job belongs to.
*
* @return string
*/
public function getQueue();
/**
* Get the raw body string for the job.
*
* @return string
*/
public function getRawBody();
}
class EntityNotFoundException extends \InvalidArgumentException
{
/**
* Create a new exception instance.
*
* @param string $type
* @param mixed $id
* @return void
*/
public function __construct($type, $id)
{
}
}
interface Factory
{
/**
* Resolve a queue connection instance.
*
* @param string $name
* @return \Illuminate\Contracts\Queue\Queue
*/
public function connection($name = null);
}
interface Queue
{
/**
* Push a new job onto the queue.
*
* @param string $job
* @param mixed $data
* @param string $queue
* @return mixed
*/
public function push($job, $data = '', $queue = null);
/**
* Push a raw payload onto the queue.
*
* @param string $payload
* @param string $queue
* @param array $options
* @return mixed
*/
public function pushRaw($payload, $queue = null, array $options = []);
/**
* Push a new job onto the queue after a delay.
*
* @param \DateTime|int $delay
* @param string $job
* @param mixed $data
* @param string $queue
* @return mixed
*/
public function later($delay, $job, $data = '', $queue = null);
/**
* Push a new job onto the queue.
*
* @param string $queue
* @param string $job
* @param mixed $data
* @return mixed
*/
public function pushOn($queue, $job, $data = '');
/**
* Push a new job onto the queue after a delay.
*
* @param string $queue
* @param \DateTime|int $delay
* @param string $job
* @param mixed $data
* @return mixed
*/
public function laterOn($queue, $delay, $job, $data = '');
/**
* Pop the next job off of the queue.
*
* @param string $queue
* @return \Illuminate\Contracts\Queue\Job|null
*/
public function pop($queue = null);
}
interface ShouldQueue
{
//
}
interface Monitor
{
/**
* Register a callback to be executed on every iteration through the queue loop.
*
* @param mixed $callback
* @return void
*/
public function looping($callback);
/**
* Register a callback to be executed when a job fails after the maximum amount of retries.
*
* @param mixed $callback
* @return void
*/
public function failing($callback);
/**
* Register a callback to be executed when a daemon queue is stopping.
*
* @param mixed $callback
* @return void
*/
public function stopping($callback);
}
}
namespace Illuminate\Contracts\Broadcasting {
interface ShouldBroadcast
{
/**
* Get the channels the event should broadcast on.
*
* @return array
*/
public function broadcastOn();
}
interface ShouldBroadcastNow extends \Illuminate\Contracts\Broadcasting\ShouldBroadcast
{
//
}
interface Factory
{
/**
* Get a broadcaster implementation by name.
*
* @param string $name
* @return void
*/
public function connection($name = null);
}
interface Broadcaster
{
/**
* Broadcast the given event.
*
* @param array $channels
* @param string $event
* @param array $payload
* @return void
*/
public function broadcast(array $channels, $event, array $payload = []);
}
}
namespace Illuminate\Contracts\Logging {
interface Log
{
/**
* Log an alert message to the logs.
*
* @param string $message
* @param array $context
* @return void
*/
public function alert($message, array $context = []);
/**
* Log a critical message to the logs.
*
* @param string $message
* @param array $context
* @return void
*/
public function critical($message, array $context = []);
/**
* Log an error message to the logs.
*
* @param string $message
* @param array $context
* @return void
*/
public function error($message, array $context = []);
/**
* Log a warning message to the logs.
*
* @param string $message
* @param array $context
* @return void
*/
public function warning($message, array $context = []);
/**
* Log a notice to the logs.
*
* @param string $message
* @param array $context
* @return void
*/
public function notice($message, array $context = []);
/**
* Log an informational message to the logs.
*
* @param string $message
* @param array $context
* @return void
*/
public function info($message, array $context = []);
/**
* Log a debug message to the logs.
*
* @param string $message
* @param array $context
* @return void
*/
public function debug($message, array $context = []);
/**
* Log a message to the logs.
*
* @param string $level
* @param string $message
* @param array $context
* @return void
*/
public function log($level, $message, array $context = []);
/**
* Register a file log handler.
*
* @param string $path
* @param string $level
* @return void
*/
public function useFiles($path, $level = 'debug');
/**
* Register a daily file log handler.
*
* @param string $path
* @param int $days
* @param string $level
* @return void
*/
public function useDailyFiles($path, $days = 0, $level = 'debug');
}
}
namespace Illuminate\Contracts\Http {
interface Kernel
{
/**
* Bootstrap the application for HTTP requests.
*
* @return void
*/
public function bootstrap();
/**
* Handle an incoming HTTP request.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* @return \Symfony\Component\HttpFoundation\Response
*/
public function handle($request);
/**
* Perform any final actions for the request lifecycle.
*
* @param \Symfony\Component\HttpFoundation\Request $request
* @param \Symfony\Component\HttpFoundation\Response $response
* @return void
*/
public function terminate($request, $response);
/**
* Get the Laravel application instance.
*
* @return \Illuminate\Contracts\Foundation\Application
*/
public function getApplication();
}
}
namespace Illuminate\Contracts\Container {
class BindingResolutionException extends \Exception
{
//
}
}
namespace Illuminate\Contracts\Config {
interface Repository
{
/**
* Determine if the given configuration value exists.
*
* @param string $key
* @return bool
*/
public function has($key);
/**
* Get the specified configuration value.
*
* @param string $key
* @param mixed $default
* @return mixed
*/
public function get($key, $default = null);
/**
* Get all of the configuration items for the application.
*
* @return array
*/
public function all();
/**
* Set a given configuration value.
*
* @param array|string $key
* @param mixed $value
* @return void
*/
public function set($key, $value = null);
/**
* Prepend a value onto an array configuration value.
*
* @param string $key
* @param mixed $value
* @return void
*/
public function prepend($key, $value);
/**
* Push a value onto an array configuration value.
*
* @param string $key
* @param mixed $value
* @return void
*/
public function push($key, $value);
}
}
namespace Illuminate\Contracts\Filesystem {
class FileNotFoundException extends \Exception
{
//
}
interface Filesystem
{
/**
* The public visibility setting.
*
* @var string
*/
const VISIBILITY_PUBLIC = 'public';
/**
* The private visibility setting.
*
* @var string
*/
const VISIBILITY_PRIVATE = 'private';
/**
* Determine if a file exists.
*
* @param string $path
* @return bool
*/
public function exists($path);
/**
* Get the contents of a file.
*
* @param string $path
* @return string
*
* @throws \Illuminate\Contracts\Filesystem\FileNotFoundException
*/
public function get($path);
/**
* Write the contents of a file.
*
* @param string $path
* @param string|resource $contents
* @param string $visibility
* @return bool
*/
public function put($path, $contents, $visibility = null);
/**
* Get the visibility for the given path.
*
* @param string $path
* @return string
*/
public function getVisibility($path);
/**
* Set the visibility for the given path.
*
* @param string $path
* @param string $visibility
* @return void
*/
public function setVisibility($path, $visibility);
/**
* Prepend to a file.
*
* @param string $path
* @param string $data
* @return int
*/
public function prepend($path, $data);
/**
* Append to a file.
*
* @param string $path
* @param string $data
* @return int
*/
public function append($path, $data);
/**
* Delete the file at a given path.
*
* @param string|array $paths
* @return bool
*/
public function delete($paths);
/**
* Copy a file to a new location.
*
* @param string $from
* @param string $to
* @return bool
*/
public function copy($from, $to);
/**
* Move a file to a new location.
*
* @param string $from
* @param string $to
* @return bool
*/
public function move($from, $to);
/**
* Get the file size of a given file.
*
* @param string $path
* @return int
*/
public function size($path);
/**
* Get the file's last modification time.
*
* @param string $path
* @return int
*/
public function lastModified($path);
/**
* Get an array of all files in a directory.
*
* @param string|null $directory
* @param bool $recursive
* @return array
*/
public function files($directory = null, $recursive = false);
/**
* Get all of the files from the given directory (recursive).
*
* @param string|null $directory
* @return array
*/
public function allFiles($directory = null);
/**
* Get all of the directories within a given directory.
*
* @param string|null $directory
* @param bool $recursive
* @return array
*/
public function directories($directory = null, $recursive = false);
/**
* Get all (recursive) of the directories within a given directory.
*
* @param string|null $directory
* @return array
*/
public function allDirectories($directory = null);
/**
* Create a directory.
*
* @param string $path
* @return bool
*/
public function makeDirectory($path);
/**
* Recursively delete a directory.
*
* @param string $directory
* @return bool
*/
public function deleteDirectory($directory);
}
interface Factory
{
/**
* Get a filesystem implementation.
*
* @param string $name
* @return \Illuminate\Contracts\Filesystem\Filesystem
*/
public function disk($name = null);
}
interface Cloud extends \Illuminate\Contracts\Filesystem\Filesystem
{
//
}
}
namespace Illuminate\Contracts\Hashing {
interface Hasher
{
/**
* Hash the given value.
*
* @param string $value
* @param array $options
* @return string
*/
public function make($value, array $options = []);
/**
* Check the given plain value against a hash.
*
* @param string $value
* @param string $hashedValue
* @param array $options
* @return bool
*/
public function check($value, $hashedValue, array $options = []);
/**
* Check if the given hash has been hashed using the given options.
*
* @param string $hashedValue
* @param array $options
* @return bool
*/
public function needsRehash($hashedValue, array $options = []);
}
}
namespace Illuminate\Validation {
class ValidationException extends \Exception
{
/**
* The validator instance.
*
* @var \Illuminate\Validation\Validator
*/
public $validator;
/**
* The recommended response to send to the client.
*
* @var \Illuminate\Http\Response|null
*/
public $response;
/**
* Create a new exception instance.
*
* @param \Illuminate\Validation\Validator $validator
* @param \Illuminate\Http\Response $response
* @return void
*/
public function __construct($validator, $response = null)
{
}
/**
* Get the underlying response instance.
*
* @return \Symfony\Component\HttpFoundation\Response
*/
public function getResponse()
{
}
}
class Factory implements \Illuminate\Contracts\Validation\Factory
{
/**
* The Translator implementation.
*
* @var \Symfony\Component\Translation\TranslatorInterface
*/
protected $translator;
/**
* The Presence Verifier implementation.
*
* @var \Illuminate\Validation\PresenceVerifierInterface
*/
protected $verifier;
/**
* The IoC container instance.
*
* @var \Illuminate\Contracts\Container\Container
*/
protected $container;
/**
* All of the custom validator extensions.
*
* @var array
*/
protected $extensions = [];
/**
* All of the custom implicit validator extensions.
*
* @var array
*/
protected $implicitExtensions = [];
/**
* All of the custom validator message replacers.
*
* @var array
*/
protected $replacers = [];
/**
* All of the fallback messages for custom rules.
*
* @var array
*/
protected $fallbackMessages = [];
/**
* The Validator resolver instance.
*
* @var Closure
*/
protected $resolver;
/**
* Create a new Validator factory instance.
*
* @param \Symfony\Component\Translation\TranslatorInterface $translator
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
public function __construct(\Symfony\Component\Translation\TranslatorInterface $translator, \Illuminate\Contracts\Container\Container $container = null)
{
}
/**
* Create a new Validator instance.
*
* @param array $data
* @param array $rules
* @param array $messages
* @param array $customAttributes
* @return \Illuminate\Validation\Validator
*/
public function make(array $data, array $rules, array $messages = [], array $customAttributes = [])
{
}
/**
* Add the extensions to a validator instance.
*
* @param \Illuminate\Validation\Validator $validator
* @return void
*/
protected function addExtensions(\Illuminate\Validation\Validator $validator)
{
}
/**
* Resolve a new Validator instance.
*
* @param array $data
* @param array $rules
* @param array $messages
* @param array $customAttributes
* @return \Illuminate\Validation\Validator
*/
protected function resolve(array $data, array $rules, array $messages, array $customAttributes)
{
}
/**
* Register a custom validator extension.
*
* @param string $rule
* @param \Closure|string $extension
* @param string $message
* @return void
*/
public function extend($rule, $extension, $message = null)
{
}
/**
* Register a custom implicit validator extension.
*
* @param string $rule
* @param \Closure|string $extension
* @param string $message
* @return void
*/
public function extendImplicit($rule, $extension, $message = null)
{
}
/**
* Register a custom implicit validator message replacer.
*
* @param string $rule
* @param \Closure|string $replacer
* @return void
*/
public function replacer($rule, $replacer)
{
}
/**
* Set the Validator instance resolver.
*
* @param \Closure $resolver
* @return void
*/
public function resolver(\Closure $resolver)
{
}
/**
* Get the Translator implementation.
*
* @return \Symfony\Component\Translation\TranslatorInterface
*/
public function getTranslator()
{
}
/**
* Get the Presence Verifier implementation.
*
* @return \Illuminate\Validation\PresenceVerifierInterface
*/
public function getPresenceVerifier()
{
}
/**
* Set the Presence Verifier implementation.
*
* @param \Illuminate\Validation\PresenceVerifierInterface $presenceVerifier
* @return void
*/
public function setPresenceVerifier(\Illuminate\Validation\PresenceVerifierInterface $presenceVerifier)
{
}
}
interface PresenceVerifierInterface
{
/**
* Count the number of objects in a collection having the given value.
*
* @param string $collection
* @param string $column
* @param string $value
* @param int $excludeId
* @param string $idColumn
* @param array $extra
* @return int
*/
public function getCount($collection, $column, $value, $excludeId = null, $idColumn = null, array $extra = []);
/**
* Count the number of objects in a collection with the given values.
*
* @param string $collection
* @param string $column
* @param array $values
* @param array $extra
* @return int
*/
public function getMultiCount($collection, $column, array $values, array $extra = []);
}
/**
* Provides default implementation of ValidatesWhenResolved contract.
*/
trait ValidatesWhenResolvedTrait
{
/**
* Validate the class instance.
*
* @return void
*/
public function validate()
{
}
/**
* Get the validator instance for the request.
*
* @return \Illuminate\Validation\Validator
*/
protected function getValidatorInstance()
{
}
/**
* Handle a failed validation attempt.
*
* @param \Illuminate\Validation\Validator $validator
* @return void
*
* @throws \Illuminate\Contracts\Validation\ValidationException
*/
protected function failedValidation(\Illuminate\Validation\Validator $validator)
{
}
/**
* Determine if the request passes the authorization check.
*
* @return bool
*/
protected function passesAuthorization()
{
}
/**
* Handle a failed authorization attempt.
*
* @return void
*
* @throws \Illuminate\Contracts\Validation\UnauthorizedException
*/
protected function failedAuthorization()
{
}
}
class Validator implements \Illuminate\Contracts\Validation\Validator
{
/**
* The Translator implementation.
*
* @var \Symfony\Component\Translation\TranslatorInterface
*/
protected $translator;
/**
* The Presence Verifier implementation.
*
* @var \Illuminate\Validation\PresenceVerifierInterface
*/
protected $presenceVerifier;
/**
* The container instance.
*
* @var \Illuminate\Contracts\Container\Container
*/
protected $container;
/**
* The failed validation rules.
*
* @var array
*/
protected $failedRules = [];
/**
* The message bag instance.
*
* @var \Illuminate\Support\MessageBag
*/
protected $messages;
/**
* The data under validation.
*
* @var array
*/
protected $data;
/**
* The files under validation.
*
* @var array
*/
protected $files = [];
/**
* The initial rules provided.
*
* @var array
*/
protected $initialRules;
/**
* The rules to be applied to the data.
*
* @var array
*/
protected $rules;
/**
* The array of wildcard attributes with their asterisks expanded.
*
* @var array
*/
protected $implicitAttributes = [];
/**
* All of the registered "after" callbacks.
*
* @var array
*/
protected $after = [];
/**
* The array of custom error messages.
*
* @var array
*/
protected $customMessages = [];
/**
* The array of fallback error messages.
*
* @var array
*/
protected $fallbackMessages = [];
/**
* The array of custom attribute names.
*
* @var array
*/
protected $customAttributes = [];
/**
* The array of custom displayable values.
*
* @var array
*/
protected $customValues = [];
/**
* All of the custom validator extensions.
*
* @var array
*/
protected $extensions = [];
/**
* All of the custom replacer extensions.
*
* @var array
*/
protected $replacers = [];
/**
* The size related validation rules.
*
* @var array
*/
protected $sizeRules = ['Size', 'Between', 'Min', 'Max'];
/**
* The numeric related validation rules.
*
* @var array
*/
protected $numericRules = ['Numeric', 'Integer'];
/**
* The validation rules that imply the field is required.
*
* @var array
*/
protected $implicitRules = ['Required', 'Filled', 'RequiredWith', 'RequiredWithAll', 'RequiredWithout', 'RequiredWithoutAll', 'RequiredIf', 'RequiredUnless', 'Accepted', 'Present'];
/**
* The validation rules which depend on other fields as parameters.
*
* @var array
*/
protected $dependentRules = ['RequiredWith', 'RequiredWithAll', 'RequiredWithout', 'RequiredWithoutAll', 'RequiredIf', 'RequiredUnless', 'Confirmed', 'Same', 'Different', 'Unique', 'Before', 'After'];
/**
* Create a new Validator instance.
*
* @param \Symfony\Component\Translation\TranslatorInterface $translator
* @param array $data
* @param array $rules
* @param array $messages
* @param array $customAttributes
* @return void
*/
public function __construct(\Symfony\Component\Translation\TranslatorInterface $translator, array $data, array $rules, array $messages = [], array $customAttributes = [])
{
}
/**
* Parse the data and hydrate the files array.
*
* @param array $data
* @param string $arrayKey
* @return array
*/
protected function parseData(array $data, $arrayKey = null)
{
}
/**
* Explode the rules into an array of rules.
*
* @param string|array $rules
* @return array
*/
protected function explodeRules($rules)
{
}
/**
* After an after validation callback.
*
* @param callable|string $callback
* @return $this
*/
public function after($callback)
{
}
/**
* Add conditions to a given field based on a Closure.
*
* @param string $attribute
* @param string|array $rules
* @param callable $callback
* @return void
*/
public function sometimes($attribute, $rules, callable $callback)
{
}
/**
* Define a set of rules that apply to each element in an array attribute.
*
* @param string $attribute
* @param string|array $rules
* @return void
*
* @throws \InvalidArgumentException
*/
public function each($attribute, $rules)
{
}
/**
* Gather a copy of the attribute data filled with any missing attributes.
*
* @param string $attribute
* @return array
*/
protected function initializeAttributeOnData($attribute)
{
}
/**
* Get all of the exact attribute values for a given wildcard attribute.
*
* @param array $data
* @param string $attribute
* @return array
*/
public function extractValuesForWildcards($data, $attribute)
{
}
/**
* Merge additional rules into a given attribute(s).
*
* @param string $attribute
* @param string|array $rules
* @return $this
*/
public function mergeRules($attribute, $rules = [])
{
}
/**
* Merge additional rules into a given attribute.
*
* @param string $attribute
* @param string|array $rules
* @return $this
*/
protected function mergeRulesForAttribute($attribute, $rules)
{
}
/**
* Determine if the data passes the validation rules.
*
* @return bool
*/
public function passes()
{
}
/**
* Determine if the data fails the validation rules.
*
* @return bool
*/
public function fails()
{
}
/**
* Validate a given attribute against a rule.
*
* @param string $attribute
* @param string $rule
* @return void
*/
protected function validate($attribute, $rule)
{
}
/**
* Returns the data which was valid.
*
* @return array
*/
public function valid()
{
}
/**
* Returns the data which was invalid.
*
* @return array
*/
public function invalid()
{
}
/**
* Generate an array of all attributes that have messages.
*
* @return array
*/
protected function attributesThatHaveMessages()
{
}
/**
* Get the value of a given attribute.
*
* @param string $attribute
* @return mixed
*/
protected function getValue($attribute)
{
}
/**
* Determine if the attribute is validatable.
*
* @param string $rule
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function isValidatable($rule, $attribute, $value)
{
}
/**
* Determine if the field is present, or the rule implies required.
*
* @param string $rule
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function presentOrRuleIsImplicit($rule, $attribute, $value)
{
}
/**
* Determine if the attribute passes any optional check.
*
* @param string $attribute
* @return bool
*/
protected function passesOptionalCheck($attribute)
{
}
/**
* Determine if a given rule implies the attribute is required.
*
* @param string $rule
* @return bool
*/
protected function isImplicit($rule)
{
}
/**
* Determine if it's a necessary presence validation.
*
* This is to avoid possible database type comparison errors.
*
* @param string $rule
* @param string $attribute
* @return bool
*/
protected function hasNotFailedPreviousRuleIfPresenceRule($rule, $attribute)
{
}
/**
* Add a failed rule and error message to the collection.
*
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return void
*/
protected function addFailure($attribute, $rule, $parameters)
{
}
/**
* Add an error message to the validator's collection of messages.
*
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return void
*/
protected function addError($attribute, $rule, $parameters)
{
}
/**
* "Validate" optional attributes.
*
* Always returns true, just lets us put sometimes in rules.
*
* @return bool
*/
protected function validateSometimes()
{
}
/**
* "Break" on first validation fail.
*
* Always returns true, just lets us put "bail" in rules.
*
* @return bool
*/
protected function validateBail()
{
}
/**
* Stop on error if "bail" rule is assigned and attribute has a message.
*
* @param string $attribute
* @return bool
*/
protected function shouldStopValidating($attribute)
{
}
/**
* Validate that a required attribute exists.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateRequired($attribute, $value)
{
}
/**
* Validate that an attribute exists even if not filled.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validatePresent($attribute, $value)
{
}
/**
* Validate the given attribute is filled if it is present.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateFilled($attribute, $value)
{
}
/**
* Determine if any of the given attributes fail the required test.
*
* @param array $attributes
* @return bool
*/
protected function anyFailingRequired(array $attributes)
{
}
/**
* Determine if all of the given attributes fail the required test.
*
* @param array $attributes
* @return bool
*/
protected function allFailingRequired(array $attributes)
{
}
/**
* Validate that an attribute exists when any other attribute exists.
*
* @param string $attribute
* @param mixed $value
* @param mixed $parameters
* @return bool
*/
protected function validateRequiredWith($attribute, $value, $parameters)
{
}
/**
* Validate that an attribute exists when all other attributes exists.
*
* @param string $attribute
* @param mixed $value
* @param mixed $parameters
* @return bool
*/
protected function validateRequiredWithAll($attribute, $value, $parameters)
{
}
/**
* Validate that an attribute exists when another attribute does not.
*
* @param string $attribute
* @param mixed $value
* @param mixed $parameters
* @return bool
*/
protected function validateRequiredWithout($attribute, $value, $parameters)
{
}
/**
* Validate that an attribute exists when all other attributes do not.
*
* @param string $attribute
* @param mixed $value
* @param mixed $parameters
* @return bool
*/
protected function validateRequiredWithoutAll($attribute, $value, $parameters)
{
}
/**
* Validate that an attribute exists when another attribute has a given value.
*
* @param string $attribute
* @param mixed $value
* @param mixed $parameters
* @return bool
*/
protected function validateRequiredIf($attribute, $value, $parameters)
{
}
/**
* Validate that an attribute exists when another attribute does not have a given value.
*
* @param string $attribute
* @param mixed $value
* @param mixed $parameters
* @return bool
*/
protected function validateRequiredUnless($attribute, $value, $parameters)
{
}
/**
* Get the number of attributes in a list that are present.
*
* @param array $attributes
* @return int
*/
protected function getPresentCount($attributes)
{
}
/**
* Validate that the values of an attribute is in another attribute.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateInArray($attribute, $value, $parameters)
{
}
/**
* Validate that an attribute has a matching confirmation.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateConfirmed($attribute, $value)
{
}
/**
* Validate that two attributes match.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateSame($attribute, $value, $parameters)
{
}
/**
* Validate that an attribute is different from another attribute.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateDifferent($attribute, $value, $parameters)
{
}
/**
* Validate that an attribute was "accepted".
*
* This validation rule implies the attribute is "required".
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateAccepted($attribute, $value)
{
}
/**
* Validate that an attribute is an array.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateArray($attribute, $value)
{
}
/**
* Validate that an attribute is a boolean.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateBoolean($attribute, $value)
{
}
/**
* Validate that an attribute is an integer.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateInteger($attribute, $value)
{
}
/**
* Validate that an attribute is numeric.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateNumeric($attribute, $value)
{
}
/**
* Validate that an attribute is a string.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateString($attribute, $value)
{
}
/**
* Validate the attribute is a valid JSON string.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateJson($attribute, $value)
{
}
/**
* Validate that an attribute has a given number of digits.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateDigits($attribute, $value, $parameters)
{
}
/**
* Validate that an attribute is between a given number of digits.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateDigitsBetween($attribute, $value, $parameters)
{
}
/**
* Validate the size of an attribute.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateSize($attribute, $value, $parameters)
{
}
/**
* Validate the size of an attribute is between a set of values.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateBetween($attribute, $value, $parameters)
{
}
/**
* Validate the size of an attribute is greater than a minimum value.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateMin($attribute, $value, $parameters)
{
}
/**
* Validate the size of an attribute is less than a maximum value.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateMax($attribute, $value, $parameters)
{
}
/**
* Get the size of an attribute.
*
* @param string $attribute
* @param mixed $value
* @return mixed
*/
protected function getSize($attribute, $value)
{
}
/**
* Validate an attribute is contained within a list of values.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateIn($attribute, $value, $parameters)
{
}
/**
* Validate an attribute is not contained within a list of values.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateNotIn($attribute, $value, $parameters)
{
}
/**
* Validate an attribute is unique among other values.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateDistinct($attribute, $value, $parameters)
{
}
/**
* Validate the uniqueness of an attribute value on a given database table.
*
* If a database column is not specified, the attribute will be used.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateUnique($attribute, $value, $parameters)
{
}
/**
* Parse the connection / table for the unique / exists rules.
*
* @param string $table
* @return array
*/
protected function parseTable($table)
{
}
/**
* Get the excluded ID column and value for the unique rule.
*
* @param array $parameters
* @return array
*/
protected function getUniqueIds($parameters)
{
}
/**
* Get the extra conditions for a unique rule.
*
* @param array $parameters
* @return array
*/
protected function getUniqueExtra($parameters)
{
}
/**
* Validate the existence of an attribute value in a database table.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateExists($attribute, $value, $parameters)
{
}
/**
* Get the number of records that exist in storage.
*
* @param mixed $connection
* @param string $table
* @param string $column
* @param mixed $value
* @param array $parameters
* @return int
*/
protected function getExistCount($connection, $table, $column, $value, $parameters)
{
}
/**
* Get the extra exist conditions.
*
* @param array $parameters
* @return array
*/
protected function getExtraExistConditions(array $parameters)
{
}
/**
* Get the extra conditions for a unique / exists rule.
*
* @param array $segments
* @return array
*/
protected function getExtraConditions(array $segments)
{
}
/**
* Guess the database column from the given attribute name.
*
* @param string $attribute
* @return string
*/
public function guessColumnForQuery($attribute)
{
}
/**
* Validate that an attribute is a valid IP.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateIp($attribute, $value)
{
}
/**
* Validate that an attribute is a valid e-mail address.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateEmail($attribute, $value)
{
}
/**
* Validate that an attribute is a valid URL.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateUrl($attribute, $value)
{
}
/**
* Validate that an attribute is an active URL.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateActiveUrl($attribute, $value)
{
}
/**
* Validate the given value is a valid file.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateFile($attribute, $value)
{
}
/**
* Validate the MIME type of a file is an image MIME type.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateImage($attribute, $value)
{
}
/**
* Validate the dimensions of an image matches the given values.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateDimensions($attribute, $value, $parameters)
{
}
/**
* Validate the guessed extension of a file upload is in a set of file extensions.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateMimes($attribute, $value, $parameters)
{
}
/**
* Validate the MIME type of a file upload attribute is in a set of MIME types.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateMimetypes($attribute, $value, $parameters)
{
}
/**
* Check that the given value is a valid file instance.
*
* @param mixed $value
* @return bool
*/
public function isAValidFileInstance($value)
{
}
/**
* Validate that an attribute contains only alphabetic characters.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateAlpha($attribute, $value)
{
}
/**
* Validate that an attribute contains only alpha-numeric characters.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateAlphaNum($attribute, $value)
{
}
/**
* Validate that an attribute contains only alpha-numeric characters, dashes, and underscores.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateAlphaDash($attribute, $value)
{
}
/**
* Validate that an attribute passes a regular expression check.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateRegex($attribute, $value, $parameters)
{
}
/**
* Validate that an attribute is a valid date.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateDate($attribute, $value)
{
}
/**
* Validate that an attribute matches a date format.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateDateFormat($attribute, $value, $parameters)
{
}
/**
* Validate the date is before a given date.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateBefore($attribute, $value, $parameters)
{
}
/**
* Validate the date is before a given date with a given format.
*
* @param string $format
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateBeforeWithFormat($format, $value, $parameters)
{
}
/**
* Validate the date is after a given date.
*
* @param string $attribute
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateAfter($attribute, $value, $parameters)
{
}
/**
* Validate the date is after a given date with a given format.
*
* @param string $format
* @param mixed $value
* @param array $parameters
* @return bool
*/
protected function validateAfterWithFormat($format, $value, $parameters)
{
}
/**
* Given two date/time strings, check that one is after the other.
*
* @param string $format
* @param string $before
* @param string $after
* @return bool
*/
protected function checkDateTimeOrder($format, $before, $after)
{
}
/**
* Get a DateTime instance from a string.
*
* @param string $format
* @param string $value
* @return \DateTime|null
*/
protected function getDateTimeWithOptionalFormat($format, $value)
{
}
/**
* Validate that an attribute is a valid timezone.
*
* @param string $attribute
* @param mixed $value
* @return bool
*/
protected function validateTimezone($attribute, $value)
{
}
/**
* Get the date format for an attribute if it has one.
*
* @param string $attribute
* @return string|null
*/
protected function getDateFormat($attribute)
{
}
/**
* Get the date timestamp.
*
* @param mixed $value
* @return int
*/
protected function getDateTimestamp($value)
{
}
/**
* Get the validation message for an attribute and rule.
*
* @param string $attribute
* @param string $rule
* @return string
*/
protected function getMessage($attribute, $rule)
{
}
/**
* Get the inline message for a rule if it exists.
*
* @param string $attribute
* @param string $lowerRule
* @param array $source
* @return string|null
*/
protected function getInlineMessage($attribute, $lowerRule, $source = null)
{
}
/**
* Get the custom error message from translator.
*
* @param string $customKey
* @return string
*/
protected function getCustomMessageFromTranslator($customKey)
{
}
/**
* Get the proper error message for an attribute and size rule.
*
* @param string $attribute
* @param string $rule
* @return string
*/
protected function getSizeMessage($attribute, $rule)
{
}
/**
* Get the data type of the given attribute.
*
* @param string $attribute
* @return string
*/
protected function getAttributeType($attribute)
{
}
/**
* Replace all error message place-holders with actual values.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function doReplacements($message, $attribute, $rule, $parameters)
{
}
/**
* Transform an array of attributes to their displayable form.
*
* @param array $values
* @return array
*/
protected function getAttributeList(array $values)
{
}
/**
* Get the displayable name of the attribute.
*
* @param string $attribute
* @return string
*/
protected function getAttribute($attribute)
{
}
/**
* Get the primary attribute name.
*
* For example, if "name.0" is given, "name.*" will be returned.
*
* @param string $attribute
* @return string
*/
protected function getPrimaryAttribute($attribute)
{
}
/**
* Get the displayable name of the value.
*
* @param string $attribute
* @param mixed $value
* @return string
*/
public function getDisplayableValue($attribute, $value)
{
}
/**
* Replace all place-holders for the between rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceBetween($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the date_format rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceDateFormat($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the different rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceDifferent($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the digits rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceDigits($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the digits (between) rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceDigitsBetween($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the min rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceMin($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the max rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceMax($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the in rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceIn($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the not_in rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceNotIn($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the in_array rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceInArray($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the mimes rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceMimes($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the required_with rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceRequiredWith($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the required_with_all rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceRequiredWithAll($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the required_without rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceRequiredWithout($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the required_without_all rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceRequiredWithoutAll($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the size rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceSize($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the required_if rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceRequiredIf($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the required_unless rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceRequiredUnless($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the same rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceSame($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the before rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceBefore($message, $attribute, $rule, $parameters)
{
}
/**
* Replace all place-holders for the after rule.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function replaceAfter($message, $attribute, $rule, $parameters)
{
}
/**
* Get all attributes.
*
* @return array
*/
public function attributes()
{
}
/**
* Checks if an attribute exists.
*
* @param string $attribute
* @return bool
*/
public function hasAttribute($attribute)
{
}
/**
* Determine if the given attribute has a rule in the given set.
*
* @param string $attribute
* @param string|array $rules
* @return bool
*/
protected function hasRule($attribute, $rules)
{
}
/**
* Get a rule and its parameters for a given attribute.
*
* @param string $attribute
* @param string|array $rules
* @return array|null
*/
protected function getRule($attribute, $rules)
{
}
/**
* Extract the rule name and parameters from a rule.
*
* @param array|string $rules
* @return array
*/
protected function parseRule($rules)
{
}
/**
* Parse an array based rule.
*
* @param array $rules
* @return array
*/
protected function parseArrayRule(array $rules)
{
}
/**
* Parse a string based rule.
*
* @param string $rules
* @return array
*/
protected function parseStringRule($rules)
{
}
/**
* Parse a parameter list.
*
* @param string $rule
* @param string $parameter
* @return array
*/
protected function parseParameters($rule, $parameter)
{
}
/**
* Parse named parameters to $key => $value items.
*
* @param array $parameters
* @return array
*/
protected function parseNamedParameters($parameters)
{
}
/**
* Normalizes a rule so that we can accept short types.
*
* @param string $rule
* @return string
*/
protected function normalizeRule($rule)
{
}
/**
* Determine if the given rule depends on other fields.
*
* @param string $rule
* @return bool
*/
protected function dependsOnOtherFields($rule)
{
}
/**
* Get the explicit keys from an attribute flattened with dot notation.
*
* E.g. 'foo.1.bar.spark.baz' -> [1, 'spark'] for 'foo.*.bar.*.baz'
*
* @param string $attribute
* @return array
*/
protected function getExplicitKeys($attribute)
{
}
/**
* Get the explicit part of the attribute name.
*
* E.g. 'foo.bar.*.baz' -> 'foo.bar'
*
* Allows us to not spin through all of the flattened data for some operations.
*
* @param string $attribute
* @return string
*/
protected function getLeadingExplicitAttributePath($attribute)
{
}
/**
* Extract data based on the given dot-notated path.
*
* Used to extract a sub-section of the data for faster iteration.
*
* @param string $attribute
* @return array
*/
protected function extractDataFromPath($attribute)
{
}
/**
* Replace each field parameter which has asterisks with the given keys.
*
* @param array $parameters
* @param array $keys
* @return array
*/
protected function replaceAsterisksInParameters(array $parameters, array $keys)
{
}
/**
* Replace asterisks with explicit keys.
*
* E.g. 'foo.*.bar.*.baz', [1, 'spark'] -> foo.1.bar.spark.baz
*
* @param string $field
* @param array $keys
* @return string
*/
protected function replaceAsterisksWithKeys($field, array $keys)
{
}
/**
* Get the array of custom validator extensions.
*
* @return array
*/
public function getExtensions()
{
}
/**
* Register an array of custom validator extensions.
*
* @param array $extensions
* @return void
*/
public function addExtensions(array $extensions)
{
}
/**
* Register an array of custom implicit validator extensions.
*
* @param array $extensions
* @return void
*/
public function addImplicitExtensions(array $extensions)
{
}
/**
* Register a custom validator extension.
*
* @param string $rule
* @param \Closure|string $extension
* @return void
*/
public function addExtension($rule, $extension)
{
}
/**
* Register a custom implicit validator extension.
*
* @param string $rule
* @param \Closure|string $extension
* @return void
*/
public function addImplicitExtension($rule, $extension)
{
}
/**
* Get the array of custom validator message replacers.
*
* @return array
*/
public function getReplacers()
{
}
/**
* Register an array of custom validator message replacers.
*
* @param array $replacers
* @return void
*/
public function addReplacers(array $replacers)
{
}
/**
* Register a custom validator message replacer.
*
* @param string $rule
* @param \Closure|string $replacer
* @return void
*/
public function addReplacer($rule, $replacer)
{
}
/**
* Get the data under validation.
*
* @return array
*/
public function getData()
{
}
/**
* Set the data under validation.
*
* @param array $data
* @return $this
*/
public function setData(array $data)
{
}
/**
* Get the validation rules.
*
* @return array
*/
public function getRules()
{
}
/**
* Set the validation rules.
*
* @param array $rules
* @return $this
*/
public function setRules(array $rules)
{
}
/**
* Set the custom attributes on the validator.
*
* @param array $attributes
* @return $this
*/
public function setAttributeNames(array $attributes)
{
}
/**
* Set the custom values on the validator.
*
* @param array $values
* @return $this
*/
public function setValueNames(array $values)
{
}
/**
* Get the files under validation.
*
* @return array
*/
public function getFiles()
{
}
/**
* Set the files under validation.
*
* @param array $files
* @return $this
*/
public function setFiles(array $files)
{
}
/**
* Get the Presence Verifier implementation.
*
* @return \Illuminate\Validation\PresenceVerifierInterface
*
* @throws \RuntimeException
*/
public function getPresenceVerifier()
{
}
/**
* Set the Presence Verifier implementation.
*
* @param \Illuminate\Validation\PresenceVerifierInterface $presenceVerifier
* @return void
*/
public function setPresenceVerifier(\Illuminate\Validation\PresenceVerifierInterface $presenceVerifier)
{
}
/**
* Get the Translator implementation.
*
* @return \Symfony\Component\Translation\TranslatorInterface
*/
public function getTranslator()
{
}
/**
* Set the Translator implementation.
*
* @param \Symfony\Component\Translation\TranslatorInterface $translator
* @return void
*/
public function setTranslator(\Symfony\Component\Translation\TranslatorInterface $translator)
{
}
/**
* Get the custom messages for the validator.
*
* @return array
*/
public function getCustomMessages()
{
}
/**
* Set the custom messages for the validator.
*
* @param array $messages
* @return void
*/
public function setCustomMessages(array $messages)
{
}
/**
* Get the custom attributes used by the validator.
*
* @return array
*/
public function getCustomAttributes()
{
}
/**
* Add custom attributes to the validator.
*
* @param array $customAttributes
* @return $this
*/
public function addCustomAttributes(array $customAttributes)
{
}
/**
* Get the custom values for the validator.
*
* @return array
*/
public function getCustomValues()
{
}
/**
* Add the custom values for the validator.
*
* @param array $customValues
* @return $this
*/
public function addCustomValues(array $customValues)
{
}
/**
* Get the fallback messages for the validator.
*
* @return array
*/
public function getFallbackMessages()
{
}
/**
* Set the fallback messages for the validator.
*
* @param array $messages
* @return void
*/
public function setFallbackMessages(array $messages)
{
}
/**
* Get the failed validation rules.
*
* @return array
*/
public function failed()
{
}
/**
* Get the message container for the validator.
*
* @return \Illuminate\Support\MessageBag
*/
public function messages()
{
}
/**
* An alternative more semantic shortcut to the message container.
*
* @return \Illuminate\Support\MessageBag
*/
public function errors()
{
}
/**
* Get the messages for the instance.
*
* @return \Illuminate\Support\MessageBag
*/
public function getMessageBag()
{
}
/**
* Set the IoC container instance.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
public function setContainer(\Illuminate\Contracts\Container\Container $container)
{
}
/**
* Call a custom validator extension.
*
* @param string $rule
* @param array $parameters
* @return bool|null
*/
protected function callExtension($rule, $parameters)
{
}
/**
* Call a class based validator extension.
*
* @param string $callback
* @param array $parameters
* @return bool
*/
protected function callClassBasedExtension($callback, $parameters)
{
}
/**
* Call a custom validator message replacer.
*
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string|null
*/
protected function callReplacer($message, $attribute, $rule, $parameters)
{
}
/**
* Call a class based validator message replacer.
*
* @param string $callback
* @param string $message
* @param string $attribute
* @param string $rule
* @param array $parameters
* @return string
*/
protected function callClassBasedReplacer($callback, $message, $attribute, $rule, $parameters)
{
}
/**
* Require a certain number of parameters to be present.
*
* @param int $count
* @param array $parameters
* @param string $rule
* @return void
*
* @throws \InvalidArgumentException
*/
protected function requireParameterCount($count, $parameters, $rule)
{
}
/**
* Handle dynamic calls to class methods.
*
* @param string $method
* @param array $parameters
* @return mixed
*
* @throws \BadMethodCallException
*/
public function __call($method, $parameters)
{
}
}
class DatabasePresenceVerifier implements \Illuminate\Validation\PresenceVerifierInterface
{
/**
* The database connection instance.
*
* @var \Illuminate\Database\ConnectionResolverInterface
*/
protected $db;
/**
* The database connection to use.
*
* @var string
*/
protected $connection = null;
/**
* Create a new database presence verifier.
*
* @param \Illuminate\Database\ConnectionResolverInterface $db
* @return void
*/
public function __construct(\Illuminate\Database\ConnectionResolverInterface $db)
{
}
/**
* Count the number of objects in a collection having the given value.
*
* @param string $collection
* @param string $column
* @param string $value
* @param int $excludeId
* @param string $idColumn
* @param array $extra
* @return int
*/
public function getCount($collection, $column, $value, $excludeId = null, $idColumn = null, array $extra = [])
{
}
/**
* Count the number of objects in a collection with the given values.
*
* @param string $collection
* @param string $column
* @param array $values
* @param array $extra
* @return int
*/
public function getMultiCount($collection, $column, array $values, array $extra = [])
{
}
/**
* Add a "where" clause to the given query.
*
* @param \Illuminate\Database\Query\Builder $query
* @param string $key
* @param string $extraValue
* @return void
*/
protected function addWhere($query, $key, $extraValue)
{
}
/**
* Get a query builder for the given table.
*
* @param string $table
* @return \Illuminate\Database\Query\Builder
*/
protected function table($table)
{
}
/**
* Set the connection to be used.
*
* @param string $connection
* @return void
*/
public function setConnection($connection)
{
}
}
class ValidationServiceProvider extends \Illuminate\Support\ServiceProvider
{
/**
* Indicates if loading of the provider is deferred.
*
* @var bool
*/
protected $defer = true;
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
}
/**
* Register the validation factory.
*
* @return void
*/
protected function registerValidationFactory()
{
}
/**
* Register the database presence verifier.
*
* @return void
*/
protected function registerPresenceVerifier()
{
}
/**
* Get the services provided by the provider.
*
* @return array
*/
public function provides()
{
}
}
}
namespace Illuminate\Console {
class OutputStyle extends \Symfony\Component\Console\Style\SymfonyStyle
{
/**
* Create a new Console OutputStyle instance.
*
* @param \Symfony\Component\Console\Input\InputInterface $input
* @param \Symfony\Component\Console\Output\OutputInterface $output
* @return void
*/
public function __construct(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
/**
* Returns whether verbosity is quiet (-q).
*
* @return bool
*/
public function isQuiet()
{
}
/**
* Returns whether verbosity is verbose (-v).
*
* @return bool
*/
public function isVerbose()
{
}
/**
* Returns whether verbosity is very verbose (-vv).
*
* @return bool
*/
public function isVeryVerbose()
{
}
/**
* Returns whether verbosity is debug (-vvv).
*
* @return bool
*/
public function isDebug()
{
}
}
}
namespace Illuminate\Console\Scheduling {
class ScheduleRunCommand extends \Illuminate\Console\Command
{
/**
* The console command name.
*
* @var string
*/
protected $name = 'schedule:run';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Run the scheduled commands';
/**
* The schedule instance.
*
* @var \Illuminate\Console\Scheduling\Schedule
*/
protected $schedule;
/**
* Create a new command instance.
*
* @param \Illuminate\Console\Scheduling\Schedule $schedule
* @return void
*/
public function __construct(\Illuminate\Console\Scheduling\Schedule $schedule)
{
}
/**
* Execute the console command.
*
* @return void
*/
public function fire()
{
}
}
class Schedule
{
/**
* All of the events on the schedule.
*
* @var array
*/
protected $events = [];
/**
* Add a new callback event to the schedule.
*
* @param string $callback
* @param array $parameters
* @return \Illuminate\Console\Scheduling\Event
*/
public function call($callback, array $parameters = [])
{
}
/**
* Add a new Artisan command event to the schedule.
*
* @param string $command
* @param array $parameters
* @return \Illuminate\Console\Scheduling\Event
*/
public function command($command, array $parameters = [])
{
}
/**
* Add a new command event to the schedule.
*
* @param string $command
* @param array $parameters
* @return \Illuminate\Console\Scheduling\Event
*/
public function exec($command, array $parameters = [])
{
}
/**
* Compile parameters for a command.
*
* @param array $parameters
* @return string
*/
protected function compileParameters(array $parameters)
{
}
/**
* Get all of the events on the schedule.
*
* @return array
*/
public function events()
{
}
/**
* Get all of the events on the schedule that are due.
*
* @param \Illuminate\Contracts\Foundation\Application $app
* @return array
*/
public function dueEvents($app)
{
}
}
class Event
{
/**
* The command string.
*
* @var string
*/
public $command;
/**
* The cron expression representing the event's frequency.
*
* @var string
*/
public $expression = '* * * * * *';
/**
* The timezone the date should be evaluated on.
*
* @var \DateTimeZone|string
*/
public $timezone;
/**
* The user the command should run as.
*
* @var string
*/
public $user;
/**
* The list of environments the command should run under.
*
* @var array
*/
public $environments = [];
/**
* Indicates if the command should run in maintenance mode.
*
* @var bool
*/
public $evenInMaintenanceMode = false;
/**
* Indicates if the command should not overlap itself.
*
* @var bool
*/
public $withoutOverlapping = false;
/**
* Indicates if the command should run in background.
*
* @var bool
*/
public $runInBackground = false;
/**
* The array of filter callbacks.
*
* @var array
*/
protected $filters = [];
/**
* The array of reject callbacks.
*
* @var array
*/
protected $rejects = [];
/**
* The location that output should be sent to.
*
* @var string
*/
public $output = '/dev/null';
/**
* Indicates whether output should be appended.
*
* @var bool
*/
protected $shouldAppendOutput = false;
/**
* The array of callbacks to be run before the event is started.
*
* @var array
*/
protected $beforeCallbacks = [];
/**
* The array of callbacks to be run after the event is finished.
*
* @var array
*/
protected $afterCallbacks = [];
/**
* The human readable description of the event.
*
* @var string
*/
public $description;
/**
* Create a new event instance.
*
* @param string $command
* @return void
*/
public function __construct($command)
{
}
/**
* Get the default output depending on the OS.
*
* @return string
*/
protected function getDefaultOutput()
{
}
/**
* Run the given event.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
public function run(\Illuminate\Contracts\Container\Container $container)
{
}
/**
* Run the command in the foreground.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
protected function runCommandInForeground(\Illuminate\Contracts\Container\Container $container)
{
}
/**
* Run the command in the background.
*
* @return void
*/
protected function runCommandInBackground()
{
}
/**
* Call all of the "before" callbacks for the event.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
protected function callBeforeCallbacks(\Illuminate\Contracts\Container\Container $container)
{
}
/**
* Call all of the "after" callbacks for the event.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
protected function callAfterCallbacks(\Illuminate\Contracts\Container\Container $container)
{
}
/**
* Build the command string.
*
* @return string
*/
public function buildCommand()
{
}
/**
* Get the mutex path for the scheduled command.
*
* @return string
*/
protected function mutexPath()
{
}
/**
* Determine if the given event should run based on the Cron expression.
*
* @param \Illuminate\Contracts\Foundation\Application $app
* @return bool
*/
public function isDue($app)
{
}
/**
* Determine if the Cron expression passes.
*
* @return bool
*/
protected function expressionPasses()
{
}
/**
* Determine if the filters pass for the event.
*
* @param \Illuminate\Contracts\Foundation\Application $app
* @return bool
*/
public function filtersPass($app)
{
}
/**
* Determine if the event runs in the given environment.
*
* @param string $environment
* @return bool
*/
public function runsInEnvironment($environment)
{
}
/**
* Determine if the event runs in maintenance mode.
*
* @return bool
*/
public function runsInMaintenanceMode()
{
}
/**
* The Cron expression representing the event's frequency.
*
* @param string $expression
* @return $this
*/
public function cron($expression)
{
}
/**
* Schedule the event to run hourly.
*
* @return $this
*/
public function hourly()
{
}
/**
* Schedule the event to run daily.
*
* @return $this
*/
public function daily()
{
}
/**
* Schedule the command at a given time.
*
* @param string $time
* @return $this
*/
public function at($time)
{
}
/**
* Schedule the event to run daily at a given time (10:00, 19:30, etc).
*
* @param string $time
* @return $this
*/
public function dailyAt($time)
{
}
/**
* Schedule the event to run twice daily.
*
* @param int $first
* @param int $second
* @return $this
*/
public function twiceDaily($first = 1, $second = 13)
{
}
/**
* Schedule the event to run only on weekdays.
*
* @return $this
*/
public function weekdays()
{
}
/**
* Schedule the event to run only on Mondays.
*
* @return $this
*/
public function mondays()
{
}
/**
* Schedule the event to run only on Tuesdays.
*
* @return $this
*/
public function tuesdays()
{
}
/**
* Schedule the event to run only on Wednesdays.
*
* @return $this
*/
public function wednesdays()
{
}
/**
* Schedule the event to run only on Thursdays.
*
* @return $this
*/
public function thursdays()
{
}
/**
* Schedule the event to run only on Fridays.
*
* @return $this
*/
public function fridays()
{
}
/**
* Schedule the event to run only on Saturdays.
*
* @return $this
*/
public function saturdays()
{
}
/**
* Schedule the event to run only on Sundays.
*
* @return $this
*/
public function sundays()
{
}
/**
* Schedule the event to run weekly.
*
* @return $this
*/
public function weekly()
{
}
/**
* Schedule the event to run weekly on a given day and time.
*
* @param int $day
* @param string $time
* @return $this
*/
public function weeklyOn($day, $time = '0:0')
{
}
/**
* Schedule the event to run monthly.
*
* @return $this
*/
public function monthly()
{
}
/**
* Schedule the event to run monthly on a given day and time.
*
* @param int $day
* @param string $time
* @return $this
*/
public function monthlyOn($day = 1, $time = '0:0')
{
}
/**
* Schedule the event to run quarterly.
*
* @return $this
*/
public function quarterly()
{
}
/**
* Schedule the event to run yearly.
*
* @return $this
*/
public function yearly()
{
}
/**
* Schedule the event to run every minute.
*
* @return $this
*/
public function everyMinute()
{
}
/**
* Schedule the event to run every five minutes.
*
* @return $this
*/
public function everyFiveMinutes()
{
}
/**
* Schedule the event to run every ten minutes.
*
* @return $this
*/
public function everyTenMinutes()
{
}
/**
* Schedule the event to run every thirty minutes.
*
* @return $this
*/
public function everyThirtyMinutes()
{
}
/**
* Set the days of the week the command should run on.
*
* @param array|mixed $days
* @return $this
*/
public function days($days)
{
}
/**
* State that the command should run in background.
*
* @return $this
*/
public function runInBackground()
{
}
/**
* Set the timezone the date should be evaluated on.
*
* @param \DateTimeZone|string $timezone
* @return $this
*/
public function timezone($timezone)
{
}
/**
* Set which user the command should run as.
*
* @param string $user
* @return $this
*/
public function user($user)
{
}
/**
* Limit the environments the command should run in.
*
* @param array|mixed $environments
* @return $this
*/
public function environments($environments)
{
}
/**
* State that the command should run even in maintenance mode.
*
* @return $this
*/
public function evenInMaintenanceMode()
{
}
/**
* Do not allow the event to overlap each other.
*
* @return $this
*/
public function withoutOverlapping()
{
}
/**
* Register a callback to further filter the schedule.
*
* @param \Closure $callback
* @return $this
*/
public function when(\Closure $callback)
{
}
/**
* Register a callback to further filter the schedule.
*
* @param \Closure $callback
* @return $this
*/
public function skip(\Closure $callback)
{
}
/**
* Send the output of the command to a given location.
*
* @param string $location
* @param bool $append
* @return $this
*/
public function sendOutputTo($location, $append = false)
{
}
/**
* Append the output of the command to a given location.
*
* @param string $location
* @return $this
*/
public function appendOutputTo($location)
{
}
/**
* E-mail the results of the scheduled operation.
*
* @param array|mixed $addresses
* @param bool $onlyIfOutputExists
* @return $this
*
* @throws \LogicException
*/
public function emailOutputTo($addresses, $onlyIfOutputExists = false)
{
}
/**
* E-mail the results of the scheduled operation if it produces output.
*
* @param array|mixed $addresses
* @return $this
*
* @throws \LogicException
*/
public function emailWrittenOutputTo($addresses)
{
}
/**
* E-mail the output of the event to the recipients.
*
* @param \Illuminate\Contracts\Mail\Mailer $mailer
* @param array $addresses
* @param bool $onlyIfOutputExists
* @return void
*/
protected function emailOutput(\Illuminate\Contracts\Mail\Mailer $mailer, $addresses, $onlyIfOutputExists = false)
{
}
/**
* Get the e-mail subject line for output results.
*
* @return string
*/
protected function getEmailSubject()
{
}
/**
* Register a callback to ping a given URL before the job runs.
*
* @param string $url
* @return $this
*/
public function pingBefore($url)
{
}
/**
* Register a callback to be called before the operation.
*
* @param \Closure $callback
* @return $this
*/
public function before(\Closure $callback)
{
}
/**
* Register a callback to ping a given URL after the job runs.
*
* @param string $url
* @return $this
*/
public function thenPing($url)
{
}
/**
* Register a callback to be called after the operation.
*
* @param \Closure $callback
* @return $this
*/
public function after(\Closure $callback)
{
}
/**
* Register a callback to be called after the operation.
*
* @param \Closure $callback
* @return $this
*/
public function then(\Closure $callback)
{
}
/**
* Set the human-friendly description of the event.
*
* @param string $description
* @return $this
*/
public function name($description)
{
}
/**
* Set the human-friendly description of the event.
*
* @param string $description
* @return $this
*/
public function description($description)
{
}
/**
* Splice the given value into the given position of the expression.
*
* @param int $position
* @param string $value
* @return $this
*/
protected function spliceIntoPosition($position, $value)
{
}
/**
* Get the summary of the event for display.
*
* @return string
*/
public function getSummaryForDisplay()
{
}
/**
* Get the Cron expression for the event.
*
* @return string
*/
public function getExpression()
{
}
}
class CallbackEvent extends \Illuminate\Console\Scheduling\Event
{
/**
* The callback to call.
*
* @var string
*/
protected $callback;
/**
* The parameters to pass to the method.
*
* @var array
*/
protected $parameters;
/**
* Create a new event instance.
*
* @param string $callback
* @param array $parameters
* @return void
*
* @throws \InvalidArgumentException
*/
public function __construct($callback, array $parameters = [])
{
}
/**
* Run the given event.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return mixed
*
* @throws \Exception
*/
public function run(\Illuminate\Contracts\Container\Container $container)
{
}
/**
* Remove the mutex file from disk.
*
* @return void
*/
protected function removeMutex()
{
}
/**
* Do not allow the event to overlap each other.
*
* @return $this
*
* @throws \LogicException
*/
public function withoutOverlapping()
{
}
/**
* Get the mutex path for the scheduled command.
*
* @return string
*/
protected function mutexPath()
{
}
/**
* Get the summary of the event for display.
*
* @return string
*/
public function getSummaryForDisplay()
{
}
}
}
namespace Illuminate\Console\Events {
class ArtisanStarting
{
/**
* The Artisan application instance.
*
* @var \Illuminate\Console\Application
*/
public $artisan;
/**
* Create a new event instance.
*
* @param \Illuminate\Console\Application $artisan
* @return void
*/
public function __construct($artisan)
{
}
}
}
namespace Illuminate\Console {
class Application extends \Symfony\Component\Console\Application implements \Illuminate\Contracts\Console\Application
{
/**
* The Laravel application instance.
*
* @var \Illuminate\Contracts\Container\Container
*/
protected $laravel;
/**
* The output from the previous command.
*
* @var \Symfony\Component\Console\Output\BufferedOutput
*/
protected $lastOutput;
/**
* Create a new Artisan console application.
*
* @param \Illuminate\Contracts\Container\Container $laravel
* @param \Illuminate\Contracts\Events\Dispatcher $events
* @param string $version
* @return void
*/
public function __construct(\Illuminate\Contracts\Container\Container $laravel, \Illuminate\Contracts\Events\Dispatcher $events, $version)
{
}
/**
* Run an Artisan console command by name.
*
* @param string $command
* @param array $parameters
* @return int
*/
public function call($command, array $parameters = [])
{
}
/**
* Get the output for the last run command.
*
* @return string
*/
public function output()
{
}
/**
* Add a command to the console.
*
* @param \Symfony\Component\Console\Command\Command $command
* @return \Symfony\Component\Console\Command\Command
*/
public function add(\Symfony\Component\Console\Command\Command $command)
{
}
/**
* Add the command to the parent instance.
*
* @param \Symfony\Component\Console\Command\Command $command
* @return \Symfony\Component\Console\Command\Command
*/
protected function addToParent(\Symfony\Component\Console\Command\Command $command)
{
}
/**
* Add a command, resolving through the application.
*
* @param string $command
* @return \Symfony\Component\Console\Command\Command
*/
public function resolve($command)
{
}
/**
* Resolve an array of commands through the application.
*
* @param array|mixed $commands
* @return $this
*/
public function resolveCommands($commands)
{
}
/**
* Get the default input definitions for the applications.
*
* This is used to add the --env option to every available command.
*
* @return \Symfony\Component\Console\Input\InputDefinition
*/
protected function getDefaultInputDefinition()
{
}
/**
* Get the global environment option for the definition.
*
* @return \Symfony\Component\Console\Input\InputOption
*/
protected function getEnvironmentOption()
{
}
/**
* Get the Laravel application instance.
*
* @return \Illuminate\Contracts\Foundation\Application
*/
public function getLaravel()
{
}
}
class ScheduleServiceProvider extends \Illuminate\Support\ServiceProvider
{
/**
* Indicates if loading of the provider is deferred.
*
* @var bool
*/
protected $defer = true;
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
}
/**
* Get the services provided by the provider.
*
* @return array
*/
public function provides()
{
}
}
trait AppNamespaceDetectorTrait
{
/**
* Get the application namespace.
*
* @return string
*/
protected function getAppNamespace()
{
}
}
class Parser
{
/**
* Parse the given console command definition into an array.
*
* @param string $expression
* @return array
*
* @throws \InvalidArgumentException
*/
public static function parse($expression)
{
}
/**
* Extract all of the parameters from the tokens.
*
* @param array $tokens
* @return array
*/
protected static function parameters(array $tokens)
{
}
/**
* Parse an argument expression.
*
* @param string $token
* @return \Symfony\Component\Console\Input\InputArgument
*/
protected static function parseArgument($token)
{
}
/**
* Parse an option expression.
*
* @param string $token
* @return \Symfony\Component\Console\Input\InputOption
*/
protected static function parseOption($token)
{
}
}
}
namespace Illuminate\Events {
class EventServiceProvider extends \Illuminate\Support\ServiceProvider
{
/**
* Register the service provider.
*
* @return void
*/
public function register()
{
}
}
class CallQueuedHandler
{
/**
* The container instance.
*
* @var \Illuminate\Contracts\Container\Container
*/
protected $container;
/**
* Create a new job instance.
*
* @param \Illuminate\Contracts\Container\Container $container
* @return void
*/
public function __construct(\Illuminate\Contracts\Container\Container $container)
{
}
/**
* Handle the queued job.
*
* @param \Illuminate\Contracts\Queue\Job $job
* @param array $data
* @return void
*/
public function call(\Illuminate\Contracts\Queue\Job $job, array $data)
{
}
/**
* Set the job instance of the given class if necessary.
*
* @param \Illuminate\Contracts\Queue\Job $job
* @param mixed $instance
* @return mixed
*/
protected function setJobInstanceIfNecessary(\Illuminate\Contracts\Queue\Job $job, $instance)
{
}
/**
* Call the failed method on the job instance.
*
* @param array $data
* @return void
*/
public function failed(array $data)
{
}
}
class Dispatcher implements \Illuminate\Contracts\Events\Dispatcher
{
/**
* The IoC container instance.
*
* @var \Illuminate\Contracts\Container\Container
*/
protected $container;
/**
* The registered event listeners.
*
* @var array
*/
protected $listeners = [];
/**
* The wildcard listeners.
*
* @var array
*/
protected $wildcards = [];
/**
* The sorted event listeners.
*
* @var array
*/
protected $sorted = [];
/**
* The event firing stack.
*
* @var array
*/
protected $firing = [];
/**
* The queue resolver instance.
*
* @var callable
*/
protected $queueResolver;
/**
* Create a new event dispatcher instance.
*
* @param \Illuminate\Contracts\Container\Container|null $container
* @return void
*/
public function __construct(\Illuminate\Contracts\Container\Container $container = null)
{
}
/**
* Register an event listener with the dispatcher.
*
* @param string|array $events
* @param mixed $listener
* @param int $priority
* @return void
*/
public function listen($events, $listener, $priority = 0)
{
}
/**
* Setup a wildcard listener callback.
*
* @param string $event
* @param mixed $listener
* @return void
*/
protected function setupWildcardListen($event, $listener)
{
}
/**
* Determine if a given event has listeners.
*
* @param string $eventName
* @return bool
*/
public function hasListeners($eventName)
{
}
/**
* Register an event and payload to be fired later.
*
* @param string $event
* @param array $payload
* @return void
*/
public function push($event, $payload = [])
{
}
/**
* Register an event subscriber with the dispatcher.
*
* @param object|string $subscriber
* @return void
*/
public function subscribe($subscriber)
{
}
/**
* Resolve the subscriber instance.
*
* @param object|string $subscriber
* @return mixed
*/
protected function resolveSubscriber($subscriber)
{
}
/**
* Fire an event until the first non-null response is returned.
*
* @param string|object $event
* @param array $payload
* @return mixed
*/
public function until($event, $payload = [])
{
}
/**
* Flush a set of pushed events.
*
* @param string $event
* @return void
*/
public function flush($event)
{
}
/**
* Get the event that is currently firing.
*
* @return string
*/
public function firing()
{
}
/**
* Fire an event and call the listeners.
*
* @param string|object $event
* @param mixed $payload
* @param bool $halt
* @return array|null
*/
public function fire($event, $payload = [], $halt = false)
{
}
/**
* Broadcast the given event class.
*
* @param \Illuminate\Contracts\Broadcasting\ShouldBroadcast $event
* @return void
*/
protected function broadcastEvent($event)
{
}
/**
* Get all of the listeners for a given event name.
*
* @param string $eventName
* @return array
*/
public function getListeners($eventName)
{
}
/**
* Get the wildcard listeners for the event.
*
* @param string $eventName
* @return array
*/
protected function getWildcardListeners($eventName)
{
}
/**
* Sort the listeners for a given event by priority.
*
* @param string $eventName
* @return array
*/
protected function sortListeners($eventName)
{
}
/**
* Register an event listener with the dispatcher.
*
* @param mixed $listener
* @return mixed
*/
public function makeListener($listener)
{
}
/**
* Create a class based listener using the IoC container.
*
* @param mixed $listener
* @return \Closure
*/
public function createClassListener($listener)
{
}
/**
* Create the class based event callable.
*
* @param string $listener
* @param \Illuminate\Container\Container $container
* @return callable
*/
protected function createClassCallable($listener, $container)
{
}
/**
* Parse the class listener into class and method.
*
* @param string $listener
* @return array
*/
protected function parseClassCallable($listener)
{
}
/**
* Determine if the event handler class should be queued.
*
* @param string $class
* @return bool
*/
protected function handlerShouldBeQueued($class)
{
}
/**
* Create a callable for putting an event handler on the queue.
*
* @param string $class
* @param string $method
* @return \Closure
*/
protected function createQueuedHandlerCallable($class, $method)
{
}
/**
* Clone the given arguments for queueing.
*
* @param array $arguments
* @return array
*/
protected function cloneArgumentsForQueueing(array $arguments)
{
}
/**
* Call the queue method on the handler class.
*
* @param string $class
* @param string $method
* @param array $arguments
* @return void
*/
protected function callQueueMethodOnHandler($class, $method, $arguments)
{
}
/**
* Remove a set of listeners from the dispatcher.
*
* @param string $event
* @return void
*/
public function forget($event)
{
}
/**
* Forget all of the pushed listeners.
*
* @return void
*/
public function forgetPushed()
{
}
/**
* Get the queue implementation from the resolver.
*
* @return \Illuminate\Contracts\Queue\Queue
*/
protected function resolveQueue()
{
}
/**
* Set the queue resolver implementation.
*
* @param callable $resolver
* @return $this
*/
public function setQueueResolver(callable $resolver)
{
}
}
}
namespace OAuth2 {
interface RequestInterface
{
public function query($name, $default = null);
public function request($name, $default = null);
public function server($name, $default = null);
public function headers($name, $default = null);
public function getAllQueryParameters();
}
}
namespace OAuth2\HttpFoundationBridge {
/**
*
*/
class Request extends \Symfony\Component\HttpFoundation\Request implements \OAuth2\RequestInterface
{
public function query($name, $default = null)
{
}
public function request($name, $default = null)
{
}
public function server($name, $default = null)
{
}
public function headers($name, $default = null)
{
}
public function getAllQueryParameters()
{
}
public static function createFromRequest(\Symfony\Component\HttpFoundation\Request $request)
{
}
/**
* Creates a new request with values from PHP's super globals.
* Overwrite to fix an apache header bug. Read more here:
* http://stackoverflow.com/questions/11990388/request-headers-bag-is-missing-authorization-header-in-symfony-2%E2%80%94
*
* @return Request A new request
*
* @api
*/
public static function createFromGlobals()
{
}
/**
* PHP does not include HTTP_AUTHORIZATION in the $_SERVER array, so this header is missing.
* We retrieve it from apache_request_headers()
*
* @see https://github.com/symfony/symfony/issues/7170
*
* @param HeaderBag $headers
*/
protected static function fixAuthHeader(\Symfony\Component\HttpFoundation\HeaderBag $headers)
{
}
}
}
namespace OAuth2 {
/**
* Interface which represents an object response. Meant to handle and display the proper OAuth2 Responses
* for errors and successes
*
* @see OAuth2\Response
*/
interface ResponseInterface
{
public function addParameters(array $parameters);
public function addHttpHeaders(array $httpHeaders);
public function setStatusCode($statusCode);
public function setError($statusCode, $name, $description = null, $uri = null);
public function setRedirect($statusCode, $url, $state = null, $error = null, $errorDescription = null, $errorUri = null);
public function getParameter($name);
}
}
namespace OAuth2\HttpFoundationBridge {
/**
*
*/
class Response extends \Symfony\Component\HttpFoundation\JsonResponse implements \OAuth2\ResponseInterface
{
public function addParameters(array $parameters)
{
}
public function addHttpHeaders(array $httpHeaders)
{
}
public function getParameter($name)
{
}
public function setError($statusCode, $error, $description = null, $uri = null)
{
}
public function setRedirect($statusCode = 302, $url, $state = null, $error = null, $errorDescription = null, $errorUri = null)
{
}
}
}
namespace OAuth2\ClientAssertionType {
/**
* Interface for all OAuth2 Client Assertion Types
*/
interface ClientAssertionTypeInterface
{
public function validateRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response);
public function getClientId();
}
/**
* Validate a client via Http Basic authentication
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class HttpBasic implements \OAuth2\ClientAssertionType\ClientAssertionTypeInterface
{
protected $storage;
protected $config;
/**
* @param OAuth2\Storage\ClientCredentialsInterface $clientStorage REQUIRED Storage class for retrieving client credentials information
* @param array $config OPTIONAL Configuration options for the server
* <code>
* $config = array(
* 'allow_credentials_in_request_body' => true, // whether to look for credentials in the POST body in addition to the Authorize HTTP Header
* 'allow_public_clients' => true // if true, "public clients" (clients without a secret) may be authenticated
* );
* </code>
*/
public function __construct(\OAuth2\Storage\ClientCredentialsInterface $storage, array $config = array())
{
}
public function validateRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
public function getClientId()
{
}
/**
* Internal function used to get the client credentials from HTTP basic
* auth or POST data.
*
* According to the spec (draft 20), the client_id can be provided in
* the Basic Authorization header (recommended) or via GET/POST.
*
* @return
* A list containing the client identifier and password, for example
* @code
* return array(
* "client_id" => CLIENT_ID, // REQUIRED the client id
* "client_secret" => CLIENT_SECRET, // OPTIONAL the client secret (may be omitted for public clients)
* );
* @endcode
*
* @see http://tools.ietf.org/html/rfc6749#section-2.3.1
*
* @ingroup oauth2_section_2
*/
public function getClientCredentials(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response = null)
{
}
}
}
namespace OAuth2\Controller {
/**
* @see OAuth2\Controller\AuthorizeControllerInterface
*/
class AuthorizeController implements \OAuth2\Controller\AuthorizeControllerInterface
{
protected $clientStorage;
protected $responseTypes;
protected $config;
protected $scopeUtil;
/**
* @param OAuth2\Storage\ClientInterface $clientStorage REQUIRED Instance of OAuth2\Storage\ClientInterface to retrieve client information
* @param array $responseTypes OPTIONAL Array of OAuth2\ResponseType\ResponseTypeInterface objects. Valid array
* keys are "code" and "token"
* @param array $config OPTIONAL Configuration options for the server
* <code>
* $config = array(
* 'allow_implicit' => false, // if the controller should allow the "implicit" grant type
* 'enforce_state' => true // if the controller should require the "state" parameter
* 'require_exact_redirect_uri' => true, // if the controller should require an exact match on the "redirect_uri" parameter
* 'redirect_status_code' => 302, // HTTP status code to use for redirect responses
* );
* </code>
* @param OAuth2\ScopeInterface $scopeUtil OPTIONAL Instance of OAuth2\ScopeInterface to validate the requested scope
*/
public function __construct(\OAuth2\Storage\ClientInterface $clientStorage, array $responseTypes = array(), array $config = array(), \OAuth2\ScopeInterface $scopeUtil = null)
{
}
public function handleAuthorizeRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response, $is_authorized, $user_id = null)
{
}
protected function setNotAuthorizedResponse(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response, $redirect_uri, $user_id = null)
{
}
/*
* We have made this protected so this class can be extended to add/modify
* these parameters
*/
protected function buildAuthorizeParameters($request, $response, $user_id)
{
}
public function validateAuthorizeRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
protected function getValidResponseTypes()
{
}
/**
* Internal method for validating redirect URI supplied
*
* @param string $inputUri The submitted URI to be validated
* @param string $registeredUriString The allowed URI(s) to validate against. Can be a space-delimited string of URIs to
* allow for multiple URIs
*
* @see http://tools.ietf.org/html/rfc6749#section-3.1.2
*/
protected function validateRedirectUri($inputUri, $registeredUriString)
{
}
/**
* Convenience methods to access the parameters derived from the validated request
*/
public function getScope()
{
}
public function getState()
{
}
public function getClientId()
{
}
public function getRedirectUri()
{
}
public function getResponseType()
{
}
}
/**
* @see OAuth2\Controller\ResourceControllerInterface
*/
class ResourceController implements \OAuth2\Controller\ResourceControllerInterface
{
protected $tokenType;
protected $tokenStorage;
protected $config;
protected $scopeUtil;
public function __construct(\OAuth2\TokenType\TokenTypeInterface $tokenType, \OAuth2\Storage\AccessTokenInterface $tokenStorage, $config = array(), \OAuth2\ScopeInterface $scopeUtil = null)
{
}
public function verifyResourceRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response, $scope = null)
{
}
public function getAccessTokenData(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
// convenience method to allow retrieval of the token
public function getToken()
{
}
}
/**
* @see OAuth2\Controller\TokenControllerInterface
*/
class TokenController implements \OAuth2\Controller\TokenControllerInterface
{
protected $accessToken;
protected $grantTypes;
protected $clientAssertionType;
protected $scopeUtil;
protected $clientStorage;
public function __construct(\OAuth2\ResponseType\AccessTokenInterface $accessToken, \OAuth2\Storage\ClientInterface $clientStorage, array $grantTypes = array(), \OAuth2\ClientAssertionType\ClientAssertionTypeInterface $clientAssertionType = null, \OAuth2\ScopeInterface $scopeUtil = null)
{
}
public function handleTokenRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
/**
* Grant or deny a requested access token.
* This would be called from the "/token" endpoint as defined in the spec.
* You can call your endpoint whatever you want.
*
* @param $request - RequestInterface
* Request object to grant access token
*
* @throws InvalidArgumentException
* @throws LogicException
*
* @see http://tools.ietf.org/html/rfc6749#section-4
* @see http://tools.ietf.org/html/rfc6749#section-10.6
* @see http://tools.ietf.org/html/rfc6749#section-4.1.3
*
* @ingroup oauth2_section_4
*/
public function grantAccessToken(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
/**
* addGrantType
*
* @param grantType - OAuth2\GrantTypeInterface
* the grant type to add for the specified identifier
* @param identifier - string
* a string passed in as "grant_type" in the response that will call this grantType
*/
public function addGrantType(\OAuth2\GrantType\GrantTypeInterface $grantType, $identifier = null)
{
}
public function handleRevokeRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
/**
* Revoke a refresh or access token. Returns true on success and when tokens are invalid
*
* Note: invalid tokens do not cause an error response since the client
* cannot handle such an error in a reasonable way. Moreover, the
* purpose of the revocation request, invalidating the particular token,
* is already achieved.
*
* @param RequestInterface $request
* @param ResponseInterface $response
* @return bool|null
*/
public function revokeToken(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
}
}
namespace OAuth2\TokenType {
interface TokenTypeInterface
{
/**
* Token type identification string
*
* ex: "bearer" or "mac"
*/
public function getTokenType();
/**
* Retrieves the token string from the request object
*/
public function getAccessTokenParameter(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response);
}
/**
*
*/
class Bearer implements \OAuth2\TokenType\TokenTypeInterface
{
public function __construct(array $config = array())
{
}
public function getTokenType()
{
}
/**
* Check if the request has supplied token
*
* @see https://github.com/bshaffer/oauth2-server-php/issues/349#issuecomment-37993588
*/
public function requestHasToken(\OAuth2\RequestInterface $request)
{
}
/**
* This is a convenience function that can be used to get the token, which can then
* be passed to getAccessTokenData(). The constraints specified by the draft are
* attempted to be adheared to in this method.
*
* As per the Bearer spec (draft 8, section 2) - there are three ways for a client
* to specify the bearer token, in order of preference: Authorization Header,
* POST and GET.
*
* NB: Resource servers MUST accept tokens via the Authorization scheme
* (http://tools.ietf.org/html/rfc6750#section-2).
*
* @todo Should we enforce TLS/SSL in this function?
*
* @see http://tools.ietf.org/html/rfc6750#section-2.1
* @see http://tools.ietf.org/html/rfc6750#section-2.2
* @see http://tools.ietf.org/html/rfc6750#section-2.3
*
* Old Android version bug (at least with version 2.2)
* @see http://code.google.com/p/android/issues/detail?id=6684
*
*/
public function getAccessTokenParameter(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
}
/**
* This is not yet supported!
*/
class Mac implements \OAuth2\TokenType\TokenTypeInterface
{
public function getTokenType()
{
}
public function getAccessTokenParameter(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
}
}
namespace OAuth2\Storage {
/**
* Implement this interface to specify where the OAuth2 Server
* should retrieve data involving the relevent scopes associated
* with this implementation.
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface ScopeInterface
{
/**
* Check if the provided scope exists.
*
* @param $scope
* A space-separated string of scopes.
*
* @return
* TRUE if it exists, FALSE otherwise.
*/
public function scopeExists($scope);
/**
* The default scope to use in the event the client
* does not request one. By returning "false", a
* request_error is returned by the server to force a
* scope request by the client. By returning "null",
* opt out of requiring scopes
*
* @param $client_id
* An optional client id that can be used to return customized default scopes.
*
* @return
* string representation of default scope, null if
* scopes are not defined, or false to force scope
* request by the client
*
* ex:
* 'default'
* ex:
* null
*/
public function getDefaultScope($client_id = null);
}
}
namespace OAuth2 {
/**
* Class to handle scope implementation logic
*
* @see OAuth2\Storage\ScopeInterface
*/
interface ScopeInterface extends \OAuth2\Storage\ScopeInterface
{
/**
* Check if everything in required scope is contained in available scope.
*
* @param $required_scope
* A space-separated string of scopes.
*
* @return
* TRUE if everything in required scope is contained in available scope,
* and FALSE if it isn't.
*
* @see http://tools.ietf.org/html/rfc6749#section-7
*
* @ingroup oauth2_section_7
*/
public function checkScope($required_scope, $available_scope);
/**
* Return scope info from request
*
* @param OAuth2\RequestInterface
* Request object to check
*
* @return
* string representation of requested scope
*/
public function getScopeFromRequest(\OAuth2\RequestInterface $request);
}
/**
* @see OAuth2\ScopeInterface
*/
class Scope implements \OAuth2\ScopeInterface
{
protected $storage;
/**
* @param mixed @storage
* Either an array of supported scopes, or an instance of OAuth2\Storage\ScopeInterface
*/
public function __construct($storage = null)
{
}
/**
* Check if everything in required scope is contained in available scope.
*
* @param $required_scope
* A space-separated string of scopes.
*
* @return
* TRUE if everything in required scope is contained in available scope,
* and FALSE if it isn't.
*
* @see http://tools.ietf.org/html/rfc6749#section-7
*
* @ingroup oauth2_section_7
*/
public function checkScope($required_scope, $available_scope)
{
}
/**
* Check if the provided scope exists in storage.
*
* @param $scope
* A space-separated string of scopes.
*
* @return
* TRUE if it exists, FALSE otherwise.
*/
public function scopeExists($scope)
{
}
public function getScopeFromRequest(\OAuth2\RequestInterface $request)
{
}
public function getDefaultScope($client_id = null)
{
}
/**
* Get reserved scopes needed by the server.
*
* In case OpenID Connect is used, these scopes must include:
* 'openid', offline_access'.
*
* @return
* An array of reserved scopes.
*/
public function getReservedScopes()
{
}
}
}
namespace OAuth2\GrantType {
/**
* Interface for all OAuth2 Grant Types
*/
interface GrantTypeInterface
{
public function getQuerystringIdentifier();
public function validateRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response);
public function getClientId();
public function getUserId();
public function getScope();
public function createAccessToken(\OAuth2\ResponseType\AccessTokenInterface $accessToken, $client_id, $user_id, $scope);
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class UserCredentials implements \OAuth2\GrantType\GrantTypeInterface
{
protected $storage;
/**
* @param OAuth2\Storage\UserCredentialsInterface $storage REQUIRED Storage class for retrieving user credentials information
*/
public function __construct(\OAuth2\Storage\UserCredentialsInterface $storage)
{
}
public function getQuerystringIdentifier()
{
}
public function validateRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
public function getClientId()
{
}
public function getUserId()
{
}
public function getScope()
{
}
public function createAccessToken(\OAuth2\ResponseType\AccessTokenInterface $accessToken, $client_id, $user_id, $scope)
{
}
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class AuthorizationCode implements \OAuth2\GrantType\GrantTypeInterface
{
protected $storage;
protected $authCode;
/**
* @param OAuth2\Storage\AuthorizationCodeInterface $storage REQUIRED Storage class for retrieving authorization code information
*/
public function __construct(\OAuth2\Storage\AuthorizationCodeInterface $storage)
{
}
public function getQuerystringIdentifier()
{
}
public function validateRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
public function getClientId()
{
}
public function getScope()
{
}
public function getUserId()
{
}
public function createAccessToken(\OAuth2\ResponseType\AccessTokenInterface $accessToken, $client_id, $user_id, $scope)
{
}
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class RefreshToken implements \OAuth2\GrantType\GrantTypeInterface
{
protected $storage;
protected $config;
/**
* @param OAuth2\Storage\RefreshTokenInterface $storage REQUIRED Storage class for retrieving refresh token information
* @param array $config OPTIONAL Configuration options for the server
* <code>
* $config = array(
* 'always_issue_new_refresh_token' => true, // whether to issue a new refresh token upon successful token request
* 'unset_refresh_token_after_use' => true // whether to unset the refresh token after after using
* );
* </code>
*/
public function __construct(\OAuth2\Storage\RefreshTokenInterface $storage, $config = array())
{
}
public function getQuerystringIdentifier()
{
}
public function validateRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
public function getClientId()
{
}
public function getUserId()
{
}
public function getScope()
{
}
public function createAccessToken(\OAuth2\ResponseType\AccessTokenInterface $accessToken, $client_id, $user_id, $scope)
{
}
}
/**
* The JWT bearer authorization grant implements JWT (JSON Web Tokens) as a grant type per the IETF draft.
*
* @see http://tools.ietf.org/html/draft-ietf-oauth-jwt-bearer-04#section-4
*
* @author F21
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class JwtBearer implements \OAuth2\GrantType\GrantTypeInterface, \OAuth2\ClientAssertionType\ClientAssertionTypeInterface
{
protected $storage;
protected $audience;
protected $jwtUtil;
protected $allowedAlgorithms;
/**
* Creates an instance of the JWT bearer grant type.
*
* @param OAuth2\Storage\JWTBearerInterface|JwtBearerInterface $storage A valid storage interface that implements storage hooks for the JWT bearer grant type.
* @param string $audience The audience to validate the token against. This is usually the full URI of the OAuth token requests endpoint.
* @param EncryptionInterface|OAuth2\Encryption\JWT $jwtUtil OPTONAL The class used to decode, encode and verify JWTs.
* @param array $config
*/
public function __construct(\OAuth2\Storage\JwtBearerInterface $storage, $audience, \OAuth2\Encryption\EncryptionInterface $jwtUtil = null, array $config = array())
{
}
/**
* Returns the grant_type get parameter to identify the grant type request as JWT bearer authorization grant.
*
* @return
* The string identifier for grant_type.
*
* @see OAuth2\GrantType\GrantTypeInterface::getQuerystringIdentifier()
*/
public function getQuerystringIdentifier()
{
}
/**
* Validates the data from the decoded JWT.
*
* @return
* TRUE if the JWT request is valid and can be decoded. Otherwise, FALSE is returned.
*
* @see OAuth2\GrantType\GrantTypeInterface::getTokenData()
*/
public function validateRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
public function getClientId()
{
}
public function getUserId()
{
}
public function getScope()
{
}
/**
* Creates an access token that is NOT associated with a refresh token.
* If a subject (sub) the name of the user/account we are accessing data on behalf of.
*
* @see OAuth2\GrantType\GrantTypeInterface::createAccessToken()
*/
public function createAccessToken(\OAuth2\ResponseType\AccessTokenInterface $accessToken, $client_id, $user_id, $scope)
{
}
}
/**
* @author Brent Shaffer <bshafs at gmail dot com>
*
* @see OAuth2\ClientAssertionType_HttpBasic
*/
class ClientCredentials extends \OAuth2\ClientAssertionType\HttpBasic implements \OAuth2\GrantType\GrantTypeInterface
{
public function __construct(\OAuth2\Storage\ClientCredentialsInterface $storage, array $config = array())
{
}
public function getQuerystringIdentifier()
{
}
public function getScope()
{
}
public function getUserId()
{
}
public function createAccessToken(\OAuth2\ResponseType\AccessTokenInterface $accessToken, $client_id, $user_id, $scope)
{
}
}
}
namespace OAuth2\Storage {
/**
* Implement this interface to specify where the OAuth2 Server
* should get/save authorization codes for the "Authorization Code"
* grant type
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface AuthorizationCodeInterface
{
/**
* The Authorization Code grant type supports a response type of "code".
*
* @var string
* @see http://tools.ietf.org/html/rfc6749#section-1.4.1
* @see http://tools.ietf.org/html/rfc6749#section-4.2
*/
const RESPONSE_TYPE_CODE = "code";
/**
* Fetch authorization code data (probably the most common grant type).
*
* Retrieve the stored data for the given authorization code.
*
* Required for OAuth2::GRANT_TYPE_AUTH_CODE.
*
* @param $code
* Authorization code to be check with.
*
* @return
* An associative array as below, and NULL if the code is invalid
* @code
* return array(
* "client_id" => CLIENT_ID, // REQUIRED Stored client identifier
* "user_id" => USER_ID, // REQUIRED Stored user identifier
* "expires" => EXPIRES, // REQUIRED Stored expiration in unix timestamp
* "redirect_uri" => REDIRECT_URI, // REQUIRED Stored redirect URI
* "scope" => SCOPE, // OPTIONAL Stored scope values in space-separated string
* );
* @endcode
*
* @see http://tools.ietf.org/html/rfc6749#section-4.1
*
* @ingroup oauth2_section_4
*/
public function getAuthorizationCode($code);
/**
* Take the provided authorization code values and store them somewhere.
*
* This function should be the storage counterpart to getAuthCode().
*
* If storage fails for some reason, we're not currently checking for
* any sort of success/failure, so you should bail out of the script
* and provide a descriptive fail message.
*
* Required for OAuth2::GRANT_TYPE_AUTH_CODE.
*
* @param string $code Authorization code to be stored.
* @param mixed $client_id Client identifier to be stored.
* @param mixed $user_id User identifier to be stored.
* @param string $redirect_uri Redirect URI(s) to be stored in a space-separated string.
* @param int $expires Expiration to be stored as a Unix timestamp.
* @param string $scope OPTIONAL Scopes to be stored in space-separated string.
*
* @ingroup oauth2_section_4
*/
public function setAuthorizationCode($code, $client_id, $user_id, $redirect_uri, $expires, $scope = null);
/**
* once an Authorization Code is used, it must be exipired
*
* @see http://tools.ietf.org/html/rfc6749#section-4.1.2
*
* The client MUST NOT use the authorization code
* more than once. If an authorization code is used more than
* once, the authorization server MUST deny the request and SHOULD
* revoke (when possible) all tokens previously issued based on
* that authorization code
*
*/
public function expireAuthorizationCode($code);
}
/**
* Implement this interface to specify where the OAuth2 Server
* should get/save access tokens
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface AccessTokenInterface
{
/**
* Look up the supplied oauth_token from storage.
*
* We need to retrieve access token data as we create and verify tokens.
*
* @param $oauth_token
* oauth_token to be check with.
*
* @return
* An associative array as below, and return NULL if the supplied oauth_token
* is invalid:
* - expires: Stored expiration in unix timestamp.
* - client_id: (optional) Stored client identifier.
* - user_id: (optional) Stored user identifier.
* - scope: (optional) Stored scope values in space-separated string.
* - id_token: (optional) Stored id_token (if "use_openid_connect" is true).
*
* @ingroup oauth2_section_7
*/
public function getAccessToken($oauth_token);
/**
* Store the supplied access token values to storage.
*
* We need to store access token data as we create and verify tokens.
*
* @param $oauth_token oauth_token to be stored.
* @param $client_id client identifier to be stored.
* @param $user_id user identifier to be stored.
* @param int $expires expiration to be stored as a Unix timestamp.
* @param string $scope OPTIONAL Scopes to be stored in space-separated string.
*
* @ingroup oauth2_section_4
*/
public function setAccessToken($oauth_token, $client_id, $user_id, $expires, $scope = null);
/**
* Expire an access token.
*
* This is not explicitly required in the spec, but if defined in a draft RFC for token
* revoking (RFC 7009) https://tools.ietf.org/html/rfc7009
*
* @param $access_token
* Access token to be expired.
*
* @ingroup oauth2_section_6
*
* @todo v2.0 include this method in interface. Omitted to maintain BC in v1.x
*/
//public function unsetAccessToken($access_token);
}
/**
* Implement this interface to specify where the OAuth2 Server
* should retrieve client information
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface ClientInterface
{
/**
* Get client details corresponding client_id.
*
* OAuth says we should store request URIs for each registered client.
* Implement this function to grab the stored URI for a given client id.
*
* @param $client_id
* Client identifier to be check with.
*
* @return array
* Client details. The only mandatory key in the array is "redirect_uri".
* This function MUST return FALSE if the given client does not exist or is
* invalid. "redirect_uri" can be space-delimited to allow for multiple valid uris.
* <code>
* return array(
* "redirect_uri" => REDIRECT_URI, // REQUIRED redirect_uri registered for the client
* "client_id" => CLIENT_ID, // OPTIONAL the client id
* "grant_types" => GRANT_TYPES, // OPTIONAL an array of restricted grant types
* "user_id" => USER_ID, // OPTIONAL the user identifier associated with this client
* "scope" => SCOPE, // OPTIONAL the scopes allowed for this client
* );
* </code>
*
* @ingroup oauth2_section_4
*/
public function getClientDetails($client_id);
/**
* Get the scope associated with this client
*
* @return
* STRING the space-delineated scope list for the specified client_id
*/
public function getClientScope($client_id);
/**
* Check restricted grant types of corresponding client identifier.
*
* If you want to restrict clients to certain grant types, override this
* function.
*
* @param $client_id
* Client identifier to be check with.
* @param $grant_type
* Grant type to be check with
*
* @return
* TRUE if the grant type is supported by this client identifier, and
* FALSE if it isn't.
*
* @ingroup oauth2_section_4
*/
public function checkRestrictedGrantType($client_id, $grant_type);
}
/**
* Implement this interface to specify how the OAuth2 Server
* should verify client credentials
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface ClientCredentialsInterface extends \OAuth2\Storage\ClientInterface
{
/**
* Make sure that the client credentials is valid.
*
* @param $client_id
* Client identifier to be check with.
* @param $client_secret
* (optional) If a secret is required, check that they've given the right one.
*
* @return
* TRUE if the client credentials are valid, and MUST return FALSE if it isn't.
* @endcode
*
* @see http://tools.ietf.org/html/rfc6749#section-3.1
*
* @ingroup oauth2_section_3
*/
public function checkClientCredentials($client_id, $client_secret = null);
/**
* Determine if the client is a "public" client, and therefore
* does not require passing credentials for certain grant types
*
* @param $client_id
* Client identifier to be check with.
*
* @return
* TRUE if the client is public, and FALSE if it isn't.
* @endcode
*
* @see http://tools.ietf.org/html/rfc6749#section-2.3
* @see https://github.com/bshaffer/oauth2-server-php/issues/257
*
* @ingroup oauth2_section_2
*/
public function isPublicClient($client_id);
}
/**
* Implement this interface to specify where the OAuth2 Server
* should retrieve user credentials for the
* "Resource Owner Password Credentials" grant type
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface UserCredentialsInterface
{
/**
* Grant access tokens for basic user credentials.
*
* Check the supplied username and password for validity.
*
* You can also use the $client_id param to do any checks required based
* on a client, if you need that.
*
* Required for OAuth2::GRANT_TYPE_USER_CREDENTIALS.
*
* @param $username
* Username to be check with.
* @param $password
* Password to be check with.
*
* @return
* TRUE if the username and password are valid, and FALSE if it isn't.
* Moreover, if the username and password are valid, and you want to
*
* @see http://tools.ietf.org/html/rfc6749#section-4.3
*
* @ingroup oauth2_section_4
*/
public function checkUserCredentials($username, $password);
/**
* @return
* ARRAY the associated "user_id" and optional "scope" values
* This function MUST return FALSE if the requested user does not exist or is
* invalid. "scope" is a space-separated list of restricted scopes.
* @code
* return array(
* "user_id" => USER_ID, // REQUIRED user_id to be stored with the authorization code or access token
* "scope" => SCOPE // OPTIONAL space-separated list of restricted scopes
* );
* @endcode
*/
public function getUserDetails($username);
}
/**
* Implement this interface to specify where the OAuth2 Server
* should get/save refresh tokens for the "Refresh Token"
* grant type
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface RefreshTokenInterface
{
/**
* Grant refresh access tokens.
*
* Retrieve the stored data for the given refresh token.
*
* Required for OAuth2::GRANT_TYPE_REFRESH_TOKEN.
*
* @param $refresh_token
* Refresh token to be check with.
*
* @return
* An associative array as below, and NULL if the refresh_token is
* invalid:
* - refresh_token: Refresh token identifier.
* - client_id: Client identifier.
* - user_id: User identifier.
* - expires: Expiration unix timestamp, or 0 if the token doesn't expire.
* - scope: (optional) Scope values in space-separated string.
*
* @see http://tools.ietf.org/html/rfc6749#section-6
*
* @ingroup oauth2_section_6
*/
public function getRefreshToken($refresh_token);
/**
* Take the provided refresh token values and store them somewhere.
*
* This function should be the storage counterpart to getRefreshToken().
*
* If storage fails for some reason, we're not currently checking for
* any sort of success/failure, so you should bail out of the script
* and provide a descriptive fail message.
*
* Required for OAuth2::GRANT_TYPE_REFRESH_TOKEN.
*
* @param $refresh_token
* Refresh token to be stored.
* @param $client_id
* Client identifier to be stored.
* @param $user_id
* User identifier to be stored.
* @param $expires
* Expiration timestamp to be stored. 0 if the token doesn't expire.
* @param $scope
* (optional) Scopes to be stored in space-separated string.
*
* @ingroup oauth2_section_6
*/
public function setRefreshToken($refresh_token, $client_id, $user_id, $expires, $scope = null);
/**
* Expire a used refresh token.
*
* This is not explicitly required in the spec, but is almost implied.
* After granting a new refresh token, the old one is no longer useful and
* so should be forcibly expired in the data store so it can't be used again.
*
* If storage fails for some reason, we're not currently checking for
* any sort of success/failure, so you should bail out of the script
* and provide a descriptive fail message.
*
* @param $refresh_token
* Refresh token to be expirse.
*
* @ingroup oauth2_section_6
*/
public function unsetRefreshToken($refresh_token);
}
/**
* Implement this interface to specify where the OAuth2 Server
* should get the JWT key for clients
*
* @TODO consider extending ClientInterface, as this will almost always
* be the same storage as retrieving clientData
*
* @author F21
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface JwtBearerInterface
{
/**
* Get the public key associated with a client_id
*
* @param $client_id
* Client identifier to be checked with.
*
* @return
* STRING Return the public key for the client_id if it exists, and MUST return FALSE if it doesn't.
*/
public function getClientKey($client_id, $subject);
/**
* Get a jti (JSON token identifier) by matching against the client_id, subject, audience and expiration.
*
* @param $client_id
* Client identifier to match.
*
* @param $subject
* The subject to match.
*
* @param $audience
* The audience to match.
*
* @param $expiration
* The expiration of the jti.
*
* @param $jti
* The jti to match.
*
* @return
* An associative array as below, and return NULL if the jti does not exist.
* - issuer: Stored client identifier.
* - subject: Stored subject.
* - audience: Stored audience.
* - expires: Stored expiration in unix timestamp.
* - jti: The stored jti.
*/
public function getJti($client_id, $subject, $audience, $expiration, $jti);
/**
* Store a used jti so that we can check against it to prevent replay attacks.
* @param $client_id
* Client identifier to insert.
*
* @param $subject
* The subject to insert.
*
* @param $audience
* The audience to insert.
*
* @param $expiration
* The expiration of the jti.
*
* @param $jti
* The jti to insert.
*/
public function setJti($client_id, $subject, $audience, $expiration, $jti);
}
}
namespace OAuth2\OpenID\Storage {
/**
* Implement this interface to specify where the OAuth2 Server
* should get/save authorization codes for the "Authorization Code"
* grant type
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface AuthorizationCodeInterface extends \OAuth2\Storage\AuthorizationCodeInterface
{
/**
* Take the provided authorization code values and store them somewhere.
*
* This function should be the storage counterpart to getAuthCode().
*
* If storage fails for some reason, we're not currently checking for
* any sort of success/failure, so you should bail out of the script
* and provide a descriptive fail message.
*
* Required for OAuth2::GRANT_TYPE_AUTH_CODE.
*
* @param $code authorization code to be stored.
* @param $client_id client identifier to be stored.
* @param $user_id user identifier to be stored.
* @param string $redirect_uri redirect URI(s) to be stored in a space-separated string.
* @param int $expires expiration to be stored as a Unix timestamp.
* @param string $scope OPTIONAL scopes to be stored in space-separated string.
* @param string $id_token OPTIONAL the OpenID Connect id_token.
*
* @ingroup oauth2_section_4
*/
public function setAuthorizationCode($code, $client_id, $user_id, $redirect_uri, $expires, $scope = null, $id_token = null);
}
}
namespace OAuth2\Storage {
/**
* Simple Couchbase storage for all storage types
*
* This class should be extended or overridden as required
*
* NOTE: Passwords are stored in plaintext, which is never
* a good idea. Be sure to override this for your application
*
* @author Tom Park <tom@raucter.com>
*/
class CouchbaseDB implements \OAuth2\Storage\AuthorizationCodeInterface, \OAuth2\Storage\AccessTokenInterface, \OAuth2\Storage\ClientCredentialsInterface, \OAuth2\Storage\UserCredentialsInterface, \OAuth2\Storage\RefreshTokenInterface, \OAuth2\Storage\JwtBearerInterface, \OAuth2\OpenID\Storage\AuthorizationCodeInterface
{
protected $db;
protected $config;
public function __construct($connection, $config = array())
{
}
// Helper function to access couchbase item by type:
protected function getObjectByType($name, $id)
{
}
// Helper function to set couchbase item by type:
protected function setObjectByType($name, $id, $array)
{
}
// Helper function to delete couchbase item by type, wait for persist to at least 1 node
protected function deleteObjectByType($name, $id)
{
}
/* ClientCredentialsInterface */
public function checkClientCredentials($client_id, $client_secret = null)
{
}
public function isPublicClient($client_id)
{
}
/* ClientInterface */
public function getClientDetails($client_id)
{
}
public function setClientDetails($client_id, $client_secret = null, $redirect_uri = null, $grant_types = null, $scope = null, $user_id = null)
{
}
public function checkRestrictedGrantType($client_id, $grant_type)
{
}
/* AccessTokenInterface */
public function getAccessToken($access_token)
{
}
public function setAccessToken($access_token, $client_id, $user_id, $expires, $scope = null)
{
}
/* AuthorizationCodeInterface */
public function getAuthorizationCode($code)
{
}
public function setAuthorizationCode($code, $client_id, $user_id, $redirect_uri, $expires, $scope = null, $id_token = null)
{
}
public function expireAuthorizationCode($code)
{
}
/* UserCredentialsInterface */
public function checkUserCredentials($username, $password)
{
}
public function getUserDetails($username)
{
}
/* RefreshTokenInterface */
public function getRefreshToken($refresh_token)
{
}
public function setRefreshToken($refresh_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetRefreshToken($refresh_token)
{
}
// plaintext passwords are bad! Override this for your application
protected function checkPassword($user, $password)
{
}
public function getUser($username)
{
}
public function setUser($username, $password, $firstName = null, $lastName = null)
{
}
public function getClientKey($client_id, $subject)
{
}
public function getClientScope($client_id)
{
}
public function getJti($client_id, $subject, $audience, $expiration, $jti)
{
}
public function setJti($client_id, $subject, $audience, $expiration, $jti)
{
}
}
/**
* Implement this interface to specify where the OAuth2 Server
* should get public/private key information
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface PublicKeyInterface
{
public function getPublicKey($client_id = null);
public function getPrivateKey($client_id = null);
public function getEncryptionAlgorithm($client_id = null);
}
}
namespace OAuth2\OpenID\Storage {
/**
* Implement this interface to specify where the OAuth2 Server
* should retrieve user claims for the OpenID Connect id_token.
*/
interface UserClaimsInterface
{
// valid scope values to pass into the user claims API call
const VALID_CLAIMS = 'profile email address phone';
// fields returned for the claims above
const PROFILE_CLAIM_VALUES = 'name family_name given_name middle_name nickname preferred_username profile picture website gender birthdate zoneinfo locale updated_at';
const EMAIL_CLAIM_VALUES = 'email email_verified';
const ADDRESS_CLAIM_VALUES = 'formatted street_address locality region postal_code country';
const PHONE_CLAIM_VALUES = 'phone_number phone_number_verified';
/**
* Return claims about the provided user id.
*
* Groups of claims are returned based on the requested scopes. No group
* is required, and no claim is required.
*
* @param $user_id
* The id of the user for which claims should be returned.
* @param $scope
* The requested scope.
* Scopes with matching claims: profile, email, address, phone.
*
* @return
* An array in the claim => value format.
*
* @see http://openid.net/specs/openid-connect-core-1_0.html#ScopeClaims
*/
public function getUserClaims($user_id, $scope);
}
}
namespace OAuth2\Storage {
/**
* Simple PDO storage for all storage types
*
* NOTE: This class is meant to get users started
* quickly. If your application requires further
* customization, extend this class or create your own.
*
* NOTE: Passwords are stored in plaintext, which is never
* a good idea. Be sure to override this for your application
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class Pdo implements \OAuth2\Storage\AuthorizationCodeInterface, \OAuth2\Storage\AccessTokenInterface, \OAuth2\Storage\ClientCredentialsInterface, \OAuth2\Storage\UserCredentialsInterface, \OAuth2\Storage\RefreshTokenInterface, \OAuth2\Storage\JwtBearerInterface, \OAuth2\Storage\ScopeInterface, \OAuth2\Storage\PublicKeyInterface, \OAuth2\OpenID\Storage\UserClaimsInterface, \OAuth2\OpenID\Storage\AuthorizationCodeInterface
{
protected $db;
protected $config;
public function __construct($connection, $config = array())
{
}
/* OAuth2\Storage\ClientCredentialsInterface */
public function checkClientCredentials($client_id, $client_secret = null)
{
}
public function isPublicClient($client_id)
{
}
/* OAuth2\Storage\ClientInterface */
public function getClientDetails($client_id)
{
}
public function setClientDetails($client_id, $client_secret = null, $redirect_uri = null, $grant_types = null, $scope = null, $user_id = null)
{
}
public function checkRestrictedGrantType($client_id, $grant_type)
{
}
/* OAuth2\Storage\AccessTokenInterface */
public function getAccessToken($access_token)
{
}
public function setAccessToken($access_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetAccessToken($access_token)
{
}
/* OAuth2\Storage\AuthorizationCodeInterface */
public function getAuthorizationCode($code)
{
}
public function setAuthorizationCode($code, $client_id, $user_id, $redirect_uri, $expires, $scope = null, $id_token = null)
{
}
public function expireAuthorizationCode($code)
{
}
/* OAuth2\Storage\UserCredentialsInterface */
public function checkUserCredentials($username, $password)
{
}
public function getUserDetails($username)
{
}
/* UserClaimsInterface */
public function getUserClaims($user_id, $claims)
{
}
protected function getUserClaim($claim, $userDetails)
{
}
/* OAuth2\Storage\RefreshTokenInterface */
public function getRefreshToken($refresh_token)
{
}
public function setRefreshToken($refresh_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetRefreshToken($refresh_token)
{
}
// plaintext passwords are bad! Override this for your application
protected function checkPassword($user, $password)
{
}
public function getUser($username)
{
}
public function setUser($username, $password, $firstName = null, $lastName = null)
{
}
/* ScopeInterface */
public function scopeExists($scope)
{
}
public function getDefaultScope($client_id = null)
{
}
/* JWTBearerInterface */
public function getClientKey($client_id, $subject)
{
}
public function getClientScope($client_id)
{
}
public function getJti($client_id, $subject, $audience, $expires, $jti)
{
}
public function setJti($client_id, $subject, $audience, $expires, $jti)
{
}
/* PublicKeyInterface */
public function getPublicKey($client_id = null)
{
}
public function getPrivateKey($client_id = null)
{
}
public function getEncryptionAlgorithm($client_id = null)
{
}
/**
* DDL to create OAuth2 database and tables for PDO storage
*
* @see https://github.com/dsquier/oauth2-server-php-mysql
*/
public function getBuildSql($dbName = 'oauth2_server_php')
{
}
}
/**
* No specific methods, but allows the library to check "instanceof"
* against interface rather than class
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface JwtAccessTokenInterface extends \OAuth2\Storage\AccessTokenInterface
{
}
/**
* Simple MongoDB storage for all storage types
*
* NOTE: This class is meant to get users started
* quickly. If your application requires further
* customization, extend this class or create your own.
*
* NOTE: Passwords are stored in plaintext, which is never
* a good idea. Be sure to override this for your application
*
* @author Julien Chaumond <chaumond@gmail.com>
*/
class Mongo implements \OAuth2\Storage\AuthorizationCodeInterface, \OAuth2\Storage\AccessTokenInterface, \OAuth2\Storage\ClientCredentialsInterface, \OAuth2\Storage\UserCredentialsInterface, \OAuth2\Storage\RefreshTokenInterface, \OAuth2\Storage\JwtBearerInterface, \OAuth2\OpenID\Storage\AuthorizationCodeInterface
{
protected $db;
protected $config;
public function __construct($connection, $config = array())
{
}
// Helper function to access a MongoDB collection by `type`:
protected function collection($name)
{
}
/* ClientCredentialsInterface */
public function checkClientCredentials($client_id, $client_secret = null)
{
}
public function isPublicClient($client_id)
{
}
/* ClientInterface */
public function getClientDetails($client_id)
{
}
public function setClientDetails($client_id, $client_secret = null, $redirect_uri = null, $grant_types = null, $scope = null, $user_id = null)
{
}
public function checkRestrictedGrantType($client_id, $grant_type)
{
}
/* AccessTokenInterface */
public function getAccessToken($access_token)
{
}
public function setAccessToken($access_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetAccessToken($access_token)
{
}
/* AuthorizationCodeInterface */
public function getAuthorizationCode($code)
{
}
public function setAuthorizationCode($code, $client_id, $user_id, $redirect_uri, $expires, $scope = null, $id_token = null)
{
}
public function expireAuthorizationCode($code)
{
}
/* UserCredentialsInterface */
public function checkUserCredentials($username, $password)
{
}
public function getUserDetails($username)
{
}
/* RefreshTokenInterface */
public function getRefreshToken($refresh_token)
{
}
public function setRefreshToken($refresh_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetRefreshToken($refresh_token)
{
}
// plaintext passwords are bad! Override this for your application
protected function checkPassword($user, $password)
{
}
public function getUser($username)
{
}
public function setUser($username, $password, $firstName = null, $lastName = null)
{
}
public function getClientKey($client_id, $subject)
{
}
public function getClientScope($client_id)
{
}
public function getJti($client_id, $subject, $audience, $expiration, $jti)
{
}
public function setJti($client_id, $subject, $audience, $expiration, $jti)
{
}
}
/**
* redis storage for all storage types
*
* To use, install "predis/predis" via composer
*
* Register client:
* <code>
* $storage = new OAuth2\Storage\Redis($redis);
* $storage->setClientDetails($client_id, $client_secret, $redirect_uri);
* </code>
*/
class Redis implements \OAuth2\Storage\AuthorizationCodeInterface, \OAuth2\Storage\AccessTokenInterface, \OAuth2\Storage\ClientCredentialsInterface, \OAuth2\Storage\UserCredentialsInterface, \OAuth2\Storage\RefreshTokenInterface, \OAuth2\Storage\JwtBearerInterface, \OAuth2\Storage\ScopeInterface, \OAuth2\OpenID\Storage\AuthorizationCodeInterface
{
/* The redis client */
protected $redis;
/* Configuration array */
protected $config;
/**
* Redis Storage!
*
* @param \Predis\Client $redis
* @param array $config
*/
public function __construct($redis, $config = array())
{
}
protected function getValue($key)
{
}
protected function setValue($key, $value, $expire = 0)
{
}
protected function expireValue($key)
{
}
/* AuthorizationCodeInterface */
public function getAuthorizationCode($code)
{
}
public function setAuthorizationCode($authorization_code, $client_id, $user_id, $redirect_uri, $expires, $scope = null, $id_token = null)
{
}
public function expireAuthorizationCode($code)
{
}
/* UserCredentialsInterface */
public function checkUserCredentials($username, $password)
{
}
public function getUserDetails($username)
{
}
public function getUser($username)
{
}
public function setUser($username, $password, $first_name = null, $last_name = null)
{
}
/* ClientCredentialsInterface */
public function checkClientCredentials($client_id, $client_secret = null)
{
}
public function isPublicClient($client_id)
{
}
/* ClientInterface */
public function getClientDetails($client_id)
{
}
public function setClientDetails($client_id, $client_secret = null, $redirect_uri = null, $grant_types = null, $scope = null, $user_id = null)
{
}
public function checkRestrictedGrantType($client_id, $grant_type)
{
}
/* RefreshTokenInterface */
public function getRefreshToken($refresh_token)
{
}
public function setRefreshToken($refresh_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetRefreshToken($refresh_token)
{
}
/* AccessTokenInterface */
public function getAccessToken($access_token)
{
}
public function setAccessToken($access_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetAccessToken($access_token)
{
}
/* ScopeInterface */
public function scopeExists($scope)
{
}
public function getDefaultScope($client_id = null)
{
}
public function setScope($scope, $client_id = null, $type = 'supported')
{
}
/*JWTBearerInterface */
public function getClientKey($client_id, $subject)
{
}
public function setClientKey($client_id, $key, $subject = null)
{
}
public function getClientScope($client_id)
{
}
public function getJti($client_id, $subject, $audience, $expiration, $jti)
{
}
public function setJti($client_id, $subject, $audience, $expiration, $jti)
{
}
}
/**
* Simple in-memory storage for all storage types
*
* NOTE: This class should never be used in production, and is
* a stub class for example use only
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class Memory implements \OAuth2\Storage\AuthorizationCodeInterface, \OAuth2\Storage\UserCredentialsInterface, \OAuth2\OpenID\Storage\UserClaimsInterface, \OAuth2\Storage\AccessTokenInterface, \OAuth2\Storage\ClientCredentialsInterface, \OAuth2\Storage\RefreshTokenInterface, \OAuth2\Storage\JwtBearerInterface, \OAuth2\Storage\ScopeInterface, \OAuth2\Storage\PublicKeyInterface, \OAuth2\OpenID\Storage\AuthorizationCodeInterface
{
public $authorizationCodes;
public $userCredentials;
public $clientCredentials;
public $refreshTokens;
public $accessTokens;
public $jwt;
public $jti;
public $supportedScopes;
public $defaultScope;
public $keys;
public function __construct($params = array())
{
}
/* AuthorizationCodeInterface */
public function getAuthorizationCode($code)
{
}
public function setAuthorizationCode($code, $client_id, $user_id, $redirect_uri, $expires, $scope = null, $id_token = null)
{
}
public function setAuthorizationCodes($authorization_codes)
{
}
public function expireAuthorizationCode($code)
{
}
/* UserCredentialsInterface */
public function checkUserCredentials($username, $password)
{
}
public function setUser($username, $password, $firstName = null, $lastName = null)
{
}
public function getUserDetails($username)
{
}
/* UserClaimsInterface */
public function getUserClaims($user_id, $claims)
{
}
protected function getUserClaim($claim, $userDetails)
{
}
/* ClientCredentialsInterface */
public function checkClientCredentials($client_id, $client_secret = null)
{
}
public function isPublicClient($client_id)
{
}
/* ClientInterface */
public function getClientDetails($client_id)
{
}
public function checkRestrictedGrantType($client_id, $grant_type)
{
}
public function setClientDetails($client_id, $client_secret = null, $redirect_uri = null, $grant_types = null, $scope = null, $user_id = null)
{
}
/* RefreshTokenInterface */
public function getRefreshToken($refresh_token)
{
}
public function setRefreshToken($refresh_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetRefreshToken($refresh_token)
{
}
public function setRefreshTokens($refresh_tokens)
{
}
/* AccessTokenInterface */
public function getAccessToken($access_token)
{
}
public function setAccessToken($access_token, $client_id, $user_id, $expires, $scope = null, $id_token = null)
{
}
public function unsetAccessToken($access_token)
{
}
public function scopeExists($scope)
{
}
public function getDefaultScope($client_id = null)
{
}
/*JWTBearerInterface */
public function getClientKey($client_id, $subject)
{
}
public function getClientScope($client_id)
{
}
public function getJti($client_id, $subject, $audience, $expires, $jti)
{
}
public function setJti($client_id, $subject, $audience, $expires, $jti)
{
}
/*PublicKeyInterface */
public function getPublicKey($client_id = null)
{
}
public function getPrivateKey($client_id = null)
{
}
public function getEncryptionAlgorithm($client_id = null)
{
}
}
/**
* DynamoDB storage for all storage types
*
* To use, install "aws/aws-sdk-php" via composer
* <code>
* composer require aws/aws-sdk-php:dev-master
* </code>
*
* Once this is done, instantiate the DynamoDB client
* <code>
* $storage = new OAuth2\Storage\Dynamodb(array("key" => "YOURKEY", "secret" => "YOURSECRET", "region" => "YOURREGION"));
* </code>
*
* Table :
* - oauth_access_tokens (primary hash key : access_token)
* - oauth_authorization_codes (primary hash key : authorization_code)
* - oauth_clients (primary hash key : client_id)
* - oauth_jwt (primary hash key : client_id, primary range key : subject)
* - oauth_public_keys (primary hash key : client_id)
* - oauth_refresh_tokens (primary hash key : refresh_token)
* - oauth_scopes (primary hash key : scope, secondary index : is_default-index hash key is_default)
* - oauth_users (primary hash key : username)
*
* @author Frederic AUGUSTE <frederic.auguste at gmail dot com>
*/
class DynamoDB implements \OAuth2\Storage\AuthorizationCodeInterface, \OAuth2\Storage\AccessTokenInterface, \OAuth2\Storage\ClientCredentialsInterface, \OAuth2\Storage\UserCredentialsInterface, \OAuth2\Storage\RefreshTokenInterface, \OAuth2\Storage\JwtBearerInterface, \OAuth2\Storage\ScopeInterface, \OAuth2\Storage\PublicKeyInterface, \OAuth2\OpenID\Storage\UserClaimsInterface, \OAuth2\OpenID\Storage\AuthorizationCodeInterface
{
protected $client;
protected $config;
public function __construct($connection, $config = array())
{
}
/* OAuth2\Storage\ClientCredentialsInterface */
public function checkClientCredentials($client_id, $client_secret = null)
{
}
public function isPublicClient($client_id)
{
}
/* OAuth2\Storage\ClientInterface */
public function getClientDetails($client_id)
{
}
public function setClientDetails($client_id, $client_secret = null, $redirect_uri = null, $grant_types = null, $scope = null, $user_id = null)
{
}
public function checkRestrictedGrantType($client_id, $grant_type)
{
}
/* OAuth2\Storage\AccessTokenInterface */
public function getAccessToken($access_token)
{
}
public function setAccessToken($access_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetAccessToken($access_token)
{
}
/* OAuth2\Storage\AuthorizationCodeInterface */
public function getAuthorizationCode($code)
{
}
public function setAuthorizationCode($authorization_code, $client_id, $user_id, $redirect_uri, $expires, $scope = null, $id_token = null)
{
}
public function expireAuthorizationCode($code)
{
}
/* OAuth2\Storage\UserCredentialsInterface */
public function checkUserCredentials($username, $password)
{
}
public function getUserDetails($username)
{
}
/* UserClaimsInterface */
public function getUserClaims($user_id, $claims)
{
}
protected function getUserClaim($claim, $userDetails)
{
}
/* OAuth2\Storage\RefreshTokenInterface */
public function getRefreshToken($refresh_token)
{
}
public function setRefreshToken($refresh_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetRefreshToken($refresh_token)
{
}
// plaintext passwords are bad! Override this for your application
protected function checkPassword($user, $password)
{
}
public function getUser($username)
{
}
public function setUser($username, $password, $first_name = null, $last_name = null)
{
}
/* ScopeInterface */
public function scopeExists($scope)
{
}
public function getDefaultScope($client_id = null)
{
}
/* JWTBearerInterface */
public function getClientKey($client_id, $subject)
{
}
public function getClientScope($client_id)
{
}
public function getJti($client_id, $subject, $audience, $expires, $jti)
{
}
public function setJti($client_id, $subject, $audience, $expires, $jti)
{
}
/* PublicKeyInterface */
public function getPublicKey($client_id = '0')
{
}
public function getPrivateKey($client_id = '0')
{
}
public function getEncryptionAlgorithm($client_id = null)
{
}
}
/**
* Cassandra storage for all storage types
*
* To use, install "thobbs/phpcassa" via composer
* <code>
* composer require thobbs/phpcassa:dev-master
* </code>
*
* Once this is done, instantiate the
* <code>
* $cassandra = new \phpcassa\Connection\ConnectionPool('oauth2_server', array('127.0.0.1:9160'));
* </code>
*
* Then, register the storage client:
* <code>
* $storage = new OAuth2\Storage\Cassandra($cassandra);
* $storage->setClientDetails($client_id, $client_secret, $redirect_uri);
* </code>
*
* @see test/lib/OAuth2/Storage/Bootstrap::getCassandraStorage
*/
class Cassandra implements \OAuth2\Storage\AuthorizationCodeInterface, \OAuth2\Storage\AccessTokenInterface, \OAuth2\Storage\ClientCredentialsInterface, \OAuth2\Storage\UserCredentialsInterface, \OAuth2\Storage\RefreshTokenInterface, \OAuth2\Storage\JwtBearerInterface, \OAuth2\Storage\ScopeInterface, \OAuth2\Storage\PublicKeyInterface, \OAuth2\OpenID\Storage\UserClaimsInterface, \OAuth2\OpenID\Storage\AuthorizationCodeInterface
{
/* The cassandra client */
protected $cassandra;
/* Configuration array */
protected $config;
/**
* Cassandra Storage! uses phpCassa
*
* @param \phpcassa\ConnectionPool $cassandra
* @param array $config
*/
public function __construct($connection = array(), array $config = array())
{
}
protected function getValue($key)
{
}
protected function setValue($key, $value, $expire = 0)
{
}
protected function expireValue($key)
{
}
/* AuthorizationCodeInterface */
public function getAuthorizationCode($code)
{
}
public function setAuthorizationCode($authorization_code, $client_id, $user_id, $redirect_uri, $expires, $scope = null, $id_token = null)
{
}
public function expireAuthorizationCode($code)
{
}
/* UserCredentialsInterface */
public function checkUserCredentials($username, $password)
{
}
// plaintext passwords are bad! Override this for your application
protected function checkPassword($user, $password)
{
}
public function getUserDetails($username)
{
}
public function getUser($username)
{
}
public function setUser($username, $password, $first_name = null, $last_name = null)
{
}
/* ClientCredentialsInterface */
public function checkClientCredentials($client_id, $client_secret = null)
{
}
public function isPublicClient($client_id)
{
}
/* ClientInterface */
public function getClientDetails($client_id)
{
}
public function setClientDetails($client_id, $client_secret = null, $redirect_uri = null, $grant_types = null, $scope = null, $user_id = null)
{
}
public function checkRestrictedGrantType($client_id, $grant_type)
{
}
/* RefreshTokenInterface */
public function getRefreshToken($refresh_token)
{
}
public function setRefreshToken($refresh_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetRefreshToken($refresh_token)
{
}
/* AccessTokenInterface */
public function getAccessToken($access_token)
{
}
public function setAccessToken($access_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetAccessToken($access_token)
{
}
/* ScopeInterface */
public function scopeExists($scope)
{
}
public function getDefaultScope($client_id = null)
{
}
public function setScope($scope, $client_id = null, $type = 'supported')
{
}
/*JWTBearerInterface */
public function getClientKey($client_id, $subject)
{
}
public function setClientKey($client_id, $key, $subject = null)
{
}
/*ScopeInterface */
public function getClientScope($client_id)
{
}
public function getJti($client_id, $subject, $audience, $expiration, $jti)
{
}
public function setJti($client_id, $subject, $audience, $expiration, $jti)
{
}
/* PublicKeyInterface */
public function getPublicKey($client_id = '')
{
}
public function getPrivateKey($client_id = '')
{
}
public function getEncryptionAlgorithm($client_id = null)
{
}
/* UserClaimsInterface */
public function getUserClaims($user_id, $claims)
{
}
protected function getUserClaim($claim, $userDetails)
{
}
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class JwtAccessToken implements \OAuth2\Storage\JwtAccessTokenInterface
{
protected $publicKeyStorage;
protected $tokenStorage;
protected $encryptionUtil;
/**
* @param OAuth2\Encryption\PublicKeyInterface $publicKeyStorage the public key encryption to use
* @param OAuth2\Storage\AccessTokenInterface $tokenStorage OPTIONAL persist the access token to another storage. This is useful if
* you want to retain access token grant information somewhere, but
* is not necessary when using this grant type.
* @param OAuth2\Encryption\EncryptionInterface $encryptionUtil OPTIONAL class to use for "encode" and "decode" functions.
*/
public function __construct(\OAuth2\Storage\PublicKeyInterface $publicKeyStorage, \OAuth2\Storage\AccessTokenInterface $tokenStorage = null, \OAuth2\Encryption\EncryptionInterface $encryptionUtil = null)
{
}
public function getAccessToken($oauth_token)
{
}
public function setAccessToken($oauth_token, $client_id, $user_id, $expires, $scope = null)
{
}
public function unsetAccessToken($access_token)
{
}
// converts a JWT access token into an OAuth2-friendly format
protected function convertJwtToOAuth2($tokenData)
{
}
}
}
namespace OAuth2\ResponseType {
interface ResponseTypeInterface
{
public function getAuthorizeResponse($params, $user_id = null);
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface AccessTokenInterface extends \OAuth2\ResponseType\ResponseTypeInterface
{
/**
* Handle the creation of access token, also issue refresh token if supported / desirable.
*
* @param $client_id client identifier related to the access token.
* @param $user_id user ID associated with the access token
* @param $scope OPTONAL scopes to be stored in space-separated string.
* @param bool $includeRefreshToken if true, a new refresh_token will be added to the response
*
* @see http://tools.ietf.org/html/rfc6749#section-5
* @ingroup oauth2_section_5
*/
public function createAccessToken($client_id, $user_id, $scope = null, $includeRefreshToken = true);
/**
* Handle the revoking of refresh tokens, and access tokens if supported / desirable
*
* @param $token
* @param $tokenTypeHint
* @return mixed
*
* @todo v2.0 include this method in interface. Omitted to maintain BC in v1.x
*/
//public function revokeToken($token, $tokenTypeHint);
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class AccessToken implements \OAuth2\ResponseType\AccessTokenInterface
{
protected $tokenStorage;
protected $refreshStorage;
protected $config;
/**
* @param OAuth2\Storage\AccessTokenInterface $tokenStorage REQUIRED Storage class for saving access token information
* @param OAuth2\Storage\RefreshTokenInterface $refreshStorage OPTIONAL Storage class for saving refresh token information
* @param array $config OPTIONAL Configuration options for the server
* <code>
* $config = array(
* 'token_type' => 'bearer', // token type identifier
* 'access_lifetime' => 3600, // time before access token expires
* 'refresh_token_lifetime' => 1209600, // time before refresh token expires
* );
* </endcode>
*/
public function __construct(\OAuth2\Storage\AccessTokenInterface $tokenStorage, \OAuth2\Storage\RefreshTokenInterface $refreshStorage = null, array $config = array())
{
}
public function getAuthorizeResponse($params, $user_id = null)
{
}
/**
* Handle the creation of access token, also issue refresh token if supported / desirable.
*
* @param $client_id client identifier related to the access token.
* @param $user_id user ID associated with the access token
* @param $scope OPTIONAL scopes to be stored in space-separated string.
* @param bool $includeRefreshToken if true, a new refresh_token will be added to the response
*
* @see http://tools.ietf.org/html/rfc6749#section-5
* @ingroup oauth2_section_5
*/
public function createAccessToken($client_id, $user_id, $scope = null, $includeRefreshToken = true)
{
}
/**
* Generates an unique access token.
*
* Implementing classes may want to override this function to implement
* other access token generation schemes.
*
* @return
* An unique access token.
*
* @ingroup oauth2_section_4
*/
protected function generateAccessToken()
{
}
/**
* Generates an unique refresh token
*
* Implementing classes may want to override this function to implement
* other refresh token generation schemes.
*
* @return
* An unique refresh.
*
* @ingroup oauth2_section_4
* @see OAuth2::generateAccessToken()
*/
protected function generateRefreshToken()
{
}
/**
* Handle the revoking of refresh tokens, and access tokens if supported / desirable
* RFC7009 specifies that "If the server is unable to locate the token using
* the given hint, it MUST extend its search across all of its supported token types"
*
* @param $token
* @param null $tokenTypeHint
* @return boolean
*/
public function revokeToken($token, $tokenTypeHint = null)
{
}
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface AuthorizationCodeInterface extends \OAuth2\ResponseType\ResponseTypeInterface
{
/**
* @return
* TRUE if the grant type requires a redirect_uri, FALSE if not
*/
public function enforceRedirect();
/**
* Handle the creation of the authorization code.
*
* @param $client_id client identifier related to the authorization code
* @param $user_id user id associated with the authorization code
* @param $redirect_uri an absolute URI to which the authorization server will redirect the
* user-agent to when the end-user authorization step is completed.
* @param $scope OPTIONAL scopes to be stored in space-separated string.
*
* @see http://tools.ietf.org/html/rfc6749#section-4
* @ingroup oauth2_section_4
*/
public function createAuthorizationCode($client_id, $user_id, $redirect_uri, $scope = null);
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class AuthorizationCode implements \OAuth2\ResponseType\AuthorizationCodeInterface
{
protected $storage;
protected $config;
public function __construct(\OAuth2\Storage\AuthorizationCodeInterface $storage, array $config = array())
{
}
public function getAuthorizeResponse($params, $user_id = null)
{
}
/**
* Handle the creation of the authorization code.
*
* @param $client_id
* Client identifier related to the authorization code
* @param $user_id
* User ID associated with the authorization code
* @param $redirect_uri
* An absolute URI to which the authorization server will redirect the
* user-agent to when the end-user authorization step is completed.
* @param $scope
* (optional) Scopes to be stored in space-separated string.
*
* @see http://tools.ietf.org/html/rfc6749#section-4
* @ingroup oauth2_section_4
*/
public function createAuthorizationCode($client_id, $user_id, $redirect_uri, $scope = null)
{
}
/**
* @return
* TRUE if the grant type requires a redirect_uri, FALSE if not
*/
public function enforceRedirect()
{
}
/**
* Generates an unique auth code.
*
* Implementing classes may want to override this function to implement
* other auth code generation schemes.
*
* @return
* An unique auth code.
*
* @ingroup oauth2_section_4
*/
protected function generateAuthorizationCode()
{
}
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class JwtAccessToken extends \OAuth2\ResponseType\AccessToken
{
protected $publicKeyStorage;
protected $encryptionUtil;
/**
* @param $config
* - store_encrypted_token_string (bool true)
* whether the entire encrypted string is stored,
* or just the token ID is stored
*/
public function __construct(\OAuth2\Storage\PublicKeyInterface $publicKeyStorage = null, \OAuth2\Storage\AccessTokenInterface $tokenStorage = null, \OAuth2\Storage\RefreshTokenInterface $refreshStorage = null, array $config = array(), \OAuth2\Encryption\EncryptionInterface $encryptionUtil = null)
{
}
/**
* Handle the creation of access token, also issue refresh token if supported / desirable.
*
* @param $client_id
* Client identifier related to the access token.
* @param $user_id
* User ID associated with the access token
* @param $scope
* (optional) Scopes to be stored in space-separated string.
* @param bool $includeRefreshToken
* If true, a new refresh_token will be added to the response
*
* @see http://tools.ietf.org/html/rfc6749#section-5
* @ingroup oauth2_section_5
*/
public function createAccessToken($client_id, $user_id, $scope = null, $includeRefreshToken = true)
{
}
protected function encodeToken(array $token, $client_id = null)
{
}
}
}
namespace OAuth2 {
/**
* OAuth2\Request
* This class is taken from the Symfony2 Framework and is part of the Symfony package.
* See Symfony\Component\HttpFoundation\Request (https://github.com/symfony/symfony)
*/
class Request implements \OAuth2\RequestInterface
{
public $attributes;
public $request;
public $query;
public $server;
public $files;
public $cookies;
public $headers;
public $content;
/**
* Constructor.
*
* @param array $query The GET parameters
* @param array $request The POST parameters
* @param array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
* @param array $cookies The COOKIE parameters
* @param array $files The FILES parameters
* @param array $server The SERVER parameters
* @param string $content The raw body data
*
* @api
*/
public function __construct(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), $content = null, array $headers = null)
{
}
/**
* Sets the parameters for this request.
*
* This method also re-initializes all properties.
*
* @param array $query The GET parameters
* @param array $request The POST parameters
* @param array $attributes The request attributes (parameters parsed from the PATH_INFO, ...)
* @param array $cookies The COOKIE parameters
* @param array $files The FILES parameters
* @param array $server The SERVER parameters
* @param string $content The raw body data
*
* @api
*/
public function initialize(array $query = array(), array $request = array(), array $attributes = array(), array $cookies = array(), array $files = array(), array $server = array(), $content = null, array $headers = null)
{
}
public function query($name, $default = null)
{
}
public function request($name, $default = null)
{
}
public function server($name, $default = null)
{
}
public function headers($name, $default = null)
{
}
public function getAllQueryParameters()
{
}
/**
* Returns the request body content.
*
* @param Boolean $asResource If true, a resource will be returned
*
* @return string|resource The request body content or a resource to read the body stream.
*/
public function getContent($asResource = false)
{
}
/**
* Creates a new request with values from PHP's super globals.
*
* @return Request A new request
*
* @api
*/
public static function createFromGlobals()
{
}
}
}
namespace OAuth2\Encryption {
interface EncryptionInterface
{
public function encode($payload, $key, $algorithm = null);
public function decode($payload, $key, $algorithm = null);
public function urlSafeB64Encode($data);
public function urlSafeB64Decode($b64);
}
/**
* Bridge file to use the firebase/php-jwt package for JWT encoding and decoding.
* @author Francis Chuang <francis.chuang@gmail.com>
*/
class FirebaseJwt implements \OAuth2\Encryption\EncryptionInterface
{
public function __construct()
{
}
public function encode($payload, $key, $alg = 'HS256', $keyId = null)
{
}
public function decode($jwt, $key = null, $allowedAlgorithms = null)
{
}
public function urlSafeB64Encode($data)
{
}
public function urlSafeB64Decode($b64)
{
}
}
/**
* @link https://github.com/F21/jwt
* @author F21
*/
class Jwt implements \OAuth2\Encryption\EncryptionInterface
{
public function encode($payload, $key, $algo = 'HS256')
{
}
public function decode($jwt, $key = null, $allowedAlgorithms = true)
{
}
public function urlSafeB64Encode($data)
{
}
public function urlSafeB64Decode($b64)
{
}
/**
* Override to create a custom header
*/
protected function generateJwtHeader($payload, $algorithm)
{
}
protected function hash_equals($a, $b)
{
}
}
}
namespace OAuth2 {
/**
* Autoloads OAuth2 classes
*
* @author Brent Shaffer <bshafs at gmail dot com>
* @license MIT License
*/
class Autoloader
{
public function __construct($dir = null)
{
}
/**
* Registers OAuth2\Autoloader as an SPL autoloader.
*/
public static function register($dir = null)
{
}
/**
* Handles autoloading of classes.
*
* @param string $class A class name.
*
* @return boolean Returns true if the class has been loaded
*/
public function autoload($class)
{
}
}
}
namespace OAuth2\OpenID\Controller {
interface AuthorizeControllerInterface
{
const RESPONSE_TYPE_ID_TOKEN = 'id_token';
const RESPONSE_TYPE_ID_TOKEN_TOKEN = 'id_token token';
const RESPONSE_TYPE_CODE_ID_TOKEN = 'code id_token';
}
/**
* @see OAuth2\Controller\AuthorizeControllerInterface
*/
class AuthorizeController extends \OAuth2\Controller\AuthorizeController implements \OAuth2\OpenID\Controller\AuthorizeControllerInterface
{
protected function setNotAuthorizedResponse(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response, $redirect_uri, $user_id = null)
{
}
protected function buildAuthorizeParameters($request, $response, $user_id)
{
}
public function validateAuthorizeRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
protected function getValidResponseTypes()
{
}
/**
* Returns whether the current request needs to generate an id token.
*
* ID Tokens are a part of the OpenID Connect specification, so this
* method checks whether OpenID Connect is enabled in the server settings
* and whether the openid scope was requested.
*
* @param $request_scope
* A space-separated string of scopes.
*
* @return
* TRUE if an id token is needed, FALSE otherwise.
*/
public function needsIdToken($request_scope)
{
}
public function getNonce()
{
}
}
/**
* @see OAuth2\Controller\UserInfoControllerInterface
*/
class UserInfoController extends \OAuth2\Controller\ResourceController implements \OAuth2\OpenID\Controller\UserInfoControllerInterface
{
protected $tokenType;
protected $tokenStorage;
protected $userClaimsStorage;
protected $config;
protected $scopeUtil;
public function __construct(\OAuth2\TokenType\TokenTypeInterface $tokenType, \OAuth2\Storage\AccessTokenInterface $tokenStorage, \OAuth2\OpenID\Storage\UserClaimsInterface $userClaimsStorage, $config = array(), \OAuth2\ScopeInterface $scopeUtil = null)
{
}
public function handleUserInfoRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response)
{
}
}
}
namespace OAuth2\OpenID\GrantType {
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class AuthorizationCode extends \OAuth2\GrantType\AuthorizationCode
{
public function createAccessToken(\OAuth2\ResponseType\AccessTokenInterface $accessToken, $client_id, $user_id, $scope)
{
}
}
}
namespace OAuth2\OpenID\ResponseType {
interface IdTokenTokenInterface extends \OAuth2\ResponseType\ResponseTypeInterface
{
}
interface IdTokenInterface extends \OAuth2\ResponseType\ResponseTypeInterface
{
/**
* Create the id token.
*
* If Authorization Code Flow is used, the id_token is generated when the
* authorization code is issued, and later returned from the token endpoint
* together with the access_token.
* If the Implicit Flow is used, the token and id_token are generated and
* returned together.
*
* @param string $client_id The client id.
* @param string $user_id The user id.
* @param string $nonce OPTIONAL The nonce.
* @param string $userClaims OPTIONAL Claims about the user.
* @param string $access_token OPTIONAL The access token, if known.
*
* @return string The ID Token represented as a JSON Web Token (JWT).
*
* @see http://openid.net/specs/openid-connect-core-1_0.html#IDToken
*/
public function createIdToken($client_id, $userInfo, $nonce = null, $userClaims = null, $access_token = null);
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
interface AuthorizationCodeInterface extends \OAuth2\ResponseType\AuthorizationCodeInterface
{
/**
* Handle the creation of the authorization code.
*
* @param $client_id Client identifier related to the authorization code
* @param $user_id User ID associated with the authorization code
* @param $redirect_uri An absolute URI to which the authorization server will redirect the
* user-agent to when the end-user authorization step is completed.
* @param $scope OPTIONAL Scopes to be stored in space-separated string.
* @param $id_token OPTIONAL The OpenID Connect id_token.
*
* @see http://tools.ietf.org/html/rfc6749#section-4
* @ingroup oauth2_section_4
*/
public function createAuthorizationCode($client_id, $user_id, $redirect_uri, $scope = null, $id_token = null);
}
/**
*
* @author Brent Shaffer <bshafs at gmail dot com>
*/
class AuthorizationCode extends \OAuth2\ResponseType\AuthorizationCode implements \OAuth2\OpenID\ResponseType\AuthorizationCodeInterface
{
public function __construct(\OAuth2\OpenID\Storage\AuthorizationCodeInterface $storage, array $config = array())
{
}
public function getAuthorizeResponse($params, $user_id = null)
{
}
/**
* Handle the creation of the authorization code.
*
* @param $client_id
* Client identifier related to the authorization code
* @param $user_id
* User ID associated with the authorization code
* @param $redirect_uri
* An absolute URI to which the authorization server will redirect the
* user-agent to when the end-user authorization step is completed.
* @param $scope
* (optional) Scopes to be stored in space-separated string.
* @param $id_token
* (optional) The OpenID Connect id_token.
*
* @see http://tools.ietf.org/html/rfc6749#section-4
* @ingroup oauth2_section_4
*/
public function createAuthorizationCode($client_id, $user_id, $redirect_uri, $scope = null, $id_token = null)
{
}
}
class IdToken implements \OAuth2\OpenID\ResponseType\IdTokenInterface
{
protected $userClaimsStorage;
protected $publicKeyStorage;
protected $config;
protected $encryptionUtil;
public function __construct(\OAuth2\OpenID\Storage\UserClaimsInterface $userClaimsStorage, \OAuth2\Storage\PublicKeyInterface $publicKeyStorage, array $config = array(), \OAuth2\Encryption\EncryptionInterface $encryptionUtil = null)
{
}
public function getAuthorizeResponse($params, $userInfo = null)
{
}
public function createIdToken($client_id, $userInfo, $nonce = null, $userClaims = null, $access_token = null)
{
}
protected function createAtHash($access_token, $client_id = null)
{
}
protected function encodeToken(array $token, $client_id = null)
{
}
}
interface CodeIdTokenInterface extends \OAuth2\ResponseType\ResponseTypeInterface
{
}
class CodeIdToken implements \OAuth2\OpenID\ResponseType\CodeIdTokenInterface
{
protected $authCode;
protected $idToken;
public function __construct(\OAuth2\OpenID\ResponseType\AuthorizationCodeInterface $authCode, \OAuth2\OpenID\ResponseType\IdTokenInterface $idToken)
{
}
public function getAuthorizeResponse($params, $user_id = null)
{
}
}
class IdTokenToken implements \OAuth2\OpenID\ResponseType\IdTokenTokenInterface
{
protected $accessToken;
protected $idToken;
public function __construct(\OAuth2\ResponseType\AccessTokenInterface $accessToken, \OAuth2\OpenID\ResponseType\IdTokenInterface $idToken)
{
}
public function getAuthorizeResponse($params, $user_id = null)
{
}
}
}
namespace OAuth2 {
/**
* Class to handle OAuth2 Responses in a graceful way. Use this interface
* to output the proper OAuth2 responses.
*
* @see OAuth2\ResponseInterface
*
* This class borrows heavily from the Symfony2 Framework and is part of the symfony package
* @see Symfony\Component\HttpFoundation\Request (https://github.com/symfony/symfony)
*/
class Response implements \OAuth2\ResponseInterface
{
public $version;
protected $statusCode = 200;
protected $statusText;
protected $parameters = array();
protected $httpHeaders = array();
public static $statusTexts = array(100 => 'Continue', 101 => 'Switching Protocols', 200 => 'OK', 201 => 'Created', 202 => 'Accepted', 203 => 'Non-Authoritative Information', 204 => 'No Content', 205 => 'Reset Content', 206 => 'Partial Content', 300 => 'Multiple Choices', 301 => 'Moved Permanently', 302 => 'Found', 303 => 'See Other', 304 => 'Not Modified', 305 => 'Use Proxy', 307 => 'Temporary Redirect', 400 => 'Bad Request', 401 => 'Unauthorized', 402 => 'Payment Required', 403 => 'Forbidden', 404 => 'Not Found', 405 => 'Method Not Allowed', 406 => 'Not Acceptable', 407 => 'Proxy Authentication Required', 408 => 'Request Timeout', 409 => 'Conflict', 410 => 'Gone', 411 => 'Length Required', 412 => 'Precondition Failed', 413 => 'Request Entity Too Large', 414 => 'Request-URI Too Long', 415 => 'Unsupported Media Type', 416 => 'Requested Range Not Satisfiable', 417 => 'Expectation Failed', 418 => 'I\'m a teapot', 500 => 'Internal Server Error', 501 => 'Not Implemented', 502 => 'Bad Gateway', 503 => 'Service Unavailable', 504 => 'Gateway Timeout', 505 => 'HTTP Version Not Supported');
public function __construct($parameters = array(), $statusCode = 200, $headers = array())
{
}
/**
* Converts the response object to string containing all headers and the response content.
*
* @return string The response with headers and content
*/
public function __toString()
{
}
/**
* Returns the build header line.
*
* @param string $name The header name
* @param string $value The header value
*
* @return string The built header line
*/
protected function buildHeader($name, $value)
{
}
public function getStatusCode()
{
}
public function setStatusCode($statusCode, $text = null)
{
}
public function getStatusText()
{
}
public function getParameters()
{
}
public function setParameters(array $parameters)
{
}
public function addParameters(array $parameters)
{
}
public function getParameter($name, $default = null)
{
}
public function setParameter($name, $value)
{
}
public function setHttpHeaders(array $httpHeaders)
{
}
public function setHttpHeader($name, $value)
{
}
public function addHttpHeaders(array $httpHeaders)
{
}
public function getHttpHeaders()
{
}
public function getHttpHeader($name, $default = null)
{
}
public function getResponseBody($format = 'json')
{
}
public function send($format = 'json')
{
}
public function setError($statusCode, $error, $errorDescription = null, $errorUri = null)
{
}
public function setRedirect($statusCode, $url, $state = null, $error = null, $errorDescription = null, $errorUri = null)
{
}
// http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html
/**
* @return Boolean
*
* @api
*/
public function isInvalid()
{
}
/**
* @return Boolean
*
* @api
*/
public function isInformational()
{
}
/**
* @return Boolean
*
* @api
*/
public function isSuccessful()
{
}
/**
* @return Boolean
*
* @api
*/
public function isRedirection()
{
}
/**
* @return Boolean
*
* @api
*/
public function isClientError()
{
}
/**
* @return Boolean
*
* @api
*/
public function isServerError()
{
}
}
}
namespace Zend\Diactoros {
/**
* Trait implementing the various methods defined in MessageInterface.
*
* @see https://github.com/php-fig/http-message/tree/master/src/MessageInterface.php
*/
trait MessageTrait
{
/**
* List of all registered headers, as key => array of values.
*
* @var array
*/
protected $headers = [];
/**
* Map of normalized header name to original name used to register header.
*
* @var array
*/
protected $headerNames = [];
/**
* @var string
*/
private $protocol = '1.1';
/**
* @var StreamInterface
*/
private $stream;
/**
* Retrieves the HTTP protocol version as a string.
*
* The string MUST contain only the HTTP version number (e.g., "1.1", "1.0").
*
* @return string HTTP protocol version.
*/
public function getProtocolVersion()
{
}
/**
* Return an instance with the specified HTTP protocol version.
*
* The version string MUST contain only the HTTP version number (e.g.,
* "1.1", "1.0").
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new protocol version.
*
* @param string $version HTTP protocol version
* @return static
*/
public function withProtocolVersion($version)
{
}
/**
* Retrieves all message headers.
*
* The keys represent the header name as it will be sent over the wire, and
* each value is an array of strings associated with the header.
*
* // Represent the headers as a string
* foreach ($message->getHeaders() as $name => $values) {
* echo $name . ": " . implode(", ", $values);
* }
*
* // Emit headers iteratively:
* foreach ($message->getHeaders() as $name => $values) {
* foreach ($values as $value) {
* header(sprintf('%s: %s', $name, $value), false);
* }
* }
*
* @return array Returns an associative array of the message's headers. Each
* key MUST be a header name, and each value MUST be an array of strings.
*/
public function getHeaders()
{
}
/**
* Checks if a header exists by the given case-insensitive name.
*
* @param string $header Case-insensitive header name.
* @return bool Returns true if any header names match the given header
* name using a case-insensitive string comparison. Returns false if
* no matching header name is found in the message.
*/
public function hasHeader($header)
{
}
/**
* Retrieves a message header value by the given case-insensitive name.
*
* This method returns an array of all the header values of the given
* case-insensitive header name.
*
* If the header does not appear in the message, this method MUST return an
* empty array.
*
* @param string $header Case-insensitive header field name.
* @return string[] An array of string values as provided for the given
* header. If the header does not appear in the message, this method MUST
* return an empty array.
*/
public function getHeader($header)
{
}
/**
* Retrieves a comma-separated string of the values for a single header.
*
* This method returns all of the header values of the given
* case-insensitive header name as a string concatenated together using
* a comma.
*
* NOTE: Not all header values may be appropriately represented using
* comma concatenation. For such headers, use getHeader() instead
* and supply your own delimiter when concatenating.
*
* If the header does not appear in the message, this method MUST return
* an empty string.
*
* @param string $name Case-insensitive header field name.
* @return string A string of values as provided for the given header
* concatenated together using a comma. If the header does not appear in
* the message, this method MUST return an empty string.
*/
public function getHeaderLine($name)
{
}
/**
* Return an instance with the provided header, replacing any existing
* values of any headers with the same case-insensitive name.
*
* While header names are case-insensitive, the casing of the header will
* be preserved by this function, and returned from getHeaders().
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new and/or updated header and value.
*
* @param string $header Case-insensitive header field name.
* @param string|string[] $value Header value(s).
* @return static
* @throws \InvalidArgumentException for invalid header names or values.
*/
public function withHeader($header, $value)
{
}
/**
* Return an instance with the specified header appended with the
* given value.
*
* Existing values for the specified header will be maintained. The new
* value(s) will be appended to the existing list. If the header did not
* exist previously, it will be added.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new header and/or value.
*
* @param string $header Case-insensitive header field name to add.
* @param string|string[] $value Header value(s).
* @return static
* @throws \InvalidArgumentException for invalid header names or values.
*/
public function withAddedHeader($header, $value)
{
}
/**
* Return an instance without the specified header.
*
* Header resolution MUST be done without case-sensitivity.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that removes
* the named header.
*
* @param string $header Case-insensitive header field name to remove.
* @return static
*/
public function withoutHeader($header)
{
}
/**
* Gets the body of the message.
*
* @return StreamInterface Returns the body as a stream.
*/
public function getBody()
{
}
/**
* Return an instance with the specified message body.
*
* The body MUST be a StreamInterface object.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return a new instance that has the
* new body stream.
*
* @param StreamInterface $body Body.
* @return static
* @throws \InvalidArgumentException When the body is not valid.
*/
public function withBody(\Psr\Http\Message\StreamInterface $body)
{
}
private function getStream($stream, $modeIfNotInstance)
{
}
/**
* Test that an array contains only strings
*
* @param array $array
* @return bool
*/
private function arrayContainsOnlyStrings(array $array)
{
}
/**
* Filter a set of headers to ensure they are in the correct internal format.
*
* Used by message constructors to allow setting all initial headers at once.
*
* @param array $originalHeaders Headers to filter.
* @return array Filtered headers and names.
*/
private function filterHeaders(array $originalHeaders)
{
}
/**
* Test if a value is a string
*
* Used with array_reduce.
*
* @param bool $carry
* @param mixed $item
* @return bool
*/
private static function filterStringValue($carry, $item)
{
}
/**
* Assert that the provided header values are valid.
*
* @see http://tools.ietf.org/html/rfc7230#section-3.2
* @param string[] $values
* @throws InvalidArgumentException
*/
private static function assertValidHeaderValue(array $values)
{
}
/**
* Validate the HTTP protocol version
*
* @param string $version
* @throws InvalidArgumentException on invalid HTTP protocol version
*/
private function validateProtocolVersion($version)
{
}
}
/**
* Provide security tools around HTTP headers to prevent common injection vectors.
*
* Code is largely lifted from the Zend\Http\Header\HeaderValue implementation in
* Zend Framework, released with the copyright and license below.
*
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
final class HeaderSecurity
{
/**
* Filter a header value
*
* Ensures CRLF header injection vectors are filtered.
*
* Per RFC 7230, only VISIBLE ASCII characters, spaces, and horizontal
* tabs are allowed in values; header continuations MUST consist of
* a single CRLF sequence followed by a space or horizontal tab.
*
* This method filters any values not allowed from the string, and is
* lossy.
*
* @see http://en.wikipedia.org/wiki/HTTP_response_splitting
* @param string $value
* @return string
*/
public static function filter($value)
{
}
/**
* Validate a header value.
*
* Per RFC 7230, only VISIBLE ASCII characters, spaces, and horizontal
* tabs are allowed in values; header continuations MUST consist of
* a single CRLF sequence followed by a space or horizontal tab.
*
* @see http://en.wikipedia.org/wiki/HTTP_response_splitting
* @param string $value
* @return bool
*/
public static function isValid($value)
{
}
/**
* Assert a header value is valid.
*
* @param string $value
* @throws InvalidArgumentException for invalid values
*/
public static function assertValid($value)
{
}
/**
* Assert whether or not a header name is valid.
*
* @see http://tools.ietf.org/html/rfc7230#section-3.2
* @param mixed $name
* @throws InvalidArgumentException
*/
public static function assertValidName($name)
{
}
}
/**
* Implementation of Psr\Http\UriInterface.
*
* Provides a value object representing a URI for HTTP requests.
*
* Instances of this class are considered immutable; all methods that
* might change state are implemented such that they retain the internal
* state of the current instance and return a new instance that contains the
* changed state.
*/
class Uri implements \Psr\Http\Message\UriInterface
{
/**
* Sub-delimiters used in query strings and fragments.
*
* @const string
*/
const CHAR_SUB_DELIMS = '!\\$&\'\\(\\)\\*\\+,;=';
/**
* Unreserved characters used in paths, query strings, and fragments.
*
* @const string
*/
const CHAR_UNRESERVED = 'a-zA-Z0-9_\\-\\.~\\pL';
/**
* @var int[] Array indexed by valid scheme names to their corresponding ports.
*/
protected $allowedSchemes = ['http' => 80, 'https' => 443];
/**
* @param string $uri
* @throws InvalidArgumentException on non-string $uri argument
*/
public function __construct($uri = '')
{
}
/**
* Operations to perform on clone.
*
* Since cloning usually is for purposes of mutation, we reset the
* $uriString property so it will be re-calculated.
*/
public function __clone()
{
}
/**
* {@inheritdoc}
*/
public function __toString()
{
}
/**
* {@inheritdoc}
*/
public function getScheme()
{
}
/**
* {@inheritdoc}
*/
public function getAuthority()
{
}
/**
* {@inheritdoc}
*/
public function getUserInfo()
{
}
/**
* {@inheritdoc}
*/
public function getHost()
{
}
/**
* {@inheritdoc}
*/
public function getPort()
{
}
/**
* {@inheritdoc}
*/
public function getPath()
{
}
/**
* {@inheritdoc}
*/
public function getQuery()
{
}
/**
* {@inheritdoc}
*/
public function getFragment()
{
}
/**
* {@inheritdoc}
*/
public function withScheme($scheme)
{
}
/**
* {@inheritdoc}
*/
public function withUserInfo($user, $password = null)
{
}
/**
* {@inheritdoc}
*/
public function withHost($host)
{
}
/**
* {@inheritdoc}
*/
public function withPort($port)
{
}
/**
* {@inheritdoc}
*/
public function withPath($path)
{
}
/**
* {@inheritdoc}
*/
public function withQuery($query)
{
}
/**
* {@inheritdoc}
*/
public function withFragment($fragment)
{
}
}
/**
* Trait with common request behaviors.
*
* Server and client-side requests differ slightly in how the Host header is
* handled; on client-side, it should be calculated on-the-fly from the
* composed URI (if present), while on server-side, it will be calculated from
* the environment. As such, this trait exists to provide the common code
* between both client-side and server-side requests, and each can then
* use the headers functionality required by their implementations.
*
* @property array $headers
* @property array $headerNames
* @property StreamInterface $stream
* @method bool hasHeader(string $header)
*/
trait RequestTrait
{
/**
* @var string
*/
private $method = '';
/**
* The request-target, if it has been provided or calculated.
*
* @var null|string
*/
private $requestTarget;
/**
* @var UriInterface
*/
private $uri;
/**
* Initialize request state.
*
* Used by constructors.
*
* @param null|string|UriInterface $uri URI for the request, if any.
* @param null|string $method HTTP method for the request, if any.
* @param string|resource|StreamInterface $body Message body, if any.
* @param array $headers Headers for the message, if any.
* @throws InvalidArgumentException for any invalid value.
*/
private function initialize($uri = null, $method = null, $body = 'php://memory', array $headers = [])
{
}
/**
* Create and return a URI instance.
*
* If `$uri` is a already a `UriInterface` instance, returns it.
*
* If `$uri` is a string, passes it to the `Uri` constructor to return an
* instance.
*
* If `$uri is null, creates and returns an empty `Uri` instance.
*
* Otherwise, it raises an exception.
*
* @param null|string|UriInterface $uri
* @return UriInterface
* @throws InvalidArgumentException
*/
private function createUri($uri)
{
}
/**
* Retrieves the message's request target.
*
* Retrieves the message's request-target either as it will appear (for
* clients), as it appeared at request (for servers), or as it was
* specified for the instance (see withRequestTarget()).
*
* In most cases, this will be the origin-form of the composed URI,
* unless a value was provided to the concrete implementation (see
* withRequestTarget() below).
*
* If no URI is available, and no request-target has been specifically
* provided, this method MUST return the string "/".
*
* @return string
*/
public function getRequestTarget()
{
}
/**
* Create a new instance with a specific request-target.
*
* If the request needs a non-origin-form request-target — e.g., for
* specifying an absolute-form, authority-form, or asterisk-form —
* this method may be used to create an instance with the specified
* request-target, verbatim.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return a new instance that has the
* changed request target.
*
* @link http://tools.ietf.org/html/rfc7230#section-2.7 (for the various
* request-target forms allowed in request messages)
* @param mixed $requestTarget
* @return static
* @throws InvalidArgumentException if the request target is invalid.
*/
public function withRequestTarget($requestTarget)
{
}
/**
* Retrieves the HTTP method of the request.
*
* @return string Returns the request method.
*/
public function getMethod()
{
}
/**
* Return an instance with the provided HTTP method.
*
* While HTTP method names are typically all uppercase characters, HTTP
* method names are case-sensitive and thus implementations SHOULD NOT
* modify the given string.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* changed request method.
*
* @param string $method Case-insensitive method.
* @return static
* @throws InvalidArgumentException for invalid HTTP methods.
*/
public function withMethod($method)
{
}
/**
* Retrieves the URI instance.
*
* This method MUST return a UriInterface instance.
*
* @link http://tools.ietf.org/html/rfc3986#section-4.3
* @return UriInterface Returns a UriInterface instance
* representing the URI of the request, if any.
*/
public function getUri()
{
}
/**
* Returns an instance with the provided URI.
*
* This method will update the Host header of the returned request by
* default if the URI contains a host component. If the URI does not
* contain a host component, any pre-existing Host header will be carried
* over to the returned request.
*
* You can opt-in to preserving the original state of the Host header by
* setting `$preserveHost` to `true`. When `$preserveHost` is set to
* `true`, the returned request will not update the Host header of the
* returned message -- even if the message contains no Host header. This
* means that a call to `getHeader('Host')` on the original request MUST
* equal the return value of a call to `getHeader('Host')` on the returned
* request.
*
* This method MUST be implemented in such a way as to retain the
* immutability of the message, and MUST return an instance that has the
* new UriInterface instance.
*
* @link http://tools.ietf.org/html/rfc3986#section-4.3
* @param UriInterface $uri New request URI to use.
* @param bool $preserveHost Preserve the original state of the Host header.
* @return static
*/
public function withUri(\Psr\Http\Message\UriInterface $uri, $preserveHost = false)
{
}
/**
* Validate the HTTP method
*
* @param null|string $method
* @throws InvalidArgumentException on invalid HTTP method.
*/
private function validateMethod($method)
{
}
/**
* Retrieve the host from the URI instance
*
* @return string
*/
private function getHostFromUri()
{
}
/**
* Ensure header names and values are valid.
*
* @param array $headers
* @throws InvalidArgumentException
*/
private function assertHeaders(array $headers)
{
}
}
/**
* HTTP Request encapsulation
*
* Requests are considered immutable; all methods that might change state are
* implemented such that they retain the internal state of the current
* message and return a new instance that contains the changed state.
*/
class Request implements \Psr\Http\Message\RequestInterface
{
use \Zend\Diactoros\MessageTrait, \Zend\Diactoros\RequestTrait;
/**
* @param null|string|UriInterface $uri URI for the request, if any.
* @param null|string $method HTTP method for the request, if any.
* @param string|resource|StreamInterface $body Message body, if any.
* @param array $headers Headers for the message, if any.
* @throws \InvalidArgumentException for any invalid value.
*/
public function __construct($uri = null, $method = null, $body = 'php://temp', array $headers = [])
{
}
/**
* {@inheritdoc}
*/
public function getHeaders()
{
}
/**
* {@inheritdoc}
*/
public function getHeader($header)
{
}
}
/**
* Class for marshaling a request object from the current PHP environment.
*
* Logic largely refactored from the ZF2 Zend\Http\PhpEnvironment\Request class.
*
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*/
abstract class ServerRequestFactory
{
/**
* Create a request from the supplied superglobal values.
*
* If any argument is not supplied, the corresponding superglobal value will
* be used.
*
* The ServerRequest created is then passed to the fromServer() method in
* order to marshal the request URI and headers.
*
* @see fromServer()
* @param array $server $_SERVER superglobal
* @param array $query $_GET superglobal
* @param array $body $_POST superglobal
* @param array $cookies $_COOKIE superglobal
* @param array $files $_FILES superglobal
* @return ServerRequest
* @throws InvalidArgumentException for invalid file values
*/
public static function fromGlobals(array $server = null, array $query = null, array $body = null, array $cookies = null, array $files = null)
{
}
/**
* Access a value in an array, returning a default value if not found
*
* Will also do a case-insensitive search if a case sensitive search fails.
*
* @param string $key
* @param array $values
* @param mixed $default
* @return mixed
*/
public static function get($key, array $values, $default = null)
{
}
/**
* Search for a header value.
*
* Does a case-insensitive search for a matching header.
*
* If found, it is returned as a string, using comma concatenation.
*
* If not, the $default is returned.
*
* @param string $header
* @param array $headers
* @param mixed $default
* @return string
*/
public static function getHeader($header, array $headers, $default = null)
{
}
/**
* Marshal the $_SERVER array
*
* Pre-processes and returns the $_SERVER superglobal.
*
* @param array $server
* @return array
*/
public static function normalizeServer(array $server)
{
}
/**
* Normalize uploaded files
*
* Transforms each value into an UploadedFileInterface instance, and ensures
* that nested arrays are normalized.
*
* @param array $files
* @return array
* @throws InvalidArgumentException for unrecognized values
*/
public static function normalizeFiles(array $files)
{
}
/**
* Marshal headers from $_SERVER
*
* @param array $server
* @return array
*/
public static function marshalHeaders(array $server)
{
}
/**
* Marshal the URI from the $_SERVER array and headers
*
* @param array $server
* @param array $headers
* @return Uri
*/
public static function marshalUriFromServer(array $server, array $headers)
{
}
/**
* Marshal the host and port from HTTP headers and/or the PHP environment
*
* @param stdClass $accumulator
* @param array $server
* @param array $headers
*/
public static function marshalHostAndPortFromHeaders(\stdClass $accumulator, array $server, array $headers)
{
}
/**
* Detect the base URI for the request
*
* Looks at a variety of criteria in order to attempt to autodetect a base
* URI, including rewrite URIs, proxy URIs, etc.
*
* From ZF2's Zend\Http\PhpEnvironment\Request class
* @copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
* @license http://framework.zend.com/license/new-bsd New BSD License
*
* @param array $server
* @return string
*/
public static function marshalRequestUri(array $server)
{
}
/**
* Strip the query string from a path
*
* @param mixed $path
* @return string
*/
public static function stripQueryString($path)
{
}
}
/**
* "Serve" incoming HTTP requests
*
* Given a callback, takes an incoming request, dispatches it to the
* callback, and then sends a response.
*/
class Server
{
/**
* Constructor
*
* Given a callback, a request, and a response, we can create a server.
*
* @param callable $callback
* @param ServerRequestInterface $request
* @param ResponseInterface $response
*/
public function __construct(callable $callback, \Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response)
{
}
/**
* Allow retrieving the request, response and callback as properties
*
* @param string $name
* @return mixed
* @throws OutOfBoundsException for invalid properties
*/
public function __get($name)
{
}
/**
* Set alternate response emitter to use.
*
* @param Response\EmitterInterface $emitter
*/
public function setEmitter(\Zend\Diactoros\Response\EmitterInterface $emitter)
{
}
/**
* Create a Server instance
*
* Creates a server instance from the callback and the following
* PHP environmental values:
*
* - server; typically this will be the $_SERVER superglobal
* - query; typically this will be the $_GET superglobal
* - body; typically this will be the $_POST superglobal
* - cookies; typically this will be the $_COOKIE superglobal
* - files; typically this will be the $_FILES superglobal
*
* @param callable $callback
* @param array $server
* @param array $query
* @param array $body
* @param array $cookies
* @param array $files
* @return static
*/
public static function createServer(callable $callback, array $server, array $query, array $body, array $cookies, array $files)
{
}
/**
* Create a Server instance from an existing request object
*
* Provided a callback, an existing request object, and optionally an
* existing response object, create and return the Server instance.
*
* If no Response object is provided, one will be created.
*
* @param callable $callback
* @param ServerRequestInterface $request
* @param null|ResponseInterface $response
* @return static
*/
public static function createServerFromRequest(callable $callback, \Psr\Http\Message\ServerRequestInterface $request, \Psr\Http\Message\ResponseInterface $response = null)
{
}
/**
* "Listen" to an incoming request
*
* If provided a $finalHandler, that callable will be used for
* incomplete requests.
*
* Output buffering is enabled prior to invoking the attached
* callback; any output buffered will be sent prior to any
* response body content.
*
* @param null|callable $finalHandler
*/
public function listen(callable $finalHandler = null)
{
}
}
/**
* Implementation of PSR HTTP streams
*/
class CallbackStream implements \Psr\Http\Message\StreamInterface
{
/**
* @var callable|null
*/
protected $callback;
/**
* @param callable $callback
* @throws InvalidArgumentException
*/
public function __construct(callable $callback)
{
}
/**
* {@inheritdoc}
*/
public function __toString()
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function detach()
{
}
/**
* Attach a new callback to the instance.
*
* @param callable $callback
* @throws InvalidArgumentException for callable callback
*/
public function attach(callable $callback)
{
}
/**
* {@inheritdoc}
*/
public function getSize()
{
}
/**
* {@inheritdoc}
*/
public function tell()
{
}
/**
* {@inheritdoc}
*/
public function eof()
{
}
/**
* {@inheritdoc}
*/
public function isSeekable()
{
}
/**
* {@inheritdoc}
*/
public function seek($offset, $whence = SEEK_SET)
{
}
/**
* {@inheritdoc}
*/
public function rewind()
{
}
/**
* {@inheritdoc}
*/
public function isWritable()
{
}
/**
* {@inheritdoc}
*/
public function write($string)
{
}
/**
* {@inheritdoc}
*/
public function isReadable()
{
}
/**
* {@inheritdoc}
*/
public function read($length)
{
}
/**
* {@inheritdoc}
*/
public function getContents()
{
}
/**
* {@inheritdoc}
*/
public function getMetadata($key = null)
{
}
}
/**
* Provides base functionality for request and response de/serialization
* strategies, including functionality for retrieving a line at a time from
* the message, splitting headers from the body, and serializing headers.
*/
abstract class AbstractSerializer
{
const CR = "\r";
const EOL = "\r\n";
const LF = "\n";
/**
* Retrieve a single line from the stream.
*
* Retrieves a line from the stream; a line is defined as a sequence of
* characters ending in a CRLF sequence.
*
* @param StreamInterface $stream
* @return string
* @throws UnexpectedValueException if the sequence contains a CR or LF in
* isolation, or ends in a CR.
*/
protected static function getLine(\Psr\Http\Message\StreamInterface $stream)
{
}
/**
* Split the stream into headers and body content.
*
* Returns an array containing two elements
*
* - The first is an array of headers
* - The second is a StreamInterface containing the body content
*
* @param StreamInterface $stream
* @return array
* @throws UnexpectedValueException For invalid headers.
*/
protected static function splitStream(\Psr\Http\Message\StreamInterface $stream)
{
}
/**
* Serialize headers to string values.
*
* @param array $headers
* @return string
*/
protected static function serializeHeaders(array $headers)
{
}
/**
* Filter a header name to wordcase
*
* @param string $header
* @return string
*/
protected static function filterHeader($header)
{
}
}
/**
* Server-side HTTP request
*
* Extends the Request definition to add methods for accessing incoming data,
* specifically server parameters, cookies, matched path parameters, query
* string arguments, body parameters, and upload file information.
*
* "Attributes" are discovered via decomposing the request (and usually
* specifically the URI path), and typically will be injected by the application.
*
* Requests are considered immutable; all methods that might change state are
* implemented such that they retain the internal state of the current
* message and return a new instance that contains the changed state.
*/
class ServerRequest implements \Psr\Http\Message\ServerRequestInterface
{
use \Zend\Diactoros\MessageTrait, \Zend\Diactoros\RequestTrait;
/**
* @param array $serverParams Server parameters, typically from $_SERVER
* @param array $uploadedFiles Upload file information, a tree of UploadedFiles
* @param null|string|UriInterface $uri URI for the request, if any.
* @param null|string $method HTTP method for the request, if any.
* @param string|resource|StreamInterface $body Message body, if any.
* @param array $headers Headers for the message, if any.
* @param array $cookies Cookies for the message, if any.
* @param array $queryParams Query params for the message, if any.
* @param null|array|object $parsedBody The deserialized body parameters, if any.
* @param string $protocol HTTP protocol version.
* @throws InvalidArgumentException for any invalid value.
*/
public function __construct(array $serverParams = [], array $uploadedFiles = [], $uri = null, $method = null, $body = 'php://input', array $headers = [], array $cookies = [], array $queryParams = [], $parsedBody = null, $protocol = '1.1')
{
}
/**
* {@inheritdoc}
*/
public function getServerParams()
{
}
/**
* {@inheritdoc}
*/
public function getUploadedFiles()
{
}
/**
* {@inheritdoc}
*/
public function withUploadedFiles(array $uploadedFiles)
{
}
/**
* {@inheritdoc}
*/
public function getCookieParams()
{
}
/**
* {@inheritdoc}
*/
public function withCookieParams(array $cookies)
{
}
/**
* {@inheritdoc}
*/
public function getQueryParams()
{
}
/**
* {@inheritdoc}
*/
public function withQueryParams(array $query)
{
}
/**
* {@inheritdoc}
*/
public function getParsedBody()
{
}
/**
* {@inheritdoc}
*/
public function withParsedBody($data)
{
}
/**
* {@inheritdoc}
*/
public function getAttributes()
{
}
/**
* {@inheritdoc}
*/
public function getAttribute($attribute, $default = null)
{
}
/**
* {@inheritdoc}
*/
public function withAttribute($attribute, $value)
{
}
/**
* {@inheritdoc}
*/
public function withoutAttribute($attribute)
{
}
/**
* Proxy to receive the request method.
*
* This overrides the parent functionality to ensure the method is never
* empty; if no method is present, it returns 'GET'.
*
* @return string
*/
public function getMethod()
{
}
/**
* Set the request method.
*
* Unlike the regular Request implementation, the server-side
* normalizes the method to uppercase to ensure consistency
* and make checking the method simpler.
*
* This methods returns a new instance.
*
* @param string $method
* @return self
*/
public function withMethod($method)
{
}
}
class UploadedFile implements \Psr\Http\Message\UploadedFileInterface
{
/**
* @param string|resource $streamOrFile
* @param int $size
* @param int $errorStatus
* @param string|null $clientFilename
* @param string|null $clientMediaType
* @throws InvalidArgumentException
*/
public function __construct($streamOrFile, $size, $errorStatus, $clientFilename = null, $clientMediaType = null)
{
}
/**
* {@inheritdoc}
* @throws \RuntimeException if the upload was not successful.
*/
public function getStream()
{
}
/**
* {@inheritdoc}
*
* @see http://php.net/is_uploaded_file
* @see http://php.net/move_uploaded_file
* @param string $targetPath Path to which to move the uploaded file.
* @throws \RuntimeException if the upload was not successful.
* @throws \InvalidArgumentException if the $path specified is invalid.
* @throws \RuntimeException on any error during the move operation, or on
* the second or subsequent call to the method.
*/
public function moveTo($targetPath)
{
}
/**
* {@inheritdoc}
*
* @return int|null The file size in bytes or null if unknown.
*/
public function getSize()
{
}
/**
* {@inheritdoc}
*
* @see http://php.net/manual/en/features.file-upload.errors.php
* @return int One of PHP's UPLOAD_ERR_XXX constants.
*/
public function getError()
{
}
/**
* {@inheritdoc}
*
* @return string|null The filename sent by the client or null if none
* was provided.
*/
public function getClientFilename()
{
}
/**
* {@inheritdoc}
*/
public function getClientMediaType()
{
}
}
}
namespace Zend\Diactoros\Response {
final class Serializer extends \Zend\Diactoros\AbstractSerializer
{
/**
* Deserialize a response string to a response instance.
*
* @param string $message
* @return Response
* @throws UnexpectedValueException when errors occur parsing the message.
*/
public static function fromString($message)
{
}
/**
* Parse a response from a stream.
*
* @param StreamInterface $stream
* @return ResponseInterface
* @throws InvalidArgumentException when the stream is not readable.
* @throws UnexpectedValueException when errors occur parsing the message.
*/
public static function fromStream(\Psr\Http\Message\StreamInterface $stream)
{
}
/**
* Create a string representation of a response.
*
* @param ResponseInterface $response
* @return string
*/
public static function toString(\Psr\Http\Message\ResponseInterface $response)
{
}
}
interface EmitterInterface
{
/**
* Emit a response.
*
* Emits a response, including status line, headers, and the message body,
* according to the environment.
*
* Implementations of this method may be written in such a way as to have
* side effects, such as usage of header() or pushing output to the
* output buffer.
*
* Implementations MAY raise exceptions if they are unable to emit the
* response; e.g., if headers have already been sent.
*
* @param ResponseInterface $response
*/
public function emit(\Psr\Http\Message\ResponseInterface $response);
}
trait SapiEmitterTrait
{
/**
* Inject the Content-Length header if is not already present.
*
* @param ResponseInterface $response
* @return ResponseInterface
*/
private function injectContentLength(\Psr\Http\Message\ResponseInterface $response)
{
}
/**
* Emit the status line.
*
* Emits the status line using the protocol version and status code from
* the response; if a reason phrase is available, it, too, is emitted.
*
* @param ResponseInterface $response
*/
private function emitStatusLine(\Psr\Http\Message\ResponseInterface $response)
{
}
/**
* Emit response headers.
*
* Loops through each header, emitting each; if the header value
* is an array with multiple values, ensures that each is sent
* in such a way as to create aggregate headers (instead of replace
* the previous).
*
* @param ResponseInterface $response
*/
private function emitHeaders(\Psr\Http\Message\ResponseInterface $response)
{
}
/**
* Loops through the output buffer, flushing each, before emitting
* the response.
*
* @param int|null $maxBufferLevel Flush up to this buffer level.
*/
private function flush($maxBufferLevel = null)
{
}
/**
* Filter a header name to wordcase
*
* @param string $header
* @return string
*/
private function filterHeader($header)
{
}
}
class SapiEmitter implements \Zend\Diactoros\Response\EmitterInterface
{
use \Zend\Diactoros\Response\SapiEmitterTrait;
/**
* Emits a response for a PHP SAPI environment.
*
* Emits the status line and headers via the header() function, and the
* body content via the output buffer.
*
* @param ResponseInterface $response
* @param null|int $maxBufferLevel Maximum output buffering level to unwrap.
*/
public function emit(\Psr\Http\Message\ResponseInterface $response, $maxBufferLevel = null)
{
}
}
}
namespace Zend\Diactoros {
/**
* HTTP response encapsulation.
*
* Responses are considered immutable; all methods that might change state are
* implemented such that they retain the internal state of the current
* message and return a new instance that contains the changed state.
*/
class Response implements \Psr\Http\Message\ResponseInterface
{
use \Zend\Diactoros\MessageTrait;
/**
* @param string|resource|StreamInterface $body Stream identifier and/or actual stream resource
* @param int $status Status code for the response, if any.
* @param array $headers Headers for the response, if any.
* @throws InvalidArgumentException on any invalid element.
*/
public function __construct($body = 'php://memory', $status = 200, array $headers = [])
{
}
/**
* {@inheritdoc}
*/
public function getStatusCode()
{
}
/**
* {@inheritdoc}
*/
public function getReasonPhrase()
{
}
/**
* {@inheritdoc}
*/
public function withStatus($code, $reasonPhrase = '')
{
}
}
}
namespace Zend\Diactoros\Response {
trait InjectContentTypeTrait
{
/**
* Inject the provided Content-Type, if none is already present.
*
* @param string $contentType
* @param array $headers
* @return array Headers with injected Content-Type
*/
private function injectContentType($contentType, array $headers)
{
}
}
/**
* Plain text response.
*
* Allows creating a response by passing a string to the constructor;
* by default, sets a status code of 200 and sets the Content-Type header to
* text/plain.
*/
class TextResponse extends \Zend\Diactoros\Response
{
use \Zend\Diactoros\Response\InjectContentTypeTrait;
/**
* Create a plain text response.
*
* Produces a text response with a Content-Type of text/plain and a default
* status of 200.
*
* @param string|StreamInterface $text String or stream for the message body.
* @param int $status Integer status code for the response; 200 by default.
* @param array $headers Array of headers to use at initialization.
* @throws InvalidArgumentException if $text is neither a string or stream.
*/
public function __construct($text, $status = 200, array $headers = [])
{
}
}
/**
* JSON response.
*
* Allows creating a response by passing data to the constructor; by default,
* serializes the data to JSON, sets a status code of 200 and sets the
* Content-Type header to application/json.
*/
class JsonResponse extends \Zend\Diactoros\Response
{
use \Zend\Diactoros\Response\InjectContentTypeTrait;
/**
* Default flags for json_encode; value of:
*
* <code>
* JSON_HEX_TAG | JSON_HEX_APOS | JSON_HEX_AMP | JSON_HEX_QUOT | JSON_UNESCAPED_SLASHES
* </code>
*
* @const int
*/
const DEFAULT_JSON_FLAGS = 79;
/**
* Create a JSON response with the given data.
*
* Default JSON encoding is performed with the following options, which
* produces RFC4627-compliant JSON, capable of embedding into HTML.
*
* - JSON_HEX_TAG
* - JSON_HEX_APOS
* - JSON_HEX_AMP
* - JSON_HEX_QUOT
* - JSON_UNESCAPED_SLASHES
*
* @param mixed $data Data to convert to JSON.
* @param int $status Integer status code for the response; 200 by default.
* @param array $headers Array of headers to use at initialization.
* @param int $encodingOptions JSON encoding options to use.
* @throws InvalidArgumentException if unable to encode the $data to JSON.
*/
public function __construct($data, $status = 200, array $headers = [], $encodingOptions = self::DEFAULT_JSON_FLAGS)
{
}
}
class SapiStreamEmitter implements \Zend\Diactoros\Response\EmitterInterface
{
use \Zend\Diactoros\Response\SapiEmitterTrait;
/**
* Emits a response for a PHP SAPI environment.
*
* Emits the status line and headers via the header() function, and the
* body content via the output buffer.
*
* @param ResponseInterface $response
* @param int $maxBufferLength Maximum output buffering size for each iteration
*/
public function emit(\Psr\Http\Message\ResponseInterface $response, $maxBufferLength = 8192)
{
}
}
/**
* Produce a redirect response.
*/
class RedirectResponse extends \Zend\Diactoros\Response
{
/**
* Create a redirect response.
*
* Produces a redirect response with a Location header and the given status
* (302 by default).
*
* Note: this method overwrites the `location` $headers value.
*
* @param string|UriInterface $uri URI for the Location header.
* @param int $status Integer status code for the redirect; 302 by default.
* @param array $headers Array of headers to use at initialization.
*/
public function __construct($uri, $status = 302, array $headers = [])
{
}
}
/**
* HTML response.
*
* Allows creating a response by passing an HTML string to the constructor;
* by default, sets a status code of 200 and sets the Content-Type header to
* text/html.
*/
class HtmlResponse extends \Zend\Diactoros\Response
{
use \Zend\Diactoros\Response\InjectContentTypeTrait;
/**
* Create an HTML response.
*
* Produces an HTML response with a Content-Type of text/html and a default
* status of 200.
*
* @param string|StreamInterface $html HTML or stream for the message body.
* @param int $status Integer status code for the response; 200 by default.
* @param array $headers Array of headers to use at initialization.
* @throws InvalidArgumentException if $html is neither a string or stream.
*/
public function __construct($html, $status = 200, array $headers = [])
{
}
}
/**
* A class representing empty HTTP responses.
*/
class EmptyResponse extends \Zend\Diactoros\Response
{
/**
* Create an empty response with the given status code.
*
* @param int $status Status code for the response, if any.
* @param array $headers Headers for the response, if any.
*/
public function __construct($status = 204, array $headers = [])
{
}
/**
* Create an empty response with the given headers.
*
* @param array $headers Headers for the response.
* @return EmptyResponse
*/
public static function withHeaders(array $headers)
{
}
}
}
namespace Zend\Diactoros {
/**
* Implementation of PSR HTTP streams
*/
class Stream implements \Psr\Http\Message\StreamInterface
{
/**
* @var resource
*/
protected $resource;
/**
* @var string|resource
*/
protected $stream;
/**
* @param string|resource $stream
* @param string $mode Mode with which to open stream
* @throws InvalidArgumentException
*/
public function __construct($stream, $mode = 'r')
{
}
/**
* {@inheritdoc}
*/
public function __toString()
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function detach()
{
}
/**
* Attach a new stream/resource to the instance.
*
* @param string|resource $resource
* @param string $mode
* @throws InvalidArgumentException for stream identifier that cannot be
* cast to a resource
* @throws InvalidArgumentException for non-resource stream
*/
public function attach($resource, $mode = 'r')
{
}
/**
* {@inheritdoc}
*/
public function getSize()
{
}
/**
* {@inheritdoc}
*/
public function tell()
{
}
/**
* {@inheritdoc}
*/
public function eof()
{
}
/**
* {@inheritdoc}
*/
public function isSeekable()
{
}
/**
* {@inheritdoc}
*/
public function seek($offset, $whence = SEEK_SET)
{
}
/**
* {@inheritdoc}
*/
public function rewind()
{
}
/**
* {@inheritdoc}
*/
public function isWritable()
{
}
/**
* {@inheritdoc}
*/
public function write($string)
{
}
/**
* {@inheritdoc}
*/
public function isReadable()
{
}
/**
* {@inheritdoc}
*/
public function read($length)
{
}
/**
* {@inheritdoc}
*/
public function getContents()
{
}
/**
* {@inheritdoc}
*/
public function getMetadata($key = null)
{
}
}
/**
* Class RelativeStream
*
* Wrapper for default Stream class, representing subpart (starting from given offset) of initial stream.
* It can be used to avoid copying full stream, conserving memory.
* @example see Zend\Diactoros\AbstractSerializer::splitStream()
*/
final class RelativeStream implements \Psr\Http\Message\StreamInterface
{
/**
* Class constructor
*
* @param StreamInterface $decoratedStream
* @param int $offset
*/
public function __construct(\Psr\Http\Message\StreamInterface $decoratedStream, $offset)
{
}
/**
* {@inheritdoc}
*/
public function __toString()
{
}
/**
* {@inheritdoc}
*/
public function close()
{
}
/**
* {@inheritdoc}
*/
public function detach()
{
}
/**
* {@inheritdoc}
*/
public function getSize()
{
}
/**
* {@inheritdoc}
*/
public function tell()
{
}
/**
* {@inheritdoc}
*/
public function eof()
{
}
/**
* {@inheritdoc}
*/
public function isSeekable()
{
}
/**
* {@inheritdoc}
*/
public function seek($offset, $whence = SEEK_SET)
{
}
/**
* {@inheritdoc}
*/
public function rewind()
{
}
/**
* {@inheritdoc}
*/
public function isWritable()
{
}
/**
* {@inheritdoc}
*/
public function write($string)
{
}
/**
* {@inheritdoc}
*/
public function isReadable()
{
}
/**
* {@inheritdoc}
*/
public function read($length)
{
}
/**
* {@inheritdoc}
*/
public function getContents()
{
}
/**
* {@inheritdoc}
*/
public function getMetadata($key = null)
{
}
}
}
namespace Zend\Diactoros\Exception {
/**
* Marker interface for package-specific exceptions.
*/
interface ExceptionInterface
{
}
/**
* Exception indicating a deprecated method.
*/
class DeprecatedMethodException extends \BadMethodCallException implements \Zend\Diactoros\Exception\ExceptionInterface
{
}
}
namespace Zend\Diactoros {
/**
* Caching version of php://input
*/
class PhpInputStream extends \Zend\Diactoros\Stream
{
/**
* @param string|resource $stream
*/
public function __construct($stream = 'php://input')
{
}
/**
* {@inheritdoc}
*/
public function __toString()
{
}
/**
* {@inheritdoc}
*/
public function isWritable()
{
}
/**
* {@inheritdoc}
*/
public function read($length)
{
}
/**
* {@inheritdoc}
*/
public function getContents($maxLength = -1)
{
}
}
}
namespace Zend\Diactoros\Request {
/**
* Serialize (cast to string) or deserialize (cast string to Request) messages.
*
* This class provides functionality for serializing a RequestInterface instance
* to a string, as well as the reverse operation of creating a Request instance
* from a string/stream representing a message.
*/
final class Serializer extends \Zend\Diactoros\AbstractSerializer
{
/**
* Deserialize a request string to a request instance.
*
* Internally, casts the message to a stream and invokes fromStream().
*
* @param string $message
* @return Request
* @throws UnexpectedValueException when errors occur parsing the message.
*/
public static function fromString($message)
{
}
/**
* Deserialize a request stream to a request instance.
*
* @param StreamInterface $stream
* @return Request
* @throws UnexpectedValueException when errors occur parsing the message.
*/
public static function fromStream(\Psr\Http\Message\StreamInterface $stream)
{
}
/**
* Serialize a request message to a string.
*
* @param RequestInterface $request
* @return string
*/
public static function toString(\Psr\Http\Message\RequestInterface $request)
{
}
}
}
namespace {
class phlyLabs_Net_IDNA
{
public function __construct($options = \false)
{
}
public function set_parameter($option, $value = \false)
{
}
public function decode($input, $one_time_encoding = \false)
{
}
public function encode($decoded, $one_time_encoding = \false)
{
}
public function get_last_error()
{
}
}
}
namespace PhpOption {
/**
* Base Option Class.
*
* @author Johannes M. Schmitt <schmittjoh@gmail.com>
*/
abstract class Option implements \IteratorAggregate
{
/**
* Creates an option given a return value.
*
* This is intended for consuming existing APIs and allows you to easily
* convert them to an option. By default, we treat ``null`` as the None case,
* and everything else as Some.
*
* @param mixed $value The actual return value.
* @param mixed $noneValue The value which should be considered "None"; null
* by default.
*
* @return Option
*/
public static function fromValue($value, $noneValue = null)
{
}
/**
* Creates an option from an array's value.
*
* If the key does not exist in the array, the array is not actually an array, or the
* array's value at the given key is null, None is returned.
*
* Otherwise, Some is returned wrapping the value at the given key.
*
* @param mixed $array a potential array value
* @param string $key the key to check
*
* @return Option
*/
public static function fromArraysValue($array, $key)
{
}
/**
* Creates a lazy-option with the given callback.
*
* This is also a helper constructor for lazy-consuming existing APIs where
* the return value is not yet an option. By default, we treat ``null`` as
* None case, and everything else as Some.
*
* @param callable $callback The callback to evaluate.
* @param array $arguments
* @param mixed $noneValue The value which should be considered "None"; null
* by default.
*
* @return Option
*/
public static function fromReturn($callback, array $arguments = array(), $noneValue = null)
{
}
/**
* Option factory, which creates new option based on passed value.
* If value is already an option, it simply returns
* If value is a \Closure, LazyOption with passed callback created and returned. If Option returned from callback,
* it returns directly (flatMap-like behaviour)
* On other case value passed to Option::fromValue() method
*
* @param Option|\Closure|mixed $value
* @param null $noneValue used when $value is mixed or Closure, for None-check
*
* @return Option
*/
public static function ensure($value, $noneValue = null)
{
}
/**
* Returns the value if available, or throws an exception otherwise.
*
* @throws \RuntimeException if value is not available
*
* @return mixed
*/
public abstract function get();
/**
* Returns the value if available, or the default value if not.
*
* @param mixed $default
*
* @return mixed
*/
public abstract function getOrElse($default);
/**
* Returns the value if available, or the results of the callable.
*
* This is preferable over ``getOrElse`` if the computation of the default
* value is expensive.
*
* @param callable $callable
*
* @return mixed
*/
public abstract function getOrCall($callable);
/**
* Returns the value if available, or throws the passed exception.
*
* @param \Exception $ex
*
* @return mixed
*/
public abstract function getOrThrow(\Exception $ex);
/**
* Returns true if no value is available, false otherwise.
*
* @return boolean
*/
public abstract function isEmpty();
/**
* Returns true if a value is available, false otherwise.
*
* @return boolean
*/
public abstract function isDefined();
/**
* Returns this option if non-empty, or the passed option otherwise.
*
* This can be used to try multiple alternatives, and is especially useful
* with lazy evaluating options:
*
* ```php
* $repo->findSomething()
* ->orElse(new LazyOption(array($repo, 'findSomethingElse')))
* ->orElse(new LazyOption(array($repo, 'createSomething')));
* ```
*
* @param Option $else
*
* @return Option
*/
public abstract function orElse(\PhpOption\Option $else);
/**
* This is similar to map() below except that the return value has no meaning;
* the passed callable is simply executed if the option is non-empty, and
* ignored if the option is empty.
*
* In all cases, the return value of the callable is discarded.
*
* ```php
* $comment->getMaybeFile()->ifDefined(function($file) {
* // Do something with $file here.
* });
* ```
*
* If you're looking for something like ``ifEmpty``, you can use ``getOrCall``
* and ``getOrElse`` in these cases.
*
* @deprecated Use forAll() instead.
*
* @param callable $callable
*
* @return void
*/
public abstract function ifDefined($callable);
/**
* This is similar to map() except that the return value of the callable has no meaning.
*
* The passed callable is simply executed if the option is non-empty, and ignored if the
* option is empty. This method is preferred for callables with side-effects, while map()
* is intended for callables without side-effects.
*
* @param callable $callable
*
* @return Option
*/
public abstract function forAll($callable);
/**
* Applies the callable to the value of the option if it is non-empty,
* and returns the return value of the callable wrapped in Some().
*
* If the option is empty, then the callable is not applied.
*
* ```php
* (new Some("foo"))->map('strtoupper')->get(); // "FOO"
* ```
*
* @param callable $callable
*
* @return Option
*/
public abstract function map($callable);
/**
* Applies the callable to the value of the option if it is non-empty, and
* returns the return value of the callable directly.
*
* In contrast to ``map``, the return value of the callable is expected to
* be an Option itself; it is not automatically wrapped in Some().
*
* @param callable $callable must return an Option
*
* @return Option
*/
public abstract function flatMap($callable);
/**
* If the option is empty, it is returned immediately without applying the callable.
*
* If the option is non-empty, the callable is applied, and if it returns true,
* the option itself is returned; otherwise, None is returned.
*
* @param callable $callable
*
* @return Option
*/
public abstract function filter($callable);
/**
* If the option is empty, it is returned immediately without applying the callable.
*
* If the option is non-empty, the callable is applied, and if it returns false,
* the option itself is returned; otherwise, None is returned.
*
* @param callable $callable
*
* @return Option
*/
public abstract function filterNot($callable);
/**
* If the option is empty, it is returned immediately.
*
* If the option is non-empty, and its value does not equal the passed value
* (via a shallow comparison ===), then None is returned. Otherwise, the
* Option is returned.
*
* In other words, this will filter all but the passed value.
*
* @param mixed $value
*
* @return Option
*/
public abstract function select($value);
/**
* If the option is empty, it is returned immediately.
*
* If the option is non-empty, and its value does equal the passed value (via
* a shallow comparison ===), then None is returned; otherwise, the Option is
* returned.
*
* In other words, this will let all values through except the passed value.
*
* @param mixed $value
*
* @return Option
*/
public abstract function reject($value);
/**
* Binary operator for the initial value and the option's value.
*
* If empty, the initial value is returned.
* If non-empty, the callable receives the initial value and the option's value as arguments
*
* ```php
*
* $some = new Some(5);
* $none = None::create();
* $result = $some->foldLeft(1, function($a, $b) { return $a + $b; }); // int(6)
* $result = $none->foldLeft(1, function($a, $b) { return $a + $b; }); // int(1)
*
* // This can be used instead of something like the following:
* $option = Option::fromValue($integerOrNull);
* $result = 1;
* if ( ! $option->isEmpty()) {
* $result += $option->get();
* }
* ```
*
* @param mixed $initialValue
* @param callable $callable function(initialValue, callable): result
*
* @return mixed
*/
public abstract function foldLeft($initialValue, $callable);
/**
* foldLeft() but with reversed arguments for the callable.
*
* @param mixed $initialValue
* @param callable $callable function(callable, initialValue): result
*
* @return mixed
*/
public abstract function foldRight($initialValue, $callable);
}
final class None extends \PhpOption\Option
{
public static function create()
{
}
public function get()
{
}
public function getOrCall($callable)
{
}
public function getOrElse($default)
{
}
public function getOrThrow(\Exception $ex)
{
}
public function isEmpty()
{
}
public function isDefined()
{
}
public function orElse(\PhpOption\Option $else)
{
}
/**
* @deprecated Use forAll() instead.
*/
public function ifDefined($callable)
{
}
public function forAll($callable)
{
}
public function map($callable)
{
}
public function flatMap($callable)
{
}
public function filter($callable)
{
}
public function filterNot($callable)
{
}
public function select($value)
{
}
public function reject($value)
{
}
public function getIterator()
{
}
public function foldLeft($initialValue, $callable)
{
}
public function foldRight($initialValue, $callable)
{
}
}
final class Some extends \PhpOption\Option
{
public function __construct($value)
{
}
public static function create($value)
{
}
public function isDefined()
{
}
public function isEmpty()
{
}
public function get()
{
}
public function getOrElse($default)
{
}
public function getOrCall($callable)
{
}
public function getOrThrow(\Exception $ex)
{
}
public function orElse(\PhpOption\Option $else)
{
}
/**
* @deprecated Use forAll() instead.
*/
public function ifDefined($callable)
{
}
public function forAll($callable)
{
}
public function map($callable)
{
}
public function flatMap($callable)
{
}
public function filter($callable)
{
}
public function filterNot($callable)
{
}
public function select($value)
{
}
public function reject($value)
{
}
public function getIterator()
{
}
public function foldLeft($initialValue, $callable)
{
}
public function foldRight($initialValue, $callable)
{
}
}
final class LazyOption extends \PhpOption\Option
{
/**
* Helper Constructor.
*
* @param callable $callback
* @param array $arguments
*
* @return LazyOption
*/
public static function create($callback, array $arguments = array())
{
}
/**
* Constructor.
*
* @param callable $callback
* @param array $arguments
*/
public function __construct($callback, array $arguments = array())
{
}
public function isDefined()
{
}
public function isEmpty()
{
}
public function get()
{
}
public function getOrElse($default)
{
}
public function getOrCall($callable)
{
}
public function getOrThrow(\Exception $ex)
{
}
public function orElse(\PhpOption\Option $else)
{
}
/**
* @deprecated Use forAll() instead.
*/
public function ifDefined($callable)
{
}
public function forAll($callable)
{
}
public function map($callable)
{
}
public function flatMap($callable)
{
}
public function filter($callable)
{
}
public function filterNot($callable)
{
}
public function select($value)
{
}
public function reject($value)
{
}
public function getIterator()
{
}
public function foldLeft($initialValue, $callable)
{
}
public function foldRight($initialValue, $callable)
{
}
}
}
namespace GoetasWebservices\Xsd\XsdToPhpRuntime\Jms\Handler {
class BaseTypesHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
{
public static function getSubscribingMethods()
{
}
public function simpleListOfToXml(\JMS\Serializer\XmlSerializationVisitor $visitor, $object, array $type, \JMS\Serializer\Context $context)
{
}
public function simpleListOfFromXml(\JMS\Serializer\XmlDeserializationVisitor $visitor, $node, array $type, \JMS\Serializer\Context $context)
{
}
}
class XmlSchemaDateHandler implements \JMS\Serializer\Handler\SubscribingHandlerInterface
{
protected $defaultTimezone;
public static function getSubscribingMethods()
{
}
public function __construct($defaultTimezone = 'UTC')
{
}
public function deserializeDateIntervalXml(\JMS\Serializer\XmlDeserializationVisitor $visitor, $data, array $type)
{
}
public function serializeDate(\JMS\Serializer\XmlSerializationVisitor $visitor, \DateTime $date, array $type, \JMS\Serializer\Context $context)
{
}
public function deserializeDate(\JMS\Serializer\XmlDeserializationVisitor $visitor, $data, array $type)
{
}
public function serializeDateTime(\JMS\Serializer\XmlSerializationVisitor $visitor, \DateTime $date, array $type, \JMS\Serializer\Context $context)
{
}
public function deserializeDateTime(\JMS\Serializer\XmlDeserializationVisitor $visitor, $data, array $type)
{
}
public function serializeTime(\JMS\Serializer\XmlSerializationVisitor $visitor, \DateTime $date, array $type, \JMS\Serializer\Context $context)
{
}
public function deserializeTime(\JMS\Serializer\XmlDeserializationVisitor $visitor, $data, array $type)
{
}
}
}
namespace PhpImap {
/**
* @see https://github.com/barbushin/php-imap
* @author Barbushin Sergey http://linkedin.com/in/barbushin
*/
class Mailbox
{
protected $imapPath;
protected $imapLogin;
protected $imapPassword;
protected $imapOptions = 0;
protected $imapRetriesNum = 0;
protected $imapParams = array();
protected $serverEncoding;
protected $attachmentsDir = null;
protected $expungeOnDisconnect = true;
/**
* @param string $imapPath
* @param string $login
* @param string $password
* @param string $attachmentsDir
* @param string $serverEncoding
* @throws Exception
*/
public function __construct($imapPath, $login, $password, $attachmentsDir = null, $serverEncoding = 'UTF-8')
{
}
/**
* Set custom connection arguments of imap_open method. See http://php.net/imap_open
* @param int $options
* @param int $retriesNum
* @param array $params
*/
public function setConnectionArgs($options = 0, $retriesNum = 0, array $params = null)
{
}
/**
* Set custom folder for attachments in case you want to have tree of folders for each email
* i.e. a/1 b/1 c/1 where a,b,c - senders, i.e. john@smith.com
* @param string $dir folder where to save attachments
*
* @return void
*/
public function setAttachmentsDir($dir)
{
}
/**
* Get IMAP mailbox connection stream
* @param bool $forceConnection Initialize connection if it's not initialized
* @return null|resource
*/
public function getImapStream($forceConnection = true)
{
}
/**
* Switch mailbox without opening a new connection
*
* @param string $imapPath
*/
public function switchMailbox($imapPath = '')
{
}
protected function initImapStream()
{
}
protected function disconnect()
{
}
/**
* Sets 'expunge on disconnect' parameter
* @param bool $isEnabled
*/
public function setExpungeOnDisconnect($isEnabled)
{
}
/**
* Get information about the current mailbox.
*
* Returns the information in an object with following properties:
* Date - current system time formatted according to RFC2822
* Driver - protocol used to access this mailbox: POP3, IMAP, NNTP
* Mailbox - the mailbox name
* Nmsgs - number of mails in the mailbox
* Recent - number of recent mails in the mailbox
*
* @return stdClass
*/
public function checkMailbox()
{
}
/**
* Creates a new mailbox specified by mailbox.
*
* @return bool
*/
public function createMailbox()
{
}
/**
* Gets status information about the given mailbox.
*
* This function returns an object containing status information.
* The object has the following properties: messages, recent, unseen, uidnext, and uidvalidity.
*
* @return stdClass if the box doesn't exist
*/
public function statusMailbox()
{
}
/**
* Gets listing the folders
*
* This function returns an object containing listing the folders.
* The object has the following properties: messages, recent, unseen, uidnext, and uidvalidity.
*
* @return array listing the folders
*/
public function getListingFolders()
{
}
/**
* This function uses imap_search() to perform a search on the mailbox currently opened in the given IMAP stream.
* For example, to match all unanswered mails sent by Mom, you'd use: "UNANSWERED FROM mom".
*
* @param string $criteria See http://php.net/imap_search for a complete list of available criteria
* @return array mailsIds (or empty array)
*/
public function searchMailbox($criteria = 'ALL')
{
}
/**
* Save mail body.
* @return bool
*/
public function saveMail($mailId, $filename = 'email.eml')
{
}
/**
* Marks mails listed in mailId for deletion.
* @return bool
*/
public function deleteMail($mailId)
{
}
/**
* Moves mails listed in mailId into new mailbox
* @return bool
*/
public function moveMail($mailId, $mailBox)
{
}
/**
* Copys mails listed in mailId into new mailbox
* @return bool
*/
public function copyMail($mailId, $mailBox)
{
}
/**
* Deletes all the mails marked for deletion by imap_delete(), imap_mail_move(), or imap_setflag_full().
* @return bool
*/
public function expungeDeletedMails()
{
}
/**
* Add the flag \Seen to a mail.
* @return bool
*/
public function markMailAsRead($mailId)
{
}
/**
* Remove the flag \Seen from a mail.
* @return bool
*/
public function markMailAsUnread($mailId)
{
}
/**
* Add the flag \Flagged to a mail.
* @return bool
*/
public function markMailAsImportant($mailId)
{
}
/**
* Add the flag \Seen to a mails.
* @return bool
*/
public function markMailsAsRead(array $mailId)
{
}
/**
* Remove the flag \Seen from some mails.
* @return bool
*/
public function markMailsAsUnread(array $mailId)
{
}
/**
* Add the flag \Flagged to some mails.
* @return bool
*/
public function markMailsAsImportant(array $mailId)
{
}
/**
* Causes a store to add the specified flag to the flags set for the mails in the specified sequence.
*
* @param array $mailsIds
* @param string $flag which you can set are \Seen, \Answered, \Flagged, \Deleted, and \Draft as defined by RFC2060.
* @return bool
*/
public function setFlag(array $mailsIds, $flag)
{
}
/**
* Cause a store to delete the specified flag to the flags set for the mails in the specified sequence.
*
* @param array $mailsIds
* @param string $flag which you can set are \Seen, \Answered, \Flagged, \Deleted, and \Draft as defined by RFC2060.
* @return bool
*/
public function clearFlag(array $mailsIds, $flag)
{
}
/**
* Fetch mail headers for listed mails ids
*
* Returns an array of objects describing one mail header each. The object will only define a property if it exists. The possible properties are:
* subject - the mails subject
* from - who sent it
* to - recipient
* date - when was it sent
* message_id - Mail-ID
* references - is a reference to this mail id
* in_reply_to - is a reply to this mail id
* size - size in bytes
* uid - UID the mail has in the mailbox
* msgno - mail sequence number in the mailbox
* recent - this mail is flagged as recent
* flagged - this mail is flagged
* answered - this mail is flagged as answered
* deleted - this mail is flagged for deletion
* seen - this mail is flagged as already read
* draft - this mail is flagged as being a draft
*
* @param array $mailsIds
* @return array
*/
public function getMailsInfo(array $mailsIds)
{
}
/**
* Get information about the current mailbox.
*
* Returns an object with following properties:
* Date - last change (current datetime)
* Driver - driver
* Mailbox - name of the mailbox
* Nmsgs - number of messages
* Recent - number of recent messages
* Unread - number of unread messages
* Deleted - number of deleted messages
* Size - mailbox size
*
* @return object Object with info | FALSE on failure
*/
public function getMailboxInfo()
{
}
/**
* Gets mails ids sorted by some criteria
*
* Criteria can be one (and only one) of the following constants:
* SORTDATE - mail Date
* SORTARRIVAL - arrival date (default)
* SORTFROM - mailbox in first From address
* SORTSUBJECT - mail subject
* SORTTO - mailbox in first To address
* SORTCC - mailbox in first cc address
* SORTSIZE - size of mail in octets
*
* @param int $criteria
* @param bool $reverse
* @return array Mails ids
*/
public function sortMails($criteria = SORTARRIVAL, $reverse = true)
{
}
/**
* Get mails count in mail box
* @return int
*/
public function countMails()
{
}
/**
* Retrieve the quota settings per user
* @return array - FALSE in the case of call failure
*/
protected function getQuota()
{
}
/**
* Return quota limit in KB
* @return int - FALSE in the case of call failure
*/
public function getQuotaLimit()
{
}
/**
* Return quota usage in KB
* @return int - FALSE in the case of call failure
*/
public function getQuotaUsage()
{
}
/**
* Get raw mail data
*
* @param $msgId
* @param bool $markAsSeen
* @return mixed
*/
public function getRawMail($msgId, $markAsSeen = true)
{
}
/**
* Get mail data
*
* @param $mailId
* @param bool $markAsSeen
* @return IncomingMail
*/
public function getMail($mailId, $markAsSeen = true)
{
}
protected function initMailPart(\PhpImap\IncomingMail $mail, $partStructure, $partNum, $markAsSeen = true)
{
}
protected function decodeMimeStr($string, $charset = 'utf-8')
{
}
function isUrlEncoded($string)
{
}
protected function decodeRFC2231($string, $charset = 'utf-8')
{
}
/**
* Converts a string from one encoding to another.
* @param string $string
* @param string $fromEncoding
* @param string $toEncoding
* @return string Converted string if conversion was successful, or the original string if not
*/
protected function convertStringEncoding($string, $fromEncoding, $toEncoding)
{
}
public function __destruct()
{
}
/**
* @param $imapPath
* @return void
*/
protected function setImapPath($imapPath)
{
}
}
class Exception extends \Exception
{
}
/**
* @see https://github.com/barbushin/php-imap
* @author Barbushin Sergey http://linkedin.com/in/barbushin
*/
class IncomingMail
{
public $id;
public $date;
public $headersRaw;
public $headers;
public $subject;
public $fromName;
public $fromAddress;
public $to = array();
public $toString;
public $cc = array();
public $bcc = array();
public $replyTo = array();
public $messageId;
public $textPlain;
public $textHtml;
/** @var IncomingMailAttachment[] */
protected $attachments = array();
public function addAttachment(\PhpImap\IncomingMailAttachment $attachment)
{
}
/**
* @return IncomingMailAttachment[]
*/
public function getAttachments()
{
}
/**
* Get array of internal HTML links placeholders
* @return array attachmentId => link placeholder
*/
public function getInternalLinksPlaceholders()
{
}
public function replaceInternalLinks($baseUri)
{
}
}
class IncomingMailAttachment
{
public $id;
public $name;
public $filePath;
public $disposition;
}
}
namespace Seld\JsonLint {
class ParsingException extends \Exception
{
protected $details;
public function __construct($message, $details = array())
{
}
public function getDetails()
{
}
}
class DuplicateKeyException extends \Seld\JsonLint\ParsingException
{
public function __construct($message, $key, array $details = array())
{
}
public function getKey()
{
}
}
/**
* Parser class
*
* Example:
*
* $parser = new JsonParser();
* // returns null if it's valid json, or an error object
* $parser->lint($json);
* // returns parsed json, like json_decode does, but slower, throws exceptions on failure.
* $parser->parse($json);
*
* Ported from https://github.com/zaach/jsonlint
*/
class JsonParser
{
const DETECT_KEY_CONFLICTS = 1;
const ALLOW_DUPLICATE_KEYS = 2;
const PARSE_TO_ASSOC = 4;
/**
* @param string $input JSON string
* @param int $flags Bitmask of parse/lint options (see constants of this class)
* @return null|ParsingException null if no error is found, a ParsingException containing all details otherwise
*/
public function lint($input, $flags = 0)
{
}
/**
* @param string $input JSON string
* @param int $flags Bitmask of parse/lint options (see constants of this class)
* @return mixed
* @throws ParsingException
*/
public function parse($input, $flags = 0)
{
}
protected function parseError($str, $hash)
{
}
}
/**
* Lexer class
*
* Ported from https://github.com/zaach/jsonlint
*/
class Lexer
{
public $match;
public $yylineno;
public $yyleng;
public $yytext;
public $yylloc;
public function lex()
{
}
public function setInput($input)
{
}
public function showPosition()
{
}
public function getPastInput()
{
}
public function getUpcomingInput()
{
}
protected function parseError($str, $hash)
{
}
}
class Undefined
{
}
}
namespace Seld\PharUtils {
class Timestamps
{
/**
* @param string $file path to the phar file to use
*/
public function __construct($file)
{
}
/**
* Updates each file's unix timestamps in the PHAR
*
* The PHAR signature can then be produced in a reproducible manner.
*
* @param int|DateTime|string $timestamp Date string or DateTime or unix timestamp to use
*/
public function updateTimestamps($timestamp = null)
{
}
/**
* Saves the updated phar file, optionally with an updated signature.
*
* @param string $path
* @param int $signatureAlgo One of Phar::MD5, Phar::SHA1, Phar::SHA256 or Phar::SHA512
* @return bool
*/
public function save($path, $signatureAlgo)
{
}
}
}
namespace Seld\CliPrompt {
class CliPrompt
{
/**
* Prompts the user for input and shows what they type
*
* @return string
*/
public static function prompt()
{
}
/**
* Prompts the user for input and hides what they type
*
* @param bool $allowFallback If prompting fails for any reason and this is set to true the prompt
* will be done using the regular prompt() function, otherwise a
* \RuntimeException is thrown.
* @return string
* @throws RuntimeException on failure to prompt, unless $allowFallback is true
*/
public static function hiddenPrompt($allowFallback = false)
{
}
}
}
namespace PHPMailer\PHPMailer {
/**
* OAuth - OAuth2 authentication wrapper class.
* Uses the oauth2-client package from the League of Extraordinary Packages.
*
* @see http://oauth2-client.thephpleague.com
*
* @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>
*/
class OAuth
{
/**
* An instance of the League OAuth Client Provider.
*
* @var AbstractProvider
*/
protected $provider;
/**
* The current OAuth access token.
*
* @var AccessToken
*/
protected $oauthToken;
/**
* The user's email address, usually used as the login ID
* and also the from address when sending email.
*
* @var string
*/
protected $oauthUserEmail = '';
/**
* The client secret, generated in the app definition of the service you're connecting to.
*
* @var string
*/
protected $oauthClientSecret = '';
/**
* The client ID, generated in the app definition of the service you're connecting to.
*
* @var string
*/
protected $oauthClientId = '';
/**
* The refresh token, used to obtain new AccessTokens.
*
* @var string
*/
protected $oauthRefreshToken = '';
/**
* OAuth constructor.
*
* @param array $options Associative array containing
* `provider`, `userName`, `clientSecret`, `clientId` and `refreshToken` elements
*/
public function __construct($options)
{
}
/**
* Get a new RefreshToken.
*
* @return RefreshToken
*/
protected function getGrant()
{
}
/**
* Get a new AccessToken.
*
* @return AccessToken
*/
protected function getToken()
{
}
/**
* Generate a base64-encoded OAuth token.
*
* @return string
*/
public function getOauth64()
{
}
}
/**
* PHPMailer exception handler.
*
* @author Marcus Bointon <phpmailer@synchromedia.co.uk>
*/
class Exception extends \Exception
{
/**
* Prettify error message output.
*
* @return string
*/
public function errorMessage()
{
}
}
/**
* PHPMailer RFC821 SMTP email transport class.
* Implements RFC 821 SMTP commands and provides some utility methods for sending mail to an SMTP server.
*
* @author Chris Ryan
* @author Marcus Bointon <phpmailer@synchromedia.co.uk>
*/
class SMTP
{
/**
* The PHPMailer SMTP version number.
*
* @var string
*/
const VERSION = '6.0.7';
/**
* SMTP line break constant.
*
* @var string
*/
const LE = "\r\n";
/**
* The SMTP port to use if one is not specified.
*
* @var int
*/
const DEFAULT_PORT = 25;
/**
* The maximum line length allowed by RFC 2822 section 2.1.1.
*
* @var int
*/
const MAX_LINE_LENGTH = 998;
/**
* Debug level for no output.
*/
const DEBUG_OFF = 0;
/**
* Debug level to show client -> server messages.
*/
const DEBUG_CLIENT = 1;
/**
* Debug level to show client -> server and server -> client messages.
*/
const DEBUG_SERVER = 2;
/**
* Debug level to show connection status, client -> server and server -> client messages.
*/
const DEBUG_CONNECTION = 3;
/**
* Debug level to show all messages.
*/
const DEBUG_LOWLEVEL = 4;
/**
* Debug output level.
* Options:
* * self::DEBUG_OFF (`0`) No debug output, default
* * self::DEBUG_CLIENT (`1`) Client commands
* * self::DEBUG_SERVER (`2`) Client commands and server responses
* * self::DEBUG_CONNECTION (`3`) As DEBUG_SERVER plus connection status
* * self::DEBUG_LOWLEVEL (`4`) Low-level data output, all messages.
*
* @var int
*/
public $do_debug = self::DEBUG_OFF;
/**
* How to handle debug output.
* Options:
* * `echo` Output plain-text as-is, appropriate for CLI
* * `html` Output escaped, line breaks converted to `<br>`, appropriate for browser output
* * `error_log` Output to error log as configured in php.ini
* Alternatively, you can provide a callable expecting two params: a message string and the debug level:
*
* ```php
* $smtp->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
* ```
*
* Alternatively, you can pass in an instance of a PSR-3 compatible logger, though only `debug`
* level output is used:
*
* ```php
* $mail->Debugoutput = new myPsr3Logger;
* ```
*
* @var string|callable|\Psr\Log\LoggerInterface
*/
public $Debugoutput = 'echo';
/**
* Whether to use VERP.
*
* @see http://en.wikipedia.org/wiki/Variable_envelope_return_path
* @see http://www.postfix.org/VERP_README.html Info on VERP
*
* @var bool
*/
public $do_verp = false;
/**
* The timeout value for connection, in seconds.
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2.
* This needs to be quite high to function correctly with hosts using greetdelay as an anti-spam measure.
*
* @see http://tools.ietf.org/html/rfc2821#section-4.5.3.2
*
* @var int
*/
public $Timeout = 300;
/**
* How long to wait for commands to complete, in seconds.
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2.
*
* @var int
*/
public $Timelimit = 300;
/**
* Patterns to extract an SMTP transaction id from reply to a DATA command.
* The first capture group in each regex will be used as the ID.
* MS ESMTP returns the message ID, which may not be correct for internal tracking.
*
* @var string[]
*/
protected $smtp_transaction_id_patterns = ['exim' => '/[\\d]{3} OK id=(.*)/', 'sendmail' => '/[\\d]{3} 2.0.0 (.*) Message/', 'postfix' => '/[\\d]{3} 2.0.0 Ok: queued as (.*)/', 'Microsoft_ESMTP' => '/[0-9]{3} 2.[\\d].0 (.*)@(?:.*) Queued mail for delivery/', 'Amazon_SES' => '/[\\d]{3} Ok (.*)/', 'SendGrid' => '/[\\d]{3} Ok: queued as (.*)/', 'CampaignMonitor' => '/[\\d]{3} 2.0.0 OK:([a-zA-Z\\d]{48})/'];
/**
* The last transaction ID issued in response to a DATA command,
* if one was detected.
*
* @var string|bool|null
*/
protected $last_smtp_transaction_id;
/**
* The socket for the server connection.
*
* @var ?resource
*/
protected $smtp_conn;
/**
* Error information, if any, for the last SMTP command.
*
* @var array
*/
protected $error = ['error' => '', 'detail' => '', 'smtp_code' => '', 'smtp_code_ex' => ''];
/**
* The reply the server sent to us for HELO.
* If null, no HELO string has yet been received.
*
* @var string|null
*/
protected $helo_rply = null;
/**
* The set of SMTP extensions sent in reply to EHLO command.
* Indexes of the array are extension names.
* Value at index 'HELO' or 'EHLO' (according to command that was sent)
* represents the server name. In case of HELO it is the only element of the array.
* Other values can be boolean TRUE or an array containing extension options.
* If null, no HELO/EHLO string has yet been received.
*
* @var array|null
*/
protected $server_caps = null;
/**
* The most recent reply received from the server.
*
* @var string
*/
protected $last_reply = '';
/**
* Output debugging info via a user-selected method.
*
* @param string $str Debug string to output
* @param int $level The debug level of this message; see DEBUG_* constants
*
* @see SMTP::$Debugoutput
* @see SMTP::$do_debug
*/
protected function edebug($str, $level = 0)
{
}
/**
* Connect to an SMTP server.
*
* @param string $host SMTP server IP or host name
* @param int $port The port number to connect to
* @param int $timeout How long to wait for the connection to open
* @param array $options An array of options for stream_context_create()
*
* @return bool
*/
public function connect($host, $port = null, $timeout = 30, $options = [])
{
}
/**
* Initiate a TLS (encrypted) session.
*
* @return bool
*/
public function startTLS()
{
}
/**
* Perform SMTP authentication.
* Must be run after hello().
*
* @see hello()
*
* @param string $username The user name
* @param string $password The password
* @param string $authtype The auth type (CRAM-MD5, PLAIN, LOGIN, XOAUTH2)
* @param OAuth $OAuth An optional OAuth instance for XOAUTH2 authentication
*
* @return bool True if successfully authenticated
*/
public function authenticate($username, $password, $authtype = null, $OAuth = null)
{
}
/**
* Calculate an MD5 HMAC hash.
* Works like hash_hmac('md5', $data, $key)
* in case that function is not available.
*
* @param string $data The data to hash
* @param string $key The key to hash with
*
* @return string
*/
protected function hmac($data, $key)
{
}
/**
* Check connection state.
*
* @return bool True if connected
*/
public function connected()
{
}
/**
* Close the socket and clean up the state of the class.
* Don't use this function without first trying to use QUIT.
*
* @see quit()
*/
public function close()
{
}
/**
* Send an SMTP DATA command.
* Issues a data command and sends the msg_data to the server,
* finializing the mail transaction. $msg_data is the message
* that is to be send with the headers. Each header needs to be
* on a single line followed by a <CRLF> with the message headers
* and the message body being separated by an additional <CRLF>.
* Implements RFC 821: DATA <CRLF>.
*
* @param string $msg_data Message data to send
*
* @return bool
*/
public function data($msg_data)
{
}
/**
* Send an SMTP HELO or EHLO command.
* Used to identify the sending server to the receiving server.
* This makes sure that client and server are in a known state.
* Implements RFC 821: HELO <SP> <domain> <CRLF>
* and RFC 2821 EHLO.
*
* @param string $host The host name or IP to connect to
*
* @return bool
*/
public function hello($host = '')
{
}
/**
* Send an SMTP HELO or EHLO command.
* Low-level implementation used by hello().
*
* @param string $hello The HELO string
* @param string $host The hostname to say we are
*
* @return bool
*
* @see hello()
*/
protected function sendHello($hello, $host)
{
}
/**
* Parse a reply to HELO/EHLO command to discover server extensions.
* In case of HELO, the only parameter that can be discovered is a server name.
*
* @param string $type `HELO` or `EHLO`
*/
protected function parseHelloFields($type)
{
}
/**
* Send an SMTP MAIL command.
* Starts a mail transaction from the email address specified in
* $from. Returns true if successful or false otherwise. If True
* the mail transaction is started and then one or more recipient
* commands may be called followed by a data command.
* Implements RFC 821: MAIL <SP> FROM:<reverse-path> <CRLF>.
*
* @param string $from Source address of this message
*
* @return bool
*/
public function mail($from)
{
}
/**
* Send an SMTP QUIT command.
* Closes the socket if there is no error or the $close_on_error argument is true.
* Implements from RFC 821: QUIT <CRLF>.
*
* @param bool $close_on_error Should the connection close if an error occurs?
*
* @return bool
*/
public function quit($close_on_error = true)
{
}
/**
* Send an SMTP RCPT command.
* Sets the TO argument to $toaddr.
* Returns true if the recipient was accepted false if it was rejected.
* Implements from RFC 821: RCPT <SP> TO:<forward-path> <CRLF>.
*
* @param string $address The address the message is being sent to
*
* @return bool
*/
public function recipient($address)
{
}
/**
* Send an SMTP RSET command.
* Abort any transaction that is currently in progress.
* Implements RFC 821: RSET <CRLF>.
*
* @return bool True on success
*/
public function reset()
{
}
/**
* Send a command to an SMTP server and check its return code.
*
* @param string $command The command name - not sent to the server
* @param string $commandstring The actual command to send
* @param int|array $expect One or more expected integer success codes
*
* @return bool True on success
*/
protected function sendCommand($command, $commandstring, $expect)
{
}
/**
* Send an SMTP SAML command.
* Starts a mail transaction from the email address specified in $from.
* Returns true if successful or false otherwise. If True
* the mail transaction is started and then one or more recipient
* commands may be called followed by a data command. This command
* will send the message to the users terminal if they are logged
* in and send them an email.
* Implements RFC 821: SAML <SP> FROM:<reverse-path> <CRLF>.
*
* @param string $from The address the message is from
*
* @return bool
*/
public function sendAndMail($from)
{
}
/**
* Send an SMTP VRFY command.
*
* @param string $name The name to verify
*
* @return bool
*/
public function verify($name)
{
}
/**
* Send an SMTP NOOP command.
* Used to keep keep-alives alive, doesn't actually do anything.
*
* @return bool
*/
public function noop()
{
}
/**
* Send an SMTP TURN command.
* This is an optional command for SMTP that this class does not support.
* This method is here to make the RFC821 Definition complete for this class
* and _may_ be implemented in future.
* Implements from RFC 821: TURN <CRLF>.
*
* @return bool
*/
public function turn()
{
}
/**
* Send raw data to the server.
*
* @param string $data The data to send
* @param string $command Optionally, the command this is part of, used only for controlling debug output
*
* @return int|bool The number of bytes sent to the server or false on error
*/
public function client_send($data, $command = '')
{
}
/**
* Get the latest error.
*
* @return array
*/
public function getError()
{
}
/**
* Get SMTP extensions available on the server.
*
* @return array|null
*/
public function getServerExtList()
{
}
/**
* Get metadata about the SMTP server from its HELO/EHLO response.
* The method works in three ways, dependent on argument value and current state:
* 1. HELO/EHLO has not been sent - returns null and populates $this->error.
* 2. HELO has been sent -
* $name == 'HELO': returns server name
* $name == 'EHLO': returns boolean false
* $name == any other string: returns null and populates $this->error
* 3. EHLO has been sent -
* $name == 'HELO'|'EHLO': returns the server name
* $name == any other string: if extension $name exists, returns True
* or its options (e.g. AUTH mechanisms supported). Otherwise returns False.
*
* @param string $name Name of SMTP extension or 'HELO'|'EHLO'
*
* @return mixed
*/
public function getServerExt($name)
{
}
/**
* Get the last reply from the server.
*
* @return string
*/
public function getLastReply()
{
}
/**
* Read the SMTP server's response.
* Either before eof or socket timeout occurs on the operation.
* With SMTP we can tell if we have more lines to read if the
* 4th character is '-' symbol. If it is a space then we don't
* need to read anything else.
*
* @return string
*/
protected function get_lines()
{
}
/**
* Enable or disable VERP address generation.
*
* @param bool $enabled
*/
public function setVerp($enabled = false)
{
}
/**
* Get VERP address generation mode.
*
* @return bool
*/
public function getVerp()
{
}
/**
* Set error messages and codes.
*
* @param string $message The error message
* @param string $detail Further detail on the error
* @param string $smtp_code An associated SMTP error code
* @param string $smtp_code_ex Extended SMTP code
*/
protected function setError($message, $detail = '', $smtp_code = '', $smtp_code_ex = '')
{
}
/**
* Set debug output method.
*
* @param string|callable $method The name of the mechanism to use for debugging output, or a callable to handle it
*/
public function setDebugOutput($method = 'echo')
{
}
/**
* Get debug output method.
*
* @return string
*/
public function getDebugOutput()
{
}
/**
* Set debug output level.
*
* @param int $level
*/
public function setDebugLevel($level = 0)
{
}
/**
* Get debug output level.
*
* @return int
*/
public function getDebugLevel()
{
}
/**
* Set SMTP timeout.
*
* @param int $timeout The timeout duration in seconds
*/
public function setTimeout($timeout = 0)
{
}
/**
* Get SMTP timeout.
*
* @return int
*/
public function getTimeout()
{
}
/**
* Reports an error number and string.
*
* @param int $errno The error number returned by PHP
* @param string $errmsg The error message returned by PHP
* @param string $errfile The file the error occurred in
* @param int $errline The line number the error occurred on
*/
protected function errorHandler($errno, $errmsg, $errfile = '', $errline = 0)
{
}
/**
* Extract and return the ID of the last SMTP transaction based on
* a list of patterns provided in SMTP::$smtp_transaction_id_patterns.
* Relies on the host providing the ID in response to a DATA command.
* If no reply has been received yet, it will return null.
* If no pattern was matched, it will return false.
*
* @return bool|null|string
*/
protected function recordLastTransactionID()
{
}
/**
* Get the queue/transaction ID of the last SMTP transaction
* If no reply has been received yet, it will return null.
* If no pattern was matched, it will return false.
*
* @return bool|null|string
*
* @see recordLastTransactionID()
*/
public function getLastTransactionID()
{
}
}
/**
* PHPMailer - PHP email creation and transport class.
*
* @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>
* @author Jim Jagielski (jimjag) <jimjag@gmail.com>
* @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
* @author Brent R. Matzelle (original founder)
*/
class PHPMailer
{
const CHARSET_ISO88591 = 'iso-8859-1';
const CHARSET_UTF8 = 'utf-8';
const CONTENT_TYPE_PLAINTEXT = 'text/plain';
const CONTENT_TYPE_TEXT_CALENDAR = 'text/calendar';
const CONTENT_TYPE_TEXT_HTML = 'text/html';
const CONTENT_TYPE_MULTIPART_ALTERNATIVE = 'multipart/alternative';
const CONTENT_TYPE_MULTIPART_MIXED = 'multipart/mixed';
const CONTENT_TYPE_MULTIPART_RELATED = 'multipart/related';
const ENCODING_7BIT = '7bit';
const ENCODING_8BIT = '8bit';
const ENCODING_BASE64 = 'base64';
const ENCODING_BINARY = 'binary';
const ENCODING_QUOTED_PRINTABLE = 'quoted-printable';
/**
* Email priority.
* Options: null (default), 1 = High, 3 = Normal, 5 = low.
* When null, the header is not set at all.
*
* @var int
*/
public $Priority;
/**
* The character set of the message.
*
* @var string
*/
public $CharSet = self::CHARSET_ISO88591;
/**
* The MIME Content-type of the message.
*
* @var string
*/
public $ContentType = self::CONTENT_TYPE_PLAINTEXT;
/**
* The message encoding.
* Options: "8bit", "7bit", "binary", "base64", and "quoted-printable".
*
* @var string
*/
public $Encoding = self::ENCODING_8BIT;
/**
* Holds the most recent mailer error message.
*
* @var string
*/
public $ErrorInfo = '';
/**
* The From email address for the message.
*
* @var string
*/
public $From = 'root@localhost';
/**
* The From name of the message.
*
* @var string
*/
public $FromName = 'Root User';
/**
* The envelope sender of the message.
* This will usually be turned into a Return-Path header by the receiver,
* and is the address that bounces will be sent to.
* If not empty, will be passed via `-f` to sendmail or as the 'MAIL FROM' value over SMTP.
*
* @var string
*/
public $Sender = '';
/**
* The Subject of the message.
*
* @var string
*/
public $Subject = '';
/**
* An HTML or plain text message body.
* If HTML then call isHTML(true).
*
* @var string
*/
public $Body = '';
/**
* The plain-text message body.
* This body can be read by mail clients that do not have HTML email
* capability such as mutt & Eudora.
* Clients that can read HTML will view the normal Body.
*
* @var string
*/
public $AltBody = '';
/**
* An iCal message part body.
* Only supported in simple alt or alt_inline message types
* To generate iCal event structures, use classes like EasyPeasyICS or iCalcreator.
*
* @see http://sprain.ch/blog/downloads/php-class-easypeasyics-create-ical-files-with-php/
* @see http://kigkonsult.se/iCalcreator/
*
* @var string
*/
public $Ical = '';
/**
* The complete compiled MIME message body.
*
* @var string
*/
protected $MIMEBody = '';
/**
* The complete compiled MIME message headers.
*
* @var string
*/
protected $MIMEHeader = '';
/**
* Extra headers that createHeader() doesn't fold in.
*
* @var string
*/
protected $mailHeader = '';
/**
* Word-wrap the message body to this number of chars.
* Set to 0 to not wrap. A useful value here is 78, for RFC2822 section 2.1.1 compliance.
*
* @see static::STD_LINE_LENGTH
*
* @var int
*/
public $WordWrap = 0;
/**
* Which method to use to send mail.
* Options: "mail", "sendmail", or "smtp".
*
* @var string
*/
public $Mailer = 'mail';
/**
* The path to the sendmail program.
*
* @var string
*/
public $Sendmail = '/usr/sbin/sendmail';
/**
* Whether mail() uses a fully sendmail-compatible MTA.
* One which supports sendmail's "-oi -f" options.
*
* @var bool
*/
public $UseSendmailOptions = true;
/**
* The email address that a reading confirmation should be sent to, also known as read receipt.
*
* @var string
*/
public $ConfirmReadingTo = '';
/**
* The hostname to use in the Message-ID header and as default HELO string.
* If empty, PHPMailer attempts to find one with, in order,
* $_SERVER['SERVER_NAME'], gethostname(), php_uname('n'), or the value
* 'localhost.localdomain'.
*
* @var string
*/
public $Hostname = '';
/**
* An ID to be used in the Message-ID header.
* If empty, a unique id will be generated.
* You can set your own, but it must be in the format "<id@domain>",
* as defined in RFC5322 section 3.6.4 or it will be ignored.
*
* @see https://tools.ietf.org/html/rfc5322#section-3.6.4
*
* @var string
*/
public $MessageID = '';
/**
* The message Date to be used in the Date header.
* If empty, the current date will be added.
*
* @var string
*/
public $MessageDate = '';
/**
* SMTP hosts.
* Either a single hostname or multiple semicolon-delimited hostnames.
* You can also specify a different port
* for each host by using this format: [hostname:port]
* (e.g. "smtp1.example.com:25;smtp2.example.com").
* You can also specify encryption type, for example:
* (e.g. "tls://smtp1.example.com:587;ssl://smtp2.example.com:465").
* Hosts will be tried in order.
*
* @var string
*/
public $Host = 'localhost';
/**
* The default SMTP server port.
*
* @var int
*/
public $Port = 25;
/**
* The SMTP HELO of the message.
* Default is $Hostname. If $Hostname is empty, PHPMailer attempts to find
* one with the same method described above for $Hostname.
*
* @see PHPMailer::$Hostname
*
* @var string
*/
public $Helo = '';
/**
* What kind of encryption to use on the SMTP connection.
* Options: '', 'ssl' or 'tls'.
*
* @var string
*/
public $SMTPSecure = '';
/**
* Whether to enable TLS encryption automatically if a server supports it,
* even if `SMTPSecure` is not set to 'tls'.
* Be aware that in PHP >= 5.6 this requires that the server's certificates are valid.
*
* @var bool
*/
public $SMTPAutoTLS = true;
/**
* Whether to use SMTP authentication.
* Uses the Username and Password properties.
*
* @see PHPMailer::$Username
* @see PHPMailer::$Password
*
* @var bool
*/
public $SMTPAuth = false;
/**
* Options array passed to stream_context_create when connecting via SMTP.
*
* @var array
*/
public $SMTPOptions = [];
/**
* SMTP username.
*
* @var string
*/
public $Username = '';
/**
* SMTP password.
*
* @var string
*/
public $Password = '';
/**
* SMTP auth type.
* Options are CRAM-MD5, LOGIN, PLAIN, XOAUTH2, attempted in that order if not specified.
*
* @var string
*/
public $AuthType = '';
/**
* An instance of the PHPMailer OAuth class.
*
* @var OAuth
*/
protected $oauth;
/**
* The SMTP server timeout in seconds.
* Default of 5 minutes (300sec) is from RFC2821 section 4.5.3.2.
*
* @var int
*/
public $Timeout = 300;
/**
* SMTP class debug output mode.
* Debug output level.
* Options:
* * `0` No output
* * `1` Commands
* * `2` Data and commands
* * `3` As 2 plus connection status
* * `4` Low-level data output.
*
* @see SMTP::$do_debug
*
* @var int
*/
public $SMTPDebug = 0;
/**
* How to handle debug output.
* Options:
* * `echo` Output plain-text as-is, appropriate for CLI
* * `html` Output escaped, line breaks converted to `<br>`, appropriate for browser output
* * `error_log` Output to error log as configured in php.ini
* By default PHPMailer will use `echo` if run from a `cli` or `cli-server` SAPI, `html` otherwise.
* Alternatively, you can provide a callable expecting two params: a message string and the debug level:
*
* ```php
* $mail->Debugoutput = function($str, $level) {echo "debug level $level; message: $str";};
* ```
*
* Alternatively, you can pass in an instance of a PSR-3 compatible logger, though only `debug`
* level output is used:
*
* ```php
* $mail->Debugoutput = new myPsr3Logger;
* ```
*
* @see SMTP::$Debugoutput
*
* @var string|callable|\Psr\Log\LoggerInterface
*/
public $Debugoutput = 'echo';
/**
* Whether to keep SMTP connection open after each message.
* If this is set to true then to close the connection
* requires an explicit call to smtpClose().
*
* @var bool
*/
public $SMTPKeepAlive = false;
/**
* Whether to split multiple to addresses into multiple messages
* or send them all in one message.
* Only supported in `mail` and `sendmail` transports, not in SMTP.
*
* @var bool
*/
public $SingleTo = false;
/**
* Storage for addresses when SingleTo is enabled.
*
* @var array
*/
protected $SingleToArray = [];
/**
* Whether to generate VERP addresses on send.
* Only applicable when sending via SMTP.
*
* @see https://en.wikipedia.org/wiki/Variable_envelope_return_path
* @see http://www.postfix.org/VERP_README.html Postfix VERP info
*
* @var bool
*/
public $do_verp = false;
/**
* Whether to allow sending messages with an empty body.
*
* @var bool
*/
public $AllowEmpty = false;
/**
* DKIM selector.
*
* @var string
*/
public $DKIM_selector = '';
/**
* DKIM Identity.
* Usually the email address used as the source of the email.
*
* @var string
*/
public $DKIM_identity = '';
/**
* DKIM passphrase.
* Used if your key is encrypted.
*
* @var string
*/
public $DKIM_passphrase = '';
/**
* DKIM signing domain name.
*
* @example 'example.com'
*
* @var string
*/
public $DKIM_domain = '';
/**
* DKIM Copy header field values for diagnostic use.
*
* @var bool
*/
public $DKIM_copyHeaderFields = true;
/**
* DKIM Extra signing headers.
*
* @example ['List-Unsubscribe', 'List-Help']
*
* @var array
*/
public $DKIM_extraHeaders = [];
/**
* DKIM private key file path.
*
* @var string
*/
public $DKIM_private = '';
/**
* DKIM private key string.
*
* If set, takes precedence over `$DKIM_private`.
*
* @var string
*/
public $DKIM_private_string = '';
/**
* Callback Action function name.
*
* The function that handles the result of the send email action.
* It is called out by send() for each email sent.
*
* Value can be any php callable: http://www.php.net/is_callable
*
* Parameters:
* bool $result result of the send action
* array $to email addresses of the recipients
* array $cc cc email addresses
* array $bcc bcc email addresses
* string $subject the subject
* string $body the email body
* string $from email address of sender
* string $extra extra information of possible use
* "smtp_transaction_id' => last smtp transaction id
*
* @var string
*/
public $action_function = '';
/**
* What to put in the X-Mailer header.
* Options: An empty string for PHPMailer default, whitespace for none, or a string to use.
*
* @var string
*/
public $XMailer = '';
/**
* Which validator to use by default when validating email addresses.
* May be a callable to inject your own validator, but there are several built-in validators.
* The default validator uses PHP's FILTER_VALIDATE_EMAIL filter_var option.
*
* @see PHPMailer::validateAddress()
*
* @var string|callable
*/
public static $validator = 'php';
/**
* An instance of the SMTP sender class.
*
* @var SMTP
*/
protected $smtp;
/**
* The array of 'to' names and addresses.
*
* @var array
*/
protected $to = [];
/**
* The array of 'cc' names and addresses.
*
* @var array
*/
protected $cc = [];
/**
* The array of 'bcc' names and addresses.
*
* @var array
*/
protected $bcc = [];
/**
* The array of reply-to names and addresses.
*
* @var array
*/
protected $ReplyTo = [];
/**
* An array of all kinds of addresses.
* Includes all of $to, $cc, $bcc.
*
* @see PHPMailer::$to
* @see PHPMailer::$cc
* @see PHPMailer::$bcc
*
* @var array
*/
protected $all_recipients = [];
/**
* An array of names and addresses queued for validation.
* In send(), valid and non duplicate entries are moved to $all_recipients
* and one of $to, $cc, or $bcc.
* This array is used only for addresses with IDN.
*
* @see PHPMailer::$to
* @see PHPMailer::$cc
* @see PHPMailer::$bcc
* @see PHPMailer::$all_recipients
*
* @var array
*/
protected $RecipientsQueue = [];
/**
* An array of reply-to names and addresses queued for validation.
* In send(), valid and non duplicate entries are moved to $ReplyTo.
* This array is used only for addresses with IDN.
*
* @see PHPMailer::$ReplyTo
*
* @var array
*/
protected $ReplyToQueue = [];
/**
* The array of attachments.
*
* @var array
*/
protected $attachment = [];
/**
* The array of custom headers.
*
* @var array
*/
protected $CustomHeader = [];
/**
* The most recent Message-ID (including angular brackets).
*
* @var string
*/
protected $lastMessageID = '';
/**
* The message's MIME type.
*
* @var string
*/
protected $message_type = '';
/**
* The array of MIME boundary strings.
*
* @var array
*/
protected $boundary = [];
/**
* The array of available languages.
*
* @var array
*/
protected $language = [];
/**
* The number of errors encountered.
*
* @var int
*/
protected $error_count = 0;
/**
* The S/MIME certificate file path.
*
* @var string
*/
protected $sign_cert_file = '';
/**
* The S/MIME key file path.
*
* @var string
*/
protected $sign_key_file = '';
/**
* The optional S/MIME extra certificates ("CA Chain") file path.
*
* @var string
*/
protected $sign_extracerts_file = '';
/**
* The S/MIME password for the key.
* Used only if the key is encrypted.
*
* @var string
*/
protected $sign_key_pass = '';
/**
* Whether to throw exceptions for errors.
*
* @var bool
*/
protected $exceptions = false;
/**
* Unique ID used for message ID and boundaries.
*
* @var string
*/
protected $uniqueid = '';
/**
* The PHPMailer Version number.
*
* @var string
*/
const VERSION = '6.0.7';
/**
* Error severity: message only, continue processing.
*
* @var int
*/
const STOP_MESSAGE = 0;
/**
* Error severity: message, likely ok to continue processing.
*
* @var int
*/
const STOP_CONTINUE = 1;
/**
* Error severity: message, plus full stop, critical error reached.
*
* @var int
*/
const STOP_CRITICAL = 2;
/**
* SMTP RFC standard line ending.
*
* @var string
*/
protected static $LE = "\r\n";
/**
* The maximum line length allowed by RFC 2822 section 2.1.1.
*
* @var int
*/
const MAX_LINE_LENGTH = 998;
/**
* The lower maximum line length allowed by RFC 2822 section 2.1.1.
* This length does NOT include the line break
* 76 means that lines will be 77 or 78 chars depending on whether
* the line break format is LF or CRLF; both are valid.
*
* @var int
*/
const STD_LINE_LENGTH = 76;
/**
* Constructor.
*
* @param bool $exceptions Should we throw external exceptions?
*/
public function __construct($exceptions = null)
{
}
/**
* Destructor.
*/
public function __destruct()
{
}
/**
* Output debugging info via user-defined method.
* Only generates output if SMTP debug output is enabled (@see SMTP::$do_debug).
*
* @see PHPMailer::$Debugoutput
* @see PHPMailer::$SMTPDebug
*
* @param string $str
*/
protected function edebug($str)
{
}
/**
* Sets message type to HTML or plain.
*
* @param bool $isHtml True for HTML mode
*/
public function isHTML($isHtml = true)
{
}
/**
* Send messages using SMTP.
*/
public function isSMTP()
{
}
/**
* Send messages using PHP's mail() function.
*/
public function isMail()
{
}
/**
* Send messages using $Sendmail.
*/
public function isSendmail()
{
}
/**
* Send messages using qmail.
*/
public function isQmail()
{
}
/**
* Add a "To" address.
*
* @param string $address The email address to send to
* @param string $name
*
* @return bool true on success, false if address already used or invalid in some way
*/
public function addAddress($address, $name = '')
{
}
/**
* Add a "CC" address.
*
* @param string $address The email address to send to
* @param string $name
*
* @return bool true on success, false if address already used or invalid in some way
*/
public function addCC($address, $name = '')
{
}
/**
* Add a "BCC" address.
*
* @param string $address The email address to send to
* @param string $name
*
* @return bool true on success, false if address already used or invalid in some way
*/
public function addBCC($address, $name = '')
{
}
/**
* Add a "Reply-To" address.
*
* @param string $address The email address to reply to
* @param string $name
*
* @return bool true on success, false if address already used or invalid in some way
*/
public function addReplyTo($address, $name = '')
{
}
/**
* Add an address to one of the recipient arrays or to the ReplyTo array. Because PHPMailer
* can't validate addresses with an IDN without knowing the PHPMailer::$CharSet (that can still
* be modified after calling this function), addition of such addresses is delayed until send().
* Addresses that have been added already return false, but do not throw exceptions.
*
* @param string $kind One of 'to', 'cc', 'bcc', or 'ReplyTo'
* @param string $address The email address to send, resp. to reply to
* @param string $name
*
* @throws Exception
*
* @return bool true on success, false if address already used or invalid in some way
*/
protected function addOrEnqueueAnAddress($kind, $address, $name)
{
}
/**
* Add an address to one of the recipient arrays or to the ReplyTo array.
* Addresses that have been added already return false, but do not throw exceptions.
*
* @param string $kind One of 'to', 'cc', 'bcc', or 'ReplyTo'
* @param string $address The email address to send, resp. to reply to
* @param string $name
*
* @throws Exception
*
* @return bool true on success, false if address already used or invalid in some way
*/
protected function addAnAddress($kind, $address, $name = '')
{
}
/**
* Parse and validate a string containing one or more RFC822-style comma-separated email addresses
* of the form "display name <address>" into an array of name/address pairs.
* Uses the imap_rfc822_parse_adrlist function if the IMAP extension is available.
* Note that quotes in the name part are removed.
*
* @see http://www.andrew.cmu.edu/user/agreen1/testing/mrbs/web/Mail/RFC822.php A more careful implementation
*
* @param string $addrstr The address list string
* @param bool $useimap Whether to use the IMAP extension to parse the list
*
* @return array
*/
public static function parseAddresses($addrstr, $useimap = true)
{
}
/**
* Set the From and FromName properties.
*
* @param string $address
* @param string $name
* @param bool $auto Whether to also set the Sender address, defaults to true
*
* @throws Exception
*
* @return bool
*/
public function setFrom($address, $name = '', $auto = true)
{
}
/**
* Return the Message-ID header of the last email.
* Technically this is the value from the last time the headers were created,
* but it's also the message ID of the last sent message except in
* pathological cases.
*
* @return string
*/
public function getLastMessageID()
{
}
/**
* Check that a string looks like an email address.
* Validation patterns supported:
* * `auto` Pick best pattern automatically;
* * `pcre8` Use the squiloople.com pattern, requires PCRE > 8.0;
* * `pcre` Use old PCRE implementation;
* * `php` Use PHP built-in FILTER_VALIDATE_EMAIL;
* * `html5` Use the pattern given by the HTML5 spec for 'email' type form input elements.
* * `noregex` Don't use a regex: super fast, really dumb.
* Alternatively you may pass in a callable to inject your own validator, for example:
*
* ```php
* PHPMailer::validateAddress('user@example.com', function($address) {
* return (strpos($address, '@') !== false);
* });
* ```
*
* You can also set the PHPMailer::$validator static to a callable, allowing built-in methods to use your validator.
*
* @param string $address The email address to check
* @param string|callable $patternselect Which pattern to use
*
* @return bool
*/
public static function validateAddress($address, $patternselect = null)
{
}
/**
* Tells whether IDNs (Internationalized Domain Names) are supported or not. This requires the
* `intl` and `mbstring` PHP extensions.
*
* @return bool `true` if required functions for IDN support are present
*/
public static function idnSupported()
{
}
/**
* Converts IDN in given email address to its ASCII form, also known as punycode, if possible.
* Important: Address must be passed in same encoding as currently set in PHPMailer::$CharSet.
* This function silently returns unmodified address if:
* - No conversion is necessary (i.e. domain name is not an IDN, or is already in ASCII form)
* - Conversion to punycode is impossible (e.g. required PHP functions are not available)
* or fails for any reason (e.g. domain contains characters not allowed in an IDN).
*
* @see PHPMailer::$CharSet
*
* @param string $address The email address to convert
*
* @return string The encoded address in ASCII form
*/
public function punyencodeAddress($address)
{
}
/**
* Create a message and send it.
* Uses the sending method specified by $Mailer.
*
* @throws Exception
*
* @return bool false on error - See the ErrorInfo property for details of the error
*/
public function send()
{
}
/**
* Prepare a message for sending.
*
* @throws Exception
*
* @return bool
*/
public function preSend()
{
}
/**
* Actually send a message via the selected mechanism.
*
* @throws Exception
*
* @return bool
*/
public function postSend()
{
}
/**
* Send mail using the $Sendmail program.
*
* @see PHPMailer::$Sendmail
*
* @param string $header The message headers
* @param string $body The message body
*
* @throws Exception
*
* @return bool
*/
protected function sendmailSend($header, $body)
{
}
/**
* Fix CVE-2016-10033 and CVE-2016-10045 by disallowing potentially unsafe shell characters.
* Note that escapeshellarg and escapeshellcmd are inadequate for our purposes, especially on Windows.
*
* @see https://github.com/PHPMailer/PHPMailer/issues/924 CVE-2016-10045 bug report
*
* @param string $string The string to be validated
*
* @return bool
*/
protected static function isShellSafe($string)
{
}
/**
* Check whether a file path is of a permitted type.
* Used to reject URLs and phar files from functions that access local file paths,
* such as addAttachment.
*
* @param string $path A relative or absolute path to a file
*
* @return bool
*/
protected static function isPermittedPath($path)
{
}
/**
* Send mail using the PHP mail() function.
*
* @see http://www.php.net/manual/en/book.mail.php
*
* @param string $header The message headers
* @param string $body The message body
*
* @throws Exception
*
* @return bool
*/
protected function mailSend($header, $body)
{
}
/**
* Get an instance to use for SMTP operations.
* Override this function to load your own SMTP implementation,
* or set one with setSMTPInstance.
*
* @return SMTP
*/
public function getSMTPInstance()
{
}
/**
* Provide an instance to use for SMTP operations.
*
* @param SMTP $smtp
*
* @return SMTP
*/
public function setSMTPInstance(\PHPMailer\PHPMailer\SMTP $smtp)
{
}
/**
* Send mail via SMTP.
* Returns false if there is a bad MAIL FROM, RCPT, or DATA input.
*
* @see PHPMailer::setSMTPInstance() to use a different class.
*
* @uses \PHPMailer\PHPMailer\SMTP
*
* @param string $header The message headers
* @param string $body The message body
*
* @throws Exception
*
* @return bool
*/
protected function smtpSend($header, $body)
{
}
/**
* Initiate a connection to an SMTP server.
* Returns false if the operation failed.
*
* @param array $options An array of options compatible with stream_context_create()
*
* @throws Exception
*
* @uses \PHPMailer\PHPMailer\SMTP
*
* @return bool
*/
public function smtpConnect($options = null)
{
}
/**
* Close the active SMTP session if one exists.
*/
public function smtpClose()
{
}
/**
* Set the language for error messages.
* Returns false if it cannot load the language file.
* The default language is English.
*
* @param string $langcode ISO 639-1 2-character language code (e.g. French is "fr")
* @param string $lang_path Path to the language file directory, with trailing separator (slash)
*
* @return bool
*/
public function setLanguage($langcode = 'en', $lang_path = '')
{
}
/**
* Get the array of strings for the current language.
*
* @return array
*/
public function getTranslations()
{
}
/**
* Create recipient headers.
*
* @param string $type
* @param array $addr An array of recipients,
* where each recipient is a 2-element indexed array with element 0 containing an address
* and element 1 containing a name, like:
* [['joe@example.com', 'Joe User'], ['zoe@example.com', 'Zoe User']]
*
* @return string
*/
public function addrAppend($type, $addr)
{
}
/**
* Format an address for use in a message header.
*
* @param array $addr A 2-element indexed array, element 0 containing an address, element 1 containing a name like
* ['joe@example.com', 'Joe User']
*
* @return string
*/
public function addrFormat($addr)
{
}
/**
* Word-wrap message.
* For use with mailers that do not automatically perform wrapping
* and for quoted-printable encoded messages.
* Original written by philippe.
*
* @param string $message The message to wrap
* @param int $length The line length to wrap to
* @param bool $qp_mode Whether to run in Quoted-Printable mode
*
* @return string
*/
public function wrapText($message, $length, $qp_mode = false)
{
}
/**
* Find the last character boundary prior to $maxLength in a utf-8
* quoted-printable encoded string.
* Original written by Colin Brown.
*
* @param string $encodedText utf-8 QP text
* @param int $maxLength Find the last character boundary prior to this length
*
* @return int
*/
public function utf8CharBoundary($encodedText, $maxLength)
{
}
/**
* Apply word wrapping to the message body.
* Wraps the message body to the number of chars set in the WordWrap property.
* You should only do this to plain-text bodies as wrapping HTML tags may break them.
* This is called automatically by createBody(), so you don't need to call it yourself.
*/
public function setWordWrap()
{
}
/**
* Assemble message headers.
*
* @return string The assembled headers
*/
public function createHeader()
{
}
/**
* Get the message MIME type headers.
*
* @return string
*/
public function getMailMIME()
{
}
/**
* Returns the whole MIME message.
* Includes complete headers and body.
* Only valid post preSend().
*
* @see PHPMailer::preSend()
*
* @return string
*/
public function getSentMIMEMessage()
{
}
/**
* Create a unique ID to use for boundaries.
*
* @return string
*/
protected function generateId()
{
}
/**
* Assemble the message body.
* Returns an empty string on failure.
*
* @throws Exception
*
* @return string The assembled message body
*/
public function createBody()
{
}
/**
* Return the start of a message boundary.
*
* @param string $boundary
* @param string $charSet
* @param string $contentType
* @param string $encoding
*
* @return string
*/
protected function getBoundary($boundary, $charSet, $contentType, $encoding)
{
}
/**
* Return the end of a message boundary.
*
* @param string $boundary
*
* @return string
*/
protected function endBoundary($boundary)
{
}
/**
* Set the message type.
* PHPMailer only supports some preset message types, not arbitrary MIME structures.
*/
protected function setMessageType()
{
}
/**
* Format a header line.
*
* @param string $name
* @param string|int $value
*
* @return string
*/
public function headerLine($name, $value)
{
}
/**
* Return a formatted mail line.
*
* @param string $value
*
* @return string
*/
public function textLine($value)
{
}
/**
* Add an attachment from a path on the filesystem.
* Never use a user-supplied path to a file!
* Returns false if the file could not be found or read.
* Explicitly *does not* support passing URLs; PHPMailer is not an HTTP client.
* If you need to do that, fetch the resource yourself and pass it in via a local file or string.
*
* @param string $path Path to the attachment
* @param string $name Overrides the attachment name
* @param string $encoding File encoding (see $Encoding)
* @param string $type File extension (MIME) type
* @param string $disposition Disposition to use
*
* @throws Exception
*
* @return bool
*/
public function addAttachment($path, $name = '', $encoding = self::ENCODING_BASE64, $type = '', $disposition = 'attachment')
{
}
/**
* Return the array of attachments.
*
* @return array
*/
public function getAttachments()
{
}
/**
* Attach all file, string, and binary attachments to the message.
* Returns an empty string on failure.
*
* @param string $disposition_type
* @param string $boundary
*
* @return string
*/
protected function attachAll($disposition_type, $boundary)
{
}
/**
* Encode a file attachment in requested format.
* Returns an empty string on failure.
*
* @param string $path The full path to the file
* @param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
*
* @throws Exception
*
* @return string
*/
protected function encodeFile($path, $encoding = self::ENCODING_BASE64)
{
}
/**
* Encode a string in requested format.
* Returns an empty string on failure.
*
* @param string $str The text to encode
* @param string $encoding The encoding to use; one of 'base64', '7bit', '8bit', 'binary', 'quoted-printable'
*
* @return string
*/
public function encodeString($str, $encoding = self::ENCODING_BASE64)
{
}
/**
* Encode a header value (not including its label) optimally.
* Picks shortest of Q, B, or none. Result includes folding if needed.
* See RFC822 definitions for phrase, comment and text positions.
*
* @param string $str The header value to encode
* @param string $position What context the string will be used in
*
* @return string
*/
public function encodeHeader($str, $position = 'text')
{
}
/**
* Check if a string contains multi-byte characters.
*
* @param string $str multi-byte text to wrap encode
*
* @return bool
*/
public function hasMultiBytes($str)
{
}
/**
* Does a string contain any 8-bit chars (in any charset)?
*
* @param string $text
*
* @return bool
*/
public function has8bitChars($text)
{
}
/**
* Encode and wrap long multibyte strings for mail headers
* without breaking lines within a character.
* Adapted from a function by paravoid.
*
* @see http://www.php.net/manual/en/function.mb-encode-mimeheader.php#60283
*
* @param string $str multi-byte text to wrap encode
* @param string $linebreak string to use as linefeed/end-of-line
*
* @return string
*/
public function base64EncodeWrapMB($str, $linebreak = null)
{
}
/**
* Encode a string in quoted-printable format.
* According to RFC2045 section 6.7.
*
* @param string $string The text to encode
*
* @return string
*/
public function encodeQP($string)
{
}
/**
* Encode a string using Q encoding.
*
* @see http://tools.ietf.org/html/rfc2047#section-4.2
*
* @param string $str the text to encode
* @param string $position Where the text is going to be used, see the RFC for what that means
*
* @return string
*/
public function encodeQ($str, $position = 'text')
{
}
/**
* Add a string or binary attachment (non-filesystem).
* This method can be used to attach ascii or binary data,
* such as a BLOB record from a database.
*
* @param string $string String attachment data
* @param string $filename Name of the attachment
* @param string $encoding File encoding (see $Encoding)
* @param string $type File extension (MIME) type
* @param string $disposition Disposition to use
*/
public function addStringAttachment($string, $filename, $encoding = self::ENCODING_BASE64, $type = '', $disposition = 'attachment')
{
}
/**
* Add an embedded (inline) attachment from a file.
* This can include images, sounds, and just about any other document type.
* These differ from 'regular' attachments in that they are intended to be
* displayed inline with the message, not just attached for download.
* This is used in HTML messages that embed the images
* the HTML refers to using the $cid value.
* Never use a user-supplied path to a file!
*
* @param string $path Path to the attachment
* @param string $cid Content ID of the attachment; Use this to reference
* the content when using an embedded image in HTML
* @param string $name Overrides the attachment name
* @param string $encoding File encoding (see $Encoding)
* @param string $type File MIME type
* @param string $disposition Disposition to use
*
* @return bool True on successfully adding an attachment
*/
public function addEmbeddedImage($path, $cid, $name = '', $encoding = self::ENCODING_BASE64, $type = '', $disposition = 'inline')
{
}
/**
* Add an embedded stringified attachment.
* This can include images, sounds, and just about any other document type.
* If your filename doesn't contain an extension, be sure to set the $type to an appropriate MIME type.
*
* @param string $string The attachment binary data
* @param string $cid Content ID of the attachment; Use this to reference
* the content when using an embedded image in HTML
* @param string $name A filename for the attachment. If this contains an extension,
* PHPMailer will attempt to set a MIME type for the attachment.
* For example 'file.jpg' would get an 'image/jpeg' MIME type.
* @param string $encoding File encoding (see $Encoding), defaults to 'base64'
* @param string $type MIME type - will be used in preference to any automatically derived type
* @param string $disposition Disposition to use
*
* @return bool True on successfully adding an attachment
*/
public function addStringEmbeddedImage($string, $cid, $name = '', $encoding = self::ENCODING_BASE64, $type = '', $disposition = 'inline')
{
}
/**
* Check if an embedded attachment is present with this cid.
*
* @param string $cid
*
* @return bool
*/
protected function cidExists($cid)
{
}
/**
* Check if an inline attachment is present.
*
* @return bool
*/
public function inlineImageExists()
{
}
/**
* Check if an attachment (non-inline) is present.
*
* @return bool
*/
public function attachmentExists()
{
}
/**
* Check if this message has an alternative body set.
*
* @return bool
*/
public function alternativeExists()
{
}
/**
* Clear queued addresses of given kind.
*
* @param string $kind 'to', 'cc', or 'bcc'
*/
public function clearQueuedAddresses($kind)
{
}
/**
* Clear all To recipients.
*/
public function clearAddresses()
{
}
/**
* Clear all CC recipients.
*/
public function clearCCs()
{
}
/**
* Clear all BCC recipients.
*/
public function clearBCCs()
{
}
/**
* Clear all ReplyTo recipients.
*/
public function clearReplyTos()
{
}
/**
* Clear all recipient types.
*/
public function clearAllRecipients()
{
}
/**
* Clear all filesystem, string, and binary attachments.
*/
public function clearAttachments()
{
}
/**
* Clear all custom headers.
*/
public function clearCustomHeaders()
{
}
/**
* Add an error message to the error container.
*
* @param string $msg
*/
protected function setError($msg)
{
}
/**
* Return an RFC 822 formatted date.
*
* @return string
*/
public static function rfcDate()
{
}
/**
* Get the server hostname.
* Returns 'localhost.localdomain' if unknown.
*
* @return string
*/
protected function serverHostname()
{
}
/**
* Validate whether a string contains a valid value to use as a hostname or IP address.
* IPv6 addresses must include [], e.g. `[::1]`, not just `::1`.
*
* @param string $host The host name or IP address to check
*
* @return bool
*/
public static function isValidHost($host)
{
}
/**
* Get an error message in the current language.
*
* @param string $key
*
* @return string
*/
protected function lang($key)
{
}
/**
* Check if an error occurred.
*
* @return bool True if an error did occur
*/
public function isError()
{
}
/**
* Add a custom header.
* $name value can be overloaded to contain
* both header name and value (name:value).
*
* @param string $name Custom header name
* @param string|null $value Header value
*/
public function addCustomHeader($name, $value = null)
{
}
/**
* Returns all custom headers.
*
* @return array
*/
public function getCustomHeaders()
{
}
/**
* Create a message body from an HTML string.
* Automatically inlines images and creates a plain-text version by converting the HTML,
* overwriting any existing values in Body and AltBody.
* Do not source $message content from user input!
* $basedir is prepended when handling relative URLs, e.g. <img src="/images/a.png"> and must not be empty
* will look for an image file in $basedir/images/a.png and convert it to inline.
* If you don't provide a $basedir, relative paths will be left untouched (and thus probably break in email)
* Converts data-uri images into embedded attachments.
* If you don't want to apply these transformations to your HTML, just set Body and AltBody directly.
*
* @param string $message HTML message string
* @param string $basedir Absolute path to a base directory to prepend to relative paths to images
* @param bool|callable $advanced Whether to use the internal HTML to text converter
* or your own custom converter @see PHPMailer::html2text()
*
* @return string $message The transformed message Body
*/
public function msgHTML($message, $basedir = '', $advanced = false)
{
}
/**
* Convert an HTML string into plain text.
* This is used by msgHTML().
* Note - older versions of this function used a bundled advanced converter
* which was removed for license reasons in #232.
* Example usage:
*
* ```php
* // Use default conversion
* $plain = $mail->html2text($html);
* // Use your own custom converter
* $plain = $mail->html2text($html, function($html) {
* $converter = new MyHtml2text($html);
* return $converter->get_text();
* });
* ```
*
* @param string $html The HTML text to convert
* @param bool|callable $advanced Any boolean value to use the internal converter,
* or provide your own callable for custom conversion
*
* @return string
*/
public function html2text($html, $advanced = false)
{
}
/**
* Get the MIME type for a file extension.
*
* @param string $ext File extension
*
* @return string MIME type of file
*/
public static function _mime_types($ext = '')
{
}
/**
* Map a file name to a MIME type.
* Defaults to 'application/octet-stream', i.e.. arbitrary binary data.
*
* @param string $filename A file name or full path, does not need to exist as a file
*
* @return string
*/
public static function filenameToType($filename)
{
}
/**
* Multi-byte-safe pathinfo replacement.
* Drop-in replacement for pathinfo(), but multibyte- and cross-platform-safe.
*
* @see http://www.php.net/manual/en/function.pathinfo.php#107461
*
* @param string $path A filename or path, does not need to exist as a file
* @param int|string $options Either a PATHINFO_* constant,
* or a string name to return only the specified piece
*
* @return string|array
*/
public static function mb_pathinfo($path, $options = null)
{
}
/**
* Set or reset instance properties.
* You should avoid this function - it's more verbose, less efficient, more error-prone and
* harder to debug than setting properties directly.
* Usage Example:
* `$mail->set('SMTPSecure', 'tls');`
* is the same as:
* `$mail->SMTPSecure = 'tls';`.
*
* @param string $name The property name to set
* @param mixed $value The value to set the property to
*
* @return bool
*/
public function set($name, $value = '')
{
}
/**
* Strip newlines to prevent header injection.
*
* @param string $str
*
* @return string
*/
public function secureHeader($str)
{
}
/**
* Normalize line breaks in a string.
* Converts UNIX LF, Mac CR and Windows CRLF line breaks into a single line break format.
* Defaults to CRLF (for message bodies) and preserves consecutive breaks.
*
* @param string $text
* @param string $breaktype What kind of line break to use; defaults to static::$LE
*
* @return string
*/
public static function normalizeBreaks($text, $breaktype = null)
{
}
/**
* Return the current line break format string.
*
* @return string
*/
public static function getLE()
{
}
/**
* Set the line break format string, e.g. "\r\n".
*
* @param string $le
*/
protected static function setLE($le)
{
}
/**
* Set the public and private key files and password for S/MIME signing.
*
* @param string $cert_filename
* @param string $key_filename
* @param string $key_pass Password for private key
* @param string $extracerts_filename Optional path to chain certificate
*/
public function sign($cert_filename, $key_filename, $key_pass, $extracerts_filename = '')
{
}
/**
* Quoted-Printable-encode a DKIM header.
*
* @param string $txt
*
* @return string
*/
public function DKIM_QP($txt)
{
}
/**
* Generate a DKIM signature.
*
* @param string $signHeader
*
* @throws Exception
*
* @return string The DKIM signature value
*/
public function DKIM_Sign($signHeader)
{
}
/**
* Generate a DKIM canonicalization header.
* Uses the 'relaxed' algorithm from RFC6376 section 3.4.2.
* Canonicalized headers should *always* use CRLF, regardless of mailer setting.
*
* @see https://tools.ietf.org/html/rfc6376#section-3.4.2
*
* @param string $signHeader Header
*
* @return string
*/
public function DKIM_HeaderC($signHeader)
{
}
/**
* Generate a DKIM canonicalization body.
* Uses the 'simple' algorithm from RFC6376 section 3.4.3.
* Canonicalized bodies should *always* use CRLF, regardless of mailer setting.
*
* @see https://tools.ietf.org/html/rfc6376#section-3.4.3
*
* @param string $body Message Body
*
* @return string
*/
public function DKIM_BodyC($body)
{
}
/**
* Create the DKIM header and body in a new message header.
*
* @param string $headers_line Header lines
* @param string $subject Subject
* @param string $body Body
*
* @return string
*/
public function DKIM_Add($headers_line, $subject, $body)
{
}
/**
* Detect if a string contains a line longer than the maximum line length
* allowed by RFC 2822 section 2.1.1.
*
* @param string $str
*
* @return bool
*/
public static function hasLineLongerThanMax($str)
{
}
/**
* Allows for public read access to 'to' property.
* Before the send() call, queued addresses (i.e. with IDN) are not yet included.
*
* @return array
*/
public function getToAddresses()
{
}
/**
* Allows for public read access to 'cc' property.
* Before the send() call, queued addresses (i.e. with IDN) are not yet included.
*
* @return array
*/
public function getCcAddresses()
{
}
/**
* Allows for public read access to 'bcc' property.
* Before the send() call, queued addresses (i.e. with IDN) are not yet included.
*
* @return array
*/
public function getBccAddresses()
{
}
/**
* Allows for public read access to 'ReplyTo' property.
* Before the send() call, queued addresses (i.e. with IDN) are not yet included.
*
* @return array
*/
public function getReplyToAddresses()
{
}
/**
* Allows for public read access to 'all_recipients' property.
* Before the send() call, queued addresses (i.e. with IDN) are not yet included.
*
* @return array
*/
public function getAllRecipientAddresses()
{
}
/**
* Perform a callback.
*
* @param bool $isSent
* @param array $to
* @param array $cc
* @param array $bcc
* @param string $subject
* @param string $body
* @param string $from
* @param array $extra
*/
protected function doCallback($isSent, $to, $cc, $bcc, $subject, $body, $from, $extra)
{
}
/**
* Get the OAuth instance.
*
* @return OAuth
*/
public function getOAuth()
{
}
/**
* Set an OAuth instance.
*
* @param OAuth $oauth
*/
public function setOAuth(\PHPMailer\PHPMailer\OAuth $oauth)
{
}
}
/**
* PHPMailer POP-Before-SMTP Authentication Class.
* Specifically for PHPMailer to use for RFC1939 POP-before-SMTP authentication.
* 1) This class does not support APOP authentication.
* 2) Opening and closing lots of POP3 connections can be quite slow. If you need
* to send a batch of emails then just perform the authentication once at the start,
* and then loop through your mail sending script. Providing this process doesn't
* take longer than the verification period lasts on your POP3 server, you should be fine.
* 3) This is really ancient technology; you should only need to use it to talk to very old systems.
* 4) This POP3 class is deliberately lightweight and incomplete, and implements just
* enough to do authentication.
* If you want a more complete class there are other POP3 classes for PHP available.
*
* @author Richard Davey (original author) <rich@corephp.co.uk>
* @author Marcus Bointon (Synchro/coolbru) <phpmailer@synchromedia.co.uk>
* @author Jim Jagielski (jimjag) <jimjag@gmail.com>
* @author Andy Prevost (codeworxtech) <codeworxtech@users.sourceforge.net>
*/
class POP3
{
/**
* The POP3 PHPMailer Version number.
*
* @var string
*/
const VERSION = '6.0.7';
/**
* Default POP3 port number.
*
* @var int
*/
const DEFAULT_PORT = 110;
/**
* Default timeout in seconds.
*
* @var int
*/
const DEFAULT_TIMEOUT = 30;
/**
* Debug display level.
* Options: 0 = no, 1+ = yes.
*
* @var int
*/
public $do_debug = 0;
/**
* POP3 mail server hostname.
*
* @var string
*/
public $host;
/**
* POP3 port number.
*
* @var int
*/
public $port;
/**
* POP3 Timeout Value in seconds.
*
* @var int
*/
public $tval;
/**
* POP3 username.
*
* @var string
*/
public $username;
/**
* POP3 password.
*
* @var string
*/
public $password;
/**
* Resource handle for the POP3 connection socket.
*
* @var resource
*/
protected $pop_conn;
/**
* Are we connected?
*
* @var bool
*/
protected $connected = false;
/**
* Error container.
*
* @var array
*/
protected $errors = [];
/**
* Line break constant.
*/
const LE = "\r\n";
/**
* Simple static wrapper for all-in-one POP before SMTP.
*
* @param string $host The hostname to connect to
* @param int|bool $port The port number to connect to
* @param int|bool $timeout The timeout value
* @param string $username
* @param string $password
* @param int $debug_level
*
* @return bool
*/
public static function popBeforeSmtp($host, $port = false, $timeout = false, $username = '', $password = '', $debug_level = 0)
{
}
/**
* Authenticate with a POP3 server.
* A connect, login, disconnect sequence
* appropriate for POP-before SMTP authorisation.
*
* @param string $host The hostname to connect to
* @param int|bool $port The port number to connect to
* @param int|bool $timeout The timeout value
* @param string $username
* @param string $password
* @param int $debug_level
*
* @return bool
*/
public function authorise($host, $port = false, $timeout = false, $username = '', $password = '', $debug_level = 0)
{
}
/**
* Connect to a POP3 server.
*
* @param string $host
* @param int|bool $port
* @param int $tval
*
* @return bool
*/
public function connect($host, $port = false, $tval = 30)
{
}
/**
* Log in to the POP3 server.
* Does not support APOP (RFC 2828, 4949).
*
* @param string $username
* @param string $password
*
* @return bool
*/
public function login($username = '', $password = '')
{
}
/**
* Disconnect from the POP3 server.
*/
public function disconnect()
{
}
/**
* Get a response from the POP3 server.
*
* @param int $size The maximum number of bytes to retrieve
*
* @return string
*/
protected function getResponse($size = 128)
{
}
/**
* Send raw data to the POP3 server.
*
* @param string $string
*
* @return int
*/
protected function sendString($string)
{
}
/**
* Checks the POP3 server response.
* Looks for for +OK or -ERR.
*
* @param string $string
*
* @return bool
*/
protected function checkResponse($string)
{
}
/**
* Add an error to the internal error store.
* Also display debug output if it's enabled.
*
* @param string $error
*/
protected function setError($error)
{
}
/**
* Get an array of error messages, if any.
*
* @return array
*/
public function getErrors()
{
}
/**
* POP3 connection error handler.
*
* @param int $errno
* @param string $errstr
* @param string $errfile
* @param int $errline
*/
protected function catchWarning($errno, $errstr, $errfile, $errline)
{
}
}
}
namespace Ramsey\Uuid\Provider {
/**
* TimeProviderInterface provides functionality to get the time from a specific
* type of time provider
*/
interface TimeProviderInterface
{
/**
* Returns a timestamp array
*
* @return int[] Array guaranteed to contain `sec` and `usec` components of a timestamp
*/
public function currentTime();
}
/**
* NodeProviderInterface provides functionality to get the node ID (or host ID
* in the form of the system's MAC address) from a specific type of node provider
*/
interface NodeProviderInterface
{
/**
* Returns the system node ID
*
* @return string System node ID as a hexadecimal string
*/
public function getNode();
}
}
namespace Ramsey\Uuid\Provider\Node {
/**
* SystemNodeProvider provides functionality to get the system node ID (MAC
* address) using external system calls
*/
class SystemNodeProvider implements \Ramsey\Uuid\Provider\NodeProviderInterface
{
/**
* Returns the system node ID
*
* @return string System node ID as a hexadecimal string
*/
public function getNode()
{
}
/**
* Returns the network interface configuration for the system
*
* @codeCoverageIgnore
* @return string
*/
protected function getIfconfig()
{
}
}
/**
* RandomNodeProvider provides functionality to generate a random node ID, in
* the event that the node ID could not be obtained from the host system
*
* @link http://tools.ietf.org/html/rfc4122#section-4.5
*/
class RandomNodeProvider implements \Ramsey\Uuid\Provider\NodeProviderInterface
{
/**
* Returns the system node ID
*
* @return string System node ID as a hexadecimal string
*/
public function getNode()
{
}
}
/**
* FallbackNodeProvider attempts to gain the system host ID from an array of
* providers, falling back to the next in line in the event a host ID can not be
* obtained
*/
class FallbackNodeProvider implements \Ramsey\Uuid\Provider\NodeProviderInterface
{
/**
* Constructs a `FallbackNodeProvider` using an array of node providers
*
* @param NodeProviderInterface[] $providers Array of node providers
*/
public function __construct(array $providers)
{
}
/**
* Returns the system node ID by iterating over an array of node providers
* and returning the first non-empty value found
*
* @return string System node ID as a hexadecimal string
*/
public function getNode()
{
}
}
}
namespace Ramsey\Uuid\Provider\Time {
/**
* SystemTimeProvider uses built-in PHP functions to provide the time
*/
class SystemTimeProvider implements \Ramsey\Uuid\Provider\TimeProviderInterface
{
/**
* Returns a timestamp array
*
* @return int[] Array containing `sec` and `usec` components of a timestamp
*/
public function currentTime()
{
}
}
/**
* FixedTimeProvider uses an previously-generated timestamp to provide the time
*
* This provider allows the use of a previously-generated timestamp, such as one
* stored in a database, when creating version 1 UUIDs.
*/
class FixedTimeProvider implements \Ramsey\Uuid\Provider\TimeProviderInterface
{
/**
* Constructs a `FixedTimeProvider` using the provided `$timestamp`
*
* @param int[] Array containing `sec` and `usec` components of a timestamp
* @throws \InvalidArgumentException if the `$timestamp` does not contain `sec` or `usec` components
*/
public function __construct(array $timestamp)
{
}
/**
* Sets the `usec` component of the timestamp
*
* @param int $value The `usec` value to set
*/
public function setUsec($value)
{
}
/**
* Sets the `sec` component of the timestamp
*
* @param int $value The `sec` value to set
*/
public function setSec($value)
{
}
/**
* Returns a timestamp array
*
* @return int[] Array containing `sec` and `usec` components of a timestamp
*/
public function currentTime()
{
}
}
}
namespace Ramsey\Uuid {
/**
* UuidFactoryInterface defines common functionality all `UuidFactory` instances
* must implement
*/
interface UuidFactoryInterface
{
/**
* Generate a version 1 UUID from a host ID, sequence number, and the current time.
*
* @param int|string $node A 48-bit number representing the hardware address
* This number may be represented as an integer or a hexadecimal string.
* @param int $clockSeq A 14-bit number used to help avoid duplicates that
* could arise when the clock is set backwards in time or if the node ID
* changes.
* @return UuidInterface
*/
public function uuid1($node = null, $clockSeq = null);
/**
* Generate a version 3 UUID based on the MD5 hash of a namespace identifier
* (which is a UUID) and a name (which is a string).
*
* @param string $ns The UUID namespace in which to create the named UUID
* @param string $name The name to create a UUID for
* @return UuidInterface
*/
public function uuid3($ns, $name);
/**
* Generate a version 4 (random) UUID.
*
* @return UuidInterface
*/
public function uuid4();
/**
* Generate a version 5 UUID based on the SHA-1 hash of a namespace
* identifier (which is a UUID) and a name (which is a string).
*
* @param string $ns The UUID namespace in which to create the named UUID
* @param string $name The name to create a UUID for
* @return UuidInterface
*/
public function uuid5($ns, $name);
/**
* Creates a UUID from a byte string.
*
* @param string $bytes A 16-byte string representation of a UUID
* @return UuidInterface
*/
public function fromBytes($bytes);
/**
* Creates a UUID from the string standard representation
*
* @param string $uuid A string representation of a UUID
* @return UuidInterface
*/
public function fromString($uuid);
/**
* Creates a `Uuid` from an integer representation
*
* The integer representation may be a real integer, a string integer, or
* an integer representation supported by a configured number converter.
*
* @param mixed $integer The integer to use when creating a `Uuid` from an
* integer; may be of any type understood by the configured number converter
* @return UuidInterface
*/
public function fromInteger($integer);
}
class UuidFactory implements \Ramsey\Uuid\UuidFactoryInterface
{
/**
* Constructs a `UuidFactory` for creating `Ramsey\Uuid\UuidInterface` instances
*
* @param FeatureSet $features A set of features for use when creating UUIDs
*/
public function __construct(\Ramsey\Uuid\FeatureSet $features = null)
{
}
/**
* Returns the UUID coder-decoder used by this factory
*
* @return CodecInterface
*/
public function getCodec()
{
}
/**
* Sets the UUID coder-decoder used by this factory
*
* @param CodecInterface $codec
*/
public function setCodec(\Ramsey\Uuid\Codec\CodecInterface $codec)
{
}
/**
* Returns the system node ID provider used by this factory
*
* @return NodeProviderInterface
*/
public function getNodeProvider()
{
}
/**
* Returns the random UUID generator used by this factory
*
* @return RandomGeneratorInterface
*/
public function getRandomGenerator()
{
}
/**
* Returns the time-based UUID generator used by this factory
*
* @return TimeGeneratorInterface
*/
public function getTimeGenerator()
{
}
/**
* Sets the time-based UUID generator this factory will use to generate version 1 UUIDs
*
* @param TimeGeneratorInterface $generator
*/
public function setTimeGenerator(\Ramsey\Uuid\Generator\TimeGeneratorInterface $generator)
{
}
/**
* Returns the number converter used by this factory
*
* @return NumberConverterInterface
*/
public function getNumberConverter()
{
}
/**
* Sets the random UUID generator this factory will use to generate version 4 UUIDs
*
* @param RandomGeneratorInterface $generator
*/
public function setRandomGenerator(\Ramsey\Uuid\Generator\RandomGeneratorInterface $generator)
{
}
/**
* Sets the number converter this factory will use
*
* @param NumberConverterInterface $converter
*/
public function setNumberConverter(\Ramsey\Uuid\Converter\NumberConverterInterface $converter)
{
}
/**
* Returns the UUID builder this factory uses when creating `Uuid` instances
*
* @return UuidBuilderInterface $builder
*/
public function getUuidBuilder()
{
}
/**
* Sets the UUID builder this factory will use when creating `Uuid` instances
*
* @param UuidBuilderInterface $builder
*/
public function setUuidBuilder(\Ramsey\Uuid\Builder\UuidBuilderInterface $builder)
{
}
public function fromBytes($bytes)
{
}
public function fromString($uuid)
{
}
public function fromInteger($integer)
{
}
public function uuid1($node = null, $clockSeq = null)
{
}
public function uuid3($ns, $name)
{
}
public function uuid4()
{
}
public function uuid5($ns, $name)
{
}
/**
* Returns a `Uuid`
*
* Uses the configured builder and codec and the provided array of hexadecimal
* value UUID fields to construct a `Uuid` object.
*
* @param array $fields An array of fields from which to construct a UUID;
* see {@see \Ramsey\Uuid\UuidInterface::getFieldsHex()} for array structure.
* @return UuidInterface
*/
public function uuid(array $fields)
{
}
/**
* Returns a version 3 or 5 namespaced `Uuid`
*
* @param string|UuidInterface $ns The UUID namespace to use
* @param string $name The string to hash together with the namespace
* @param int $version The version of UUID to create (3 or 5)
* @param string $hashFunction The hash function to use when hashing together
* the namespace and name
* @return UuidInterface
*/
protected function uuidFromNsAndName($ns, $name, $version, $hashFunction)
{
}
/**
* Returns a `Uuid` created from `$hash` with the version field set to `$version`
* and the variant field set for RFC 4122
*
* @param string $hash The hash to use when creating the UUID
* @param int $version The UUID version to set for this hash (1, 3, 4, or 5)
* @return UuidInterface
*/
protected function uuidFromHashedName($hash, $version)
{
}
}
}
namespace Ramsey\Uuid\Generator {
/**
* RandomGeneratorInterface provides functionality to generate strings of random
* binary data
*/
interface RandomGeneratorInterface
{
/**
* Generates a string of random binary data of the specified length
*
* @param integer $length The number of bytes of random binary data to generate
* @return string A binary string
*/
public function generate($length);
}
/**
* RandomLibAdapter provides functionality to generate strings of random
* binary data using the ircmaxell/random-lib library
*
* @link https://packagist.org/packages/ircmaxell/random-lib
*/
class RandomLibAdapter implements \Ramsey\Uuid\Generator\RandomGeneratorInterface
{
/**
* Constructs a `RandomLibAdapter` using a `RandomLib\Generator`
*
* By default, if no `Generator` is passed in, this creates a medium-strength
* generator to use when generating random binary data.
*
* @param Generator $generator An ircmaxell/random-lib `Generator`
*/
public function __construct(\RandomLib\Generator $generator = null)
{
}
/**
* Generates a string of random binary data of the specified length
*
* @param integer $length The number of bytes of random binary data to generate
* @return string A binary string
*/
public function generate($length)
{
}
}
/**
* MtRandRandomGenerator provides functionality to generate strings of random
* binary data using the `mt_rand()` PHP function
*
* @link http://php.net/mt_rand
*/
class MtRandGenerator implements \Ramsey\Uuid\Generator\RandomGeneratorInterface
{
/**
* Generates a string of random binary data of the specified length
*
* @param integer $length The number of bytes of random binary data to generate
* @return string A binary string
*/
public function generate($length)
{
}
}
/**
* TimeGeneratorInterface provides functionality to generate strings of binary
* data for version 1 UUIDs based on a host ID, sequence number, and the current
* time
*/
interface TimeGeneratorInterface
{
/**
* Generate a version 1 UUID from a host ID, sequence number, and the current time
*
* @param int|string $node A 48-bit number representing the hardware address
* This number may be represented as an integer or a hexadecimal string.
* @param int $clockSeq A 14-bit number used to help avoid duplicates that
* could arise when the clock is set backwards in time or if the node ID
* changes.
* @return string A binary string
*/
public function generate($node = null, $clockSeq = null);
}
/**
* CombGenerator provides functionality to generate COMB (combined GUID/timestamp)
* sequential UUIDs
*
* @link https://en.wikipedia.org/wiki/Globally_unique_identifier#Sequential_algorithms
*/
class CombGenerator implements \Ramsey\Uuid\Generator\RandomGeneratorInterface
{
const TIMESTAMP_BYTES = 6;
/**
* Constructs a `CombGenerator` using a random-number generator and a number converter
*
* @param RandomGeneratorInterface $generator Random-number generator for the non-time part.
* @param NumberConverterInterface $numberConverter Instance of number converter.
*/
public function __construct(\Ramsey\Uuid\Generator\RandomGeneratorInterface $generator, \Ramsey\Uuid\Converter\NumberConverterInterface $numberConverter)
{
}
/**
* Generates a string of binary data of the specified length
*
* @param integer $length The number of bytes of random binary data to generate
* @return string A binary string
*/
public function generate($length)
{
}
}
/**
* PeclUuidTimeGenerator provides functionality to generate strings of binary
* data for version 1 UUIDs using the PECL UUID PHP extension
*
* @link https://pecl.php.net/package/uuid
*/
class PeclUuidTimeGenerator implements \Ramsey\Uuid\Generator\TimeGeneratorInterface
{
/**
* Generate a version 1 UUID using the PECL UUID extension
*
* @param int|string $node Not used in this context
* @param int $clockSeq Not used in this context
* @return string A binary string
*/
public function generate($node = null, $clockSeq = null)
{
}
}
/**
* SodiumRandomGenerator provides functionality to generate strings of random
* binary data using the PECL libsodium extension
*
* @link http://pecl.php.net/package/libsodium
* @link https://paragonie.com/book/pecl-libsodium
*/
class SodiumRandomGenerator implements \Ramsey\Uuid\Generator\RandomGeneratorInterface
{
/**
* Generates a string of random binary data of the specified length
*
* @param integer $length The number of bytes of random binary data to generate
* @return string A binary string
*/
public function generate($length)
{
}
}
/**
* DefaultTimeGenerator provides functionality to generate strings of binary
* data for version 1 UUIDs based on a host ID, sequence number, and the current
* time
*/
class DefaultTimeGenerator implements \Ramsey\Uuid\Generator\TimeGeneratorInterface
{
/**
* Constructs a `DefaultTimeGenerator` using a node provider, time converter,
* and time provider
*
* @param NodeProviderInterface $nodeProvider
* @param TimeConverterInterface $timeConverter
* @param TimeProviderInterface $timeProvider
*/
public function __construct(\Ramsey\Uuid\Provider\NodeProviderInterface $nodeProvider, \Ramsey\Uuid\Converter\TimeConverterInterface $timeConverter, \Ramsey\Uuid\Provider\TimeProviderInterface $timeProvider)
{
}
/**
* Generate a version 1 UUID from a host ID, sequence number, and the current time
*
* If $node is not given, we will attempt to obtain the local hardware
* address. If $clockSeq is given, it is used as the sequence number;
* otherwise a random 14-bit sequence number is chosen.
*
* @param int|string $node A 48-bit number representing the hardware address
* This number may be represented as an integer or a hexadecimal string.
* @param int $clockSeq A 14-bit number used to help avoid duplicates that
* could arise when the clock is set backwards in time or if the node ID
* changes.
* @return string A binary string
*/
public function generate($node = null, $clockSeq = null)
{
}
/**
* Uses the node provider given when constructing this instance to get
* the node ID (usually a MAC address)
*
* @param string|int $node A node value that may be used to override the node provider
* @return string Hexadecimal representation of the node ID
*/
protected function getValidNode($node)
{
}
}
/**
* RandomBytesGenerator provides functionality to generate strings of random
* binary data using `random_bytes()` function in PHP 7+ or paragonie/random_compat
*
* @link http://php.net/random_bytes
* @link https://github.com/paragonie/random_compat
*/
class RandomBytesGenerator implements \Ramsey\Uuid\Generator\RandomGeneratorInterface
{
/**
* Generates a string of random binary data of the specified length
*
* @param integer $length The number of bytes of random binary data to generate
* @return string A binary string
*/
public function generate($length)
{
}
}
/**
* OpenSslRandomGenerator provides functionality to generate strings of random
* binary data using the `openssl_random_pseudo_bytes()` PHP function
*
* The use of this generator requires PHP to be compiled using the
* `--with-openssl` option.
*
* @link http://php.net/openssl_random_pseudo_bytes
*/
class OpenSslGenerator implements \Ramsey\Uuid\Generator\RandomGeneratorInterface
{
/**
* Generates a string of random binary data of the specified length
*
* @param integer $length The number of bytes of random binary data to generate
* @return string A binary string
*/
public function generate($length)
{
}
}
/**
* A factory for retrieving a time generator, based on the environment
*/
class TimeGeneratorFactory
{
/**
* Constructs a `TimeGeneratorFactory` using a node provider, time converter,
* and time provider
*
* @param NodeProviderInterface $nodeProvider
* @param TimeConverterInterface $timeConverter
* @param TimeProviderInterface $timeProvider
*/
public function __construct(\Ramsey\Uuid\Provider\NodeProviderInterface $nodeProvider, \Ramsey\Uuid\Converter\TimeConverterInterface $timeConverter, \Ramsey\Uuid\Provider\TimeProviderInterface $timeProvider)
{
}
/**
* Returns a default time generator, based on the current environment
*
* @return TimeGeneratorInterface
*/
public function getGenerator()
{
}
}
/**
* PeclUuidRandomGenerator provides functionality to generate strings of random
* binary data using the PECL UUID PHP extension
*
* @link https://pecl.php.net/package/uuid
*/
class PeclUuidRandomGenerator implements \Ramsey\Uuid\Generator\RandomGeneratorInterface
{
/**
* Generates a string of random binary data of the specified length
*
* @param integer $length The number of bytes of random binary data to generate
* @return string A binary string
*/
public function generate($length)
{
}
}
/**
* A factory for retrieving a random generator, based on the environment
*/
class RandomGeneratorFactory
{
/**
* Returns a default random generator, based on the current environment
*
* @return RandomGeneratorInterface
*/
public static function getGenerator()
{
}
}
}
namespace Ramsey\Uuid\Builder {
/**
* UuidBuilderInterface builds instances UuidInterface
*/
interface UuidBuilderInterface
{
/**
* Builds an instance of a UuidInterface
*
* @param CodecInterface $codec The codec to use for building this UuidInterface instance
* @param array $fields An array of fields from which to construct a UuidInterface instance;
* see {@see \Ramsey\Uuid\UuidInterface::getFieldsHex()} for array structure.
* @return UuidInterface
*/
public function build(\Ramsey\Uuid\Codec\CodecInterface $codec, array $fields);
}
/**
* DefaultUuidBuilder is the default UUID builder for ramsey/uuid; it builds
* instances of Uuid objects
*/
class DefaultUuidBuilder implements \Ramsey\Uuid\Builder\UuidBuilderInterface
{
/**
* Constructs the DefaultUuidBuilder
*
* @param NumberConverterInterface $converter The number converter to use when constructing the Uuid
*/
public function __construct(\Ramsey\Uuid\Converter\NumberConverterInterface $converter)
{
}
/**
* Builds a Uuid
*
* @param CodecInterface $codec The codec to use for building this Uuid
* @param array $fields An array of fields from which to construct the Uuid;
* see {@see \Ramsey\Uuid\UuidInterface::getFieldsHex()} for array structure.
* @return Uuid
*/
public function build(\Ramsey\Uuid\Codec\CodecInterface $codec, array $fields)
{
}
}
/**
* DegradedUuidBuilder builds instances of DegradedUuid
*/
class DegradedUuidBuilder implements \Ramsey\Uuid\Builder\UuidBuilderInterface
{
/**
* Constructs the DegradedUuidBuilder
*
* @param NumberConverterInterface $converter The number converter to use when constructing the DegradedUuid
*/
public function __construct(\Ramsey\Uuid\Converter\NumberConverterInterface $converter)
{
}
/**
* Builds a DegradedUuid
*
* @param CodecInterface $codec The codec to use for building this DegradedUuid
* @param array $fields An array of fields from which to construct the DegradedUuid;
* see {@see \Ramsey\Uuid\UuidInterface::getFieldsHex()} for array structure.
* @return DegradedUuid
*/
public function build(\Ramsey\Uuid\Codec\CodecInterface $codec, array $fields)
{
}
}
}
namespace Ramsey\Uuid\Codec {
/**
* CodecInterface represents a UUID coder-decoder
*/
interface CodecInterface
{
/**
* Encodes a UuidInterface as a string representation of a UUID
*
* @param UuidInterface $uuid
* @return string Hexadecimal string representation of a UUID
*/
public function encode(\Ramsey\Uuid\UuidInterface $uuid);
/**
* Encodes a UuidInterface as a binary representation of a UUID
*
* @param UuidInterface $uuid
* @return string Binary string representation of a UUID
*/
public function encodeBinary(\Ramsey\Uuid\UuidInterface $uuid);
/**
* Decodes a string representation of a UUID into a UuidInterface object instance
*
* @param string $encodedUuid
* @return UuidInterface
*/
public function decode($encodedUuid);
/**
* Decodes a binary representation of a UUID into a UuidInterface object instance
*
* @param string $bytes
* @return UuidInterface
*/
public function decodeBytes($bytes);
}
/**
* StringCodec encodes and decodes RFC 4122 UUIDs
*
* @link http://tools.ietf.org/html/rfc4122
*/
class StringCodec implements \Ramsey\Uuid\Codec\CodecInterface
{
/**
* Constructs a StringCodec for use encoding and decoding UUIDs
*
* @param UuidBuilderInterface $builder The UUID builder to use when encoding UUIDs
*/
public function __construct(\Ramsey\Uuid\Builder\UuidBuilderInterface $builder)
{
}
/**
* Encodes a UuidInterface as a string representation of a UUID
*
* @param UuidInterface $uuid
* @return string Hexadecimal string representation of a UUID
*/
public function encode(\Ramsey\Uuid\UuidInterface $uuid)
{
}
/**
* Encodes a UuidInterface as a binary representation of a UUID
*
* @param UuidInterface $uuid
* @return string Binary string representation of a UUID
*/
public function encodeBinary(\Ramsey\Uuid\UuidInterface $uuid)
{
}
/**
* Decodes a string representation of a UUID into a UuidInterface object instance
*
* @param string $encodedUuid
* @return UuidInterface
*/
public function decode($encodedUuid)
{
}
/**
* Decodes a binary representation of a UUID into a UuidInterface object instance
*
* @param string $bytes
* @return UuidInterface
*/
public function decodeBytes($bytes)
{
}
/**
* Returns the UUID builder
*
* @return UuidBuilderInterface
*/
protected function getBuilder()
{
}
/**
* Returns an array of UUID components (the UUID exploded on its dashes)
*
* @param string $encodedUuid
* @return array
*/
protected function extractComponents($encodedUuid)
{
}
/**
* Returns the fields that make up this UUID
*
* @see \Ramsey\Uuid\UuidInterface::getFieldsHex()
* @param array $components
* @return array
*/
protected function getFields(array $components)
{
}
}
/**
* TimestampLastCombCodec encodes and decodes COMB UUIDs which have the timestamp as the first 48 bits.
* To be used with MySQL, PostgreSQL, Oracle.
*/
class TimestampFirstCombCodec extends \Ramsey\Uuid\Codec\StringCodec
{
/**
* Encodes a UuidInterface as a string representation of a timestamp first COMB UUID
*
* @param UuidInterface $uuid
*
* @return string Hexadecimal string representation of a GUID
*/
public function encode(\Ramsey\Uuid\UuidInterface $uuid)
{
}
/**
* Encodes a UuidInterface as a binary representation of timestamp first COMB UUID
*
* @param UuidInterface $uuid
*
* @return string Binary string representation of timestamp first COMB UUID
*/
public function encodeBinary(\Ramsey\Uuid\UuidInterface $uuid)
{
}
/**
* Decodes a string representation of timestamp first COMB UUID into a UuidInterface object instance
*
* @param string $encodedUuid
*
* @return UuidInterface
*/
public function decode($encodedUuid)
{
}
/**
* Decodes a binary representation of timestamp first COMB UUID into a UuidInterface object instance
*
* @param string $bytes
*
* @return UuidInterface
*/
public function decodeBytes($bytes)
{
}
/**
* Swaps the first 48 bits with the last 48 bits
*
* @param array $components An array of UUID components (the UUID exploded on its dashes)
*
* @return void
*/
protected function swapTimestampAndRandomBits(array &$components)
{
}
}
/**
* GuidStringCodec encodes and decodes globally unique identifiers (GUID)
*
* @link https://en.wikipedia.org/wiki/Globally_unique_identifier
*/
class GuidStringCodec extends \Ramsey\Uuid\Codec\StringCodec
{
/**
* Encodes a UuidInterface as a string representation of a GUID
*
* @param UuidInterface $uuid
* @return string Hexadecimal string representation of a GUID
*/
public function encode(\Ramsey\Uuid\UuidInterface $uuid)
{
}
/**
* Encodes a UuidInterface as a binary representation of a GUID
*
* @param UuidInterface $uuid
* @return string Binary string representation of a GUID
*/
public function encodeBinary(\Ramsey\Uuid\UuidInterface $uuid)
{
}
/**
* Decodes a string representation of a GUID into a UuidInterface object instance
*
* @param string $encodedUuid
* @return UuidInterface
*/
public function decode($encodedUuid)
{
}
/**
* Decodes a binary representation of a GUID into a UuidInterface object instance
*
* @param string $bytes
* @return UuidInterface
*/
public function decodeBytes($bytes)
{
}
/**
* Swaps fields to support GUID byte order
*
* @param array $components An array of UUID components (the UUID exploded on its dashes)
* @return void
*/
protected function swapFields(array &$components)
{
}
}
/**
* TimestampLastCombCodec encodes and decodes COMB UUIDs which have the timestamp as the last 48 bits.
* To be used with MSSQL.
*/
class TimestampLastCombCodec extends \Ramsey\Uuid\Codec\StringCodec
{
}
}
namespace Ramsey\Uuid {
/**
* Provides binary math utilities
*/
class BinaryUtils
{
/**
* Applies the RFC 4122 variant field to the `clock_seq_hi_and_reserved` field
*
* @param $clockSeqHi
* @return int The high field of the clock sequence multiplexed with the variant
* @link http://tools.ietf.org/html/rfc4122#section-4.1.1
*/
public static function applyVariant($clockSeqHi)
{
}
/**
* Applies the RFC 4122 version number to the `time_hi_and_version` field
*
* @param string $timeHi
* @param integer $version
* @return int The high field of the timestamp multiplexed with the version number
* @link http://tools.ietf.org/html/rfc4122#section-4.1.3
*/
public static function applyVersion($timeHi, $version)
{
}
}
/**
* UuidInterface defines common functionality for all universally unique
* identifiers (UUIDs)
*/
interface UuidInterface extends \JsonSerializable, \Serializable
{
/**
* Compares this UUID to the specified UUID.
*
* The first of two UUIDs is greater than the second if the most
* significant field in which the UUIDs differ is greater for the first
* UUID.
*
* * Q. What's the value of being able to sort UUIDs?
* * A. Use them as keys in a B-Tree or similar mapping.
*
* @param UuidInterface $other UUID to which this UUID is compared
* @return int -1, 0 or 1 as this UUID is less than, equal to, or greater than `$uuid`
*/
public function compareTo(\Ramsey\Uuid\UuidInterface $other);
/**
* Compares this object to the specified object.
*
* The result is true if and only if the argument is not null, is a UUID
* object, has the same variant, and contains the same value, bit for bit,
* as this UUID.
*
* @param object $other
* @return bool True if `$other` is equal to this UUID
*/
public function equals($other);
/**
* Returns the UUID as a 16-byte string (containing the six integer fields
* in big-endian byte order).
*
* @return string
*/
public function getBytes();
/**
* Returns the number converter to use for converting hex values to/from integers.
*
* @return NumberConverterInterface
*/
public function getNumberConverter();
/**
* Returns the hexadecimal value of the UUID.
*
* @return string
*/
public function getHex();
/**
* Returns an array of the fields of this UUID, with keys named according
* to the RFC 4122 names for the fields.
*
* * **time_low**: The low field of the timestamp, an unsigned 32-bit integer
* * **time_mid**: The middle field of the timestamp, an unsigned 16-bit integer
* * **time_hi_and_version**: The high field of the timestamp multiplexed with
* the version number, an unsigned 16-bit integer
* * **clock_seq_hi_and_reserved**: The high field of the clock sequence
* multiplexed with the variant, an unsigned 8-bit integer
* * **clock_seq_low**: The low field of the clock sequence, an unsigned
* 8-bit integer
* * **node**: The spatially unique node identifier, an unsigned 48-bit
* integer
*
* @return array The UUID fields represented as hexadecimal values
*/
public function getFieldsHex();
/**
* Returns the high field of the clock sequence multiplexed with the variant
* (bits 65-72 of the UUID).
*
* @return string Hexadecimal value of clock_seq_hi_and_reserved
*/
public function getClockSeqHiAndReservedHex();
/**
* Returns the low field of the clock sequence (bits 73-80 of the UUID).
*
* @return string Hexadecimal value of clock_seq_low
*/
public function getClockSeqLowHex();
/**
* Returns the clock sequence value associated with this UUID.
*
* @return string Hexadecimal value of clock sequence
*/
public function getClockSequenceHex();
/**
* Returns a PHP `DateTime` object representing the timestamp associated
* with this UUID.
*
* The timestamp value is only meaningful in a time-based UUID, which
* has version type 1. If this UUID is not a time-based UUID then
* this method throws `UnsupportedOperationException`.
*
* @return \DateTime A PHP DateTime representation of the date
* @throws UnsupportedOperationException If this UUID is not a version 1 UUID
*/
public function getDateTime();
/**
* Returns the integer value of the UUID, converted to an appropriate number
* representation.
*
* @return mixed Converted representation of the unsigned 128-bit integer value
*/
public function getInteger();
/**
* Returns the least significant 64 bits of this UUID's 128 bit value.
*
* @return string Hexadecimal value of least significant bits
*/
public function getLeastSignificantBitsHex();
/**
* Returns the most significant 64 bits of this UUID's 128 bit value.
*
* @return string Hexadecimal value of most significant bits
*/
public function getMostSignificantBitsHex();
/**
* Returns the node value associated with this UUID
*
* For UUID version 1, the node field consists of an IEEE 802 MAC
* address, usually the host address. For systems with multiple IEEE
* 802 addresses, any available one can be used. The lowest addressed
* octet (octet number 10) contains the global/local bit and the
* unicast/multicast bit, and is the first octet of the address
* transmitted on an 802.3 LAN.
*
* For systems with no IEEE address, a randomly or pseudo-randomly
* generated value may be used; see RFC 4122, Section 4.5. The
* multicast bit must be set in such addresses, in order that they
* will never conflict with addresses obtained from network cards.
*
* For UUID version 3 or 5, the node field is a 48-bit value constructed
* from a name as described in RFC 4122, Section 4.3.
*
* For UUID version 4, the node field is a randomly or pseudo-randomly
* generated 48-bit value as described in RFC 4122, Section 4.4.
*
* @return string Hexadecimal value of node
* @link http://tools.ietf.org/html/rfc4122#section-4.1.6
*/
public function getNodeHex();
/**
* Returns the high field of the timestamp multiplexed with the version
* number (bits 49-64 of the UUID).
*
* @return string Hexadecimal value of time_hi_and_version
*/
public function getTimeHiAndVersionHex();
/**
* Returns the low field of the timestamp (the first 32 bits of the UUID).
*
* @return string Hexadecimal value of time_low
*/
public function getTimeLowHex();
/**
* Returns the middle field of the timestamp (bits 33-48 of the UUID).
*
* @return string Hexadecimal value of time_mid
*/
public function getTimeMidHex();
/**
* Returns the timestamp value associated with this UUID.
*
* The 60 bit timestamp value is constructed from the time_low,
* time_mid, and time_hi fields of this UUID. The resulting
* timestamp is measured in 100-nanosecond units since midnight,
* October 15, 1582 UTC.
*
* The timestamp value is only meaningful in a time-based UUID, which
* has version type 1. If this UUID is not a time-based UUID then
* this method throws UnsupportedOperationException.
*
* @return string Hexadecimal value of the timestamp
* @throws UnsupportedOperationException If this UUID is not a version 1 UUID
* @link http://tools.ietf.org/html/rfc4122#section-4.1.4
*/
public function getTimestampHex();
/**
* Returns the string representation of the UUID as a URN.
*
* @return string
* @link http://en.wikipedia.org/wiki/Uniform_Resource_Name
*/
public function getUrn();
/**
* Returns the variant number associated with this UUID.
*
* The variant number describes the layout of the UUID. The variant
* number has the following meaning:
*
* * 0 - Reserved for NCS backward compatibility
* * 2 - The RFC 4122 variant (used by this class)
* * 6 - Reserved, Microsoft Corporation backward compatibility
* * 7 - Reserved for future definition
*
* @return int
* @link http://tools.ietf.org/html/rfc4122#section-4.1.1
*/
public function getVariant();
/**
* Returns the version number associated with this UUID.
*
* The version number describes how this UUID was generated and has the
* following meaning:
*
* * 1 - Time-based UUID
* * 2 - DCE security UUID
* * 3 - Name-based UUID hashed with MD5
* * 4 - Randomly generated UUID
* * 5 - Name-based UUID hashed with SHA-1
*
* Returns null if this UUID is not an RFC 4122 variant, since version
* is only meaningful for this variant.
*
* @return int|null
* @link http://tools.ietf.org/html/rfc4122#section-4.1.3
*/
public function getVersion();
/**
* Converts this UUID into a string representation.
*
* @return string
*/
public function toString();
}
/**
* FeatureSet detects and exposes available features in the current environment
* (32- or 64-bit, available dependencies, etc.)
*/
class FeatureSet
{
/**
* Constructs a `FeatureSet` for use by a `UuidFactory` to determine or set
* features available to the environment
*
* @param bool $useGuids Whether to build UUIDs using the `GuidStringCodec`
* @param bool $force32Bit Whether to force the use of 32-bit functionality
* (primarily for testing purposes)
* @param bool $forceNoBigNumber Whether to disable the use of moontoast/math
* `BigNumber` (primarily for testing purposes)
* @param bool $ignoreSystemNode Whether to disable attempts to check for
* the system host ID (primarily for testing purposes)
* @param bool $enablePecl Whether to enable the use of the `PeclUuidTimeGenerator`
* to generate version 1 UUIDs
*/
public function __construct($useGuids = false, $force32Bit = false, $forceNoBigNumber = false, $ignoreSystemNode = false, $enablePecl = false)
{
}
/**
* Returns the builder configured for this environment
*
* @return UuidBuilderInterface
*/
public function getBuilder()
{
}
/**
* Returns the UUID UUID coder-decoder configured for this environment
*
* @return CodecInterface
*/
public function getCodec()
{
}
/**
* Returns the system node ID provider configured for this environment
*
* @return NodeProviderInterface
*/
public function getNodeProvider()
{
}
/**
* Returns the number converter configured for this environment
*
* @return NumberConverterInterface
*/
public function getNumberConverter()
{
}
/**
* Returns the random UUID generator configured for this environment
*
* @return RandomGeneratorInterface
*/
public function getRandomGenerator()
{
}
/**
* Returns the time-based UUID generator configured for this environment
*
* @return TimeGeneratorInterface
*/
public function getTimeGenerator()
{
}
/**
* Sets the time provider for use in this environment
*
* @param TimeProviderInterface $timeProvider
*/
public function setTimeProvider(\Ramsey\Uuid\Provider\TimeProviderInterface $timeProvider)
{
}
/**
* Determines which UUID coder-decoder to use and returns the configured
* codec for this environment
*
* @param bool $useGuids Whether to build UUIDs using the `GuidStringCodec`
* @return CodecInterface
*/
protected function buildCodec($useGuids = false)
{
}
/**
* Determines which system node ID provider to use and returns the configured
* system node ID provider for this environment
*
* @return NodeProviderInterface
*/
protected function buildNodeProvider()
{
}
/**
* Determines which number converter to use and returns the configured
* number converter for this environment
*
* @return NumberConverterInterface
*/
protected function buildNumberConverter()
{
}
/**
* Determines which random UUID generator to use and returns the configured
* random UUID generator for this environment
*
* @return RandomGeneratorInterface
*/
protected function buildRandomGenerator()
{
}
/**
* Determines which time-based UUID generator to use and returns the configured
* time-based UUID generator for this environment
*
* @param TimeProviderInterface $timeProvider
* @return TimeGeneratorInterface
*/
protected function buildTimeGenerator(\Ramsey\Uuid\Provider\TimeProviderInterface $timeProvider)
{
}
/**
* Determines which time converter to use and returns the configured
* time converter for this environment
*
* @return TimeConverterInterface
*/
protected function buildTimeConverter()
{
}
/**
* Determines which UUID builder to use and returns the configured UUID
* builder for this environment
*
* @return UuidBuilderInterface
*/
protected function buildUuidBuilder()
{
}
/**
* Returns true if the system has `Moontoast\Math\BigNumber`
*
* @return bool
*/
protected function hasBigNumber()
{
}
/**
* Returns true if the system is 64-bit, false otherwise
*
* @return bool
*/
protected function is64BitSystem()
{
}
}
/**
* Represents a universally unique identifier (UUID), according to RFC 4122.
*
* This class provides immutable UUID objects (the Uuid class) and the static
* methods `uuid1()`, `uuid3()`, `uuid4()`, and `uuid5()` for generating version
* 1, 3, 4, and 5 UUIDs as specified in RFC 4122.
*
* If all you want is a unique ID, you should probably call `uuid1()` or `uuid4()`.
* Note that `uuid1()` may compromise privacy since it creates a UUID containing
* the computer’s network address. `uuid4()` creates a random UUID.
*
* @link http://tools.ietf.org/html/rfc4122
* @link http://en.wikipedia.org/wiki/Universally_unique_identifier
* @link http://docs.python.org/3/library/uuid.html
* @link http://docs.oracle.com/javase/6/docs/api/java/util/UUID.html
*/
class Uuid implements \Ramsey\Uuid\UuidInterface
{
/**
* When this namespace is specified, the name string is a fully-qualified domain name.
* @link http://tools.ietf.org/html/rfc4122#appendix-C
*/
const NAMESPACE_DNS = '6ba7b810-9dad-11d1-80b4-00c04fd430c8';
/**
* When this namespace is specified, the name string is a URL.
* @link http://tools.ietf.org/html/rfc4122#appendix-C
*/
const NAMESPACE_URL = '6ba7b811-9dad-11d1-80b4-00c04fd430c8';
/**
* When this namespace is specified, the name string is an ISO OID.
* @link http://tools.ietf.org/html/rfc4122#appendix-C
*/
const NAMESPACE_OID = '6ba7b812-9dad-11d1-80b4-00c04fd430c8';
/**
* When this namespace is specified, the name string is an X.500 DN in DER or a text output format.
* @link http://tools.ietf.org/html/rfc4122#appendix-C
*/
const NAMESPACE_X500 = '6ba7b814-9dad-11d1-80b4-00c04fd430c8';
/**
* The nil UUID is special form of UUID that is specified to have all 128 bits set to zero.
* @link http://tools.ietf.org/html/rfc4122#section-4.1.7
*/
const NIL = '00000000-0000-0000-0000-000000000000';
/**
* Reserved for NCS compatibility.
* @link http://tools.ietf.org/html/rfc4122#section-4.1.1
*/
const RESERVED_NCS = 0;
/**
* Specifies the UUID layout given in RFC 4122.
* @link http://tools.ietf.org/html/rfc4122#section-4.1.1
*/
const RFC_4122 = 2;
/**
* Reserved for Microsoft compatibility.
* @link http://tools.ietf.org/html/rfc4122#section-4.1.1
*/
const RESERVED_MICROSOFT = 6;
/**
* Reserved for future definition.
* @link http://tools.ietf.org/html/rfc4122#section-4.1.1
*/
const RESERVED_FUTURE = 7;
/**
* Regular expression pattern for matching a valid UUID of any variant.
*/
const VALID_PATTERN = '^[0-9A-Fa-f]{8}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{4}-[0-9A-Fa-f]{12}$';
/**
* The codec to use when encoding or decoding UUID strings.
* @var CodecInterface
*/
protected $codec;
/**
* The fields that make up this UUID.
*
* This is initialized to the nil value.
*
* @var array
* @see UuidInterface::getFieldsHex()
*/
protected $fields = array('time_low' => '00000000', 'time_mid' => '0000', 'time_hi_and_version' => '0000', 'clock_seq_hi_and_reserved' => '00', 'clock_seq_low' => '00', 'node' => '000000000000');
/**
* The number converter to use for converting hex values to/from integers.
* @var NumberConverterInterface
*/
protected $converter;
/**
* Creates a universally unique identifier (UUID) from an array of fields.
*
* Unless you're making advanced use of this library to generate identifiers
* that deviate from RFC 4122, you probably do not want to instantiate a
* UUID directly. Use the static methods, instead:
*
* ```
* use Ramsey\Uuid\Uuid;
*
* $timeBasedUuid = Uuid::uuid1();
* $namespaceMd5Uuid = Uuid::uuid3(Uuid::NAMESPACE_URL, 'http://php.net/');
* $randomUuid = Uuid::uuid4();
* $namespaceSha1Uuid = Uuid::uuid5(Uuid::NAMESPACE_URL, 'http://php.net/');
* ```
*
* @param array $fields An array of fields from which to construct a UUID;
* see {@see \Ramsey\Uuid\UuidInterface::getFieldsHex()} for array structure.
* @param NumberConverterInterface $converter The number converter to use
* for converting hex values to/from integers.
* @param CodecInterface $codec The codec to use when encoding or decoding
* UUID strings.
*/
public function __construct(array $fields, \Ramsey\Uuid\Converter\NumberConverterInterface $converter, \Ramsey\Uuid\Codec\CodecInterface $codec)
{
}
/**
* Converts this UUID object to a string when the object is used in any
* string context.
*
* @return string
* @link http://www.php.net/manual/en/language.oop5.magic.php#object.tostring
*/
public function __toString()
{
}
/**
* Converts this UUID object to a string when the object is serialized
* with `json_encode()`
*
* @return string
* @link http://php.net/manual/en/class.jsonserializable.php
*/
public function jsonSerialize()
{
}
/**
* Converts this UUID object to a string when the object is serialized
* with `serialize()`
*
* @return string
* @link http://php.net/manual/en/class.serializable.php
*/
public function serialize()
{
}
/**
* Re-constructs the object from its serialized form.
*
* @param string $serialized
* @link http://php.net/manual/en/class.serializable.php
*/
public function unserialize($serialized)
{
}
public function compareTo(\Ramsey\Uuid\UuidInterface $other)
{
}
public function equals($other)
{
}
public function getBytes()
{
}
/**
* Returns the high field of the clock sequence multiplexed with the variant
* (bits 65-72 of the UUID).
*
* @return int Unsigned 8-bit integer value of clock_seq_hi_and_reserved
*/
public function getClockSeqHiAndReserved()
{
}
public function getClockSeqHiAndReservedHex()
{
}
/**
* Returns the low field of the clock sequence (bits 73-80 of the UUID).
*
* @return int Unsigned 8-bit integer value of clock_seq_low
*/
public function getClockSeqLow()
{
}
public function getClockSeqLowHex()
{
}
/**
* Returns the clock sequence value associated with this UUID.
*
* For UUID version 1, the clock sequence is used to help avoid
* duplicates that could arise when the clock is set backwards in time
* or if the node ID changes.
*
* For UUID version 3 or 5, the clock sequence is a 14-bit value
* constructed from a name as described in RFC 4122, Section 4.3.
*
* For UUID version 4, clock sequence is a randomly or pseudo-randomly
* generated 14-bit value as described in RFC 4122, Section 4.4.
*
* @return int Unsigned 14-bit integer value of clock sequence
* @link http://tools.ietf.org/html/rfc4122#section-4.1.5
*/
public function getClockSequence()
{
}
public function getClockSequenceHex()
{
}
public function getNumberConverter()
{
}
public function getDateTime()
{
}
/**
* Returns an array of the fields of this UUID, with keys named according
* to the RFC 4122 names for the fields.
*
* * **time_low**: The low field of the timestamp, an unsigned 32-bit integer
* * **time_mid**: The middle field of the timestamp, an unsigned 16-bit integer
* * **time_hi_and_version**: The high field of the timestamp multiplexed with
* the version number, an unsigned 16-bit integer
* * **clock_seq_hi_and_reserved**: The high field of the clock sequence
* multiplexed with the variant, an unsigned 8-bit integer
* * **clock_seq_low**: The low field of the clock sequence, an unsigned
* 8-bit integer
* * **node**: The spatially unique node identifier, an unsigned 48-bit
* integer
*
* @return array The UUID fields represented as integer values
* @link http://tools.ietf.org/html/rfc4122#section-4.1.2
*/
public function getFields()
{
}
public function getFieldsHex()
{
}
public function getHex()
{
}
public function getInteger()
{
}
/**
* Returns the least significant 64 bits of this UUID's 128 bit value.
*
* @return mixed Converted representation of the unsigned 64-bit integer value
*/
public function getLeastSignificantBits()
{
}
public function getLeastSignificantBitsHex()
{
}
/**
* Returns the most significant 64 bits of this UUID's 128 bit value.
*
* @return mixed Converted representation of the unsigned 64-bit integer value
*/
public function getMostSignificantBits()
{
}
public function getMostSignificantBitsHex()
{
}
/**
* Returns the node value associated with this UUID
*
* For UUID version 1, the node field consists of an IEEE 802 MAC
* address, usually the host address. For systems with multiple IEEE
* 802 addresses, any available one can be used. The lowest addressed
* octet (octet number 10) contains the global/local bit and the
* unicast/multicast bit, and is the first octet of the address
* transmitted on an 802.3 LAN.
*
* For systems with no IEEE address, a randomly or pseudo-randomly
* generated value may be used; see RFC 4122, Section 4.5. The
* multicast bit must be set in such addresses, in order that they
* will never conflict with addresses obtained from network cards.
*
* For UUID version 3 or 5, the node field is a 48-bit value constructed
* from a name as described in RFC 4122, Section 4.3.
*
* For UUID version 4, the node field is a randomly or pseudo-randomly
* generated 48-bit value as described in RFC 4122, Section 4.4.
*
* @return int Unsigned 48-bit integer value of node
* @link http://tools.ietf.org/html/rfc4122#section-4.1.6
*/
public function getNode()
{
}
public function getNodeHex()
{
}
/**
* Returns the high field of the timestamp multiplexed with the version
* number (bits 49-64 of the UUID).
*
* @return int Unsigned 16-bit integer value of time_hi_and_version
*/
public function getTimeHiAndVersion()
{
}
public function getTimeHiAndVersionHex()
{
}
/**
* Returns the low field of the timestamp (the first 32 bits of the UUID).
*
* @return int Unsigned 32-bit integer value of time_low
*/
public function getTimeLow()
{
}
public function getTimeLowHex()
{
}
/**
* Returns the middle field of the timestamp (bits 33-48 of the UUID).
*
* @return int Unsigned 16-bit integer value of time_mid
*/
public function getTimeMid()
{
}
public function getTimeMidHex()
{
}
/**
* Returns the timestamp value associated with this UUID.
*
* The 60 bit timestamp value is constructed from the time_low,
* time_mid, and time_hi fields of this UUID. The resulting
* timestamp is measured in 100-nanosecond units since midnight,
* October 15, 1582 UTC.
*
* The timestamp value is only meaningful in a time-based UUID, which
* has version type 1. If this UUID is not a time-based UUID then
* this method throws UnsupportedOperationException.
*
* @return int Unsigned 60-bit integer value of the timestamp
* @throws UnsupportedOperationException If this UUID is not a version 1 UUID
* @link http://tools.ietf.org/html/rfc4122#section-4.1.4
*/
public function getTimestamp()
{
}
public function getTimestampHex()
{
}
public function getUrn()
{
}
public function getVariant()
{
}
public function getVersion()
{
}
public function toString()
{
}
/**
* Returns the currently set factory used to create UUIDs.
*
* @return UuidFactoryInterface
*/
public static function getFactory()
{
}
/**
* Sets the factory used to create UUIDs.
*
* @param UuidFactoryInterface $factory
*/
public static function setFactory(\Ramsey\Uuid\UuidFactoryInterface $factory)
{
}
/**
* Creates a UUID from a byte string.
*
* @param string $bytes
* @return UuidInterface
*/
public static function fromBytes($bytes)
{
}
/**
* Creates a UUID from the string standard representation.
*
* @param string $name A string that specifies a UUID
* @return UuidInterface
*/
public static function fromString($name)
{
}
/**
* Creates a UUID from a 128-bit integer string.
*
* @param string $integer String representation of 128-bit integer
* @return UuidInterface
*/
public static function fromInteger($integer)
{
}
/**
* Check if a string is a valid UUID.
*
* @param string $uuid The string UUID to test
* @return boolean
*/
public static function isValid($uuid)
{
}
/**
* Generate a version 1 UUID from a host ID, sequence number, and the current time.
*
* @param int|string $node A 48-bit number representing the hardware address
* This number may be represented as an integer or a hexadecimal string.
* @param int $clockSeq A 14-bit number used to help avoid duplicates that
* could arise when the clock is set backwards in time or if the node ID
* changes.
* @return UuidInterface
*/
public static function uuid1($node = null, $clockSeq = null)
{
}
/**
* Generate a version 3 UUID based on the MD5 hash of a namespace identifier
* (which is a UUID) and a name (which is a string).
*
* @param string $ns The UUID namespace in which to create the named UUID
* @param string $name The name to create a UUID for
* @return UuidInterface
*/
public static function uuid3($ns, $name)
{
}
/**
* Generate a version 4 (random) UUID.
*
* @return UuidInterface
*/
public static function uuid4()
{
}
/**
* Generate a version 5 UUID based on the SHA-1 hash of a namespace
* identifier (which is a UUID) and a name (which is a string).
*
* @param string $ns The UUID namespace in which to create the named UUID
* @param string $name The name to create a UUID for
* @return UuidInterface
*/
public static function uuid5($ns, $name)
{
}
}
/**
* DegradedUuid represents an RFC 4122 UUID on 32-bit systems
*
* @see Uuid
*/
class DegradedUuid extends \Ramsey\Uuid\Uuid
{
public function getDateTime()
{
}
/**
* For degraded UUIDs, throws an `UnsatisfiedDependencyException` when
* called on a 32-bit system
*
* @throws UnsatisfiedDependencyException if called on a 32-bit system
*/
public function getFields()
{
}
/**
* For degraded UUIDs, throws an `UnsatisfiedDependencyException` when
* called on a 32-bit system
*
* @throws UnsatisfiedDependencyException if called on a 32-bit system
*/
public function getNode()
{
}
/**
* For degraded UUIDs, throws an `UnsatisfiedDependencyException` when
* called on a 32-bit system
*
* @throws UnsatisfiedDependencyException if called on a 32-bit system
*/
public function getTimeLow()
{
}
/**
* For degraded UUIDs, throws an `UnsatisfiedDependencyException` when
* called on a 32-bit system
*
* @throws UnsatisfiedDependencyException if called on a 32-bit system
* @throws UnsupportedOperationException If this UUID is not a version 1 UUID
*/
public function getTimestamp()
{
}
}
}
namespace Ramsey\Uuid\Exception {
/**
* Thrown to indicate that the requested operation is not supported.
*/
class UnsupportedOperationException extends \RuntimeException
{
}
/**
* Thrown to indicate that the requested operation has dependencies that have not
* been satisfied.
*/
class UnsatisfiedDependencyException extends \RuntimeException
{
}
}
namespace Ramsey\Uuid\Converter {
/**
* NumberConverterInterface converts UUIDs from hexadecimal characters into
* representations of integers and vice versa
*/
interface NumberConverterInterface
{
/**
* Converts a hexadecimal number into an integer representation of the number
*
* The integer representation returned may be an object or a string
* representation of the integer, depending on the implementation.
*
* @param string $hex The hexadecimal string representation to convert
* @return mixed
*/
public function fromHex($hex);
/**
* Converts an integer representation into a hexadecimal string representation
* of the number
*
* @param mixed $integer An integer representation to convert; this may be
* a true integer, a string integer, or a object representation that
* this converter can understand
* @return string Hexadecimal string
*/
public function toHex($integer);
}
}
namespace Ramsey\Uuid\Converter\Number {
/**
* BigNumberConverter converts UUIDs from hexadecimal characters into
* moontoast/math `BigNumber` representations of integers and vice versa
*/
class BigNumberConverter implements \Ramsey\Uuid\Converter\NumberConverterInterface
{
/**
* Converts a hexadecimal number into a `Moontoast\Math\BigNumber` representation
*
* @param string $hex The hexadecimal string representation to convert
* @return BigNumber
*/
public function fromHex($hex)
{
}
/**
* Converts an integer or `Moontoast\Math\BigNumber` integer representation
* into a hexadecimal string representation
*
* @param int|string|BigNumber $integer An integer or `Moontoast\Math\BigNumber`
* @return string Hexadecimal string
*/
public function toHex($integer)
{
}
}
/**
* DegradedNumberConverter throws `UnsatisfiedDependencyException` exceptions
* if attempting to use number conversion functionality in an environment that
* does not support large integers (i.e. when moontoast/math is not available)
*/
class DegradedNumberConverter implements \Ramsey\Uuid\Converter\NumberConverterInterface
{
/**
* Throws an `UnsatisfiedDependencyException`
*
* @param string $hex The hexadecimal string representation to convert
* @return void
* @throws UnsatisfiedDependencyException
*/
public function fromHex($hex)
{
}
/**
* Throws an `UnsatisfiedDependencyException`
*
* @param mixed $integer An integer representation to convert
* @return void
* @throws UnsatisfiedDependencyException
*/
public function toHex($integer)
{
}
}
}
namespace Ramsey\Uuid\Converter {
/**
* TimeConverterInterface provides facilities for converting parts of time into
* representations that may be used in UUIDs
*/
interface TimeConverterInterface
{
/**
* Uses the provided seconds and micro-seconds to calculate the time_low,
* time_mid, and time_high fields used by RFC 4122 version 1 UUIDs
*
* @param string $seconds
* @param string $microSeconds
* @return string[] An array guaranteed to contain `low`, `mid`, and `high` keys
* @link http://tools.ietf.org/html/rfc4122#section-4.2.2
*/
public function calculateTime($seconds, $microSeconds);
}
}
namespace Ramsey\Uuid\Converter\Time {
/**
* DegradedTimeConverter throws `UnsatisfiedDependencyException` exceptions
* if attempting to use time conversion functionality in an environment that
* does not support large integers (i.e. when moontoast/math is not available)
*/
class DegradedTimeConverter implements \Ramsey\Uuid\Converter\TimeConverterInterface
{
/**
* Throws an `UnsatisfiedDependencyException`
*
* @param string $seconds
* @param string $microSeconds
* @return void
* @throws UnsatisfiedDependencyException
*/
public function calculateTime($seconds, $microSeconds)
{
}
}
/**
* PhpTimeConverter uses built-in PHP functions and standard math operations
* available to the PHP programming language to provide facilities for
* converting parts of time into representations that may be used in UUIDs
*/
class PhpTimeConverter implements \Ramsey\Uuid\Converter\TimeConverterInterface
{
/**
* Uses the provided seconds and micro-seconds to calculate the time_low,
* time_mid, and time_high fields used by RFC 4122 version 1 UUIDs
*
* @param string $seconds
* @param string $microSeconds
* @return string[] An array containing `low`, `mid`, and `high` keys
* @link http://tools.ietf.org/html/rfc4122#section-4.2.2
*/
public function calculateTime($seconds, $microSeconds)
{
}
}
/**
* BigNumberTimeConverter uses the moontoast/math library's `BigNumber` to
* provide facilities for converting parts of time into representations that may
* be used in UUIDs
*/
class BigNumberTimeConverter implements \Ramsey\Uuid\Converter\TimeConverterInterface
{
/**
* Uses the provided seconds and micro-seconds to calculate the time_low,
* time_mid, and time_high fields used by RFC 4122 version 1 UUIDs
*
* @param string $seconds
* @param string $microSeconds
* @return string[] An array containing `low`, `mid`, and `high` keys
* @link http://tools.ietf.org/html/rfc4122#section-4.2.2
*/
public function calculateTime($seconds, $microSeconds)
{
}
}
}
namespace net\authorize\util {
class ANetSensitiveFields
{
public static function getSensitiveStringRegexes()
{
}
public static function getSensitiveXmlTags()
{
}
}
/**
* A class defining helpers
*
* @package AuthorizeNet
* @subpackage net\authorize\util
*/
class Helpers
{
/**
* @return string current date-time
*/
public static function now()
{
}
}
//to do: use Doctrine\Common\Annotations\AnnotationRegistry::registerAutoloadNamespace to auto load classes
class SensitiveTag
{
/**
* @Type("string")
* @SerializedName("tagName")
*/
public $tagName;
/**
* @Type("string")
* @SerializedName("pattern")
*/
public $pattern;
/**
* @Type("string")
* @SerializedName("replacement")
*/
public $replacement;
/**
* @Type("boolean")
* @SerializedName("disableMask")
*/
public $disableMask;
public function __construct($tagName, $pattern = "", $replace = "", $disableMask = false)
{
}
}
class LogFactory
{
public static function getLog($classType)
{
}
}
//to do: use Doctrine\Common\Annotations\AnnotationRegistry::registerAutoloadNamespace to auto load classes
class SensitiveDataConfigType
{
/**
* @Type("array<net\authorize\util\SensitiveTag>")
* @SerializedName("sensitiveTags")
*/
public $sensitiveTags;
/**
* @Type("array<string>")
* @SerializedName("sensitiveStringRegexes")
*/
public $sensitiveStringRegexes;
}
/**
* A class to implement logging.
*
* @package AuthorizeNet
* @subpackage net\authorize\util
*/
class Log
{
public function debug($logMessage, $flags = FILE_APPEND)
{
}
public function info($logMessage, $flags = FILE_APPEND)
{
}
public function warn($logMessage, $flags = FILE_APPEND)
{
}
public function error($logMessage, $flags = FILE_APPEND)
{
}
public function debugFormat($format, $args = array(), $flags = FILE_APPEND)
{
}
public function infoFormat($format, $args = array(), $flags = FILE_APPEND)
{
}
public function warnFormat($format, $args = array(), $flags = FILE_APPEND)
{
}
public function errorFormat($format, $args = array(), $flags = FILE_APPEND)
{
}
/**
* @param string $logLevel
* possible values = ANET_LOG_DEBUG, ANET_LOG_INFO, ANET_LOG_WARN, ANET_LOG_ERROR
*/
public function setLogLevel($logLevel)
{
}
/**
* @return string
*/
public function getLogLevel()
{
}
/**
* @param string $logFile
*/
public function setLogFile($logFile)
{
}
/**
* @return string
*/
public function getLogFile()
{
}
public function __construct()
{
}
}
}
namespace net\authorize\api\controller {
class ARBGetSubscriptionController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetCustomerPaymentProfileListController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class MobileDeviceRegistrationController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class CreateCustomerProfileTransactionController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class CreateCustomerProfileFromTransactionController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class DeleteCustomerProfileController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetCustomerProfileIdsController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class DecryptPaymentDataController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetMerchantDetailsController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class UpdateCustomerProfileController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetCustomerProfileController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class DeleteCustomerShippingAddressController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetHostedPaymentPageController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class ARBGetSubscriptionListController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class IsAliveController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetAUJobDetailsController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class CreateCustomerPaymentProfileController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class DeleteCustomerPaymentProfileController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetTransactionDetailsController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetTransactionListController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class SecurePaymentContainerController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class ARBUpdateSubscriptionController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class LogoutController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class MobileDeviceLoginController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class UpdateSplitTenderGroupController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class ARBCreateSubscriptionController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetAUJobSummaryController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class CreateTransactionController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class CreateCustomerShippingAddressController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetSettledBatchListController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class ARBGetSubscriptionStatusController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetCustomerShippingAddressController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetTransactionListForCustomerController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class CreateCustomerProfileController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetCustomerPaymentProfileController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class ValidateCustomerPaymentProfileController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class SendCustomerTransactionReceiptController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetHostedProfilePageController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class UpdateCustomerPaymentProfileController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetBatchStatisticsController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class GetUnsettledTransactionListController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class UpdateCustomerShippingAddressController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class UpdateHeldTransactionController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
class ARBCancelSubscriptionController extends \net\authorize\api\controller\base\ApiOperationBase
{
public function __construct(\net\authorize\api\contract\v1\AnetApiRequestType $request)
{
}
protected function validateRequest()
{
}
}
}
namespace net\authorize\api\contract\v1 {
/**
* Class representing ANetApiResponseType
*
*
* XSD Type: ANetApiResponse
*/
class ANetApiResponseType
{
/**
* Gets as refId
*
* @return string
*/
public function getRefId()
{
}
/**
* Sets a new refId
*
* @param string $refId
* @return self
*/
public function setRefId($refId)
{
}
/**
* Gets as messages
*
* @return \net\authorize\api\contract\v1\MessagesType
*/
public function getMessages()
{
}
/**
* Sets a new messages
*
* @param \net\authorize\api\contract\v1\MessagesType $messages
* @return self
*/
public function setMessages(\net\authorize\api\contract\v1\MessagesType $messages)
{
}
/**
* Gets as sessionToken
*
* @return string
*/
public function getSessionToken()
{
}
/**
* Sets a new sessionToken
*
* @param string $sessionToken
* @return self
*/
public function setSessionToken($sessionToken)
{
}
}
/**
* Class representing IsAliveResponse
*/
class IsAliveResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing ANetApiRequestType
*
*
* XSD Type: ANetApiRequest
*/
class ANetApiRequestType
{
/**
* Gets as merchantAuthentication
*
* @return \net\authorize\api\contract\v1\MerchantAuthenticationType
*/
public function getMerchantAuthentication()
{
}
/**
* Sets a new merchantAuthentication
*
* @param \net\authorize\api\contract\v1\MerchantAuthenticationType
* $merchantAuthentication
* @return self
*/
public function setMerchantAuthentication(\net\authorize\api\contract\v1\MerchantAuthenticationType $merchantAuthentication)
{
}
/**
* Gets as clientId
*
* @return string
*/
public function getClientId()
{
}
/**
* Sets a new clientId
*
* @param string $clientId
* @return self
*/
public function setClientId($clientId)
{
}
/**
* Gets as refId
*
* @return string
*/
public function getRefId()
{
}
/**
* Sets a new refId
*
* @param string $refId
* @return self
*/
public function setRefId($refId)
{
}
}
/**
* Class representing GetTransactionListRequest
*/
class GetTransactionListRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as batchId
*
* @return string
*/
public function getBatchId()
{
}
/**
* Sets a new batchId
*
* @param string $batchId
* @return self
*/
public function setBatchId($batchId)
{
}
/**
* Gets as sorting
*
* @return \net\authorize\api\contract\v1\TransactionListSortingType
*/
public function getSorting()
{
}
/**
* Sets a new sorting
*
* @param \net\authorize\api\contract\v1\TransactionListSortingType $sorting
* @return self
*/
public function setSorting(\net\authorize\api\contract\v1\TransactionListSortingType $sorting)
{
}
/**
* Gets as paging
*
* @return \net\authorize\api\contract\v1\PagingType
*/
public function getPaging()
{
}
/**
* Sets a new paging
*
* @param \net\authorize\api\contract\v1\PagingType $paging
* @return self
*/
public function setPaging(\net\authorize\api\contract\v1\PagingType $paging)
{
}
}
/**
* Class representing GetHostedPaymentPageRequest
*/
class GetHostedPaymentPageRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as transactionRequest
*
* @return \net\authorize\api\contract\v1\TransactionRequestType
*/
public function getTransactionRequest()
{
}
/**
* Sets a new transactionRequest
*
* @param \net\authorize\api\contract\v1\TransactionRequestType $transactionRequest
* @return self
*/
public function setTransactionRequest(\net\authorize\api\contract\v1\TransactionRequestType $transactionRequest)
{
}
/**
* Adds as setting
*
* Allowed values for settingName are: hostedPaymentIFrameCommunicatorUrl,
* hostedPaymentButtonOptions, hostedPaymentReturnOptions,
* hostedPaymentOrderOptions, hostedPaymentPaymentOptions,
* hostedPaymentBillingAddressOptions, hostedPaymentShippingAddressOptions,
* hostedPaymentSecurityOptions, hostedPaymentCustomerOptions,
* hostedPaymentStyleOptions
*
* @return self
* @param \net\authorize\api\contract\v1\SettingType $setting
*/
public function addToHostedPaymentSettings(\net\authorize\api\contract\v1\SettingType $setting)
{
}
/**
* isset hostedPaymentSettings
*
* Allowed values for settingName are: hostedPaymentIFrameCommunicatorUrl,
* hostedPaymentButtonOptions, hostedPaymentReturnOptions,
* hostedPaymentOrderOptions, hostedPaymentPaymentOptions,
* hostedPaymentBillingAddressOptions, hostedPaymentShippingAddressOptions,
* hostedPaymentSecurityOptions, hostedPaymentCustomerOptions,
* hostedPaymentStyleOptions
*
* @param scalar $index
* @return boolean
*/
public function issetHostedPaymentSettings($index)
{
}
/**
* unset hostedPaymentSettings
*
* Allowed values for settingName are: hostedPaymentIFrameCommunicatorUrl,
* hostedPaymentButtonOptions, hostedPaymentReturnOptions,
* hostedPaymentOrderOptions, hostedPaymentPaymentOptions,
* hostedPaymentBillingAddressOptions, hostedPaymentShippingAddressOptions,
* hostedPaymentSecurityOptions, hostedPaymentCustomerOptions,
* hostedPaymentStyleOptions
*
* @param scalar $index
* @return void
*/
public function unsetHostedPaymentSettings($index)
{
}
/**
* Gets as hostedPaymentSettings
*
* Allowed values for settingName are: hostedPaymentIFrameCommunicatorUrl,
* hostedPaymentButtonOptions, hostedPaymentReturnOptions,
* hostedPaymentOrderOptions, hostedPaymentPaymentOptions,
* hostedPaymentBillingAddressOptions, hostedPaymentShippingAddressOptions,
* hostedPaymentSecurityOptions, hostedPaymentCustomerOptions,
* hostedPaymentStyleOptions
*
* @return \net\authorize\api\contract\v1\SettingType[]
*/
public function getHostedPaymentSettings()
{
}
/**
* Sets a new hostedPaymentSettings
*
* Allowed values for settingName are: hostedPaymentIFrameCommunicatorUrl,
* hostedPaymentButtonOptions, hostedPaymentReturnOptions,
* hostedPaymentOrderOptions, hostedPaymentPaymentOptions,
* hostedPaymentBillingAddressOptions, hostedPaymentShippingAddressOptions,
* hostedPaymentSecurityOptions, hostedPaymentCustomerOptions,
* hostedPaymentStyleOptions
*
* @param \net\authorize\api\contract\v1\SettingType[] $hostedPaymentSettings
* @return self
*/
public function setHostedPaymentSettings(array $hostedPaymentSettings)
{
}
}
/**
* Class representing GetBatchStatisticsResponse
*/
class GetBatchStatisticsResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as batch
*
* @return \net\authorize\api\contract\v1\BatchDetailsType
*/
public function getBatch()
{
}
/**
* Sets a new batch
*
* @param \net\authorize\api\contract\v1\BatchDetailsType $batch
* @return self
*/
public function setBatch(\net\authorize\api\contract\v1\BatchDetailsType $batch)
{
}
}
/**
* Class representing ListOfAUDetailsType
*
*
* XSD Type: ListOfAUDetailsType
*/
class ListOfAUDetailsType
{
/**
* Adds as auUpdate
*
* @return self
* @param \net\authorize\api\contract\v1\AuUpdateType $auUpdate
*/
public function addToAuUpdate(\net\authorize\api\contract\v1\AuUpdateType $auUpdate)
{
}
/**
* isset auUpdate
*
* @param scalar $index
* @return boolean
*/
public function issetAuUpdate($index)
{
}
/**
* unset auUpdate
*
* @param scalar $index
* @return void
*/
public function unsetAuUpdate($index)
{
}
/**
* Gets as auUpdate
*
* @return \net\authorize\api\contract\v1\AuUpdateType[]
*/
public function getAuUpdate()
{
}
/**
* Sets a new auUpdate
*
* @param \net\authorize\api\contract\v1\AuUpdateType[] $auUpdate
* @return self
*/
public function setAuUpdate(array $auUpdate)
{
}
/**
* Adds as auDelete
*
* @return self
* @param \net\authorize\api\contract\v1\AuDeleteType $auDelete
*/
public function addToAuDelete(\net\authorize\api\contract\v1\AuDeleteType $auDelete)
{
}
/**
* isset auDelete
*
* @param scalar $index
* @return boolean
*/
public function issetAuDelete($index)
{
}
/**
* unset auDelete
*
* @param scalar $index
* @return void
*/
public function unsetAuDelete($index)
{
}
/**
* Gets as auDelete
*
* @return \net\authorize\api\contract\v1\AuDeleteType[]
*/
public function getAuDelete()
{
}
/**
* Sets a new auDelete
*
* @param \net\authorize\api\contract\v1\AuDeleteType[] $auDelete
* @return self
*/
public function setAuDelete(array $auDelete)
{
}
}
/**
* Class representing BatchDetailsType
*
*
* XSD Type: batchDetailsType
*/
class BatchDetailsType
{
/**
* Gets as batchId
*
* @return string
*/
public function getBatchId()
{
}
/**
* Sets a new batchId
*
* @param string $batchId
* @return self
*/
public function setBatchId($batchId)
{
}
/**
* Gets as settlementTimeUTC
*
* @return \DateTime
*/
public function getSettlementTimeUTC()
{
}
/**
* Sets a new settlementTimeUTC
*
* @param \DateTime $settlementTimeUTC
* @return self
*/
public function setSettlementTimeUTC(\DateTime $settlementTimeUTC)
{
}
/**
* Gets as settlementTimeLocal
*
* @return \DateTime
*/
public function getSettlementTimeLocal()
{
}
/**
* Sets a new settlementTimeLocal
*
* @param \DateTime $settlementTimeLocal
* @return self
*/
public function setSettlementTimeLocal(\DateTime $settlementTimeLocal)
{
}
/**
* Gets as settlementState
*
* @return string
*/
public function getSettlementState()
{
}
/**
* Sets a new settlementState
*
* @param string $settlementState
* @return self
*/
public function setSettlementState($settlementState)
{
}
/**
* Gets as paymentMethod
*
* @return string
*/
public function getPaymentMethod()
{
}
/**
* Sets a new paymentMethod
*
* @param string $paymentMethod
* @return self
*/
public function setPaymentMethod($paymentMethod)
{
}
/**
* Gets as marketType
*
* @return string
*/
public function getMarketType()
{
}
/**
* Sets a new marketType
*
* @param string $marketType
* @return self
*/
public function setMarketType($marketType)
{
}
/**
* Gets as product
*
* @return string
*/
public function getProduct()
{
}
/**
* Sets a new product
*
* @param string $product
* @return self
*/
public function setProduct($product)
{
}
/**
* Adds as statistic
*
* @return self
* @param \net\authorize\api\contract\v1\BatchStatisticType $statistic
*/
public function addToStatistics(\net\authorize\api\contract\v1\BatchStatisticType $statistic)
{
}
/**
* isset statistics
*
* @param scalar $index
* @return boolean
*/
public function issetStatistics($index)
{
}
/**
* unset statistics
*
* @param scalar $index
* @return void
*/
public function unsetStatistics($index)
{
}
/**
* Gets as statistics
*
* @return \net\authorize\api\contract\v1\BatchStatisticType[]
*/
public function getStatistics()
{
}
/**
* Sets a new statistics
*
* @param \net\authorize\api\contract\v1\BatchStatisticType[] $statistics
* @return self
*/
public function setStatistics(array $statistics)
{
}
}
/**
* Class representing ProfileTransAmountType
*
*
* XSD Type: profileTransAmountType
*/
class ProfileTransAmountType
{
/**
* Gets as amount
*
* @return float
*/
public function getAmount()
{
}
/**
* Sets a new amount
*
* @param float $amount
* @return self
*/
public function setAmount($amount)
{
}
/**
* Gets as tax
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getTax()
{
}
/**
* Sets a new tax
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $tax
* @return self
*/
public function setTax(\net\authorize\api\contract\v1\ExtendedAmountType $tax)
{
}
/**
* Gets as shipping
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getShipping()
{
}
/**
* Sets a new shipping
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $shipping
* @return self
*/
public function setShipping(\net\authorize\api\contract\v1\ExtendedAmountType $shipping)
{
}
/**
* Gets as duty
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getDuty()
{
}
/**
* Sets a new duty
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $duty
* @return self
*/
public function setDuty(\net\authorize\api\contract\v1\ExtendedAmountType $duty)
{
}
/**
* Adds as lineItems
*
* @return self
* @param \net\authorize\api\contract\v1\LineItemType $lineItems
*/
public function addToLineItems(\net\authorize\api\contract\v1\LineItemType $lineItems)
{
}
/**
* isset lineItems
*
* @param scalar $index
* @return boolean
*/
public function issetLineItems($index)
{
}
/**
* unset lineItems
*
* @param scalar $index
* @return void
*/
public function unsetLineItems($index)
{
}
/**
* Gets as lineItems
*
* @return \net\authorize\api\contract\v1\LineItemType[]
*/
public function getLineItems()
{
}
/**
* Sets a new lineItems
*
* @param \net\authorize\api\contract\v1\LineItemType[] $lineItems
* @return self
*/
public function setLineItems(array $lineItems)
{
}
}
/**
* Class representing ProfileTransOrderType
*
*
* XSD Type: profileTransOrderType
*/
class ProfileTransOrderType extends \net\authorize\api\contract\v1\ProfileTransAmountType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as customerShippingAddressId
*
* @return string
*/
public function getCustomerShippingAddressId()
{
}
/**
* Sets a new customerShippingAddressId
*
* @param string $customerShippingAddressId
* @return self
*/
public function setCustomerShippingAddressId($customerShippingAddressId)
{
}
/**
* Gets as order
*
* @return \net\authorize\api\contract\v1\OrderExType
*/
public function getOrder()
{
}
/**
* Sets a new order
*
* @param \net\authorize\api\contract\v1\OrderExType $order
* @return self
*/
public function setOrder(\net\authorize\api\contract\v1\OrderExType $order)
{
}
/**
* Gets as taxExempt
*
* @return boolean
*/
public function getTaxExempt()
{
}
/**
* Sets a new taxExempt
*
* @param boolean $taxExempt
* @return self
*/
public function setTaxExempt($taxExempt)
{
}
/**
* Gets as recurringBilling
*
* @return boolean
*/
public function getRecurringBilling()
{
}
/**
* Sets a new recurringBilling
*
* @param boolean $recurringBilling
* @return self
*/
public function setRecurringBilling($recurringBilling)
{
}
/**
* Gets as cardCode
*
* @return string
*/
public function getCardCode()
{
}
/**
* Sets a new cardCode
*
* @param string $cardCode
* @return self
*/
public function setCardCode($cardCode)
{
}
/**
* Gets as splitTenderId
*
* @return string
*/
public function getSplitTenderId()
{
}
/**
* Sets a new splitTenderId
*
* @param string $splitTenderId
* @return self
*/
public function setSplitTenderId($splitTenderId)
{
}
}
/**
* Class representing ProfileTransAuthOnlyType
*
*
* XSD Type: profileTransAuthOnlyType
*/
class ProfileTransAuthOnlyType extends \net\authorize\api\contract\v1\ProfileTransOrderType
{
}
/**
* Class representing ProfileTransRefundType
*
*
* XSD Type: profileTransRefundType
*/
class ProfileTransRefundType extends \net\authorize\api\contract\v1\ProfileTransAmountType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as customerShippingAddressId
*
* @return string
*/
public function getCustomerShippingAddressId()
{
}
/**
* Sets a new customerShippingAddressId
*
* @param string $customerShippingAddressId
* @return self
*/
public function setCustomerShippingAddressId($customerShippingAddressId)
{
}
/**
* Gets as creditCardNumberMasked
*
* @return string
*/
public function getCreditCardNumberMasked()
{
}
/**
* Sets a new creditCardNumberMasked
*
* @param string $creditCardNumberMasked
* @return self
*/
public function setCreditCardNumberMasked($creditCardNumberMasked)
{
}
/**
* Gets as bankRoutingNumberMasked
*
* @return string
*/
public function getBankRoutingNumberMasked()
{
}
/**
* Sets a new bankRoutingNumberMasked
*
* @param string $bankRoutingNumberMasked
* @return self
*/
public function setBankRoutingNumberMasked($bankRoutingNumberMasked)
{
}
/**
* Gets as bankAccountNumberMasked
*
* @return string
*/
public function getBankAccountNumberMasked()
{
}
/**
* Sets a new bankAccountNumberMasked
*
* @param string $bankAccountNumberMasked
* @return self
*/
public function setBankAccountNumberMasked($bankAccountNumberMasked)
{
}
/**
* Gets as order
*
* @return \net\authorize\api\contract\v1\OrderExType
*/
public function getOrder()
{
}
/**
* Sets a new order
*
* @param \net\authorize\api\contract\v1\OrderExType $order
* @return self
*/
public function setOrder(\net\authorize\api\contract\v1\OrderExType $order)
{
}
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
}
/**
* Class representing GetTransactionDetailsRequest
*/
class GetTransactionDetailsRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
}
/**
* Class representing LineItemType
*
*
* XSD Type: lineItemType
*/
class LineItemType
{
/**
* Gets as itemId
*
* @return string
*/
public function getItemId()
{
}
/**
* Sets a new itemId
*
* @param string $itemId
* @return self
*/
public function setItemId($itemId)
{
}
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as description
*
* @return string
*/
public function getDescription()
{
}
/**
* Sets a new description
*
* @param string $description
* @return self
*/
public function setDescription($description)
{
}
/**
* Gets as quantity
*
* @return float
*/
public function getQuantity()
{
}
/**
* Sets a new quantity
*
* @param float $quantity
* @return self
*/
public function setQuantity($quantity)
{
}
/**
* Gets as unitPrice
*
* @return float
*/
public function getUnitPrice()
{
}
/**
* Sets a new unitPrice
*
* @param float $unitPrice
* @return self
*/
public function setUnitPrice($unitPrice)
{
}
/**
* Gets as taxable
*
* @return boolean
*/
public function getTaxable()
{
}
/**
* Sets a new taxable
*
* @param boolean $taxable
* @return self
*/
public function setTaxable($taxable)
{
}
}
/**
* Class representing PaymentDetailsType
*
*
* XSD Type: paymentDetails
*/
class PaymentDetailsType
{
/**
* Gets as currency
*
* @return string
*/
public function getCurrency()
{
}
/**
* Sets a new currency
*
* @param string $currency
* @return self
*/
public function setCurrency($currency)
{
}
/**
* Gets as promoCode
*
* @return string
*/
public function getPromoCode()
{
}
/**
* Sets a new promoCode
*
* @param string $promoCode
* @return self
*/
public function setPromoCode($promoCode)
{
}
/**
* Gets as misc
*
* @return string
*/
public function getMisc()
{
}
/**
* Sets a new misc
*
* @param string $misc
* @return self
*/
public function setMisc($misc)
{
}
/**
* Gets as giftWrap
*
* @return string
*/
public function getGiftWrap()
{
}
/**
* Sets a new giftWrap
*
* @param string $giftWrap
* @return self
*/
public function setGiftWrap($giftWrap)
{
}
/**
* Gets as discount
*
* @return string
*/
public function getDiscount()
{
}
/**
* Sets a new discount
*
* @param string $discount
* @return self
*/
public function setDiscount($discount)
{
}
/**
* Gets as tax
*
* @return string
*/
public function getTax()
{
}
/**
* Sets a new tax
*
* @param string $tax
* @return self
*/
public function setTax($tax)
{
}
/**
* Gets as shippingHandling
*
* @return string
*/
public function getShippingHandling()
{
}
/**
* Sets a new shippingHandling
*
* @param string $shippingHandling
* @return self
*/
public function setShippingHandling($shippingHandling)
{
}
/**
* Gets as subTotal
*
* @return string
*/
public function getSubTotal()
{
}
/**
* Sets a new subTotal
*
* @param string $subTotal
* @return self
*/
public function setSubTotal($subTotal)
{
}
/**
* Gets as orderID
*
* @return string
*/
public function getOrderID()
{
}
/**
* Sets a new orderID
*
* @param string $orderID
* @return self
*/
public function setOrderID($orderID)
{
}
/**
* Gets as amount
*
* @return string
*/
public function getAmount()
{
}
/**
* Sets a new amount
*
* @param string $amount
* @return self
*/
public function setAmount($amount)
{
}
}
/**
* Class representing CreditCardSimpleType
*
*
* XSD Type: creditCardSimpleType
*/
class CreditCardSimpleType
{
/**
* Gets as cardNumber
*
* @return string
*/
public function getCardNumber()
{
}
/**
* Sets a new cardNumber
*
* @param string $cardNumber
* @return self
*/
public function setCardNumber($cardNumber)
{
}
/**
* Gets as expirationDate
*
* @return string
*/
public function getExpirationDate()
{
}
/**
* Sets a new expirationDate
*
* @param string $expirationDate
* @return self
*/
public function setExpirationDate($expirationDate)
{
}
}
/**
* Class representing CreditCardType
*
*
* XSD Type: creditCardType
*/
class CreditCardType extends \net\authorize\api\contract\v1\CreditCardSimpleType
{
/**
* Gets as cardCode
*
* @return string
*/
public function getCardCode()
{
}
/**
* Sets a new cardCode
*
* @param string $cardCode
* @return self
*/
public function setCardCode($cardCode)
{
}
/**
* Gets as isPaymentToken
*
* @return boolean
*/
public function getIsPaymentToken()
{
}
/**
* Sets a new isPaymentToken
*
* @param boolean $isPaymentToken
* @return self
*/
public function setIsPaymentToken($isPaymentToken)
{
}
/**
* Gets as cryptogram
*
* @return string
*/
public function getCryptogram()
{
}
/**
* Sets a new cryptogram
*
* @param string $cryptogram
* @return self
*/
public function setCryptogram($cryptogram)
{
}
}
}
namespace net\authorize\api\contract\v1\MessagesType {
/**
* Class representing MessageAType
*/
class MessageAType
{
/**
* Gets as code
*
* @return string
*/
public function getCode()
{
}
/**
* Sets a new code
*
* @param string $code
* @return self
*/
public function setCode($code)
{
}
/**
* Gets as text
*
* @return string
*/
public function getText()
{
}
/**
* Sets a new text
*
* @param string $text
* @return self
*/
public function setText($text)
{
}
}
}
namespace net\authorize\api\contract\v1 {
/**
* Class representing PermissionType
*
*
* XSD Type: permissionType
*/
class PermissionType
{
/**
* Gets as permissionName
*
* @return string
*/
public function getPermissionName()
{
}
/**
* Sets a new permissionName
*
* @param string $permissionName
* @return self
*/
public function setPermissionName($permissionName)
{
}
}
/**
* Class representing KeyValueType
*
*
* XSD Type: KeyValue
*/
class KeyValueType
{
/**
* Gets as encoding
*
* @return string
*/
public function getEncoding()
{
}
/**
* Sets a new encoding
*
* @param string $encoding
* @return self
*/
public function setEncoding($encoding)
{
}
/**
* Gets as encryptionAlgorithm
*
* @return string
*/
public function getEncryptionAlgorithm()
{
}
/**
* Sets a new encryptionAlgorithm
*
* @param string $encryptionAlgorithm
* @return self
*/
public function setEncryptionAlgorithm($encryptionAlgorithm)
{
}
/**
* Gets as scheme
*
* @return \net\authorize\api\contract\v1\KeyManagementSchemeType
*/
public function getScheme()
{
}
/**
* Sets a new scheme
*
* @param \net\authorize\api\contract\v1\KeyManagementSchemeType $scheme
* @return self
*/
public function setScheme(\net\authorize\api\contract\v1\KeyManagementSchemeType $scheme)
{
}
}
/**
* Class representing ARBGetSubscriptionListResponse
*/
class ARBGetSubscriptionListResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as totalNumInResultSet
*
* @return integer
*/
public function getTotalNumInResultSet()
{
}
/**
* Sets a new totalNumInResultSet
*
* @param integer $totalNumInResultSet
* @return self
*/
public function setTotalNumInResultSet($totalNumInResultSet)
{
}
/**
* Adds as subscriptionDetail
*
* @return self
* @param \net\authorize\api\contract\v1\SubscriptionDetailType $subscriptionDetail
*/
public function addToSubscriptionDetails(\net\authorize\api\contract\v1\SubscriptionDetailType $subscriptionDetail)
{
}
/**
* isset subscriptionDetails
*
* @param scalar $index
* @return boolean
*/
public function issetSubscriptionDetails($index)
{
}
/**
* unset subscriptionDetails
*
* @param scalar $index
* @return void
*/
public function unsetSubscriptionDetails($index)
{
}
/**
* Gets as subscriptionDetails
*
* @return \net\authorize\api\contract\v1\SubscriptionDetailType[]
*/
public function getSubscriptionDetails()
{
}
/**
* Sets a new subscriptionDetails
*
* @param \net\authorize\api\contract\v1\SubscriptionDetailType[]
* $subscriptionDetails
* @return self
*/
public function setSubscriptionDetails(array $subscriptionDetails)
{
}
}
/**
* Class representing GetTransactionListResponse
*/
class GetTransactionListResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Adds as transaction
*
* @return self
* @param \net\authorize\api\contract\v1\TransactionSummaryType $transaction
*/
public function addToTransactions(\net\authorize\api\contract\v1\TransactionSummaryType $transaction)
{
}
/**
* isset transactions
*
* @param scalar $index
* @return boolean
*/
public function issetTransactions($index)
{
}
/**
* unset transactions
*
* @param scalar $index
* @return void
*/
public function unsetTransactions($index)
{
}
/**
* Gets as transactions
*
* @return \net\authorize\api\contract\v1\TransactionSummaryType[]
*/
public function getTransactions()
{
}
/**
* Sets a new transactions
*
* @param \net\authorize\api\contract\v1\TransactionSummaryType[] $transactions
* @return self
*/
public function setTransactions(array $transactions)
{
}
/**
* Gets as totalNumInResultSet
*
* @return integer
*/
public function getTotalNumInResultSet()
{
}
/**
* Sets a new totalNumInResultSet
*
* @param integer $totalNumInResultSet
* @return self
*/
public function setTotalNumInResultSet($totalNumInResultSet)
{
}
}
/**
* Class representing UpdateSplitTenderGroupRequest
*/
class UpdateSplitTenderGroupRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as splitTenderId
*
* @return string
*/
public function getSplitTenderId()
{
}
/**
* Sets a new splitTenderId
*
* @param string $splitTenderId
* @return self
*/
public function setSplitTenderId($splitTenderId)
{
}
/**
* Gets as splitTenderStatus
*
* @return string
*/
public function getSplitTenderStatus()
{
}
/**
* Sets a new splitTenderStatus
*
* @param string $splitTenderStatus
* @return self
*/
public function setSplitTenderStatus($splitTenderStatus)
{
}
}
/**
* Class representing GetCustomerPaymentProfileResponse
*/
class GetCustomerPaymentProfileResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as paymentProfile
*
* @return \net\authorize\api\contract\v1\CustomerPaymentProfileMaskedType
*/
public function getPaymentProfile()
{
}
/**
* Sets a new paymentProfile
*
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileMaskedType
* $paymentProfile
* @return self
*/
public function setPaymentProfile(\net\authorize\api\contract\v1\CustomerPaymentProfileMaskedType $paymentProfile)
{
}
}
/**
* Class representing UpdateCustomerPaymentProfileResponse
*/
class UpdateCustomerPaymentProfileResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as validationDirectResponse
*
* @return string
*/
public function getValidationDirectResponse()
{
}
/**
* Sets a new validationDirectResponse
*
* @param string $validationDirectResponse
* @return self
*/
public function setValidationDirectResponse($validationDirectResponse)
{
}
}
/**
* Class representing ValidateCustomerPaymentProfileResponse
*/
class ValidateCustomerPaymentProfileResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as directResponse
*
* @return string
*/
public function getDirectResponse()
{
}
/**
* Sets a new directResponse
*
* @param string $directResponse
* @return self
*/
public function setDirectResponse($directResponse)
{
}
}
/**
* Class representing CustomerProfileBaseType
*
*
* XSD Type: customerProfileBaseType
*/
class CustomerProfileBaseType
{
/**
* Gets as merchantCustomerId
*
* @return string
*/
public function getMerchantCustomerId()
{
}
/**
* Sets a new merchantCustomerId
*
* @param string $merchantCustomerId
* @return self
*/
public function setMerchantCustomerId($merchantCustomerId)
{
}
/**
* Gets as description
*
* @return string
*/
public function getDescription()
{
}
/**
* Sets a new description
*
* @param string $description
* @return self
*/
public function setDescription($description)
{
}
/**
* Gets as email
*
* @return string
*/
public function getEmail()
{
}
/**
* Sets a new email
*
* @param string $email
* @return self
*/
public function setEmail($email)
{
}
}
/**
* Class representing CustomerProfileExType
*
*
* XSD Type: customerProfileExType
*/
class CustomerProfileExType extends \net\authorize\api\contract\v1\CustomerProfileBaseType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
}
/**
* Class representing SubscriptionCustomerProfileType
*
*
* XSD Type: subscriptionCustomerProfileType
*/
class SubscriptionCustomerProfileType extends \net\authorize\api\contract\v1\CustomerProfileExType
{
/**
* Gets as paymentProfile
*
* @return \net\authorize\api\contract\v1\CustomerPaymentProfileMaskedType
*/
public function getPaymentProfile()
{
}
/**
* Sets a new paymentProfile
*
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileMaskedType
* $paymentProfile
* @return self
*/
public function setPaymentProfile(\net\authorize\api\contract\v1\CustomerPaymentProfileMaskedType $paymentProfile)
{
}
/**
* Gets as shippingProfile
*
* @return \net\authorize\api\contract\v1\CustomerAddressExType
*/
public function getShippingProfile()
{
}
/**
* Sets a new shippingProfile
*
* @param \net\authorize\api\contract\v1\CustomerAddressExType $shippingProfile
* @return self
*/
public function setShippingProfile(\net\authorize\api\contract\v1\CustomerAddressExType $shippingProfile)
{
}
}
/**
* Class representing GetUnsettledTransactionListResponse
*/
class GetUnsettledTransactionListResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Adds as transaction
*
* @return self
* @param \net\authorize\api\contract\v1\TransactionSummaryType $transaction
*/
public function addToTransactions(\net\authorize\api\contract\v1\TransactionSummaryType $transaction)
{
}
/**
* isset transactions
*
* @param scalar $index
* @return boolean
*/
public function issetTransactions($index)
{
}
/**
* unset transactions
*
* @param scalar $index
* @return void
*/
public function unsetTransactions($index)
{
}
/**
* Gets as transactions
*
* @return \net\authorize\api\contract\v1\TransactionSummaryType[]
*/
public function getTransactions()
{
}
/**
* Sets a new transactions
*
* @param \net\authorize\api\contract\v1\TransactionSummaryType[] $transactions
* @return self
*/
public function setTransactions(array $transactions)
{
}
/**
* Gets as totalNumInResultSet
*
* @return integer
*/
public function getTotalNumInResultSet()
{
}
/**
* Sets a new totalNumInResultSet
*
* @param integer $totalNumInResultSet
* @return self
*/
public function setTotalNumInResultSet($totalNumInResultSet)
{
}
}
/**
* Class representing SubscriptionPaymentType
*
*
* XSD Type: subscriptionPaymentType
*/
class SubscriptionPaymentType
{
/**
* Gets as id
*
* @return integer
*/
public function getId()
{
}
/**
* Sets a new id
*
* @param integer $id
* @return self
*/
public function setId($id)
{
}
/**
* Gets as payNum
*
* @return integer
*/
public function getPayNum()
{
}
/**
* Sets a new payNum
*
* @param integer $payNum
* @return self
*/
public function setPayNum($payNum)
{
}
}
/**
* Class representing CustomerPaymentProfileSortingType
*
*
* XSD Type: CustomerPaymentProfileSorting
*/
class CustomerPaymentProfileSortingType
{
/**
* Gets as orderBy
*
* @return string
*/
public function getOrderBy()
{
}
/**
* Sets a new orderBy
*
* @param string $orderBy
* @return self
*/
public function setOrderBy($orderBy)
{
}
/**
* Gets as orderDescending
*
* @return boolean
*/
public function getOrderDescending()
{
}
/**
* Sets a new orderDescending
*
* @param boolean $orderDescending
* @return self
*/
public function setOrderDescending($orderDescending)
{
}
}
/**
* Class representing GetAUJobSummaryRequest
*/
class GetAUJobSummaryRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as month
*
* @return string
*/
public function getMonth()
{
}
/**
* Sets a new month
*
* @param string $month
* @return self
*/
public function setMonth($month)
{
}
}
/**
* Class representing TransactionSummaryType
*
*
* XSD Type: transactionSummaryType
*/
class TransactionSummaryType
{
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
/**
* Gets as submitTimeUTC
*
* @return \DateTime
*/
public function getSubmitTimeUTC()
{
}
/**
* Sets a new submitTimeUTC
*
* @param \DateTime $submitTimeUTC
* @return self
*/
public function setSubmitTimeUTC(\DateTime $submitTimeUTC)
{
}
/**
* Gets as submitTimeLocal
*
* @return \DateTime
*/
public function getSubmitTimeLocal()
{
}
/**
* Sets a new submitTimeLocal
*
* @param \DateTime $submitTimeLocal
* @return self
*/
public function setSubmitTimeLocal(\DateTime $submitTimeLocal)
{
}
/**
* Gets as transactionStatus
*
* @return string
*/
public function getTransactionStatus()
{
}
/**
* Sets a new transactionStatus
*
* @param string $transactionStatus
* @return self
*/
public function setTransactionStatus($transactionStatus)
{
}
/**
* Gets as invoiceNumber
*
* @return string
*/
public function getInvoiceNumber()
{
}
/**
* Sets a new invoiceNumber
*
* @param string $invoiceNumber
* @return self
*/
public function setInvoiceNumber($invoiceNumber)
{
}
/**
* Gets as firstName
*
* @return string
*/
public function getFirstName()
{
}
/**
* Sets a new firstName
*
* @param string $firstName
* @return self
*/
public function setFirstName($firstName)
{
}
/**
* Gets as lastName
*
* @return string
*/
public function getLastName()
{
}
/**
* Sets a new lastName
*
* @param string $lastName
* @return self
*/
public function setLastName($lastName)
{
}
/**
* Gets as accountType
*
* @return string
*/
public function getAccountType()
{
}
/**
* Sets a new accountType
*
* @param string $accountType
* @return self
*/
public function setAccountType($accountType)
{
}
/**
* Gets as accountNumber
*
* @return string
*/
public function getAccountNumber()
{
}
/**
* Sets a new accountNumber
*
* @param string $accountNumber
* @return self
*/
public function setAccountNumber($accountNumber)
{
}
/**
* Gets as settleAmount
*
* @return float
*/
public function getSettleAmount()
{
}
/**
* Sets a new settleAmount
*
* @param float $settleAmount
* @return self
*/
public function setSettleAmount($settleAmount)
{
}
/**
* Gets as marketType
*
* @return string
*/
public function getMarketType()
{
}
/**
* Sets a new marketType
*
* @param string $marketType
* @return self
*/
public function setMarketType($marketType)
{
}
/**
* Gets as product
*
* @return string
*/
public function getProduct()
{
}
/**
* Sets a new product
*
* @param string $product
* @return self
*/
public function setProduct($product)
{
}
/**
* Gets as mobileDeviceId
*
* @return string
*/
public function getMobileDeviceId()
{
}
/**
* Sets a new mobileDeviceId
*
* @param string $mobileDeviceId
* @return self
*/
public function setMobileDeviceId($mobileDeviceId)
{
}
/**
* Gets as subscription
*
* @return \net\authorize\api\contract\v1\SubscriptionPaymentType
*/
public function getSubscription()
{
}
/**
* Sets a new subscription
*
* @param \net\authorize\api\contract\v1\SubscriptionPaymentType $subscription
* @return self
*/
public function setSubscription(\net\authorize\api\contract\v1\SubscriptionPaymentType $subscription)
{
}
/**
* Gets as hasReturnedItems
*
* @return boolean
*/
public function getHasReturnedItems()
{
}
/**
* Sets a new hasReturnedItems
*
* @param boolean $hasReturnedItems
* @return self
*/
public function setHasReturnedItems($hasReturnedItems)
{
}
/**
* Gets as fraudInformation
*
* @return \net\authorize\api\contract\v1\FraudInformationType
*/
public function getFraudInformation()
{
}
/**
* Sets a new fraudInformation
*
* @param \net\authorize\api\contract\v1\FraudInformationType $fraudInformation
* @return self
*/
public function setFraudInformation(\net\authorize\api\contract\v1\FraudInformationType $fraudInformation)
{
}
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\CustomerProfileIdType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\CustomerProfileIdType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\CustomerProfileIdType $profile)
{
}
}
/**
* Class representing BatchStatisticType
*
*
* XSD Type: batchStatisticType
*/
class BatchStatisticType
{
/**
* Gets as accountType
*
* @return string
*/
public function getAccountType()
{
}
/**
* Sets a new accountType
*
* @param string $accountType
* @return self
*/
public function setAccountType($accountType)
{
}
/**
* Gets as chargeAmount
*
* @return float
*/
public function getChargeAmount()
{
}
/**
* Sets a new chargeAmount
*
* @param float $chargeAmount
* @return self
*/
public function setChargeAmount($chargeAmount)
{
}
/**
* Gets as chargeCount
*
* @return integer
*/
public function getChargeCount()
{
}
/**
* Sets a new chargeCount
*
* @param integer $chargeCount
* @return self
*/
public function setChargeCount($chargeCount)
{
}
/**
* Gets as refundAmount
*
* @return float
*/
public function getRefundAmount()
{
}
/**
* Sets a new refundAmount
*
* @param float $refundAmount
* @return self
*/
public function setRefundAmount($refundAmount)
{
}
/**
* Gets as refundCount
*
* @return integer
*/
public function getRefundCount()
{
}
/**
* Sets a new refundCount
*
* @param integer $refundCount
* @return self
*/
public function setRefundCount($refundCount)
{
}
/**
* Gets as voidCount
*
* @return integer
*/
public function getVoidCount()
{
}
/**
* Sets a new voidCount
*
* @param integer $voidCount
* @return self
*/
public function setVoidCount($voidCount)
{
}
/**
* Gets as declineCount
*
* @return integer
*/
public function getDeclineCount()
{
}
/**
* Sets a new declineCount
*
* @param integer $declineCount
* @return self
*/
public function setDeclineCount($declineCount)
{
}
/**
* Gets as errorCount
*
* @return integer
*/
public function getErrorCount()
{
}
/**
* Sets a new errorCount
*
* @param integer $errorCount
* @return self
*/
public function setErrorCount($errorCount)
{
}
/**
* Gets as returnedItemAmount
*
* @return float
*/
public function getReturnedItemAmount()
{
}
/**
* Sets a new returnedItemAmount
*
* @param float $returnedItemAmount
* @return self
*/
public function setReturnedItemAmount($returnedItemAmount)
{
}
/**
* Gets as returnedItemCount
*
* @return integer
*/
public function getReturnedItemCount()
{
}
/**
* Sets a new returnedItemCount
*
* @param integer $returnedItemCount
* @return self
*/
public function setReturnedItemCount($returnedItemCount)
{
}
/**
* Gets as chargebackAmount
*
* @return float
*/
public function getChargebackAmount()
{
}
/**
* Sets a new chargebackAmount
*
* @param float $chargebackAmount
* @return self
*/
public function setChargebackAmount($chargebackAmount)
{
}
/**
* Gets as chargebackCount
*
* @return integer
*/
public function getChargebackCount()
{
}
/**
* Sets a new chargebackCount
*
* @param integer $chargebackCount
* @return self
*/
public function setChargebackCount($chargebackCount)
{
}
/**
* Gets as correctionNoticeCount
*
* @return integer
*/
public function getCorrectionNoticeCount()
{
}
/**
* Sets a new correctionNoticeCount
*
* @param integer $correctionNoticeCount
* @return self
*/
public function setCorrectionNoticeCount($correctionNoticeCount)
{
}
/**
* Gets as chargeChargeBackAmount
*
* @return float
*/
public function getChargeChargeBackAmount()
{
}
/**
* Sets a new chargeChargeBackAmount
*
* @param float $chargeChargeBackAmount
* @return self
*/
public function setChargeChargeBackAmount($chargeChargeBackAmount)
{
}
/**
* Gets as chargeChargeBackCount
*
* @return integer
*/
public function getChargeChargeBackCount()
{
}
/**
* Sets a new chargeChargeBackCount
*
* @param integer $chargeChargeBackCount
* @return self
*/
public function setChargeChargeBackCount($chargeChargeBackCount)
{
}
/**
* Gets as refundChargeBackAmount
*
* @return float
*/
public function getRefundChargeBackAmount()
{
}
/**
* Sets a new refundChargeBackAmount
*
* @param float $refundChargeBackAmount
* @return self
*/
public function setRefundChargeBackAmount($refundChargeBackAmount)
{
}
/**
* Gets as refundChargeBackCount
*
* @return integer
*/
public function getRefundChargeBackCount()
{
}
/**
* Sets a new refundChargeBackCount
*
* @param integer $refundChargeBackCount
* @return self
*/
public function setRefundChargeBackCount($refundChargeBackCount)
{
}
/**
* Gets as chargeReturnedItemsAmount
*
* @return float
*/
public function getChargeReturnedItemsAmount()
{
}
/**
* Sets a new chargeReturnedItemsAmount
*
* @param float $chargeReturnedItemsAmount
* @return self
*/
public function setChargeReturnedItemsAmount($chargeReturnedItemsAmount)
{
}
/**
* Gets as chargeReturnedItemsCount
*
* @return integer
*/
public function getChargeReturnedItemsCount()
{
}
/**
* Sets a new chargeReturnedItemsCount
*
* @param integer $chargeReturnedItemsCount
* @return self
*/
public function setChargeReturnedItemsCount($chargeReturnedItemsCount)
{
}
/**
* Gets as refundReturnedItemsAmount
*
* @return float
*/
public function getRefundReturnedItemsAmount()
{
}
/**
* Sets a new refundReturnedItemsAmount
*
* @param float $refundReturnedItemsAmount
* @return self
*/
public function setRefundReturnedItemsAmount($refundReturnedItemsAmount)
{
}
/**
* Gets as refundReturnedItemsCount
*
* @return integer
*/
public function getRefundReturnedItemsCount()
{
}
/**
* Sets a new refundReturnedItemsCount
*
* @param integer $refundReturnedItemsCount
* @return self
*/
public function setRefundReturnedItemsCount($refundReturnedItemsCount)
{
}
}
/**
* Class representing GetTransactionDetailsResponse
*/
class GetTransactionDetailsResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as transaction
*
* @return \net\authorize\api\contract\v1\TransactionDetailsType
*/
public function getTransaction()
{
}
/**
* Sets a new transaction
*
* @param \net\authorize\api\contract\v1\TransactionDetailsType $transaction
* @return self
*/
public function setTransaction(\net\authorize\api\contract\v1\TransactionDetailsType $transaction)
{
}
/**
* Gets as clientId
*
* @return string
*/
public function getClientId()
{
}
/**
* Sets a new clientId
*
* @param string $clientId
* @return self
*/
public function setClientId($clientId)
{
}
/**
* Gets as transrefId
*
* @return string
*/
public function getTransrefId()
{
}
/**
* Sets a new transrefId
*
* @param string $transrefId
* @return self
*/
public function setTransrefId($transrefId)
{
}
}
/**
* Class representing GetCustomerPaymentProfileRequest
*/
class GetCustomerPaymentProfileRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as unmaskExpirationDate
*
* @return boolean
*/
public function getUnmaskExpirationDate()
{
}
/**
* Sets a new unmaskExpirationDate
*
* @param boolean $unmaskExpirationDate
* @return self
*/
public function setUnmaskExpirationDate($unmaskExpirationDate)
{
}
/**
* Gets as includeIssuerInfo
*
* @return boolean
*/
public function getIncludeIssuerInfo()
{
}
/**
* Sets a new includeIssuerInfo
*
* @param boolean $includeIssuerInfo
* @return self
*/
public function setIncludeIssuerInfo($includeIssuerInfo)
{
}
}
/**
* Class representing ARBGetSubscriptionRequest
*/
class ARBGetSubscriptionRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as subscriptionId
*
* @return string
*/
public function getSubscriptionId()
{
}
/**
* Sets a new subscriptionId
*
* @param string $subscriptionId
* @return self
*/
public function setSubscriptionId($subscriptionId)
{
}
/**
* Gets as includeTransactions
*
* @return boolean
*/
public function getIncludeTransactions()
{
}
/**
* Sets a new includeTransactions
*
* @param boolean $includeTransactions
* @return self
*/
public function setIncludeTransactions($includeTransactions)
{
}
}
/**
* Class representing ProfileTransAuthCaptureType
*
*
* XSD Type: profileTransAuthCaptureType
*/
class ProfileTransAuthCaptureType extends \net\authorize\api\contract\v1\ProfileTransOrderType
{
}
/**
* Class representing GetBatchStatisticsRequest
*/
class GetBatchStatisticsRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as batchId
*
* @return string
*/
public function getBatchId()
{
}
/**
* Sets a new batchId
*
* @param string $batchId
* @return self
*/
public function setBatchId($batchId)
{
}
}
/**
* Class representing AuDetailsType
*
*
* XSD Type: auDetailsType
*/
class AuDetailsType
{
/**
* Gets as customerProfileID
*
* @return integer
*/
public function getCustomerProfileID()
{
}
/**
* Sets a new customerProfileID
*
* @param integer $customerProfileID
* @return self
*/
public function setCustomerProfileID($customerProfileID)
{
}
/**
* Gets as customerPaymentProfileID
*
* @return integer
*/
public function getCustomerPaymentProfileID()
{
}
/**
* Sets a new customerPaymentProfileID
*
* @param integer $customerPaymentProfileID
* @return self
*/
public function setCustomerPaymentProfileID($customerPaymentProfileID)
{
}
/**
* Gets as firstName
*
* @return string
*/
public function getFirstName()
{
}
/**
* Sets a new firstName
*
* @param string $firstName
* @return self
*/
public function setFirstName($firstName)
{
}
/**
* Gets as lastName
*
* @return string
*/
public function getLastName()
{
}
/**
* Sets a new lastName
*
* @param string $lastName
* @return self
*/
public function setLastName($lastName)
{
}
/**
* Gets as updateTimeUTC
*
* @return string
*/
public function getUpdateTimeUTC()
{
}
/**
* Sets a new updateTimeUTC
*
* @param string $updateTimeUTC
* @return self
*/
public function setUpdateTimeUTC($updateTimeUTC)
{
}
/**
* Gets as auReasonCode
*
* @return string
*/
public function getAuReasonCode()
{
}
/**
* Sets a new auReasonCode
*
* @param string $auReasonCode
* @return self
*/
public function setAuReasonCode($auReasonCode)
{
}
/**
* Gets as reasonDescription
*
* @return string
*/
public function getReasonDescription()
{
}
/**
* Sets a new reasonDescription
*
* @param string $reasonDescription
* @return self
*/
public function setReasonDescription($reasonDescription)
{
}
}
/**
* Class representing AuDeleteType
*
*
* XSD Type: auDeleteType
*/
class AuDeleteType extends \net\authorize\api\contract\v1\AuDetailsType
{
/**
* Gets as creditCard
*
* @return \net\authorize\api\contract\v1\CreditCardMaskedType
*/
public function getCreditCard()
{
}
/**
* Sets a new creditCard
*
* @param \net\authorize\api\contract\v1\CreditCardMaskedType $creditCard
* @return self
*/
public function setCreditCard(\net\authorize\api\contract\v1\CreditCardMaskedType $creditCard)
{
}
}
/**
* Class representing GetCustomerProfileIdsResponse
*/
class GetCustomerProfileIdsResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Adds as numericString
*
* @return self
* @param string $numericString
*/
public function addToIds($numericString)
{
}
/**
* isset ids
*
* @param scalar $index
* @return boolean
*/
public function issetIds($index)
{
}
/**
* unset ids
*
* @param scalar $index
* @return void
*/
public function unsetIds($index)
{
}
/**
* Gets as ids
*
* @return string[]
*/
public function getIds()
{
}
/**
* Sets a new ids
*
* @param string $ids
* @return self
*/
public function setIds(array $ids)
{
}
}
/**
* Class representing KeyManagementSchemeType
*
*
* XSD Type: KeyManagementScheme
*/
class KeyManagementSchemeType
{
/**
* Gets as dUKPT
*
* @return \net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType
*/
public function getDUKPT()
{
}
/**
* Sets a new dUKPT
*
* @param \net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType $dUKPT
* @return self
*/
public function setDUKPT(\net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType $dUKPT)
{
}
}
/**
* Class representing EmvTagType
*
*
* XSD Type: emvTag
*/
class EmvTagType
{
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as value
*
* @return string
*/
public function getValue()
{
}
/**
* Sets a new value
*
* @param string $value
* @return self
*/
public function setValue($value)
{
}
/**
* Gets as formatted
*
* @return string
*/
public function getFormatted()
{
}
/**
* Sets a new formatted
*
* @param string $formatted
* @return self
*/
public function setFormatted($formatted)
{
}
}
/**
* Class representing CreateCustomerShippingAddressResponse
*/
class CreateCustomerShippingAddressResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerAddressId
*
* @return string
*/
public function getCustomerAddressId()
{
}
/**
* Sets a new customerAddressId
*
* @param string $customerAddressId
* @return self
*/
public function setCustomerAddressId($customerAddressId)
{
}
}
/**
* Class representing CustomerProfilePaymentType
*
*
* XSD Type: customerProfilePaymentType
*/
class CustomerProfilePaymentType
{
/**
* Gets as createProfile
*
* @return boolean
*/
public function getCreateProfile()
{
}
/**
* Sets a new createProfile
*
* @param boolean $createProfile
* @return self
*/
public function setCreateProfile($createProfile)
{
}
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as paymentProfile
*
* @return \net\authorize\api\contract\v1\PaymentProfileType
*/
public function getPaymentProfile()
{
}
/**
* Sets a new paymentProfile
*
* @param \net\authorize\api\contract\v1\PaymentProfileType $paymentProfile
* @return self
*/
public function setPaymentProfile(\net\authorize\api\contract\v1\PaymentProfileType $paymentProfile)
{
}
/**
* Gets as shippingProfileId
*
* @return string
*/
public function getShippingProfileId()
{
}
/**
* Sets a new shippingProfileId
*
* @param string $shippingProfileId
* @return self
*/
public function setShippingProfileId($shippingProfileId)
{
}
}
/**
* Class representing AuResponseType
*
*
* XSD Type: auResponseType
*/
class AuResponseType
{
/**
* Gets as auReasonCode
*
* @return string
*/
public function getAuReasonCode()
{
}
/**
* Sets a new auReasonCode
*
* @param string $auReasonCode
* @return self
*/
public function setAuReasonCode($auReasonCode)
{
}
/**
* Gets as profileCount
*
* @return integer
*/
public function getProfileCount()
{
}
/**
* Sets a new profileCount
*
* @param integer $profileCount
* @return self
*/
public function setProfileCount($profileCount)
{
}
/**
* Gets as reasonDescription
*
* @return string
*/
public function getReasonDescription()
{
}
/**
* Sets a new reasonDescription
*
* @param string $reasonDescription
* @return self
*/
public function setReasonDescription($reasonDescription)
{
}
}
/**
* Class representing CustomerProfileType
*
*
* XSD Type: customerProfileType
*/
class CustomerProfileType extends \net\authorize\api\contract\v1\CustomerProfileBaseType
{
/**
* Adds as paymentProfiles
*
* @return self
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileType
* $paymentProfiles
*/
public function addToPaymentProfiles(\net\authorize\api\contract\v1\CustomerPaymentProfileType $paymentProfiles)
{
}
/**
* isset paymentProfiles
*
* @param scalar $index
* @return boolean
*/
public function issetPaymentProfiles($index)
{
}
/**
* unset paymentProfiles
*
* @param scalar $index
* @return void
*/
public function unsetPaymentProfiles($index)
{
}
/**
* Gets as paymentProfiles
*
* @return \net\authorize\api\contract\v1\CustomerPaymentProfileType[]
*/
public function getPaymentProfiles()
{
}
/**
* Sets a new paymentProfiles
*
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileType[]
* $paymentProfiles
* @return self
*/
public function setPaymentProfiles(array $paymentProfiles)
{
}
/**
* Adds as shipToList
*
* @return self
* @param \net\authorize\api\contract\v1\CustomerAddressType $shipToList
*/
public function addToShipToList(\net\authorize\api\contract\v1\CustomerAddressType $shipToList)
{
}
/**
* isset shipToList
*
* @param scalar $index
* @return boolean
*/
public function issetShipToList($index)
{
}
/**
* unset shipToList
*
* @param scalar $index
* @return void
*/
public function unsetShipToList($index)
{
}
/**
* Gets as shipToList
*
* @return \net\authorize\api\contract\v1\CustomerAddressType[]
*/
public function getShipToList()
{
}
/**
* Sets a new shipToList
*
* @param \net\authorize\api\contract\v1\CustomerAddressType[] $shipToList
* @return self
*/
public function setShipToList(array $shipToList)
{
}
/**
* Gets as profileType
*
* @return string
*/
public function getProfileType()
{
}
/**
* Sets a new profileType
*
* @param string $profileType
* @return self
*/
public function setProfileType($profileType)
{
}
}
/**
* Class representing UpdateCustomerProfileRequest
*/
class UpdateCustomerProfileRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\CustomerProfileExType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\CustomerProfileExType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\CustomerProfileExType $profile)
{
}
}
/**
* Class representing ProfileTransactionType
*
*
* XSD Type: profileTransactionType
*/
class ProfileTransactionType
{
/**
* Gets as profileTransAuthCapture
*
* @return \net\authorize\api\contract\v1\ProfileTransAuthCaptureType
*/
public function getProfileTransAuthCapture()
{
}
/**
* Sets a new profileTransAuthCapture
*
* @param \net\authorize\api\contract\v1\ProfileTransAuthCaptureType
* $profileTransAuthCapture
* @return self
*/
public function setProfileTransAuthCapture(\net\authorize\api\contract\v1\ProfileTransAuthCaptureType $profileTransAuthCapture)
{
}
/**
* Gets as profileTransAuthOnly
*
* @return \net\authorize\api\contract\v1\ProfileTransAuthOnlyType
*/
public function getProfileTransAuthOnly()
{
}
/**
* Sets a new profileTransAuthOnly
*
* @param \net\authorize\api\contract\v1\ProfileTransAuthOnlyType
* $profileTransAuthOnly
* @return self
*/
public function setProfileTransAuthOnly(\net\authorize\api\contract\v1\ProfileTransAuthOnlyType $profileTransAuthOnly)
{
}
/**
* Gets as profileTransPriorAuthCapture
*
* @return \net\authorize\api\contract\v1\ProfileTransPriorAuthCaptureType
*/
public function getProfileTransPriorAuthCapture()
{
}
/**
* Sets a new profileTransPriorAuthCapture
*
* @param \net\authorize\api\contract\v1\ProfileTransPriorAuthCaptureType
* $profileTransPriorAuthCapture
* @return self
*/
public function setProfileTransPriorAuthCapture(\net\authorize\api\contract\v1\ProfileTransPriorAuthCaptureType $profileTransPriorAuthCapture)
{
}
/**
* Gets as profileTransCaptureOnly
*
* @return \net\authorize\api\contract\v1\ProfileTransCaptureOnlyType
*/
public function getProfileTransCaptureOnly()
{
}
/**
* Sets a new profileTransCaptureOnly
*
* @param \net\authorize\api\contract\v1\ProfileTransCaptureOnlyType
* $profileTransCaptureOnly
* @return self
*/
public function setProfileTransCaptureOnly(\net\authorize\api\contract\v1\ProfileTransCaptureOnlyType $profileTransCaptureOnly)
{
}
/**
* Gets as profileTransRefund
*
* @return \net\authorize\api\contract\v1\ProfileTransRefundType
*/
public function getProfileTransRefund()
{
}
/**
* Sets a new profileTransRefund
*
* @param \net\authorize\api\contract\v1\ProfileTransRefundType $profileTransRefund
* @return self
*/
public function setProfileTransRefund(\net\authorize\api\contract\v1\ProfileTransRefundType $profileTransRefund)
{
}
/**
* Gets as profileTransVoid
*
* @return \net\authorize\api\contract\v1\ProfileTransVoidType
*/
public function getProfileTransVoid()
{
}
/**
* Sets a new profileTransVoid
*
* @param \net\authorize\api\contract\v1\ProfileTransVoidType $profileTransVoid
* @return self
*/
public function setProfileTransVoid(\net\authorize\api\contract\v1\ProfileTransVoidType $profileTransVoid)
{
}
}
/**
* Class representing EncryptedTrackDataType
*
*
* XSD Type: encryptedTrackDataType
*/
class EncryptedTrackDataType
{
/**
* Gets as formOfPayment
*
* @return \net\authorize\api\contract\v1\KeyBlockType
*/
public function getFormOfPayment()
{
}
/**
* Sets a new formOfPayment
*
* @param \net\authorize\api\contract\v1\KeyBlockType $formOfPayment
* @return self
*/
public function setFormOfPayment(\net\authorize\api\contract\v1\KeyBlockType $formOfPayment)
{
}
}
}
namespace net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType {
/**
* Class representing DeviceInfoAType
*/
class DeviceInfoAType
{
/**
* Gets as description
*
* @return string
*/
public function getDescription()
{
}
/**
* Sets a new description
*
* @param string $description
* @return self
*/
public function setDescription($description)
{
}
}
/**
* Class representing EncryptedDataAType
*/
class EncryptedDataAType
{
/**
* Gets as value
*
* @return string
*/
public function getValue()
{
}
/**
* Sets a new value
*
* @param string $value
* @return self
*/
public function setValue($value)
{
}
}
/**
* Class representing ModeAType
*/
class ModeAType
{
/**
* Gets as pIN
*
* @return string
*/
public function getPIN()
{
}
/**
* Sets a new pIN
*
* @param string $pIN
* @return self
*/
public function setPIN($pIN)
{
}
/**
* Gets as data
*
* @return string
*/
public function getData()
{
}
/**
* Sets a new data
*
* @param string $data
* @return self
*/
public function setData($data)
{
}
}
}
namespace net\authorize\api\contract\v1\KeyManagementSchemeType {
/**
* Class representing DUKPTAType
*/
class DUKPTAType
{
/**
* Gets as operation
*
* @return string
*/
public function getOperation()
{
}
/**
* Sets a new operation
*
* @param string $operation
* @return self
*/
public function setOperation($operation)
{
}
/**
* Gets as mode
*
* @return
* \net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType\ModeAType
*/
public function getMode()
{
}
/**
* Sets a new mode
*
* @param
* \net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType\ModeAType
* $mode
* @return self
*/
public function setMode(\net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType\ModeAType $mode)
{
}
/**
* Gets as deviceInfo
*
* @return
* \net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType\DeviceInfoAType
*/
public function getDeviceInfo()
{
}
/**
* Sets a new deviceInfo
*
* @param
* \net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType\DeviceInfoAType
* $deviceInfo
* @return self
*/
public function setDeviceInfo(\net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType\DeviceInfoAType $deviceInfo)
{
}
/**
* Gets as encryptedData
*
* @return
* \net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType\EncryptedDataAType
*/
public function getEncryptedData()
{
}
/**
* Sets a new encryptedData
*
* @param
* \net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType\EncryptedDataAType
* $encryptedData
* @return self
*/
public function setEncryptedData(\net\authorize\api\contract\v1\KeyManagementSchemeType\DUKPTAType\EncryptedDataAType $encryptedData)
{
}
}
}
namespace net\authorize\api\contract\v1 {
/**
* Class representing DecryptPaymentDataRequest
*/
class DecryptPaymentDataRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as opaqueData
*
* @return \net\authorize\api\contract\v1\OpaqueDataType
*/
public function getOpaqueData()
{
}
/**
* Sets a new opaqueData
*
* @param \net\authorize\api\contract\v1\OpaqueDataType $opaqueData
* @return self
*/
public function setOpaqueData(\net\authorize\api\contract\v1\OpaqueDataType $opaqueData)
{
}
/**
* Gets as callId
*
* @return string
*/
public function getCallId()
{
}
/**
* Sets a new callId
*
* @param string $callId
* @return self
*/
public function setCallId($callId)
{
}
}
}
namespace net\authorize\api\contract\v1\TransactionRequestType {
/**
* Class representing UserFieldsAType
*/
class UserFieldsAType
{
/**
* Adds as userField
*
* @return self
* @param \net\authorize\api\contract\v1\UserFieldType $userField
*/
public function addToUserField(\net\authorize\api\contract\v1\UserFieldType $userField)
{
}
/**
* isset userField
*
* @param scalar $index
* @return boolean
*/
public function issetUserField($index)
{
}
/**
* unset userField
*
* @param scalar $index
* @return void
*/
public function unsetUserField($index)
{
}
/**
* Gets as userField
*
* @return \net\authorize\api\contract\v1\UserFieldType[]
*/
public function getUserField()
{
}
/**
* Sets a new userField
*
* @param \net\authorize\api\contract\v1\UserFieldType[] $userField
* @return self
*/
public function setUserField(array $userField)
{
}
}
}
namespace net\authorize\api\contract\v1 {
/**
* Class representing PayPalType
*
*
* XSD Type: payPalType
*/
class PayPalType
{
/**
* Gets as successUrl
*
* @return string
*/
public function getSuccessUrl()
{
}
/**
* Sets a new successUrl
*
* @param string $successUrl
* @return self
*/
public function setSuccessUrl($successUrl)
{
}
/**
* Gets as cancelUrl
*
* @return string
*/
public function getCancelUrl()
{
}
/**
* Sets a new cancelUrl
*
* @param string $cancelUrl
* @return self
*/
public function setCancelUrl($cancelUrl)
{
}
/**
* Gets as paypalLc
*
* @return string
*/
public function getPaypalLc()
{
}
/**
* Sets a new paypalLc
*
* @param string $paypalLc
* @return self
*/
public function setPaypalLc($paypalLc)
{
}
/**
* Gets as paypalHdrImg
*
* @return string
*/
public function getPaypalHdrImg()
{
}
/**
* Sets a new paypalHdrImg
*
* @param string $paypalHdrImg
* @return self
*/
public function setPaypalHdrImg($paypalHdrImg)
{
}
/**
* Gets as paypalPayflowcolor
*
* @return string
*/
public function getPaypalPayflowcolor()
{
}
/**
* Sets a new paypalPayflowcolor
*
* @param string $paypalPayflowcolor
* @return self
*/
public function setPaypalPayflowcolor($paypalPayflowcolor)
{
}
/**
* Gets as payerID
*
* @return string
*/
public function getPayerID()
{
}
/**
* Sets a new payerID
*
* @param string $payerID
* @return self
*/
public function setPayerID($payerID)
{
}
}
/**
* Class representing CustomerPaymentProfileBaseType
*
*
* XSD Type: customerPaymentProfileBaseType
*/
class CustomerPaymentProfileBaseType
{
/**
* Gets as customerType
*
* @return string
*/
public function getCustomerType()
{
}
/**
* Sets a new customerType
*
* @param string $customerType
* @return self
*/
public function setCustomerType($customerType)
{
}
/**
* Gets as billTo
*
* @return \net\authorize\api\contract\v1\CustomerAddressType
*/
public function getBillTo()
{
}
/**
* Sets a new billTo
*
* @param \net\authorize\api\contract\v1\CustomerAddressType $billTo
* @return self
*/
public function setBillTo(\net\authorize\api\contract\v1\CustomerAddressType $billTo)
{
}
}
/**
* Class representing CustomerPaymentProfileType
*
*
* XSD Type: customerPaymentProfileType
*/
class CustomerPaymentProfileType extends \net\authorize\api\contract\v1\CustomerPaymentProfileBaseType
{
/**
* Gets as payment
*
* @return \net\authorize\api\contract\v1\PaymentType
*/
public function getPayment()
{
}
/**
* Sets a new payment
*
* @param \net\authorize\api\contract\v1\PaymentType $payment
* @return self
*/
public function setPayment(\net\authorize\api\contract\v1\PaymentType $payment)
{
}
/**
* Gets as driversLicense
*
* @return \net\authorize\api\contract\v1\DriversLicenseType
*/
public function getDriversLicense()
{
}
/**
* Sets a new driversLicense
*
* @param \net\authorize\api\contract\v1\DriversLicenseType $driversLicense
* @return self
*/
public function setDriversLicense(\net\authorize\api\contract\v1\DriversLicenseType $driversLicense)
{
}
/**
* Gets as taxId
*
* @return string
*/
public function getTaxId()
{
}
/**
* Sets a new taxId
*
* @param string $taxId
* @return self
*/
public function setTaxId($taxId)
{
}
/**
* Gets as defaultPaymentProfile
*
* @return boolean
*/
public function getDefaultPaymentProfile()
{
}
/**
* Sets a new defaultPaymentProfile
*
* @param boolean $defaultPaymentProfile
* @return self
*/
public function setDefaultPaymentProfile($defaultPaymentProfile)
{
}
}
/**
* Class representing CustomerPaymentProfileExType
*
*
* XSD Type: customerPaymentProfileExType
*/
class CustomerPaymentProfileExType extends \net\authorize\api\contract\v1\CustomerPaymentProfileType
{
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
}
}
namespace net\authorize\api\contract\v1\TransactionResponseType {
/**
* Class representing SecureAcceptanceAType
*/
class SecureAcceptanceAType
{
/**
* Gets as secureAcceptanceUrl
*
* @return string
*/
public function getSecureAcceptanceUrl()
{
}
/**
* Sets a new secureAcceptanceUrl
*
* @param string $secureAcceptanceUrl
* @return self
*/
public function setSecureAcceptanceUrl($secureAcceptanceUrl)
{
}
/**
* Gets as payerID
*
* @return string
*/
public function getPayerID()
{
}
/**
* Sets a new payerID
*
* @param string $payerID
* @return self
*/
public function setPayerID($payerID)
{
}
/**
* Gets as payerEmail
*
* @return string
*/
public function getPayerEmail()
{
}
/**
* Sets a new payerEmail
*
* @param string $payerEmail
* @return self
*/
public function setPayerEmail($payerEmail)
{
}
}
/**
* Class representing EmvResponseAType
*/
class EmvResponseAType
{
/**
* Gets as tlvData
*
* @return string
*/
public function getTlvData()
{
}
/**
* Sets a new tlvData
*
* @param string $tlvData
* @return self
*/
public function setTlvData($tlvData)
{
}
/**
* Adds as tag
*
* @return self
* @param \net\authorize\api\contract\v1\EmvTagType $tag
*/
public function addToTags(\net\authorize\api\contract\v1\EmvTagType $tag)
{
}
/**
* isset tags
*
* @param scalar $index
* @return boolean
*/
public function issetTags($index)
{
}
/**
* unset tags
*
* @param scalar $index
* @return void
*/
public function unsetTags($index)
{
}
/**
* Gets as tags
*
* @return \net\authorize\api\contract\v1\EmvTagType[]
*/
public function getTags()
{
}
/**
* Sets a new tags
*
* @param \net\authorize\api\contract\v1\EmvTagType[] $tags
* @return self
*/
public function setTags(array $tags)
{
}
}
/**
* Class representing UserFieldsAType
*/
class UserFieldsAType
{
/**
* Adds as userField
*
* @return self
* @param \net\authorize\api\contract\v1\UserFieldType $userField
*/
public function addToUserField(\net\authorize\api\contract\v1\UserFieldType $userField)
{
}
/**
* isset userField
*
* @param scalar $index
* @return boolean
*/
public function issetUserField($index)
{
}
/**
* unset userField
*
* @param scalar $index
* @return void
*/
public function unsetUserField($index)
{
}
/**
* Gets as userField
*
* @return \net\authorize\api\contract\v1\UserFieldType[]
*/
public function getUserField()
{
}
/**
* Sets a new userField
*
* @param \net\authorize\api\contract\v1\UserFieldType[] $userField
* @return self
*/
public function setUserField(array $userField)
{
}
}
}
namespace net\authorize\api\contract\v1\TransactionResponseType\SplitTenderPaymentsAType {
/**
* Class representing SplitTenderPaymentAType
*/
class SplitTenderPaymentAType
{
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
/**
* Gets as responseCode
*
* @return string
*/
public function getResponseCode()
{
}
/**
* Sets a new responseCode
*
* @param string $responseCode
* @return self
*/
public function setResponseCode($responseCode)
{
}
/**
* Gets as responseToCustomer
*
* @return string
*/
public function getResponseToCustomer()
{
}
/**
* Sets a new responseToCustomer
*
* @param string $responseToCustomer
* @return self
*/
public function setResponseToCustomer($responseToCustomer)
{
}
/**
* Gets as authCode
*
* @return string
*/
public function getAuthCode()
{
}
/**
* Sets a new authCode
*
* @param string $authCode
* @return self
*/
public function setAuthCode($authCode)
{
}
/**
* Gets as accountNumber
*
* @return string
*/
public function getAccountNumber()
{
}
/**
* Sets a new accountNumber
*
* @param string $accountNumber
* @return self
*/
public function setAccountNumber($accountNumber)
{
}
/**
* Gets as accountType
*
* @return string
*/
public function getAccountType()
{
}
/**
* Sets a new accountType
*
* @param string $accountType
* @return self
*/
public function setAccountType($accountType)
{
}
/**
* Gets as requestedAmount
*
* @return string
*/
public function getRequestedAmount()
{
}
/**
* Sets a new requestedAmount
*
* @param string $requestedAmount
* @return self
*/
public function setRequestedAmount($requestedAmount)
{
}
/**
* Gets as approvedAmount
*
* @return string
*/
public function getApprovedAmount()
{
}
/**
* Sets a new approvedAmount
*
* @param string $approvedAmount
* @return self
*/
public function setApprovedAmount($approvedAmount)
{
}
/**
* Gets as balanceOnCard
*
* @return string
*/
public function getBalanceOnCard()
{
}
/**
* Sets a new balanceOnCard
*
* @param string $balanceOnCard
* @return self
*/
public function setBalanceOnCard($balanceOnCard)
{
}
}
}
namespace net\authorize\api\contract\v1\TransactionResponseType\MessagesAType {
/**
* Class representing MessageAType
*/
class MessageAType
{
/**
* Gets as code
*
* @return string
*/
public function getCode()
{
}
/**
* Sets a new code
*
* @param string $code
* @return self
*/
public function setCode($code)
{
}
/**
* Gets as description
*
* @return string
*/
public function getDescription()
{
}
/**
* Sets a new description
*
* @param string $description
* @return self
*/
public function setDescription($description)
{
}
}
}
namespace net\authorize\api\contract\v1\TransactionResponseType\ErrorsAType {
/**
* Class representing ErrorAType
*/
class ErrorAType
{
/**
* Gets as errorCode
*
* @return string
*/
public function getErrorCode()
{
}
/**
* Sets a new errorCode
*
* @param string $errorCode
* @return self
*/
public function setErrorCode($errorCode)
{
}
/**
* Gets as errorText
*
* @return string
*/
public function getErrorText()
{
}
/**
* Sets a new errorText
*
* @param string $errorText
* @return self
*/
public function setErrorText($errorText)
{
}
}
}
namespace net\authorize\api\contract\v1\TransactionResponseType {
/**
* Class representing MessagesAType
*/
class MessagesAType
{
/**
* Adds as message
*
* @return self
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\MessagesAType\MessageAType
* $message
*/
public function addToMessage(\net\authorize\api\contract\v1\TransactionResponseType\MessagesAType\MessageAType $message)
{
}
/**
* isset message
*
* @param scalar $index
* @return boolean
*/
public function issetMessage($index)
{
}
/**
* unset message
*
* @param scalar $index
* @return void
*/
public function unsetMessage($index)
{
}
/**
* Gets as message
*
* @return
* \net\authorize\api\contract\v1\TransactionResponseType\MessagesAType\MessageAType[]
*/
public function getMessage()
{
}
/**
* Sets a new message
*
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\MessagesAType\MessageAType[]
* $message
* @return self
*/
public function setMessage(array $message)
{
}
}
}
namespace net\authorize\api\contract\v1\TransactionResponseType\EmvResponseAType {
/**
* Class representing TagsAType
*/
class TagsAType
{
/**
* Adds as tag
*
* @return self
* @param \net\authorize\api\contract\v1\EmvTagType $tag
*/
public function addToTag(\net\authorize\api\contract\v1\EmvTagType $tag)
{
}
/**
* isset tag
*
* @param scalar $index
* @return boolean
*/
public function issetTag($index)
{
}
/**
* unset tag
*
* @param scalar $index
* @return void
*/
public function unsetTag($index)
{
}
/**
* Gets as tag
*
* @return \net\authorize\api\contract\v1\EmvTagType[]
*/
public function getTag()
{
}
/**
* Sets a new tag
*
* @param \net\authorize\api\contract\v1\EmvTagType[] $tag
* @return self
*/
public function setTag(array $tag)
{
}
}
}
namespace net\authorize\api\contract\v1\TransactionResponseType {
/**
* Class representing ErrorsAType
*/
class ErrorsAType
{
/**
* Adds as error
*
* @return self
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\ErrorsAType\ErrorAType
* $error
*/
public function addToError(\net\authorize\api\contract\v1\TransactionResponseType\ErrorsAType\ErrorAType $error)
{
}
/**
* isset error
*
* @param scalar $index
* @return boolean
*/
public function issetError($index)
{
}
/**
* unset error
*
* @param scalar $index
* @return void
*/
public function unsetError($index)
{
}
/**
* Gets as error
*
* @return
* \net\authorize\api\contract\v1\TransactionResponseType\ErrorsAType\ErrorAType[]
*/
public function getError()
{
}
/**
* Sets a new error
*
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\ErrorsAType\ErrorAType[]
* $error
* @return self
*/
public function setError(array $error)
{
}
}
/**
* Class representing SplitTenderPaymentsAType
*/
class SplitTenderPaymentsAType
{
/**
* Adds as splitTenderPayment
*
* @return self
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\SplitTenderPaymentsAType\SplitTenderPaymentAType
* $splitTenderPayment
*/
public function addToSplitTenderPayment(\net\authorize\api\contract\v1\TransactionResponseType\SplitTenderPaymentsAType\SplitTenderPaymentAType $splitTenderPayment)
{
}
/**
* isset splitTenderPayment
*
* @param scalar $index
* @return boolean
*/
public function issetSplitTenderPayment($index)
{
}
/**
* unset splitTenderPayment
*
* @param scalar $index
* @return void
*/
public function unsetSplitTenderPayment($index)
{
}
/**
* Gets as splitTenderPayment
*
* @return
* \net\authorize\api\contract\v1\TransactionResponseType\SplitTenderPaymentsAType\SplitTenderPaymentAType[]
*/
public function getSplitTenderPayment()
{
}
/**
* Sets a new splitTenderPayment
*
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\SplitTenderPaymentsAType\SplitTenderPaymentAType[]
* $splitTenderPayment
* @return self
*/
public function setSplitTenderPayment(array $splitTenderPayment)
{
}
}
/**
* Class representing PrePaidCardAType
*/
class PrePaidCardAType
{
/**
* Gets as requestedAmount
*
* @return string
*/
public function getRequestedAmount()
{
}
/**
* Sets a new requestedAmount
*
* @param string $requestedAmount
* @return self
*/
public function setRequestedAmount($requestedAmount)
{
}
/**
* Gets as approvedAmount
*
* @return string
*/
public function getApprovedAmount()
{
}
/**
* Sets a new approvedAmount
*
* @param string $approvedAmount
* @return self
*/
public function setApprovedAmount($approvedAmount)
{
}
/**
* Gets as balanceOnCard
*
* @return string
*/
public function getBalanceOnCard()
{
}
/**
* Sets a new balanceOnCard
*
* @param string $balanceOnCard
* @return self
*/
public function setBalanceOnCard($balanceOnCard)
{
}
}
}
namespace net\authorize\api\contract\v1 {
/**
* Class representing TransactionDetailsType
*
*
* XSD Type: transactionDetailsType
*/
class TransactionDetailsType
{
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
/**
* Gets as refTransId
*
* @return string
*/
public function getRefTransId()
{
}
/**
* Sets a new refTransId
*
* @param string $refTransId
* @return self
*/
public function setRefTransId($refTransId)
{
}
/**
* Gets as splitTenderId
*
* @return string
*/
public function getSplitTenderId()
{
}
/**
* Sets a new splitTenderId
*
* @param string $splitTenderId
* @return self
*/
public function setSplitTenderId($splitTenderId)
{
}
/**
* Gets as submitTimeUTC
*
* @return \DateTime
*/
public function getSubmitTimeUTC()
{
}
/**
* Sets a new submitTimeUTC
*
* @param \DateTime $submitTimeUTC
* @return self
*/
public function setSubmitTimeUTC(\DateTime $submitTimeUTC)
{
}
/**
* Gets as submitTimeLocal
*
* @return \DateTime
*/
public function getSubmitTimeLocal()
{
}
/**
* Sets a new submitTimeLocal
*
* @param \DateTime $submitTimeLocal
* @return self
*/
public function setSubmitTimeLocal(\DateTime $submitTimeLocal)
{
}
/**
* Gets as transactionType
*
* @return string
*/
public function getTransactionType()
{
}
/**
* Sets a new transactionType
*
* @param string $transactionType
* @return self
*/
public function setTransactionType($transactionType)
{
}
/**
* Gets as transactionStatus
*
* @return string
*/
public function getTransactionStatus()
{
}
/**
* Sets a new transactionStatus
*
* @param string $transactionStatus
* @return self
*/
public function setTransactionStatus($transactionStatus)
{
}
/**
* Gets as responseCode
*
* @return integer
*/
public function getResponseCode()
{
}
/**
* Sets a new responseCode
*
* @param integer $responseCode
* @return self
*/
public function setResponseCode($responseCode)
{
}
/**
* Gets as responseReasonCode
*
* @return integer
*/
public function getResponseReasonCode()
{
}
/**
* Sets a new responseReasonCode
*
* @param integer $responseReasonCode
* @return self
*/
public function setResponseReasonCode($responseReasonCode)
{
}
/**
* Gets as subscription
*
* @return \net\authorize\api\contract\v1\SubscriptionPaymentType
*/
public function getSubscription()
{
}
/**
* Sets a new subscription
*
* @param \net\authorize\api\contract\v1\SubscriptionPaymentType $subscription
* @return self
*/
public function setSubscription(\net\authorize\api\contract\v1\SubscriptionPaymentType $subscription)
{
}
/**
* Gets as responseReasonDescription
*
* @return string
*/
public function getResponseReasonDescription()
{
}
/**
* Sets a new responseReasonDescription
*
* @param string $responseReasonDescription
* @return self
*/
public function setResponseReasonDescription($responseReasonDescription)
{
}
/**
* Gets as authCode
*
* @return string
*/
public function getAuthCode()
{
}
/**
* Sets a new authCode
*
* @param string $authCode
* @return self
*/
public function setAuthCode($authCode)
{
}
/**
* Gets as aVSResponse
*
* @return string
*/
public function getAVSResponse()
{
}
/**
* Sets a new aVSResponse
*
* @param string $aVSResponse
* @return self
*/
public function setAVSResponse($aVSResponse)
{
}
/**
* Gets as cardCodeResponse
*
* @return string
*/
public function getCardCodeResponse()
{
}
/**
* Sets a new cardCodeResponse
*
* @param string $cardCodeResponse
* @return self
*/
public function setCardCodeResponse($cardCodeResponse)
{
}
/**
* Gets as cAVVResponse
*
* @return string
*/
public function getCAVVResponse()
{
}
/**
* Sets a new cAVVResponse
*
* @param string $cAVVResponse
* @return self
*/
public function setCAVVResponse($cAVVResponse)
{
}
/**
* Gets as fDSFilterAction
*
* @return string
*/
public function getFDSFilterAction()
{
}
/**
* Sets a new fDSFilterAction
*
* @param string $fDSFilterAction
* @return self
*/
public function setFDSFilterAction($fDSFilterAction)
{
}
/**
* Adds as fDSFilter
*
* @return self
* @param \net\authorize\api\contract\v1\FDSFilterType $fDSFilter
*/
public function addToFDSFilters(\net\authorize\api\contract\v1\FDSFilterType $fDSFilter)
{
}
/**
* isset fDSFilters
*
* @param scalar $index
* @return boolean
*/
public function issetFDSFilters($index)
{
}
/**
* unset fDSFilters
*
* @param scalar $index
* @return void
*/
public function unsetFDSFilters($index)
{
}
/**
* Gets as fDSFilters
*
* @return \net\authorize\api\contract\v1\FDSFilterType[]
*/
public function getFDSFilters()
{
}
/**
* Sets a new fDSFilters
*
* @param \net\authorize\api\contract\v1\FDSFilterType[] $fDSFilters
* @return self
*/
public function setFDSFilters(array $fDSFilters)
{
}
/**
* Gets as batch
*
* @return \net\authorize\api\contract\v1\BatchDetailsType
*/
public function getBatch()
{
}
/**
* Sets a new batch
*
* @param \net\authorize\api\contract\v1\BatchDetailsType $batch
* @return self
*/
public function setBatch(\net\authorize\api\contract\v1\BatchDetailsType $batch)
{
}
/**
* Gets as order
*
* @return \net\authorize\api\contract\v1\OrderExType
*/
public function getOrder()
{
}
/**
* Sets a new order
*
* @param \net\authorize\api\contract\v1\OrderExType $order
* @return self
*/
public function setOrder(\net\authorize\api\contract\v1\OrderExType $order)
{
}
/**
* Gets as requestedAmount
*
* @return float
*/
public function getRequestedAmount()
{
}
/**
* Sets a new requestedAmount
*
* @param float $requestedAmount
* @return self
*/
public function setRequestedAmount($requestedAmount)
{
}
/**
* Gets as authAmount
*
* @return float
*/
public function getAuthAmount()
{
}
/**
* Sets a new authAmount
*
* @param float $authAmount
* @return self
*/
public function setAuthAmount($authAmount)
{
}
/**
* Gets as settleAmount
*
* @return float
*/
public function getSettleAmount()
{
}
/**
* Sets a new settleAmount
*
* @param float $settleAmount
* @return self
*/
public function setSettleAmount($settleAmount)
{
}
/**
* Gets as tax
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getTax()
{
}
/**
* Sets a new tax
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $tax
* @return self
*/
public function setTax(\net\authorize\api\contract\v1\ExtendedAmountType $tax)
{
}
/**
* Gets as shipping
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getShipping()
{
}
/**
* Sets a new shipping
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $shipping
* @return self
*/
public function setShipping(\net\authorize\api\contract\v1\ExtendedAmountType $shipping)
{
}
/**
* Gets as duty
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getDuty()
{
}
/**
* Sets a new duty
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $duty
* @return self
*/
public function setDuty(\net\authorize\api\contract\v1\ExtendedAmountType $duty)
{
}
/**
* Adds as lineItem
*
* @return self
* @param \net\authorize\api\contract\v1\LineItemType $lineItem
*/
public function addToLineItems(\net\authorize\api\contract\v1\LineItemType $lineItem)
{
}
/**
* isset lineItems
*
* @param scalar $index
* @return boolean
*/
public function issetLineItems($index)
{
}
/**
* unset lineItems
*
* @param scalar $index
* @return void
*/
public function unsetLineItems($index)
{
}
/**
* Gets as lineItems
*
* @return \net\authorize\api\contract\v1\LineItemType[]
*/
public function getLineItems()
{
}
/**
* Sets a new lineItems
*
* @param \net\authorize\api\contract\v1\LineItemType[] $lineItems
* @return self
*/
public function setLineItems(array $lineItems)
{
}
/**
* Gets as prepaidBalanceRemaining
*
* @return float
*/
public function getPrepaidBalanceRemaining()
{
}
/**
* Sets a new prepaidBalanceRemaining
*
* @param float $prepaidBalanceRemaining
* @return self
*/
public function setPrepaidBalanceRemaining($prepaidBalanceRemaining)
{
}
/**
* Gets as taxExempt
*
* @return boolean
*/
public function getTaxExempt()
{
}
/**
* Sets a new taxExempt
*
* @param boolean $taxExempt
* @return self
*/
public function setTaxExempt($taxExempt)
{
}
/**
* Gets as payment
*
* @return \net\authorize\api\contract\v1\PaymentMaskedType
*/
public function getPayment()
{
}
/**
* Sets a new payment
*
* @param \net\authorize\api\contract\v1\PaymentMaskedType $payment
* @return self
*/
public function setPayment(\net\authorize\api\contract\v1\PaymentMaskedType $payment)
{
}
/**
* Gets as customer
*
* @return \net\authorize\api\contract\v1\CustomerDataType
*/
public function getCustomer()
{
}
/**
* Sets a new customer
*
* @param \net\authorize\api\contract\v1\CustomerDataType $customer
* @return self
*/
public function setCustomer(\net\authorize\api\contract\v1\CustomerDataType $customer)
{
}
/**
* Gets as billTo
*
* @return \net\authorize\api\contract\v1\CustomerAddressType
*/
public function getBillTo()
{
}
/**
* Sets a new billTo
*
* @param \net\authorize\api\contract\v1\CustomerAddressType $billTo
* @return self
*/
public function setBillTo(\net\authorize\api\contract\v1\CustomerAddressType $billTo)
{
}
/**
* Gets as shipTo
*
* @return \net\authorize\api\contract\v1\NameAndAddressType
*/
public function getShipTo()
{
}
/**
* Sets a new shipTo
*
* @param \net\authorize\api\contract\v1\NameAndAddressType $shipTo
* @return self
*/
public function setShipTo(\net\authorize\api\contract\v1\NameAndAddressType $shipTo)
{
}
/**
* Gets as recurringBilling
*
* @return boolean
*/
public function getRecurringBilling()
{
}
/**
* Sets a new recurringBilling
*
* @param boolean $recurringBilling
* @return self
*/
public function setRecurringBilling($recurringBilling)
{
}
/**
* Gets as customerIP
*
* @return string
*/
public function getCustomerIP()
{
}
/**
* Sets a new customerIP
*
* @param string $customerIP
* @return self
*/
public function setCustomerIP($customerIP)
{
}
/**
* Gets as product
*
* @return string
*/
public function getProduct()
{
}
/**
* Sets a new product
*
* @param string $product
* @return self
*/
public function setProduct($product)
{
}
/**
* Gets as entryMode
*
* @return string
*/
public function getEntryMode()
{
}
/**
* Sets a new entryMode
*
* @param string $entryMode
* @return self
*/
public function setEntryMode($entryMode)
{
}
/**
* Gets as marketType
*
* @return string
*/
public function getMarketType()
{
}
/**
* Sets a new marketType
*
* @param string $marketType
* @return self
*/
public function setMarketType($marketType)
{
}
/**
* Gets as mobileDeviceId
*
* @return string
*/
public function getMobileDeviceId()
{
}
/**
* Sets a new mobileDeviceId
*
* @param string $mobileDeviceId
* @return self
*/
public function setMobileDeviceId($mobileDeviceId)
{
}
/**
* Gets as customerSignature
*
* @return string
*/
public function getCustomerSignature()
{
}
/**
* Sets a new customerSignature
*
* @param string $customerSignature
* @return self
*/
public function setCustomerSignature($customerSignature)
{
}
/**
* Adds as returnedItem
*
* @return self
* @param \net\authorize\api\contract\v1\ReturnedItemType $returnedItem
*/
public function addToReturnedItems(\net\authorize\api\contract\v1\ReturnedItemType $returnedItem)
{
}
/**
* isset returnedItems
*
* @param scalar $index
* @return boolean
*/
public function issetReturnedItems($index)
{
}
/**
* unset returnedItems
*
* @param scalar $index
* @return void
*/
public function unsetReturnedItems($index)
{
}
/**
* Gets as returnedItems
*
* @return \net\authorize\api\contract\v1\ReturnedItemType[]
*/
public function getReturnedItems()
{
}
/**
* Sets a new returnedItems
*
* @param \net\authorize\api\contract\v1\ReturnedItemType[] $returnedItems
* @return self
*/
public function setReturnedItems(array $returnedItems)
{
}
/**
* Gets as solution
*
* @return \net\authorize\api\contract\v1\SolutionType
*/
public function getSolution()
{
}
/**
* Sets a new solution
*
* @param \net\authorize\api\contract\v1\SolutionType $solution
* @return self
*/
public function setSolution(\net\authorize\api\contract\v1\SolutionType $solution)
{
}
/**
* Adds as tag
*
* @return self
* @param
* \net\authorize\api\contract\v1\TransactionDetailsType\EmvDetailsAType\TagAType
* $tag
*/
public function addToEmvDetails(\net\authorize\api\contract\v1\TransactionDetailsType\EmvDetailsAType\TagAType $tag)
{
}
/**
* isset emvDetails
*
* @param scalar $index
* @return boolean
*/
public function issetEmvDetails($index)
{
}
/**
* unset emvDetails
*
* @param scalar $index
* @return void
*/
public function unsetEmvDetails($index)
{
}
/**
* Gets as emvDetails
*
* @return
* \net\authorize\api\contract\v1\TransactionDetailsType\EmvDetailsAType\TagAType[]
*/
public function getEmvDetails()
{
}
/**
* Sets a new emvDetails
*
* @param
* \net\authorize\api\contract\v1\TransactionDetailsType\EmvDetailsAType\TagAType[]
* $emvDetails
* @return self
*/
public function setEmvDetails(array $emvDetails)
{
}
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\CustomerProfileIdType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\CustomerProfileIdType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\CustomerProfileIdType $profile)
{
}
/**
* Gets as surcharge
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getSurcharge()
{
}
/**
* Sets a new surcharge
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $surcharge
* @return self
*/
public function setSurcharge(\net\authorize\api\contract\v1\ExtendedAmountType $surcharge)
{
}
/**
* Gets as employeeId
*
* @return string
*/
public function getEmployeeId()
{
}
/**
* Sets a new employeeId
*
* @param string $employeeId
* @return self
*/
public function setEmployeeId($employeeId)
{
}
/**
* Gets as tip
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getTip()
{
}
/**
* Sets a new tip
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $tip
* @return self
*/
public function setTip(\net\authorize\api\contract\v1\ExtendedAmountType $tip)
{
}
}
/**
* Class representing KeyBlockType
*
*
* XSD Type: KeyBlock
*/
class KeyBlockType
{
/**
* Gets as value
*
* @return \net\authorize\api\contract\v1\KeyValueType
*/
public function getValue()
{
}
/**
* Sets a new value
*
* @param \net\authorize\api\contract\v1\KeyValueType $value
* @return self
*/
public function setValue(\net\authorize\api\contract\v1\KeyValueType $value)
{
}
}
/**
* Class representing ArrayOfSettingType
*
*
* XSD Type: ArrayOfSetting
*/
class ArrayOfSettingType
{
/**
* Adds as setting
*
* @return self
* @param \net\authorize\api\contract\v1\SettingType $setting
*/
public function addToSetting(\net\authorize\api\contract\v1\SettingType $setting)
{
}
/**
* isset setting
*
* @param scalar $index
* @return boolean
*/
public function issetSetting($index)
{
}
/**
* unset setting
*
* @param scalar $index
* @return void
*/
public function unsetSetting($index)
{
}
/**
* Gets as setting
*
* @return \net\authorize\api\contract\v1\SettingType[]
*/
public function getSetting()
{
}
/**
* Sets a new setting
*
* @param \net\authorize\api\contract\v1\SettingType[] $setting
* @return self
*/
public function setSetting(array $setting)
{
}
}
/**
* Class representing EmailSettingsType
*
* Allowed values for settingName are: headerEmailReceipt and footerEmailReceipt
* XSD Type: emailSettingsType
*/
class EmailSettingsType extends \net\authorize\api\contract\v1\ArrayOfSettingType
{
/**
* Gets as version
*
* @return integer
*/
public function getVersion()
{
}
/**
* Sets a new version
*
* @param integer $version
* @return self
*/
public function setVersion($version)
{
}
}
/**
* Class representing WebCheckOutDataType
*
*
* XSD Type: webCheckOutDataType
*/
class WebCheckOutDataType
{
/**
* Gets as type
*
* @return string
*/
public function getType()
{
}
/**
* Sets a new type
*
* @param string $type
* @return self
*/
public function setType($type)
{
}
/**
* Gets as id
*
* @return string
*/
public function getId()
{
}
/**
* Sets a new id
*
* @param string $id
* @return self
*/
public function setId($id)
{
}
/**
* Gets as token
*
* @return \net\authorize\api\contract\v1\WebCheckOutDataTypeTokenType
*/
public function getToken()
{
}
/**
* Sets a new token
*
* @param \net\authorize\api\contract\v1\WebCheckOutDataTypeTokenType $token
* @return self
*/
public function setToken(\net\authorize\api\contract\v1\WebCheckOutDataTypeTokenType $token)
{
}
/**
* Gets as bankToken
*
* @return \net\authorize\api\contract\v1\BankAccountType
*/
public function getBankToken()
{
}
/**
* Sets a new bankToken
*
* @param \net\authorize\api\contract\v1\BankAccountType $bankToken
* @return self
*/
public function setBankToken(\net\authorize\api\contract\v1\BankAccountType $bankToken)
{
}
}
/**
* Class representing IsAliveRequest
*/
class IsAliveRequest
{
/**
* Gets as refId
*
* @return string
*/
public function getRefId()
{
}
/**
* Sets a new refId
*
* @param string $refId
* @return self
*/
public function setRefId($refId)
{
}
}
/**
* Class representing CreateCustomerProfileRequest
*/
class CreateCustomerProfileRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\CustomerProfileType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\CustomerProfileType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\CustomerProfileType $profile)
{
}
/**
* Gets as validationMode
*
* @return string
*/
public function getValidationMode()
{
}
/**
* Sets a new validationMode
*
* @param string $validationMode
* @return self
*/
public function setValidationMode($validationMode)
{
}
}
/**
* Class representing LogoutResponse
*/
class LogoutResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing TransactionListSortingType
*
*
* XSD Type: TransactionListSorting
*/
class TransactionListSortingType
{
/**
* Gets as orderBy
*
* @return string
*/
public function getOrderBy()
{
}
/**
* Sets a new orderBy
*
* @param string $orderBy
* @return self
*/
public function setOrderBy($orderBy)
{
}
/**
* Gets as orderDescending
*
* @return boolean
*/
public function getOrderDescending()
{
}
/**
* Sets a new orderDescending
*
* @param boolean $orderDescending
* @return self
*/
public function setOrderDescending($orderDescending)
{
}
}
/**
* Class representing CreateCustomerProfileTransactionRequest
*/
class CreateCustomerProfileTransactionRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as transaction
*
* @return \net\authorize\api\contract\v1\ProfileTransactionType
*/
public function getTransaction()
{
}
/**
* Sets a new transaction
*
* @param \net\authorize\api\contract\v1\ProfileTransactionType $transaction
* @return self
*/
public function setTransaction(\net\authorize\api\contract\v1\ProfileTransactionType $transaction)
{
}
/**
* Gets as extraOptions
*
* @return string
*/
public function getExtraOptions()
{
}
/**
* Sets a new extraOptions
*
* @param string $extraOptions
* @return self
*/
public function setExtraOptions($extraOptions)
{
}
}
/**
* Class representing GetHostedProfilePageResponse
*/
class GetHostedProfilePageResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as token
*
* @return string
*/
public function getToken()
{
}
/**
* Sets a new token
*
* @param string $token
* @return self
*/
public function setToken($token)
{
}
}
/**
* Class representing GetAUJobSummaryResponse
*/
class GetAUJobSummaryResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Adds as auResponse
*
* @return self
* @param \net\authorize\api\contract\v1\AuResponseType $auResponse
*/
public function addToAuSummary(\net\authorize\api\contract\v1\AuResponseType $auResponse)
{
}
/**
* isset auSummary
*
* @param scalar $index
* @return boolean
*/
public function issetAuSummary($index)
{
}
/**
* unset auSummary
*
* @param scalar $index
* @return void
*/
public function unsetAuSummary($index)
{
}
/**
* Gets as auSummary
*
* @return \net\authorize\api\contract\v1\AuResponseType[]
*/
public function getAuSummary()
{
}
/**
* Sets a new auSummary
*
* @param \net\authorize\api\contract\v1\AuResponseType[] $auSummary
* @return self
*/
public function setAuSummary(array $auSummary)
{
}
}
/**
* Class representing ARBUpdateSubscriptionResponse
*/
class ARBUpdateSubscriptionResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\CustomerProfileIdType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\CustomerProfileIdType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\CustomerProfileIdType $profile)
{
}
}
/**
* Class representing MobileDeviceType
*
*
* XSD Type: mobileDeviceType
*/
class MobileDeviceType
{
/**
* Gets as mobileDeviceId
*
* @return string
*/
public function getMobileDeviceId()
{
}
/**
* Sets a new mobileDeviceId
*
* @param string $mobileDeviceId
* @return self
*/
public function setMobileDeviceId($mobileDeviceId)
{
}
/**
* Gets as description
*
* @return string
*/
public function getDescription()
{
}
/**
* Sets a new description
*
* @param string $description
* @return self
*/
public function setDescription($description)
{
}
/**
* Gets as phoneNumber
*
* @return string
*/
public function getPhoneNumber()
{
}
/**
* Sets a new phoneNumber
*
* @param string $phoneNumber
* @return self
*/
public function setPhoneNumber($phoneNumber)
{
}
/**
* Gets as devicePlatform
*
* @return string
*/
public function getDevicePlatform()
{
}
/**
* Sets a new devicePlatform
*
* @param string $devicePlatform
* @return self
*/
public function setDevicePlatform($devicePlatform)
{
}
/**
* Gets as deviceActivation
*
* @return string
*/
public function getDeviceActivation()
{
}
/**
* Sets a new deviceActivation
*
* @param string $deviceActivation
* @return self
*/
public function setDeviceActivation($deviceActivation)
{
}
}
/**
* Class representing OrderType
*
*
* XSD Type: orderType
*/
class OrderType
{
/**
* Gets as invoiceNumber
*
* @return string
*/
public function getInvoiceNumber()
{
}
/**
* Sets a new invoiceNumber
*
* @param string $invoiceNumber
* @return self
*/
public function setInvoiceNumber($invoiceNumber)
{
}
/**
* Gets as description
*
* @return string
*/
public function getDescription()
{
}
/**
* Sets a new description
*
* @param string $description
* @return self
*/
public function setDescription($description)
{
}
}
/**
* Class representing MobileDeviceRegistrationResponse
*/
class MobileDeviceRegistrationResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing DeleteCustomerShippingAddressRequest
*/
class DeleteCustomerShippingAddressRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerAddressId
*
* @return string
*/
public function getCustomerAddressId()
{
}
/**
* Sets a new customerAddressId
*
* @param string $customerAddressId
* @return self
*/
public function setCustomerAddressId($customerAddressId)
{
}
}
/**
* Class representing EnumCollection
*/
class EnumCollection
{
/**
* Gets as customerProfileSummaryType
*
* @return \net\authorize\api\contract\v1\CustomerProfileSummaryType
*/
public function getCustomerProfileSummaryType()
{
}
/**
* Sets a new customerProfileSummaryType
*
* @param \net\authorize\api\contract\v1\CustomerProfileSummaryType
* $customerProfileSummaryType
* @return self
*/
public function setCustomerProfileSummaryType(\net\authorize\api\contract\v1\CustomerProfileSummaryType $customerProfileSummaryType)
{
}
/**
* Gets as paymentSimpleType
*
* @return \net\authorize\api\contract\v1\PaymentSimpleType
*/
public function getPaymentSimpleType()
{
}
/**
* Sets a new paymentSimpleType
*
* @param \net\authorize\api\contract\v1\PaymentSimpleType $paymentSimpleType
* @return self
*/
public function setPaymentSimpleType(\net\authorize\api\contract\v1\PaymentSimpleType $paymentSimpleType)
{
}
/**
* Gets as accountTypeEnum
*
* @return string
*/
public function getAccountTypeEnum()
{
}
/**
* Sets a new accountTypeEnum
*
* @param string $accountTypeEnum
* @return self
*/
public function setAccountTypeEnum($accountTypeEnum)
{
}
/**
* Gets as cardTypeEnum
*
* @return string
*/
public function getCardTypeEnum()
{
}
/**
* Sets a new cardTypeEnum
*
* @param string $cardTypeEnum
* @return self
*/
public function setCardTypeEnum($cardTypeEnum)
{
}
/**
* Gets as fDSFilterActionEnum
*
* @return string
*/
public function getFDSFilterActionEnum()
{
}
/**
* Sets a new fDSFilterActionEnum
*
* @param string $fDSFilterActionEnum
* @return self
*/
public function setFDSFilterActionEnum($fDSFilterActionEnum)
{
}
/**
* Gets as permissionsEnum
*
* @return string
*/
public function getPermissionsEnum()
{
}
/**
* Sets a new permissionsEnum
*
* @param string $permissionsEnum
* @return self
*/
public function setPermissionsEnum($permissionsEnum)
{
}
/**
* Gets as settingNameEnum
*
* @return string
*/
public function getSettingNameEnum()
{
}
/**
* Sets a new settingNameEnum
*
* @param string $settingNameEnum
* @return self
*/
public function setSettingNameEnum($settingNameEnum)
{
}
/**
* Gets as settlementStateEnum
*
* @return string
*/
public function getSettlementStateEnum()
{
}
/**
* Sets a new settlementStateEnum
*
* @param string $settlementStateEnum
* @return self
*/
public function setSettlementStateEnum($settlementStateEnum)
{
}
/**
* Gets as transactionStatusEnum
*
* @return string
*/
public function getTransactionStatusEnum()
{
}
/**
* Sets a new transactionStatusEnum
*
* @param string $transactionStatusEnum
* @return self
*/
public function setTransactionStatusEnum($transactionStatusEnum)
{
}
/**
* Gets as transactionTypeEnum
*
* @return string
*/
public function getTransactionTypeEnum()
{
}
/**
* Sets a new transactionTypeEnum
*
* @param string $transactionTypeEnum
* @return self
*/
public function setTransactionTypeEnum($transactionTypeEnum)
{
}
}
/**
* Class representing UpdateCustomerProfileResponse
*/
class UpdateCustomerProfileResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing GetUnsettledTransactionListRequest
*/
class GetUnsettledTransactionListRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as status
*
* @return string
*/
public function getStatus()
{
}
/**
* Sets a new status
*
* @param string $status
* @return self
*/
public function setStatus($status)
{
}
/**
* Gets as sorting
*
* @return \net\authorize\api\contract\v1\TransactionListSortingType
*/
public function getSorting()
{
}
/**
* Sets a new sorting
*
* @param \net\authorize\api\contract\v1\TransactionListSortingType $sorting
* @return self
*/
public function setSorting(\net\authorize\api\contract\v1\TransactionListSortingType $sorting)
{
}
/**
* Gets as paging
*
* @return \net\authorize\api\contract\v1\PagingType
*/
public function getPaging()
{
}
/**
* Sets a new paging
*
* @param \net\authorize\api\contract\v1\PagingType $paging
* @return self
*/
public function setPaging(\net\authorize\api\contract\v1\PagingType $paging)
{
}
}
/**
* Class representing UpdateSplitTenderGroupResponse
*/
class UpdateSplitTenderGroupResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing CustomerProfileSummaryType
*
*
* XSD Type: customerProfileSummaryType
*/
class CustomerProfileSummaryType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as description
*
* @return string
*/
public function getDescription()
{
}
/**
* Sets a new description
*
* @param string $description
* @return self
*/
public function setDescription($description)
{
}
/**
* Gets as merchantCustomerId
*
* @return string
*/
public function getMerchantCustomerId()
{
}
/**
* Sets a new merchantCustomerId
*
* @param string $merchantCustomerId
* @return self
*/
public function setMerchantCustomerId($merchantCustomerId)
{
}
/**
* Gets as email
*
* @return string
*/
public function getEmail()
{
}
/**
* Sets a new email
*
* @param string $email
* @return self
*/
public function setEmail($email)
{
}
/**
* Gets as createdDate
*
* @return \DateTime
*/
public function getCreatedDate()
{
}
/**
* Sets a new createdDate
*
* @param \DateTime $createdDate
* @return self
*/
public function setCreatedDate(\DateTime $createdDate)
{
}
}
/**
* Class representing ErrorResponse
*/
class ErrorResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing CreateCustomerPaymentProfileResponse
*/
class CreateCustomerPaymentProfileResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as validationDirectResponse
*
* @return string
*/
public function getValidationDirectResponse()
{
}
/**
* Sets a new validationDirectResponse
*
* @param string $validationDirectResponse
* @return self
*/
public function setValidationDirectResponse($validationDirectResponse)
{
}
}
/**
* Class representing GetAUJobDetailsRequest
*/
class GetAUJobDetailsRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as month
*
* @return string
*/
public function getMonth()
{
}
/**
* Sets a new month
*
* @param string $month
* @return self
*/
public function setMonth($month)
{
}
/**
* Gets as modifiedTypeFilter
*
* @return string
*/
public function getModifiedTypeFilter()
{
}
/**
* Sets a new modifiedTypeFilter
*
* @param string $modifiedTypeFilter
* @return self
*/
public function setModifiedTypeFilter($modifiedTypeFilter)
{
}
/**
* Gets as paging
*
* @return \net\authorize\api\contract\v1\PagingType
*/
public function getPaging()
{
}
/**
* Sets a new paging
*
* @param \net\authorize\api\contract\v1\PagingType $paging
* @return self
*/
public function setPaging(\net\authorize\api\contract\v1\PagingType $paging)
{
}
}
/**
* Class representing CreditCardTrackType
*
*
* XSD Type: creditCardTrackType
*/
class CreditCardTrackType
{
/**
* Gets as track1
*
* @return string
*/
public function getTrack1()
{
}
/**
* Sets a new track1
*
* @param string $track1
* @return self
*/
public function setTrack1($track1)
{
}
/**
* Gets as track2
*
* @return string
*/
public function getTrack2()
{
}
/**
* Sets a new track2
*
* @param string $track2
* @return self
*/
public function setTrack2($track2)
{
}
}
/**
* Class representing DriversLicenseType
*
*
* XSD Type: driversLicenseType
*/
class DriversLicenseType
{
/**
* Gets as number
*
* @return string
*/
public function getNumber()
{
}
/**
* Sets a new number
*
* @param string $number
* @return self
*/
public function setNumber($number)
{
}
/**
* Gets as state
*
* @return string
*/
public function getState()
{
}
/**
* Sets a new state
*
* @param string $state
* @return self
*/
public function setState($state)
{
}
/**
* Gets as dateOfBirth
*
* @return string
*/
public function getDateOfBirth()
{
}
/**
* Sets a new dateOfBirth
*
* @param string $dateOfBirth
* @return self
*/
public function setDateOfBirth($dateOfBirth)
{
}
}
/**
* Class representing GetCustomerProfileResponse
*/
class GetCustomerProfileResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\CustomerProfileMaskedType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\CustomerProfileMaskedType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\CustomerProfileMaskedType $profile)
{
}
/**
* Adds as subscriptionId
*
* @return self
* @param string $subscriptionId
*/
public function addToSubscriptionIds($subscriptionId)
{
}
/**
* isset subscriptionIds
*
* @param scalar $index
* @return boolean
*/
public function issetSubscriptionIds($index)
{
}
/**
* unset subscriptionIds
*
* @param scalar $index
* @return void
*/
public function unsetSubscriptionIds($index)
{
}
/**
* Gets as subscriptionIds
*
* @return string[]
*/
public function getSubscriptionIds()
{
}
/**
* Sets a new subscriptionIds
*
* @param string $subscriptionIds
* @return self
*/
public function setSubscriptionIds(array $subscriptionIds)
{
}
}
/**
* Class representing ExtendedAmountType
*
*
* XSD Type: extendedAmountType
*/
class ExtendedAmountType
{
/**
* Gets as amount
*
* @return float
*/
public function getAmount()
{
}
/**
* Sets a new amount
*
* @param float $amount
* @return self
*/
public function setAmount($amount)
{
}
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as description
*
* @return string
*/
public function getDescription()
{
}
/**
* Sets a new description
*
* @param string $description
* @return self
*/
public function setDescription($description)
{
}
}
/**
* Class representing CreateCustomerProfileFromTransactionRequest
*/
class CreateCustomerProfileFromTransactionRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
/**
* Gets as customer
*
* @return \net\authorize\api\contract\v1\CustomerProfileBaseType
*/
public function getCustomer()
{
}
/**
* Sets a new customer
*
* @param \net\authorize\api\contract\v1\CustomerProfileBaseType $customer
* @return self
*/
public function setCustomer(\net\authorize\api\contract\v1\CustomerProfileBaseType $customer)
{
}
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as defaultPaymentProfile
*
* @return boolean
*/
public function getDefaultPaymentProfile()
{
}
/**
* Sets a new defaultPaymentProfile
*
* @param boolean $defaultPaymentProfile
* @return self
*/
public function setDefaultPaymentProfile($defaultPaymentProfile)
{
}
/**
* Gets as defaultShippingAddress
*
* @return boolean
*/
public function getDefaultShippingAddress()
{
}
/**
* Sets a new defaultShippingAddress
*
* @param boolean $defaultShippingAddress
* @return self
*/
public function setDefaultShippingAddress($defaultShippingAddress)
{
}
/**
* Gets as profileType
*
* @return string
*/
public function getProfileType()
{
}
/**
* Sets a new profileType
*
* @param string $profileType
* @return self
*/
public function setProfileType($profileType)
{
}
}
/**
* Class representing SendCustomerTransactionReceiptRequest
*/
class SendCustomerTransactionReceiptRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
/**
* Gets as customerEmail
*
* @return string
*/
public function getCustomerEmail()
{
}
/**
* Sets a new customerEmail
*
* @param string $customerEmail
* @return self
*/
public function setCustomerEmail($customerEmail)
{
}
/**
* Gets as emailSettings
*
* @return \net\authorize\api\contract\v1\EmailSettingsType
*/
public function getEmailSettings()
{
}
/**
* Sets a new emailSettings
*
* @param \net\authorize\api\contract\v1\EmailSettingsType $emailSettings
* @return self
*/
public function setEmailSettings(\net\authorize\api\contract\v1\EmailSettingsType $emailSettings)
{
}
}
/**
* Class representing GetCustomerPaymentProfileListRequest
*/
class GetCustomerPaymentProfileListRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as searchType
*
* @return string
*/
public function getSearchType()
{
}
/**
* Sets a new searchType
*
* @param string $searchType
* @return self
*/
public function setSearchType($searchType)
{
}
/**
* Gets as month
*
* @return string
*/
public function getMonth()
{
}
/**
* Sets a new month
*
* @param string $month
* @return self
*/
public function setMonth($month)
{
}
/**
* Gets as sorting
*
* @return \net\authorize\api\contract\v1\CustomerPaymentProfileSortingType
*/
public function getSorting()
{
}
/**
* Sets a new sorting
*
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileSortingType $sorting
* @return self
*/
public function setSorting(\net\authorize\api\contract\v1\CustomerPaymentProfileSortingType $sorting)
{
}
/**
* Gets as paging
*
* @return \net\authorize\api\contract\v1\PagingType
*/
public function getPaging()
{
}
/**
* Sets a new paging
*
* @param \net\authorize\api\contract\v1\PagingType $paging
* @return self
*/
public function setPaging(\net\authorize\api\contract\v1\PagingType $paging)
{
}
}
/**
* Class representing DriversLicenseMaskedType
*
*
* XSD Type: driversLicenseMaskedType
*/
class DriversLicenseMaskedType
{
/**
* Gets as number
*
* @return string
*/
public function getNumber()
{
}
/**
* Sets a new number
*
* @param string $number
* @return self
*/
public function setNumber($number)
{
}
/**
* Gets as state
*
* @return string
*/
public function getState()
{
}
/**
* Sets a new state
*
* @param string $state
* @return self
*/
public function setState($state)
{
}
/**
* Gets as dateOfBirth
*
* @return string
*/
public function getDateOfBirth()
{
}
/**
* Sets a new dateOfBirth
*
* @param string $dateOfBirth
* @return self
*/
public function setDateOfBirth($dateOfBirth)
{
}
}
/**
* Class representing GetCustomerProfileIdsRequest
*/
class GetCustomerProfileIdsRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
}
/**
* Class representing SecurePaymentContainerRequest
*/
class SecurePaymentContainerRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as data
*
* @return \net\authorize\api\contract\v1\WebCheckOutDataType
*/
public function getData()
{
}
/**
* Sets a new data
*
* @param \net\authorize\api\contract\v1\WebCheckOutDataType $data
* @return self
*/
public function setData(\net\authorize\api\contract\v1\WebCheckOutDataType $data)
{
}
}
/**
* Class representing MobileDeviceLoginResponse
*/
class MobileDeviceLoginResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as merchantContact
*
* @return \net\authorize\api\contract\v1\MerchantContactType
*/
public function getMerchantContact()
{
}
/**
* Sets a new merchantContact
*
* @param \net\authorize\api\contract\v1\MerchantContactType $merchantContact
* @return self
*/
public function setMerchantContact(\net\authorize\api\contract\v1\MerchantContactType $merchantContact)
{
}
/**
* Adds as permission
*
* @return self
* @param \net\authorize\api\contract\v1\PermissionType $permission
*/
public function addToUserPermissions(\net\authorize\api\contract\v1\PermissionType $permission)
{
}
/**
* isset userPermissions
*
* @param scalar $index
* @return boolean
*/
public function issetUserPermissions($index)
{
}
/**
* unset userPermissions
*
* @param scalar $index
* @return void
*/
public function unsetUserPermissions($index)
{
}
/**
* Gets as userPermissions
*
* @return \net\authorize\api\contract\v1\PermissionType[]
*/
public function getUserPermissions()
{
}
/**
* Sets a new userPermissions
*
* @param \net\authorize\api\contract\v1\PermissionType[] $userPermissions
* @return self
*/
public function setUserPermissions(array $userPermissions)
{
}
/**
* Gets as merchantAccount
*
* @return \net\authorize\api\contract\v1\TransRetailInfoType
*/
public function getMerchantAccount()
{
}
/**
* Sets a new merchantAccount
*
* @param \net\authorize\api\contract\v1\TransRetailInfoType $merchantAccount
* @return self
*/
public function setMerchantAccount(\net\authorize\api\contract\v1\TransRetailInfoType $merchantAccount)
{
}
}
/**
* Class representing PaymentProfileType
*
*
* XSD Type: paymentProfile
*/
class PaymentProfileType
{
/**
* Gets as paymentProfileId
*
* @return string
*/
public function getPaymentProfileId()
{
}
/**
* Sets a new paymentProfileId
*
* @param string $paymentProfileId
* @return self
*/
public function setPaymentProfileId($paymentProfileId)
{
}
/**
* Gets as cardCode
*
* @return string
*/
public function getCardCode()
{
}
/**
* Sets a new cardCode
*
* @param string $cardCode
* @return self
*/
public function setCardCode($cardCode)
{
}
}
}
namespace net\authorize\api\contract\v1\TransactionDetailsType {
/**
* Class representing EmvDetailsAType
*/
class EmvDetailsAType
{
/**
* Adds as tag
*
* @return self
* @param
* \net\authorize\api\contract\v1\TransactionDetailsType\EmvDetailsAType\TagAType
* $tag
*/
public function addToTag(\net\authorize\api\contract\v1\TransactionDetailsType\EmvDetailsAType\TagAType $tag)
{
}
/**
* isset tag
*
* @param scalar $index
* @return boolean
*/
public function issetTag($index)
{
}
/**
* unset tag
*
* @param scalar $index
* @return void
*/
public function unsetTag($index)
{
}
/**
* Gets as tag
*
* @return
* \net\authorize\api\contract\v1\TransactionDetailsType\EmvDetailsAType\TagAType[]
*/
public function getTag()
{
}
/**
* Sets a new tag
*
* @param
* \net\authorize\api\contract\v1\TransactionDetailsType\EmvDetailsAType\TagAType[]
* $tag
* @return self
*/
public function setTag(array $tag)
{
}
}
}
namespace net\authorize\api\contract\v1\TransactionDetailsType\EmvDetailsAType {
/**
* Class representing TagAType
*/
class TagAType
{
/**
* Gets as tagId
*
* @return string
*/
public function getTagId()
{
}
/**
* Sets a new tagId
*
* @param string $tagId
* @return self
*/
public function setTagId($tagId)
{
}
/**
* Gets as data
*
* @return string
*/
public function getData()
{
}
/**
* Sets a new data
*
* @param string $data
* @return self
*/
public function setData($data)
{
}
}
}
namespace net\authorize\api\contract\v1 {
/**
* Class representing CreateTransactionResponse
*/
class CreateTransactionResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as transactionResponse
*
* @return \net\authorize\api\contract\v1\TransactionResponseType
*/
public function getTransactionResponse()
{
}
/**
* Sets a new transactionResponse
*
* @param \net\authorize\api\contract\v1\TransactionResponseType
* $transactionResponse
* @return self
*/
public function setTransactionResponse(\net\authorize\api\contract\v1\TransactionResponseType $transactionResponse)
{
}
/**
* Gets as profileResponse
*
* @return \net\authorize\api\contract\v1\CreateProfileResponseType
*/
public function getProfileResponse()
{
}
/**
* Sets a new profileResponse
*
* @param \net\authorize\api\contract\v1\CreateProfileResponseType $profileResponse
* @return self
*/
public function setProfileResponse(\net\authorize\api\contract\v1\CreateProfileResponseType $profileResponse)
{
}
}
/**
* Class representing CustomerDataType
*
*
* XSD Type: customerDataType
*/
class CustomerDataType
{
/**
* Gets as type
*
* @return string
*/
public function getType()
{
}
/**
* Sets a new type
*
* @param string $type
* @return self
*/
public function setType($type)
{
}
/**
* Gets as id
*
* @return string
*/
public function getId()
{
}
/**
* Sets a new id
*
* @param string $id
* @return self
*/
public function setId($id)
{
}
/**
* Gets as email
*
* @return string
*/
public function getEmail()
{
}
/**
* Sets a new email
*
* @param string $email
* @return self
*/
public function setEmail($email)
{
}
/**
* Gets as driversLicense
*
* @return \net\authorize\api\contract\v1\DriversLicenseType
*/
public function getDriversLicense()
{
}
/**
* Sets a new driversLicense
*
* @param \net\authorize\api\contract\v1\DriversLicenseType $driversLicense
* @return self
*/
public function setDriversLicense(\net\authorize\api\contract\v1\DriversLicenseType $driversLicense)
{
}
/**
* Gets as taxId
*
* @return string
*/
public function getTaxId()
{
}
/**
* Sets a new taxId
*
* @param string $taxId
* @return self
*/
public function setTaxId($taxId)
{
}
}
/**
* Class representing CreateProfileResponseType
*
*
* XSD Type: createProfileResponse
*/
class CreateProfileResponseType
{
/**
* Gets as messages
*
* @return \net\authorize\api\contract\v1\MessagesType
*/
public function getMessages()
{
}
/**
* Sets a new messages
*
* @param \net\authorize\api\contract\v1\MessagesType $messages
* @return self
*/
public function setMessages(\net\authorize\api\contract\v1\MessagesType $messages)
{
}
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Adds as numericString
*
* @return self
* @param string $numericString
*/
public function addToCustomerPaymentProfileIdList($numericString)
{
}
/**
* isset customerPaymentProfileIdList
*
* @param scalar $index
* @return boolean
*/
public function issetCustomerPaymentProfileIdList($index)
{
}
/**
* unset customerPaymentProfileIdList
*
* @param scalar $index
* @return void
*/
public function unsetCustomerPaymentProfileIdList($index)
{
}
/**
* Gets as customerPaymentProfileIdList
*
* @return string[]
*/
public function getCustomerPaymentProfileIdList()
{
}
/**
* Sets a new customerPaymentProfileIdList
*
* @param string $customerPaymentProfileIdList
* @return self
*/
public function setCustomerPaymentProfileIdList(array $customerPaymentProfileIdList)
{
}
/**
* Adds as numericString
*
* @return self
* @param string $numericString
*/
public function addToCustomerShippingAddressIdList($numericString)
{
}
/**
* isset customerShippingAddressIdList
*
* @param scalar $index
* @return boolean
*/
public function issetCustomerShippingAddressIdList($index)
{
}
/**
* unset customerShippingAddressIdList
*
* @param scalar $index
* @return void
*/
public function unsetCustomerShippingAddressIdList($index)
{
}
/**
* Gets as customerShippingAddressIdList
*
* @return string[]
*/
public function getCustomerShippingAddressIdList()
{
}
/**
* Sets a new customerShippingAddressIdList
*
* @param string $customerShippingAddressIdList
* @return self
*/
public function setCustomerShippingAddressIdList(array $customerShippingAddressIdList)
{
}
}
/**
* Class representing ARBCancelSubscriptionRequest
*/
class ARBCancelSubscriptionRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as subscriptionId
*
* @return string
*/
public function getSubscriptionId()
{
}
/**
* Sets a new subscriptionId
*
* @param string $subscriptionId
* @return self
*/
public function setSubscriptionId($subscriptionId)
{
}
}
/**
* Class representing ARBGetSubscriptionResponse
*/
class ARBGetSubscriptionResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as subscription
*
* @return \net\authorize\api\contract\v1\ARBSubscriptionMaskedType
*/
public function getSubscription()
{
}
/**
* Sets a new subscription
*
* @param \net\authorize\api\contract\v1\ARBSubscriptionMaskedType $subscription
* @return self
*/
public function setSubscription(\net\authorize\api\contract\v1\ARBSubscriptionMaskedType $subscription)
{
}
}
/**
* Class representing SendCustomerTransactionReceiptResponse
*/
class SendCustomerTransactionReceiptResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing GetAUJobDetailsResponse
*/
class GetAUJobDetailsResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as totalNumInResultSet
*
* @return integer
*/
public function getTotalNumInResultSet()
{
}
/**
* Sets a new totalNumInResultSet
*
* @param integer $totalNumInResultSet
* @return self
*/
public function setTotalNumInResultSet($totalNumInResultSet)
{
}
/**
* Gets as auDetails
*
* @return \net\authorize\api\contract\v1\ListOfAUDetailsType
*/
public function getAuDetails()
{
}
/**
* Sets a new auDetails
*
* @param \net\authorize\api\contract\v1\ListOfAUDetailsType $auDetails
* @return self
*/
public function setAuDetails(\net\authorize\api\contract\v1\ListOfAUDetailsType $auDetails)
{
}
}
/**
* Class representing BankAccountMaskedType
*
*
* XSD Type: bankAccountMaskedType
*/
class BankAccountMaskedType
{
/**
* Gets as accountType
*
* @return string
*/
public function getAccountType()
{
}
/**
* Sets a new accountType
*
* @param string $accountType
* @return self
*/
public function setAccountType($accountType)
{
}
/**
* Gets as routingNumber
*
* @return string
*/
public function getRoutingNumber()
{
}
/**
* Sets a new routingNumber
*
* @param string $routingNumber
* @return self
*/
public function setRoutingNumber($routingNumber)
{
}
/**
* Gets as accountNumber
*
* @return string
*/
public function getAccountNumber()
{
}
/**
* Sets a new accountNumber
*
* @param string $accountNumber
* @return self
*/
public function setAccountNumber($accountNumber)
{
}
/**
* Gets as nameOnAccount
*
* @return string
*/
public function getNameOnAccount()
{
}
/**
* Sets a new nameOnAccount
*
* @param string $nameOnAccount
* @return self
*/
public function setNameOnAccount($nameOnAccount)
{
}
/**
* Gets as echeckType
*
* @return string
*/
public function getEcheckType()
{
}
/**
* Sets a new echeckType
*
* @param string $echeckType
* @return self
*/
public function setEcheckType($echeckType)
{
}
/**
* Gets as bankName
*
* @return string
*/
public function getBankName()
{
}
/**
* Sets a new bankName
*
* @param string $bankName
* @return self
*/
public function setBankName($bankName)
{
}
}
/**
* Class representing PaymentType
*
*
* XSD Type: paymentType
*/
class PaymentType
{
/**
* Gets as creditCard
*
* @return \net\authorize\api\contract\v1\CreditCardType
*/
public function getCreditCard()
{
}
/**
* Sets a new creditCard
*
* @param \net\authorize\api\contract\v1\CreditCardType $creditCard
* @return self
*/
public function setCreditCard(\net\authorize\api\contract\v1\CreditCardType $creditCard)
{
}
/**
* Gets as bankAccount
*
* @return \net\authorize\api\contract\v1\BankAccountType
*/
public function getBankAccount()
{
}
/**
* Sets a new bankAccount
*
* @param \net\authorize\api\contract\v1\BankAccountType $bankAccount
* @return self
*/
public function setBankAccount(\net\authorize\api\contract\v1\BankAccountType $bankAccount)
{
}
/**
* Gets as trackData
*
* @return \net\authorize\api\contract\v1\CreditCardTrackType
*/
public function getTrackData()
{
}
/**
* Sets a new trackData
*
* @param \net\authorize\api\contract\v1\CreditCardTrackType $trackData
* @return self
*/
public function setTrackData(\net\authorize\api\contract\v1\CreditCardTrackType $trackData)
{
}
/**
* Gets as encryptedTrackData
*
* @return \net\authorize\api\contract\v1\EncryptedTrackDataType
*/
public function getEncryptedTrackData()
{
}
/**
* Sets a new encryptedTrackData
*
* @param \net\authorize\api\contract\v1\EncryptedTrackDataType $encryptedTrackData
* @return self
*/
public function setEncryptedTrackData(\net\authorize\api\contract\v1\EncryptedTrackDataType $encryptedTrackData)
{
}
/**
* Gets as payPal
*
* @return \net\authorize\api\contract\v1\PayPalType
*/
public function getPayPal()
{
}
/**
* Sets a new payPal
*
* @param \net\authorize\api\contract\v1\PayPalType $payPal
* @return self
*/
public function setPayPal(\net\authorize\api\contract\v1\PayPalType $payPal)
{
}
/**
* Gets as opaqueData
*
* @return \net\authorize\api\contract\v1\OpaqueDataType
*/
public function getOpaqueData()
{
}
/**
* Sets a new opaqueData
*
* @param \net\authorize\api\contract\v1\OpaqueDataType $opaqueData
* @return self
*/
public function setOpaqueData(\net\authorize\api\contract\v1\OpaqueDataType $opaqueData)
{
}
/**
* Gets as emv
*
* @return \net\authorize\api\contract\v1\PaymentEmvType
*/
public function getEmv()
{
}
/**
* Sets a new emv
*
* @param \net\authorize\api\contract\v1\PaymentEmvType $emv
* @return self
*/
public function setEmv(\net\authorize\api\contract\v1\PaymentEmvType $emv)
{
}
/**
* Gets as dataSource
*
* @return string
*/
public function getDataSource()
{
}
/**
* Sets a new dataSource
*
* @param string $dataSource
* @return self
*/
public function setDataSource($dataSource)
{
}
}
/**
* Class representing OpaqueDataType
*
*
* XSD Type: opaqueDataType
*/
class OpaqueDataType
{
/**
* Gets as dataDescriptor
*
* @return string
*/
public function getDataDescriptor()
{
}
/**
* Sets a new dataDescriptor
*
* @param string $dataDescriptor
* @return self
*/
public function setDataDescriptor($dataDescriptor)
{
}
/**
* Gets as dataValue
*
* @return string
*/
public function getDataValue()
{
}
/**
* Sets a new dataValue
*
* @param string $dataValue
* @return self
*/
public function setDataValue($dataValue)
{
}
/**
* Gets as dataKey
*
* @return string
*/
public function getDataKey()
{
}
/**
* Sets a new dataKey
*
* @param string $dataKey
* @return self
*/
public function setDataKey($dataKey)
{
}
}
/**
* Class representing AuUpdateType
*
*
* XSD Type: auUpdateType
*/
class AuUpdateType extends \net\authorize\api\contract\v1\AuDetailsType
{
/**
* Gets as newCreditCard
*
* @return \net\authorize\api\contract\v1\CreditCardMaskedType
*/
public function getNewCreditCard()
{
}
/**
* Sets a new newCreditCard
*
* @param \net\authorize\api\contract\v1\CreditCardMaskedType $newCreditCard
* @return self
*/
public function setNewCreditCard(\net\authorize\api\contract\v1\CreditCardMaskedType $newCreditCard)
{
}
/**
* Gets as oldCreditCard
*
* @return \net\authorize\api\contract\v1\CreditCardMaskedType
*/
public function getOldCreditCard()
{
}
/**
* Sets a new oldCreditCard
*
* @param \net\authorize\api\contract\v1\CreditCardMaskedType $oldCreditCard
* @return self
*/
public function setOldCreditCard(\net\authorize\api\contract\v1\CreditCardMaskedType $oldCreditCard)
{
}
}
/**
* Class representing TransactionResponseType
*
*
* XSD Type: transactionResponse
*/
class TransactionResponseType
{
/**
* Gets as responseCode
*
* @return string
*/
public function getResponseCode()
{
}
/**
* Sets a new responseCode
*
* @param string $responseCode
* @return self
*/
public function setResponseCode($responseCode)
{
}
/**
* Gets as rawResponseCode
*
* @return string
*/
public function getRawResponseCode()
{
}
/**
* Sets a new rawResponseCode
*
* @param string $rawResponseCode
* @return self
*/
public function setRawResponseCode($rawResponseCode)
{
}
/**
* Gets as authCode
*
* @return string
*/
public function getAuthCode()
{
}
/**
* Sets a new authCode
*
* @param string $authCode
* @return self
*/
public function setAuthCode($authCode)
{
}
/**
* Gets as avsResultCode
*
* @return string
*/
public function getAvsResultCode()
{
}
/**
* Sets a new avsResultCode
*
* @param string $avsResultCode
* @return self
*/
public function setAvsResultCode($avsResultCode)
{
}
/**
* Gets as cvvResultCode
*
* @return string
*/
public function getCvvResultCode()
{
}
/**
* Sets a new cvvResultCode
*
* @param string $cvvResultCode
* @return self
*/
public function setCvvResultCode($cvvResultCode)
{
}
/**
* Gets as cavvResultCode
*
* @return string
*/
public function getCavvResultCode()
{
}
/**
* Sets a new cavvResultCode
*
* @param string $cavvResultCode
* @return self
*/
public function setCavvResultCode($cavvResultCode)
{
}
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
/**
* Gets as refTransID
*
* @return string
*/
public function getRefTransID()
{
}
/**
* Sets a new refTransID
*
* @param string $refTransID
* @return self
*/
public function setRefTransID($refTransID)
{
}
/**
* Gets as transHash
*
* @return string
*/
public function getTransHash()
{
}
/**
* Sets a new transHash
*
* @param string $transHash
* @return self
*/
public function setTransHash($transHash)
{
}
/**
* Gets as testRequest
*
* @return string
*/
public function getTestRequest()
{
}
/**
* Sets a new testRequest
*
* @param string $testRequest
* @return self
*/
public function setTestRequest($testRequest)
{
}
/**
* Gets as accountNumber
*
* @return string
*/
public function getAccountNumber()
{
}
/**
* Sets a new accountNumber
*
* @param string $accountNumber
* @return self
*/
public function setAccountNumber($accountNumber)
{
}
/**
* Gets as entryMode
*
* @return string
*/
public function getEntryMode()
{
}
/**
* Sets a new entryMode
*
* @param string $entryMode
* @return self
*/
public function setEntryMode($entryMode)
{
}
/**
* Gets as accountType
*
* @return string
*/
public function getAccountType()
{
}
/**
* Sets a new accountType
*
* @param string $accountType
* @return self
*/
public function setAccountType($accountType)
{
}
/**
* Gets as splitTenderId
*
* @return string
*/
public function getSplitTenderId()
{
}
/**
* Sets a new splitTenderId
*
* @param string $splitTenderId
* @return self
*/
public function setSplitTenderId($splitTenderId)
{
}
/**
* Gets as prePaidCard
*
* @return \net\authorize\api\contract\v1\TransactionResponseType\PrePaidCardAType
*/
public function getPrePaidCard()
{
}
/**
* Sets a new prePaidCard
*
* @param \net\authorize\api\contract\v1\TransactionResponseType\PrePaidCardAType
* $prePaidCard
* @return self
*/
public function setPrePaidCard(\net\authorize\api\contract\v1\TransactionResponseType\PrePaidCardAType $prePaidCard)
{
}
/**
* Adds as message
*
* @return self
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\MessagesAType\MessageAType
* $message
*/
public function addToMessages(\net\authorize\api\contract\v1\TransactionResponseType\MessagesAType\MessageAType $message)
{
}
/**
* isset messages
*
* @param scalar $index
* @return boolean
*/
public function issetMessages($index)
{
}
/**
* unset messages
*
* @param scalar $index
* @return void
*/
public function unsetMessages($index)
{
}
/**
* Gets as messages
*
* @return
* \net\authorize\api\contract\v1\TransactionResponseType\MessagesAType\MessageAType[]
*/
public function getMessages()
{
}
/**
* Sets a new messages
*
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\MessagesAType\MessageAType[]
* $messages
* @return self
*/
public function setMessages(array $messages)
{
}
/**
* Adds as error
*
* @return self
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\ErrorsAType\ErrorAType
* $error
*/
public function addToErrors(\net\authorize\api\contract\v1\TransactionResponseType\ErrorsAType\ErrorAType $error)
{
}
/**
* isset errors
*
* @param scalar $index
* @return boolean
*/
public function issetErrors($index)
{
}
/**
* unset errors
*
* @param scalar $index
* @return void
*/
public function unsetErrors($index)
{
}
/**
* Gets as errors
*
* @return
* \net\authorize\api\contract\v1\TransactionResponseType\ErrorsAType\ErrorAType[]
*/
public function getErrors()
{
}
/**
* Sets a new errors
*
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\ErrorsAType\ErrorAType[]
* $errors
* @return self
*/
public function setErrors(array $errors)
{
}
/**
* Adds as splitTenderPayment
*
* @return self
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\SplitTenderPaymentsAType\SplitTenderPaymentAType
* $splitTenderPayment
*/
public function addToSplitTenderPayments(\net\authorize\api\contract\v1\TransactionResponseType\SplitTenderPaymentsAType\SplitTenderPaymentAType $splitTenderPayment)
{
}
/**
* isset splitTenderPayments
*
* @param scalar $index
* @return boolean
*/
public function issetSplitTenderPayments($index)
{
}
/**
* unset splitTenderPayments
*
* @param scalar $index
* @return void
*/
public function unsetSplitTenderPayments($index)
{
}
/**
* Gets as splitTenderPayments
*
* @return
* \net\authorize\api\contract\v1\TransactionResponseType\SplitTenderPaymentsAType\SplitTenderPaymentAType[]
*/
public function getSplitTenderPayments()
{
}
/**
* Sets a new splitTenderPayments
*
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\SplitTenderPaymentsAType\SplitTenderPaymentAType[]
* $splitTenderPayments
* @return self
*/
public function setSplitTenderPayments(array $splitTenderPayments)
{
}
/**
* Adds as userField
*
* @return self
* @param \net\authorize\api\contract\v1\UserFieldType $userField
*/
public function addToUserFields(\net\authorize\api\contract\v1\UserFieldType $userField)
{
}
/**
* isset userFields
*
* @param scalar $index
* @return boolean
*/
public function issetUserFields($index)
{
}
/**
* unset userFields
*
* @param scalar $index
* @return void
*/
public function unsetUserFields($index)
{
}
/**
* Gets as userFields
*
* @return \net\authorize\api\contract\v1\UserFieldType[]
*/
public function getUserFields()
{
}
/**
* Sets a new userFields
*
* @param \net\authorize\api\contract\v1\UserFieldType[] $userFields
* @return self
*/
public function setUserFields(array $userFields)
{
}
/**
* Gets as shipTo
*
* @return \net\authorize\api\contract\v1\NameAndAddressType
*/
public function getShipTo()
{
}
/**
* Sets a new shipTo
*
* @param \net\authorize\api\contract\v1\NameAndAddressType $shipTo
* @return self
*/
public function setShipTo(\net\authorize\api\contract\v1\NameAndAddressType $shipTo)
{
}
/**
* Gets as secureAcceptance
*
* @return
* \net\authorize\api\contract\v1\TransactionResponseType\SecureAcceptanceAType
*/
public function getSecureAcceptance()
{
}
/**
* Sets a new secureAcceptance
*
* @param
* \net\authorize\api\contract\v1\TransactionResponseType\SecureAcceptanceAType
* $secureAcceptance
* @return self
*/
public function setSecureAcceptance(\net\authorize\api\contract\v1\TransactionResponseType\SecureAcceptanceAType $secureAcceptance)
{
}
/**
* Gets as emvResponse
*
* @return \net\authorize\api\contract\v1\TransactionResponseType\EmvResponseAType
*/
public function getEmvResponse()
{
}
/**
* Sets a new emvResponse
*
* @param \net\authorize\api\contract\v1\TransactionResponseType\EmvResponseAType
* $emvResponse
* @return self
*/
public function setEmvResponse(\net\authorize\api\contract\v1\TransactionResponseType\EmvResponseAType $emvResponse)
{
}
/**
* Gets as transHashSha2
*
* @return string
*/
public function getTransHashSha2()
{
}
/**
* Sets a new transHashSha2
*
* @param string $transHashSha2
* @return self
*/
public function setTransHashSha2($transHashSha2)
{
}
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\CustomerProfileIdType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\CustomerProfileIdType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\CustomerProfileIdType $profile)
{
}
}
/**
* Class representing PaymentEmvType
*
*
* XSD Type: paymentEmvType
*/
class PaymentEmvType
{
/**
* Gets as emvData
*
* @return mixed
*/
public function getEmvData()
{
}
/**
* Sets a new emvData
*
* @param mixed $emvData
* @return self
*/
public function setEmvData($emvData)
{
}
/**
* Gets as emvDescriptor
*
* @return mixed
*/
public function getEmvDescriptor()
{
}
/**
* Sets a new emvDescriptor
*
* @param mixed $emvDescriptor
* @return self
*/
public function setEmvDescriptor($emvDescriptor)
{
}
/**
* Gets as emvVersion
*
* @return mixed
*/
public function getEmvVersion()
{
}
/**
* Sets a new emvVersion
*
* @param mixed $emvVersion
* @return self
*/
public function setEmvVersion($emvVersion)
{
}
}
/**
* Class representing CustomerPaymentProfileListItemType
*
*
* XSD Type: customerPaymentProfileListItemType
*/
class CustomerPaymentProfileListItemType
{
/**
* Gets as defaultPaymentProfile
*
* @return boolean
*/
public function getDefaultPaymentProfile()
{
}
/**
* Sets a new defaultPaymentProfile
*
* @param boolean $defaultPaymentProfile
* @return self
*/
public function setDefaultPaymentProfile($defaultPaymentProfile)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return integer
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param integer $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as customerProfileId
*
* @return integer
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param integer $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as billTo
*
* @return \net\authorize\api\contract\v1\CustomerAddressType
*/
public function getBillTo()
{
}
/**
* Sets a new billTo
*
* @param \net\authorize\api\contract\v1\CustomerAddressType $billTo
* @return self
*/
public function setBillTo(\net\authorize\api\contract\v1\CustomerAddressType $billTo)
{
}
/**
* Gets as payment
*
* @return \net\authorize\api\contract\v1\PaymentMaskedType
*/
public function getPayment()
{
}
/**
* Sets a new payment
*
* @param \net\authorize\api\contract\v1\PaymentMaskedType $payment
* @return self
*/
public function setPayment(\net\authorize\api\contract\v1\PaymentMaskedType $payment)
{
}
}
/**
* Class representing SubscriptionDetailType
*
*
* XSD Type: SubscriptionDetail
*/
class SubscriptionDetailType
{
/**
* Gets as id
*
* @return integer
*/
public function getId()
{
}
/**
* Sets a new id
*
* @param integer $id
* @return self
*/
public function setId($id)
{
}
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as status
*
* @return string
*/
public function getStatus()
{
}
/**
* Sets a new status
*
* @param string $status
* @return self
*/
public function setStatus($status)
{
}
/**
* Gets as createTimeStampUTC
*
* @return \DateTime
*/
public function getCreateTimeStampUTC()
{
}
/**
* Sets a new createTimeStampUTC
*
* @param \DateTime $createTimeStampUTC
* @return self
*/
public function setCreateTimeStampUTC(\DateTime $createTimeStampUTC)
{
}
/**
* Gets as firstName
*
* @return string
*/
public function getFirstName()
{
}
/**
* Sets a new firstName
*
* @param string $firstName
* @return self
*/
public function setFirstName($firstName)
{
}
/**
* Gets as lastName
*
* @return string
*/
public function getLastName()
{
}
/**
* Sets a new lastName
*
* @param string $lastName
* @return self
*/
public function setLastName($lastName)
{
}
/**
* Gets as totalOccurrences
*
* @return integer
*/
public function getTotalOccurrences()
{
}
/**
* Sets a new totalOccurrences
*
* @param integer $totalOccurrences
* @return self
*/
public function setTotalOccurrences($totalOccurrences)
{
}
/**
* Gets as pastOccurrences
*
* @return integer
*/
public function getPastOccurrences()
{
}
/**
* Sets a new pastOccurrences
*
* @param integer $pastOccurrences
* @return self
*/
public function setPastOccurrences($pastOccurrences)
{
}
/**
* Gets as paymentMethod
*
* @return string
*/
public function getPaymentMethod()
{
}
/**
* Sets a new paymentMethod
*
* @param string $paymentMethod
* @return self
*/
public function setPaymentMethod($paymentMethod)
{
}
/**
* Gets as accountNumber
*
* @return string
*/
public function getAccountNumber()
{
}
/**
* Sets a new accountNumber
*
* @param string $accountNumber
* @return self
*/
public function setAccountNumber($accountNumber)
{
}
/**
* Gets as invoice
*
* @return string
*/
public function getInvoice()
{
}
/**
* Sets a new invoice
*
* @param string $invoice
* @return self
*/
public function setInvoice($invoice)
{
}
/**
* Gets as amount
*
* @return float
*/
public function getAmount()
{
}
/**
* Sets a new amount
*
* @param float $amount
* @return self
*/
public function setAmount($amount)
{
}
/**
* Gets as currencyCode
*
* @return string
*/
public function getCurrencyCode()
{
}
/**
* Sets a new currencyCode
*
* @param string $currencyCode
* @return self
*/
public function setCurrencyCode($currencyCode)
{
}
/**
* Gets as customerProfileId
*
* @return integer
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param integer $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return integer
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param integer $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as customerShippingProfileId
*
* @return integer
*/
public function getCustomerShippingProfileId()
{
}
/**
* Sets a new customerShippingProfileId
*
* @param integer $customerShippingProfileId
* @return self
*/
public function setCustomerShippingProfileId($customerShippingProfileId)
{
}
}
/**
* Class representing BankAccountType
*
*
* XSD Type: bankAccountType
*/
class BankAccountType
{
/**
* Gets as accountType
*
* @return string
*/
public function getAccountType()
{
}
/**
* Sets a new accountType
*
* @param string $accountType
* @return self
*/
public function setAccountType($accountType)
{
}
/**
* Gets as routingNumber
*
* @return string
*/
public function getRoutingNumber()
{
}
/**
* Sets a new routingNumber
*
* @param string $routingNumber
* @return self
*/
public function setRoutingNumber($routingNumber)
{
}
/**
* Gets as accountNumber
*
* @return string
*/
public function getAccountNumber()
{
}
/**
* Sets a new accountNumber
*
* @param string $accountNumber
* @return self
*/
public function setAccountNumber($accountNumber)
{
}
/**
* Gets as nameOnAccount
*
* @return string
*/
public function getNameOnAccount()
{
}
/**
* Sets a new nameOnAccount
*
* @param string $nameOnAccount
* @return self
*/
public function setNameOnAccount($nameOnAccount)
{
}
/**
* Gets as echeckType
*
* @return string
*/
public function getEcheckType()
{
}
/**
* Sets a new echeckType
*
* @param string $echeckType
* @return self
*/
public function setEcheckType($echeckType)
{
}
/**
* Gets as bankName
*
* @return string
*/
public function getBankName()
{
}
/**
* Sets a new bankName
*
* @param string $bankName
* @return self
*/
public function setBankName($bankName)
{
}
/**
* Gets as checkNumber
*
* @return string
*/
public function getCheckNumber()
{
}
/**
* Sets a new checkNumber
*
* @param string $checkNumber
* @return self
*/
public function setCheckNumber($checkNumber)
{
}
}
/**
* Class representing CustomerProfileIdType
*
*
* XSD Type: customerProfileIdType
*/
class CustomerProfileIdType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as customerAddressId
*
* @return string
*/
public function getCustomerAddressId()
{
}
/**
* Sets a new customerAddressId
*
* @param string $customerAddressId
* @return self
*/
public function setCustomerAddressId($customerAddressId)
{
}
}
}
namespace net\authorize\api\contract\v1\PaymentScheduleType {
/**
* Class representing IntervalAType
*/
class IntervalAType
{
/**
* Gets as length
*
* @return integer
*/
public function getLength()
{
}
/**
* Sets a new length
*
* @param integer $length
* @return self
*/
public function setLength($length)
{
}
/**
* Gets as unit
*
* @return string
*/
public function getUnit()
{
}
/**
* Sets a new unit
*
* @param string $unit
* @return self
*/
public function setUnit($unit)
{
}
}
}
namespace net\authorize\api\contract\v1 {
/**
* Class representing FraudInformationType
*
*
* XSD Type: fraudInformationType
*/
class FraudInformationType
{
/**
* Adds as fraudFilter
*
* @return self
* @param string $fraudFilter
*/
public function addToFraudFilterList($fraudFilter)
{
}
/**
* isset fraudFilterList
*
* @param scalar $index
* @return boolean
*/
public function issetFraudFilterList($index)
{
}
/**
* unset fraudFilterList
*
* @param scalar $index
* @return void
*/
public function unsetFraudFilterList($index)
{
}
/**
* Gets as fraudFilterList
*
* @return string[]
*/
public function getFraudFilterList()
{
}
/**
* Sets a new fraudFilterList
*
* @param string[] $fraudFilterList
* @return self
*/
public function setFraudFilterList(array $fraudFilterList)
{
}
/**
* Gets as fraudAction
*
* @return string
*/
public function getFraudAction()
{
}
/**
* Sets a new fraudAction
*
* @param string $fraudAction
* @return self
*/
public function setFraudAction($fraudAction)
{
}
}
/**
* Class representing AuthenticateTestRequest
*/
class AuthenticateTestRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
}
/**
* Class representing GetSettledBatchListResponse
*/
class GetSettledBatchListResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Adds as batch
*
* @return self
* @param \net\authorize\api\contract\v1\BatchDetailsType $batch
*/
public function addToBatchList(\net\authorize\api\contract\v1\BatchDetailsType $batch)
{
}
/**
* isset batchList
*
* @param scalar $index
* @return boolean
*/
public function issetBatchList($index)
{
}
/**
* unset batchList
*
* @param scalar $index
* @return void
*/
public function unsetBatchList($index)
{
}
/**
* Gets as batchList
*
* @return \net\authorize\api\contract\v1\BatchDetailsType[]
*/
public function getBatchList()
{
}
/**
* Sets a new batchList
*
* @param \net\authorize\api\contract\v1\BatchDetailsType[] $batchList
* @return self
*/
public function setBatchList(array $batchList)
{
}
}
/**
* Class representing SecurePaymentContainerResponse
*/
class SecurePaymentContainerResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as opaqueData
*
* @return \net\authorize\api\contract\v1\OpaqueDataType
*/
public function getOpaqueData()
{
}
/**
* Sets a new opaqueData
*
* @param \net\authorize\api\contract\v1\OpaqueDataType $opaqueData
* @return self
*/
public function setOpaqueData(\net\authorize\api\contract\v1\OpaqueDataType $opaqueData)
{
}
}
/**
* Class representing UpdateCustomerShippingAddressResponse
*/
class UpdateCustomerShippingAddressResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing ARBGetSubscriptionStatusResponse
*/
class ARBGetSubscriptionStatusResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as status
*
* @return string
*/
public function getStatus()
{
}
/**
* Sets a new status
*
* @param string $status
* @return self
*/
public function setStatus($status)
{
}
}
/**
* Class representing CreateCustomerPaymentProfileRequest
*/
class CreateCustomerPaymentProfileRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as paymentProfile
*
* @return \net\authorize\api\contract\v1\CustomerPaymentProfileType
*/
public function getPaymentProfile()
{
}
/**
* Sets a new paymentProfile
*
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileType $paymentProfile
* @return self
*/
public function setPaymentProfile(\net\authorize\api\contract\v1\CustomerPaymentProfileType $paymentProfile)
{
}
/**
* Gets as validationMode
*
* @return string
*/
public function getValidationMode()
{
}
/**
* Sets a new validationMode
*
* @param string $validationMode
* @return self
*/
public function setValidationMode($validationMode)
{
}
}
/**
* Class representing ProfileTransVoidType
*
*
* XSD Type: profileTransVoidType
*/
class ProfileTransVoidType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as customerShippingAddressId
*
* @return string
*/
public function getCustomerShippingAddressId()
{
}
/**
* Sets a new customerShippingAddressId
*
* @param string $customerShippingAddressId
* @return self
*/
public function setCustomerShippingAddressId($customerShippingAddressId)
{
}
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
}
/**
* Class representing UpdateCustomerPaymentProfileRequest
*/
class UpdateCustomerPaymentProfileRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as paymentProfile
*
* @return \net\authorize\api\contract\v1\CustomerPaymentProfileExType
*/
public function getPaymentProfile()
{
}
/**
* Sets a new paymentProfile
*
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileExType
* $paymentProfile
* @return self
*/
public function setPaymentProfile(\net\authorize\api\contract\v1\CustomerPaymentProfileExType $paymentProfile)
{
}
/**
* Gets as validationMode
*
* @return string
*/
public function getValidationMode()
{
}
/**
* Sets a new validationMode
*
* @param string $validationMode
* @return self
*/
public function setValidationMode($validationMode)
{
}
}
/**
* Class representing UpdateHeldTransactionResponse
*/
class UpdateHeldTransactionResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as transactionResponse
*
* @return \net\authorize\api\contract\v1\TransactionResponseType
*/
public function getTransactionResponse()
{
}
/**
* Sets a new transactionResponse
*
* @param \net\authorize\api\contract\v1\TransactionResponseType
* $transactionResponse
* @return self
*/
public function setTransactionResponse(\net\authorize\api\contract\v1\TransactionResponseType $transactionResponse)
{
}
}
/**
* Class representing ARBGetSubscriptionListSortingType
*
*
* XSD Type: ARBGetSubscriptionListSorting
*/
class ARBGetSubscriptionListSortingType
{
/**
* Gets as orderBy
*
* @return string
*/
public function getOrderBy()
{
}
/**
* Sets a new orderBy
*
* @param string $orderBy
* @return self
*/
public function setOrderBy($orderBy)
{
}
/**
* Gets as orderDescending
*
* @return boolean
*/
public function getOrderDescending()
{
}
/**
* Sets a new orderDescending
*
* @param boolean $orderDescending
* @return self
*/
public function setOrderDescending($orderDescending)
{
}
}
/**
* Class representing GetHostedPaymentPageResponse
*/
class GetHostedPaymentPageResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as token
*
* @return string
*/
public function getToken()
{
}
/**
* Sets a new token
*
* @param string $token
* @return self
*/
public function setToken($token)
{
}
}
/**
* Class representing PagingType
*
*
* XSD Type: Paging
*/
class PagingType
{
/**
* Gets as limit
*
* @return integer
*/
public function getLimit()
{
}
/**
* Sets a new limit
*
* @param integer $limit
* @return self
*/
public function setLimit($limit)
{
}
/**
* Gets as offset
*
* @return integer
*/
public function getOffset()
{
}
/**
* Sets a new offset
*
* @param integer $offset
* @return self
*/
public function setOffset($offset)
{
}
}
/**
* Class representing GetCustomerProfileRequest
*/
class GetCustomerProfileRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as merchantCustomerId
*
* @return string
*/
public function getMerchantCustomerId()
{
}
/**
* Sets a new merchantCustomerId
*
* @param string $merchantCustomerId
* @return self
*/
public function setMerchantCustomerId($merchantCustomerId)
{
}
/**
* Gets as email
*
* @return string
*/
public function getEmail()
{
}
/**
* Sets a new email
*
* @param string $email
* @return self
*/
public function setEmail($email)
{
}
/**
* Gets as unmaskExpirationDate
*
* @return boolean
*/
public function getUnmaskExpirationDate()
{
}
/**
* Sets a new unmaskExpirationDate
*
* @param boolean $unmaskExpirationDate
* @return self
*/
public function setUnmaskExpirationDate($unmaskExpirationDate)
{
}
/**
* Gets as includeIssuerInfo
*
* @return boolean
*/
public function getIncludeIssuerInfo()
{
}
/**
* Sets a new includeIssuerInfo
*
* @param boolean $includeIssuerInfo
* @return self
*/
public function setIncludeIssuerInfo($includeIssuerInfo)
{
}
}
/**
* Class representing SolutionType
*
*
* XSD Type: solutionType
*/
class SolutionType
{
/**
* Gets as id
*
* @return string
*/
public function getId()
{
}
/**
* Sets a new id
*
* @param string $id
* @return self
*/
public function setId($id)
{
}
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as vendorName
*
* @return string
*/
public function getVendorName()
{
}
/**
* Sets a new vendorName
*
* @param string $vendorName
* @return self
*/
public function setVendorName($vendorName)
{
}
}
/**
* Class representing DeleteCustomerShippingAddressResponse
*/
class DeleteCustomerShippingAddressResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing MessagesType
*
*
* XSD Type: messagesType
*/
class MessagesType
{
/**
* Gets as resultCode
*
* @return string
*/
public function getResultCode()
{
}
/**
* Sets a new resultCode
*
* @param string $resultCode
* @return self
*/
public function setResultCode($resultCode)
{
}
/**
* Adds as message
*
* @return self
* @param \net\authorize\api\contract\v1\MessagesType\MessageAType $message
*/
public function addToMessage(\net\authorize\api\contract\v1\MessagesType\MessageAType $message)
{
}
/**
* isset message
*
* @param scalar $index
* @return boolean
*/
public function issetMessage($index)
{
}
/**
* unset message
*
* @param scalar $index
* @return void
*/
public function unsetMessage($index)
{
}
/**
* Gets as message
*
* @return \net\authorize\api\contract\v1\MessagesType\MessageAType[]
*/
public function getMessage()
{
}
/**
* Sets a new message
*
* @param \net\authorize\api\contract\v1\MessagesType\MessageAType[] $message
* @return self
*/
public function setMessage(array $message)
{
}
}
/**
* Class representing ARBSubscriptionMaskedType
*
*
* XSD Type: ARBSubscriptionMaskedType
*/
class ARBSubscriptionMaskedType
{
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as paymentSchedule
*
* @return \net\authorize\api\contract\v1\PaymentScheduleType
*/
public function getPaymentSchedule()
{
}
/**
* Sets a new paymentSchedule
*
* @param \net\authorize\api\contract\v1\PaymentScheduleType $paymentSchedule
* @return self
*/
public function setPaymentSchedule(\net\authorize\api\contract\v1\PaymentScheduleType $paymentSchedule)
{
}
/**
* Gets as amount
*
* @return float
*/
public function getAmount()
{
}
/**
* Sets a new amount
*
* @param float $amount
* @return self
*/
public function setAmount($amount)
{
}
/**
* Gets as trialAmount
*
* @return float
*/
public function getTrialAmount()
{
}
/**
* Sets a new trialAmount
*
* @param float $trialAmount
* @return self
*/
public function setTrialAmount($trialAmount)
{
}
/**
* Gets as status
*
* @return string
*/
public function getStatus()
{
}
/**
* Sets a new status
*
* @param string $status
* @return self
*/
public function setStatus($status)
{
}
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\SubscriptionCustomerProfileType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\SubscriptionCustomerProfileType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\SubscriptionCustomerProfileType $profile)
{
}
/**
* Gets as order
*
* @return \net\authorize\api\contract\v1\OrderType
*/
public function getOrder()
{
}
/**
* Sets a new order
*
* @param \net\authorize\api\contract\v1\OrderType $order
* @return self
*/
public function setOrder(\net\authorize\api\contract\v1\OrderType $order)
{
}
/**
* Adds as arbTransaction
*
* @return self
* @param \net\authorize\api\contract\v1\ArbTransactionType $arbTransaction
*/
public function addToArbTransactions(\net\authorize\api\contract\v1\ArbTransactionType $arbTransaction)
{
}
/**
* isset arbTransactions
*
* @param scalar $index
* @return boolean
*/
public function issetArbTransactions($index)
{
}
/**
* unset arbTransactions
*
* @param scalar $index
* @return void
*/
public function unsetArbTransactions($index)
{
}
/**
* Gets as arbTransactions
*
* @return \net\authorize\api\contract\v1\ArbTransactionType[]
*/
public function getArbTransactions()
{
}
/**
* Sets a new arbTransactions
*
* @param \net\authorize\api\contract\v1\ArbTransactionType[] $arbTransactions
* @return self
*/
public function setArbTransactions(array $arbTransactions)
{
}
}
/**
* Class representing ProfileTransPriorAuthCaptureType
*
*
* XSD Type: profileTransPriorAuthCaptureType
*/
class ProfileTransPriorAuthCaptureType extends \net\authorize\api\contract\v1\ProfileTransAmountType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as customerShippingAddressId
*
* @return string
*/
public function getCustomerShippingAddressId()
{
}
/**
* Sets a new customerShippingAddressId
*
* @param string $customerShippingAddressId
* @return self
*/
public function setCustomerShippingAddressId($customerShippingAddressId)
{
}
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
}
/**
* Class representing ARBCancelSubscriptionResponse
*/
class ARBCancelSubscriptionResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing GetMerchantDetailsRequest
*/
class GetMerchantDetailsRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
}
/**
* Class representing CreditCardMaskedType
*
*
* XSD Type: creditCardMaskedType
*/
class CreditCardMaskedType
{
/**
* Gets as cardNumber
*
* @return string
*/
public function getCardNumber()
{
}
/**
* Sets a new cardNumber
*
* @param string $cardNumber
* @return self
*/
public function setCardNumber($cardNumber)
{
}
/**
* Gets as expirationDate
*
* @return string
*/
public function getExpirationDate()
{
}
/**
* Sets a new expirationDate
*
* @param string $expirationDate
* @return self
*/
public function setExpirationDate($expirationDate)
{
}
/**
* Gets as cardType
*
* @return string
*/
public function getCardType()
{
}
/**
* Sets a new cardType
*
* @param string $cardType
* @return self
*/
public function setCardType($cardType)
{
}
/**
* Gets as cardArt
*
* @return \net\authorize\api\contract\v1\CardArtType
*/
public function getCardArt()
{
}
/**
* Sets a new cardArt
*
* @param \net\authorize\api\contract\v1\CardArtType $cardArt
* @return self
*/
public function setCardArt(\net\authorize\api\contract\v1\CardArtType $cardArt)
{
}
/**
* Gets as issuerNumber
*
* @return string
*/
public function getIssuerNumber()
{
}
/**
* Sets a new issuerNumber
*
* @param string $issuerNumber
* @return self
*/
public function setIssuerNumber($issuerNumber)
{
}
/**
* Gets as isPaymentToken
*
* @return boolean
*/
public function getIsPaymentToken()
{
}
/**
* Sets a new isPaymentToken
*
* @param boolean $isPaymentToken
* @return self
*/
public function setIsPaymentToken($isPaymentToken)
{
}
}
/**
* Class representing ARBSubscriptionType
*
*
* XSD Type: ARBSubscriptionType
*/
class ARBSubscriptionType
{
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as paymentSchedule
*
* @return \net\authorize\api\contract\v1\PaymentScheduleType
*/
public function getPaymentSchedule()
{
}
/**
* Sets a new paymentSchedule
*
* @param \net\authorize\api\contract\v1\PaymentScheduleType $paymentSchedule
* @return self
*/
public function setPaymentSchedule(\net\authorize\api\contract\v1\PaymentScheduleType $paymentSchedule)
{
}
/**
* Gets as amount
*
* @return float
*/
public function getAmount()
{
}
/**
* Sets a new amount
*
* @param float $amount
* @return self
*/
public function setAmount($amount)
{
}
/**
* Gets as trialAmount
*
* @return float
*/
public function getTrialAmount()
{
}
/**
* Sets a new trialAmount
*
* @param float $trialAmount
* @return self
*/
public function setTrialAmount($trialAmount)
{
}
/**
* Gets as payment
*
* @return \net\authorize\api\contract\v1\PaymentType
*/
public function getPayment()
{
}
/**
* Sets a new payment
*
* @param \net\authorize\api\contract\v1\PaymentType $payment
* @return self
*/
public function setPayment(\net\authorize\api\contract\v1\PaymentType $payment)
{
}
/**
* Gets as order
*
* @return \net\authorize\api\contract\v1\OrderType
*/
public function getOrder()
{
}
/**
* Sets a new order
*
* @param \net\authorize\api\contract\v1\OrderType $order
* @return self
*/
public function setOrder(\net\authorize\api\contract\v1\OrderType $order)
{
}
/**
* Gets as customer
*
* @return \net\authorize\api\contract\v1\CustomerType
*/
public function getCustomer()
{
}
/**
* Sets a new customer
*
* @param \net\authorize\api\contract\v1\CustomerType $customer
* @return self
*/
public function setCustomer(\net\authorize\api\contract\v1\CustomerType $customer)
{
}
/**
* Gets as billTo
*
* @return \net\authorize\api\contract\v1\NameAndAddressType
*/
public function getBillTo()
{
}
/**
* Sets a new billTo
*
* @param \net\authorize\api\contract\v1\NameAndAddressType $billTo
* @return self
*/
public function setBillTo(\net\authorize\api\contract\v1\NameAndAddressType $billTo)
{
}
/**
* Gets as shipTo
*
* @return \net\authorize\api\contract\v1\NameAndAddressType
*/
public function getShipTo()
{
}
/**
* Sets a new shipTo
*
* @param \net\authorize\api\contract\v1\NameAndAddressType $shipTo
* @return self
*/
public function setShipTo(\net\authorize\api\contract\v1\NameAndAddressType $shipTo)
{
}
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\CustomerProfileIdType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\CustomerProfileIdType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\CustomerProfileIdType $profile)
{
}
}
/**
* Class representing UpdateHeldTransactionRequest
*/
class UpdateHeldTransactionRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as heldTransactionRequest
*
* @return \net\authorize\api\contract\v1\HeldTransactionRequestType
*/
public function getHeldTransactionRequest()
{
}
/**
* Sets a new heldTransactionRequest
*
* @param \net\authorize\api\contract\v1\HeldTransactionRequestType
* $heldTransactionRequest
* @return self
*/
public function setHeldTransactionRequest(\net\authorize\api\contract\v1\HeldTransactionRequestType $heldTransactionRequest)
{
}
}
/**
* Class representing ARBCreateSubscriptionRequest
*/
class ARBCreateSubscriptionRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as subscription
*
* @return \net\authorize\api\contract\v1\ARBSubscriptionType
*/
public function getSubscription()
{
}
/**
* Sets a new subscription
*
* @param \net\authorize\api\contract\v1\ARBSubscriptionType $subscription
* @return self
*/
public function setSubscription(\net\authorize\api\contract\v1\ARBSubscriptionType $subscription)
{
}
}
/**
* Class representing TransRetailInfoType
*
*
* XSD Type: transRetailInfoType
*/
class TransRetailInfoType
{
/**
* Gets as marketType
*
* @return string
*/
public function getMarketType()
{
}
/**
* Sets a new marketType
*
* @param string $marketType
* @return self
*/
public function setMarketType($marketType)
{
}
/**
* Gets as deviceType
*
* @return string
*/
public function getDeviceType()
{
}
/**
* Sets a new deviceType
*
* @param string $deviceType
* @return self
*/
public function setDeviceType($deviceType)
{
}
/**
* Gets as customerSignature
*
* @return string
*/
public function getCustomerSignature()
{
}
/**
* Sets a new customerSignature
*
* @param string $customerSignature
* @return self
*/
public function setCustomerSignature($customerSignature)
{
}
/**
* Gets as terminalNumber
*
* @return string
*/
public function getTerminalNumber()
{
}
/**
* Sets a new terminalNumber
*
* @param string $terminalNumber
* @return self
*/
public function setTerminalNumber($terminalNumber)
{
}
}
/**
* Class representing CcAuthenticationType
*
*
* XSD Type: ccAuthenticationType
*/
class CcAuthenticationType
{
/**
* Gets as authenticationIndicator
*
* @return string
*/
public function getAuthenticationIndicator()
{
}
/**
* Sets a new authenticationIndicator
*
* @param string $authenticationIndicator
* @return self
*/
public function setAuthenticationIndicator($authenticationIndicator)
{
}
/**
* Gets as cardholderAuthenticationValue
*
* @return string
*/
public function getCardholderAuthenticationValue()
{
}
/**
* Sets a new cardholderAuthenticationValue
*
* @param string $cardholderAuthenticationValue
* @return self
*/
public function setCardholderAuthenticationValue($cardholderAuthenticationValue)
{
}
}
/**
* Class representing MobileDeviceRegistrationRequest
*/
class MobileDeviceRegistrationRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as mobileDevice
*
* @return \net\authorize\api\contract\v1\MobileDeviceType
*/
public function getMobileDevice()
{
}
/**
* Sets a new mobileDevice
*
* @param \net\authorize\api\contract\v1\MobileDeviceType $mobileDevice
* @return self
*/
public function setMobileDevice(\net\authorize\api\contract\v1\MobileDeviceType $mobileDevice)
{
}
}
/**
* Class representing CreateCustomerProfileTransactionResponse
*/
class CreateCustomerProfileTransactionResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as transactionResponse
*
* @return \net\authorize\api\contract\v1\TransactionResponseType
*/
public function getTransactionResponse()
{
}
/**
* Sets a new transactionResponse
*
* @param \net\authorize\api\contract\v1\TransactionResponseType
* $transactionResponse
* @return self
*/
public function setTransactionResponse(\net\authorize\api\contract\v1\TransactionResponseType $transactionResponse)
{
}
/**
* Gets as directResponse
*
* @return string
*/
public function getDirectResponse()
{
}
/**
* Sets a new directResponse
*
* @param string $directResponse
* @return self
*/
public function setDirectResponse($directResponse)
{
}
}
/**
* Class representing CreateCustomerShippingAddressRequest
*/
class CreateCustomerShippingAddressRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as address
*
* @return \net\authorize\api\contract\v1\CustomerAddressType
*/
public function getAddress()
{
}
/**
* Sets a new address
*
* @param \net\authorize\api\contract\v1\CustomerAddressType $address
* @return self
*/
public function setAddress(\net\authorize\api\contract\v1\CustomerAddressType $address)
{
}
/**
* Gets as defaultShippingAddress
*
* @return boolean
*/
public function getDefaultShippingAddress()
{
}
/**
* Sets a new defaultShippingAddress
*
* @param boolean $defaultShippingAddress
* @return self
*/
public function setDefaultShippingAddress($defaultShippingAddress)
{
}
}
/**
* Class representing ValidateCustomerPaymentProfileRequest
*/
class ValidateCustomerPaymentProfileRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as customerShippingAddressId
*
* @return string
*/
public function getCustomerShippingAddressId()
{
}
/**
* Sets a new customerShippingAddressId
*
* @param string $customerShippingAddressId
* @return self
*/
public function setCustomerShippingAddressId($customerShippingAddressId)
{
}
/**
* Gets as cardCode
*
* @return string
*/
public function getCardCode()
{
}
/**
* Sets a new cardCode
*
* @param string $cardCode
* @return self
*/
public function setCardCode($cardCode)
{
}
/**
* Gets as validationMode
*
* @return string
*/
public function getValidationMode()
{
}
/**
* Sets a new validationMode
*
* @param string $validationMode
* @return self
*/
public function setValidationMode($validationMode)
{
}
}
/**
* Class representing GetMerchantDetailsResponse
*/
class GetMerchantDetailsResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as isTestMode
*
* @return boolean
*/
public function getIsTestMode()
{
}
/**
* Sets a new isTestMode
*
* @param boolean $isTestMode
* @return self
*/
public function setIsTestMode($isTestMode)
{
}
/**
* Adds as processor
*
* @return self
* @param \net\authorize\api\contract\v1\ProcessorType $processor
*/
public function addToProcessors(\net\authorize\api\contract\v1\ProcessorType $processor)
{
}
/**
* isset processors
*
* @param scalar $index
* @return boolean
*/
public function issetProcessors($index)
{
}
/**
* unset processors
*
* @param scalar $index
* @return void
*/
public function unsetProcessors($index)
{
}
/**
* Gets as processors
*
* @return \net\authorize\api\contract\v1\ProcessorType[]
*/
public function getProcessors()
{
}
/**
* Sets a new processors
*
* @param \net\authorize\api\contract\v1\ProcessorType[] $processors
* @return self
*/
public function setProcessors(array $processors)
{
}
/**
* Gets as merchantName
*
* @return string
*/
public function getMerchantName()
{
}
/**
* Sets a new merchantName
*
* @param string $merchantName
* @return self
*/
public function setMerchantName($merchantName)
{
}
/**
* Gets as gatewayId
*
* @return string
*/
public function getGatewayId()
{
}
/**
* Sets a new gatewayId
*
* @param string $gatewayId
* @return self
*/
public function setGatewayId($gatewayId)
{
}
/**
* Adds as marketType
*
* @return self
* @param string $marketType
*/
public function addToMarketTypes($marketType)
{
}
/**
* isset marketTypes
*
* @param scalar $index
* @return boolean
*/
public function issetMarketTypes($index)
{
}
/**
* unset marketTypes
*
* @param scalar $index
* @return void
*/
public function unsetMarketTypes($index)
{
}
/**
* Gets as marketTypes
*
* @return string[]
*/
public function getMarketTypes()
{
}
/**
* Sets a new marketTypes
*
* @param string $marketTypes
* @return self
*/
public function setMarketTypes(array $marketTypes)
{
}
/**
* Adds as productCode
*
* @return self
* @param string $productCode
*/
public function addToProductCodes($productCode)
{
}
/**
* isset productCodes
*
* @param scalar $index
* @return boolean
*/
public function issetProductCodes($index)
{
}
/**
* unset productCodes
*
* @param scalar $index
* @return void
*/
public function unsetProductCodes($index)
{
}
/**
* Gets as productCodes
*
* @return string[]
*/
public function getProductCodes()
{
}
/**
* Sets a new productCodes
*
* @param string $productCodes
* @return self
*/
public function setProductCodes(array $productCodes)
{
}
/**
* Adds as paymentMethod
*
* @return self
* @param string $paymentMethod
*/
public function addToPaymentMethods($paymentMethod)
{
}
/**
* isset paymentMethods
*
* @param scalar $index
* @return boolean
*/
public function issetPaymentMethods($index)
{
}
/**
* unset paymentMethods
*
* @param scalar $index
* @return void
*/
public function unsetPaymentMethods($index)
{
}
/**
* Gets as paymentMethods
*
* @return string[]
*/
public function getPaymentMethods()
{
}
/**
* Sets a new paymentMethods
*
* @param string $paymentMethods
* @return self
*/
public function setPaymentMethods(array $paymentMethods)
{
}
/**
* Adds as currency
*
* @return self
* @param string $currency
*/
public function addToCurrencies($currency)
{
}
/**
* isset currencies
*
* @param scalar $index
* @return boolean
*/
public function issetCurrencies($index)
{
}
/**
* unset currencies
*
* @param scalar $index
* @return void
*/
public function unsetCurrencies($index)
{
}
/**
* Gets as currencies
*
* @return string[]
*/
public function getCurrencies()
{
}
/**
* Sets a new currencies
*
* @param string $currencies
* @return self
*/
public function setCurrencies(array $currencies)
{
}
/**
* Gets as publicClientKey
*
* @return string
*/
public function getPublicClientKey()
{
}
/**
* Sets a new publicClientKey
*
* @param string $publicClientKey
* @return self
*/
public function setPublicClientKey($publicClientKey)
{
}
}
/**
* Class representing GetHostedProfilePageRequest
*/
class GetHostedProfilePageRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Adds as setting
*
* Allowed values for settingName are: hostedProfileReturnUrl,
* hostedProfileReturnUrlText, hostedProfilePageBorderVisible,
* hostedProfileIFrameCommunicatorUrl, hostedProfileHeadingBgColor,
* hostedProfileBillingAddressRequired, hostedProfileCardCodeRequired,
* hostedProfileBillingAddressOptions, hostedProfileManageOptions,
* hostedProfilePaymentOptions, hostedProfileSaveButtonText.
*
* @return self
* @param \net\authorize\api\contract\v1\SettingType $setting
*/
public function addToHostedProfileSettings(\net\authorize\api\contract\v1\SettingType $setting)
{
}
/**
* isset hostedProfileSettings
*
* Allowed values for settingName are: hostedProfileReturnUrl,
* hostedProfileReturnUrlText, hostedProfilePageBorderVisible,
* hostedProfileIFrameCommunicatorUrl, hostedProfileHeadingBgColor,
* hostedProfileBillingAddressRequired, hostedProfileCardCodeRequired,
* hostedProfileBillingAddressOptions, hostedProfileManageOptions,
* hostedProfilePaymentOptions, hostedProfileSaveButtonText.
*
* @param scalar $index
* @return boolean
*/
public function issetHostedProfileSettings($index)
{
}
/**
* unset hostedProfileSettings
*
* Allowed values for settingName are: hostedProfileReturnUrl,
* hostedProfileReturnUrlText, hostedProfilePageBorderVisible,
* hostedProfileIFrameCommunicatorUrl, hostedProfileHeadingBgColor,
* hostedProfileBillingAddressRequired, hostedProfileCardCodeRequired,
* hostedProfileBillingAddressOptions, hostedProfileManageOptions,
* hostedProfilePaymentOptions, hostedProfileSaveButtonText.
*
* @param scalar $index
* @return void
*/
public function unsetHostedProfileSettings($index)
{
}
/**
* Gets as hostedProfileSettings
*
* Allowed values for settingName are: hostedProfileReturnUrl,
* hostedProfileReturnUrlText, hostedProfilePageBorderVisible,
* hostedProfileIFrameCommunicatorUrl, hostedProfileHeadingBgColor,
* hostedProfileBillingAddressRequired, hostedProfileCardCodeRequired,
* hostedProfileBillingAddressOptions, hostedProfileManageOptions,
* hostedProfilePaymentOptions, hostedProfileSaveButtonText.
*
* @return \net\authorize\api\contract\v1\SettingType[]
*/
public function getHostedProfileSettings()
{
}
/**
* Sets a new hostedProfileSettings
*
* Allowed values for settingName are: hostedProfileReturnUrl,
* hostedProfileReturnUrlText, hostedProfilePageBorderVisible,
* hostedProfileIFrameCommunicatorUrl, hostedProfileHeadingBgColor,
* hostedProfileBillingAddressRequired, hostedProfileCardCodeRequired,
* hostedProfileBillingAddressOptions, hostedProfileManageOptions,
* hostedProfilePaymentOptions, hostedProfileSaveButtonText.
*
* @param \net\authorize\api\contract\v1\SettingType[] $hostedProfileSettings
* @return self
*/
public function setHostedProfileSettings(array $hostedProfileSettings)
{
}
}
/**
* Class representing CustomerProfileInfoExType
*
*
* XSD Type: customerProfileInfoExType
*/
class CustomerProfileInfoExType extends \net\authorize\api\contract\v1\CustomerProfileExType
{
/**
* Gets as profileType
*
* @return string
*/
public function getProfileType()
{
}
/**
* Sets a new profileType
*
* @param string $profileType
* @return self
*/
public function setProfileType($profileType)
{
}
}
/**
* Class representing MerchantAuthenticationType
*
*
* XSD Type: merchantAuthenticationType
*/
class MerchantAuthenticationType
{
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as transactionKey
*
* @return string
*/
public function getTransactionKey()
{
}
/**
* Sets a new transactionKey
*
* @param string $transactionKey
* @return self
*/
public function setTransactionKey($transactionKey)
{
}
/**
* Gets as sessionToken
*
* @return string
*/
public function getSessionToken()
{
}
/**
* Sets a new sessionToken
*
* @param string $sessionToken
* @return self
*/
public function setSessionToken($sessionToken)
{
}
/**
* Gets as password
*
* @return string
*/
public function getPassword()
{
}
/**
* Sets a new password
*
* @param string $password
* @return self
*/
public function setPassword($password)
{
}
/**
* Gets as impersonationAuthentication
*
* @return \net\authorize\api\contract\v1\ImpersonationAuthenticationType
*/
public function getImpersonationAuthentication()
{
}
/**
* Sets a new impersonationAuthentication
*
* @param \net\authorize\api\contract\v1\ImpersonationAuthenticationType
* $impersonationAuthentication
* @return self
*/
public function setImpersonationAuthentication(\net\authorize\api\contract\v1\ImpersonationAuthenticationType $impersonationAuthentication)
{
}
/**
* Gets as fingerPrint
*
* @return \net\authorize\api\contract\v1\FingerPrintType
*/
public function getFingerPrint()
{
}
/**
* Sets a new fingerPrint
*
* @param \net\authorize\api\contract\v1\FingerPrintType $fingerPrint
* @return self
*/
public function setFingerPrint(\net\authorize\api\contract\v1\FingerPrintType $fingerPrint)
{
}
/**
* Gets as clientKey
*
* @return string
*/
public function getClientKey()
{
}
/**
* Sets a new clientKey
*
* @param string $clientKey
* @return self
*/
public function setClientKey($clientKey)
{
}
/**
* Gets as accessToken
*
* @return string
*/
public function getAccessToken()
{
}
/**
* Sets a new accessToken
*
* @param string $accessToken
* @return self
*/
public function setAccessToken($accessToken)
{
}
/**
* Gets as mobileDeviceId
*
* @return string
*/
public function getMobileDeviceId()
{
}
/**
* Sets a new mobileDeviceId
*
* @param string $mobileDeviceId
* @return self
*/
public function setMobileDeviceId($mobileDeviceId)
{
}
}
/**
* Class representing FingerPrintType
*
*
* XSD Type: fingerPrintType
*/
class FingerPrintType
{
/**
* Gets as hashValue
*
* @return string
*/
public function getHashValue()
{
}
/**
* Sets a new hashValue
*
* @param string $hashValue
* @return self
*/
public function setHashValue($hashValue)
{
}
/**
* Gets as sequence
*
* @return string
*/
public function getSequence()
{
}
/**
* Sets a new sequence
*
* @param string $sequence
* @return self
*/
public function setSequence($sequence)
{
}
/**
* Gets as timestamp
*
* @return string
*/
public function getTimestamp()
{
}
/**
* Sets a new timestamp
*
* @param string $timestamp
* @return self
*/
public function setTimestamp($timestamp)
{
}
/**
* Gets as currencyCode
*
* @return string
*/
public function getCurrencyCode()
{
}
/**
* Sets a new currencyCode
*
* @param string $currencyCode
* @return self
*/
public function setCurrencyCode($currencyCode)
{
}
/**
* Gets as amount
*
* @return string
*/
public function getAmount()
{
}
/**
* Sets a new amount
*
* @param string $amount
* @return self
*/
public function setAmount($amount)
{
}
}
/**
* Class representing ImpersonationAuthenticationType
*
*
* XSD Type: impersonationAuthenticationType
*/
class ImpersonationAuthenticationType
{
/**
* Gets as partnerLoginId
*
* @return string
*/
public function getPartnerLoginId()
{
}
/**
* Sets a new partnerLoginId
*
* @param string $partnerLoginId
* @return self
*/
public function setPartnerLoginId($partnerLoginId)
{
}
/**
* Gets as partnerTransactionKey
*
* @return string
*/
public function getPartnerTransactionKey()
{
}
/**
* Sets a new partnerTransactionKey
*
* @param string $partnerTransactionKey
* @return self
*/
public function setPartnerTransactionKey($partnerTransactionKey)
{
}
}
/**
* Class representing ARBGetSubscriptionListRequest
*/
class ARBGetSubscriptionListRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as searchType
*
* @return string
*/
public function getSearchType()
{
}
/**
* Sets a new searchType
*
* @param string $searchType
* @return self
*/
public function setSearchType($searchType)
{
}
/**
* Gets as sorting
*
* @return \net\authorize\api\contract\v1\ARBGetSubscriptionListSortingType
*/
public function getSorting()
{
}
/**
* Sets a new sorting
*
* @param \net\authorize\api\contract\v1\ARBGetSubscriptionListSortingType $sorting
* @return self
*/
public function setSorting(\net\authorize\api\contract\v1\ARBGetSubscriptionListSortingType $sorting)
{
}
/**
* Gets as paging
*
* @return \net\authorize\api\contract\v1\PagingType
*/
public function getPaging()
{
}
/**
* Sets a new paging
*
* @param \net\authorize\api\contract\v1\PagingType $paging
* @return self
*/
public function setPaging(\net\authorize\api\contract\v1\PagingType $paging)
{
}
}
/**
* Class representing ARBGetSubscriptionStatusRequest
*/
class ARBGetSubscriptionStatusRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as subscriptionId
*
* @return string
*/
public function getSubscriptionId()
{
}
/**
* Sets a new subscriptionId
*
* @param string $subscriptionId
* @return self
*/
public function setSubscriptionId($subscriptionId)
{
}
}
/**
* Class representing GetCustomerShippingAddressRequest
*/
class GetCustomerShippingAddressRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerAddressId
*
* @return string
*/
public function getCustomerAddressId()
{
}
/**
* Sets a new customerAddressId
*
* @param string $customerAddressId
* @return self
*/
public function setCustomerAddressId($customerAddressId)
{
}
}
/**
* Class representing ReturnedItemType
*
*
* XSD Type: returnedItemType
*/
class ReturnedItemType
{
/**
* Gets as id
*
* @return string
*/
public function getId()
{
}
/**
* Sets a new id
*
* @param string $id
* @return self
*/
public function setId($id)
{
}
/**
* Gets as dateUTC
*
* @return \DateTime
*/
public function getDateUTC()
{
}
/**
* Sets a new dateUTC
*
* @param \DateTime $dateUTC
* @return self
*/
public function setDateUTC(\DateTime $dateUTC)
{
}
/**
* Gets as dateLocal
*
* @return \DateTime
*/
public function getDateLocal()
{
}
/**
* Sets a new dateLocal
*
* @param \DateTime $dateLocal
* @return self
*/
public function setDateLocal(\DateTime $dateLocal)
{
}
/**
* Gets as code
*
* @return string
*/
public function getCode()
{
}
/**
* Sets a new code
*
* @param string $code
* @return self
*/
public function setCode($code)
{
}
/**
* Gets as description
*
* @return string
*/
public function getDescription()
{
}
/**
* Sets a new description
*
* @param string $description
* @return self
*/
public function setDescription($description)
{
}
}
/**
* Class representing CreateCustomerProfileResponse
*/
class CreateCustomerProfileResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Adds as numericString
*
* @return self
* @param string $numericString
*/
public function addToCustomerPaymentProfileIdList($numericString)
{
}
/**
* isset customerPaymentProfileIdList
*
* @param scalar $index
* @return boolean
*/
public function issetCustomerPaymentProfileIdList($index)
{
}
/**
* unset customerPaymentProfileIdList
*
* @param scalar $index
* @return void
*/
public function unsetCustomerPaymentProfileIdList($index)
{
}
/**
* Gets as customerPaymentProfileIdList
*
* @return string[]
*/
public function getCustomerPaymentProfileIdList()
{
}
/**
* Sets a new customerPaymentProfileIdList
*
* @param string $customerPaymentProfileIdList
* @return self
*/
public function setCustomerPaymentProfileIdList(array $customerPaymentProfileIdList)
{
}
/**
* Adds as numericString
*
* @return self
* @param string $numericString
*/
public function addToCustomerShippingAddressIdList($numericString)
{
}
/**
* isset customerShippingAddressIdList
*
* @param scalar $index
* @return boolean
*/
public function issetCustomerShippingAddressIdList($index)
{
}
/**
* unset customerShippingAddressIdList
*
* @param scalar $index
* @return void
*/
public function unsetCustomerShippingAddressIdList($index)
{
}
/**
* Gets as customerShippingAddressIdList
*
* @return string[]
*/
public function getCustomerShippingAddressIdList()
{
}
/**
* Sets a new customerShippingAddressIdList
*
* @param string $customerShippingAddressIdList
* @return self
*/
public function setCustomerShippingAddressIdList(array $customerShippingAddressIdList)
{
}
/**
* Adds as string
*
* @return self
* @param string $string
*/
public function addToValidationDirectResponseList($string)
{
}
/**
* isset validationDirectResponseList
*
* @param scalar $index
* @return boolean
*/
public function issetValidationDirectResponseList($index)
{
}
/**
* unset validationDirectResponseList
*
* @param scalar $index
* @return void
*/
public function unsetValidationDirectResponseList($index)
{
}
/**
* Gets as validationDirectResponseList
*
* @return string[]
*/
public function getValidationDirectResponseList()
{
}
/**
* Sets a new validationDirectResponseList
*
* @param string[] $validationDirectResponseList
* @return self
*/
public function setValidationDirectResponseList(array $validationDirectResponseList)
{
}
}
/**
* Class representing ARBUpdateSubscriptionRequest
*/
class ARBUpdateSubscriptionRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as subscriptionId
*
* @return string
*/
public function getSubscriptionId()
{
}
/**
* Sets a new subscriptionId
*
* @param string $subscriptionId
* @return self
*/
public function setSubscriptionId($subscriptionId)
{
}
/**
* Gets as subscription
*
* @return \net\authorize\api\contract\v1\ARBSubscriptionType
*/
public function getSubscription()
{
}
/**
* Sets a new subscription
*
* @param \net\authorize\api\contract\v1\ARBSubscriptionType $subscription
* @return self
*/
public function setSubscription(\net\authorize\api\contract\v1\ARBSubscriptionType $subscription)
{
}
}
/**
* Class representing DeleteCustomerPaymentProfileRequest
*/
class DeleteCustomerPaymentProfileRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
}
/**
* Class representing OrderExType
*
*
* XSD Type: orderExType
*/
class OrderExType extends \net\authorize\api\contract\v1\OrderType
{
/**
* Gets as purchaseOrderNumber
*
* @return string
*/
public function getPurchaseOrderNumber()
{
}
/**
* Sets a new purchaseOrderNumber
*
* @param string $purchaseOrderNumber
* @return self
*/
public function setPurchaseOrderNumber($purchaseOrderNumber)
{
}
}
/**
* Class representing LogoutRequest
*/
class LogoutRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
}
/**
* Class representing GetCustomerPaymentProfileListResponse
*/
class GetCustomerPaymentProfileListResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as totalNumInResultSet
*
* @return integer
*/
public function getTotalNumInResultSet()
{
}
/**
* Sets a new totalNumInResultSet
*
* @param integer $totalNumInResultSet
* @return self
*/
public function setTotalNumInResultSet($totalNumInResultSet)
{
}
/**
* Adds as paymentProfile
*
* @return self
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileListItemType
* $paymentProfile
*/
public function addToPaymentProfiles(\net\authorize\api\contract\v1\CustomerPaymentProfileListItemType $paymentProfile)
{
}
/**
* isset paymentProfiles
*
* @param scalar $index
* @return boolean
*/
public function issetPaymentProfiles($index)
{
}
/**
* unset paymentProfiles
*
* @param scalar $index
* @return void
*/
public function unsetPaymentProfiles($index)
{
}
/**
* Gets as paymentProfiles
*
* @return \net\authorize\api\contract\v1\CustomerPaymentProfileListItemType[]
*/
public function getPaymentProfiles()
{
}
/**
* Sets a new paymentProfiles
*
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileListItemType[]
* $paymentProfiles
* @return self
*/
public function setPaymentProfiles(array $paymentProfiles)
{
}
}
/**
* Class representing NameAndAddressType
*
*
* XSD Type: nameAndAddressType
*/
class NameAndAddressType
{
/**
* Gets as firstName
*
* @return string
*/
public function getFirstName()
{
}
/**
* Sets a new firstName
*
* @param string $firstName
* @return self
*/
public function setFirstName($firstName)
{
}
/**
* Gets as lastName
*
* @return string
*/
public function getLastName()
{
}
/**
* Sets a new lastName
*
* @param string $lastName
* @return self
*/
public function setLastName($lastName)
{
}
/**
* Gets as company
*
* @return string
*/
public function getCompany()
{
}
/**
* Sets a new company
*
* @param string $company
* @return self
*/
public function setCompany($company)
{
}
/**
* Gets as address
*
* @return string
*/
public function getAddress()
{
}
/**
* Sets a new address
*
* @param string $address
* @return self
*/
public function setAddress($address)
{
}
/**
* Gets as city
*
* @return string
*/
public function getCity()
{
}
/**
* Sets a new city
*
* @param string $city
* @return self
*/
public function setCity($city)
{
}
/**
* Gets as state
*
* @return string
*/
public function getState()
{
}
/**
* Sets a new state
*
* @param string $state
* @return self
*/
public function setState($state)
{
}
/**
* Gets as zip
*
* @return string
*/
public function getZip()
{
}
/**
* Sets a new zip
*
* @param string $zip
* @return self
*/
public function setZip($zip)
{
}
/**
* Gets as country
*
* @return string
*/
public function getCountry()
{
}
/**
* Sets a new country
*
* @param string $country
* @return self
*/
public function setCountry($country)
{
}
}
/**
* Class representing CustomerAddressType
*
*
* XSD Type: customerAddressType
*/
class CustomerAddressType extends \net\authorize\api\contract\v1\NameAndAddressType
{
/**
* Gets as phoneNumber
*
* @return string
*/
public function getPhoneNumber()
{
}
/**
* Sets a new phoneNumber
*
* @param string $phoneNumber
* @return self
*/
public function setPhoneNumber($phoneNumber)
{
}
/**
* Gets as faxNumber
*
* @return string
*/
public function getFaxNumber()
{
}
/**
* Sets a new faxNumber
*
* @param string $faxNumber
* @return self
*/
public function setFaxNumber($faxNumber)
{
}
/**
* Gets as email
*
* @return string
*/
public function getEmail()
{
}
/**
* Sets a new email
*
* @param string $email
* @return self
*/
public function setEmail($email)
{
}
}
/**
* Class representing CustomerAddressExType
*
*
* XSD Type: customerAddressExType
*/
class CustomerAddressExType extends \net\authorize\api\contract\v1\CustomerAddressType
{
/**
* Gets as customerAddressId
*
* @return string
*/
public function getCustomerAddressId()
{
}
/**
* Sets a new customerAddressId
*
* @param string $customerAddressId
* @return self
*/
public function setCustomerAddressId($customerAddressId)
{
}
}
/**
* Class representing DeleteCustomerPaymentProfileResponse
*/
class DeleteCustomerPaymentProfileResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing CreateTransactionRequest
*/
class CreateTransactionRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as transactionRequest
*
* @return \net\authorize\api\contract\v1\TransactionRequestType
*/
public function getTransactionRequest()
{
}
/**
* Sets a new transactionRequest
*
* @param \net\authorize\api\contract\v1\TransactionRequestType $transactionRequest
* @return self
*/
public function setTransactionRequest(\net\authorize\api\contract\v1\TransactionRequestType $transactionRequest)
{
}
}
/**
* Class representing ProcessorType
*
*
* XSD Type: processorType
*/
class ProcessorType
{
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as id
*
* @return integer
*/
public function getId()
{
}
/**
* Sets a new id
*
* @param integer $id
* @return self
*/
public function setId($id)
{
}
/**
* Adds as cardType
*
* @return self
* @param string $cardType
*/
public function addToCardTypes($cardType)
{
}
/**
* isset cardTypes
*
* @param scalar $index
* @return boolean
*/
public function issetCardTypes($index)
{
}
/**
* unset cardTypes
*
* @param scalar $index
* @return void
*/
public function unsetCardTypes($index)
{
}
/**
* Gets as cardTypes
*
* @return string[]
*/
public function getCardTypes()
{
}
/**
* Sets a new cardTypes
*
* @param string[] $cardTypes
* @return self
*/
public function setCardTypes(array $cardTypes)
{
}
}
/**
* Class representing CustomerType
*
*
* XSD Type: customerType
*/
class CustomerType
{
/**
* Gets as type
*
* @return string
*/
public function getType()
{
}
/**
* Sets a new type
*
* @param string $type
* @return self
*/
public function setType($type)
{
}
/**
* Gets as id
*
* @return string
*/
public function getId()
{
}
/**
* Sets a new id
*
* @param string $id
* @return self
*/
public function setId($id)
{
}
/**
* Gets as email
*
* @return string
*/
public function getEmail()
{
}
/**
* Sets a new email
*
* @param string $email
* @return self
*/
public function setEmail($email)
{
}
/**
* Gets as phoneNumber
*
* @return string
*/
public function getPhoneNumber()
{
}
/**
* Sets a new phoneNumber
*
* @param string $phoneNumber
* @return self
*/
public function setPhoneNumber($phoneNumber)
{
}
/**
* Gets as faxNumber
*
* @return string
*/
public function getFaxNumber()
{
}
/**
* Sets a new faxNumber
*
* @param string $faxNumber
* @return self
*/
public function setFaxNumber($faxNumber)
{
}
/**
* Gets as driversLicense
*
* @return \net\authorize\api\contract\v1\DriversLicenseType
*/
public function getDriversLicense()
{
}
/**
* Sets a new driversLicense
*
* @param \net\authorize\api\contract\v1\DriversLicenseType $driversLicense
* @return self
*/
public function setDriversLicense(\net\authorize\api\contract\v1\DriversLicenseType $driversLicense)
{
}
/**
* Gets as taxId
*
* @return string
*/
public function getTaxId()
{
}
/**
* Sets a new taxId
*
* @param string $taxId
* @return self
*/
public function setTaxId($taxId)
{
}
}
/**
* Class representing FDSFilterType
*
*
* XSD Type: FDSFilterType
*/
class FDSFilterType
{
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as action
*
* @return string
*/
public function getAction()
{
}
/**
* Sets a new action
*
* @param string $action
* @return self
*/
public function setAction($action)
{
}
}
/**
* Class representing TokenMaskedType
*
*
* XSD Type: tokenMaskedType
*/
class TokenMaskedType
{
/**
* Gets as tokenSource
*
* @return string
*/
public function getTokenSource()
{
}
/**
* Sets a new tokenSource
*
* @param string $tokenSource
* @return self
*/
public function setTokenSource($tokenSource)
{
}
/**
* Gets as tokenNumber
*
* @return string
*/
public function getTokenNumber()
{
}
/**
* Sets a new tokenNumber
*
* @param string $tokenNumber
* @return self
*/
public function setTokenNumber($tokenNumber)
{
}
/**
* Gets as expirationDate
*
* @return string
*/
public function getExpirationDate()
{
}
/**
* Sets a new expirationDate
*
* @param string $expirationDate
* @return self
*/
public function setExpirationDate($expirationDate)
{
}
}
/**
* Class representing HeldTransactionRequestType
*
*
* XSD Type: heldTransactionRequestType
*/
class HeldTransactionRequestType
{
/**
* Gets as action
*
* @return string
*/
public function getAction()
{
}
/**
* Sets a new action
*
* @param string $action
* @return self
*/
public function setAction($action)
{
}
/**
* Gets as refTransId
*
* @return string
*/
public function getRefTransId()
{
}
/**
* Sets a new refTransId
*
* @param string $refTransId
* @return self
*/
public function setRefTransId($refTransId)
{
}
}
/**
* Class representing ProfileTransCaptureOnlyType
*
*
* XSD Type: profileTransCaptureOnlyType
*/
class ProfileTransCaptureOnlyType extends \net\authorize\api\contract\v1\ProfileTransOrderType
{
/**
* Gets as approvalCode
*
* @return string
*/
public function getApprovalCode()
{
}
/**
* Sets a new approvalCode
*
* @param string $approvalCode
* @return self
*/
public function setApprovalCode($approvalCode)
{
}
}
/**
* Class representing SecurePaymentContainerErrorType
*
*
* XSD Type: securePaymentContainerErrorType
*/
class SecurePaymentContainerErrorType
{
/**
* Gets as code
*
* @return string
*/
public function getCode()
{
}
/**
* Sets a new code
*
* @param string $code
* @return self
*/
public function setCode($code)
{
}
/**
* Gets as description
*
* @return string
*/
public function getDescription()
{
}
/**
* Sets a new description
*
* @param string $description
* @return self
*/
public function setDescription($description)
{
}
}
/**
* Class representing UserFieldType
*
*
* XSD Type: userField
*/
class UserFieldType
{
/**
* Gets as name
*
* @return string
*/
public function getName()
{
}
/**
* Sets a new name
*
* @param string $name
* @return self
*/
public function setName($name)
{
}
/**
* Gets as value
*
* @return string
*/
public function getValue()
{
}
/**
* Sets a new value
*
* @param string $value
* @return self
*/
public function setValue($value)
{
}
}
/**
* Class representing CardArtType
*
*
* XSD Type: cardArt
*/
class CardArtType
{
/**
* Gets as cardBrand
*
* @return string
*/
public function getCardBrand()
{
}
/**
* Sets a new cardBrand
*
* @param string $cardBrand
* @return self
*/
public function setCardBrand($cardBrand)
{
}
/**
* Gets as cardImageHeight
*
* @return string
*/
public function getCardImageHeight()
{
}
/**
* Sets a new cardImageHeight
*
* @param string $cardImageHeight
* @return self
*/
public function setCardImageHeight($cardImageHeight)
{
}
/**
* Gets as cardImageUrl
*
* @return string
*/
public function getCardImageUrl()
{
}
/**
* Sets a new cardImageUrl
*
* @param string $cardImageUrl
* @return self
*/
public function setCardImageUrl($cardImageUrl)
{
}
/**
* Gets as cardImageWidth
*
* @return string
*/
public function getCardImageWidth()
{
}
/**
* Sets a new cardImageWidth
*
* @param string $cardImageWidth
* @return self
*/
public function setCardImageWidth($cardImageWidth)
{
}
/**
* Gets as cardType
*
* @return string
*/
public function getCardType()
{
}
/**
* Sets a new cardType
*
* @param string $cardType
* @return self
*/
public function setCardType($cardType)
{
}
}
/**
* Class representing ArbTransactionType
*
*
* XSD Type: arbTransaction
*/
class ArbTransactionType
{
/**
* Gets as transId
*
* @return string
*/
public function getTransId()
{
}
/**
* Sets a new transId
*
* @param string $transId
* @return self
*/
public function setTransId($transId)
{
}
/**
* Gets as response
*
* @return string
*/
public function getResponse()
{
}
/**
* Sets a new response
*
* @param string $response
* @return self
*/
public function setResponse($response)
{
}
/**
* Gets as submitTimeUTC
*
* @return \DateTime
*/
public function getSubmitTimeUTC()
{
}
/**
* Sets a new submitTimeUTC
*
* @param \DateTime $submitTimeUTC
* @return self
*/
public function setSubmitTimeUTC(\DateTime $submitTimeUTC)
{
}
/**
* Gets as payNum
*
* @return integer
*/
public function getPayNum()
{
}
/**
* Sets a new payNum
*
* @param integer $payNum
* @return self
*/
public function setPayNum($payNum)
{
}
/**
* Gets as attemptNum
*
* @return integer
*/
public function getAttemptNum()
{
}
/**
* Sets a new attemptNum
*
* @param integer $attemptNum
* @return self
*/
public function setAttemptNum($attemptNum)
{
}
}
/**
* Class representing MerchantContactType
*
*
* XSD Type: merchantContactType
*/
class MerchantContactType
{
/**
* Gets as merchantName
*
* @return string
*/
public function getMerchantName()
{
}
/**
* Sets a new merchantName
*
* @param string $merchantName
* @return self
*/
public function setMerchantName($merchantName)
{
}
/**
* Gets as merchantAddress
*
* @return string
*/
public function getMerchantAddress()
{
}
/**
* Sets a new merchantAddress
*
* @param string $merchantAddress
* @return self
*/
public function setMerchantAddress($merchantAddress)
{
}
/**
* Gets as merchantCity
*
* @return string
*/
public function getMerchantCity()
{
}
/**
* Sets a new merchantCity
*
* @param string $merchantCity
* @return self
*/
public function setMerchantCity($merchantCity)
{
}
/**
* Gets as merchantState
*
* @return string
*/
public function getMerchantState()
{
}
/**
* Sets a new merchantState
*
* @param string $merchantState
* @return self
*/
public function setMerchantState($merchantState)
{
}
/**
* Gets as merchantZip
*
* @return string
*/
public function getMerchantZip()
{
}
/**
* Sets a new merchantZip
*
* @param string $merchantZip
* @return self
*/
public function setMerchantZip($merchantZip)
{
}
/**
* Gets as merchantPhone
*
* @return string
*/
public function getMerchantPhone()
{
}
/**
* Sets a new merchantPhone
*
* @param string $merchantPhone
* @return self
*/
public function setMerchantPhone($merchantPhone)
{
}
}
/**
* Class representing PaymentSimpleType
*
*
* XSD Type: paymentSimpleType
*/
class PaymentSimpleType
{
/**
* Gets as creditCard
*
* @return \net\authorize\api\contract\v1\CreditCardSimpleType
*/
public function getCreditCard()
{
}
/**
* Sets a new creditCard
*
* @param \net\authorize\api\contract\v1\CreditCardSimpleType $creditCard
* @return self
*/
public function setCreditCard(\net\authorize\api\contract\v1\CreditCardSimpleType $creditCard)
{
}
/**
* Gets as bankAccount
*
* @return \net\authorize\api\contract\v1\BankAccountType
*/
public function getBankAccount()
{
}
/**
* Sets a new bankAccount
*
* @param \net\authorize\api\contract\v1\BankAccountType $bankAccount
* @return self
*/
public function setBankAccount(\net\authorize\api\contract\v1\BankAccountType $bankAccount)
{
}
}
/**
* Class representing DeleteCustomerProfileResponse
*/
class DeleteCustomerProfileResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing TransactionRequestType
*
*
* XSD Type: transactionRequestType
*/
class TransactionRequestType
{
/**
* Gets as transactionType
*
* @return string
*/
public function getTransactionType()
{
}
/**
* Sets a new transactionType
*
* @param string $transactionType
* @return self
*/
public function setTransactionType($transactionType)
{
}
/**
* Gets as amount
*
* @return float
*/
public function getAmount()
{
}
/**
* Sets a new amount
*
* @param float $amount
* @return self
*/
public function setAmount($amount)
{
}
/**
* Gets as currencyCode
*
* @return string
*/
public function getCurrencyCode()
{
}
/**
* Sets a new currencyCode
*
* @param string $currencyCode
* @return self
*/
public function setCurrencyCode($currencyCode)
{
}
/**
* Gets as payment
*
* @return \net\authorize\api\contract\v1\PaymentType
*/
public function getPayment()
{
}
/**
* Sets a new payment
*
* @param \net\authorize\api\contract\v1\PaymentType $payment
* @return self
*/
public function setPayment(\net\authorize\api\contract\v1\PaymentType $payment)
{
}
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\CustomerProfilePaymentType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\CustomerProfilePaymentType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\CustomerProfilePaymentType $profile)
{
}
/**
* Gets as solution
*
* @return \net\authorize\api\contract\v1\SolutionType
*/
public function getSolution()
{
}
/**
* Sets a new solution
*
* @param \net\authorize\api\contract\v1\SolutionType $solution
* @return self
*/
public function setSolution(\net\authorize\api\contract\v1\SolutionType $solution)
{
}
/**
* Gets as callId
*
* @return string
*/
public function getCallId()
{
}
/**
* Sets a new callId
*
* @param string $callId
* @return self
*/
public function setCallId($callId)
{
}
/**
* Gets as terminalNumber
*
* @return string
*/
public function getTerminalNumber()
{
}
/**
* Sets a new terminalNumber
*
* @param string $terminalNumber
* @return self
*/
public function setTerminalNumber($terminalNumber)
{
}
/**
* Gets as authCode
*
* @return string
*/
public function getAuthCode()
{
}
/**
* Sets a new authCode
*
* @param string $authCode
* @return self
*/
public function setAuthCode($authCode)
{
}
/**
* Gets as refTransId
*
* @return string
*/
public function getRefTransId()
{
}
/**
* Sets a new refTransId
*
* @param string $refTransId
* @return self
*/
public function setRefTransId($refTransId)
{
}
/**
* Gets as splitTenderId
*
* @return string
*/
public function getSplitTenderId()
{
}
/**
* Sets a new splitTenderId
*
* @param string $splitTenderId
* @return self
*/
public function setSplitTenderId($splitTenderId)
{
}
/**
* Gets as order
*
* @return \net\authorize\api\contract\v1\OrderType
*/
public function getOrder()
{
}
/**
* Sets a new order
*
* @param \net\authorize\api\contract\v1\OrderType $order
* @return self
*/
public function setOrder(\net\authorize\api\contract\v1\OrderType $order)
{
}
/**
* Adds as lineItem
*
* @return self
* @param \net\authorize\api\contract\v1\LineItemType $lineItem
*/
public function addToLineItems(\net\authorize\api\contract\v1\LineItemType $lineItem)
{
}
/**
* isset lineItems
*
* @param scalar $index
* @return boolean
*/
public function issetLineItems($index)
{
}
/**
* unset lineItems
*
* @param scalar $index
* @return void
*/
public function unsetLineItems($index)
{
}
/**
* Gets as lineItems
*
* @return \net\authorize\api\contract\v1\LineItemType[]
*/
public function getLineItems()
{
}
/**
* Sets a new lineItems
*
* @param \net\authorize\api\contract\v1\LineItemType[] $lineItems
* @return self
*/
public function setLineItems(array $lineItems)
{
}
/**
* Gets as tax
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getTax()
{
}
/**
* Sets a new tax
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $tax
* @return self
*/
public function setTax(\net\authorize\api\contract\v1\ExtendedAmountType $tax)
{
}
/**
* Gets as duty
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getDuty()
{
}
/**
* Sets a new duty
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $duty
* @return self
*/
public function setDuty(\net\authorize\api\contract\v1\ExtendedAmountType $duty)
{
}
/**
* Gets as shipping
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getShipping()
{
}
/**
* Sets a new shipping
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $shipping
* @return self
*/
public function setShipping(\net\authorize\api\contract\v1\ExtendedAmountType $shipping)
{
}
/**
* Gets as taxExempt
*
* @return boolean
*/
public function getTaxExempt()
{
}
/**
* Sets a new taxExempt
*
* @param boolean $taxExempt
* @return self
*/
public function setTaxExempt($taxExempt)
{
}
/**
* Gets as poNumber
*
* @return string
*/
public function getPoNumber()
{
}
/**
* Sets a new poNumber
*
* @param string $poNumber
* @return self
*/
public function setPoNumber($poNumber)
{
}
/**
* Gets as customer
*
* @return \net\authorize\api\contract\v1\CustomerDataType
*/
public function getCustomer()
{
}
/**
* Sets a new customer
*
* @param \net\authorize\api\contract\v1\CustomerDataType $customer
* @return self
*/
public function setCustomer(\net\authorize\api\contract\v1\CustomerDataType $customer)
{
}
/**
* Gets as billTo
*
* @return \net\authorize\api\contract\v1\CustomerAddressType
*/
public function getBillTo()
{
}
/**
* Sets a new billTo
*
* @param \net\authorize\api\contract\v1\CustomerAddressType $billTo
* @return self
*/
public function setBillTo(\net\authorize\api\contract\v1\CustomerAddressType $billTo)
{
}
/**
* Gets as shipTo
*
* @return \net\authorize\api\contract\v1\NameAndAddressType
*/
public function getShipTo()
{
}
/**
* Sets a new shipTo
*
* @param \net\authorize\api\contract\v1\NameAndAddressType $shipTo
* @return self
*/
public function setShipTo(\net\authorize\api\contract\v1\NameAndAddressType $shipTo)
{
}
/**
* Gets as customerIP
*
* @return string
*/
public function getCustomerIP()
{
}
/**
* Sets a new customerIP
*
* @param string $customerIP
* @return self
*/
public function setCustomerIP($customerIP)
{
}
/**
* Gets as cardholderAuthentication
*
* @return \net\authorize\api\contract\v1\CcAuthenticationType
*/
public function getCardholderAuthentication()
{
}
/**
* Sets a new cardholderAuthentication
*
* @param \net\authorize\api\contract\v1\CcAuthenticationType
* $cardholderAuthentication
* @return self
*/
public function setCardholderAuthentication(\net\authorize\api\contract\v1\CcAuthenticationType $cardholderAuthentication)
{
}
/**
* Gets as retail
*
* @return \net\authorize\api\contract\v1\TransRetailInfoType
*/
public function getRetail()
{
}
/**
* Sets a new retail
*
* @param \net\authorize\api\contract\v1\TransRetailInfoType $retail
* @return self
*/
public function setRetail(\net\authorize\api\contract\v1\TransRetailInfoType $retail)
{
}
/**
* Gets as employeeId
*
* @return string
*/
public function getEmployeeId()
{
}
/**
* Sets a new employeeId
*
* @param string $employeeId
* @return self
*/
public function setEmployeeId($employeeId)
{
}
/**
* Adds as setting
*
* Allowed values for settingName are: emailCustomer, merchantEmail,
* allowPartialAuth, headerEmailReceipt, footerEmailReceipt, recurringBilling,
* duplicateWindow, testRequest.
*
* @return self
* @param \net\authorize\api\contract\v1\SettingType $setting
*/
public function addToTransactionSettings(\net\authorize\api\contract\v1\SettingType $setting)
{
}
/**
* isset transactionSettings
*
* Allowed values for settingName are: emailCustomer, merchantEmail,
* allowPartialAuth, headerEmailReceipt, footerEmailReceipt, recurringBilling,
* duplicateWindow, testRequest.
*
* @param scalar $index
* @return boolean
*/
public function issetTransactionSettings($index)
{
}
/**
* unset transactionSettings
*
* Allowed values for settingName are: emailCustomer, merchantEmail,
* allowPartialAuth, headerEmailReceipt, footerEmailReceipt, recurringBilling,
* duplicateWindow, testRequest.
*
* @param scalar $index
* @return void
*/
public function unsetTransactionSettings($index)
{
}
/**
* Gets as transactionSettings
*
* Allowed values for settingName are: emailCustomer, merchantEmail,
* allowPartialAuth, headerEmailReceipt, footerEmailReceipt, recurringBilling,
* duplicateWindow, testRequest.
*
* @return \net\authorize\api\contract\v1\SettingType[]
*/
public function getTransactionSettings()
{
}
/**
* Sets a new transactionSettings
*
* Allowed values for settingName are: emailCustomer, merchantEmail,
* allowPartialAuth, headerEmailReceipt, footerEmailReceipt, recurringBilling,
* duplicateWindow, testRequest.
*
* @param \net\authorize\api\contract\v1\SettingType[] $transactionSettings
* @return self
*/
public function setTransactionSettings(array $transactionSettings)
{
}
/**
* Adds as userField
*
* @return self
* @param \net\authorize\api\contract\v1\UserFieldType $userField
*/
public function addToUserFields(\net\authorize\api\contract\v1\UserFieldType $userField)
{
}
/**
* isset userFields
*
* @param scalar $index
* @return boolean
*/
public function issetUserFields($index)
{
}
/**
* unset userFields
*
* @param scalar $index
* @return void
*/
public function unsetUserFields($index)
{
}
/**
* Gets as userFields
*
* @return \net\authorize\api\contract\v1\UserFieldType[]
*/
public function getUserFields()
{
}
/**
* Sets a new userFields
*
* @param \net\authorize\api\contract\v1\UserFieldType[] $userFields
* @return self
*/
public function setUserFields(array $userFields)
{
}
/**
* Gets as surcharge
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getSurcharge()
{
}
/**
* Sets a new surcharge
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $surcharge
* @return self
*/
public function setSurcharge(\net\authorize\api\contract\v1\ExtendedAmountType $surcharge)
{
}
/**
* Gets as merchantDescriptor
*
* @return string
*/
public function getMerchantDescriptor()
{
}
/**
* Sets a new merchantDescriptor
*
* @param string $merchantDescriptor
* @return self
*/
public function setMerchantDescriptor($merchantDescriptor)
{
}
/**
* Gets as subMerchant
*
* @return \net\authorize\api\contract\v1\SubMerchantType
*/
public function getSubMerchant()
{
}
/**
* Sets a new subMerchant
*
* @param \net\authorize\api\contract\v1\SubMerchantType $subMerchant
* @return self
*/
public function setSubMerchant(\net\authorize\api\contract\v1\SubMerchantType $subMerchant)
{
}
/**
* Gets as tip
*
* @return \net\authorize\api\contract\v1\ExtendedAmountType
*/
public function getTip()
{
}
/**
* Sets a new tip
*
* @param \net\authorize\api\contract\v1\ExtendedAmountType $tip
* @return self
*/
public function setTip(\net\authorize\api\contract\v1\ExtendedAmountType $tip)
{
}
}
/**
* Class representing GetSettledBatchListRequest
*/
class GetSettledBatchListRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as includeStatistics
*
* @return boolean
*/
public function getIncludeStatistics()
{
}
/**
* Sets a new includeStatistics
*
* @param boolean $includeStatistics
* @return self
*/
public function setIncludeStatistics($includeStatistics)
{
}
/**
* Gets as firstSettlementDate
*
* @return \DateTime
*/
public function getFirstSettlementDate()
{
}
/**
* Sets a new firstSettlementDate
*
* @param \DateTime $firstSettlementDate
* @return self
*/
public function setFirstSettlementDate(\DateTime $firstSettlementDate)
{
}
/**
* Gets as lastSettlementDate
*
* @return \DateTime
*/
public function getLastSettlementDate()
{
}
/**
* Sets a new lastSettlementDate
*
* @param \DateTime $lastSettlementDate
* @return self
*/
public function setLastSettlementDate(\DateTime $lastSettlementDate)
{
}
}
/**
* Class representing CustomerPaymentProfileMaskedType
*
*
* XSD Type: customerPaymentProfileMaskedType
*/
class CustomerPaymentProfileMaskedType extends \net\authorize\api\contract\v1\CustomerPaymentProfileBaseType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as defaultPaymentProfile
*
* @return boolean
*/
public function getDefaultPaymentProfile()
{
}
/**
* Sets a new defaultPaymentProfile
*
* @param boolean $defaultPaymentProfile
* @return self
*/
public function setDefaultPaymentProfile($defaultPaymentProfile)
{
}
/**
* Gets as payment
*
* @return \net\authorize\api\contract\v1\PaymentMaskedType
*/
public function getPayment()
{
}
/**
* Sets a new payment
*
* @param \net\authorize\api\contract\v1\PaymentMaskedType $payment
* @return self
*/
public function setPayment(\net\authorize\api\contract\v1\PaymentMaskedType $payment)
{
}
/**
* Gets as driversLicense
*
* @return \net\authorize\api\contract\v1\DriversLicenseMaskedType
*/
public function getDriversLicense()
{
}
/**
* Sets a new driversLicense
*
* @param \net\authorize\api\contract\v1\DriversLicenseMaskedType $driversLicense
* @return self
*/
public function setDriversLicense(\net\authorize\api\contract\v1\DriversLicenseMaskedType $driversLicense)
{
}
/**
* Gets as taxId
*
* @return string
*/
public function getTaxId()
{
}
/**
* Sets a new taxId
*
* @param string $taxId
* @return self
*/
public function setTaxId($taxId)
{
}
/**
* Adds as subscriptionId
*
* @return self
* @param string $subscriptionId
*/
public function addToSubscriptionIds($subscriptionId)
{
}
/**
* isset subscriptionIds
*
* @param scalar $index
* @return boolean
*/
public function issetSubscriptionIds($index)
{
}
/**
* unset subscriptionIds
*
* @param scalar $index
* @return void
*/
public function unsetSubscriptionIds($index)
{
}
/**
* Gets as subscriptionIds
*
* @return string[]
*/
public function getSubscriptionIds()
{
}
/**
* Sets a new subscriptionIds
*
* @param string $subscriptionIds
* @return self
*/
public function setSubscriptionIds(array $subscriptionIds)
{
}
}
/**
* Class representing UpdateCustomerShippingAddressRequest
*/
class UpdateCustomerShippingAddressRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as address
*
* @return \net\authorize\api\contract\v1\CustomerAddressExType
*/
public function getAddress()
{
}
/**
* Sets a new address
*
* @param \net\authorize\api\contract\v1\CustomerAddressExType $address
* @return self
*/
public function setAddress(\net\authorize\api\contract\v1\CustomerAddressExType $address)
{
}
/**
* Gets as defaultShippingAddress
*
* @return boolean
*/
public function getDefaultShippingAddress()
{
}
/**
* Sets a new defaultShippingAddress
*
* @param boolean $defaultShippingAddress
* @return self
*/
public function setDefaultShippingAddress($defaultShippingAddress)
{
}
}
/**
* Class representing GetTransactionListForCustomerRequest
*/
class GetTransactionListForCustomerRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
/**
* Gets as customerPaymentProfileId
*
* @return string
*/
public function getCustomerPaymentProfileId()
{
}
/**
* Sets a new customerPaymentProfileId
*
* @param string $customerPaymentProfileId
* @return self
*/
public function setCustomerPaymentProfileId($customerPaymentProfileId)
{
}
/**
* Gets as sorting
*
* @return \net\authorize\api\contract\v1\TransactionListSortingType
*/
public function getSorting()
{
}
/**
* Sets a new sorting
*
* @param \net\authorize\api\contract\v1\TransactionListSortingType $sorting
* @return self
*/
public function setSorting(\net\authorize\api\contract\v1\TransactionListSortingType $sorting)
{
}
/**
* Gets as paging
*
* @return \net\authorize\api\contract\v1\PagingType
*/
public function getPaging()
{
}
/**
* Sets a new paging
*
* @param \net\authorize\api\contract\v1\PagingType $paging
* @return self
*/
public function setPaging(\net\authorize\api\contract\v1\PagingType $paging)
{
}
}
/**
* Class representing GetCustomerShippingAddressResponse
*/
class GetCustomerShippingAddressResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as defaultShippingAddress
*
* @return boolean
*/
public function getDefaultShippingAddress()
{
}
/**
* Sets a new defaultShippingAddress
*
* @param boolean $defaultShippingAddress
* @return self
*/
public function setDefaultShippingAddress($defaultShippingAddress)
{
}
/**
* Gets as address
*
* @return \net\authorize\api\contract\v1\CustomerAddressExType
*/
public function getAddress()
{
}
/**
* Sets a new address
*
* @param \net\authorize\api\contract\v1\CustomerAddressExType $address
* @return self
*/
public function setAddress(\net\authorize\api\contract\v1\CustomerAddressExType $address)
{
}
/**
* Adds as subscriptionId
*
* @return self
* @param string $subscriptionId
*/
public function addToSubscriptionIds($subscriptionId)
{
}
/**
* isset subscriptionIds
*
* @param scalar $index
* @return boolean
*/
public function issetSubscriptionIds($index)
{
}
/**
* unset subscriptionIds
*
* @param scalar $index
* @return void
*/
public function unsetSubscriptionIds($index)
{
}
/**
* Gets as subscriptionIds
*
* @return string[]
*/
public function getSubscriptionIds()
{
}
/**
* Sets a new subscriptionIds
*
* @param string $subscriptionIds
* @return self
*/
public function setSubscriptionIds(array $subscriptionIds)
{
}
}
/**
* Class representing PaymentScheduleType
*
*
* XSD Type: paymentScheduleType
*/
class PaymentScheduleType
{
/**
* Gets as interval
*
* @return \net\authorize\api\contract\v1\PaymentScheduleType\IntervalAType
*/
public function getInterval()
{
}
/**
* Sets a new interval
*
* @param \net\authorize\api\contract\v1\PaymentScheduleType\IntervalAType
* $interval
* @return self
*/
public function setInterval(\net\authorize\api\contract\v1\PaymentScheduleType\IntervalAType $interval)
{
}
/**
* Gets as startDate
*
* @return \DateTime
*/
public function getStartDate()
{
}
/**
* Sets a new startDate
*
* @param \DateTime $startDate
* @return self
*/
public function setStartDate(\DateTime $startDate)
{
}
/**
* Gets as totalOccurrences
*
* @return integer
*/
public function getTotalOccurrences()
{
}
/**
* Sets a new totalOccurrences
*
* @param integer $totalOccurrences
* @return self
*/
public function setTotalOccurrences($totalOccurrences)
{
}
/**
* Gets as trialOccurrences
*
* @return integer
*/
public function getTrialOccurrences()
{
}
/**
* Sets a new trialOccurrences
*
* @param integer $trialOccurrences
* @return self
*/
public function setTrialOccurrences($trialOccurrences)
{
}
}
/**
* Class representing SubMerchantType
*
*
* XSD Type: subMerchantType
*/
class SubMerchantType
{
/**
* Gets as identifier
*
* @return string
*/
public function getIdentifier()
{
}
/**
* Sets a new identifier
*
* @param string $identifier
* @return self
*/
public function setIdentifier($identifier)
{
}
/**
* Gets as doingBusinessAs
*
* @return string
*/
public function getDoingBusinessAs()
{
}
/**
* Sets a new doingBusinessAs
*
* @param string $doingBusinessAs
* @return self
*/
public function setDoingBusinessAs($doingBusinessAs)
{
}
/**
* Gets as paymentServiceProviderName
*
* @return string
*/
public function getPaymentServiceProviderName()
{
}
/**
* Sets a new paymentServiceProviderName
*
* @param string $paymentServiceProviderName
* @return self
*/
public function setPaymentServiceProviderName($paymentServiceProviderName)
{
}
/**
* Gets as paymentServiceFacilitator
*
* @return string
*/
public function getPaymentServiceFacilitator()
{
}
/**
* Sets a new paymentServiceFacilitator
*
* @param string $paymentServiceFacilitator
* @return self
*/
public function setPaymentServiceFacilitator($paymentServiceFacilitator)
{
}
/**
* Gets as streetAddress
*
* @return string
*/
public function getStreetAddress()
{
}
/**
* Sets a new streetAddress
*
* @param string $streetAddress
* @return self
*/
public function setStreetAddress($streetAddress)
{
}
/**
* Gets as phone
*
* @return string
*/
public function getPhone()
{
}
/**
* Sets a new phone
*
* @param string $phone
* @return self
*/
public function setPhone($phone)
{
}
/**
* Gets as email
*
* @return string
*/
public function getEmail()
{
}
/**
* Sets a new email
*
* @param string $email
* @return self
*/
public function setEmail($email)
{
}
/**
* Gets as postalCode
*
* @return string
*/
public function getPostalCode()
{
}
/**
* Sets a new postalCode
*
* @param string $postalCode
* @return self
*/
public function setPostalCode($postalCode)
{
}
/**
* Gets as city
*
* @return string
*/
public function getCity()
{
}
/**
* Sets a new city
*
* @param string $city
* @return self
*/
public function setCity($city)
{
}
/**
* Gets as regionCode
*
* @return string
*/
public function getRegionCode()
{
}
/**
* Sets a new regionCode
*
* @param string $regionCode
* @return self
*/
public function setRegionCode($regionCode)
{
}
/**
* Gets as countryCode
*
* @return string
*/
public function getCountryCode()
{
}
/**
* Sets a new countryCode
*
* @param string $countryCode
* @return self
*/
public function setCountryCode($countryCode)
{
}
}
/**
* Class representing CustomerProfileMaskedType
*
*
* XSD Type: customerProfileMaskedType
*/
class CustomerProfileMaskedType extends \net\authorize\api\contract\v1\CustomerProfileExType
{
/**
* Adds as paymentProfiles
*
* @return self
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileMaskedType
* $paymentProfiles
*/
public function addToPaymentProfiles(\net\authorize\api\contract\v1\CustomerPaymentProfileMaskedType $paymentProfiles)
{
}
/**
* isset paymentProfiles
*
* @param scalar $index
* @return boolean
*/
public function issetPaymentProfiles($index)
{
}
/**
* unset paymentProfiles
*
* @param scalar $index
* @return void
*/
public function unsetPaymentProfiles($index)
{
}
/**
* Gets as paymentProfiles
*
* @return \net\authorize\api\contract\v1\CustomerPaymentProfileMaskedType[]
*/
public function getPaymentProfiles()
{
}
/**
* Sets a new paymentProfiles
*
* @param \net\authorize\api\contract\v1\CustomerPaymentProfileMaskedType[]
* $paymentProfiles
* @return self
*/
public function setPaymentProfiles(array $paymentProfiles)
{
}
/**
* Adds as shipToList
*
* @return self
* @param \net\authorize\api\contract\v1\CustomerAddressExType $shipToList
*/
public function addToShipToList(\net\authorize\api\contract\v1\CustomerAddressExType $shipToList)
{
}
/**
* isset shipToList
*
* @param scalar $index
* @return boolean
*/
public function issetShipToList($index)
{
}
/**
* unset shipToList
*
* @param scalar $index
* @return void
*/
public function unsetShipToList($index)
{
}
/**
* Gets as shipToList
*
* @return \net\authorize\api\contract\v1\CustomerAddressExType[]
*/
public function getShipToList()
{
}
/**
* Sets a new shipToList
*
* @param \net\authorize\api\contract\v1\CustomerAddressExType[] $shipToList
* @return self
*/
public function setShipToList(array $shipToList)
{
}
/**
* Gets as profileType
*
* @return string
*/
public function getProfileType()
{
}
/**
* Sets a new profileType
*
* @param string $profileType
* @return self
*/
public function setProfileType($profileType)
{
}
}
/**
* Class representing SettingType
*
*
* XSD Type: settingType
*/
class SettingType
{
/**
* Gets as settingName
*
* @return string
*/
public function getSettingName()
{
}
/**
* Sets a new settingName
*
* @param string $settingName
* @return self
*/
public function setSettingName($settingName)
{
}
/**
* Gets as settingValue
*
* @return string
*/
public function getSettingValue()
{
}
/**
* Sets a new settingValue
*
* @param string $settingValue
* @return self
*/
public function setSettingValue($settingValue)
{
}
}
/**
* Class representing PaymentMaskedType
*
*
* XSD Type: paymentMaskedType
*/
class PaymentMaskedType
{
/**
* Gets as creditCard
*
* @return \net\authorize\api\contract\v1\CreditCardMaskedType
*/
public function getCreditCard()
{
}
/**
* Sets a new creditCard
*
* @param \net\authorize\api\contract\v1\CreditCardMaskedType $creditCard
* @return self
*/
public function setCreditCard(\net\authorize\api\contract\v1\CreditCardMaskedType $creditCard)
{
}
/**
* Gets as bankAccount
*
* @return \net\authorize\api\contract\v1\BankAccountMaskedType
*/
public function getBankAccount()
{
}
/**
* Sets a new bankAccount
*
* @param \net\authorize\api\contract\v1\BankAccountMaskedType $bankAccount
* @return self
*/
public function setBankAccount(\net\authorize\api\contract\v1\BankAccountMaskedType $bankAccount)
{
}
/**
* Gets as tokenInformation
*
* @return \net\authorize\api\contract\v1\TokenMaskedType
*/
public function getTokenInformation()
{
}
/**
* Sets a new tokenInformation
*
* @param \net\authorize\api\contract\v1\TokenMaskedType $tokenInformation
* @return self
*/
public function setTokenInformation(\net\authorize\api\contract\v1\TokenMaskedType $tokenInformation)
{
}
}
/**
* Class representing AuthenticateTestResponse
*/
class AuthenticateTestResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
}
/**
* Class representing ARBCreateSubscriptionResponse
*/
class ARBCreateSubscriptionResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as subscriptionId
*
* @return string
*/
public function getSubscriptionId()
{
}
/**
* Sets a new subscriptionId
*
* @param string $subscriptionId
* @return self
*/
public function setSubscriptionId($subscriptionId)
{
}
/**
* Gets as profile
*
* @return \net\authorize\api\contract\v1\CustomerProfileIdType
*/
public function getProfile()
{
}
/**
* Sets a new profile
*
* @param \net\authorize\api\contract\v1\CustomerProfileIdType $profile
* @return self
*/
public function setProfile(\net\authorize\api\contract\v1\CustomerProfileIdType $profile)
{
}
}
/**
* Class representing MobileDeviceLoginRequest
*/
class MobileDeviceLoginRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
}
/**
* Class representing DecryptPaymentDataResponse
*/
class DecryptPaymentDataResponse extends \net\authorize\api\contract\v1\ANetApiResponseType
{
/**
* Gets as shippingInfo
*
* @return \net\authorize\api\contract\v1\CustomerAddressType
*/
public function getShippingInfo()
{
}
/**
* Sets a new shippingInfo
*
* @param \net\authorize\api\contract\v1\CustomerAddressType $shippingInfo
* @return self
*/
public function setShippingInfo(\net\authorize\api\contract\v1\CustomerAddressType $shippingInfo)
{
}
/**
* Gets as billingInfo
*
* @return \net\authorize\api\contract\v1\CustomerAddressType
*/
public function getBillingInfo()
{
}
/**
* Sets a new billingInfo
*
* @param \net\authorize\api\contract\v1\CustomerAddressType $billingInfo
* @return self
*/
public function setBillingInfo(\net\authorize\api\contract\v1\CustomerAddressType $billingInfo)
{
}
/**
* Gets as cardInfo
*
* @return \net\authorize\api\contract\v1\CreditCardMaskedType
*/
public function getCardInfo()
{
}
/**
* Sets a new cardInfo
*
* @param \net\authorize\api\contract\v1\CreditCardMaskedType $cardInfo
* @return self
*/
public function setCardInfo(\net\authorize\api\contract\v1\CreditCardMaskedType $cardInfo)
{
}
/**
* Gets as paymentDetails
*
* @return \net\authorize\api\contract\v1\PaymentDetailsType
*/
public function getPaymentDetails()
{
}
/**
* Sets a new paymentDetails
*
* @param \net\authorize\api\contract\v1\PaymentDetailsType $paymentDetails
* @return self
*/
public function setPaymentDetails(\net\authorize\api\contract\v1\PaymentDetailsType $paymentDetails)
{
}
}
/**
* Class representing DeleteCustomerProfileRequest
*/
class DeleteCustomerProfileRequest extends \net\authorize\api\contract\v1\ANetApiRequestType
{
/**
* Gets as customerProfileId
*
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* Sets a new customerProfileId
*
* @param string $customerProfileId
* @return self
*/
public function setCustomerProfileId($customerProfileId)
{
}
}
}
namespace net\authorize\api\constants {
class ANetEnvironment
{
const CUSTOM = "http://wwww.myendpoint.com";
const SANDBOX = "https://apitest.authorize.net";
const PRODUCTION = "https://api2.authorize.net";
const VERSION = "1.9.7";
}
}
namespace {
/**
* Sends requests to the Authorize.Net gateways.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetRequest
*/
abstract class AuthorizeNetRequest
{
protected $_api_login;
protected $_transaction_key;
protected $_post_string;
public $VERIFY_PEER = \true;
// attempt trust validation of SSL certificates when establishing secure connections.
protected $_sandbox = \true;
protected $_logger = \null;
/**
* Set the _post_string
*/
protected abstract function _setPostString();
/**
* Handle the response string
*/
protected abstract function _handleResponse($string);
/**
* Get the post url. We need this because until 5.3 you
* you could not access child constants in a parent class.
*/
protected abstract function _getPostUrl();
/**
* Constructor.
*
* @param string $api_login_id The Merchant's API Login ID.
* @param string $transaction_key The Merchant's Transaction Key.
*/
public function __construct($api_login_id = \false, $transaction_key = \false)
{
}
/**
* Alter the gateway url.
*
* @param bool $bool Use the Sandbox.
*/
public function setSandbox($bool)
{
}
/**
* Set a log file.
*
* @param string $filepath Path to log file.
*/
public function setLogFile($filepath)
{
}
/**
* Return the post string.
*
* @return string
*/
public function getPostString()
{
}
/**
* Posts the request to AuthorizeNet & returns response.
*
* @return AuthorizeNetARB_Response The response.
*/
protected function _sendRequest()
{
}
}
/**
* Easily interact with the Authorize.Net AIM API.
*
*
* Example Authorize and Capture Transaction against the Sandbox:
* <code>
* <?php require_once 'AuthorizeNet.php'
* $sale = new AuthorizeNetAIM;
* $sale->setFields(
* array(
* 'amount' => '4.99',
* 'card_num' => '411111111111111',
* 'exp_date' => '0515'
* )
* );
* $response = $sale->authorizeAndCapture();
* if ($response->approved) {
* echo "Sale successful!"; } else {
* echo $response->error_message;
* }
* ?>
* </code>
*
* Note: To send requests to the live gateway, either define this:
* define("AUTHORIZENET_SANDBOX", false);
* -- OR --
* $sale = new AuthorizeNetAIM;
* $sale->setSandbox(false);
*
* @package AuthorizeNet
* @subpackage AuthorizeNetAIM
* @link http://www.authorize.net/support/AIM_guide.pdf AIM Guide
*/
/**
* Builds and sends an AuthorizeNet AIM Request.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetAIM
*/
class AuthorizeNetAIM extends \AuthorizeNetRequest
{
const LIVE_URL = 'https://secure2.authorize.net/gateway/transact.dll';
const SANDBOX_URL = 'https://test.authorize.net/gateway/transact.dll';
/**
* Holds all the x_* name/values that will be posted in the request.
* Default values are provided for best practice fields.
*/
protected $_x_post_fields = array("version" => "3.1", "delim_char" => ",", "delim_data" => "TRUE", "relay_response" => "FALSE", "encap_char" => "|");
/**
* Checks to make sure a field is actually in the API before setting.
* Set to false to skip this check.
*/
public $verify_x_fields = \true;
/**
* Do an AUTH_CAPTURE transaction.
*
* Required "x_" fields: card_num, exp_date, amount
*
* @param string $amount The dollar amount to charge
* @param string $card_num The credit card number
* @param string $exp_date CC expiration date
*
* @return AuthorizeNetAIM_Response
*/
public function authorizeAndCapture($amount = \false, $card_num = \false, $exp_date = \false)
{
}
/**
* Do a PRIOR_AUTH_CAPTURE transaction.
*
* Required "x_" field: trans_id(The transaction id of the prior auth, unless split
* tender, then set x_split_tender_id manually.)
* amount (only if lesser than original auth)
*
* @param string $trans_id Transaction id to charge
* @param string $amount Dollar amount to charge if lesser than auth
*
* @return AuthorizeNetAIM_Response
*/
public function priorAuthCapture($trans_id = \false, $amount = \false)
{
}
/**
* Do an AUTH_ONLY transaction.
*
* Required "x_" fields: card_num, exp_date, amount
*
* @param string $amount The dollar amount to charge
* @param string $card_num The credit card number
* @param string $exp_date CC expiration date
*
* @return AuthorizeNetAIM_Response
*/
public function authorizeOnly($amount = \false, $card_num = \false, $exp_date = \false)
{
}
/**
* Do a VOID transaction.
*
* Required "x_" field: trans_id(The transaction id of the prior auth, unless split
* tender, then set x_split_tender_id manually.)
*
* @param string $trans_id Transaction id to void
*
* @return AuthorizeNetAIM_Response
*/
public function void($trans_id = \false)
{
}
/**
* Do a CAPTURE_ONLY transaction.
*
* Required "x_" fields: auth_code, amount, card_num , exp_date
*
* @param string $auth_code The auth code
* @param string $amount The dollar amount to charge
* @param string $card_num The last 4 of credit card number
* @param string $exp_date CC expiration date
*
* @return AuthorizeNetAIM_Response
*/
public function captureOnly($auth_code = \false, $amount = \false, $card_num = \false, $exp_date = \false)
{
}
/**
* Do a CREDIT transaction.
*
* Required "x_" fields: trans_id, amount, card_num (just the last 4)
*
* @param string $trans_id Transaction id to credit
* @param string $amount The dollar amount to credit
* @param string $card_num The last 4 of credit card number
*
* @return AuthorizeNetAIM_Response
*/
public function credit($trans_id = \false, $amount = \false, $card_num = \false)
{
}
/**
* Alternative syntax for setting x_ fields.
*
* Usage: $sale->method = "echeck";
*
* @param string $name
* @param string $value
*/
public function __set($name, $value)
{
}
/**
* Quickly set multiple fields.
*
* Note: The prefix x_ will be added to all fields. If you want to set a
* custom field without the x_ prefix, use setCustomField or setCustomFields.
*
* @param array $fields Takes an array or object.
*/
public function setFields($fields)
{
}
/**
* Quickly set multiple custom fields.
*
* @param array $fields
*/
public function setCustomFields($fields)
{
}
/**
* Add a line item.
*
* @param string $item_id
* @param string $item_name
* @param string $item_description
* @param string $item_quantity
* @param string $item_unit_price
* @param string $item_taxable
*/
public function addLineItem($item_id, $item_name, $item_description, $item_quantity, $item_unit_price, $item_taxable)
{
}
/**
* Use ECHECK as payment type.
*/
public function setECheck($bank_aba_code, $bank_acct_num, $bank_acct_type, $bank_name, $bank_acct_name, $echeck_type = 'WEB')
{
}
/**
* Set an individual name/value pair. This will append x_ to the name
* before posting.
*
* @param string $name
* @param string $value
*/
public function setField($name, $value)
{
}
/**
* Set a custom field. Note: the x_ prefix will not be added to
* your custom field if you use this method.
*
* @param string $name
* @param string $value
*/
public function setCustomField($name, $value)
{
}
/**
* Unset an x_ field.
*
* @param string $name Field to unset.
*/
public function unsetField($name)
{
}
/**
*
*
* @param string $response
*
* @return AuthorizeNetAIM_Response
*/
protected function _handleResponse($response)
{
}
/**
* @return string
*/
protected function _getPostUrl()
{
}
/**
* Converts the x_post_fields array into a string suitable for posting.
*/
protected function _setPostString()
{
}
}
/**
* Base class for the AuthorizeNet AIM & SIM Responses.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetResponse
*/
/**
* Parses an AuthorizeNet Response.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetResponse
*/
class AuthorizeNetResponse
{
const APPROVED = 1;
const DECLINED = 2;
const ERROR = 3;
const HELD = 4;
public $approved;
public $declined;
public $error;
public $held;
public $response_code;
public $response_subcode;
public $response_reason_code;
public $response_reason_text;
public $authorization_code;
public $avs_response;
public $transaction_id;
public $invoice_number;
public $description;
public $amount;
public $method;
public $transaction_type;
public $customer_id;
public $first_name;
public $last_name;
public $company;
public $address;
public $city;
public $state;
public $zip_code;
public $country;
public $phone;
public $fax;
public $email_address;
public $ship_to_first_name;
public $ship_to_last_name;
public $ship_to_company;
public $ship_to_address;
public $ship_to_city;
public $ship_to_state;
public $ship_to_zip_code;
public $ship_to_country;
public $tax;
public $duty;
public $freight;
public $tax_exempt;
public $purchase_order_number;
public $md5_hash;
public $card_code_response;
public $cavv_response;
// cardholder_authentication_verification_response
public $account_number;
public $card_type;
public $split_tender_id;
public $requested_amount;
public $balance_on_card;
public $response;
// The response string from AuthorizeNet.
}
/**
* Parses an AuthorizeNet AIM Response.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetAIM
*/
class AuthorizeNetAIM_Response extends \AuthorizeNetResponse
{
// An array with the split response.
/**
* Constructor. Parses the AuthorizeNet response string.
*
* @param string $response The response from the AuthNet server.
* @param string $delimiter The delimiter used (default is ",")
* @param string $encap_char The encap_char used (default is "|")
* @param array $custom_fields Any custom fields set in the request.
*/
public function __construct($response, $delimiter, $encap_char, $custom_fields)
{
}
}
/**
* Easily interact with the Authorize.Net CIM XML API.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
* @link http://www.authorize.net/support/CIM_XML_guide.pdf CIM XML Guide
*/
/**
* A class to send a request to the CIM XML API.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
class AuthorizeNetCIM extends \AuthorizeNetRequest
{
const LIVE_URL = "https://api2.authorize.net/xml/v1/request.api";
const SANDBOX_URL = "https://apitest.authorize.net/xml/v1/request.api";
/**
* Optional. Used if the merchant wants to set a reference ID.
*
* @param string $refId
*/
public function setRefId($refId)
{
}
/**
* Create a customer profile.
*
* @param AuthorizeNetCustomer $customerProfile
* @param string $validationMode
*
* @return AuthorizeNetCIM_Response
*/
public function createCustomerProfile($customerProfile, $validationMode = "none")
{
}
/**
* Create a customer payment profile.
*
* @param int $customerProfileId
* @param AuthorizeNetPaymentProfile $paymentProfile
* @param string $validationMode
*
* @return AuthorizeNetCIM_Response
*/
public function createCustomerPaymentProfile($customerProfileId, $paymentProfile, $validationMode = "none")
{
}
/**
* Create a shipping address.
*
* @param int $customerProfileId
* @param AuthorizeNetAddress $shippingAddress
*
* @return AuthorizeNetCIM_Response
*/
public function createCustomerShippingAddress($customerProfileId, $shippingAddress)
{
}
/**
* Create a transaction.
*
* @param string $transactionType
* @param AuthorizeNetTransaction $transaction
* @param string $extraOptionsString
*
* @return AuthorizeNetCIM_Response
*/
public function createCustomerProfileTransaction($transactionType, $transaction, $extraOptionsString = "")
{
}
/**
* Delete a customer profile.
*
* @param int $customerProfileId
*
* @return AuthorizeNetCIM_Response
*/
public function deleteCustomerProfile($customerProfileId)
{
}
/**
* Delete a payment profile.
*
* @param int $customerProfileId
* @param int $customerPaymentProfileId
*
* @return AuthorizeNetCIM_Response
*/
public function deleteCustomerPaymentProfile($customerProfileId, $customerPaymentProfileId)
{
}
/**
* Delete a shipping address.
*
* @param int $customerProfileId
* @param int $customerAddressId
*
* @return AuthorizeNetCIM_Response
*/
public function deleteCustomerShippingAddress($customerProfileId, $customerAddressId)
{
}
/**
* Get all customer profile ids.
*
* @return AuthorizeNetCIM_Response
*/
public function getCustomerProfileIds()
{
}
/**
* Get a customer profile.
*
* @param int $customerProfileId
*
* @return AuthorizeNetCIM_Response
*/
public function getCustomerProfile($customerProfileId, $unmaskExpirationDate = \false)
{
}
/**
* Get a payment profile.
*
* @param int $customerProfileId
* @param int $customerPaymentProfileId
* @param boolean $unmaskExpirationDate
*
* @return AuthorizeNetCIM_Response
*/
public function getCustomerPaymentProfile($customerProfileId, $customerPaymentProfileId, $unmaskExpirationDate = \false)
{
}
/**
* Get a shipping address.
*
* @param int $customerProfileId
* @param int $customerAddressId
*
* @return AuthorizeNetCIM_Response
*/
public function getCustomerShippingAddress($customerProfileId, $customerAddressId)
{
}
/**
* Update a profile.
*
* @param int $customerProfileId
* @param AuthorizeNetCustomer $customerProfile
*
* @return AuthorizeNetCIM_Response
*/
public function updateCustomerProfile($customerProfileId, $customerProfile)
{
}
/**
* Update a payment profile.
*
* @param int $customerProfileId
* @param int $customerPaymentProfileId
* @param AuthorizeNetPaymentProfile $paymentProfile
* @param string $validationMode
*
* @return AuthorizeNetCIM_Response
*/
public function updateCustomerPaymentProfile($customerProfileId, $customerPaymentProfileId, $paymentProfile, $validationMode = "none")
{
}
/**
* Update a shipping address.
*
* @param int $customerProfileId
* @param int $customerShippingAddressId
* @param AuthorizeNetAddress $shippingAddress
*
* @return AuthorizeNetCIM_Response
*/
public function updateCustomerShippingAddress($customerProfileId, $customerShippingAddressId, $shippingAddress)
{
}
/**
* Update the status of an existing order that contains multiple transactions with the same splitTenderId.
*
* @param int $splitTenderId
* @param string $splitTenderStatus
*
* @return AuthorizeNetCIM_Response
*/
public function updateSplitTenderGroup($splitTenderId, $splitTenderStatus)
{
}
/**
* Validate a customer payment profile.
*
* @param int $customerProfileId
* @param int $customerPaymentProfileId
* @param int $customerShippingAddressId
* @param int $cardCode
* @param string $validationMode
*
* @return AuthorizeNetCIM_Response
*/
public function validateCustomerPaymentProfile($customerProfileId, $customerPaymentProfileId, $customerShippingAddressId, $cardCode, $validationMode = "testMode")
{
}
/**
* Get hosted profile page request token
*
* @param string $customerProfileId
* @param mixed $settings
*
* @return AuthorizeNetCIM_Response
*/
public function getHostedProfilePageRequest($customerProfileId, $settings = 0)
{
}
/**
* @return string
*/
protected function _getPostUrl()
{
}
/**
*
*
* @param string $response
*
* @return AuthorizeNetCIM_Response
*/
protected function _handleResponse($response)
{
}
/**
* Prepare the XML post string.
*/
protected function _setPostString()
{
}
}
/**
* Base class for the AuthorizeNet ARB & CIM Responses.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetXML
*/
/**
* Base class for the AuthorizeNet ARB & CIM Responses.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetXML
*/
class AuthorizeNetXMLResponse
{
public $xml;
// Holds a SimpleXML Element with response.
/**
* Constructor. Parses the AuthorizeNet response string.
*
* @param string $response The response from the AuthNet server.
*/
public function __construct($response)
{
}
/**
* Was the transaction successful?
*
* @return bool
*/
public function isOk()
{
}
/**
* Run an xpath query on the cleaned XML response
*
* @param string $path
* @return array Returns an array of SimpleXMLElement objects or FALSE in case of an error.
*/
public function xpath($path)
{
}
/**
* Was there an error?
*
* @return bool
*/
public function isError()
{
}
/**
* @return string
*/
public function getErrorMessage()
{
}
/**
* @return string
*/
public function getRefID()
{
}
/**
* @return string
*/
public function getResultCode()
{
}
/**
* @return string
*/
public function getMessageCode()
{
}
/**
* @return string
*/
public function getMessageText()
{
}
/**
* Grabs the contents of a unique element.
*
* @param string
* @return string
*/
protected function _getElementContents($elementName)
{
}
}
/**
* A class to parse a response from the CIM XML API.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
class AuthorizeNetCIM_Response extends \AuthorizeNetXMLResponse
{
/**
* @return AuthorizeNetAIM_Response
*/
public function getTransactionResponse()
{
}
/**
* @return array Array of AuthorizeNetAIM_Response objects for each payment profile.
*/
public function getValidationResponses()
{
}
/**
* @return AuthorizeNetAIM_Response
*/
public function getValidationResponse()
{
}
/**
* @return array
*/
public function getCustomerProfileIds()
{
}
/**
* @return array
*/
public function getCustomerPaymentProfileIds()
{
}
/**
* @return array
*/
public function getCustomerShippingAddressIds()
{
}
/**
* @return string
*/
public function getCustomerAddressId()
{
}
/**
* @return string
*/
public function getCustomerProfileId()
{
}
/**
* @return string
*/
public function getPaymentProfileId()
{
}
}
/**
* A helper class for using hosted order page.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetSIM
*/
class AuthorizeNetSIM_Form
{
public $x_address;
public $x_amount;
public $x_background_url;
public $x_card_num;
public $x_city;
public $x_color_background;
public $x_color_link;
public $x_color_text;
public $x_company;
public $x_country;
public $x_cust_id;
public $x_customer_ip;
public $x_description;
public $x_delim_data;
public $x_duplicate_window;
public $x_duty;
public $x_email;
public $x_email_customer;
public $x_fax;
public $x_first_name;
public $x_footer_email_receipt;
public $x_footer_html_payment_form;
public $x_footer_html_receipt;
public $x_fp_hash;
public $x_fp_sequence;
public $x_fp_timestamp;
public $x_freight;
public $x_header_email_receipt;
public $x_header_html_payment_form;
public $x_header_html_receipt;
public $x_invoice_num;
public $x_last_name;
public $x_line_item;
public $x_login;
public $x_logo_url;
public $x_method;
public $x_phone;
public $x_po_num;
public $x_receipt_link_method;
public $x_receipt_link_text;
public $x_receipt_link_url;
public $x_recurring_billing;
public $x_relay_response;
public $x_relay_url;
public $x_rename;
public $x_ship_to_address;
public $x_ship_to_company;
public $x_ship_to_country;
public $x_ship_to_city;
public $x_ship_to_first_name;
public $x_ship_to_last_name;
public $x_ship_to_state;
public $x_ship_to_zip;
public $x_show_form;
public $x_state;
public $x_tax;
public $x_tax_exempt;
public $x_test_request;
public $x_trans_id;
public $x_type;
public $x_version;
public $x_zip;
/**
* Constructor
*
* @param array $fields Fields to set.
*/
public function __construct($fields = \false)
{
}
/**
* Get a string of HTML hidden fields for use in a form.
*
* @return string
*/
public function getHiddenFieldString()
{
}
/**
* Generates a fingerprint needed for a hosted order form or DPM.
*
* @param string $api_login_id Login ID.
* @param string $transaction_key API key.
* @param string $amount Amount of transaction.
* @param string $fp_sequence An invoice number or random number.
* @param string $fp_timestamp Timestamp.
* @param string $fp_currency_code Currency Code
*
* @return string The fingerprint.
*/
public static function getFingerprint($api_login_id, $transaction_key, $amount, $fp_sequence, $fp_timestamp, $fp_currency_code = '')
{
}
}
/**
* Demonstrates the Direct Post Method.
*
* To implement the Direct Post Method you need to implement 3 steps:
*
* Step 1: Add necessary hidden fields to your checkout form and make your form is set to post to AuthorizeNet.
*
* Step 2: Receive a response from AuthorizeNet, do your business logic, and return
* a relay response snippet with a url to redirect the customer to.
*
* Step 3: Show a receipt page to your customer.
*
* This class is more for demonstration purposes than actual production use.
*
*
* @package AuthorizeNet
* @subpackage AuthorizeNetDPM
*/
/**
* A class that demonstrates the DPM method.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetDPM
*/
class AuthorizeNetDPM extends \AuthorizeNetSIM_Form
{
const LIVE_URL = 'https://secure2.authorize.net/gateway/transact.dll';
const SANDBOX_URL = 'https://test.authorize.net/gateway/transact.dll';
/**
* Implements all 3 steps of the Direct Post Method for demonstration
* purposes.
*/
public static function directPostDemo($url, $api_login_id, $transaction_key, $amount = "0.00", $md5_setting = "")
{
}
/**
* A snippet to send to AuthorizeNet to redirect the user back to the
* merchant's server. Use this on your relay response page.
*
* @param string $redirect_url Where to redirect the user.
*
* @return string
*/
public static function getRelayResponseSnippet($redirect_url)
{
}
/**
* Generate a sample form for use in a demo Direct Post implementation.
*
* @param string $amount Amount of the transaction.
* @param string $fp_sequence Sequential number(ie. Invoice #)
* @param string $relay_response_url The Relay Response URL
* @param string $api_login_id Your API Login ID
* @param string $transaction_key Your API Tran Key.
* @param bool $test_mode Use the sandbox?
* @param bool $prefill Prefill sample values(for test purposes).
*
* @return string
*/
public static function getCreditCardForm($amount, $fp_sequence, $relay_response_url, $api_login_id, $transaction_key, $test_mode = \true, $prefill = \true)
{
}
}
/**
* Easily interact with the Authorize.Net Card Present API.
*
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCP
* @link http://www.authorize.net/support/CP_guide.pdf Card Present Guide
*/
/**
* Builds and sends an AuthorizeNet CP Request.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCP
*/
class AuthorizeNetCP extends \AuthorizeNetAIM
{
const LIVE_URL = 'https://cardpresent.authorize.net/gateway/transact.dll';
public $verify_x_fields = \false;
/**
* Holds all the x_* name/values that will be posted in the request.
* Default values are provided for best practice fields.
*/
protected $_x_post_fields = array("cpversion" => "1.0", "delim_char" => ",", "encap_char" => "|", "market_type" => "2", "response_format" => "1");
/**
* Strip sentinels and set track1 field.
*
* @param string $track1data
*/
public function setTrack1Data($track1data)
{
}
/**
* Strip sentinels and set track2 field.
*
* @param string $track2data
*/
public function setTrack2Data($track2data)
{
}
/**
*
*
* @param string $response
*
* @return AuthorizeNetAIM_Response
*/
protected function _handleResponse($response)
{
}
}
/**
* Parses an AuthorizeNet Card Present Response.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCP
*/
class AuthorizeNetCP_Response extends \AuthorizeNetResponse
{
// An array with the split response.
/**
* Constructor. Parses the AuthorizeNet response string.
*
* @param string $response The response from the AuthNet server.
* @param string $delimiter The delimiter used (default is ",")
* @param string $encap_char The encap_char used (default is "|")
* @param array $custom_fields Any custom fields set in the request.
*/
public function __construct($response, $delimiter, $encap_char, $custom_fields)
{
}
/**
* Is the MD5 provided correct?
*
* @param string $api_login_id
* @param string $md5_setting
* @return bool
*/
public function isAuthorizeNet($api_login_id = \false, $md5_setting = \false)
{
}
}
/**
* Easily interact with the Authorize.Net Transaction Details XML API.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetTD
* @link http://www.authorize.net/support/ReportingGuide_XML.pdf Transaction Details XML Guide
*/
/**
* A class to send a request to the Transaction Details XML API.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetTD
*/
class AuthorizeNetTD extends \AuthorizeNetRequest
{
const LIVE_URL = "https://api2.authorize.net/xml/v1/request.api";
const SANDBOX_URL = "https://apitest.authorize.net/xml/v1/request.api";
/**
* This function returns information about a settled batch: Batch ID, Settlement Time, &
* Settlement State. If you specify includeStatistics, you also receive batch statistics
* by payment type.
*
*
* The detault date range is one day (the previous 24 hour period). The maximum date range is 31
* days. The merchant time zone is taken into consideration when calculating the batch date range,
* unless the Z is specified in the first and last settlement date
*
* @param bool $includeStatistics
* @param string $firstSettlementDate // yyyy-mmddTHH:MM:SS
* @param string $lastSettlementDate // yyyy-mmddTHH:MM:SS
* @param bool $utc // Use UTC instead of merchant time zone setting
*
* @return AuthorizeNetTD_Response
*/
public function getSettledBatchList($includeStatistics = \false, $firstSettlementDate = \false, $lastSettlementDate = \false, $utc = \true)
{
}
/**
* Return all settled batches for a certain month.
*
* @param int $month
* @param int $year
*
* @return AuthorizeNetTD_Response
*/
public function getSettledBatchListForMonth($month = \false, $year = \false)
{
}
/**
* This function returns limited transaction details for a specified batch ID
*
* @param int $batchId
*
* @return AuthorizeNetTD_Response
*/
public function getTransactionList($batchId)
{
}
/**
* Return all transactions for a certain day.
*
* @param int $month
* @param int $day
* @param int $year
*
* @return array Array of SimpleXMLElments
*/
public function getTransactionsForDay($month = \false, $day = \false, $year = \false)
{
}
/**
* This function returns full transaction details for a specified transaction ID.
*
* @param int $transId
*
* @return AuthorizeNetTD_Response
*/
public function getTransactionDetails($transId)
{
}
/**
* This function returns statistics about the settled batch specified by $batchId.
*
* @param int $batchId
*
* @return AuthorizeNetTD_Response
*/
public function getBatchStatistics($batchId)
{
}
/**
* This function returns the last 1000 unsettled transactions.
*
*
* @return AuthorizeNetTD_Response
*/
public function getUnsettledTransactionList()
{
}
/**
* @return string
*/
protected function _getPostUrl()
{
}
/**
*
*
* @param string $response
*
* @return AuthorizeNetTransactionDetails_Response
*/
protected function _handleResponse($response)
{
}
/**
* Prepare the XML post string.
*/
protected function _setPostString()
{
}
}
/**
* A class to parse a response from the Transaction Details XML API.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetTD
*/
class AuthorizeNetTD_Response extends \AuthorizeNetXMLResponse
{
}
/**
* Easily use the Authorize.Net Server Integration Method(SIM).
*
* @package AuthorizeNet
* @subpackage AuthorizeNetSIM
* @link http://www.authorize.net/support/SIM_guide.pdf SIM Guide
*/
/**
* Easily parse an AuthorizeNet SIM Response.
* @package AuthorizeNet
* @subpackage AuthorizeNetSIM
*/
class AuthorizeNetSIM extends \AuthorizeNetResponse
{
// For ARB transactions
public $subscription_id;
public $subscription_paynum;
/**
* Constructor.
*
* @param string $api_login_id
* @param string $md5_setting For verifying an Authorize.Net message.
*/
public function __construct($api_login_id = \false, $md5_setting = \false)
{
}
/**
* Verify the request is AuthorizeNet.
*
* @return bool
*/
public function isAuthorizeNet()
{
}
/**
* Generates an Md5 hash to compare against Authorize.Net's.
*
* @return string Hash
*/
public function generateHash()
{
}
}
/**
* AuthorizeNetException.php
*
* @package AuthorizeNet
*/
/**
* Exception class for AuthorizeNet PHP SDK.
*
* @package AuthorizeNet
*/
class AuthorizeNetException extends \Exception
{
}
/**
* Classes for the various AuthorizeNet data types.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
/**
* A class that contains all fields for a CIM Customer Profile.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
class AuthorizeNetCustomer
{
public $merchantCustomerId;
public $description;
public $email;
public $paymentProfiles = array();
public $shipToList = array();
public $customerProfileId;
}
/**
* A class that contains all fields for a CIM Address.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
class AuthorizeNetAddress
{
public $firstName;
public $lastName;
public $company;
public $address;
public $city;
public $state;
public $zip;
public $country;
public $phoneNumber;
public $faxNumber;
public $customerAddressId;
}
/**
* A class that contains all fields for a CIM Payment Profile.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
class AuthorizeNetPaymentProfile
{
public $customerType;
public $billTo;
public $payment;
public $customerPaymentProfileId;
public function __construct()
{
}
}
/**
* A class that contains all fields for a CIM Payment Type.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
class AuthorizeNetPayment
{
public $creditCard;
public $bankAccount;
public function __construct()
{
}
}
/**
* A class that contains all fields for a CIM Transaction.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
class AuthorizeNetTransaction
{
public $amount;
public $tax;
public $shipping;
public $duty;
public $lineItems = array();
public $customerProfileId;
public $customerPaymentProfileId;
public $customerShippingAddressId;
public $creditCardNumberMasked;
public $bankRoutingNumberMasked;
public $bankAccountNumberMasked;
public $order;
public $taxExempt;
public $recurringBilling;
public $cardCode;
public $splitTenderId;
public $approvalCode;
public $transId;
public function __construct()
{
}
}
/**
* A class that contains all fields for a CIM Transaction Line Item.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
class AuthorizeNetLineItem
{
public $itemId;
public $name;
public $description;
public $quantity;
public $unitPrice;
public $taxable;
}
/**
* A class that contains all fields for a CIM Credit Card.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
class AuthorizeNetCreditCard
{
public $cardNumber;
public $expirationDate;
public $cardCode;
}
/**
* A class that contains all fields for a CIM Bank Account.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetCIM
*/
class AuthorizeNetBankAccount
{
public $accountType;
public $routingNumber;
public $accountNumber;
public $nameOnAccount;
public $echeckType;
public $bankName;
}
/**
* A class that contains all fields for an AuthorizeNet ARB Subscription.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetARB
*/
class AuthorizeNet_Subscription
{
public $name;
public $intervalLength;
public $intervalUnit;
public $startDate;
public $totalOccurrences;
public $trialOccurrences;
public $amount;
public $trialAmount;
public $creditCardCardNumber;
public $creditCardExpirationDate;
public $creditCardCardCode;
public $bankAccountAccountType;
public $bankAccountRoutingNumber;
public $bankAccountAccountNumber;
public $bankAccountNameOnAccount;
public $bankAccountEcheckType;
public $bankAccountBankName;
public $orderInvoiceNumber;
public $orderDescription;
public $customerId;
public $customerEmail;
public $customerPhoneNumber;
public $customerFaxNumber;
public $billToFirstName;
public $billToLastName;
public $billToCompany;
public $billToAddress;
public $billToCity;
public $billToState;
public $billToZip;
public $billToCountry;
public $shipToFirstName;
public $shipToLastName;
public $shipToCompany;
public $shipToAddress;
public $shipToCity;
public $shipToState;
public $shipToZip;
public $shipToCountry;
public function getXml()
{
}
}
/**
* A class that contains all fields for an AuthorizeNet ARB SubscriptionList.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetARB
*/
class AuthorizeNetGetSubscriptionList
{
public $searchType;
public $sorting;
public $paging;
public function getXml()
{
}
}
class AuthorizeNetSubscriptionListPaging
{
public $limit;
public $offset;
public function getXml()
{
}
}
class AuthorizeNetSubscriptionListSorting
{
public $orderBy;
public $orderDescending;
public function getXml()
{
}
}
/**
* Easily interact with the Authorize.Net ARB XML API.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetARB
* @link http://www.authorize.net/support/ARB_guide.pdf ARB Guide
*/
/**
* A class to send a request to the ARB XML API.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetARB
*/
class AuthorizeNetARB extends \AuthorizeNetRequest
{
const LIVE_URL = "https://api2.authorize.net/xml/v1/request.api";
const SANDBOX_URL = "https://apitest.authorize.net/xml/v1/request.api";
/**
* Optional. Used if the merchant wants to set a reference ID.
*
* @param string $refId
*/
public function setRefId($refId)
{
}
/**
* Create an ARB subscription
*
* @param AuthorizeNet_Subscription $subscription
*
* @return AuthorizeNetARB_Response
*/
public function createSubscription(\AuthorizeNet_Subscription $subscription)
{
}
/**
* Update an ARB subscription
*
* @param int $subscriptionId
* @param AuthorizeNet_Subscription $subscription
*
* @return AuthorizeNetARB_Response
*/
public function updateSubscription($subscriptionId, \AuthorizeNet_Subscription $subscription)
{
}
/**
* Get status of a subscription
*
* @param int $subscriptionId
*
* @return AuthorizeNetARB_Response
*/
public function getSubscriptionStatus($subscriptionId)
{
}
/**
* Cancel a subscription
*
* @param int $subscriptionId
*
* @return AuthorizeNetARB_Response
*/
public function cancelSubscription($subscriptionId)
{
}
/**
* Create an ARB subscription
*
* @param AuthorizeNet_Subscription $subscription
*
* @return AuthorizeNetARB_Response
*/
public function getSubscriptionList(\AuthorizeNetGetSubscriptionList $subscriptionList)
{
}
/**
*
*
* @param string $response
*
* @return AuthorizeNetARB_Response
*/
protected function _handleResponse($response)
{
}
/**
* @return string
*/
protected function _getPostUrl()
{
}
/**
* Prepare the XML document for posting.
*/
protected function _setPostString()
{
}
}
/**
* A class to parse a response from the ARB XML API.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetARB
*/
class AuthorizeNetARB_Response extends \AuthorizeNetXMLResponse
{
/**
* @return int
*/
public function getSubscriptionId()
{
}
/**
* @return string
*/
public function getSubscriptionStatus()
{
}
}
/**
* A simple wrapper for the SOAP API as well as a helper function
* to generate a documentation file from the WSDL.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetSoap
*/
/**
* A simple wrapper for the SOAP API as well as a helper function
* to generate a documentation file from the WSDL.
*
* @package AuthorizeNet
* @subpackage AuthorizeNetSoap
* @todo Make the doc file a usable class.
*/
class AuthorizeNetSOAP extends \SoapClient
{
const WSDL_URL = "https://api2.authorize.net/soap/v1/Service.asmx?WSDL";
const LIVE_URL = "https://api2.authorize.net/soap/v1/Service.asmx";
const SANDBOX_URL = "https://apitest.authorize.net/soap/v1/Service.asmx";
public $sandbox;
/**
* Constructor
*/
public function __construct()
{
}
/**
* Switch between the sandbox or production gateway.
*
* @param bool
*/
public function setSandbox($bool)
{
}
/**
* Get all types as PHP Code.
* @return string
*/
public function getSoapTypes()
{
}
/**
* Get all methods as PHP Code.
* @return string
*/
public function getSoapMethods()
{
}
/**
* Create a file from the WSDL for reference.
*/
public function saveSoapDocumentation($path)
{
}
}
}
namespace WHMCS {
class Client
{
protected $userid = "";
protected $clientModel = NULL;
public function __construct($user)
{
}
public function getClientModel()
{
}
public function setID($userid)
{
}
public function getID()
{
}
public function getUneditableClientProfileFields()
{
}
public function isEditableField($field)
{
}
public static function formatPhoneNumber($details)
{
}
public function getDetails($contactid = "")
{
}
public function getCurrency()
{
}
public function updateClient()
{
}
public function getContactsWithAddresses()
{
}
public function getContacts()
{
}
public function getContact($contactid)
{
}
public function deleteContact($contactid)
{
}
public function getFiles()
{
}
public function resetSendPW()
{
}
public function sendEmailTpl($tplname)
{
}
public function getEmailTemplates()
{
}
public function sendCustomEmail($subject, $message)
{
}
}
}
namespace WHMCS\Cron {
interface DecoratorItemInterface
{
public function getIcon();
public function getName();
public function getSuccessCountIdentifier();
public function getFailureCountIdentifier();
public function getSuccessKeyword();
public function getFailureKeyword();
public function getFailureUrl();
public function getDetailUrl();
public function isBooleanStatusItem();
public function hasDetail();
}
}
namespace WHMCS\Cron\Console\Helper {
class DailyCronHelper implements \Symfony\Component\Console\Helper\HelperInterface
{
protected $helperSet = NULL;
protected $report = NULL;
protected $io = NULL;
protected $isDailyCronInvocation = NULL;
protected $status = NULL;
public function __construct(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output, \WHMCS\Cron\Status $status)
{
}
public function setHelperSet(\Symfony\Component\Console\Helper\HelperSet $helperSet = NULL)
{
}
public function getHelperSet()
{
}
public function getName()
{
}
public function calculateIfIsDailyCronInvocation()
{
}
public function isDailyCronInvocation()
{
}
public function getReport()
{
}
public function sendDailyCronDigest()
{
}
public function isDailyCronRunningOnTime()
{
}
public function sendDailyNotificationDailyCronNotExecuting()
{
}
public function hookRegisterTaskCompletion($task, $completed = true)
{
}
public function startDailyCron()
{
}
public function endDailyCron()
{
}
}
}
namespace WHMCS\Scheduling\Task {
interface TaskInterface
{
const ACCESS_DEBUG = 256;
const ACCESS_SYSTEM = 128;
const ACCESS_HOOK = 64;
const ACCESS_USER = 32;
public function getName();
public function setName($name);
public function run();
public function getOutputKeys();
public function getLatestOutputs(array $outputKeys);
public function getOutputsSince(\WHMCS\Carbon $since, array $outputKeys);
public function getPriority();
public function setPriority($priority);
public function getDescription();
public function setDescription($description);
public function getFrequencyMinutes();
public function setFrequencyMinutes($minutes);
public function anticipatedNextRun(\WHMCS\Carbon $date);
public function isEnabled();
public function setEnabled($state);
public function isPeriodic();
public function setPeriodic($state);
public function getStatus();
public function getSystemName();
public function getAccessLevel();
public static function all();
public static function register();
public function output($key);
public function isDailyTask();
public function monthlyDayOfExecution();
public function isSkipDailyCron();
public function addSuccess(array $data);
public function addFailure(array $data);
public function getSuccesses();
public function getFailures();
public function addCustom($type, array $data);
public function getCustom($type);
public function getDetail();
}
trait DecoratorItemTrait
{
protected $icon = "fas fa-cube";
protected $successCountIdentifier = 0;
protected $successKeyword = "Completed";
protected $failureCountIdentifier = 0;
protected $failureKeyword = "Failed";
protected $isBooleanStatus = false;
protected $hasDetail = false;
public function getIcon()
{
}
public function getSuccessCountIdentifier()
{
}
public function getFailureCountIdentifier()
{
}
public function getSuccessKeyword()
{
}
public function getFailureKeyword()
{
}
public function isBooleanStatusItem()
{
}
public function hasDetail()
{
}
}
abstract class RegisterTrait
{
protected $outputInstances = array();
protected $details = array("success" => array(), "failure" => array());
public function output($key)
{
}
public function getNamespace()
{
}
public function getLatestOutputs(array $outputKeys = array())
{
}
public function getOutputsSince(\WHMCS\Carbon $since, array $outputKeys = array())
{
}
public function addSuccess(array $data)
{
}
public function getSuccesses()
{
}
public function addFailure(array $data)
{
}
public function getFailures()
{
}
public function addCustom($type, array $data)
{
}
public function getCustom($type)
{
}
public function getDetail()
{
}
public function setDetails(array $details)
{
}
public abstract function getOutputKeys();
}
class AbstractTask extends \Illuminate\Database\Eloquent\Model implements \WHMCS\Cron\DecoratorItemInterface, \WHMCS\Scheduling\Task\TaskInterface
{
use \WHMCS\Scheduling\Task\DecoratorItemTrait;
use \WHMCS\Scheduling\Task\RegisterTrait;
protected $table = "tbltask";
protected $guarded = array();
protected $casts = array("is_enabled" => "boolean", "is_periodic" => "boolean");
protected $defaultPriority = 0;
protected $defaultIsEnabled = true;
protected $defaultIsPeriodic = true;
protected $defaultFrequency = 1440;
protected $defaultDescription = "A generic task invoked periodically";
protected $defaultName = "Generic task";
protected $accessLevel = \WHMCS\Scheduling\Task\TaskInterface::ACCESS_USER;
protected $preExecuteCallbacks = array();
protected $postExecuteCallbacks = array();
protected $outputs = array();
protected $callback = NULL;
protected $skipDailyCron = false;
public function createTable($drop = false)
{
}
protected static function boot()
{
}
public static function firstOfClassOrNew(array $attributes = array())
{
}
public static function register($allowDuplicates = false)
{
}
public function getDefaultAttributes()
{
}
public function newCollection(array $models = array())
{
}
public function getName()
{
}
public function setName($name)
{
}
protected function execute()
{
}
public function run()
{
}
public function getPriority()
{
}
public function setPriority($priority)
{
}
public function getDescription()
{
}
public function setDescription($description)
{
}
public function getFrequencyMinutes()
{
}
public function setFrequencyMinutes($minutes)
{
}
public function anticipatedNextRun(\WHMCS\Carbon $date = NULL)
{
}
protected function anticipatedNextMonthlyRun($checkDay, \WHMCS\Carbon $date = NULL)
{
}
public function isEnabled()
{
}
public function setEnabled($state)
{
}
public function isPeriodic()
{
}
public function setPeriodic($state)
{
}
public function getStatus()
{
}
public function getStatusAttribute($status)
{
}
public function status()
{
}
public function getSystemName()
{
}
public function getAccessLevel()
{
}
public function getOutputKeys()
{
}
public function isDailyTask()
{
}
public function monthlyDayOfExecution()
{
}
public function isSkipDailyCron()
{
}
public function getDetailUrl()
{
}
public function getFailureUrl()
{
}
}
}
namespace WHMCS\Cron\Console\Helper {
class TaskCollectionHelper extends \WHMCS\Scheduling\Task\AbstractTask implements \Symfony\Component\Console\Helper\HelperInterface
{
protected $helperSet = NULL;
public function setHelperSet(\Symfony\Component\Console\Helper\HelperSet $helperSet = NULL)
{
}
public function getHelperSet()
{
}
public function getName()
{
}
public function allTasks()
{
}
public function getExcludeCollection(\Symfony\Component\Console\Input\InputInterface $input)
{
}
public function getIncludeCollection(\Symfony\Component\Console\Input\InputInterface $input)
{
}
public function addTasksAsOptions(\Symfony\Component\Console\Command\Command $cmd)
{
}
public function updateStatusPreRun(\WHMCS\Scheduling\Task\Collection $tasks, $setNextDue = true)
{
}
public function filterShouldRun(\WHMCS\Scheduling\Task\Collection $tasks)
{
}
public function filterTasksForToday(\WHMCS\Scheduling\Task\Collection $tasks)
{
}
public function filterTasksForDailyCron(\WHMCS\Scheduling\Task\Collection $tasks)
{
}
}
}
namespace WHMCS\Cron\Console {
class Application extends \Symfony\Component\Console\Application
{
protected function getDefaultInputDefinition()
{
}
protected function getDefaultCommands()
{
}
protected function getDefaultHelperSet()
{
}
protected function getCommandName(\Symfony\Component\Console\Input\InputInterface $input)
{
}
}
}
namespace WHMCS\Cron\Console\Style {
class TaskStyle extends \Symfony\Component\Console\Style\SymfonyStyle
{
protected $originalInput = NULL;
protected $originalOutput = NULL;
public function __construct(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
public function getInput()
{
}
public function getOutput()
{
}
public function isQuiet()
{
}
public function isVerbose()
{
}
public function isVeryVerbose()
{
}
public function isDebug()
{
}
public function preparingQueue()
{
}
public function queueReady()
{
}
public function startQueue($totalQueuedTasks = 0, $name = "")
{
}
public function advanceQueue()
{
}
public function endQueue()
{
}
public function describeTask(\WHMCS\Scheduling\Task\TaskInterface $task)
{
}
public function errorException(\Exception $e)
{
}
public function hasForceOption()
{
}
public function hasEmailReportOption()
{
}
}
}
namespace WHMCS\Cron\Console\Command {
class ListCommand extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
public function getNativeDefinition()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
abstract class AbstractCronCommand extends \Symfony\Component\Console\Command\Command
{
protected $io = NULL;
protected $incompleteTasks = 0;
protected function initialize(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
public abstract function getInputBasedCollection(\Symfony\Component\Console\Input\InputInterface $input);
protected function getPreparedTaskCollection()
{
}
protected function startUp()
{
}
protected function tearDown()
{
}
protected function beforeExecution()
{
}
protected function afterExecution()
{
}
protected function getSystemQueue()
{
}
protected function executeSystemQueue()
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
protected function executeCollection(\WHMCS\Scheduling\Task\Collection $tasks)
{
}
}
class AllCommand extends \WHMCS\Cron\Console\Command\AbstractCronCommand
{
protected function configure()
{
}
public function getInputBasedCollection(\Symfony\Component\Console\Input\InputInterface $input)
{
}
protected function beforeExecution()
{
}
protected function afterExecution()
{
}
protected function getSystemQueue()
{
}
}
class SkipCommand extends \WHMCS\Cron\Console\Command\AllCommand
{
protected function configure()
{
}
public function getInputBasedCollection(\Symfony\Component\Console\Input\InputInterface $input)
{
}
protected function getSystemQueue()
{
}
}
class RegisterDefaultsCommand extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
public function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
public static function registerAnyNonSystemTask(\WHMCS\Cron\Console\Style\TaskStyle $io = NULL)
{
}
public static function resetNextRun(\WHMCS\Scheduling\Task\Collection $tasks, \WHMCS\Carbon $nextRunTime)
{
}
}
class DoCommand extends \WHMCS\Cron\Console\Command\AbstractCronCommand
{
protected function configure()
{
}
protected function beforeExecution()
{
}
protected function afterExecution()
{
}
public function getInputBasedCollection(\Symfony\Component\Console\Input\InputInterface $input)
{
}
protected function initialize(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
protected function getSystemQueue()
{
}
}
class HelpCommand extends \Symfony\Component\Console\Command\Command
{
protected function configure()
{
}
public function getNativeDefinition()
{
}
protected function getDefaultInputDefinition()
{
}
public function setCommand(\Symfony\Component\Console\Command\Command $command)
{
}
protected function execute(\Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
}
}
namespace WHMCS\Cron\Console\Input {
trait LegacyOptionsTrait
{
protected $map = array("invoices" => "CreateInvoices", "affcommissions" => "AffiliateCommissions", "affreports" => "AffiliateReports", "backups" => "DatabaseBackup", "cancelrequests" => "CancellationRequests", "ccexpirynotices" => "CreditCardExpiryNotices", "ccprocessing" => "ProcessCreditCardPayments", "clientstatussync" => "AutoClientStatusSync", "closetickets" => "CloseInactiveTickets", "domainrenewalnotices" => "DomainRenewalNotices", "emailmarketing" => "EmailMarketer", "escalations" => "TicketEscalations", "fixedtermterminations" => "FixedTermTerminations", "invoicereminders" => "InvoiceReminders", "latefees" => "AddLateFees", "overagesbilling" => "OverageBilling", "suspensions" => "AutoSuspensions", "terminations" => "AutoTerminations", "updatepricing" => "CurrencyUpdateProductPricing", "updaterates" => "CurrencyUpdateExchangeRate", "usagestats" => "UpdateServerUsage");
protected $renameMap = array("DomainExpirySync" => "DomainStatusSync");
public function getMap()
{
}
public function setMap($map)
{
}
public function convertLegacyOptions(array $options)
{
}
public function convertRenamedOptions(array $options = array())
{
}
}
class HttpInput extends \Symfony\Component\Console\Input\ArgvInput
{
use \WHMCS\Cron\Console\Input\LegacyOptionsTrait;
public function __construct(array $parameters)
{
}
public function isLegacyInput($input = array())
{
}
public function getControllingOptions($parameters)
{
}
public function getMutatedLegacyInput($input = array())
{
}
}
class CliInput extends \Symfony\Component\Console\Input\ArgvInput
{
use \WHMCS\Cron\Console\Input\LegacyOptionsTrait;
protected $originalData = NULL;
public function __construct(array $argv = NULL)
{
}
public function supportedCommands()
{
}
public function isLegacyInput()
{
}
public function getMutatedLegacyInput()
{
}
}
}
namespace WHMCS\Cron {
class Decorator
{
protected $item = NULL;
public function __construct(\WHMCS\Cron\DecoratorItemInterface $item)
{
}
public function render($data, $isDisabled)
{
}
public function renderStatisticalItem($data, $isDisabled)
{
}
public function renderBooleanItem($data, $isDisabled)
{
}
}
}
namespace WHMCS\Cron\Task {
class TenantUsageMetrics extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1519;
protected $defaultFrequency = 720;
protected $defaultDescription = "Collect tenant usage metrics from servers";
protected $defaultName = "Tenant Usage Metrics";
protected $systemName = "TenantUsageMetrics";
protected $outputs = array("tenants" => array("defaultValue" => 0, "identifier" => "tenants", "name" => "Tenants"), "servers" => array("defaultValue" => 0, "identifier" => "servers", "name" => "Servers"));
protected $icon = "fas fa-chart-bar";
protected $successCountIdentifier = "servers";
protected $successKeyword = "Updated";
protected $skipDailyCron = true;
public function __invoke()
{
}
}
class ServerUsageCount extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1900;
protected $defaultFrequency = 60;
protected $skipDailyCron = true;
protected $defaultDescription = "Auto Update Server Usage Count";
protected $defaultName = "Update Server Usage";
protected $systemName = "ServerUsageCount";
public function __invoke()
{
}
}
class CreditCardExpiryNotices extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1650;
protected $defaultFrequency = 43200;
protected $defaultDescription = "Sending Credit Card Expiry Reminders";
protected $defaultName = "Credit Card Expiry Notices";
protected $systemName = "CreditCardExpiryNotices";
protected $outputs = array("notices" => array("defaultValue" => 0, "identifier" => "notices", "name" => "Credit Card Expiry Notices"));
protected $icon = "fas fa-credit-card";
protected $isBooleanStatus = false;
protected $successCountIdentifier = "notices";
protected $successKeyword = "Sent";
public function monthlyDayOfExecution()
{
}
public function anticipatedNextRun(\WHMCS\Carbon $date = NULL)
{
}
public function __invoke()
{
}
}
class CurrencyUpdateProductPricing extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1510;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Update Product Prices for Current Rates";
protected $defaultName = "Product Pricing Updates";
protected $systemName = "CurrencyUpdateProductPricing";
protected $outputs = array("updated" => array("defaultValue" => 0, "identifier" => "updated", "name" => "Pricing Updated for Exchange Rates"));
protected $icon = "far fa-money-bill-alt";
protected $isBooleanStatus = true;
protected $successCountIdentifier = "updated";
protected $successKeyword = "Completed";
public function __invoke()
{
}
}
class PollPaymentGateway extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1575;
protected $defaultDescription = "Runs the poll function for any active payment gateways. Runs before Automation Suspensions in case required.";
protected $defaultName = "Poll Payment Gateways";
protected $systemName = "PollPaymentGateway";
public function __invoke()
{
}
}
class CheckForWhmcsUpdate extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 2000;
protected $defaultFrequency = 480;
protected $defaultDescription = "Check for WHMCS Software Updates";
protected $defaultName = "WHMCS Updates";
protected $systemName = "CheckForWhmcsUpdate";
protected $outputs = array("update.checked" => array("defaultValue" => 0, "identifier" => "update.checked", "name" => "Update Check Performed"), "update.available" => array("defaultValue" => 0, "identifier" => "update.available", "name" => "Update Available"), "update.version" => array("defaultValue" => 0, "identifier" => "update.version", "name" => "Update Version"));
protected $icon = "fas fa-download";
protected $isBooleanStatus = true;
protected $successCountIdentifier = "update.checked";
public function __invoke()
{
}
}
class RunJobsQueue extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 2000;
protected $defaultFrequency = 5;
protected $defaultDescription = "Execute queued jobs that are due for execution.";
protected $defaultName = "Run Jobs Queue";
protected $systemName = "RunJobsQueue";
protected $outputs = array("executed" => array("defaultValue" => 0, "identifier" => "executed", "name" => "Jobs Executed"));
protected $icon = "fas fa-gavel";
protected $successCountIdentifier = "jobs.queue";
protected $successKeyword = "Executed";
public function __invoke()
{
}
public function executeQueuedJobs()
{
}
}
class LicenseNotice extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $accessLevel = \WHMCS\Scheduling\Task\TaskInterface::ACCESS_SYSTEM;
protected $defaultPriority = 700;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Upgrade license on request or send notification alerts";
protected $defaultName = "License Usage & Notification";
protected $systemName = "LicenseNotice";
protected $outputs = array();
public function __invoke()
{
}
public function getAdminHelpLink()
{
}
}
class AffiliateCommissions extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1620;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Process Delayed Affiliate Commissions";
protected $defaultName = "Delayed Affiliate Commissions";
protected $systemName = "AffiliateCommissions";
protected $outputs = array("payments" => array("defaultValue" => 0, "identifier" => "payments", "name" => "Affiliate Payments"));
protected $icon = "far fa-money-bill-alt";
protected $successCountIdentifier = "payments";
protected $successKeyword = "Cleared";
public function __invoke()
{
}
}
class AutoClientStatusSync extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1680;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Synchronise Client Status";
protected $defaultName = "Client Status Update";
protected $systemName = "AutoClientStatusSync";
protected $outputs = array("active.product.domain" => array("defaultValue" => 0, "identifier" => "active.product.domain", "name" => "Active due to domain"), "active.product.addon" => array("defaultValue" => 0, "identifier" => "active.product.addon", "name" => "Active due to addon"), "active.product.service" => array("defaultValue" => 0, "identifier" => "active.product.service", "name" => "Active due to service"), "active.billable.item" => array("defaultValue" => 0, "identifier" => "active.billable.item", "name" => "Active due to billable item"), "inactive.login" => array("defaultValue" => 0, "identifier" => "inactive.login", "name" => "Inactive due to no login"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"), "processed" => array("defaultValue" => 0, "identifier" => "processed", "name" => "Client Status Synced"));
protected $icon = "fas fa-sort";
protected $successCountIdentifier = "processed";
protected $successKeyword = "Completed";
protected $hasDetail = true;
public function __invoke()
{
}
protected function activateClientsWithActiveDomainProduct()
{
}
protected function activateClientsWithActiveProductAddon()
{
}
protected function activateClientsWithActiveHostingProduct()
{
}
protected function activateClientsWithActiveBillableItems()
{
}
protected function deactivateClientsWithoutLoginActivity()
{
}
}
class SslStatusSync extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1650;
protected $defaultFrequency = 1440;
protected $defaultDescription = "SSL Status Sync";
protected $defaultName = "SSL Sync";
protected $systemName = "SslSync";
protected $outputs = array("success" => array("defaultValue" => 0, "identifier" => "success", "name" => "SSL Status Sync Success"));
protected $icon = "far fa-lock-alt";
protected $isBooleanStatus = false;
protected $successCountIdentifier = "success";
protected $successKeyword = "Synced";
public function __invoke()
{
}
protected function getNewDomains()
{
}
protected function syncSslStatus()
{
}
}
class EmailMarketer extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1640;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Process Email Marketer Rules";
protected $defaultName = "Email Marketer Rules";
protected $systemName = "EmailMarketer";
protected $outputs = array("sent" => array("defaultValue" => 0, "identifier" => "sent", "name" => "Emails Sent"));
protected $icon = "fas fa-envelope";
protected $successCountIdentifier = "sent";
protected $successKeyword = "Emails Sent";
public function __invoke()
{
}
}
class DatabaseBackup extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $accessLevel = \WHMCS\Scheduling\Task\TaskInterface::ACCESS_SYSTEM;
protected $defaultPriority = 5000;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Create a database backup and deliver via FTP or email";
protected $defaultName = "Database Backup";
protected $systemName = "DatabaseBackup";
protected $outputs = array("completed" => array("defaultValue" => 0, "identifier" => "completed", "name" => "Backup Completed"));
protected $icon = "fas fa-database";
protected $isBooleanStatus = true;
protected $successCountIdentifier = "completed";
protected $zipFile = NULL;
public function __invoke()
{
}
protected function doCpanel()
{
}
protected function doFtpAndEmail()
{
}
protected function isBackupSystemActive($system)
{
}
protected function generateDatabaseBackupZipFile()
{
}
protected function createZipFile($tempZipFile, $tempDatabaseFile, $databaseName)
{
}
protected function emailZip($zipFile, $attachmentName)
{
}
protected function ftpZip($zipFile, $remoteFile)
{
}
protected function requestCPanelBackup()
{
}
protected function doSftpBackup($zipFile, $remoteFile)
{
}
protected function doFtpBackup($zipFile, $remoteFile)
{
}
}
class CancellationRequests extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1570;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Process Cancellation Requests";
protected $defaultName = "Cancellation Requests";
protected $systemName = "CancellationRequests";
protected $outputs = array("cancellations" => array("defaultValue" => 0, "identifier" => "cancellations", "name" => "Cancelled"), "manual" => array("defaultValue" => 0, "identifier" => "manual", "name" => "Manual Cancellation Required"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"));
protected $icon = "fas fa-times";
protected $successCountIdentifier = "cancellations";
protected $failureCountIdentifier = "manual";
protected $successKeyword = "Processed";
protected $hasDetail = true;
public function __invoke()
{
}
}
class CurrencyUpdateExchangeRates extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1500;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Update Currency Exchange Rates";
protected $defaultName = "Currency Exchange Rates";
protected $systemName = "CurrencyUpdateExchangeRates";
protected $outputs = array("updated" => array("defaultValue" => 0, "identifier" => "updated", "name" => "Exchange Rates Updated"));
protected $icon = "fas fa-chart-line";
protected $isBooleanStatus = true;
protected $successCountIdentifier = "updated";
public function __invoke()
{
}
}
class FixedTermTerminations extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1600;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Process Fixed Term Terminations";
protected $defaultName = "Fixed Term Terminations";
protected $systemName = "FixedTermTerminations";
protected $outputs = array("terminations" => array("defaultValue" => 0, "identifier" => "terminations", "name" => "Services Terminated"), "manual" => array("defaultValue" => 0, "identifier" => "manual", "name" => "Manual Terminations Required"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"));
protected $icon = "fas fa-plug";
protected $successCountIdentifier = "terminations";
protected $failureCountIdentifier = "manual";
protected $successKeyword = "Terminated";
protected $hasDetail = true;
public function __invoke()
{
}
}
class ServerRemoteMetaData extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1910;
protected $defaultFrequency = 60;
protected $skipDailyCron = true;
protected $defaultDescription = "Auto Update Server Meta Data";
protected $defaultName = "Update Server Meta Data";
protected $systemName = "ServerRemoteMetaData";
public function __invoke()
{
}
}
class CloseInactiveTickets extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1610;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Auto Close Inactive Tickets";
protected $defaultName = "Inactive Tickets";
protected $systemName = "CloseInactiveTickets";
protected $outputs = array("closed" => array("defaultValue" => 0, "identifier" => "closed", "name" => "Closed"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"));
protected $icon = "fas fa-ticket-alt";
protected $successCountIdentifier = "closed";
protected $successKeyword = "Closed";
protected $hasDetail = true;
public function __invoke()
{
}
}
class DataNormalization extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $accessLevel = \WHMCS\Scheduling\Task\TaskInterface::ACCESS_SYSTEM;
protected $defaultPriority = 710;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Normalize Database";
protected $defaultName = "Database Normalization";
protected $systemName = "DataNormalization";
protected $outputs = array();
public function __invoke()
{
}
}
class ProcessCreditCardPayments extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1540;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Process Credit Card Charges";
protected $defaultName = "Credit Card Charges";
protected $systemName = "ProcessCreditCardPayments";
protected $outputs = array("captured" => array("defaultValue" => 0, "identifier" => "captured", "name" => "Captured Payments"), "failures" => array("defaultValue" => 0, "identifier" => "failures", "name" => "Failed Capture Payments"), "deleted" => array("defaultValue" => 0, "identifier" => "deleted", "name" => "Expired Credit Cards Deleted"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"));
protected $icon = "fas fa-credit-card";
protected $successCountIdentifier = "captured";
protected $failureCountIdentifier = "failures";
protected $successKeyword = "Captured";
protected $failureKeyword = "Declined";
protected $hasDetail = true;
public function __invoke()
{
}
}
class DomainStatusSync extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 2150;
protected $defaultFrequency = 240;
protected $defaultDescription = "Domain Status Syncing";
protected $defaultName = "Domain Status Synchronisation";
protected $systemName = "DomainStatusSync";
protected $outputs = array("synced" => array("defaultValue" => 0, "identifier" => "synced", "name" => "Synced"));
protected $icon = "fas fa-history";
protected $successCountIdentifier = "synced";
protected $successKeyword = "Domains Synced";
protected $skipDailyCron = true;
public function __invoke()
{
}
public function getFrequencyMinutes()
{
}
}
class DomainRenewalNotices extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1560;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Processing Domain Renewal Notices";
protected $defaultName = "Domain Renewal Notices";
protected $systemName = "DomainRenewalNotices";
protected $outputs = array("sent" => array("defaultValue" => 0, "identifier" => "sent", "name" => "Renewal Notices"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"));
protected $icon = "fas fa-globe";
protected $successCountIdentifier = "sent";
protected $successKeyword = "Sent";
protected $hasDetail = true;
public function __invoke()
{
}
}
class OverageBilling extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1670;
protected $defaultFrequency = 43200;
protected $defaultDescription = "Process Overage Billing Charges";
protected $defaultName = "Overage Billing Charges";
protected $systemName = "OverageBilling";
protected $outputs = array("invoice.created" => array("defaultValue" => 0, "identifier" => "invoice.created", "name" => "Total Overage Billing Invoices"));
protected $icon = "far fa-file-alt";
protected $successCountIdentifier = "invoice.created";
protected $failedCountIdentifier = "";
protected $successKeyword = "Generated";
public function monthlyDayOfExecution()
{
}
public function anticipatedNextRun(\WHMCS\Carbon $date = NULL)
{
}
public function __invoke()
{
}
}
class TicketEscalations extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1700;
protected $defaultFrequency = 3;
protected $defaultDescription = "Process and escalate tickets per any Escalation Rules";
protected $defaultName = "Ticket Escalation Rules";
protected $systemName = "TicketEscalations";
protected $outputs = array("processed" => array("defaultValue" => 0, "identifier" => "run", "name" => "Ticket Escalation Rules"));
protected $icon = "fas fa-level-up-alt";
protected $isBooleanStatus = true;
protected $successCountIdentifier = "processed";
protected $successKeyword = "Processed";
public function __invoke()
{
}
}
class DataRetentionPruning extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1800;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Perform data retention pruning operations.";
protected $defaultName = "Data Retention Pruning";
protected $systemName = "DataRetentionPruning";
protected $outputs = array("clients.deleted" => array("defaultValue" => 0, "identifier" => "deleted", "name" => "Clients Deleted"));
protected $icon = "fas fa-trash-alt";
protected $successCountIdentifier = "clients.deleted";
protected $successKeyword = "Deleted";
public function __invoke()
{
}
protected function deleteInactiveClients()
{
}
}
class AutoPruneTicketAttachments extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1615;
protected $defaultFrequency = 60;
protected $defaultDescription = "Auto Remove Inactive Ticket Attachments";
protected $defaultName = "Prune Ticket Attachments";
protected $systemName = "AutoPruneTicketAttachments";
protected $icon = "fas fa-file-minus";
protected $successCountIdentifier = "removed";
protected $successKeyword = "Removed";
protected $outputs = array("removed" => array("defaultValue" => 0, "identifier" => "removed", "name" => "Removed"));
protected $skipDailyCron = true;
public function __invoke()
{
}
}
class CreateInvoices extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1520;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Generate Invoices";
protected $defaultName = "Invoices";
protected $systemName = "CreateInvoices";
protected $outputs = array("invoice.created" => array("defaultValue" => 0, "identifier" => "invoice.created", "name" => "Total Invoices"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"));
protected $icon = "far fa-file-alt";
protected $successCountIdentifier = "invoice.created";
protected $failedCountIdentifier = "";
protected $successKeyword = "Generated";
protected $hasDetail = true;
public function __invoke()
{
}
}
class UpdateServerUsage extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1660;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Updating Disk & Bandwidth Usage Stats";
protected $defaultName = "Server Usage Stats";
protected $systemName = "UpdateServerUsage";
protected $outputs = array("updated" => array("defaultValue" => 0, "identifier" => "updated", "name" => "Servers Updated"), "completed" => array("defaultValue" => 0, "identifier" => "completed", "name" => "Server Usage Updates Completed"));
protected $icon = "fas fa-server";
protected $isBooleanStatus = true;
protected $successCountIdentifier = "completed";
public function __invoke()
{
}
}
class AutoTerminations extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1590;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Process Overdue Terminations";
protected $defaultName = "Overdue Terminations";
protected $systemName = "AutoTerminations";
protected $outputs = array("terminations" => array("defaultValue" => 0, "identifier" => "terminations", "name" => "Terminations"), "manual" => array("defaultValue" => 0, "identifier" => "manual", "name" => "Manual Termination Required"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"));
protected $icon = "far fa-calendar-times";
protected $successCountIdentifier = "terminations";
protected $failureCountIdentifier = "manual";
protected $successKeyword = "Terminated";
protected $hasDetail = true;
public function __invoke()
{
}
}
class UpdateDomainExpiryStatus extends \WHMCS\Scheduling\Task\AbstractTask
{
public $description = "Update Domain Expiry Status";
protected $defaultPriority = 1690;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Update Domain Expiry Status";
protected $defaultName = "Domain Expiry";
protected $systemName = "UpdateDomainExpiryStatus";
protected $outputs = array("expired" => array("defaultValue" => 0, "identifier" => "expired", "name" => "Domains Set to Expired"), "grace" => array("defaultValue" => 0, "identifier" => "grace", "name" => "Domains Set to Grace Period"), "redemption" => array("defaultValue" => 0, "identifier" => "redemption", "name" => "Domains Set to Redemption Grace Period"));
protected $icon = "fas fa-link";
protected $isBooleanStatus = false;
protected $successCountIdentifier = "expired";
protected $successKeyword = "Expired";
public function __construct(array $attributes = array())
{
}
public function __invoke()
{
}
}
class InvoiceReminders extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1550;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Generate daily reminders for unpaid and overdue invoice";
protected $defaultName = "Invoice & Overdue Reminders";
protected $systemName = "InvoiceReminders";
protected $outputs = array("unpaid" => array("defaultValue" => 0, "identifier" => "unpaid", "name" => "Unpaid Reminders"), "overdue.first" => array("defaultValue" => 0, "identifier" => "overdue.first", "name" => "First Overdue Notices"), "overdue.second" => array("defaultValue" => 0, "identifier" => "overdue.second", "name" => "Second Overdue Notices"), "overdue.third" => array("defaultValue" => 0, "identifier" => "overdue.third", "name" => "Third Overdue Notices"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"));
protected $icon = "far fa-envelope";
protected $successCountIdentifier = array("unpaid", "overdue.first", "overdue.second", "overdue.third");
protected $successKeyword = "Sent";
protected $hasDetail = true;
public function __invoke()
{
}
public function sendUnpaidInvoiceReminders()
{
}
public function sendOverdueInvoiceReminders()
{
}
}
class AutoSuspensions extends \WHMCS\Scheduling\Task\AbstractTask
{
public $description = "Processing Overdue Suspensions";
protected $defaultPriority = 1580;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Process Overdue Suspensions";
protected $defaultName = "Overdue Suspensions";
protected $systemName = "AutoSuspensions";
protected $outputs = array("suspended" => array("defaultValue" => 0, "identifier" => "unpaid", "name" => "Overdue Suspended"), "manual" => array("defaultValue" => 0, "identifier" => "manual", "name" => "Manual Suspension Required"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"));
protected $icon = "fas fa-bell";
protected $successCountIdentifier = "suspended";
protected $failureCountIdentifier = "manual";
protected $successKeyword = "Suspended";
protected $hasDetail = true;
public function __invoke()
{
}
}
class SystemConfiguration extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $accessLevel = \WHMCS\Scheduling\Task\TaskInterface::ACCESS_SYSTEM;
protected $defaultPriority = 800;
protected $defaultFrequency = 1440;
protected $defaultDescription = "System Configuration Check";
protected $defaultName = "System Configuration Check";
protected $systemName = "SystemConfiguration";
protected $outputs = array();
public function __invoke()
{
}
public function getComponentReport()
{
}
}
class AffiliateReports extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1630;
protected $defaultFrequency = 43200;
protected $defaultDescription = "Send Monthly Affiliate Reports";
protected $defaultName = "Affiliate Reports";
protected $systemName = "AffiliateReports";
protected $outputs = array("sent" => array("defaultValue" => 0, "identifier" => "sent", "name" => "Affiliate Reports Sent"));
protected $icon = "far fa-money-bill-alt";
protected $isBooleanStatus = false;
protected $successCountIdentifier = "sent";
protected $successKeyword = "Emails Sent";
public function monthlyDayOfExecution()
{
}
public function anticipatedNextRun(\WHMCS\Carbon $date = NULL)
{
}
public function __invoke()
{
}
}
class AddLateFees extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 1530;
protected $defaultFrequency = 1440;
protected $defaultDescription = "Apply Late Fees";
protected $defaultName = "Late Fees";
protected $systemName = "AddLateFees";
protected $outputs = array("invoice.latefees" => array("defaultValue" => 0, "identifier" => "invoice.latefees", "name" => "Late Fee Invoices"), "action.detail" => array("defaultValue" => "", "identifier" => "action.detail", "name" => "Action Detail"));
protected $icon = "fas fa-gavel";
protected $successCountIdentifier = "invoice.latefees";
protected $successKeyword = "Added";
protected $hasDetail = true;
public function __invoke()
{
}
protected function addLateFeesToInvoices()
{
}
}
class DomainTransferSync extends \WHMCS\Scheduling\Task\AbstractTask
{
protected $defaultPriority = 2100;
protected $defaultFrequency = 240;
protected $defaultDescription = "Syncing Domain Pending Transfer Status";
protected $defaultName = "Domain Transfer Status Synchronisation";
protected $systemName = "DomainTransferSync";
protected $outputs = array("synced" => array("defaultValue" => 0, "identifier" => "synced", "name" => "Synced"));
protected $icon = "fas fa-exchange-alt";
protected $successCountIdentifier = "synced";
protected $successKeyword = "Transfers Checked";
protected $skipDailyCron = true;
public function __invoke()
{
}
public function getFrequencyMinutes()
{
}
}
}
namespace WHMCS\Cron {
class Status
{
public function setLastDailyCronInvocationTime(\WHMCS\Carbon $datetime = NULL)
{
}
public function getLastDailyCronInvocationTime()
{
}
public function hasDailyCronRunInLast24Hours()
{
}
public function hasDailyCronRunSince($hours)
{
}
public function hasDailyCronEverRun()
{
}
public function hasCronEverBeenInvoked()
{
}
public static function getDailyCronExecutionHour()
{
}
public static function setDailyCronExecutionHour($time = "09")
{
}
public function isOkayToRunDailyCronNow()
{
}
public function hasCronBeenInvokedIn24Hours()
{
}
public function getLastCronInvocationTime()
{
}
public function setCronInvocationTime()
{
}
}
}
namespace WHMCS {
class Session
{
public static function getSessionServiceProviderClass(\WHMCS\Config\Application $appConfig)
{
}
public static function initializeHandler(\WHMCS\Config\Application $appConfig)
{
}
protected function startSession()
{
}
public static function start()
{
}
protected function getSessionName($instanceid)
{
}
public function create($instanceid)
{
}
public static function get($key)
{
}
public static function set($key, $value)
{
}
public static function delete($key)
{
}
public static function getAndDelete($key)
{
}
public static function rotate()
{
}
public static function destroy()
{
}
public function nullify()
{
}
public function restore()
{
}
public static function release()
{
}
public static function setAndRelease($key, $value)
{
}
public static function exists($key)
{
}
}
}
namespace WHMCS\Session\Database {
class ServiceProvider extends \Illuminate\Support\ServiceProvider
{
public function register()
{
}
protected function setSessionSerialization()
{
}
protected function setSaveHandler($handler)
{
}
public function factoryConfiguration(array $databaseConfig = array())
{
}
public function factoryHandler(\WHMCS\Session\Database\Configuration $configuration)
{
}
}
class Configuration
{
public function __construct(array $databaseConfig, \WHMCS\Database\Capsule $databaseManager)
{
}
public function getConnection()
{
}
protected function getConnectionFromConfiguration($databaseConfiguration)
{
}
public function getLifetime()
{
}
public function setLifetime($lifetime)
{
}
public function getDatabaseConfiguration()
{
}
public function setDatabaseConfiguration(array $databaseConfiguration)
{
}
public function getTable()
{
}
public function setTable($table)
{
}
public function getConnectionAlias()
{
}
public function setConnectionAlias($connectionAlias)
{
}
public function getDatabaseManager()
{
}
public function setDatabaseManager(\WHMCS\Database\Capsule $databaseManager)
{
}
public function getLogErrors()
{
}
public function setLogErrors($logErrors)
{
}
}
final class SessionHandler implements \SessionHandlerInterface
{
public function __construct(\WHMCS\Session\Database\Configuration $config)
{
}
public function open($savePath, $sessionName)
{
}
public function close()
{
}
public function read($sessionId)
{
}
public function write($sessionId, $data)
{
}
public function destroy($sessionId)
{
}
public function gc($lifetime)
{
}
}
}
namespace WHMCS\Knowledgebase\Controller {
class Category
{
public function view(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
class Article
{
public function view(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function vote(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
class Knowledgebase
{
public function index()
{
}
public function viewTag(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function search(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
}
namespace WHMCS\Knowledgebase {
class Category extends \WHMCS\Model\AbstractModel
{
protected $table = "tblknowledgebasecats";
public $timestamps = false;
public static function findSystemTranslation($id)
{
}
public function scopeTranslationsOf($query, $id = "", $language = "")
{
}
public function bestTranslation($language = "")
{
}
public function isHidden()
{
}
public function ancestors($maxAncestors = 100)
{
}
public function articles()
{
}
public function subCategories()
{
}
public function getSubCategoryArticleCountAttribute()
{
}
public static function rootCategories()
{
}
public static function hiddenCategoryIds()
{
}
}
}
namespace WHMCS\Http\Message {
abstract class AbstractViewableResponse extends \Zend\Diactoros\Response\HtmlResponse
{
protected $getBodyFromPrivateStream = false;
public function __construct($data = "", $status = 200, array $headers = array())
{
}
public function getBody()
{
}
protected abstract function getOutputContent();
}
}
namespace WHMCS {
class ClientArea extends \WHMCS\Http\Message\AbstractViewableResponse
{
protected $renderedOutput = "";
protected $skipMainBodyContainer = false;
protected $baseUrl = "";
protected $outputHooks = array("ClientAreaPage");
protected $client = NULL;
public function __construct($data = "", $status = 200, array $headers = array())
{
}
public function isInOrderForm()
{
}
public function resetRenderedOutput()
{
}
protected function initializeView()
{
}
public function setPageTitle($title)
{
}
public function getPageTitle()
{
}
public function addToBreadCrumb($link, $text)
{
}
public function resetBreadCrumb()
{
}
public function getUserID()
{
}
public function getClient()
{
}
public function isLoggedIn()
{
}
public function requireLogin()
{
}
public function setTemplate($template)
{
}
public function getTemplateFile()
{
}
public function assign($key, $value, $allowOverride = true)
{
}
public function setTemplateVariables($data)
{
}
public function getTemplateVariables()
{
}
public static function getRawStatus($val)
{
}
protected function startSmartyIfNotStarted()
{
}
protected function startSmarty()
{
}
protected function initEmptyTemplateVars()
{
}
public function setDisplayTitle($displayTitle)
{
}
public function getDisplayTitle()
{
}
public function setTagLine($tagline)
{
}
public function getCurrentPageName()
{
}
protected function registerDefaultTPLVars()
{
}
protected function getCurrencyOptions()
{
}
protected function getLanguageSwitcherHTML()
{
}
public function initPage()
{
}
public function getSingleTPLOutput($templatepath, $templateVariables = array())
{
}
protected function runClientAreaOutputHook($hookName)
{
}
public static function getConditionalLinks()
{
}
protected function buildBreadCrumbHtml()
{
}
public function getBreadCrumbHtml()
{
}
public function setBreadCrumbHtml($breadCrumbHtml)
{
}
public static function getCurrentPageLinkBack()
{
}
public static function isAdminMasqueradingAsClient()
{
}
public static function calculatePwStrengthThresholds()
{
}
public function outputWithoutExit()
{
}
public function output()
{
}
public function getOutputContent()
{
}
public function getLicenseBannerMessage()
{
}
public function getLicenseBannerHtml()
{
}
public function disableHeaderFooterOutput()
{
}
public function isWrappedWithHeaderFooter()
{
}
public function addOutputHookFunction($name)
{
}
protected function runOutputHooks()
{
}
public function skipMainBodyContainer()
{
}
public function buildContactAccessDenied($requiredPermission)
{
}
}
}
namespace WHMCS\Knowledgebase\View {
class Index extends \WHMCS\ClientArea
{
protected function initializeView()
{
}
public function getRootCategoryTemplateData()
{
}
public function getArticleTemplateData(\WHMCS\Knowledgebase\Article $item)
{
}
public function getCategoryTemplateData(\WHMCS\Knowledgebase\Category $item)
{
}
}
class Category extends \WHMCS\Knowledgebase\View\Index
{
protected function initializeView()
{
}
}
class Article extends \WHMCS\Knowledgebase\View\Index
{
protected function initializeView()
{
}
}
}
namespace WHMCS\Knowledgebase {
class Tag extends \WHMCS\Model\AbstractModel
{
protected $table = "tblknowledgebasetags";
public $timestamps = false;
public function scopeTag($query, $tag)
{
}
public static function getTagTotals()
{
}
public function articles()
{
}
}
class Article extends \WHMCS\Model\AbstractModel
{
protected $table = "tblknowledgebase";
protected $fillable = array("votes", "views", "useful");
public $timestamps = false;
public static function boot()
{
}
public function scopeTranslationsOf($query, $id = "", $language = "")
{
}
public function bestTranslation($language = "")
{
}
public function categories()
{
}
public function getPrimaryCategoryAttribute()
{
}
public function getSiblingsAttribute()
{
}
public function isOrphaned()
{
}
public static function filterOrphanedArticles(\Illuminate\Database\Eloquent\Collection $items)
{
}
public static function mostViewed($limit = 5)
{
}
public function tags()
{
}
}
class ArticleCategoryLink extends \WHMCS\Model\AbstractModel
{
protected $table = "tblknowledgebaselinks";
public $timestamps = false;
public function article()
{
}
public function category()
{
}
}
class Image extends \WHMCS\Model\AbstractModel
{
protected $table = "tblknowledgebase_images";
protected $fillable = array("filename", "original_name");
public function createTable($drop = false)
{
}
}
class KnowledgebaseServiceProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\ProviderTrait;
protected function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Backups {
class Backups
{
public function getActiveProviders()
{
}
}
}
namespace WHMCS\Authentication {
class Client
{
protected $user = NULL;
protected $isMasqueradingAdmin = false;
protected $verifiedFirstFactorRemotely = false;
const SETTING_ALLOW_AUTOAUTH = "AllowAutoAuth";
public function __construct($username, $password = "")
{
}
public function findUser()
{
}
public function getUser()
{
}
public function setUser($user)
{
}
public function comparePassword($userProvidedPassword, $storedHash)
{
}
public function isMasqueradingAdmin()
{
}
public function getMasqueradingAdmin()
{
}
public function clearSessionIds()
{
}
protected function setSessionIds($user)
{
}
public function finalizeLogin()
{
}
protected function dispatchLoginShare($username, $password)
{
}
public function prepareSecondFactor()
{
}
public static function isInSecondFactorRequestState()
{
}
public function needsSecondFactorToFinalize()
{
}
public function verifySecondFactor()
{
}
public function verifyFirstFactor()
{
}
public static function generateClientLoginHash($userId, $contactId, $passwordHash, $email)
{
}
}
class PasswordReset
{
public function sendPasswordResetEmail($email)
{
}
public function changeUserPassword($user, $newPassword)
{
}
}
}
namespace WHMCS\Application\Support\ServiceProvider {
abstract class AbstractServiceProvider
{
protected $app = NULL;
public function __construct(\WHMCS\Container $app)
{
}
public abstract function register();
}
}
namespace WHMCS\Authentication\Remote {
class ServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider implements \WHMCS\Route\Contracts\ProviderInterface
{
use \WHMCS\Route\ProviderTrait;
public function register()
{
}
public function registerRoutes(\FastRoute\RouteCollector $routeCollector)
{
}
}
}
namespace WHMCS\Authentication\Remote\Providers {
abstract class AbstractRemoteAuthProvider
{
protected $config = array();
protected $twoFaRedirectUrl = "";
protected $description = "";
protected $configurationDescription = "";
const NAME = "";
const FRIENDLY_NAME = "";
const HTML_TARGET_LOGIN = "login";
const HTML_TARGET_REGISTER = "register";
const HTML_TARGET_CHECKOUT = "checkout";
const HTML_TARGET_CONNECT = "connect";
const LOGIN_RESULT_GENERAL_ERROR = "error";
const LOGIN_RESULT_LOGGED_IN = "logged_in";
const LOGIN_RESULT_LINKING_COMPLETE = "linking_complete";
const LOGIN_RESULT_LOGIN_TO_LINK = "login_to_link";
const LOGIN_RESULT_2FA_NEEDED = "2fa_needed";
const LOGIN_RESULT_OTHER_USER_EXISTS = "other_user_exists";
const LOGIN_RESULT_ALREADY_LINKED_HERE = "already_linked";
const LOGIN_RESULT_USER_NOT_AUTHORIZED = "not_authorized";
public function __construct()
{
}
public function getConfigurationFields()
{
}
public abstract function getEnabled();
public abstract function setEnabled($value);
public abstract function linkAccount($context);
public abstract function verifyConfiguration();
public abstract function getHtmlScriptCode($htmlTarget);
public abstract function getHtmlButton($htmlTarget);
public function getHtml($htmlTarget)
{
}
public function getDescription()
{
}
public function getConfigurationDescription()
{
}
public function getConfiguration()
{
}
public function setConfiguration(array $config)
{
}
public function saveConfiguration()
{
}
public abstract function parseMetadata($metadata);
protected function findAccountLink($remoteUserId)
{
}
protected function linkLoggedInUser($remoteUserId, $context = NULL)
{
}
protected function logUserWithAccountLink(\WHMCS\Authentication\Remote\AccountLink $accountLink)
{
}
protected function isLoggedInUsersAccountLink(\WHMCS\Authentication\Remote\AccountLink $accountLink)
{
}
protected function processRemoteUserId($remoteUserId, $context, $failIfExists)
{
}
protected function saveContext($context)
{
}
protected function retrieveContext()
{
}
public function getRegistrationFormData($context)
{
}
public function getRemoteAccountName($context)
{
}
}
}
namespace WHMCS\Authentication\Remote\Providers\Google {
final class GoogleSignin extends \WHMCS\Authentication\Remote\Providers\AbstractRemoteAuthProvider
{
const NAME = "google_signin";
const FRIENDLY_NAME = "Google";
public function getConfigurationFields()
{
}
public function getEnabled()
{
}
public function setEnabled($value)
{
}
public function parseMetadata($metadata)
{
}
public function getHtmlScriptCode($htmlTarget)
{
}
public function getHtmlButton($htmlTarget)
{
}
public function linkAccount($context)
{
}
public function finalizeSignin(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getRegistrationFormData($context)
{
}
public function verifyConfiguration()
{
}
public function getRemoteAccountName($context)
{
}
}
}
namespace WHMCS\Authentication\Remote\Providers\Facebook {
final class FacebookSignin extends \WHMCS\Authentication\Remote\Providers\AbstractRemoteAuthProvider
{
const NAME = "facebook_signin";
const FRIENDLY_NAME = "Facebook";
public function getConfigurationFields()
{
}
public function getEnabled()
{
}
public function setEnabled($value)
{
}
public function parseMetadata($metadata)
{
}
public function getHtmlScriptCode($htmlTarget)
{
}
public function getHtmlButton($htmlTarget)
{
}
public function linkAccount($context)
{
}
public function finalizeSignin(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getRegistrationFormData($context)
{
}
public function verifyConfiguration()
{
}
public function getRemoteAccountName($context)
{
}
}
}
namespace WHMCS\Authentication\Remote\Providers\Twitter {
final class TwitterOauth extends \WHMCS\Authentication\Remote\Providers\AbstractRemoteAuthProvider
{
const NAME = "twitter_oauth";
const FRIENDLY_NAME = "Twitter";
public function getConfigurationFields()
{
}
public function getEnabled()
{
}
public function setEnabled($value)
{
}
public function parseMetadata($metadata)
{
}
public function getHtmlScriptCode($htmlTarget)
{
}
public function getHtmlButton($htmlTarget)
{
}
public function authorizeSignin(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function signinCallback(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function linkAccount($context)
{
}
public function getRegistrationFormData($context)
{
}
public function verifyConfiguration()
{
}
public function getRemoteAccountName($context)
{
}
}
}
namespace WHMCS\Authentication\Remote {
class AccountLink extends \WHMCS\Model\AbstractModel
{
protected $table = "tblauthn_account_links";
protected $columnMap = array("clientId" => "client_id", "contactId" => "contact_id");
public function createTable($drop = false)
{
}
public function client()
{
}
public function contact()
{
}
public function scopeViaProvider(\Illuminate\Database\Eloquent\Builder $query, \WHMCS\Authentication\Remote\Providers\AbstractRemoteAuthProvider $provider)
{
}
}
}
namespace WHMCS\Authentication\Remote\Management\Client {
class ViewHelper
{
public function getTemplateData($targetHtml = NULL)
{
}
public function getTableData($userRemoteAccountLinks)
{
}
}
class Controller
{
public function getLinks(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function delete(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Authentication\Remote {
final class RemoteAuth
{
const AUTHN_CONTEXTS_VAR = "authn_provider_contexts";
public function __construct()
{
}
public function getProviders()
{
}
public function getEnabledProviders()
{
}
public function getEnabledProvidersHtmlCode($htmlTarget)
{
}
public function getProviderByName($providerName)
{
}
public function saveProviderContext(\WHMCS\Authentication\Remote\Providers\AbstractRemoteAuthProvider $provider, $context)
{
}
public function retrieveProviderContext(\WHMCS\Authentication\Remote\Providers\AbstractRemoteAuthProvider $provider)
{
}
public function isPrelinkPerformed()
{
}
public function generateRandomPassword()
{
}
public function eraseProviderContext(\WHMCS\Authentication\Remote\Providers\AbstractRemoteAuthProvider $provider)
{
}
public function linkRemoteAccounts()
{
}
public function getRegistrationFormData()
{
}
public function logAccountLinkCreation(\WHMCS\Authentication\Remote\AccountLink $accountLink)
{
}
public function logAccountLinkDeletion(\WHMCS\Authentication\Remote\AccountLink $accountLink)
{
}
public function logAccountLinkLogin(\WHMCS\Authentication\Remote\AccountLink $accountLink, $twofaPending = false)
{
}
}
class ProviderSetting extends \WHMCS\Model\AbstractModel
{
protected $table = "tblauthn_config";
public function createTable($drop = false)
{
}
public function scopeForProvider(\Illuminate\Database\Eloquent\Builder $query, \WHMCS\Authentication\Remote\Providers\AbstractRemoteAuthProvider $provider)
{
}
public function scopeEnabled(\Illuminate\Database\Eloquent\Builder $query)
{
}
}
class AuthUserMetadata
{
protected $fullName = NULL;
protected $emailAddress = NULL;
protected $username = NULL;
protected $providerName = NULL;
public function __construct($fullName = "", $emailAddress = "", $username = "", $providerName = "")
{
}
public function getFullName()
{
}
public function setFullName($name)
{
}
public function getEmailAddress()
{
}
public function setEmailAddress($email)
{
}
public function getUsername()
{
}
public function setUsername($username)
{
}
public function getProviderName()
{
}
public function setProviderName($provider)
{
}
}
}
namespace WHMCS\Authentication\TwoFactor {
class TwoFactorController
{
protected $inAdminArea = false;
protected $userIdSessionVariableName = "uid";
protected function isAdmin()
{
}
protected function getUserId()
{
}
protected function initTwoFactorObject()
{
}
public function enable(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function configure(\WHMCS\Http\Message\ServerRequest $request, $verifyError = "")
{
}
public function qrCode(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function verify(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function disable(\WHMCS\Http\Message\ServerRequest $request, $errorMsg = "")
{
}
public function disableConfirm(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Authentication {
class DeviceConfigurationController
{
public function generate(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function delete(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function manage(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function update(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function updateFields(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getDevices(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function createNew(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class Device extends \WHMCS\Model\AbstractModel
{
use \Illuminate\Database\Eloquent\SoftDeletes;
protected $table = "tbldeviceauth";
protected $primaryKey = "id";
protected $permissions = NULL;
protected $fillable = array("identifier", "secret", "compat_secret", "user_id", "is_admin", "role_ids", "description");
protected $booleans = array("is_admin");
protected $dates = array("last_access");
protected $casts = array("role_ids" => "json");
public function createTable($drop = false)
{
}
public static function boot()
{
}
public function scopeByIdentifier($query, $identifier)
{
}
public function admin()
{
}
public static function newAdminDevice(\WHMCS\User\Admin $admin, $description = "")
{
}
public function verify($userInput)
{
}
public function verifyCompat($userInput)
{
}
public static function generateIdentifier()
{
}
public static function generateSecret()
{
}
public function rolesCollection()
{
}
public function permissions()
{
}
public function addRole(\WHMCS\Authorization\Contracts\RoleInterface $role)
{
}
public function removeRole(\WHMCS\Authorization\Contracts\RoleInterface $role)
{
}
public static function purgeRoleFromAllDevices(\WHMCS\Authorization\Contracts\RoleInterface $role)
{
}
}
}
namespace WHMCS {
class Gateways
{
const CC_EXPIRY_MAX_YEARS = 20;
public function getDisplayNames()
{
}
public function getDisplayName($gateway)
{
}
public static function isNameValid($gateway)
{
}
public static function getActiveGateways()
{
}
public function getAvailableGatewayInstances($onlyStoreRemote = false)
{
}
public function isActiveGateway($gateway)
{
}
public static function makeSafeName($gateway)
{
}
public function getAvailableGateways($invoiceid = "")
{
}
public function getFirstAvailableGateway()
{
}
public function getCCDateMonths()
{
}
public function getCCStartDateYears()
{
}
public function getCCExpiryDateYears()
{
}
public function getActiveMerchantGatewaysByType()
{
}
public function hasGatewaysSupportingManage()
{
}
public function isLocalCreditCardStorageEnabled($client = true)
{
}
public function isIssueDateAndStartNumberEnabled()
{
}
public function isLocalBankAccountGatewayAvailable()
{
}
public function isCreditCardStorageAllowed()
{
}
public static function getSupportedCardTypesForJQueryPayment()
{
}
}
class Table
{
public function __construct($width = "20")
{
}
public function add($name, $field, $fullwidth = false)
{
}
public function output()
{
}
}
}
namespace WHMCS\Results {
class ResultsList extends \ArrayObject
{
public function toArray()
{
}
}
}
namespace WHMCS {
class TableQuery
{
protected $recordOffset = 0;
protected $recordLimit = 25;
protected $data = array();
public function getData()
{
}
public function getOne()
{
}
public function setRecordLimit($limit)
{
}
public function getRecordLimit()
{
}
public function getRecordOffset()
{
}
public function getQueryLimit()
{
}
public function setData($data = array())
{
}
}
abstract class TableModel extends \WHMCS\TableQuery
{
protected $pageObj = NULL;
protected $queryObj = NULL;
public function __construct(\WHMCS\Pagination $obj = NULL)
{
}
public abstract function _execute($implementationData);
public function setPageObj(\WHMCS\Pagination $pageObj)
{
}
public function getPageObj()
{
}
public function execute($implementationData = NULL)
{
}
}
class Tickets extends \WHMCS\TableModel
{
public $ticketid = 0;
public $data = array();
public $deptids = array();
public $deptnames = array();
public $deptemails = array();
protected $departmentFeedbackRequest = array();
public $tagticketids = array();
public function _execute($criteria = NULL)
{
}
public function getTickets($criteria = array())
{
}
public function getAdminsDeptIDs()
{
}
public function getAdminSig()
{
}
public function getStatuses($counts = false)
{
}
public function getStatusesWithCounts()
{
}
public function getAssignableStatuses()
{
}
public function setID($ticketid)
{
}
public function getData($var = "")
{
}
public function getDepartments()
{
}
public function getDeptName($deptid = "")
{
}
public function getAdminsDepartments()
{
}
public function getClientName()
{
}
public function validateDept($deptid = "")
{
}
public function setDept($newdeptid)
{
}
public function changeDept($newdeptid)
{
}
public function setStatus($newstatus)
{
}
public function setSubject($newsubject)
{
}
public function setFlagTo($adminid)
{
}
public function setPriority($newpriority)
{
}
public function sendAdminEmail($tplname, $adminid = "", $notifydeptadmins = false, $vars = array(), $getlatestmsg = false)
{
}
public function log($msg)
{
}
public function addTagCloudID($ticketid)
{
}
public function getTagTicketIds()
{
}
public function getTagCloudData()
{
}
public function buildTagCloud()
{
}
public function getShortLastReplyTime($lastreply)
{
}
public function getLastReplyTime($lastreply = "", $from = "now")
{
}
public function getSummary($text, $length = 100)
{
}
public function getStatusColour($tstatus)
{
}
public function getReplies()
{
}
public function formatMsg($message = "")
{
}
public function getTicketAttachmentsInfo($replyid, $attachment, $removed = false)
{
}
public function getNotes()
{
}
public function getFlaggableStaff()
{
}
public function getPriorities()
{
}
public function getAllowedAttachments()
{
}
public static function notifyTicketChanges($ticketId, array $changes, array $recipients = array(), array $removeRecipients = array())
{
}
public function getDepartmentFeedbackNotifications()
{
}
}
class Invoice
{
protected $pdf = NULL;
protected $invoiceId = 0;
protected $data = array();
protected $output = array();
protected $totalBalance = 0;
protected $gateway = NULL;
protected $gatewayModulesWhereCallbacksMightBeDelayed = array("paypal", "paypalcheckout");
public function __construct($invoiceId = 0)
{
}
public function setID($invoiceId)
{
}
public function getID()
{
}
protected function loadData($force = true)
{
}
public function getData($var = "")
{
}
public function getStatuses()
{
}
public function getModel()
{
}
public function isAllowed($uid = 0)
{
}
protected function formatForOutput()
{
}
public function getOutput($pdf = false)
{
}
public function initialiseGatewayAndParams($passedInGatewayModuleName = "")
{
}
public function getGatewayInvoiceParams(array $params = array())
{
}
public function getPaymentLink()
{
}
public function getLineItems($entityDecode = false)
{
}
public function getTransactions()
{
}
public function pdfCreate()
{
}
protected function makePDFFriendly()
{
}
public function pdfInvoicePage($invoiceId = 0)
{
}
public function pdfAddPage($tplfile, array $tplvars)
{
}
public function pdfOutput()
{
}
public function getInvoices($status = "", $userid = 0, $orderby = "id", $sort = "DESC", $limit = "", $excludeDraftInvoices = true)
{
}
public function getTotalBalance()
{
}
public function getTotalBalanceFormatted()
{
}
public function getEmailTemplates()
{
}
public function isAddFundsInvoice()
{
}
public static function isValidCustomInvoiceNumberFormat($format)
{
}
public function isProformaInvoice()
{
}
public static function saveClientSnapshotData($invoiceId)
{
}
protected function getClientSnapshotData()
{
}
public static function getUserIdByInvoiceId($invoiceId)
{
}
public function isAssignedGatewayWithDelayedCallbacks()
{
}
public function showPaymentSuccessAwaitingNotificationMsg($paymentSuccessful = false)
{
}
}
}
namespace WHMCS\Model {
trait HasModuleTrait
{
protected $instantiatedModule = NULL;
public function scopeOfModule($query, \WHMCS\Module\AbstractModule $module)
{
}
public function getModuleNameAttribute()
{
}
public function setModuleNameAttribute($value)
{
}
public function getModuleTypeAttribute()
{
}
public function setModuleTypeAttribute($value)
{
}
public function setModuleAttribute($value)
{
}
public function getModuleAttribute()
{
}
}
abstract class AbstractKeyValuePair extends \WHMCS\Model\AbstractModel
{
protected $booleanValues = array();
protected $nonEmptyValues = array();
protected $semanticVersionValues = array();
protected $commaSeparatedValues = array();
protected $characterSeparatedValues = array();
public function __construct(array $attributes = array())
{
}
public function setAttribute($key, $value)
{
}
public function getAttribute($key)
{
}
public function isCommaSeparatedValue()
{
}
}
trait HasProductEntityTrait
{
protected static $productRelationTypes = NULL;
public static function loadRelationClassMap()
{
}
public function relationEntity()
{
}
protected function getRelatedType($relation)
{
}
public function setRelationEntityAttribute(\WHMCS\Model\AbstractModel $model)
{
}
public function scopeOfRelated($query, $relation)
{
}
}
trait HasServiceEntityTrait
{
protected static $serviceRelationTypes = NULL;
public static function loadRelationClassMap()
{
}
public function relationEntity()
{
}
public function scopeOfRelated($query, $relation)
{
}
}
class Observer
{
public function creating(\Illuminate\Database\Eloquent\Model $model)
{
}
public function updating(\Illuminate\Database\Eloquent\Model $model)
{
}
protected function enforceUniqueConstraint(\Illuminate\Database\Eloquent\Model $model)
{
}
protected function enforceGuardedForUpdateProperties(\Illuminate\Database\Eloquent\Model $model)
{
}
}
}
namespace WHMCS\Affiliate {
class Hit extends \WHMCS\Model\AbstractModel
{
protected $table = "tblaffiliates_hits";
public $timestamps = false;
public $dates = array("created_at");
protected $fillable = array("affiliate_id", "referrer_id", "created_at");
public function referrer()
{
}
}
class Referrer extends \WHMCS\Model\AbstractModel
{
protected $table = "tblaffiliates_referrers";
protected $fillable = array("affiliate_id", "referrer");
public function hits()
{
}
}
}
namespace WHMCS\Order {
class Order extends \WHMCS\Model\AbstractModel
{
protected $table = "tblorders";
public $timestamps = false;
protected $dates = array("date");
protected $columnMap = array("clientId" => "userid", "orderNumber" => "ordernum");
protected $appends = array("isPaid");
public function client()
{
}
public function contact()
{
}
public function services()
{
}
public function addons()
{
}
public function domains()
{
}
public function invoice()
{
}
public function getIsPaidAttribute()
{
}
}
}
namespace WHMCS\Version {
abstract class AbstractVersion
{
protected $major = "";
protected $minor = "";
protected $patch = "";
protected $preReleaseIdentifier = "";
protected $preReleaseRevision = "";
protected $buildTag = "";
protected $casualNames = array("release" => "", "rc" => "RC", "beta" => "Beta", "alpha" => "Alpha");
protected $version = "0.0.0";
protected $data = array();
const DEFAULT_PRERELEASE_IDENTIFIER = "release";
const DEFAULT_PRERELEASE_REVISION = "1";
public function __construct($version)
{
}
public abstract function isValid($version);
public abstract function parse($version);
public function getVersion()
{
}
public function setVersion($version)
{
}
public function getCanonical()
{
}
public function getCasual()
{
}
public function getMajor()
{
}
public function getMinor()
{
}
public function getPatch()
{
}
public function getPreReleaseIdentifier()
{
}
public function getPreReleaseRevision()
{
}
public function getBuildTag()
{
}
public function setMajor($data)
{
}
public function setMinor($data)
{
}
public function setPatch($data)
{
}
public function setPreReleaseIdentifier($data)
{
}
public function setPreReleaseRevision($data)
{
}
public function setBuildTag($data)
{
}
}
class SemanticVersion extends \WHMCS\Version\AbstractVersion
{
protected function getSemVerPattern()
{
}
public static function isSemantic($version)
{
}
public function isValid($version)
{
}
protected function separateBuildTag($version)
{
}
public function parse($version)
{
}
public function getCanonical()
{
}
public function getRelease()
{
}
public static function compare(\WHMCS\Version\SemanticVersion $a, \WHMCS\Version\SemanticVersion $b, $operator)
{
}
public static function isNextRevision(\WHMCS\Version\SemanticVersion $current, \WHMCS\Version\SemanticVersion $next)
{
}
protected static function getBoolForOperatorCompare($operator, $status)
{
}
protected static function getLabelHierarchyMap()
{
}
public static function compareForSort(\WHMCS\Version\SemanticVersion $versionA, \WHMCS\Version\SemanticVersion $versionB)
{
}
}
}
namespace WHMCS\Environment\Ioncube\Contracts {
interface InspectorIteratorInterface extends \IteratorAggregate, \ArrayAccess, \Serializable, \Countable
{
public function getArrayCopy();
public function exchangeArray($input);
}
}
namespace WHMCS\Environment\Ioncube\Inspector\Iterator {
class AbstractInspectorIterator extends \ArrayObject implements \WHMCS\Environment\Ioncube\Contracts\InspectorIteratorInterface
{
public function merge(\WHMCS\Environment\Ioncube\Contracts\InspectorIteratorInterface $currentInspections)
{
}
public function factoryAnalyser($filePath = "")
{
}
public function factoryLogFile($filePath)
{
}
}
class Directory extends \WHMCS\Environment\Ioncube\Inspector\Iterator\AbstractInspectorIterator
{
public static function fromDirectory($directory = "")
{
}
public function inspectDirectory($directory = NULL)
{
}
protected function getFilterAllEncodedFiles()
{
}
protected function getEncodedFilesFromDirectory($includeDirectories = array(), $excludeDirectories = array(), $filter = NULL)
{
}
}
class Loggable extends \WHMCS\Environment\Ioncube\Inspector\Iterator\AbstractInspectorIterator
{
public static function fromDatabase()
{
}
protected function exchangeWithLog()
{
}
public function getLastScanTime()
{
}
public function setLastScanTime(\WHMCS\Carbon $dateTime)
{
}
public function nullifyLastScanTime()
{
}
public function purgeAll()
{
}
public function save()
{
}
}
}
namespace WHMCS\Environment\Ioncube\Contracts {
interface InspectorFilterIteratorInterface
{
public function getPhpVersion();
public function setPhpVersion($phpVersion);
public function getFilterIterator(\Iterator $iterator);
public function accept(\WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface $current);
}
}
namespace WHMCS\Environment\Ioncube\Inspector\Filter {
abstract class AbstractCacheIterator extends \CachingIterator implements \WHMCS\Environment\Ioncube\Contracts\InspectorFilterIteratorInterface
{
public function __construct($phpVersion, \WHMCS\Environment\Ioncube\Contracts\InspectorIteratorInterface $iterator, $flags = self::FULL_CACHE)
{
}
public function getPhpVersion()
{
}
public function setPhpVersion($phpVersion)
{
}
public function getFilterIterator(\Iterator $iterator)
{
}
public abstract function accept(\WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface $current);
}
abstract class AbstractAbsolutelyNonDecodableIterator extends \WHMCS\Environment\Ioncube\Inspector\Filter\AbstractCacheIterator
{
public function accept(\WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface $current)
{
}
public abstract function getAssessment(\WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface $file);
}
class EncoderFingerprintFavorV9 extends \WHMCS\Environment\Ioncube\Inspector\Filter\AbstractAbsolutelyNonDecodableIterator
{
public function getAssessment(\WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface $file)
{
}
}
class AnyEncodingIterator extends \WHMCS\Environment\Ioncube\Inspector\Filter\AbstractCacheIterator
{
public function accept(\WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface $current)
{
}
}
}
namespace WHMCS\Environment\Ioncube\Contracts {
interface LoaderInterface
{
public static function getVersion();
public function compatAssessment($phpVersion, \WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface $file);
public function supportsBundledEncoding();
}
interface EncodedFileInterface
{
const ENCODER_VERSION_OUTDATED = "outdated";
const ENCODER_VERSION_V8_OR_OLDER = "8minus";
const ENCODER_VERSION_V9_PLUS_NON_BUNDLED = "9plus";
const ENCODER_VERSION_V10_PLUS_NON_BUNDLED = "10nonbundled";
const ENCODER_VERSION_V10_PLUS_BUNDLED = "10bundled";
const ENCODER_VERSION_UNKNOWN = "unknown";
const ENCODER_VERSION_NONE = "none";
const ASSESSMENT_COMPAT_NO = 0;
const ASSESSMENT_COMPAT_YES = 1;
const ASSESSMENT_COMPAT_LIKELY = 2;
const ASSESSMENT_COMPAT_UNLIKELY = 3;
public function getFilename();
public function getFileContentHash();
public function getEncoderVersion();
public function getTargetPhpVersion();
public function versionCompatibilityAssessment($phpVersion, \WHMCS\Environment\Ioncube\Contracts\LoaderInterface $loader);
public function canRunOnPhpVersion($phpVersion);
}
interface InspectedFileInterface extends \WHMCS\Environment\Ioncube\Contracts\EncodedFileInterface
{
public function getAnalyzer();
public function getBundledPhpVersions();
public function getLoadedInPhp();
}
}
namespace WHMCS\Environment\Ioncube\Loader {
class Loader100100 implements \WHMCS\Environment\Ioncube\Contracts\LoaderInterface
{
public static function getVersion()
{
}
public function compatAssessment($phpVersion, \WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface $file)
{
}
protected function compatV9PlusNonBundled($phpVersion, $verifiedLoadedInPhp, \WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface $file = NULL)
{
}
protected function compatV10Bundled($phpVersion, array $bundledFor = array())
{
}
public function supportsBundledEncoding()
{
}
}
class LocalLoader implements \WHMCS\Environment\Ioncube\Contracts\LoaderInterface
{
public function __construct(\WHMCS\Version\SemanticVersion $version = NULL)
{
}
public static function getVersion()
{
}
public static function factoryLoader(\WHMCS\Version\SemanticVersion $version)
{
}
public function compatAssessment($phpVersion, \WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface $file)
{
}
public function supportsBundledEncoding()
{
}
public function getInternalLoader()
{
}
}
}
namespace WHMCS\Environment\Ioncube\Log {
class File extends \WHMCS\Model\AbstractModel implements \WHMCS\Environment\Ioncube\Contracts\InspectedFileInterface
{
protected $table = "tblioncube_file_log";
public $timestamps = false;
protected $casts = array("bundled_php_versions" => "array", "loaded_in_php" => "array");
protected $fillable = array("filename", "content_hash", "encoder_version", "bundled_php_versions", "loaded_in_php", "target_php_version");
public function createTable($drop = false)
{
}
public function getFileFingerprint()
{
}
public function replaceAll(array $models)
{
}
protected function factoryAnalyzer()
{
}
public function getAnalyzer()
{
}
public function setAnalyzer($analyzer)
{
}
public function getFilename()
{
}
public function getFileContentHash()
{
}
public function getEncoderVersion()
{
}
public function getTargetPhpVersion()
{
}
public function versionCompatibilityAssessment($phpVersion, \WHMCS\Environment\Ioncube\Contracts\LoaderInterface $loader = NULL)
{
}
public function getBundledPhpVersions()
{
}
public function getLoadedInPhp()
{
}
public function canRunOnPhpVersion($phpVersion)
{
}
}
}
namespace WHMCS\Environment\Ioncube {
class EncodedFile implements \WHMCS\Environment\Ioncube\Contracts\EncodedFileInterface
{
const MAX_LINES_IN_PREAMBLE = 1;
const ENCODER_VERSION_PREAMBLE_HASHES = NULL;
public function __construct($filename = NULL, $contentHash = NULL, $encoderVersion = NULL, $bundledPhpVersions = NULL, $targetPhpVersion = NULL)
{
}
public function getFileContentHash()
{
}
public static function generateFileContentHash($filename)
{
}
public function analyze($filename)
{
}
public function getEncoderVersion()
{
}
public function isBundled()
{
}
public function hasPhpVersionBundled($phpVersion)
{
}
public function getBundledPhpVersions()
{
}
public function getTargetPhpVersion()
{
}
public function getFilename()
{
}
public function canRunOnIoncubeLoaderVersion($ioncubeLoaderVersion)
{
}
public function canRunOnInstalledIoncubeLoader()
{
}
public function canRunOnPhpVersion($phpVersion)
{
}
public function canRunOnInstalledPhpVersion()
{
}
public function getLoggable()
{
}
public function versionCompatibilityAssessment($phpVersion, \WHMCS\Environment\Ioncube\Contracts\LoaderInterface $loader = NULL)
{
}
}
}
namespace WHMCS\Environment {
class Curl
{
const OPENSSL_MIN_TLS_VERSION = "1.0.1c";
const LAST_BAD_VERSION = "7.35.0";
protected static function compareOpenSslVersion($checkVersion, $baseVersion)
{
}
public static function hasKnownGoodVersion(array $curlVersion)
{
}
public static function hasSslSupport(array $curlVersion)
{
}
public static function hasSecureTlsSupport(array $curlVersion)
{
}
public static function getInfo()
{
}
}
class OperatingSystem
{
public static function isWindows($phpOs = PHP_OS)
{
}
public function isOwnedByMe($path)
{
}
}
class Http
{
public function siteIsConfiguredForSsl()
{
}
public function siteHasVerifiedSslCert()
{
}
}
interface ComponentInterface
{
public function report(\WHMCS\Environment\Report $report);
public function addTopic($name, $closure);
public function name();
}
class Report
{
const VERSION = "1.0.0";
const API_SPEC = "1.0.0";
const TYPE_EVENT = 0;
const TYPE_STATE = 1;
public function __construct($type, array $components = array())
{
}
public function report()
{
}
public function toJson()
{
}
public function info()
{
}
public function data()
{
}
public function type()
{
}
public function systemId()
{
}
public function apiSpec()
{
}
public function version()
{
}
}
class Component implements \WHMCS\Environment\ComponentInterface
{
protected $name = NULL;
protected $topics = array();
public function __construct($name)
{
}
public function name()
{
}
public function addTopic($name, $closure)
{
}
public function report(\WHMCS\Environment\Report $report)
{
}
protected function data(\WHMCS\Environment\Report $report)
{
}
}
class WHMCS
{
public function isDownloadsPathCustom($path)
{
}
public function isAttachmentsPathCustom($path)
{
}
public function isCompiledTemplatesPathCustom($path)
{
}
public function isCronPathCustom($path)
{
}
public function isConfigurationWritable()
{
}
public function hasCronCompletedInLastDay()
{
}
public function shouldPopCronRun()
{
}
public function cronPhpVersion()
{
}
public function hasPopCronRunInLastHour()
{
}
public function isUsingADefaultOrderFormTemplate($template)
{
}
public function isUsingADefaultSystemTemplate($template)
{
}
public function isDisplayingErrors($databaseSetting, $configFileSetting = NULL)
{
}
public function getDbCollations()
{
}
public function isUsingEncryptedEmailDelivery($smtpOption = "")
{
}
public function isUsingSMTP()
{
}
public function isVendorWhmcsWhmcsWritable()
{
}
public function isUpdateTmpPathSet()
{
}
public function isUpdateTmpPathWriteable()
{
}
public function hasEnoughMemoryForUpgrade($memoryLimitRequired = \WHMCS\View\Admin\HealthCheck\HealthCheckRepository::DEFAULT_MEMORY_LIMIT_FOR_AUTO_UPDATE)
{
}
public static function systemId()
{
}
}
final class WebServer
{
const SERVER_NAME_APACHE = "Apache";
const HTACCESS_FILE = ".htaccess";
public static function getServerFamily()
{
}
public static function getServerVersion()
{
}
public static function getControlPanelInfo()
{
}
public static function isApache()
{
}
public static function isLiteSpeed()
{
}
public static function supportsHtaccess()
{
}
public static function hasModRewrite()
{
}
public static function hasRootHtaccess()
{
}
public static function hasAdminHtaccess()
{
}
public static function getExternalCommunicationIp()
{
}
}
class DbEngine
{
public static function isSupportedByWhmcs($version)
{
}
public static function isSqlStrictMode()
{
}
public static function getInfo()
{
}
}
final class Environment
{
public static function toArray()
{
}
}
class Php
{
protected static $myUid = NULL;
protected static $versionSupport = array("5.3" => array("active" => "14 Aug 2013", "security" => "14 Aug 2014"), "5.4" => array("active" => "14 Sep 2014", "security" => "14 Sep 2015"), "5.5" => array("active" => "10 Jul 2015", "security" => "10 Jul 2016"), "5.6" => array("active" => "31 Dec 2016", "security" => "31 Dec 2018"), "7.0" => array("active" => "03 Dec 2017", "security" => "03 Dec 2018"), "7.1" => array("active" => "01 Dec 2018", "security" => "01 Dec 2019"), "7.2" => array("active" => "30 Nov 2019", "security" => "30 Nov 2020"), "7.3" => array("active" => "06 Dec 2020", "security" => "06 Dec 2021"));
public static function functionEnabled($function)
{
}
public static function getIniSetting($setting)
{
}
public static function isIniSettingEnabled($setting)
{
}
public static function isFunctionAvailable($function)
{
}
public static function isModuleActive($module)
{
}
public static function isCli()
{
}
public static function getUserRunningPhp()
{
}
public static function hasValidTimezone()
{
}
public static function hasExtension($extension)
{
}
public static function isSessionAutoStartEnabled()
{
}
public static function isSessionSavePathWritable()
{
}
public static function isSupportedByWhmcs($version = PHP_VERSION)
{
}
public static function hasActivePhpSupport($majorMinor)
{
}
public static function hasSecurityPhpSupport($majorMinor)
{
}
public static function convertMemoryLimitToBytes($memoryLimit)
{
}
public static function getPhpMemoryLimitInBytes()
{
}
public static function hasErrorLevelEnabled($errorLevels, $checkLevel)
{
}
public static function getVersion()
{
}
public static function getLoadedExtensions()
{
}
public static function getPreferredCliBinary()
{
}
}
}
namespace WHMCS\Environment\WHMCS {
class UsageBilling extends \WHMCS\Environment\Component
{
const NAME = "UsageBilling";
public function __construct()
{
}
protected function topicSettings()
{
}
protected function topicProductMetrics()
{
}
}
}
namespace WHMCS {
class Form
{
public function __construct($name = "frm1")
{
}
public function name($name)
{
}
public function getname()
{
}
public function form($url = "", $files = false, $target = "", $method = "post", $nosubmitvar = false)
{
}
public function issubmitted($skiptoken = false)
{
}
public function text($name, $value = "", $size = 30, $disabled = false, $class = "", $type = "text")
{
}
public function password($name, $value = "", $size = 30, $disabled = false, $class = "")
{
}
public function date($name, $value = "", $size = 12, $disabled = false, $class = "form-control date-picker-single")
{
}
public function textarea($name, $value, $rows = 3, $cols = 50, $class = "form-control")
{
}
public function checkbox($name, $label = "", $checked = false, $value = "1", $class = "")
{
}
public function dropdown($name, $values = array(), $selected = "", $onchange = "", $anyopt = "", $noneopt = "", $size = "1", $id = "", $cssClass = "form-control select-inline")
{
}
public function radio($name, $values = array(), $selected = "", $spacer = "<br />")
{
}
public function hidden($name, $value)
{
}
public function submit($text, $class = "btn btn-primary")
{
}
public function button($text, $onclick = "", $class = "btn btn-default")
{
}
public function modalButton($text, $dataTarget, $class = "btn btn-default")
{
}
public function reset($text, $class = "btn btn-default")
{
}
public function savereset()
{
}
public function close()
{
}
}
}
namespace WHMCS\View {
class Form
{
const METHOD_GET = "get";
const METHOD_POST = "post";
public function setUri($uri)
{
}
public function setUriPrefixAdminBaseUrl($uri)
{
}
public function setUriByRoutePath($routePath)
{
}
public function getUri()
{
}
public function setMethod($method)
{
}
public function getMethod()
{
}
public function setParameters(array $params)
{
}
public function getParameters()
{
}
public function setSubmitLabel($submitLabel)
{
}
public function getSubmitLabel()
{
}
}
}
namespace WHMCS\View\Menu {
class MenuFactory extends \Knp\Menu\MenuFactory
{
protected $loader = NULL;
protected $rootItemName = NULL;
public function __construct()
{
}
public function createItem($name, array $options = array())
{
}
protected function buildMenuStructure(array $structure = array())
{
}
public function emptySidebar()
{
}
public function getLoader()
{
}
public function isOnRoutePath($routePathName, $wildcardMatch = false)
{
}
}
}
namespace WHMCS\View\Client\Menu {
class PrimarySidebarFactory extends \WHMCS\View\Menu\MenuFactory
{
protected $rootItemName = "Primary Sidebar";
public function clientView()
{
}
public function serviceList()
{
}
public function serviceView()
{
}
public function serviceUpgrade()
{
}
public function sslCertificateOrderView()
{
}
public function domainList()
{
}
public function domainView()
{
}
public function invoiceList()
{
}
public function clientQuoteList()
{
}
public function clientAddFunds()
{
}
public function affiliateView()
{
}
public function announcementList()
{
}
public function downloadList()
{
}
public function supportKnowledgeBase()
{
}
public function support()
{
}
public function networkIssueList()
{
}
public function ticketList()
{
}
public function ticketSubmit()
{
}
public function ticketFeedback()
{
}
public function ticketView()
{
}
public function clientRegistration()
{
}
public function clientHome()
{
}
protected function buildSupportKnowledgeBaseCategories()
{
}
public function orderFormView()
{
}
}
class SecondarySidebarFactory extends \WHMCS\View\Client\Menu\PrimarySidebarFactory
{
protected $rootItemName = "Secondary Sidebar";
public function clientView()
{
}
public function serviceList()
{
}
public function serviceView()
{
}
public function serviceUpgrade()
{
}
public function sslCertificateOrderView()
{
}
public function domainList()
{
}
public function domainView()
{
}
public function invoiceList()
{
}
public function clientQuoteList()
{
}
public function clientAddFunds()
{
}
public function affiliateView()
{
}
public function announcementList()
{
}
public function downloadList()
{
}
public function supportKnowledgeBase()
{
}
public function support()
{
}
public function networkIssueList()
{
}
public function ticketList()
{
}
public function ticketFeedback()
{
}
public function ticketSubmit()
{
}
public function ticketView()
{
}
protected function buildDomainActionsChildren()
{
}
protected function buildBillingChildItems()
{
}
protected function buildBaseSupportItems()
{
}
public function clientRegistration()
{
}
public function clientHome()
{
}
public function orderFormView()
{
}
}
class MenuRepository
{
protected $primaryNavbar = NULL;
protected $secondaryNavbar = NULL;
protected $primarySidebar = NULL;
protected $secondarySidebar = NULL;
protected $primaryNavbarFactory = NULL;
protected $secondaryNavbarFactory = NULL;
protected $primarySidebarFactory = NULL;
protected $secondarySidebarFactory = NULL;
protected $context = array();
public function __construct(\WHMCS\View\Client\Menu\PrimaryNavbarFactory $primaryNavbarFactory, \WHMCS\View\Client\Menu\SecondaryNavbarFactory $secondaryNavbarFactory, \WHMCS\View\Client\Menu\PrimarySidebarFactory $primarySidebarFactory, \WHMCS\View\Client\Menu\SecondarySidebarFactory $secondarySidebarFactory)
{
}
protected function setPrimaryNavbarFactory(\WHMCS\View\Client\Menu\PrimaryNavbarFactory $navbarFactory)
{
}
protected function setSecondaryNavbarFactory(\WHMCS\View\Client\Menu\SecondaryNavbarFactory $navbarFactory)
{
}
protected function setPrimarySidebarFactory(\WHMCS\View\Client\Menu\PrimarySidebarFactory $primarySidebarFactory)
{
}
protected function setSecondarySidebarFactory(\WHMCS\View\Client\Menu\SecondarySidebarFactory $secondarySidebarFactory)
{
}
protected function buildSidebar($sidebar, $type = NULL)
{
}
public function primaryNavbar($firstName = "", array $conditionalLinks = array())
{
}
public function secondaryNavbar($firstName = "", array $conditionalLinks = array())
{
}
public function primarySidebar($type = NULL)
{
}
public function secondarySidebar($type = NULL)
{
}
public function addContext($key, $value)
{
}
public function context($key = NULL)
{
}
public function removeEmptyChildren(\WHMCS\View\Menu\Item $menuBar)
{
}
}
class PrimaryNavbarFactory extends \WHMCS\View\Menu\MenuFactory
{
protected $rootItemName = "Primary Navbar";
public function navbar($firstName = "", array $conditionalLinks = array())
{
}
protected function getLoggedOutNavBarStructure(array $conditionalLinks = array())
{
}
protected function getLoggedInNavBarStructure($firstName = "", array $conditionalLinks = array())
{
}
protected function buildDomainsChildren(array $conditionalLinks = array())
{
}
protected function buildBillingChildren($conditionalLinks)
{
}
protected function buildStoreChildren(array $conditionalLinks = array())
{
}
}
class SecondaryNavbarFactory extends \WHMCS\View\Client\Menu\PrimaryNavbarFactory
{
protected $rootItemName = "Secondary Navbar";
public function navbar($firstName = "", array $conditionalLinks = array())
{
}
protected function getLoggedOutNavBarStructure(array $conditionalLinks = array())
{
}
protected function getLoggedInNavBarStructure($firstName = "", array $conditionalLinks = array())
{
}
protected function buildAccountChildren(array $conditionalLinks = array())
{
}
}
}
namespace WHMCS\View\Client {
class HomepagePanel
{
protected $name = NULL;
protected $label = NULL;
protected $icon = NULL;
protected $color = "blue";
protected $order = 0;
protected $bodyHtml = NULL;
protected $buttonLink = NULL;
protected $buttonText = NULL;
protected $buttonIcon = NULL;
public function setName($name)
{
}
public function getName()
{
}
public function setLabel($label)
{
}
public function setIcon($icon)
{
}
public function setColor($color)
{
}
public function setOrder($order)
{
}
public function setBodyHtml($bodyHtml)
{
}
public function setHeaderButton($link, $text, $icon = "")
{
}
public function getBodyHtml()
{
}
public function toArray()
{
}
}
}
namespace WHMCS\View {
interface HtmlPageInterface
{
public function getFormattedHtmlHeadContent();
public function getFormattedHeaderContent();
public function getFormattedBodyContent();
public function getFormattedFooterContent();
}
class Bootstrap
{
public function renderKeyValuePairsInColumns($colWidth, $data)
{
}
}
interface LinkDecoratorInterface
{
public function decorateLinksInText($text);
}
}
namespace WHMCS\View\Markup\Bbcode {
class Bbcode
{
public static function transform($text)
{
}
}
}
namespace WHMCS\View\Markup {
class Markup
{
public function determineMarkupEditor($contentType = "", $definedEditor = "plain", $timestamp = NULL)
{
}
public function transform($text, $markupFormat = "plain", $emailFriendly = false)
{
}
public function isAfterMdeUpgrade($timestamp)
{
}
}
interface TransformInterface
{
const FORMAT_PLAIN = "plain";
const FORMAT_BBCODE = "bbcode";
const FORMAT_MARKDOWN = "markdown";
const FORMAT_HTML = "html";
public function transform($text, $markupFormat, $emailFriendly);
}
}
namespace WHMCS\View\Markup\Error {
abstract class AbstractConsoleOutput implements \IteratorAggregate, \WHMCS\View\Markup\TransformInterface
{
public function __construct($firstErrorOnly = false, $showNonErrorAsError = false)
{
}
public abstract function getIterator();
public function transform($text, $markupFormat = NULL, $emailFriendly = false)
{
}
public function getText()
{
}
protected function transformPlain(\Iterator $iterator)
{
}
protected function transformHtml(\Iterator $iterator)
{
}
protected function getMessageIterator(\Iterator $parsedTextIterator)
{
}
protected abstract function getMatchDecorators();
}
trait ErrorLevelTrait
{
protected $errorLevel = \WHMCS\View\Markup\Error\ErrorLevelInterface::ERROR;
public function isAnError()
{
}
public function errorName()
{
}
}
interface ErrorLevelInterface
{
const DEBUG = 100;
const INFO = 200;
const NOTICE = 250;
const WARNING = 300;
const ERROR = 400;
const CRITICAL = 500;
const ALERT = 550;
const EMERGENCY = 600;
public function isAnError();
}
}
namespace WHMCS\View\Markup\Error\Message {
interface DecoratorInterface
{
public function toHtml();
public function toPlain();
public function getTitle();
public function getHelpUrl();
}
}
namespace WHMCS\View\Markup\Error\Message\MatchDecorator {
interface MatchDecoratorInterface extends \WHMCS\View\Markup\Error\Message\DecoratorInterface, \WHMCS\View\Markup\Error\ErrorLevelInterface
{
public function wrap(\Iterator $data);
public function getData();
public function hasMatch();
}
abstract class AbstractMatchDecorator implements \WHMCS\View\Markup\Error\Message\MatchDecorator\MatchDecoratorInterface
{
use \WHMCS\View\Markup\Error\ErrorLevelTrait;
protected $parsedMessages = NULL;
public function __construct(\Iterator $data = NULL)
{
}
public abstract function toPlain();
public abstract function toHtml();
public abstract function getTitle();
public abstract function getHelpUrl();
protected abstract function isKnown($data);
public function wrap(\Iterator $data)
{
}
public function hasMatch()
{
}
public function getData()
{
}
protected function setParsedMessages(\SplDoublyLinkedList $messages)
{
}
public function getParsedMessages()
{
}
public function getParsedMessageList()
{
}
protected function getMatches()
{
}
protected function toGenericHtml($error = "")
{
}
protected function toGenericPlain($error = "")
{
}
public function __toString()
{
}
}
trait GenericMatchDecorationTrait
{
public function toHtml()
{
}
public function toPlain()
{
}
}
}
namespace WHMCS\View\Markup\Error\Message\MatchDecorator\Validation {
class InvalidCertificate extends \WHMCS\View\Markup\Error\Message\MatchDecorator\AbstractMatchDecorator
{
use \WHMCS\View\Markup\Error\Message\MatchDecorator\GenericMatchDecorationTrait;
const PATTERN_FAILED_CERT_LOAD = "/Invalid certificate content/";
public function getTitle()
{
}
public function getHelpUrl()
{
}
protected function isKnown($data)
{
}
}
}
namespace WHMCS\View\Markup\Error\Message\MatchDecorator\SystemRequirements {
class DiskQuotaExceeded extends \WHMCS\View\Markup\Error\Message\MatchDecorator\AbstractMatchDecorator
{
use \WHMCS\View\Markup\Error\Message\MatchDecorator\GenericMatchDecorationTrait;
const PATTERN_DISK_QUOTA_EXCEEDED = "/Disk quota exceeded/";
public function getTitle()
{
}
public function getHelpUrl()
{
}
protected function isKnown($data)
{
}
}
class FunctionDisabled extends \WHMCS\View\Markup\Error\Message\MatchDecorator\AbstractMatchDecorator
{
use \WHMCS\View\Markup\Error\Message\MatchDecorator\GenericMatchDecorationTrait;
const PATTERN_FUNCTION_DISABLED = "/(.*)\\(\\) has been disabled for security reasons/";
public function getTitle()
{
}
public function getHelpUrl()
{
}
protected function isKnown($data)
{
}
}
}
namespace WHMCS\View\Markup\Error\Message\MatchDecorator\FilePermission {
class NotWritablePath extends \WHMCS\View\Markup\Error\Message\MatchDecorator\AbstractMatchDecorator
{
use \WHMCS\View\Markup\Error\Message\MatchDecorator\GenericMatchDecorationTrait;
const PATTERN_PATH_NOT_WRITABLE = "/Permission Error. Failed to create or modify path: (.*)/";
const PATTERN_VENDOR_NOT_WRITABLE = "/(vendor(?:\\/whmcs(?:\\/whmcs)?)?) does not exist and could not be created/";
const PATTERN_VENDOR_NO_DELETE = "/Could not delete (\\/(?:.*)vendor\\/(?:.*))/";
const PATTERN_WHMCS_WHMCS_MISSING = "/file could not be written to ((?:.*)\\/vendor\\/whmcs\\/whmcs).*\\.zip: failed to open stream: No such file or directory/";
const PATTERN_WHMCS_WHMCS_NOT_MUTABLE = "/file could not be written to ((?:.*)\\/vendor\\/whmcs\\/whmcs).*\\.zip: failed to open stream: Permission denied/";
public function getTitle()
{
}
public function getHelpUrl()
{
}
protected function isKnown($data)
{
}
}
class PostCommandCopy extends \WHMCS\View\Markup\Error\Message\MatchDecorator\AbstractMatchDecorator
{
use \WHMCS\View\Markup\Error\Message\MatchDecorator\GenericMatchDecorationTrait;
const PATTERN_DIRECTORY_UNABLE_TO_COPY = "/Unable to copy (.*) to (.*)/";
const PATTERN_UNABLE_TO_PERFORM_EARLY_FILE_COPY = "/Failed to perform early file copy during WHMCS file relocation/";
public function getTitle()
{
}
public function getHelpUrl()
{
}
protected function isKnown($data)
{
}
}
class CacheNotWritable extends \WHMCS\View\Markup\Error\Message\MatchDecorator\AbstractMatchDecorator
{
use \WHMCS\View\Markup\Error\Message\MatchDecorator\GenericMatchDecorationTrait;
protected $errorLevel = \WHMCS\View\Markup\Error\ErrorLevelInterface::WARNING;
const PATTERN_DIRECTORY_CACHE_NOT_WRITABLE = "/cache directory ([^,].*), or directory is not writable/";
public function getTitle()
{
}
public function getHelpUrl()
{
}
protected function isKnown($data)
{
}
}
}
namespace WHMCS\View\Markup\Error\Message\MatchDecorator {
class NoMatchDecorator extends \WHMCS\View\Markup\Error\Message\MatchDecorator\AbstractMatchDecorator
{
use \WHMCS\View\Markup\Error\Message\MatchDecorator\GenericMatchDecorationTrait;
public function getTitle()
{
}
public function getHelpUrl()
{
}
protected function isKnown($data)
{
}
}
}
namespace WHMCS\View\Markup\Error\Message\MatchDecorator\NetworkIssue {
class FailedKeyserverFetch extends \WHMCS\View\Markup\Error\Message\MatchDecorator\AbstractMatchDecorator
{
use \WHMCS\View\Markup\Error\Message\MatchDecorator\GenericMatchDecorationTrait;
const PATTERN_GENERIC_GET_URL = "/Failed to get certificate metadata from keyserver. Error:/";
const PATTERN_CRL_GET_URL = "/Failed to get CRL package from keyserver. Error:/";
public function getTitle()
{
}
public function getHelpUrl()
{
}
protected function isKnown($data)
{
}
}
}
namespace WHMCS\View\Markup\Error {
class ComposerOutput extends \WHMCS\View\Markup\Error\AbstractConsoleOutput
{
public static function filterComposerNoise($line)
{
}
public static function getComposerOutputStack($data)
{
}
public function getIterator()
{
}
protected function getMatchDecorators()
{
}
}
}
namespace Michelf {
#
# Markdown Parser Interface
#
interface MarkdownInterface
{
#
# Initialize the parser and return the result of its transform method.
# This will work fine for derived classes too.
#
public static function defaultTransform($text);
#
# Main function. Performs some preprocessing on the input text
# and pass it through the document gamut.
#
public function transform($text);
}
#
# Markdown Parser Class
#
class Markdown implements \Michelf\MarkdownInterface
{
### Version ###
const MARKDOWNLIB_VERSION = "1.6.0";
### Simple Function Interface ###
public static function defaultTransform($text)
{
}
### Configuration Variables ###
# Change to ">" for HTML output.
public $empty_element_suffix = " />";
public $tab_width = 4;
# Change to `true` to disallow markup or entities.
public $no_markup = false;
public $no_entities = false;
# Predefined urls and titles for reference links and images.
public $predef_urls = array();
public $predef_titles = array();
# Optional filter function for URLs
public $url_filter_func = null;
# Optional header id="" generation callback function.
public $header_id_func = null;
# Optional function for converting code block content to HTML
public $code_block_content_func = null;
# Class attribute to toggle "enhanced ordered list" behaviour
# setting this to true will allow ordered lists to start from the index
# number that is defined first. For example:
# 2. List item two
# 3. List item three
#
# becomes
# <ol start="2">
# <li>List item two</li>
# <li>List item three</li>
# </ol>
public $enhanced_ordered_list = false;
### Parser Implementation ###
# Regex to match balanced [brackets].
# Needed to insert a maximum bracked depth while converting to PHP.
protected $nested_brackets_depth = 6;
protected $nested_brackets_re;
protected $nested_url_parenthesis_depth = 4;
protected $nested_url_parenthesis_re;
# Table of hash values for escaped characters:
protected $escape_chars = '\\`*_{}[]()>#+-.!';
protected $escape_chars_re;
public function __construct()
{
}
# Internal hashes used during transformation.
protected $urls = array();
protected $titles = array();
protected $html_hashes = array();
# Status flag to avoid invalid nesting.
protected $in_anchor = false;
protected function setup()
{
}
protected function teardown()
{
}
public function transform($text)
{
}
protected $document_gamut = array(
# Strip link definitions, store in hashes.
"stripLinkDefinitions" => 20,
"runBasicBlockGamut" => 30,
);
protected function stripLinkDefinitions($text)
{
}
protected function _stripLinkDefinitions_callback($matches)
{
}
protected function hashHTMLBlocks($text)
{
}
protected function _hashHTMLBlocks_callback($matches)
{
}
protected function hashPart($text, $boundary = 'X')
{
}
protected function hashBlock($text)
{
}
protected $block_gamut = array(
#
# These are all the transformations that form block-level
# tags like paragraphs, headers, and list items.
#
"doHeaders" => 10,
"doHorizontalRules" => 20,
"doLists" => 40,
"doCodeBlocks" => 50,
"doBlockQuotes" => 60,
);
protected function runBlockGamut($text)
{
}
protected function runBasicBlockGamut($text)
{
}
protected function doHorizontalRules($text)
{
}
protected $span_gamut = array(
#
# These are all the transformations that occur *within* block-level
# tags like paragraphs, headers, and list items.
#
# Process character escapes, code spans, and inline HTML
# in one shot.
"parseSpan" => -30,
# Process anchor and image tags. Images must come first,
# because ![foo][f] looks like an anchor.
"doImages" => 10,
"doAnchors" => 20,
# Make links out of things like `<https://example.com/>`
# Must come after doAnchors, because you can use < and >
# delimiters in inline links like [this](<url>).
"doAutoLinks" => 30,
"encodeAmpsAndAngles" => 40,
"doItalicsAndBold" => 50,
"doHardBreaks" => 60,
);
protected function runSpanGamut($text)
{
}
protected function doHardBreaks($text)
{
}
protected function _doHardBreaks_callback($matches)
{
}
protected function doAnchors($text)
{
}
protected function _doAnchors_reference_callback($matches)
{
}
protected function _doAnchors_inline_callback($matches)
{
}
protected function doImages($text)
{
}
protected function _doImages_reference_callback($matches)
{
}
protected function _doImages_inline_callback($matches)
{
}
protected function doHeaders($text)
{
}
protected function _doHeaders_callback_setext($matches)
{
}
protected function _doHeaders_callback_atx($matches)
{
}
protected function _generateIdFromHeaderValue($headerValue)
{
}
protected function doLists($text)
{
}
protected function _doLists_callback($matches)
{
}
protected $list_level = 0;
protected function processListItems($list_str, $marker_any_re)
{
}
protected function _processListItems_callback($matches)
{
}
protected function doCodeBlocks($text)
{
}
protected function _doCodeBlocks_callback($matches)
{
}
protected function makeCodeSpan($code)
{
}
protected $em_relist = array('' => '(?:(?<!\\*)\\*(?!\\*)|(?<!_)_(?!_))(?![\\.,:;]?\\s)', '*' => '(?<![\\s*])\\*(?!\\*)', '_' => '(?<![\\s_])_(?!_)');
protected $strong_relist = array('' => '(?:(?<!\\*)\\*\\*(?!\\*)|(?<!_)__(?!_))(?![\\.,:;]?\\s)', '**' => '(?<![\\s*])\\*\\*(?!\\*)', '__' => '(?<![\\s_])__(?!_)');
protected $em_strong_relist = array('' => '(?:(?<!\\*)\\*\\*\\*(?!\\*)|(?<!_)___(?!_))(?![\\.,:;]?\\s)', '***' => '(?<![\\s*])\\*\\*\\*(?!\\*)', '___' => '(?<![\\s_])___(?!_)');
protected $em_strong_prepared_relist;
protected function prepareItalicsAndBold()
{
}
protected function doItalicsAndBold($text)
{
}
protected function doBlockQuotes($text)
{
}
protected function _doBlockQuotes_callback($matches)
{
}
protected function _doBlockQuotes_callback2($matches)
{
}
protected function formParagraphs($text)
{
}
protected function encodeAttribute($text)
{
}
protected function encodeURLAttribute($url, &$text = null)
{
}
protected function encodeAmpsAndAngles($text)
{
}
protected function doAutoLinks($text)
{
}
protected function _doAutoLinks_url_callback($matches)
{
}
protected function _doAutoLinks_email_callback($matches)
{
}
protected function encodeEntityObfuscatedAttribute($text, &$tail = null, $head_length = 0)
{
}
protected function parseSpan($str)
{
}
protected function handleSpanToken($token, &$str)
{
}
protected function outdent($text)
{
}
# String length function for detab. `_initDetab` will create a function to
# hanlde UTF-8 if the default function does not exist.
protected $utf8_strlen = 'mb_strlen';
protected function detab($text)
{
}
protected function _detab_callback($matches)
{
}
protected function _initDetab()
{
}
protected function unhash($text)
{
}
protected function _unhash_callback($matches)
{
}
}
#
# Markdown Extra Parser Class
#
class MarkdownExtra extends \Michelf\Markdown
{
### Configuration Variables ###
# Prefix for footnote ids.
public $fn_id_prefix = "";
# Optional title attribute for footnote links and backlinks.
public $fn_link_title = "";
public $fn_backlink_title = "";
# Optional class attribute for footnote links and backlinks.
public $fn_link_class = "footnote-ref";
public $fn_backlink_class = "footnote-backref";
# Content to be displayed within footnote backlinks. The default is '↩';
# the U+FE0E on the end is a Unicode variant selector used to prevent iOS
# from displaying the arrow character as an emoji.
public $fn_backlink_html = '↩︎';
# Class name for table cell alignment (%% replaced left/center/right)
# For instance: 'go-%%' becomes 'go-left' or 'go-right' or 'go-center'
# If empty, the align attribute is used instead of a class name.
public $table_align_class_tmpl = '';
# Optional class prefix for fenced code block.
public $code_class_prefix = "";
# Class attribute for code blocks goes on the `code` tag;
# setting this to true will put attributes on the `pre` tag instead.
public $code_attr_on_pre = false;
# Predefined abbreviations.
public $predef_abbr = array();
### Parser Implementation ###
public function __construct()
{
}
# Extra variables used during extra transformations.
protected $footnotes = array();
protected $footnotes_ordered = array();
protected $footnotes_ref_count = array();
protected $footnotes_numbers = array();
protected $abbr_desciptions = array();
protected $abbr_word_re = '';
# Give the current footnote number.
protected $footnote_counter = 1;
protected function setup()
{
}
protected function teardown()
{
}
### Extra Attribute Parser ###
# Expression to use to catch attributes (includes the braces)
protected $id_class_attr_catch_re = '\\{((?>[ ]*[#.a-z][-_:a-zA-Z0-9=]+){1,})[ ]*\\}';
# Expression to use when parsing in a context when no capture is desired
protected $id_class_attr_nocatch_re = '\\{(?>[ ]*[#.a-z][-_:a-zA-Z0-9=]+){1,}[ ]*\\}';
protected function doExtraAttributes($tag_name, $attr, $defaultIdValue = null, $classes = array())
{
}
protected function stripLinkDefinitions($text)
{
}
protected function _stripLinkDefinitions_callback($matches)
{
}
### HTML Block Parser ###
# Tags that are always treated as block tags:
protected $block_tags_re = 'p|div|h[1-6]|blockquote|pre|table|dl|ol|ul|address|form|fieldset|iframe|hr|legend|article|section|nav|aside|hgroup|header|footer|figcaption|figure';
# Tags treated as block tags only if the opening tag is alone on its line:
protected $context_block_tags_re = 'script|noscript|style|ins|del|iframe|object|source|track|param|math|svg|canvas|audio|video';
# Tags where markdown="1" default to span mode:
protected $contain_span_tags_re = 'p|h[1-6]|li|dd|dt|td|th|legend|address';
# Tags which must not have their contents modified, no matter where
# they appear:
protected $clean_tags_re = 'script|style|math|svg';
# Tags that do not need to be closed.
protected $auto_close_tags_re = 'hr|img|param|source|track';
protected function hashHTMLBlocks($text)
{
}
protected function _hashHTMLBlocks_inMarkdown($text, $indent = 0, $enclosing_tag_re = '', $span = false)
{
}
protected function _hashHTMLBlocks_inHTML($text, $hash_method, $md_attr)
{
}
protected function hashClean($text)
{
}
protected function doAnchors($text)
{
}
protected function _doAnchors_reference_callback($matches)
{
}
protected function _doAnchors_inline_callback($matches)
{
}
protected function doImages($text)
{
}
protected function _doImages_reference_callback($matches)
{
}
protected function _doImages_inline_callback($matches)
{
}
protected function doHeaders($text)
{
}
protected function _doHeaders_callback_setext($matches)
{
}
protected function _doHeaders_callback_atx($matches)
{
}
protected function doTables($text)
{
}
protected function _doTable_leadingPipe_callback($matches)
{
}
protected function _doTable_makeAlignAttr($alignname)
{
}
protected function _doTable_callback($matches)
{
}
protected function doDefLists($text)
{
}
protected function _doDefLists_callback($matches)
{
}
protected function processDefListItems($list_str)
{
}
protected function _processDefListItems_callback_dt($matches)
{
}
protected function _processDefListItems_callback_dd($matches)
{
}
protected function doFencedCodeBlocks($text)
{
}
protected function _doFencedCodeBlocks_callback($matches)
{
}
protected function _doFencedCodeBlocks_newlines($matches)
{
}
#
# Redefining emphasis markers so that emphasis by underscore does not
# work in the middle of a word.
#
protected $em_relist = array('' => '(?:(?<!\\*)\\*(?!\\*)|(?<![a-zA-Z0-9_])_(?!_))(?![\\.,:;]?\\s)', '*' => '(?<![\\s*])\\*(?!\\*)', '_' => '(?<![\\s_])_(?![a-zA-Z0-9_])');
protected $strong_relist = array('' => '(?:(?<!\\*)\\*\\*(?!\\*)|(?<![a-zA-Z0-9_])__(?!_))(?![\\.,:;]?\\s)', '**' => '(?<![\\s*])\\*\\*(?!\\*)', '__' => '(?<![\\s_])__(?![a-zA-Z0-9_])');
protected $em_strong_relist = array('' => '(?:(?<!\\*)\\*\\*\\*(?!\\*)|(?<![a-zA-Z0-9_])___(?!_))(?![\\.,:;]?\\s)', '***' => '(?<![\\s*])\\*\\*\\*(?!\\*)', '___' => '(?<![\\s_])___(?![a-zA-Z0-9_])');
protected function formParagraphs($text)
{
}
### Footnotes
protected function stripFootnotes($text)
{
}
protected function _stripFootnotes_callback($matches)
{
}
protected function doFootnotes($text)
{
}
protected function appendFootnotes($text)
{
}
protected function _appendFootnotes_callback($matches)
{
}
### Abbreviations ###
protected function stripAbbreviations($text)
{
}
protected function _stripAbbreviations_callback($matches)
{
}
protected function doAbbreviations($text)
{
}
protected function _doAbbreviations_callback($matches)
{
}
}
}
namespace WHMCS\View\Markup\Markdown {
class Markdown extends \Michelf\MarkdownExtra
{
public $no_markup = true;
public $email_friendly = false;
public function __construct()
{
}
public static function defaultTransform($text)
{
}
protected function doHtmlPurifier($text)
{
}
protected function doTextWithBreaks($text)
{
}
protected function doAutoLinks($text)
{
}
protected function _doAutoLinks_url_callback($matches)
{
}
protected function _doAnchors_inline_callback($matches)
{
}
protected function _doImages_reference_callback($matches)
{
}
protected function _doImages_inline_callback($matches)
{
}
protected function _doLinkReplace_callback(array $matches)
{
}
protected function legacyAutoHyperLink($message)
{
}
protected function formParagraphs($text)
{
}
protected function _doFencedCodeBlocks_callback($matches)
{
}
protected function _doTable_callback($matches)
{
}
protected function _doLists_callback($matches)
{
}
}
}
namespace WHMCS\View {
class Template
{
protected static $setting = "Template";
protected static $allTemplates = array();
protected static $defaultTemplate = "six";
protected static $templateDirectory = "templates";
protected static $ignoredTemplateDirectories = array("orderforms");
protected $name = NULL;
protected $config = NULL;
public function __construct($name, \WHMCS\Config\Template $config)
{
}
public static function factory($systemTemplateName = NULL, $sessionTemplateName = NULL, $requestTemplateName = NULL)
{
}
public static function find($name)
{
}
public static function all()
{
}
public static function getDefault()
{
}
public function getName()
{
}
public function getDisplayName()
{
}
public function getConfig()
{
}
public function isDefault()
{
}
}
class Helper
{
const ERROR_TITLE = "Critical Error";
const ERROR_BODY = "Unknown Error";
public static function applicationError($title = self::ERROR_TITLE, $body = self::ERROR_BODY, $exception = NULL)
{
}
public static function generateCssFriendlyId($name, $title = "")
{
}
public static function generateCssFriendlyClassName($value)
{
}
public static function buildTagCloud(array $tags = array())
{
}
public static function alert($text, $alertType = "info", $additionalClasses = "")
{
}
public static function jsGrowlNotification($type, $titleLangKey, $msgLangKey)
{
}
public static function getAssetVersionHash()
{
}
public static function getDomainGroupLabel($group)
{
}
public static function getServerDropdownOptions($selectedServerId = 0)
{
}
}
}
namespace WHMCS\View\Menu\Factory {
class WhmcsExtension implements \Knp\Menu\Factory\ExtensionInterface
{
public function buildOptions(array $options)
{
}
public function buildItem(\Knp\Menu\ItemInterface $item, array $options)
{
}
}
}
namespace WHMCS\View\Menu {
class Item extends \Knp\Menu\MenuItem
{
protected $badge = "";
protected $order = NULL;
protected $disabled = false;
protected $icon = "";
protected $headingHtml = NULL;
protected $bodyHtml = NULL;
protected $footerHtml = NULL;
public function getName()
{
}
public function setName($name)
{
}
public function getUri()
{
}
public function setUri($uri)
{
}
public function getLabel()
{
}
public function setLabel($label)
{
}
public function addChild($child, array $options = array())
{
}
public function getChild($name)
{
}
public function copy()
{
}
public function getLevel()
{
}
public function getRoot()
{
}
public function isRoot()
{
}
public function getParent()
{
}
public function getChildren()
{
}
public function setChildren(array $children)
{
}
public function removeChild($name)
{
}
public function hasChildren()
{
}
public function setBadge($badge)
{
}
public function getBadge()
{
}
public function hasBadge()
{
}
public function setOrder($order)
{
}
public function getOrder()
{
}
public function setClass($cssClassString)
{
}
public function getClass()
{
}
public function disable()
{
}
public function enable()
{
}
public function isDisabled()
{
}
public function getExtras()
{
}
public function getExtra($name, $default = NULL)
{
}
public function setExtras(array $extras)
{
}
public function setExtra($name, $value)
{
}
protected function isFontAwesomeIcon($icon)
{
}
protected function isGlyphicon($icon)
{
}
public function setIcon($icon)
{
}
public function getIcon()
{
}
public function hasIcon()
{
}
public function hasFontAwesomeIcon()
{
}
public function hasGlyphicon()
{
}
public function getBodyHtml()
{
}
public function setBodyHtml($html)
{
}
public function hasBodyHtml()
{
}
public function getFooterHtml()
{
}
public function setFooterHtml($html)
{
}
public function hasFooterHtml()
{
}
public function getHeadingHtml()
{
}
public function setHeadingHtml($html)
{
}
public function hasHeadingHtml()
{
}
public function getId()
{
}
public static function sort(\WHMCS\View\Menu\Item $menu, $sortChildren = true)
{
}
protected function swapOrder($swapOrder)
{
}
public function moveUp()
{
}
public function moveDown()
{
}
public function moveToFront()
{
}
public function moveToBack()
{
}
}
}
namespace WHMCS\View\Engine {
interface VariableAccessorInterface
{
public function assign($tpl_var, $value, $nocache);
}
}
namespace WHMCS\View\Engine\Php {
abstract class AbstractPlatesEngine extends \League\Plates\Engine implements \WHMCS\View\Engine\VariableAccessorInterface
{
public function __construct($directory = NULL, $fileExtension = "php")
{
}
public function getDefaultVariables()
{
}
public function assign($tpl_var, $value = NULL, $nocache = false)
{
}
}
class Admin extends \WHMCS\View\Engine\Php\AbstractPlatesEngine
{
}
}
namespace {
/**
* Smarty Internal Plugin Data
* This file contains the basic classes and methods for template and variable creation
*
* @package Smarty
* @subpackage Template
* @author Uwe Tews
*/
/**
* Base class with template and variable methods
*
* @package Smarty
* @subpackage Template
*
* @property int $scope
* @property Smarty $smarty
* The following methods will be dynamically loaded by the extension handler when they are called.
* They are located in a corresponding Smarty_Internal_Method_xxxx class
*
* @method mixed _getConfigVariable(string $varName, bool $errorEnable = true)
* @method mixed getConfigVariable(string $varName, bool $errorEnable = true)
* @method mixed getConfigVars(string $varName = null, bool $searchParents = true)
* @method mixed getGlobal(string $varName = null)
* @method mixed getStreamVariable(string $variable)
* @method Smarty_Internal_Data clearAssign(mixed $tpl_var)
* @method Smarty_Internal_Data clearAllAssign()
* @method Smarty_Internal_Data clearConfig(string $varName = null)
* @method Smarty_Internal_Data configLoad(string $config_file, mixed $sections = null, string $scope = 'local')
*/
abstract class Smarty_Internal_Data
{
/**
* This object type (Smarty = 1, template = 2, data = 4)
*
* @var int
*/
public $_objType = 4;
/**
* name of class used for templates
*
* @var string
*/
public $template_class = 'Smarty_Internal_Template';
/**
* template variables
*
* @var Smarty_Variable[]
*/
public $tpl_vars = array();
/**
* parent template (if any)
*
* @var Smarty|Smarty_Internal_Template|Smarty_Data
*/
public $parent = \null;
/**
* configuration settings
*
* @var string[]
*/
public $config_vars = array();
/**
* extension handler
*
* @var Smarty_Internal_Extension_Handler
*/
public $ext = \null;
/**
* Smarty_Internal_Data constructor.
*
* Install extension handler
*/
public function __construct()
{
}
/**
* assigns a Smarty variable
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value the value to assign
* @param boolean $nocache if true any output of this variable will be not cached
*
* @return Smarty_Internal_Data current Smarty_Internal_Data (or Smarty or Smarty_Internal_Template) instance for
* chaining
*/
public function assign($tpl_var, $value = \null, $nocache = \false)
{
}
/**
* appends values to template variables
*
* @api Smarty::append()
* @link http://www.smarty.net/docs/en/api.append.tpl
*
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value the value to append
* @param bool $merge flag if array elements shall be merged
* @param bool $nocache if true any output of this variable will
* be not cached
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public function append($tpl_var, $value = \null, $merge = \false, $nocache = \false)
{
}
/**
* assigns a global Smarty variable
*
* @param string $varName the global variable name
* @param mixed $value the value to assign
* @param boolean $nocache if true any output of this variable will be not cached
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public function assignGlobal($varName, $value = \null, $nocache = \false)
{
}
/**
* appends values to template variables by reference
*
* @param string $tpl_var the template variable name
* @param mixed &$value the referenced value to append
* @param boolean $merge flag if array elements shall be merged
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public function appendByRef($tpl_var, &$value, $merge = \false)
{
}
/**
* assigns values to template variables by reference
*
* @param string $tpl_var the template variable name
* @param $value
* @param boolean $nocache if true any output of this variable will be not cached
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public function assignByRef($tpl_var, &$value, $nocache = \false)
{
}
/**
* Returns a single or all template variables
*
* @api Smarty::getTemplateVars()
* @link http://www.smarty.net/docs/en/api.get.template.vars.tpl
*
* @param string $varName variable name or null
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $_ptr optional pointer to data object
* @param bool $searchParents include parent templates?
*
* @return mixed variable value or or array of variables
*/
public function getTemplateVars($varName = \null, \Smarty_Internal_Data $_ptr = \null, $searchParents = \true)
{
}
/**
* gets the object of a Smarty variable
*
* @param string $variable the name of the Smarty variable
* @param Smarty_Internal_Data $_ptr optional pointer to data object
* @param boolean $searchParents search also in parent data
* @param bool $error_enable
*
* @return Smarty_Variable|Smarty_Undefined_Variable the object of the variable
* @deprecated since 3.1.28 please use Smarty_Internal_Data::getTemplateVars() instead.
*/
public function getVariable($variable = \null, \Smarty_Internal_Data $_ptr = \null, $searchParents = \true, $error_enable = \true)
{
}
/**
* Follow the parent chain an merge template and config variables
*
* @param \Smarty_Internal_Data|null $data
*/
public function _mergeVars(\Smarty_Internal_Data $data = \null)
{
}
/**
* Return true if this instance is a Data obj
*
* @return bool
*/
public function _isDataObj()
{
}
/**
* Return true if this instance is a template obj
*
* @return bool
*/
public function _isTplObj()
{
}
/**
* Return true if this instance is a Smarty obj
*
* @return bool
*/
public function _isSmartyObj()
{
}
/**
* Get Smarty object
*
* @return Smarty
*/
public function _getSmartyObj()
{
}
/**
* Handle unknown class methods
*
* @param string $name unknown method-name
* @param array $args argument array
*
* @return mixed
*/
public function __call($name, $args)
{
}
}
/**
* Smarty Internal Plugin Smarty Template Base
* This file contains the basic shared methods for template handling
*
* @package Smarty
* @subpackage Template
* @author Uwe Tews
*/
/**
* Class with shared smarty/template methods
*
* @package Smarty
* @subpackage Template
*
* @property int $_objType
*
* The following methods will be dynamically loaded by the extension handler when they are called.
* They are located in a corresponding Smarty_Internal_Method_xxxx class
*
* @method Smarty_Internal_TemplateBase addAutoloadFilters(mixed $filters, string $type = null)
* @method Smarty_Internal_TemplateBase addDefaultModifiers(mixed $modifiers)
* @method Smarty_Internal_TemplateBase addLiterals(mixed $literals)
* @method Smarty_Internal_TemplateBase createData(Smarty_Internal_Data $parent = null, string $name = null)
* @method array getAutoloadFilters(string $type = null)
* @method string getDebugTemplate()
* @method array getDefaultModifier()
* @method array getLiterals()
* @method array getTags(mixed $template = null)
* @method object getRegisteredObject(string $object_name)
* @method Smarty_Internal_TemplateBase registerCacheResource(string $name, Smarty_CacheResource $resource_handler)
* @method Smarty_Internal_TemplateBase registerClass(string $class_name, string $class_impl)
* @method Smarty_Internal_TemplateBase registerDefaultConfigHandler(callback $callback)
* @method Smarty_Internal_TemplateBase registerDefaultPluginHandler(callback $callback)
* @method Smarty_Internal_TemplateBase registerDefaultTemplateHandler(callback $callback)
* @method Smarty_Internal_TemplateBase registerResource(string $name, mixed $resource_handler)
* @method Smarty_Internal_TemplateBase setAutoloadFilters(mixed $filters, string $type = null)
* @method Smarty_Internal_TemplateBase setDebugTemplate(string $tpl_name)
* @method Smarty_Internal_TemplateBase setDefaultModifiers(mixed $modifiers)
* @method Smarty_Internal_TemplateBase setLiterals(mixed $literals)
* @method Smarty_Internal_TemplateBase unloadFilter(string $type, string $name)
* @method Smarty_Internal_TemplateBase unregisterCacheResource(string $name)
* @method Smarty_Internal_TemplateBase unregisterObject(string $object_name)
* @method Smarty_Internal_TemplateBase unregisterPlugin(string $type, string $name)
* @method Smarty_Internal_TemplateBase unregisterFilter(string $type, mixed $callback)
* @method Smarty_Internal_TemplateBase unregisterResource(string $name)
*/
abstract class Smarty_Internal_TemplateBase extends \Smarty_Internal_Data
{
/**
* Set this if you want different sets of cache files for the same
* templates.
*
* @var string
*/
public $cache_id = \null;
/**
* Set this if you want different sets of compiled files for the same
* templates.
*
* @var string
*/
public $compile_id = \null;
/**
* caching enabled
*
* @var int
*/
public $caching = \Smarty::CACHING_OFF;
/**
* check template for modifications?
*
* @var int
*/
public $compile_check = \Smarty::COMPILECHECK_ON;
/**
* cache lifetime in seconds
*
* @var integer
*/
public $cache_lifetime = 3600;
/**
* Array of source information for known template functions
*
* @var array
*/
public $tplFunctions = array();
/**
* universal cache
*
* @var array()
*/
public $_cache = array();
/**
* fetches a rendered Smarty template
*
* @param string $template the resource handle of the template file or template object
* @param mixed $cache_id cache id to be used with this template
* @param mixed $compile_id compile id to be used with this template
* @param object $parent next higher level of Smarty variables
*
* @throws Exception
* @throws SmartyException
* @return string rendered template output
*/
public function fetch($template = \null, $cache_id = \null, $compile_id = \null, $parent = \null)
{
}
/**
* displays a Smarty template
*
* @param string $template the resource handle of the template file or template object
* @param mixed $cache_id cache id to be used with this template
* @param mixed $compile_id compile id to be used with this template
* @param object $parent next higher level of Smarty variables
*
* @throws \Exception
* @throws \SmartyException
*/
public function display($template = \null, $cache_id = \null, $compile_id = \null, $parent = \null)
{
}
/**
* test if cache is valid
*
* @api Smarty::isCached()
* @link http://www.smarty.net/docs/en/api.is.cached.tpl
*
* @param null|string|\Smarty_Internal_Template $template the resource handle of the template file or template
* object
* @param mixed $cache_id cache id to be used with this template
* @param mixed $compile_id compile id to be used with this template
* @param object $parent next higher level of Smarty variables
*
* @return bool cache status
* @throws \Exception
* @throws \SmartyException
*/
public function isCached($template = \null, $cache_id = \null, $compile_id = \null, $parent = \null)
{
}
/**
* Registers plugin to be used in templates
*
* @api Smarty::registerPlugin()
* @link http://www.smarty.net/docs/en/api.register.plugin.tpl
*
* @param string $type plugin type
* @param string $name name of template tag
* @param callback $callback PHP callback to register
* @param bool $cacheable if true (default) this function is cache able
* @param mixed $cache_attr caching attributes if any
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function registerPlugin($type, $name, $callback, $cacheable = \true, $cache_attr = \null)
{
}
/**
* load a filter of specified type and name
*
* @api Smarty::loadFilter()
* @link http://www.smarty.net/docs/en/api.load.filter.tpl
*
* @param string $type filter type
* @param string $name filter name
*
* @return bool
* @throws \SmartyException
*/
public function loadFilter($type, $name)
{
}
/**
* Registers a filter function
*
* @api Smarty::registerFilter()
* @link http://www.smarty.net/docs/en/api.register.filter.tpl
*
* @param string $type filter type
* @param callback $callback
* @param string|null $name optional filter name
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function registerFilter($type, $callback, $name = \null)
{
}
/**
* Registers object to be used in templates
*
* @api Smarty::registerObject()
* @link http://www.smarty.net/docs/en/api.register.object.tpl
*
* @param string $object_name
* @param object $object the referenced PHP object to register
* @param array $allowed_methods_properties list of allowed methods (empty = all)
* @param bool $format smarty argument format, else traditional
* @param array $block_methods list of block-methods
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function registerObject($object_name, $object, $allowed_methods_properties = array(), $format = \true, $block_methods = array())
{
}
/**
* @param int $compile_check
*/
public function setCompileCheck($compile_check)
{
}
/**
* @param int $caching
*/
public function setCaching($caching)
{
}
/**
* @param int $cache_lifetime
*/
public function setCacheLifetime($cache_lifetime)
{
}
/**
* @param string $compile_id
*/
public function setCompileId($compile_id)
{
}
/**
* @param string $cache_id
*/
public function setCacheId($cache_id)
{
}
}
/**
* This is the main Smarty class
*
* @package Smarty
*
* The following methods will be dynamically loaded by the extension handler when they are called.
* They are located in a corresponding Smarty_Internal_Method_xxxx class
*
* @method int clearAllCache(int $exp_time = null, string $type = null)
* @method int clearCache(string $template_name, string $cache_id = null, string $compile_id = null, int $exp_time = null, string $type = null)
* @method int compileAllTemplates(string $extension = '.tpl', bool $force_compile = false, int $time_limit = 0, $max_errors = null)
* @method int compileAllConfig(string $extension = '.conf', bool $force_compile = false, int $time_limit = 0, $max_errors = null)
* @method int clearCompiledTemplate($resource_name = null, $compile_id = null, $exp_time = null)
*/
class Smarty extends \Smarty_Internal_TemplateBase
{
/**
* smarty version
*/
const SMARTY_VERSION = '3.1.33-p1';
/**
* define variable scopes
*/
const SCOPE_LOCAL = 1;
const SCOPE_PARENT = 2;
const SCOPE_TPL_ROOT = 4;
const SCOPE_ROOT = 8;
const SCOPE_SMARTY = 16;
const SCOPE_GLOBAL = 32;
/**
* define caching modes
*/
const CACHING_OFF = 0;
const CACHING_LIFETIME_CURRENT = 1;
const CACHING_LIFETIME_SAVED = 2;
/**
* define constant for clearing cache files be saved expiration dates
*/
const CLEAR_EXPIRED = -1;
/**
* define compile check modes
*/
const COMPILECHECK_OFF = 0;
const COMPILECHECK_ON = 1;
const COMPILECHECK_CACHEMISS = 2;
/**
* define debug modes
*/
const DEBUG_OFF = 0;
const DEBUG_ON = 1;
const DEBUG_INDIVIDUAL = 2;
/**
* modes for handling of "<?php ... ?>" tags in templates.
*/
const PHP_PASSTHRU = 0;
//-> print tags as plain text
const PHP_QUOTE = 1;
//-> escape tags as entities
const PHP_REMOVE = 2;
//-> escape tags as entities
const PHP_ALLOW = 3;
//-> escape tags as entities
/**
* filter types
*/
const FILTER_POST = 'post';
const FILTER_PRE = 'pre';
const FILTER_OUTPUT = 'output';
const FILTER_VARIABLE = 'variable';
/**
* plugin types
*/
const PLUGIN_FUNCTION = 'function';
const PLUGIN_BLOCK = 'block';
const PLUGIN_COMPILER = 'compiler';
const PLUGIN_MODIFIER = 'modifier';
const PLUGIN_MODIFIERCOMPILER = 'modifiercompiler';
/**
* assigned global tpl vars
*/
public static $global_tpl_vars = array();
/**
* Flag denoting if Multibyte String functions are available
*/
public static $_MBSTRING = \SMARTY_MBSTRING;
/**
* The character set to adhere to (e.g. "UTF-8")
*/
public static $_CHARSET = \SMARTY_RESOURCE_CHAR_SET;
/**
* The date format to be used internally
* (accepts date() and strftime())
*/
public static $_DATE_FORMAT = \SMARTY_RESOURCE_DATE_FORMAT;
/**
* Flag denoting if PCRE should run in UTF-8 mode
*/
public static $_UTF8_MODIFIER = 'u';
/**
* Flag denoting if operating system is windows
*/
public static $_IS_WINDOWS = \false;
/**
* auto literal on delimiters with whitespace
*
* @var boolean
*/
public $auto_literal = \true;
/**
* display error on not assigned variables
*
* @var boolean
*/
public $error_unassigned = \false;
/**
* look up relative file path in include_path
*
* @var boolean
*/
public $use_include_path = \false;
/**
* flag if template_dir is normalized
*
* @var bool
*/
public $_templateDirNormalized = \false;
/**
* joined template directory string used in cache keys
*
* @var string
*/
public $_joined_template_dir = \null;
/**
* flag if config_dir is normalized
*
* @var bool
*/
public $_configDirNormalized = \false;
/**
* joined config directory string used in cache keys
*
* @var string
*/
public $_joined_config_dir = \null;
/**
* default template handler
*
* @var callable
*/
public $default_template_handler_func = \null;
/**
* default config handler
*
* @var callable
*/
public $default_config_handler_func = \null;
/**
* default plugin handler
*
* @var callable
*/
public $default_plugin_handler_func = \null;
/**
* flag if template_dir is normalized
*
* @var bool
*/
public $_compileDirNormalized = \false;
/**
* flag if plugins_dir is normalized
*
* @var bool
*/
public $_pluginsDirNormalized = \false;
/**
* flag if template_dir is normalized
*
* @var bool
*/
public $_cacheDirNormalized = \false;
/**
* force template compiling?
*
* @var boolean
*/
public $force_compile = \false;
/**
* use sub dirs for compiled/cached files?
*
* @var boolean
*/
public $use_sub_dirs = \false;
/**
* allow ambiguous resources (that are made unique by the resource handler)
*
* @var boolean
*/
public $allow_ambiguous_resources = \false;
/**
* merge compiled includes
*
* @var boolean
*/
public $merge_compiled_includes = \false;
/*
* flag for behaviour when extends: resource and {extends} tag are used simultaneous
* if false disable execution of {extends} in templates called by extends resource.
* (behaviour as versions < 3.1.28)
*
* @var boolean
*/
public $extends_recursion = \true;
/**
* force cache file creation
*
* @var boolean
*/
public $force_cache = \false;
/**
* template left-delimiter
*
* @var string
*/
public $left_delimiter = "{";
/**
* template right-delimiter
*
* @var string
*/
public $right_delimiter = "}";
/**
* array of strings which shall be treated as literal by compiler
*
* @var array string
*/
public $literals = array();
/**
* class name
* This should be instance of Smarty_Security.
*
* @var string
* @see Smarty_Security
*/
public $security_class = 'Smarty_Security';
/**
* implementation of security class
*
* @var Smarty_Security
*/
public $security_policy = \null;
/**
* controls handling of PHP-blocks
*
* @var integer
*/
public $php_handling = self::PHP_PASSTHRU;
/**
* controls if the php template file resource is allowed
*
* @var bool
*/
public $allow_php_templates = \false;
/**
* debug mode
* Setting this to true enables the debug-console.
*
* @var boolean
*/
public $debugging = \false;
/**
* This determines if debugging is enable-able from the browser.
* <ul>
* <li>NONE => no debugging control allowed</li>
* <li>URL => enable debugging when SMARTY_DEBUG is found in the URL.</li>
* </ul>
*
* @var string
*/
public $debugging_ctrl = 'NONE';
/**
* Name of debugging URL-param.
* Only used when $debugging_ctrl is set to 'URL'.
* The name of the URL-parameter that activates debugging.
*
* @var string
*/
public $smarty_debug_id = 'SMARTY_DEBUG';
/**
* Path of debug template.
*
* @var string
*/
public $debug_tpl = \null;
/**
* When set, smarty uses this value as error_reporting-level.
*
* @var int
*/
public $error_reporting = \null;
/**
* Controls whether variables with the same name overwrite each other.
*
* @var boolean
*/
public $config_overwrite = \true;
/**
* Controls whether config values of on/true/yes and off/false/no get converted to boolean.
*
* @var boolean
*/
public $config_booleanize = \true;
/**
* Controls whether hidden config sections/vars are read from the file.
*
* @var boolean
*/
public $config_read_hidden = \false;
/**
* locking concurrent compiles
*
* @var boolean
*/
public $compile_locking = \true;
/**
* Controls whether cache resources should use locking mechanism
*
* @var boolean
*/
public $cache_locking = \false;
/**
* seconds to wait for acquiring a lock before ignoring the write lock
*
* @var float
*/
public $locking_timeout = 10;
/**
* resource type used if none given
* Must be an valid key of $registered_resources.
*
* @var string
*/
public $default_resource_type = 'file';
/**
* caching type
* Must be an element of $cache_resource_types.
*
* @var string
*/
public $caching_type = 'file';
/**
* config type
*
* @var string
*/
public $default_config_type = 'file';
/**
* check If-Modified-Since headers
*
* @var boolean
*/
public $cache_modified_check = \false;
/**
* registered plugins
*
* @var array
*/
public $registered_plugins = array();
/**
* registered objects
*
* @var array
*/
public $registered_objects = array();
/**
* registered classes
*
* @var array
*/
public $registered_classes = array();
/**
* registered filters
*
* @var array
*/
public $registered_filters = array();
/**
* registered resources
*
* @var array
*/
public $registered_resources = array();
/**
* registered cache resources
*
* @var array
*/
public $registered_cache_resources = array();
/**
* autoload filter
*
* @var array
*/
public $autoload_filters = array();
/**
* default modifier
*
* @var array
*/
public $default_modifiers = array();
/**
* autoescape variable output
*
* @var boolean
*/
public $escape_html = \false;
/**
* start time for execution time calculation
*
* @var int
*/
public $start_time = 0;
/**
* required by the compiler for BC
*
* @var string
*/
public $_current_file = \null;
/**
* internal flag to enable parser debugging
*
* @var bool
*/
public $_parserdebug = \false;
/**
* This object type (Smarty = 1, template = 2, data = 4)
*
* @var int
*/
public $_objType = 1;
/**
* Debug object
*
* @var Smarty_Internal_Debug
*/
public $_debug = \null;
/**
* template directory
*
* @var array
*/
protected $template_dir = array('./templates/');
/**
* flags for normalized template directory entries
*
* @var array
*/
protected $_processedTemplateDir = array();
/**
* config directory
*
* @var array
*/
protected $config_dir = array('./configs/');
/**
* flags for normalized template directory entries
*
* @var array
*/
protected $_processedConfigDir = array();
/**
* compile directory
*
* @var string
*/
protected $compile_dir = './templates_c/';
/**
* plugins directory
*
* @var array
*/
protected $plugins_dir = array();
/**
* cache directory
*
* @var string
*/
protected $cache_dir = './cache/';
/**
* removed properties
*
* @var string[]
*/
protected $obsoleteProperties = array('resource_caching', 'template_resource_caching', 'direct_access_security', '_dir_perms', '_file_perms', 'plugin_search_order', 'inheritance_merge_compiled_includes', 'resource_cache_mode');
/**
* List of private properties which will call getter/setter on a direct access
*
* @var string[]
*/
protected $accessMap = array('template_dir' => 'TemplateDir', 'config_dir' => 'ConfigDir', 'plugins_dir' => 'PluginsDir', 'compile_dir' => 'CompileDir', 'cache_dir' => 'CacheDir');
/**
* Initialize new Smarty object
*/
public function __construct()
{
}
/**
* Enable error handler to mute expected messages
*
* @return boolean
* @deprecated
*/
public static function muteExpectedErrors()
{
}
/**
* Disable error handler muting expected messages
*
* @deprecated
*/
public static function unmuteExpectedErrors()
{
}
/**
* Check if a template resource exists
*
* @param string $resource_name template name
*
* @return bool status
* @throws \SmartyException
*/
public function templateExists($resource_name)
{
}
/**
* Loads security class and enables security
*
* @param string|Smarty_Security $security_class if a string is used, it must be class-name
*
* @return Smarty current Smarty instance for chaining
* @throws \SmartyException
*/
public function enableSecurity($security_class = \null)
{
}
/**
* Disable security
*
* @return Smarty current Smarty instance for chaining
*/
public function disableSecurity()
{
}
/**
* Add template directory(s)
*
* @param string|array $template_dir directory(s) of template sources
* @param string $key of the array element to assign the template dir to
* @param bool $isConfig true for config_dir
*
* @return Smarty current Smarty instance for chaining
*/
public function addTemplateDir($template_dir, $key = \null, $isConfig = \false)
{
}
/**
* Get template directories
*
* @param mixed $index index of directory to get, null to get all
* @param bool $isConfig true for config_dir
*
* @return array list of template directories, or directory of $index
*/
public function getTemplateDir($index = \null, $isConfig = \false)
{
}
/**
* Set template directory
*
* @param string|array $template_dir directory(s) of template sources
* @param bool $isConfig true for config_dir
*
* @return \Smarty current Smarty instance for chaining
*/
public function setTemplateDir($template_dir, $isConfig = \false)
{
}
/**
* Add config directory(s)
*
* @param string|array $config_dir directory(s) of config sources
* @param mixed $key key of the array element to assign the config dir to
*
* @return Smarty current Smarty instance for chaining
*/
public function addConfigDir($config_dir, $key = \null)
{
}
/**
* Get config directory
*
* @param mixed $index index of directory to get, null to get all
*
* @return array configuration directory
*/
public function getConfigDir($index = \null)
{
}
/**
* Set config directory
*
* @param $config_dir
*
* @return Smarty current Smarty instance for chaining
*/
public function setConfigDir($config_dir)
{
}
/**
* Adds directory of plugin files
*
* @param null|array|string $plugins_dir
*
* @return Smarty current Smarty instance for chaining
*/
public function addPluginsDir($plugins_dir)
{
}
/**
* Get plugin directories
*
* @return array list of plugin directories
*/
public function getPluginsDir()
{
}
/**
* Set plugins directory
*
* @param string|array $plugins_dir directory(s) of plugins
*
* @return Smarty current Smarty instance for chaining
*/
public function setPluginsDir($plugins_dir)
{
}
/**
* Get compiled directory
*
* @return string path to compiled templates
*/
public function getCompileDir()
{
}
/**
*
* @param string $compile_dir directory to store compiled templates in
*
* @return Smarty current Smarty instance for chaining
*/
public function setCompileDir($compile_dir)
{
}
/**
* Get cache directory
*
* @return string path of cache directory
*/
public function getCacheDir()
{
}
/**
* Set cache directory
*
* @param string $cache_dir directory to store cached templates in
*
* @return Smarty current Smarty instance for chaining
*/
public function setCacheDir($cache_dir)
{
}
/**
* creates a template object
*
* @param string $template the resource handle of the template file
* @param mixed $cache_id cache id to be used with this template
* @param mixed $compile_id compile id to be used with this template
* @param object $parent next higher level of Smarty variables
* @param boolean $do_clone flag is Smarty object shall be cloned
*
* @return \Smarty_Internal_Template template object
* @throws \SmartyException
*/
public function createTemplate($template, $cache_id = \null, $compile_id = \null, $parent = \null, $do_clone = \true)
{
}
/**
* Takes unknown classes and loads plugin files for them
* class name format: Smarty_PluginType_PluginName
* plugin filename format: plugintype.pluginname.php
*
* @param string $plugin_name class plugin name to load
* @param bool $check check if already loaded
*
* @return string |boolean filepath of loaded file or false
* @throws \SmartyException
*/
public function loadPlugin($plugin_name, $check = \true)
{
}
/**
* Get unique template id
*
* @param string $template_name
* @param null|mixed $cache_id
* @param null|mixed $compile_id
* @param null $caching
* @param \Smarty_Internal_Template $template
*
* @return string
* @throws \SmartyException
*/
public function _getTemplateId($template_name, $cache_id = \null, $compile_id = \null, $caching = \null, \Smarty_Internal_Template $template = \null)
{
}
/**
* Normalize path
* - remove /./ and /../
* - make it absolute if required
*
* @param string $path file path
* @param bool $realpath if true - convert to absolute
* false - convert to relative
* null - keep as it is but
* remove /./ /../
*
* @return string
*/
public function _realpath($path, $realpath = \null)
{
}
/**
* Empty template objects cache
*/
public function _clearTemplateCache()
{
}
/**
* @param boolean $use_sub_dirs
*/
public function setUseSubDirs($use_sub_dirs)
{
}
/**
* @param int $error_reporting
*/
public function setErrorReporting($error_reporting)
{
}
/**
* @param boolean $escape_html
*/
public function setEscapeHtml($escape_html)
{
}
/**
* Return auto_literal flag
*
* @return boolean
*/
public function getAutoLiteral()
{
}
/**
* Set auto_literal flag
*
* @param boolean $auto_literal
*/
public function setAutoLiteral($auto_literal = \true)
{
}
/**
* @param boolean $force_compile
*/
public function setForceCompile($force_compile)
{
}
/**
* @param boolean $merge_compiled_includes
*/
public function setMergeCompiledIncludes($merge_compiled_includes)
{
}
/**
* Get left delimiter
*
* @return string
*/
public function getLeftDelimiter()
{
}
/**
* Set left delimiter
*
* @param string $left_delimiter
*/
public function setLeftDelimiter($left_delimiter)
{
}
/**
* Get right delimiter
*
* @return string $right_delimiter
*/
public function getRightDelimiter()
{
}
/**
* Set right delimiter
*
* @param string
*/
public function setRightDelimiter($right_delimiter)
{
}
/**
* @param boolean $debugging
*/
public function setDebugging($debugging)
{
}
/**
* @param boolean $config_overwrite
*/
public function setConfigOverwrite($config_overwrite)
{
}
/**
* @param boolean $config_booleanize
*/
public function setConfigBooleanize($config_booleanize)
{
}
/**
* @param boolean $config_read_hidden
*/
public function setConfigReadHidden($config_read_hidden)
{
}
/**
* @param boolean $compile_locking
*/
public function setCompileLocking($compile_locking)
{
}
/**
* @param string $default_resource_type
*/
public function setDefaultResourceType($default_resource_type)
{
}
/**
* @param string $caching_type
*/
public function setCachingType($caching_type)
{
}
/**
* Test install
*
* @param null $errors
*/
public function testInstall(&$errors = \null)
{
}
/**
* Get Smarty object
*
* @return Smarty
*/
public function _getSmartyObj()
{
}
/**
* <<magic>> Generic getter.
* Calls the appropriate getter function.
* Issues an E_USER_NOTICE if no valid getter is found.
*
* @param string $name property name
*
* @return mixed
*/
public function __get($name)
{
}
/**
* <<magic>> Generic setter.
* Calls the appropriate setter function.
* Issues an E_USER_NOTICE if no valid setter is found.
*
* @param string $name property name
* @param mixed $value parameter passed to setter
*
*/
public function __set($name, $value)
{
}
}
/**
* Smarty Backward Compatibility Wrapper Class
*
* @package Smarty
*/
class SmartyBC extends \Smarty
{
/**
* Smarty 2 BC
*
* @var string
*/
public $_version = self::SMARTY_VERSION;
/**
* This is an array of directories where trusted php scripts reside.
*
* @var array
*/
public $trusted_dir = array();
/**
* Initialize new SmartyBC object
*/
public function __construct()
{
}
/**
* wrapper for assign_by_ref
*
* @param string $tpl_var the template variable name
* @param mixed &$value the referenced value to assign
*/
public function assign_by_ref($tpl_var, &$value)
{
}
/**
* wrapper for append_by_ref
*
* @param string $tpl_var the template variable name
* @param mixed &$value the referenced value to append
* @param boolean $merge flag if array elements shall be merged
*/
public function append_by_ref($tpl_var, &$value, $merge = \false)
{
}
/**
* clear the given assigned template variable.
*
* @param string $tpl_var the template variable to clear
*/
public function clear_assign($tpl_var)
{
}
/**
* Registers custom function to be used in templates
*
* @param string $function the name of the template function
* @param string $function_impl the name of the PHP function to register
* @param bool $cacheable
* @param mixed $cache_attrs
*
* @throws \SmartyException
*/
public function register_function($function, $function_impl, $cacheable = \true, $cache_attrs = \null)
{
}
/**
* Unregister custom function
*
* @param string $function name of template function
*/
public function unregister_function($function)
{
}
/**
* Registers object to be used in templates
*
* @param string $object name of template object
* @param object $object_impl the referenced PHP object to register
* @param array $allowed list of allowed methods (empty = all)
* @param boolean $smarty_args smarty argument format, else traditional
* @param array $block_methods list of methods that are block format
*
* @throws SmartyException
* @internal param array $block_functs list of methods that are block format
*/
public function register_object($object, $object_impl, $allowed = array(), $smarty_args = \true, $block_methods = array())
{
}
/**
* Unregister object
*
* @param string $object name of template object
*/
public function unregister_object($object)
{
}
/**
* Registers block function to be used in templates
*
* @param string $block name of template block
* @param string $block_impl PHP function to register
* @param bool $cacheable
* @param mixed $cache_attrs
*
* @throws \SmartyException
*/
public function register_block($block, $block_impl, $cacheable = \true, $cache_attrs = \null)
{
}
/**
* Unregister block function
*
* @param string $block name of template function
*/
public function unregister_block($block)
{
}
/**
* Registers compiler function
*
* @param string $function name of template function
* @param string $function_impl name of PHP function to register
* @param bool $cacheable
*
* @throws \SmartyException
*/
public function register_compiler_function($function, $function_impl, $cacheable = \true)
{
}
/**
* Unregister compiler function
*
* @param string $function name of template function
*/
public function unregister_compiler_function($function)
{
}
/**
* Registers modifier to be used in templates
*
* @param string $modifier name of template modifier
* @param string $modifier_impl name of PHP function to register
*
* @throws \SmartyException
*/
public function register_modifier($modifier, $modifier_impl)
{
}
/**
* Unregister modifier
*
* @param string $modifier name of template modifier
*/
public function unregister_modifier($modifier)
{
}
/**
* Registers a resource to fetch a template
*
* @param string $type name of resource
* @param array $functions array of functions to handle resource
*/
public function register_resource($type, $functions)
{
}
/**
* Unregister a resource
*
* @param string $type name of resource
*/
public function unregister_resource($type)
{
}
/**
* Registers a prefilter function to apply
* to a template before compiling
*
* @param callable $function
*
* @throws \SmartyException
*/
public function register_prefilter($function)
{
}
/**
* Unregister a prefilter function
*
* @param callable $function
*/
public function unregister_prefilter($function)
{
}
/**
* Registers a postfilter function to apply
* to a compiled template after compilation
*
* @param callable $function
*
* @throws \SmartyException
*/
public function register_postfilter($function)
{
}
/**
* Unregister a postfilter function
*
* @param callable $function
*/
public function unregister_postfilter($function)
{
}
/**
* Registers an output filter function to apply
* to a template output
*
* @param callable $function
*
* @throws \SmartyException
*/
public function register_outputfilter($function)
{
}
/**
* Unregister an outputfilter function
*
* @param callable $function
*/
public function unregister_outputfilter($function)
{
}
/**
* load a filter of specified type and name
*
* @param string $type filter type
* @param string $name filter name
*
* @throws \SmartyException
*/
public function load_filter($type, $name)
{
}
/**
* clear cached content for the given template and cache id
*
* @param string $tpl_file name of template file
* @param string $cache_id name of cache_id
* @param string $compile_id name of compile_id
* @param string $exp_time expiration time
*
* @return boolean
*/
public function clear_cache($tpl_file = \null, $cache_id = \null, $compile_id = \null, $exp_time = \null)
{
}
/**
* clear the entire contents of cache (all templates)
*
* @param string $exp_time expire time
*
* @return boolean
*/
public function clear_all_cache($exp_time = \null)
{
}
/**
* test to see if valid cache exists for this template
*
* @param string $tpl_file name of template file
* @param string $cache_id
* @param string $compile_id
*
* @return bool
* @throws \Exception
* @throws \SmartyException
*/
public function is_cached($tpl_file, $cache_id = \null, $compile_id = \null)
{
}
/**
* clear all the assigned template variables.
*/
public function clear_all_assign()
{
}
/**
* clears compiled version of specified template resource,
* or all compiled template files if one is not specified.
* This function is for advanced use only, not normally needed.
*
* @param string $tpl_file
* @param string $compile_id
* @param string $exp_time
*
* @return boolean results of {@link smarty_core_rm_auto()}
*/
public function clear_compiled_tpl($tpl_file = \null, $compile_id = \null, $exp_time = \null)
{
}
/**
* Checks whether requested template exists.
*
* @param string $tpl_file
*
* @return bool
* @throws \SmartyException
*/
public function template_exists($tpl_file)
{
}
/**
* Returns an array containing template variables
*
* @param string $name
*
* @return array
*/
public function get_template_vars($name = \null)
{
}
/**
* Returns an array containing config variables
*
* @param string $name
*
* @return array
*/
public function get_config_vars($name = \null)
{
}
/**
* load configuration values
*
* @param string $file
* @param string $section
* @param string $scope
*/
public function config_load($file, $section = \null, $scope = 'global')
{
}
/**
* return a reference to a registered object
*
* @param string $name
*
* @return object
*/
public function get_registered_object($name)
{
}
/**
* clear configuration values
*
* @param string $var
*/
public function clear_config($var = \null)
{
}
/**
* trigger Smarty error
*
* @param string $error_msg
* @param integer $error_type
*/
public function trigger_error($error_msg, $error_type = \E_USER_WARNING)
{
}
}
}
namespace WHMCS {
class Smarty extends \SmartyBC
{
public function __construct($admin = false, $policyName = NULL)
{
}
protected function setMbStringMode()
{
}
public function trigger_error($error_msg, $error_type = E_USER_WARNING)
{
}
public function clearAllCaches()
{
}
public static function sprintf2Modifier($string, $arg1, $arg2 = "", $arg3 = "", $arg4 = "")
{
}
public static function langFunction($params)
{
}
public function fetch($template = NULL, $cache_id = NULL, $compile_id = NULL, $parent = NULL, $display = false, $merge_tpl_vars = true, $no_output_filter = false)
{
}
public function setMailMessage(\WHMCS\Mail\Message $message)
{
}
public static function preFilterSmartyTemplateVariableScopeResolution($source, \Smarty_Internal_Template $internal_Template)
{
}
}
}
namespace WHMCS\View\Engine\Smarty {
class Admin extends \WHMCS\Smarty implements \WHMCS\View\Engine\VariableAccessorInterface
{
public function __construct($admin = true, $policyName = NULL)
{
}
}
}
namespace WHMCS\View {
class ViewServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider
{
public function register()
{
}
}
class HtmlErrorPage
{
public $title = "Oops!";
public $body = "";
public function __construct($title = NULL, $body = NULL, $css = NULL)
{
}
public static function getHtmlAnyEnvironmentIssues()
{
}
public static function getHtmlAdminHelp($hasStackAlready = true)
{
}
public function getHtmlErrorPage()
{
}
public function defaultTitle()
{
}
public function defaultCss()
{
}
public function defaultBody()
{
}
public function defaultHtmlErrorPage()
{
}
public static function getTemplateErrorPage()
{
}
public static function getHtmlStackTrace($exception)
{
}
}
}
namespace WHMCS\View\Admin\HealthCheck {
class HealthCheckResult
{
protected $name = NULL;
protected $type = NULL;
protected $title = NULL;
protected $severityLevel = NULL;
protected $body = NULL;
public function __construct($name, $type, $title, $severityLevel, $body)
{
}
public function getName()
{
}
protected function setName($name)
{
}
public function getType()
{
}
protected function setType($type)
{
}
public function getTitle()
{
}
protected function setTitle($title)
{
}
public function getSeverityLevel()
{
}
protected function setSeverityLevel($severityLevel)
{
}
public function getBody()
{
}
protected function setBody($body)
{
}
public function toArray()
{
}
}
class HealthCheckRepository
{
protected $osChecker = NULL;
protected $whmcsChecker = NULL;
protected $curlChecker = NULL;
protected $httpChecker = NULL;
const RECOMMENDED_DB_COLLATIONS = "utf8mb4_unicode_ci";
const MINIMUM_MEMORY_LIMIT = 67108864;
const RECOMMENDED_MEMORY_LIMIT = 134217728;
const DEFAULT_MEMORY_LIMIT_FOR_AUTO_UPDATE = self::MINIMUM_MEMORY_LIMIT;
public function __construct(\WHMCS\Environment\OperatingSystem $osChecker = NULL, \WHMCS\Environment\WHMCS $whmcsChecker = NULL, \WHMCS\Environment\Http $httpChecker = NULL)
{
}
protected function buildCheckResults(array $results)
{
}
public function keyChecks()
{
}
public function nonKeyChecks()
{
}
protected function displayWhmcsPaths()
{
}
protected function checkForUpdateVersionAvailable()
{
}
protected function checkForCustomPathUsage()
{
}
protected function checkForLaxFilePermissions()
{
}
protected function checkForSensitiveDirectoryRemoteAccess()
{
}
protected function checkForUnsupportedWebServer()
{
}
protected function getQuickLinks()
{
}
protected function hasCronRunToday()
{
}
protected function hasPopCronRunInLastHour()
{
}
protected function checkDefaultTemplateUsage()
{
}
protected function checkDbVersion()
{
}
protected function checkDbCollations()
{
}
protected function checkPhpVersion()
{
}
protected function checkBrowserPhpVsCronPhp()
{
}
protected function checkRequiredPhpExtensions()
{
}
protected function checkRecommendedPhpExtensions()
{
}
protected function checkRequiredPhpFunctions()
{
}
protected function checkErrorDisplay()
{
}
protected function checkPhpErrorLevels()
{
}
protected function checkPhpMemoryLimit()
{
}
protected function checkCurlVersion()
{
}
protected function checkForCurlSslSupport()
{
}
protected function checkForCurlSecureTlsSupport()
{
}
protected function checkPhpSessionSupport()
{
}
protected function checkPhpTimezone()
{
}
protected function checkForSiteSsl()
{
}
protected function checkSMTPMailEncryption()
{
}
public function checkUpdaterRequirements(\WHMCS\Installer\Update\Updater $updater = NULL)
{
}
}
}
namespace WHMCS\View\Admin\Marketplace {
class PromotionHelper
{
const PROMO_BASE_URL = "https://cdn.whmcs.com/promo/";
public function hookIntoPage(\WHMCS\Admin $adminInterface)
{
}
protected function defineModalHtml()
{
}
public function isPromoFetchRequest()
{
}
protected function getPromoUrl($partner)
{
}
public function fetchPromoContent($partner, $params = array())
{
}
protected function post($url, $params)
{
}
protected function generateResponse($response)
{
}
protected function parseResponse($rawResponse)
{
}
protected function activateRegistrar($moduleName, $parameters)
{
}
protected function activateGateway($moduleName, $parameters)
{
}
}
}
namespace WHMCS\View\Template {
class OrderForm extends \WHMCS\View\Template
{
protected static $setting = "OrderFormTemplate";
protected static $defaultTemplate = "base";
protected static $templateDirectory = "templates/orderforms";
protected static $ignoredTemplateDirectories = array();
protected $children = NULL;
protected $parent = NULL;
public static function find($name)
{
}
public static function all()
{
}
public static function factory($requestedTemplateFile = NULL, $systemTemplateName = NULL, $sessionTemplateName = NULL, $requestTemplateName = NULL)
{
}
protected function buildParent()
{
}
public function getParent()
{
}
public function isRoot()
{
}
public function getChildren()
{
}
protected function buildChildren()
{
}
public function getChild($name)
{
}
public function hasChild($name)
{
}
public function productGroups()
{
}
public function getTemplatePath()
{
}
public function hasTemplate($template, $checkParent = true)
{
}
public function getThumbnailWebPath()
{
}
}
}
namespace WHMCS\View\Formatter {
class Price
{
protected $price = 0;
protected $currency = NULL;
protected $defaultFormat = NULL;
protected $defaultCurrencyDescriptor = array("format" => "1", "prefix" => "", "suffix" => "");
const PREFIX = "{PREFIX}";
const PRICE = "{PRICE}";
const SUFFIX = "{SUFFIX}";
public function __construct($price, $currency = NULL)
{
}
public function __toString()
{
}
public function toFull()
{
}
public function toPrefixed()
{
}
public function toSuffixed()
{
}
public function toNumeric()
{
}
public function format($format = NULL, $currency = NULL)
{
}
public function getCurrency()
{
}
public static function adjustDecimals($amount, $currencyCode)
{
}
}
}
namespace WHMCS\View {
class Asset
{
protected $webRoot = "";
public function __construct($webRoot)
{
}
public function getWebRoot()
{
}
public function getJsPath()
{
}
public function getCssPath()
{
}
public function getImgPath()
{
}
public function getFontsPath()
{
}
public function getFontAwesomePath()
{
}
public function getFilesystemImgPath()
{
}
public static function cssInclude($filename)
{
}
public static function conditionalFontawesomeCssInclude($html)
{
}
public static function conditionalCssInclude($filename, $html, $conditionalRegex = NULL)
{
}
public static function conditionalInclude($html, $conditionalRegex, $injectable)
{
}
public static function jsInclude($filename)
{
}
public static function imgTag($filename, $alt = "", $options = array())
{
}
public static function icon($rootClassName)
{
}
}
}
namespace WHMCS\Ticket {
class Watchers extends \WHMCS\Model\AbstractModel
{
protected $table = "tblticket_watchers";
public $timestamps = true;
public function createTable($drop = false)
{
}
public function scopeOfTicket(\Illuminate\Database\Eloquent\Builder $query, $ticketId)
{
}
public function scopeByAdmin(\Illuminate\Database\Eloquent\Builder $query, $adminId)
{
}
}
}
namespace WHMCS\Product {
class Pricing
{
protected $product = NULL;
protected $pricing = NULL;
public function __construct($product, $currency)
{
}
public function allAvailableCycles()
{
}
public function months($months)
{
}
public function byCycle($cycle)
{
}
public function free()
{
}
public function onetime()
{
}
public function monthly()
{
}
public function quarterly()
{
}
public function semiannual()
{
}
public function semiannually()
{
}
public function annual()
{
}
public function annually()
{
}
public function biennial()
{
}
public function biennially()
{
}
public function triennial()
{
}
public function triennially()
{
}
public function best()
{
}
public function first()
{
}
public function getHighestMonthly()
{
}
}
trait CompoundNameTrait
{
private function sluggify($value)
{
}
private function getCompoundName()
{
}
private function setCompoundName(array $value)
{
}
protected function getDisplayNameAttribute()
{
}
protected function setDisplayNameAttribute($value)
{
}
protected function getControlNameAttribute()
{
}
protected function setControlNameAttribute($value)
{
}
}
class Product extends \WHMCS\Model\AbstractModel
{
protected $table = "tblproducts";
protected $columnMap = array("productGroupId" => "gid", "isHidden" => "hidden", "welcomeEmailTemplateId" => "welcomeemail", "stockControlEnabled" => "stockcontrol", "quantityInStock" => "qty", "proRataChargeDayOfCurrentMonth" => "proratadate", "proRataChargeNextMonthAfterDay" => "proratachargenextmonth", "paymentType" => "paytype", "allowMultipleQuantities" => "allowqty", "freeSubDomains" => "subdomain", "module" => "servertype", "serverGroupId" => "servergroup", "moduleConfigOption1" => "configoption1", "moduleConfigOption2" => "configoption2", "moduleConfigOption3" => "configoption3", "moduleConfigOption4" => "configoption4", "moduleConfigOption5" => "configoption5", "moduleConfigOption6" => "configoption6", "moduleConfigOption7" => "configoption7", "moduleConfigOption8" => "configoption8", "moduleConfigOption9" => "configoption9", "moduleConfigOption10" => "configoption10", "moduleConfigOption11" => "configoption11", "moduleConfigOption12" => "configoption12", "moduleConfigOption13" => "configoption13", "moduleConfigOption14" => "configoption14", "moduleConfigOption15" => "configoption15", "moduleConfigOption16" => "configoption16", "moduleConfigOption17" => "configoption17", "moduleConfigOption18" => "configoption18", "moduleConfigOption19" => "configoption19", "moduleConfigOption20" => "configoption20", "moduleConfigOption21" => "configoption21", "moduleConfigOption22" => "configoption22", "moduleConfigOption23" => "configoption23", "moduleConfigOption24" => "configoption24", "recurringCycleLimit" => "recurringcycles", "daysAfterSignUpUntilAutoTermination" => "autoterminatedays", "autoTerminationEmailTemplateId" => "autoterminateemail", "allowConfigOptionUpgradeDowngrade" => "configoptionsupgrade", "upgradeEmailTemplateId" => "upgradeemail", "enableOverageBillingAndUnits" => "overagesenabled", "overageDiskLimit" => "overagesdisklimit", "overageBandwidthLimit" => "overagesbwlimit", "overageDiskPrice" => "overagesdiskprice", "overageBandwidthPrice" => "overagesbwprice", "applyTax" => "tax", "affiliatePayoutOnceOnly" => "affiliateonetime", "affiliatePaymentType" => "affiliatepaytype", "affiliatePaymentAmount" => "affiliatepayamount", "isRetired" => "retired", "displayOrder" => "order");
protected $booleans = array("isHidden", "showDomainOptions", "stockControlEnabled", "proRataBilling", "allowConfigOptionUpgradeDowngrade", "applyTax", "affiliatePayoutOnceOnly", "isRetired", "isFeatured");
protected $strings = array("description", "autoSetup", "module", "moduleConfigOption1", "moduleConfigOption2", "moduleConfigOption3", "moduleConfigOption4", "moduleConfigOption5", "moduleConfigOption6", "moduleConfigOption7", "moduleConfigOption8", "moduleConfigOption9", "moduleConfigOption10", "moduleConfigOption11", "moduleConfigOption12", "moduleConfigOption13", "moduleConfigOption14", "moduleConfigOption15", "moduleConfigOption16", "moduleConfigOption17", "moduleConfigOption18", "moduleConfigOption19", "moduleConfigOption20", "moduleConfigOption21", "moduleConfigOption22", "moduleConfigOption23", "moduleConfigOption24");
protected $ints = array("welcomeEmailTemplateId", "quantityInStock", "proRataChargeDayOfCurrentMonth", "proRataChargeNextMonthAfterDay", "serverGroupId", "displayOrder");
protected $commaSeparated = array("freeSubDomains", "freeDomainPaymentTerms", "freeDomainTlds", "enableOverageBillingAndUnits");
protected $appends = array("formattedProductFeatures");
const TYPE_SHARED = "hostingaccount";
const TYPE_RESELLER = "reselleraccount";
const TYPE_SERVERS = "server";
const TYPE_OTHER = "other";
const PAYMENT_FREE = "free";
const PAYMENT_ONETIME = "onetime";
const PAYMENT_RECURRING = "recurring";
const DEFAULT_EMAIL_TEMPLATES = NULL;
public static function boot()
{
}
public function productGroup()
{
}
public function welcomeEmailTemplate()
{
}
public function autoTerminationEmailTemplate()
{
}
public function upgradeEmailTemplate()
{
}
public function productDownloads()
{
}
public function upgradeProducts()
{
}
public function services()
{
}
public function customFields()
{
}
public function scopeVisible(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeSorted($query)
{
}
public function getDownloadIds()
{
}
public function getUpgradeProductIds()
{
}
public function getAvailableBillingCycles()
{
}
public function pricing($currency = NULL)
{
}
public function getNameAttribute($name)
{
}
public function getDescriptionAttribute($description)
{
}
public function translatedNames()
{
}
public function translatedDescriptions()
{
}
public static function getProductName($productId, $fallback = "", $language = NULL)
{
}
public static function getProductDescription($productId, $fallback = "", $language = NULL)
{
}
public function assignMatchingMarketConnectAddons(array $addons)
{
}
public function isFree()
{
}
public function isOneTime()
{
}
public function scopeMarketConnect(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeSsl(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeRapidssl(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeGeotrust(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeDigicert(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeSymantec(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeWeebly(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeSpamexperts(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeSitelock(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeSitelockVPN(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeMarketConnectProducts(\Illuminate\Database\Eloquent\Builder $query, $products)
{
}
public function scopeCodeguard(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeMarketgoo(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeProductKey($query, $productKey)
{
}
public function scopeIsNotRetired(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeIsRetired(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function getProductKeyAttribute($value)
{
}
public function isMarketConnectProduct()
{
}
public function getServiceKeyAttribute($value)
{
}
public function isValidForUpgrade(\WHMCS\Product\Product $product)
{
}
public function getFormattedProductFeaturesAttribute()
{
}
public function getBilledMetricsAttribute()
{
}
public function metrics()
{
}
public function emailMarketerRules()
{
}
}
class ConfigOption extends \WHMCS\Model\AbstractModel
{
use \WHMCS\Product\CompoundNameTrait;
protected $table = "tblproductconfigoptions";
protected $primaryKey = "id";
public $timestamps = false;
protected $fillable = array("gid", "optionname", "optiontype", "qtyminimum", "qtymaximum", "order", "hidden");
protected $casts = array("gid" => "integer", "optionname" => "string", "optiontype" => "integer", "qtyminimum" => "integer", "qtymaximum" => "integer", "order" => "integer", "hidden" => "boolean");
protected $columnMap = array("groupId" => "gid", "isHidden" => "hidden");
protected $selectableOptionClass = "WHMCS\\Product\\ConfigOptionSelection";
protected $configGroupClass = "WHMCS\\Product\\ConfigOptionGroup";
public function selectableOptions()
{
}
public function configGroup()
{
}
public function scopeOfProduct($query, \WHMCS\Product\Product $product)
{
}
public function scopeOfProductId($query, $productId)
{
}
}
}
namespace WHMCS\Product\Pricing {
class Price
{
protected $price = NULL;
public function __construct($price)
{
}
public function cycle()
{
}
public function isFree()
{
}
public function isOneTime()
{
}
public function isRecurring()
{
}
public function setup()
{
}
public function price()
{
}
public function breakdown()
{
}
public function toPrefixedString()
{
}
public function toSuffixedString()
{
}
public function toFullString()
{
}
public function getShortCycle()
{
}
public function isYearly()
{
}
public function cycleInYears()
{
}
public function yearlyPrice()
{
}
public function cycleInMonths()
{
}
public function monthlyPrice()
{
}
public function breakdownPrice()
{
}
public function breakdownPriceNumeric()
{
}
public function calculatePercentageDifference($price, $decimalPlaces = 0)
{
}
}
class Comparison
{
protected $firstProduct = NULL;
protected $secondProduct = NULL;
protected $currency = array();
public function __construct(\WHMCS\Product\Pricing $firstProduct = NULL, \WHMCS\Product\Pricing $secondProduct = NULL, array $currency = array())
{
}
public function setFirstProduct(\WHMCS\Product\Pricing $product)
{
}
public function setSecondProduct(\WHMCS\Product\Pricing $product)
{
}
protected function canCompare()
{
}
public function diff($cycle)
{
}
}
}
namespace WHMCS\Product\Server {
class Remote extends \WHMCS\Model\AbstractModel
{
protected $table = "tblservers_remote";
protected $columnMap = array("serverId" => "server_id", "numAccounts" => "num_accounts", "metaData" => "meta_data");
protected $fillable = array("server_id");
public function server()
{
}
public function getMetaDataAttribute($metaData)
{
}
public function setMetaDataAttribute($metaData)
{
}
}
}
namespace WHMCS\Product {
class ConfigOptionSelection extends \WHMCS\Model\AbstractModel
{
use \WHMCS\Product\CompoundNameTrait;
protected $table = "tblproductconfigoptionssub";
protected $primaryKey = "id";
public $timestamps = false;
protected $fillable = array("configid", "optionname", "sortorder", "hidden");
protected $casts = array("configid" => "integer", "optionname" => "string", "sortorder" => "integer", "hidden" => "boolean");
protected $columnMap = array("isHidden" => "hidden");
protected $configOptionClass = "WHMCS\\Product\\ConfigOption";
protected $hasSetupFees = NULL;
protected $hasLinearCyclePricing = NULL;
public function newCollection(array $models = array())
{
}
public function configOption()
{
}
public function pricingByCurrency(\WHMCS\Billing\Currency $currency)
{
}
public function hasSetupFees()
{
}
public function hasLinearCyclePricing()
{
}
public function getPricing()
{
}
public function getPricingByCycle()
{
}
public function calculateLinearPricing($monthlyRecurring = 0, $monthlySetup = 0)
{
}
public function setPricing($pricing, $autofillLinearPricing = false, $hasSetupFees = false)
{
}
}
class ConfigOptions
{
protected $cache = array();
protected function getCurrencyID()
{
}
protected function isCached($productID)
{
}
protected function getFromCache($productID, $optionLabel)
{
}
protected function storeToCache($productID, $optionLabel, $optionsData)
{
}
protected function loadData($productID)
{
}
public function getBasePrice($productID, $billingCycle)
{
}
public function hasConfigOptions($productID)
{
}
}
class Server extends \WHMCS\Model\AbstractModel
{
protected $table = "tblservers";
public $timestamps = false;
protected $columnMap = array("ipAddress" => "ipaddress", "assignedIpAddresses" => "assignedips", "monthlyCost" => "monthlycost", "dataCenter" => "noc", "statusAddress" => "statusaddress", "nameserverOne" => "nameserver1", "nameserverOneIpAddress" => "nameserver1ip", "nameserverTwo" => "nameserver2", "nameserverTwoIpAddress" => "nameserver2ip", "nameserverThree" => "nameserver3", "nameserverThreeIpAddress" => "nameserver3ip", "nameserverFour" => "nameserver4", "nameserverFourIpAddress" => "nameserver4ip", "nameserverFive" => "nameserver5", "nameserverFiveIpAddress" => "nameserver5ip", "maxAccounts" => "maxaccounts", "accessHash" => "accesshash");
protected $appends = array("activeAccountsCount");
public static function boot()
{
}
public function services()
{
}
public function addons()
{
}
public function scopeOfModule(\Illuminate\Database\Eloquent\Builder $query, $module)
{
}
public function scopeEnabled(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeDefault(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function getActiveAccountsCountAttribute()
{
}
public function getModuleInterface()
{
}
public function remote()
{
}
public function usageTenants()
{
}
public function usageTenant($tenant)
{
}
public function usageTenantByService(\WHMCS\Service\Service $service)
{
}
public function getMetricProvider()
{
}
public function syncTenantUsage($tenantName)
{
}
public function syncAllUsage()
{
}
}
class Promotion extends \WHMCS\Model\AbstractModel
{
protected $table = "tblpromotions";
public $timestamps = false;
}
class ConfigOptionGroupLinks extends \WHMCS\Model\AbstractModel
{
protected $table = "tblproductconfiglinks";
protected $primaryKey = "id";
public $timestamps = false;
protected $fillable = array("pid", "gid");
protected $configOptionGroupClass = "WHMCS\\Product\\ConfigOptionGroup";
protected $productClass = "WHMCS\\Product\\Product";
public function configGroup()
{
}
public function product()
{
}
public function scopeGroupId($query, $groupId)
{
}
public function scopeProductId($query, $productId)
{
}
}
class ConfigOptionGroup extends \WHMCS\Model\AbstractModel
{
protected $table = "tblproductconfiggroups";
protected $primaryKey = "id";
public $timestamps = false;
protected $fillable = array("name", "description");
protected $casts = array("name" => "string", "description" => "string");
protected $configOptionClass = "WHMCS\\Product\\ConfigOption";
public function configOptions()
{
}
}
}
namespace WHMCS\Product\Group {
class Feature extends \WHMCS\Model\AbstractModel
{
protected $table = "tblproduct_group_features";
public static function boot()
{
}
public function productGroup()
{
}
public function translatedFeatures()
{
}
public function getFeatureAttribute($feature)
{
}
}
}
namespace WHMCS\Product {
class Group extends \WHMCS\Model\AbstractModel
{
protected $table = "tblproductgroups";
protected $columnMap = array("orderFormTemplate" => "orderfrmtpl", "disabledPaymentGateways" => "disabledgateways", "isHidden" => "hidden", "displayOrder" => "order");
protected $booleans = array("isHidden");
protected $commaSeparated = array("disabledPaymentGateways");
public static function boot()
{
}
public function products()
{
}
public function features()
{
}
public function scopeNotHidden($query)
{
}
public function scopeSorted($query)
{
}
public function orderFormTemplate()
{
}
public function getAvailableBillingCycles()
{
}
public function translatedNames()
{
}
public function translatedHeadlines()
{
}
public function translatedTaglines()
{
}
public function getNameAttribute($name)
{
}
public function getHeadlineAttribute($headline)
{
}
public function getTaglineAttribute($tagline)
{
}
public static function getGroupName($groupId, $fallback = "", $language = NULL)
{
}
public static function getHeadline($groupId, $fallback = "", $language = NULL)
{
}
public static function getTagline($groupId, $fallback = "", $language = NULL)
{
}
}
class Products
{
public function getProducts($groupId = NULL)
{
}
}
class Addon extends \WHMCS\Model\AbstractModel
{
protected $table = "tbladdons";
protected $columnMap = array("applyTax" => "tax", "showOnOrderForm" => "showorder", "welcomeEmailTemplateId" => "welcomeemail", "autoLinkCriteria" => "autolinkby", "isHidden" => "hidden", "isRetired" => "retired");
protected $booleans = array("applyTax", "showOnOrderForm", "suspendProduct", "isHidden", "retired");
protected $commaSeparated = array("packages", "downloads");
protected $casts = array("autolinkby" => "array");
public static function boot()
{
}
public function scopeShowOnOrderForm(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeIsHidden(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeIsNotHidden(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeIsRetired(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeIsNotRetired(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeAvailableOnOrderForm(\Illuminate\Database\Eloquent\Builder $query, array $addons = array())
{
}
public function scopeSorted($query)
{
}
public function welcomeEmailTemplate()
{
}
public function getNameAttribute($name)
{
}
public function getDescriptionAttribute($description)
{
}
public function customFields()
{
}
public function serviceAddons()
{
}
public function moduleConfiguration()
{
}
public function translatedNames()
{
}
public function translatedDescriptions()
{
}
public static function getAddonName($addonId, $fallback = "", $language = NULL)
{
}
public static function getAddonDescription($addonId, $fallback = "", $language = NULL)
{
}
public function pricing($currency = NULL)
{
}
public function isFree()
{
}
public function isOneTime()
{
}
public function scopeMarketConnect(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function getProductKeyAttribute($value)
{
}
public function isMarketConnectAddon()
{
}
public function getServiceKeyAttribute($value)
{
}
public function isValidForUpgrade(\WHMCS\Product\Addon $addon)
{
}
public function isVisibleOnOrderForm(array $addonIds = array())
{
}
public static function getAddonDropdownValues($currentAddonId = 0)
{
}
public function emailMarketerRules()
{
}
}
}
namespace {
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/**
* @class TCPDF
* PHP class for generating PDF documents without requiring external extensions.
* TCPDF project (http://www.tcpdf.org) has been originally derived in 2002 from the Public Domain FPDF class by Olivier Plathey (http://www.fpdf.org), but now is almost entirely rewritten.<br>
* @package com.tecnick.tcpdf
* @brief PHP class for generating PDF documents without requiring external extensions.
* @version 6.2.26
* @author Nicola Asuni - info@tecnick.com
* @IgnoreAnnotation("protected")
* @IgnoreAnnotation("public")
* @IgnoreAnnotation("pre")
*/
class TCPDF
{
// Protected properties
/**
* Current page number.
* @protected
*/
protected $page;
/**
* Current object number.
* @protected
*/
protected $n;
/**
* Array of object offsets.
* @protected
*/
protected $offsets = array();
/**
* Array of object IDs for each page.
* @protected
*/
protected $pageobjects = array();
/**
* Buffer holding in-memory PDF.
* @protected
*/
protected $buffer;
/**
* Array containing pages.
* @protected
*/
protected $pages = array();
/**
* Current document state.
* @protected
*/
protected $state;
/**
* Compression flag.
* @protected
*/
protected $compress;
/**
* Current page orientation (P = Portrait, L = Landscape).
* @protected
*/
protected $CurOrientation;
/**
* Page dimensions.
* @protected
*/
protected $pagedim = array();
/**
* Scale factor (number of points in user unit).
* @protected
*/
protected $k;
/**
* Width of page format in points.
* @protected
*/
protected $fwPt;
/**
* Height of page format in points.
* @protected
*/
protected $fhPt;
/**
* Current width of page in points.
* @protected
*/
protected $wPt;
/**
* Current height of page in points.
* @protected
*/
protected $hPt;
/**
* Current width of page in user unit.
* @protected
*/
protected $w;
/**
* Current height of page in user unit.
* @protected
*/
protected $h;
/**
* Left margin.
* @protected
*/
protected $lMargin;
/**
* Right margin.
* @protected
*/
protected $rMargin;
/**
* Cell left margin (used by regions).
* @protected
*/
protected $clMargin;
/**
* Cell right margin (used by regions).
* @protected
*/
protected $crMargin;
/**
* Top margin.
* @protected
*/
protected $tMargin;
/**
* Page break margin.
* @protected
*/
protected $bMargin;
/**
* Array of cell internal paddings ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
* @since 5.9.000 (2010-10-03)
* @protected
*/
protected $cell_padding = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0);
/**
* Array of cell margins ('T' => top, 'R' => right, 'B' => bottom, 'L' => left).
* @since 5.9.000 (2010-10-04)
* @protected
*/
protected $cell_margin = array('T' => 0, 'R' => 0, 'B' => 0, 'L' => 0);
/**
* Current horizontal position in user unit for cell positioning.
* @protected
*/
protected $x;
/**
* Current vertical position in user unit for cell positioning.
* @protected
*/
protected $y;
/**
* Height of last cell printed.
* @protected
*/
protected $lasth;
/**
* Line width in user unit.
* @protected
*/
protected $LineWidth;
/**
* Array of standard font names.
* @protected
*/
protected $CoreFonts;
/**
* Array of used fonts.
* @protected
*/
protected $fonts = array();
/**
* Array of font files.
* @protected
*/
protected $FontFiles = array();
/**
* Array of encoding differences.
* @protected
*/
protected $diffs = array();
/**
* Array of used images.
* @protected
*/
protected $images = array();
/**
* Depth of the svg tag, to keep track if the svg tag is a subtag or the root tag.
* @protected
*/
protected $svg_tag_depth = 0;
/**
* Array of Annotations in pages.
* @protected
*/
protected $PageAnnots = array();
/**
* Array of internal links.
* @protected
*/
protected $links = array();
/**
* Current font family.
* @protected
*/
protected $FontFamily;
/**
* Current font style.
* @protected
*/
protected $FontStyle;
/**
* Current font ascent (distance between font top and baseline).
* @protected
* @since 2.8.000 (2007-03-29)
*/
protected $FontAscent;
/**
* Current font descent (distance between font bottom and baseline).
* @protected
* @since 2.8.000 (2007-03-29)
*/
protected $FontDescent;
/**
* Underlining flag.
* @protected
*/
protected $underline;
/**
* Overlining flag.
* @protected
*/
protected $overline;
/**
* Current font info.
* @protected
*/
protected $CurrentFont;
/**
* Current font size in points.
* @protected
*/
protected $FontSizePt;
/**
* Current font size in user unit.
* @protected
*/
protected $FontSize;
/**
* Commands for drawing color.
* @protected
*/
protected $DrawColor;
/**
* Commands for filling color.
* @protected
*/
protected $FillColor;
/**
* Commands for text color.
* @protected
*/
protected $TextColor;
/**
* Indicates whether fill and text colors are different.
* @protected
*/
protected $ColorFlag;
/**
* Automatic page breaking.
* @protected
*/
protected $AutoPageBreak;
/**
* Threshold used to trigger page breaks.
* @protected
*/
protected $PageBreakTrigger;
/**
* Flag set when processing page header.
* @protected
*/
protected $InHeader = \false;
/**
* Flag set when processing page footer.
* @protected
*/
protected $InFooter = \false;
/**
* Zoom display mode.
* @protected
*/
protected $ZoomMode;
/**
* Layout display mode.
* @protected
*/
protected $LayoutMode;
/**
* If true set the document information dictionary in Unicode.
* @protected
*/
protected $docinfounicode = \true;
/**
* Document title.
* @protected
*/
protected $title = '';
/**
* Document subject.
* @protected
*/
protected $subject = '';
/**
* Document author.
* @protected
*/
protected $author = '';
/**
* Document keywords.
* @protected
*/
protected $keywords = '';
/**
* Document creator.
* @protected
*/
protected $creator = '';
/**
* Starting page number.
* @protected
*/
protected $starting_page_number = 1;
/**
* The right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image.
* @since 2002-07-31
* @author Nicola Asuni
* @protected
*/
protected $img_rb_x;
/**
* The right-bottom corner Y coordinate of last inserted image.
* @since 2002-07-31
* @author Nicola Asuni
* @protected
*/
protected $img_rb_y;
/**
* Adjusting factor to convert pixels to user units.
* @since 2004-06-14
* @author Nicola Asuni
* @protected
*/
protected $imgscale = 1;
/**
* Boolean flag set to true when the input text is unicode (require unicode fonts).
* @since 2005-01-02
* @author Nicola Asuni
* @protected
*/
protected $isunicode = \false;
/**
* PDF version.
* @since 1.5.3
* @protected
*/
protected $PDFVersion = '1.7';
/**
* ID of the stored default header template (-1 = not set).
* @protected
*/
protected $header_xobjid = \false;
/**
* If true reset the Header Xobject template at each page
* @protected
*/
protected $header_xobj_autoreset = \false;
/**
* Minimum distance between header and top page margin.
* @protected
*/
protected $header_margin;
/**
* Minimum distance between footer and bottom page margin.
* @protected
*/
protected $footer_margin;
/**
* Original left margin value.
* @protected
* @since 1.53.0.TC013
*/
protected $original_lMargin;
/**
* Original right margin value.
* @protected
* @since 1.53.0.TC013
*/
protected $original_rMargin;
/**
* Default font used on page header.
* @protected
*/
protected $header_font;
/**
* Default font used on page footer.
* @protected
*/
protected $footer_font;
/**
* Language templates.
* @protected
*/
protected $l;
/**
* Barcode to print on page footer (only if set).
* @protected
*/
protected $barcode = \false;
/**
* Boolean flag to print/hide page header.
* @protected
*/
protected $print_header = \true;
/**
* Boolean flag to print/hide page footer.
* @protected
*/
protected $print_footer = \true;
/**
* Header image logo.
* @protected
*/
protected $header_logo = '';
/**
* Width of header image logo in user units.
* @protected
*/
protected $header_logo_width = 30;
/**
* Title to be printed on default page header.
* @protected
*/
protected $header_title = '';
/**
* String to pring on page header after title.
* @protected
*/
protected $header_string = '';
/**
* Color for header text (RGB array).
* @since 5.9.174 (2012-07-25)
* @protected
*/
protected $header_text_color = array(0, 0, 0);
/**
* Color for header line (RGB array).
* @since 5.9.174 (2012-07-25)
* @protected
*/
protected $header_line_color = array(0, 0, 0);
/**
* Color for footer text (RGB array).
* @since 5.9.174 (2012-07-25)
* @protected
*/
protected $footer_text_color = array(0, 0, 0);
/**
* Color for footer line (RGB array).
* @since 5.9.174 (2012-07-25)
* @protected
*/
protected $footer_line_color = array(0, 0, 0);
/**
* Text shadow data array.
* @since 5.9.174 (2012-07-25)
* @protected
*/
protected $txtshadow = array('enabled' => \false, 'depth_w' => 0, 'depth_h' => 0, 'color' => \false, 'opacity' => 1, 'blend_mode' => 'Normal');
/**
* Default number of columns for html table.
* @protected
*/
protected $default_table_columns = 4;
// variables for html parser
/**
* HTML PARSER: array to store current link and rendering styles.
* @protected
*/
protected $HREF = array();
/**
* List of available fonts on filesystem.
* @protected
*/
protected $fontlist = array();
/**
* Current foreground color.
* @protected
*/
protected $fgcolor;
/**
* HTML PARSER: array of boolean values, true in case of ordered list (OL), false otherwise.
* @protected
*/
protected $listordered = array();
/**
* HTML PARSER: array count list items on nested lists.
* @protected
*/
protected $listcount = array();
/**
* HTML PARSER: current list nesting level.
* @protected
*/
protected $listnum = 0;
/**
* HTML PARSER: indent amount for lists.
* @protected
*/
protected $listindent = 0;
/**
* HTML PARSER: current list indententation level.
* @protected
*/
protected $listindentlevel = 0;
/**
* Current background color.
* @protected
*/
protected $bgcolor;
/**
* Temporary font size in points.
* @protected
*/
protected $tempfontsize = 10;
/**
* Spacer string for LI tags.
* @protected
*/
protected $lispacer = '';
/**
* Default encoding.
* @protected
* @since 1.53.0.TC010
*/
protected $encoding = 'UTF-8';
/**
* PHP internal encoding.
* @protected
* @since 1.53.0.TC016
*/
protected $internal_encoding;
/**
* Boolean flag to indicate if the document language is Right-To-Left.
* @protected
* @since 2.0.000
*/
protected $rtl = \false;
/**
* Boolean flag used to force RTL or LTR string direction.
* @protected
* @since 2.0.000
*/
protected $tmprtl = \false;
// --- Variables used for document encryption:
/**
* IBoolean flag indicating whether document is protected.
* @protected
* @since 2.0.000 (2008-01-02)
*/
protected $encrypted;
/**
* Array containing encryption settings.
* @protected
* @since 5.0.005 (2010-05-11)
*/
protected $encryptdata = array();
/**
* Last RC4 key encrypted (cached for optimisation).
* @protected
* @since 2.0.000 (2008-01-02)
*/
protected $last_enc_key;
/**
* Last RC4 computed key.
* @protected
* @since 2.0.000 (2008-01-02)
*/
protected $last_enc_key_c;
/**
* File ID (used on document trailer).
* @protected
* @since 5.0.005 (2010-05-12)
*/
protected $file_id;
// --- bookmark ---
/**
* Outlines for bookmark.
* @protected
* @since 2.1.002 (2008-02-12)
*/
protected $outlines = array();
/**
* Outline root for bookmark.
* @protected
* @since 2.1.002 (2008-02-12)
*/
protected $OutlineRoot;
// --- javascript and form ---
/**
* Javascript code.
* @protected
* @since 2.1.002 (2008-02-12)
*/
protected $javascript = '';
/**
* Javascript counter.
* @protected
* @since 2.1.002 (2008-02-12)
*/
protected $n_js;
/**
* line through state
* @protected
* @since 2.8.000 (2008-03-19)
*/
protected $linethrough;
/**
* Array with additional document-wide usage rights for the document.
* @protected
* @since 5.8.014 (2010-08-23)
*/
protected $ur = array();
/**
* DPI (Dot Per Inch) Document Resolution (do not change).
* @protected
* @since 3.0.000 (2008-03-27)
*/
protected $dpi = 72;
/**
* Array of page numbers were a new page group was started (the page numbers are the keys of the array).
* @protected
* @since 3.0.000 (2008-03-27)
*/
protected $newpagegroup = array();
/**
* Array that contains the number of pages in each page group.
* @protected
* @since 3.0.000 (2008-03-27)
*/
protected $pagegroups = array();
/**
* Current page group number.
* @protected
* @since 3.0.000 (2008-03-27)
*/
protected $currpagegroup = 0;
/**
* Array of transparency objects and parameters.
* @protected
* @since 3.0.000 (2008-03-27)
*/
protected $extgstates;
/**
* Set the default JPEG compression quality (1-100).
* @protected
* @since 3.0.000 (2008-03-27)
*/
protected $jpeg_quality;
/**
* Default cell height ratio.
* @protected
* @since 3.0.014 (2008-05-23)
*/
protected $cell_height_ratio = \K_CELL_HEIGHT_RATIO;
/**
* PDF viewer preferences.
* @protected
* @since 3.1.000 (2008-06-09)
*/
protected $viewer_preferences;
/**
* A name object specifying how the document should be displayed when opened.
* @protected
* @since 3.1.000 (2008-06-09)
*/
protected $PageMode;
/**
* Array for storing gradient information.
* @protected
* @since 3.1.000 (2008-06-09)
*/
protected $gradients = array();
/**
* Array used to store positions inside the pages buffer (keys are the page numbers).
* @protected
* @since 3.2.000 (2008-06-26)
*/
protected $intmrk = array();
/**
* Array used to store positions inside the pages buffer (keys are the page numbers).
* @protected
* @since 5.7.000 (2010-08-03)
*/
protected $bordermrk = array();
/**
* Array used to store page positions to track empty pages (keys are the page numbers).
* @protected
* @since 5.8.007 (2010-08-18)
*/
protected $emptypagemrk = array();
/**
* Array used to store content positions inside the pages buffer (keys are the page numbers).
* @protected
* @since 4.6.021 (2009-07-20)
*/
protected $cntmrk = array();
/**
* Array used to store footer positions of each page.
* @protected
* @since 3.2.000 (2008-07-01)
*/
protected $footerpos = array();
/**
* Array used to store footer length of each page.
* @protected
* @since 4.0.014 (2008-07-29)
*/
protected $footerlen = array();
/**
* Boolean flag to indicate if a new line is created.
* @protected
* @since 3.2.000 (2008-07-01)
*/
protected $newline = \true;
/**
* End position of the latest inserted line.
* @protected
* @since 3.2.000 (2008-07-01)
*/
protected $endlinex = 0;
/**
* PDF string for width value of the last line.
* @protected
* @since 4.0.006 (2008-07-16)
*/
protected $linestyleWidth = '';
/**
* PDF string for CAP value of the last line.
* @protected
* @since 4.0.006 (2008-07-16)
*/
protected $linestyleCap = '0 J';
/**
* PDF string for join value of the last line.
* @protected
* @since 4.0.006 (2008-07-16)
*/
protected $linestyleJoin = '0 j';
/**
* PDF string for dash value of the last line.
* @protected
* @since 4.0.006 (2008-07-16)
*/
protected $linestyleDash = '[] 0 d';
/**
* Boolean flag to indicate if marked-content sequence is open.
* @protected
* @since 4.0.013 (2008-07-28)
*/
protected $openMarkedContent = \false;
/**
* Count the latest inserted vertical spaces on HTML.
* @protected
* @since 4.0.021 (2008-08-24)
*/
protected $htmlvspace = 0;
/**
* Array of Spot colors.
* @protected
* @since 4.0.024 (2008-09-12)
*/
protected $spot_colors = array();
/**
* Symbol used for HTML unordered list items.
* @protected
* @since 4.0.028 (2008-09-26)
*/
protected $lisymbol = '';
/**
* String used to mark the beginning and end of EPS image blocks.
* @protected
* @since 4.1.000 (2008-10-18)
*/
protected $epsmarker = 'x#!#EPS#!#x';
/**
* Array of transformation matrix.
* @protected
* @since 4.2.000 (2008-10-29)
*/
protected $transfmatrix = array();
/**
* Current key for transformation matrix.
* @protected
* @since 4.8.005 (2009-09-17)
*/
protected $transfmatrix_key = 0;
/**
* Booklet mode for double-sided pages.
* @protected
* @since 4.2.000 (2008-10-29)
*/
protected $booklet = \false;
/**
* Epsilon value used for float calculations.
* @protected
* @since 4.2.000 (2008-10-29)
*/
protected $feps = 0.005;
/**
* Array used for custom vertical spaces for HTML tags.
* @protected
* @since 4.2.001 (2008-10-30)
*/
protected $tagvspaces = array();
/**
* HTML PARSER: custom indent amount for lists. Negative value means disabled.
* @protected
* @since 4.2.007 (2008-11-12)
*/
protected $customlistindent = -1;
/**
* Boolean flag to indicate if the border of the cell sides that cross the page should be removed.
* @protected
* @since 4.2.010 (2008-11-14)
*/
protected $opencell = \true;
/**
* Array of files to embedd.
* @protected
* @since 4.4.000 (2008-12-07)
*/
protected $embeddedfiles = array();
/**
* Boolean flag to indicate if we are inside a PRE tag.
* @protected
* @since 4.4.001 (2008-12-08)
*/
protected $premode = \false;
/**
* Array used to store positions of graphics transformation blocks inside the page buffer.
* keys are the page numbers
* @protected
* @since 4.4.002 (2008-12-09)
*/
protected $transfmrk = array();
/**
* Default color for html links.
* @protected
* @since 4.4.003 (2008-12-09)
*/
protected $htmlLinkColorArray = array(0, 0, 255);
/**
* Default font style to add to html links.
* @protected
* @since 4.4.003 (2008-12-09)
*/
protected $htmlLinkFontStyle = 'U';
/**
* Counts the number of pages.
* @protected
* @since 4.5.000 (2008-12-31)
*/
protected $numpages = 0;
/**
* Array containing page lengths in bytes.
* @protected
* @since 4.5.000 (2008-12-31)
*/
protected $pagelen = array();
/**
* Counts the number of pages.
* @protected
* @since 4.5.000 (2008-12-31)
*/
protected $numimages = 0;
/**
* Store the image keys.
* @protected
* @since 4.5.000 (2008-12-31)
*/
protected $imagekeys = array();
/**
* Length of the buffer in bytes.
* @protected
* @since 4.5.000 (2008-12-31)
*/
protected $bufferlen = 0;
/**
* Counts the number of fonts.
* @protected
* @since 4.5.000 (2009-01-02)
*/
protected $numfonts = 0;
/**
* Store the font keys.
* @protected
* @since 4.5.000 (2009-01-02)
*/
protected $fontkeys = array();
/**
* Store the font object IDs.
* @protected
* @since 4.8.001 (2009-09-09)
*/
protected $font_obj_ids = array();
/**
* Store the fage status (true when opened, false when closed).
* @protected
* @since 4.5.000 (2009-01-02)
*/
protected $pageopen = array();
/**
* Default monospace font.
* @protected
* @since 4.5.025 (2009-03-10)
*/
protected $default_monospaced_font = 'courier';
/**
* Cloned copy of the current class object.
* @protected
* @since 4.5.029 (2009-03-19)
*/
protected $objcopy;
/**
* Array used to store the lengths of cache files.
* @protected
* @since 4.5.029 (2009-03-19)
*/
protected $cache_file_length = array();
/**
* Table header content to be repeated on each new page.
* @protected
* @since 4.5.030 (2009-03-20)
*/
protected $thead = '';
/**
* Margins used for table header.
* @protected
* @since 4.5.030 (2009-03-20)
*/
protected $theadMargins = array();
/**
* Boolean flag to enable document digital signature.
* @protected
* @since 4.6.005 (2009-04-24)
*/
protected $sign = \false;
/**
* Digital signature data.
* @protected
* @since 4.6.005 (2009-04-24)
*/
protected $signature_data = array();
/**
* Digital signature max length.
* @protected
* @since 4.6.005 (2009-04-24)
*/
protected $signature_max_length = 11742;
/**
* Data for digital signature appearance.
* @protected
* @since 5.3.011 (2010-06-16)
*/
protected $signature_appearance = array('page' => 1, 'rect' => '0 0 0 0');
/**
* Array of empty digital signature appearances.
* @protected
* @since 5.9.101 (2011-07-06)
*/
protected $empty_signature_appearance = array();
/**
* Boolean flag to enable document timestamping with TSA.
* @protected
* @since 6.0.085 (2014-06-19)
*/
protected $tsa_timestamp = \false;
/**
* Timestamping data.
* @protected
* @since 6.0.085 (2014-06-19)
*/
protected $tsa_data = array();
/**
* Regular expression used to find blank characters (required for word-wrapping).
* @protected
* @since 4.6.006 (2009-04-28)
*/
protected $re_spaces = '/[^\\S\\xa0]/';
/**
* Array of $re_spaces parts.
* @protected
* @since 5.5.011 (2010-07-09)
*/
protected $re_space = array('p' => '[^\\S\\xa0]', 'm' => '');
/**
* Digital signature object ID.
* @protected
* @since 4.6.022 (2009-06-23)
*/
protected $sig_obj_id = 0;
/**
* ID of page objects.
* @protected
* @since 4.7.000 (2009-08-29)
*/
protected $page_obj_id = array();
/**
* List of form annotations IDs.
* @protected
* @since 4.8.000 (2009-09-07)
*/
protected $form_obj_id = array();
/**
* Deafult Javascript field properties. Possible values are described on official Javascript for Acrobat API reference. Annotation options can be directly specified using the 'aopt' entry.
* @protected
* @since 4.8.000 (2009-09-07)
*/
protected $default_form_prop = array('lineWidth' => 1, 'borderStyle' => 'solid', 'fillColor' => array(255, 255, 255), 'strokeColor' => array(128, 128, 128));
/**
* Javascript objects array.
* @protected
* @since 4.8.000 (2009-09-07)
*/
protected $js_objects = array();
/**
* Current form action (used during XHTML rendering).
* @protected
* @since 4.8.000 (2009-09-07)
*/
protected $form_action = '';
/**
* Current form encryption type (used during XHTML rendering).
* @protected
* @since 4.8.000 (2009-09-07)
*/
protected $form_enctype = 'application/x-www-form-urlencoded';
/**
* Current method to submit forms.
* @protected
* @since 4.8.000 (2009-09-07)
*/
protected $form_mode = 'post';
/**
* List of fonts used on form fields (fontname => fontkey).
* @protected
* @since 4.8.001 (2009-09-09)
*/
protected $annotation_fonts = array();
/**
* List of radio buttons parent objects.
* @protected
* @since 4.8.001 (2009-09-09)
*/
protected $radiobutton_groups = array();
/**
* List of radio group objects IDs.
* @protected
* @since 4.8.001 (2009-09-09)
*/
protected $radio_groups = array();
/**
* Text indentation value (used for text-indent CSS attribute).
* @protected
* @since 4.8.006 (2009-09-23)
*/
protected $textindent = 0;
/**
* Store page number when startTransaction() is called.
* @protected
* @since 4.8.006 (2009-09-23)
*/
protected $start_transaction_page = 0;
/**
* Store Y position when startTransaction() is called.
* @protected
* @since 4.9.001 (2010-03-28)
*/
protected $start_transaction_y = 0;
/**
* True when we are printing the thead section on a new page.
* @protected
* @since 4.8.027 (2010-01-25)
*/
protected $inthead = \false;
/**
* Array of column measures (width, space, starting Y position).
* @protected
* @since 4.9.001 (2010-03-28)
*/
protected $columns = array();
/**
* Number of colums.
* @protected
* @since 4.9.001 (2010-03-28)
*/
protected $num_columns = 1;
/**
* Current column number.
* @protected
* @since 4.9.001 (2010-03-28)
*/
protected $current_column = 0;
/**
* Starting page for columns.
* @protected
* @since 4.9.001 (2010-03-28)
*/
protected $column_start_page = 0;
/**
* Maximum page and column selected.
* @protected
* @since 5.8.000 (2010-08-11)
*/
protected $maxselcol = array('page' => 0, 'column' => 0);
/**
* Array of: X difference between table cell x start and starting page margin, cellspacing, cellpadding.
* @protected
* @since 5.8.000 (2010-08-11)
*/
protected $colxshift = array('x' => 0, 's' => array('H' => 0, 'V' => 0), 'p' => array('L' => 0, 'T' => 0, 'R' => 0, 'B' => 0));
/**
* Text rendering mode: 0 = Fill text; 1 = Stroke text; 2 = Fill, then stroke text; 3 = Neither fill nor stroke text (invisible); 4 = Fill text and add to path for clipping; 5 = Stroke text and add to path for clipping; 6 = Fill, then stroke text and add to path for clipping; 7 = Add text to path for clipping.
* @protected
* @since 4.9.008 (2010-04-03)
*/
protected $textrendermode = 0;
/**
* Text stroke width in doc units.
* @protected
* @since 4.9.008 (2010-04-03)
*/
protected $textstrokewidth = 0;
/**
* Current stroke color.
* @protected
* @since 4.9.008 (2010-04-03)
*/
protected $strokecolor;
/**
* Default unit of measure for document.
* @protected
* @since 5.0.000 (2010-04-22)
*/
protected $pdfunit = 'mm';
/**
* Boolean flag true when we are on TOC (Table Of Content) page.
* @protected
*/
protected $tocpage = \false;
/**
* Boolean flag: if true convert vector images (SVG, EPS) to raster image using GD or ImageMagick library.
* @protected
* @since 5.0.000 (2010-04-26)
*/
protected $rasterize_vector_images = \false;
/**
* Boolean flag: if true enables font subsetting by default.
* @protected
* @since 5.3.002 (2010-06-07)
*/
protected $font_subsetting = \true;
/**
* Array of default graphic settings.
* @protected
* @since 5.5.008 (2010-07-02)
*/
protected $default_graphic_vars = array();
/**
* Array of XObjects.
* @protected
* @since 5.8.014 (2010-08-23)
*/
protected $xobjects = array();
/**
* Boolean value true when we are inside an XObject.
* @protected
* @since 5.8.017 (2010-08-24)
*/
protected $inxobj = \false;
/**
* Current XObject ID.
* @protected
* @since 5.8.017 (2010-08-24)
*/
protected $xobjid = '';
/**
* Percentage of character stretching.
* @protected
* @since 5.9.000 (2010-09-29)
*/
protected $font_stretching = 100;
/**
* Increases or decreases the space between characters in a text by the specified amount (tracking).
* @protected
* @since 5.9.000 (2010-09-29)
*/
protected $font_spacing = 0;
/**
* Array of no-write regions.
* ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right)
* @protected
* @since 5.9.003 (2010-10-14)
*/
protected $page_regions = array();
/**
* Boolean value true when page region check is active.
* @protected
*/
protected $check_page_regions = \true;
/**
* Array of PDF layers data.
* @protected
* @since 5.9.102 (2011-07-13)
*/
protected $pdflayers = array();
/**
* A dictionary of names and corresponding destinations (Dests key on document Catalog).
* @protected
* @since 5.9.097 (2011-06-23)
*/
protected $dests = array();
/**
* Object ID for Named Destinations
* @protected
* @since 5.9.097 (2011-06-23)
*/
protected $n_dests;
/**
* Embedded Files Names
* @protected
* @since 5.9.204 (2013-01-23)
*/
protected $efnames = array();
/**
* Directory used for the last SVG image.
* @protected
* @since 5.0.000 (2010-05-05)
*/
protected $svgdir = '';
/**
* Deafult unit of measure for SVG.
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgunit = 'px';
/**
* Array of SVG gradients.
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svggradients = array();
/**
* ID of last SVG gradient.
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svggradientid = 0;
/**
* Boolean value true when in SVG defs group.
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgdefsmode = \false;
/**
* Array of SVG defs.
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgdefs = array();
/**
* Boolean value true when in SVG clipPath tag.
* @protected
* @since 5.0.000 (2010-04-26)
*/
protected $svgclipmode = \false;
/**
* Array of SVG clipPath commands.
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgclippaths = array();
/**
* Array of SVG clipPath tranformation matrix.
* @protected
* @since 5.8.022 (2010-08-31)
*/
protected $svgcliptm = array();
/**
* ID of last SVG clipPath.
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgclipid = 0;
/**
* SVG text.
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgtext = '';
/**
* SVG text properties.
* @protected
* @since 5.8.013 (2010-08-23)
*/
protected $svgtextmode = array();
/**
* Array of SVG properties.
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected $svgstyles = array(array('alignment-baseline' => 'auto', 'baseline-shift' => 'baseline', 'clip' => 'auto', 'clip-path' => 'none', 'clip-rule' => 'nonzero', 'color' => 'black', 'color-interpolation' => 'sRGB', 'color-interpolation-filters' => 'linearRGB', 'color-profile' => 'auto', 'color-rendering' => 'auto', 'cursor' => 'auto', 'direction' => 'ltr', 'display' => 'inline', 'dominant-baseline' => 'auto', 'enable-background' => 'accumulate', 'fill' => 'black', 'fill-opacity' => 1, 'fill-rule' => 'nonzero', 'filter' => 'none', 'flood-color' => 'black', 'flood-opacity' => 1, 'font' => '', 'font-family' => 'helvetica', 'font-size' => 'medium', 'font-size-adjust' => 'none', 'font-stretch' => 'normal', 'font-style' => 'normal', 'font-variant' => 'normal', 'font-weight' => 'normal', 'glyph-orientation-horizontal' => '0deg', 'glyph-orientation-vertical' => 'auto', 'image-rendering' => 'auto', 'kerning' => 'auto', 'letter-spacing' => 'normal', 'lighting-color' => 'white', 'marker' => '', 'marker-end' => 'none', 'marker-mid' => 'none', 'marker-start' => 'none', 'mask' => 'none', 'opacity' => 1, 'overflow' => 'auto', 'pointer-events' => 'visiblePainted', 'shape-rendering' => 'auto', 'stop-color' => 'black', 'stop-opacity' => 1, 'stroke' => 'none', 'stroke-dasharray' => 'none', 'stroke-dashoffset' => 0, 'stroke-linecap' => 'butt', 'stroke-linejoin' => 'miter', 'stroke-miterlimit' => 4, 'stroke-opacity' => 1, 'stroke-width' => 1, 'text-anchor' => 'start', 'text-decoration' => 'none', 'text-rendering' => 'auto', 'unicode-bidi' => 'normal', 'visibility' => 'visible', 'word-spacing' => 'normal', 'writing-mode' => 'lr-tb', 'text-color' => 'black', 'transfmatrix' => array(1, 0, 0, 1, 0, 0)));
/**
* If true force sRGB color profile for all document.
* @protected
* @since 5.9.121 (2011-09-28)
*/
protected $force_srgb = \false;
/**
* If true set the document to PDF/A mode.
* @protected
* @since 5.9.121 (2011-09-27)
*/
protected $pdfa_mode = \false;
/**
* Document creation date-time
* @protected
* @since 5.9.152 (2012-03-22)
*/
protected $doc_creation_timestamp;
/**
* Document modification date-time
* @protected
* @since 5.9.152 (2012-03-22)
*/
protected $doc_modification_timestamp;
/**
* Custom XMP data.
* @protected
* @since 5.9.128 (2011-10-06)
*/
protected $custom_xmp = '';
/**
* Overprint mode array.
* (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
* @protected
* @since 5.9.152 (2012-03-23)
*/
protected $overprint = array('OP' => \false, 'op' => \false, 'OPM' => 0);
/**
* Alpha mode array.
* (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
* @protected
* @since 5.9.152 (2012-03-23)
*/
protected $alpha = array('CA' => 1, 'ca' => 1, 'BM' => '/Normal', 'AIS' => \false);
/**
* Define the page boundaries boxes to be set on document.
* @protected
* @since 5.9.152 (2012-03-23)
*/
protected $page_boxes = array('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox');
/**
* If true print TCPDF meta link.
* @protected
* @since 5.9.152 (2012-03-23)
*/
protected $tcpdflink = \true;
/**
* Cache array for computed GD gamma values.
* @protected
* @since 5.9.1632 (2012-06-05)
*/
protected $gdgammacache = array();
//------------------------------------------------------------
// METHODS
//------------------------------------------------------------
/**
* This is the class constructor.
* It allows to set up the page format, the orientation and the measure unit used in all the methods (except for the font sizes).
*
* IMPORTANT: Please note that this method sets the mb_internal_encoding to ASCII, so if you are using the mbstring module functions with TCPDF you need to correctly set/unset the mb_internal_encoding when needed.
*
* @param $orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or Portrait (default)</li><li>L or Landscape</li><li>'' (empty string) for automatic orientation</li></ul>
* @param $unit (string) User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
* @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
* @param $unicode (boolean) TRUE means that the input text is unicode (default = true)
* @param $encoding (string) Charset encoding (used only when converting back html entities); default is UTF-8.
* @param $diskcache (boolean) DEPRECATED FEATURE
* @param $pdfa (boolean) If TRUE set the document to PDF/A mode.
* @public
* @see getPageSizeFromFormat(), setPageFormat()
*/
public function __construct($orientation = 'P', $unit = 'mm', $format = 'A4', $unicode = \true, $encoding = 'UTF-8', $diskcache = \false, $pdfa = \false)
{
}
/**
* Default destructor.
* @public
* @since 1.53.0.TC016
*/
public function __destruct()
{
}
/**
* Set the units of measure for the document.
* @param $unit (string) User measure unit. Possible values are:<ul><li>pt: point</li><li>mm: millimeter (default)</li><li>cm: centimeter</li><li>in: inch</li></ul><br />A point equals 1/72 of inch, that is to say about 0.35 mm (an inch being 2.54 cm). This is a very common unit in typography; font sizes are expressed in that unit.
* @public
* @since 3.0.015 (2008-06-06)
*/
public function setPageUnit($unit)
{
}
/**
* Change the format of the current page
* @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() documentation or an array of two numbers (width, height) or an array containing the following measures and options:<ul>
* <li>['format'] = page format name (one of the above);</li>
* <li>['Rotate'] : The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.</li>
* <li>['PZ'] : The page's preferred zoom (magnification) factor.</li>
* <li>['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed:</li>
* <li>['MediaBox']['llx'] : lower-left x coordinate</li>
* <li>['MediaBox']['lly'] : lower-left y coordinate</li>
* <li>['MediaBox']['urx'] : upper-right x coordinate</li>
* <li>['MediaBox']['ury'] : upper-right y coordinate</li>
* <li>['CropBox'] : the visible region of default user space:</li>
* <li>['CropBox']['llx'] : lower-left x coordinate</li>
* <li>['CropBox']['lly'] : lower-left y coordinate</li>
* <li>['CropBox']['urx'] : upper-right x coordinate</li>
* <li>['CropBox']['ury'] : upper-right y coordinate</li>
* <li>['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment:</li>
* <li>['BleedBox']['llx'] : lower-left x coordinate</li>
* <li>['BleedBox']['lly'] : lower-left y coordinate</li>
* <li>['BleedBox']['urx'] : upper-right x coordinate</li>
* <li>['BleedBox']['ury'] : upper-right y coordinate</li>
* <li>['TrimBox'] : the intended dimensions of the finished page after trimming:</li>
* <li>['TrimBox']['llx'] : lower-left x coordinate</li>
* <li>['TrimBox']['lly'] : lower-left y coordinate</li>
* <li>['TrimBox']['urx'] : upper-right x coordinate</li>
* <li>['TrimBox']['ury'] : upper-right y coordinate</li>
* <li>['ArtBox'] : the extent of the page's meaningful content:</li>
* <li>['ArtBox']['llx'] : lower-left x coordinate</li>
* <li>['ArtBox']['lly'] : lower-left y coordinate</li>
* <li>['ArtBox']['urx'] : upper-right x coordinate</li>
* <li>['ArtBox']['ury'] : upper-right y coordinate</li>
* <li>['BoxColorInfo'] :specify the colours and other visual characteristics that should be used in displaying guidelines on the screen for each of the possible page boundaries other than the MediaBox:</li>
* <li>['BoxColorInfo'][BOXTYPE]['C'] : an array of three numbers in the range 0-255, representing the components in the DeviceRGB colour space.</li>
* <li>['BoxColorInfo'][BOXTYPE]['W'] : the guideline width in default user units</li>
* <li>['BoxColorInfo'][BOXTYPE]['S'] : the guideline style: S = Solid; D = Dashed</li>
* <li>['BoxColorInfo'][BOXTYPE]['D'] : dash array defining a pattern of dashes and gaps to be used in drawing dashed guidelines</li>
* <li>['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation</li>
* <li>['trans']['Dur'] : The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.</li>
* <li>['trans']['S'] : transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade</li>
* <li>['trans']['D'] : The duration of the transition effect, in seconds.</li>
* <li>['trans']['Dm'] : (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.</li>
* <li>['trans']['M'] : (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.</li>
* <li>['trans']['Di'] : (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.</li>
* <li>['trans']['SS'] : (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0.</li>
* <li>['trans']['B'] : (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.</li>
* </ul>
* @param $orientation (string) page orientation. Possible values are (case insensitive):<ul>
* <li>P or Portrait (default)</li>
* <li>L or Landscape</li>
* <li>'' (empty string) for automatic orientation</li>
* </ul>
* @protected
* @since 3.0.015 (2008-06-06)
* @see getPageSizeFromFormat()
*/
protected function setPageFormat($format, $orientation = 'P')
{
}
/**
* Set page orientation.
* @param $orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or Portrait (default)</li><li>L or Landscape</li><li>'' (empty string) for automatic orientation</li></ul>
* @param $autopagebreak (boolean) Boolean indicating if auto-page-break mode should be on or off.
* @param $bottommargin (float) bottom margin of the page.
* @public
* @since 3.0.015 (2008-06-06)
*/
public function setPageOrientation($orientation, $autopagebreak = '', $bottommargin = '')
{
}
/**
* Set regular expression to detect withespaces or word separators.
* The pattern delimiter must be the forward-slash character "/".
* Some example patterns are:
* <pre>
* Non-Unicode or missing PCRE unicode support: "/[^\S\xa0]/"
* Unicode and PCRE unicode support: "/(?!\xa0)[\s\p{Z}]/u"
* Unicode and PCRE unicode support in Chinese mode: "/(?!\xa0)[\s\p{Z}\p{Lo}]/u"
* if PCRE unicode support is turned ON ("\P" is the negate class of "\p"):
* \s : any whitespace character
* \p{Z} : any separator
* \p{Lo} : Unicode letter or ideograph that does not have lowercase and uppercase variants. Is used to chunk chinese words.
* \xa0 : Unicode Character 'NO-BREAK SPACE' (U+00A0)
* </pre>
* @param $re (string) regular expression (leave empty for default).
* @public
* @since 4.6.016 (2009-06-15)
*/
public function setSpacesRE($re = '/[^\\S\\xa0]/')
{
}
/**
* Enable or disable Right-To-Left language mode
* @param $enable (Boolean) if true enable Right-To-Left language mode.
* @param $resetx (Boolean) if true reset the X position on direction change.
* @public
* @since 2.0.000 (2008-01-03)
*/
public function setRTL($enable, $resetx = \true)
{
}
/**
* Return the RTL status
* @return boolean
* @public
* @since 4.0.012 (2008-07-24)
*/
public function getRTL()
{
}
/**
* Force temporary RTL language direction
* @param $mode (mixed) can be false, 'L' for LTR or 'R' for RTL
* @public
* @since 2.1.000 (2008-01-09)
*/
public function setTempRTL($mode)
{
}
/**
* Return the current temporary RTL status
* @return boolean
* @public
* @since 4.8.014 (2009-11-04)
*/
public function isRTLTextDir()
{
}
/**
* Set the last cell height.
* @param $h (float) cell height.
* @author Nicola Asuni
* @public
* @since 1.53.0.TC034
*/
public function setLastH($h)
{
}
/**
* Return the cell height
* @param $fontsize (int) Font size in internal units
* @param $padding (boolean) If true add cell padding
* @public
*/
public function getCellHeight($fontsize, $padding = \TRUE)
{
}
/**
* Reset the last cell height.
* @public
* @since 5.9.000 (2010-10-03)
*/
public function resetLastH()
{
}
/**
* Get the last cell height.
* @return last cell height
* @public
* @since 4.0.017 (2008-08-05)
*/
public function getLastH()
{
}
/**
* Set the adjusting factor to convert pixels to user units.
* @param $scale (float) adjusting factor to convert pixels to user units.
* @author Nicola Asuni
* @public
* @since 1.5.2
*/
public function setImageScale($scale)
{
}
/**
* Returns the adjusting factor to convert pixels to user units.
* @return float adjusting factor to convert pixels to user units.
* @author Nicola Asuni
* @public
* @since 1.5.2
*/
public function getImageScale()
{
}
/**
* Returns an array of page dimensions:
* <ul><li>$this->pagedim[$this->page]['w'] = page width in points</li><li>$this->pagedim[$this->page]['h'] = height in points</li><li>$this->pagedim[$this->page]['wk'] = page width in user units</li><li>$this->pagedim[$this->page]['hk'] = page height in user units</li><li>$this->pagedim[$this->page]['tm'] = top margin</li><li>$this->pagedim[$this->page]['bm'] = bottom margin</li><li>$this->pagedim[$this->page]['lm'] = left margin</li><li>$this->pagedim[$this->page]['rm'] = right margin</li><li>$this->pagedim[$this->page]['pb'] = auto page break</li><li>$this->pagedim[$this->page]['or'] = page orientation</li><li>$this->pagedim[$this->page]['olm'] = original left margin</li><li>$this->pagedim[$this->page]['orm'] = original right margin</li><li>$this->pagedim[$this->page]['Rotate'] = The number of degrees by which the page shall be rotated clockwise when displayed or printed. The value shall be a multiple of 90.</li><li>$this->pagedim[$this->page]['PZ'] = The page's preferred zoom (magnification) factor.</li><li>$this->pagedim[$this->page]['trans'] : the style and duration of the visual transition to use when moving from another page to the given page during a presentation<ul><li>$this->pagedim[$this->page]['trans']['Dur'] = The page's display duration (also called its advance timing): the maximum length of time, in seconds, that the page shall be displayed during presentations before the viewer application shall automatically advance to the next page.</li><li>$this->pagedim[$this->page]['trans']['S'] = transition style : Split, Blinds, Box, Wipe, Dissolve, Glitter, R, Fly, Push, Cover, Uncover, Fade</li><li>$this->pagedim[$this->page]['trans']['D'] = The duration of the transition effect, in seconds.</li><li>$this->pagedim[$this->page]['trans']['Dm'] = (Split and Blinds transition styles only) The dimension in which the specified transition effect shall occur: H = Horizontal, V = Vertical. Default value: H.</li><li>$this->pagedim[$this->page]['trans']['M'] = (Split, Box and Fly transition styles only) The direction of motion for the specified transition effect: I = Inward from the edges of the page, O = Outward from the center of the pageDefault value: I.</li><li>$this->pagedim[$this->page]['trans']['Di'] = (Wipe, Glitter, Fly, Cover, Uncover and Push transition styles only) The direction in which the specified transition effect shall moves, expressed in degrees counterclockwise starting from a left-to-right direction. If the value is a number, it shall be one of: 0 = Left to right, 90 = Bottom to top (Wipe only), 180 = Right to left (Wipe only), 270 = Top to bottom, 315 = Top-left to bottom-right (Glitter only). If the value is a name, it shall be None, which is relevant only for the Fly transition when the value of SS is not 1.0. Default value: 0.</li><li>$this->pagedim[$this->page]['trans']['SS'] = (Fly transition style only) The starting or ending scale at which the changes shall be drawn. If M specifies an inward transition, the scale of the changes drawn shall progress from SS to 1.0 over the course of the transition. If M specifies an outward transition, the scale of the changes drawn shall progress from 1.0 to SS over the course of the transition. Default: 1.0. </li><li>$this->pagedim[$this->page]['trans']['B'] = (Fly transition style only) If true, the area that shall be flown in is rectangular and opaque. Default: false.</li></ul></li><li>$this->pagedim[$this->page]['MediaBox'] : the boundaries of the physical medium on which the page shall be displayed or printed<ul><li>$this->pagedim[$this->page]['MediaBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['MediaBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['CropBox'] : the visible region of default user space<ul><li>$this->pagedim[$this->page]['CropBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['CropBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['BleedBox'] : the region to which the contents of the page shall be clipped when output in a production environment<ul><li>$this->pagedim[$this->page]['BleedBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['BleedBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['TrimBox'] : the intended dimensions of the finished page after trimming<ul><li>$this->pagedim[$this->page]['TrimBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['TrimBox']['ury'] = upper-right y coordinate in points</li></ul></li><li>$this->pagedim[$this->page]['ArtBox'] : the extent of the page's meaningful content<ul><li>$this->pagedim[$this->page]['ArtBox']['llx'] = lower-left x coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['lly'] = lower-left y coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['urx'] = upper-right x coordinate in points</li><li>$this->pagedim[$this->page]['ArtBox']['ury'] = upper-right y coordinate in points</li></ul></li></ul>
* @param $pagenum (int) page number (empty = current page)
* @return array of page dimensions.
* @author Nicola Asuni
* @public
* @since 4.5.027 (2009-03-16)
*/
public function getPageDimensions($pagenum = '')
{
}
/**
* Returns the page width in units.
* @param $pagenum (int) page number (empty = current page)
* @return int page width.
* @author Nicola Asuni
* @public
* @since 1.5.2
* @see getPageDimensions()
*/
public function getPageWidth($pagenum = '')
{
}
/**
* Returns the page height in units.
* @param $pagenum (int) page number (empty = current page)
* @return int page height.
* @author Nicola Asuni
* @public
* @since 1.5.2
* @see getPageDimensions()
*/
public function getPageHeight($pagenum = '')
{
}
/**
* Returns the page break margin.
* @param $pagenum (int) page number (empty = current page)
* @return int page break margin.
* @author Nicola Asuni
* @public
* @since 1.5.2
* @see getPageDimensions()
*/
public function getBreakMargin($pagenum = '')
{
}
/**
* Returns the scale factor (number of points in user unit).
* @return int scale factor.
* @author Nicola Asuni
* @public
* @since 1.5.2
*/
public function getScaleFactor()
{
}
/**
* Defines the left, top and right margins.
* @param $left (float) Left margin.
* @param $top (float) Top margin.
* @param $right (float) Right margin. Default value is the left one.
* @param $keepmargins (boolean) if true overwrites the default page margins
* @public
* @since 1.0
* @see SetLeftMargin(), SetTopMargin(), SetRightMargin(), SetAutoPageBreak()
*/
public function SetMargins($left, $top, $right = -1, $keepmargins = \false)
{
}
/**
* Defines the left margin. The method can be called before creating the first page. If the current abscissa gets out of page, it is brought back to the margin.
* @param $margin (float) The margin.
* @public
* @since 1.4
* @see SetTopMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()
*/
public function SetLeftMargin($margin)
{
}
/**
* Defines the top margin. The method can be called before creating the first page.
* @param $margin (float) The margin.
* @public
* @since 1.5
* @see SetLeftMargin(), SetRightMargin(), SetAutoPageBreak(), SetMargins()
*/
public function SetTopMargin($margin)
{
}
/**
* Defines the right margin. The method can be called before creating the first page.
* @param $margin (float) The margin.
* @public
* @since 1.5
* @see SetLeftMargin(), SetTopMargin(), SetAutoPageBreak(), SetMargins()
*/
public function SetRightMargin($margin)
{
}
/**
* Set the same internal Cell padding for top, right, bottom, left-
* @param $pad (float) internal padding.
* @public
* @since 2.1.000 (2008-01-09)
* @see getCellPaddings(), setCellPaddings()
*/
public function SetCellPadding($pad)
{
}
/**
* Set the internal Cell paddings.
* @param $left (float) left padding
* @param $top (float) top padding
* @param $right (float) right padding
* @param $bottom (float) bottom padding
* @public
* @since 5.9.000 (2010-10-03)
* @see getCellPaddings(), SetCellPadding()
*/
public function setCellPaddings($left = '', $top = '', $right = '', $bottom = '')
{
}
/**
* Get the internal Cell padding array.
* @return array of padding values
* @public
* @since 5.9.000 (2010-10-03)
* @see setCellPaddings(), SetCellPadding()
*/
public function getCellPaddings()
{
}
/**
* Set the internal Cell margins.
* @param $left (float) left margin
* @param $top (float) top margin
* @param $right (float) right margin
* @param $bottom (float) bottom margin
* @public
* @since 5.9.000 (2010-10-03)
* @see getCellMargins()
*/
public function setCellMargins($left = '', $top = '', $right = '', $bottom = '')
{
}
/**
* Get the internal Cell margin array.
* @return array of margin values
* @public
* @since 5.9.000 (2010-10-03)
* @see setCellMargins()
*/
public function getCellMargins()
{
}
/**
* Adjust the internal Cell padding array to take account of the line width.
* @param $brd (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return array of adjustments
* @public
* @since 5.9.000 (2010-10-03)
*/
protected function adjustCellPadding($brd = 0)
{
}
/**
* Enables or disables the automatic page breaking mode. When enabling, the second parameter is the distance from the bottom of the page that defines the triggering limit. By default, the mode is on and the margin is 2 cm.
* @param $auto (boolean) Boolean indicating if mode should be on or off.
* @param $margin (float) Distance from the bottom of the page.
* @public
* @since 1.0
* @see Cell(), MultiCell(), AcceptPageBreak()
*/
public function SetAutoPageBreak($auto, $margin = 0)
{
}
/**
* Return the auto-page-break mode (true or false).
* @return boolean auto-page-break mode
* @public
* @since 5.9.088
*/
public function getAutoPageBreak()
{
}
/**
* Defines the way the document is to be displayed by the viewer.
* @param $zoom (mixed) The zoom to use. It can be one of the following string values or a number indicating the zooming factor to use. <ul><li>fullpage: displays the entire page on screen </li><li>fullwidth: uses maximum width of window</li><li>real: uses real size (equivalent to 100% zoom)</li><li>default: uses viewer default mode</li></ul>
* @param $layout (string) The page layout. Possible values are:<ul><li>SinglePage Display one page at a time</li><li>OneColumn Display the pages in one column</li><li>TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left</li><li>TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right</li><li>TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left</li><li>TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right</li></ul>
* @param $mode (string) A name object specifying how the document should be displayed when opened:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible</li><li>UseOC (PDF 1.5) Optional content group panel visible</li><li>UseAttachments (PDF 1.6) Attachments panel visible</li></ul>
* @public
* @since 1.2
*/
public function SetDisplayMode($zoom, $layout = 'SinglePage', $mode = 'UseNone')
{
}
/**
* Activates or deactivates page compression. When activated, the internal representation of each page is compressed, which leads to a compression ratio of about 2 for the resulting document. Compression is on by default.
* Note: the Zlib extension is required for this feature. If not present, compression will be turned off.
* @param $compress (boolean) Boolean indicating if compression must be enabled.
* @public
* @since 1.4
*/
public function SetCompression($compress = \true)
{
}
/**
* Set flag to force sRGB_IEC61966-2.1 black scaled ICC color profile for the whole document.
* @param $mode (boolean) If true force sRGB output intent.
* @public
* @since 5.9.121 (2011-09-28)
*/
public function setSRGBmode($mode = \false)
{
}
/**
* Turn on/off Unicode mode for document information dictionary (meta tags).
* This has effect only when unicode mode is set to false.
* @param $unicode (boolean) if true set the meta information in Unicode
* @since 5.9.027 (2010-12-01)
* @public
*/
public function SetDocInfoUnicode($unicode = \true)
{
}
/**
* Defines the title of the document.
* @param $title (string) The title.
* @public
* @since 1.2
* @see SetAuthor(), SetCreator(), SetKeywords(), SetSubject()
*/
public function SetTitle($title)
{
}
/**
* Defines the subject of the document.
* @param $subject (string) The subject.
* @public
* @since 1.2
* @see SetAuthor(), SetCreator(), SetKeywords(), SetTitle()
*/
public function SetSubject($subject)
{
}
/**
* Defines the author of the document.
* @param $author (string) The name of the author.
* @public
* @since 1.2
* @see SetCreator(), SetKeywords(), SetSubject(), SetTitle()
*/
public function SetAuthor($author)
{
}
/**
* Associates keywords with the document, generally in the form 'keyword1 keyword2 ...'.
* @param $keywords (string) The list of keywords.
* @public
* @since 1.2
* @see SetAuthor(), SetCreator(), SetSubject(), SetTitle()
*/
public function SetKeywords($keywords)
{
}
/**
* Defines the creator of the document. This is typically the name of the application that generates the PDF.
* @param $creator (string) The name of the creator.
* @public
* @since 1.2
* @see SetAuthor(), SetKeywords(), SetSubject(), SetTitle()
*/
public function SetCreator($creator)
{
}
/**
* Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.
* @param $msg (string) The error message
* @public
* @since 1.0
*/
public function Error($msg)
{
}
/**
* This method begins the generation of the PDF document.
* It is not necessary to call it explicitly because AddPage() does it automatically.
* Note: no page is created by this method
* @public
* @since 1.0
* @see AddPage(), Close()
*/
public function Open()
{
}
/**
* Terminates the PDF document.
* It is not necessary to call this method explicitly because Output() does it automatically.
* If the document contains no page, AddPage() is called to prevent from getting an invalid document.
* @public
* @since 1.0
* @see Open(), Output()
*/
public function Close()
{
}
/**
* Move pointer at the specified document page and update page dimensions.
* @param $pnum (int) page number (1 ... numpages)
* @param $resetmargins (boolean) if true reset left, right, top margins and Y position.
* @public
* @since 2.1.000 (2008-01-07)
* @see getPage(), lastpage(), getNumPages()
*/
public function setPage($pnum, $resetmargins = \false)
{
}
/**
* Reset pointer to the last document page.
* @param $resetmargins (boolean) if true reset left, right, top margins and Y position.
* @public
* @since 2.0.000 (2008-01-04)
* @see setPage(), getPage(), getNumPages()
*/
public function lastPage($resetmargins = \false)
{
}
/**
* Get current document page number.
* @return int page number
* @public
* @since 2.1.000 (2008-01-07)
* @see setPage(), lastpage(), getNumPages()
*/
public function getPage()
{
}
/**
* Get the total number of insered pages.
* @return int number of pages
* @public
* @since 2.1.000 (2008-01-07)
* @see setPage(), getPage(), lastpage()
*/
public function getNumPages()
{
}
/**
* Adds a new TOC (Table Of Content) page to the document.
* @param $orientation (string) page orientation.
* @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
* @param $keepmargins (boolean) if true overwrites the default page margins with the current margins
* @public
* @since 5.0.001 (2010-05-06)
* @see AddPage(), startPage(), endPage(), endTOCPage()
*/
public function addTOCPage($orientation = '', $format = '', $keepmargins = \false)
{
}
/**
* Terminate the current TOC (Table Of Content) page
* @public
* @since 5.0.001 (2010-05-06)
* @see AddPage(), startPage(), endPage(), addTOCPage()
*/
public function endTOCPage()
{
}
/**
* Adds a new page to the document. If a page is already present, the Footer() method is called first to output the footer (if enabled). Then the page is added, the current position set to the top-left corner according to the left and top margins (or top-right if in RTL mode), and Header() is called to display the header (if enabled).
* The origin of the coordinate system is at the top-left corner (or top-right for RTL) and increasing ordinates go downwards.
* @param $orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
* @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
* @param $keepmargins (boolean) if true overwrites the default page margins with the current margins
* @param $tocpage (boolean) if true set the tocpage state to true (the added page will be used to display Table Of Content).
* @public
* @since 1.0
* @see startPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()
*/
public function AddPage($orientation = '', $format = '', $keepmargins = \false, $tocpage = \false)
{
}
/**
* Terminate the current page
* @param $tocpage (boolean) if true set the tocpage state to false (end the page used to display Table Of Content).
* @public
* @since 4.2.010 (2008-11-14)
* @see AddPage(), startPage(), addTOCPage(), endTOCPage()
*/
public function endPage($tocpage = \false)
{
}
/**
* Starts a new page to the document. The page must be closed using the endPage() function.
* The origin of the coordinate system is at the top-left corner and increasing ordinates go downwards.
* @param $orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
* @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
* @param $tocpage (boolean) if true the page is designated to contain the Table-Of-Content.
* @since 4.2.010 (2008-11-14)
* @see AddPage(), endPage(), addTOCPage(), endTOCPage(), getPageSizeFromFormat(), setPageFormat()
* @public
*/
public function startPage($orientation = '', $format = '', $tocpage = \false)
{
}
/**
* Set start-writing mark on current page stream used to put borders and fills.
* Borders and fills are always created after content and inserted on the position marked by this method.
* This function must be called after calling Image() function for a background image.
* Background images must be always inserted before calling Multicell() or WriteHTMLCell() or WriteHTML() functions.
* @public
* @since 4.0.016 (2008-07-30)
*/
public function setPageMark()
{
}
/**
* Set start-writing mark on selected page.
* Borders and fills are always created after content and inserted on the position marked by this method.
* @param $page (int) page number (default is the current page)
* @protected
* @since 4.6.021 (2009-07-20)
*/
protected function setContentMark($page = 0)
{
}
/**
* Set header data.
* @param $ln (string) header image logo
* @param $lw (string) header image logo width in mm
* @param $ht (string) string to print as title on document header
* @param $hs (string) string to print on document header
* @param $tc (array) RGB array color for text.
* @param $lc (array) RGB array color for line.
* @public
*/
public function setHeaderData($ln = '', $lw = 0, $ht = '', $hs = '', $tc = array(0, 0, 0), $lc = array(0, 0, 0))
{
}
/**
* Set footer data.
* @param $tc (array) RGB array color for text.
* @param $lc (array) RGB array color for line.
* @public
*/
public function setFooterData($tc = array(0, 0, 0), $lc = array(0, 0, 0))
{
}
/**
* Returns header data:
* <ul><li>$ret['logo'] = logo image</li><li>$ret['logo_width'] = width of the image logo in user units</li><li>$ret['title'] = header title</li><li>$ret['string'] = header description string</li></ul>
* @return array()
* @public
* @since 4.0.012 (2008-07-24)
*/
public function getHeaderData()
{
}
/**
* Set header margin.
* (minimum distance between header and top page margin)
* @param $hm (int) distance in user units
* @public
*/
public function setHeaderMargin($hm = 10)
{
}
/**
* Returns header margin in user units.
* @return float
* @since 4.0.012 (2008-07-24)
* @public
*/
public function getHeaderMargin()
{
}
/**
* Set footer margin.
* (minimum distance between footer and bottom page margin)
* @param $fm (int) distance in user units
* @public
*/
public function setFooterMargin($fm = 10)
{
}
/**
* Returns footer margin in user units.
* @return float
* @since 4.0.012 (2008-07-24)
* @public
*/
public function getFooterMargin()
{
}
/**
* Set a flag to print page header.
* @param $val (boolean) set to true to print the page header (default), false otherwise.
* @public
*/
public function setPrintHeader($val = \true)
{
}
/**
* Set a flag to print page footer.
* @param $val (boolean) set to true to print the page footer (default), false otherwise.
* @public
*/
public function setPrintFooter($val = \true)
{
}
/**
* Return the right-bottom (or left-bottom for RTL) corner X coordinate of last inserted image
* @return float
* @public
*/
public function getImageRBX()
{
}
/**
* Return the right-bottom (or left-bottom for RTL) corner Y coordinate of last inserted image
* @return float
* @public
*/
public function getImageRBY()
{
}
/**
* Reset the xobject template used by Header() method.
* @public
*/
public function resetHeaderTemplate()
{
}
/**
* Set a flag to automatically reset the xobject template used by Header() method at each page.
* @param $val (boolean) set to true to reset Header xobject template at each page, false otherwise.
* @public
*/
public function setHeaderTemplateAutoreset($val = \true)
{
}
/**
* This method is used to render the page header.
* It is automatically called by AddPage() and could be overwritten in your own inherited class.
* @public
*/
public function Header()
{
}
/**
* This method is used to render the page footer.
* It is automatically called by AddPage() and could be overwritten in your own inherited class.
* @public
*/
public function Footer()
{
}
/**
* This method is used to render the page header.
* @protected
* @since 4.0.012 (2008-07-24)
*/
protected function setHeader()
{
}
/**
* This method is used to render the page footer.
* @protected
* @since 4.0.012 (2008-07-24)
*/
protected function setFooter()
{
}
/**
* Check if we are on the page body (excluding page header and footer).
* @return true if we are not in page header nor in page footer, false otherwise.
* @protected
* @since 5.9.091 (2011-06-15)
*/
protected function inPageBody()
{
}
/**
* This method is used to render the table header on new page (if any).
* @protected
* @since 4.5.030 (2009-03-25)
*/
protected function setTableHeader()
{
}
/**
* Returns the current page number.
* @return int page number
* @public
* @since 1.0
* @see getAliasNbPages()
*/
public function PageNo()
{
}
/**
* Returns the array of spot colors.
* @return (array) Spot colors array.
* @public
* @since 6.0.038 (2013-09-30)
*/
public function getAllSpotColors()
{
}
/**
* Defines a new spot color.
* It can be expressed in RGB components or gray scale.
* The method can be called before the first page is created and the value is retained from page to page.
* @param $name (string) Full name of the spot color.
* @param $c (float) Cyan color for CMYK. Value between 0 and 100.
* @param $m (float) Magenta color for CMYK. Value between 0 and 100.
* @param $y (float) Yellow color for CMYK. Value between 0 and 100.
* @param $k (float) Key (Black) color for CMYK. Value between 0 and 100.
* @public
* @since 4.0.024 (2008-09-12)
* @see SetDrawSpotColor(), SetFillSpotColor(), SetTextSpotColor()
*/
public function AddSpotColor($name, $c, $m, $y, $k)
{
}
/**
* Set the spot color for the specified type ('draw', 'fill', 'text').
* @param $type (string) Type of object affected by this color: ('draw', 'fill', 'text').
* @param $name (string) Name of the spot color.
* @param $tint (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
* @return (string) PDF color command.
* @public
* @since 5.9.125 (2011-10-03)
*/
public function setSpotColor($type, $name, $tint = 100)
{
}
/**
* Defines the spot color used for all drawing operations (lines, rectangles and cell borders).
* @param $name (string) Name of the spot color.
* @param $tint (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
* @public
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetFillSpotColor(), SetTextSpotColor()
*/
public function SetDrawSpotColor($name, $tint = 100)
{
}
/**
* Defines the spot color used for all filling operations (filled rectangles and cell backgrounds).
* @param $name (string) Name of the spot color.
* @param $tint (float) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
* @public
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetDrawSpotColor(), SetTextSpotColor()
*/
public function SetFillSpotColor($name, $tint = 100)
{
}
/**
* Defines the spot color used for text.
* @param $name (string) Name of the spot color.
* @param $tint (int) Intensity of the color (from 0 to 100 ; 100 = full intensity by default).
* @public
* @since 4.0.024 (2008-09-12)
* @see AddSpotColor(), SetDrawSpotColor(), SetFillSpotColor()
*/
public function SetTextSpotColor($name, $tint = 100)
{
}
/**
* Set the color array for the specified type ('draw', 'fill', 'text').
* It can be expressed in RGB, CMYK or GRAY SCALE components.
* The method can be called before the first page is created and the value is retained from page to page.
* @param $type (string) Type of object affected by this color: ('draw', 'fill', 'text').
* @param $color (array) Array of colors (1=gray, 3=RGB, 4=CMYK or 5=spotcolor=CMYK+name values).
* @param $ret (boolean) If true do not send the PDF command.
* @return (string) The PDF command or empty string.
* @public
* @since 3.1.000 (2008-06-11)
*/
public function setColorArray($type, $color, $ret = \false)
{
}
/**
* Defines the color used for all drawing operations (lines, rectangles and cell borders).
* It can be expressed in RGB, CMYK or GRAY SCALE components.
* The method can be called before the first page is created and the value is retained from page to page.
* @param $color (array) Array of colors (1, 3 or 4 values).
* @param $ret (boolean) If true do not send the PDF command.
* @return string the PDF command
* @public
* @since 3.1.000 (2008-06-11)
* @see SetDrawColor()
*/
public function SetDrawColorArray($color, $ret = \false)
{
}
/**
* Defines the color used for all filling operations (filled rectangles and cell backgrounds).
* It can be expressed in RGB, CMYK or GRAY SCALE components.
* The method can be called before the first page is created and the value is retained from page to page.
* @param $color (array) Array of colors (1, 3 or 4 values).
* @param $ret (boolean) If true do not send the PDF command.
* @public
* @since 3.1.000 (2008-6-11)
* @see SetFillColor()
*/
public function SetFillColorArray($color, $ret = \false)
{
}
/**
* Defines the color used for text. It can be expressed in RGB components or gray scale.
* The method can be called before the first page is created and the value is retained from page to page.
* @param $color (array) Array of colors (1, 3 or 4 values).
* @param $ret (boolean) If true do not send the PDF command.
* @public
* @since 3.1.000 (2008-6-11)
* @see SetFillColor()
*/
public function SetTextColorArray($color, $ret = \false)
{
}
/**
* Defines the color used by the specified type ('draw', 'fill', 'text').
* @param $type (string) Type of object affected by this color: ('draw', 'fill', 'text').
* @param $col1 (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
* @param $col2 (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
* @param $col3 (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
* @param $col4 (float) KEY (BLACK) color for CMYK (0-100).
* @param $ret (boolean) If true do not send the command.
* @param $name (string) spot color name (if any)
* @return (string) The PDF command or empty string.
* @public
* @since 5.9.125 (2011-10-03)
*/
public function setColor($type, $col1 = 0, $col2 = -1, $col3 = -1, $col4 = -1, $ret = \false, $name = '')
{
}
/**
* Defines the color used for all drawing operations (lines, rectangles and cell borders). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
* @param $col1 (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
* @param $col2 (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
* @param $col3 (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
* @param $col4 (float) KEY (BLACK) color for CMYK (0-100).
* @param $ret (boolean) If true do not send the command.
* @param $name (string) spot color name (if any)
* @return string the PDF command
* @public
* @since 1.3
* @see SetDrawColorArray(), SetFillColor(), SetTextColor(), Line(), Rect(), Cell(), MultiCell()
*/
public function SetDrawColor($col1 = 0, $col2 = -1, $col3 = -1, $col4 = -1, $ret = \false, $name = '')
{
}
/**
* Defines the color used for all filling operations (filled rectangles and cell backgrounds). It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
* @param $col1 (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
* @param $col2 (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
* @param $col3 (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
* @param $col4 (float) KEY (BLACK) color for CMYK (0-100).
* @param $ret (boolean) If true do not send the command.
* @param $name (string) Spot color name (if any).
* @return (string) The PDF command.
* @public
* @since 1.3
* @see SetFillColorArray(), SetDrawColor(), SetTextColor(), Rect(), Cell(), MultiCell()
*/
public function SetFillColor($col1 = 0, $col2 = -1, $col3 = -1, $col4 = -1, $ret = \false, $name = '')
{
}
/**
* Defines the color used for text. It can be expressed in RGB components or gray scale. The method can be called before the first page is created and the value is retained from page to page.
* @param $col1 (float) GRAY level for single color, or Red color for RGB (0-255), or CYAN color for CMYK (0-100).
* @param $col2 (float) GREEN color for RGB (0-255), or MAGENTA color for CMYK (0-100).
* @param $col3 (float) BLUE color for RGB (0-255), or YELLOW color for CMYK (0-100).
* @param $col4 (float) KEY (BLACK) color for CMYK (0-100).
* @param $ret (boolean) If true do not send the command.
* @param $name (string) Spot color name (if any).
* @return (string) Empty string.
* @public
* @since 1.3
* @see SetTextColorArray(), SetDrawColor(), SetFillColor(), Text(), Cell(), MultiCell()
*/
public function SetTextColor($col1 = 0, $col2 = -1, $col3 = -1, $col4 = -1, $ret = \false, $name = '')
{
}
/**
* Returns the length of a string in user unit. A font must be selected.<br>
* @param $s (string) The string whose length is to be computed
* @param $fontname (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
* @param $fontstyle (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line-through</li><li>O: overline</li></ul> or any combination. The default value is regular.
* @param $fontsize (float) Font size in points. The default value is the current size.
* @param $getarray (boolean) if true returns an array of characters widths, if false returns the total length.
* @return mixed int total string length or array of characted widths
* @author Nicola Asuni
* @public
* @since 1.2
*/
public function GetStringWidth($s, $fontname = '', $fontstyle = '', $fontsize = 0, $getarray = \false)
{
}
/**
* Returns the string length of an array of chars in user unit or an array of characters widths. A font must be selected.<br>
* @param $sa (string) The array of chars whose total length is to be computed
* @param $fontname (string) Family font. It can be either a name defined by AddFont() or one of the standard families. It is also possible to pass an empty string, in that case, the current family is retained.
* @param $fontstyle (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line through</li><li>O: overline</li></ul> or any combination. The default value is regular.
* @param $fontsize (float) Font size in points. The default value is the current size.
* @param $getarray (boolean) if true returns an array of characters widths, if false returns the total length.
* @return mixed int total string length or array of characted widths
* @author Nicola Asuni
* @public
* @since 2.4.000 (2008-03-06)
*/
public function GetArrStringWidth($sa, $fontname = '', $fontstyle = '', $fontsize = 0, $getarray = \false)
{
}
/**
* Returns the length of the char in user unit for the current font considering current stretching and spacing (tracking).
* @param $char (int) The char code whose length is to be returned
* @param $notlast (boolean) If false ignore the font-spacing.
* @return float char width
* @author Nicola Asuni
* @public
* @since 2.4.000 (2008-03-06)
*/
public function GetCharWidth($char, $notlast = \true)
{
}
/**
* Returns the length of the char in user unit for the current font.
* @param $char (int) The char code whose length is to be returned
* @return float char width
* @author Nicola Asuni
* @public
* @since 5.9.000 (2010-09-28)
*/
public function getRawCharWidth($char)
{
}
/**
* Returns the numbero of characters in a string.
* @param $s (string) The input string.
* @return int number of characters
* @public
* @since 2.0.0001 (2008-01-07)
*/
public function GetNumChars($s)
{
}
/**
* Fill the list of available fonts ($this->fontlist).
* @protected
* @since 4.0.013 (2008-07-28)
*/
protected function getFontsList()
{
}
/**
* Imports a TrueType, Type1, core, or CID0 font and makes it available.
* It is necessary to generate a font definition file first (read /fonts/utils/README.TXT).
* The definition file (and the font file itself when embedding) must be present either in the current directory or in the one indicated by K_PATH_FONTS if the constant is defined. If it could not be found, the error "Could not include font definition file" is generated.
* @param $family (string) Font family. The name can be chosen arbitrarily. If it is a standard family name, it will override the corresponding font.
* @param $style (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular (default)</li><li>B: bold</li><li>I: italic</li><li>BI or IB: bold italic</li></ul>
* @param $fontfile (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
* @return array containing the font data, or false in case of error.
* @param $subset (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
* @public
* @since 1.5
* @see SetFont(), setFontSubsetting()
*/
public function AddFont($family, $style = '', $fontfile = '', $subset = 'default')
{
}
/**
* Sets the font used to print character strings.
* The font can be either a standard one or a font added via the AddFont() method. Standard fonts use Windows encoding cp1252 (Western Europe).
* The method can be called before the first page is created and the font is retained from page to page.
* If you just wish to change the current font size, it is simpler to call SetFontSize().
* Note: for the standard fonts, the font metric files must be accessible. There are three possibilities for this:<ul><li>They are in the current directory (the one where the running script lies)</li><li>They are in one of the directories defined by the include_path parameter</li><li>They are in the directory defined by the K_PATH_FONTS constant</li></ul><br />
* @param $family (string) Family font. It can be either a name defined by AddFont() or one of the standard Type1 families (case insensitive):<ul><li>times (Times-Roman)</li><li>timesb (Times-Bold)</li><li>timesi (Times-Italic)</li><li>timesbi (Times-BoldItalic)</li><li>helvetica (Helvetica)</li><li>helveticab (Helvetica-Bold)</li><li>helveticai (Helvetica-Oblique)</li><li>helveticabi (Helvetica-BoldOblique)</li><li>courier (Courier)</li><li>courierb (Courier-Bold)</li><li>courieri (Courier-Oblique)</li><li>courierbi (Courier-BoldOblique)</li><li>symbol (Symbol)</li><li>zapfdingbats (ZapfDingbats)</li></ul> It is also possible to pass an empty string. In that case, the current family is retained.
* @param $style (string) Font style. Possible values are (case insensitive):<ul><li>empty string: regular</li><li>B: bold</li><li>I: italic</li><li>U: underline</li><li>D: line through</li><li>O: overline</li></ul> or any combination. The default value is regular. Bold and italic styles do not apply to Symbol and ZapfDingbats basic fonts or other fonts when not defined.
* @param $size (float) Font size in points. The default value is the current size. If no size has been specified since the beginning of the document, the value taken is 12
* @param $fontfile (string) The font definition file. By default, the name is built from the family and style, in lower case with no spaces.
* @param $subset (mixed) if true embedd only a subset of the font (stores only the information related to the used characters); if false embedd full font; if 'default' uses the default value set using setFontSubsetting(). This option is valid only for TrueTypeUnicode fonts. If you want to enable users to change the document, set this parameter to false. If you subset the font, the person who receives your PDF would need to have your same font in order to make changes to your PDF. The file size of the PDF would also be smaller because you are embedding only part of a font.
* @param $out (boolean) if true output the font size command, otherwise only set the font properties.
* @author Nicola Asuni
* @public
* @since 1.0
* @see AddFont(), SetFontSize()
*/
public function SetFont($family, $style = '', $size = \null, $fontfile = '', $subset = 'default', $out = \true)
{
}
/**
* Defines the size of the current font.
* @param $size (float) The font size in points.
* @param $out (boolean) if true output the font size command, otherwise only set the font properties.
* @public
* @since 1.0
* @see SetFont()
*/
public function SetFontSize($size, $out = \true)
{
}
/**
* Returns the bounding box of the current font in user units.
* @return array
* @public
* @since 5.9.152 (2012-03-23)
*/
public function getFontBBox()
{
}
/**
* Convert a relative font measure into absolute value.
* @param $s (int) Font measure.
* @return float Absolute measure.
* @since 5.9.186 (2012-09-13)
*/
public function getAbsFontMeasure($s)
{
}
/**
* Returns the glyph bounding box of the specified character in the current font in user units.
* @param $char (int) Input character code.
* @return mixed array(xMin, yMin, xMax, yMax) or FALSE if not defined.
* @since 5.9.186 (2012-09-13)
*/
public function getCharBBox($char)
{
}
/**
* Return the font descent value
* @param $font (string) font name
* @param $style (string) font style
* @param $size (float) The size (in points)
* @return int font descent
* @public
* @author Nicola Asuni
* @since 4.9.003 (2010-03-30)
*/
public function getFontDescent($font, $style = '', $size = 0)
{
}
/**
* Return the font ascent value.
* @param $font (string) font name
* @param $style (string) font style
* @param $size (float) The size (in points)
* @return int font ascent
* @public
* @author Nicola Asuni
* @since 4.9.003 (2010-03-30)
*/
public function getFontAscent($font, $style = '', $size = 0)
{
}
/**
* Return true in the character is present in the specified font.
* @param $char (mixed) Character to check (integer value or string)
* @param $font (string) Font name (family name).
* @param $style (string) Font style.
* @return (boolean) true if the char is defined, false otherwise.
* @public
* @since 5.9.153 (2012-03-28)
*/
public function isCharDefined($char, $font = '', $style = '')
{
}
/**
* Replace missing font characters on selected font with specified substitutions.
* @param $text (string) Text to process.
* @param $font (string) Font name (family name).
* @param $style (string) Font style.
* @param $subs (array) Array of possible character substitutions. The key is the character to check (integer value) and the value is a single intege value or an array of possible substitutes.
* @return (string) Processed text.
* @public
* @since 5.9.153 (2012-03-28)
*/
public function replaceMissingChars($text, $font = '', $style = '', $subs = array())
{
}
/**
* Defines the default monospaced font.
* @param $font (string) Font name.
* @public
* @since 4.5.025
*/
public function SetDefaultMonospacedFont($font)
{
}
/**
* Creates a new internal link and returns its identifier. An internal link is a clickable area which directs to another place within the document.<br />
* The identifier can then be passed to Cell(), Write(), Image() or Link(). The destination is defined with SetLink().
* @public
* @since 1.5
* @see Cell(), Write(), Image(), Link(), SetLink()
*/
public function AddLink()
{
}
/**
* Defines the page and position a link points to.
* @param $link (int) The link identifier returned by AddLink()
* @param $y (float) Ordinate of target position; -1 indicates the current position. The default value is 0 (top of page)
* @param $page (int) Number of target page; -1 indicates the current page (default value). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.
* @public
* @since 1.5
* @see AddLink()
*/
public function SetLink($link, $y = 0, $page = -1)
{
}
/**
* Puts a link on a rectangular area of the page.
* Text or image links are generally put via Cell(), Write() or Image(), but this method can be useful for instance to define a clickable area inside an image.
* @param $x (float) Abscissa of the upper-left corner of the rectangle
* @param $y (float) Ordinate of the upper-left corner of the rectangle
* @param $w (float) Width of the rectangle
* @param $h (float) Height of the rectangle
* @param $link (mixed) URL or identifier returned by AddLink()
* @param $spaces (int) number of spaces on the text to link
* @public
* @since 1.5
* @see AddLink(), Annotation(), Cell(), Write(), Image()
*/
public function Link($x, $y, $w, $h, $link, $spaces = 0)
{
}
/**
* Puts a markup annotation on a rectangular area of the page.
* !!!!THE ANNOTATION SUPPORT IS NOT YET FULLY IMPLEMENTED !!!!
* @param $x (float) Abscissa of the upper-left corner of the rectangle
* @param $y (float) Ordinate of the upper-left corner of the rectangle
* @param $w (float) Width of the rectangle
* @param $h (float) Height of the rectangle
* @param $text (string) annotation text or alternate content
* @param $opt (array) array of options (see section 8.4 of PDF reference 1.7).
* @param $spaces (int) number of spaces on the text to link
* @public
* @since 4.0.018 (2008-08-06)
*/
public function Annotation($x, $y, $w, $h, $text, $opt = array('Subtype' => 'Text'), $spaces = 0)
{
}
/**
* Embedd the attached files.
* @since 4.4.000 (2008-12-07)
* @protected
* @see Annotation()
*/
protected function _putEmbeddedFiles()
{
}
/**
* Prints a text cell at the specified position.
* This method allows to place a string precisely on the page.
* @param $x (float) Abscissa of the cell origin
* @param $y (float) Ordinate of the cell origin
* @param $txt (string) String to print
* @param $fstroke (int) outline size in user units (false = disable)
* @param $fclip (boolean) if true activate clipping mode (you must call StartTransform() before this function and StopTransform() to stop the clipping tranformation).
* @param $ffill (boolean) if true fills the text
* @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
* @param $align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
* @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
* @param $link (mixed) URL or identifier returned by AddLink().
* @param $stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
* @param $ignore_min_height (boolean) if true ignore automatic minimum height value.
* @param $calign (string) cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li><li>B : cell bottom</li></ul>
* @param $valign (string) text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>C : center</li><li>B : bottom</li></ul>
* @param $rtloff (boolean) if true uses the page top-left corner as origin of axis for $x and $y initial position.
* @public
* @since 1.0
* @see Cell(), Write(), MultiCell(), WriteHTML(), WriteHTMLCell()
*/
public function Text($x, $y, $txt, $fstroke = \false, $fclip = \false, $ffill = \true, $border = 0, $ln = 0, $align = '', $fill = \false, $link = '', $stretch = 0, $ignore_min_height = \false, $calign = 'T', $valign = 'M', $rtloff = \false)
{
}
/**
* Whenever a page break condition is met, the method is called, and the break is issued or not depending on the returned value.
* The default implementation returns a value according to the mode selected by SetAutoPageBreak().<br />
* This method is called automatically and should not be called directly by the application.
* @return boolean
* @public
* @since 1.4
* @see SetAutoPageBreak()
*/
public function AcceptPageBreak()
{
}
/**
* Add page if needed.
* @param $h (float) Cell height. Default value: 0.
* @param $y (mixed) starting y position, leave empty for current position.
* @param $addpage (boolean) if true add a page, otherwise only return the true/false state
* @return boolean true in case of page break, false otherwise.
* @since 3.2.000 (2008-07-01)
* @protected
*/
protected function checkPageBreak($h = 0, $y = '', $addpage = \true)
{
}
/**
* Prints a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br />
* If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
* @param $w (float) Cell width. If 0, the cell extends up to the right margin.
* @param $h (float) Cell height. Default value: 0.
* @param $txt (string) String to print. Default value: empty string.
* @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul> Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
* @param $align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
* @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
* @param $link (mixed) URL or identifier returned by AddLink().
* @param $stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
* @param $ignore_min_height (boolean) if true ignore automatic minimum height value.
* @param $calign (string) cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>C : center</li><li>B : cell bottom</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li></ul>
* @param $valign (string) text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>C : center</li><li>B : bottom</li></ul>
* @public
* @since 1.0
* @see SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), AddLink(), Ln(), MultiCell(), Write(), SetAutoPageBreak()
*/
public function Cell($w, $h = 0, $txt = '', $border = 0, $ln = 0, $align = '', $fill = \false, $link = '', $stretch = 0, $ignore_min_height = \false, $calign = 'T', $valign = 'M')
{
}
/**
* Returns the PDF string code to print a cell (rectangular area) with optional borders, background color and character string. The upper-left corner of the cell corresponds to the current position. The text can be aligned or centered. After the call, the current position moves to the right or to the next line. It is possible to put a link on the text.<br />
* If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
* @param $w (float) Cell width. If 0, the cell extends up to the right margin.
* @param $h (float) Cell height. Default value: 0.
* @param $txt (string) String to print. Default value: empty string.
* @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL languages)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
* @param $align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
* @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
* @param $link (mixed) URL or identifier returned by AddLink().
* @param $stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
* @param $ignore_min_height (boolean) if true ignore automatic minimum height value.
* @param $calign (string) cell vertical alignment relative to the specified Y value. Possible values are:<ul><li>T : cell top</li><li>C : center</li><li>B : cell bottom</li><li>A : font top</li><li>L : font baseline</li><li>D : font bottom</li></ul>
* @param $valign (string) text vertical alignment inside the cell. Possible values are:<ul><li>T : top</li><li>M : middle</li><li>B : bottom</li></ul>
* @return string containing cell code
* @protected
* @since 1.0
* @see Cell()
*/
protected function getCellCode($w, $h = 0, $txt = '', $border = 0, $ln = 0, $align = '', $fill = \false, $link = '', $stretch = 0, $ignore_min_height = \false, $calign = 'T', $valign = 'M')
{
}
/**
* Replace a char if is defined on the current font.
* @param $oldchar (int) Integer code (unicode) of the character to replace.
* @param $newchar (int) Integer code (unicode) of the new character.
* @return int the replaced char or the old char in case the new char i not defined
* @protected
* @since 5.9.167 (2012-06-22)
*/
protected function replaceChar($oldchar, $newchar)
{
}
/**
* Returns the code to draw the cell border
* @param $x (float) X coordinate.
* @param $y (float) Y coordinate.
* @param $w (float) Cell width.
* @param $h (float) Cell height.
* @param $brd (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return string containing cell border code
* @protected
* @see SetLineStyle()
* @since 5.7.000 (2010-08-02)
*/
protected function getCellBorder($x, $y, $w, $h, $brd)
{
}
/**
* This method allows printing text with line breaks.
* They can be automatic (as soon as the text reaches the right border of the cell) or explicit (via the \n character). As many cells as necessary are output, one below the other.<br />
* Text can be aligned, centered or justified. The cell block can be framed and the background painted.
* @param $w (float) Width of cells. If 0, they extend up to the right margin of the page.
* @param $h (float) Cell minimum height. The cell extends automatically if needed.
* @param $txt (string) String to print
* @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param $align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align</li><li>C: center</li><li>R: right align</li><li>J: justification (default value when $ishtml=false)</li></ul>
* @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
* @param $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right</li><li>1: to the beginning of the next line [DEFAULT]</li><li>2: below</li></ul>
* @param $x (float) x position in user units
* @param $y (float) y position in user units
* @param $reseth (boolean) if true reset the last cell height (default true).
* @param $stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
* @param $ishtml (boolean) INTERNAL USE ONLY -- set to true if $txt is HTML content (default = false). Never set this parameter to true, use instead writeHTMLCell() or writeHTML() methods.
* @param $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width.
* @param $maxh (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature. This feature works only when $ishtml=false.
* @param $valign (string) Vertical alignment of text (requires $maxh = $h > 0). Possible values are:<ul><li>T: TOP</li><li>M: middle</li><li>B: bottom</li></ul>. This feature works only when $ishtml=false and the cell must fit in a single page.
* @param $fitcell (boolean) if true attempt to fit all the text within the cell by reducing the font size (do not work in HTML mode). $maxh must be greater than 0 and equal to $h.
* @return int Return the number of cells or 1 for html mode.
* @public
* @since 1.3
* @see SetFont(), SetDrawColor(), SetFillColor(), SetTextColor(), SetLineWidth(), Cell(), Write(), SetAutoPageBreak()
*/
public function MultiCell($w, $h, $txt, $border = 0, $align = 'J', $fill = \false, $ln = 1, $x = '', $y = '', $reseth = \true, $stretch = 0, $ishtml = \false, $autopadding = \true, $maxh = 0, $valign = 'T', $fitcell = \false)
{
}
/**
* This method return the estimated number of lines for print a simple text string using Multicell() method.
* @param $txt (string) String for calculating his height
* @param $w (float) Width of cells. If 0, they extend up to the right margin of the page.
* @param $reseth (boolean) if true reset the last cell height (default false).
* @param $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true).
* @param $cellpadding (float) Internal cell padding, if empty uses default cell padding.
* @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return float Return the minimal height needed for multicell method for printing the $txt param.
* @author Alexander Escalona Fern\E1ndez, Nicola Asuni
* @public
* @since 4.5.011
*/
public function getNumLines($txt, $w = 0, $reseth = \false, $autopadding = \true, $cellpadding = '', $border = 0)
{
}
/**
* This method return the estimated height needed for printing a simple text string using the Multicell() method.
* Generally, if you want to know the exact height for a block of content you can use the following alternative technique:
* @pre
* // store current object
* $pdf->startTransaction();
* // store starting values
* $start_y = $pdf->GetY();
* $start_page = $pdf->getPage();
* // call your printing functions with your parameters
* // - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
* $pdf->MultiCell($w=0, $h=0, $txt, $border=1, $align='L', $fill=false, $ln=1, $x='', $y='', $reseth=true, $stretch=0, $ishtml=false, $autopadding=true, $maxh=0);
* // - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
* // get the new Y
* $end_y = $pdf->GetY();
* $end_page = $pdf->getPage();
* // calculate height
* $height = 0;
* if ($end_page == $start_page) {
* $height = $end_y - $start_y;
* } else {
* for ($page=$start_page; $page <= $end_page; ++$page) {
* $this->setPage($page);
* if ($page == $start_page) {
* // first page
* $height = $this->h - $start_y - $this->bMargin;
* } elseif ($page == $end_page) {
* // last page
* $height = $end_y - $this->tMargin;
* } else {
* $height = $this->h - $this->tMargin - $this->bMargin;
* }
* }
* }
* // restore previous object
* $pdf = $pdf->rollbackTransaction();
*
* @param $w (float) Width of cells. If 0, they extend up to the right margin of the page.
* @param $txt (string) String for calculating his height
* @param $reseth (boolean) if true reset the last cell height (default false).
* @param $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width (default true).
* @param $cellpadding (float) Internal cell padding, if empty uses default cell padding.
* @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @return float Return the minimal height needed for multicell method for printing the $txt param.
* @author Nicola Asuni, Alexander Escalona Fern\E1ndez
* @public
*/
public function getStringHeight($w, $txt, $reseth = \false, $autopadding = \true, $cellpadding = '', $border = 0)
{
}
/**
* This method prints text from the current position.<br />
* @param $h (float) Line height
* @param $txt (string) String to print
* @param $link (mixed) URL or identifier returned by AddLink()
* @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
* @param $align (string) Allows to center or align the text. Possible values are:<ul><li>L or empty string: left align (default value)</li><li>C: center</li><li>R: right align</li><li>J: justify</li></ul>
* @param $ln (boolean) if true set cursor at the bottom of the line, otherwise set cursor at the top of the line.
* @param $stretch (int) font stretch mode: <ul><li>0 = disabled</li><li>1 = horizontal scaling only if text is larger than cell width</li><li>2 = forced horizontal scaling to fit cell width</li><li>3 = character spacing only if text is larger than cell width</li><li>4 = forced character spacing to fit cell width</li></ul> General font stretching and scaling values will be preserved when possible.
* @param $firstline (boolean) if true prints only the first line and return the remaining string.
* @param $firstblock (boolean) if true the string is the starting of a line.
* @param $maxh (float) maximum height. It should be >= $h and less then remaining space to the bottom of the page, or 0 for disable this feature.
* @param $wadj (float) first line width will be reduced by this amount (used in HTML mode).
* @param $margin (array) margin array of the parent container
* @return mixed Return the number of cells or the remaining string if $firstline = true.
* @public
* @since 1.5
*/
public function Write($h, $txt, $link = '', $fill = \false, $align = '', $ln = \false, $stretch = 0, $firstline = \false, $firstblock = \false, $maxh = 0, $wadj = 0, $margin = '')
{
}
/**
* Returns the remaining width between the current position and margins.
* @return int Return the remaining width
* @protected
*/
protected function getRemainingWidth()
{
}
/**
* Set the block dimensions accounting for page breaks and page/column fitting
* @param $w (float) width
* @param $h (float) height
* @param $x (float) X coordinate
* @param $y (float) Y coodiante
* @param $fitonpage (boolean) if true the block is resized to not exceed page dimensions.
* @return array($w, $h, $x, $y)
* @protected
* @since 5.5.009 (2010-07-05)
*/
protected function fitBlock($w, $h, $x, $y, $fitonpage = \false)
{
}
/**
* Puts an image in the page.
* The upper-left corner must be given.
* The dimensions can be specified in different ways:<ul>
* <li>explicit width and height (expressed in user unit)</li>
* <li>one explicit dimension, the other being calculated automatically in order to keep the original proportions</li>
* <li>no explicit dimension, in which case the image is put at 72 dpi</li></ul>
* Supported formats are JPEG and PNG images whitout GD library and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;
* The format can be specified explicitly or inferred from the file extension.<br />
* It is possible to put a link on the image.<br />
* Remark: if an image is used several times, only one copy will be embedded in the file.<br />
* @param $file (string) Name of the file containing the image or a '@' character followed by the image data string. To link an image without embedding it on the document, set an asterisk character before the URL (i.e.: '*http://www.example.com/image.jpg').
* @param $x (float) Abscissa of the upper-left corner (LTR) or upper-right corner (RTL).
* @param $y (float) Ordinate of the upper-left corner (LTR) or upper-right corner (RTL).
* @param $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param $type (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
* @param $link (mixed) URL or identifier returned by AddLink().
* @param $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @param $resize (mixed) If true resize (reduce) the image to fit $w and $h (requires GD or ImageMagick library); if false do not resize; if 2 force resize in all cases (upscaling and downscaling).
* @param $dpi (int) dot-per-inch resolution used on resize
* @param $palign (string) Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param $ismask (boolean) true if this image is a mask, false otherwise
* @param $imgmask (mixed) image object returned by this function or false
* @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param $fitbox (mixed) If not false scale image dimensions proportionally to fit within the ($w, $h) box. $fitbox can be true or a 2 characters string indicating the image alignment inside the box. The first character indicate the horizontal alignment (L = left, C = center, R = right) the second character indicate the vertical algnment (T = top, M = middle, B = bottom).
* @param $hidden (boolean) If true do not display the image.
* @param $fitonpage (boolean) If true the image is resized to not exceed page dimensions.
* @param $alt (boolean) If true the image will be added as alternative and not directly printed (the ID of the image will be returned).
* @param $altimgs (array) Array of alternate images IDs. Each alternative image must be an array with two values: an integer representing the image ID (the value returned by the Image method) and a boolean value to indicate if the image is the default for printing.
* @return image information
* @public
* @since 1.1
*/
public function Image($file, $x = '', $y = '', $w = 0, $h = 0, $type = '', $link = '', $align = '', $resize = \false, $dpi = 300, $palign = '', $ismask = \false, $imgmask = \false, $border = 0, $fitbox = \false, $hidden = \false, $fitonpage = \false, $alt = \false, $altimgs = array())
{
}
/**
* Extract info from a PNG image with alpha channel using the Imagick or GD library.
* @param $file (string) Name of the file containing the image.
* @param $x (float) Abscissa of the upper-left corner.
* @param $y (float) Ordinate of the upper-left corner.
* @param $wpx (float) Original width of the image in pixels.
* @param $hpx (float) original height of the image in pixels.
* @param $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param $type (string) Image format. Possible values are (case insensitive): JPEG and PNG (whitout GD library) and all images supported by GD: GD, GD2, GD2PART, GIF, JPEG, PNG, BMP, XBM, XPM;. If not specified, the type is inferred from the file extension.
* @param $link (mixed) URL or identifier returned by AddLink().
* @param $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @param $resize (boolean) If true resize (reduce) the image to fit $w and $h (requires GD library).
* @param $dpi (int) dot-per-inch resolution used on resize
* @param $palign (string) Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param $filehash (string) File hash used to build unique file names.
* @author Nicola Asuni
* @protected
* @since 4.3.007 (2008-12-04)
* @see Image()
*/
protected function ImagePngAlpha($file, $x, $y, $wpx, $hpx, $w, $h, $type, $link, $align, $resize, $dpi, $palign, $filehash = '')
{
}
/**
* Get the GD-corrected PNG gamma value from alpha color
* @param $img (int) GD image Resource ID.
* @param $c (int) alpha color
* @protected
* @since 4.3.007 (2008-12-04)
*/
protected function getGDgamma($img, $c)
{
}
/**
* Performs a line break.
* The current abscissa goes back to the left margin and the ordinate increases by the amount passed in parameter.
* @param $h (float) The height of the break. By default, the value equals the height of the last printed cell.
* @param $cell (boolean) if true add the current left (or right o for RTL) padding to the X coordinate
* @public
* @since 1.0
* @see Cell()
*/
public function Ln($h = '', $cell = \false)
{
}
/**
* Returns the relative X value of current position.
* The value is relative to the left border for LTR languages and to the right border for RTL languages.
* @return float
* @public
* @since 1.2
* @see SetX(), GetY(), SetY()
*/
public function GetX()
{
}
/**
* Returns the absolute X value of current position.
* @return float
* @public
* @since 1.2
* @see SetX(), GetY(), SetY()
*/
public function GetAbsX()
{
}
/**
* Returns the ordinate of the current position.
* @return float
* @public
* @since 1.0
* @see SetY(), GetX(), SetX()
*/
public function GetY()
{
}
/**
* Defines the abscissa of the current position.
* If the passed value is negative, it is relative to the right of the page (or left if language is RTL).
* @param $x (float) The value of the abscissa in user units.
* @param $rtloff (boolean) if true always uses the page top-left corner as origin of axis.
* @public
* @since 1.2
* @see GetX(), GetY(), SetY(), SetXY()
*/
public function SetX($x, $rtloff = \false)
{
}
/**
* Moves the current abscissa back to the left margin and sets the ordinate.
* If the passed value is negative, it is relative to the bottom of the page.
* @param $y (float) The value of the ordinate in user units.
* @param $resetx (bool) if true (default) reset the X position.
* @param $rtloff (boolean) if true always uses the page top-left corner as origin of axis.
* @public
* @since 1.0
* @see GetX(), GetY(), SetY(), SetXY()
*/
public function SetY($y, $resetx = \true, $rtloff = \false)
{
}
/**
* Defines the abscissa and ordinate of the current position.
* If the passed values are negative, they are relative respectively to the right and bottom of the page.
* @param $x (float) The value of the abscissa.
* @param $y (float) The value of the ordinate.
* @param $rtloff (boolean) if true always uses the page top-left corner as origin of axis.
* @public
* @since 1.2
* @see SetX(), SetY()
*/
public function SetXY($x, $y, $rtloff = \false)
{
}
/**
* Set the absolute X coordinate of the current pointer.
* @param $x (float) The value of the abscissa in user units.
* @public
* @since 5.9.186 (2012-09-13)
* @see setAbsX(), setAbsY(), SetAbsXY()
*/
public function SetAbsX($x)
{
}
/**
* Set the absolute Y coordinate of the current pointer.
* @param $y (float) (float) The value of the ordinate in user units.
* @public
* @since 5.9.186 (2012-09-13)
* @see setAbsX(), setAbsY(), SetAbsXY()
*/
public function SetAbsY($y)
{
}
/**
* Set the absolute X and Y coordinates of the current pointer.
* @param $x (float) The value of the abscissa in user units.
* @param $y (float) (float) The value of the ordinate in user units.
* @public
* @since 5.9.186 (2012-09-13)
* @see setAbsX(), setAbsY(), SetAbsXY()
*/
public function SetAbsXY($x, $y)
{
}
/**
* Send the document to a given destination: string, local file or browser.
* In the last case, the plug-in may be used (if present) or a download ("Save as" dialog box) may be forced.<br />
* The method first calls Close() if necessary to terminate the document.
* @param $name (string) The name of the file when saved. Note that special characters are removed and blanks characters are replaced with the underscore character.
* @param $dest (string) Destination where to send the document. It can take one of the following values:<ul><li>I: send the file inline to the browser (default). The plug-in is used if available. The name given by name is used when one selects the "Save as" option on the link generating the PDF.</li><li>D: send to the browser and force a file download with the name given by name.</li><li>F: save to a local server file with the name given by name.</li><li>S: return the document as a string (name is ignored).</li><li>FI: equivalent to F + I option</li><li>FD: equivalent to F + D option</li><li>E: return the document as base64 mime multi-part email attachment (RFC 2045)</li></ul>
* @return string
* @public
* @since 1.0
* @see Close()
*/
public function Output($name = 'doc.pdf', $dest = 'I')
{
}
/**
* Unset all class variables except the following critical variables.
* @param $destroyall (boolean) if true destroys all class variables, otherwise preserves critical variables.
* @param $preserve_objcopy (boolean) if true preserves the objcopy variable
* @public
* @since 4.5.016 (2009-02-24)
*/
public function _destroy($destroyall = \false, $preserve_objcopy = \false)
{
}
/**
* Check for locale-related bug
* @protected
*/
protected function _dochecks()
{
}
/**
* Return an array containing variations for the basic page number alias.
* @param $a (string) Base alias.
* @return array of page number aliases
* @protected
*/
protected function getInternalPageNumberAliases($a = '')
{
}
/**
* Return an array containing all internal page aliases.
* @return array of page number aliases
* @protected
*/
protected function getAllInternalPageNumberAliases()
{
}
/**
* Replace right shift page number aliases with spaces to correct right alignment.
* This works perfectly only when using monospaced fonts.
* @param $page (string) Page content.
* @param $aliases (array) Array of page aliases.
* @param $diff (int) initial difference to add.
* @return replaced page content.
* @protected
*/
protected function replaceRightShiftPageNumAliases($page, $aliases, $diff)
{
}
/**
* Set page boxes to be included on page descriptions.
* @param $boxes (array) Array of page boxes to set on document: ('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox').
* @protected
*/
protected function setPageBoxTypes($boxes)
{
}
/**
* Output pages (and replace page number aliases).
* @protected
*/
protected function _putpages()
{
}
/**
* Get references to page annotations.
* @param $n (int) page number
* @return string
* @protected
* @author Nicola Asuni
* @since 5.0.010 (2010-05-17)
*/
protected function _getannotsrefs($n)
{
}
/**
* Output annotations objects for all pages.
* !!! THIS METHOD IS NOT YET COMPLETED !!!
* See section 12.5 of PDF 32000_2008 reference.
* @protected
* @author Nicola Asuni
* @since 4.0.018 (2008-08-06)
*/
protected function _putannotsobjs()
{
}
/**
* Put appearance streams XObject used to define annotation's appearance states.
* @param $w (int) annotation width
* @param $h (int) annotation height
* @param $stream (string) appearance stream
* @return int object ID
* @protected
* @since 4.8.001 (2009-09-09)
*/
protected function _putAPXObject($w = 0, $h = 0, $stream = '')
{
}
/**
* Output fonts.
* @author Nicola Asuni
* @protected
*/
protected function _putfonts()
{
}
/**
* Adds unicode fonts.<br>
* Based on PDF Reference 1.3 (section 5)
* @param $font (array) font data
* @protected
* @author Nicola Asuni
* @since 1.52.0.TC005 (2005-01-05)
*/
protected function _puttruetypeunicode($font)
{
}
/**
* Output CID-0 fonts.
* A Type 0 CIDFont contains glyph descriptions based on the Adobe Type 1 font format
* @param $font (array) font data
* @protected
* @author Andrew Whitehead, Nicola Asuni, Yukihiro Nakadaira
* @since 3.2.000 (2008-06-23)
*/
protected function _putcidfont0($font)
{
}
/**
* Output images.
* @protected
*/
protected function _putimages()
{
}
/**
* Output Form XObjects Templates.
* @author Nicola Asuni
* @since 5.8.017 (2010-08-24)
* @protected
* @see startTemplate(), endTemplate(), printTemplate()
*/
protected function _putxobjects()
{
}
/**
* Output Spot Colors Resources.
* @protected
* @since 4.0.024 (2008-09-12)
*/
protected function _putspotcolors()
{
}
/**
* Return XObjects Dictionary.
* @return string XObjects dictionary
* @protected
* @since 5.8.014 (2010-08-23)
*/
protected function _getxobjectdict()
{
}
/**
* Output Resources Dictionary.
* @protected
*/
protected function _putresourcedict()
{
}
/**
* Output Resources.
* @protected
*/
protected function _putresources()
{
}
/**
* Adds some Metadata information (Document Information Dictionary)
* (see Chapter 14.3.3 Document Information Dictionary of PDF32000_2008.pdf Reference)
* @return int object id
* @protected
*/
protected function _putinfo()
{
}
/**
* Set additional XMP data to be added on the default XMP data just before the end of "x:xmpmeta" tag.
* IMPORTANT: This data is added as-is without controls, so you have to validate your data before using this method!
* @param $xmp (string) Custom XMP data.
* @since 5.9.128 (2011-10-06)
* @public
*/
public function setExtraXMP($xmp)
{
}
/**
* Put XMP data object and return ID.
* @return (int) The object ID.
* @since 5.9.121 (2011-09-28)
* @protected
*/
protected function _putXMP()
{
}
/**
* Output Catalog.
* @return int object id
* @protected
*/
protected function _putcatalog()
{
}
/**
* Output viewer preferences.
* @return string for viewer preferences
* @author Nicola asuni
* @since 3.1.000 (2008-06-09)
* @protected
*/
protected function _putviewerpreferences()
{
}
/**
* Output PDF File Header (7.5.2).
* @protected
*/
protected function _putheader()
{
}
/**
* Output end of document (EOF).
* @protected
*/
protected function _enddoc()
{
}
/**
* Initialize a new page.
* @param $orientation (string) page orientation. Possible values are (case insensitive):<ul><li>P or PORTRAIT (default)</li><li>L or LANDSCAPE</li></ul>
* @param $format (mixed) The format used for pages. It can be either: one of the string values specified at getPageSizeFromFormat() or an array of parameters specified at setPageFormat().
* @protected
* @see getPageSizeFromFormat(), setPageFormat()
*/
protected function _beginpage($orientation = '', $format = '')
{
}
/**
* Mark end of page.
* @protected
*/
protected function _endpage()
{
}
/**
* Begin a new object and return the object number.
* @return int object number
* @protected
*/
protected function _newobj()
{
}
/**
* Return the starting object string for the selected object ID.
* @param $objid (int) Object ID (leave empty to get a new ID).
* @return string the starting object string
* @protected
* @since 5.8.009 (2010-08-20)
*/
protected function _getobj($objid = '')
{
}
/**
* Underline text.
* @param $x (int) X coordinate
* @param $y (int) Y coordinate
* @param $txt (string) text to underline
* @protected
*/
protected function _dounderline($x, $y, $txt)
{
}
/**
* Underline for rectangular text area.
* @param $x (int) X coordinate
* @param $y (int) Y coordinate
* @param $w (int) width to underline
* @protected
* @since 4.8.008 (2009-09-29)
*/
protected function _dounderlinew($x, $y, $w)
{
}
/**
* Line through text.
* @param $x (int) X coordinate
* @param $y (int) Y coordinate
* @param $txt (string) text to linethrough
* @protected
*/
protected function _dolinethrough($x, $y, $txt)
{
}
/**
* Line through for rectangular text area.
* @param $x (int) X coordinate
* @param $y (int) Y coordinate
* @param $w (int) line length (width)
* @protected
* @since 4.9.008 (2009-09-29)
*/
protected function _dolinethroughw($x, $y, $w)
{
}
/**
* Overline text.
* @param $x (int) X coordinate
* @param $y (int) Y coordinate
* @param $txt (string) text to overline
* @protected
* @since 4.9.015 (2010-04-19)
*/
protected function _dooverline($x, $y, $txt)
{
}
/**
* Overline for rectangular text area.
* @param $x (int) X coordinate
* @param $y (int) Y coordinate
* @param $w (int) width to overline
* @protected
* @since 4.9.015 (2010-04-19)
*/
protected function _dooverlinew($x, $y, $w)
{
}
/**
* Format a data string for meta information
* @param $s (string) data string to escape.
* @param $n (int) object ID
* @return string escaped string.
* @protected
*/
protected function _datastring($s, $n = 0)
{
}
/**
* Set the document creation timestamp
* @param $time (mixed) Document creation timestamp in seconds or date-time string.
* @public
* @since 5.9.152 (2012-03-23)
*/
public function setDocCreationTimestamp($time)
{
}
/**
* Set the document modification timestamp
* @param $time (mixed) Document modification timestamp in seconds or date-time string.
* @public
* @since 5.9.152 (2012-03-23)
*/
public function setDocModificationTimestamp($time)
{
}
/**
* Returns document creation timestamp in seconds.
* @return (int) Creation timestamp in seconds.
* @public
* @since 5.9.152 (2012-03-23)
*/
public function getDocCreationTimestamp()
{
}
/**
* Returns document modification timestamp in seconds.
* @return (int) Modfication timestamp in seconds.
* @public
* @since 5.9.152 (2012-03-23)
*/
public function getDocModificationTimestamp()
{
}
/**
* Returns a formatted date for meta information
* @param $n (int) Object ID.
* @param $timestamp (int) Timestamp to convert.
* @return string escaped date string.
* @protected
* @since 4.6.028 (2009-08-25)
*/
protected function _datestring($n = 0, $timestamp = 0)
{
}
/**
* Format a text string for meta information
* @param $s (string) string to escape.
* @param $n (int) object ID
* @return string escaped string.
* @protected
*/
protected function _textstring($s, $n = 0)
{
}
/**
* get raw output stream.
* @param $s (string) string to output.
* @param $n (int) object reference for encryption mode
* @protected
* @author Nicola Asuni
* @since 5.5.000 (2010-06-22)
*/
protected function _getrawstream($s, $n = 0)
{
}
/**
* Output a string to the document.
* @param $s (string) string to output.
* @protected
*/
protected function _out($s)
{
}
/**
* Set header font.
* @param $font (array) Array describing the basic font parameters: (family, style, size).
* @public
* @since 1.1
*/
public function setHeaderFont($font)
{
}
/**
* Get header font.
* @return array() Array describing the basic font parameters: (family, style, size).
* @public
* @since 4.0.012 (2008-07-24)
*/
public function getHeaderFont()
{
}
/**
* Set footer font.
* @param $font (array) Array describing the basic font parameters: (family, style, size).
* @public
* @since 1.1
*/
public function setFooterFont($font)
{
}
/**
* Get Footer font.
* @return array() Array describing the basic font parameters: (family, style, size).
* @public
* @since 4.0.012 (2008-07-24)
*/
public function getFooterFont()
{
}
/**
* Set language array.
* @param $language (array)
* @public
* @since 1.1
*/
public function setLanguageArray($language)
{
}
/**
* Returns the PDF data.
* @public
*/
public function getPDFData()
{
}
/**
* Output anchor link.
* @param $url (string) link URL or internal link (i.e.: <a href="#23,4.5">link to page 23 at 4.5 Y position</a>)
* @param $name (string) link name
* @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
* @param $firstline (boolean) if true prints only the first line and return the remaining string.
* @param $color (array) array of RGB text color
* @param $style (string) font style (U, D, B, I)
* @param $firstblock (boolean) if true the string is the starting of a line.
* @return the number of cells used or the remaining text if $firstline = true;
* @public
*/
public function addHtmlLink($url, $name, $fill = \false, $firstline = \false, $color = '', $style = -1, $firstblock = \false)
{
}
/**
* Converts pixels to User's Units.
* @param $px (int) pixels
* @return float value in user's unit
* @public
* @see setImageScale(), getImageScale()
*/
public function pixelsToUnits($px)
{
}
/**
* Reverse function for htmlentities.
* Convert entities in UTF-8.
* @param $text_to_convert (string) Text to convert.
* @return string converted text string
* @public
*/
public function unhtmlentities($text_to_convert)
{
}
// ENCRYPTION METHODS ----------------------------------
/**
* Compute encryption key depending on object number where the encrypted data is stored.
* This is used for all strings and streams without crypt filter specifier.
* @param $n (int) object number
* @return int object key
* @protected
* @author Nicola Asuni
* @since 2.0.000 (2008-01-02)
*/
protected function _objectkey($n)
{
}
/**
* Encrypt the input string.
* @param $n (int) object number
* @param $s (string) data string to encrypt
* @return encrypted string
* @protected
* @author Nicola Asuni
* @since 5.0.005 (2010-05-11)
*/
protected function _encrypt_data($n, $s)
{
}
/**
* Put encryption on PDF document.
* @protected
* @author Nicola Asuni
* @since 2.0.000 (2008-01-02)
*/
protected function _putencryption()
{
}
/**
* Compute U value (used for encryption)
* @return string U value
* @protected
* @since 2.0.000 (2008-01-02)
* @author Nicola Asuni
*/
protected function _Uvalue()
{
}
/**
* Compute UE value (used for encryption)
* @return string UE value
* @protected
* @since 5.9.006 (2010-10-19)
* @author Nicola Asuni
*/
protected function _UEvalue()
{
}
/**
* Compute O value (used for encryption)
* @return string O value
* @protected
* @since 2.0.000 (2008-01-02)
* @author Nicola Asuni
*/
protected function _Ovalue()
{
}
/**
* Compute OE value (used for encryption)
* @return string OE value
* @protected
* @since 5.9.006 (2010-10-19)
* @author Nicola Asuni
*/
protected function _OEvalue()
{
}
/**
* Convert password for AES-256 encryption mode
* @param $password (string) password
* @return string password
* @protected
* @since 5.9.006 (2010-10-19)
* @author Nicola Asuni
*/
protected function _fixAES256Password($password)
{
}
/**
* Compute encryption key
* @protected
* @since 2.0.000 (2008-01-02)
* @author Nicola Asuni
*/
protected function _generateencryptionkey()
{
}
/**
* Set document protection
* Remark: the protection against modification is for people who have the full Acrobat product.
* If you don't set any password, the document will open as usual. If you set a user password, the PDF viewer will ask for it before displaying the document. The master password, if different from the user one, can be used to get full access.
* Note: protecting a document requires to encrypt it, which increases the processing time a lot. This can cause a PHP time-out in some cases, especially if the document contains images or fonts.
* @param $permissions (Array) the set of permissions (specify the ones you want to block):<ul><li>print : Print the document;</li><li>modify : Modify the contents of the document by operations other than those controlled by 'fill-forms', 'extract' and 'assemble';</li><li>copy : Copy or otherwise extract text and graphics from the document;</li><li>annot-forms : Add or modify text annotations, fill in interactive form fields, and, if 'modify' is also set, create or modify interactive form fields (including signature fields);</li><li>fill-forms : Fill in existing interactive form fields (including signature fields), even if 'annot-forms' is not specified;</li><li>extract : Extract text and graphics (in support of accessibility to users with disabilities or for other purposes);</li><li>assemble : Assemble the document (insert, rotate, or delete pages and create bookmarks or thumbnail images), even if 'modify' is not set;</li><li>print-high : Print the document to a representation from which a faithful digital copy of the PDF content could be generated. When this is not set, printing is limited to a low-level representation of the appearance, possibly of degraded quality.</li><li>owner : (inverted logic - only for public-key) when set permits change of encryption and enables all other permissions.</li></ul>
* @param $user_pass (String) user password. Empty by default.
* @param $owner_pass (String) owner password. If not specified, a random value is used.
* @param $mode (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.
* @param $pubkeys (String) array of recipients containing public-key certificates ('c') and permissions ('p'). For example: array(array('c' => 'file://../examples/data/cert/tcpdf.crt', 'p' => array('print')))
* @public
* @since 2.0.000 (2008-01-02)
* @author Nicola Asuni
*/
public function SetProtection($permissions = array('print', 'modify', 'copy', 'annot-forms', 'fill-forms', 'extract', 'assemble', 'print-high'), $user_pass = '', $owner_pass = \null, $mode = 0, $pubkeys = \null)
{
}
// END OF ENCRYPTION FUNCTIONS -------------------------
// START TRANSFORMATIONS SECTION -----------------------
/**
* Starts a 2D tranformation saving current graphic state.
* This function must be called before scaling, mirroring, translation, rotation and skewing.
* Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function StartTransform()
{
}
/**
* Stops a 2D tranformation restoring previous graphic state.
* This function must be called after scaling, mirroring, translation, rotation and skewing.
* Use StartTransform() before, and StopTransform() after the transformations to restore the normal behavior.
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function StopTransform()
{
}
/**
* Horizontal Scaling.
* @param $s_x (float) scaling factor for width as percent. 0 is not allowed.
* @param $x (int) abscissa of the scaling center. Default is current x position
* @param $y (int) ordinate of the scaling center. Default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function ScaleX($s_x, $x = '', $y = '')
{
}
/**
* Vertical Scaling.
* @param $s_y (float) scaling factor for height as percent. 0 is not allowed.
* @param $x (int) abscissa of the scaling center. Default is current x position
* @param $y (int) ordinate of the scaling center. Default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function ScaleY($s_y, $x = '', $y = '')
{
}
/**
* Vertical and horizontal proportional Scaling.
* @param $s (float) scaling factor for width and height as percent. 0 is not allowed.
* @param $x (int) abscissa of the scaling center. Default is current x position
* @param $y (int) ordinate of the scaling center. Default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function ScaleXY($s, $x = '', $y = '')
{
}
/**
* Vertical and horizontal non-proportional Scaling.
* @param $s_x (float) scaling factor for width as percent. 0 is not allowed.
* @param $s_y (float) scaling factor for height as percent. 0 is not allowed.
* @param $x (int) abscissa of the scaling center. Default is current x position
* @param $y (int) ordinate of the scaling center. Default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function Scale($s_x, $s_y, $x = '', $y = '')
{
}
/**
* Horizontal Mirroring.
* @param $x (int) abscissa of the point. Default is current x position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function MirrorH($x = '')
{
}
/**
* Verical Mirroring.
* @param $y (int) ordinate of the point. Default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function MirrorV($y = '')
{
}
/**
* Point reflection mirroring.
* @param $x (int) abscissa of the point. Default is current x position
* @param $y (int) ordinate of the point. Default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function MirrorP($x = '', $y = '')
{
}
/**
* Reflection against a straight line through point (x, y) with the gradient angle (angle).
* @param $angle (float) gradient angle of the straight line. Default is 0 (horizontal line).
* @param $x (int) abscissa of the point. Default is current x position
* @param $y (int) ordinate of the point. Default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function MirrorL($angle = 0, $x = '', $y = '')
{
}
/**
* Translate graphic object horizontally.
* @param $t_x (int) movement to the right (or left for RTL)
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function TranslateX($t_x)
{
}
/**
* Translate graphic object vertically.
* @param $t_y (int) movement to the bottom
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function TranslateY($t_y)
{
}
/**
* Translate graphic object horizontally and vertically.
* @param $t_x (int) movement to the right
* @param $t_y (int) movement to the bottom
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function Translate($t_x, $t_y)
{
}
/**
* Rotate object.
* @param $angle (float) angle in degrees for counter-clockwise rotation
* @param $x (int) abscissa of the rotation center. Default is current x position
* @param $y (int) ordinate of the rotation center. Default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function Rotate($angle, $x = '', $y = '')
{
}
/**
* Skew horizontally.
* @param $angle_x (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right)
* @param $x (int) abscissa of the skewing center. default is current x position
* @param $y (int) ordinate of the skewing center. default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function SkewX($angle_x, $x = '', $y = '')
{
}
/**
* Skew vertically.
* @param $angle_y (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
* @param $x (int) abscissa of the skewing center. default is current x position
* @param $y (int) ordinate of the skewing center. default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function SkewY($angle_y, $x = '', $y = '')
{
}
/**
* Skew.
* @param $angle_x (float) angle in degrees between -90 (skew to the left) and 90 (skew to the right)
* @param $angle_y (float) angle in degrees between -90 (skew to the bottom) and 90 (skew to the top)
* @param $x (int) abscissa of the skewing center. default is current x position
* @param $y (int) ordinate of the skewing center. default is current y position
* @public
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
public function Skew($angle_x, $angle_y, $x = '', $y = '')
{
}
/**
* Apply graphic transformations.
* @param $tm (array) transformation matrix
* @protected
* @since 2.1.000 (2008-01-07)
* @see StartTransform(), StopTransform()
*/
protected function Transform($tm)
{
}
// END TRANSFORMATIONS SECTION -------------------------
// START GRAPHIC FUNCTIONS SECTION ---------------------
// The following section is based on the code provided by David Hernandez Sanz
/**
* Defines the line width. By default, the value equals 0.2 mm. The method can be called before the first page is created and the value is retained from page to page.
* @param $width (float) The width.
* @public
* @since 1.0
* @see Line(), Rect(), Cell(), MultiCell()
*/
public function SetLineWidth($width)
{
}
/**
* Returns the current the line width.
* @return int Line width
* @public
* @since 2.1.000 (2008-01-07)
* @see Line(), SetLineWidth()
*/
public function GetLineWidth()
{
}
/**
* Set line style.
* @param $style (array) Line style. Array with keys among the following:
* <ul>
* <li>width (float): Width of the line in user units.</li>
* <li>cap (string): Type of cap to put on the line. Possible values are:
* butt, round, square. The difference between "square" and "butt" is that
* "square" projects a flat end past the end of the line.</li>
* <li>join (string): Type of join. Possible values are: miter, round,
* bevel.</li>
* <li>dash (mixed): Dash pattern. Is 0 (without dash) or string with
* series of length values, which are the lengths of the on and off dashes.
* For example: "2" represents 2 on, 2 off, 2 on, 2 off, ...; "2,1" is 2 on,
* 1 off, 2 on, 1 off, ...</li>
* <li>phase (integer): Modifier on the dash pattern which is used to shift
* the point at which the pattern starts.</li>
* <li>color (array): Draw color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName).</li>
* </ul>
* @param $ret (boolean) if true do not send the command.
* @return string the PDF command
* @public
* @since 2.1.000 (2008-01-08)
*/
public function SetLineStyle($style, $ret = \false)
{
}
/**
* Begin a new subpath by moving the current point to coordinates (x, y), omitting any connecting line segment.
* @param $x (float) Abscissa of point.
* @param $y (float) Ordinate of point.
* @protected
* @since 2.1.000 (2008-01-08)
*/
protected function _outPoint($x, $y)
{
}
/**
* Append a straight line segment from the current point to the point (x, y).
* The new current point shall be (x, y).
* @param $x (float) Abscissa of end point.
* @param $y (float) Ordinate of end point.
* @protected
* @since 2.1.000 (2008-01-08)
*/
protected function _outLine($x, $y)
{
}
/**
* Append a rectangle to the current path as a complete subpath, with lower-left corner (x, y) and dimensions widthand height in user space.
* @param $x (float) Abscissa of upper-left corner.
* @param $y (float) Ordinate of upper-left corner.
* @param $w (float) Width.
* @param $h (float) Height.
* @param $op (string) options
* @protected
* @since 2.1.000 (2008-01-08)
*/
protected function _outRect($x, $y, $w, $h, $op)
{
}
/**
* Append a cubic Bezier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x2, y2) as the Bezier control points.
* The new current point shall be (x3, y3).
* @param $x1 (float) Abscissa of control point 1.
* @param $y1 (float) Ordinate of control point 1.
* @param $x2 (float) Abscissa of control point 2.
* @param $y2 (float) Ordinate of control point 2.
* @param $x3 (float) Abscissa of end point.
* @param $y3 (float) Ordinate of end point.
* @protected
* @since 2.1.000 (2008-01-08)
*/
protected function _outCurve($x1, $y1, $x2, $y2, $x3, $y3)
{
}
/**
* Append a cubic Bezier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using the current point and (x2, y2) as the Bezier control points.
* The new current point shall be (x3, y3).
* @param $x2 (float) Abscissa of control point 2.
* @param $y2 (float) Ordinate of control point 2.
* @param $x3 (float) Abscissa of end point.
* @param $y3 (float) Ordinate of end point.
* @protected
* @since 4.9.019 (2010-04-26)
*/
protected function _outCurveV($x2, $y2, $x3, $y3)
{
}
/**
* Append a cubic Bezier curve to the current path. The curve shall extend from the current point to the point (x3, y3), using (x1, y1) and (x3, y3) as the Bezier control points.
* The new current point shall be (x3, y3).
* @param $x1 (float) Abscissa of control point 1.
* @param $y1 (float) Ordinate of control point 1.
* @param $x3 (float) Abscissa of end point.
* @param $y3 (float) Ordinate of end point.
* @protected
* @since 2.1.000 (2008-01-08)
*/
protected function _outCurveY($x1, $y1, $x3, $y3)
{
}
/**
* Draws a line between two points.
* @param $x1 (float) Abscissa of first point.
* @param $y1 (float) Ordinate of first point.
* @param $x2 (float) Abscissa of second point.
* @param $y2 (float) Ordinate of second point.
* @param $style (array) Line style. Array like for SetLineStyle(). Default value: default line style (empty array).
* @public
* @since 1.0
* @see SetLineWidth(), SetDrawColor(), SetLineStyle()
*/
public function Line($x1, $y1, $x2, $y2, $style = array())
{
}
/**
* Draws a rectangle.
* @param $x (float) Abscissa of upper-left corner.
* @param $y (float) Ordinate of upper-left corner.
* @param $w (float) Width.
* @param $h (float) Height.
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $border_style (array) Border style of rectangle. Array with keys among the following:
* <ul>
* <li>all: Line style of all borders. Array like for SetLineStyle().</li>
* <li>L, T, R, B or combinations: Line style of left, top, right or bottom border. Array like for SetLineStyle().</li>
* </ul>
* If a key is not present or is null, the correspondent border is not drawn. Default value: default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
* @public
* @since 1.0
* @see SetLineStyle()
*/
public function Rect($x, $y, $w, $h, $style = '', $border_style = array(), $fill_color = array())
{
}
/**
* Draws a Bezier curve.
* The Bezier curve is a tangent to the line between the control points at
* either end of the curve.
* @param $x0 (float) Abscissa of start point.
* @param $y0 (float) Ordinate of start point.
* @param $x1 (float) Abscissa of control point 1.
* @param $y1 (float) Ordinate of control point 1.
* @param $x2 (float) Abscissa of control point 2.
* @param $y2 (float) Ordinate of control point 2.
* @param $x3 (float) Abscissa of end point.
* @param $y3 (float) Ordinate of end point.
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $line_style (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
* @public
* @see SetLineStyle()
* @since 2.1.000 (2008-01-08)
*/
public function Curve($x0, $y0, $x1, $y1, $x2, $y2, $x3, $y3, $style = '', $line_style = array(), $fill_color = array())
{
}
/**
* Draws a poly-Bezier curve.
* Each Bezier curve segment is a tangent to the line between the control points at
* either end of the curve.
* @param $x0 (float) Abscissa of start point.
* @param $y0 (float) Ordinate of start point.
* @param $segments (float) An array of bezier descriptions. Format: array(x1, y1, x2, y2, x3, y3).
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $line_style (array) Line style of curve. Array like for SetLineStyle(). Default value: default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
* @public
* @see SetLineStyle()
* @since 3.0008 (2008-05-12)
*/
public function Polycurve($x0, $y0, $segments, $style = '', $line_style = array(), $fill_color = array())
{
}
/**
* Draws an ellipse.
* An ellipse is formed from n Bezier curves.
* @param $x0 (float) Abscissa of center point.
* @param $y0 (float) Ordinate of center point.
* @param $rx (float) Horizontal radius.
* @param $ry (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0.
* @param $angle: (float) Angle oriented (anti-clockwise). Default value: 0.
* @param $astart: (float) Angle start of draw line. Default value: 0.
* @param $afinish: (float) Angle finish of draw line. Default value: 360.
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $line_style (array) Line style of ellipse. Array like for SetLineStyle(). Default value: default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
* @param $nc (integer) Number of curves used to draw a 90 degrees portion of ellipse.
* @author Nicola Asuni
* @public
* @since 2.1.000 (2008-01-08)
*/
public function Ellipse($x0, $y0, $rx, $ry = '', $angle = 0, $astart = 0, $afinish = 360, $style = '', $line_style = array(), $fill_color = array(), $nc = 2)
{
}
/**
* Append an elliptical arc to the current path.
* An ellipse is formed from n Bezier curves.
* @param $xc (float) Abscissa of center point.
* @param $yc (float) Ordinate of center point.
* @param $rx (float) Horizontal radius.
* @param $ry (float) Vertical radius (if ry = 0 then is a circle, see Circle()). Default value: 0.
* @param $xang: (float) Angle between the X-axis and the major axis of the ellipse. Default value: 0.
* @param $angs: (float) Angle start of draw line. Default value: 0.
* @param $angf: (float) Angle finish of draw line. Default value: 360.
* @param $pie (boolean) if true do not mark the border point (used to draw pie sectors).
* @param $nc (integer) Number of curves used to draw a 90 degrees portion of ellipse.
* @param $startpoint (boolean) if true output a starting point.
* @param $ccw (boolean) if true draws in counter-clockwise.
* @param $svg (boolean) if true the angles are in svg mode (already calculated).
* @return array bounding box coordinates (x min, y min, x max, y max)
* @author Nicola Asuni
* @protected
* @since 4.9.019 (2010-04-26)
*/
protected function _outellipticalarc($xc, $yc, $rx, $ry, $xang = 0, $angs = 0, $angf = 360, $pie = \false, $nc = 2, $startpoint = \true, $ccw = \true, $svg = \false)
{
}
/**
* Draws a circle.
* A circle is formed from n Bezier curves.
* @param $x0 (float) Abscissa of center point.
* @param $y0 (float) Ordinate of center point.
* @param $r (float) Radius.
* @param $angstr: (float) Angle start of draw line. Default value: 0.
* @param $angend: (float) Angle finish of draw line. Default value: 360.
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $line_style (array) Line style of circle. Array like for SetLineStyle(). Default value: default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array).
* @param $nc (integer) Number of curves used to draw a 90 degrees portion of circle.
* @public
* @since 2.1.000 (2008-01-08)
*/
public function Circle($x0, $y0, $r, $angstr = 0, $angend = 360, $style = '', $line_style = array(), $fill_color = array(), $nc = 2)
{
}
/**
* Draws a polygonal line
* @param $p (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $line_style (array) Line style of polygon. Array with keys among the following:
* <ul>
* <li>all: Line style of all lines. Array like for SetLineStyle().</li>
* <li>0 to ($np - 1): Line style of each line. Array like for SetLineStyle().</li>
* </ul>
* If a key is not present or is null, not draws the line. Default value is default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
* @since 4.8.003 (2009-09-15)
* @public
*/
public function PolyLine($p, $style = '', $line_style = array(), $fill_color = array())
{
}
/**
* Draws a polygon.
* @param $p (array) Points 0 to ($np - 1). Array with values (x0, y0, x1, y1,..., x(np-1), y(np - 1))
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $line_style (array) Line style of polygon. Array with keys among the following:
* <ul>
* <li>all: Line style of all lines. Array like for SetLineStyle().</li>
* <li>0 to ($np - 1): Line style of each line. Array like for SetLineStyle().</li>
* </ul>
* If a key is not present or is null, not draws the line. Default value is default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
* @param $closed (boolean) if true the polygon is closes, otherwise will remain open
* @public
* @since 2.1.000 (2008-01-08)
*/
public function Polygon($p, $style = '', $line_style = array(), $fill_color = array(), $closed = \true)
{
}
/**
* Draws a regular polygon.
* @param $x0 (float) Abscissa of center point.
* @param $y0 (float) Ordinate of center point.
* @param $r: (float) Radius of inscribed circle.
* @param $ns (integer) Number of sides.
* @param $angle (float) Angle oriented (anti-clockwise). Default value: 0.
* @param $draw_circle (boolean) Draw inscribed circle or not. Default value: false.
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $line_style (array) Line style of polygon sides. Array with keys among the following:
* <ul>
* <li>all: Line style of all sides. Array like for SetLineStyle().</li>
* <li>0 to ($ns - 1): Line style of each side. Array like for SetLineStyle().</li>
* </ul>
* If a key is not present or is null, not draws the side. Default value is default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array).
* @param $circle_style (string) Style of rendering of inscribed circle (if draws). Possible values are:
* <ul>
* <li>D or empty string: Draw (default).</li>
* <li>F: Fill.</li>
* <li>DF or FD: Draw and fill.</li>
* <li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li>
* <li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li>
* </ul>
* @param $circle_outLine_style (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array).
* @param $circle_fill_color (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
* @public
* @since 2.1.000 (2008-01-08)
*/
public function RegularPolygon($x0, $y0, $r, $ns, $angle = 0, $draw_circle = \false, $style = '', $line_style = array(), $fill_color = array(), $circle_style = '', $circle_outLine_style = array(), $circle_fill_color = array())
{
}
/**
* Draws a star polygon
* @param $x0 (float) Abscissa of center point.
* @param $y0 (float) Ordinate of center point.
* @param $r (float) Radius of inscribed circle.
* @param $nv (integer) Number of vertices.
* @param $ng (integer) Number of gap (if ($ng % $nv = 1) then is a regular polygon).
* @param $angle: (float) Angle oriented (anti-clockwise). Default value: 0.
* @param $draw_circle: (boolean) Draw inscribed circle or not. Default value is false.
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $line_style (array) Line style of polygon sides. Array with keys among the following:
* <ul>
* <li>all: Line style of all sides. Array like for
* SetLineStyle().</li>
* <li>0 to (n - 1): Line style of each side. Array like for SetLineStyle().</li>
* </ul>
* If a key is not present or is null, not draws the side. Default value is default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(red, green, blue). Default value: default color (empty array).
* @param $circle_style (string) Style of rendering of inscribed circle (if draws). Possible values are:
* <ul>
* <li>D or empty string: Draw (default).</li>
* <li>F: Fill.</li>
* <li>DF or FD: Draw and fill.</li>
* <li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li>
* <li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li>
* </ul>
* @param $circle_outLine_style (array) Line style of inscribed circle (if draws). Array like for SetLineStyle(). Default value: default line style (empty array).
* @param $circle_fill_color (array) Fill color of inscribed circle (if draws). Format: array(red, green, blue). Default value: default color (empty array).
* @public
* @since 2.1.000 (2008-01-08)
*/
public function StarPolygon($x0, $y0, $r, $nv, $ng, $angle = 0, $draw_circle = \false, $style = '', $line_style = array(), $fill_color = array(), $circle_style = '', $circle_outLine_style = array(), $circle_fill_color = array())
{
}
/**
* Draws a rounded rectangle.
* @param $x (float) Abscissa of upper-left corner.
* @param $y (float) Ordinate of upper-left corner.
* @param $w (float) Width.
* @param $h (float) Height.
* @param $r (float) the radius of the circle used to round off the corners of the rectangle.
* @param $round_corner (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top right, bottom right, bottom left and top left. Default value: all rounded corner ("1111").
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $border_style (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
* @public
* @since 2.1.000 (2008-01-08)
*/
public function RoundedRect($x, $y, $w, $h, $r, $round_corner = '1111', $style = '', $border_style = array(), $fill_color = array())
{
}
/**
* Draws a rounded rectangle.
* @param $x (float) Abscissa of upper-left corner.
* @param $y (float) Ordinate of upper-left corner.
* @param $w (float) Width.
* @param $h (float) Height.
* @param $rx (float) the x-axis radius of the ellipse used to round off the corners of the rectangle.
* @param $ry (float) the y-axis radius of the ellipse used to round off the corners of the rectangle.
* @param $round_corner (string) Draws rounded corner or not. String with a 0 (not rounded i-corner) or 1 (rounded i-corner) in i-position. Positions are, in order and begin to 0: top right, bottom right, bottom left and top left. Default value: all rounded corner ("1111").
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $border_style (array) Border style of rectangle. Array like for SetLineStyle(). Default value: default line style (empty array).
* @param $fill_color (array) Fill color. Format: array(GREY) or array(R,G,B) or array(C,M,Y,K) or array(C,M,Y,K,SpotColorName). Default value: default color (empty array).
* @public
* @since 4.9.019 (2010-04-22)
*/
public function RoundedRectXY($x, $y, $w, $h, $rx, $ry, $round_corner = '1111', $style = '', $border_style = array(), $fill_color = array())
{
}
/**
* Draws a grahic arrow.
* @param $x0 (float) Abscissa of first point.
* @param $y0 (float) Ordinate of first point.
* @param $x1 (float) Abscissa of second point.
* @param $y1 (float) Ordinate of second point.
* @param $head_style (int) (0 = draw only arrowhead arms, 1 = draw closed arrowhead, but no fill, 2 = closed and filled arrowhead, 3 = filled arrowhead)
* @param $arm_size (float) length of arrowhead arms
* @param $arm_angle (int) angle between an arm and the shaft
* @author Piotr Galecki, Nicola Asuni, Andy Meier
* @since 4.6.018 (2009-07-10)
*/
public function Arrow($x0, $y0, $x1, $y1, $head_style = 0, $arm_size = 5, $arm_angle = 15)
{
}
// END GRAPHIC FUNCTIONS SECTION -----------------------
/**
* Add a Named Destination.
* NOTE: destination names are unique, so only last entry will be saved.
* @param $name (string) Destination name.
* @param $y (float) Y position in user units of the destiantion on the selected page (default = -1 = current position; 0 = page start;).
* @param $page (int|string) Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.
* @param $x (float) X position in user units of the destiantion on the selected page (default = -1 = current position;).
* @return (string) Stripped named destination identifier or false in case of error.
* @public
* @author Christian Deligant, Nicola Asuni
* @since 5.9.097 (2011-06-23)
*/
public function setDestination($name, $y = -1, $page = '', $x = -1)
{
}
/**
* Return the Named Destination array.
* @return (array) Named Destination array.
* @public
* @author Nicola Asuni
* @since 5.9.097 (2011-06-23)
*/
public function getDestination()
{
}
/**
* Insert Named Destinations.
* @protected
* @author Johannes G\FCntert, Nicola Asuni
* @since 5.9.098 (2011-06-23)
*/
protected function _putdests()
{
}
/**
* Adds a bookmark - alias for Bookmark().
* @param $txt (string) Bookmark description.
* @param $level (int) Bookmark level (minimum value is 0).
* @param $y (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
* @param $page (int|string) Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.
* @param $style (string) Font style: B = Bold, I = Italic, BI = Bold + Italic.
* @param $color (array) RGB color array (values from 0 to 255).
* @param $x (float) X position in user units of the bookmark on the selected page (default = -1 = current position;).
* @param $link (mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name).
* @public
*/
public function setBookmark($txt, $level = 0, $y = -1, $page = '', $style = '', $color = array(0, 0, 0), $x = -1, $link = '')
{
}
/**
* Adds a bookmark.
* @param $txt (string) Bookmark description.
* @param $level (int) Bookmark level (minimum value is 0).
* @param $y (float) Y position in user units of the bookmark on the selected page (default = -1 = current position; 0 = page start;).
* @param $page (int|string) Target page number (leave empty for current page). If you prefix a page number with the * character, then this page will not be changed when adding/deleting/moving pages.
* @param $style (string) Font style: B = Bold, I = Italic, BI = Bold + Italic.
* @param $color (array) RGB color array (values from 0 to 255).
* @param $x (float) X position in user units of the bookmark on the selected page (default = -1 = current position;).
* @param $link (mixed) URL, or numerical link ID, or named destination (# character followed by the destination name), or embedded file (* character followed by the file name).
* @public
* @since 2.1.002 (2008-02-12)
*/
public function Bookmark($txt, $level = 0, $y = -1, $page = '', $style = '', $color = array(0, 0, 0), $x = -1, $link = '')
{
}
/**
* Sort bookmarks for page and key.
* @protected
* @since 5.9.119 (2011-09-19)
*/
protected function sortBookmarks()
{
}
/**
* Create a bookmark PDF string.
* @protected
* @author Olivier Plathey, Nicola Asuni
* @since 2.1.002 (2008-02-12)
*/
protected function _putbookmarks()
{
}
// --- JAVASCRIPT ------------------------------------------------------
/**
* Adds a javascript
* @param $script (string) Javascript code
* @public
* @author Johannes G\FCntert, Nicola Asuni
* @since 2.1.002 (2008-02-12)
*/
public function IncludeJS($script)
{
}
/**
* Adds a javascript object and return object ID
* @param $script (string) Javascript code
* @param $onload (boolean) if true executes this object when opening the document
* @return int internal object ID
* @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
public function addJavascriptObject($script, $onload = \false)
{
}
/**
* Create a javascript PDF string.
* @protected
* @author Johannes G\FCntert, Nicola Asuni
* @since 2.1.002 (2008-02-12)
*/
protected function _putjavascript()
{
}
/**
* Adds a javascript form field.
* @param $type (string) field type
* @param $name (string) field name
* @param $x (int) horizontal position
* @param $y (int) vertical position
* @param $w (int) width
* @param $h (int) height
* @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @protected
* @author Denis Van Nuffelen, Nicola Asuni
* @since 2.1.002 (2008-02-12)
*/
protected function _addfield($type, $name, $x, $y, $w, $h, $prop)
{
}
// --- FORM FIELDS -----------------------------------------------------
/**
* Set default properties for form fields.
* @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-06)
*/
public function setFormDefaultProp($prop = array())
{
}
/**
* Return the default properties for form fields.
* @return array $prop javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-06)
*/
public function getFormDefaultProp()
{
}
/**
* Creates a text field
* @param $name (string) field name
* @param $w (float) Width of the rectangle
* @param $h (float) Height of the rectangle
* @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
* @param $x (float) Abscissa of the upper-left corner of the rectangle
* @param $y (float) Ordinate of the upper-left corner of the rectangle
* @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
* @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
public function TextField($name, $w, $h, $prop = array(), $opt = array(), $x = '', $y = '', $js = \false)
{
}
/**
* Creates a RadioButton field.
* @param $name (string) Field name.
* @param $w (int) Width of the radio button.
* @param $prop (array) Javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @param $opt (array) Annotation parameters. Possible values are described on official PDF32000_2008 reference.
* @param $onvalue (string) Value to be returned if selected.
* @param $checked (boolean) Define the initial state.
* @param $x (float) Abscissa of the upper-left corner of the rectangle
* @param $y (float) Ordinate of the upper-left corner of the rectangle
* @param $js (boolean) If true put the field using JavaScript (requires Acrobat Writer to be rendered).
* @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
public function RadioButton($name, $w, $prop = array(), $opt = array(), $onvalue = 'On', $checked = \false, $x = '', $y = '', $js = \false)
{
}
/**
* Creates a List-box field
* @param $name (string) field name
* @param $w (int) width
* @param $h (int) height
* @param $values (array) array containing the list of values.
* @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
* @param $x (float) Abscissa of the upper-left corner of the rectangle
* @param $y (float) Ordinate of the upper-left corner of the rectangle
* @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
* @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
public function ListBox($name, $w, $h, $values, $prop = array(), $opt = array(), $x = '', $y = '', $js = \false)
{
}
/**
* Creates a Combo-box field
* @param $name (string) field name
* @param $w (int) width
* @param $h (int) height
* @param $values (array) array containing the list of values.
* @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
* @param $x (float) Abscissa of the upper-left corner of the rectangle
* @param $y (float) Ordinate of the upper-left corner of the rectangle
* @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
* @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
public function ComboBox($name, $w, $h, $values, $prop = array(), $opt = array(), $x = '', $y = '', $js = \false)
{
}
/**
* Creates a CheckBox field
* @param $name (string) field name
* @param $w (int) width
* @param $checked (boolean) define the initial state.
* @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
* @param $onvalue (string) value to be returned if selected.
* @param $x (float) Abscissa of the upper-left corner of the rectangle
* @param $y (float) Ordinate of the upper-left corner of the rectangle
* @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
* @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
public function CheckBox($name, $w, $checked = \false, $prop = array(), $opt = array(), $onvalue = 'Yes', $x = '', $y = '', $js = \false)
{
}
/**
* Creates a button field
* @param $name (string) field name
* @param $w (int) width
* @param $h (int) height
* @param $caption (string) caption.
* @param $action (mixed) action triggered by pressing the button. Use a string to specify a javascript action. Use an array to specify a form action options as on section 12.7.5 of PDF32000_2008.
* @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @param $opt (array) annotation parameters. Possible values are described on official PDF32000_2008 reference.
* @param $x (float) Abscissa of the upper-left corner of the rectangle
* @param $y (float) Ordinate of the upper-left corner of the rectangle
* @param $js (boolean) if true put the field using JavaScript (requires Acrobat Writer to be rendered).
* @public
* @author Nicola Asuni
* @since 4.8.000 (2009-09-07)
*/
public function Button($name, $w, $h, $caption, $action, $prop = array(), $opt = array(), $x = '', $y = '', $js = \false)
{
}
// --- END FORMS FIELDS ------------------------------------------------
/**
* Add certification signature (DocMDP or UR3)
* You can set only one signature type
* @protected
* @author Nicola Asuni
* @since 4.6.008 (2009-05-07)
*/
protected function _putsignature()
{
}
/**
* Set User's Rights for PDF Reader
* WARNING: This is experimental and currently do not work.
* Check the PDF Reference 8.7.1 Transform Methods,
* Table 8.105 Entries in the UR transform parameters dictionary
* @param $enable (boolean) if true enable user's rights on PDF reader
* @param $document (string) Names specifying additional document-wide usage rights for the document. The only defined value is "/FullSave", which permits a user to save the document along with modified form and/or annotation data.
* @param $annots (string) Names specifying additional annotation-related usage rights for the document. Valid names in PDF 1.5 and later are /Create/Delete/Modify/Copy/Import/Export, which permit the user to perform the named operation on annotations.
* @param $form (string) Names specifying additional form-field-related usage rights for the document. Valid names are: /Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate
* @param $signature (string) Names specifying additional signature-related usage rights for the document. The only defined value is /Modify, which permits a user to apply a digital signature to an existing signature form field or clear a signed signature form field.
* @param $ef (string) Names specifying additional usage rights for named embedded files in the document. Valid names are /Create/Delete/Modify/Import, which permit the user to perform the named operation on named embedded files
Names specifying additional embedded-files-related usage rights for the document.
* @param $formex (string) Names specifying additional form-field-related usage rights. The only valid name is BarcodePlaintext, which permits text form field data to be encoded as a plaintext two-dimensional barcode.
* @public
* @author Nicola Asuni
* @since 2.9.000 (2008-03-26)
*/
public function setUserRights($enable = \true, $document = '/FullSave', $annots = '/Create/Delete/Modify/Copy/Import/Export', $form = '/Add/Delete/FillIn/Import/Export/SubmitStandalone/SpawnTemplate', $signature = '/Modify', $ef = '/Create/Delete/Modify/Import', $formex = '')
{
}
/**
* Enable document signature (requires the OpenSSL Library).
* The digital signature improve document authenticity and integrity and allows o enable extra features on Acrobat Reader.
* To create self-signed signature: openssl req -x509 -nodes -days 365000 -newkey rsa:1024 -keyout tcpdf.crt -out tcpdf.crt
* To export crt to p12: openssl pkcs12 -export -in tcpdf.crt -out tcpdf.p12
* To convert pfx certificate to pem: openssl pkcs12 -in tcpdf.pfx -out tcpdf.crt -nodes
* @param $signing_cert (mixed) signing certificate (string or filename prefixed with 'file://')
* @param $private_key (mixed) private key (string or filename prefixed with 'file://')
* @param $private_key_password (string) password
* @param $extracerts (string) specifies the name of a file containing a bunch of extra certificates to include in the signature which can for example be used to help the recipient to verify the certificate that you used.
* @param $cert_type (int) The access permissions granted for this document. Valid values shall be: 1 = No changes to the document shall be permitted; any change to the document shall invalidate the signature; 2 = Permitted changes shall be filling in forms, instantiating page templates, and signing; other changes shall invalidate the signature; 3 = Permitted changes shall be the same as for 2, as well as annotation creation, deletion, and modification; other changes shall invalidate the signature.
* @param $info (array) array of option information: Name, Location, Reason, ContactInfo.
* @param $approval (string) Enable approval signature eg. for PDF incremental update
* @public
* @author Nicola Asuni
* @since 4.6.005 (2009-04-24)
*/
public function setSignature($signing_cert = '', $private_key = '', $private_key_password = '', $extracerts = '', $cert_type = 2, $info = array(), $approval = '')
{
}
/**
* Set the digital signature appearance (a cliccable rectangle area to get signature properties)
* @param $x (float) Abscissa of the upper-left corner.
* @param $y (float) Ordinate of the upper-left corner.
* @param $w (float) Width of the signature area.
* @param $h (float) Height of the signature area.
* @param $page (int) option page number (if < 0 the current page is used).
* @param $name (string) Name of the signature.
* @public
* @author Nicola Asuni
* @since 5.3.011 (2010-06-17)
*/
public function setSignatureAppearance($x = 0, $y = 0, $w = 0, $h = 0, $page = -1, $name = '')
{
}
/**
* Add an empty digital signature appearance (a cliccable rectangle area to get signature properties)
* @param $x (float) Abscissa of the upper-left corner.
* @param $y (float) Ordinate of the upper-left corner.
* @param $w (float) Width of the signature area.
* @param $h (float) Height of the signature area.
* @param $page (int) option page number (if < 0 the current page is used).
* @param $name (string) Name of the signature.
* @public
* @author Nicola Asuni
* @since 5.9.101 (2011-07-06)
*/
public function addEmptySignatureAppearance($x = 0, $y = 0, $w = 0, $h = 0, $page = -1, $name = '')
{
}
/**
* Get the array that defines the signature appearance (page and rectangle coordinates).
* @param $x (float) Abscissa of the upper-left corner.
* @param $y (float) Ordinate of the upper-left corner.
* @param $w (float) Width of the signature area.
* @param $h (float) Height of the signature area.
* @param $page (int) option page number (if < 0 the current page is used).
* @param $name (string) Name of the signature.
* @return (array) Array defining page and rectangle coordinates of signature appearance.
* @protected
* @author Nicola Asuni
* @since 5.9.101 (2011-07-06)
*/
protected function getSignatureAppearanceArray($x = 0, $y = 0, $w = 0, $h = 0, $page = -1, $name = '')
{
}
/**
* Enable document timestamping (requires the OpenSSL Library).
* The trusted timestamping improve document security that means that no one should be able to change the document once it has been recorded.
* Use with digital signature only!
* @param $tsa_host (string) Time Stamping Authority (TSA) server (prefixed with 'https://')
* @param $tsa_username (string) Specifies the username for TSA authorization (optional) OR specifies the TSA authorization PEM file (see: example_66.php, optional)
* @param $tsa_password (string) Specifies the password for TSA authorization (optional)
* @param $tsa_cert (string) Specifies the location of TSA certificate for authorization (optional for cURL)
* @public
* @author Richard Stockinger
* @since 6.0.090 (2014-06-16)
*/
public function setTimeStamp($tsa_host = '', $tsa_username = '', $tsa_password = '', $tsa_cert = '')
{
}
/**
* NOT YET IMPLEMENTED
* Request TSA for a timestamp
* @param $signature (string) Digital signature as binary string
* @return (string) Timestamped digital signature
* @protected
* @author Richard Stockinger
* @since 6.0.090 (2014-06-16)
*/
protected function applyTSA($signature)
{
}
/**
* Create a new page group.
* NOTE: call this function before calling AddPage()
* @param $page (int) starting group page (leave empty for next page).
* @public
* @since 3.0.000 (2008-03-27)
*/
public function startPageGroup($page = '')
{
}
/**
* Set the starting page number.
* @param $num (int) Starting page number.
* @since 5.9.093 (2011-06-16)
* @public
*/
public function setStartingPageNumber($num = 1)
{
}
/**
* Returns the string alias used right align page numbers.
* If the current font is unicode type, the returned string wil contain an additional open curly brace.
* @return string
* @since 5.9.099 (2011-06-27)
* @public
*/
public function getAliasRightShift()
{
}
/**
* Returns the string alias used for the total number of pages.
* If the current font is unicode type, the returned string is surrounded by additional curly braces.
* This alias will be replaced by the total number of pages in the document.
* @return string
* @since 4.0.018 (2008-08-08)
* @public
*/
public function getAliasNbPages()
{
}
/**
* Returns the string alias used for the page number.
* If the current font is unicode type, the returned string is surrounded by additional curly braces.
* This alias will be replaced by the page number.
* @return string
* @since 4.5.000 (2009-01-02)
* @public
*/
public function getAliasNumPage()
{
}
/**
* Return the alias for the total number of pages in the current page group.
* If the current font is unicode type, the returned string is surrounded by additional curly braces.
* This alias will be replaced by the total number of pages in this group.
* @return alias of the current page group
* @public
* @since 3.0.000 (2008-03-27)
*/
public function getPageGroupAlias()
{
}
/**
* Return the alias for the page number on the current page group.
* If the current font is unicode type, the returned string is surrounded by additional curly braces.
* This alias will be replaced by the page number (relative to the belonging group).
* @return alias of the current page group
* @public
* @since 4.5.000 (2009-01-02)
*/
public function getPageNumGroupAlias()
{
}
/**
* Return the current page in the group.
* @return current page in the group
* @public
* @since 3.0.000 (2008-03-27)
*/
public function getGroupPageNo()
{
}
/**
* Returns the current group page number formatted as a string.
* @public
* @since 4.3.003 (2008-11-18)
* @see PaneNo(), formatPageNumber()
*/
public function getGroupPageNoFormatted()
{
}
/**
* Returns the current page number formatted as a string.
* @public
* @since 4.2.005 (2008-11-06)
* @see PaneNo(), formatPageNumber()
*/
public function PageNoFormatted()
{
}
/**
* Put pdf layers.
* @protected
* @since 3.0.000 (2008-03-27)
*/
protected function _putocg()
{
}
/**
* Start a new pdf layer.
* @param $name (string) Layer name (only a-z letters and numbers). Leave empty for automatic name.
* @param $print (boolean|null) Set to TRUE to print this layer, FALSE to not print and NULL to not set this option
* @param $view (boolean) Set to true to view this layer.
* @param $lock (boolean) If true lock the layer
* @public
* @since 5.9.102 (2011-07-13)
*/
public function startLayer($name = '', $print = \true, $view = \true, $lock = \true)
{
}
/**
* End the current PDF layer.
* @public
* @since 5.9.102 (2011-07-13)
*/
public function endLayer()
{
}
/**
* Set the visibility of the successive elements.
* This can be useful, for instance, to put a background
* image or color that will show on screen but won't print.
* @param $v (string) visibility mode. Legal values are: all, print, screen or view.
* @public
* @since 3.0.000 (2008-03-27)
*/
public function setVisibility($v)
{
}
/**
* Add transparency parameters to the current extgstate
* @param $parms (array) parameters
* @return the number of extgstates
* @protected
* @since 3.0.000 (2008-03-27)
*/
protected function addExtGState($parms)
{
}
/**
* Add an extgstate
* @param $gs (array) extgstate
* @protected
* @since 3.0.000 (2008-03-27)
*/
protected function setExtGState($gs)
{
}
/**
* Put extgstates for object transparency
* @protected
* @since 3.0.000 (2008-03-27)
*/
protected function _putextgstates()
{
}
/**
* Set overprint mode for stroking (OP) and non-stroking (op) painting operations.
* (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
* @param $stroking (boolean) If true apply overprint for stroking operations.
* @param $nonstroking (boolean) If true apply overprint for painting operations other than stroking.
* @param $mode (integer) Overprint mode: (0 = each source colour component value replaces the value previously painted for the corresponding device colorant; 1 = a tint value of 0.0 for a source colour component shall leave the corresponding component of the previously painted colour unchanged).
* @public
* @since 5.9.152 (2012-03-23)
*/
public function setOverprint($stroking = \true, $nonstroking = '', $mode = 0)
{
}
/**
* Get the overprint mode array (OP, op, OPM).
* (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
* @return array.
* @public
* @since 5.9.152 (2012-03-23)
*/
public function getOverprint()
{
}
/**
* Set alpha for stroking (CA) and non-stroking (ca) operations.
* @param $stroking (float) Alpha value for stroking operations: real value from 0 (transparent) to 1 (opaque).
* @param $bm (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity
* @param $nonstroking (float) Alpha value for non-stroking operations: real value from 0 (transparent) to 1 (opaque).
* @param $ais (boolean)
* @public
* @since 3.0.000 (2008-03-27)
*/
public function setAlpha($stroking = 1, $bm = 'Normal', $nonstroking = '', $ais = \false)
{
}
/**
* Get the alpha mode array (CA, ca, BM, AIS).
* (Check the "Entries in a Graphics State Parameter Dictionary" on PDF 32000-1:2008).
* @return array.
* @public
* @since 5.9.152 (2012-03-23)
*/
public function getAlpha()
{
}
/**
* Set the default JPEG compression quality (1-100)
* @param $quality (int) JPEG quality, integer between 1 and 100
* @public
* @since 3.0.000 (2008-03-27)
*/
public function setJPEGQuality($quality)
{
}
/**
* Set the default number of columns in a row for HTML tables.
* @param $cols (int) number of columns
* @public
* @since 3.0.014 (2008-06-04)
*/
public function setDefaultTableColumns($cols = 4)
{
}
/**
* Set the height of the cell (line height) respect the font height.
* @param $h (int) cell proportion respect font height (typical value = 1.25).
* @public
* @since 3.0.014 (2008-06-04)
*/
public function setCellHeightRatio($h)
{
}
/**
* return the height of cell repect font height.
* @public
* @since 4.0.012 (2008-07-24)
*/
public function getCellHeightRatio()
{
}
/**
* Set the PDF version (check PDF reference for valid values).
* @param $version (string) PDF document version.
* @public
* @since 3.1.000 (2008-06-09)
*/
public function setPDFVersion($version = '1.7')
{
}
/**
* Set the viewer preferences dictionary controlling the way the document is to be presented on the screen or in print.
* (see Section 8.1 of PDF reference, "Viewer Preferences").
* <ul><li>HideToolbar boolean (Optional) A flag specifying whether to hide the viewer application's tool bars when the document is active. Default value: false.</li><li>HideMenubar boolean (Optional) A flag specifying whether to hide the viewer application's menu bar when the document is active. Default value: false.</li><li>HideWindowUI boolean (Optional) A flag specifying whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed. Default value: false.</li><li>FitWindow boolean (Optional) A flag specifying whether to resize the document's window to fit the size of the first displayed page. Default value: false.</li><li>CenterWindow boolean (Optional) A flag specifying whether to position the document's window in the center of the screen. Default value: false.</li><li>DisplayDocTitle boolean (Optional; PDF 1.4) A flag specifying whether the window's title bar should display the document title taken from the Title entry of the document information dictionary (see Section 10.2.1, "Document Information Dictionary"). If false, the title bar should instead display the name of the PDF file containing the document. Default value: false.</li><li>NonFullScreenPageMode name (Optional) The document's page mode, specifying how to display the document on exiting full-screen mode:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>UseOC Optional content group panel visible</li></ul>This entry is meaningful only if the value of the PageMode entry in the catalog dictionary (see Section 3.6.1, "Document Catalog") is FullScreen; it is ignored otherwise. Default value: UseNone.</li><li>ViewArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be displayed when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>ViewClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when viewing the document on the screen. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintArea name (Optional; PDF 1.4) The name of the page boundary representing the area of a page to be rendered when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintClip name (Optional; PDF 1.4) The name of the page boundary to which the contents of a page are to be clipped when printing the document. Valid values are (see Section 10.10.1, "Page Boundaries").:<ul><li>MediaBox</li><li>CropBox (default)</li><li>BleedBox</li><li>TrimBox</li><li>ArtBox</li></ul></li><li>PrintScaling name (Optional; PDF 1.6) The page scaling option to be selected when a print dialog is displayed for this document. Valid values are: <ul><li>None, which indicates that the print dialog should reflect no page scaling</li><li>AppDefault (default), which indicates that applications should use the current print scaling</li></ul></li><li>Duplex name (Optional; PDF 1.7) The paper handling option to use when printing the file from the print dialog. The following values are valid:<ul><li>Simplex - Print single-sided</li><li>DuplexFlipShortEdge - Duplex and flip on the short edge of the sheet</li><li>DuplexFlipLongEdge - Duplex and flip on the long edge of the sheet</li></ul>Default value: none</li><li>PickTrayByPDFSize boolean (Optional; PDF 1.7) A flag specifying whether the PDF page size is used to select the input paper tray. This setting influences only the preset values used to populate the print dialog presented by a PDF viewer application. If PickTrayByPDFSize is true, the check box in the print dialog associated with input paper tray is checked. Note: This setting has no effect on Mac OS systems, which do not provide the ability to pick the input tray by size.</li><li>PrintPageRange array (Optional; PDF 1.7) The page numbers used to initialize the print dialog box when the file is printed. The first page of the PDF file is denoted by 1. Each pair consists of the first and last pages in the sub-range. An odd number of integers causes this entry to be ignored. Negative numbers cause the entire array to be ignored. Default value: as defined by PDF viewer application</li><li>NumCopies integer (Optional; PDF 1.7) The number of copies to be printed when the print dialog is opened for this file. Supported values are the integers 2 through 5. Values outside this range are ignored. Default value: as defined by PDF viewer application, but typically 1</li></ul>
* @param $preferences (array) array of options.
* @author Nicola Asuni
* @public
* @since 3.1.000 (2008-06-09)
*/
public function setViewerPreferences($preferences)
{
}
/**
* Paints color transition registration bars
* @param $x (float) abscissa of the top left corner of the rectangle.
* @param $y (float) ordinate of the top left corner of the rectangle.
* @param $w (float) width of the rectangle.
* @param $h (float) height of the rectangle.
* @param $transition (boolean) if true prints tcolor transitions to white.
* @param $vertical (boolean) if true prints bar vertically.
* @param $colors (string) colors to print separated by comma. Valid values are: A,W,R,G,B,C,M,Y,K,RGB,CMYK,ALL,ALLSPOT,<SPOT_COLOR_NAME>. Where: A = grayscale black, W = grayscale white, R = RGB red, G RGB green, B RGB blue, C = CMYK cyan, M = CMYK magenta, Y = CMYK yellow, K = CMYK key/black, RGB = RGB registration color, CMYK = CMYK registration color, ALL = Spot registration color, ALLSPOT = print all defined spot colors, <SPOT_COLOR_NAME> = name of the spot color to print.
* @author Nicola Asuni
* @since 4.9.000 (2010-03-26)
* @public
*/
public function colorRegistrationBar($x, $y, $w, $h, $transition = \true, $vertical = \false, $colors = 'A,R,G,B,C,M,Y,K')
{
}
/**
* Paints crop marks.
* @param $x (float) abscissa of the crop mark center.
* @param $y (float) ordinate of the crop mark center.
* @param $w (float) width of the crop mark.
* @param $h (float) height of the crop mark.
* @param $type (string) type of crop mark, one symbol per type separated by comma: T = TOP, F = BOTTOM, L = LEFT, R = RIGHT, TL = A = TOP-LEFT, TR = B = TOP-RIGHT, BL = C = BOTTOM-LEFT, BR = D = BOTTOM-RIGHT.
* @param $color (array) crop mark color (default spot registration color).
* @author Nicola Asuni
* @since 4.9.000 (2010-03-26)
* @public
*/
public function cropMark($x, $y, $w, $h, $type = 'T,R,B,L', $color = array(100, 100, 100, 100, 'All'))
{
}
/**
* Paints a registration mark
* @param $x (float) abscissa of the registration mark center.
* @param $y (float) ordinate of the registration mark center.
* @param $r (float) radius of the crop mark.
* @param $double (boolean) if true print two concentric crop marks.
* @param $cola (array) crop mark color (default spot registration color 'All').
* @param $colb (array) second crop mark color (default spot registration color 'None').
* @author Nicola Asuni
* @since 4.9.000 (2010-03-26)
* @public
*/
public function registrationMark($x, $y, $r, $double = \false, $cola = array(100, 100, 100, 100, 'All'), $colb = array(0, 0, 0, 0, 'None'))
{
}
/**
* Paints a CMYK registration mark
* @param $x (float) abscissa of the registration mark center.
* @param $y (float) ordinate of the registration mark center.
* @param $r (float) radius of the crop mark.
* @author Nicola Asuni
* @since 6.0.038 (2013-09-30)
* @public
*/
public function registrationMarkCMYK($x, $y, $r)
{
}
/**
* Paints a linear colour gradient.
* @param $x (float) abscissa of the top left corner of the rectangle.
* @param $y (float) ordinate of the top left corner of the rectangle.
* @param $w (float) width of the rectangle.
* @param $h (float) height of the rectangle.
* @param $col1 (array) first color (Grayscale, RGB or CMYK components).
* @param $col2 (array) second color (Grayscale, RGB or CMYK components).
* @param $coords (array) array of the form (x1, y1, x2, y2) which defines the gradient vector (see linear_gradient_coords.jpg). The default value is from left to right (x1=0, y1=0, x2=1, y2=0).
* @author Andreas W\FCrmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
* @public
*/
public function LinearGradient($x, $y, $w, $h, $col1 = array(), $col2 = array(), $coords = array(0, 0, 1, 0))
{
}
/**
* Paints a radial colour gradient.
* @param $x (float) abscissa of the top left corner of the rectangle.
* @param $y (float) ordinate of the top left corner of the rectangle.
* @param $w (float) width of the rectangle.
* @param $h (float) height of the rectangle.
* @param $col1 (array) first color (Grayscale, RGB or CMYK components).
* @param $col2 (array) second color (Grayscale, RGB or CMYK components).
* @param $coords (array) array of the form (fx, fy, cx, cy, r) where (fx, fy) is the starting point of the gradient with color1, (cx, cy) is the center of the circle with color2, and r is the radius of the circle (see radial_gradient_coords.jpg). (fx, fy) should be inside the circle, otherwise some areas will not be defined.
* @author Andreas W\FCrmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
* @public
*/
public function RadialGradient($x, $y, $w, $h, $col1 = array(), $col2 = array(), $coords = array(0.5, 0.5, 0.5, 0.5, 1))
{
}
/**
* Paints a coons patch mesh.
* @param $x (float) abscissa of the top left corner of the rectangle.
* @param $y (float) ordinate of the top left corner of the rectangle.
* @param $w (float) width of the rectangle.
* @param $h (float) height of the rectangle.
* @param $col1 (array) first color (lower left corner) (RGB components).
* @param $col2 (array) second color (lower right corner) (RGB components).
* @param $col3 (array) third color (upper right corner) (RGB components).
* @param $col4 (array) fourth color (upper left corner) (RGB components).
* @param $coords (array) <ul><li>for one patch mesh: array(float x1, float y1, .... float x12, float y12): 12 pairs of coordinates (normally from 0 to 1) which specify the Bezier control points that define the patch. First pair is the lower left edge point, next is its right control point (control point 2). Then the other points are defined in the order: control point 1, edge point, control point 2 going counter-clockwise around the patch. Last (x12, y12) is the first edge point's left control point (control point 1).</li><li>for two or more patch meshes: array[number of patches]: arrays with the following keys for each patch: f: where to put that patch (0 = first patch, 1, 2, 3 = right, top and left of precedent patch - I didn't figure this out completely - just try and error ;-) points: 12 pairs of coordinates of the Bezier control points as above for the first patch, 8 pairs of coordinates for the following patches, ignoring the coordinates already defined by the precedent patch (I also didn't figure out the order of these - also: try and see what's happening) colors: must be 4 colors for the first patch, 2 colors for the following patches</li></ul>
* @param $coords_min (array) minimum value used by the coordinates. If a coordinate's value is smaller than this it will be cut to coords_min. default: 0
* @param $coords_max (array) maximum value used by the coordinates. If a coordinate's value is greater than this it will be cut to coords_max. default: 1
* @param $antialias (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts.
* @author Andreas W\FCrmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
* @public
*/
public function CoonsPatchMesh($x, $y, $w, $h, $col1 = array(), $col2 = array(), $col3 = array(), $col4 = array(), $coords = array(0.0, 0.0, 0.33, 0.0, 0.67, 0.0, 1.0, 0.0, 1.0, 0.33, 1.0, 0.67, 1.0, 1.0, 0.67, 1.0, 0.33, 1.0, 0.0, 1.0, 0.0, 0.67, 0.0, 0.33), $coords_min = 0, $coords_max = 1, $antialias = \false)
{
}
/**
* Set a rectangular clipping area.
* @param $x (float) abscissa of the top left corner of the rectangle (or top right corner for RTL mode).
* @param $y (float) ordinate of the top left corner of the rectangle.
* @param $w (float) width of the rectangle.
* @param $h (float) height of the rectangle.
* @author Andreas W\FCrmser, Nicola Asuni
* @since 3.1.000 (2008-06-09)
* @protected
*/
protected function Clip($x, $y, $w, $h)
{
}
/**
* Output gradient.
* @param $type (int) type of gradient (1 Function-based shading; 2 Axial shading; 3 Radial shading; 4 Free-form Gouraud-shaded triangle mesh; 5 Lattice-form Gouraud-shaded triangle mesh; 6 Coons patch mesh; 7 Tensor-product patch mesh). (Not all types are currently supported)
* @param $coords (array) array of coordinates.
* @param $stops (array) array gradient color components: color = array of GRAY, RGB or CMYK color components; offset = (0 to 1) represents a location along the gradient vector; exponent = exponent of the exponential interpolation function (default = 1).
* @param $background (array) An array of colour components appropriate to the colour space, specifying a single background colour value.
* @param $antialias (boolean) A flag indicating whether to filter the shading function to prevent aliasing artifacts.
* @author Nicola Asuni
* @since 3.1.000 (2008-06-09)
* @public
*/
public function Gradient($type, $coords, $stops, $background = array(), $antialias = \false)
{
}
/**
* Output gradient shaders.
* @author Nicola Asuni
* @since 3.1.000 (2008-06-09)
* @protected
*/
function _putshaders()
{
}
/**
* Draw the sector of a circle.
* It can be used for instance to render pie charts.
* @param $xc (float) abscissa of the center.
* @param $yc (float) ordinate of the center.
* @param $r (float) radius.
* @param $a (float) start angle (in degrees).
* @param $b (float) end angle (in degrees).
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $cw: (float) indicates whether to go clockwise (default: true).
* @param $o: (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock). Default: 90.
* @author Maxime Delorme, Nicola Asuni
* @since 3.1.000 (2008-06-09)
* @public
*/
public function PieSector($xc, $yc, $r, $a, $b, $style = 'FD', $cw = \true, $o = 90)
{
}
/**
* Draw the sector of an ellipse.
* It can be used for instance to render pie charts.
* @param $xc (float) abscissa of the center.
* @param $yc (float) ordinate of the center.
* @param $rx (float) the x-axis radius.
* @param $ry (float) the y-axis radius.
* @param $a (float) start angle (in degrees).
* @param $b (float) end angle (in degrees).
* @param $style (string) Style of rendering. See the getPathPaintOperator() function for more information.
* @param $cw: (float) indicates whether to go clockwise.
* @param $o: (float) origin of angles (0 for 3 o'clock, 90 for noon, 180 for 9 o'clock, 270 for 6 o'clock).
* @param $nc (integer) Number of curves used to draw a 90 degrees portion of arc.
* @author Maxime Delorme, Nicola Asuni
* @since 3.1.000 (2008-06-09)
* @public
*/
public function PieSectorXY($xc, $yc, $rx, $ry, $a, $b, $style = 'FD', $cw = \false, $o = 0, $nc = 2)
{
}
/**
* Embed vector-based Adobe Illustrator (AI) or AI-compatible EPS files.
* NOTE: EPS is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
* Only vector drawing is supported, not text or bitmap.
* Although the script was successfully tested with various AI format versions, best results are probably achieved with files that were exported in the AI3 format (tested with Illustrator CS2, Freehand MX and Photoshop CS2).
* @param $file (string) Name of the file containing the image or a '@' character followed by the EPS/AI data string.
* @param $x (float) Abscissa of the upper-left corner.
* @param $y (float) Ordinate of the upper-left corner.
* @param $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param $link (mixed) URL or identifier returned by AddLink().
* @param $useBoundingBox (boolean) specifies whether to position the bounding box (true) or the complete canvas (false) at location (x,y). Default value is true.
* @param $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @param $palign (string) Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param $fitonpage (boolean) if true the image is resized to not exceed page dimensions.
* @param $fixoutvals (boolean) if true remove values outside the bounding box.
* @author Valentin Schmidt, Nicola Asuni
* @since 3.1.000 (2008-06-09)
* @public
*/
public function ImageEps($file, $x = '', $y = '', $w = 0, $h = 0, $link = '', $useBoundingBox = \true, $align = '', $palign = '', $border = 0, $fitonpage = \false, $fixoutvals = \false)
{
}
/**
* Set document barcode.
* @param $bc (string) barcode
* @public
*/
public function setBarcode($bc = '')
{
}
/**
* Get current barcode.
* @return string
* @public
* @since 4.0.012 (2008-07-24)
*/
public function getBarcode()
{
}
/**
* Print a Linear Barcode.
* @param $code (string) code to print
* @param $type (string) type of barcode (see tcpdf_barcodes_1d.php for supported formats).
* @param $x (int) x position in user units (empty string = current x position)
* @param $y (int) y position in user units (empty string = current y position)
* @param $w (int) width in user units (empty string = remaining page width)
* @param $h (int) height in user units (empty string = remaining page height)
* @param $xres (float) width of the smallest bar in user units (empty string = default value = 0.4mm)
* @param $style (array) array of options:<ul>
* <li>boolean $style['border'] if true prints a border</li>
* <li>int $style['padding'] padding to leave around the barcode in user units (set to 'auto' for automatic padding)</li>
* <li>int $style['hpadding'] horizontal padding in user units (set to 'auto' for automatic padding)</li>
* <li>int $style['vpadding'] vertical padding in user units (set to 'auto' for automatic padding)</li>
* <li>array $style['fgcolor'] color array for bars and text</li>
* <li>mixed $style['bgcolor'] color array for background (set to false for transparent)</li>
* <li>boolean $style['text'] if true prints text below the barcode</li>
* <li>string $style['label'] override default label</li>
* <li>string $style['font'] font name for text</li><li>int $style['fontsize'] font size for text</li>
* <li>int $style['stretchtext']: 0 = disabled; 1 = horizontal scaling only if necessary; 2 = forced horizontal scaling; 3 = character spacing only if necessary; 4 = forced character spacing.</li>
* <li>string $style['position'] horizontal position of the containing barcode cell on the page: L = left margin; C = center; R = right margin.</li>
* <li>string $style['align'] horizontal position of the barcode on the containing rectangle: L = left; C = center; R = right.</li>
* <li>string $style['stretch'] if true stretch the barcode to best fit the available width, otherwise uses $xres resolution for a single bar.</li>
* <li>string $style['fitwidth'] if true reduce the width to fit the barcode width + padding. When this option is enabled the 'stretch' option is automatically disabled.</li>
* <li>string $style['cellfitalign'] this option works only when 'fitwidth' is true and 'position' is unset or empty. Set the horizontal position of the containing barcode cell inside the specified rectangle: L = left; C = center; R = right.</li></ul>
* @param $align (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @author Nicola Asuni
* @since 3.1.000 (2008-06-09)
* @public
*/
public function write1DBarcode($code, $type, $x = '', $y = '', $w = '', $h = '', $xres = '', $style = array(), $align = '')
{
}
/**
* Print 2D Barcode.
* @param $code (string) code to print
* @param $type (string) type of barcode (see tcpdf_barcodes_2d.php for supported formats).
* @param $x (int) x position in user units
* @param $y (int) y position in user units
* @param $w (int) width in user units
* @param $h (int) height in user units
* @param $style (array) array of options:<ul>
* <li>boolean $style['border'] if true prints a border around the barcode</li>
* <li>int $style['padding'] padding to leave around the barcode in barcode units (set to 'auto' for automatic padding)</li>
* <li>int $style['hpadding'] horizontal padding in barcode units (set to 'auto' for automatic padding)</li>
* <li>int $style['vpadding'] vertical padding in barcode units (set to 'auto' for automatic padding)</li>
* <li>int $style['module_width'] width of a single module in points</li>
* <li>int $style['module_height'] height of a single module in points</li>
* <li>array $style['fgcolor'] color array for bars and text</li>
* <li>mixed $style['bgcolor'] color array for background or false for transparent</li>
* <li>string $style['position'] barcode position on the page: L = left margin; C = center; R = right margin; S = stretch</li><li>$style['module_width'] width of a single module in points</li>
* <li>$style['module_height'] height of a single module in points</li></ul>
* @param $align (string) Indicates the alignment of the pointer next to barcode insertion relative to barcode height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @param $distort (boolean) if true distort the barcode to fit width and height, otherwise preserve aspect ratio
* @author Nicola Asuni
* @since 4.5.037 (2009-04-07)
* @public
*/
public function write2DBarcode($code, $type, $x = '', $y = '', $w = '', $h = '', $style = array(), $align = '', $distort = \false)
{
}
/**
* Returns an array containing current margins:
* <ul>
<li>$ret['left'] = left margin</li>
<li>$ret['right'] = right margin</li>
<li>$ret['top'] = top margin</li>
<li>$ret['bottom'] = bottom margin</li>
<li>$ret['header'] = header margin</li>
<li>$ret['footer'] = footer margin</li>
<li>$ret['cell'] = cell padding array</li>
<li>$ret['padding_left'] = cell left padding</li>
<li>$ret['padding_top'] = cell top padding</li>
<li>$ret['padding_right'] = cell right padding</li>
<li>$ret['padding_bottom'] = cell bottom padding</li>
* </ul>
* @return array containing all margins measures
* @public
* @since 3.2.000 (2008-06-23)
*/
public function getMargins()
{
}
/**
* Returns an array containing original margins:
* <ul>
<li>$ret['left'] = left margin</li>
<li>$ret['right'] = right margin</li>
* </ul>
* @return array containing all margins measures
* @public
* @since 4.0.012 (2008-07-24)
*/
public function getOriginalMargins()
{
}
/**
* Returns the current font size.
* @return current font size
* @public
* @since 3.2.000 (2008-06-23)
*/
public function getFontSize()
{
}
/**
* Returns the current font size in points unit.
* @return current font size in points unit
* @public
* @since 3.2.000 (2008-06-23)
*/
public function getFontSizePt()
{
}
/**
* Returns the current font family name.
* @return string current font family name
* @public
* @since 4.3.008 (2008-12-05)
*/
public function getFontFamily()
{
}
/**
* Returns the current font style.
* @return string current font style
* @public
* @since 4.3.008 (2008-12-05)
*/
public function getFontStyle()
{
}
/**
* Cleanup HTML code (requires HTML Tidy library).
* @param $html (string) htmlcode to fix
* @param $default_css (string) CSS commands to add
* @param $tagvs (array) parameters for setHtmlVSpace method
* @param $tidy_options (array) options for tidy_parse_string function
* @return string XHTML code cleaned up
* @author Nicola Asuni
* @public
* @since 5.9.017 (2010-11-16)
* @see setHtmlVSpace()
*/
public function fixHTMLCode($html, $default_css = '', $tagvs = '', $tidy_options = '')
{
}
/**
* Returns the border width from CSS property
* @param $width (string) border width
* @return int with in user units
* @protected
* @since 5.7.000 (2010-08-02)
*/
protected function getCSSBorderWidth($width)
{
}
/**
* Returns the border dash style from CSS property
* @param $style (string) border style to convert
* @return int sash style (return -1 in case of none or hidden border)
* @protected
* @since 5.7.000 (2010-08-02)
*/
protected function getCSSBorderDashStyle($style)
{
}
/**
* Returns the border style array from CSS border properties
* @param $cssborder (string) border properties
* @return array containing border properties
* @protected
* @since 5.7.000 (2010-08-02)
*/
protected function getCSSBorderStyle($cssborder)
{
}
/**
* Get the internal Cell padding from CSS attribute.
* @param $csspadding (string) padding properties
* @param $width (float) width of the containing element
* @return array of cell paddings
* @public
* @since 5.9.000 (2010-10-04)
*/
public function getCSSPadding($csspadding, $width = 0)
{
}
/**
* Get the internal Cell margin from CSS attribute.
* @param $cssmargin (string) margin properties
* @param $width (float) width of the containing element
* @return array of cell margins
* @public
* @since 5.9.000 (2010-10-04)
*/
public function getCSSMargin($cssmargin, $width = 0)
{
}
/**
* Get the border-spacing from CSS attribute.
* @param $cssbspace (string) border-spacing CSS properties
* @param $width (float) width of the containing element
* @return array of border spacings
* @public
* @since 5.9.010 (2010-10-27)
*/
public function getCSSBorderMargin($cssbspace, $width = 0)
{
}
/**
* Returns the letter-spacing value from CSS value
* @param $spacing (string) letter-spacing value
* @param $parent (float) font spacing (tracking) value of the parent element
* @return float quantity to increases or decreases the space between characters in a text.
* @protected
* @since 5.9.000 (2010-10-02)
*/
protected function getCSSFontSpacing($spacing, $parent = 0)
{
}
/**
* Returns the percentage of font stretching from CSS value
* @param $stretch (string) stretch mode
* @param $parent (float) stretch value of the parent element
* @return float font stretching percentage
* @protected
* @since 5.9.000 (2010-10-02)
*/
protected function getCSSFontStretching($stretch, $parent = 100)
{
}
/**
* Convert HTML string containing font size value to points
* @param $val (string) String containing font size value and unit.
* @param $refsize (float) Reference font size in points.
* @param $parent_size (float) Parent font size in points.
* @param $defaultunit (string) Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).
* @return float value in points
* @public
*/
public function getHTMLFontUnits($val, $refsize = 12, $parent_size = 12, $defaultunit = 'pt')
{
}
/**
* Returns the HTML DOM array.
* @param $html (string) html code
* @return array
* @protected
* @since 3.2.000 (2008-06-20)
*/
protected function getHtmlDomArray($html)
{
}
/**
* Returns the string used to find spaces
* @return string
* @protected
* @author Nicola Asuni
* @since 4.8.024 (2010-01-15)
*/
protected function getSpaceString()
{
}
/**
* Return an hash code used to ensure that the serialized data has been generated by this TCPDF instance.
* @param $data (string) serialized data
* @return string
* @public static
*/
protected function getHashForTCPDFtagParams($data)
{
}
/**
* Serialize an array of parameters to be used with TCPDF tag in HTML code.
* @param $data (array) parameters array
* @return string containing serialized data
* @public static
*/
public function serializeTCPDFtagParameters($data)
{
}
/**
* Unserialize parameters to be used with TCPDF tag in HTML code.
* @param $data (string) serialized data
* @return array containing unserialized data
* @protected static
*/
protected function unserializeTCPDFtagParameters($data)
{
}
/**
* Prints a cell (rectangular area) with optional borders, background color and html text string.
* The upper-left corner of the cell corresponds to the current position. After the call, the current position moves to the right or to the next line.<br />
* If automatic page breaking is enabled and the cell goes beyond the limit, a page break is done before outputting.
* IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting.
* Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul
* NOTE: all the HTML attributes must be enclosed in double-quote.
* @param $w (float) Cell width. If 0, the cell extends up to the right margin.
* @param $h (float) Cell minimum height. The cell extends automatically if needed.
* @param $x (float) upper-left corner X coordinate
* @param $y (float) upper-left corner Y coordinate
* @param $html (string) html text to print. Default value: empty string.
* @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param $ln (int) Indicates where the current position should go after the call. Possible values are:<ul><li>0: to the right (or left for RTL language)</li><li>1: to the beginning of the next line</li><li>2: below</li></ul>
Putting 1 is equivalent to putting 0 and calling Ln() just after. Default value: 0.
* @param $fill (boolean) Indicates if the cell background must be painted (true) or transparent (false).
* @param $reseth (boolean) if true reset the last cell height (default true).
* @param $align (string) Allows to center or align the text. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param $autopadding (boolean) if true, uses internal padding and automatically adjust it to account for line width.
* @see Multicell(), writeHTML()
* @public
*/
public function writeHTMLCell($w, $h, $x, $y, $html = '', $border = 0, $ln = 0, $fill = \false, $reseth = \true, $align = '', $autopadding = \true)
{
}
/**
* Allows to preserve some HTML formatting (limited support).<br />
* IMPORTANT: The HTML must be well formatted - try to clean-up it using an application like HTML-Tidy before submitting.
* Supported tags are: a, b, blockquote, br, dd, del, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, img, li, ol, p, pre, small, span, strong, sub, sup, table, tcpdf, td, th, thead, tr, tt, u, ul
* NOTE: all the HTML attributes must be enclosed in double-quote.
* @param $html (string) text to display
* @param $ln (boolean) if true add a new line after text (default = true)
* @param $fill (boolean) Indicates if the background must be painted (true) or transparent (false).
* @param $reseth (boolean) if true reset the last cell height (default false).
* @param $cell (boolean) if true add the current left (or right for RTL) padding to each Write (default false).
* @param $align (string) Allows to center or align the text. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @public
*/
public function writeHTML($html, $ln = \true, $fill = \false, $reseth = \false, $cell = \false, $align = '')
{
}
/**
* Process opening tags.
* @param $dom (array) html dom array
* @param $key (int) current element id
* @param $cell (boolean) if true add the default left (or right if RTL) padding to each new line (default false).
* @return $dom array
* @protected
*/
protected function openHTMLTagHandler($dom, $key, $cell)
{
}
/**
* Process closing tags.
* @param $dom (array) html dom array
* @param $key (int) current element id
* @param $cell (boolean) if true add the default left (or right if RTL) padding to each new line (default false).
* @param $maxbottomliney (int) maximum y value of current line
* @return $dom array
* @protected
*/
protected function closeHTMLTagHandler($dom, $key, $cell, $maxbottomliney = 0)
{
}
/**
* Add vertical spaces if needed.
* @param $hbz (string) Distance between current y and line bottom.
* @param $hb (string) The height of the break.
* @param $cell (boolean) if true add the default left (or right if RTL) padding to each new line (default false).
* @param $firsttag (boolean) set to true when the tag is the first.
* @param $lasttag (boolean) set to true when the tag is the last.
* @protected
*/
protected function addHTMLVertSpace($hbz = 0, $hb = 0, $cell = \false, $firsttag = \false, $lasttag = \false)
{
}
/**
* Return the starting coordinates to draw an html border
* @return array containing top-left border coordinates
* @protected
* @since 5.7.000 (2010-08-03)
*/
protected function getBorderStartPosition()
{
}
/**
* Draw an HTML block border and fill
* @param $tag (array) array of tag properties.
* @param $xmax (int) end X coordinate for border.
* @protected
* @since 5.7.000 (2010-08-03)
*/
protected function drawHTMLTagBorder($tag, $xmax)
{
}
/**
* Set the default bullet to be used as LI bullet symbol
* @param $symbol (string) character or string to be used (legal values are: '' = automatic, '!' = auto bullet, '#' = auto numbering, 'disc', 'disc', 'circle', 'square', '1', 'decimal', 'decimal-leading-zero', 'i', 'lower-roman', 'I', 'upper-roman', 'a', 'lower-alpha', 'lower-latin', 'A', 'upper-alpha', 'upper-latin', 'lower-greek', 'img|type|width|height|image.ext')
* @public
* @since 4.0.028 (2008-09-26)
*/
public function setLIsymbol($symbol = '!')
{
}
/**
* Set the booklet mode for double-sided pages.
* @param $booklet (boolean) true set the booklet mode on, false otherwise.
* @param $inner (float) Inner page margin.
* @param $outer (float) Outer page margin.
* @public
* @since 4.2.000 (2008-10-29)
*/
public function SetBooklet($booklet = \true, $inner = -1, $outer = -1)
{
}
/**
* Swap the left and right margins.
* @param $reverse (boolean) if true swap left and right margins.
* @protected
* @since 4.2.000 (2008-10-29)
*/
protected function swapMargins($reverse = \true)
{
}
/**
* Set the vertical spaces for HTML tags.
* The array must have the following structure (example):
* $tagvs = array('h1' => array(0 => array('h' => '', 'n' => 2), 1 => array('h' => 1.3, 'n' => 1)));
* The first array level contains the tag names,
* the second level contains 0 for opening tags or 1 for closing tags,
* the third level contains the vertical space unit (h) and the number spaces to add (n).
* If the h parameter is not specified, default values are used.
* @param $tagvs (array) array of tags and relative vertical spaces.
* @public
* @since 4.2.001 (2008-10-30)
*/
public function setHtmlVSpace($tagvs)
{
}
/**
* Set custom width for list indentation.
* @param $width (float) width of the indentation. Use negative value to disable it.
* @public
* @since 4.2.007 (2008-11-12)
*/
public function setListIndentWidth($width)
{
}
/**
* Set the top/bottom cell sides to be open or closed when the cell cross the page.
* @param $isopen (boolean) if true keeps the top/bottom border open for the cell sides that cross the page.
* @public
* @since 4.2.010 (2008-11-14)
*/
public function setOpenCell($isopen)
{
}
/**
* Set the color and font style for HTML links.
* @param $color (array) RGB array of colors
* @param $fontstyle (string) additional font styles to add
* @public
* @since 4.4.003 (2008-12-09)
*/
public function setHtmlLinksStyle($color = array(0, 0, 255), $fontstyle = 'U')
{
}
/**
* Convert HTML string containing value and unit of measure to user's units or points.
* @param $htmlval (string) String containing values and unit.
* @param $refsize (string) Reference value in points.
* @param $defaultunit (string) Default unit (can be one of the following: %, em, ex, px, in, mm, pc, pt).
* @param $points (boolean) If true returns points, otherwise returns value in user's units.
* @return float value in user's unit or point if $points=true
* @public
* @since 4.4.004 (2008-12-10)
*/
public function getHTMLUnitToUnits($htmlval, $refsize = 1, $defaultunit = 'px', $points = \false)
{
}
/**
* Output an HTML list bullet or ordered item symbol
* @param $listdepth (int) list nesting level
* @param $listtype (string) type of list
* @param $size (float) current font size
* @protected
* @since 4.4.004 (2008-12-10)
*/
protected function putHtmlListBullet($listdepth, $listtype = '', $size = 10)
{
}
/**
* Returns current graphic variables as array.
* @return array of graphic variables
* @protected
* @since 4.2.010 (2008-11-14)
*/
protected function getGraphicVars()
{
}
/**
* Set graphic variables.
* @param $gvars (array) array of graphic variablesto restore
* @param $extended (boolean) if true restore extended graphic variables
* @protected
* @since 4.2.010 (2008-11-14)
*/
protected function setGraphicVars($gvars, $extended = \false)
{
}
/**
* Outputs the "save graphics state" operator 'q'
* @protected
*/
protected function _outSaveGraphicsState()
{
}
/**
* Outputs the "restore graphics state" operator 'Q'
* @protected
*/
protected function _outRestoreGraphicsState()
{
}
/**
* Set buffer content (always append data).
* @param $data (string) data
* @protected
* @since 4.5.000 (2009-01-02)
*/
protected function setBuffer($data)
{
}
/**
* Replace the buffer content
* @param $data (string) data
* @protected
* @since 5.5.000 (2010-06-22)
*/
protected function replaceBuffer($data)
{
}
/**
* Get buffer content.
* @return string buffer content
* @protected
* @since 4.5.000 (2009-01-02)
*/
protected function getBuffer()
{
}
/**
* Set page buffer content.
* @param $page (int) page number
* @param $data (string) page data
* @param $append (boolean) if true append data, false replace.
* @protected
* @since 4.5.000 (2008-12-31)
*/
protected function setPageBuffer($page, $data, $append = \false)
{
}
/**
* Get page buffer content.
* @param $page (int) page number
* @return string page buffer content or false in case of error
* @protected
* @since 4.5.000 (2008-12-31)
*/
protected function getPageBuffer($page)
{
}
/**
* Set image buffer content.
* @param $image (string) image key
* @param $data (array) image data
* @return int image index number
* @protected
* @since 4.5.000 (2008-12-31)
*/
protected function setImageBuffer($image, $data)
{
}
/**
* Set image buffer content for a specified sub-key.
* @param $image (string) image key
* @param $key (string) image sub-key
* @param $data (array) image data
* @protected
* @since 4.5.000 (2008-12-31)
*/
protected function setImageSubBuffer($image, $key, $data)
{
}
/**
* Get image buffer content.
* @param $image (string) image key
* @return string image buffer content or false in case of error
* @protected
* @since 4.5.000 (2008-12-31)
*/
protected function getImageBuffer($image)
{
}
/**
* Set font buffer content.
* @param $font (string) font key
* @param $data (array) font data
* @protected
* @since 4.5.000 (2009-01-02)
*/
protected function setFontBuffer($font, $data)
{
}
/**
* Set font buffer content.
* @param $font (string) font key
* @param $key (string) font sub-key
* @param $data (array) font data
* @protected
* @since 4.5.000 (2009-01-02)
*/
protected function setFontSubBuffer($font, $key, $data)
{
}
/**
* Get font buffer content.
* @param $font (string) font key
* @return string font buffer content or false in case of error
* @protected
* @since 4.5.000 (2009-01-02)
*/
protected function getFontBuffer($font)
{
}
/**
* Move a page to a previous position.
* @param $frompage (int) number of the source page
* @param $topage (int) number of the destination page (must be less than $frompage)
* @return true in case of success, false in case of error.
* @public
* @since 4.5.000 (2009-01-02)
*/
public function movePage($frompage, $topage)
{
}
/**
* Remove the specified page.
* @param $page (int) page to remove
* @return true in case of success, false in case of error.
* @public
* @since 4.6.004 (2009-04-23)
*/
public function deletePage($page)
{
}
/**
* Clone the specified page to a new page.
* @param $page (int) number of page to copy (0 = current page)
* @return true in case of success, false in case of error.
* @public
* @since 4.9.015 (2010-04-20)
*/
public function copyPage($page = 0)
{
}
/**
* Output a Table of Content Index (TOC).
* This method must be called after all Bookmarks were set.
* Before calling this method you have to open the page using the addTOCPage() method.
* After calling this method you have to call endTOCPage() to close the TOC page.
* You can override this method to achieve different styles.
* @param $page (int) page number where this TOC should be inserted (leave empty for current page).
* @param $numbersfont (string) set the font for page numbers (please use monospaced font for better alignment).
* @param $filler (string) string used to fill the space between text and page number.
* @param $toc_name (string) name to use for TOC bookmark.
* @param $style (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic.
* @param $color (array) RGB color array for bookmark title (values from 0 to 255).
* @public
* @author Nicola Asuni
* @since 4.5.000 (2009-01-02)
* @see addTOCPage(), endTOCPage(), addHTMLTOC()
*/
public function addTOC($page = '', $numbersfont = '', $filler = '.', $toc_name = 'TOC', $style = '', $color = array(0, 0, 0))
{
}
/**
* Output a Table Of Content Index (TOC) using HTML templates.
* This method must be called after all Bookmarks were set.
* Before calling this method you have to open the page using the addTOCPage() method.
* After calling this method you have to call endTOCPage() to close the TOC page.
* @param $page (int) page number where this TOC should be inserted (leave empty for current page).
* @param $toc_name (string) name to use for TOC bookmark.
* @param $templates (array) array of html templates. Use: "#TOC_DESCRIPTION#" for bookmark title, "#TOC_PAGE_NUMBER#" for page number.
* @param $correct_align (boolean) if true correct the number alignment (numbers must be in monospaced font like courier and right aligned on LTR, or left aligned on RTL)
* @param $style (string) Font style for title: B = Bold, I = Italic, BI = Bold + Italic.
* @param $color (array) RGB color array for title (values from 0 to 255).
* @public
* @author Nicola Asuni
* @since 5.0.001 (2010-05-06)
* @see addTOCPage(), endTOCPage(), addTOC()
*/
public function addHTMLTOC($page = '', $toc_name = 'TOC', $templates = array(), $correct_align = \true, $style = '', $color = array(0, 0, 0))
{
}
/**
* Stores a copy of the current TCPDF object used for undo operation.
* @public
* @since 4.5.029 (2009-03-19)
*/
public function startTransaction()
{
}
/**
* Delete the copy of the current TCPDF object used for undo operation.
* @public
* @since 4.5.029 (2009-03-19)
*/
public function commitTransaction()
{
}
/**
* This method allows to undo the latest transaction by returning the latest saved TCPDF object with startTransaction().
* @param $self (boolean) if true restores current class object to previous state without the need of reassignment via the returned value.
* @return TCPDF object.
* @public
* @since 4.5.029 (2009-03-19)
*/
public function rollbackTransaction($self = \false)
{
}
// --- MULTI COLUMNS METHODS -----------------------
/**
* Set multiple columns of the same size
* @param $numcols (int) number of columns (set to zero to disable columns mode)
* @param $width (int) column width
* @param $y (int) column starting Y position (leave empty for current Y position)
* @public
* @since 4.9.001 (2010-03-28)
*/
public function setEqualColumns($numcols = 0, $width = 0, $y = '')
{
}
/**
* Remove columns and reset page margins.
* @public
* @since 5.9.072 (2011-04-26)
*/
public function resetColumns()
{
}
/**
* Set columns array.
* Each column is represented by an array of arrays with the following keys: (w = width, s = space between columns, y = column top position).
* @param $columns (array)
* @public
* @since 4.9.001 (2010-03-28)
*/
public function setColumnsArray($columns)
{
}
/**
* Set position at a given column
* @param $col (int) column number (from 0 to getNumberOfColumns()-1); empty string = current column.
* @public
* @since 4.9.001 (2010-03-28)
*/
public function selectColumn($col = '')
{
}
/**
* Return the current column number
* @return int current column number
* @public
* @since 5.5.011 (2010-07-08)
*/
public function getColumn()
{
}
/**
* Return the current number of columns.
* @return int number of columns
* @public
* @since 5.8.018 (2010-08-25)
*/
public function getNumberOfColumns()
{
}
/**
* Set Text rendering mode.
* @param $stroke (int) outline size in user units (0 = disable).
* @param $fill (boolean) if true fills the text (default).
* @param $clip (boolean) if true activate clipping mode
* @public
* @since 4.9.008 (2009-04-02)
*/
public function setTextRenderingMode($stroke = 0, $fill = \true, $clip = \false)
{
}
/**
* Set parameters for drop shadow effect for text.
* @param $params (array) Array of parameters: enabled (boolean) set to true to enable shadow; depth_w (float) shadow width in user units; depth_h (float) shadow height in user units; color (array) shadow color or false to use the stroke color; opacity (float) Alpha value: real value from 0 (transparent) to 1 (opaque); blend_mode (string) blend mode, one of the following: Normal, Multiply, Screen, Overlay, Darken, Lighten, ColorDodge, ColorBurn, HardLight, SoftLight, Difference, Exclusion, Hue, Saturation, Color, Luminosity.
* @since 5.9.174 (2012-07-25)
* @public
*/
public function setTextShadow($params = array('enabled' => \false, 'depth_w' => 0, 'depth_h' => 0, 'color' => \false, 'opacity' => 1, 'blend_mode' => 'Normal'))
{
}
/**
* Return the text shadow parameters array.
* @return Array of parameters.
* @since 5.9.174 (2012-07-25)
* @public
*/
public function getTextShadow()
{
}
/**
* Returns an array of chars containing soft hyphens.
* @param $word (array) array of chars
* @param $patterns (array) Array of hypenation patterns.
* @param $dictionary (array) Array of words to be returned without applying the hyphenation algorithm.
* @param $leftmin (int) Minimum number of character to leave on the left of the word without applying the hyphens.
* @param $rightmin (int) Minimum number of character to leave on the right of the word without applying the hyphens.
* @param $charmin (int) Minimum word length to apply the hyphenation algorithm.
* @param $charmax (int) Maximum length of broken piece of word.
* @return array text with soft hyphens
* @author Nicola Asuni
* @since 4.9.012 (2010-04-12)
* @protected
*/
protected function hyphenateWord($word, $patterns, $dictionary = array(), $leftmin = 1, $rightmin = 2, $charmin = 1, $charmax = 8)
{
}
/**
* Returns text with soft hyphens.
* @param $text (string) text to process
* @param $patterns (mixed) Array of hypenation patterns or a TEX file containing hypenation patterns. TEX patterns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/
* @param $dictionary (array) Array of words to be returned without applying the hyphenation algorithm.
* @param $leftmin (int) Minimum number of character to leave on the left of the word without applying the hyphens.
* @param $rightmin (int) Minimum number of character to leave on the right of the word without applying the hyphens.
* @param $charmin (int) Minimum word length to apply the hyphenation algorithm.
* @param $charmax (int) Maximum length of broken piece of word.
* @return array text with soft hyphens
* @author Nicola Asuni
* @since 4.9.012 (2010-04-12)
* @public
*/
public function hyphenateText($text, $patterns, $dictionary = array(), $leftmin = 1, $rightmin = 2, $charmin = 1, $charmax = 8)
{
}
/**
* Enable/disable rasterization of vector images using ImageMagick library.
* @param $mode (boolean) if true enable rasterization, false otherwise.
* @public
* @since 5.0.000 (2010-04-27)
*/
public function setRasterizeVectorImages($mode)
{
}
/**
* Enable or disable default option for font subsetting.
* @param $enable (boolean) if true enable font subsetting by default.
* @author Nicola Asuni
* @public
* @since 5.3.002 (2010-06-07)
*/
public function setFontSubsetting($enable = \true)
{
}
/**
* Return the default option for font subsetting.
* @return boolean default font subsetting state.
* @author Nicola Asuni
* @public
* @since 5.3.002 (2010-06-07)
*/
public function getFontSubsetting()
{
}
/**
* Left trim the input string
* @param $str (string) string to trim
* @param $replace (string) string that replace spaces.
* @return left trimmed string
* @author Nicola Asuni
* @public
* @since 5.8.000 (2010-08-11)
*/
public function stringLeftTrim($str, $replace = '')
{
}
/**
* Right trim the input string
* @param $str (string) string to trim
* @param $replace (string) string that replace spaces.
* @return right trimmed string
* @author Nicola Asuni
* @public
* @since 5.8.000 (2010-08-11)
*/
public function stringRightTrim($str, $replace = '')
{
}
/**
* Trim the input string
* @param $str (string) string to trim
* @param $replace (string) string that replace spaces.
* @return trimmed string
* @author Nicola Asuni
* @public
* @since 5.8.000 (2010-08-11)
*/
public function stringTrim($str, $replace = '')
{
}
/**
* Return true if the current font is unicode type.
* @return true for unicode font, false otherwise.
* @author Nicola Asuni
* @public
* @since 5.8.002 (2010-08-14)
*/
public function isUnicodeFont()
{
}
/**
* Return normalized font name
* @param $fontfamily (string) property string containing font family names
* @return string normalized font name
* @author Nicola Asuni
* @public
* @since 5.8.004 (2010-08-17)
*/
public function getFontFamilyName($fontfamily)
{
}
/**
* Start a new XObject Template.
* An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images).
* An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
* Note: X,Y coordinates will be reset to 0,0.
* @param $w (int) Template width in user units (empty string or zero = page width less margins).
* @param $h (int) Template height in user units (empty string or zero = page height less margins).
* @param $group (mixed) Set transparency group. Can be a boolean value or an array specifying optional parameters: 'CS' (solour space name), 'I' (boolean flag to indicate isolated group) and 'K' (boolean flag to indicate knockout group).
* @return int the XObject Template ID in case of success or false in case of error.
* @author Nicola Asuni
* @public
* @since 5.8.017 (2010-08-24)
* @see endTemplate(), printTemplate()
*/
public function startTemplate($w = 0, $h = 0, $group = \false)
{
}
/**
* End the current XObject Template started with startTemplate() and restore the previous graphic state.
* An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images).
* An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
* @return int the XObject Template ID in case of success or false in case of error.
* @author Nicola Asuni
* @public
* @since 5.8.017 (2010-08-24)
* @see startTemplate(), printTemplate()
*/
public function endTemplate()
{
}
/**
* Print an XObject Template.
* You can print an XObject Template inside the currently opened Template.
* An XObject Template is a PDF block that is a self-contained description of any sequence of graphics objects (including path objects, text objects, and sampled images).
* An XObject Template may be painted multiple times, either on several pages or at several locations on the same page and produces the same results each time, subject only to the graphics state at the time it is invoked.
* @param $id (string) The ID of XObject Template to print.
* @param $x (int) X position in user units (empty string = current x position)
* @param $y (int) Y position in user units (empty string = current y position)
* @param $w (int) Width in user units (zero = remaining page width)
* @param $h (int) Height in user units (zero = remaining page height)
* @param $align (string) Indicates the alignment of the pointer next to template insertion relative to template height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul>
* @param $palign (string) Allows to center or align the template on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param $fitonpage (boolean) If true the template is resized to not exceed page dimensions.
* @author Nicola Asuni
* @public
* @since 5.8.017 (2010-08-24)
* @see startTemplate(), endTemplate()
*/
public function printTemplate($id, $x = '', $y = '', $w = 0, $h = 0, $align = '', $palign = '', $fitonpage = \false)
{
}
/**
* Set the percentage of character stretching.
* @param $perc (int) percentage of stretching (100 = no stretching)
* @author Nicola Asuni
* @public
* @since 5.9.000 (2010-09-29)
*/
public function setFontStretching($perc = 100)
{
}
/**
* Get the percentage of character stretching.
* @return float stretching value
* @author Nicola Asuni
* @public
* @since 5.9.000 (2010-09-29)
*/
public function getFontStretching()
{
}
/**
* Set the amount to increase or decrease the space between characters in a text.
* @param $spacing (float) amount to increase or decrease the space between characters in a text (0 = default spacing)
* @author Nicola Asuni
* @public
* @since 5.9.000 (2010-09-29)
*/
public function setFontSpacing($spacing = 0)
{
}
/**
* Get the amount to increase or decrease the space between characters in a text.
* @return int font spacing (tracking) value
* @author Nicola Asuni
* @public
* @since 5.9.000 (2010-09-29)
*/
public function getFontSpacing()
{
}
/**
* Return an array of no-write page regions
* @return array of no-write page regions
* @author Nicola Asuni
* @public
* @since 5.9.003 (2010-10-13)
* @see setPageRegions(), addPageRegion()
*/
public function getPageRegions()
{
}
/**
* Set no-write regions on page.
* A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code.
* A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
* You can set multiple regions for the same page.
* @param $regions (array) array of no-write regions. For each region you can define an array as follow: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right). Omit this parameter to remove all regions.
* @author Nicola Asuni
* @public
* @since 5.9.003 (2010-10-13)
* @see addPageRegion(), getPageRegions()
*/
public function setPageRegions($regions = array())
{
}
/**
* Add a single no-write region on selected page.
* A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code.
* A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
* You can set multiple regions for the same page.
* @param $region (array) array of a single no-write region array: ('page' => page number or empy for current page, 'xt' => X top, 'yt' => Y top, 'xb' => X bottom, 'yb' => Y bottom, 'side' => page side 'L' = left or 'R' = right).
* @author Nicola Asuni
* @public
* @since 5.9.003 (2010-10-13)
* @see setPageRegions(), getPageRegions()
*/
public function addPageRegion($region)
{
}
/**
* Remove a single no-write region.
* @param $key (int) region key
* @author Nicola Asuni
* @public
* @since 5.9.003 (2010-10-13)
* @see setPageRegions(), getPageRegions()
*/
public function removePageRegion($key)
{
}
/**
* Check page for no-write regions and adapt current coordinates and page margins if necessary.
* A no-write region is a portion of the page with a rectangular or trapezium shape that will not be covered when writing text or html code.
* A region is always aligned on the left or right side of the page ad is defined using a vertical segment.
* @param $h (float) height of the text/image/object to print in user units
* @param $x (float) current X coordinate in user units
* @param $y (float) current Y coordinate in user units
* @return array($x, $y)
* @author Nicola Asuni
* @protected
* @since 5.9.003 (2010-10-13)
*/
protected function checkPageRegions($h, $x, $y)
{
}
// --- SVG METHODS ---------------------------------------------------------
/**
* Embedd a Scalable Vector Graphics (SVG) image.
* NOTE: SVG standard is not yet fully implemented, use the setRasterizeVectorImages() method to enable/disable rasterization of vector images using ImageMagick library.
* @param $file (string) Name of the SVG file or a '@' character followed by the SVG data string.
* @param $x (float) Abscissa of the upper-left corner.
* @param $y (float) Ordinate of the upper-left corner.
* @param $w (float) Width of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param $h (float) Height of the image in the page. If not specified or equal to zero, it is automatically calculated.
* @param $link (mixed) URL or identifier returned by AddLink().
* @param $align (string) Indicates the alignment of the pointer next to image insertion relative to image height. The value can be:<ul><li>T: top-right for LTR or top-left for RTL</li><li>M: middle-right for LTR or middle-left for RTL</li><li>B: bottom-right for LTR or bottom-left for RTL</li><li>N: next line</li></ul> If the alignment is an empty string, then the pointer will be restored on the starting SVG position.
* @param $palign (string) Allows to center or align the image on the current line. Possible values are:<ul><li>L : left align</li><li>C : center</li><li>R : right align</li><li>'' : empty string : left for LTR or right for RTL</li></ul>
* @param $border (mixed) Indicates if borders must be drawn around the cell. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul> or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group - for example: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param $fitonpage (boolean) if true the image is resized to not exceed page dimensions.
* @author Nicola Asuni
* @since 5.0.000 (2010-05-02)
* @public
*/
public function ImageSVG($file, $x = '', $y = '', $w = 0, $h = 0, $link = '', $align = '', $palign = '', $border = 0, $fitonpage = \false)
{
}
/**
* Convert SVG transformation matrix to PDF.
* @param $tm (array) original SVG transformation matrix
* @return array transformation matrix
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected function convertSVGtMatrix($tm)
{
}
/**
* Apply SVG graphic transformation matrix.
* @param $tm (array) original SVG transformation matrix
* @protected
* @since 5.0.000 (2010-05-02)
*/
protected function SVGTransform($tm)
{
}
/**
* Apply the requested SVG styles (*** TO BE COMPLETED ***)
* @param $svgstyle (array) array of SVG styles to apply
* @param $prevsvgstyle (array) array of previous SVG style
* @param $x (int) X origin of the bounding box
* @param $y (int) Y origin of the bounding box
* @param $w (int) width of the bounding box
* @param $h (int) height of the bounding box
* @param $clip_function (string) clip function
* @param $clip_params (array) array of parameters for clipping function
* @return object style
* @author Nicola Asuni
* @since 5.0.000 (2010-05-02)
* @protected
*/
protected function setSVGStyles($svgstyle, $prevsvgstyle, $x = 0, $y = 0, $w = 1, $h = 1, $clip_function = '', $clip_params = array())
{
}
/**
* Draws an SVG path
* @param $d (string) attribute d of the path SVG element
* @param $style (string) Style of rendering. Possible values are:
* <ul>
* <li>D or empty string: Draw (default).</li>
* <li>F: Fill.</li>
* <li>F*: Fill using the even-odd rule to determine which regions lie inside the clipping path.</li>
* <li>DF or FD: Draw and fill.</li>
* <li>DF* or FD*: Draw and fill using the even-odd rule to determine which regions lie inside the clipping path.</li>
* <li>CNZ: Clipping mode (using the even-odd rule to determine which regions lie inside the clipping path).</li>
* <li>CEO: Clipping mode (using the nonzero winding number rule to determine which regions lie inside the clipping path).</li>
* </ul>
* @return array of container box measures (x, y, w, h)
* @author Nicola Asuni
* @since 5.0.000 (2010-05-02)
* @protected
*/
protected function SVGPath($d, $style = '')
{
}
/**
* Return the tag name without the namespace
* @param $name (string) Tag name
* @protected
*/
protected function removeTagNamespace($name)
{
}
/**
* Sets the opening SVG element handler function for the XML parser. (*** TO BE COMPLETED ***)
* @param $parser (resource) The first parameter, parser, is a reference to the XML parser calling the handler.
* @param $name (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters.
* @param $attribs (array) The third parameter, attribs, contains an associative array with the element's attributes (if any). The keys of this array are the attribute names, the values are the attribute values. Attribute names are case-folded on the same criteria as element names. Attribute values are not case-folded. The original order of the attributes can be retrieved by walking through attribs the normal way, using each(). The first key in the array was the first attribute, and so on.
* @param $ctm (array) tranformation matrix for clipping mode (starting transformation matrix).
* @author Nicola Asuni
* @since 5.0.000 (2010-05-02)
* @protected
*/
protected function startSVGElementHandler($parser, $name, $attribs, $ctm = array())
{
}
/**
* Sets the closing SVG element handler function for the XML parser.
* @param $parser (resource) The first parameter, parser, is a reference to the XML parser calling the handler.
* @param $name (string) The second parameter, name, contains the name of the element for which this handler is called. If case-folding is in effect for this parser, the element name will be in uppercase letters.
* @author Nicola Asuni
* @since 5.0.000 (2010-05-02)
* @protected
*/
protected function endSVGElementHandler($parser, $name)
{
}
/**
* Sets the character data handler function for the XML parser.
* @param $parser (resource) The first parameter, parser, is a reference to the XML parser calling the handler.
* @param $data (string) The second parameter, data, contains the character data as a string.
* @author Nicola Asuni
* @since 5.0.000 (2010-05-02)
* @protected
*/
protected function segSVGContentHandler($parser, $data)
{
}
// --- END SVG METHODS -----------------------------------------------------
}
}
namespace WHMCS {
class PDF extends \TCPDF
{
protected $paperSize = NULL;
protected $headerTplFile = "";
protected $footerTplFile = "";
protected $templateVars = array();
public function __construct()
{
}
public function setHeaderTplFile($headerTplFile)
{
}
public function setFooterTplFile($footerTplFile)
{
}
public function setTemplateVars(array $tplVars)
{
}
public function Header()
{
}
public function Footer()
{
}
public function SetFont($family, $style = "", $size = NULL, $fontfile = "", $subset = "default", $out = true)
{
}
}
class WhmcsMailbox extends \PhpImap\Mailbox
{
public function __construct($imapPath, $login, $password, $attachmentsDir = NULL, $serverEncoding = "UTF-8")
{
}
protected function convertStringEncoding($string, $fromEncoding, $toEncoding)
{
}
}
class Pricing
{
protected $currency = NULL;
public function loadPricing($type, $relid, $currency = NULL)
{
}
public function getData($key)
{
}
public function getRelID()
{
}
public function getSetup($cycle)
{
}
public function getPrice($cycle)
{
}
public function getAvailableBillingCycles()
{
}
public function hasBillingCyclesAvailable()
{
}
public function getFirstAvailableCycle()
{
}
public function getAllCycleOptions()
{
}
public function getOneTimePricing()
{
}
protected function getCycleData($cycle, $months = 0)
{
}
public function getAllCycleOptionsIndexedByCycle()
{
}
}
class TwoFactorAuthentication
{
protected $settings = array();
protected $clientmodules = array();
protected $adminmodules = array();
protected $adminmodule = "";
protected $adminsettings = array();
protected $admininfo = array();
protected $clientmodule = "";
protected $clientsettings = array();
protected $clientinfo = array();
protected $adminid = "";
protected $clientid = "";
public function __construct()
{
}
protected function loadSettings()
{
}
public function getModuleSettings($module)
{
}
public function getModuleSetting($module, $name)
{
}
public function setModuleSetting($module, $name, $value)
{
}
public function isModuleEnabled($module)
{
}
public function isModuleEnabledForClients($module)
{
}
public function isModuleEnabledForAdmins($module)
{
}
public function setModuleClientEnablementStatus($module, $status)
{
}
public function setModuleAdminEnablementStatus($module, $status)
{
}
public function isForced()
{
}
public function isForcedClients()
{
}
public function isForcedAdmins()
{
}
public function setForcedClients($status)
{
}
public function setForcedAdmins($status)
{
}
public function save()
{
}
public function isActiveClients()
{
}
public function isActiveAdmins()
{
}
public function setClientID($id)
{
}
public function setAdminID($id)
{
}
protected function loadClientSettings()
{
}
protected function loadAdminSettings()
{
}
public function getAvailableModules()
{
}
protected function getAvailableClientModules()
{
}
protected function getAvailableAdminModules()
{
}
public function isEnabled()
{
}
protected function isEnabledClient()
{
}
protected function isEnabledAdmin()
{
}
protected function getModule()
{
}
public function moduleCall($function, $module = "", $extraParams = array())
{
}
protected function buildParams($module)
{
}
public function activateUser($module, $settings = array())
{
}
public function disableUser()
{
}
public function validateAndDisableUser($inputVerifyPassword)
{
}
public function saveUserSettings($arr)
{
}
public function getUserSetting($var)
{
}
public function verifyBackupCode($code)
{
}
public function generateNewBackupCode()
{
}
}
class Terminus
{
protected static function setInstance(\WHMCS\Terminus $terminus)
{
}
protected static function destroyInstance()
{
}
public static function getInstance()
{
}
public function doExit($status = 0)
{
}
public function doDie($msg = "")
{
}
}
}
namespace WHMCS\Network {
class NetworkIssue extends \WHMCS\Model\AbstractModel
{
protected $table = "tblnetworkissues";
protected $columnMap = array("affectedType" => "type", "affectedOther" => "affecting", "affectedServerId" => "server", "lastUpdateDate" => "lastupdate");
protected $dates = array("startdate", "enddate", "lastupdate");
public static function boot()
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\View\Traits {
trait AdminUserContextTrait
{
protected $adminUser = NULL;
public function getAdminUser()
{
}
public function setAdminUser($user)
{
}
public function getAdminTemplateVariables()
{
}
public function getAdminLanguageVariables()
{
}
public function getOnlineAdminUsernames()
{
}
public function isFullAdmin()
{
}
}
abstract class NotificationTrait
{
protected $topBarNotification = array();
protected $clientLimitNotification = array();
protected $globalWarningNotification = array();
public abstract function getAdminUser();
public function getTopBarNotification()
{
}
public function getClientLimitNotification()
{
}
public function getGlobalWarningNotification()
{
}
public function addTopBarNotification($notification)
{
}
public function addClientLimitNotification($clientLimitNotification)
{
}
public function addGlobalWarningNotification($globalWarningNotification)
{
}
protected function getClientLimitNotificationDismisses()
{
}
protected function isClientLimitNotificationDismissed($title)
{
}
public function getNotificationJavascript()
{
}
public function getNotificationJquery()
{
}
}
}
namespace WHMCS {
class Admin
{
use \WHMCS\Admin\ApplicationSupport\View\Traits\AdminUserContextTrait;
use \WHMCS\Admin\ApplicationSupport\View\Traits\NotificationTrait;
public $loginRequired = true;
public $requiredPermission = "";
public $title = "";
public $sidebar = "";
public $icon = "";
public $helplink = "";
public $jscode = "";
public $internaljquerycode = array();
public $jquerycode = "";
public $template = "";
public $content = "";
public $templatevars = array();
public $filename = "";
public $rowLimit = 50;
public $tablePagination = true;
public $adminTemplate = self::DEFAULT_ADMIN_TEMPLATE;
public $exitmsg = "";
public $language = "english";
public $extrajscode = array();
public $headOutput = array();
public $chartFunctions = array();
public $sortableTableCount = 0;
protected $tabPrefix = "";
public $smarty = "";
protected $notificationContent = "";
protected $bodyContent = "";
protected $headerContent = "";
protected $footerContent = "";
protected $responseType = self::RESPONSE_HTML;
protected $translateJqueryDefined = false;
protected $standardVariablesLoaded = false;
protected $tabCount = 1;
protected $defaultTabOpen = false;
protected $topBarNotifications = array();
const DEFAULT_ADMIN_TEMPLATE = "blend";
const RESPONSE_JSON_MODAL_MESSAGE = "JSON_MODAL_MESSAGE";
const RESPONSE_JSON_MESSAGE = \WHMCS\Http\Message\ResponseFactory::RESPONSE_TYPE_JSON;
const RESPONSE_JSON = "JSON";
const RESPONSE_HTML_MESSAGE = \WHMCS\Http\Message\ResponseFactory::RESPONSE_TYPE_HTML;
const RESPONSE_HTML = "HTML";
public function __construct($reqpermission, $releaseSession = true)
{
}
public function getResponseType()
{
}
public function setResponseType($responseType)
{
}
public function isModalResponseType()
{
}
public function isHtmlMessageResponseType()
{
}
public function isJsonMessageResponseType()
{
}
public function isJsonResponseType()
{
}
public function isHtmlResponseType()
{
}
public static function getID()
{
}
public function getAdminID()
{
}
public function getAdminRoleID()
{
}
protected function setAdminRoleId($roleId)
{
}
public function hasPermission($permissionName)
{
}
protected function hasPermissionId($permissionId, $roleId = 0)
{
}
protected function getPermissionIdFromName($permissionName)
{
}
public function requiredFiles($reqfiles)
{
}
public function setTemplate($tplname)
{
}
public function assign($tplvar, $value = NULL)
{
}
public function clientsDropDown($selectedValue, $autoSubmit = false, $fieldName = "userid", $anyOption = false, $tabOrder = 0)
{
}
public function productStatusDropDown($status, $anyop = false, $name = "status", $id = "")
{
}
public function getTemplate($template, $runAdminAreaPageHook = true)
{
}
public function getTemplatePath()
{
}
protected function factoryAdminSmarty()
{
}
public function display()
{
}
public function populateStandardAdminSmartyVariables()
{
}
public function getGlobalClientLimitNotification($adminRoleId, $licensing)
{
}
protected function dismissClientLimitNotification($title)
{
}
protected function dismissClientLimitNotificationPermanently($title)
{
}
protected function isClientLimitNotificationDismissed($title)
{
}
public function assignToSmarty()
{
}
public function output($jsonEncodingOptions = NULL)
{
}
public function displayPopUp()
{
}
public function sortableTableInit($defaultsort, $defaultorder = "ASC")
{
}
public function sortableTable($columns, $tabledata, $formurl = "", $formbuttons = "", $topbuttons = "")
{
}
public function setClientsProfilePresets($userId = 0)
{
}
protected function getClientsProfileHeader($userId = 0)
{
}
public function gracefulExit($msg)
{
}
public function cyclesDropDown($billingcycle, $any = "", $freeop = "", $name = "billingcycle", $onchange = "", $id = "")
{
}
public function jqueryDialog($name, $title, $message, $buttons = array(), $height = "", $width = "", $alerttype = "alert")
{
}
public function outputClientLink($userid, $firstname = "", $lastname = "", $companyname = "", $groupid = "", $newWindow = false)
{
}
public function lang($section, $var, $escape = "")
{
}
public function deleteJSConfirm($name, $langtype, $langvar, $url)
{
}
public function popupWindow($link, $formId = "", $width = 600, $height = 400, $output = true)
{
}
public function valUserID($tempuid)
{
}
public function richTextEditor($location = "")
{
}
public function productDropDown($pid = 0, $noneopt = "", $anyopt = "")
{
}
public function dialog($funccall = "", $content = "", $draggable = true)
{
}
public function addHeadOutput($output)
{
}
public function addHeadJsCode($code)
{
}
public function addHeadJqueryCode($code)
{
}
public function addInternalJQueryCode($code)
{
}
protected function setHeaderContent($text = "")
{
}
public function autoAddTokensToForms($content)
{
}
public function assertClientBoundary($userId, $errorMessage = NULL)
{
}
protected function getHeaderContent()
{
}
public function setNotificationContent($text = "")
{
}
public function getNotificationContent()
{
}
public function setBodyContent($data = "")
{
}
public function getBodyContent()
{
}
public function setFooterContent($text = "")
{
}
public function getFooterContent()
{
}
public function getPageContent()
{
}
public function beginAdminTabs(array $tabs = array(), $defaultTabOpen = false, $tabPrefix = "")
{
}
public function nextAdminTab()
{
}
public function endAdminTabs()
{
}
protected function makeAdminTabsToggle()
{
}
public function modal($name, $title, $message, array $buttons = array(), $size = "", $panelType = "primary")
{
}
public function modalWithConfirmation($name, $question, $url, $jsVariable = "invoice")
{
}
public function clientSearchDropdown($name, $selectedOption = "", array $options = array(), $placeHolder = "", $valueAttribute = "id", $tabOrder = 0)
{
}
public function performClientSearch($searchTerm)
{
}
public function flash($title, $message, $status = "success")
{
}
public function getFlash()
{
}
public function getFlashAsInfobox()
{
}
public function addMarkdownEditor($jsVariable = "openTicketMDE", $uniqueId = "ticket_open", $elementId = "replymessage", $addFilesToHead = true)
{
}
public function formatImportantClientNotes(array $notes)
{
}
public function getTranslationLink($type, $id, $customFieldType = "")
{
}
protected function addToTopBarNotifications($htmlOutput)
{
}
protected function getTopBarNotifications()
{
}
protected function getGlobalAdminWarningNotifications()
{
}
protected function validateAuthConfirmation($password)
{
}
public function hasAuthConfirmation()
{
}
public function requireAuthConfirmation()
{
}
public function jsonResponse($data)
{
}
public function getChartFunctions()
{
}
public static function dismissFeatureHighlightsUntilUpdateForAdmin($adminId, $forVersion = \WHMCS\Notification\VersionFeatureHighlights::FEATURE_HIGHLIGHT_VERSION)
{
}
public function isFeatureHighlightsDismissedUntilUpdate($forVersion = \WHMCS\Notification\VersionFeatureHighlights::FEATURE_HIGHLIGHT_VERSION)
{
}
public function removeFeatureHighlightsPermanentDismissal()
{
}
public function dismissFeatureHighlightsUntilUpdate($forVersion = \WHMCS\Notification\VersionFeatureHighlights::FEATURE_HIGHLIGHT_VERSION)
{
}
public function dismissFeatureHighlightsForSession($forVersion = \WHMCS\Notification\VersionFeatureHighlights::FEATURE_HIGHLIGHT_VERSION)
{
}
public function shouldSeeFeatureHighlights($forVersion = \WHMCS\Notification\VersionFeatureHighlights::FEATURE_HIGHLIGHT_VERSION)
{
}
public function setAdminTemplate($templateName)
{
}
}
}
namespace WHMCS\Billing {
interface PricingInterface
{
const TYPE_PRODUCT = "product";
const TYPE_ADDON = "addon";
const TYPE_CONFIGOPTION = "configoptions";
const TYPE_DOMAIN_REGISTER = "domainregister";
const TYPE_DOMAIN_TRANSFER = "domaintransfer";
const TYPE_DOMAIN_RENEW = "domainrenew";
const TYPE_DOMAIN_ADDON = "domainaddons";
const TYPE_USAGE = "usage";
public function pricingType();
}
class Pricing extends \WHMCS\Model\AbstractModel implements \WHMCS\Billing\PricingInterface
{
protected $table = "tblpricing";
public $timestamps = false;
protected $fillable = array("relid", "type", "currency", "msetupfee", "qsetupfee", "ssetupfee", "asetupfee", "bsetupfee", "tsetupfee", "monthly", "quarterly", "semiannually", "annually", "biennially", "triennially");
protected $types = NULL;
public static function boot()
{
}
public function createTable($drop = false)
{
}
public function priceFields()
{
}
public function setupFields()
{
}
public function updateEnumField()
{
}
public function getCurrencyAttribute()
{
}
public function setCurrencyAttribute($value)
{
}
public function getCurrencyIdAttribute()
{
}
public function setCurrencyIdAttribute($value)
{
}
public function pricingType()
{
}
public function supportedTypes()
{
}
}
}
namespace WHMCS\Billing\Pricing {
class Markup
{
protected $amount = 0;
protected $margin = 0;
protected $rounding = 0;
protected $decimalPlaces = 2;
public static function factoryFixed($amount, $margin, $rounding = 0)
{
}
public static function factoryPercentage($amount, $margin, $rounding = 0)
{
}
public function amount($amount)
{
}
public function margin($margin)
{
}
public function rounding($rounding)
{
}
public function fixed()
{
}
public function percentage()
{
}
public function decimalPlaces($decimalPlaces)
{
}
protected function doRounding($amount)
{
}
public function percentageDifference($costPrice)
{
}
}
}
namespace WHMCS\Billing\Tax {
class Vat
{
const EU_COUNTRIES = array("AT" => 20, "BE" => 21, "BG" => 20, "CY" => 19, "CZ" => 21, "DE" => 19, "DK" => 25, "EE" => 20, "ES" => 21, "FI" => 24, "FR" => 20, "GB" => 20, "GR" => 24, "HR" => 25, "HU" => 27, "IE" => 23, "IT" => 22, "LT" => 21, "LU" => 17, "LV" => 21, "MT" => 18, "NL" => 21, "PL" => 23, "PT" => 23, "RO" => 19, "SE" => 25, "SI" => 22, "SK" => 20);
public static function validateNumber($vatNumber = "")
{
}
public static function setTaxExempt(\WHMCS\User\Client &$client)
{
}
public function initiateInvoiceNumberingReset()
{
}
protected function resetInvoiceNumbering($key, $resetFrequency)
{
}
protected static function sendValidateTaxNumber($vatNumber)
{
}
protected static function removeSessionData($vatNumber)
{
}
public static function getLabel($prefix = "tax")
{
}
public static function getFieldName($contact = false)
{
}
public static function isUsingNativeField($contact = false)
{
}
public static function isTaxIdEnabled()
{
}
public static function isTaxIdDisabled()
{
}
public static function isTaxEnabled()
{
}
}
}
namespace WHMCS\Billing {
class Quote extends \WHMCS\Model\AbstractModel
{
protected $table = "tblquotes";
public $timestamps = false;
protected $columnMap = array("status" => "stage", "validUntilDate" => "validuntil", "clientId" => "userid", "lastModifiedDate" => "lastmodified", "customerNotes" => "customernotes", "adminNotes" => "adminnotes", "dateCreated" => "datecreated", "dateSent" => "datesent", "dateAccepted" => "dateaccepted");
protected $dates = array("validuntil", "datecreated", "lastmodified", "datesent", "dateaccepted");
public function client()
{
}
public function items()
{
}
}
interface InvoiceItemInterface
{
const TYPE_NONE = "";
const TYPE_MASS_PAY_INVOICE = "Invoice";
const TYPE_ADD_FUNDS_INVOICE = "AddFunds";
const TYPE_SERVICE = "Hosting";
const TYPE_SERVICE_ADDON = "Addon";
const TYPE_DOMAIN = "Domain";
const TYPE_DOMAIN_REGISTRATION = "DomainRegister";
const TYPE_DOMAIN_TRANSFER = "DomainTransfer";
const TYPE_DOMAIN_EMAIL_FORWARDING = "DomainAddonEMF";
const TYPE_DOMAIN_ID_PROTECTION = "DomainAddonIDP";
const TYPE_DOMAIN_DNS_MANAGEMENT = "DomainAddonDNS";
const TYPE_UPGRADE = "Upgrade";
const TYPE_BILLABLE_ITEM = "Item";
const TYPE_BILLABLE_USAGE = "Usage";
const PSEUDO_TYPE_PRORATA_PRODUCT = "ProrataProduct";
const PSEUDO_TYPE_PRORATA_PRODUCT_ADDON = "ProrataAddon";
}
class LegacyPricing
{
protected $db_fields = array("msetupfee", "qsetupfee", "ssetupfee", "asetupfee", "bsetupfee", "tsetupfee", "monthly", "quarterly", "semiannually", "annually", "biennially", "triennially");
public function getDBFields()
{
}
}
}
namespace WHMCS\Billing\Quote {
class Item extends \WHMCS\Model\AbstractModel
{
protected $table = "tblquoteitems";
protected $booleans = array("taxable");
protected $columnMap = array("isTaxable" => "taxable");
public function quote()
{
}
}
}
namespace WHMCS\Billing\Payment\Transaction {
class History extends \WHMCS\Model\AbstractModel
{
protected $table = "tbltransaction_history";
protected $dates = array("dateCreated", "dateUpdated");
protected $booleans = array("completed");
protected $columnMap = array("invoiceId" => "invoice_id", "transactionId" => "transaction_id", "remoteStatus" => "remote_status", "additionalInformation" => "additional_information", "currencyId" => "currency_id");
protected $fillable = array("invoice_id", "gateway", "transaction_id");
public static function boot()
{
}
public function createTable($drop = false)
{
}
public function invoice()
{
}
public function currency()
{
}
public function getAdditionalInformationAttribute($information)
{
}
public function setAdditionalInformationAttribute(array $value = array())
{
}
}
}
namespace WHMCS\Billing\Payment {
class Transaction extends \WHMCS\Model\AbstractModel
{
protected $table = "tblaccounts";
protected $dates = array("date");
protected $columnMap = array("clientId" => "userid", "currencyId" => "currency", "paymentGateway" => "gateway", "exchangeRate" => "rate", "transactionId" => "transid", "amountIn" => "amountin", "amountOut" => "amountout", "invoiceId" => "invoiceid", "refundId" => "refundid");
public $timestamps = false;
public function client()
{
}
public function invoice()
{
}
public function scopeLookup($query, $gateway, $transactionId)
{
}
}
}
namespace WHMCS\Billing\Invoice\Tax {
class Vat
{
protected $invoice = NULL;
public function __construct(\WHMCS\Billing\Invoice $invoice)
{
}
public function setCustomInvoiceNumberFormat()
{
}
public function setInvoiceDateOnPayment()
{
}
protected function incrementNextCustomInvoiceNumber($lastNumber)
{
}
}
}
namespace WHMCS\Billing\Invoice {
class Item extends \WHMCS\Model\AbstractModel implements \WHMCS\Billing\InvoiceItemInterface
{
protected $table = "tblinvoiceitems";
public $timestamps = false;
protected $booleans = array("taxed");
protected $dates = array("dueDate");
protected $columnMap = array("relatedEntityId" => "relid");
protected $fillable = array("type", "relid", "description", "amount", "userid", "paymentmethod", "duedate", "taxed", "invoiceid");
public function invoice()
{
}
public function addon()
{
}
public function domain()
{
}
public function service()
{
}
public function scopeOnlyServices($query)
{
}
public function scopeOnlyAddons($query)
{
}
public function scopeOnlyDomains($query)
{
}
}
class Helper
{
public static function convertCurrency($amount, \WHMCS\Billing\Currency $currency, \WHMCS\Billing\Invoice $invoice)
{
}
}
class Data extends \WHMCS\Model\AbstractModel
{
protected $table = "tblinvoicedata";
protected $fillable = array("invoice_id", "country");
public function createTable($drop = false)
{
}
public function invoice()
{
}
}
class Snapshot extends \WHMCS\Model\AbstractModel
{
protected $table = "mod_invoicedata";
public $timestamps = false;
protected $primaryKey = "invoiceid";
public $unique = array("invoiceid");
protected $columnMap = array("invoiceId" => "invoiceid", "clientsDetails" => "clientsdetails", "customFields" => "customfields");
protected $fillable = array("invoiceid", "clientsdetails", "customfields");
public function createTable($drop = false)
{
}
public function invoice()
{
}
public function getClientsDetailsAttribute()
{
}
public function getCustomFieldsAttribute()
{
}
public function setClientsDetailsAttribute(array $clientsDetails)
{
}
public function setCustomFieldsAttribute(array $customFields)
{
}
}
}
namespace WHMCS\Billing {
class Gateway extends \WHMCS\Model\AbstractModel
{
protected $table = "tblpaymentgateways";
public $timestamps = false;
public function scopeName($query)
{
}
}
class Cycles
{
protected $nonRecurringCycles = NULL;
protected $recurringCycles = array("monthly" => "Monthly", "quarterly" => "Quarterly", "semiannually" => "Semi-Annually", "annually" => "Annually", "biennially" => "Biennially", "triennially" => "Triennially");
protected $monthsToCyclesMap = NULL;
const CYCLE_FREE = "free";
const CYCLE_ONETIME = "onetime";
const DISPLAY_FREE = "Free Account";
const DISPLAY_ONETIME = "One Time";
public function getSystemBillingCycles($excludeNonRecurring = false)
{
}
public function getRecurringSystemBillingCycles()
{
}
public function isValidSystemBillingCycle($cycle)
{
}
public function isValidPublicBillingCycle($cycle)
{
}
public function getPublicBillingCycles()
{
}
public function getRecurringCycles()
{
}
public function getPublicBillingCycle($cycle)
{
}
public function getNormalisedBillingCycle($cycle)
{
}
public function getNameByMonths($months)
{
}
public function getNumberOfMonths($cycle)
{
}
public function isRecurring($cycle)
{
}
public function isFree($cycle)
{
}
public function translate($cycle)
{
}
public function getGreaterCycles($cycle)
{
}
}
class Tax
{
public function __construct()
{
}
public function reset()
{
}
protected function validateTaxBase($taxBase)
{
}
protected function validateTaxPercentage($percentage)
{
}
protected function validateTaxLevelPercentages($level1Percentage, $level2Percentage)
{
}
public function getLevel1Percentage()
{
}
public function setLevel1Percentage($level1Percentage)
{
}
public function getLevel2Percentage()
{
}
public function setLevel2Percentage($level2Percentage)
{
}
public function getIsInclusive()
{
}
public function setIsInclusive($isInclusive)
{
}
public function getIsCompound()
{
}
public function setIsCompound($isCompound)
{
}
public function getTaxBase()
{
}
public function setTaxBase($taxBase)
{
}
protected function recalculate()
{
}
public function getTotalBeforeTaxes()
{
}
public function getLevel1TaxTotal()
{
}
public function getLevel2TaxTotal()
{
}
public function getTotalAfterTaxes()
{
}
}
class Currency extends \WHMCS\Model\AbstractModel
{
protected $table = "tblcurrencies";
public $timestamps = false;
const DEFAULT_CURRENCY_ID = 1;
public function scopeDefaultCurrency($query)
{
}
public function scopeDefaultSorting($query)
{
}
public static function validateCurrencyCode(&$currencyCode)
{
}
}
}
namespace WHMCS\Billing\Domains {
class Invoice
{
protected $type = "grace";
protected $defaultPaymentMethod = "";
protected $fee = 0;
protected $feeType = "";
protected $feeDescription = "";
public function __construct()
{
}
public function cancelInvoiceForExpiredDomains(\Illuminate\Database\Eloquent\Collection $expiredDomains)
{
}
public function cancelOrGenerateInvoiceForDomainGraceAndRedemption(\Illuminate\Database\Eloquent\Collection $domains, $type = "grace")
{
}
}
}
namespace WHMCS {
class Validate
{
protected $optionalFields = array();
protected $validated = array();
protected $errors = array();
protected $errorMessages = array();
public function setOptionalFields($optionalFields)
{
}
public function validate($rule, $field, $languageKey, $field2 = "", $value = NULL)
{
}
public function reverseValidate($rule, $field, $languageKey, $field2 = "", $value = NULL)
{
}
public function validateCustomFields($type, $relid, $order = false, $customFields = array())
{
}
protected function runRule($rule, $field, $field2, $val = NULL)
{
}
protected function checkUploadExtensions($field)
{
}
protected function checkCaptchaInput($val)
{
}
protected function calcPasswordStrength($password)
{
}
public function addError($var)
{
}
public function addErrors(array $errors = array())
{
}
public function validated($field)
{
}
public function error($field)
{
}
public function getErrorFields()
{
}
public function getErrors()
{
}
public function hasErrors()
{
}
public function getHTMLErrorOutput()
{
}
protected function removePreviousValidations($field)
{
}
}
}
namespace WHMCS\Mentions {
class Mentions
{
protected static function parseForMentions($message)
{
}
public static function getIdsForMentions($message)
{
}
public static function getMentionReplacements($message)
{
}
public static function sendNotification($type, $relatedId, $message, array $recipients, $description = "")
{
}
}
}
namespace WHMCS {
class Cookie
{
public function __construct()
{
}
public static function get($name, $treatAsArray = false)
{
}
public static function set($name, $value, $expires = 0, $secure = NULL)
{
}
public static function delete($name)
{
}
}
class Invoices extends \WHMCS\TableModel
{
protected static $invoiceStatusValues = NULL;
public function _execute($criteria = NULL)
{
}
public function getInvoices($criteria = array())
{
}
public function formatStatus($status)
{
}
public function getInvoiceTotals()
{
}
public function duplicate($invoiceid)
{
}
public static function isSequentialPaidInvoiceNumberingEnabled()
{
}
public static function getNextSequentialPaidInvoiceNumber()
{
}
public static function padAndIncrement($number, $incrementAmount = 1)
{
}
public static function adjustIncrementForNextInvoice($lastInvoiceId)
{
}
public static function getInvoiceStatusValues()
{
}
}
class Pagination extends \WHMCS\TableQuery
{
protected $page = 1;
protected $defaultsort = "ASC";
protected $defaultorderby = "id";
protected $name = "default";
protected $sort = "";
protected $orderby = "";
protected $numResults = 0;
protected $hiddenResults = 0;
protected $pagination = true;
protected $validOrderByValues = array();
protected $basePath = NULL;
public function __construct($name = "", $defaultorderby = "", $defaultsort = "")
{
}
public function setBasePath($path)
{
}
public function digestCookieData()
{
}
public function setPage($page)
{
}
public function getPage()
{
}
public function setNumResults($num)
{
}
public function getNumResults()
{
}
public function getTotalPages()
{
}
public function getStartingNumber()
{
}
public function getEndingNumber()
{
}
public function getPrevPage()
{
}
public function getNextPage()
{
}
public function setDefaultOrderBy($field)
{
}
public function setDefaultSortDirection($sort)
{
}
public function setOrderBy($field)
{
}
public function setValidOrderByValues($array)
{
}
public function getValidOrderByValues()
{
}
public function isValidOrderBy($field)
{
}
public function getOrderBy()
{
}
public function setSortDirection($sort)
{
}
public function reverseSortDirection()
{
}
public function getSortDirection()
{
}
public function setPagination($boolean)
{
}
public function isPaginated()
{
}
public function setHiddenCount($hidden)
{
}
public function getHiddenCount()
{
}
public function getBasePath($withPage = true)
{
}
public function getName()
{
}
}
}
namespace WHMCS\Database {
class MysqlCompat
{
public static $emulated = array("mysql_affected_rows", "mysql_error", "mysql_fetch_array", "mysql_fetch_assoc", "mysql_fetch_object", "mysql_fetch_row", "mysql_get_client_info", "mysql_get_server_info", "mysql_insert_id", "mysql_num_fields", "mysql_num_rows", "mysql_query", "mysql_real_escape_string");
public static $notSupported = array("mysql_client_encoding", "mysql_close", "mysql_connect", "mysql_create_db", "mysql_data_seek", "mysql_db_name", "mysql_db_query", "mysql_drop_db", "mysql_errno", "mysql_escape_string", "mysql_fetch_field", "mysql_fetch_lengths", "mysql_field_flags", "mysql_field_len", "mysql_field_name", "mysql_field_seek", "mysql_field_table", "mysql_field_type", "mysql_free_result", "mysql_get_host_info", "mysql_get_proto_info", "mysql_info", "mysql_list_dbs", "mysql_list_fields", "mysql_list_processes", "mysql_list_tables", "mysql_pconnect", "mysql_ping", "mysql_result", "mysql_select_db", "mysql_set_charset", "mysql_stat", "mysql_tablename", "mysql_thread_id", "mysql_unbuffered_query");
protected $lastStatement = NULL;
protected $lastPDOException = NULL;
protected $pdo = NULL;
public function __construct(\PDO $pdo)
{
}
public function getLastStatement()
{
}
public function setLastStatement(\PDOStatement $lastStatement = NULL)
{
}
public function getPdo()
{
}
public function setPdo($pdo)
{
}
public function isExecuteQuery($query)
{
}
public function mysqlAffectedRows()
{
}
public function mysqlQuery($query, $pdo = NULL)
{
}
public function mysqlError()
{
}
public function mysqlFetchArray(\PDOStatement $statement)
{
}
public function mysqlFetchAssoc(\PDOStatement $statement)
{
}
public function mysqlFetchObject(\PDOStatement $statement)
{
}
public function mysqlFetchRow(\PDOStatement $statement)
{
}
public function mysqlGetClientInfo($pdo = NULL)
{
}
public function mysqlGetServerInfo($pdo = NULL)
{
}
public function mysqlInsertId()
{
}
public function mysqlNumFields(\PDOStatement $statement)
{
}
public function mysqlNumRows(\PDOStatement $statement)
{
}
public function mysqlRealEscapeString($data)
{
}
}
}
namespace WHMCS\Database\Dumper {
class Table
{
protected $database = NULL;
protected $tableName = NULL;
protected $dumpSchema = true;
protected $dumpData = true;
protected $addDropTable = true;
protected $addTableLocks = true;
protected $lockTableDuringDump = true;
protected $selectBatchSize = 100;
public function __construct(\WHMCS\Database\DatabaseInterface $database, $tableName, array $options = array())
{
}
protected function setDatabase(\WHMCS\Database\DatabaseInterface $database)
{
}
protected function getDatabase()
{
}
protected function setTableName($tableName)
{
}
protected function getTableName()
{
}
protected function setDumpSchema($dumpSchema)
{
}
protected function getDumpSchema()
{
}
protected function setDumpData($dumpData)
{
}
protected function getDumpData()
{
}
protected function setAddDropTable($addDropTable)
{
}
protected function getAddDropTable()
{
}
protected function setAddTableLocks($addTableLocks)
{
}
protected function getAddTableLocks()
{
}
public function setLockTableDuringDump($lockTableDuringDump)
{
}
public function getLockTableDuringDump()
{
}
protected function setSelectBatchSize($selectBatchSize)
{
}
protected function getSelectBatchSize()
{
}
public function dump($fh)
{
}
protected function getRowCount()
{
}
protected function getDataBatch($offset, $limit)
{
}
protected function generateDataRow(array $row = array())
{
}
protected function generateSchema()
{
}
protected function generateSchemaHeader()
{
}
protected function generateSchemaFooter()
{
}
protected function generateDataHeader()
{
}
protected function generateLockTableHeader()
{
}
protected function generateLockTableFooter()
{
}
protected function generateDropTable()
{
}
protected function lock()
{
}
protected function unlock()
{
}
}
class Database
{
protected $database = NULL;
protected $addCreateDatabase = false;
protected $addDropDatabase = false;
public function __construct(\WHMCS\Database\DatabaseInterface $database, array $options = array())
{
}
protected function setDatabase(\WHMCS\Database\DatabaseInterface $database)
{
}
protected function getDatabase()
{
}
protected function setAddCreateDatabase($addCreateDatabase)
{
}
protected function getAddCreateDatabase()
{
}
protected function setAddDropDatabase($addDropDatabase)
{
}
protected function getAddDropDatabase()
{
}
public function dumpTo($path, array $tables = array())
{
}
public function importFrom($path)
{
}
public function dump($fh)
{
}
protected function getAllTables()
{
}
protected function generateDumpHeader()
{
}
protected function generateCreateDatabase()
{
}
protected function generateDropDatabase()
{
}
protected function generateUseDatabase()
{
}
protected function unlock()
{
}
}
}
namespace WHMCS\Database {
interface DatabaseInterface
{
public function getConnection();
public function retrieveDatabaseConnection();
}
class Capsule extends \Illuminate\Database\Capsule\Manager
{
public static function getInstance()
{
}
public static function applyCollationIfCompatible($columnName)
{
}
}
}
namespace WHMCS {
class Database implements \WHMCS\Database\DatabaseInterface
{
protected $hostname = NULL;
protected $username = NULL;
protected $password = NULL;
protected $databaseName = NULL;
protected $characterSet = "latin1";
protected $connection = NULL;
protected $port = NULL;
protected $pdo = NULL;
protected $sqlMode = "";
const WAIT_TIMEOUT = 600;
public function __construct(\WHMCS\Config\DatabaseInterface $config)
{
}
public function getPdo()
{
}
public function setPdo(\PDO $pdo)
{
}
protected function setHostname($hostname)
{
}
protected function getHostname()
{
}
protected function setUsername($username)
{
}
protected function getUsername()
{
}
protected function setPassword($password)
{
}
protected function getPassword()
{
}
protected function getPort()
{
}
protected function setPort($port)
{
}
protected function setDatabaseName($databaseName)
{
}
public function getDatabaseName()
{
}
protected function setCharacterSet($characterSet)
{
}
public function getCharacterSet()
{
}
protected function setConnection($connection)
{
}
public function getConnection()
{
}
public function getSqlMode()
{
}
public function setSqlMode($value)
{
}
public function retrieveDatabaseConnection()
{
}
protected function connect()
{
}
protected function getCollationFromCharacterSet($characterSet = "utf8")
{
}
protected function capsuleFactory()
{
}
protected function applySqlMode($sqlMode)
{
}
protected function applyLegacyConnectionSqlMode($sqlMode)
{
}
public function listTables()
{
}
public function optimizeTables(array $tables)
{
}
public function showVariable($variableName)
{
}
public function showLegacyConnectionVariable($variableName)
{
}
public function isSqlStrictMode()
{
}
public function getSqlVersion()
{
}
public function getSqlVersionComment()
{
}
}
class Mobile extends \WHMCS\Admin
{
public function getTemplatePath()
{
}
protected function factoryAdminSmarty()
{
}
public function output()
{
}
public function setPageTitle($title)
{
}
public function setHeaderLeftBtn($url, $label = "", $icon = "")
{
}
public function setHeaderRightBtn($url, $label, $icon = "")
{
}
}
}
namespace WHMCS\Service {
class Ssl extends \WHMCS\Model\AbstractModel
{
protected $table = "tblsslorders";
protected $columnMap = array("certificateType" => "certtype", "configurationData" => "configdata");
protected $dates = array("completionDate");
protected $appends = array("validationType");
protected $fillable = array("userid", "serviceid", "addon_id", "module");
public $timestamps = false;
const STATUS_AWAITING_CONFIGURATION = "Awaiting Configuration";
const STATUS_CONFIGURATION_SUBMITTED = "Configuration Submitted";
const STATUS_AWAITING_ISSUANCE = "Awaiting Issuance";
const STATUS_COMPLETED = "Completed";
const STATUS_CANCELLED = "Cancelled";
public function client()
{
}
public function service()
{
}
public function addon()
{
}
public function getConfigurationDataAttribute($value)
{
}
public function setConfigurationDataAttribute($value)
{
}
public function getValidationTypeAttribute()
{
}
public function getConfigurationUrl()
{
}
public function getUpgradeUrl()
{
}
}
class ConfigOption extends \WHMCS\Model\AbstractModel
{
protected $table = "tblhostingconfigoptions";
public $timestamps = false;
public function scopeOfService($query, \WHMCS\Service\Service $service)
{
}
public function productConfigOptionSelection()
{
}
public function productConfigOption()
{
}
public function service()
{
}
public function metricUsage()
{
}
}
}
namespace WHMCS\Service\Upgrade {
class Calculator
{
protected $upgradeEntity = NULL;
protected $upgradeTarget = NULL;
protected $upgradeBillingCycle = NULL;
protected $upgradeOutput = NULL;
public function setUpgradeTargets($upgradeEntity, $upgradeTarget, $upgradeBillingCycle = NULL)
{
}
public function calculate()
{
}
protected function isServiceUpgrade()
{
}
protected function getUpgradeType()
{
}
protected function getUpgradeEntityProductIdValue()
{
}
protected function calculateCredit()
{
}
public function calculateDaysInCurrentBillingCycle($nextDueDate, $billingCycle)
{
}
}
class Upgrade extends \WHMCS\Model\AbstractModel
{
protected $table = "tblupgrades";
protected $columnMap = array("userId" => "userid", "orderId" => "orderid", "entityId" => "relid", "originalValue" => "originalvalue", "newValue" => "newvalue", "upgradeAmount" => "amount", "recurringChange" => "recurringchange");
protected $dates = array("date");
protected $casts = array("calculation" => "array");
public $timestamps = false;
public $currency = NULL;
public $applyTax = false;
public $localisedNewCycle = NULL;
const TYPE_SERVICE = "service";
const TYPE_ADDON = "addon";
const TYPE_PACKAGE = "package";
const TYPE_CONFIGOPTIONS = "configoptions";
public function service()
{
}
public function addon()
{
}
public function originalProduct()
{
}
public function newProduct()
{
}
public function originalAddon()
{
}
public function newAddon()
{
}
}
}
namespace WHMCS\Service {
class Properties
{
protected $model = NULL;
protected static $fieldsToCustomFieldName = array("username" => "Username", "password" => "Password", "domain" => "Domain", "license" => "License Key", "dedicatedip" => "Dedicated IP", "diskusage" => "Disk Usage", "disklimit" => "Disk Limit", "bwusage" => "Bandwidth Usage", "bwlimit" => "Bandwidth Limit", "lastupdate" => "Last Update", "subscriptionid" => "Subscription ID");
public function __construct($model)
{
}
protected function isNativeField($fieldName)
{
}
protected function getNativeFieldDisplayName($fieldName)
{
}
protected function getCustomField($model, $fieldName)
{
}
protected function createCustomField($model, $fieldName, $fieldType)
{
}
public function save(array $data)
{
}
public function get($fieldName)
{
}
}
class Status
{
const PENDING = "Pending";
const ACTIVE = "Active";
const SUSPENDED = "Suspended";
const TERMINATED = "Terminated";
const CANCELLED = "Cancelled";
const FRAUD = "Fraud";
}
class CancellationRequest extends \WHMCS\Model\AbstractModel
{
protected $table = "tblcancelrequests";
protected $columnMap = array("serviceId" => "relid", "whenToCancel" => "type");
protected $dates = array("date");
public function service()
{
}
}
class Service extends \WHMCS\Model\AbstractModel
{
protected $table = "tblhosting";
protected $columnMap = array("clientId" => "userid", "productId" => "packageid", "serverId" => "server", "registrationDate" => "regdate", "paymentGateway" => "paymentmethod", "status" => "domainstatus", "promotionId" => "promoid", "promotionCount" => "promocount", "overrideAutoSuspend" => "overideautosuspend", "overrideSuspendUntilDate" => "overidesuspenduntil", "bandwidthUsage" => "bwusage", "bandwidthLimit" => "bwlimit", "lastUpdateDate" => "lastupdate", "firstPaymentAmount" => "firstpaymentamount", "recurringAmount" => "amount", "recurringFee" => "amount");
protected $dates = array("registrationDate", "overrideSuspendUntilDate", "lastUpdateDate");
protected $booleans = array("overideautosuspend");
protected $appends = array("serviceProperties");
protected $hidden = array("password");
const STATUS_PENDING = \WHMCS\Utility\Status::PENDING;
const STATUS_ACTIVE = \WHMCS\Utility\Status::ACTIVE;
const STATUS_SUSPENDED = \WHMCS\Utility\Status::SUSPENDED;
public function scopeUserId($query, $userId)
{
}
public function scopeActive($query)
{
}
public function scopeMarketConnect($query)
{
}
public function scopeIsConsideredActive(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeIsNotRecurring(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function isRecurring()
{
}
public function client()
{
}
public function product()
{
}
public function paymentGateway()
{
}
public function addons()
{
}
public function order()
{
}
public function promotion()
{
}
public function cancellationRequests()
{
}
public function ssl()
{
}
public function hasAvailableUpgrades()
{
}
public function failedActions()
{
}
public function customFieldValues()
{
}
protected function getCustomFieldType()
{
}
protected function getCustomFieldRelId()
{
}
public function getServicePropertiesAttribute()
{
}
public function canBeUpgraded()
{
}
public function isService()
{
}
public function isAddon()
{
}
public function serverModel()
{
}
public function legacyProvision()
{
}
public function getMetricProvider()
{
}
public function metrics($onlyBilledMetrics = false, $mode = NULL)
{
}
public function getLink()
{
}
public function getUniqueIdentifierValue($uniqueIdField)
{
}
}
}
namespace WHMCS\Service\Automation {
class AddonAutomation
{
protected $action = "";
protected $addon = NULL;
protected $aliasActions = array("CancelAccount" => "TerminateAccount", "Fraud" => "TerminateAccount");
protected $error = "";
protected $supportedActions = array("CreateAccount" => "AddonActivation", "SuspendAccount" => "AddonSuspended", "UnsuspendAccount" => "AddonUnsuspended", "TerminateAccount" => "AddonTerminated", "CancelAccount" => "AddonCancelled", "Fraud" => "AddonFraud", "Renew" => "", "ChangePassword" => "", "LoginLink" => "", "ChangePackage" => "", "CustomFunction" => "", "ClientArea" => "");
public static function factory($addon)
{
}
protected function setAction($action)
{
}
public function getAction()
{
}
public function getError()
{
}
protected function addError($error)
{
}
public function runAction($action, $extra = "")
{
}
protected function runHook()
{
}
}
}
namespace WHMCS\Service {
class Addon extends \WHMCS\Model\AbstractModel
{
protected $table = "tblhostingaddons";
protected $columnMap = array("orderId" => "orderid", "serviceId" => "hostingid", "clientId" => "userid", "recurringFee" => "recurring", "registrationDate" => "regdate", "applyTax" => "tax", "terminationDate" => "termination_date", "paymentGateway" => "paymentmethod", "serverId" => "server", "productId" => "addonid", "subscriptionId" => "subscriptionid");
protected $dates = array("regDate", "registrationDate", "nextdueDate", "nextinvoiceDate", "terminationDate");
protected $appends = array("serviceProperties");
public static function boot()
{
}
public function scopeUserId(\Illuminate\Database\Eloquent\Builder $query, $userId)
{
}
public function scopeOfService(\Illuminate\Database\Eloquent\Builder $query, $serviceId)
{
}
public function scopeActive(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeMarketConnect(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeIsConsideredActive(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeIsNotRecurring($query)
{
}
public function service()
{
}
public function productAddon()
{
}
public function client()
{
}
public function customFieldValues()
{
}
protected function getCustomFieldType()
{
}
protected function getCustomFieldRelId()
{
}
public function order()
{
}
public function paymentGateway()
{
}
public function getServicePropertiesAttribute()
{
}
public function ssl()
{
}
public function canBeUpgraded()
{
}
public function isService()
{
}
public function isAddon()
{
}
public function serverModel()
{
}
public function failedActions()
{
}
public function legacyProvision()
{
}
public function isRecurring()
{
}
public function getLink()
{
}
}
}
namespace WHMCS {
class WHOIS
{
protected $definitions = array();
protected $definitionsPath = NULL;
protected $socketPrefix = "socket://";
public function __construct($definitionsPath = "")
{
}
protected function load()
{
}
protected function parseFile($path)
{
}
public function init()
{
}
public function getSocketPrefix()
{
}
public function canLookup($tld)
{
}
public function getFromDefinitions($tld, $key)
{
}
protected function getUri($tld)
{
}
protected function isSocketLookup($tld)
{
}
protected function getAvailableMatchString($tld)
{
}
protected function httpWhoisLookup($domain, $uri)
{
}
protected function socketWhoisLookup($domain, $server, $port, $tld)
{
}
public function lookup($parts)
{
}
}
}
namespace WHMCS\Updater\Version {
class IncrementalVersion
{
protected $updateActions = array();
protected $version = NULL;
protected $runUpdateCodeBeforeDatabase = false;
public static $versionIncrements = array("3.2.0", "3.2.1", "3.2.2", "3.2.3", "3.3.0", "3.4.0", "3.4.1", "3.5.0", "3.5.1", "3.6.0", "3.6.1", "3.6.2", "3.7.0", "3.7.1", "3.7.2", "3.8.0", "3.8.1", "3.8.2", "4.0.0", "4.0.1", "4.1.0", "4.1.1", "4.1.2", "4.2.0", "4.2.1", "4.3.0", "4.3.1", "4.4.0", "4.4.1", "4.4.2", "4.5.0", "4.5.1", "4.5.2", "5.0.0", "5.0.1", "5.0.2", "5.0.3", "5.1.0", "5.1.1", "5.1.2", "5.2.0", "5.2.1", "5.2.2", "5.2.3", "5.2.4", "5.2.5", "5.3.0", "5.3.1", "5.3.2", "5.3.3-rc.1", "5.3.3-rc.2", "5.3.3-release.1", "5.3.4-release.1", "5.3.5-release.1", "5.3.6-release.1", "5.3.7-release.1", "5.3.8-release.1", "5.3.9-release.1", "5.3.12-release.1", "6.0.0-alpha.1", "6.0.0-beta.1", "6.0.0-beta.2", "6.0.0-beta.3", "6.0.0-beta.4", "6.0.0-beta.5", "6.0.0-rc.1", "6.0.0-rc.2", "6.0.0-rc.3", "6.0.0-release.1", "6.0.1-release.1", "6.0.2-release.1", "6.1.0-alpha.1", "6.1.0-rc.1", "6.1.0-release.1", "6.1.1-release.1", "6.2.0-alpha.1", "6.2.0-rc.1", "6.2.0-release.1", "6.2.1-release.1", "6.2.2-release.1", "6.3.0-alpha.1", "6.3.0-rc.1", "6.3.0-release.1", "6.3.1-release.1", "7.0.0-alpha.1", "7.0.0-alpha.5", "7.0.0-beta.1", "7.0.0-beta.2", "7.0.0-rc.1", "7.0.0-release.1", "7.0.1-release.1", "7.1.0-alpha.1", "7.1.0-beta.1", "7.1.0-rc.1", "7.1.0-release.1", "7.1.1-release.1", "7.1.2-release.1", "7.2.0-alpha.1", "7.2.0-beta.1", "7.2.0-beta.2", "7.2.0-beta.3", "7.2.0-rc.1", "7.2.0-release.1", "7.2.1-release.1", "7.2.2-release.1", "7.2.3-release.1", "7.3.0-alpha.1", "7.3.0-beta.1", "7.3.0-rc.1", "7.3.0-release.1", "7.4.0-alpha.1", "7.4.0-beta.1", "7.4.0-rc.1", "7.4.0-release.1", "7.4.1-release.1", "7.4.2-release.1", "7.5.0-alpha.1", "7.5.0-beta.1", "7.5.0-rc.1", "7.5.0-release.1", "7.5.1-release.1", "7.5.1-release.2", "7.5.2-release.1", "7.5.3-release.1", "7.6.0-alpha.1", "7.6.0-beta.1", "7.6.0-rc.1", "7.6.0-release.1", "7.6.1-release.1", "7.6.2-release.1", "7.7.0-alpha.1", "7.7.0-beta.1", "7.7.0-rc.1", "7.7.0-release.1", "7.7.1-release.1", "7.8.0-alpha.1", "7.8.0-beta.1", "7.8.0-beta.2", "7.8.0-rc.1", "7.8.0-release.1", "7.8.1-release.1", "7.8.2-release.1", "7.8.3-release.1", "7.9.0-alpha.1", "7.9.0-beta.1", "7.9.0-rc.1", "7.9.0-release.1", "7.9.1-release.1", "7.9.2-release.1", "7.10.0-alpha.1", "7.10.0-beta.1", "7.10.0-rc.1", "7.10.0-rc.2", "7.10.0-release.1", "7.10.1-release.1", "7.10.2-release.1");
protected $filesToRemove = array();
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
public function getVersion()
{
}
protected function setVersion(\WHMCS\Version\SemanticVersion $version)
{
}
public static function factory($version)
{
}
protected function generateDatabaseFileName()
{
}
protected function importDatabaseChanges()
{
}
protected function runUpdateCode()
{
}
protected static function useCanonicalVersion(\WHMCS\Version\SemanticVersion $version)
{
}
protected function applyDatabaseVersion()
{
}
protected function removeFiles()
{
}
public function applyUpdate()
{
}
public function getFeatureHighlights()
{
}
}
class Version520 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
}
class Version740alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeVarilogixModuleIfNotInUse", "addApiRoleIfCredentialsExist");
protected function removeVarilogixModuleIfNotInUse()
{
}
public function getFeatureHighlights()
{
}
protected function addApiRoleIfCredentialsExist()
{
}
}
class Version740release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("updateNotificationEmailTemplate");
protected function updateNotificationEmailTemplate()
{
}
}
class Version790alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("createNewSitelockVPNEmailTemplate", "updateBracketTable", "enableUsageBilling", "addUsageCollectionCronTask");
protected function createNewSitelockVPNEmailTemplate()
{
}
protected function updateBracketTable()
{
}
protected function enableUsageBilling()
{
}
protected function addUsageCollectionCronTask()
{
}
}
class Version362 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
}
class Version7100alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeUnusedLegacyModules", "createKbImageTable", "createKbFileAssetSetting", "createSuggestedTldsSetting", "convertEmailMarketerData", "addWeeblyFreeProductAndAddon", "updateWeeblySettingsWithIncludeFree", "addMarketgooWelcomeEmail", "updateCreditCardExpiringSoon");
protected function createKbImageTable()
{
}
protected function createKbFileAssetSetting()
{
}
public function createSuggestedTldsSetting()
{
}
public function updateCreditCardExpiringSoon()
{
}
protected function convertEmailMarketerData()
{
}
protected function addWeeblyFreeProductAndAddon()
{
}
protected function updateWeeblySettingsWithIncludeFree()
{
}
protected function addMarketgooWelcomeEmail()
{
}
public function getUnusedLegacyModules()
{
}
public function removeUnusedLegacyModules()
{
}
public function getFeatureHighlights()
{
}
}
class Version5313release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $runUpdateCodeBeforeDatabase = true;
protected function runUpdateCode()
{
}
}
class Version770alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("addPrimaryKeysToTables", "migrateEUVatAddon", "createInvoiceDataTable", "correctSpamExpertsEmailTemplate", "migrateStorageConfigurations", "updateRecaptchaOptions", "createSslStatusTable", "createTransactionHistoryTable");
protected function addPrimaryKeysToTables()
{
}
protected function migrateEUVatAddon()
{
}
protected function createInvoiceDataTable()
{
}
protected function correctSpamExpertsEmailTemplate()
{
}
public function getApplicationConfig()
{
}
public function migrateStorageConfigurations()
{
}
protected function updateRecaptchaOptions()
{
}
protected function createSslStatusTable()
{
}
protected function createTransactionHistoryTable()
{
}
}
class Version780alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("insertGatewayModuleHooks", "pruneOrphanedSslOrders", "registerRemoveTicketAttachmentsCronTask", "updateLinkInSpamExpertsWelcomeEmail", "removeGooglePlus1", "removeUnusedLegacyModules", "updateCreditCardInvoiceCreatedEmailTemplate");
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
public function pruneOrphanedSslOrders()
{
}
public function registerRemoveTicketAttachmentsCronTask()
{
}
public function updateLinkInSpamExpertsWelcomeEmail()
{
}
public function removeGooglePlus1()
{
}
public function insertGatewayModuleHooks()
{
}
public function getUnusedLegacyModules()
{
}
public function removeUnusedLegacyModules()
{
}
public function getFeatureHighlights()
{
}
public function updateCreditCardInvoiceCreatedEmailTemplate()
{
}
}
class Version770beta1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("updateSpamExpertsWelcomeEmail", "createCodeGuardWelcomeEmail");
protected function updateSpamExpertsWelcomeEmail()
{
}
protected function createCodeGuardWelcomeEmail()
{
}
public function getFeatureHighlights()
{
}
}
class Version700beta2 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("migrateSystemSslUrl", "decodeEmailTemplates");
public function migrateSystemSslUrl()
{
}
public function decodeEmailTemplates()
{
}
}
class Version723release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array();
}
class Version770release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("registerSslStatusSyncCronTask");
public function registerSslStatusSyncCronTask()
{
}
}
class Version532 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
}
class Version760release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeUnusedLegacyModules", "storeCaptchaForms");
protected function removeUnusedLegacyModules()
{
}
protected function storeCaptchaForms()
{
}
}
class Version620alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("createUuidColumnsIfNecessary", "createUuids");
public function createUuidColumnsIfNecessary()
{
}
public function createUuids()
{
}
}
class Version330 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
}
class Version760alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeUnusedLegacyModules", "conditionallyUpdate2CheckoutVariables", "addServiceRenewalFailedAdminEmailTemplate", "addDomainTransferCompletedEmailTemplate", "conditionallyCreateMaxMindPaymentTable", "conditionallyActivateNewWeeblyPlans", "updateWhmcsWhoisToWhmcsDomains", "conditionallyUpdateMaxMindTableValues");
protected function removeUnusedLegacyModules()
{
}
protected function addServiceRenewalFailedAdminEmailTemplate()
{
}
protected function addDomainTransferCompletedEmailTemplate()
{
}
protected function conditionallyUpdate2CheckoutVariables()
{
}
protected function conditionallyCreateMaxMindPaymentTable()
{
}
protected function conditionallyActivateNewWeeblyPlans()
{
}
protected function updateWhmcsWhoisToWhmcsDomains()
{
}
protected function conditionallyUpdateMaxMindTableValues()
{
}
}
class Version730release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeArchivingOnlyMarketConnectProduct", "removeArchivingOnlyMarketConnectAddon");
protected function removeArchivingOnlyMarketConnectProduct()
{
}
protected function removeArchivingOnlyMarketConnectAddon()
{
}
}
class Version710alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("addAdminPasswordResetVerificationEmailTemplate", "addAdminPasswordResetConfirmationEmailTemplate");
public function addAdminPasswordResetVerificationEmailTemplate()
{
}
public function addAdminPasswordResetConfirmationEmailTemplate()
{
}
}
class Version750release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("addInvoiceModifiedEmail");
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
protected function addInvoiceModifiedEmail()
{
}
}
class Version360 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
}
class Version600alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeDuplicateSettings", "convertMailTemplateBooleanColumns", "convertClientUnixTimestampColumns", "convertClientBooleanColumns", "convertDomainBooleanColumns", "convertProductBooleanColumns", "convertProductGroupBooleanColumns", "convertDownloadBooleanColumns", "convertDownloadCategoryBooleanColumns", "migrateProductDownloadIdsToItsTable", "migrateProductUpgradeIdsToItsTable", "convertServiceBooleanColumns", "convertAnnouncementBooleanColumns", "updateAdminUserForAutoReleaseModule", "createServiceUnsuspendedEmailTemplate", "addManualUpgradeRequiredEmailTemplate", "convertNoMD5Passwords", "migrateDiscontinuedOrderFormTemplates", "migrateDiscontinuedAdminOriginalTemplate", "convertContactUnixTimestampColumns");
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
protected function removeDuplicateSettings()
{
}
protected function convertMailTemplateBooleanColumns()
{
}
protected function convertClientUnixTimestampColumns()
{
}
protected function convertClientBooleanColumns()
{
}
protected function convertDomainBooleanColumns()
{
}
protected function convertProductBooleanColumns()
{
}
protected function convertProductGroupBooleanColumns()
{
}
protected function convertDownloadBooleanColumns()
{
}
protected function convertDownloadCategoryBooleanColumns()
{
}
protected function migrateProductDownloadIdsToItsTable()
{
}
protected function migrateProductUpgradeIdsToItsTable()
{
}
protected function convertServiceBooleanColumns()
{
}
protected function convertAnnouncementBooleanColumns()
{
}
protected function updateAdminUserForAutoReleaseModule()
{
}
protected function createServiceUnsuspendedEmailTemplate()
{
}
protected function addManualUpgradeRequiredEmailTemplate()
{
}
protected function convertNoMD5Passwords()
{
}
protected function migrateDiscontinuedOrderFormTemplates()
{
}
protected function migrateDiscontinuedAdminOriginalTemplate()
{
}
protected function convertContactUnixTimestampColumns()
{
}
}
class Version370 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
protected function decryptOldPassword($string)
{
}
}
class Version601release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("migrateFixedInvoiceDataAddon");
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
protected function migrateFixedInvoiceDataAddon()
{
}
}
class Version700beta1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeLegacyClassLocations");
public function removeLegacyClassLocations()
{
}
}
class Version750alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("replaceTicketTidInEmailNotificationsSubject", "registerDataRetentionPruningCronTask", "addMentionNotificationAdminEmailTemplate", "convertDomainPricingBooleanColumns", "convertConfigurationFileDomainRenewalGracePeriodsToDatabase", "updateUpcomingDomainRenewalNotice", "createSiteLockWelcomeEmailTemplate", "removeThreeYearMarketConnectSslTerms", "removeUnusedLegacyModules");
protected function replaceTicketTidInEmailNotificationsSubject()
{
}
protected function registerDataRetentionPruningCronTask()
{
}
protected function addMentionNotificationAdminEmailTemplate()
{
}
protected function removeUnusedLegacyModules()
{
}
protected function convertDomainPricingBooleanColumns()
{
}
protected function convertConfigurationFileDomainRenewalGracePeriodsToDatabase()
{
}
protected function updateUpcomingDomainRenewalNotice()
{
}
public function createSiteLockWelcomeEmailTemplate()
{
}
protected function removeThreeYearMarketConnectSslTerms()
{
}
}
class Version750rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("checkForSpacesInAdminUsername", "renameMergeFieldsInUpcomingDomainRenewalNoticeEmailTemplate");
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
protected function checkForSpacesInAdminUsername()
{
}
protected function renameMergeFieldsInUpcomingDomainRenewalNoticeEmailTemplate()
{
}
public function getFeatureHighlights()
{
}
}
class Version771release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("addIndexToSslSyncTable");
public function addIndexToSslSyncTable()
{
}
}
class Version630rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("insertUpgradeTimeForMDE");
public function insertUpgradeTimeForMDE()
{
}
}
class Version760Beta1 extends \WHMCS\Updater\Version\IncrementalVersion
{
public function getFeatureHighlights()
{
}
}
class Version712release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("updateEmailTemplatesToCorrectPropagatedSpelling");
protected function updateEmailTemplatesToCorrectPropagatedSpelling()
{
}
}
class Version770rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeUnusedLegacyModules");
protected function removeUnusedLegacyModules()
{
}
}
class Version700rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("setDefaultUpdateDetails", "setDefaultDailyCronInvocationHour");
public function setDefaultUpdateDetails()
{
}
public function setDefaultDailyCronInvocationHour()
{
}
}
class Version600beta2 extends \WHMCS\Updater\Version\IncrementalVersion
{
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
}
class Version7101release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("addWeeblyFreeProductId", "fixWeeblyFreeAddonMissingModuleConfig", "fixWeeblySettingIncludeFreeLocation", "fixWeeblyProductSortOrder", "fixWeeblyFreeStockControl");
protected function addWeeblyFreeProductId()
{
}
protected function fixWeeblyFreeAddonMissingModuleConfig()
{
}
protected function fixWeeblySettingIncludeFreeLocation()
{
}
protected function fixWeeblyProductSortOrder()
{
}
protected function fixWeeblyFreeStockControl()
{
}
}
class Version5312release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $runUpdateCodeBeforeDatabase = true;
protected function runUpdateCode()
{
}
}
class Version700alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
}
class Version700release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("mutateDailyCronConfigurations");
public function mutateDailyCronConfigurations()
{
}
}
class Version790beta1 extends \WHMCS\Updater\Version\IncrementalVersion
{
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
public function getFeatureHighlights()
{
}
}
class Version740rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeHtAccessTxt", "createDefaultNotificationEmailTemplate", "removeOldApplicationLink");
protected function removeHtAccessTxt()
{
}
protected function createDefaultNotificationEmailTemplate()
{
}
protected function removeOldApplicationLink()
{
}
}
class Version761release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("correctWhmcsWhoisToWhmcsDomains");
protected function correctWhmcsWhoisToWhmcsDomains()
{
}
}
class Version701release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeAdminForceSSLSetting");
public function removeAdminForceSSLSetting()
{
}
}
class Version780rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("registerServerUsageCountCronTask", "registerServerRemoteMetaDataCronTask", "correctDomainExpirySyncFrequencyNaming", "updateDomainExpirySyncCronTaskNaming", "registerCronTasks", "updateWeeblyWelcomeEmailContent");
protected function registerServerUsageCountCronTask()
{
}
protected function registerServerRemoteMetaDataCronTask()
{
}
protected function correctDomainExpirySyncFrequencyNaming()
{
}
protected function updateDomainExpirySyncCronTaskNaming()
{
}
protected function registerCronTasks()
{
}
protected function updateWeeblyWelcomeEmailContent()
{
}
}
class Version400 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
protected function v4GenerateClientPW($plain, $salt = "")
{
}
}
class Version7100release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("updateEmailImagesAssetSetting", "updateMarketGooWelcomeEmail");
protected function updateEmailImagesAssetSetting()
{
}
protected function updateMarketGooWelcomeEmail()
{
}
}
class Version511 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
}
class Version720rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("addSystemURLIfNotDefined");
protected function addSystemURLIfNotDefined()
{
}
}
class Version710beta1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("updateCronTasksNextDue", "migrateLookupProviderSettings", "removeLegacyAdminWidgets");
protected function updateCronTasksNextDue()
{
}
protected function migrateLookupProviderSettings()
{
}
protected function removeLegacyAdminWidgets()
{
}
}
class Version720alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("convertAddonsBooleanColumns", "populateClientIdInHostingAddons", "relabelQuoteAcceptedNotificationEmailTemplate", "updateWhmcsUrlInClientSignUpEmailToBeALink", "updateWhmcsUrlInDomainRegistrationConfirmationEmailToBeALink", "updateWhmcsUrlInDedicatedVPSWelcomeEmailToBeALink", "updateWhmcsUrlInDomainTransferInitiatedEmailToBeALink", "updateWhmcsUrlInDomainRenewalConfirmationEmailToBeALink", "updateWhmcsUrlInCreditCardExpiringSoonEmailToBeALink", "addViewFeatureHighlightsPermission", "addManageMarketPlacePermission", "addConfigureTicketEscalationsPermissionsToConfigureSupportDepartments", "createDirectDebitPaymentFailedEmailTemplate", "createDirectDebitPaymentConfirmationEmailTemplate", "createDirectDebitPaymentPendingEmailTemplate", "createCreditCardPaymentPendingEmailTemplate", "createPaymentReversedNotificationEmailTemplate", "createSpamExpertsWelcomeEmailTemplate", "createWeeblyWelcomeEmailTemplate", "conditionallyCreateHtaccessFile", "detectAndSetUriPathMode", "createSslConfigurationRequiredEmailTemplate");
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
protected function convertAddonsBooleanColumns()
{
}
protected function populateClientIdInHostingAddons()
{
}
protected function createSpamExpertsWelcomeEmailTemplate()
{
}
protected function relabelQuoteAcceptedNotificationEmailTemplate()
{
}
protected function updateWhmcsUrlInClientSignUpEmailToBeALink()
{
}
protected function updateWhmcsUrlInDomainRegistrationConfirmationEmailToBeALink()
{
}
protected function updateWhmcsUrlInDedicatedVPSWelcomeEmailToBeALink()
{
}
protected function updateWhmcsUrlInDomainTransferInitiatedEmailToBeALink()
{
}
protected function updateWhmcsUrlInDomainRenewalConfirmationEmailToBeALink()
{
}
protected function updateWhmcsUrlInCreditCardExpiringSoonEmailToBeALink()
{
}
protected function addViewFeatureHighlightsPermission()
{
}
protected function addManageMarketPlacePermission()
{
}
public function getFeatureHighlights()
{
}
protected function createWeeblyWelcomeEmailTemplate()
{
}
protected function addConfigureTicketEscalationsPermissionsToConfigureSupportDepartments()
{
}
public function conditionallyCreateHtaccessFile()
{
}
public function detectAndSetUriPathMode()
{
}
protected function createDirectDebitPaymentFailedEmailTemplate()
{
}
protected function createDirectDebitPaymentConfirmationEmailTemplate()
{
}
protected function createDirectDebitPaymentPendingEmailTemplate()
{
}
protected function createCreditCardPaymentPendingEmailTemplate()
{
}
protected function createPaymentReversedNotificationEmailTemplate()
{
}
protected function createSslConfigurationRequiredEmailTemplate()
{
}
}
class Version410 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
}
class Version361 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
}
class Version720beta2 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("addPaymentReversalChangeSettings");
protected function addPaymentReversalChangeSettings()
{
}
}
class Version600beta4 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("updateExpiredDomainNoticeTemplate", "adjustAffiliatePayoutDefault");
protected function updateExpiredDomainNoticeTemplate()
{
}
protected function adjustAffiliatePayoutDefault()
{
}
}
class Version790release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("pruneOrphanedSslOrders");
public function pruneOrphanedSslOrders()
{
}
}
class Version380 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
}
class Version7100beta1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("updateProductIdsInMarketConnectServices", "renameSymantecProductsAndDisable2YearCycles", "renameSymantecAddonsAndDisable2YearCycles", "updateSellingPriceOfDigiCertCertificates");
protected function updateProductIdsInMarketConnectServices()
{
}
protected function renameSymantecProductsAndDisable2YearCycles()
{
}
protected function renameSymantecAddonsAndDisable2YearCycles()
{
}
protected function updateSellingPriceOfDigiCertCertificates()
{
}
}
class Version510 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected function runUpdateCode()
{
}
}
class Version742release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("removeComposerInstallUpdateHooks");
protected function removeComposerInstallUpdateHooks()
{
}
}
class Version730alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("createAuthnTables", "addConfigureSignInIntegrationPermission", "rewordUnchangedClientSignUpEmail", "createPendingUpgradeOrderCancelledEmailTemplate", "convertOldBackupSettings", "registerJobsQueueTask", "rewordUnchangedClientSignUpEmail", "addMissingOauthScopes", "cloneOauthScopeShoppingCartAddonsPivots", "syncApplicationLinksOnUpgrade");
protected function createAuthnTables()
{
}
protected function addConfigureSignInIntegrationPermission()
{
}
protected function rewordUnchangedClientSignUpEmail()
{
}
protected function convertOldBackupSettings()
{
}
protected function createPendingUpgradeOrderCancelledEmailTemplate()
{
}
protected function registerJobsQueueTask()
{
}
protected function syncApplicationLinksOnUpgrade()
{
}
protected function addMissingOauthScopes()
{
}
protected function cloneOauthScopeShoppingCartAddonsPivots()
{
}
public function getFeatureHighlights()
{
}
}
class Version760rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
}
class Version720release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("renameClientIdToUseridInTblHostingAddons");
protected function renameClientIdToUseridInTblHostingAddons()
{
}
}
class Version600rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
}
class Version630release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("newEmailHeader", "newEmailCss", "newEmailFooter", "updateCreateTicketNotificationEmail", "removeOldAdminSupportEmailTemplates");
public function newEmailHeader()
{
}
public function newEmailFooter()
{
}
public function newEmailCSS()
{
}
public function updateCreateTicketNotificationEmail()
{
}
public function removeOldAdminSupportEmailTemplates()
{
}
}
class Version720beta3 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("addMissingDotToSubDomainProductOptions", "addAddonIdFieldToModLicensingIfLicensingAddonEnabled", "addAutoLinkCriteriaToMarketConnectAddons");
protected function addMissingDotToSubDomainProductOptions()
{
}
protected function addAddonIdFieldToModLicensingIfLicensingAddonEnabled()
{
}
protected function addAutoLinkCriteriaToMarketConnectAddons()
{
}
}
class Version790rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("ensureOfflineCCTypeIsReplaced", "updateCreditCardPaymentConfirmation");
protected function ensureOfflineCCTypeIsReplaced()
{
}
protected function updateCreditCardPaymentConfirmation()
{
}
}
class Version7102release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("checkForInvalidFileStorageLocation", "ensure2CheckOutDisabled");
protected function checkForInvalidFileStorageLocation()
{
}
protected function ensure2CheckOutDisabled()
{
}
}
class Version700alpha5 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("updateEnomDomainLookupProviderSetting", "removeToggleInfoPopup", "disableSetupWizardForUpgrades");
public function updateEnomDomainLookupProviderSetting()
{
}
public function removeToggleInfoPopup()
{
}
public function disableSetupWizardForUpgrades()
{
}
}
class Version610alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("migrateMaxMindIgnoreCity", "moveAttachmentsProjectsFiles", "detectCronRunForHealthAndUpdates");
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
protected function migrateMaxMindIgnoreCity()
{
}
protected function moveAttachmentsProjectsFiles()
{
}
protected function detectCronRunForHealthAndUpdates()
{
}
}
class Version7100rc1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("setWeeblyFreeDescription", "addSsoCustomRedirectScope", "enableAutoAuthIfKeyed", "createEmailImageTable", "createEmailFileAssetSetting", "removeTldPivotTables");
public function __construct(\WHMCS\Version\SemanticVersion $version)
{
}
protected function setWeeblyFreeDescription()
{
}
public function enableAutoAuthIfKeyed()
{
}
protected function addSsoCustomRedirectScope()
{
}
protected function createEmailImageTable()
{
}
protected function createEmailFileAssetSetting()
{
}
public function removeTldPivotTables()
{
}
}
class Version783release1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("convertCentovaCastHostnames");
protected function convertCentovaCastHostnames()
{
}
}
class Version630alpha1 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $updateActions = array("migrateOpenIDValues", "createTicketNotificationEmail");
public function migrateOpenIDValues()
{
}
public function createTicketNotificationEmail()
{
}
}
class Version350 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $runUpdateCodeBeforeDatabase = true;
protected function runUpdateCode()
{
}
}
class Version533 extends \WHMCS\Updater\Version\IncrementalVersion
{
protected $runUpdateCodeBeforeDatabase = true;
protected function runUpdateCode()
{
}
}
}
namespace WHMCS\Contracts {
interface ServiceProvisionInterface
{
public function provision($model, array $params);
public function configure($model, array $params);
public function cancel($model, array $params);
public function renew($model, array $response);
public function install($model);
}
interface CollectionInterface
{
public function all();
public function avg($key);
public function average($key);
public function collapse();
public function contains($key, $value);
public function diff($items);
public function diffKeys($items);
public function each(callable $callback);
public function every($step, $offset);
public function except($keys);
public function filter(callable $callback);
public function where($key, $value, $strict);
public function whereLoose($key, $value);
public function whereIn($key, array $values, $strict);
public function whereInLoose($key, array $values);
public function first(callable $callback, $default);
public function flatten($depth);
public function flip();
public function forget($keys);
public function get($key, $default);
public function groupBy($groupBy, $preserveKeys);
public function keyBy($keyBy);
public function has($key);
public function implode($value, $glue);
public function intersect($items);
public function isEmpty();
public function keys();
public function last(callable $callback, $default);
public function pluck($value, $key);
public function lists($value, $key);
public function map(callable $callback);
public function flatMap(callable $callback);
public function max($key);
public function merge($items);
public function combine($values);
public function union($items);
public function min($key);
public function only($keys);
public function forPage($page, $perPage);
public function pop();
public function prepend($value, $key);
public function push($value);
public function pull($key, $default);
public function put($key, $value);
public function random($amount);
public function reduce(callable $callback, $initial);
public function reject($callback);
public function reverse();
public function search($value, $strict);
public function shift();
public function shuffle();
public function slice($offset, $length);
public function chunk($size);
public function sort(callable $callback);
public function sortBy($callback, $options, $descending);
public function sortByDesc($callback, $options);
public function splice($offset, $length, $replacement);
public function sum($callback);
public function take($limit);
public function transform(callable $callback);
public function unique($key);
public function values();
public function zip($items);
public function toArray();
public function jsonSerialize();
public function toJson($options);
public function getIterator();
public function getCachingIterator($flags);
public function count();
public function offsetExists($key);
public function offsetGet($key);
public function offsetSet($key, $value);
public function offsetUnset($key);
public function __toString();
}
interface ProductServiceTypes
{
const TYPE_SERVICE_PRODUCT_ADDON = "ServiceProductAddon";
const TYPE_SERVICE_PRODUCT = "ServiceProduct";
const TYPE_SERVICE_CONFIGOPTION = "ServiceConfigOption";
const TYPE_SERVICE_METRICUSAGE = "ServiceMetricUsage";
const TYPE_PRODUCT_PRODUCT_ADDON = "ProductAddon";
const TYPE_PRODUCT_PRODUCT = "Product";
const TYPE_PRODUCT_CONFIGOPTION = "ProductConfigOption";
const TYPE_USAGE_ITEM = "UsageItem";
}
}
namespace WHMCS\ApplicationLink {
class Client extends \WHMCS\Model\AbstractModel
{
protected $table = "tbloauthserver_clients";
protected $scopePivotTable = "tbloauthserver_client_scopes";
protected $scopePivotId = "client_id";
protected $characterSeparated = array(" " => array("grantTypes", "redirectUri"));
public function createTable($drop = false)
{
}
public static function boot()
{
}
public function scopes()
{
}
public function getFormattedScopes()
{
}
public function getScopeAttribute()
{
}
public function setSecretAttribute($value)
{
}
public function getDecryptedSecretAttribute()
{
}
public function user()
{
}
public function service()
{
}
public function rsaKeyPair()
{
}
public function toArray()
{
}
public static function generateClientId($prefix = NULL)
{
}
public static function generateSecret()
{
}
}
class AccessToken extends \WHMCS\Model\AbstractModel
{
protected $table = "tbloauthserver_access_tokens";
protected $primaryKey = "id";
protected $scopePivotTable = "tbloauthserver_access_token_scopes";
protected $scopePivotId = "access_token_id";
protected $commaSeparated = array("grantTypes");
protected $dates = array("expires");
public function createTable($drop = false)
{
}
public function scopes()
{
}
protected function getFormattedScopes()
{
}
public function getScopeAttribute()
{
}
public function getUserAttribute()
{
}
public function client()
{
}
public function toArray()
{
}
public static function deleteExpired(\WHMCS\Carbon $datetime = NULL)
{
}
}
class Scope extends \WHMCS\Model\AbstractModel
{
protected $table = "tbloauthserver_scopes";
protected $scopePivotTable = "tbloauthserver_client_scopes";
protected $standardScopes = array(array("scope" => "clientarea:sso", "description" => "Single Sign-on for Client Area", "isDefault" => 1), array("scope" => "clientarea:profile", "description" => "Account Profile", "isDefault" => 0), array("scope" => "clientarea:billing_info", "description" => "Manage Billing Information", "isDefault" => 0), array("scope" => "clientarea:emails", "description" => "Email History", "isDefault" => 0), array("scope" => "clientarea:announcements", "description" => "Announcements", "isDefault" => 0), array("scope" => "clientarea:downloads", "description" => "Downloads", "isDefault" => 0), array("scope" => "clientarea:knowledgebase", "description" => "Knowledgebase", "isDefault" => 0), array("scope" => "clientarea:network_status", "description" => "Network Status", "isDefault" => 0), array("scope" => "clientarea:services", "description" => "Products/Services", "isDefault" => 0), array("scope" => "clientarea:product_details", "description" => "Product Info/Details (requires associated serviceId)", "isDefault" => 0), array("scope" => "clientarea:domains", "description" => "Domains", "isDefault" => 0), array("scope" => "clientarea:domain_details", "description" => "Domain Info/Details (requires associated domainId)", "isDefault" => 0), array("scope" => "clientarea:invoices", "description" => "Invoices", "isDefault" => 0), array("scope" => "clientarea:tickets", "description" => "Support Tickets", "isDefault" => 0), array("scope" => "clientarea:submit_ticket", "description" => "Submit New Ticket", "isDefault" => 0), array("scope" => "clientarea:shopping_cart", "description" => "Shopping Cart Default Product Group", "isDefault" => 0), array("scope" => "clientarea:upgrade", "description" => "Upgrade/Downgrade", "isDefault" => 0), array("scope" => "clientarea:shopping_cart_domain_register", "description" => "Shopping Cart Register New Domain", "isDefault" => 0), array("scope" => "clientarea:shopping_cart_domain_transfer", "description" => "Shopping Cart Transfer Existing Domain", "isDefault" => 0), array("scope" => "openid", "description" => "Scope required for OpenID Connect ID tokens", "isDefault" => 0), array("scope" => "email", "description" => "Scope used for Email Claim", "isDefault" => 0), array("scope" => "profile", "description" => "Scope used for Profile Claim", "isDefault" => 0), array("scope" => "sso:custom_redirect", "description" => "Scope required for arbitrary path redirect on token creation", "isDefault" => 0));
public function createTable($drop = false)
{
}
public function getStandardScopes()
{
}
}
}
namespace WHMCS\ApplicationLink\GrantType {
class SingleSignOn extends \OAuth2\GrantType\ClientCredentials
{
public function getQuerystringIdentifier()
{
}
}
}
namespace WHMCS\ApplicationLink\Storage {
class Whmcs implements \OAuth2\Storage\AccessTokenInterface, \OAuth2\Storage\AuthorizationCodeInterface, \OAuth2\Storage\ClientCredentialsInterface, \OAuth2\OpenID\Storage\AuthorizationCodeInterface, \OAuth2\Storage\PublicKeyInterface, \OAuth2\Storage\ScopeInterface, \OAuth2\OpenID\Storage\UserClaimsInterface
{
public function checkClientCredentials($client_id, $client_secret = NULL)
{
}
public function isPublicClient($client_id)
{
}
public function getClientDetails($client_id)
{
}
public function setClientDetails($client_id, $client_secret, $redirect_uri = "", $grant_types = "", $scope = "", $user_id = "", $service_id = 0, $keypair_id = 0, $name = "", $description = "", $logoUri = "")
{
}
public function checkRestrictedGrantType($client_id, $grant_type)
{
}
public function getAccessToken($access_token)
{
}
public function setAccessToken($access_token, $client_id, $user_id, $expires, $scope = NULL)
{
}
public function scopeExists($scope)
{
}
public function getDefaultScope($client_id = NULL)
{
}
public function getClientScope($client_id)
{
}
public function getAuthorizationCode($code)
{
}
public function setAuthorizationCode($code, $client_id, $user_id, $redirect_uri, $expires, $scope = NULL, $id_token = NULL)
{
}
public function expireAuthorizationCode($code)
{
}
public function setUserAuthorizedScopes($clientId, $user, \Illuminate\Database\Eloquent\Collection $scopes)
{
}
public function getUserAuthorizedScopes($clientId, $user)
{
}
public function getPublicKey($client_id = NULL)
{
}
public function getPrivateKey($client_id = NULL)
{
}
public function getKeyDetails($client_id = NULL)
{
}
public function getEncryptionAlgorithm($client_id = NULL)
{
}
public function getUserClaims($user_id, $scope)
{
}
}
}
namespace WHMCS\ApplicationLink\Server\SingleSignOn {
class RedirectResponse extends \Symfony\Component\HttpFoundation\RedirectResponse
{
protected $pathScopeMap = array("clientarea:homepage" => "/clientarea.php", "clientarea:profile" => "/clientarea.php?action=details", "clientarea:billing_info" => "/clientarea.php?action=creditcard", "clientarea:emails" => "/clientarea.php?action=emails", "clientarea:announcements" => "/index.php?rp=/announcements", "clientarea:downloads" => "/index.php?rp=/download", "clientarea:knowledgebase" => "/knowledgebase.php", "clientarea:network_status" => "/serverstatus.php", "clientarea:services" => "/clientarea.php?action=services", "clientarea:product_details" => "/clientarea.php?action=productdetails&id=:serviceId", "clientarea:domains" => "/clientarea.php?action=domains", "clientarea:domain_details" => "/clientarea.php?action=domaindetails&id=:domainId", "clientarea:invoices" => "/clientarea.php?action=invoices", "clientarea:tickets" => "/supporttickets.php", "clientarea:submit_ticket" => "/submitticket.php", "clientarea:shopping_cart" => "/cart.php", "clientarea:shopping_cart_addons" => "/cart.php?gid=addons", "clientarea:upgrade" => "/upgrade.php?type=package&id=:serviceId", "clientarea:shopping_cart_domain_register" => "/cart.php?a=add&domain=register", "clientarea:shopping_cart_domain_transfer" => "/cart.php?a=add&domain=transfer", "sso:custom_redirect" => "/:ssoRedirectPath");
protected $scopesWithDynamicPaths = array("sso:custom_redirect" => array("ssoRedirectPath"), "clientarea:product_details" => array("serviceId"), "clientarea:domain_details" => array("domainId"), "clientarea:upgrade" => array("serviceId"));
const DEFAULT_URL = "/clientarea.php";
const DEFAULT_SCOPE = "clientarea:homepage";
public function __construct($url = "", $status = 302, $headers = array())
{
}
public function setTargetUrlFromToken(\WHMCS\ApplicationLink\AccessToken $token)
{
}
public function getScopesWithDynamicPaths()
{
}
public function getScopePath(\WHMCS\ApplicationLink\AccessToken $token, $data = array())
{
}
public function getScope(\WHMCS\ApplicationLink\AccessToken $token)
{
}
protected function getPathFromScope($scope)
{
}
protected function fillPlaceHolders($path, $data = array())
{
}
}
}
namespace WHMCS\ApplicationLink {
class AuthorizationCode extends \WHMCS\Model\AbstractModel
{
protected $table = "tbloauthserver_auth_codes";
protected $primaryKey = "id";
protected $scopePivotTable = "tbloauthserver_authcode_scopes";
protected $scopePivotId = "authorization_code_id";
protected $dates = array("expires");
public function createTable($drop = false)
{
}
public static function boot()
{
}
public function scopes()
{
}
protected function getFormattedScopes()
{
}
public function getScopeAttribute()
{
}
public function user()
{
}
public function client()
{
}
public function toArray()
{
}
}
}
namespace WHMCS\ApplicationLink\Scope {
class UserAuthorization extends \WHMCS\Model\AbstractModel
{
protected $table = "tbloauthserver_user_authz";
protected $primaryKey = "id";
protected $scopePivotTable = "tbloauthserver_user_authz_scopes";
protected $scopePivotId = "user_authz_id";
protected $dates = array("expires");
public function createTable($drop = false)
{
}
public function scopes()
{
}
protected function getFormattedScopes()
{
}
public function getScopeAttribute()
{
}
public function user()
{
}
public function client()
{
}
public function toArray()
{
}
}
}
namespace WHMCS\ApplicationLink {
class ApplicationLink extends \WHMCS\Model\AbstractModel
{
protected $table = "tblapplinks";
protected $primaryKey = "id";
protected $fillable = array("module_type", "module_name");
public function createTable($drop = false)
{
}
public function links()
{
}
public function log()
{
}
}
}
namespace WHMCS\Scheduling\Contract {
interface JobInterface
{
public function jobName($name);
public function jobClassName($className);
public function jobMethodName($methodName);
public function jobMethodArguments($arguments);
public function jobAvailableAt(\WHMCS\Carbon $date);
public function jobDigestHash($hash);
}
}
namespace WHMCS\Scheduling\Jobs {
trait JobTrait
{
protected $jobName = "";
protected $jobClassName = "";
protected $jobMethodName = "";
protected $jobMethodArguments = array();
protected $jobDigestHash = "";
protected $jobAvailableAt = NULL;
public function jobName($name = "")
{
}
public function jobClassName($className = "")
{
}
public function jobMethodName($methodName = "")
{
}
public function jobMethodArguments($arguments = array())
{
}
public function jobAvailableAt(\WHMCS\Carbon $date = NULL)
{
}
public function jobDigestHash($hash = "")
{
}
}
}
namespace WHMCS\ApplicationLink {
class Provision implements \WHMCS\Scheduling\Contract\JobInterface
{
use \WHMCS\Scheduling\Jobs\JobTrait;
public function sync($module)
{
}
public function cleanup($module)
{
}
public function cloneScopeLink($applinkId, $oldScopeName, $newScopeName)
{
}
}
}
namespace WHMCS\ApplicationLink\OpenID\Claim {
abstract class AbstractClaim
{
protected $user = NULL;
protected $claimName = NULL;
public function __construct(\WHMCS\User\UserInterface $user, $claimName = NULL)
{
}
public function getUser()
{
}
public function setUser(\WHMCS\User\UserInterface $user)
{
}
public function getClaimName()
{
}
public function setClaimName($claimName)
{
}
public function toArray()
{
}
protected abstract function hydrate();
}
class Email extends \WHMCS\ApplicationLink\OpenID\Claim\AbstractClaim
{
public $email = NULL;
public $email_verified = NULL;
public function hydrate()
{
}
}
class Profile extends \WHMCS\ApplicationLink\OpenID\Claim\AbstractClaim
{
public $name = NULL;
public $family_name = NULL;
public $given_name = NULL;
public $preferred_username = NULL;
public $locale = NULL;
public $update_at = NULL;
public function hydrate()
{
}
}
class ClaimFactory extends \WHMCS\ApplicationLink\OpenID\Claim\AbstractClaim
{
protected $claimMap = array("profile" => "\\WHMCS\\ApplicationLink\\OpenID\\Claim\\Profile", "email" => "\\WHMCS\\ApplicationLink\\OpenID\\Claim\\Email");
protected $userClaims = array();
protected $requestedClaims = array();
public function __construct(\WHMCS\User\UserInterface $user, $claims)
{
}
protected function hydrate()
{
}
public function getClaim($claim)
{
}
public function toArray()
{
}
}
}
namespace WHMCS\ApplicationLink\OpenID\ResponseType {
class IdToken extends \OAuth2\OpenID\ResponseType\IdToken
{
protected function encodeToken(array $token, $client_id = NULL)
{
}
}
}
namespace WHMCS\ApplicationLink {
class Links extends \WHMCS\Model\AbstractModel
{
protected $table = "tblapplinks_links";
protected $primaryKey = "id";
protected $fillable = array("applink_id", "scope");
public static function boot()
{
}
public function createTable($drop = false)
{
}
public function applicationLink()
{
}
}
class Log extends \WHMCS\Model\AbstractModel
{
protected $table = "tblapplinks_log";
protected $primaryKey = "id";
public function createTable($drop = false)
{
}
public function applicationLink()
{
}
}
}
namespace WHMCS\Scheduling {
interface StatusInterface
{
public function isInProgress();
public function isDueNow();
public function calculateAndSetNextDue();
public function setNextDue(\WHMCS\Carbon $nextDue);
public function setInProgress($state);
public function getLastRuntime();
public function setLastRuntime(\WHMCS\Carbon $date);
public function getNextDue();
}
}
namespace WHMCS\Scheduling\Task {
class Collection extends \Illuminate\Database\Eloquent\Collection
{
public function __construct($items)
{
}
protected function filterToTasks($models)
{
}
public function transformToTasks()
{
}
public function isEnabled()
{
}
public function isLevel($level)
{
}
}
class Status extends \WHMCS\Model\AbstractModel implements \WHMCS\Scheduling\StatusInterface
{
protected $table = "tbltask_status";
protected $dates = array("next_due", "last_run");
protected $frequency = 1440;
protected $fillable = array("task_id");
public function createTable($drop = false)
{
}
public function isInProgress()
{
}
public function advanceStale(\WHMCS\Carbon $stale)
{
}
public function isLongOverDue()
{
}
public function isDueNow()
{
}
public function calculateAndSetNextDue()
{
}
public function setNextDue(\WHMCS\Carbon $nextDue)
{
}
public function setInProgress($state)
{
}
public function getLastRuntime()
{
}
public function setLastRuntime(\WHMCS\Carbon $date)
{
}
public function getNextDue()
{
}
public function getFrequency()
{
}
public function task()
{
}
}
}
namespace WHMCS\Scheduling\Jobs {
final class Queue extends \WHMCS\Model\AbstractModel
{
public function createTable($drop = false)
{
}
public static function add($name, $class, $method, array $inputParams = array(), $delay = 0, $replaceExisting = false)
{
}
public static function addOrUpdate($name, $class, $method, $inputParams, $delay = 0)
{
}
public static function remove($name)
{
}
public static function exists($name)
{
}
public function encryptArguments(array $data)
{
}
public function decryptArguments($data)
{
}
public function createDigestHash(\WHMCS\Scheduling\Contract\JobInterface $job)
{
}
public function verifyDigestHash(\WHMCS\Scheduling\Contract\JobInterface $job)
{
}
public function executeJob()
{
}
public function validateJob(\WHMCS\Scheduling\Contract\JobInterface $job)
{
}
public function addJob(\WHMCS\Scheduling\Contract\JobInterface $job, $replaceExisting = false)
{
}
}
}
namespace WHMCS\Smarty {
class SmartyServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider
{
public function register()
{
}
protected function getUserPolicySettings($policyName)
{
}
protected function getPolicyClassName($policyName)
{
}
}
}
namespace {
/**
* Smarty Resource Plugin
*
* @package Smarty
* @subpackage TemplateResources
* @author Rodney Rehm
*/
/**
* Smarty Resource Plugin
* Base implementation for resource plugins
*
* @package Smarty
* @subpackage TemplateResources
*
* @method renderUncompiled(Smarty_Template_Source $source, Smarty_Internal_Template $_template)
* @method populateCompiledFilepath(Smarty_Template_Compiled $compiled, Smarty_Internal_Template $_template)
* @method process(Smarty_Internal_Template $_smarty_tpl)
*/
abstract class Smarty_Resource
{
/**
* resource types provided by the core
*
* @var array
*/
public static $sysplugins = array('file' => 'smarty_internal_resource_file.php', 'string' => 'smarty_internal_resource_string.php', 'extends' => 'smarty_internal_resource_extends.php', 'stream' => 'smarty_internal_resource_stream.php', 'eval' => 'smarty_internal_resource_eval.php', 'php' => 'smarty_internal_resource_php.php');
/**
* Source is bypassing compiler
*
* @var boolean
*/
public $uncompiled = \false;
/**
* Source must be recompiled on every occasion
*
* @var boolean
*/
public $recompiled = \false;
/**
* Flag if resource does implement populateCompiledFilepath() method
*
* @var bool
*/
public $hasCompiledHandler = \false;
/**
* Load Resource Handler
*
* @param Smarty $smarty smarty object
* @param string $type name of the resource
*
* @throws SmartyException
* @return Smarty_Resource Resource Handler
*/
public static function load(\Smarty $smarty, $type)
{
}
/**
* extract resource_type and resource_name from template_resource and config_resource
*
* @note "C:/foo.tpl" was forced to file resource up till Smarty 3.1.3 (including).
*
* @param string $resource_name template_resource or config_resource to parse
* @param string $default_resource the default resource_type defined in $smarty
*
* @return array with parsed resource name and type
*/
public static function parseResourceName($resource_name, $default_resource)
{
}
/**
* modify template_resource according to resource handlers specifications
*
* @param \Smarty_Internal_Template|\Smarty $obj Smarty instance
* @param string $template_resource template_resource to extract resource handler and
* name of
*
* @return string unique resource name
* @throws \SmartyException
*/
public static function getUniqueTemplateName($obj, $template_resource)
{
}
/**
* initialize Source Object for given resource
* wrapper for backward compatibility to versions < 3.1.22
* Either [$_template] or [$smarty, $template_resource] must be specified
*
* @param Smarty_Internal_Template $_template template object
* @param Smarty $smarty smarty object
* @param string $template_resource resource identifier
*
* @return \Smarty_Template_Source Source Object
* @throws \SmartyException
*/
public static function source(\Smarty_Internal_Template $_template = \null, \Smarty $smarty = \null, $template_resource = \null)
{
}
/**
* Load template's source into current template object
*
* @param Smarty_Template_Source $source source object
*
* @return string template source
* @throws SmartyException if source cannot be loaded
*/
public abstract function getContent(\Smarty_Template_Source $source);
/**
* populate Source Object with meta data from Resource
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*/
public abstract function populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = \null);
/**
* populate Source Object with timestamp and exists from Resource
*
* @param Smarty_Template_Source $source source object
*/
public function populateTimestamp(\Smarty_Template_Source $source)
{
}
/**
* modify resource_name according to resource handlers specifications
*
* @param Smarty $smarty Smarty instance
* @param string $resource_name resource_name to make unique
* @param boolean $isConfig flag for config resource
*
* @return string unique resource name
*/
public function buildUniqueResourceName(\Smarty $smarty, $resource_name, $isConfig = \false)
{
}
/*
* Check if resource must check time stamps when when loading complied or cached templates.
* Resources like 'extends' which use source components my disable timestamp checks on own resource.
*
* @return bool
*/
/**
* Determine basename for compiled filename
*
* @param Smarty_Template_Source $source source object
*
* @return string resource's basename
*/
public function getBasename(\Smarty_Template_Source $source)
{
}
/**
* @return bool
*/
public function checkTimestamps()
{
}
}
/**
* Smarty Resource Plugin
*
* @package Smarty
* @subpackage TemplateResources
* @author Rodney Rehm
*/
/**
* Smarty Resource Plugin
* Wrapper Implementation for custom resource plugins
*
* @package Smarty
* @subpackage TemplateResources
*/
abstract class Smarty_Resource_Custom extends \Smarty_Resource
{
/**
* fetch template and its modification time from data source
*
* @param string $name template name
* @param string &$source template source
* @param integer &$mtime template modification timestamp (epoch)
*/
protected abstract function fetch($name, &$source, &$mtime);
/**
* Fetch template's modification timestamp from data source
* {@internal implementing this method is optional.
* Only implement it if modification times can be accessed faster than loading the complete template source.}}
*
* @param string $name template name
*
* @return integer|boolean timestamp (epoch) the template was modified, or false if not found
*/
protected function fetchTimestamp($name)
{
}
/**
* populate Source Object with meta data from Resource
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*/
public function populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = \null)
{
}
/**
* Load template's source into current template object
*
* @param Smarty_Template_Source $source source object
*
* @return string template source
* @throws SmartyException if source cannot be loaded
*/
public function getContent(\Smarty_Template_Source $source)
{
}
/**
* Determine basename for compiled filename
*
* @param Smarty_Template_Source $source source object
*
* @return string resource's basename
*/
public function getBasename(\Smarty_Template_Source $source)
{
}
}
}
namespace WHMCS\Smarty\Resource {
class MailMessage extends \Smarty_Resource_Custom
{
protected $message = NULL;
public function __construct(\WHMCS\Mail\Message $message)
{
}
protected function setMessage(\WHMCS\Mail\Message $message)
{
}
protected function getMessage()
{
}
protected function fetch($name, &$source, &$mtime)
{
}
}
}
namespace {
/**
* Smarty plugin
*
* @package Smarty
* @subpackage Security
* @author Uwe Tews
*/
/**
* FIXME: Smarty_Security API
* - getter and setter instead of public properties would allow cultivating an internal cache properly
* - current implementation of isTrustedResourceDir() assumes that Smarty::$template_dir and Smarty::$config_dir
* are immutable the cache is killed every time either of the variables change. That means that two distinct
* Smarty objects with differing
* $template_dir or $config_dir should NOT share the same Smarty_Security instance,
* as this would lead to (severe) performance penalty! how should this be handled?
*/
/**
* This class does contain the security settings
*/
class Smarty_Security
{
/**
* This determines how Smarty handles "<?php ... ?>" tags in templates.
* possible values:
* <ul>
* <li>Smarty::PHP_PASSTHRU -> echo PHP tags as they are</li>
* <li>Smarty::PHP_QUOTE -> escape tags as entities</li>
* <li>Smarty::PHP_REMOVE -> remove php tags</li>
* <li>Smarty::PHP_ALLOW -> execute php tags</li>
* </ul>
*
* @var integer
*/
public $php_handling = \Smarty::PHP_PASSTHRU;
/**
* This is the list of template directories that are considered secure.
* $template_dir is in this list implicitly.
*
* @var array
*/
public $secure_dir = array();
/**
* This is an array of directories where trusted php scripts reside.
* {@link $security} is disabled during their inclusion/execution.
*
* @var array
*/
public $trusted_dir = array();
/**
* List of regular expressions (PCRE) that include trusted URIs
*
* @var array
*/
public $trusted_uri = array();
/**
* List of trusted constants names
*
* @var array
*/
public $trusted_constants = array();
/**
* This is an array of trusted static classes.
* If empty access to all static classes is allowed.
* If set to 'none' none is allowed.
*
* @var array
*/
public $static_classes = array();
/**
* This is an nested array of trusted classes and static methods.
* If empty access to all static classes and methods is allowed.
* Format:
* array (
* 'class_1' => array('method_1', 'method_2'), // allowed methods listed
* 'class_2' => array(), // all methods of class allowed
* )
* If set to null none is allowed.
*
* @var array
*/
public $trusted_static_methods = array();
/**
* This is an array of trusted static properties.
* If empty access to all static classes and properties is allowed.
* Format:
* array (
* 'class_1' => array('prop_1', 'prop_2'), // allowed properties listed
* 'class_2' => array(), // all properties of class allowed
* )
* If set to null none is allowed.
*
* @var array
*/
public $trusted_static_properties = array();
/**
* This is an array of trusted PHP functions.
* If empty all functions are allowed.
* To disable all PHP functions set $php_functions = null.
*
* @var array
*/
public $php_functions = array('isset', 'empty', 'count', 'sizeof', 'in_array', 'is_array', 'time');
/**
* This is an array of trusted PHP modifiers.
* If empty all modifiers are allowed.
* To disable all modifier set $php_modifiers = null.
*
* @var array
*/
public $php_modifiers = array('escape', 'count', 'nl2br');
/**
* This is an array of allowed tags.
* If empty no restriction by allowed_tags.
*
* @var array
*/
public $allowed_tags = array();
/**
* This is an array of disabled tags.
* If empty no restriction by disabled_tags.
*
* @var array
*/
public $disabled_tags = array();
/**
* This is an array of allowed modifier plugins.
* If empty no restriction by allowed_modifiers.
*
* @var array
*/
public $allowed_modifiers = array();
/**
* This is an array of disabled modifier plugins.
* If empty no restriction by disabled_modifiers.
*
* @var array
*/
public $disabled_modifiers = array();
/**
* This is an array of disabled special $smarty variables.
*
* @var array
*/
public $disabled_special_smarty_vars = array();
/**
* This is an array of trusted streams.
* If empty all streams are allowed.
* To disable all streams set $streams = null.
*
* @var array
*/
public $streams = array('file');
/**
* + flag if constants can be accessed from template
*
* @var boolean
*/
public $allow_constants = \true;
/**
* + flag if super globals can be accessed from template
*
* @var boolean
*/
public $allow_super_globals = \true;
/**
* max template nesting level
*
* @var int
*/
public $max_template_nesting = 0;
/**
* Cache for $resource_dir lookup
*
* @var array
*/
protected $_resource_dir = array();
/**
* Cache for $template_dir lookup
*
* @var array
*/
protected $_template_dir = array();
/**
* Cache for $config_dir lookup
*
* @var array
*/
protected $_config_dir = array();
/**
* Cache for $secure_dir lookup
*
* @var array
*/
protected $_secure_dir = array();
/**
* Cache for $php_resource_dir lookup
*
* @var array
*/
protected $_php_resource_dir = \null;
/**
* Cache for $trusted_dir lookup
*
* @var array
*/
protected $_trusted_dir = \null;
/**
* Cache for include path status
*
* @var bool
*/
protected $_include_path_status = \false;
/**
* Cache for $_include_array lookup
*
* @var array
*/
protected $_include_dir = array();
/**
* @param Smarty $smarty
*/
public function __construct($smarty)
{
}
/**
* Check if PHP function is trusted.
*
* @param string $function_name
* @param object $compiler compiler object
*
* @return boolean true if function is trusted
*/
public function isTrustedPhpFunction($function_name, $compiler)
{
}
/**
* Check if static class is trusted.
*
* @param string $class_name
* @param object $compiler compiler object
*
* @return boolean true if class is trusted
*/
public function isTrustedStaticClass($class_name, $compiler)
{
}
/**
* Check if static class method/property is trusted.
*
* @param string $class_name
* @param string $params
* @param object $compiler compiler object
*
* @return boolean true if class method is trusted
*/
public function isTrustedStaticClassAccess($class_name, $params, $compiler)
{
}
/**
* Check if PHP modifier is trusted.
*
* @param string $modifier_name
* @param object $compiler compiler object
*
* @return boolean true if modifier is trusted
*/
public function isTrustedPhpModifier($modifier_name, $compiler)
{
}
/**
* Check if tag is trusted.
*
* @param string $tag_name
* @param object $compiler compiler object
*
* @return boolean true if tag is trusted
*/
public function isTrustedTag($tag_name, $compiler)
{
}
/**
* Check if special $smarty variable is trusted.
*
* @param string $var_name
* @param object $compiler compiler object
*
* @return boolean true if tag is trusted
*/
public function isTrustedSpecialSmartyVar($var_name, $compiler)
{
}
/**
* Check if modifier plugin is trusted.
*
* @param string $modifier_name
* @param object $compiler compiler object
*
* @return boolean true if tag is trusted
*/
public function isTrustedModifier($modifier_name, $compiler)
{
}
/**
* Check if constants are enabled or trusted
*
* @param string $const constant name
* @param object $compiler compiler object
*
* @return bool
*/
public function isTrustedConstant($const, $compiler)
{
}
/**
* Check if stream is trusted.
*
* @param string $stream_name
*
* @return boolean true if stream is trusted
* @throws SmartyException if stream is not trusted
*/
public function isTrustedStream($stream_name)
{
}
/**
* Check if directory of file resource is trusted.
*
* @param string $filepath
* @param null|bool $isConfig
*
* @return bool true if directory is trusted
* @throws \SmartyException if directory is not trusted
*/
public function isTrustedResourceDir($filepath, $isConfig = \null)
{
}
/**
* Check if URI (e.g. {fetch} or {html_image}) is trusted
* To simplify things, isTrustedUri() resolves all input to "{$PROTOCOL}://{$HOSTNAME}".
* So "http://username:password@hello.world.example.org:8080/some-path?some=query-string"
* is reduced to "http://hello.world.example.org" prior to applying the patters from {@link $trusted_uri}.
*
* @param string $uri
*
* @return boolean true if URI is trusted
* @throws SmartyException if URI is not trusted
* @uses $trusted_uri for list of patterns to match against $uri
*/
public function isTrustedUri($uri)
{
}
/**
* Check if directory of file resource is trusted.
*
* @param string $filepath
*
* @return boolean true if directory is trusted
* @throws SmartyException if PHP directory is not trusted
*/
public function isTrustedPHPDir($filepath)
{
}
/**
* Loads security class and enables security
*
* @param \Smarty $smarty
* @param string|Smarty_Security $security_class if a string is used, it must be class-name
*
* @return \Smarty current Smarty instance for chaining
* @throws \SmartyException when an invalid class name is provided
*/
public static function enableSecurity(\Smarty $smarty, $security_class)
{
}
/**
* Start template processing
*
* @param $template
*
* @throws SmartyException
*/
public function startTemplate($template)
{
}
/**
* Exit template processing
*/
public function endTemplate()
{
}
/**
* Register callback functions call at start/end of template rendering
*
* @param \Smarty_Internal_Template $template
*/
public function registerCallBacks(\Smarty_Internal_Template $template)
{
}
}
}
namespace WHMCS\Smarty\Security {
class Policy extends \Smarty_Security
{
const TAG_COMPILER_PHP = "private_php";
public function __construct(\Smarty $smarty, \WHMCS\Smarty\Security\Settings\BasePolicy $policySettings)
{
}
public function loadPolicySettings(\WHMCS\Smarty\Security\Settings\BasePolicy $settings)
{
}
public function isTrustedTag($tag_name, $compiler)
{
}
}
}
namespace WHMCS\Smarty\Security\Settings {
class BasePolicy
{
protected $phpFunctions = NULL;
protected $phpModifiers = NULL;
protected $allowedModifiers = NULL;
protected $disabledModifiers = NULL;
protected $allowedTags = NULL;
protected $disabledTags = NULL;
protected $staticClasses = NULL;
protected $trustedStaticMethods = NULL;
protected $trustedStaticProperties = NULL;
protected $disabledSpecialSmartyVars = NULL;
protected $streams = NULL;
protected $allowSuperGlobals = NULL;
protected $allowConstants = NULL;
protected $secureDir = NULL;
protected $trustedDir = NULL;
public function __construct(array $data)
{
}
protected function getDefaultPolicySettings()
{
}
public function getPhpFunctions()
{
}
public function setphpFunctions($phpFunctions)
{
}
public function getPhpModifiers()
{
}
public function setPhpModifiers($phpModifiers)
{
}
public function getAllowedModifiers()
{
}
public function setAllowedModifiers($allowedModifiers)
{
}
public function getDisabledModifiers()
{
}
public function setDisabledModifiers($disabledModifiers)
{
}
public function getAllowedTags()
{
}
public function setAllowedTags($allowedTags)
{
}
public function getDisabledTags()
{
}
public function setDisabledTags($disabledTags)
{
}
public function getStaticClasses()
{
}
public function setStaticClasses($staticClasses)
{
}
public function getTrustedStaticMethods()
{
}
public function setTrustedStaticMethods($staticMethods)
{
}
public function getTrustedStaticProperties()
{
}
public function setTrustedStaticProperties($trustedStaticProperties)
{
}
public function getDisabledSpecialSmartyVars()
{
}
public function setDisabledSpecialSmartyVars($disabledSpecialSmartyVars)
{
}
public function getStreams()
{
}
public function setStreams($streams)
{
}
public function isAllowSuperGlobals()
{
}
public function setAllowSuperGlobals($allowSuperGlobals)
{
}
public function getSecureDir()
{
}
public function setSecureDir($secureDir)
{
}
public function getTrustedDir()
{
}
public function setTrustedDir($trustedDir)
{
}
public function isAllowConstants()
{
}
public function setAllowConstants($allowConstants)
{
}
public function hasPhpTagCompiler()
{
}
}
class SystemPolicy extends \WHMCS\Smarty\Security\Settings\BasePolicy
{
public function __construct(array $data)
{
}
protected function mergeSettingsAndAdminValues(array $data)
{
}
}
class MailPolicy extends \WHMCS\Smarty\Security\Settings\SystemPolicy
{
protected function getDefaultPolicySettings()
{
}
}
}
namespace WHMCS\Module {
abstract class AbstractModule
{
protected $type = "";
protected $loadedmodule = "";
protected $metaData = array();
protected $moduleParams = array();
protected $usesDirectories = true;
protected $cacheActiveModules = NULL;
const TYPE_ADMIN = "admin";
const TYPE_ADDON = "addons";
const TYPE_FRAUD = "fraud";
const TYPE_GATEWAY = "gateways";
const TYPE_NOTIFICATION = "notifications";
const TYPE_REGISTRAR = "registrars";
const TYPE_REPORT = "reports";
const TYPE_SECURITY = "security";
const TYPE_SERVER = "servers";
const TYPE_SOCIAL = "social";
const TYPE_SUPPORT = "support";
const TYPE_WIDGET = "widgets";
const ALL_TYPES = NULL;
const FUNCTIONDOESNTEXIST = "!Function not found in module!";
const MODULE_NOT_ACTIVE = "Module Not Activated";
public function getType()
{
}
public function setType($type)
{
}
protected function setLoadedModule($module)
{
}
public function getLoadedModule()
{
}
public function getList($type = "")
{
}
protected function getBaseModulesDir()
{
}
public function getBaseModuleDir()
{
}
public function getModuleDirectory($module)
{
}
public function getModulePath($module)
{
}
public function getAppMetaDataFilePath($module)
{
}
public function load($module, $globalVariable = NULL)
{
}
public function call($function, array $params = array())
{
}
public function functionExists($name)
{
}
protected function getMetaData()
{
}
protected function setMetaData($metaData)
{
}
public function getMetaDataValue($keyName)
{
}
public function isMetaDataValueSet($keyName)
{
}
public function getDisplayName()
{
}
public function getAPIVersion()
{
}
public function getApplicationLinkDescription()
{
}
public function getLogoFilename()
{
}
public function getSmallLogoFilename()
{
}
protected function getDefaultAPIVersion()
{
}
public function prepareParams($params)
{
}
protected function addParam($key, $value)
{
}
public function getParams()
{
}
public function getParam($key)
{
}
public function findTemplate($templateName)
{
}
public function isApplicationLinkSupported()
{
}
public function isApplicationLinkingEnabled()
{
}
public function activate(array $parameters = array())
{
}
public function deactivate(array $parameters = array())
{
}
public function updateConfiguration(array $parameters = array())
{
}
public function getConfiguration()
{
}
public function getActiveModules()
{
}
public function isActive($moduleName)
{
}
public function getApps()
{
}
public function getAdminActivationForms($moduleName)
{
}
public function getAdminManagementForms($moduleName)
{
}
}
class Security extends \WHMCS\Module\AbstractModule
{
protected $type = self::TYPE_SECURITY;
public function getActiveModules()
{
}
public function getAdminActivationForms($moduleName)
{
}
public function getAdminManagementForms($moduleName)
{
}
}
}
namespace WHMCS\Module\Storage {
abstract class AbstractDataStorage
{
protected abstract function readDataFromStorage();
protected abstract function writeDataToStorage(array $allModulesData);
public function __construct($moduleName)
{
}
public static function forModule($moduleName)
{
}
public function getModuleName()
{
}
public function setModuleName($moduleName)
{
}
public function deleteAll()
{
}
protected function validateValue($value)
{
}
public function getValue($key, $default = NULL, $deleteImmediately = false)
{
}
public function getAndDeleteValue($key, $default = NULL)
{
}
public function setValue($key, $value)
{
}
public function deleteValue($key)
{
}
}
final class EncryptedTransientStorage extends \WHMCS\Module\Storage\AbstractDataStorage
{
}
}
namespace WHMCS\Module {
class Widget extends \WHMCS\Module\AbstractModule
{
protected $type = self::TYPE_WIDGET;
protected $usesDirectories = false;
protected $widgets = NULL;
protected $hookName = "AdminHomeWidgets";
public function loadWidgets()
{
}
protected function initGlobalChartForLegacyWidgets()
{
}
protected function loadWidgetsViaHooks()
{
}
public function getAllWidgets()
{
}
public function getWidgetByName($widgetId)
{
}
}
class Fraud extends \WHMCS\Module\AbstractModule
{
protected $type = self::TYPE_FRAUD;
const SKIP_MODULES = array("SKIPPED", "CREDIT");
public function getActiveModules()
{
}
public function load($module, $globalVariable = NULL)
{
}
public function getSettings()
{
}
public function call($function, array $params = array())
{
}
public function doFraudCheck($orderid, $userid = "", $ip = "")
{
}
public function processResultsForDisplay($orderid, $fraudoutput = "")
{
}
public function getAdminActivationForms($moduleName)
{
}
public function getAdminManagementForms($moduleName)
{
}
}
class Server extends \WHMCS\Module\AbstractModule
{
protected $type = self::TYPE_SERVER;
protected $serviceID = "";
protected $addonId = 0;
protected $serviceModule = "";
protected $addonModule = "";
protected $modelData = NULL;
protected $params = NULL;
public function getActiveModules()
{
}
public function setServiceId($serviceId, $populateModel = true)
{
}
public function setAddonId($addonId)
{
}
public static function factoryFromModel($model)
{
}
public function getModuleByServiceID($serviceID = 0)
{
}
public function getModuleByAddonId($addonId = 0)
{
}
public function getServiceModule()
{
}
public function getAddonModule()
{
}
public function loadByServiceID($serviceID)
{
}
public function loadByAddonId($addonId)
{
}
public function buildParams()
{
}
protected function buildServiceParams(\WHMCS\Service\Service $serviceData)
{
}
protected function buildAddonParams(\WHMCS\Service\Addon $addonData)
{
}
public function getServerParams($server)
{
}
public function call($function, array $params = array())
{
}
public function getListWithDisplayNames()
{
}
protected function getSingleSignOnUrl($serverId, $admin)
{
}
public function getSingleSignOnUrlForService()
{
}
public function getSingleSignOnUrlForAdmin($serverId)
{
}
protected function isClientFitForApplicationLinks($client, array &$errors = NULL)
{
}
public function enableApplicationLinks($performingSync = false)
{
}
public function disableApplicationLinks($performingSync = false)
{
}
public function cleanupOldApplicationLinks()
{
}
protected function addToAppLinkLog($appLinkId, $level, $message)
{
}
protected function determineServersWithApplicationLinksSupport($appLinkId, $skipLogging = false)
{
}
public function syncApplicationLinksConfigChange()
{
}
public function doSingleApplicationLinkCall($action)
{
}
public function getServerListForModule()
{
}
public static function generateRandomPassword()
{
}
public function generateRandomPasswordForModule()
{
}
public function getAdminActivationForms($moduleName)
{
}
public function getAdminManagementForms($moduleName)
{
}
}
class RegistrarSetting extends \WHMCS\Model\AbstractModel
{
protected $table = "tblregistrars";
public $timestamps = false;
protected $fillable = array("registrar");
public function scopeRegistrar(\Illuminate\Database\Eloquent\Builder $query, $registrarName)
{
}
public function scopeSetting(\Illuminate\Database\Eloquent\Builder $query, $registrarSettingName)
{
}
public function getValueAttribute($value)
{
}
public function setValueAttribute($value)
{
}
}
}
namespace WHMCS\Module\Addon {
class Setting extends \WHMCS\Model\AbstractModel
{
protected $table = "tbladdonmodules";
protected $fillable = array("module", "setting");
public $timestamps = false;
public function scopeModule($query, $module)
{
}
}
}
namespace WHMCS\Module {
class GatewaySetting extends \WHMCS\Model\AbstractModel
{
protected $table = "tblpaymentgateways";
public $timestamps = false;
protected $fillable = array("gateway", "setting");
public function scopeGateway(\Illuminate\Database\Eloquent\Builder $query, $gatewayName)
{
}
public function scopeSetting(\Illuminate\Database\Eloquent\Builder $query, $settingName)
{
}
public static function getValue($gateway, $setting)
{
}
public static function setValue($gateway, $setting, $value)
{
}
public static function getForGateway($gateway)
{
}
}
class ClientAreaController
{
public function index(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
class LegacyWidget extends \WHMCS\Module\AbstractWidget
{
protected $bodyOutput = NULL;
protected $jsOutput = NULL;
protected $jqueryOutput = NULL;
public static function factory($title, $bodyOutput, $jsOutput, $jqueryOutput)
{
}
public function setTitle($title)
{
}
public function setBodyOutput($bodyOutput)
{
}
public function setJsOutput($jsOutput)
{
}
public function setJqueryOutput($jqueryOutput)
{
}
public function getId()
{
}
public function getData()
{
}
public function generateOutput($data)
{
}
}
class LegacyModuleCleanup
{
const JOB_UPDATER_ADMIN_NOTIFICATION = "updater.legacyModuleCleanup.adminNotification";
public function removeModule($moduleName, $moduleType)
{
}
public function removeModulesIfInstalledAndUnused(array $modules)
{
}
}
class Registrar extends \WHMCS\Module\AbstractModule
{
protected $type = self::TYPE_REGISTRAR;
protected $domainID = 0;
protected $function = NULL;
public function __construct()
{
}
public function getActiveModules()
{
}
public function getDisplayName()
{
}
public function clearSettings()
{
}
public function getSettings()
{
}
public function setDomainID($domainID)
{
}
protected function getDomainID()
{
}
public function buildParams()
{
}
public function call($function, array $additionalParams = array())
{
}
public function isActivated()
{
}
public function activate(array $parameters = array())
{
}
public function deactivate(array $parameters = array())
{
}
public function saveSettings(array $newSettings = array(), $logChanges = true)
{
}
public function getConfiguration()
{
}
public function updateConfiguration(array $parameters = array())
{
}
protected function buildFunctionSpecificParams(\WHMCS\Domain\Domain $domain, array &$params)
{
}
public function load($module, $globalVariable = NULL)
{
}
public function getAdminActivationForms($moduleName)
{
}
public function getAdminManagementForms($moduleName)
{
}
public function validateConfiguration($newSettings)
{
}
}
class Queue extends \WHMCS\Model\AbstractModel
{
protected $columnMap = array("lastAttempt" => "last_attempt", "lastAttemptError" => "last_attempt_error");
protected $table = "tblmodulequeue";
protected $primaryKey = "id";
protected $casts = array("last_attempt" => "datetime");
protected $dates = array("last_attempt");
protected $fillable = array("service_type", "service_id", "module_name", "module_action", "completed");
public function createTable($drop = false)
{
}
public function scopeIncomplete(\Illuminate\Database\Eloquent\Builder $query)
{
}
public static function add($serviceType, $serviceId, $module, $moduleAction, $lastAttemptError)
{
}
public function getLastAttemptErrorAttribute()
{
}
public function setLastAttemptErrorAttribute($value)
{
}
public static function resolve($serviceType, $serviceId, $module, $moduleAction)
{
}
public function service()
{
}
public function domain()
{
}
public function addon()
{
}
}
class Autoloader
{
protected $baseModulePath = NULL;
protected $moduleTypes = array("Addon" => "addons", "Fraud" => "fraud", "Gateway" => "gateways", "Notification" => "notifications", "Registrar" => "registrars", "Report" => "reports", "Security" => "security", "Server" => "servers", "Social" => "social", "Support" => "support", "Widget" => "widgets");
public static function register(\WHMCS\Module\Autoloader $loader = NULL)
{
}
public static function unregister(\WHMCS\Module\Autoloader $loader = NULL)
{
}
public function moduleClassLoader($className)
{
}
public function getBaseModulePath()
{
}
public function getModuleTypes()
{
}
public function getClassParts($className)
{
}
protected function splitAtUppercase($string)
{
}
public function getModuleDirectoryNames($moduleName)
{
}
public function getModuleIncludePaths($moduleType, $moduleName, $relativeClassParts)
{
}
}
class Module
{
protected $classMap = array("addons" => "Addon", "fraud" => "Fraud", "gateways" => "Gateway", "notifications" => "Notification", "registrars" => "Registrar", "security" => "Security", "servers" => "Server");
protected $cacheActiveModules = NULL;
public function getClassMap()
{
}
public function getAllClasses()
{
}
public function getClassByModuleType($type)
{
}
public static function sluggify($moduleType, $moduleName)
{
}
public static function defineHooks()
{
}
public function getModuleType(\WHMCS\Module\AbstractModule $module)
{
}
}
class Notification extends \WHMCS\Module\AbstractModule
{
protected $type = self::TYPE_NOTIFICATION;
public function getActiveModules()
{
}
public function getClassPath()
{
}
public function getAdminActivationForms($moduleName)
{
}
public function getAdminManagementForms($moduleName)
{
}
}
class Gateway extends \WHMCS\Module\AbstractModule
{
protected $type = self::TYPE_GATEWAY;
protected $usesDirectories = false;
protected $activeList = "";
protected $legacyGatewayParams = array();
const WORKFLOW_ASSISTED = "assisted";
const WORKFLOW_REMOTE = "remote";
const WORKFLOW_NOLOCALCARDINPUT = "nolocalcardinput";
const WORKFLOW_TOKEN = "token";
const WORKFLOW_MERCHANT = "merchant";
const WORKFLOW_THIRDPARTY = "thirdparty";
const GATEWAY_BANK = "Bank";
const GATEWAY_CREDIT_CARD = "CC";
const GATEWAY_THIRD_PARTY = "Invoices";
const PROCESSING_OFFLINE = "Offline";
const PROCESSING_ONLINE = "Online";
public function __construct()
{
}
public function getActiveModules()
{
}
public function getList($type = "")
{
}
public static function factory($name)
{
}
public function getActiveGateways()
{
}
public function getMerchantGateways()
{
}
public function isActiveGateway($gateway)
{
}
public function getDisplayName()
{
}
public function getAvailableGateways($invoiceid = "")
{
}
public function getFirstAvailableGateway()
{
}
public function load($module, $globalVariable = NULL)
{
}
public function loadSettings()
{
}
public function isLoadedModuleActive()
{
}
public function call($function, array $params = array())
{
}
public function activate(array $parameters = array())
{
}
public function deactivate(array $parameters = array())
{
}
protected function saveConfigValue($setting, $value, $order = 0)
{
}
public function getConfiguration()
{
}
public function updateConfiguration(array $parameters = array())
{
}
public function getAdminActivationForms($moduleName)
{
}
public function getAdminManagementForms($moduleName)
{
}
public function getOnBoardingRedirectHtml()
{
}
public function getWorkflowType()
{
}
public function isTokenised()
{
}
public function supportsLocalBankDetails()
{
}
public function supportsAutoCapture()
{
}
public function getBaseGatewayType()
{
}
public function getProcessingType()
{
}
public function isSupportedCurrency($currencyCode)
{
}
}
class Addon extends \WHMCS\Module\AbstractModule
{
protected $type = self::TYPE_ADDON;
public function getActiveModules()
{
}
public function call($function, array $params = array())
{
}
public function getAdminActivationForms($moduleName)
{
}
public function getAdminManagementForms($moduleName)
{
}
}
}
namespace WHMCS {
class Container extends \Illuminate\Container\Container implements \Interop\Container\ContainerInterface
{
protected $serviceProviders = array();
public function environment()
{
}
public function isDownForMaintenance()
{
}
public function call($callback, array $parameters = array(), $defaultMethod = NULL)
{
}
public function register($serviceProvider)
{
}
public function get($id)
{
}
public function has($id)
{
}
}
}
namespace WHMCS\Mail\Job {
class AdminNotification implements \WHMCS\Scheduling\Contract\JobInterface
{
use \WHMCS\Scheduling\Jobs\JobTrait;
const JOB_NAME_GENERIC = "sendAdminNotification.deferred";
public function send()
{
}
}
}
namespace WHMCS\Mail {
class Emailer
{
protected $message = NULL;
protected $entityId = NULL;
protected $extraParams = NULL;
protected $isNonClientEmail = false;
protected $recipientUserId = NULL;
protected $recipientContactId = NULL;
protected $mergeData = array();
protected $emailTemplateNamesToNotLog = array("Automated Password Reset", "Client Email Address Verification", "Password Reset Validation");
const EMAIL_TYPE_ADMIN = "admin";
const EMAIL_TYPE_AFFILIATE = "affiliate";
const EMAIL_TYPE_DOMAIN = "domain";
const EMAIL_TYPE_GENERAL = "general";
const EMAIL_TYPE_INVOICE = "invoice";
const EMAIL_TYPE_NOTIFICATION = "notification";
const EMAIL_TYPE_PRODUCT = "product";
const EMAIL_TYPE_SUPPORT = "support";
const ENTITY_MAP = NULL;
const CLIENT_EMAILS = NULL;
public function __construct(\WHMCS\Mail\Message $message, $entityId, $extraParams = NULL)
{
}
public static function factory(\WHMCS\Mail\Message $message, $entityId, $extraParams = NULL)
{
}
public static function factoryByTemplate($template, $entityId = 0, $extraParams = NULL)
{
}
public static function getTemplate($templateName, $entityId = 0)
{
}
protected function getExtra($key)
{
}
protected function getClientMergeData()
{
}
protected function getGenericMergeData()
{
}
protected function allowCc()
{
}
protected function prepare()
{
}
public function finalizeCopiedRecipients(\WHMCS\Mail\Message $message, $relationalId)
{
}
public function getMergeData()
{
}
public function getMergeDataByKey($key)
{
}
public function preview()
{
}
public function send()
{
}
protected function setRecipient($userId, $contactId = NULL)
{
}
public function assign($key, $value)
{
}
public function massAssign($data)
{
}
public function getMessage()
{
}
}
class Template extends \WHMCS\Model\AbstractModel
{
protected $table = "tblemailtemplates";
protected $guarded = array("id");
protected $booleans = array("custom", "disabled", "plaintext");
protected $commaSeparated = array("attachments", "copyTo", "blindCopyTo");
public $unique = array();
public function __toString()
{
}
public function scopeMaster($query)
{
}
public static function getActiveLanguages()
{
}
public static function boot()
{
}
}
}
namespace WHMCS\Mail\Entity {
class Invoice extends \WHMCS\Mail\Emailer
{
protected function getEntitySpecificMergeData($invoiceId)
{
}
}
class Admin extends \WHMCS\Mail\Emailer
{
protected $isNonClientEmail = true;
public function __construct($message, $entityId, $extraParams = NULL)
{
}
protected function getEntitySpecificMergeData($userId, $extra)
{
}
public function determineAdminRecipientsAndSender($to, $deptid, $adminid, $ticketnotify)
{
}
}
class Product extends \WHMCS\Mail\Emailer
{
protected function getEntitySpecificMergeData($serviceId, $extraParams)
{
}
protected function getAddonSpecificMergeData($addonId, array $gatewaysArray = array())
{
}
}
class Domain extends \WHMCS\Mail\Emailer
{
protected function getEntitySpecificMergeData($domainId)
{
}
}
class Support extends \WHMCS\Mail\Emailer
{
protected function getEntitySpecificMergeData($ticketId, $extra)
{
}
}
class Affiliate extends \WHMCS\Mail\Emailer
{
protected function getEntitySpecificMergeData($affiliateId)
{
}
}
class General extends \WHMCS\Mail\Emailer
{
protected function getEntitySpecificMergeData($userId, $extra)
{
}
}
class Notification extends \WHMCS\Mail\Emailer
{
protected $isNonClientEmail = true;
public function __construct($message, $entityId, $extraParams = NULL)
{
}
public function getEntitySpecificMergeData($id, $extra)
{
}
}
}
namespace WHMCS\Mail {
class Message
{
protected $type = "general";
protected $templateName = "";
protected $from = array();
protected $to = array();
protected $cc = array();
protected $bcc = array();
protected $subject = "";
protected $body = "";
protected $bodyPlainText = "";
protected $attachments = array();
const HEADER_MARKER = "<!-- message header end -->";
const FOOTER_MARKER = "<!-- message footer start -->";
public function __construct()
{
}
public static function createFromTemplate(\WHMCS\Mail\Template $template)
{
}
public function setType($type)
{
}
public function getType()
{
}
public function setTemplateName($templateName)
{
}
public function getTemplateName()
{
}
public function addRecipient($kind, $email, $name = "")
{
}
public function clearRecipients($kind)
{
}
public function setFromName($name)
{
}
public function getFromName()
{
}
public function setFromEmail($email)
{
}
public function getFromEmail()
{
}
public function getRecipients($kind)
{
}
public function getFormattedRecipients($kind)
{
}
public function setSubject($subject)
{
}
public function getSubject()
{
}
public function setBodyAndPlainText($body)
{
}
public function setBody($body)
{
}
public function setBodyFromSmarty($body)
{
}
public function getBody()
{
}
public function getBodyWithoutCSS()
{
}
public function setPlainText($text)
{
}
protected function replaceLinksWithUrl($text)
{
}
public function getPlainText()
{
}
public function addStringAttachment($filename, $data)
{
}
public function addFileAttachment($filename, $filepath)
{
}
public function getAttachments()
{
}
public function hasRecipients()
{
}
public function saveToEmailLog($userId)
{
}
}
class Image extends \WHMCS\Model\AbstractModel
{
protected $table = "tblemail_images";
protected $fillable = array("filename", "original_name");
public function createTable($drop = false)
{
}
}
class AdminNotification
{
protected $rawHtml = "<!DOCTYPE html PUBLIC \"-//W3C//DTD XHTML 1.0 Transitional//EN\" \"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd\">\n<html xmlns=\"http://www.w3.org/1999/xhtml\">\n <head>\n <meta http-equiv=\"Content-Type\" content=\"text/html; charset=**CHARSET**\" />\n <meta name=\"viewport\" content=\"width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no\">\n <title>**SUBJECT**</title>\n <style type=\"text/css\">\n [EmailCSS]\n </style>\n </head>\n <body leftmargin=\"0\" marginwidth=\"0\" topmargin=\"0\" marginheight=\"0\" offset=\"0\">\n <center>\n <table align=\"center\" border=\"0\" cellpadding=\"0\" cellspacing=\"0\" height=\"100%\" width=\"100%\" id=\"bodyTable\">\n <tr>\n <td align=\"center\" valign=\"top\" id=\"bodyCell\">\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" id=\"templateContainer\">\n <tr>\n <td align=\"center\" valign=\"top\">\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" id=\"templateHeader\">\n <tr>\n <td valign=\"top\" class=\"headerContent\">\n <img src=\"**LOGOURL**\" style=\"max-width:600px;padding:20px 20px 0 20px\" id=\"headerImage\" alt=\"**COMPANYNAME**\" />\n </td>\n </tr>\n </table>\n </td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\">\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" id=\"templateBody\">\n <tr>\n <td valign=\"top\" class=\"bodyContent\">\n **MESSAGE**\n </td>\n </tr>\n </table>\n </td>\n </tr>\n <tr>\n <td align=\"center\" valign=\"top\">\n <table border=\"0\" cellpadding=\"0\" cellspacing=\"0\" width=\"100%\" id=\"templateFooter\">\n <tr>\n <td valign=\"top\" class=\"footerContent\">\n <a href=\"https://www.whmcs.com/\"><img src=\"https://cdn.whmcs.com/images/whmcs_email_footer.png\" id=\"footerImage\" alt=\"WHMCS\" /></a>\n This notification was automatically generated by WHMCS<br />\n <a href=\"**DOMAIN**/\">**DOMAIN**/</a>\n <span class=\"hide-mobile\"> | </span>\n <a href=\"**ADMINURL**\">log in to the admin area</a> \n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </td>\n </tr>\n </table>\n </center>\n </body>\n</html>";
protected static $cssStyling = ".ExternalClass,.ExternalClass div,.ExternalClass font,.ExternalClass p,.ExternalClass span,.ExternalClass td,h1,img{line-height:100%}h1,h2{display:block;font-family:Helvetica;font-style:normal;font-weight:700}#outlook a{padding:0}.ExternalClass,.ReadMsgBody{width:100%}a,blockquote,body,li,p,table,td{-webkit-text-size-adjust:100%;-ms-text-size-adjust:100%}table,td{mso-table-lspace:0;mso-table-rspace:0}img{-ms-interpolation-mode:bicubic;border:0;height:auto;outline:0;text-decoration:none}table{border-collapse:collapse!important}#bodyCell,#bodyTable,body{height:100%!important;margin:0;padding:0;width:100%!important}#bodyCell{padding:20px;}#templateContainer{width:600px;border:1px solid #ddd;background-color:#fff}#bodyTable,body{background-color:#FAFAFA}h1{color:#202020!important;font-size:26px;letter-spacing:normal;text-align:left;margin:0 0 10px}h2{color:#404040!important;font-size:20px;line-height:100%;letter-spacing:normal;text-align:left;margin:0 0 10px}h3,h4{display:block;font-style:italic;font-weight:400;letter-spacing:normal;text-align:left;margin:0 0 10px;font-family:Helvetica;line-height:100%}h3{color:#606060!important;font-size:16px}h4{color:grey!important;font-size:14px}.headerContent{color:#505050;font-family:Helvetica;font-size:20px;font-weight:700;line-height:100%;text-align:left;vertical-align:middle;padding:0}.bodyContent,.footerContent{font-family:Helvetica;line-height:150%;text-align:left;}.bodyContent pre{padding:15px;background-color:#444;color:#f8f8f8;border:0}.bodyContent pre code{white-space:pre;word-break:normal;word-wrap:normal}.bodyContent table{margin:10px 0;background-color:#fff;border:1px solid #ddd}.bodyContent table th{padding:4px 10px;background-color:#f8f8f8;border:1px solid #ddd;font-family:Helvetica;font-size:14px;font-weight:700;text-align:center}.bodyContent table td{padding:3px 8px;border:1px solid #ddd;font-family:Helvetica;font-size:14px}.quoted-content {margin:15px 0;padding:15px;background-color:#f9f9f9;border-radius:4px}.bodyContent table.keyvalue-table{border:0}.bodyContent table.keyvalue-table td{border:0}.table-responsive{border:0}.bodyContent a{word-break:break-all}.headerContent a .yshortcuts,.headerContent a:link,.headerContent a:visited{color:#1f5d8c;font-weight:400;text-decoration:underline}#headerImage{height:auto;max-width:600px;padding:20px 20px 0 20px}#footerImage{float:right;padding:0 0 0 15px}#templateBody{background-color:#fff}.bodyContent{color:#505050;font-size:14px;padding:20px}.bodyContent a .yshortcuts,.bodyContent a:link,.bodyContent a:visited{color:#1f5d8c;font-weight:400;text-decoration:underline}.bodyContent a:hover{text-decoration:none}.bodyContent img{display:inline;height:auto;max-width:560px}.footerContent{background-color:#f8f8f8;color:grey;font-size:10px;padding:20px}.footerContent a .yshortcuts,.footerContent a span,.footerContent a:link,.footerContent a:visited{color:#606060;font-weight:400;text-decoration:underline}@media only screen and (max-width:640px){h1,h2,h3,h4{line-height:100%!important}#templateContainer{max-width:600px!important;width:100%!important}#templateContainer,body{width:100%!important}a,blockquote,body,li,p,table,td{-webkit-text-size-adjust:none!important}body{min-width:100%!important}#bodyCell{padding:10px!important}h1{font-size:24px!important}h2{font-size:20px!important}h3{font-size:18px!important}h4{font-size:16px!important}#templatePreheader{display:none!important}.headerContent{font-size:20px!important;line-height:125%!important}.footerContent{font-size:14px!important;line-height:115%!important}.footerContent a{display:block!important}#footerImage{float:none;padding:0 0 20px 0}.hide-mobile{display:none;}}table.grid-block,table.grid-block table,table.grid-block td{margin:0;padding:0;border:0;background-color:inherit}table.grid-block-inner{background-color:#efefef;}@media only screen and (max-width: 640px){td[class=\"grid-block\"] table{width:100%}td[class=\"grid-block\"] .spacer{display:none}td[class=\"grid-block\"] .row-nopadding{padding:0!important}td[class=\"grid-block\"] .section{display:block;float:left;height:auto;padding:10px 20px;margin-bottom:8px;-moz-box-sizing:border-box;-webkit-box-sizing:border-box;box-sizing:border-box;width:100%}}";
public function getRawHtml()
{
}
public static function getCssStyling()
{
}
public function getPreparedHtml($subject, $message)
{
}
}
}
namespace WHMCS {
class TransientData
{
protected $chunkSize = 62000;
const DB_TABLE = "tbltransientdata";
public static function getInstance()
{
}
public function store($name, $data, $life = 300)
{
}
public function chunkedStore($name, $data, $life = 300)
{
}
protected function clearChunkedStorage($name)
{
}
public function retrieve($name)
{
}
public function retrieveChunkedItem($name)
{
}
public function retrieveByData($data)
{
}
public function ifNameExists($name)
{
}
public function delete($name)
{
}
public function purgeExpired($delaySeconds = 120)
{
}
protected function sqlSelect($name, $exclude_expired = false)
{
}
protected function sqlSelectByData($data, $exclude_expired = false)
{
}
protected function sqlInsert($name, $data, $expires)
{
}
protected function sqlUpdate($name, $data, $expires)
{
}
public function sqlDelete($name)
{
}
}
class ListTable
{
public function __construct(\WHMCS\Pagination $obj, $tableCount = 0, \WHMCS\Admin $adminInterface = NULL)
{
}
public function getPageObj()
{
}
public function setPagination($boolean)
{
}
public function isPaginated()
{
}
public function setMassActionURL($url)
{
}
public function getMassActionURL()
{
}
public function setMassActionBtns($btns)
{
}
public function getMassActionBtns()
{
}
public function setShowMassActionBtnsTop($boolean)
{
}
public function getShowMassActionBtnsTop()
{
}
public function setColumns($array)
{
}
public function getColumns()
{
}
public function addRow($array)
{
}
public function addExpandRow($output)
{
}
public function getRows()
{
}
public function outputTableHeader()
{
}
public function outputTable()
{
}
public function outputTablePagination()
{
}
public function addOutput($content)
{
}
public function output()
{
}
protected function getHiddenOutput()
{
}
protected function getPageDropdown()
{
}
protected function dropdownOption($pageNumber)
{
}
public function setShowHidden($state)
{
}
public function isShowingHidden()
{
}
}
class MobileListTable extends \WHMCS\ListTable
{
public function addTableHeadOutput($html)
{
}
public function outputTableHeader()
{
}
public function outputTable()
{
}
public function outputTablePagination()
{
}
}
}
namespace WHMCS\ClientArea {
class ClientAreaServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider implements \WHMCS\Route\Contracts\ProviderInterface
{
use \WHMCS\Route\ProviderTrait;
protected function getRoutes()
{
}
public function registerRoutes(\FastRoute\RouteCollector $routeCollector)
{
}
public function register()
{
}
}
class UpgradeController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function addToCart(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class ClientAreaController
{
public function homePage(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function loginWithRedirect(\Psr\Http\Message\ServerRequestInterface $request)
{
}
protected function getAnnouncements()
{
}
public function sslPurchase(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function displayImage(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\ClientArea\Account {
class PaymentMethodsController
{
protected function initView()
{
}
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function add(\WHMCS\Http\Message\ServerRequest $request, $payMethod = NULL)
{
}
public function initToken(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function create(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function manage(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function save(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function setDefault(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function delete(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getBillingContacts(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function createBillingContact(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class AccountController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class AccountRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\ProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
public function registerRoutes(\FastRoute\RouteCollector $routeCollector)
{
}
}
}
namespace WHMCS\ClientArea\Invoice {
class InvoiceController
{
protected $userDetailsValidationError = false;
public function pay(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function payBank(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\Invoice $invoice = NULL, $errorMessage = "")
{
}
protected function payCard(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\Invoice $invoice, $errorMessage = "")
{
}
public function process(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function processCardFromCart(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function validateBank(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\Invoice $invoice)
{
}
protected function validateCard(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\Invoice $invoice, $fromOrderForm = false)
{
}
protected function processPayment(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\Invoice $invoice, \WHMCS\Payment\PayMethod\Model $payMethod, $fromOrderForm = false)
{
}
protected function checkAccess(\WHMCS\Invoice $invoice)
{
}
protected function initView($hookFunctionName = "ClientAreaPageBankAccountCheckout")
{
}
}
class InvoiceRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\ProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\ClientArea {
class PasswordResetController
{
public function emailPrompt(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function validateEmail(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function useKey(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function securityPrompt(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function securityValidate(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function changePrompt(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function changePerform(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Cart\Controller {
class DomainController
{
protected function startOrderForm()
{
}
protected function endOrderForm()
{
}
public function singleRenew(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function massRenew(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function addRenewal()
{
}
public function calcRenewalCartTotals()
{
}
}
}
namespace WHMCS\Cart\Item {
abstract class AbstractItem
{
public $id = NULL;
public $name = NULL;
public $billingCycle = NULL;
public $billingPeriod = 1;
public $qty = 1;
public $amount = NULL;
public $recurring = NULL;
public $taxed = false;
public $initialPeriod = 0;
public $initialCycle = NULL;
public function setId($id)
{
}
public function setName($name)
{
}
public function setBillingCycle($billingCycle)
{
}
public function setBillingPeriod($billingPeriod)
{
}
public function setQuantity($qty)
{
}
public function setAmount(\WHMCS\View\Formatter\Price $amount)
{
}
public function setRecurring(\WHMCS\View\Formatter\Price $recurring = NULL)
{
}
public function setTaxed($taxed)
{
}
public function setInitialPeriod($period, $cycle)
{
}
public function hasInitialPeriod()
{
}
}
class Product extends \WHMCS\Cart\Item\AbstractItem
{
}
class Domain extends \WHMCS\Cart\Item\AbstractItem
{
}
class Item extends \WHMCS\Cart\Item\AbstractItem
{
}
class Addon extends \WHMCS\Cart\Item\AbstractItem
{
}
}
namespace WHMCS\Cart {
class Cart
{
public $invoiceId = 0;
public $items = array();
public $total = NULL;
public $taxCalculator = NULL;
public $client = NULL;
public static function fromSession()
{
}
public function setInvoiceId($invoiceId)
{
}
public function getInvoiceModel()
{
}
public function setClient(\WHMCS\User\Client $client = NULL)
{
}
public function setItems($items)
{
}
public function setTotal(\WHMCS\View\Formatter\Price $total)
{
}
public function getFirstRecurringItem()
{
}
public function isRecurring()
{
}
public function getRecurringTotals()
{
}
public function getRecurringTotal()
{
}
public function setTaxCalculator(\WHMCS\Billing\Tax $taxCalculator)
{
}
public function getTaxCalculator(\WHMCS\User\Client $client)
{
}
public function applyTax()
{
}
public function getDescription()
{
}
public function applyClientGroupDiscount()
{
}
public function getTotal()
{
}
}
class CartServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider implements \WHMCS\Route\Contracts\ProviderInterface
{
use \WHMCS\Route\ProviderTrait;
protected function getRoutes()
{
}
public function registerRoutes(\FastRoute\RouteCollector $routeCollector)
{
}
public function register()
{
}
}
}
namespace WHMCS\Log {
class ActivityLogHandler extends \Monolog\Handler\AbstractProcessingHandler
{
protected function write(array $record)
{
}
}
interface RegisterInterface
{
public function __toString();
public function toArray();
public function toJson();
public function getName();
public function setName($name);
public function getNamespace();
public function setNamespace($key);
public function getNamespaceId();
public function setNamespaceId($id);
public function setValue($value);
public function getValue();
public function write($value);
public function latestByNamespaces(array $namespaces, $id);
}
class Register extends \Illuminate\Database\Eloquent\Model implements \WHMCS\Log\RegisterInterface
{
protected $table = "tbllog_register";
protected static $unguarded = true;
public function createTable($drop = false)
{
}
public function getName()
{
}
public function setName($name)
{
}
public function getNamespaceId()
{
}
public function setNamespaceId($id)
{
}
public function getNamespace()
{
}
public function setNamespace($key)
{
}
public function setValue($value)
{
}
public function getValue()
{
}
public function latestByNamespaces(array $namespaces, $id = NULL)
{
}
public function sinceByNamespace(\WHMCS\Carbon $since, array $namespaces, $id = NULL)
{
}
public function scopeOnDateByNamespaceId(\Illuminate\Database\Eloquent\Builder $query, \WHMCS\Carbon $on, $id)
{
}
public function scopeActionDetails(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function write($value)
{
}
}
}
namespace WHMCS\Log\Register {
class DailyCronReport extends \WHMCS\Log\Register
{
public function __construct(array $attributes = array())
{
}
public function getValue()
{
}
public function setValue($value)
{
}
public function write($value)
{
}
protected function taskToArray(\WHMCS\Scheduling\Task\TaskInterface $task, $completed = true)
{
}
public function start()
{
}
public function finish()
{
}
public function completed(\WHMCS\Scheduling\Task\TaskInterface $task)
{
}
public function notCompleted(\WHMCS\Scheduling\Task\TaskInterface $task)
{
}
public function taskDataToHtml(array $taskData)
{
}
public function toHtmlDigest()
{
}
protected function updateAvailableInfoAlert($data)
{
}
protected function cronStatus($data)
{
}
protected function taskStatus($data)
{
}
protected function viewSummaryLink()
{
}
protected function moduleQueueStatus($data)
{
}
}
}
namespace WHMCS\Log {
class LogServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider
{
public function register()
{
}
public function factoryDefaultChannelLogger()
{
}
protected function importLogHandlers($baseDirectory = NULL)
{
}
}
interface LoggerAwareInterface extends \Psr\Log\LoggerAwareInterface
{
public function getLogger();
}
class Activity
{
protected $criteria = array();
protected $outputFormatting = true;
public function setOutputFormatting($enable)
{
}
public function getOutputFormatting()
{
}
public function prune()
{
}
public function setCriteria($where)
{
}
public function getCriteria($key)
{
}
protected function buildCriteria()
{
}
public function getTotalCount()
{
}
public function getLogEntries($page = 0, $limit = 0)
{
}
public function autoLink($description)
{
}
}
}
namespace WHMCS\Api\V1 {
class Api
{
protected $adminId = 0;
protected $action = NULL;
protected $params = array();
protected $status = NULL;
protected $response = array();
protected $registerLocalVars = false;
protected $request = NULL;
protected $isAdminUserRequired = true;
public function getIsAdminUserRequired()
{
}
public function setIsAdminUserRequired($isAdminUserRequired)
{
}
public function getRequest()
{
}
public function setRequest($request)
{
}
public function __construct()
{
}
public function setAction($action)
{
}
protected function getAction()
{
}
public function setAdminUser($user)
{
}
protected function getAdminUser()
{
}
public function setParam($name, $value)
{
}
public function setParams(array $params)
{
}
protected function getParams()
{
}
protected function executeApiCall()
{
}
public function call($action = "")
{
}
public function get($key)
{
}
public function getResults()
{
}
public function getRegisterLocalVars()
{
}
public function setRegisterLocalVars($registerLocalVars)
{
}
}
}
namespace WHMCS {
class Api extends \WHMCS\Api\V1\Api
{
}
}
namespace WHMCS\Apps {
class Feed
{
protected $cacheTimeout = 604800;
protected $feed = array();
public function __construct()
{
}
protected function loadFeed()
{
}
protected function loadFromCache()
{
}
protected function fetchFromRemote()
{
}
public function heros()
{
}
public function categories()
{
}
public function apps()
{
}
public function additionalApps()
{
}
}
}
namespace WHMCS\Apps\Meta\Schema {
class AbstractVersion
{
public $metaData = array();
public function __construct(array $metaData)
{
}
protected function meta($key)
{
}
}
}
namespace WHMCS\Apps\Meta\Schema\Version1 {
class Local extends \WHMCS\Apps\Meta\Schema\AbstractVersion
{
public function getType()
{
}
public function getName()
{
}
public function getVersion()
{
}
public function getLicense()
{
}
public function getCategory()
{
}
public function getDisplayName()
{
}
public function getTagline()
{
}
public function getShortDescription()
{
}
public function getLongDescription()
{
}
public function getFeatures()
{
}
public function getLogoFilename()
{
}
public function getLogoBase64()
{
}
public function getMarketplaceUrl()
{
}
public function getAuthors()
{
}
public function getHomepageUrl()
{
}
public function getLearnMoreUrl()
{
}
public function getSupportEmail()
{
}
public function getSupportUrl()
{
}
public function getDocumentationUrl()
{
}
}
class Remote extends \WHMCS\Apps\Meta\Schema\Version1\Local
{
public function getLogoAssetFilename()
{
}
public function getLogoRemoteUri()
{
}
public function getPurchaseFreeTrialDays()
{
}
public function getPurchasePrice()
{
}
public function getPurchaseCurrency()
{
}
public function getPurchaseTerm()
{
}
public function getPurchaseUrl()
{
}
public function isFeatured()
{
}
public function isPopular()
{
}
public function isUpdated()
{
}
public function getKeywords()
{
}
public function getWeighting()
{
}
public function isHidden()
{
}
}
}
namespace WHMCS\Apps\Meta\Sources {
class RemoteFeed
{
public function getAdditionalApps()
{
}
public function getAppByModuleName($moduleType, $moduleName)
{
}
protected function getSchemaMajorVersion($metaData)
{
}
public function parseJson($metaData)
{
}
}
class LocalFile
{
public static function build($filePath)
{
}
public function load($filePath)
{
}
protected function getSchemaMajorVersion($data)
{
}
public function parseJson($data)
{
}
}
}
namespace WHMCS\Apps\Meta {
class MetaData
{
protected $localMetaData = NULL;
protected $remoteMetaData = NULL;
public static function factoryFromModule($moduleInterface, $moduleName)
{
}
public static function factoryFromRemoteFeed($feed)
{
}
protected function get($method, $allowLocal = true)
{
}
public function getType()
{
}
public function getName()
{
}
public function getVersion()
{
}
public function getLicense()
{
}
public function getCategory()
{
}
public function getDisplayName()
{
}
public function getTagline()
{
}
public function getShortDescription()
{
}
public function getLongDescription()
{
}
public function getFeatures()
{
}
public function getLogoFilename()
{
}
public function getLogoBase64()
{
}
public function getLogoAssetFilename()
{
}
public function getLogoRemoteUri()
{
}
public function getMarketplaceUrl()
{
}
public function getAuthors()
{
}
public function getHomepageUrl()
{
}
public function getLearnMoreUrl()
{
}
public function getSupportEmail()
{
}
public function getSupportUrl()
{
}
public function getDocumentationUrl()
{
}
public function getPurchaseFreeTrialDays()
{
}
public function getPurchasePrice()
{
}
public function getPurchaseCurrency()
{
}
public function getPurchaseTerm()
{
}
public function getPurchaseUrl()
{
}
public function isFeatured()
{
}
public function isPopular()
{
}
public function isUpdated()
{
}
public function getKeywords()
{
}
public function getWeighting()
{
}
public function isHidden()
{
}
}
}
namespace WHMCS\Apps\App {
class Model
{
protected $moduleInterface = NULL;
protected $moduleType = NULL;
protected $moduleName = NULL;
protected $metaData = NULL;
protected $managementObj = NULL;
const MISSING_TAGLINE = "No description available.";
const MISSING_ICON_PATH = "assets/img/module/missing_icon.png";
public static function factoryFromModule($moduleInterface, $moduleName)
{
}
public static function factoryFromRemoteFeed($metaData)
{
}
public function getKey()
{
}
protected function getModuleInterface()
{
}
public function isActive()
{
}
public function isInstalledLocally()
{
}
public function getActivationForms()
{
}
public function getManagementForms()
{
}
public function getModuleType()
{
}
public function getModuleName()
{
}
public function getType()
{
}
public function getName()
{
}
public function hasVersion()
{
}
public function getVersion()
{
}
public function hasLogo()
{
}
public function getLogoFilename()
{
}
public function getLogoRemoteUri()
{
}
public function getLogoContent()
{
}
public function getDisplayName()
{
}
public function getCategory()
{
}
public function getCategoryModel()
{
}
public function getCategoryDisplayName()
{
}
public function getTagline()
{
}
public function getLongDescription()
{
}
public function hasFeatures()
{
}
public function getFeatures()
{
}
public function requiresPurchase()
{
}
public function hasPurchaseFreeTrial()
{
}
public function getPurchaseFreeTrialDays()
{
}
public function getPurchasePrice()
{
}
public function getPurchaseCurrency()
{
}
public function getPurchaseCurrencySymbol()
{
}
public function getPurchaseTerm()
{
}
public function getPurchaseUrl()
{
}
public function requiresLicense()
{
}
public function isLicensed()
{
}
public function isFeatured()
{
}
public function isPopular()
{
}
public function isUpdated()
{
}
protected function addGaTracking($url)
{
}
public function getAuthors()
{
}
public function getHomepageUrl()
{
}
public function getSupportEmail()
{
}
public function getSupportUrl()
{
}
public function getDocumentationUrl()
{
}
public function getLearnMoreUrl()
{
}
public function getMarketplaceUrl()
{
}
public function getKeywords()
{
}
public function isVisible()
{
}
public function isHidden()
{
}
}
class Collection
{
protected $apps = NULL;
public function __construct()
{
}
protected function initialiseApps()
{
}
public function all()
{
}
public function exists($appKey)
{
}
public function get($appKey)
{
}
public function active()
{
}
}
}
namespace WHMCS\Apps\App\Utility {
class AppHelper
{
protected $excludedFromActiveApps = array("servers.marketconnect");
public function isExcludedFromActiveList($appKey)
{
}
public function getNonModuleActivationForms($moduleType, $moduleName)
{
}
public function getNonModuleManagementForms($moduleType, $moduleName)
{
}
public function isNonModuleActive($moduleType, $moduleName)
{
}
}
}
namespace WHMCS\Apps\Category {
class Model
{
protected $data = NULL;
public function __construct($data)
{
}
public function getSlug()
{
}
public function getDisplayName()
{
}
public function getTagline()
{
}
public function getModuleType()
{
}
public function getFeatured()
{
}
public function getExclusions()
{
}
public function getAdditions()
{
}
public function getIcon()
{
}
public function includeInHomeFeatured()
{
}
public function getHomeFeaturedNumApps()
{
}
public function getFeaturedAppKeys()
{
}
public function getFeaturedApps($apps)
{
}
public function getFeaturedAppsForHome($apps)
{
}
protected function getAllApps($apps)
{
}
public function getNonFeaturedApps($apps)
{
}
}
class Collection
{
public $categories = array();
public function __construct()
{
}
public function all()
{
}
public function first()
{
}
public function homeFeatured()
{
}
public function getCategoryBySlug($slug)
{
}
public function getAllFeaturedKeys()
{
}
}
}
namespace WHMCS\Apps\Hero {
class Model
{
public $data = NULL;
public function __construct($data)
{
}
public function getImageUrl()
{
}
public function hasTargetAppKey()
{
}
public function getTargetAppKey()
{
}
public function hasRemoteUrl()
{
}
public function getRemoteUrl()
{
}
}
class Collection
{
public $heros = NULL;
public function __construct()
{
}
public function get()
{
}
}
}
namespace WHMCS {
class Filter
{
public function __construct($filterName = "")
{
}
public function isActive()
{
}
public function setAllowedVars($allowedvars)
{
}
public function addAllowedVar($var)
{
}
public function getFromReq($var)
{
}
public function getFromSession($var)
{
}
public function get($var)
{
}
public function store()
{
}
public function redir($vars = "")
{
}
public function getFilterCriteria()
{
}
}
class Init
{
protected $input = array();
protected $last_input = NULL;
protected $clean_variables = array("int" => array("id", "userid", "kbcid", "invoiceid", "idkb", "currency", "currencyid"), "a-z" => array("systpl", "language"), "a-z_" => array("carttpl"));
protected $license = "";
protected $db_host = "";
protected $db_username = "";
protected $db_password = "";
protected $db_name = "";
protected $db_sqlcharset = "";
protected $cc_hash = "";
protected $templates_compiledir = "";
protected $customadminpath = "";
public $remote_ip = "";
protected $protected_variables = array("whmcs", "smtp_debug", "attachments_dir", "downloads_dir", "customadminpath", "mysql_charset", "overidephptimelimit", "orderform", "smartyvalues", "usingsupportmodule", "copyrighttext", "adminorder", "revokelocallicense", "allow_idn_domains", "templatefile", "_LANG", "_ADMINLANG", "display_errors", "debug_output", "mysql_errors", "moduleparams", "errormessage", "where");
public function init()
{
}
public function load_function($name)
{
}
public function sanitize_input_vars($arr)
{
}
public function replace_input($array)
{
}
public function reset_input()
{
}
public function isInRequest($key, $key2 = "")
{
}
public function getFromRequest($key, $key2 = "")
{
}
public function get_req_var($k, $k2 = "")
{
}
public function get_req_var_if($e, $key, $fallbackarray, $fallbackarraykey = "", $key2 = "")
{
}
protected function load_input()
{
}
public function clean_param_array(array $params)
{
}
protected function clean_input()
{
}
public function sanitize($type, $var)
{
}
public function get_license_key()
{
}
public function set_config($key, $value)
{
}
public function get_config($key)
{
}
public function get_template_compiledir_name()
{
}
public function check_template_cache_writeable()
{
}
public function get_admin_folder_name()
{
}
public function get_filename()
{
}
public function get_hash()
{
}
protected function validate_templates()
{
}
public function get_lang($var)
{
}
public function in_ssl()
{
}
public function getCurrencyID()
{
}
public function formatPostedPhoneNumber($field = "phonenumber")
{
}
}
class Application extends \WHMCS\Init
{
protected $clientTemplate = NULL;
protected $dangerousVariables = array("_GET", "_POST", "_REQUEST", "_SERVER", "_COOKIE", "_FILES", "_ENV", "GLOBALS");
protected $phpSelf = NULL;
const FILES_VERSION = "7.10.2-release.1";
const RELEASE_DATE = "2020-05-19";
public function __construct(\WHMCS\Config\AbstractConfig $config, \WHMCS\Database $database = NULL)
{
}
public static function getInstance()
{
}
protected function loadDatabase(\WHMCS\Database $database = NULL)
{
}
public function importConfig(\WHMCS\Config\AbstractConfig $config)
{
}
public function getLicense()
{
}
public function getLicenseClientKey()
{
}
public function setPhpSelf($script)
{
}
public function getPhpSelf()
{
}
public function setRemoteIp($ip)
{
}
public function getRemoteIp()
{
}
public function getDatabaseObj()
{
}
public function getApplicationConfig()
{
}
public function getAttachmentsDir()
{
}
public function getDownloadsDir()
{
}
public function getTemplatesCacheDir()
{
}
public function getCronDirectory()
{
}
public function redirect($path = NULL, $vars = array(), $prefix = "")
{
}
public function getRedirectUrl($path, $vars = array(), $prefix = "")
{
}
public function redirectSystemURL($path = "", $vars = "")
{
}
public function redirectToRoutePath($route, $routeVariables = array(), $queryParameters = NULL)
{
}
public function initInputs()
{
}
protected function registerGlobalVariable($globalVariableName, $globalVariableValue)
{
}
protected function register_globals()
{
}
protected function loadAdminDefinedConfigurations()
{
}
public function isVisitorIPBanned()
{
}
protected function shouldRedirectForIPBan()
{
}
public function getWHMCSInstanceID()
{
}
protected function createWHMCSInstanceID()
{
}
public function getCurrentFilename($stripExtension = true)
{
}
public function getSystemURL($withTrailing = true)
{
}
public function getSystemSSLURL()
{
}
public function getSystemSSLURLOrFail()
{
}
public function isSSLAvailable()
{
}
public function isApiRequest()
{
}
public function isClientAreaRequest()
{
}
public function isAdminAreaRequest()
{
}
public function isExecutingViaCron()
{
}
public function getClientAreaTemplate()
{
}
public function getVersion()
{
}
public function getDBVersion()
{
}
public function doFileAndDBVersionsNotMatch()
{
}
public function getReleaseDate()
{
}
public function setMaintenanceMode()
{
}
public function unsetMaintenanceMode()
{
}
public function isInMaintenanceMode()
{
}
public function isUpdateAvailable()
{
}
public function isUpdating()
{
}
public function getLogoUrlForEmailTemplate()
{
}
}
}
namespace WHMCS\Search {
interface SearchInterface
{
public function search($searchTerm);
}
class Client implements \WHMCS\Search\SearchInterface
{
public function search($searchTerm = NULL)
{
}
public function fuzzySearch($searchTerm, $clientId = NULL)
{
}
}
class IntelligentSearch implements \WHMCS\Search\SearchInterface
{
protected $searchTerm = "";
protected $numResults = 10;
protected $more = "";
protected $hideInactive = 0;
const TYPE_CLIENT = "client";
const TYPE_CONTACT = "contact";
const TYPE_SERVICE = "service";
const TYPE_DOMAIN = "domain";
const TYPE_INVOICE = "invoice";
const TYPE_TICKET = "ticket";
const TYPE_OTHER = "other";
public function search($searchInput = array())
{
}
protected function searchClients()
{
}
protected function searchContacts()
{
}
protected function searchServices()
{
}
protected function searchDomains()
{
}
protected function searchInvoices()
{
}
protected function searchTickets()
{
}
}
class IntelligentSearchAutoSearch
{
const SESSION_STORAGE_NAME = "intelligentSearchAutoSearch";
public static function isEnabled()
{
}
public static function setStatus($enabled)
{
}
}
class Contact implements \WHMCS\Search\SearchInterface
{
public function search($searchTerm = NULL)
{
}
public function fuzzySearch($searchTerm, \WHMCS\User\Client $client)
{
}
}
}
namespace WHMCS\Search\ApplicationSupport\Controller {
interface SearchInterface
{
public function searchRequest(\WHMCS\Http\Message\ServerRequest $request);
}
}
namespace WHMCS {
class TokenManager
{
protected $namespaceSettings = array();
protected $defaultNamespaceValue = true;
public static function init(\WHMCS\Init $whmcs)
{
}
public function __construct()
{
}
public function getToken()
{
}
public function setToken($token)
{
}
public function conditionallySetToken()
{
}
public function generateToken($type = "form")
{
}
public function checkToken($namespace = "WHMCS.default", $token = NULL)
{
}
public function handleInvalidToken()
{
}
public function isValidToken($token = "")
{
}
public function getDefaultNamespaceSettings()
{
}
public function getStoredNamespaceSettings($whmcs)
{
}
public function setStoredNamespaceSettings($whmcs, $namespace_settings)
{
}
public function getNamespaceSettings()
{
}
public function setNamespaceSettings($namespace_settings)
{
}
public function getNamespaceValue($namespace)
{
}
public function generateAdminConfigurationHTMLRows($aInt)
{
}
protected function htmlRow($aInt, $key, $value, $whmcs_default = NULL, $show = true)
{
}
public function processAdminHTMLSave($whmcs)
{
}
protected function processOneNamespaceRequest($whmcs, $key)
{
}
}
class Clients extends \WHMCS\TableModel
{
public function _execute($criteria = NULL)
{
}
public function getClients($criteria = array())
{
}
public function getGroups()
{
}
public function getNumberOfOpenCancellationRequests()
{
}
}
class Mail extends \PHPMailer\PHPMailer\PHPMailer
{
protected $decodeAltBodyOnSend = true;
protected static $validEncodings = array("8bit", "7bit", "binary", "base64", "quoted-printable");
public function __construct($name = "", $email = "")
{
}
public function setSenderNameAndEmail($name, $email)
{
}
protected function serverHostname()
{
}
public static function getValidEncodings()
{
}
protected function setEncoding($config_value = 0)
{
}
protected function addAnAddress($kind, $address, $name = "")
{
}
public function send()
{
}
public function sendMessage(\WHMCS\Mail\Message $message)
{
}
}
}
namespace WHMCS\Application {
class ApplicationServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider
{
public function register()
{
}
public static function checkVersion()
{
}
public static function isVersionBumpValid(\WHMCS\Version\SemanticVersion $fileVersion, \WHMCS\Version\SemanticVersion $databaseVersion)
{
}
}
}
namespace WHMCS\Application\Support\Controller {
trait DelegationTrait
{
public function redirect(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function redirectTo($pathData, \WHMCS\Http\Message\ServerRequest $request)
{
}
protected function delegateTo($pathData, \WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Application\Support\Facades {
class Facade extends \Illuminate\Support\Facades\Facade
{
public static function self()
{
}
}
class Config extends \WHMCS\Application\Support\Facades\Facade
{
protected static function getFacadeAccessor()
{
}
}
class Di extends \Illuminate\Support\Facades\Facade
{
protected static function getFacadeAccessor()
{
}
}
class AdminLang extends \WHMCS\Application\Support\Facades\Facade
{
protected static function getFacadeAccessor()
{
}
}
class Storage extends \WHMCS\Application\Support\Facades\Facade
{
protected static function getFacadeAccessor()
{
}
}
class Menu extends \WHMCS\Application\Support\Facades\Facade
{
protected static function getFacadeAccessor()
{
}
}
class Lang extends \WHMCS\Application\Support\Facades\Facade
{
protected static function getFacadeAccessor()
{
}
}
class App extends \WHMCS\Application\Support\Facades\Facade
{
protected static function getFacadeAccessor()
{
}
}
class Log extends \WHMCS\Application\Support\Facades\Facade
{
protected static function getFacadeAccessor()
{
}
}
}
namespace WHMCS\Authorization\Rbac {
trait PermissionTrait
{
protected $permissionData = array();
public function setData(array $data = array())
{
}
public function getData()
{
}
public function isAllowed($item)
{
}
public function listAll()
{
}
}
trait RoleTrait
{
use \WHMCS\Authorization\Rbac\PermissionTrait;
public function allow(array $itemsToAllow = array())
{
}
public function deny(array $itemsToDeny = array())
{
}
}
}
namespace WHMCS\Authorization\Contracts {
interface PermissionInterface
{
public function isAllowed($item);
public function listAll();
}
}
namespace WHMCS\Authorization\Rbac {
class AccessList implements \WHMCS\Authorization\Contracts\PermissionInterface
{
use \WHMCS\Authorization\Rbac\PermissionTrait {
setData as _setData;
}
public function __construct(array $rbacs = array())
{
}
protected function mergePermissions(array $permissionsToMerge)
{
}
public function toJson($options = 0)
{
}
public function __toString()
{
}
public function setData(array $data = array())
{
}
}
}
namespace WHMCS\Authorization\Contracts {
interface RoleInterface
{
public function getId();
public function allow(array $itemsToAllow);
public function deny(array $itemsToDeny);
public function getData();
public function setData(array $data);
}
}
namespace WHMCS\Authorization\Rbac {
abstract class AbstractRole extends \WHMCS\Model\AbstractModel implements \WHMCS\Authorization\Contracts\PermissionInterface, \WHMCS\Authorization\Contracts\RoleInterface
{
use \WHMCS\Authorization\Rbac\RoleTrait;
public $timestamps = true;
protected $primaryKey = "id";
protected $casts = array("permissions" => "json");
protected $fillable = array("permissions", "role", "description");
public function createTable($drop = false)
{
}
public static function boot()
{
}
public function newFromBuilder($attributes = array(), $connection = NULL)
{
}
public function getId()
{
}
}
}
namespace WHMCS\Api\V1 {
class Catalog
{
protected $groups = array();
protected $actions = array();
const SETTING_API_CATALOG = "ApiCatalog";
const GROUP_ADDONS = "Addons";
const GROUP_AFFILIATES = "Affiliates";
const GROUP_AUTHENTICATION = "Authentication";
const GROUP_BILLING = "Billing";
const GROUP_CLIENT = "Client";
const GROUP_CUSTOM = "Custom";
const GROUP_DOMAINS = "Domains";
const GROUP_MODULE = "Module";
const GROUP_ORDERS = "Orders";
const GROUP_PRODUCTS = "Products";
const GROUP_PMA = "Project-Management";
const GROUP_SERVERS = "Servers";
const GROUP_SERVICE = "Service";
const GROUP_SUPPORT = "Support";
const GROUP_TICKETS = "Tickets";
const GROUP_SYSTEM = "System";
public function __construct(array $data = array())
{
}
public function getGroups()
{
}
public function setGroups($groups)
{
}
public function getActions()
{
}
public function setActions($actions)
{
}
public function toJson($options = 0)
{
}
public function toArray()
{
}
public function getGroupedActions()
{
}
public static function get()
{
}
public static function factoryApiRole(\WHMCS\Api\V1\Catalog $catalog, $permissionClass = "WHMCS\\Api\\Authorization\\ApiRole")
{
}
public static function add(array $actions = array(), array $groups = array())
{
}
public static function store(\WHMCS\Api\V1\Catalog $catalog = NULL)
{
}
public static function normalize(\WHMCS\Api\V1\Catalog $catalog)
{
}
public static function defaultCatalog()
{
}
}
}
namespace WHMCS\Api\Log {
class RequestResponseProcessor
{
protected $variablesToMask = array("password", "Password", "secret", "password2", "hash", "accesshash", "access_hash", "cc_encryption_hash", "accesskey");
protected $loggableAttributes = NULL;
public function formatRequestResponse(array $record)
{
}
public function processorResponseMetadata(array $record)
{
}
public function __invoke(array $record)
{
}
}
class Handler extends \Monolog\Handler\AbstractProcessingHandler
{
protected $isHandling = false;
public function __construct($level = \Monolog\Logger::DEBUG, $bubble = true)
{
}
public function write(array $record)
{
}
protected function isDebugEnabled()
{
}
public function isHandling(array $record)
{
}
}
class Log extends \WHMCS\Model\AbstractModel
{
protected $table = "tblapilog";
protected $guarded = array();
public function createTable($drop = false)
{
}
}
}
namespace WHMCS\Api\Authorization {
class ApiRole extends \WHMCS\Authorization\Rbac\AbstractRole
{
protected $table = "tblapi_roles";
}
}
namespace WHMCS\Api {
class ApiServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider implements \WHMCS\Route\Contracts\ProviderInterface
{
use \WHMCS\Route\ProviderTrait;
public function register()
{
}
public function getRoutes()
{
}
public function registerRoutes(\FastRoute\RouteCollector $routeCollector)
{
}
}
}
namespace WHMCS\Api\ApplicationSupport\ApplicationLinks {
trait ClientUserTrait
{
private $user = NULL;
public function setClientUser($user)
{
}
public function getClientUser()
{
}
}
}
namespace WHMCS\Api\ApplicationSupport\ApplicationLinks\GrantType {
class ClientOtp extends \WHMCS\ApplicationLink\GrantType\SingleSignOn
{
use \WHMCS\Api\ApplicationSupport\ApplicationLinks\ClientUserTrait;
public function getUserId()
{
}
}
}
namespace WHMCS\Api\ApplicationSupport\ApplicationLinks\Server {
class ClientAccessSsoToken extends \WHMCS\ApplicationLink\Server\Server implements \WHMCS\ApplicationLink\Server\ApplicationLinkServerInterface
{
use \WHMCS\Api\ApplicationSupport\ApplicationLinks\ClientUserTrait;
public function getClientOtpGrant()
{
}
public function handleTokenRequest(\OAuth2\RequestInterface $request, \OAuth2\ResponseInterface $response = NULL)
{
}
protected function getAuthenticatedClientId()
{
}
protected function preProcessHandleTokenRequest(\OAuth2\HttpFoundationBridge\Request $request, \OAuth2\HttpFoundationBridge\Response $response = NULL)
{
}
protected function postProcessHandleTokenRequest(\OAuth2\ResponseInterface $response, \OAuth2\HttpFoundationBridge\Request $request)
{
}
protected function updateTokenForScope(\OAuth2\HttpFoundationBridge\Request $request, $id)
{
}
}
}
namespace WHMCS\Api\ApplicationSupport\Http {
class ResponseFactory
{
const RESPONSE_FORMAT_NVP = "nvp";
const RESPONSE_FORMAT_XML = "xml";
const RESPONSE_FORMAT_JSON = "json";
const RESPONSE_FORMAT_DEFAULT_HIGHLY_STRUCTURED = self::RESPONSE_FORMAT_XML;
const RESPONSE_FORMAT_DEFAULT_BASIC_STRUCTURED = self::RESPONSE_FORMAT_NVP;
public static function factory(\WHMCS\Api\ApplicationSupport\Http\ServerRequest $request, array $responseData, $statusCode = \Symfony\Component\HttpFoundation\Response::HTTP_OK)
{
}
public static function getSupportedResponseTypes()
{
}
public static function isValidResponseType($type)
{
}
public static function isTypeHighlyStructured($type)
{
}
}
}
namespace WHMCS\Http\Message {
class ServerRequest extends \Zend\Diactoros\ServerRequest
{
protected $queryBag = NULL;
protected $requestBag = NULL;
protected $attributesBag = NULL;
public static function fromGlobals(array $server = NULL, array $query = NULL, array $body = NULL, array $cookies = NULL, array $files = NULL)
{
}
public function withQueryParams(array $query)
{
}
public function query()
{
}
public function withParsedBody($data)
{
}
public function request()
{
}
public function getResponseType()
{
}
public function expectsJsonResponse()
{
}
public function isAdminRequest()
{
}
public function isApiRequest()
{
}
public function isXHR()
{
}
public function withAttribute($attribute, $value)
{
}
public function withoutAttribute($attribute)
{
}
public function attributes()
{
}
public function has($key)
{
}
public function get($key, $default = NULL)
{
}
}
}
namespace WHMCS\Api\ApplicationSupport\Http {
class ServerRequest extends \WHMCS\Http\Message\ServerRequest
{
public function __clone()
{
}
public static function fromGlobals(array $server = NULL, array $query = NULL, array $body = NULL, array $cookies = NULL, array $files = NULL)
{
}
protected function seedAttributes()
{
}
public function getAction()
{
}
public function getResponseFormat()
{
}
public function isDeviceAuthentication()
{
}
public function getIdentifier()
{
}
public function getSecret()
{
}
public function getUsername()
{
}
public function getPassword()
{
}
public function getAccessKey()
{
}
}
}
namespace WHMCS\Route\Contracts\Middleware {
interface StrategyInterface extends \Interop\Http\ServerMiddleware\MiddlewareInterface
{
public function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate);
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate);
}
}
namespace WHMCS\Route\Middleware\Strategy {
abstract class DelegatingMiddlewareTrait
{
public abstract function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate);
public function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
}
namespace WHMCS\Api\ApplicationSupport\Route\Middleware {
class HandleProcessor implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\DelegatingMiddlewareTrait;
public function getApiFilePath(\WHMCS\Api\ApplicationSupport\Http\ServerRequest $request)
{
}
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function getV1Api()
{
}
public function processV1Request(\WHMCS\Api\ApplicationSupport\Http\ServerRequest $request)
{
}
}
}
namespace WHMCS\Route\Middleware\Strategy {
abstract class AssumingMiddlewareTrait
{
public abstract function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate);
public function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
}
namespace WHMCS\Api\ApplicationSupport\Route\Middleware {
class ActionFilter implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
protected $apiFunctionsRestrictedToLocalApi = array("setconfigurationvalue");
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function isRestrictedToLocalApi(\WHMCS\Api\ApplicationSupport\Http\ServerRequest $request)
{
}
protected function resolveLegacyAction($action = "")
{
}
}
class Authentication implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\DelegatingMiddlewareTrait;
protected $processLogin = true;
public function disableProcessLogin()
{
}
public function verifyDeviceCredentials($userProvidedIdentifier, $userProvidedSecret, $allowCompatVerification = false)
{
}
public function verifyAdminCredentials($userProvidedUsername, $userProvidedPassword)
{
}
protected function login(\WHMCS\User\Admin $admin)
{
}
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
class ApiLog implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
class ActionResponseFormat implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
protected $actionResponseHighlyStructured = array("domaingetwhoisinfo", "getactivitylog", "getaffiliates", "getannouncements", "getcancelledpackages", "getclientgroups", "getclients", "getclientsaddons", "getclientsdomains", "getclientsproducts", "getcontacts", "getcredits", "getcurrencies", "getemails", "getemailtemplates", "getinvoice", "getinvoices", "getmodulequeue", "getorders", "getorderstatuses", "getpaymentmethods", "getproducts", "getproject", "getprojects", "getpromotions", "getquotes", "getstaffonline", "getsupportdepartments", "getsupportstatuses", "getticket", "getticketnotes", "getticketpredefinedcats", "getticketpredefinedreplies", "gettickets", "gettodoitems", "gettodoitemstatuses", "gettransactions", "orderfraudcheck");
protected $requiresJsonResponse = array("getadminusers");
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function isResponseTypeAllowed($action, $type)
{
}
public function isActionResponseHighlyStructured($action)
{
}
public function requiresJsonResponse($action)
{
}
protected function normalizeRequest(\WHMCS\Api\ApplicationSupport\Http\ServerRequest $request)
{
}
}
}
namespace WHMCS\Security\Middleware {
class Authorization implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\DelegatingMiddlewareTrait;
protected $request = NULL;
protected $csrfRequestMethods = array();
protected $csrfNamespace = "";
protected $csrfCheckRequired = true;
protected $requireAnyPermission = array();
protected $requireAllPermission = array();
public function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function assertAuthorization(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\User\UserInterface $user = NULL)
{
}
protected function responseInvalidCsrfToken()
{
}
protected function responseMissingMultiplePermissions(array $permissionNames = array())
{
}
protected function responseMissingPermission(array $permissionNames = array())
{
}
public function requireCsrfToken(array $csrfRequestMethods = NULL, $csrfNamespace = NULL)
{
}
public function hasValidCsrfToken()
{
}
public function getRequest()
{
}
public function setRequest(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getDefaultCsrfNamespace()
{
}
public function getDefaultCsrfRequestMethods()
{
}
public function getCsrfRequestMethods()
{
}
public function setCsrfRequestMethods(array $csrfRequestMethods)
{
}
public function getCsrfNamespace()
{
}
public function setCsrfNamespace($csrfNamespace)
{
}
public function isCsrfCheckRequired()
{
}
public function setCsrfCheckRequired($checkRequired)
{
}
public function getRequireAnyPermission()
{
}
public function setRequireAnyPermission(array $permissions = array())
{
}
public function getRequireAllPermission()
{
}
public function setRequireAllPermission(array $permissions = array())
{
}
}
}
namespace WHMCS\Api\ApplicationSupport\Route\Middleware {
class Authorization extends \WHMCS\Security\Middleware\Authorization
{
public function assertAuthorization(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\User\UserInterface $user = NULL)
{
}
public function hasValidCsrfToken()
{
}
protected function responseActionNotAllowed($action)
{
}
}
class SystemAccessControl implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
protected function getSystemAccessKey()
{
}
protected function getAllowedIps()
{
}
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
}
namespace WHMCS {
class Auth
{
public function getInfobyID($adminid, $resource = NULL, $restrictToEnabled = true)
{
}
public function getInfobyUsername($username, $restrictToEnabled = true)
{
}
public function comparePasswordInputWithHook($userInput, $isApi = false)
{
}
public function comparePassword($password)
{
}
public function compareApiPassword($password)
{
}
public function isTwoFactor()
{
}
public function getAdminID()
{
}
public function getAdminRoleId()
{
}
public function getAdminUsername()
{
}
public function getAdminEmail()
{
}
public function getLegacyAdminPW()
{
}
public function getAdminPWHash()
{
}
public function isAdminPWHashSet()
{
}
public function generateNewPasswordHashAndStore($password)
{
}
public function generateNewPasswordHashAndStoreForApi($password)
{
}
public function getAdminTemplate()
{
}
public function getAdminLanguage()
{
}
public function getAdmin2FAModule()
{
}
public function isActive()
{
}
public function generateAdminSessionHash($whmcsclass = false)
{
}
public function setSessionVars($whmcsclass = false)
{
}
public function processLogin($createAdminLogEntry = true)
{
}
public function getRememberMeCookie()
{
}
public function isValidRememberMeCookie($whmcsclass = false)
{
}
public function setRememberMeCookie()
{
}
public function unsetRememberMeCookie()
{
}
protected function sendWhitelistedIPNotice()
{
}
public function failedLogin()
{
}
public static function getID()
{
}
public static function isLoggedIn()
{
}
public function logout()
{
}
public function isSessionPWHashValid($whmcsclass = false)
{
}
public function updateAdminLog()
{
}
public function destroySession()
{
}
public static function persistAdminSession()
{
}
public static function persistClientSession()
{
}
public function authenticateClientFromToken(\WHMCS\ApplicationLink\AccessToken $token)
{
}
public function cleanRedirectUri($uri)
{
}
public function redirectToLogin()
{
}
public function routableRedirectToLogin(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function redirectPostLogin($redirectUri)
{
}
public function redirect($redirectUri, $queryString = "")
{
}
}
}
namespace WHMCS\Announcement\Controller {
class AnnouncementController
{
public function __construct()
{
}
public function index(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function twitterFeed(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function view(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
}
namespace WHMCS\Announcement {
class Announcement extends \WHMCS\Model\AbstractModel
{
protected $table = "tblannouncements";
protected $columnMap = array("publishDate" => "date", "isPublished" => "published");
protected $dates = array("publishDate");
protected $booleans = array("isPublished");
public static function boot()
{
}
public function parent()
{
}
public function translations()
{
}
public static function getUniqueMonthsWithAnnouncements($count = 10)
{
}
public function scopeTranslationsOf($query, $id = "", $language = "")
{
}
public function bestTranslation($language = "")
{
}
public function scopePublished(\Illuminate\Database\Eloquent\Builder $query)
{
}
}
}
namespace WHMCS\Announcement\View {
class TwitterFeed extends \WHMCS\ClientArea
{
protected function initializeView()
{
}
}
class Index extends \WHMCS\ClientArea
{
protected function initializeView()
{
}
public function getAnnouncementTemplateData(\WHMCS\Announcement\Announcement $item)
{
}
}
class Item extends \WHMCS\Announcement\View\Index
{
protected function initializeView()
{
}
}
}
namespace WHMCS\Announcement {
class Rss
{
public function toXml(\Psr\Http\Message\ServerRequestInterface $request)
{
}
protected function getXmlItems()
{
}
}
}
namespace WHMCS\Support\Ticket {
class Reply extends \WHMCS\Model\AbstractModel
{
protected $table = "tblticketreplies";
protected $columnMap = array("clientId" => "userid", "contactId" => "contactid");
protected $dates = array("date");
protected $hidden = array("editor");
public $timestamps = false;
const CREATED_AT = "date";
public static function boot()
{
}
public function ticket()
{
}
}
}
namespace WHMCS\Support {
class Ticket extends \WHMCS\Model\AbstractModel
{
protected $table = "tbltickets";
protected $columnMap = array("ticketNumber" => "tid", "departmentId" => "did", "subject" => "title", "flaggedAdminId" => "flag", "replyingAdminId" => "replyingadmin", "adminRead" => "adminunread", "priority" => "urgency", "createdByAdminUser" => "admin", "mergedWithTicketId" => "merged_ticket_id");
protected $commaSeparated = array("adminunread");
protected $dates = array("date", "lastreply", "replyingtime");
protected $hidden = array("flag", "adminunread", "clientunread", "replyingadmin", "replyingtime", "editor");
const CREATED_AT = "date";
const PRIORITY_LOW = "low";
const PRIORITY_MEDIUM = "medium";
const PRIORITY_HIGH = "high";
public static function boot()
{
}
public function client()
{
}
public function contact()
{
}
public function department()
{
}
public function flaggedAdmin()
{
}
public function replies()
{
}
public function mergedTicket()
{
}
public function replyingAdmin()
{
}
public function scopeUserId(\Illuminate\Database\Eloquent\Builder $query, $userId)
{
}
public function scopeNotMerged(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function mergeOtherTicketsInToThis(array $ticketIds)
{
}
public function getLink()
{
}
public static function getPriorities()
{
}
}
class Department extends \WHMCS\Model\AbstractModel
{
protected $table = "tblticketdepartments";
public $timestamps = false;
protected $columnMap = array("clientsOnly" => "clientsonly", "pipeRepliesOnly" => "piperepliesonly", "noAutoResponder" => "noautoresponder", "feedbackRequest" => "feedback_request");
public function scopeEnforceUserVisibilityPermissions(\Illuminate\Database\Eloquent\Builder $query)
{
}
public static function boot()
{
}
public function getNameAttribute($name)
{
}
public function getDescriptionAttribute($description)
{
}
public function translatedNames()
{
}
public function translatedDescriptions()
{
}
public static function getDepartmentName($departmentId, $fallback = "", $language = NULL)
{
}
public static function getDepartmentDescription($departmentId, $fallback = "", $language = NULL)
{
}
public function tickets()
{
}
}
}
namespace WHMCS {
class OrderForm
{
public function getCartData()
{
}
public function getCartDataByKey($key, $keyNotFoundValue = "")
{
}
public function getProductGroups($asCollection = false)
{
}
public function getProducts($productGroup, $includeConfigOptions = false, $includeBundles = false)
{
}
public function formatProductDescription($desc)
{
}
public function getProductGroupInfo($gid)
{
}
public function setPid($pid)
{
}
public function getProductInfo($var = "")
{
}
public function validateBillingCycle($billingcycle)
{
}
public function getNumItemsInCart()
{
}
public static function addToCart($type, $parameters)
{
}
public static function addProductToCart($productId, $billingCycle, $domain, array $extra = array())
{
}
public static function addAddonToCart($addonId, $serviceId, $billingCycle, array $extra = array())
{
}
public static function addUpgradeToCart($upgradeEntityType, $upgradeEntityId, $targetEntityId, $billingCycle)
{
}
public function startExpressCheckout($gateway, $metaData, $payerData)
{
}
public function cancelExpressCheckout()
{
}
public function expressCheckoutCompleted()
{
}
public function inExpressCheckout()
{
}
public function getExpressCheckoutData()
{
}
public function getExpressCheckoutGateway()
{
}
}
}
namespace WHMCS\Payment {
class PaymentServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider
{
public function register()
{
}
}
}
namespace WHMCS\User\Contracts {
interface ContactAwareInterface
{
public function client();
public function contact();
}
}
namespace WHMCS\Payment\Contracts {
interface PayMethodTypeInterface
{
const TYPE_BANK_ACCOUNT = "BankAccount";
const TYPE_REMOTE_BANK_ACCOUNT = "RemoteBankAccount";
const TYPE_CREDITCARD_LOCAL = "CreditCard";
const TYPE_CREDITCARD_REMOTE_MANAGED = "RemoteCreditCard";
const TYPE_CREDITCARD_REMOTE_UNMANAGED = "PayToken";
public function getType($instance);
public function getTypeDescription($instance);
public function isManageable();
public function isCreditCard();
public function isLocalCreditCard();
public function isRemoteCreditCard();
public function isBankAccount();
public function isRemoteBankAccount();
}
interface PayMethodInterface extends \WHMCS\User\Contracts\ContactAwareInterface, \WHMCS\Payment\Contracts\PayMethodTypeInterface
{
public function payment();
public function isDefaultPayMethod();
public function setAsDefaultPayMethod();
public function getDescription();
public function setDescription($value);
public function getGateway();
public function setGateway(\WHMCS\Module\Gateway $value);
public function isUsingInactiveGateway();
public function getPaymentDescription();
public function save(array $options);
}
interface CreditCardDetailsInterface
{
public function getCardNumber();
public function setCardNumber($value);
public function getCardCvv();
public function setCardCvv($value);
public function getLastFour();
public function setLastFour($value);
public function getMaskedCardNumber();
public function getExpiryDate();
public function setExpiryDate(\WHMCS\Carbon $value);
public function getCardType();
public function setCardType($value);
public function getStartDate();
public function setStartDate(\WHMCS\Carbon $value);
public function getIssueNumber();
public function setIssueNumber($value);
}
interface SensitiveDataInterface
{
public function getEncryptionKey();
public function wipeSensitiveData();
public function getSensitiveDataAttributeName();
public function getSensitiveProperty($property);
public function setSensitiveProperty($property, $value);
public function getSensitiveData();
}
interface PayMethodAdapterInterface extends \WHMCS\User\Contracts\ContactAwareInterface, \WHMCS\Payment\Contracts\PayMethodTypeInterface, \WHMCS\Payment\Contracts\SensitiveDataInterface
{
public function payMethod();
public static function factoryPayMethod(\WHMCS\User\Contracts\UserInterface $client, \WHMCS\User\Contracts\ContactInterface $billingContact, $description, $isMigratingCard);
public function getDisplayName();
}
interface BankAccountDetailsInterface
{
public function getRoutingNumber();
public function setRoutingNumber($value);
public function getAccountNumber();
public function setAccountNumber($value);
public function getBankName();
public function setBankName($value);
public function getAccountType();
public function setAccountType($value);
public function getAccountHolderName();
public function setAccountHolderName($value);
}
interface RemoteTokenDetailsInterface
{
public function getRemoteToken();
public function setRemoteToken($value);
public function createRemote();
public function updateRemote();
public function deleteRemote();
public function getBillingContactParamsForRemoteCall(\WHMCS\User\Contracts\UserInterface $client, \WHMCS\User\Contracts\ContactInterface $contact);
}
}
namespace WHMCS\Payment {
class Subscription
{
public static function getInfo($relatedItem)
{
}
public static function cancel($relatedItem)
{
}
}
}
namespace WHMCS\Payment\Adapter {
interface AdapterInterface
{
public function getConfigurationParameters();
public function setConfigurationParameters(array $configuration);
public function getSolutionType();
public function setSolutionType($type);
public function isLinkCapable();
public function isCaptureCapable();
public function isRefundCapable();
public function isRemotePaymentDetailsStorageCapable();
public function getHtmlLink(array $params);
public function captureTransaction(array $params);
public function refundTransaction(array $params);
public function storePaymentDetailsRemotely(array $params);
}
abstract class AbstractAdapter implements \WHMCS\Payment\Adapter\AdapterInterface
{
protected $type = "";
protected $name = "";
protected $config = array();
protected $captureCapable = false;
protected $refundCapable = false;
protected $remotePaymentDetailsStorageCapable = false;
protected $linkCapable = false;
public function __construct($name = "")
{
}
public function setName($name)
{
}
public function getName()
{
}
public function getConfigurationParameters()
{
}
public function setConfigurationParameters(array $configuration)
{
}
public function getSolutionType()
{
}
public function setSolutionType($type)
{
}
public function isLinkCapable()
{
}
public function isCaptureCapable()
{
}
public function isRefundCapable()
{
}
public function isRemotePaymentDetailsStorageCapable()
{
}
public function getHtmlLink(array $params = NULL)
{
}
public function captureTransaction(array $params)
{
}
public function refundTransaction(array $params)
{
}
public function storePaymentDetailsRemotely(array $params)
{
}
}
class GatewaysModuleAdapter extends \WHMCS\Payment\Adapter\AbstractAdapter
{
public function __construct($name)
{
}
protected function detectSolutionTypeFromCapabilities()
{
}
protected function detectCapabilitiesFromDefinedFunctions()
{
}
protected function getConfigurationFromDefinedFunctions()
{
}
public function captureTransaction(array $params)
{
}
public function refundTransaction(array $params)
{
}
public function storePaymentDetailsRemotely(array $params)
{
}
public function getHtmlLink(array $params = NULL)
{
}
}
}
namespace WHMCS\Payment {
class PaymentRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\ProviderTrait;
protected function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
class PaymentController
{
public function confirm(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function update(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getRemoteToken(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class Solutions extends \ArrayObject
{
protected $iterator = NULL;
const TYPE_GATEWAY = "gateway";
const TYPE_ALTERNATE = "alternate";
const TYPE_MULTI = "allinone";
public function __construct()
{
}
public function getIterator()
{
}
protected function restoreDefaultIterator()
{
}
public function setIterator(\Iterator $iterator)
{
}
public function count()
{
}
public function loadSolutionsInDirectory($directory)
{
}
public function getAdapterFromFile(\SplFileInfo $resource)
{
}
public static function getValidSolutionTypes()
{
}
public static function isValidSolutionType($type)
{
}
public function applyFilter(\WHMCS\Payment\Filter\FilterInterface $filter)
{
}
public function removeAllFilters()
{
}
public function removeFilter()
{
}
}
}
namespace WHMCS\Payment\Filter {
interface FilterInterface
{
public function getFilteredIterator(\Iterator $iterator);
public function filter(\WHMCS\Payment\Adapter\AdapterInterface $adapter);
}
abstract class AbstractFilter implements \WHMCS\Payment\Filter\FilterInterface
{
public function getFilteredIterator(\Iterator $iterator)
{
}
public abstract function filter(\WHMCS\Payment\Adapter\AdapterInterface $adapter);
}
class Name extends \WHMCS\Payment\Filter\AbstractFilter
{
public function __construct($name)
{
}
public function filter(\WHMCS\Payment\Adapter\AdapterInterface $adapter)
{
}
}
}
namespace WHMCS\Payment\Filter\Iterator {
class CallbackIterator extends \FilterIterator
{
public function __construct(\Iterator $iterator, $conditionalCallback)
{
}
public function accept()
{
}
public function setCallback($callback)
{
}
public function getCallback()
{
}
}
}
namespace WHMCS\Payment\Filter {
class Type extends \WHMCS\Payment\Filter\AbstractFilter
{
public function __construct($type)
{
}
public function filter(\WHMCS\Payment\Adapter\AdapterInterface $adapter)
{
}
}
}
namespace WHMCS\Payment\Exception {
class MethodNotImplemented extends \BadMethodCallException
{
}
class InvalidModuleException extends \LogicException
{
}
}
namespace WHMCS\Payment\PayMethod {
class MigrationProcessor
{
public function migrateForClient(\WHMCS\User\Client $client)
{
}
}
}
namespace WHMCS\Payment\PayMethod\Traits {
trait GatewayTrait
{
public function loadGateway($gatewayName)
{
}
}
trait PayMethodFromRequestTrait
{
private static function getClient(\WHMCS\Http\Message\ServerRequest $request)
{
}
public static function getBillingContact(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\User\Client $client)
{
}
public static function factoryFromRequest(\WHMCS\Http\Message\ServerRequest $request)
{
}
private static function getBankPayment(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\User\Contracts\UserInterface $client, \WHMCS\User\Contracts\ContactInterface $billingContact, $description = "")
{
}
private static function getCardPayment(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\User\Contracts\UserInterface $client, \WHMCS\User\Contracts\ContactInterface $billingContact, $description = "")
{
}
}
trait TypeTrait
{
public function getType($instance = NULL)
{
}
public function getTypeDescription($instance = NULL)
{
}
public function isManageable()
{
}
public function isLocalCreditCard()
{
}
public function isRemoteCreditCard()
{
}
public function isCreditCard()
{
}
public function isBankAccount()
{
}
public function isRemoteBankAccount()
{
}
public function getSupportedPayMethodTypes()
{
}
}
}
namespace WHMCS\Payment\PayMethod {
class Model extends \WHMCS\Model\AbstractModel implements \WHMCS\Payment\Contracts\PayMethodInterface
{
use \Illuminate\Database\Eloquent\SoftDeletes;
use \WHMCS\Payment\PayMethod\Traits\GatewayTrait;
use \WHMCS\Payment\PayMethod\Traits\PayMethodFromRequestTrait;
use \WHMCS\Payment\PayMethod\Traits\TypeTrait {
getType as baseGetType;
}
protected $dates = array("deleted_at");
protected $table = "tblpaymethods";
public function createTable($drop = false)
{
}
public static function boot()
{
}
public function newCollection(array $models = array())
{
}
public function payment()
{
}
public function client()
{
}
public function contact()
{
}
public function getType($instance = NULL)
{
}
public static function totalPayMethodsOnFile(\WHMCS\User\Contracts\UserInterface $client)
{
}
public function isDefaultPayMethod()
{
}
public function setAsDefaultPayMethod()
{
}
public function getDescription()
{
}
public function setDescription($value)
{
}
public function getGateway()
{
}
public function setGateway(\WHMCS\Module\Gateway $value)
{
}
public function isUsingInactiveGateway()
{
}
public function isExpired()
{
}
public function getStatus()
{
}
public function getFontAwesomeIcon()
{
}
public function getContactId()
{
}
public function isTokenised()
{
}
public function getPaymentDescription()
{
}
public function capture(\WHMCS\Billing\Invoice $invoice, $cvc = "")
{
}
public static function findForClient($id, $clientId)
{
}
public function invoices()
{
}
public static function deleteLocalCreditCards()
{
}
public static function deleteExpiredCreditCards(\WHMCS\Scheduling\Task\TaskInterface $task = NULL)
{
}
}
}
namespace WHMCS\Payment\PayMethod\Traits {
trait PayMethodFactoryTrait
{
public static function factoryPayMethod(\WHMCS\User\Contracts\UserInterface $client, \WHMCS\User\Contracts\ContactInterface $billingContact = NULL, $description = "", $isMigratingCard = false)
{
}
public function newPayMethod(\WHMCS\User\Contracts\UserInterface $client, \WHMCS\User\Contracts\ContactInterface $billingContact = NULL, $description = "")
{
}
}
}
namespace WHMCS\Payment\PayMethod\Adapter {
abstract class BaseAdapterModel extends \WHMCS\Model\AbstractModel implements \WHMCS\Payment\Contracts\PayMethodAdapterInterface
{
use \WHMCS\Payment\PayMethod\Traits\TypeTrait;
use \WHMCS\Payment\PayMethod\Traits\PayMethodFactoryTrait;
public $timestamps = true;
public static function boot()
{
}
public function payMethod()
{
}
public function client()
{
}
public function contact()
{
}
public function getEncryptionKey()
{
}
}
abstract class BankAccountModel extends \WHMCS\Payment\PayMethod\Adapter\BaseAdapterModel
{
use \Illuminate\Database\Eloquent\SoftDeletes;
protected $table = "tblbankaccts";
protected $dates = array("deleted_at");
public function createTable($drop = false)
{
}
public static function boot()
{
}
public function getSensitiveDataAttributeName()
{
}
}
}
namespace WHMCS\Payment\PayMethod\Traits {
trait SensitiveDataTrait
{
private $sensitiveData = NULL;
public function wipeSensitiveData()
{
}
public function getSensitiveProperty($property)
{
}
public function setSensitiveProperty($property, $value)
{
}
public function unsetSensitiveProperty($property)
{
}
public function getRawSensitiveData()
{
}
public function getSensitiveData()
{
}
}
trait RemoteBankAccountDetailsTrait
{
use \WHMCS\Payment\PayMethod\Traits\SensitiveDataTrait;
public function getSensitiveDataAttributeName()
{
}
public function getAccountNumber()
{
}
public function setAccountNumber($value)
{
}
public function getAccountHolderName()
{
}
public function setAccountHolderName($value)
{
}
public function getDisplayName()
{
}
public function setMigrated()
{
}
public function isMigrated()
{
}
}
}
namespace WHMCS\Payment\PayMethod\Adapter {
class RemoteBankAccount extends \WHMCS\Payment\PayMethod\Adapter\BankAccountModel implements \WHMCS\Payment\Contracts\RemoteTokenDetailsInterface
{
use \WHMCS\Payment\PayMethod\Traits\RemoteBankAccountDetailsTrait;
public function getName()
{
}
public function setName($value)
{
}
public function getRemoteToken()
{
}
public function setRemoteToken($value)
{
}
protected function getGatewayParamsForRemoteCall(\WHMCS\Module\Gateway $gateway)
{
}
public function getBillingContactParamsForRemoteCall(\WHMCS\User\Contracts\UserInterface $client, \WHMCS\User\Contracts\ContactInterface $contact = NULL)
{
}
protected function storeRemote($action)
{
}
public function createRemote()
{
}
public function updateRemote()
{
}
public function deleteRemote()
{
}
public function validateRequiredValuesPreSave()
{
}
}
}
namespace WHMCS\Payment\PayMethod\Traits {
trait BankAccountDetailsTrait
{
use \WHMCS\Payment\PayMethod\Traits\SensitiveDataTrait;
public function getSensitiveDataAttributeName()
{
}
public function getRoutingNumber()
{
}
public function setRoutingNumber($value)
{
}
public function getAccountNumber()
{
}
public function setAccountNumber($value)
{
}
public function getAccountType()
{
}
public function setAccountType($value)
{
}
public function getBankName()
{
}
public function setBankName($value)
{
}
public function getAccountHolderName()
{
}
public function setAccountHolderName($value)
{
}
public function validateRequiredValuesPreSave()
{
}
public function getDisplayName()
{
}
public function setMigrated()
{
}
public function isMigrated()
{
}
}
}
namespace WHMCS\Payment\PayMethod\Adapter {
class BankAccount extends \WHMCS\Payment\PayMethod\Adapter\BankAccountModel implements \WHMCS\Payment\Contracts\BankAccountDetailsInterface
{
use \WHMCS\Payment\PayMethod\Traits\BankAccountDetailsTrait;
}
abstract class CreditCardModel extends \WHMCS\Payment\PayMethod\Adapter\BaseAdapterModel implements \WHMCS\Payment\Contracts\CreditCardDetailsInterface
{
use \Illuminate\Database\Eloquent\SoftDeletes;
protected $table = "tblcreditcards";
protected $dates = array("expiry_date", "deleted_at");
public function createTable($drop = false)
{
}
public function isExpired()
{
}
public function runCcUpdateHook()
{
}
}
}
namespace WHMCS\Payment\PayMethod\Traits {
trait CreditCardDetailsTrait
{
use \WHMCS\Payment\PayMethod\Traits\SensitiveDataTrait;
private $cardCvv = "";
public function getSensitiveDataAttributeName()
{
}
public function getCardCvv()
{
}
public function setCardCvv($value)
{
}
public function getCardNumber()
{
}
public function setCardNumber($value)
{
}
public function getLastFour()
{
}
public function setLastFour($value)
{
}
public function getMaskedCardNumber()
{
}
public function getExpiryDate()
{
}
public function setExpiryDate(\WHMCS\Carbon $value)
{
}
public function isExpired()
{
}
public function getCardType()
{
}
public function setCardType($value)
{
}
public function getStartDate()
{
}
public function setStartDate(\WHMCS\Carbon $value)
{
}
public function getIssueNumber()
{
}
public function setIssueNumber($value)
{
}
public function getDisplayName()
{
}
public function setMigrated()
{
}
public function isMigrated()
{
}
public function validateRequiredValuesPreSave()
{
}
public function validateRequiredValuesForEditPreSave()
{
}
protected function normaliseCardType($cardType)
{
}
}
}
namespace WHMCS\Payment\PayMethod\Adapter {
class RemoteCreditCard extends \WHMCS\Payment\PayMethod\Adapter\CreditCardModel implements \WHMCS\Payment\Contracts\RemoteTokenDetailsInterface
{
use \WHMCS\Payment\PayMethod\Traits\CreditCardDetailsTrait;
public static function boot()
{
}
public function getRemoteToken()
{
}
public function setRemoteToken($value)
{
}
public function getPaymentParamsForRemoteCall()
{
}
protected function getGatewayParamsForRemoteCall(\WHMCS\Module\Gateway $gateway)
{
}
public function getBillingContactParamsForRemoteCall(\WHMCS\User\Contracts\UserInterface $client, \WHMCS\User\Contracts\ContactInterface $contact = NULL)
{
}
protected function storeRemote($action)
{
}
public function createRemote()
{
}
public function updateRemote()
{
}
public function deleteRemote()
{
}
public function getDisplayName()
{
}
public function validateRequiredValuesPreSave()
{
}
public function validateRequiredValuesForEditPreSave()
{
}
}
class CreditCard extends \WHMCS\Payment\PayMethod\Adapter\CreditCardModel
{
use \WHMCS\Payment\PayMethod\Traits\CreditCardDetailsTrait {
getRawSensitiveData as ccGetRawSensitiveData;
}
public static function boot()
{
}
public static function factoryPayMethod(\WHMCS\User\Contracts\UserInterface $client, \WHMCS\User\Contracts\ContactInterface $billingContact = NULL, $description = "", $isMigratingCard = false)
{
}
protected function getRawSensitiveData()
{
}
public function getDisplayName()
{
}
public function isMigrating()
{
}
public function setIsMigrating($isMigrating)
{
}
}
}
namespace WHMCS\Payment\PayMethod {
class Collection extends \Illuminate\Database\Eloquent\Collection
{
public function forGateway($gatewayModule)
{
}
public function creditCards()
{
}
public function localCreditCards()
{
}
public function bankAccounts()
{
}
public function validateGateways()
{
}
public function sortByExpiryDate($expiringFirst = false)
{
}
}
}
namespace WHMCS\Payment {
class PaymentGatewayProductMapping extends \WHMCS\Model\AbstractModel
{
protected $table = "tblpaymentgateways_product_mapping";
public $timestamps = true;
public function createTable($drop = false)
{
}
public function scopeGateway($query, $gateway)
{
}
public function scopeAccountIdentifier($query, $accountIdentifier)
{
}
public function scopeProductIdentifier($query, $productIdentifier)
{
}
}
}
namespace WHMCS\Admin\Controller {
class GlobalWarningController
{
public function dismiss(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class LoginController
{
use \WHMCS\Application\Support\Controller\DelegationTrait;
public function viewLoginForm(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function loginPhp(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class ErrorController
{
use \WHMCS\Application\Support\Controller\DelegationTrait;
public function loginRequired(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class HomepageController
{
public static function assertCurl()
{
}
public function refreshWidget(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function saveNotes(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function toggleWidgetDisplay(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function mentions(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function marketingConversion(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function dismissMarketConnectProductPromo(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function orderWidgets(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class ImageController
{
public function uploadImage(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function recentlyUploaded(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Client {
class TicketsController
{
public function tickets(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function close(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function delete(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function merge(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class ClientController
{
public function export(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Client\Invoice {
class InvoiceController
{
public function capture(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function doCapture(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Client {
class ProfileController
{
public function consentHistory(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function profileContacts(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class ClientRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Client\PayMethod {
class PayMethodController
{
public function selectStorageOptions(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function newPayMethodForm(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function saveNew(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function viewPayMethod(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function updateExisting(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function deleteExisting(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function doDeleteExisting(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function payMethodsHtmlRows(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function decryptCcData(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function clearLocalCardPayMethods(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function remoteConfirm(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function remoteUpdate(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class ViewHelper
{
public function __construct(\WHMCS\Admin $aInt = NULL)
{
}
public function getIconClass(\WHMCS\Payment\Contracts\PayMethodInterface $payMethod)
{
}
public function getShortDescription(\WHMCS\Payment\Contracts\PayMethodInterface $payMethod)
{
}
public function clientProfileSummaryHtmlTableRows(\WHMCS\User\Client $client)
{
}
public function clientProfileSummaryHtml(\WHMCS\User\Client $client)
{
}
protected function clientProfileHtml(\WHMCS\User\Client $client, $template, array $vars = array())
{
}
}
}
namespace WHMCS\Admin\Billing {
class BillingRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
class OfflineCcController
{
public function getForm(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function decryptCardData(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function applyTransaction(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Server {
class ServerController
{
public function refreshRemoteData(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class ServerRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Setup\Notifications {
class NotificationsRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
class NotificationsController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function listNotifications(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function manageRule(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function duplicateRule(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function deleteRule(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function manageRuleOutput(\WHMCS\Http\Message\ServerRequest $request, $title, $rule)
{
}
protected function buildConditionField($eventType, $name, $values, $ruleConditions)
{
}
public function saveRule(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function setRuleStatus(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function manageProvider(\WHMCS\Http\Message\ServerRequest $request, $errorMsg = NULL)
{
}
public function saveProvider(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getDynamicField(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getProvidersStatus()
{
}
public function disableProvider(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Setup\Authentication\Client {
class RemoteProviderController
{
public function viewProviderSettings(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function deleteAccountLink(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function deactivate(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function activate(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function updateProviderSettings(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function getSettingsFromRequest(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class RemoteAuthRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Setup\Authentication {
class TwoFactorAuthController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function status(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function saveSettings(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function configureModule(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function saveModule(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class AuthRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Setup\Tld {
class TldController
{
protected function buildPricingForCurrency(array $pricingData, \WHMCS\Billing\Currency $currency)
{
}
protected function buildPricingArraysUsingCurrencyConversion()
{
}
protected function getUpdateArraysFromBuiltPricing()
{
}
protected function savePricing(array $updatePricing)
{
}
protected function conditionallySaveGraceAndRedemptionData()
{
}
public function massConfiguration(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class TldRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Setup\Product {
class MetricPriceViewHelper
{
public function getMetricPricingModalBody(\WHMCS\UsageBilling\Product\UsageItem $usageItem)
{
}
protected function currencyCell(\WHMCS\Billing\Currency $currency, $price = NULL, $name = "pricing")
{
}
protected function tableJs($isSimpleMode)
{
}
}
}
namespace WHMCS\Admin\Setup\Storage {
class StorageController
{
const MAX_FAILURE_REASON_LENGTH = 400;
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function editConfiguration(\WHMCS\Http\Message\ServerRequest $request, $errorMsg = NULL, $duplicate = false)
{
}
public function duplicateConfiguration(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function saveConfiguration(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function testConfiguration(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function deleteConfiguration(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function dismissError(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function cancelMigration(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function switchAssetStorage(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function startMigration(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class StorageRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Setup {
class Servers
{
public function getAutoPopulateServers()
{
}
public function add($name, $type, $ipaddress, $assignedips, $hostname, $monthlycost, $noc, $statusaddress, $nameserver1, $nameserver1ip, $nameserver2, $nameserver2ip, $nameserver3, $nameserver3ip, $nameserver4, $nameserver4ip, $nameserver5, $nameserver5ip, $maxaccounts, $username, $password, $accesshash, $secure, $port, $restrictssoroles, $disabled = 0)
{
}
public function fetchAutoPopulateServerConfig($module, $hostname, $ipaddress, $username, $password, $accesshash, $secure, $port)
{
}
public function createApiToken($module, $serverId)
{
}
}
class OverviewController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function getLinks()
{
}
}
class ProductSetup
{
protected $product = NULL;
protected $moduleInterface = NULL;
protected $mode = NULL;
protected function getProduct($productId)
{
}
protected function getModuleSetupRequestMode()
{
}
protected function getModuleInterface()
{
}
protected function hasSimpleConfigMode()
{
}
protected function getModuleSettingsFields()
{
}
public function getModuleSettings($productId)
{
}
public static function formatSubDomainValuesToEnsureLeadingDotAndUnique(array $subDomains = array())
{
}
protected function getUsageItem($productId, \WHMCS\Http\Message\ServerRequest $request)
{
}
public function toggleMetric($productId, \WHMCS\Http\Message\ServerRequest $request)
{
}
public function getMetricPricing($productId, \WHMCS\Http\Message\ServerRequest $request)
{
}
public function saveMetricPricing($productId, \WHMCS\Http\Message\ServerRequest $request)
{
}
}
class AddonSetup
{
protected $addonId = NULL;
protected $addon = NULL;
protected $moduleInterface = NULL;
protected $mode = NULL;
protected function setAddonId($addonId = 0)
{
}
public function getAddonId()
{
}
protected function getAddon($addonId = 0)
{
}
protected function getModuleSetupRequestMode()
{
}
protected function getModuleInterface()
{
}
protected function hasSimpleConfigMode()
{
}
protected function getModuleSettingsFields()
{
}
public function getModuleSettings($addonId)
{
}
}
}
namespace WHMCS\Admin\Setup\Payments {
class TaxController
{
public function saveSettings(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function create(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function delete(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function pageSummaryHtml()
{
}
protected function taxRuleQuery($level)
{
}
protected function getTaxHtmlTableData($level = 1)
{
}
protected function pageJQuery()
{
}
public function setupEuRates(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function migrateCustomField(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class TaxRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
class GatewaysController
{
public function handleOnboardingReturn(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function callAdditionalFunction(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class GatewaysRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Setup {
class SetupTasks
{
public function evaluateAndGet()
{
}
protected function isCompanyNameAndLogoSet()
{
}
}
}
namespace WHMCS\Admin\Setup\Authorization {
class AuthorizationRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Setup\Authorization\Api\View {
class RoleHelper
{
public function getTableData($roles)
{
}
protected function getActionBtnGroup($id)
{
}
}
class DeviceHelper
{
public function getTableData($devices)
{
}
protected function getLastAccessText(\WHMCS\Authentication\Device $device)
{
}
protected function getDescriptionBtn(\WHMCS\Authentication\Device $device)
{
}
protected function getActionBtnGroup($id)
{
}
}
}
namespace WHMCS\Admin\Setup\Authorization\Api {
class RoleController
{
public function listRoles(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function manage(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function get(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function create(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function delete(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function update(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function selectOptions(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Setup\General\UriManagement\View\Helper {
class SimpleSetting
{
public function getSimpleSettingHtmlPartial()
{
}
public function resetSuccessHtml(array $successMessages)
{
}
}
}
namespace WHMCS\Admin\Setup\General\UriManagement {
class ConfigurationController
{
protected $relativePath = "";
const PATH_COMPARISON_TEST = "/resources/test";
const PATH_COMPARISON_INDEX = "";
const ROUTE_TYPE_REWRITE = "/detect-route-environment";
const ROUTE_TYPE_ACCEPTPATHINFO = "/index.php/detect-route-environment";
const ROUTE_TYPE_BASIC = "/index.php?rp=/detect-route-environment";
const SETTING_MODE_OVERRIDE = "UriModeOverride";
const SETTING_AUTO_MANAGE = "UriRewriteAutoManage";
public function __construct($pathComparison = NULL)
{
}
public function detectRouteEnvironment(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function remoteDetectEnvironmentMode(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function setEnvironmentMode(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getRelativePath()
{
}
public function setRelativePath($relativePath)
{
}
public static function generateAuthorization()
{
}
protected function isAuthorizedRequest(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function getModeFromUri($routePath)
{
}
public function getAllKnowRouteTypes()
{
}
protected function queryEnvironmentMode()
{
}
public function updateUriManagementSetting(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function applyBestConfiguration(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function view(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function synchronizeRules(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
}
namespace WHMCS\Admin\Setup {
class GeneralSettings
{
public function autoDetermineSystemUrl()
{
}
public function autoDetermineDomain()
{
}
public function autoDetermineSystemEmailsFromEmail()
{
}
public function autoSetInitialConfiguration($companyName, $email, $address, $country, $language, $logoUrl)
{
}
public function getCurrencyBasedOnCountry($country)
{
}
public function setDefaultCurrencyIfNotUsed($currency)
{
}
public function getDateFormatBasedOnCountry($country)
{
}
public function setupFirstSupportDepartment($email)
{
}
}
class Domains
{
public function enable()
{
}
public function disable()
{
}
public function setupTldsWithDefaultOptions($extensions, $registrar, $price)
{
}
public function addTld($extension, $dnsManagement = false, $emailForwarding = false, $idProtection = false, $requiresEppCode = false, $registrar = "", $price = -1, $tldGroup = "")
{
}
}
}
namespace WHMCS\Admin\Service {
class ServiceController
{
protected function listServices($serviceType = "")
{
}
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function shared(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function reseller(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function server(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function other(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function serviceDetail(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function subscriptionInfo(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function subscriptionCancel(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class ServiceRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Service\Table {
class Service extends \WHMCS\TableModel
{
public function _execute($criteria = NULL)
{
}
protected function getServices($criteria = NULL)
{
}
}
}
namespace WHMCS\Admin {
class AdminServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider
{
public function register()
{
}
public static function getAdminRouteBase()
{
}
public static function hasDefaultAdminDirectory()
{
}
public static function hasConfiguredCustomAdminPath()
{
}
}
}
namespace WHMCS\Admin\Addon {
class AddonRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Addon\Table {
class Addon extends \WHMCS\TableModel
{
public function _execute($criteria = NULL)
{
}
protected function getAddons(array $criteria = NULL)
{
}
}
}
namespace WHMCS\Admin\Addon {
class AddonController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function addonDetail(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function subscriptionInfo(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function subscriptionCancel(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin {
class AdminRouteProvider implements \WHMCS\Route\Contracts\ProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
}
}
namespace WHMCS\Admin\Apps {
class AppsRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
class AppsController
{
public function index(\WHMCS\Http\Message\ServerRequest $request, $postLoadAction = NULL, $postLoadParams = array())
{
}
public function jumpBrowse(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function jumpActive(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function jumpSearch(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function featured(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function active(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function search(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function category(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function infoModal(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function logo(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Search\Controller {
abstract class AbstractSearchController implements \WHMCS\Search\ApplicationSupport\Controller\SearchInterface, \WHMCS\Search\SearchInterface
{
public abstract function getSearchTerm(\WHMCS\Http\Message\ServerRequest $request);
public abstract function getSearchable();
public function searchRequest(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class IntelligentSearchController extends \WHMCS\Admin\Search\Controller\AbstractSearchController
{
public function getSearchTerm(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getSearchable()
{
}
public function search($searchTerm = NULL)
{
}
public function setAutoSearch(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class ClientController extends \WHMCS\Admin\Search\Controller\AbstractSearchController
{
public function getSearchTerm(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getSearchable()
{
}
public function search($searchTerm = NULL)
{
}
}
class ContactController extends \WHMCS\Admin\Search\Controller\AbstractSearchController
{
public function getSearchTerm(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getSearchable()
{
}
public function search($searchTerm = NULL)
{
}
}
}
namespace WHMCS\Admin\Support {
class SupportRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
class SupportController
{
public function getClientServices(\WHMCS\Http\Message\ServerRequest $request, $skipTen = true)
{
}
protected function getClientServicesOutput(\WHMCS\Http\Message\ServerRequest $request, $skipTen = true)
{
}
public function setRelatedService(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function getRelatedDescriptionFromTypeAndId($type, $id)
{
}
public function getAdditionalData(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Account {
class TwoFactorController extends \WHMCS\Authentication\TwoFactor\TwoFactorController
{
protected $inAdminArea = true;
protected $userIdSessionVariableName = "adminid";
}
class AccountRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Domain {
class DomainRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
class DomainController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function sslCheck(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function domainDetail(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function subscriptionInfo(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function subscriptionCancel(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Domain\Table {
class Domain extends \WHMCS\TableModel
{
public function _execute($criteria = NULL)
{
}
public function getDomains(array $criteria = NULL)
{
}
}
}
namespace WHMCS\Admin\Wizard\Steps\ConfigureSsl {
class Approval
{
public function getStepContent()
{
}
public function save($data)
{
}
}
class Complete
{
public function getStepContent()
{
}
}
class Contacts
{
public function getStepContent()
{
}
public function save($data)
{
}
}
class Csr
{
public function getStepContent()
{
}
public function save($data)
{
}
}
}
namespace WHMCS\Admin\Wizard\Steps\GettingStarted {
class MarketConnect
{
public function getTemplateVariables()
{
}
public function getStepContent()
{
}
}
class Servers
{
public function getTemplateVariables()
{
}
public function getStepContent()
{
}
public function verifyConnection($data)
{
}
public function save($data)
{
}
}
class Complete
{
public function getStepContent()
{
}
}
class Start
{
public function getStepContent()
{
}
}
class Registrars
{
public function getTemplateVariables()
{
}
public function getStepContent()
{
}
public function save($data)
{
}
}
class Settings
{
public function getTemplateVariables()
{
}
public function getStepContent()
{
}
public function save($data)
{
}
}
class CreditCard
{
const API_URL = "https://www.whmcs.com/api/merchant_gateway_signup.php";
const API_SECRET_KEY = "561fd73b5a43e453444004a543f0b4731c05cd1e";
public function getStepContent()
{
}
public function save($data)
{
}
}
class Enom
{
const API_URL = "https://www.whmcs.com/api/enom_create_acct.php";
const API_SECRET_KEY = "10ef2c21b3c3311fca310f65af97cd1308469396";
public function getTemplateVariables()
{
}
public function getStepContent()
{
}
public function save($data)
{
}
}
class Payments
{
public function getTemplateVariables()
{
}
public function getStepContent()
{
}
public function save($data)
{
}
}
}
namespace WHMCS\Admin\Wizard {
abstract class Wizard
{
protected $wizardName = NULL;
protected $steps = array();
public abstract function hasRequiredAdminPermissions();
public static function factory($wizardName)
{
}
public function getName()
{
}
protected function getSteps()
{
}
protected function getStepClass($name)
{
}
public function render(\WHMCS\Smarty $smarty)
{
}
public function handleSubmit($step, $action, $data)
{
}
protected function getStepLabels()
{
}
protected function getWizardWrap()
{
}
}
class ConfigureSsl extends \WHMCS\Admin\Wizard\Wizard
{
protected $wizardName = "ConfigureSsl";
public function __construct()
{
}
public function hasRequiredAdminPermissions()
{
}
}
class GettingStarted extends \WHMCS\Admin\Wizard\Wizard
{
protected $wizardName = "GettingStarted";
public function __construct()
{
}
public function hasRequiredAdminPermissions()
{
}
}
}
namespace WHMCS\Admin\Utilities\Assent\Controller {
class EulaController
{
public function eulaAcceptanceRequired(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function acceptEula(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class LicenseController
{
const REQUEST_ATTRIBUTE_NO_WRITE_CONFIG = "no_write_license_key_update";
public function licensedRequired(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function updateLicenseKey(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function factoryConfigurationWriter()
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\View\Traits {
trait BodyContentTrait
{
protected $bodyContent = "";
public function getBodyContent()
{
}
public function setBodyContent($content)
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\View\Html {
class ContentWrapper extends \WHMCS\Http\Message\AbstractViewableResponse implements \WHMCS\View\HtmlPageInterface
{
use \WHMCS\Admin\ApplicationSupport\View\Traits\BodyContentTrait;
public function __construct($data = "", $status = 200, array $headers = array())
{
}
protected function getOutputContent()
{
}
public function getFormattedHtmlHeadContent()
{
}
public function getFormattedHeaderContent()
{
}
public function getFormattedBodyContent()
{
}
public function getFormattedFooterContent()
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\View\Traits {
trait AdminAreaHookTrait
{
public function runHookAdminFooterOutput(array $hookVariables)
{
}
public function runHookAdminHeaderOutput(array $hookVariables)
{
}
public function runHookAdminHeadOutput(array $hookVariables)
{
}
public function runHookAdminAreaPage(array $hookVariables)
{
}
}
trait JavascriptTrait
{
protected $jquery = array();
protected $javascript = array();
protected $javascriptChart = array();
public function addJquery($code)
{
}
public function addJavascript($code)
{
}
public function addJavascriptChart($name)
{
}
public function getFormattedJquery()
{
}
public function getFormattedJavascript()
{
}
protected function getChartRedrawJavascript()
{
}
public function getJquery()
{
}
public function setJquery($jquery)
{
}
public function getJavascript()
{
}
public function setJavascript($javascript)
{
}
public function getJavascriptChart()
{
}
public function setJavascriptChart($javascriptChart)
{
}
public function modal($name, $title, $message, array $buttons = array(), $size = "", $panelType = "primary")
{
}
public function modalWithConfirmation($name, $question, $url, $jsVariable = "invoice")
{
}
}
trait PageContextTrait
{
protected $charset = "";
protected $favicon = "";
protected $title = "";
protected $helpLink = "";
protected $csrfToken = "";
protected $versionHash = "";
protected $dateFormat = "";
protected $htmlHeadElements = array();
public function getFavicon()
{
}
public function setFavicon($favicon)
{
}
public function getTitle()
{
}
public function setTitle($title)
{
}
public function getHelpLink()
{
}
public function setHelpLink($helpLink)
{
}
public function getCsrfToken()
{
}
public function setCsrfToken($csrfToken)
{
}
public function getVersionHash()
{
}
public function setVersionHash($versionHash)
{
}
public function getCharset()
{
}
public function setCharset($charset)
{
}
public function getDateFormat()
{
}
public function setDateFormat($dateFormat)
{
}
public function getLicenseBannerHtml()
{
}
public function getHtmlHeadElements()
{
}
public function setHtmlHeadElements($htmlHeadElements)
{
}
public function getFormattedHtmlHeadContent()
{
}
public function addHtmlHeadElement($htmlHeadElement)
{
}
}
abstract class SidebarTrait
{
protected $sidebarName = "";
protected $sidebarNameOptions = array("support", "config", "home", "clients", "utilities", "billing", "orders", "addonmodules", "reports");
public abstract function getAdminUser();
public function getSidebarName()
{
}
public function setSidebarName($name)
{
}
public function isSidebarMinimized()
{
}
public function getSidebarVariables()
{
}
}
abstract class TemplatePageTrait
{
protected $templateVariables = NULL;
protected $templateEngine = NULL;
protected $templateDirectory = "";
protected $templateName = "";
protected abstract function factoryEngine();
public function getTemplateVariables()
{
}
public function setTemplateVariables($templateVariables)
{
}
public function getTemplateEngine()
{
}
public function setTemplateEngine($templateEngine)
{
}
public function getTemplateDirectory()
{
}
public function setTemplateDirectory($templateDirectory)
{
}
public function getTemplateName()
{
}
public function setTemplateName($templateName)
{
}
}
trait AdminHtmlViewTrait
{
use \WHMCS\Admin\ApplicationSupport\View\Traits\AdminAreaHookTrait;
use \WHMCS\Admin\ApplicationSupport\View\Traits\AdminUserContextTrait;
use \WHMCS\Admin\ApplicationSupport\View\Traits\BodyContentTrait;
use \WHMCS\Admin\ApplicationSupport\View\Traits\JavascriptTrait;
use \WHMCS\Admin\ApplicationSupport\View\Traits\NotificationTrait;
use \WHMCS\Admin\ApplicationSupport\View\Traits\PageContextTrait;
use \WHMCS\Admin\ApplicationSupport\View\Traits\SidebarTrait;
use \WHMCS\Admin\ApplicationSupport\View\Traits\TemplatePageTrait;
public function prepareVariableContent()
{
}
protected function getNonHookTemplateVariables()
{
}
public function getTemplateDirectory()
{
}
public function standardTemplateVariables()
{
}
}
trait VersionTrait
{
private $version = NULL;
public function getFeatureVersion()
{
}
public function getVersion()
{
}
public function setVersion($version)
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\View\Html\Php {
class TemplatePage extends \WHMCS\Admin\ApplicationSupport\View\Html\ContentWrapper
{
use \WHMCS\Admin\ApplicationSupport\View\Traits\AdminHtmlViewTrait;
use \WHMCS\Admin\ApplicationSupport\View\Traits\VersionTrait;
public function __construct($templateName, array $data = array(), $status = 200, array $headers = array())
{
}
public function getTemplateDirectory()
{
}
protected function factoryEngine()
{
}
public function getBodyContent()
{
}
}
}
namespace WHMCS\Admin\Utilities\Assent\View {
class AssentPage extends \WHMCS\Admin\ApplicationSupport\View\Html\Php\TemplatePage
{
public function getTemplateDirectory()
{
}
}
}
namespace WHMCS\Admin\Utilities\Tools\EmailMarketer {
class Controller
{
public function manage(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function save(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Utilities\Tools\TldSync {
class TldSyncController
{
public function importStart(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function importLoad(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function calculatePricing($existingTlds, $tldImportItems, $currencies)
{
}
public function importTlds(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Utilities\Tools\ServerSync {
class SyncItem
{
protected $moduleValues = array();
protected $uniqueIdField = NULL;
protected $productField = NULL;
protected $services = NULL;
public function __construct(array $moduleValues, $uniqueIdField, $servicesCollection, $productField)
{
}
protected function determineServiceMatches($uniqueIdField, $servicesCollection)
{
}
public function getUniqueIdentifier()
{
}
public function getName()
{
}
public function getPrimaryIp()
{
}
public function getProduct()
{
}
public function getStatus()
{
}
public function getDomain()
{
}
public function getUsername()
{
}
public function getEmail()
{
}
public function getProductField()
{
}
public function getCreated()
{
}
public function getServices()
{
}
public function getServicesCount()
{
}
public function hasMatches()
{
}
public function hasMultipleMatches()
{
}
public function hasExactMatch()
{
}
public function getMatches()
{
}
}
class Process
{
public static function import(\WHMCS\Admin\Utilities\Tools\ServerSync\SyncItem $syncItem, \WHMCS\Module\Server $moduleInterface, $serverId, array $additional = array())
{
}
public static function sync(\WHMCS\Admin\Utilities\Tools\ServerSync\SyncItem $syncItem, \WHMCS\Admin\Utilities\Tools\ServerSync\ServiceItem $serviceItem, $serverId)
{
}
public static function terminate(\WHMCS\Service\Service $service)
{
}
}
class ServiceItem
{
protected $service = NULL;
protected $syncItem = NULL;
protected $uniqueIdField = NULL;
protected $productField = NULL;
public function __construct(\WHMCS\Service\Service $service, \WHMCS\Admin\Utilities\Tools\ServerSync\SyncItem $syncItem, $uniqueIdField, $productField)
{
}
public function getService()
{
}
protected function syncItem()
{
}
public function getId()
{
}
public function getUniqueIdentifier()
{
}
public function getName()
{
}
public function getPrimaryIp()
{
}
public function getProduct()
{
}
public function getStatus()
{
}
public function getUsername()
{
}
public function getCreated()
{
}
public function hasUniqueIdMatch()
{
}
public function hasPrimaryIpMatch()
{
}
public function hasProductMatch()
{
}
public function hasUsernameMatch()
{
}
public function hasStatusMatch()
{
}
public function hasCreatedMatch()
{
}
public function getProductField()
{
}
public function isTerminated()
{
}
}
class Controller
{
public function analyse(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function process(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Utilities\Tools {
class EmailMarketer extends \WHMCS\Model\AbstractModel
{
protected $table = "tblemailmarketer";
protected $pivotTable = "tblemailmarketer_related_pivot";
protected $columnMap = array("disabled" => "disable");
public function createPivotTable($drop = false)
{
}
public function setSettingsAttribute($settings)
{
}
public function getSettingsAttribute()
{
}
public function products()
{
}
public function addons()
{
}
}
class ToolsRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Utilities\System\PhpCompat\View\AccordionByCompat {
class AccordionGroup
{
protected $id = "";
protected $subId = "";
protected $description = "";
protected $title = "";
protected $data = array();
protected $titleCssClass = "";
public function getId()
{
}
public function setId($id)
{
}
public function getSubId()
{
}
public function setSubId($subId)
{
}
public function getDescription()
{
}
public function setDescription($description)
{
}
public function getTitle()
{
}
public function setTitle($title)
{
}
public function getData()
{
}
public function setData($data)
{
}
public function getCollapseId()
{
}
public function getHeadingId()
{
}
public function getTableId()
{
}
public function getTitleIconClass()
{
}
public function getTitleBadgeCount()
{
}
public function getTitleCssClass()
{
}
public function setTitleCssClass($titleCssClass)
{
}
}
}
namespace WHMCS\Admin\Utilities\System\PhpCompat\View\AccordionByCompat\Style {
class ThreeAssessmentGroup
{
protected $assessmentGroups = array();
public function __construct()
{
}
public function defaultAssessmentGroups($phpVersionId = NULL)
{
}
}
}
namespace WHMCS\Admin\Utilities\System\PhpCompat\View {
abstract class AbstractVersionDetails
{
protected $style = NULL;
protected $phpVersion = "";
protected $phpVersionId = "";
protected $iterator = NULL;
protected $ioncubeLoader = NULL;
public function __construct($phpVersion, $phpVersionId, $iterator, $ioncubeLoader, $whmcsCompat)
{
}
public abstract function getHtml();
public function getPhpVersion()
{
}
public function setPhpVersion($phpVersion)
{
}
public function getPhpVersionId()
{
}
public function setPhpVersionId($phpVersionId)
{
}
public function getIterator()
{
}
public function setIterator($iterator)
{
}
public function getIoncubeLoader()
{
}
public function setIoncubeLoader($ioncubeLoader)
{
}
}
}
namespace WHMCS\Admin\Utilities\System\PhpCompat\View\AccordionByCompat {
class VersionDetails extends \WHMCS\Admin\Utilities\System\PhpCompat\View\AbstractVersionDetails
{
protected $assessmentGroups = array();
public function __construct($phpVersion, $phpVersionId, $iterator, $ioncubeLoader, $whmcsCompat, $style = NULL)
{
}
public function getHtml()
{
}
protected function getAssessmentViewGroups()
{
}
protected function getAccordionHtml()
{
}
}
}
namespace WHMCS\Admin\Utilities\System\PhpCompat {
class PhpCompatController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function scan(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function getVersionDataWithAccordionCompat(\WHMCS\Environment\Ioncube\Contracts\InspectorIteratorInterface $inspector)
{
}
}
}
namespace WHMCS\Admin\Utilities\System {
class SystemRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
}
namespace WHMCS\Admin\Utilities\System\Automation {
class AutomationController
{
public function getDetail(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\Help {
class HelpRouteProvider implements \WHMCS\Route\Contracts\DeferredProviderInterface
{
use \WHMCS\Route\AdminProviderTrait;
public function getRoutes()
{
}
public function getDeferredRoutePathNameAttribute()
{
}
}
class HelpController
{
use \WHMCS\Application\Support\Controller\DelegationTrait;
protected function getLicense()
{
}
public function forceLicenseCheck(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function sendLicenseUpgradeRequest(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function fetchLicenseUpgradeData(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function viewLicense(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\View {
class PreRenderProcessor
{
public function process($html)
{
}
public function mutateRelativePathsToAbsolutePaths($html = "")
{
}
public function autoAddTokensToForms($html = "")
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\View\Html\Helper {
class ClientSearchDropdown implements \WHMCS\View\HtmlPageInterface
{
protected $nameAttribute = "";
protected $selected = "";
protected $selectOptions = array();
protected $placeholderText = "";
protected $dataValueFieldAttribute = "id";
protected $fieldTabIndex = 0;
public function __construct($nameAttribute, $selectedOption = "", array $selectOptions = array(), $placeholderText = "", $dataValueFieldAttribute = "id", $fieldTabIndex = 0)
{
}
public function getFormattedHtmlHeadContent()
{
}
public function getFormattedHeaderContent()
{
}
protected function getHtmlSelectOptions()
{
}
public function getFormattedBodyContent()
{
}
public function getFormattedFooterContent()
{
}
public function getNameAttribute()
{
}
public function setNameAttribute($nameAttribute = "")
{
}
public function getSelected()
{
}
public function setSelected($selectedOption = "")
{
}
public function getSelectOptions()
{
}
public function setSelectOptions(array $selectOptions = array())
{
}
public function getPlaceholderText()
{
}
public function setPlaceholderText($placeholderText = "")
{
}
public function getDataValueFieldAttribute()
{
}
public function setDataValueFieldAttribute($dataValueFieldAttribute = "id")
{
}
public function getFieldTabIndex()
{
}
public function setFieldTabIndex($fieldTabIndex = 0)
{
}
}
class GlobalWarning
{
const GLOBAL_WARNING_COOKIE_NAME = "DismissGlobalWarning";
public function getWarningScopes()
{
}
public function getNotifications()
{
}
public function getDismissalTracker()
{
}
public function updateDismissalTracker($alertToDismiss = "")
{
}
protected function setCookie(array $data = array())
{
}
protected function getCookie()
{
}
protected function getGlobalWarningDismissalHTML($alert)
{
}
protected function checkWarningSsl()
{
}
protected function getWarningHTMLSsl()
{
}
protected function checkWarningNonStrictMode()
{
}
protected function getDatabase()
{
}
protected function getWarningHTMLNonStrictMode()
{
}
protected function checkWarningHookDebugMode()
{
}
protected function getWarningHTMLHookDebugMode()
{
}
}
class SortableTable
{
protected static $tables = array();
protected static $sortData = array();
protected $tableId = 0;
protected $orderBy = "";
protected $orderDirection = "";
protected $page = 0;
protected $totalPages = 0;
protected $rowLimit = 1;
protected $sortPage = NULL;
protected $pagination = false;
protected $sortableTableCount = 0;
protected $defaultRowLimit = 50;
protected $jqueryCode = array();
protected $rowsOfData = 0;
protected $request = NULL;
public function __construct(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function fetchUserSortData()
{
}
public function storeUserSortData(array $data = array())
{
}
public function factorySimpleTable($page = 0, $limit = NULL)
{
}
public function factoryPaginatedTable($tableNamespace, $columnOrderBy, $defaultOrderDirection = NULL, $page = 0, $limit = NULL)
{
}
public function getHtml($columns, $tableData, $formUrl = "", $formButtons = "", $topButtons = "")
{
}
protected function getHiddenInputHtml()
{
}
protected function getPaginationSelector()
{
}
protected function getPaginationForm()
{
}
public function getTableId()
{
}
public function setTableId($tableId)
{
}
public function getOrderBy()
{
}
public function setOrderBy($orderBy)
{
}
public function getOrderDirection()
{
}
public function setOrderDirection($orderDirection)
{
}
public function getPage()
{
}
public function setPage($page)
{
}
public function getRowLimit()
{
}
public function setRowLimit($rowLimit)
{
}
public function getSortPage()
{
}
public function setSortPage($sortPage)
{
}
public function hasPagination()
{
}
public function setPagination($pagination)
{
}
public function getSortableTableCount()
{
}
public function setSortableTableCount($sortableTableCount)
{
}
public function getDefaultRowLimit()
{
}
public function setDefaultRowLimit($defaultRowLimit)
{
}
public function getJqueryCode()
{
}
public function addJqueryCode($jqueryCode)
{
}
public function getTotalPages()
{
}
public function setTotalPages($totalPages)
{
}
public function getRowsOfData()
{
}
public function setRowsOfData($rowsOfData)
{
}
public function getRequest()
{
}
public function setRequest($request)
{
}
}
class ClientSelectedDropDown extends \WHMCS\Admin\ApplicationSupport\View\Html\Helper\ClientSearchDropdown
{
protected $selectedClientId = 0;
public function __construct($nameAttribute = "userid", $selectedClientId = 0)
{
}
public function getSelectedClientId()
{
}
public function setSelectedClientId($selectedClientId)
{
}
protected function getSelectOptionsForClientId($clientId = 0)
{
}
protected function getHtmlSelectOptions()
{
}
}
class ContactSelectedDropDown extends \WHMCS\Admin\ApplicationSupport\View\Html\Helper\ClientSelectedDropDown
{
protected $includeClientAsOption = false;
protected $selectorClass = "selectize-contact-search";
protected $client = NULL;
public function __construct(\WHMCS\User\Client $client, $includeClientAsOption = false, $nameAttribute = "userid", $selected = 0)
{
}
public function setSelectedClientId($selectedClientId)
{
}
protected function getSelectOptionsForClientId($clientId = 0)
{
}
}
class TabbedContent implements \WHMCS\View\HtmlPageInterface, \Countable
{
protected $activeTabId = 0;
protected $firstTabOpenByDefault = false;
protected $tabs = NULL;
protected $tabPrefix = "";
public function __construct($tabPrefix = "", $firstTabOpenByDefault = false, \SplDoublyLinkedList $dll = NULL)
{
}
public function isFirstTabOpenByDefault()
{
}
public function setFirstTabOpenByDefault($firstTabOpenByDefault)
{
}
public function getTabPrefix()
{
}
public function setTabPrefix($tabPrefix)
{
}
public function addTabContent($label, $content, $addTabParamToUrls = true, $id = NULL)
{
}
public function addTabParamToUrls($id, $content)
{
}
public function count()
{
}
public function getFormattedHeaderContent()
{
}
public function buildHtmlList()
{
}
public function setActiveTabId($id = 0)
{
}
public function getActiveTabId()
{
}
public function buildHtmlContentContainer()
{
}
public function getJQueryCode()
{
}
public function getFormattedHtmlHeadContent()
{
}
public function getFormattedBodyContent()
{
}
public function getFormattedFooterContent()
{
}
protected function isActiveTab($key)
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\View\Html {
abstract class AbstractNoEngine extends \WHMCS\Http\Message\AbstractViewableResponse implements \WHMCS\View\HtmlPageInterface
{
use \WHMCS\Admin\ApplicationSupport\View\Traits\AdminHtmlViewTrait;
protected function factoryEngine()
{
}
public function getOutputContent()
{
}
public function getFormattedHtmlHeadContent()
{
}
public function getFormattedHeaderContent()
{
}
public function getFormattedFooterContent()
{
}
public function getFormattedBodyContent()
{
}
}
class PopUp extends \WHMCS\Admin\ApplicationSupport\View\Html\AbstractNoEngine
{
public function __construct($data = "", $status = 200, array $headers = array())
{
}
public function getFormattedHeaderContent()
{
}
public function getFormattedFooterContent()
{
}
}
abstract class AbstractTemplateEngine extends \WHMCS\Http\Message\AbstractViewableResponse implements \WHMCS\View\HtmlPageInterface
{
use \WHMCS\Admin\ApplicationSupport\View\Traits\AdminHtmlViewTrait;
public abstract function getFormattedHeaderContent();
public abstract function getFormattedBodyContent();
public abstract function getFormattedFooterContent();
public function prepareVariableContent()
{
}
public function getOutputContent()
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\View\Html\Smarty {
class BodyContentWrapper extends \WHMCS\Admin\ApplicationSupport\View\Html\AbstractTemplateEngine
{
public function __construct($data = "", $status = 200, array $headers = array())
{
}
public function getFormattedBodyContent()
{
}
protected function factoryEngine()
{
}
public function getFormattedFooterContent()
{
}
public function getFormattedHeaderContent()
{
}
}
class TemplateBody extends \WHMCS\Admin\ApplicationSupport\View\Html\Smarty\BodyContentWrapper
{
public function __construct($bodyTemplateName)
{
}
public function getBodyContent()
{
}
}
class ErrorPage extends \WHMCS\Admin\ApplicationSupport\View\Html\Smarty\BodyContentWrapper
{
public function __construct($data = "", $status = 200, array $headers = array())
{
}
public function getBody()
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\Http\Message {
class ResponseFactory
{
public function genericError(\WHMCS\Http\Message\ServerRequest $request, $statusCode = 500)
{
}
public function missingPermission(\WHMCS\Http\Message\ServerRequest $request, array $permissionNames = array(), $allRequired = true)
{
}
public function invalidCsrfToken(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Admin\ApplicationSupport\Route\Middleware {
class DirectoryValidation implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\DelegatingMiddlewareTrait;
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function assertAdminDirectory(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function hasDefaultAdminDirectoryOnDisk()
{
}
protected function messageForgetAboutDefaultAdminDir()
{
}
protected function messageForgetToConfigureCustomAdminPath()
{
}
protected function messageAccessingAdminFileOutsideOfCustomAdminPath()
{
}
}
class Authentication implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\DelegatingMiddlewareTrait;
protected $adminAuth = null;
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
protected function prepareAdminLanguage(\WHMCS\User\Admin $user)
{
}
protected function getAdminAuth()
{
}
protected function setAdminAuth($adminAuth)
{
}
}
class AuthenticationConfirmation extends \WHMCS\Admin\ApplicationSupport\Route\Middleware\Authentication
{
public function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function authenticationConfirmation(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function checkUserConfirmation(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\User\Admin $user)
{
}
protected function isPreviousConfirmationStale()
{
}
}
class Authorization extends \WHMCS\Security\Middleware\Authorization
{
public function getDefaultCsrfNamespace()
{
}
protected function responseMissingMultiplePermissions(array $permissionNames = array())
{
}
protected function responseMissingPermission(array $permissionNames = array())
{
}
protected function responseInvalidCsrfToken()
{
}
}
class Assent implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\DelegatingMiddlewareTrait;
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
}
namespace WHMCS\Token {
class Query
{
const DEFAULT_TOKEN_NAME = "TokenQuery";
public function __construct($name = "")
{
}
public function generateToken()
{
}
public function isValidTokenFormat($token)
{
}
public function setTokenValue($token)
{
}
public function getTokenValue()
{
}
public function getQuery($token = "")
{
}
public function setQuery($token = "", $query = "")
{
}
public function generateRandomAlphanumeric($length = 16)
{
}
public function setTokenName($name)
{
}
public function getTokenName()
{
}
}
}
namespace WHMCS\Domain\Ssl {
class Downloader
{
public function getCertificate($domain)
{
}
}
class Status extends \WHMCS\Model\AbstractModel
{
protected $table = "tblsslstatus";
protected $fillable = array("user_id", "domain_name");
protected $booleans = array("active");
protected $dates = array("start_date", "expiry_date", "last_synced_date");
protected $allowAutoResync = true;
public function createTable($drop = false)
{
}
public static function factory($userId, $domainName)
{
}
public function needsResync()
{
}
public function disableAutoResync()
{
}
protected function downloadAndSyncCertificate()
{
}
public function syncAndSave()
{
}
public function client()
{
}
public function isActive()
{
}
public function isInactive()
{
}
public function getStatus()
{
}
public function getStatusDisplayLabel()
{
}
public function getFormattedExpiryDate()
{
}
public function getTooltipContent()
{
}
public function getImagePath()
{
}
protected function getImageFilepath($filename)
{
}
public function getClass()
{
}
}
class Certificate
{
protected $certData = NULL;
public function __construct($certData = NULL)
{
}
protected function normaliseCertificateData($data)
{
}
public function getSubjectCommonName()
{
}
public function getSubjectOrg()
{
}
public function getIssuerName()
{
}
public function getIssuerOrg()
{
}
public function getStartDate()
{
}
public function getExpiryDate()
{
}
protected function parseIssuerString($string)
{
}
protected function parseDate($date)
{
}
}
}
namespace WHMCS\Domain {
class AdditionalField extends \WHMCS\Model\AbstractModel
{
protected $table = "tbldomainsadditionalfields";
protected $fillable = array("domainid", "name");
public function domain()
{
}
}
class Domain extends \WHMCS\Model\AbstractModel
{
protected $table = "tbldomains";
protected $dates = array("registrationdate", "expirydate", "nextduedate", "nextinvoicedate");
protected $columnMap = array("clientId" => "userid", "registrarModuleName" => "registrar", "promotionId" => "promoid", "paymentGateway" => "paymentmethod", "hasDnsManagement" => "dnsmanagement", "hasEmailForwarding" => "emailforwarding", "hasIdProtection" => "idprotection", "hasAutoInvoiceOnNextDueDisabled" => "donotrenew", "isSyncedWithRegistrar" => "synced", "isPremium" => "is_premium");
protected $booleans = array("hasDnsManagement", "hasEmailForwarding", "hasIdProtection", "isPremium", "hasAutoInvoiceOnNextDueDisabled", "isSyncedWithRegistrar");
protected $characterSeparated = array("|" => array("reminders"));
protected $appends = array("tld", "extension", "gracePeriod", "gracePeriodFee", "redemptionGracePeriod", "redemptionGracePeriodFee");
public function scopeOfClient(\Illuminate\Database\Eloquent\Builder $query, $clientId)
{
}
public function scopeNextDueBefore(\Illuminate\Database\Eloquent\Builder $query, \WHMCS\Carbon $date)
{
}
public function scopeIsConsideredActive(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function getTldAttribute()
{
}
public function client()
{
}
public function additionalFields()
{
}
public function extra()
{
}
public function order()
{
}
public function paymentGateway()
{
}
public function invoiceItems()
{
}
public function setRemindersAttribute($reminders)
{
}
public function failedActions()
{
}
public function isConfiguredTld()
{
}
public function getAdditionalFields()
{
}
public function getExtensionAttribute()
{
}
public function getGracePeriodAttribute()
{
}
public function getGracePeriodFeeAttribute()
{
}
public function getRedemptionGracePeriodAttribute()
{
}
public function getRedemptionGracePeriodFeeAttribute()
{
}
public function getLink()
{
}
}
class Extra extends \WHMCS\Model\AbstractModel
{
protected $table = "tbldomains_extra";
protected $fillable = array("domain_id", "name");
public $guardedForUpdate = array("domain_id", "name");
public function domain()
{
}
public function createTable($drop = false)
{
}
}
}
namespace WHMCS\Domain\TopLevel {
class ImportItem
{
protected $extension = NULL;
protected $registerPrice = NULL;
protected $renewPrice = NULL;
protected $graceFeePrice = NULL;
protected $graceFeeDays = NULL;
protected $redemptionFeePrice = NULL;
protected $redemptionFeeDays = NULL;
protected $transferPrice = NULL;
protected $currencyCode = NULL;
protected $minYears = 1;
protected $yearsStep = 1;
protected $maxYears = 1;
protected $years = array();
protected $eppRequired = false;
public function setExtension($extension)
{
}
public function setRegisterPrice($price = NULL)
{
}
public function setRenewPrice($price = NULL)
{
}
public function setGraceFeePrice($price = NULL)
{
}
public function setGraceFeeDays($days = NULL)
{
}
public function setRedemptionFeePrice($price = NULL)
{
}
public function setRedemptionFeeDays($days = NULL)
{
}
public function setTransferPrice($price = NULL)
{
}
public function setCurrency($currencyCode)
{
}
public function setYears(array $years)
{
}
public function setMinYears($years)
{
}
public function setMaxYears($years)
{
}
public function setYearsStep($years)
{
}
public function setEppRequired($required)
{
}
public function getExtension()
{
}
protected function isIdn()
{
}
protected function hasAsteriskInTld()
{
}
public function isUnsupportedTld()
{
}
public function getRegisterPrice()
{
}
public function getRenewPrice()
{
}
public function getGraceFeePrice()
{
}
public function getGraceFeeDays()
{
}
public function getRedemptionFeePrice()
{
}
public function getRedemptionFeeDays()
{
}
public function getTransferPrice()
{
}
public function getMinYears()
{
}
public function getMaxYears()
{
}
public function getYearsStep()
{
}
public function getCurrency()
{
}
public function getRequiresEpp()
{
}
public function getYears()
{
}
public function toArray()
{
}
public static function fromArray(array $data)
{
}
}
class GracePeriod
{
public static function getForTld($tld)
{
}
}
class RedemptionGracePeriod
{
public static function getForTld($tld)
{
}
}
class Categories
{
protected $data = NULL;
protected $loaded = false;
const DIRECTORY = NULL;
const FILENAME = "categories.json";
const REMOVE_KEYWORD = "REMOVE";
protected function getDirectory()
{
}
protected function load()
{
}
protected function setData($data)
{
}
protected function applyUserCustomisations($userData)
{
}
public function getAllTlds()
{
}
public function hasTld($tld)
{
}
public function getCategoriesByTld($tld, $allowOther = true)
{
}
public function getCategoriesByTlds(array $tlds)
{
}
protected function formatTld($tld)
{
}
}
}
namespace WHMCS\Domain {
class Checker
{
protected $request = NULL;
protected $lookupProvider = NULL;
protected $domain = NULL;
protected $type = "";
protected $searchResult = array();
public function __construct(\WHMCS\Domains\DomainLookup\Provider\AbstractProvider $lookupProvider = NULL)
{
}
public function ajaxCheck()
{
}
public function cartDomainCheck(\WHMCS\Domains\Domain $searchDomain, array $tlds)
{
}
public function getLookupProvider()
{
}
public function getSearchResult()
{
}
public function populateSuggestionsInSmartyValues(array &$smartyVariables)
{
}
protected function conditionallyReleaseSession()
{
}
protected function checkCaptcha()
{
}
protected function processIdnLabel($label)
{
}
protected function prepareAjaxDomain()
{
}
protected function checkDomain()
{
}
protected function checkIncart()
{
}
protected function checkOwndomain()
{
}
protected function checkSpotlight()
{
}
protected function checkSubdomain()
{
}
protected function checkSuggestions()
{
}
protected function checkTransfer()
{
}
protected function overrideCheckIfDomainAlreadyOrdered()
{
}
protected function processPremiumDomains()
{
}
protected function cartPreventDuplicateProduct($domain)
{
}
public function populateCartWithDomainSmartyVariables($domainOption, array &$smartyVariables)
{
}
protected function getTldsList()
{
}
protected function getSpotlightTlds()
{
}
}
class Status
{
protected $statusValues = NULL;
const PENDING = "Pending";
const PENDING_REGISTRATION = "Pending Registration";
const PENDING_TRANSFER = "Pending Transfer";
const ACTIVE = "Active";
const GRACE = "Grace";
const REDEMPTION = "Redemption";
const EXPIRED = "Expired";
const TRANSFERRED_AWAY = "Transferred Away";
const CANCELLED = "Cancelled";
const FRAUD = "Fraud";
public function all()
{
}
public function allWithTranslations()
{
}
protected function translate($status)
{
}
public function translatedDropdownOptions(array $selectedStatus = NULL)
{
}
}
}
namespace WHMCS\Domain\Registrar {
class Domain
{
protected $domain = NULL;
protected $expiryDate = NULL;
protected $registrationStatus = NULL;
protected $restorable = NULL;
protected $renewBeforeExpiration = NULL;
protected $idProtectionStatus = NULL;
protected $dnsManagementStatus = NULL;
protected $emailForwardingStatus = NULL;
protected $nameservers = array();
protected $transferLock = NULL;
protected $transferLockExpiryDate = NULL;
protected $irtpOptOutStatus = NULL;
protected $irtpTransferLock = NULL;
protected $irtpTransferLockExpiryDate = NULL;
protected $domainContactChangePending = NULL;
protected $domainContactChangeExpiryDate = NULL;
protected $willDomainSuspend = NULL;
protected $isIrtpEnabled = NULL;
protected $irtpVerificationTriggerFields = array();
protected $registrantEmailAddress = NULL;
const STATUS_ACTIVE = "Active";
const STATUS_ARCHIVED = "Archived";
const STATUS_DELETED = "Deleted";
const STATUS_EXPIRED = "Expired";
const STATUS_INACTIVE = "InActive";
const STATUS_SUSPENDED = "Suspended";
const STATUS_PENDING_DELETE = "Pending Delete Restorable";
public function getRegistrantEmailAddress()
{
}
public function setRegistrantEmailAddress($registrantEmailAddress)
{
}
public function getDomain()
{
}
public function setDomain($domain)
{
}
public function getExpiryDate()
{
}
public function setExpiryDate(\WHMCS\Carbon $expiryDate = NULL)
{
}
public function getRegistrationStatus()
{
}
public function setRegistrationStatus($registrationStatus)
{
}
public function getRestorable()
{
}
public function setRestorable($restorable)
{
}
public function getRenewBeforeExpiration()
{
}
public function setRenewBeforeExpiration($renewBeforeExpiration)
{
}
public function getIdProtectionStatus()
{
}
public function setIdProtectionStatus($idProtectionStatus)
{
}
public function getDnsManagementStatus()
{
}
public function setDnsManagementStatus($dnsManagementStatus)
{
}
public function getEmailForwardingStatus()
{
}
public function setEmailForwardingStatus($emailForwardingStatus)
{
}
public function hasNameservers()
{
}
public function getNameservers()
{
}
public function setNameservers($nameservers)
{
}
public function hasTransferLock()
{
}
public function getTransferLock()
{
}
public function setTransferLock($transferLock)
{
}
public function getTransferLockExpiryDate()
{
}
public function setTransferLockExpiryDate(\WHMCS\Carbon $transferLockExpiryDate = NULL)
{
}
public function getIrtpOptOutStatus()
{
}
public function setIrtpOptOutStatus($irtpOptOutStatus)
{
}
public function getIrtpTransferLock()
{
}
public function setIrtpTransferLock($irtpTransferLock)
{
}
public function getIrtpTransferLockExpiryDate()
{
}
public function setIrtpTransferLockExpiryDate(\WHMCS\Carbon $irtpTransferLockExpiryDate)
{
}
public function isContactChangePending()
{
}
public function setDomainContactChangePending($domainContactChangePending)
{
}
public function getDomainContactChangeExpiryDate()
{
}
public function setDomainContactChangeExpiryDate(\WHMCS\Carbon $domainContactChangeExpiryDate = NULL)
{
}
public function getPendingSuspension()
{
}
public function setPendingSuspension($willDomainSuspend)
{
}
public function setIsIrtpEnabled($isIrtpEnabled)
{
}
public function getIsIrtpEnabled()
{
}
public function isIrtpEnabled()
{
}
public function setIrtpVerificationTriggerFields(array $fields = array())
{
}
public function getIrtpVerificationTriggerFields()
{
}
}
}
namespace WHMCS\CustomField {
class CustomFieldValue extends \WHMCS\Model\AbstractModel
{
protected $table = "tblcustomfieldsvalues";
protected $columnMap = array("relatedId" => "relid");
protected $fillable = array("fieldid", "relid");
public function customField()
{
}
public function addon()
{
}
public function client()
{
}
public function service()
{
}
}
}
namespace WHMCS\Marketing {
class SubscriptionController
{
public function manage(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class Consent extends \WHMCS\Model\AbstractModel
{
protected $table = "tblmarketing_consent";
protected $booleans = array("optIn", "admin");
public function client()
{
}
public static function logOptIn($userId, $userIp = "")
{
}
public static function logOptOut($userId, $userIp = "")
{
}
}
class EmailSubscription
{
const ACTION_OPTIN = "optin";
const ACTION_OPTOUT = "optout";
public static function isUsingOptInField()
{
}
public function generateOptInUrl($userId, $email)
{
}
public function generateOptOutUrl($userId, $email)
{
}
protected function generateOptInOutUrl($action, $userId, $email)
{
}
public function generateKey($userId, $email, $action)
{
}
public function validateKey(\WHMCS\User\Client $client, $action, $key)
{
}
}
}
namespace WHMCS\Filter {
class Json
{
public static function safeDecode($content, $assoc = false, $depth = 512, $options = 0)
{
}
}
class Input
{
public static function url($url)
{
}
}
class HostAddress
{
public function __construct($hostname, $ipAddress = "", $port = "")
{
}
public function getIpAddress()
{
}
public function getIpAddressForUrl()
{
}
public function getHostname()
{
}
public function getHostnameForUrl()
{
}
public function getPort()
{
}
}
}
namespace WHMCS\Download\Controller {
class DownloadController
{
public function index(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function viewCategory(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function search(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
}
namespace WHMCS\Download {
class Download extends \WHMCS\Model\AbstractModel
{
protected $table = "tbldownloads";
protected $columnMap = array("downloadCategoryId" => "category", "timesDownloaded" => "downloads", "fileLocation" => "location", "clientDownloadOnly" => "clientsonly", "isHidden" => "hidden", "isProductDownload" => "productdownload");
protected $booleans = array("clientDownloadOnly", "isHidden", "isProductDownload");
public function asLink()
{
}
public function downloadCategory()
{
}
public function products()
{
}
public function scopeConsiderProductDownloads(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeTopDownloads(\Illuminate\Database\Eloquent\Builder $query, $count = 5)
{
}
public static function boot()
{
}
public function translatedNames()
{
}
public function translatedDescriptions()
{
}
public function scopeInCategory(\Illuminate\Database\Eloquent\Builder $query, $catId)
{
}
public function scopeVisible(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeCategoryVisible(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeSearch(\Illuminate\Database\Eloquent\Builder $query, $search)
{
}
}
class Category extends \WHMCS\Model\AbstractModel
{
protected $table = "tbldownloadcats";
protected $columnMap = array("isHidden" => "hidden");
protected $booleans = array("isHidden");
public function parentCategory()
{
}
public function childCategories()
{
}
public function downloads()
{
}
public function scopeOfParent(\Illuminate\Database\Eloquent\Builder $query, $parentId = 0)
{
}
public function scopeVisible(\Illuminate\Database\Eloquent\Builder $query)
{
}
}
}
namespace WHMCS\Download\View {
class Index extends \WHMCS\ClientArea
{
protected function initializeView()
{
}
public function formatDownloadsForTemplate($downloads)
{
}
}
}
namespace WHMCS {
class Carbon extends \Carbon\Carbon
{
protected static $days = NULL;
protected static $shortDays = NULL;
protected static $months = NULL;
protected static $shortMonths = NULL;
protected static $daySuffixes = NULL;
protected static $timeSuffixes = NULL;
protected static $supportedLocales = array("af", "ar", "az", "bg", "bn", "ca", "cs", "da", "de", "el", "en", "eo", "es", "et", "eu", "fa", "fi", "fo", "fr", "he", "hr", "hu", "id", "it", "ja", "ko", "lt", "lv", "ms", "nl", "no", "pl", "pt", "pt_BR", "ro", "ru", "sk", "sl", "sq", "sr", "sv", "th", "tr", "uk", "uz", "vi", "zh", "zh-TW");
const JANUARY = 1;
const FEBRUARY = 2;
const MARCH = 3;
const APRIL = 4;
const MAY = 5;
const JUNE = 6;
const JULY = 7;
const AUGUST = 8;
const SEPTEMBER = 9;
const OCTOBER = 10;
const NOVEMBER = 11;
const DECEMBER = 12;
const JAN = 1;
const FEB = 2;
const MAR = 3;
const APR = 4;
const JUN = 6;
const JUL = 7;
const AUG = 8;
const SEPT = 9;
const OCT = 10;
const NOV = 11;
const DEC = 12;
const TH = 0;
const ND = 1;
const RD = 2;
const ST = 3;
const SUN = 0;
const MON = 1;
const TUE = 2;
const WED = 3;
const THU = 4;
const FRI = 5;
const SAT = 6;
const AM = 0;
const PM = 1;
const am = 2;
const pm = 3;
public function format($format)
{
}
public function translatePassedToFormat($dateTime, $format)
{
}
public function translateTimestampToFormat($timestamp, $format)
{
}
public static function setLocale($locale)
{
}
public function getAdminDateFormat($withTime = false)
{
}
public function toAdminDateFormat()
{
}
public function toAdminDateTimeFormat()
{
}
public static function createFromAdminDateFormat($dateString)
{
}
public static function createFromAdminDateTimeFormat($dateTimeString)
{
}
public function getClientDateFormat($withTime = false)
{
}
public function toClientDateFormat()
{
}
public function toClientDateTimeFormat()
{
}
public static function parseDateRangeValue($value, $withTime = false)
{
}
public static function fromCreditCard($date)
{
}
public function toCreditCard()
{
}
public static function optionalValueForCreditCardInput($value)
{
}
public static function createFromCcInput($monthYear)
{
}
public function whmcsTimeDiffForHumans(\DateTimeInterface $new, $absolute = false)
{
}
protected function translateKey($langKey)
{
}
public static function safeCreateFromMySqlDate($mysqlDate)
{
}
public function toMicroTime()
{
}
public function startOfMonthMicro()
{
}
public function endOfMonthMicro()
{
}
public function startOfDayMicro()
{
}
public function endOfDayMicro()
{
}
public static function createFromTimestamp($timestamp, $tz = NULL)
{
}
}
}
namespace WHMCS\Http {
trait DataTrait
{
protected $rawData = array();
public function getRawData()
{
}
public function setRawData($rawData)
{
}
}
trait PriceDataTrait
{
public function mutatePriceToFull($data = array())
{
}
}
class JsonResponse extends \Symfony\Component\HttpFoundation\JsonResponse
{
use \WHMCS\Http\DataTrait;
use \WHMCS\Http\PriceDataTrait;
public function setData($data = array())
{
}
}
class Request
{
protected static $trustedProxies = array();
protected static $trustedHostPatterns = array();
protected static $trustedHosts = array();
protected static $trustedHeaders = NULL;
protected $headers = array();
protected $server = array();
const HEADER_CLIENT_IP = "client_ip";
const HEADER_CLIENT_HOST = "client_host";
const HEADER_CLIENT_PROTO = "client_proto";
const HEADER_CLIENT_PORT = "client_port";
public function __construct($server = array())
{
}
public static function setTrustedProxies(array $proxies)
{
}
public static function getTrustedProxies()
{
}
public static function setTrustedHeaderName($key, $value)
{
}
public static function getTrustedHeaderName($key)
{
}
public function getClientIps()
{
}
public function getClientIp()
{
}
public static function defineProxyTrustFromApplication(\WHMCS\Application $whmcs)
{
}
}
}
namespace WHMCS\Http\Message {
abstract class AbstractAttachmentResponse extends \Zend\Diactoros\Response
{
use \Zend\Diactoros\Response\InjectContentTypeTrait;
protected $data = NULL;
protected $attachmentFilename = NULL;
public function __construct($data, $attachmentFilename, $status = 200, array $headers = array())
{
}
public function getData()
{
}
public function setData($data)
{
}
public function getAttachmentFilename()
{
}
public function setAttachmentFilename($attachmentFilename)
{
}
protected abstract function createDataStream();
protected abstract function getDataContentType();
protected abstract function getDataContentLength();
protected function getDataContentDisposition()
{
}
}
class CsvAttachmentResponse extends \WHMCS\Http\Message\AbstractAttachmentResponse
{
public function __construct($data, $attachmentFilename, $status = 200, array $headers = array())
{
}
protected function prepareData(array $data)
{
}
protected function createDataStream()
{
}
protected function getDataContentType()
{
}
protected function getDataContentLength()
{
}
}
class FileAttachmentResponse extends \WHMCS\Http\Message\AbstractAttachmentResponse
{
public function __construct($file, $attachmentFilename = NULL, $status = 200, array $headers = array())
{
}
protected function createDataStream()
{
}
protected function getDataContentType()
{
}
protected function getDataContentLength()
{
}
}
}
namespace WHMCS\Route\Contracts {
interface MapInterface
{
public function mapRoute($route);
public function getMappedRoute($key);
public function getMappedAttributeName();
}
}
namespace WHMCS\Route {
abstract class HandleMapTrait
{
protected $routes = array();
public abstract function getMappedAttributeName();
public function mapRoute($route)
{
}
public function getMappedRoute($key)
{
}
}
}
namespace WHMCS\Http\Message {
class ResponseFactory implements \WHMCS\Route\Contracts\MapInterface
{
use \WHMCS\Route\HandleMapTrait;
const RESPONSE_TYPE_JSON = "JSON_MESSAGE";
const RESPONSE_TYPE_HTML = "HTML_MESSAGE";
public function getMappedAttributeName()
{
}
public function factory(\WHMCS\Http\Message\ServerRequest $request, $data = NULL)
{
}
public function factoryFromException(\WHMCS\Http\Message\ServerRequest $request, \WHMCS\Exception\HttpCodeException $exception)
{
}
public function factoryAccessDenied(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function factoryInvalidCsrfToken(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function factoryLoginRequired(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class JsonResponse extends \Zend\Diactoros\Response\JsonResponse
{
use \WHMCS\Http\DataTrait;
use \WHMCS\Http\PriceDataTrait;
public function __construct($data, $status = 200, array $headers = array(), $encodingOptions = \Zend\Diactoros\Response\JsonResponse::DEFAULT_JSON_FLAGS)
{
}
public function withData($data, $encodingOptions = \Zend\Diactoros\Response\JsonResponse::DEFAULT_JSON_FLAGS)
{
}
}
class XmlResponse extends \Zend\Diactoros\Response\TextResponse
{
use \WHMCS\Http\DataTrait;
use \Zend\Diactoros\Response\InjectContentTypeTrait;
use \WHMCS\Http\PriceDataTrait;
public function __construct($data = "", $status = 200, array $headers = array())
{
}
public function convertToBody($data = array())
{
}
protected function convertToXml($val, $lastk = "", $printed = false)
{
}
}
class JsonAttachmentResponse extends \WHMCS\Http\Message\AbstractAttachmentResponse
{
public function __construct($data, $attachmentFilename, $status = 200, array $headers = array(), $encodingOptions = \Zend\Diactoros\Response\JsonResponse::DEFAULT_JSON_FLAGS)
{
}
protected function createDataStream()
{
}
protected function getDataContentType()
{
}
protected function getDataContentLength()
{
}
}
class JsonFormResponse extends \WHMCS\Http\Message\JsonResponse
{
public static function createWithSuccess($data = NULL)
{
}
public static function createWithErrors(array $data)
{
}
}
}
namespace WHMCS\Http {
class IpUtils
{
public static function checkIp($requestIp, $ips)
{
}
public static function checkIp4($requestIp, $ip)
{
}
public static function checkIp6($requestIp, $ip)
{
}
}
}
namespace WHMCS\MarketConnect {
class MarketConnect
{
public static $services = array("symantec" => "Symantec", "weebly" => "Weebly", "spamexperts" => "SpamExperts", "sitelock" => "Sitelock", "sitelockvpn" => "SitelockVPN", "codeguard" => "CodeGuard", "marketgoo" => "Marketgoo");
const PRICING_TERM_FREE = 100;
public static function getServices()
{
}
public static function hasActiveServices()
{
}
public static function getActiveServices()
{
}
public static function isActive($service)
{
}
public static function getProductKeys()
{
}
public static function getProductKeysToServices()
{
}
public static function factoryPromotionalHelperByProductKey($productKey)
{
}
public static function getClassByService($service)
{
}
public static function factoryPromotionalHelper($service)
{
}
public static function getMenuItems($loggedIn = false)
{
}
protected static function getMenuItemsChildren(&$i = 0, $order = 1000)
{
}
public static function getSidebarMenuItems(&$i, $order = 0)
{
}
public function activate($service)
{
}
public function deactivate($service)
{
}
public function createProductsFromApiResponse($products)
{
}
public static function isAccountConfigured()
{
}
public static function accountEmail()
{
}
public static function getApiBearerToken()
{
}
public function removeMarketplaceAddons($addons)
{
}
protected function getAddonsByGroup($addons)
{
}
public function getAdminMarketplaceAddonPromo($addons, $billingCycle, $orderItemId)
{
}
public function getMarketplaceConfigureProductAddonPromoHtml($addons, $billingCycle)
{
}
}
}
namespace WHMCS\MarketConnect\Services {
interface ServiceInterface extends \WHMCS\Contracts\ServiceProvisionInterface
{
}
abstract class AbstractService implements \WHMCS\MarketConnect\Services\ServiceInterface
{
public abstract function provision($model, array $params);
public abstract function configure($model, array $params);
public abstract function cancel($model, array $params);
public function renew($model, array $params = NULL)
{
}
public function install($model)
{
}
public function adminManagementButtons($params)
{
}
public function adminServicesTabOutput(array $params, \WHMCS\MarketConnect\OrderInformation $orderInfo = NULL, array $actionBtns = NULL)
{
}
public function emailMergeData(array $params, array $passedData = array())
{
}
public function isSslProduct()
{
}
}
class Weebly extends \WHMCS\MarketConnect\Services\AbstractService
{
public function provision($model, array $params = NULL)
{
}
public function configure($model, array $params = NULL)
{
}
public function cancel($model, array $params = NULL)
{
}
public function clientAreaAllowedFunctions(array $params)
{
}
public function clientAreaOutput(array $params)
{
}
public function adminServicesTabOutput(array $params, \WHMCS\MarketConnect\OrderInformation $orderInfo = NULL, array $actionBtns = NULL)
{
}
public function isEligibleForUpgrade()
{
}
public function updateFtpDetails(array $params)
{
}
}
class Marketgoo extends \WHMCS\MarketConnect\Services\AbstractService
{
public function provision($model, array $params = NULL)
{
}
public function configure($model, array $params = NULL)
{
}
public function cancel($model, array $params = NULL)
{
}
public function adminServicesTabOutput(array $params, \WHMCS\MarketConnect\OrderInformation $orderInformation = NULL, array $actionButtons = NULL)
{
}
public function isEligibleForUpgrade()
{
}
public function clientAreaAllowedFunctions(array $params)
{
}
public function clientAreaOutput(array $params)
{
}
}
class Symantec extends \WHMCS\MarketConnect\Services\AbstractService
{
public function provision($model, array $params = NULL)
{
}
public function configure($model, array $params = NULL, \WHMCS\Service\Service $relatedHostingService = NULL)
{
}
protected function applyCompetitiveUpgradeFreeMonths($model, $freeMonths)
{
}
public function cancel($model, array $params = NULL)
{
}
public function install($model)
{
}
public function clientAreaAllowedFunctions(array $params)
{
}
public function clientAreaOutput(array $params)
{
}
public function renew($model, array $params = NULL)
{
}
protected function getMarketplaceServerType($serverType)
{
}
public function generateCsr($model, \WHMCS\Module\Server $serverInterface, array $params = NULL)
{
}
public function adminServicesTabOutput(array $params, \WHMCS\MarketConnect\OrderInformation $orderInfo = NULL, array $actionBtns = NULL)
{
}
protected function fileAuthUpload(\WHMCS\Module\Server $serverInterface, $initialDomain, array $response)
{
}
public function isEligibleForUpgrade()
{
}
public function isSslProduct()
{
}
}
class CodeGuard extends \WHMCS\MarketConnect\Services\AbstractService
{
public function provision($model, array $params = NULL)
{
}
public function configure($model, array $params = NULL)
{
}
public function cancel($model, array $params = NULL)
{
}
public function clientAreaAllowedFunctions(array $params)
{
}
public function clientAreaOutput(array $params)
{
}
public function adminServicesTabOutput(array $params, \WHMCS\MarketConnect\OrderInformation $orderInformation = NULL, array $actionButtons = NULL)
{
}
public function emailMergeData(array $params, array $preCalculatedMergeData = array())
{
}
public function isEligibleForUpgrade()
{
}
}
class Sitelock extends \WHMCS\MarketConnect\Services\AbstractService
{
public function provision($model, array $params = NULL)
{
}
public function configure($model, array $params = NULL)
{
}
protected function provisionFtp($model, $parentModel)
{
}
protected function provisionDns($model, $parentModel, $dnsRecordsToProvision)
{
}
public function cancel($model, array $params = NULL)
{
}
public function clientAreaAllowedFunctions($params)
{
}
public function clientAreaOutput(array $params)
{
}
public function adminServicesTabOutput(array $params, \WHMCS\MarketConnect\OrderInformation $orderInformation = NULL, array $actionButtons = NULL)
{
}
public function isEligibleForUpgrade()
{
}
}
class SitelockVPN extends \WHMCS\MarketConnect\Services\AbstractService
{
public function provision($model, array $params = NULL)
{
}
public function configure($model, array $params = NULL)
{
}
public function cancel($model, array $params = NULL)
{
}
public function clientAreaAllowedFunctions($params)
{
}
public function clientAreaOutput(array $params)
{
}
public function adminServicesTabOutput(array $params, \WHMCS\MarketConnect\OrderInformation $orderInformation = NULL, array $actionButtons = NULL)
{
}
public function isEligibleForUpgrade()
{
}
}
class SpamExperts extends \WHMCS\MarketConnect\Services\AbstractService
{
public function provision($model, array $params = NULL)
{
}
public function configure($model, array $params = NULL)
{
}
public function cancel($model, array $params = NULL)
{
}
public function clientAreaAllowedFunctions($params)
{
}
public function clientAreaOutput(array $params)
{
}
public function adminServicesTabOutput(array $params, \WHMCS\MarketConnect\OrderInformation $orderInformation = NULL, array $actionButtons = NULL)
{
}
public function isEligibleForUpgrade()
{
}
public function emailMergeData(array $params, array $preCalculatedMergeData = array())
{
}
}
}
namespace WHMCS\MarketConnect\Output {
class ClientArea extends \WHMCS\ClientArea
{
protected function getCurrencyOptions()
{
}
}
}
namespace WHMCS\MarketConnect {
class SpamExpertsController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class MarketgooController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class Promotion
{
const SERVICES = array("symantec" => array("vendorName" => "DigiCert", "vendorSystemName" => "symantec", "serviceTitle" => "SSL Certificates", "tagLine" => "The World's #1 Security Solution", "description" => "Sell SSL's from DigiCert, the world's premier high-assurance digital certificate provider.", "supportsSso" => false, "serviceList" => false), "weebly" => array("vendorName" => "Weebly", "vendorSystemName" => "weebly", "serviceTitle" => "Website Builder", "tagLine" => "The World's Leading Website Builder", "description" => "Make it easier for customers to create a website with Weebly's drag and drop site builder.", "supportsSso" => false, "serviceList" => true, "features" => array("builder", "ecommerce", "forms", "templates", "gallery", "blogging", "video", "seo")), "codeguard" => array("vendorName" => "CodeGuard", "vendorSystemName" => "codeguard", "serviceTitle" => "Website Backup", "tagLine" => "Backup solutions", "description" => "Automated website backup with one-click restores, malware detection and WordPress management.", "supportsSso" => false, "serviceList" => true), "sitelock" => array("vendorName" => "SiteLock", "vendorSystemName" => "sitelock", "serviceTitle" => "Website Security", "tagLine" => "Cloud-based Website Protection & Malware Removal", "description" => "Security and malware scanning, detection and removal plus WAF and CDN services.", "supportsSso" => false, "serviceList" => true), "sitelockvpn" => array("vendorName" => "SiteLock", "vendorSystemName" => "sitelockvpn", "serviceTitle" => "VPN", "tagLine" => "Web Browsing Security & Protection", "description" => "Offer High Speed, Secure, and Easy to Use VPN Security and Protection for Web Browsing.", "supportsSso" => false, "serviceList" => true), "spamexperts" => array("vendorName" => "SpamExperts", "vendorSystemName" => "spamexperts", "serviceTitle" => "Email Security", "tagLine" => "Business Class Email Filtering & Compliance", "description" => "Offer professional email services including Anti-Spam, Virus Protection and Email Archiving.", "supportsSso" => false, "serviceList" => true), "marketgoo" => array("vendorName" => "Marketgoo", "vendorSystemName" => "marketgoo", "serviceTitle" => "SEO Tools", "description" => "Help grow businesses with easy, do-it-yourself SEO tools.", "supportsSso" => false, "serviceList" => true));
const DEFAULT_SETTINGS = array(array("name" => "auto-assign-addons", "label" => "Auto Assign to Addons", "description" => "Automatically assign these products as add-on options to all applicable products", "default" => true), array("name" => "activate-landing-page", "label" => "Landing Page Links", "description" => "Activate navigation link within the client area navigation bar", "default" => true));
public static function initHooks()
{
}
public static function cartViewPromotion($checkout = false)
{
}
protected static function renderPromotionsCarousel($promotions)
{
}
}
class Api
{
const MARKETPLACE_LIVE_URL = "https://marketplace.whmcs.com/api/";
const MARKETPLACE_TESTING_URL = "https://testing.marketplace.whmcs.com/api/";
const MARKETPLACE_LOCAL_TESTING_URL = "http://localhost:8000/api/";
const MARKETPLACE_API_VERSION = "v1";
public function link($email, $password, $licenseKey, $agreetos)
{
}
public function register($firstname, $lastname, $company, $email, $password, $licenseKey, $agreetos)
{
}
public function balance()
{
}
public function services()
{
}
public function activate($service)
{
}
public function deactivate($service)
{
}
public function purchase($service, $term)
{
}
public function configure(array $configurationData)
{
}
public function renew($orderNumber, $term, $callbackUrl = "")
{
}
public function extra($function, array $params = array())
{
}
public function cancel($orderNumber)
{
}
public function status($orderNumber)
{
}
public function sso()
{
}
public function ssoForService($service)
{
}
public function ssoForOrder($orderNumber)
{
}
public function upgrade($orderNumber, $service, $term)
{
}
public function validateCompetitiveUpgrade($url)
{
}
public function testCodeGuardWebsiteConnection(array $params)
{
}
protected function get($action, array $data = array(), $timeout = NULL)
{
}
protected function post($action, array $data = array(), $timeout = NULL)
{
}
protected function useMarketplaceTestingEnv()
{
}
protected function useMarketplaceLocalTestingEnv()
{
}
protected function getApiUrl()
{
}
protected function call($action, $method, $data, $timeout = 300)
{
}
}
class SitelockVPNController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class AdminController
{
public function dispatch(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getBalance(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function showLearnMore(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function showManage(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function sso(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function doSsoRedirect(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function link(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function register(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function disconnect(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function activate(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function deactivate(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function enableProduct(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function disableProduct(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function setPricing(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function setPromoStatus(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function setGeneralSetting(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function ssoForService(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function getServices(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function ssoForServiceId(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function getIntroTourSteps()
{
}
}
class MarketConnectServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider implements \WHMCS\Route\Contracts\ProviderInterface
{
use \WHMCS\Route\ProviderTrait;
public function register()
{
}
protected function getRoutes()
{
}
public function registerRoutes(\FastRoute\RouteCollector $routeCollector)
{
}
}
class ServicesFeed
{
protected $services = NULL;
public function __construct()
{
}
protected function performRemoteFetch()
{
}
protected function getServicesCache()
{
}
protected function isGroupIdInFeed($id)
{
}
public function getServicesByGroupId($id)
{
}
public function getEmulationOfConfiguredProducts($groupSlug)
{
}
public function isNotAvailable()
{
}
public function getTerms($productKey = NULL)
{
}
public function getPricingMatrix($products)
{
}
public function getPricing($keyToFetch = "price")
{
}
public function getCostPrice($productKey)
{
}
public function getRecommendedRetailPrice($productKey)
{
}
public function convertRecommendedRrpPrices($rate)
{
}
public static function removeCache()
{
}
}
class CodeGuardController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function getFaqs()
{
}
}
}
namespace WHMCS\MarketConnect\Promotion {
class Promotion
{
protected $promotion = NULL;
protected $product = NULL;
protected $upsellService = NULL;
public function __construct(\WHMCS\MarketConnect\Promotion\PromotionContentWrapper $promotion, \WHMCS\Product\Product $product, $upsellService = NULL)
{
}
public function getPromotion()
{
}
public function getProduct()
{
}
public function getUpsellService()
{
}
protected function getTemplate()
{
}
protected function getTargetUrl()
{
}
protected function getInputParameters()
{
}
public function render()
{
}
public function __toString()
{
}
}
class UpsellPromotion extends \WHMCS\MarketConnect\Promotion\Promotion
{
protected $supportsUpgrades = NULL;
protected function serviceSupportsUpgrade()
{
}
protected function getTargetUrl()
{
}
protected function getInputParameters()
{
}
}
class PromotionContentWrapper
{
protected $serviceName = NULL;
protected $productKey = NULL;
protected $upsell = NULL;
protected $data = NULL;
public function __construct($serviceName, $productKey, $promoData, $isUpsell = false)
{
}
public function validatePromoData($promoData)
{
}
public function getServiceName()
{
}
public function getId()
{
}
public function canShowPromo()
{
}
public function getTemplate()
{
}
public function getClass()
{
}
public function getImagePath()
{
}
protected function getText($key)
{
}
protected function getLanguageKey($key)
{
}
protected function langStringOrFallback($key, $fallbackText)
{
}
public function getHeadline()
{
}
public function getTagline()
{
}
public function getDescription()
{
}
public function hasFeatures()
{
}
public function getFeatures()
{
}
public function hasHighlights()
{
}
public function getHighlights()
{
}
public function getLearnMoreRoute()
{
}
public function getCta()
{
}
}
}
namespace WHMCS\MarketConnect\Promotion\Service {
abstract class AbstractService
{
protected $name = NULL;
protected $friendlyName = NULL;
protected $productKeys = array();
protected $qualifyingProductTypes = array();
protected $settings = array();
protected $upsells = array();
protected $defaultPromotionalContent = array();
protected $promotionalContent = array();
protected $upsellPromoContent = array();
protected $loginPanel = NULL;
protected $supportsUpgrades = true;
protected $promoteToNewClients = false;
protected $promosRequireQualifyingProducts = true;
protected $requiresDomain = true;
protected $noPromotionStatuses = array("Cancelled", "Terminated", "Fraud");
public function getProductKeys()
{
}
public function getName()
{
}
public function getModel()
{
}
public function getSettings()
{
}
public function supportsUpgrades()
{
}
public function doPromosRequireQualifyingProducts()
{
}
public function collectionContains($collection, $contains)
{
}
public function getBestUpsell($productKey)
{
}
public function getPromotionalContent($promotionalKey)
{
}
public function getUpsellPromotionalContent($promotionalKey)
{
}
public function getRecommendedProductKeyForUpgrade($productKey)
{
}
protected function getAddonArray(array $groupedAddons, $addons, $billingCycle)
{
}
public function cartViewPromotion()
{
}
public function cartCheckoutPromotion()
{
}
protected function cartPromo($callingLocation)
{
}
public function clientHasActiveServices()
{
}
public function supportsLogin()
{
}
public function getLoginPanel()
{
}
public function getPromotedProduct()
{
}
public function clientAreaHomeOutput()
{
}
public function clientAreaSidebars()
{
}
public function productDetailsLogin(\WHMCS\Service\Service $serviceModel)
{
}
public function productDetailsOutput(\WHMCS\Service\Service $serviceModel)
{
}
public function adminCartConfigureProductAddon($addonsByGroup, $addons, $billingCycle, $orderItemId)
{
}
public function getProductKeyPrefixes()
{
}
public function cartConfigureProductAddon($addonsByGroup, $addons, $billingCycle)
{
}
protected function getAddonToSelectByDefault()
{
}
protected function getExcludedFromNewPurchaseAddonIds()
{
}
protected function renderCartConfigureProductAddon($addonOptions, $firstCycle)
{
}
public function requiresDomain()
{
}
}
class Weebly extends \WHMCS\MarketConnect\Promotion\Service\AbstractService
{
protected $name = "weebly";
protected $friendlyName = "Weebly";
protected $primaryIcon = "assets/img/marketconnect/weebly/logo.png";
protected $primaryLandingPageRouteName = "store-websitebuilder-index";
protected $promoteToNewClients = true;
protected $productKeys = array("weebly_lite", "weebly_free", "weebly_starter", "weebly_pro", "weebly_business");
protected $qualifyingProductTypes = NULL;
protected $upsells = array("weebly_lite" => array("weebly_starter", "weebly_pro", "weebly_business"), "weebly_free" => array("weebly_starter", "weebly_pro", "weebly_business"), "weebly_starter" => array("weebly_pro", "weebly_business"), "weebly_pro" => array("weebly_business"));
protected $loginPanel = array("label" => "marketConnect.weebly.buildWebsite", "icon" => "fa-desktop", "image" => "assets/img/marketconnect/weebly/dragdropeditor.png", "color" => "blue", "dropdownReplacementText" => "");
protected $settings = array(array("name" => "include-weebly-free-by-default", "label" => "Include Weebly Free by Default", "description" => "Automatically pre-select Weebly Free by default for new orders of all applicable products", "default" => true));
protected $upsellPromoContent = array("weebly_starter" => array("imagePath" => "assets/img/marketconnect/weebly/logo.png", "headline" => "Upgrade to Weebly Starter", "tagline" => "To unlock the full power of Weebly", "features" => array("Ideal for personal websites and blogs", "Create Unlimited Pages", "No Weebly Ads", "Basic eCommerce Functionality"), "learnMoreRoute" => "store-websitebuilder-index", "cta" => "Upgrade to"), "weebly_pro" => array("imagePath" => "assets/img/marketconnect/weebly/logo.png", "headline" => "Upgrade to Weebly Pro", "tagline" => "For even more power and flexibility", "features" => array("Up to 25 eCommerce Products", "Rich HD Video & Audio Content", "Password Protected Pages", "Powerful Site Search"), "learnMoreRoute" => "store-websitebuilder-index", "cta" => "Upgrade to"), "weebly_business" => array("imagePath" => "assets/img/marketconnect/weebly/logo.png", "headline" => "Upgrade to Weebly Business", "tagline" => "Ideal for eCommerce and SMBs", "features" => array("Sell unlimited eCommerce Products", "More powerful eCommerce features", "Coupons & Tax Calculation", "0% Weebly Transaction fees"), "learnMoreRoute" => "store-websitebuilder-index", "cta" => "Upgrade to"));
protected $idealFor = array("weebly_free" => "Starting Out", "weebly_starter" => "Personal Use", "weebly_pro" => "Groups + Organizations", "weebly_business" => "Businesses + Stores");
protected $siteFeatures = array("weebly_lite" => array("Drag & Drop Builder", "1 Page", "Powered by Weebly line"), "weebly_free" => array("Drag & Drop Builder", "Unlimited Pages", "Powered by Weebly line"), "weebly_starter" => array("ddBuilder" => "Drag & Drop Builder", "pages" => "Unlimited Pages", "noAds" => "No Weebly Ads"), "weebly_pro" => array("ddBuilder" => "Drag & Drop Builder", "pages" => "Unlimited Pages", "noAds" => "No Weebly Ads", "search" => "Site Search", "passwords" => "Password Protection", "backgrounds" => "Video Backgrounds", "hdVideo" => "HD Video & Audio", "memberCount" => "Up to 100 Members"), "weebly_business" => array("ddBuilder" => "Drag & Drop Builder", "pages" => "Unlimited Pages", "noAds" => "No Weebly Ads", "search" => "Site Search", "passwords" => "Password Protection", "backgrounds" => "Video Backgrounds", "hdVideo" => "HD Video & Audio", "memberCount" => "Up to 100 Members", "registration" => "Membership Registration"));
protected $ecommerceFeatures = array("weebly_starter" => array("3pcFee" => "3% Weebly Transaction Fees", "tenProducts" => "Up to 10 Products", "checkoutOnWeebly" => "Checkout on Weebly.com"), "weebly_pro" => array("3pcFee" => "3% Weebly Transaction Fees", "twentyFiveProducts" => "Up to 25 Products", "checkoutOnWeebly" => "Checkout on Weebly.com"), "weebly_business" => array("0pcFee" => "0% Weebly Transaction Fees", "unlimitedProducts" => "Unlimited Products", "checkoutOnWeebly" => "Checkout on Weebly.com", "inventory" => "Inventory Management", "coupons" => "Coupons", "tax" => "Tax Calculator"));
protected $defaultPromotionalContent = array("imagePath" => "assets/img/marketconnect/icons/weebly.png", "headline" => "Drag & drop site builder", "tagline" => "Powered by Weebly™", "features" => array("Powerful drag and drop website builder", "No coding knowledge needed", "Over 100 pre-made themes", "Drag and drop editor"), "learnMoreRoute" => "store-websitebuilder-index", "cta" => "Add Weebly");
protected $promotionalContent = array("weebly_free" => array("imagePath" => "assets/img/marketconnect/icons/weebly.png", "headline" => "Drag & drop site builder", "tagline" => "Powered by Weebly™", "features" => array("Powerful drag and drop website builder", "No coding knowledge needed", "Over 100 pre-made themes", "Drag and drop editor"), "learnMoreRoute" => "store-websitebuilder-index", "cta" => "Start building a website for"));
protected $recommendedUpgradePaths = array("weebly_lite" => "weebly_starter", "weebly_free" => "weebly_starter", "weebly_starter" => "weebly_pro", "weebly_pro" => "weebly_business");
public function getIdealFor($key)
{
}
public function getSiteFeatures($key)
{
}
public function getEcommerceFeatures($key)
{
}
public function getFeaturesForUpgrade($key)
{
}
protected function getAddonToSelectByDefault()
{
}
}
class Marketgoo extends \WHMCS\MarketConnect\Promotion\Service\AbstractService
{
protected $name = "marketgoo";
protected $friendlyName = "Marketgoo";
protected $primaryIcon = "assets/img/marketconnect/marketgoo/logo.png";
protected $primaryLandingPageRouteName = "store-marketgoo-index";
protected $productKeys = array("marketgoo_lite", "marketgoo_pro");
protected $qualifyingProductTypes = NULL;
protected $loginPanel = array("label" => "marketConnect.marketgoo.manageSEO", "icon" => "fa-search", "image" => "assets/img/marketconnect/marketgoo/logo-sml.svg", "color" => "blue", "dropdownReplacementText" => "");
protected $recommendedUpgradePaths = array("marketgoo_lite" => "marketgoo_pro");
protected $upsells = array("marketgoo_lite" => array("marketgoo_pro"));
protected $upsellPromoContent = array("marketgoo_pro" => array("imagePath" => "assets/img/marketconnect/marketgoo/logo-sml.svg", "headline" => "Upgrade to Marketgoo Pro", "tagline" => "Get a step-by-step plan", "features" => array("Daily scanning of up to 1000 Pages", "Track more competitors and keywords", "Daily PDF Reports", "Complete with step-by-step guide"), "learnMoreRoute" => "store-marketgoo-index", "cta" => "Upgrade to"));
protected $defaultPromotionalContent = array("imagePath" => "assets/img/marketconnect/marketgoo/logo-sml.svg", "headline" => "Improve Website Traffic", "tagline" => "With SEO Tools from marketgoo", "features" => array("Search engine submission", "Weekly scanning of up to 50 Pages", "Track your competitors", "Monthly PDF Progress Report"), "learnMoreRoute" => "store-marketgoo-index", "cta" => "Buy", "ctaRoute" => "store-marketgoo-index");
public function getPlanFeatures($key)
{
}
public function getFeaturesForUpgrade($key)
{
}
protected function getAddonToSelectByDefault()
{
}
}
class Symantec extends \WHMCS\MarketConnect\Promotion\Service\AbstractService
{
protected $name = "ssl";
protected $friendlyName = "SSL";
protected $primaryIcon = "assets/img/marketconnect/symantec/ssl.png";
protected $primaryLandingPageRouteName = "store-ssl-certificates-index";
protected $supportsUpgrades = false;
protected $qualifyingProductTypes = NULL;
protected $productKeys = array("rapidssl_rapidssl", "rapidssl_wildcard", "geotrust_quickssl", "geotrust_quicksslpremium", "geotrust_truebizid", "geotrust_truebizidev", "geotrust_quicksslpremiumwildcard", "geotrust_truebizidwildcard", "digicert_securesite", "digicert_securesitepro", "digicert_securesiteev", "digicert_securesiteproev");
protected $sslTypes = array("dv" => array("rapidssl_rapidssl", "geotrust_quickssl", "geotrust_quicksslpremium"), "ov" => array("geotrust_truebizid", "digicert_securesite", "digicert_securesitepro"), "ev" => array("geotrust_truebizidev", "digicert_securesiteev", "digicert_securesiteproev"), "wildcard" => array("rapidssl_wildcard", "geotrust_quicksslpremiumwildcard", "geotrust_truebizidwildcard"));
protected $certificateFeatures = array("rapidssl_rapidssl" => array("displayName" => "RapidSSL", "validation" => "Domain", "issuance" => "Minutes", "for" => "Personal Websites", "retail" => "59.00", "warranty" => "10,000", "seal" => "Static", "ev" => false), "rapidssl_wildcard" => array("displayName" => "RapidSSL Wildcard", "validation" => "Domain", "issuance" => "Minutes", "for" => "Personal Websites", "retail" => "249.00", "warranty" => "10,000", "seal" => "Static", "ev" => false), "geotrust_quicksslpremium" => array("displayName" => "Geotrust QuickSSL Premium", "validation" => "Domain", "issuance" => "Minutes", "for" => "Small Business", "retail" => "149.00", "warranty" => "500,000", "seal" => "Dynamic", "ev" => false), "geotrust_quicksslpremiumwildcard" => array("displayName" => "Geotrust QuickSSL Premium Wildcard", "validation" => "Domain", "issuance" => "Minutes", "for" => "Small Business", "retail" => "279.00", "warranty" => "500,000", "seal" => "Dynamic", "ev" => false), "geotrust_truebizid" => array("displayName" => "Geotrust True BusinessID", "validation" => "Domain + Business", "issuance" => "1-3 Days", "for" => "Business", "retail" => "199.00", "warranty" => "1,250,000", "seal" => "Dynamic", "ev" => false), "geotrust_truebizidwildcard" => array("displayName" => "Geotrust True BusinessID Wildcard", "validation" => "Domain + Business", "issuance" => "1-3 Days", "for" => "Business & Ecommerce", "retail" => "599.00", "warranty" => "1,250,000", "seal" => "Dynamic", "ev" => false), "geotrust_truebizidev" => array("displayName" => "Geotrust True BusinessID with EV", "validation" => "Highest Business Validation", "issuance" => "1-5 Days", "for" => "Business & Ecommerce", "retail" => "299.00", "warranty" => "1,500,000", "seal" => "Dynamic", "ev" => true), "digicert_securesite" => array("displayName" => "DigiCert Secure Site", "validation" => "Domain + Business", "issuance" => "1-3 Days", "for" => "Business", "retail" => "399.00", "warranty" => "1,500,000", "seal" => "Dynamic Norton Secured", "ev" => false), "digicert_securesitepro" => array("displayName" => "DigiCert Secure Site Pro", "validation" => "Domain + Business", "issuance" => "1-3 Days", "for" => "Business + Ecommerce", "retail" => "995.00", "warranty" => "1,500,000", "seal" => "Dynamic Norton Secured", "ev" => false), "digicert_securesiteev" => array("displayName" => "DigiCert Secure Site with EV", "validation" => "Highest Business Validation", "issuance" => "1-5 Days", "for" => "Business & Ecommerce", "retail" => "995.00", "warranty" => "1,500,000", "seal" => "Dynamic Norton Secured", "ev" => true), "digicert_securesiteproev" => array("displayName" => "DigiCert Secure Site Pro with EV", "validation" => "Highest Business Validation", "issuance" => "1-5 Days", "for" => "Business & Ecommerce", "retail" => "1499.00", "warranty" => "1,750,000", "seal" => "Dynamic Norton Secured", "ev" => true));
protected $upsells = array("rapidssl_rapidssl" => array("geotrust_truebizidev", "rapidssl_wildcard", "geotrust_truebizidwildcard", "geotrust_truebizid", "geotrust_quicksslpremium"), "rapidssl_wildcard" => array("geotrust_truebizidev", "geotrust_quicksslpremiumwildcard", "geotrust_truebizidwildcard", "digicert_securesiteev"), "geotrust_quickssl" => array("geotrust_truebizidev", "geotrust_truebizid", "geotrust_quicksslpremiumwildcard", "geotrust_truebizidwildcard"), "geotrust_quicksslpremium" => array("geotrust_truebizidev", "geotrust_truebizid", "geotrust_quicksslpremiumwildcard", "geotrust_truebizidwildcard"), "geotrust_truebizid" => array("geotrust_truebizidev", "geotrust_truebizidwildcard", "digicert_securesite"), "geotrust_truebizidev" => array("digicert_securesiteev", "digicert_securesiteproev"), "geotrust_truebizidwildcard" => array("geotrust_truebizidev", "digicert_securesiteev", "digicert_securesiteproev"), "digicert_securesite" => array("digicert_securesiteev", "digicert_securesiteproev"), "digicert_securesitepro" => array("digicert_securesiteproev", "digicert_securesiteev"), "digicert_securesiteev" => array("digicert_securesiteproev"));
protected $defaultPromotionalContent = array("imagePath" => "assets/img/marketconnect/icons/symantec.png", "headline" => "xxxx", "tagline" => "xxxxxx", "features" => array("Activate HTTPS and the lock icon", "Secure online transactions", "Encrypt sensitive data", "Protect user privacy"), "learnMoreRoute" => "store-ssl-certificates-index", "cta" => "Add");
protected $promotionalContent = array("rapidssl_rapidssl" => array("imagePath" => "assets/img/marketconnect/icons/symantec.png", "headline" => "Boost your search rankings", "tagline" => "with a RapidSSL™ Certificate", "features" => array("Activate HTTPS and the lock icon", "Secure online transactions", "Encrypt sensitive data", "Protect user privacy"), "learnMoreRoute" => "store-ssl-certificates-index", "cta" => "Add"), "rapidssl_wildcard" => array("imagePath" => "assets/img/marketconnect/symantec/ssl-subs.png", "headline" => "Secure your subdomains", "tagline" => "with a RapidSSL™ Wildcard certificate", "description" => "Manage security across every subdomain with a single Wildcard SSL certificate", "features" => array("Protects unlimited subdomains", "Activate HTTPS and the lock icon", "One single certificate to install", "99.9% Browser Recognition"), "cta" => "Upgrade to", "learnMoreRoute" => "store-ssl-certificates-wildcard"));
protected $upsellPromoContent = array("rapidssl_wildcard" => array("imagePath" => "assets/img/marketconnect/symantec/ssl-subs.png", "headline" => "Upgrade to Wildcard", "tagline" => "to secure your subdomains too", "features" => array("Protects unlimited subdomains", "Activate HTTPS and the lock icon", "One single certificate to install", "99.9% Browser Recognition"), "cta" => "Upgrade to", "learnMoreRoute" => "store-ssl-certificates-wildcard"), "geotrust_truebizidev" => array("imagePath" => "assets/img/marketconnect/symantec/green-bar-ev-promo.png", "headline" => "Get the green address bar", "tagline" => "with a GeoTrust™ EV certificate", "features" => array("Provides greater trust and authenticity", "Recommended for Business Use", "Padlock with Green Address Bar", "Universal device and browser compatibility"), "cta" => "Upgrade to", "learnMoreRoute" => "store-ssl-certificates-ev"), "geotrust_truebizidwildcard" => array("imagePath" => "assets/img/marketconnect/symantec/ssl-multi.png", "headline" => "Upgrade to OV Wildcard", "tagline" => "for organization level validation", "features" => array("Provides more assurance to customers", "Protects unlimited subdomains", "Activate HTTPS and the lock icon", "One single certificate to install"), "cta" => "Upgrade to", "learnMoreRoute" => "store-ssl-certificates-wildcard"), "geotrust_truebizid" => array("imagePath" => "assets/img/marketconnect/symantec/ssl-subs.png", "headline" => "Upgrade to True BusinessID", "tagline" => "for organization level validation", "features" => array("Provides more assurance to customers", "Protects unlimited subdomains", "Activate HTTPS and the lock icon", "One single certificate to install"), "cta" => "Upgrade to", "learnMoreRoute" => "store-ssl-certificates-ov"), "geotrust_quicksslpremium" => array("imagePath" => "assets/img/marketconnect/symantec/ssl-subs.png", "headline" => "Upgrade to QuickSSL Premium", "tagline" => "Ideal for Small Business", "features" => array("Recommended for Small Business", "USD \$500,000 Warranty Value", "Activate HTTPS and the lock icon", "99.9% Browser Recognition"), "cta" => "Upgrade to", "learnMoreRoute" => "store-ssl-certificates-dv"), "geotrust_quicksslpremiumwildcard" => array("imagePath" => "assets/img/marketconnect/symantec/ssl-subs.png", "headline" => "Upgrade to Premium Wildcard", "tagline" => "and protect unlimited subdomains", "features" => array("Increased assurance for customers", "Protects unlimited subdomains", "Activate HTTPS and the lock icon", "Single certificate to maintain"), "cta" => "Upgrade to", "learnMoreRoute" => "store-ssl-certificates-wildcard"), "digicert_securesite" => array("imagePath" => "assets/img/marketconnect/symantec/ssl-multi.png", "headline" => "Upgrade to Secure Site", "tagline" => "for industry leading assurance", "features" => array("Recommended for businesses", "Ultra strong security encryption", "Maximum warranty protection", "Security for transactions"), "cta" => "Upgrade to", "learnMoreRoute" => "store-ssl-certificates-ov"), "digicert_securesiteev" => array("imagePath" => "assets/img/marketconnect/symantec/ssl-subs.png", "headline" => "Upgrade to Secure Site EV", "tagline" => "for even greater assurance", "features" => array("The best visual assurance and trust cues", "Strongest security algorithms", "Best in class security for transactions", "Award winning support"), "cta" => "Upgrade to", "learnMoreRoute" => "store-ssl-certificates-ev"), "digicert_securesiteproev" => array("imagePath" => "assets/img/marketconnect/symantec/ssl-subs.png", "headline" => "Upgrade to Pro EV", "tagline" => "the highest certificate we offer", "features" => array("Most advanced encryption algorithm", "Powerful visual assurance cues", "Green address bar", "Maximum assurance for visitors"), "cta" => "Upgrade to", "learnMoreRoute" => "store-ssl-certificates-ev"));
public function getSslTypes()
{
}
public function getCertificateFeatures()
{
}
}
class CodeGuard extends \WHMCS\MarketConnect\Promotion\Service\AbstractService
{
protected $name = "codeguard";
protected $friendlyName = "CodeGuard";
protected $primaryIcon = "assets/img/marketconnect/codeguard/logo-sml.png";
protected $primaryLandingPageRouteName = "store-codeguard-index";
protected $productKeys = array("codeguard_lite", "codeguard_personal", "codeguard_professional", "codeguard_business", "codeguard_businessplus", "codeguard_power", "codeguard_powerplus");
protected $qualifyingProductTypes = NULL;
protected $loginPanel = array("label" => "marketConnect.codeguard.manageBackup", "icon" => "fa-hdd", "image" => "assets/img/marketconnect/codeguard/hero-image-a.png", "color" => "lime", "dropdownReplacementText" => "");
protected $defaultPromotionalContent = array("imagePath" => "assets/img/marketconnect/codeguard/logo-sml.png", "headline" => "Daily Website Backup", "tagline" => "Powered by CodeGuard™", "features" => array("Automatic daily website backup", "Automatic one-click restores", "Malware monitoring & alerting", "WordPress update automation"), "learnMoreRoute" => "store-codeguard-index", "cta" => "Add CodeGuard");
protected $upsells = array("codeguard_lite" => array("codeguard_personal"), "codeguard_personal" => array("codeguard_professional"), "codeguard_professional" => array("codeguard_business"), "codeguard_business" => array("codeguard_businessplus"), "codeguard_businessplus" => array("codeguard_power"), "codeguard_power" => array("codeguard_powerplus"));
protected $recommendedUpgradePaths = array("codeguard_lite" => "codeguard_personal", "codeguard_personal" => "codeguard_professional", "codeguard_professional" => "codeguard_business", "codeguard_business" => "codeguard_businessplus", "codeguard_businessplus" => "codeguard_power", "codeguard_power" => "codeguard_powerplus");
public function __construct()
{
}
public static function getDiskSpaceFromName($name)
{
}
public function getFeaturesForUpgrade($key)
{
}
}
class Sitelock extends \WHMCS\MarketConnect\Promotion\Service\AbstractService
{
protected $name = "sitelock";
protected $friendlyName = "Sitelock";
protected $primaryIcon = "assets/img/marketconnect/sitelock/logo.png";
protected $primaryLandingPageRouteName = "store-sitelock-index";
protected $productKeys = array("sitelock_lite", "sitelock_find", "sitelock_fix", "sitelock_defend", "sitelock_emergency");
protected $qualifyingProductTypes = NULL;
protected $loginPanel = array("label" => "marketConnect.sitelock.manageSecurity", "icon" => "fa-bug", "image" => "assets/img/marketconnect/sitelock/logo-sml.png", "color" => "pomegranate", "dropdownReplacementText" => "");
protected $settings = array(array("name" => "include-sitelock-lite-by-default", "label" => "Include SiteLock Lite by Default", "description" => "Automatically pre-select SiteLock Lite by default for new orders of all applicable products", "default" => true));
protected $planFeatures = array("sitelock_lite" => array("Daily Malware Scanning" => true, "Number of Pages" => 5, "Daily Blacklist Monitoring" => true, "SiteLock Risk Score" => true), "sitelock_find" => array("Daily Malware Scanning" => true, "Number of Pages" => 25, "Daily Blacklist Monitoring" => true, "SiteLock Risk Score" => true, "Website Application Scan" => "One Time", "SQL Injection Scan" => "One Time", "Cross Site (XSS) Scan" => "One Time", "Sitelock™ Trust Seal" => true), "sitelock_fix" => array("Daily Malware Scanning" => true, "Number of Pages" => 500, "Daily Blacklist Monitoring" => true, "SiteLock Risk Score" => true, "Website Application Scan" => "Daily", "SQL Injection Scan" => "Daily", "Cross Site (XSS) Scan" => "Daily", "Sitelock™ Trust Seal" => true, "Daily SMART Scans" => true, "Automatic Malware Removal" => true, "TrueShield Protection" => true, "Wordpress Scan" => true, "Spam Blacklist Monitoring" => true), "sitelock_defend" => array("Daily Malware Scanning" => true, "Number of Pages" => 500, "Daily Blacklist Monitoring" => true, "SiteLock Risk Score" => true, "Website Application Scan" => "Daily", "SQL Injection Scan" => "Daily", "Cross Site (XSS) Scan" => "Daily", "Sitelock™ Trust Seal" => true, "Daily SMART Scans" => true, "Automatic Malware Removal" => true, "TrueShield Protection" => true, "Wordpress Scan" => true, "Spam Blacklist Monitoring" => true, "Web Application Firewall" => true, "Global CDN" => true, "Content Acceleration" => true));
protected $recommendedUpgradePaths = array("sitelock_lite" => "sitelock_find", "sitelock_find" => "sitelock_fix", "sitelock_fix" => "sitelock_defend");
protected $upsells = array("sitelock_lite" => array("sitelock_find", "sitelock_fix", "sitelock_defend"), "sitelock_find" => array("sitelock_fix", "sitelock_defend"), "sitelock_fix" => array("sitelock_defend"));
protected $upsellPromoContent = array("sitelock_find" => array("imagePath" => "assets/img/marketconnect/sitelock/logo.png", "headline" => "Upgrade to SiteLock Find", "tagline" => "Stop more malware and vulnerabilities.", "features" => array("Scans up to 25 Pages", "SQL Injection & Cross-Site (XSS) Scan", "Website Application Scan", "WordPress Scan"), "learnMoreRoute" => "store-sitelock-index", "cta" => "Upgrade to"), "sitelock_fix" => array("imagePath" => "assets/img/marketconnect/sitelock/logo.png", "headline" => "Upgrade to SiteLock Fix", "tagline" => "Removes malicious code automatically.", "features" => array("Scans up to 500 Pages", "Daily Vulnerability Scans", "Automatic Malware Removal", "Daily SMART Scans"), "learnMoreRoute" => "store-sitelock-index", "cta" => "Upgrade to"), "sitelock_defend" => array("imagePath" => "assets/img/marketconnect/sitelock/logo.png", "headline" => "Upgrade to SiteLock Defend", "tagline" => "Improves website speed with CDN", "features" => array("Find, Fix, and prevent threats", "Global CDN for increased performance", "Scans up to 500 Pages", "Automatic Malware Removal"), "learnMoreRoute" => "store-sitelock-index", "cta" => "Upgrade to"));
protected $defaultPromotionalContent = array("imagePath" => "assets/img/marketconnect/sitelock/logo.png", "headline" => "Secure your website with SiteLock", "tagline" => "Protect yourself against hackers and malware with SiteLock's industry leading protection.", "features" => array("Daily Malware Scanning", "Daily Blacklist Monitoring", "SiteLock Risk Score", "SiteLock Trust Seal"), "learnMoreRoute" => "store-sitelock-index", "cta" => "Buy", "ctaRoute" => "store-sitelock-index");
protected $promotionalContent = array("sitelock_lite" => array("imagePath" => "assets/img/marketconnect/icons/sitelock.png", "headline" => "Daily Website Scanning", "tagline" => "Security protection by SiteLock™", "features" => array("Try completely free up to 5 pages", "Daily Malware Scanning", "Daily Blacklist Monitoring", "Sitelock Trust Seal"), "learnMoreRoute" => "store-sitelock-index", "cta" => "Try SiteLock", "ctaRoute" => "store-sitelock-index"));
public function getPlanFeatures($key)
{
}
public function getFeaturesForUpgrade($key)
{
}
protected function getAddonToSelectByDefault()
{
}
protected function getExcludedFromNewPurchaseAddonIds()
{
}
}
class SitelockVPN extends \WHMCS\MarketConnect\Promotion\Service\AbstractService
{
protected $name = "sitelockvpn";
protected $friendlyName = "Sitelock VPN";
protected $primaryIcon = "assets/img/marketconnect/sitelockvpn/logo.png";
protected $primaryLandingPageRouteName = "store-sitelockvpn-index";
protected $promosRequireQualifyingProducts = false;
protected $requiresDomain = false;
protected $productKeys = array("sitelockvpn_standard");
protected $qualifyingProductTypes = array();
protected $loginPanel = array("label" => "marketConnect.sitelockvpn.manageVPN", "icon" => "fa-network-wired", "image" => "assets/img/marketconnect/sitelockvpn/logo-sml.png", "color" => "pomegranate", "dropdownReplacementText" => "sitelockvpn.loginPanelText");
protected $defaultPromotionalContent = array("imagePath" => "assets/img/marketconnect/sitelockvpn/logo.png", "headline" => "Secure Your Web Browsing", "tagline" => "High speed and secure VPN service", "features" => array("No Restrictions", "High Speed Network", "Unlimited bandwidth", "256-bit AES Encryption"), "learnMoreRoute" => "store-sitelockvpn-index", "cta" => "Buy", "ctaRoute" => "store-sitelockvpn-index");
protected $planFeatures = array("sitelockvpn_standard" => array("noRestrictions" => "No Restrictions", "highSpeed" => "High Speed Network", "unlimited" => "Unlimited bandwidth", "encryption" => "256-bit AES Encryption"));
public function getPlanFeatures($key)
{
}
}
class SpamExperts extends \WHMCS\MarketConnect\Promotion\Service\AbstractService
{
protected $name = "spamexperts";
protected $friendlyName = "SpamExperts";
protected $primaryIcon = "assets/img/marketconnect/spamexperts/logo.png";
protected $primaryLandingPageRouteName = "store-emailservices-index";
protected $productKeys = array("spamexperts_incoming", "spamexperts_outgoing", "spamexperts_incomingoutgoing", "spamexperts_incomingarchiving", "spamexperts_outgoingarchiving", "spamexperts_incomingoutgoingarchiving");
protected $qualifyingProductTypes = NULL;
protected $loginPanel = array("label" => "marketConnect.spamexperts.manageEmail", "icon" => "fas fa-envelope-open", "image" => "assets/img/marketconnect/spamexperts/logo.png", "color" => "teal", "dropdownReplacementText" => "");
protected $upsells = array("spamexperts_incoming" => array("spamexperts_incomingoutgoing"), "spamexperts_outgoing" => array("spamexperts_incomingoutgoing"), "spamexperts_incomingoutgoing" => array("spamexperts_incomingoutgoingarchiving"), "spamexperts_incomingarchiving" => array("spamexperts_incomingoutgoingarchiving"), "spamexperts_outgoingarchiving" => array("spamexperts_incomingoutgoingarchiving"));
protected $upsellPromoContent = array("spamexperts_incomingoutgoing" => array("imagePath" => "assets/img/marketconnect/spamexperts/logo.png", "headline" => "Add Outgoing Protection", "tagline" => "For complete peace of mind", "features" => array("Inbound and outbound protection", "Protect the reputation of your brand", "Increase outbound email continuity", "Improve email deliverability"), "learnMoreRoute" => "store-emailservices-index", "cta" => "Upgrade to"), "spamexperts_incomingoutgoingarchiving" => array("imagePath" => "assets/img/marketconnect/spamexperts/logo.png", "headline" => "Add Email Archiving", "tagline" => "Complete protection against loss", "features" => array("Full suite of email protection", "Inbound and outbound protection", "Secure backups of all email activity", "Improved email continuity and deliverability"), "learnMoreRoute" => "store-emailservices-index", "cta" => "Upgrade to"));
protected $defaultPromotionalContent = array("imagePath" => "assets/img/marketconnect/icons/spamexperts.png", "headline" => "Say goodbye to Spam", "tagline" => "Full email security solution", "features" => array("Near 100% filtering accuracy", "Increased email continuity & redundancy", "Easy setup and configuration", "Supports up to 1000 email boxes"), "learnMoreRoute" => "store-emailservices-index", "cta" => "Add", "ctaRoute" => "store-emailservices-index");
protected $planFeatures = array("spamexperts_incomingarchiving" => array("Easy setup & configuration" => true, "Virus Protection" => true, "Malware Protection" => true, "Spam Protection" => true, "Scans incoming mail" => true, "Secure email archiving" => true), "spamexperts_outgoingarchiving" => array("Easy setup & configuration" => true, "Virus Protection" => true, "Malware Protection" => true, "Spam Protection" => true, "Scans outgoing mail" => true, "Secure email archiving" => true), "spamexperts_incomingoutgoing" => array("Easy setup & configuration" => true, "Virus, Malware and Spam Protection" => true, "Scans all incoming mail" => true, "Increased continuity & redundancy" => true, "Compatible with any mail server" => true, "Scans incoming mail" => true, "Scans outgoing mail" => true), "spamexperts_incomingoutgoingarchiving" => array("Easy setup & configuration" => true, "Virus, Malware and Spam Protection" => true, "Scans all incoming mail" => true, "Increased continuity & redundancy" => true, "Compatible with any mail server" => true, "Scans incoming mail" => true, "Scans outgoing mail" => true, "Secure email archiving" => true));
protected $recommendedUpgradePaths = array("spamexperts_incoming" => "spamexperts_incomingoutgoing", "spamexperts_outgoing" => "spamexperts_incomingoutgoing", "spamexperts_incomingoutgoing" => "spamexperts_incomingoutgoingarchiving", "spamexperts_incomingarchiving" => "spamexperts_incomingoutgoingarchiving", "spamexperts_outgoingarchiving" => "spamexperts_incomingoutgoingarchiving");
public function getFeaturesForUpgrade($key)
{
}
}
}
namespace WHMCS\MarketConnect\Promotion\Helper {
class Client
{
protected $clientId = NULL;
public function __construct($clientId)
{
}
public function getProductTypes()
{
}
public function hasProductTypes(array $types)
{
}
public function getProductProductKeys()
{
}
public function getAddonProductKeys()
{
}
public function getProductAndAddonProductKeys()
{
}
public function getProductsAndAddons()
{
}
public function getServices($serviceName = "")
{
}
}
class Cart
{
protected $productTypes = NULL;
protected $marketConnectProductKeys = NULL;
protected $sslTypes = array("rapidssl", "geotrust", "digicert");
public function getProductTypes()
{
}
public function hasProductTypes(array $types)
{
}
public function getMarketConnectProductKeys()
{
}
public function hasMarketConnectProductKeys(array $productKeys)
{
}
public function isUpSellForAddon($addonId, $newAddonId)
{
}
}
class Service
{
protected $service = NULL;
public function __construct($service)
{
}
public function getAddonProducts()
{
}
public function getAddonProductKeys()
{
}
public function getProductAndAddonProductKeys()
{
}
public function getActiveAddonByProductKeys($productKeys)
{
}
}
}
namespace WHMCS\MarketConnect\Promotion {
class LoginPanel extends \WHMCS\View\Client\HomepagePanel
{
protected $requiresDomain = true;
protected $dropdownReplacementText = "";
public function setImage($image)
{
}
public function setRequiresDomain($requiresDomain)
{
}
public function setDropdownReplacementText($replacementText)
{
}
public function setPoweredBy($poweredBy)
{
}
public function setServices($services)
{
}
protected function buildServicesDropdown()
{
}
public function getBodyHtml()
{
}
public function toHtml()
{
}
}
class CartPromotion extends \WHMCS\MarketConnect\Promotion\Promotion
{
protected function getTemplate()
{
}
}
}
namespace WHMCS\MarketConnect {
class Provision
{
protected $controllerMap = array("rapidssl" => "WHMCS\\MarketConnect\\Services\\Symantec", "geotrust" => "WHMCS\\MarketConnect\\Services\\Symantec", "digicert" => "WHMCS\\MarketConnect\\Services\\Symantec", "spamexperts" => "WHMCS\\MarketConnect\\Services\\SpamExperts", "weebly" => "WHMCS\\MarketConnect\\Services\\Weebly", "sitelock" => "WHMCS\\MarketConnect\\Services\\Sitelock", "codeguard" => "WHMCS\\MarketConnect\\Services\\CodeGuard", "sitelockvpn" => "WHMCS\\MarketConnect\\Services\\SitelockVPN", "marketgoo" => "WHMCS\\MarketConnect\\Services\\Marketgoo");
protected $model = NULL;
const AUTO_INSTALL_PANELS = array("cpanel", "directadmin", "plesk");
public static function factoryFromModel($model)
{
}
public function setModel($model)
{
}
protected function getServiceIdentifier()
{
}
protected function getServiceIdentifierPrefix()
{
}
protected function getServiceController()
{
}
public function provision(array $params)
{
}
public function configure(array $params)
{
}
public function cancel()
{
}
public function install()
{
}
public function renew(array $params)
{
}
public function adminManagementButtons($params)
{
}
public function adminServicesTabOutput($params)
{
}
public function clientAreaAllowedFunctions($params)
{
}
public function clientAreaOutput($params)
{
}
public function isEligibleForUpgrade()
{
}
public function getServiceType()
{
}
public function generateCsr()
{
}
public static function findRelatedHostingService(\WHMCS\Service\Service $model)
{
}
public function updateFtpDetails(array $params)
{
}
public function emailMergeData(array $params)
{
}
public function isSslProduct()
{
}
}
}
namespace WHMCS\MarketConnect\Exception {
class AuthNotConfigured extends \WHMCS\Exception
{
}
class ConnectionError extends \WHMCS\Exception
{
}
class AuthError extends \WHMCS\Exception
{
}
class GeneralError extends \WHMCS\Exception
{
}
}
namespace WHMCS\MarketConnect {
class Balance
{
protected $balance = NULL;
protected $updatedAt = NULL;
protected $cacheTimeout = 1;
public function loadFromCache()
{
}
public function setBalance($balance)
{
}
public function getBalance()
{
}
public function isLastUpdatedSet()
{
}
public function getLastUpdated()
{
}
public function getLastUpdatedDiff()
{
}
public function setCacheTimeout($hours)
{
}
public function isExpired()
{
}
public function updateViaApi()
{
}
public function updateViaApiIfExpired()
{
}
public function saveToCache()
{
}
}
class OrderInformation
{
public $orderNumber = "";
public $domain = "";
public $status = "";
public $statusDescription = "";
public $additionalInformation = array();
public $timestamp = 0;
public $cacheExpiryTime = 240;
public function __construct($orderNumber = NULL)
{
}
public static function factory($params)
{
}
public static function cache($orderNumber, $data)
{
}
protected function loadFromCache($orderNumber)
{
}
protected function load($data)
{
}
public function getLastUpdated()
{
}
public function isCacheStale()
{
}
}
class StoreController
{
public function order(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function login(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function addToCart(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function validate(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class SslController
{
protected $module = "marketconnect";
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function viewDv(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function viewOv(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function viewEv(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function viewWildcard(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function certInfoView()
{
}
public function handleSslCallback(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function manage(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function resendApproverEmail(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function competitiveUpgrade(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function validateCompetitiveUpgrade(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class Service extends \WHMCS\Model\AbstractModel
{
protected $table = "tblmarketconnect_services";
protected $booleans = array("status");
protected $casts = array("settings" => "array");
protected $commaSeparated = array("productIds");
protected $fillable = array("name");
protected $appends = array("productGroup");
public $timestamps = false;
public function scopeActive(\Illuminate\Database\Eloquent\Builder $query)
{
}
public static function activate($serviceName, array $productIdNames = NULL)
{
}
public function deactivate()
{
}
public function setting($key)
{
}
public function factoryPromoter()
{
}
public function getProductGroupAttribute()
{
}
public static function getAutoAssignableAddons()
{
}
public function getSettingDefinitions()
{
}
}
class WeeblyController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
public function upgrade(\WHMCS\Http\Message\ServerRequest $request)
{
}
protected function setUpgradeProductKeyByPlan($plan)
{
}
protected function setUpgradeProductKeyByServiceId($serviceId)
{
}
protected function setUpgradeProductKeyByAddonIdAndServiceId($addonId, $serviceId)
{
}
protected function getUpgradeProductKey()
{
}
public function orderUpgrade(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class SitelockController
{
public function index(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS {
class License
{
const LICENSE_API_VERSION = "1.1";
const LICENSE_API_HOSTS = array('127.0.0.1');
const STAGING_LICENSE_API_HOSTS = array('127.0.0.1');
const UNLICENSED_KEY = "LICENSE-REQUIRED";
public function checkFile($value)
{
}
public function setLicenseKey($licenseKey)
{
}
public function setLocalKey($localKey)
{
}
public function setSalt($version, $hash)
{
}
public function useInternalValidationMirror()
{
}
protected function getHosts()
{
}
public function getLicenseKey()
{
}
protected function getHostDomain()
{
}
protected function getHostIP()
{
}
protected function getHostDir()
{
}
protected function isLocalKeyValidToUse()
{
}
protected function hasLocalKeyExpired()
{
}
protected function buildPostData()
{
}
public function isUnlicensed()
{
}
public function validate($forceRemote = false)
{
}
protected function callHome($postfields)
{
}
protected function makeCall($url, $query_string, $timeout = 5)
{
}
public function forceRemoteCheck()
{
}
protected function isRunningInCLI()
{
}
protected function hasLocalKey()
{
}
protected function validateLocalKey()
{
}
public function getBanner()
{
}
public function getKeyData($var)
{
}
protected function getArrayKeyData($var)
{
}
public function getRegisteredName()
{
}
public function getProductName()
{
}
public function getStatus()
{
}
public function getSupportAccess()
{
}
protected function getCheckDate()
{
}
protected function getLicensedAddons()
{
}
public function getActiveAddons()
{
}
public function isActiveAddon($addon)
{
}
public function getExpiryDate($showday = false)
{
}
public function getLatestPublicVersion()
{
}
public function getLatestPreReleaseVersion()
{
}
public function getLatestVersion()
{
}
public function isUpdateAvailable()
{
}
public function getRequiresUpdates()
{
}
public function getUpdatesExpirationDate()
{
}
public function checkOwnedUpdatesForReleaseDate($releaseDate)
{
}
public function checkOwnedUpdates()
{
}
public function getBrandingRemoval()
{
}
public function getDebugLog()
{
}
public function getUpdateValidityDate()
{
}
public function isClientLimitsEnabled()
{
}
public function getClientLimit()
{
}
public function getTextClientLimit()
{
}
public function getNumberOfActiveClients()
{
}
public function getTextNumberOfActiveClients(\WHMCS\Admin $admin = NULL)
{
}
public function getClientBoundaryId()
{
}
public function isNearClientLimit()
{
}
public function isClientLimitsAutoUpgradeEnabled()
{
}
public function getClientLimitLearnMoreUrl()
{
}
public function getClientLimitUpgradeUrl()
{
}
protected function getMemberPublicKey()
{
}
protected function setMemberPublicKey($publicKey = "")
{
}
public function encryptMemberData(array $data = array())
{
}
public function getClientLimitNotificationAttributes()
{
}
protected function buildMemberData()
{
}
public function getEncryptedMemberData()
{
}
protected function getUpgradeUrl($host)
{
}
public function makeUpgradeCall()
{
}
public function isValidLicenseKey($licenseKey)
{
}
public function hashMessage($value)
{
}
public function getValueFromHashMessage($message)
{
}
public function isValidHashMessage($message)
{
}
}
}
namespace WHMCS\UsageBilling {
class MetricUsageSettings
{
const NAME_INVOICING = "MetricUsageInvoicing";
const NAME_COLLECTION = "MetricUsageCollection";
public static function isCollectionEnable()
{
}
public static function isInvoicingEnabled()
{
}
public static function enableCollection()
{
}
public static function disableCollection()
{
}
public static function enableInvoicing()
{
}
public static function disableInvoicing()
{
}
}
}
namespace WHMCS\UsageBilling\Product {
class UsageItem extends \WHMCS\Model\AbstractModel
{
use \WHMCS\Model\HasModuleTrait;
use \WHMCS\Model\HasProductEntityTrait;
use \Illuminate\Database\Eloquent\SoftDeletes;
protected $cachedModuleMetric = NULL;
protected $table = "tblusage_items";
protected $primaryKey = "id";
protected $fillable = array("rel_type", "rel_id", "module", "module_type", "metric", "included", "is_hidden");
protected $casts = array("is_hidden" => "boolean");
public static function boot()
{
}
public function createTable($drop = false)
{
}
public function scopeIncludeDisabled($query)
{
}
public function scopeOfMetricName($query, $metric)
{
}
public static function firstOrNewByRelations($metric, \WHMCS\Model\AbstractModel $model = NULL, \WHMCS\Module\AbstractModule $module = NULL)
{
}
public function pricingSchema()
{
}
public function getModuleMetric()
{
}
public function setModuleMetric(\WHMCS\UsageBilling\Contracts\Metrics\MetricInterface $value)
{
}
public function createPriceSchemaZero()
{
}
public function createPriceSchema(array $pricingDetails = array())
{
}
}
}
namespace WHMCS\UsageBilling\Contracts\Metrics {
interface UsageInterface
{
public function collectedAt();
public function startAt();
public function endAt();
public function value();
}
interface UsageStubInterface extends \WHMCS\UsageBilling\Contracts\Metrics\UsageInterface
{
}
}
namespace WHMCS\UsageBilling\Metrics {
class NoUsage implements \WHMCS\UsageBilling\Contracts\Metrics\UsageStubInterface
{
public function __construct()
{
}
public function collectedAt()
{
}
public function startAt()
{
}
public function endAt()
{
}
public function value()
{
}
}
class Usage implements \WHMCS\UsageBilling\Contracts\Metrics\UsageInterface
{
public function __construct($value, $collectedAt = NULL, $startAt = NULL, $endAt = NULL)
{
}
public function collectedAt()
{
}
public function startAt()
{
}
public function endAt()
{
}
public function value()
{
}
}
}
namespace WHMCS\UsageBilling\Metrics\Server {
class Tenant extends \WHMCS\Model\AbstractModel
{
protected $table = "tblserver_tenants";
public $timestamps = true;
protected $fillable = array("server_id", "tenant", "created_at", "updated_at");
public function createTable($drop = false)
{
}
public function metricProvider()
{
}
public function server()
{
}
public function createStats(array $metrics)
{
}
}
class Stat extends \WHMCS\Model\AbstractModel
{
protected $table = "tbltenant_stats";
public $timestamps = true;
protected $fillable = array("tenant_id", "metric", "type", "value", "measured_at", "invoice_id");
public function createTable($drop = false)
{
}
public function unbilledValueBefore(\WHMCS\Carbon $startOfCycle, \WHMCS\UsageBilling\Metrics\Server\Tenant $tenant, \WHMCS\UsageBilling\Contracts\Metrics\MetricInterface $metric)
{
}
public function unbilledQueryBefore(\WHMCS\Carbon $startOfCycle, \WHMCS\UsageBilling\Metrics\Server\Tenant $tenant, \WHMCS\UsageBilling\Contracts\Metrics\MetricInterface $metric)
{
}
public function unbilledValueAfter(\WHMCS\Carbon $startOfCycle, \WHMCS\UsageBilling\Metrics\Server\Tenant $tenant, \WHMCS\UsageBilling\Contracts\Metrics\MetricInterface $metric)
{
}
public function unbilledFirstAfter(\WHMCS\Carbon $startOfCycle, \WHMCS\UsageBilling\Metrics\Server\Tenant $tenant, \WHMCS\UsageBilling\Contracts\Metrics\MetricInterface $metric)
{
}
public function unbilledValueFirst(\WHMCS\UsageBilling\Metrics\Server\Tenant $tenant, \WHMCS\UsageBilling\Contracts\Metrics\MetricInterface $metric)
{
}
}
}
namespace WHMCS\UsageBilling\Contracts\Metrics {
interface ProviderInterface
{
public function metrics();
public function tenantUsage($tenant);
public function usage();
}
}
namespace WHMCS\UsageBilling\Metrics\Providers {
abstract class AbstractProvider implements \WHMCS\UsageBilling\Contracts\Metrics\ProviderInterface
{
protected $storage = array();
protected $metrics = NULL;
public abstract function usage();
public abstract function tenantUsage($tenant);
public function __construct(array $metrics = array())
{
}
public function metrics()
{
}
protected function getStorage()
{
}
protected function setStorage(array $storage)
{
}
}
class CallbackUsage extends \WHMCS\UsageBilling\Metrics\Providers\AbstractProvider
{
public function __construct(array $items = array(), $usageCallable = NULL, $tenantUsageCallable = NULL)
{
}
public function tenantUsage($tenant)
{
}
public function usage($useCache = true)
{
}
}
}
namespace WHMCS\UsageBilling\Contracts\Metrics {
interface MetricInterface
{
const TYPE_SNAPSHOT = "snapshot";
const TYPE_PERIOD_DAY = "day";
const TYPE_PERIOD_MONTH = "month";
public function usage();
public function withUsage(\WHMCS\UsageBilling\Contracts\Metrics\UsageInterface $usage);
public function units();
public function systemName();
public function displayName();
public function type();
}
}
namespace WHMCS\UsageBilling\Metrics {
class Metric implements \WHMCS\UsageBilling\Contracts\Metrics\MetricInterface
{
public function __construct($systemName, $displayName = NULL, $type = NULL, \WHMCS\UsageBilling\Contracts\Metrics\UnitInterface $units = NULL, \WHMCS\UsageBilling\Contracts\Metrics\UsageInterface $usage = NULL)
{
}
public function usage()
{
}
public function withUsage(\WHMCS\UsageBilling\Contracts\Metrics\UsageInterface $usage = NULL)
{
}
public function units()
{
}
public function systemName()
{
}
public function displayName()
{
}
public function type()
{
}
}
}
namespace WHMCS\UsageBilling\Contracts\Metrics {
interface UnitInterface
{
const TYPE_CURRENCY = "currency";
const TYPE_FLOAT_PRECISION_LOW = "low";
const TYPE_FLOAT_PRECISION_HIGH = "high";
const TYPE_INT = "int";
const TYPE_MICROTIME = "microtime";
public function name();
public function perUnitName($value);
public function prefix();
public function suffix();
public function type();
public function decorate($value);
public function formatForType($value);
public function roundForType($value);
}
}
namespace WHMCS\UsageBilling\Metrics\Units {
abstract class AbstractUnit implements \WHMCS\UsageBilling\Contracts\Metrics\UnitInterface
{
public function __construct($name, $singlePerUnitName = NULL, $pluralPerUnitName = NULL, $prefix = NULL, $suffix = NULL)
{
}
public function name()
{
}
public function perUnitName($value = 0)
{
}
public function prefix()
{
}
public function suffix()
{
}
public function decorate($value)
{
}
public function roundForType($value)
{
}
public function formatForType($value)
{
}
public abstract function type();
}
class FloatingPoint extends \WHMCS\UsageBilling\Metrics\Units\AbstractUnit
{
public function type()
{
}
}
class Bytes extends \WHMCS\UsageBilling\Metrics\Units\FloatingPoint
{
public function __construct($name = "Bytes", $singlePerUnitName = "Byte", $pluralPerUnitName = "Bytes", $prefix = NULL, $suffix = "B")
{
}
public static function convert($value, $from, $to)
{
}
}
class GigaBytes extends \WHMCS\UsageBilling\Metrics\Units\Bytes
{
public function __construct($name = "Gigabytes", $singlePerUnitName = NULL, $pluralPerUnitName = NULL, $prefix = NULL, $suffix = "GB")
{
}
}
class MegaBytes extends \WHMCS\UsageBilling\Metrics\Units\Bytes
{
public function __construct($name = "Megabytes", $singlePerUnitName = NULL, $pluralPerUnitName = NULL, $prefix = NULL, $suffix = "MB")
{
}
}
class WholeNumber extends \WHMCS\UsageBilling\Metrics\Units\AbstractUnit
{
public function type()
{
}
}
class Accounts extends \WHMCS\UsageBilling\Metrics\Units\WholeNumber
{
public function __construct($name = "Accounts", $singlePerUnitName = "Account", $pluralPerUnitName = "Accounts", $prefix = NULL, $suffix = "")
{
}
}
class KiloBytes extends \WHMCS\UsageBilling\Metrics\Units\Bytes
{
public function __construct($name = "Kilobytes", $singlePerUnitName = NULL, $pluralPerUnitName = NULL, $prefix = NULL, $suffix = "KB")
{
}
}
class Domains extends \WHMCS\UsageBilling\Metrics\Units\WholeNumber
{
public function __construct($name = "Domains", $singlePerUnitName = "Domain", $pluralPerUnitName = "Domains", $prefix = NULL, $suffix = "")
{
}
}
}
namespace WHMCS\UsageBilling\Pricing\Product {
class Pricing extends \WHMCS\Billing\Pricing
{
public function pricingType()
{
}
public function bracket()
{
}
public function createFixedPricing(\WHMCS\UsageBilling\Pricing\Fixed\Bracket $bracket)
{
}
}
}
namespace WHMCS\UsageBilling\Contracts\Pricing {
interface PriceBracketInterface
{
public function schemaType();
public function withinRange($value, $unitType);
public function belowRange($value, $unitType);
public function pricing();
public function isFree();
public function pricingForCurrencyId($id);
public function newCollection();
public function relationEntity();
}
}
namespace WHMCS\UsageBilling\Pricing {
abstract class AbstractPriceBracket extends \WHMCS\Model\AbstractModel implements \WHMCS\UsageBilling\Contracts\Pricing\PriceBracketInterface
{
protected $fillable = array("floor", "ceiling", "rel_type", "rel_id", "schema_type");
public function createTable($drop = false)
{
}
public static function boot()
{
}
public function updateColumnsForDecimalsAndInclusive()
{
}
public function newCollection(array $models = array())
{
}
public function belowRange($value, $unitType = \WHMCS\UsageBilling\Contracts\Metrics\UnitInterface::TYPE_INT)
{
}
public function withinRange($value, $unitType = \WHMCS\UsageBilling\Contracts\Metrics\UnitInterface::TYPE_INT)
{
}
public function pricing()
{
}
public function pricingForCurrencyId($id)
{
}
public abstract function getPricingMorphClassname();
public abstract function relationEntity();
public function schemaType()
{
}
public function isFree()
{
}
}
}
namespace WHMCS\UsageBilling\Pricing\Product {
class Bracket extends \WHMCS\UsageBilling\Pricing\AbstractPriceBracket
{
use \WHMCS\Model\HasProductEntityTrait;
protected $table = "tblpricing_bracket";
public function getPricingMorphClassname()
{
}
public function createMetricUsageFixedBracket(\WHMCS\UsageBilling\Service\MetricUsage $metricUsage)
{
}
}
}
namespace WHMCS\UsageBilling\Pricing\Fixed {
class Pricing extends \WHMCS\Billing\Pricing
{
protected $table = "tblpricing_fixed";
public function bracket()
{
}
public function pricingType()
{
}
}
class Bracket extends \WHMCS\UsageBilling\Pricing\AbstractPriceBracket
{
use \WHMCS\Model\HasServiceEntityTrait;
protected $table = "tblpricing_fixed_bracket";
public function getPricingMorphClassname()
{
}
public function servicePricing($service)
{
}
}
}
namespace WHMCS\UsageBilling\Contracts\Pricing {
interface PricingSchemaInterface extends \WHMCS\Contracts\CollectionInterface
{
const TYPE_SIMPLE = "simple";
const TYPE_FLAT = "flat";
const TYPE_GRADUATED = "grad";
public function getStubInclusiveBracket();
public static function getSchemaTypes();
public function schemaType();
public function isFree();
public function freeLimit();
public function firstCostBracket();
public function fixedUsagePricing();
}
}
namespace WHMCS\UsageBilling\Pricing {
class PricingSchema extends \Illuminate\Database\Eloquent\Collection implements \WHMCS\UsageBilling\Contracts\Pricing\PricingSchemaInterface
{
public static function getSchemaTypes()
{
}
public function schemaType()
{
}
public function isFree()
{
}
public function freeLimit()
{
}
public function firstCostBracket()
{
}
public function getStubInclusiveBracket()
{
}
public function fixedUsagePricing()
{
}
}
}
namespace WHMCS\UsageBilling\Service {
class MetricUsage extends \WHMCS\Model\AbstractModel
{
use \WHMCS\Model\HasModuleTrait;
use \WHMCS\Model\HasServiceEntityTrait;
protected $table = "tblmetric_usage";
protected $primaryKey = "id";
protected $fillable = array("rel_type", "rel_id", "module", "module_type", "metric");
public static function boot()
{
}
public function createTable($drop = false)
{
}
public function pricingSchema()
{
}
public function factoryInvoiceItem()
{
}
}
class ServiceMetric extends \WHMCS\UsageBilling\Metrics\Metric
{
public function __construct(\WHMCS\Service\Service $service, $systemName, $displayName = NULL, $type = NULL, \WHMCS\UsageBilling\Contracts\Metrics\UnitInterface $units = NULL, \WHMCS\UsageBilling\Contracts\Metrics\UsageInterface $usage = NULL, \WHMCS\UsageBilling\Contracts\Metrics\UsageInterface $historicUsage = NULL, \WHMCS\UsageBilling\Product\UsageItem $usageItem = NULL, $tenantStatId = NULL)
{
}
public static function factoryFromMetric(\WHMCS\Service\Service $service, \WHMCS\UsageBilling\Contracts\Metrics\MetricInterface $metric, \WHMCS\UsageBilling\Contracts\Metrics\UsageInterface $historicUsage = NULL, \WHMCS\UsageBilling\Product\UsageItem $usageItem = NULL, $tenantStatId = NULL)
{
}
public function withUsageItem(\WHMCS\UsageBilling\Product\UsageItem $usageItem)
{
}
public function usageItem()
{
}
public function withUsage(\WHMCS\UsageBilling\Contracts\Metrics\UsageInterface $usage = NULL, $tenantStatId = NULL)
{
}
public function withHistoricUsage(\WHMCS\UsageBilling\Contracts\Metrics\UsageInterface $historicUsage = NULL)
{
}
public function historicUsage()
{
}
public function service()
{
}
public function isEnabled()
{
}
public function tenantStatId()
{
}
}
class ViewHelper
{
public function serverTenantUsageTable($serviceMetrics = array())
{
}
}
}
namespace WHMCS\UsageBilling\Contracts\Invoice {
interface UsageItemInterface
{
public function getUsageCalculations(\WHMCS\UsageBilling\Service\ServiceMetric $serviceMetric, \WHMCS\UsageBilling\Contracts\Pricing\PricingSchemaInterface $pricingSchema);
}
interface UsageCalculationInterface
{
public function consumed();
public function bracket();
public function price();
public function isIncluded();
}
}
namespace WHMCS\UsageBilling\Invoice\Item {
abstract class AbstractUsageItem implements \WHMCS\UsageBilling\Contracts\Invoice\UsageItemInterface
{
public function __construct(\WHMCS\UsageBilling\Service\ServiceMetric $serviceMetric)
{
}
public function getInvoiceItem()
{
}
protected function useHistoricalUsage(\WHMCS\UsageBilling\Service\ServiceMetric $serviceMetric)
{
}
public function getServiceMetric()
{
}
public function setServiceMetric($serviceMetric)
{
}
public function getCalculations()
{
}
public function setCalculations($calculations)
{
}
public function getServiceName()
{
}
public function getModule()
{
}
protected function getDefaultServiceAttributes()
{
}
public abstract function getUsageCalculations(\WHMCS\UsageBilling\Service\ServiceMetric $serviceMetric, \WHMCS\UsageBilling\Contracts\Pricing\PricingSchemaInterface $pricingSchema);
protected function getLineItemDescription()
{
}
protected function calculatePrice()
{
}
}
class Graduated extends \WHMCS\UsageBilling\Invoice\Item\AbstractUsageItem
{
public function getUsageCalculations(\WHMCS\UsageBilling\Service\ServiceMetric $serviceMetric, \WHMCS\UsageBilling\Contracts\Pricing\PricingSchemaInterface $pricingSchema)
{
}
}
class Flat extends \WHMCS\UsageBilling\Invoice\Item\AbstractUsageItem
{
public function getUsageCalculations(\WHMCS\UsageBilling\Service\ServiceMetric $serviceMetric, \WHMCS\UsageBilling\Contracts\Pricing\PricingSchemaInterface $pricingSchema)
{
}
}
class Simple extends \WHMCS\UsageBilling\Invoice\Item\Flat
{
}
class ModuleDelegate extends \WHMCS\UsageBilling\Invoice\Item\AbstractUsageItem
{
public function getUsageCalculations(\WHMCS\UsageBilling\Service\ServiceMetric $serviceMetric, \WHMCS\UsageBilling\Contracts\Pricing\PricingSchemaInterface $pricingSchema)
{
}
public function getInvoiceItem()
{
}
}
}
namespace WHMCS\UsageBilling\Invoice {
class ItemFactory
{
public function factoryItemsFromService(\WHMCS\Service\Service $service, $mode = NULL)
{
}
public function factoryInvoiceItem(\WHMCS\UsageBilling\Service\ServiceMetric $serviceMetric)
{
}
}
}
namespace WHMCS\UsageBilling\Invoice\Calculation {
class Charge implements \WHMCS\UsageBilling\Contracts\Invoice\UsageCalculationInterface
{
public function __construct($consumed = 0, \WHMCS\Billing\PricingInterface $price = NULL, \WHMCS\UsageBilling\Contracts\Pricing\PriceBracketInterface $bracket = NULL, $isIncluded = false)
{
}
public function consumed()
{
}
public function bracket()
{
}
public function price()
{
}
public function isIncluded()
{
}
}
class Included extends \WHMCS\UsageBilling\Invoice\Calculation\Charge
{
public function __construct($consumed = 0, \WHMCS\Billing\PricingInterface $price = NULL, \WHMCS\UsageBilling\Contracts\Pricing\PriceBracketInterface $bracket = NULL, $isIncluded = true)
{
}
}
}
namespace WHMCS\UsageBilling\Invoice {
class ServiceUsage
{
const MODE_VALUES_COMPACT_HIST = 1;
const MODE_VALUES_NON_COMPACT_HIST = 2;
const MODE_PERIODS_ANY = 4;
const MODE_PERIODS_CLOSED = 8;
public function __construct($service)
{
}
public function generateInvoiceItems($mode = NULL, $nextDueDate = NULL, $tax = 0)
{
}
public static function markUsageAsInvoiced($invoiceId, $invoiceLineItems = array())
{
}
public function createUsageInvoice()
{
}
public function hasUsageForInvoicing()
{
}
public static function isSingleHistory($mode)
{
}
public static function isMultiHistory($mode)
{
}
public static function isAllUsage($mode)
{
}
public static function getAllUsageMode()
{
}
public static function getQuickViewMode()
{
}
public static function getRecurringInvoiceMode()
{
}
}
}
namespace WHMCS {
class Order
{
public function setID($orderId)
{
}
protected function loadData()
{
}
public function getData($key)
{
}
public function getActiveFraudModule()
{
}
public function shouldFraudCheckBeSkipped()
{
}
protected function skipFraudCheckBecauseOfExistingOrders()
{
}
protected function shouldFraudCheckBeSkippedByHook()
{
}
protected function skipFraudCheckBecausePaidByCredit()
{
}
}
}
namespace WHMCS\Exception\Session\Database {
class DatabaseSessionException extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception\Authentication {
class PasswordResetFailure extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception {
class HttpCodeException extends \WHMCS\Exception
{
const DEFAULT_HTTP_CODE = 400;
public function __construct($message = NULL, $code = NULL, \Exception $previous = NULL)
{
}
public function getDefaultStatusCode()
{
}
public function getDefaultStatusReason($code)
{
}
}
}
namespace WHMCS\Exception\Authentication {
abstract class AbstractAuthenticationException extends \WHMCS\Exception\HttpCodeException
{
const DEFAULT_HTTP_CODE = 403;
}
class LoginRequired extends \WHMCS\Exception\Authentication\AbstractAuthenticationException
{
}
}
namespace WHMCS\Exception\Authentication\Remote {
class AbstractRemoteAuthException extends \WHMCS\Exception
{
}
class RemoteAuthProcessException extends \WHMCS\Exception\Authentication\Remote\AbstractRemoteAuthException
{
}
class RemoteAuthConfigException extends \WHMCS\Exception\Authentication\Remote\AbstractRemoteAuthException
{
}
}
namespace WHMCS\Exception\Authentication {
class InvalidSecret extends \WHMCS\Exception\Authentication\AbstractAuthenticationException
{
}
}
namespace WHMCS\Exception\Model {
class GuardedForUpdate extends \WHMCS\Exception
{
}
class UniqueConstraint extends \WHMCS\Exception
{
}
class EmptyValue extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception\Gateways {
class RedirectToInvoice extends \WHMCS\Exception
{
}
class SubscriptionCancellationNotSupported extends \WHMCS\Exception\Information
{
}
class Declined extends \WHMCS\Exception\Information
{
}
class SubscriptionCancellationFailed extends \WHMCS\Exception\Information
{
}
}
namespace WHMCS\Exception\Order {
class HookSkipFraudCheck extends \Exception
{
}
class PaidByCredit extends \Exception
{
}
class SkipFraudCheck extends \Exception
{
}
}
namespace WHMCS\Exception\Version {
class Parse extends \WHMCS\Exception
{
}
class BadVersionNumber extends \WHMCS\Exception\Version\Parse
{
}
}
namespace WHMCS\Exception\View {
class TemplateNotFound extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception\Storage {
class StorageException extends \WHMCS\Exception
{
}
class AssetMigrationException extends \WHMCS\Exception\Storage\StorageException
{
}
class UnsupportedMigrationPathException extends \WHMCS\Exception\Storage\AssetMigrationException
{
}
class StorageConfigurationException extends \WHMCS\Exception\Storage\StorageException
{
public function __construct(array $fields)
{
}
public function getFields()
{
}
}
class SameStorageConfigurationExistsException extends \WHMCS\Exception\Storage\StorageException
{
}
}
namespace WHMCS\Exception\Billing {
class BillingException extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception\Fraud {
class FraudCheckException extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception {
class InvalidCaptcha extends \WHMCS\Exception\Information
{
}
class AccessDenied extends \WHMCS\Exception
{
}
class Installer extends \WHMCS\Exception
{
}
class Fatal extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception\Updater {
class CouldNotUnlock extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception\Validation {
class Required extends \WHMCS\Exception
{
}
class InvalidValue extends \WHMCS\Exception
{
}
class InvalidHostAddress extends \WHMCS\Exception\Validation\InvalidValue
{
}
class InvalidIpAddress extends \WHMCS\Exception\Validation\InvalidHostAddress
{
}
class InvalidPort extends \WHMCS\Exception\Validation\InvalidHostAddress
{
}
class InvalidCharacters extends \WHMCS\Exception
{
}
class DuplicateValue extends \WHMCS\Exception
{
}
class InvalidFirstCharacter extends \WHMCS\Exception
{
}
class InvalidLength extends \WHMCS\Exception
{
}
class InvalidHostname extends \WHMCS\Exception\Validation\InvalidHostAddress
{
}
}
namespace WHMCS\Exception\Scheduling\Jobs {
class QueueException extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception\OAuth2 {
class NonExistentScope extends \WHMCS\Exception\Fatal
{
}
}
namespace WHMCS\Exception\Module {
class InvalidConfiguration extends \WHMCS\Exception\Information
{
}
class SingleSignOnError extends \WHMCS\Exception\Information
{
}
class NotImplemented extends \WHMCS\Exception\Information
{
}
class ApiException extends \WHMCS\Exception
{
}
class FunctionNotFound extends \WHMCS\Exception\Information
{
}
class NotServicable extends \WHMCS\Exception\Fatal
{
}
class GeneralError extends \WHMCS\Exception\Information
{
}
class MalformedResponseException extends \WHMCS\Exception
{
}
class NotActivated extends \WHMCS\Exception\Information
{
}
}
namespace WHMCS\Exception\Mail {
class TemplateDisabled extends \WHMCS\Exception
{
}
class InvalidTemplate extends \WHMCS\Exception
{
}
class SendHookAbort extends \WHMCS\Exception
{
}
class SendFailure extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception {
class InvalidDomain extends \WHMCS\Exception\Information
{
}
}
namespace WHMCS\Exception\Application\Configuration {
class ParseError extends \WHMCS\Exception\Fatal
{
}
class LicenseKeyNotDefined extends \WHMCS\Exception\Information
{
}
}
namespace WHMCS\Exception\File {
class NotFound extends \WHMCS\Exception\Information
{
}
}
namespace WHMCS\Exception\Application\Configuration {
class FileNotFound extends \WHMCS\Exception\File\NotFound
{
}
class CannotConnectToDatabase extends \WHMCS\Exception\Information
{
}
}
namespace WHMCS\Exception\Application {
class InstallerExists extends \WHMCS\Exception\Information
{
}
class InstallationVersionMisMatch extends \WHMCS\Exception\Information
{
}
}
namespace WHMCS\Exception\Authorization {
class AbstractAuthorizationException extends \WHMCS\Exception\HttpCodeException
{
const DEFAULT_HTTP_CODE = 403;
}
class AccessDenied extends \WHMCS\Exception\Authorization\AbstractAuthorizationException
{
}
class InvalidCsrfToken extends \WHMCS\Exception\Authorization\AbstractAuthorizationException
{
}
}
namespace WHMCS\Exception\Api {
class ActionNotFound extends \WHMCS\Exception
{
}
class NoResponse extends \WHMCS\Exception
{
}
class InvalidArgument extends \WHMCS\Exception
{
}
class AuthException extends \WHMCS\Exception\Authentication\AbstractAuthenticationException
{
}
class InvalidResponseType extends \WHMCS\Exception
{
}
class InvalidAction extends \WHMCS\Exception
{
}
class InvalidUser extends \WHMCS\Exception
{
}
class FailedResponse extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception\Handler {
trait ExceptionLoggingTrait
{
public function log($exception)
{
}
}
}
namespace WHMCS\Exception\Handler\Log {
class BaseExceptionLoggerHandler extends \WHMCS\Log\ActivityLogHandler
{
public function isHandling(array $record)
{
}
protected function write(array $record)
{
}
protected function getDefaultFormatter()
{
}
}
class ErrorExceptionLoggerHandler extends \WHMCS\Log\ActivityLogHandler
{
public function isHandling(array $record)
{
}
protected function write(array $record)
{
}
protected function getDefaultFormatter()
{
}
}
class PdoExceptionLoggerHandler extends \WHMCS\Log\ActivityLogHandler
{
public function isHandling(array $record)
{
}
protected function write(array $record)
{
}
protected function getDefaultFormatter()
{
}
}
}
namespace WHMCS\Exception\Handler {
class CriticalHtmlHandler extends \Whoops\Handler\Handler
{
use \WHMCS\Exception\Handler\ExceptionLoggingTrait;
protected function getErrorOutputForCli()
{
}
protected function getHtmlErrorOutput()
{
}
public function handle()
{
}
protected function isActuallyError()
{
}
protected function isActuallyFatalError()
{
}
}
class TerminusHandler extends \Whoops\Handler\Handler
{
public function handle()
{
}
}
class PrettyHtmlHandler extends \WHMCS\Exception\Handler\CriticalHtmlHandler
{
public function handle()
{
}
public function getHtmlErrorPage()
{
}
}
}
namespace WHMCS\Exception\Marketing {
class AlreadyOptedIn extends \WHMCS\Exception
{
}
class AlreadyOptedOut extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception\Http {
class ConnectionError extends \WHMCS\Exception
{
}
}
namespace WHMCS\Exception\Container {
class NotBuildable extends \WHMCS\Exception\Fatal implements \Psr\Container\ContainerExceptionInterface
{
}
class IdentifierNotDefined extends \WHMCS\Exception\Fatal implements \Psr\Container\NotFoundExceptionInterface
{
}
}
namespace WHMCS\Exception\File {
class NotDeleted extends \WHMCS\Exception\Information
{
}
class NotUploaded extends \WHMCS\Exception\Information
{
}
class NotCreated extends \WHMCS\Exception\Information
{
}
}
namespace WHMCS\Exception\Installer {
class UserBail extends \WHMCS\Exception\Installer
{
}
class UnknownArgument extends \WHMCS\Exception\Installer
{
}
}
namespace WHMCS\Exception\User {
class NoSuchUserException extends \WHMCS\Exception\Fatal
{
}
}
namespace WHMCS\Exception\Domains\Pricing {
class NoSale extends \WHMCS\Exception\Information
{
}
class ContactUs extends \WHMCS\Exception\Information
{
}
}
namespace WHMCS\Exception {
class ProgramExit extends \WHMCS\Exception\Fatal
{
}
}
namespace WHMCS\File {
trait StorageErrorHandlingTrait
{
private $assetSetting = NULL;
public function getAssetSetting()
{
}
public function setAssetSetting($assetSetting)
{
}
private function wrapStorageCall($methodName, array $args)
{
}
public function has($path)
{
}
public function read($path)
{
}
public function readStream($path)
{
}
public function listContents($directory = "", $recursive = false)
{
}
public function getMetadata($path)
{
}
public function getSize($path)
{
}
public function getMimetype($path)
{
}
public function getTimestamp($path)
{
}
public function getVisibility($path)
{
}
public function write($path, $contents, array $config = array())
{
}
public function writeStream($path, $resource, array $config = array())
{
}
public function update($path, $contents, array $config = array())
{
}
public function updateStream($path, $resource, array $config = array())
{
}
public function rename($path, $newpath)
{
}
public function copy($path, $newpath)
{
}
public function delete($path)
{
}
public function deleteDir($dirname)
{
}
public function createDir($dirname, array $config = array())
{
}
public function setVisibility($path, $visibility)
{
}
public function put($path, $contents, array $config = array())
{
}
public function putStream($path, $resource, array $config = array())
{
}
public function readAndDelete($path)
{
}
public function get($path, \League\Flysystem\Handler $handler = NULL)
{
}
}
class Directory
{
protected $path = "";
public function __construct($path)
{
}
protected function setPath($path)
{
}
protected function getPath()
{
}
public function getSubdirectories()
{
}
public function listFiles()
{
}
}
}
namespace WHMCS\File\Configuration {
class FileAssetSetting extends \WHMCS\Model\AbstractModel
{
protected $table = "tblfileassetsettings";
public function setAssetTypeAttribute($value)
{
}
public function configuration()
{
}
public function migrateToConfiguration()
{
}
public function scopeForAssetType(\Illuminate\Database\Eloquent\Builder $query, $assetType)
{
}
public function scopeInMigration(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function createFilesystemAdapter($subPath = "")
{
}
public function scopeUsingConfiguration(\Illuminate\Database\Eloquent\Builder $query, $configurationId)
{
}
}
class StorageConfiguration extends \WHMCS\Model\AbstractModel
{
protected $table = "tblstorageconfigurations";
protected $casts = array("is_local" => "boolean", "last_error" => "array");
public static function boot()
{
}
public static function newLocal()
{
}
public static function newRemote()
{
}
public function getSettingsAttribute()
{
}
public function setSettingsAttribute(array $value)
{
}
public function createStorageProvider()
{
}
public function testForDuplicate()
{
}
public function assetSettings()
{
}
public function assetSettingsMigratedTo()
{
}
public function scopeLocal(\Illuminate\Database\Eloquent\Builder $builder)
{
}
public static function factoryLocalStorageConfigurationForDir($localPath)
{
}
}
}
namespace WHMCS\File {
class FileAssetCollection extends \Illuminate\Support\Collection
{
public static function forAssetType($assetType)
{
}
}
}
namespace WHMCS\File\Provider {
interface StorageProviderInterface
{
public static function getShortName();
public static function getName();
public function getConfigSummaryText();
public function getConfigSummaryHtml();
public function getIcon();
public function applyConfiguration(array $configSettings);
public function testConfiguration();
public function exportConfiguration(\WHMCS\File\Configuration\StorageConfiguration $config);
public function getConfigurationFields();
public function getAccessCredentialFieldNames();
public function getFieldsLockedInUse();
public function isLocal();
public function createFilesystemAdapterForAssetType($assetType, $subPath);
public static function getExceptionErrorMessage(\Exception $e);
}
class S3StorageProvider implements \WHMCS\File\Provider\StorageProviderInterface
{
public static function getShortName()
{
}
public static function getName()
{
}
public function isLocal()
{
}
public function applyConfiguration(array $configSettings)
{
}
public function exportConfiguration(\WHMCS\File\Configuration\StorageConfiguration $config = NULL)
{
}
public function getConfigurationFields()
{
}
public function getAccessCredentialFieldNames()
{
}
public function createS3Client()
{
}
public function getBucket()
{
}
public function getPathPrefix($assetType)
{
}
public function createFilesystemAdapterForAssetType($assetType, $subPath = "")
{
}
public function getConfigSummaryText()
{
}
public function getConfigSummaryHtml()
{
}
public function getIcon()
{
}
public function testConfiguration()
{
}
public function getFieldsLockedInUse()
{
}
public static function getExceptionErrorMessage(\Exception $e)
{
}
}
interface LocalStorageProviderInterface
{
public function getLocalPath();
}
class LocalStorageProvider implements \WHMCS\File\Provider\StorageProviderInterface, \WHMCS\File\Provider\LocalStorageProviderInterface
{
public static function getShortName()
{
}
public static function getName()
{
}
public function isLocal()
{
}
public function applyConfiguration(array $configSettings)
{
}
public function exportConfiguration(\WHMCS\File\Configuration\StorageConfiguration $config = NULL)
{
}
public function getConfigurationFields()
{
}
public function getAccessCredentialFieldNames()
{
}
public function getLocalPath()
{
}
public function createFilesystemAdapterForAssetType($assetType, $subPath = "")
{
}
public function setLocalPath($localPath)
{
}
public function getConfigSummaryText()
{
}
public function getConfigSummaryHtml()
{
}
public function getIcon()
{
}
public function testConfiguration()
{
}
public function getFieldsLockedInUse()
{
}
public static function getExceptionErrorMessage(\Exception $e)
{
}
}
class StorageProviderFactory
{
public static function getProviderClasses()
{
}
public static function createProvider($providerShortName)
{
}
public static function getLocalStoragePathsInUse()
{
}
public static function getTopLevelLocalStoragePathsInUse()
{
}
}
}
namespace WHMCS\File {
class Filesystem extends \League\Flysystem\Filesystem
{
use \WHMCS\File\StorageErrorHandlingTrait;
public function isLocalAdapter()
{
}
public function deleteAllowNotPresent($path)
{
}
public function getSizeStrict($path)
{
}
}
class StorageServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider
{
public function register()
{
}
}
}
namespace WHMCS\File\Migration {
class MigrationJob implements \WHMCS\Scheduling\Contract\JobInterface
{
use \WHMCS\Scheduling\Jobs\JobTrait;
const JOB_NAME = "storage.asset.migrations";
public static function queue()
{
}
public static function dequeue()
{
}
public function performAssetMigrations()
{
}
}
class FileAssetMigrationProgress extends \WHMCS\Model\AbstractModel
{
protected $table = "tblfileassetmigrationprogress";
protected $casts = array("migrated_objects" => "array", "active" => "boolean");
protected $fillable = array("asset_type");
protected $attributes = array("active" => true);
const MAX_CONSECUTIVE_FAILURES = 5;
public function setAssetTypeAttribute($value)
{
}
public function scopeForAssetType(\Illuminate\Database\Eloquent\Builder $query, $assetType)
{
}
}
}
namespace WHMCS\File\Migration\Processor {
interface MigrationProcessorInterface
{
public function migrate();
public function getMigrationProgress();
}
abstract class AbstractMigrationProcessor implements \WHMCS\File\Migration\Processor\MigrationProcessorInterface
{
protected $assetType = NULL;
protected $timeLimit = self::DEFAULT_MIGRATION_TIME_LIMIT_SEC;
protected $dataSizeLimit = self::DEFAULT_MIGRATION_DATA_SIZE_LIMIT;
protected $objectsToMigrate = array();
protected $migratedObjects = array();
const DEFAULT_MIGRATION_TIME_LIMIT_SEC = 240;
const DEFAULT_MIGRATION_DATA_SIZE_LIMIT = 1073741824;
public abstract function setFromProvider(\WHMCS\File\Provider\StorageProviderInterface $fromProvider);
public abstract function setToProvider(\WHMCS\File\Provider\StorageProviderInterface $toProvider);
protected abstract function doMigrate();
public function __construct($assetType)
{
}
public function getTimeLimit()
{
}
public function setTimeLimit($timeLimit)
{
}
public function getDataSizeLimit()
{
}
public function setDataSizeLimit($dataSizeLimit)
{
}
protected function addMigratedObject($objectPath)
{
}
protected function saveMigrationProgress()
{
}
protected function isObjectMigrated($objectPath)
{
}
protected function finalizeMigrationRun()
{
}
public function migrate()
{
}
public function getMigrationProgress()
{
}
}
trait LocalCapableProcessorTrait
{
private $targetDirMode = NULL;
public function validateLocalPath($localDir)
{
}
public function createDirectoriesForFile($filePath)
{
}
}
class S3ToLocalMigrationProcessor extends \WHMCS\File\Migration\Processor\AbstractMigrationProcessor
{
use \WHMCS\File\Migration\Processor\LocalCapableProcessorTrait;
const DOWNLOAD_CONCURRENCY = 5;
const TEMP_LOCAL_FILE_EXT = ".migration";
public function setFromProvider(\WHMCS\File\Provider\StorageProviderInterface $fromProvider)
{
}
public function setToProvider(\WHMCS\File\Provider\StorageProviderInterface $toProvider)
{
}
protected function doMigrate()
{
}
}
class S3ToS3MigrationProcessor extends \WHMCS\File\Migration\Processor\AbstractMigrationProcessor
{
const MIGRATION_CONCURRENCY = 10;
public function setFromProvider(\WHMCS\File\Provider\StorageProviderInterface $fromProvider)
{
}
public function setToProvider(\WHMCS\File\Provider\StorageProviderInterface $toProvider)
{
}
protected function doMigrate()
{
}
}
class LocalToLocalMigrationProcessor extends \WHMCS\File\Migration\Processor\AbstractMigrationProcessor
{
use \WHMCS\File\Migration\Processor\LocalCapableProcessorTrait;
public function setFromProvider(\WHMCS\File\Provider\StorageProviderInterface $fromProvider)
{
}
public function setToProvider(\WHMCS\File\Provider\StorageProviderInterface $toProvider)
{
}
protected function doMigrate()
{
}
}
final class MigrationProcessorFactory
{
public static function canMigrateFileAsset(\WHMCS\File\Provider\StorageProviderInterface $fromProvider, \WHMCS\File\Provider\StorageProviderInterface $toProvider)
{
}
public static function createForFileAsset(\WHMCS\File\Configuration\FileAssetSetting $assetSetting, $timeLimitSec = \WHMCS\File\Migration\Processor\AbstractMigrationProcessor::DEFAULT_MIGRATION_TIME_LIMIT_SEC, $dataSizeLimit = \WHMCS\File\Migration\Processor\AbstractMigrationProcessor::DEFAULT_MIGRATION_DATA_SIZE_LIMIT)
{
}
}
class LocalToS3MigrationProcessor extends \WHMCS\File\Migration\Processor\AbstractMigrationProcessor
{
protected $s3Bucket = NULL;
const UPLOAD_CONCURRENCY = 5;
public function setFromProvider(\WHMCS\File\Provider\StorageProviderInterface $fromProvider)
{
}
public function setToProvider(\WHMCS\File\Provider\StorageProviderInterface $toProvider)
{
}
protected function getObjectKeyFromAwsResult(\Aws\Result $awsResult)
{
}
protected function doMigrate()
{
}
}
}
namespace WHMCS\File {
final class Storage
{
public function clientFiles()
{
}
public function downloads()
{
}
public function emailAttachments()
{
}
public function emailTemplateAttachments()
{
}
public function projectManagementFiles($projectId = NULL)
{
}
public function ticketAttachments()
{
}
public function kbImages()
{
}
public function emailImages()
{
}
}
class Upload
{
protected $uploadedFile = NULL;
protected $uploadFilename = NULL;
protected $uploadTmpName = NULL;
public function __construct($nameOrFile, $key = NULL)
{
}
public static function getUploadedFiles($name)
{
}
public function store(\WHMCS\File\Filesystem $storage, $fileNameToSave)
{
}
public function storeAsClientFile()
{
}
public function storeAsDownload()
{
}
public function storeAsEmailAttachment()
{
}
public function storeAsEmailTemplateAttachment()
{
}
public function storeAsProjectFile($projectId)
{
}
public function storeAsTicketAttachment()
{
}
public function storeAsKbImage()
{
}
public function storeAsEmailImage()
{
}
public function getFileName()
{
}
public function getExtension()
{
}
public function getFileTmpName()
{
}
public function getSize()
{
}
public function getClientMediaType()
{
}
public function getCleanName()
{
}
public function isUploaded()
{
}
public function move($dest_dir = "", $prefix = "")
{
}
protected function generateUniqueDestinationPath($dest_dir, $prefix)
{
}
protected function makeRandomSeed()
{
}
public function checkExtension()
{
}
public static function isExtensionAllowed($filename)
{
}
public function contents()
{
}
public function setFilename($name)
{
}
}
class FileAsset
{
const TYPE_CLIENT_FILES = "client_files";
const TYPE_DOWNLOADS = "downloads";
const TYPE_EMAIL_ATTACHMENTS = "email_attachments";
const TYPE_EMAIL_IMAGES = "email_images";
const TYPE_EMAIL_TEMPLATE_ATTACHMENTS = "email_template_attachments";
const TYPE_KB_IMAGES = "kb_images";
const TYPE_PM_FILES = "pm_files";
const TYPE_TICKET_ATTACHMENTS = "ticket_attachments";
const TYPES = NULL;
const NO_MIGRATION_TYPES = NULL;
public static function canMigrate($assetType)
{
}
public static function validType($assetType)
{
}
public static function getTypeName($assetType)
{
}
public static function getMimeTypeByExtension($filename)
{
}
public static function disallowHtmlMimeType($mimeType)
{
}
}
}
namespace WHMCS\Config {
class Setting extends \WHMCS\Model\AbstractKeyValuePair
{
public $incrementing = false;
protected $table = "tblconfiguration";
protected $primaryKey = "setting";
public $unique = array("setting");
public $guardedForUpdate = array("setting");
protected $fillable = array("value");
protected $booleanValues = array("EnableProformaInvoicing");
protected $nonEmptyValues = array();
protected $commaSeparatedValues = array("BulkCheckTLDs");
protected static $defaultKeyValuePairs = array();
public static function boot()
{
}
public static function allDefaults()
{
}
public function scopeUpdater($query)
{
}
public static function getValue($setting)
{
}
public static function setValue($key, $value)
{
}
public static function deleteValue($key)
{
}
public static function allAsArray()
{
}
public function getBooleanValues()
{
}
public function getCommaSeparatedValues()
{
}
public function newCollection(array $models = array())
{
}
}
abstract class AbstractConfig extends \ArrayObject
{
public function __construct(array $data = array())
{
}
public function setData(array $data)
{
}
public function getData()
{
}
public function setDefaultReturnValue($value)
{
}
public function OffsetGet($property)
{
}
}
class Template
{
protected $configFile = NULL;
protected $name = NULL;
protected $metaData = array();
protected $properties = array();
protected $configDefinitions = array();
protected $config = array();
public function __construct(\WHMCS\File $configFile)
{
}
public function save(\WHMCS\File $saveTo = NULL)
{
}
public function saveTo($path)
{
}
public function getProperties()
{
}
public function setProperty($key, $value)
{
}
public function getConfigDefinitions()
{
}
public function getConfig()
{
}
public function setConfig($key, $value)
{
}
}
}
namespace WHMCS\Config\Module {
class ModuleConfiguration extends \WHMCS\Model\AbstractModel
{
protected $table = "tblmodule_configuration";
protected $fillable = array("entity_type", "setting_name", "friendly_name", "value");
public function createTable($drop = false)
{
}
public function productAddon()
{
}
public function product()
{
}
}
}
namespace WHMCS\Config {
class ApplicationWriter
{
public function __construct($filePath = NULL)
{
}
public function getFilePath()
{
}
protected function setFilePath($filePath)
{
}
public function setValue($keyName, $value)
{
}
protected function readFileContents($filePath)
{
}
protected function writeFileContents($filePath, array $contents)
{
}
protected function replaceContentValue(array $content, $keyName, $value)
{
}
}
class RuntimeStorage extends \WHMCS\Config\AbstractConfig
{
}
interface DatabaseInterface
{
public function getDatabaseName();
public function getDatabaseUsername();
public function getDatabasePassword();
public function getDatabaseHost();
public function getDatabaseCharset();
public function getDatabasePort();
public function setDatabasePort($value);
public function setDatabaseName($value);
public function setDatabaseUsername($value);
public function setDatabasePassword($value);
public function setDatabaseHost($value);
public function setDatabaseCharset($value);
public function getSqlMode();
}
class Application extends \WHMCS\Config\AbstractConfig implements \WHMCS\Config\DatabaseInterface
{
protected $loadedFilename = NULL;
protected $rootDir = NULL;
protected $requireConfigurationValues = array("license" => "License Key", "db_host" => "Database Hostname", "db_username" => "Database Username", "db_password" => "Database Password", "db_name" => "Database Name", "mysql_charset" => "MySQL Charset", "cc_encryption_hash" => "Encryption Hash", "templates_compiledir" => "Template Compile Directory");
const WHMCS_DEFAULT_CONFIG_FILE = "configuration.php";
const DEFAULT_ATTACHMENTS_FOLDER = "attachments";
const DEFAULT_DOWNLOADS_FOLDER = "downloads";
const DEFAULT_COMPILED_TEMPLATES_FOLDER = "templates_c";
const DEFAULT_ADMIN_FOLDER = "admin";
const DEFAULT_CRON_FOLDER = "crons";
const DEFAULT_SQL_MODE = "";
public function __construct(array $data = array())
{
}
public function isConfigFileLoaded()
{
}
public function getLoadedFilename()
{
}
protected function setLoadedFilename($filename)
{
}
public function validConfigVariables()
{
}
public function loadConfigFile($file)
{
}
public function configFileExists($file)
{
}
protected function getAbsolutePath($file)
{
}
public function getDatabaseName()
{
}
public function getDatabaseUserName()
{
}
public function getDatabasePassword()
{
}
public function getDatabaseHost()
{
}
public function getDatabaseCharset()
{
}
public function getDatabasePort()
{
}
public function setDatabaseCharset($charset)
{
}
public function setDatabaseName($name)
{
}
public function setDatabaseUsername($username)
{
}
public function setDatabaseHost($host)
{
}
protected function parseDatabasePortFromHost($host)
{
}
public function setDatabasePassword($password)
{
}
public function setDatabasePort($port)
{
}
public function getDefaultApplicationConfigFilename()
{
}
public function hasCustomWritableDirectories()
{
}
public function getRootDir()
{
}
public function getAbsoluteAttachmentsPath()
{
}
public function getSqlMode()
{
}
public function invalidConfigurationValues()
{
}
public function write(array $config, $file)
{
}
}
class SettingCollection extends \Illuminate\Database\Eloquent\Collection
{
protected $prefix = NULL;
protected $modelClassName = NULL;
public function __construct($models = array(), $modelClassName = "\\WHMCS\\Config\\Setting", $prefix = "")
{
}
public function __set($key, $value)
{
}
public function __get($key)
{
}
public function find($key, $default = NULL)
{
}
public function saveAll()
{
}
public function baseModel()
{
}
}
}
namespace WHMCS\Language {
abstract class AbstractLanguage extends \Symfony\Component\Translation\Translator
{
protected $globalVariable = "";
protected $name = NULL;
protected static $languageCache = NULL;
const FALLBACK_LANGUAGE = "english";
public function __construct($name = "english", $fallback = self::FALLBACK_LANGUAGE, $languageDirectoryOverride = NULL)
{
}
public static function getLanguages($languageDirectoryOverride = NULL)
{
}
public static function getValidLanguageName($language, $fallback = self::FALLBACK_LANGUAGE)
{
}
public static function getLocales()
{
}
public function getLanguageLocale()
{
}
public function getName()
{
}
public function toArray()
{
}
protected function unFlatten(array &$messages, $key, $value)
{
}
public function getFile()
{
}
public function synchronizeFileWith(\WHMCS\Language\AbstractLanguage $language, $saveTo = NULL)
{
}
public function getLanguageFileFooter()
{
}
protected static function findOrCreate($languageName)
{
}
}
}
namespace WHMCS\Language\Loader {
class WhmcsLoader extends \Symfony\Component\Translation\Loader\ArrayLoader implements \Symfony\Component\Translation\Loader\LoaderInterface
{
protected $globalVariable = NULL;
public function __construct($globalVariable = "_LANG")
{
}
public function load($resource, $locale, $domain = "messages")
{
}
}
class DatabaseLoader extends \Symfony\Component\Translation\Loader\ArrayLoader implements \Symfony\Component\Translation\Loader\LoaderInterface
{
public function load($resource, $locale, $domain = "dynamicMessages")
{
}
}
}
namespace WHMCS\Language {
class ClientLanguage extends \WHMCS\Language\AbstractLanguage
{
protected $globalVariable = "_LANG";
public static function getDirectory()
{
}
public static function factory($systemLanguage = "", $sessionLanguage = "", $requestLanguage = "", $inClientArea = false)
{
}
public function getLanguageFileFooter()
{
}
}
class AdminLanguage extends \WHMCS\Language\AbstractLanguage
{
protected $globalVariable = "_ADMINLANG";
public static function getDirectory()
{
}
public static function factory($languageName = self::FALLBACK_LANGUAGE)
{
}
}
class DynamicTranslation extends \WHMCS\Model\AbstractModel
{
protected $table = "tbldynamic_translations";
protected $primaryKey = "id";
protected $fillable = array("related_type", "related_id", "language", "input_type");
public static function boot()
{
}
public function createTable($drop = false)
{
}
public function relatedItems()
{
}
public function reloadDynamicTranslation()
{
}
public function getInputField()
{
}
public static function getInputType($relatedType)
{
}
public static function saveNewTranslations($relatedId, array $relatedTypes = array())
{
}
}
}
namespace WHMCS {
class Cron
{
public static function init()
{
}
public function getValidActions()
{
}
public function isRunningInCLI()
{
}
public function fetchArgs($force = false)
{
}
public function setDebugMode($state = false)
{
}
public function determineRunMode()
{
}
public function raiseLimits()
{
}
public function isScheduled($action)
{
}
public function logActivity($msg, $sub = false)
{
}
public function logActivityDebug($msg)
{
}
public function log($msg, $verbose = 0)
{
}
public function logmemusage($line)
{
}
public function emailLog($msg)
{
}
public function emailLogSub($msg)
{
}
public function emailReport()
{
}
public function isInDoOnlyMode()
{
}
public static function getCronsPath($fileName)
{
}
public static function getCronPathErrorMessage()
{
}
public static function getCronRootDirErrorMessage()
{
}
public static function formatOutput($output)
{
}
public static function getLegacyCronMessage()
{
}
public function setLastDailyCronInvocationTime(\WHMCS\Carbon $datetime = NULL)
{
}
public function getLastDailyCronInvocationTime()
{
}
public function hasDailyCronRunInLast24Hours()
{
}
public function hasDailyCronEverRun()
{
}
public function hasCronEverBeenInvoked()
{
}
public static function getDailyCronExecutionHour()
{
}
public static function setDailyCronExecutionHour($time = "09")
{
}
public function isOkayToRunDailyCronNow()
{
}
public function hasCronBeenInvokedIn24Hours()
{
}
public function getLastCronInvocationTime()
{
}
public function setCronInvocationTime()
{
}
}
}
namespace WHMCS\Security\Hash {
class Password
{
protected $useHmac = false;
protected $defaultHashAlgorithm = 1;
protected $defaultHashOptions = array();
protected $infoCache = array();
const HASH_MD5 = "plain-MD5";
const HASH_SALTED_MD5 = "salted-MD5";
const HASH_HMAC_SHA256 = "HMAC-SHA256";
const HASH_BCRYPT = "bcrypt";
const HASH_UNKNOWN = "unknown";
const PATTERN_MD5 = "/^[a-f0-9]{32}\$/i";
const PATTERN_SALTED_MD5 = "/^[a-f0-9]{32}(?::(.+))\$/i";
const PATTERN_HMAC_SHA256 = "/^[a-f0-9]{64}(?::(.+))\$/i";
const PATTERN_BCRYPT = "/^(\\\$2[axy]|\\\$2)\\\$[0-9]{0,2}?\\\$([a-z0-9\\/.]{22})[a-z0-9\\/.]{31}\$/i";
public function __construct($useHmac = false)
{
}
public function verify($input, $storedHash)
{
}
public function hash($input, $algorithm = "", $options = array())
{
}
public function getInfo($hash)
{
}
public function needsRehash($hash, $algorithm = "", $options = array())
{
}
protected function hmacHash($input, $key = "")
{
}
protected function verifyHmacSha256($input, $storedHash)
{
}
protected function verifyMd5($input, $storedHash)
{
}
protected function verifySaltedMd5($input, $storedHash)
{
}
public function assertBinarySameness($hashedInput, $storedHash)
{
}
}
}
namespace WHMCS\Security\Encryption {
class Aes extends \phpseclib\Crypt\AES
{
public function __construct($mode = \phpseclib\Crypt\Base::MODE_CBC)
{
}
public function encrypt($plaintext)
{
}
public function decrypt($ciphertext)
{
}
public function hex2bin($hexInput)
{
}
}
class RsaKeyPair extends \WHMCS\Model\AbstractModel
{
protected $table = "tblrsakeypairs";
public function createTable($drop = false)
{
}
public function setPrivateKeyAttribute($value)
{
}
public function getDecryptedPrivateKeyAttribute()
{
}
public static function factoryKeyPair($keySize = 4096)
{
}
public function getPublicRsaAttribute()
{
}
public function getPrivateRsaAttribute()
{
}
}
}
namespace WHMCS\Security {
class Environment
{
public static function setHttpProxyHeader($userConfiguredProxy = "")
{
}
}
}
namespace WHMCS {
class File
{
protected $path = NULL;
public function __construct($path)
{
}
public function exists()
{
}
public function create($contents)
{
}
public function delete()
{
}
public static function isFileNameSafe($filename)
{
}
public function contents()
{
}
}
class CustomField extends \WHMCS\Model\AbstractModel
{
protected $table = "tblcustomfields";
protected $columnMap = array("relatedId" => "relid", "regularExpression" => "regexpr", "showOnOrderForm" => "showorder", "showOnInvoice" => "showinvoice");
protected $commaSeparated = array("fieldOptions");
protected $fillable = array("type", "relid", "fieldName", "fieldType");
public static function boot()
{
}
public function scopeClientFields(\Illuminate\Database\Eloquent\Builder $query)
{
}
public function scopeProductFields(\Illuminate\Database\Eloquent\Builder $query, $productId)
{
}
public function scopeSupportFields(\Illuminate\Database\Eloquent\Builder $query, $departmentId)
{
}
public function scopeAddonFields(\Illuminate\Database\Eloquent\Builder $query, $addonId)
{
}
public function product()
{
}
public function addon()
{
}
public function getFieldNameAttribute($fieldName)
{
}
public function getDescriptionAttribute($description)
{
}
public function customFieldValues()
{
}
public static function getFieldName($fieldId, $fallback = "", $language = NULL)
{
}
public static function getDescription($fieldId, $fallback = "", $language = NULL)
{
}
}
}
namespace WHMCS\Installer {
class Installer
{
protected $installed = false;
protected $version = NULL;
protected $latestVersion = NULL;
protected $database = NULL;
protected $customAdminPath = "admin";
protected $templatesCompiledDir = \WHMCS\Config\Application::DEFAULT_COMPILED_TEMPLATES_FOLDER;
protected $installerDirectory = "";
const DEFAULT_VERSION = "0.0.0";
public function __construct(\WHMCS\Version\SemanticVersion $installedVersion, \WHMCS\Version\SemanticVersion $latestVersionAvailable)
{
}
public function setInstallerDirectory($dir)
{
}
public function getInstallerDirectory()
{
}
public function isInstalled()
{
}
public function getLatestMajorMinorVersion()
{
}
public function getInstalledVersion()
{
}
public function getInstalledVersionNumeric()
{
}
protected function shouldRunUpgrade(\WHMCS\Version\SemanticVersion $versionOfInterest)
{
}
public function isUpToDate()
{
}
public function checkIfInstalled($forceLoadConfig = false)
{
}
public function factoryDatabase($host = "127.0.0.1", $port = "", $username = "", $password = "", $dbName = "", $mysqlCharset = "")
{
}
protected function getVersionFromDatabase()
{
}
public function getDatabase()
{
}
public function setDatabase($db)
{
}
protected function fetchDatabaseConfigurationValue($key = "Version")
{
}
protected function storeDatabaseConfigurationValue($value, $key = "Version")
{
}
public function runUpgrades()
{
}
public function getAdminPath()
{
}
public function getVersion()
{
}
public function setVersion(\WHMCS\Version\SemanticVersion $version)
{
}
public function getLatestVersion()
{
}
public function setLatestVersion(\WHMCS\Version\SemanticVersion $latest)
{
}
public function clearCompiledTemplates()
{
}
public function setReleaseTierPin()
{
}
public function seedDatabase()
{
}
public function createInitialAdminUser($username, $firstName, $lastName, $password, $email)
{
}
public function performNonSeedIncrementalChange(array $settings = array(), array $localStorage = array())
{
}
protected function createInitialStorageConfigurations(array $localStorage = array())
{
}
}
}
namespace WHMCS\Installer\Composer {
class CertificateManager
{
const KEYSERVER_URL_TESTING = "https://pki.dev.whmcs.com/";
const KEYSERVER_URL_PRODUCTION = "https://pki.whmcs.com/";
const CERTS_CACHE_SUBDIR = "certs";
const MAX_CA_LEVELS = 2;
const ROOT_CA_CERTIFICATE_CONTENT = "-----BEGIN CERTIFICATE-----\nMIIJgzCCBWugAwIBAgIJANx485J3h2VKMA0GCSqGSIb3DQEBCwUAMEUxCzAJBgNV\nBAYTAlVTMQ4wDAYDVQQIDAVUZXhhczEOMAwGA1UECgwFV0hNQ1MxFjAUBgNVBAMM\nDVdITUNTIFJvb3QgQ0EwHhcNMTYwNzA3MjIzNjM4WhcNMzYwNzAyMjIzNjM4WjBF\nMQswCQYDVQQGEwJVUzEOMAwGA1UECAwFVGV4YXMxDjAMBgNVBAoMBVdITUNTMRYw\nFAYDVQQDDA1XSE1DUyBSb290IENBMIIEIjANBgkqhkiG9w0BAQEFAAOCBA8AMIIE\nCgKCBAEAsyCjYEFwvU+fv3QR0vD9OdFSuJ6/xugVXi0GVLtHg+WCsrgpzIVQ/R97\nSIHx5+mI4qgvtdH5DaMkPn0P1gRYgnxt+dJMfWnhVkGLhVX6PGkdXhIETKuqwN1J\n+Xulox1BWfCbKfslOJTT49/A5ri4nDJWHJjbU4Ko7sK4zM3agEQv+6wFzRSFDVW8\npJLHra6TXt+C3uw0T/ERzlD/QVtX9mRL2PhLaNEcjr1uxmV5hHqDHpq6b+GstWKy\n9ghpoP3z9Q6JC0tYi/s94ssGsCRAolntIyh+XWfVXubZLuvy0N6dkyIuil9OnAjb\n3b5f5fRI8LG3im93WBer0i70OFXoV3StjdE3hs5/tya3bKXlUNUsmFlYOWgmi1vG\nKmUbn+98j4wevv+K8msYvs0WQ4N7weXN9wAew9Rah5PTLCz1qG/MGmi7sZQNTPUe\nGml0GTBoXQX6eezTC7K0A1TQcqL59C1HvVz5r23bPMkab6We8dow35Sn0WCLe0Nr\nOgLquvkHBpHM1hcUF6NbHj9ntgWhxy/abbsxyTEZKRFzsgRydlk1ly5omMzP1ozk\nwUaeEtzoa/ciVCrS4odk5kbmDnmPCr+yB7Whm92yr0EMeGQRlI1cVRLzZUg9vJ//\nsh8Mr8J5Jy+0RawxWabDY4tK4lMV8uGjRaBj3FCftIgR//jC+qDaCBIcHWZKgIfS\nbYmAhDnJeCeMkRMrXPRm/uyx6YiQ1ub5Io2rIqNoEWAStEuV43Aw/lUXYsX2Vseb\ncoIM7PnrBTigi4paenqUiGutKLoC3uamK4wmMCnqlWr5srTW10+OkBFQGlmuVgXT\ndS453oI1wfB7kNyNIiq9Sj0v7ibEp/xbrqRhhxFRmpElk9AYO+ZEKBaR6vD88Nhv\ntkmWLT0mob4RyTNOR5NcazkIDjLxfTjlebbzkGjWNTuumBUF3fjqxmvvVmqmsGt4\nr9yL7Xy2hx2o4c6dqTS9bk8Sn4p/SxMU7UoxkRbjbVskfawXjpBMh1SrTNRDAFJ9\nj+uZe/0JxBI6uojj7V5PKXtixs3OHz1HMSOCpx7NIe7bR+2KKpOLZk0UeBEBmf/E\nCrRNPu3DJL9xLjNMZXbJAVRh/VgDqY45bF8BhVI92ewnvZolxdzgj6KQsTGfrTIS\n2a/KrbZnKCcPl/CtWOroPK6Q6fQGZmi5KzfpDCJVz9dq5Q1QtkM0SB9XSoF+IITD\ntsWoai1PR+U/6+f4412IQKp7O2pMsUV4NPbX0P2jYwfFDQmHTFr+lWLOvwHN+h1w\n/hIF/CiWghcphYYhN/4yNrUhliDsXigl/9nQRP0Qw4E3708PwkFLesYaygKWQKGT\nL6ysyCAN9W62XWsxLC0lffPIa1O8WwIDAQABo3YwdDARBglghkgBhvhCAQEEBAMC\nAAEwHQYDVR0OBBYEFE2WzMhfNkRf1FgBY8rL4IN4M8ICMB8GA1UdIwQYMBaAFE2W\nzMhfNkRf1FgBY8rL4IN4M8ICMA8GA1UdEwEB/wQFMAMBAf8wDgYDVR0PAQH/BAQD\nAgGGMA0GCSqGSIb3DQEBCwUAA4IEAQCCrk37FUnqPsCI5voK1Ht1n32k4+zQZSZi\nHLOn2FTfg8pH2/cGNnT4RUYGZ2dQjTiGx1N4VIQ8U98KkCTZRLmNTa0uiPOzxa0X\n/VjYZNUXLslgYNXr/BH4m3/0pbHFcMygt8m18Ftc/Hp3sY+Phml1JVtK1t5bDrVR\n12w0SyRFekUUO6S5t9vnuBToNFX758y19jOwv1UN4pt4UEQzhjyadp/7rBEAFThs\nxZ0tGVTxf/itAlNiWfdhw4RGFskAf0T1SDNs48J/PH6b+ON8I2H2CIO+WI8MqGZm\nstNvZhDsVWv5naiBPcOZYrMRdQUPEtFttXQE/Myv3fEslqi6tO61F2r6wgEUPoKW\ndugbwxMlkvC/xqeawSpdp86FhGGosrcItW0Uqw0nBiFw1EBW/knxh9DRmi8k0RHC\njb8Ul8TaM8xr3SitT6oqB4t4eEHQCmvd0ycdHcfjQQpVdBhfdeUxQNX+jjNICnv0\n2m4oz0/kj0XiZGCDmA8sxCVC4Y+Qymaqvcu2Zj7yyUl0doRhkTxpOWsYQDTDgFi5\nXFhSIetPhrSQsYI9At8MQKLMqqVKhIwwrQtbsNsqzl1sS+GvttgSy5wwpwcEg7TZ\n+KYue0KCxZb33UywkoapW8HcHKePHIlOUt7LBoWwgs/Ypjrt9oWWrIzMlnU2+oUs\ncJgIwPIPa3M6jDBsM1369yG83YvzOFFJ6q73hV4oCsdchtaZHxvvdq+dDpxDgqt/\nmKLTqIEPtmJ11gFbMqh4gKmztWOcv1zVTpioafViOlPnGZ2I0C4g3bi5GUzKjggb\ndLU7Oe0HdmxSlu3cKPS3fBf2rgeevIbQrpGDtsLb4jchpa0vp/InnlcepX8ujtEJ\n60iqnET0di4mfo90q9sNuBmcvCGkjI4h4Mv+g08ksaSV1Wd0+3utwGaIZrJ8bTkW\nrZn9/OX1hUBmMssxLJy0EUqScWll2QW6SCbOFA3fJyEhujKhHU1oHHg5WbT7y7IZ\n8ynlmvccXcbdfu4MoqItGOC1nj3ZiGCW++QI6Dif7SmilnpF8xGMF5eut/+Eg3qz\n4mtF+kbluIGBiWR2CR486H1A27pW2plYL2LC2beCGG9aom98xKYT9ERKdwoCom1z\n2quBxFbnV8vLJw0if0cLi2OH/CQx+Hy6y0TKzDVaOQl7h2kFu5z6Hbtat0vejZAH\nT1OQRISMgDSjVQqJRaxepD7Ops1sagL9BfVQeww9+4URfJtC8d0WuFsLil235ds8\n7VSMXjDPTljhphc7l4XfsLmzcFd8jpXqrbBJnxYOO5xE6XubzqCUFf4p9pI0yTXf\nFsrC0StsUUyUM8eyWHbpp1rprIIc8b/qoi6YXGZ+m62azYAhFjoa\n-----END CERTIFICATE-----";
public function __construct($updateTempPath)
{
}
public function getUpdateTempDir()
{
}
public function setUpdateTempDir($value)
{
}
public function getRootCaCertificateContent()
{
}
public function getEnvironmentErrors()
{
}
public function isEnvironmentValid()
{
}
public static function getKeyServerUrl()
{
}
public function getPathFromKeyserver($path)
{
}
public function getValidCodeSigningCertificateContent($keyIdentifier)
{
}
}
class UpdateNotification extends \WHMCS\View\Admin\HealthCheck\HealthCheckResult
{
}
class WhmcsRepository extends \Composer\Repository\ComposerRepository
{
const REPOSITORY_TYPE = "whmcs-composer";
protected function fetchFile($filename, $cacheKey = NULL, $sha256 = NULL, $storeLastModifiedTime = false)
{
}
}
class ComposerUpdateException extends \WHMCS\Exception
{
}
class UpdateEnvironment
{
public static function initEnvironment($updateTempDir)
{
}
}
class ComposerJson
{
const STABILITY_DEV = "dev";
const STABILITY_ALPHA = "alpha";
const STABILITY_BETA = "beta";
const STABILITY_RC = "RC";
const STABILITY_STABLE = "stable";
public function __construct()
{
}
public function init()
{
}
public function getMinimumStability()
{
}
public function setMinimumStability($value)
{
}
public function checkStability($stability)
{
}
public function getAllowInsecureHttp()
{
}
public function setAllowInsecureHttp($value)
{
}
public function addRepository($url, $type = "composer")
{
}
public function disablePackagist()
{
}
public function enablePackagist()
{
}
public function getVersionRequirementFromVersionPin($version)
{
}
public function addRequirementWithVersion($packageName, $version)
{
}
public function addRequirementWithStability($packageName, $stability)
{
}
public function buildArray()
{
}
public function build()
{
}
}
class ValidatedZipDownloader extends \Composer\Downloader\ZipDownloader
{
public function download(\Composer\Package\PackageInterface $package, $path)
{
}
public function setPackageMetadataCallback(callable $callback)
{
}
protected function generateValidationHash($file)
{
}
protected function getPackageSignature()
{
}
protected function isSignatureValid($file, $certificate)
{
}
protected function validateFile($file)
{
}
protected function extract($file, $path)
{
}
}
class ComposerUpdate
{
const REPOSITORY_URL_TESTING = "https://releases.dev.whmcs.com/v2/";
const REPOSITORY_URL_PRODUCTION = "https://releases.whmcs.com/v2/";
const REPO_DATE_STAMPED_MANIFESTS_PATH = "daily/";
const FIRST_UPDATABLE_RELEASE_DATE = "2016-07-19";
public function __construct($updateTempPath)
{
}
public static function isDryRunOnlyUpdate()
{
}
public static function isUsingInternalUpdateResources()
{
}
public static function getDefaultAllowedCoreStabilityTiers()
{
}
public static function getRepositoryUrl()
{
}
public function getFirstUpdatableReleaseDate()
{
}
public function setFirstUpdatableReleaseDate($value)
{
}
public function getAllowedCoreStabilityTiers()
{
}
public function setAllowedCoreStabilityTiers(array $value)
{
}
public function getCoreStabilityTier()
{
}
public function setCoreStabilityTier($value)
{
}
public function getCoreVersion()
{
}
protected function isValidCoreVersion($value)
{
}
public function setCoreVersion($value)
{
}
public function setSkipLicenseCheck($value)
{
}
public function getSkipLicenseCheck()
{
}
protected function setComposerWrapper(\WHMCS\Installer\Composer\ComposerWrapper $composer)
{
}
public function getInstalledVersion()
{
}
public static function getAllVersionsRepositoryUrl()
{
}
protected function getRepositoryUrlForDate($updatesExpiryDate)
{
}
protected function getRepositoryUrlForLicense(\WHMCS\License $license)
{
}
public function getRepositoryUrlForCurrentInstall()
{
}
public function pinUpdateChannel($versionOrTier)
{
}
protected function getComposerConfig()
{
}
protected function deleteComposerJsonFile()
{
}
protected function initComposerEnvironment()
{
}
protected function cleanupComposerEnvironment()
{
}
protected function doComposerCommand(\Closure $command)
{
}
protected function addToUpdateLog($message)
{
}
protected function validateUpdateResults()
{
}
public function update()
{
}
public function getLatestVersion($forceUpdate = false)
{
}
public function canUpdate(\WHMCS\Version\SemanticVersion $latestVersion)
{
}
public function getUpdateLog()
{
}
protected function getMetadataByPackage($packageName)
{
}
public function getReleaseMetaData()
{
}
}
class WhmcsRemoteFilesystem extends \Composer\Util\RemoteFilesystem
{
public function __construct(\Composer\IO\IOInterface $io, \Composer\Config $config = NULL, array $options = array(), $disableTls = false)
{
}
protected function get($originUrl, $fileUrl, $additionalOptions = array(), $fileName = NULL, $progress = true)
{
}
}
class Channels
{
public function __construct($repository = NULL, $minStabilityLevels = array())
{
}
public function setMinStabilityLevels($toSet)
{
}
public function getMinStabilityLevels()
{
}
public function setAllVersionsToPin($toSet)
{
}
public function getAllVersionsToPin()
{
}
public function setRepositoryURL($url)
{
}
public function getRepositoryURL()
{
}
public function setPackagesJson($jsonBody)
{
}
public function getPackagesJson()
{
}
public function setLtsJson($jsonBody)
{
}
public function getLtsJson()
{
}
public function setCurrentVersion(\WHMCS\Version\SemanticVersion $version)
{
}
public function fetchRemoteVersionsAvailable()
{
}
public function downloadRemoteLtsJson()
{
}
public function filterRemoteVersions()
{
}
public function getVersionsToOffer()
{
}
public function getSubscribeOptions()
{
}
protected function getActiveAndLTSVersions()
{
}
public function isPinOutOfLTS($pinnedSetting = NULL)
{
}
}
class PackagesFile
{
protected static function flattenMessageArray(array $data)
{
}
public static function getValidationHashBase($packageVersion, array $messages)
{
}
protected function generateValidationHash(\WHMCS\Version\SemanticVersion $packageVersion, array $messages)
{
}
protected function isNotificationsSignatureValid(\WHMCS\Version\SemanticVersion $packageVersion, array $messages, $signature, $certificate)
{
}
public function validateNotificationSignatures(array $data)
{
}
}
class MonologBufferedOutputWrapper extends \Symfony\Component\Console\Output\BufferedOutput
{
protected $logger = NULL;
public function getLogger()
{
}
public function setLogger(\Monolog\Logger $logger)
{
}
protected function doWrite($message, $newline)
{
}
}
final class CertificateCrl
{
const CRL_START = "-----BEGIN X509 CRL-----";
const CRL_END = "-----END X509 CRL-----";
public function __construct($crlContent)
{
}
public static function popFromPackage(&$crlPackage)
{
}
public function clear()
{
}
public function getAuthorityKeyIdentifier()
{
}
public function setCrlContent($crlContent)
{
}
public function isLoaded()
{
}
public function checkCertificateNotRevoked(\WHMCS\Installer\Composer\Certificate $certificate)
{
}
public function validateSignedBy(\WHMCS\Installer\Composer\Certificate $caCertificate)
{
}
}
class UpdateNotificationRepository
{
public function __construct(\WHMCS\Installer\Composer\Channels $channel)
{
}
public function setCurrentVersion($version)
{
}
public function setLicense(\WHMCS\License $license)
{
}
public function getCurrentVersion()
{
}
public function setUpdateVersion($version)
{
}
public function getUpdateVersion()
{
}
public function setLatestBetaVersion($version)
{
}
public function getLatestBetaVersion()
{
}
public function setLatestStableVersion($version)
{
}
public function getLatestStableVersion()
{
}
public function setLatestSupportAndUpdatesVersion($version)
{
}
public function getLatestSupportAndUpdatesVersion()
{
}
public function setCurrentTier($tier)
{
}
public function getCurrentTier()
{
}
public function getNotifications()
{
}
public function checkIfPrereleaseRCUpdateAvailable()
{
}
public function checkIfPrereleaseBetaUpdateAvailable()
{
}
public function checkIfPinnedVersionPreventsUpdate()
{
}
public function checkIfPinnedVersionIsUnsupported()
{
}
public function checkIfSupportAndUpdatesBlocksUpdate()
{
}
}
class WhmcsComposerFactory extends \Composer\Factory
{
protected function addLocalRepository(\Composer\IO\IOInterface $io, \Composer\Repository\RepositoryManager $rm, $vendorDir)
{
}
}
class ComposerWrapper
{
const PACKAGE_NAME = "whmcs/whmcs";
const COMPOSER_UPDATE_SUBDIR = "composer";
public function __construct($updateTempPath)
{
}
protected function getTargetDir()
{
}
protected function setTargetDir($value)
{
}
protected function getUpdateTempDir()
{
}
protected function setUpdateTempDir($value)
{
}
public function getDryRun()
{
}
public function setDryRun($value)
{
}
public function getCommandOutput()
{
}
public function getCommandExecutionTime()
{
}
public function getCommandSuccess()
{
}
public function setConfig(array $value)
{
}
public function initEnvironment()
{
}
public function getEnvironmentErrors()
{
}
public function isEnvironmentValid()
{
}
protected function validateCommandEnvironment()
{
}
protected function saveErrorHandling()
{
}
protected function restoreErrorHandling()
{
}
protected function startCommandRun()
{
}
protected function endCommandRun()
{
}
protected function deleteInstalledJson()
{
}
protected function deleteComposerLock()
{
}
public function update()
{
}
public function getLatestVersion()
{
}
public function getLastRunPackageMetadata()
{
}
}
final class Certificate
{
const CACHE_SIGNING_SUBDIR = "signing";
const CACHE_INTERMEDIATE_SUBDIR = "intermediate";
const TYPE_CODE_SIGNING = 1;
const TYPE_INTERMEDIATE = 2;
public function __construct($certType)
{
}
public function clear()
{
}
public function getCertsDir()
{
}
public function setCertsDir($value)
{
}
public function getSubdir()
{
}
public function setSubdir($value)
{
}
public function getKeyIdentifier()
{
}
public function getAuthorityKeyIdentifier()
{
}
public function getCertificateContent()
{
}
public function getSerialNumber()
{
}
public function getIsCa()
{
}
public function getCanSignCerts()
{
}
public function getCanSignCrls()
{
}
public function getCanSignCode()
{
}
public function getCacheEnabled()
{
}
public function setCacheEnabled($value)
{
}
public static function convertKeyIdentifier($base64KeyIdentifier)
{
}
public function setCertificateContent($value)
{
}
public function loadFromCache($keyIdentifier)
{
}
public function checkLoaded()
{
}
public function saveToCache()
{
}
public function deleteFromCache()
{
}
public function getIsCached()
{
}
public function isLoaded()
{
}
public function getCertificateType()
{
}
public function validateSignedBy(\WHMCS\Installer\Composer\Certificate $caCertificate)
{
}
}
class WhmcsComposerApplication extends \Composer\Console\Application
{
public function getOverrideConfig()
{
}
public function setOverrideConfig($value)
{
}
public function getComposer($required = true, $disablePlugins = false)
{
}
protected function doRunCommand(\Symfony\Component\Console\Command\Command $command, \Symfony\Component\Console\Input\InputInterface $input, \Symfony\Component\Console\Output\OutputInterface $output)
{
}
public function getPackageMetadata()
{
}
}
}
namespace WHMCS\Installer\Cli\Log {
class ProgressHandler extends \Monolog\Handler\AbstractProcessingHandler
{
protected $progressBar = NULL;
protected $output = NULL;
public function getProgressBar()
{
}
public function setProgressBar($progressBar)
{
}
public function getOutput()
{
}
public function setOutput($output)
{
}
protected function write(array $record)
{
}
}
}
namespace WHMCS\Installer\Cli {
class AbstractApplication
{
protected $cli = NULL;
protected $installer = NULL;
public function __construct(\League\CLImate\CLImate $cli, \WHMCS\Installer\Installer $installer)
{
}
public function getCli()
{
}
public function setCli($cli)
{
}
public function getInstaller()
{
}
public function setInstaller($installer)
{
}
public function header($title = "")
{
}
public function headerArt()
{
}
public function footer()
{
}
public function error($message, $suggestHelp = false)
{
}
public function errorException(\Exception $e)
{
}
public function addVerbosity()
{
}
protected function createProgressBar($totalSteps)
{
}
public function addProgressBar($totalSteps = 0, $calculateBehind = true)
{
}
protected function notImplemented()
{
}
public function eula()
{
}
public function sanitizeConfig(array $config = array())
{
}
public function install(array $config = array())
{
}
public function upgrade()
{
}
public function status()
{
}
}
class Application extends \WHMCS\Installer\Cli\AbstractApplication
{
protected $preflightCount = 1;
public function status()
{
}
public function preflightCheckOutput($msg)
{
}
protected function preInstallCheck()
{
}
protected function createAdminUser(array $admin = array())
{
}
protected function outputAdminCreatedMessage($username, $password)
{
}
public function sanitizeConfig(array $config = array())
{
}
protected function createConfigurationFile(array $config)
{
}
public function install(array $config = array())
{
}
public function upgrade()
{
}
}
}
namespace WHMCS\Installer {
class DatabaseContent
{
protected $schemaDirectory = "";
public function __construct($schemaDirectory = NULL)
{
}
public function getDefaultSchemaDirectory()
{
}
public function getSchemaDirectory()
{
}
public function setSchemaDirectory($schemaDirectory)
{
}
public function getDatabaseSeedContent()
{
}
}
class LogServiceProvider extends \WHMCS\Log\LogServiceProvider
{
public function factoryDefaultChannelLogger()
{
}
protected function importLogHandlers($baseDirectory = NULL)
{
}
public static function getUpdateLogHandler()
{
}
}
}
namespace WHMCS\Installer\Update {
class UpdateLog extends \WHMCS\Model\AbstractModel
{
protected $table = "tblupdatelog";
public function createTable($drop = false)
{
}
}
class UpdateNotification
{
protected $style = "";
protected $icon = "";
protected $title = "";
protected $body = "";
protected $acceptanceMessage = "";
protected $overrides = array();
protected $id = "";
const STYLE_SUCCESS = "success";
const STYLE_WARNING = "warning";
const STYLE_DANGER = "danger";
const STYLE_INFO = "info";
const STYLE_GREY = "grey";
const STYLES = NULL;
const TITLE_HIDDEN = "::hidden::";
const MAX_TITLE_LENGTH = 90;
public function __construct($title = "", $body = "", $style = self::STYLE_WARNING, $icon = "fa-asterisk", $requiresAcceptance = "", $overrides = array(), $id = "")
{
}
protected function updateUniqueId()
{
}
public static function loadFromJson($json)
{
}
public function toArray()
{
}
public function toJson()
{
}
public function setTitle($title)
{
}
public function validateTitle($title)
{
}
public function getTitle()
{
}
public function setBody($body)
{
}
public function validateBody($body)
{
}
public function getBody()
{
}
public function setStyle($style)
{
}
public function validateStyle($style)
{
}
public function getStyle()
{
}
public function setIcon($icon)
{
}
public function validateIcon($icon)
{
}
public function getIcon()
{
}
public function setAcceptanceMessage($acceptance)
{
}
public function validateAcceptanceMessage($acceptance)
{
}
public function getAcceptanceMessage()
{
}
public function requiresAcceptance()
{
}
public function setUniqueId($id)
{
}
public function getUniqueId()
{
}
public function validateUniqueId($id)
{
}
public function getSafeBody()
{
}
public function getSafeTitle()
{
}
public function setOverrides($overrides)
{
}
public function getOverrides()
{
}
public function validateOverrides($overrides)
{
}
}
class Updater
{
protected $cachedPackagesDataFile = NULL;
const FALLBACK_UPDATE_CHANNEL = \WHMCS\Installer\Composer\ComposerJson::STABILITY_STABLE;
public function getLatestVersion()
{
}
public function isUpdateAvailable()
{
}
public function getInstalledMajorMinorVersion()
{
}
public function getVersionParts($version)
{
}
public function getVersionNumber($version)
{
}
public function getVersionLabel($version)
{
}
public function getChannel()
{
}
public function setChannel($channel)
{
}
public function getTemporaryPath()
{
}
public function setTemporaryPath($path)
{
}
public function setCachedPackagesDataFile($json)
{
}
public function getMaintenanceMessage()
{
}
public static function isAutoUpdateInProgress()
{
}
public static function isAutoUpdateInProgressByCurrentAdminUser()
{
}
public function enableAutoUpdateMaintenanceMsg()
{
}
public function disableAutoUpdateMaintenanceMsg()
{
}
public function getLastCheckedForUpdates()
{
}
public function isUpdateTempPathConfigured()
{
}
public function isUpdateTempPathWriteable()
{
}
public function getUpdateChannels()
{
}
public function setConfiguration($channel, $temporaryPath, $maintenanceMsg)
{
}
public function updateRemoteComposerData()
{
}
public function fetchLTSInfo()
{
}
public function getUpgradeAlerts()
{
}
public function fetchComposerLatestVersion()
{
}
public function performFileUpdate()
{
}
protected function getCachedPackagesDataFile()
{
}
public function getReleaseNotesUrl($version = NULL)
{
}
public function getChangelogUrl($version = NULL)
{
}
public function getMemoryLimitRequiredToUpdateTo(\WHMCS\Version\SemanticVersion $version = NULL)
{
}
public function getMinimumRequiredIoncubeLoaderVersion(\WHMCS\Version\SemanticVersion $version)
{
}
public function getPreUpdateNotificationsForVersion(\WHMCS\Version\SemanticVersion $updateToVersion)
{
}
protected function applyNotificationOverrides(array $notifications)
{
}
protected function getPreUpdateNotificationsForUpgradeBetweenVersions(\WHMCS\Version\SemanticVersion $updateToVersion, \WHMCS\Version\SemanticVersion $updateFromVersion)
{
}
}
class ReleaseMetadata
{
protected $releaseNotesUrl = "";
protected $changeLogUrl = "";
protected $valid = false;
protected $simulated = false;
protected $repositoryUrl = "";
protected $productVersion = "";
public function __construct()
{
}
public function getReleaseNotesUrl()
{
}
public function setReleaseNotesUrl($value)
{
}
public function getChangeLogUrl()
{
}
public function setChangeLogUrl($value)
{
}
public function setRepositoryUrl($value)
{
}
public function isValid()
{
}
public function clean()
{
}
protected function loadFromCache()
{
}
public function setFromPackageMetadata($productVersion, array $packageMetadata)
{
}
protected function loadFromRepository()
{
}
protected function loadSimulatedData()
{
}
public function save()
{
}
public function load($allowRepositoryFetch = true)
{
}
}
class UpdateCheckTask extends \WHMCS\Scheduling\Task\AbstractTask
{
public $description = "WHMCS Update Check";
protected $frequency = "0 */8 * * *";
public function __construct()
{
}
public function __invoke()
{
}
}
class UpdateLogHandler extends \Monolog\Handler\AbstractProcessingHandler
{
protected function write(array $record)
{
}
protected function getDefaultFormatter()
{
}
}
}
namespace WHMCS\User\Contracts {
interface ContactInterface extends \WHMCS\Model\Contracts\ModelInterface
{
}
interface UserInterface
{
public function getUsernameAttribute();
public function hasPermission($permission);
}
}
namespace WHMCS\User {
interface UserInterface extends \WHMCS\User\Contracts\UserInterface
{
}
abstract class AbstractUser extends \WHMCS\Model\AbstractModel
{
public abstract function isAllowedToAuthenticate();
public static function findUuid($uuid)
{
}
public static function boot()
{
}
}
}
namespace WHMCS\User\Traits {
trait EmailPreferences
{
public static $emailPreferencesDefaults = NULL;
public function validateEmailPreferences(array $preferences)
{
}
public function getEmailPreferences()
{
}
public function getEmailPreference($type)
{
}
public function setEmailPreferences($preferences)
{
}
}
}
namespace WHMCS\User {
class Client extends \WHMCS\User\AbstractUser implements \WHMCS\User\Contracts\ContactInterface, \WHMCS\User\UserInterface
{
use \WHMCS\User\Traits\EmailPreferences;
protected $table = "tblclients";
protected $columnMap = array("passwordHash" => "password", "twoFactorAuthModule" => "authmodule", "twoFactorAuthData" => "authdata", "currencyId" => "currency", "defaultPaymentGateway" => "defaultgateway", "overrideLateFee" => "latefeeoveride", "overrideOverdueNotices" => "overideduenotices", "disableAutomaticCreditCardProcessing" => "disableautocc", "billingContactId" => "billingcid", "securityQuestionId" => "securityqid", "securityQuestionAnswer" => "securityqans", "creditCardType" => "cardtype", "creditCardLastFourDigits" => "cardlastfour", "creditCardExpiryDate" => "expdate", "storedBankNameCrypt" => "bankname", "storedBankTypeCrypt" => "banktype", "storedBankCodeCrypt" => "bankcode", "storedBankAccountCrypt" => "bankacct", "paymentGatewayToken" => "gatewayid", "lastLoginDate" => "lastlogin", "lastLoginIp" => "ip", "lastLoginHostname" => "host", "passwordResetKey" => "pwresetkey", "passwordResetKeyRequestDate" => "pwresetexpiry", "passwordResetKeyExpiryDate" => "pwresetexpiry");
public $timestamps = true;
protected $dates = array("lastLoginDate", "passwordResetKeyRequestDate", "passwordResetKeyExpiryDate");
protected $booleans = array("taxExempt", "overrideLateFee", "overrideOverdueNotices", "separateInvoices", "disableAutomaticCreditCardProcessing", "emailOptOut", "marketingEmailsOptIn", "overrideAutoClose", "emailVerified");
protected $casts = array("email_preferences" => "array");
public $unique = array("email");
protected $appends = array("fullName", "countryName", "groupName");
protected $fillable = array("lastlogin", "ip", "host", "pwresetkey", "pwresetexpiry");
protected $hidden = array("password", "authdata", "securityqans", "cardnum", "startdate", "expdate", "issuenumber", "bankname", "banktype", "bankcode", "bankacct", "pwresetkey", "pwresetexpiry");
const STATUS_ACTIVE = "Active";
const STATUS_INACTIVE = "Inactive";
const STATUS_CLOSED = "Closed";
const PAYMENT_DATA_MIGRATED = "--MIGRATED--";
public function domains()
{
}
public function services()
{
}
public function addons()
{
}
public function contacts()
{
}
public function billingContact()
{
}
public function quotes()
{
}
public function affiliate()
{
}
public function securityQuestion()
{
}
public function invoices()
{
}
public function transactions()
{
}
public function remoteAccountLinks()
{
}
public function orders()
{
}
public function marketingConsent()
{
}
public function scopeLoggedIn($query)
{
}
public function scopeEmail($query, $email)
{
}
public function currencyrel()
{
}
public static function getStatuses()
{
}
public function hasDomain($domainName)
{
}
protected function generateCreditCardEncryptionKey()
{
}
public function getAlerts(\WHMCS\User\Client\AlertFactory $factory = NULL)
{
}
public function isCreditCardExpiring($withinMonths = 2)
{
}
public function getFullNameAttribute()
{
}
public function getCountryNameAttribute()
{
}
public function getSecurityQuestionAnswerAttribute($answer)
{
}
public function setSecurityQuestionAnswerAttribute($answer)
{
}
public function generateCreditCardEncryptedField($value)
{
}
public function getUsernameAttribute()
{
}
public function hasSingleSignOnPermission()
{
}
public function isAllowedToAuthenticate()
{
}
public function isEmailAddressVerified()
{
}
public function getEmailVerificationId()
{
}
public static function generateEmailVerificationKey()
{
}
public function sendEmailAddressVerification()
{
}
public function updateLastLogin(\WHMCS\Carbon $time = NULL, $ip = NULL, $host = NULL)
{
}
public function customFieldValues()
{
}
protected function getCustomFieldType()
{
}
protected function getCustomFieldRelId()
{
}
public function hasPermission($permission)
{
}
public function tickets()
{
}
public function isOptedInToMarketingEmails()
{
}
public function marketingEmailOptIn($userIp = "", $performCurrentSettingCheck = true)
{
}
public function marketingEmailOptOut($userIp = "", $performCurrentSettingCheck = true)
{
}
public function logActivity($message)
{
}
public function deleteEntireClient()
{
}
public static function getGroups()
{
}
public function needsCardDetailsMigrated()
{
}
public function needsBankDetailsMigrated()
{
}
public function needsUnknownPaymentTokenMigrated()
{
}
public function needsAnyPaymentDetailsMigrated()
{
}
public function migratePaymentDetailsIfRequired($forceInCron = false)
{
}
public function markCardDetailsAsMigrated()
{
}
public function markBankDetailsAsMigrated()
{
}
public function markPaymentTokenMigrated()
{
}
public function payMethods()
{
}
public function defaultBillingContact()
{
}
public function getGroupNameAttribute()
{
}
public function domainSslStatuses()
{
}
public function generateUniquePlaceholderEmail()
{
}
public function deleteAllCreditCards()
{
}
public static function getUsedCardTypes()
{
}
public function buildBillingContactsArray()
{
}
public function createRemoteCardPayMethod(\WHMCS\Module\Gateway $gateway, $cardNumber, $cardExpiryDate, $remoteToken, $billingContactId = "billing", $description = "", $cardType = NULL, $cardStartDate = NULL, $cardIssueNumber = NULL)
{
}
public function createCardPayMethod($cardNumber, $cardExpiryDate, $billingContactId = "billing", $description = "", $cardType = NULL, $cardStartDate = NULL, $cardIssueNumber = NULL)
{
}
public function createBankPayMethod($accountType, $routingNumber, $accountNumber, $bankName, $accountHolderName, $billingContactId = "billing", $description = "")
{
}
public function createRemoteBankPayMethod(\WHMCS\Module\Gateway $gateway, $remoteToken, $accountNumber = "", $accountHolderName = "", $billingContactId = "billing", $description = "")
{
}
public function getClientDiscountPercentage()
{
}
public function addCredit($description, $amount)
{
}
public function getLink()
{
}
}
}
namespace WHMCS\User\Client {
class AlertFactory
{
protected $client = NULL;
protected $alerts = array();
public function __construct(\WHMCS\User\Client $client)
{
}
public function build()
{
}
protected function addAlert(\WHMCS\User\Alert $alert)
{
}
protected function checkForExpiringCreditCard()
{
}
protected function checkForDomainsExpiringSoon()
{
}
protected function checkForUnpaidInvoices()
{
}
protected function checkForCreditBalance()
{
}
}
class SecurityQuestion extends \WHMCS\Model\AbstractModel
{
protected $table = "tbladminsecurityquestions";
public function getQuestionAttribute($question)
{
}
public function setQuestionAttribute($question)
{
}
public function clients()
{
}
}
class Affiliate extends \WHMCS\Model\AbstractModel
{
protected $table = "tblaffiliates";
protected $columnMap = array("visitorCount" => "visitors", "commissionType" => "paytype", "paymentAmount" => "payamount", "isPaidOneTimeCommission" => "onetime", "amountWithdrawn" => "withdrawn");
protected $dates = array("date");
public function client()
{
}
}
class Contact extends \WHMCS\Model\AbstractModel implements \WHMCS\User\Contracts\ContactInterface
{
use \WHMCS\User\Traits\EmailPreferences;
protected $table = "tblcontacts";
protected $columnMap = array("clientId" => "userid", "isSubAccount" => "subaccount", "passwordHash" => "password", "receivesDomainEmails" => "domainemails", "receivesGeneralEmails" => "generalemails", "receivesInvoiceEmails" => "invoiceemails", "receivesProductEmails" => "productemails", "receivesSupportEmails" => "supportemails", "receivesAffiliateEmails" => "affiliateemails", "passwordResetKey" => "pwresetkey", "passwordResetKeyExpiryDate" => "pwresetexpiry");
protected $dates = array("passwordResetKeyExpiryDate");
protected $booleans = array("isSubAccount", "receivesDomainEmails", "receivesGeneralEmails", "receivesInvoiceEmails", "receivesProductEmails", "receivesSupportEmails", "receivesAffiliateEmails");
protected $commaSeparated = array("permissions");
protected $appends = array("fullName", "countryName");
public static $allPermissions = array("profile", "contacts", "products", "manageproducts", "productsso", "domains", "managedomains", "invoices", "quotes", "tickets", "affiliates", "emails", "orders");
protected $hidden = array("password", "pwresetkey", "pwresetexpiry");
public function client()
{
}
public function remoteAccountLinks()
{
}
public function orders()
{
}
public function getFullNameAttribute()
{
}
public function getCountryNameAttribute()
{
}
public function updateLastLogin(\WHMCS\Carbon $time = NULL, $ip = NULL, $host = NULL)
{
}
public function getLanguageAttribute()
{
}
public function getTwoFactorAuthModuleAttribute()
{
}
public function tickets()
{
}
public static function currentContactHasPermissionName($permissionName)
{
}
}
}
namespace WHMCS\User {
class Admin extends \WHMCS\User\AbstractUser implements \WHMCS\User\UserInterface
{
protected $table = "tbladmins";
protected $columnMap = array("roleId" => "roleid", "passwordHash" => "password", "twoFactorAuthModule" => "authmodule", "twoFactorAuthData" => "authdata", "supportDepartmentIds" => "supportdepts", "isDisabled" => "disabled", "receivesTicketNotifications" => "ticketnotifications", "loginAttempts" => "loginattempts", "homeWidgets" => "homewidgets", "hiddenWidgets" => "hidden_widgets", "widgetOrder" => "widget_order");
public $unique = array("email");
protected $appends = array("fullName", "gravatarHash");
protected $commaSeparated = array("supportDepartmentIds", "receivesTicketNotifications", "hiddenWidgets", "widgetOrder");
protected $rules = array("firstname" => "required", "lastname" => "required", "email" => "required|email", "username" => "required|min:2", "template" => "required", "language" => "required");
protected $hidden = array("password", "passwordhash", "authdata", "password_reset_key", "password_reset_data", "password_reset_expiry");
const TEMPLATE_THEME_DEFAULT = "blend";
public function getFullNameAttribute()
{
}
public function getGravatarHashAttribute()
{
}
public function getUsernameAttribute()
{
}
public function isAllowedToAuthenticate()
{
}
public function isAllowedToMasquerade()
{
}
public function hasPermission($permission)
{
}
public function getRolePermissions()
{
}
public function getModulePermissions()
{
}
public function authenticationDevices()
{
}
public function getTemplateThemeNameAttribute()
{
}
public function validateUsername($username, $existingUserId = NULL)
{
}
public function flaggedTickets()
{
}
public function scopeActive(\Illuminate\Database\Eloquent\Builder $query)
{
}
public static function getAuthenticatedUser()
{
}
}
class AdminLog extends \WHMCS\Model\AbstractModel
{
protected $table = "tbladminlog";
protected $columnMap = array("username" => "adminusername");
public $timestamps = false;
public $unique = array("sessionid");
public function admin()
{
}
public function scopeOnline($query)
{
}
}
class Alert
{
protected $message = NULL;
protected $severity = "info";
protected $link = NULL;
protected $linkText = NULL;
public function __construct($message, $severity = "info", $link = NULL, $linkText = NULL)
{
}
public function getMessage()
{
}
protected function setMessage($message)
{
}
public function getSeverity()
{
}
protected function setSeverity($severity = "info")
{
}
public function getLink()
{
}
protected function setLink($link)
{
}
public function getLinkText()
{
}
protected function setLinkText($linkText)
{
}
}
}
namespace WHMCS\User\Admin {
class Permission
{
protected $permission = array("1" => "Main Homepage", "2" => "Sidebar Statistics", "3" => "My Account", "4" => "List Clients", "5" => "List Services", "6" => "List Addons", "7" => "List Domains", "8" => "Add New Client", "104" => "View Clients Summary", "120" => "Allow Login as Client", "9" => "Edit Clients Details", "128" => "View Credit Log", "129" => "Manage Credits", "10" => "Manage Pay Methods", "106" => "Decrypt Full Credit Card Number", "107" => "Update/Delete Stored Credit Card", "123" => "Attempts CC Captures", "11" => "View Clients Products/Services", "12" => "Edit Clients Products/Services", "99" => "Create Upgrade/Downgrade Orders", "13" => "Delete Clients Products/Services", "14" => "Perform Server Operations", "15" => "View Clients Domains", "16" => "Edit Clients Domains", "17" => "Delete Clients Domains", "98" => "Perform Registrar Operations", "95" => "Manage Clients Files", "18" => "View Clients Notes", "19" => "Add/Edit Client Notes", "97" => "Delete Client Notes", "20" => "Delete Client", "21" => "Mass Mail", "22" => "View Cancellation Requests", "23" => "Manage Affiliates", "24" => "View Orders", "25" => "Delete Order", "26" => "View Order Details", "27" => "Add New Order", "130" => "Use Any Promotion Code on Order", "28" => "List Transactions", "94" => "View Income Totals", "29" => "Add Transaction", "30" => "Edit Transaction", "31" => "Delete Transaction", "33" => "List Invoices", "34" => "Create Invoice", "124" => "Generate Due Invoices", "35" => "Manage Invoice", "36" => "Delete Invoice", "92" => "Refund Invoice Payments", "89" => "View Billable Items", "90" => "Manage Billable Items", "37" => "Offline Credit Card Processing", "32" => "View Gateway Log", "85" => "Manage Quotes", "38" => "Support Center Overview", "39" => "Manage Announcements", "40" => "Manage Knowledgebase", "41" => "Manage Downloads", "84" => "Manage Network Issues", "42" => "List Support Tickets", "105" => "View Support Ticket", "121" => "Access All Tickets Directly", "82" => "View Flagged Tickets", "43" => "Open New Ticket", "93" => "Delete Ticket", "125" => "Create Predefined Replies", "44" => "Manage Predefined Replies", "126" => "Delete Predefined Replies", "45" => "View Reports", "146" => "Client Data Export", "88" => "Mass Data Export", "46" => "Addon Modules", "135" => "Update WHMCS", "136" => "Modify Update Configuration", "131" => "WHMCSConnect", "101" => "Email Marketer", "47" => "Link Tracking", "49" => "Calendar", "50" => "To-Do List", "51" => "WHOIS Lookups", "52" => "Domain Resolver Checker", "53" => "View Integration Code", "54" => "WHM Import Script", "138" => "Automation Status", "55" => "Database Status", "56" => "System Cleanup Operations", "57" => "View PHP Info", "58" => "View Activity Log", "59" => "View Admin Log", "60" => "View Email Message Log", "61" => "View Ticket Mail Import Log", "62" => "View WHOIS Lookup Log", "103" => "View Module Debug Log", "137" => "View Module Queue", "63" => "Configure General Settings", "148" => "Apps and Integrations", "143" => "Configure Sign-In Integration", "67" => "Configure Automation Settings", "141" => "Manage MarketConnect", "145" => "View MarketConnect Balance", "144" => "Manage Notifications", "147" => "Manage Storage Settings", "133" => "Configure Application Links", "134" => "Configure OpenID Connect", "64" => "Configure Administrators", "65" => "Configure Admin Roles", "127" => "Configure Two-Factor Authentication", "142" => "Manage API Credentials", "100" => "Configure Addon Modules", "91" => "Configure Client Groups", "66" => "Configure Servers", "86" => "Configure Currencies", "68" => "Configure Payment Gateways", "69" => "Tax Configuration", "70" => "View Email Templates", "113" => "Create/Edit Email Templates", "114" => "Delete Email Templates", "115" => "Manage Email Template Languages", "71" => "View Products/Services", "119" => "Manage Product Groups", "116" => "Create New Products/Services", "117" => "Edit Products/Services", "118" => "Delete Products/Services", "72" => "Configure Product Addons", "102" => "Configure Product Bundles", "73" => "View Promotions", "108" => "Create/Edit Promotions", "109" => "Delete Promotions", "74" => "Configure Domain Pricing", "75" => "Configure Support Departments", "140" => "Configure Escalation Rules", "96" => "Configure Ticket Statuses", "122" => "Configure Order Statuses", "76" => "Configure Spam Control", "110" => "View Banned IPs", "111" => "Add Banned IP", "112" => "Unban Banned IP", "77" => "Configure Banned Emails", "78" => "Configure Domain Registrars", "79" => "Configure Fraud Protection", "80" => "Configure Custom Client Fields", "87" => "Configure Security Questions", "83" => "Configure Database Backups", "132" => "Health and Updates", "139" => "View What's New", "81" => "API Access");
public static function all()
{
}
public static function findId($authorizationName)
{
}
public static function findName($id)
{
}
public static function hasPermissionId($permissionId, $adminId)
{
}
public static function currentAdminHasPermissionName($permName)
{
}
}
}
namespace WHMCS {
class Chart
{
public $chartcount = 0;
public function __construct()
{
}
public function drawChart($type, $data, $args = array(), $height = "300px", $width = "100%")
{
}
}
}
namespace WHMCS\Domains\Controller {
class DomainController
{
public function pricing(\Psr\Http\Message\ServerRequestInterface $request)
{
}
public function sslCheck(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
}
namespace WHMCS\Domains {
class DomainPricing
{
protected $domain = NULL;
protected $tldPricing = NULL;
public function __construct(\WHMCS\Domains\Domain $domain, $formatCurrency = true)
{
}
public function setDomain($domain)
{
}
public function getDomain()
{
}
public function setTldPricing(array $tldPricing)
{
}
public function getTldPricing()
{
}
public function hasPricing($type = "register", $specificPeriod = 0)
{
}
public function allPricing()
{
}
public function forPeriod($period)
{
}
public function forRegistrationPeriod($period)
{
}
public function shortestPeriod()
{
}
public function longestPeriod()
{
}
public function toArray()
{
}
}
class Domain
{
protected $secondLevel = NULL;
protected $topLevel = NULL;
protected $secondLevelPunycode = NULL;
protected $generalAvailability = true;
protected $premiumDomain = false;
protected static $whois = NULL;
public function __construct($domain, $tld = NULL)
{
}
public static function createFromSldAndTld($sld, $tld)
{
}
protected function setDomain($domain)
{
}
protected function setDomainBySecondAndTopLevels($sld, $tld)
{
}
public function setSecondLevel($secondLevel)
{
}
public function getUnicodeSecondLevel()
{
}
public function getSecondLevel()
{
}
public function setTopLevel($topLevel)
{
}
public function getTopLevel()
{
}
public function getDotTopLevel()
{
}
public function getSLD()
{
}
public function getTLD()
{
}
public function getDomain($idn = true)
{
}
public function toUnicode()
{
}
public function toPunycode()
{
}
public function getRawDomain()
{
}
public function getLastTLDSegment()
{
}
public function getPunycodeSecondLevel()
{
}
public function getIdnSecondLevel()
{
}
public function isGeneralAvailability()
{
}
public function isPremiumDomain()
{
}
public function isIdn()
{
}
public function setGeneralAvailability($generalAvailability)
{
}
public function setPunycodeSecondLevel($idn)
{
}
public function setIdnSecondLevel($idn)
{
}
public function setPremiumDomain($premiumDomain)
{
}
public static function isValidDomainName($sld, $tld)
{
}
protected static function containsValidNonIdnCharacters($sld, $tld)
{
}
public static function isSupportedTld($tld)
{
}
protected static function getTldDomainLengthRestrictions()
{
}
protected static function normalizeDomainLengthRestrictionArray($restrictionArray)
{
}
protected static function getCoreTldList()
{
}
public function alreadyBilledAsAHostingProduct()
{
}
public function alreadyBilledAsADomainItem()
{
}
public function pricing()
{
}
public function group()
{
}
public function getDomainMinimumLength()
{
}
public function getDomainMaximumLength()
{
}
protected function getPremiumPricing($registrar = NULL, array $type = array())
{
}
public function getPremiumRegistrationPrice($registrar = NULL)
{
}
public function getPremiumRenewalPrice($registrar = NULL)
{
}
protected static function eligibleCountriesForEuTld()
{
}
public static function isValidForEuRegistration($countryCode)
{
}
public function getExtensionModel()
{
}
}
}
namespace WHMCS\Domains\Pricing {
class Premium extends \WHMCS\Model\AbstractModel
{
protected $table = "tbldomainpricing_premium";
public static function boot()
{
}
public function createTable($drop = false)
{
}
public static function markupForCost($amount)
{
}
}
}
namespace WHMCS\Domains\DomainLookup {
class Provider
{
protected static $providerNames = array("BasicWhois" => "\\WHMCS\\Domains\\DomainLookup\\Provider\\BasicWhois", "WhmcsWhois" => "\\WHMCS\\Domains\\DomainLookup\\Provider\\WhmcsWhois", "WhmcsDomains" => "WHMCS\\Domains\\DomainLookup\\Provider\\WhmcsDomains", "Registrar" => "\\WHMCS\\Domains\\DomainLookup\\Provider\\Registrar");
public static function factory($providerName = "", $registrar = "")
{
}
public static function getDomainLookupProvider()
{
}
public static function getDomainLookupRegistrar()
{
}
public static function getAvailableProviders()
{
}
public static function getAvailableRegistrarProviders()
{
}
}
}
namespace WHMCS\Domains\DomainLookup\Provider\WhmcsDomains {
class ApiClient
{
const DEFAULT_LANGUAGE = "english";
const SUPPORTED_LANGUAGES = array("english" => "eng", "french" => "fre", "spanish" => "spa", "italian" => "ita", "portuguese" => "por", "german" => "ger", "dutch" => "dut", "turkish" => "tur", "vietnamese" => "vie", "chinese" => "chi", "japanese" => "jpn", "korean" => "kor");
public function __construct($url = NULL, $apiKey = NULL)
{
}
public function getLanguage()
{
}
public function getEnableSensitiveContentFilter()
{
}
public function setEnableSensitiveContentFilter($enableSensitiveContentFilter)
{
}
public function setLanguage($language)
{
}
public function getUrl()
{
}
public function getApiKey()
{
}
public function setApiKey($apiKey)
{
}
public function getTimeout()
{
}
public function setTimeout($timeout)
{
}
protected function apiCall($endpoint, array $params = array())
{
}
protected function getSearchResult(array $apiDomainResult)
{
}
public function bulkCheck($sld, array $tlds)
{
}
protected function getApiLanguage()
{
}
public function suggest($name, array $tlds, $maxResults = 20)
{
}
}
}
namespace WHMCS\Domains\DomainLookup\Provider {
abstract class AbstractProvider
{
protected abstract function getGeneralAvailability($sld, array $tlds);
protected abstract function getDomainSuggestions(\WHMCS\Domains\Domain $domain, $tldsToInclude);
public abstract function getSettings();
public function checkAvailability(\WHMCS\Domains\Domain $domain, $tlds)
{
}
protected function getSpotlightTlds()
{
}
public function getSuggestions(\WHMCS\Domains\Domain $domain)
{
}
public function getTldsForSuggestions()
{
}
public function checkSubDomain(\WHMCS\Domains\Domain $subDomain)
{
}
public function checkOwnDomain(\WHMCS\Domains\Domain $ownDomain)
{
}
public function getProviderName()
{
}
}
class BasicWhois extends \WHMCS\Domains\DomainLookup\Provider\AbstractProvider
{
protected $bulkCheckLimit = 10;
protected static $apiClient = NULL;
protected function getGeneralAvailability($sld, array $tlds)
{
}
protected function preprocessDomainSuggestionTlds(array $tldsToInclude)
{
}
protected function getDomainSuggestions(\WHMCS\Domains\Domain $domain, $tldsToInclude)
{
}
public function factoryApiClient()
{
}
public function getSettings()
{
}
}
class WhmcsWhois extends \WHMCS\Domains\DomainLookup\Provider\BasicWhois
{
public function getSettings()
{
}
}
class Registrar extends \WHMCS\Domains\DomainLookup\Provider\WhmcsWhois
{
protected $registrarModule = NULL;
protected function getGeneralAvailability($sld, array $tlds)
{
}
protected function getDomainSuggestions(\WHMCS\Domains\Domain $domain, $tldsToInclude)
{
}
public function loadRegistrar($moduleName)
{
}
public function getRegistrar()
{
}
public function getSettings()
{
}
}
class WhmcsDomains extends \WHMCS\Domains\DomainLookup\Provider\WhmcsWhois
{
public function __construct(\WHMCS\Domains\DomainLookup\Provider\WhmcsDomains\ApiClient $apiClient = NULL)
{
}
protected function processUnknownResults($sld, array $verisignResults)
{
}
protected function getGeneralAvailabilityViaApi($sld, array $tlds)
{
}
protected function getGeneralAvailability($sld, array $tlds)
{
}
protected function getDomainSuggestionsViaApi(\WHMCS\Domains\Domain $domain, $tldsToInclude)
{
}
protected function getDomainSuggestions(\WHMCS\Domains\Domain $domain, $tldsToInclude)
{
}
public function getSettings()
{
}
}
}
namespace WHMCS\Domains\DomainLookup {
class DomainLookupException extends \WHMCS\Exception
{
}
class SearchResult extends \WHMCS\Domains\Domain
{
protected $score = 1;
protected $premiumCostPricing = array();
protected $status = NULL;
const STATUS_REGISTERED = "registered";
const STATUS_NOT_REGISTERED = "available for registration";
const STATUS_RESERVED = "reserved";
const STATUS_UNKNOWN = "unknown";
const STATUS_TLD_NOT_SUPPORTED = "tld not supported";
public function __construct($sld, $tld)
{
}
public static function factoryFromDomain(\WHMCS\Domains\Domain $domain)
{
}
public function setScore($score)
{
}
public function getScore()
{
}
public function setPremiumCostPricing($pricing = array())
{
}
public function getPremiumCostPricing()
{
}
public function isAvailableForPurchase()
{
}
public function isMatchingLengthRequirements()
{
}
public function setStatus($status)
{
}
public function getStatus()
{
}
public function getLegacyStatus()
{
}
public function toArray()
{
}
public function pricing()
{
}
protected function calculatePremiumPricing()
{
}
}
class Settings extends \WHMCS\Model\AbstractModel
{
protected $table = "tbldomain_lookup_configuration";
protected $fillable = array("registrar", "setting");
public function createTable($drop = false)
{
}
public function scopeOfRegistrar(\Illuminate\Database\Eloquent\Builder $query, $registrar)
{
}
}
class ResultsList extends \WHMCS\Results\ResultsList
{
}
}
namespace WHMCS\Domains {
class Idna extends \phlyLabs_Net_IDNA
{
}
}
namespace WHMCS\Domains\Extension {
class Pricing extends \WHMCS\Billing\Pricing
{
protected $table = "tblpricing";
public $timestamps = false;
protected $columnMap = array("currencyId" => "currency", "year1" => "msetupfee", "year2" => "qsetupfee", "year3" => "ssetupfee", "year4" => "asetupfee", "year5" => "bsetupfee", "year6" => "monthly", "year7" => "quarterly", "year8" => "semiannually", "year9" => "annually", "year10" => "biennially", "clientGroupId" => "tsetupfee");
protected $hidden = array("triennially");
protected $acceptedTypesForScope = array("register", "renew", "transfer");
protected $fillable = array("type", "relid", "currency", "tsetupfee");
public static function boot()
{
}
public function scopeOfTldId(\Illuminate\Database\Eloquent\Builder $query, $tldId)
{
}
public function scopeOfClientGroup(\Illuminate\Database\Eloquent\Builder $query, $clientGroupId)
{
}
public function scopeOfType(\Illuminate\Database\Eloquent\Builder $query, $type = "register")
{
}
public function scopeOfCurrencyId(\Illuminate\Database\Eloquent\Builder $query, $currencyId = 1)
{
}
public function extension()
{
}
public function currencyModel()
{
}
}
}
namespace WHMCS\Domains {
class AdditionalFields
{
protected $fieldsData = array();
protected $activeTLD = "";
protected $activeDomain = "";
protected $activeTLDValues = array();
protected $resourcePath = NULL;
protected $countries = NULL;
protected $placeholderData = NULL;
protected $domainType = "register";
public function setDomain($domain)
{
}
public function setTLD($tld)
{
}
public function getTLD()
{
}
public function getResourcePath()
{
}
protected function fetch($file)
{
}
protected function loadFieldsData()
{
}
public function getFields()
{
}
protected function populatePlaceholderData()
{
}
protected function replacePlaceholders($options)
{
}
protected function getConfigValue($fieldKey, $name)
{
}
protected function getFieldName($fieldKey)
{
}
public function setFieldValues($values)
{
}
protected function getFieldValue($fieldKey)
{
}
public function getFieldsForOutput($domainKey = "")
{
}
protected function genFieldHTML($name, $type, $size, $options, $defaultval, $required)
{
}
public function getMissingRequiredFields()
{
}
public function isMissingRequiredFields()
{
}
public function getFieldValuesFromDatabase($domainID)
{
}
public function getAsNameValueArray()
{
}
public function saveToDatabase($domainID, $creating = true)
{
}
protected function processFieldOverrides(array &$fields, array $fieldMap, array $overrideData)
{
}
public function setDomainType($type = "register")
{
}
}
class Extension extends \WHMCS\Model\AbstractModel
{
protected $table = "tbldomainpricing";
protected $columnMap = array("supportsDnsManagement" => "dnsmanagement", "supportsEmailForwarding" => "emailforwarding", "supportsIdProtection" => "idprotection", "requiresEppCode" => "eppcode", "autoRegistrationRegistrar" => "autoreg", "gracePeriod" => "grace_period", "gracePeriodFee" => "grace_period_fee", "redemptionGracePeriod" => "redemption_grace_period", "redemptionGracePeriodFee" => "redemption_grace_period_fee", "topLevelId" => "top_level_id");
protected $appends = array("defaultGracePeriod", "defaultRedemptionGracePeriod", "pricing");
protected $casts = array("grace_period_fee" => "float", "gracePeriodFee" => "float", "redemption_grace_period_fee" => "float", "redemptionGracePeriodFee" => "float");
protected $fillable = array("extension");
public static function boot()
{
}
public function getDefaultGracePeriodAttribute()
{
}
public function getDefaultRedemptionGracePeriodAttribute()
{
}
public function getPricingAttribute()
{
}
public function getGracePeriodFeeAttribute()
{
}
public function setGracePeriodFeeAttribute($value)
{
}
public function getRedemptionGracePeriodFeeAttribute()
{
}
public function setRedemptionGracePeriodFeeAttribute($value)
{
}
public function price()
{
}
}
}
namespace WHMCS {
class Domains
{
public function splitAndCleanDomainInput($domain)
{
}
protected function stripOutSubdomains($domain)
{
}
public function clean($val)
{
}
public function checkDomainisValid($parts)
{
}
public function getDomainsDatabyID($domainid)
{
}
public function isActive()
{
}
public function isPending()
{
}
public function getData($var)
{
}
public function getModule()
{
}
public function hasFunction($function)
{
}
public function moduleCall($function, $additionalVars = array())
{
}
public function getModuleReturn($var = "")
{
}
public function getLastError()
{
}
public function getDefaultNameservers()
{
}
public function getSLD()
{
}
public function getTLD()
{
}
public function buildWHOISSaveArray($data)
{
}
public function getManagementOptions()
{
}
public static function getRenewableDomains($userID = 0, array $specificDomains = NULL)
{
}
public function obtainEmailReminders()
{
}
public function getDomainInformation()
{
}
public function saveContactDetails(\WHMCS\Client $client, array $contactdetails, array $wc, array $sel = NULL)
{
}
}
class Service
{
public function __construct($serviceId = NULL, $userId = NULL)
{
}
public function setServiceID($serviceid, $userid = "")
{
}
public function getServicesData()
{
}
public function isNotValid()
{
}
public function getData($var)
{
}
public function getID()
{
}
public function getServerInfo()
{
}
public function getSuspensionReason()
{
}
public function getBillingCycleDisplay()
{
}
public function getStatusDisplay()
{
}
public function getPaymentMethod()
{
}
public function getAllowProductUpgrades()
{
}
public function getAllowConfigOptionsUpgrade()
{
}
public function getAllowChangePassword()
{
}
public function getModule()
{
}
public function getPredefinedAddonsOnce()
{
}
public function getPredefinedAddons()
{
}
public function getPredefinedAddonName($addonid)
{
}
public function hasProductGotAddons()
{
}
public function getAddons()
{
}
public function getAssociatedDownloads()
{
}
public function getCustomFields()
{
}
public function getConfigurableOptions()
{
}
public function getAllowCancellation()
{
}
public function hasCancellationRequest()
{
}
public function getDiskUsageStats()
{
}
public function hasFunction($function)
{
}
public function moduleCall($function, $vars = array())
{
}
public function getModuleReturn($var = "")
{
}
public function getLastError()
{
}
}
}
namespace WHMCS\Input {
class Validation
{
public function escapeshellcmd($string)
{
}
public function mismatchedQuotePosition($string, $quoteCharacter = "\"")
{
}
}
class Sanitize
{
public static function makeSafeForOutput($val)
{
}
public static function convertToCompatHtml($val)
{
}
public static function encode($val)
{
}
public static function encodeToCompatHTML($val)
{
}
public static function decode($val)
{
}
protected function encodeArray($array)
{
}
protected function encodeArrayToCompatHTML($array)
{
}
protected function decodeArray($array)
{
}
protected function encodeString($val)
{
}
protected function encodeStringToCompatHTML($val)
{
}
public function getCompatBitmask()
{
}
protected function decodeString($val)
{
}
public static function maskEmailVerificationId($message)
{
}
public static function escapeSingleQuotedString($content)
{
}
public static function stripTags($val, $allowedTags = "")
{
}
protected function stripTagsFromString($val, $allowedTags)
{
}
protected function stripTagsFromArray(array $array, $allowedTags)
{
}
}
}
namespace WHMCS\Notification {
class Provider extends \WHMCS\Model\AbstractModel
{
protected $table = "tblnotificationproviders";
public $fillable = array("name");
protected $casts = array("settings" => "array", "active" => "boolean");
public function createTable($drop = false)
{
}
public function scopeActive($query)
{
}
public function initObject()
{
}
}
class Events
{
const TICKET = "Ticket";
const INVOICE = "Invoice";
const ORDER = "Order";
const SERVICE = "Service";
const DOMAIN = "Domain";
const API = "API";
const EventClasses = NULL;
public static function all()
{
}
public static function factory($name)
{
}
public static function defineHooks()
{
}
public static function trigger($eventType, $event, $hookParameters)
{
}
}
}
namespace WHMCS\Notification\Contracts {
interface NotificationInterface
{
public function getTitle();
public function setTitle($title);
public function getMessage();
public function setMessage($message);
public function getUrl();
public function setUrl($url);
public function getAttributes();
public function setAttributes($attributes);
public function addAttribute(\WHMCS\Notification\Contracts\NotificationAttributeInterface $attribute);
}
interface NotificationAttributeInterface
{
public function getLabel();
public function setLabel($label);
public function getValue();
public function setValue($value);
public function getUrl();
public function setUrl($url);
public function getStyle();
public function setStyle($style);
public function getIcon();
public function setIcon($icon);
}
}
namespace WHMCS\Notification {
class Rule extends \WHMCS\Model\AbstractModel
{
protected $table = "tblnotificationrules";
protected $casts = array("conditions" => "array", "provider_config" => "array", "active" => "boolean", "can_delete" => "boolean");
protected $commaSeparated = array("events");
public function createTable($drop = false)
{
}
public function triggerNotification(\WHMCS\Notification\Notification $notification)
{
}
public static function rebuildCache()
{
}
public static function getCache()
{
}
public function scopeActive(\Illuminate\Database\Eloquent\Builder $query)
{
}
}
class VersionFeatureHighlights
{
protected $version = NULL;
protected $incrementalVersion = NULL;
const FEATURE_HIGHLIGHT_VERSION = "7.10.0-alpha.1";
public function __construct($featureVersion = self::FEATURE_HIGHLIGHT_VERSION, \WHMCS\Updater\Version\IncrementalVersion $incrementalVersion = NULL)
{
}
public function getFeatureHighlights()
{
}
}
}
namespace WHMCS\Notification\Events {
class API
{
const DISPLAY_NAME = "API";
public function getEvents()
{
}
public function getConditions()
{
}
public function evaluateConditions($event, $conditions, $hookParameters)
{
}
public function buildNotification($event, $hookParameters)
{
}
}
class Invoice
{
const DISPLAY_NAME = "Invoice";
public function getEvents()
{
}
public function getConditions()
{
}
public function evaluateConditions($event, $conditions, $hookParameters)
{
}
public function buildNotification($event, $hookParameters)
{
}
}
class Domain
{
const DISPLAY_NAME = "Domain";
public function getEvents()
{
}
public function getConditions()
{
}
public function evaluateConditions($event, $conditions, $hookParameters)
{
}
public function buildNotification($event, $hookParameters)
{
}
}
class Ticket
{
const DISPLAY_NAME = "Ticket";
public function getEvents()
{
}
public function getConditions()
{
}
public function evaluateConditions($event, $conditions, $hookParameters)
{
}
public function buildNotification($event, $hookParameters)
{
}
}
class Order
{
const DISPLAY_NAME = "Order";
public function getEvents()
{
}
public function getConditions()
{
}
public function evaluateConditions($event, $conditions, $hookParameters)
{
}
public function buildNotification($event, $hookParameters)
{
}
}
class Service
{
const DISPLAY_NAME = "Service";
public function getEvents()
{
}
public function getConditions()
{
}
public function evaluateConditions($event, $conditions, $hookParameters)
{
}
public function buildNotification($event, $hookParameters)
{
}
}
}
namespace WHMCS\Notification {
class Notification implements \WHMCS\Notification\Contracts\NotificationInterface
{
protected $title = "";
protected $message = "";
protected $url = "";
protected $attributes = array();
public function getTitle()
{
}
public function getMessage()
{
}
public function getUrl()
{
}
public function getAttributes()
{
}
public function setAttributes($attributes)
{
}
public function setTitle($title)
{
}
public function setMessage($message)
{
}
public function setUrl($url)
{
}
public function addAttribute(\WHMCS\Notification\Contracts\NotificationAttributeInterface $attribute)
{
}
}
class NotificationAttribute implements \WHMCS\Notification\Contracts\NotificationAttributeInterface
{
protected $label = "";
protected $value = "";
protected $url = "";
protected $style = "";
protected $icon = "";
public function setLabel($label)
{
}
public function setValue($value)
{
}
public function setUrl($url)
{
}
public function setStyle($style)
{
}
public function setIcon($icon)
{
}
public function getLabel()
{
}
public function getValue()
{
}
public function getUrl()
{
}
public function getStyle()
{
}
public function getIcon()
{
}
}
}
namespace WHMCS\Notification\Exception {
class AbortNotification extends \WHMCS\Exception
{
}
}
namespace WHMCS\Notification {
class FeatureHighlight
{
protected $title = NULL;
protected $subtitle = NULL;
protected $headlineImage = NULL;
protected $iconImage = NULL;
protected $description = NULL;
protected $btn1Link = NULL;
protected $btn1Label = NULL;
protected $btn2Link = NULL;
protected $btn2Label = NULL;
protected $assetHelper = NULL;
public function __construct($title = NULL, $subtitle = NULL, $headlineImage = NULL, $iconImage = NULL, $description = NULL, $btn1Link = NULL, $btn1Label = NULL, $btn2Link = NULL, $btn2Label = NULL)
{
}
public function getTitle()
{
}
public function getSubtitle()
{
}
public function getImage($imageName = NULL)
{
}
public function getIcon()
{
}
public function getHeadlineImage()
{
}
public function hasHeadlineImage()
{
}
public function getDescription()
{
}
public function hasBtn1Link()
{
}
public function getBtn1Link()
{
}
public function getBtn1Label()
{
}
public function hasBtn2Link()
{
}
public function getBtn2Link()
{
}
public function getBtn2Label()
{
}
}
}
namespace WHMCS {
class Orders extends \WHMCS\TableModel
{
public function _execute($criteria = NULL)
{
}
public function getOrders($criteria = array())
{
}
public function getPendingCount()
{
}
public function getStatuses()
{
}
public function formatStatus($status)
{
}
public function setID($orderid)
{
}
public function loadData()
{
}
public function getData($var = "")
{
}
public function getFraudResults()
{
}
public function delete($orderid = 0)
{
}
public function setCancelled($orderid = 0)
{
}
public function setFraud($orderid = 0)
{
}
public function setPending($orderid = 0)
{
}
public function getItems()
{
}
}
}
namespace WHMCS\Utility {
class Binary
{
public static function strlen($binary_string)
{
}
public static function substr($binary_string, $start, $length)
{
}
}
class Captcha
{
public static $defaultFormSettings = NULL;
public $recaptcha = NULL;
const SETTING_CAPTCHA_FORMS = "CaptchaForms";
const FORM_CHECKOUT_COMPLETION = "checkoutCompletion";
const FORM_DOMAIN_CHECKER = "domainChecker";
const FORM_REGISTRATION = "registration";
const FORM_CONTACT_US = "contactUs";
const FORM_SUBMIT_TICKET = "submitTicket";
const FORM_LOGIN = "login";
public function __construct()
{
}
public function isSystemEnabledRuntime()
{
}
public static function getDefaultFormSettings()
{
}
public function validateAppropriateCaptcha($form, \WHMCS\Validate $validate)
{
}
public function getForms()
{
}
public function setForms($forms)
{
}
public function isEnabledForForm($formName)
{
}
public function getStoredFormSettings()
{
}
public function setStoredFormSettings(array $data = array())
{
}
public function isEnabled()
{
}
public function setEnabled($enabled)
{
}
public function __toString()
{
}
public function getCaptchaType()
{
}
public function getButtonClass($formName)
{
}
}
class CurrencyExchange extends \WHMCS\Config\AbstractConfig
{
const EXCHANGE_RATE_FEED_URL = "https://www.ecb.europa.eu/stats/eurofxref/eurofxref-daily.xml";
public static function fetchCurrentRates()
{
}
public static function factoryFromStoredRates()
{
}
public function hasCurrencyCode($code)
{
}
public function getUsdExchangeRate($code)
{
}
}
}
namespace WHMCS\Utility\Environment {
class WebHelper
{
public static function getBaseUrl($root = ROOTDIR, $scriptName = NULL)
{
}
public static function getAdminBaseUrl($root = ROOTDIR, $scriptName = NULL)
{
}
}
class CurrentUser
{
public static function getIP()
{
}
public static function getForwardedIpWithoutTrust()
{
}
public static function getIPHost()
{
}
public static function isIpv4AndPublic($ip)
{
}
}
}
namespace WHMCS\Utility\Error {
class Run implements \Whoops\RunInterface
{
public function __construct(\Whoops\Util\SystemFacade $system = NULL)
{
}
public function pushHandler($handler)
{
}
public function popHandler()
{
}
public function getHandlers()
{
}
public function clearHandlers()
{
}
public function register()
{
}
public function unregister()
{
}
public function allowQuit($exit = NULL)
{
}
public function silenceErrorsInPaths($patterns, $levels = 10240)
{
}
public function getSilenceErrorsInPaths()
{
}
public function sendHttpCode($code = NULL)
{
}
public function writeToOutput($send = NULL)
{
}
public function handleException($exception)
{
}
public function handleError($level, $message, $file = NULL, $line = NULL)
{
}
public function handleShutdown()
{
}
}
}
namespace WHMCS\Utility {
class GeoIp
{
public static function getLookupUrl($ip)
{
}
public static function getLookupHtmlAnchor($ip, $classes = NULL, $text = NULL)
{
}
}
final class SafeInclude
{
public static function file($filename, callable $failureCallback = NULL)
{
}
public static function criticalFile($filename, callable $failureCallback = NULL)
{
}
}
}
namespace WHMCS\Utility\Bootstrap {
abstract class AbstractBootstrap
{
protected static function checkBareMinimumRequirements()
{
}
public static function boot()
{
}
protected static function facadeDiContainer(\WHMCS\Container $container)
{
}
protected static function factoryContainer()
{
}
public static function registerServices(\WHMCS\Container $container, array $servicesToRegister)
{
}
protected static function bindSingletons(\WHMCS\Container $container, array $singletonsToBind)
{
}
protected static function bindInstances(\WHMCS\Container $container, array $instancesToBind)
{
}
protected static function defineClassAliases(array $classAliases)
{
}
public static function getSingletons()
{
}
public static function getServices()
{
}
public static function getAliases()
{
}
}
class Installer extends \WHMCS\Utility\Bootstrap\AbstractBootstrap
{
protected static function checkBareMinimumRequirements()
{
}
public static function boot(\WHMCS\Config\RuntimeStorage $preBootInstances = NULL)
{
}
public static function getAliases()
{
}
public static function getInstances()
{
}
public static function getSingletons()
{
}
public static function getServices()
{
}
}
class Application extends \WHMCS\Utility\Bootstrap\AbstractBootstrap
{
public static function boot(\WHMCS\Config\RuntimeStorage $preBootInstances = NULL)
{
}
public static function verifyInstallerIsAbsent()
{
}
public static function persistSession()
{
}
public static function getAliases()
{
}
public static function getInstances()
{
}
public static function getSingletons()
{
}
public static function getServices()
{
}
}
class OauthServer extends \WHMCS\Utility\Bootstrap\Application
{
public static function boot(\WHMCS\Config\RuntimeStorage $preBootInstances = NULL)
{
}
}
}
namespace WHMCS\Utility {
class Random
{
public function string($lowercase, $uppercase, $numbers, $symbols)
{
}
public function number($length)
{
}
public function setSymbols($symbols)
{
}
}
class Eula
{
protected $eulaText = "";
protected $effectiveDate = false;
const SETTING_EULA_ACCEPTED = "EulaAgreementAccepted";
public function isEulaAccepted()
{
}
public function markAsAccepted(\WHMCS\User\UserInterface $admin)
{
}
public function markAsNotAccepted()
{
}
protected function loadData()
{
}
public function getEulaText()
{
}
public function setEulaText($eulaText)
{
}
public function getEffectiveDate()
{
}
public function setEffectiveDate($effectiveDate)
{
}
}
class Country
{
protected $countries = array();
protected $countriesPath = NULL;
public function __construct($countriesPath = "")
{
}
protected function load()
{
}
protected function loadFile($path)
{
}
public function getCountries()
{
}
public function getCountryNameArray()
{
}
public function getCountryNamesOnly()
{
}
public function getCallingCode($countryCode)
{
}
public function getStates($countryCode)
{
}
public function getStateCodeMapping($countryCode)
{
}
public function getStateNameFromCode($countryCode, $stateCode)
{
}
public function getName($countryCode)
{
}
public function isValidCountryCode($countryCode)
{
}
public function isValidCountryName($countryName)
{
}
}
class Image
{
const IMAGE_EMAIL = "em";
const IMAGE_KNOWLEDGEBASE = "kb";
public function displayKbImage($id)
{
}
public function displayEMailImage($id)
{
}
protected function displayImage($id, $type = self::IMAGE_KNOWLEDGEBASE)
{
}
protected function displayDefaultImageUnavailable()
{
}
}
class File
{
public static function recursiveCopy($sourcePath, $destinationPath, array $excludeFromCopy = array(), $preservePermissions = true, $preserveTimes = true)
{
}
public static function recursiveDelete($path, array $excludeFiles = array(), $removeRootDirectory = false)
{
}
public static function recursiveMkDir($location, $dirPath)
{
}
}
class Status
{
const PENDING = "Pending";
const PENDING_REGISTRATION = "Pending Registration";
const PENDING_TRANSFER = "Pending Transfer";
const ACTIVE = "Active";
const INACTIVE = "Inactive";
const CLOSED = "Closed";
const COMPLETED = "Completed";
const SUSPENDED = "Suspended";
const TERMINATED = "Terminated";
const GRACE = "Grace";
const REDEMPTION = "Redemption";
const EXPIRED = "Expired";
const CANCELLED = "Cancelled";
const FRAUD = "Fraud";
const TRANSFERRED_AWAY = "Transferred Away";
const CLIENT_STATUSES = NULL;
const SERVICE_STATUSES = NULL;
const DOMAIN_STATUSES = NULL;
}
class ErrorManagement
{
protected $runner = NULL;
protected $deferredHandlers = array();
const ERROR_LEVEL_DEBUG_VALUE = NULL;
const ERROR_LEVEL_DEBUG_KEY = "debug";
const ERROR_LEVEL_WARNINGS_VALUE = NULL;
const ERROR_LEVEL_WARNINGS_KEY = "warnings";
const ERROR_LEVEL_ERRORS_VALUE = NULL;
const ERROR_LEVEL_ERRORS_KEY = "errors";
const ERROR_LEVEL_NONE_VALUE = 0;
const ERROR_LEVEL_NONE_KEY = "none";
const ERROR_LEVEL_INHERIT_VALUE = -1;
const ERROR_LEVEL_INHERIT_KEY = "inherit";
public function __construct(\Whoops\RunInterface $runner = NULL)
{
}
public static function performErrorReportingSanityCheck()
{
}
public function getRunner()
{
}
public static function factoryRunner()
{
}
public static function boot(\Whoops\RunInterface $runner = NULL)
{
}
public function loadApplicationHandlers()
{
}
public static function disableIniDisplayErrors()
{
}
public static function enableIniDisplayErrors($setting = true)
{
}
public static function isDisplayErrorCurrentlyVisible()
{
}
public static function setErrorReportingLevel($errorLevel = self::ERROR_LEVEL_NONE_VALUE)
{
}
public static function supportedErrorLevels()
{
}
public function setErrorLogging($state = false)
{
}
public function isReportingLevelSupported($level)
{
}
public static function isAllowedToLogErrors()
{
}
public static function isAllowedToLogSqlErrors()
{
}
public function addDeferredHandler(\Whoops\Handler\Handler $handler)
{
}
public function loadDeferredHandlers()
{
}
public static function distillErrorReportingLevelFromDisplayErrorSetting($setting = NULL)
{
}
public function applyConfigurationSettings(\WHMCS\Config\AbstractConfig $config)
{
}
}
class Recaptcha
{
const CAPTCHA_INVISIBLE = "invisible";
const CAPTCHA_RECAPTCHA = "recaptcha";
public function __construct(\WHMCS\Utility\Captcha $captcha)
{
}
public function validate($recaptchaToken = "")
{
}
protected function verify($recaptchaToken)
{
}
public function isEnabled()
{
}
public function setEnabled($enabled)
{
}
public function getSiteKey()
{
}
public function setSiteKey($siteKey)
{
}
public function getSecret()
{
}
public function setSecret($secret)
{
}
public function isInvisible()
{
}
public function setIsInvisible($isInvisible)
{
}
}
}
namespace WHMCS\Route\Contracts\Middleware {
interface ProxyInterface extends \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
public function factoryProxyDriver($handle, \WHMCS\Http\Message\ServerRequest $request);
}
}
namespace WHMCS\Route\Middleware {
abstract class AbstractProxyMiddleware implements \WHMCS\Route\Contracts\Middleware\ProxyInterface, \WHMCS\Route\Contracts\MapInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
use \WHMCS\Route\HandleMapTrait;
public abstract function factoryProxyDriver($handle, \WHMCS\Http\Message\ServerRequest $request);
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
class AuthorizationProxy extends \WHMCS\Route\Middleware\AbstractProxyMiddleware
{
public function getMappedAttributeName()
{
}
public function factoryProxyDriver($handle, \WHMCS\Http\Message\ServerRequest $request = NULL)
{
}
}
class AuthenticationProxy extends \WHMCS\Route\Middleware\AbstractProxyMiddleware
{
public function getMappedAttributeName()
{
}
public function factoryProxyDriver($handle, \WHMCS\Http\Message\ServerRequest $request = NULL)
{
}
}
class BackendDispatch implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function getDispatch(\WHMCS\Http\Message\ServerRequest $request)
{
}
}
class RoutePathMatch implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
class WhitelistFilter implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\DelegatingMiddlewareTrait;
protected $filterList = NULL;
protected $strictFilter = true;
public function __construct($strictFilter = true, array $filterList = array())
{
}
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
protected function isAllowed(\Psr\Http\Message\ServerRequestInterface $request)
{
}
protected function getFilterList()
{
}
protected function setFilterList(array $filterList)
{
}
protected function isStrictFilter()
{
}
protected function setStrictFilter($strictFilter)
{
}
protected function whitelistRequest(\Psr\Http\Message\ServerRequestInterface $request)
{
}
protected function blacklistRequest(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
}
namespace WHMCS\Route\Middleware\Strategy {
abstract class SharingMiddlewareTrait
{
public abstract function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate);
public abstract function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate);
}
}
namespace WHMCS\Route\Middleware {
class BackendPsr7Response implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\SharingMiddlewareTrait;
public function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
class HandleProcessor implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
class RoutableRequestQueryUri implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
protected function updateUriFromRequestQuery(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
class RoutableClientModuleRequest implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
class RoutableRequestUri implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function updateUriFromServerScriptName(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
class RoutableApiRequestUri extends \WHMCS\Route\Middleware\WhitelistFilter
{
const ATTRIBUTE_API_REQUEST = "isApiRouteRequest";
public function __construct($strictFilter = true, array $filterList = array())
{
}
protected function whitelistRequest(\Psr\Http\Message\ServerRequestInterface $request)
{
}
protected function blacklistRequest(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
class RoutableAdminRequestUri implements \WHMCS\Route\Contracts\Middleware\StrategyInterface
{
use \WHMCS\Route\Middleware\Strategy\AssumingMiddlewareTrait;
const ATTRIBUTE_ADMIN_REQUEST = "isAdminRouteRequest";
public function _process(\WHMCS\Http\Message\ServerRequest $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
public function isAdminLegacyEndpoint($path)
{
}
public function isAdminRoutePath($path)
{
}
}
}
namespace WHMCS\Route {
class UriPath implements \WHMCS\Route\Contracts\MapInterface
{
use \WHMCS\Route\HandleMapTrait;
protected $deferredRoutes = array();
const MODE_REWRITE = "rewrite";
const MODE_ACCEPTPATHINFO = "acceptpathinfo";
const MODE_BASIC = "basic";
const MODE_UNKNOWN = "unknown";
const SETTING_MODE = "RouteUriPathMode";
public function __construct($baseUri = "")
{
}
public function mapRoute($route)
{
}
public function getMappedAttributeName()
{
}
public function getSafeNonRoutablePath()
{
}
public function getRawPath($routeName, $routeVars)
{
}
public function getPath($routeName, ...$routeVars)
{
}
public function getRouteCollector()
{
}
protected function getDeferredRoutePath($routeName)
{
}
protected function buildRoutePath($routeName, $routeVars)
{
}
public static function getAllKnownModes()
{
}
public function setMode($mode)
{
}
public function getMode()
{
}
protected function getModRewriteFriendlyString($string)
{
}
}
class RouteServiceProvider extends \WHMCS\Application\Support\ServiceProvider\AbstractServiceProvider
{
use \WHMCS\Route\ProviderTrait;
public function register()
{
}
protected function standardRoutes()
{
}
}
}
namespace WHMCS\Route\Dispatcher {
class DeferrableGroup extends \FastRoute\Dispatcher\GroupCountBased
{
protected $collector = NULL;
protected $loadedDeferredGroup = array();
public function __construct(\FastRoute\RouteCollector $data)
{
}
public function dispatch($httpMethod, $uri)
{
}
public function deferredDispatch($httpMethod, $uri)
{
}
}
}
namespace WHMCS\Route\Rewrite {
class RuleSet
{
public function reduce(array $ruleSet)
{
}
public function getLegacyRules()
{
}
public function generateRuleSet()
{
}
}
class File extends \SplFileObject
{
protected $beforeRuleSet = array();
protected $ourRuleSet = array();
protected $afterRuleSet = array();
protected $ruleGenerator = NULL;
protected $exclusivelyWhmcs = false;
const FILE_DEFAULT = ".htaccess";
const MARKER_BEGIN = "### BEGIN - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###";
const MARKER_END = "### END - WHMCS managed rules - DO NOT EDIT BETWEEN WHMCS MARKERS ###";
public static function factory($filename, \WHMCS\Route\Rewrite\RuleSet $ruleGenerator = NULL)
{
}
public function parse()
{
}
public function isEmpty()
{
}
public function inspectForExclusiveWhmcsRules()
{
}
public function isInSync()
{
}
public function updateWhmcsRuleSet()
{
}
public function backupCurrentRules()
{
}
public function isExclusivelyWhmcs()
{
}
public function setExclusivelyWhmcs($exclusivelyWhmcs)
{
}
public function getRuleGenerator()
{
}
public function setRuleGenerator($ruleGenerator)
{
}
public function getBeforeRuleSet()
{
}
public function setBeforeRuleSet($beforeRuleSet)
{
}
public function getOurRuleSet()
{
}
public function setOurRuleSet($ourRuleSet)
{
}
public function getAfterRuleSet()
{
}
public function setAfterRuleSet($afterRuleSet)
{
}
}
}
namespace WHMCS {
class Addon
{
public function __construct($addonId = NULL, $userId = NULL)
{
}
public function setAddonId($addonId, $userId = 0)
{
}
public function getAddonData()
{
}
public function getData($key1, $key2 = "")
{
}
public function getModule()
{
}
public function getId()
{
}
public function hasFunction($function)
{
}
public function moduleCall($function, $vars = array())
{
}
public function getModuleReturn($var = "")
{
}
public function getLastError()
{
}
}
}
namespace {
/**
* @class Datamatrix
* Class to create DataMatrix ECC 200 barcode arrays for TCPDF class.
* DataMatrix (ISO/IEC 16022:2006) is a 2-dimensional bar code.
*
* @package com.tecnick.tcpdf
* @author Nicola Asuni
* @version 1.0.004
*/
class Datamatrix
{
/**
* Barcode array to be returned which is readable by TCPDF.
* @protected
*/
protected $barcode_array = array();
/**
* Store last used encoding for data codewords.
* @protected
*/
protected $last_enc = \ENC_ASCII;
/**
* Table of Data Matrix ECC 200 Symbol Attributes:<ul>
* <li>total matrix rows (including finder pattern)</li>
* <li>total matrix cols (including finder pattern)</li>
* <li>total matrix rows (without finder pattern)</li>
* <li>total matrix cols (without finder pattern)</li>
* <li>region data rows (with finder pattern)</li>
* <li>region data col (with finder pattern)</li>
* <li>region data rows (without finder pattern)</li>
* <li>region data col (without finder pattern)</li>
* <li>horizontal regions</li>
* <li>vertical regions</li>
* <li>regions</li>
* <li>data codewords</li>
* <li>error codewords</li>
* <li>blocks</li>
* <li>data codewords per block</li>
* <li>error codewords per block</li>
* </ul>
* @protected
*/
protected $symbattr = array(
// square form ---------------------------------------------------------------------------------------
array(0xa, 0xa, 0x8, 0x8, 0xa, 0xa, 0x8, 0x8, 0x1, 0x1, 0x1, 0x3, 0x5, 0x1, 0x3, 0x5),
// 10x10
array(0xc, 0xc, 0xa, 0xa, 0xc, 0xc, 0xa, 0xa, 0x1, 0x1, 0x1, 0x5, 0x7, 0x1, 0x5, 0x7),
// 12x12
array(0xe, 0xe, 0xc, 0xc, 0xe, 0xe, 0xc, 0xc, 0x1, 0x1, 0x1, 0x8, 0xa, 0x1, 0x8, 0xa),
// 14x14
array(0x10, 0x10, 0xe, 0xe, 0x10, 0x10, 0xe, 0xe, 0x1, 0x1, 0x1, 0xc, 0xc, 0x1, 0xc, 0xc),
// 16x16
array(0x12, 0x12, 0x10, 0x10, 0x12, 0x12, 0x10, 0x10, 0x1, 0x1, 0x1, 0x12, 0xe, 0x1, 0x12, 0xe),
// 18x18
array(0x14, 0x14, 0x12, 0x12, 0x14, 0x14, 0x12, 0x12, 0x1, 0x1, 0x1, 0x16, 0x12, 0x1, 0x16, 0x12),
// 20x20
array(0x16, 0x16, 0x14, 0x14, 0x16, 0x16, 0x14, 0x14, 0x1, 0x1, 0x1, 0x1e, 0x14, 0x1, 0x1e, 0x14),
// 22x22
array(0x18, 0x18, 0x16, 0x16, 0x18, 0x18, 0x16, 0x16, 0x1, 0x1, 0x1, 0x24, 0x18, 0x1, 0x24, 0x18),
// 24x24
array(0x1a, 0x1a, 0x18, 0x18, 0x1a, 0x1a, 0x18, 0x18, 0x1, 0x1, 0x1, 0x2c, 0x1c, 0x1, 0x2c, 0x1c),
// 26x26
array(0x20, 0x20, 0x1c, 0x1c, 0x10, 0x10, 0xe, 0xe, 0x2, 0x2, 0x4, 0x3e, 0x24, 0x1, 0x3e, 0x24),
// 32x32
array(0x24, 0x24, 0x20, 0x20, 0x12, 0x12, 0x10, 0x10, 0x2, 0x2, 0x4, 0x56, 0x2a, 0x1, 0x56, 0x2a),
// 36x36
array(0x28, 0x28, 0x24, 0x24, 0x14, 0x14, 0x12, 0x12, 0x2, 0x2, 0x4, 0x72, 0x30, 0x1, 0x72, 0x30),
// 40x40
array(0x2c, 0x2c, 0x28, 0x28, 0x16, 0x16, 0x14, 0x14, 0x2, 0x2, 0x4, 0x90, 0x38, 0x1, 0x90, 0x38),
// 44x44
array(0x30, 0x30, 0x2c, 0x2c, 0x18, 0x18, 0x16, 0x16, 0x2, 0x2, 0x4, 0xae, 0x44, 0x1, 0xae, 0x44),
// 48x48
array(0x34, 0x34, 0x30, 0x30, 0x1a, 0x1a, 0x18, 0x18, 0x2, 0x2, 0x4, 0xcc, 0x54, 0x2, 0x66, 0x2a),
// 52x52
array(0x40, 0x40, 0x38, 0x38, 0x10, 0x10, 0xe, 0xe, 0x4, 0x4, 0x10, 0x118, 0x70, 0x2, 0x8c, 0x38),
// 64x64
array(0x48, 0x48, 0x40, 0x40, 0x12, 0x12, 0x10, 0x10, 0x4, 0x4, 0x10, 0x170, 0x90, 0x4, 0x5c, 0x24),
// 72x72
array(0x50, 0x50, 0x48, 0x48, 0x14, 0x14, 0x12, 0x12, 0x4, 0x4, 0x10, 0x1c8, 0xc0, 0x4, 0x72, 0x30),
// 80x80
array(0x58, 0x58, 0x50, 0x50, 0x16, 0x16, 0x14, 0x14, 0x4, 0x4, 0x10, 0x240, 0xe0, 0x4, 0x90, 0x38),
// 88x88
array(0x60, 0x60, 0x58, 0x58, 0x18, 0x18, 0x16, 0x16, 0x4, 0x4, 0x10, 0x2b8, 0x110, 0x4, 0xae, 0x44),
// 96x96
array(0x68, 0x68, 0x60, 0x60, 0x1a, 0x1a, 0x18, 0x18, 0x4, 0x4, 0x10, 0x330, 0x150, 0x6, 0x88, 0x38),
// 104x104
array(0x78, 0x78, 0x6c, 0x6c, 0x14, 0x14, 0x12, 0x12, 0x6, 0x6, 0x24, 0x41a, 0x198, 0x6, 0xaf, 0x44),
// 120x120
array(0x84, 0x84, 0x78, 0x78, 0x16, 0x16, 0x14, 0x14, 0x6, 0x6, 0x24, 0x518, 0x1f0, 0x8, 0xa3, 0x3e),
// 132x132
array(0x90, 0x90, 0x84, 0x84, 0x18, 0x18, 0x16, 0x16, 0x6, 0x6, 0x24, 0x616, 0x26c, 0xa, 0x9c, 0x3e),
// 144x144
// rectangular form (currently unused) ---------------------------------------------------------------------------
array(0x8, 0x12, 0x6, 0x10, 0x8, 0x12, 0x6, 0x10, 0x1, 0x1, 0x1, 0x5, 0x7, 0x1, 0x5, 0x7),
// 8x18
array(0x8, 0x20, 0x6, 0x1c, 0x8, 0x10, 0x6, 0xe, 0x1, 0x2, 0x2, 0xa, 0xb, 0x1, 0xa, 0xb),
// 8x32
array(0xc, 0x1a, 0xa, 0x18, 0xc, 0x1a, 0xa, 0x18, 0x1, 0x1, 0x1, 0x10, 0xe, 0x1, 0x10, 0xe),
// 12x26
array(0xc, 0x24, 0xa, 0x20, 0xc, 0x12, 0xa, 0x10, 0x1, 0x2, 0x2, 0xc, 0x12, 0x1, 0xc, 0x12),
// 12x36
array(0x10, 0x24, 0xe, 0x20, 0x10, 0x12, 0xe, 0x10, 0x1, 0x2, 0x2, 0x20, 0x18, 0x1, 0x20, 0x18),
// 16x36
array(0x10, 0x30, 0xe, 0x2c, 0x10, 0x18, 0xe, 0x16, 0x1, 0x2, 0x2, 0x31, 0x1c, 0x1, 0x31, 0x1c),
);
/**
* Map encodation modes whit character sets.
* @protected
*/
protected $chset_id = array(\ENC_C40 => 'C40', \ENC_TXT => 'TXT', \ENC_X12 => 'X12');
/**
* Basic set of characters for each encodation mode.
* @protected
*/
protected $chset = array(
'C40' => array(
// Basic set for C40 ----------------------------------------------------------------------------
'S1' => 0x0,
'S2' => 0x1,
'S3' => 0x2,
0x20 => 0x3,
0x30 => 0x4,
0x31 => 0x5,
0x32 => 0x6,
0x33 => 0x7,
0x34 => 0x8,
0x35 => 0x9,
//
0x36 => 0xa,
0x37 => 0xb,
0x38 => 0xc,
0x39 => 0xd,
0x41 => 0xe,
0x42 => 0xf,
0x43 => 0x10,
0x44 => 0x11,
0x45 => 0x12,
0x46 => 0x13,
//
0x47 => 0x14,
0x48 => 0x15,
0x49 => 0x16,
0x4a => 0x17,
0x4b => 0x18,
0x4c => 0x19,
0x4d => 0x1a,
0x4e => 0x1b,
0x4f => 0x1c,
0x50 => 0x1d,
//
0x51 => 0x1e,
0x52 => 0x1f,
0x53 => 0x20,
0x54 => 0x21,
0x55 => 0x22,
0x56 => 0x23,
0x57 => 0x24,
0x58 => 0x25,
0x59 => 0x26,
0x5a => 0x27,
),
//
'TXT' => array(
// Basic set for TEXT ---------------------------------------------------------------------------
'S1' => 0x0,
'S2' => 0x1,
'S3' => 0x2,
0x20 => 0x3,
0x30 => 0x4,
0x31 => 0x5,
0x32 => 0x6,
0x33 => 0x7,
0x34 => 0x8,
0x35 => 0x9,
//
0x36 => 0xa,
0x37 => 0xb,
0x38 => 0xc,
0x39 => 0xd,
0x61 => 0xe,
0x62 => 0xf,
0x63 => 0x10,
0x64 => 0x11,
0x65 => 0x12,
0x66 => 0x13,
//
0x67 => 0x14,
0x68 => 0x15,
0x69 => 0x16,
0x6a => 0x17,
0x6b => 0x18,
0x6c => 0x19,
0x6d => 0x1a,
0x6e => 0x1b,
0x6f => 0x1c,
0x70 => 0x1d,
//
0x71 => 0x1e,
0x72 => 0x1f,
0x73 => 0x20,
0x74 => 0x21,
0x75 => 0x22,
0x76 => 0x23,
0x77 => 0x24,
0x78 => 0x25,
0x79 => 0x26,
0x7a => 0x27,
),
//
'SH1' => array(
// Shift 1 set ----------------------------------------------------------------------------------
0x0 => 0x0,
0x1 => 0x1,
0x2 => 0x2,
0x3 => 0x3,
0x4 => 0x4,
0x5 => 0x5,
0x6 => 0x6,
0x7 => 0x7,
0x8 => 0x8,
0x9 => 0x9,
//
0xa => 0xa,
0xb => 0xb,
0xc => 0xc,
0xd => 0xd,
0xe => 0xe,
0xf => 0xf,
0x10 => 0x10,
0x11 => 0x11,
0x12 => 0x12,
0x13 => 0x13,
//
0x14 => 0x14,
0x15 => 0x15,
0x16 => 0x16,
0x17 => 0x17,
0x18 => 0x18,
0x19 => 0x19,
0x1a => 0x1a,
0x1b => 0x1b,
0x1c => 0x1c,
0x1d => 0x1d,
//
0x1e => 0x1e,
0x1f => 0x1f,
),
//
'SH2' => array(
// Shift 2 set ----------------------------------------------------------------------------------
0x21 => 0x0,
0x22 => 0x1,
0x23 => 0x2,
0x24 => 0x3,
0x25 => 0x4,
0x26 => 0x5,
0x27 => 0x6,
0x28 => 0x7,
0x29 => 0x8,
0x2a => 0x9,
//
0x2b => 0xa,
0x2c => 0xb,
0x2d => 0xc,
0x2e => 0xd,
0x2f => 0xe,
0x3a => 0xf,
0x3b => 0x10,
0x3c => 0x11,
0x3d => 0x12,
0x3e => 0x13,
//
0x3f => 0x14,
0x40 => 0x15,
0x5b => 0x16,
0x5c => 0x17,
0x5d => 0x18,
0x5e => 0x19,
0x5f => 0x1a,
'F1' => 0x1b,
'US' => 0x1e,
),
//
'S3C' => array(
// Shift 3 set for C40 --------------------------------------------------------------------------
0x60 => 0x0,
0x61 => 0x1,
0x62 => 0x2,
0x63 => 0x3,
0x64 => 0x4,
0x65 => 0x5,
0x66 => 0x6,
0x67 => 0x7,
0x68 => 0x8,
0x69 => 0x9,
//
0x6a => 0xa,
0x6b => 0xb,
0x6c => 0xc,
0x6d => 0xd,
0x6e => 0xe,
0x6f => 0xf,
0x70 => 0x10,
0x71 => 0x11,
0x72 => 0x12,
0x73 => 0x13,
//
0x74 => 0x14,
0x75 => 0x15,
0x76 => 0x16,
0x77 => 0x17,
0x78 => 0x18,
0x79 => 0x19,
0x7a => 0x1a,
0x7b => 0x1b,
0x7c => 0x1c,
0x7d => 0x1d,
//
0x7e => 0x1e,
0x7f => 0x1f,
),
'S3T' => array(
// Shift 3 set for TEXT -------------------------------------------------------------------------
0x60 => 0x0,
0x41 => 0x1,
0x42 => 0x2,
0x43 => 0x3,
0x44 => 0x4,
0x45 => 0x5,
0x46 => 0x6,
0x47 => 0x7,
0x48 => 0x8,
0x49 => 0x9,
//
0x4a => 0xa,
0x4b => 0xb,
0x4c => 0xc,
0x4d => 0xd,
0x4e => 0xe,
0x4f => 0xf,
0x50 => 0x10,
0x51 => 0x11,
0x52 => 0x12,
0x53 => 0x13,
//
0x54 => 0x14,
0x55 => 0x15,
0x56 => 0x16,
0x57 => 0x17,
0x58 => 0x18,
0x59 => 0x19,
0x5a => 0x1a,
0x7b => 0x1b,
0x7c => 0x1c,
0x7d => 0x1d,
//
0x7e => 0x1e,
0x7f => 0x1f,
),
//
'X12' => array(
// Set for X12 ----------------------------------------------------------------------------------
0xd => 0x0,
0x2a => 0x1,
0x3e => 0x2,
0x20 => 0x3,
0x30 => 0x4,
0x31 => 0x5,
0x32 => 0x6,
0x33 => 0x7,
0x34 => 0x8,
0x35 => 0x9,
//
0x36 => 0xa,
0x37 => 0xb,
0x38 => 0xc,
0x39 => 0xd,
0x41 => 0xe,
0x42 => 0xf,
0x43 => 0x10,
0x44 => 0x11,
0x45 => 0x12,
0x46 => 0x13,
//
0x47 => 0x14,
0x48 => 0x15,
0x49 => 0x16,
0x4a => 0x17,
0x4b => 0x18,
0x4c => 0x19,
0x4d => 0x1a,
0x4e => 0x1b,
0x4f => 0x1c,
0x50 => 0x1d,
//
0x51 => 0x1e,
0x52 => 0x1f,
0x53 => 0x20,
0x54 => 0x21,
0x55 => 0x22,
0x56 => 0x23,
0x57 => 0x24,
0x58 => 0x25,
0x59 => 0x26,
0x5a => 0x27,
),
);
// -----------------------------------------------------------------------------
/**
* This is the class constructor.
* Creates a datamatrix object
* @param $code (string) Code to represent using Datamatrix.
* @public
*/
public function __construct($code)
{
}
/**
* Returns a barcode array which is readable by TCPDF
* @return array barcode array readable by TCPDF;
* @public
*/
public function getBarcodeArray()
{
}
/**
* Product of two numbers in a Power-of-Two Galois Field
* @param $a (int) first number to multiply.
* @param $b (int) second number to multiply.
* @param $log (array) Log table.
* @param $alog (array) Anti-Log table.
* @param $gf (array) Number of Factors of the Reed-Solomon polynomial.
* @return int product
* @protected
*/
protected function getGFProduct($a, $b, $log, $alog, $gf)
{
}
/**
* Add error correction codewords to data codewords array (ANNEX E).
* @param $wd (array) Array of datacodewords.
* @param $nb (int) Number of blocks.
* @param $nd (int) Number of data codewords per block.
* @param $nc (int) Number of correction codewords per block.
* @param $gf (int) numner of fields on log/antilog table (power of 2).
* @param $pp (int) The value of its prime modulus polynomial (301 for ECC200).
* @return array data codewords + error codewords
* @protected
*/
protected function getErrorCorrection($wd, $nb, $nd, $nc, $gf = 256, $pp = 301)
{
}
/**
* Return the 253-state codeword
* @param $cwpad (int) Pad codeword.
* @param $cwpos (int) Number of data codewords from the beginning of encoded data.
* @return pad codeword
* @protected
*/
protected function get253StateCodeword($cwpad, $cwpos)
{
}
/**
* Return the 255-state codeword
* @param $cwpad (int) Pad codeword.
* @param $cwpos (int) Number of data codewords from the beginning of encoded data.
* @return pad codeword
* @protected
*/
protected function get255StateCodeword($cwpad, $cwpos)
{
}
/**
* Returns true if the char belongs to the selected mode
* @param $chr (int) Character (byte) to check.
* @param $mode (int) Current encoding mode.
* @return boolean true if the char is of the selected mode.
* @protected
*/
protected function isCharMode($chr, $mode)
{
}
/**
* The look-ahead test scans the data to be encoded to find the best mode (Annex P - steps from J to S).
* @param $data (string) data to encode
* @param $pos (int) current position
* @param $mode (int) current encoding mode
* @return int encoding mode
* @protected
*/
protected function lookAheadTest($data, $pos, $mode)
{
}
/**
* Get the switching codeword to a new encoding mode (latch codeword)
* @param $mode (int) New encoding mode.
* @return (int) Switch codeword.
* @protected
*/
protected function getSwitchEncodingCodeword($mode)
{
}
/**
* Choose the minimum matrix size and return the max number of data codewords.
* @param $numcw (int) Number of current codewords.
* @return number of data codewords in matrix
* @protected
*/
protected function getMaxDataCodewords($numcw)
{
}
/**
* Get high level encoding using the minimum symbol data characters for ECC 200
* @param $data (string) data to encode
* @return array of codewords
* @protected
*/
protected function getHighLevelEncoding($data)
{
}
/**
* Places "chr+bit" with appropriate wrapping within array[].
* (Annex F - ECC 200 symbol character placement)
* @param $marr (array) Array of symbols.
* @param $nrow (int) Number of rows.
* @param $ncol (int) Number of columns.
* @param $row (int) Row number.
* @param $col (int) Column number.
* @param $chr (int) Char byte.
* @param $bit (int) Bit.
* @return array
* @protected
*/
protected function placeModule($marr, $nrow, $ncol, $row, $col, $chr, $bit)
{
}
/**
* Places the 8 bits of a utah-shaped symbol character.
* (Annex F - ECC 200 symbol character placement)
* @param $marr (array) Array of symbols.
* @param $nrow (int) Number of rows.
* @param $ncol (int) Number of columns.
* @param $row (int) Row number.
* @param $col (int) Column number.
* @param $chr (int) Char byte.
* @return array
* @protected
*/
protected function placeUtah($marr, $nrow, $ncol, $row, $col, $chr)
{
}
/**
* Places the 8 bits of the first special corner case.
* (Annex F - ECC 200 symbol character placement)
* @param $marr (array) Array of symbols.
* @param $nrow (int) Number of rows.
* @param $ncol (int) Number of columns.
* @param $chr (int) Char byte.
* @return array
* @protected
*/
protected function placeCornerA($marr, $nrow, $ncol, $chr)
{
}
/**
* Places the 8 bits of the second special corner case.
* (Annex F - ECC 200 symbol character placement)
* @param $marr (array) Array of symbols.
* @param $nrow (int) Number of rows.
* @param $ncol (int) Number of columns.
* @param $chr (int) Char byte.
* @return array
* @protected
*/
protected function placeCornerB($marr, $nrow, $ncol, $chr)
{
}
/**
* Places the 8 bits of the third special corner case.
* (Annex F - ECC 200 symbol character placement)
* @param $marr (array) Array of symbols.
* @param $nrow (int) Number of rows.
* @param $ncol (int) Number of columns.
* @param $chr (int) Char byte.
* @return array
* @protected
*/
protected function placeCornerC($marr, $nrow, $ncol, $chr)
{
}
/**
* Places the 8 bits of the fourth special corner case.
* (Annex F - ECC 200 symbol character placement)
* @param $marr (array) Array of symbols.
* @param $nrow (int) Number of rows.
* @param $ncol (int) Number of columns.
* @param $chr (int) Char byte.
* @return array
* @protected
*/
protected function placeCornerD($marr, $nrow, $ncol, $chr)
{
}
/**
* Build a placement map.
* (Annex F - ECC 200 symbol character placement)
* @param $nrow (int) Number of rows.
* @param $ncol (int) Number of columns.
* @return array
* @protected
*/
protected function getPlacementMap($nrow, $ncol)
{
}
}
// end of definitions
// #*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#
/**
* @class PDF417
* Class to create PDF417 barcode arrays for TCPDF class.
* PDF417 (ISO/IEC 15438:2006) is a 2-dimensional stacked bar code created by Symbol Technologies in 1991.
* @package com.tecnick.tcpdf
* @author Nicola Asuni
* @version 1.0.003
*/
class PDF417
{
/**
* Barcode array to be returned which is readable by TCPDF.
* @protected
*/
protected $barcode_array = array();
/**
* Start pattern.
* @protected
*/
protected $start_pattern = '11111111010101000';
/**
* Stop pattern.
* @protected
*/
protected $stop_pattern = '111111101000101001';
/**
* Array of text Compaction Sub-Modes (values 0xFB - 0xFF are used for submode changers).
* @protected
*/
protected $textsubmodes = array(
array(0x41, 0x42, 0x43, 0x44, 0x45, 0x46, 0x47, 0x48, 0x49, 0x4a, 0x4b, 0x4c, 0x4d, 0x4e, 0x4f, 0x50, 0x51, 0x52, 0x53, 0x54, 0x55, 0x56, 0x57, 0x58, 0x59, 0x5a, 0x20, 0xfd, 0xfe, 0xff),
// Alpha
array(0x61, 0x62, 0x63, 0x64, 0x65, 0x66, 0x67, 0x68, 0x69, 0x6a, 0x6b, 0x6c, 0x6d, 0x6e, 0x6f, 0x70, 0x71, 0x72, 0x73, 0x74, 0x75, 0x76, 0x77, 0x78, 0x79, 0x7a, 0x20, 0xfd, 0xfe, 0xff),
// Lower
array(0x30, 0x31, 0x32, 0x33, 0x34, 0x35, 0x36, 0x37, 0x38, 0x39, 0x26, 0xd, 0x9, 0x2c, 0x3a, 0x23, 0x2d, 0x2e, 0x24, 0x2f, 0x2b, 0x25, 0x2a, 0x3d, 0x5e, 0xfb, 0x20, 0xfd, 0xfe, 0xff),
// Mixed
array(0x3b, 0x3c, 0x3e, 0x40, 0x5b, 0x5c, 0x5d, 0x5f, 0x60, 0x7e, 0x21, 0xd, 0x9, 0x2c, 0x3a, 0xa, 0x2d, 0x2e, 0x24, 0x2f, 0x22, 0x7c, 0x2a, 0x28, 0x29, 0x3f, 0x7b, 0x7d, 0x27, 0xff),
);
/**
* Array of switching codes for Text Compaction Sub-Modes.
* @protected
*/
protected $textlatch = array(
'01' => array(27),
'02' => array(28),
'03' => array(28, 25),
//
'10' => array(28, 28),
'12' => array(28),
'13' => array(28, 25),
//
'20' => array(28),
'21' => array(27),
'23' => array(25),
//
'30' => array(29),
'31' => array(29, 27),
'32' => array(29, 28),
);
/**
* Clusters of codewords (0, 3, 6)<br/>
* Values are hex equivalents of binary representation of bars (1 = bar, 0 = space).<br/>
* The codewords numbered from 900 to 928 have special meaning, some enable to switch between modes in order to optimise the code:<ul>
* <li>900 : Switch to "Text" mode</li>
* <li>901 : Switch to "Byte" mode</li>
* <li>902 : Switch to "Numeric" mode</li>
* <li>903 - 912 : Reserved</li>
* <li>913 : Switch to "Octet" only for the next codeword</li>
* <li>914 - 920 : Reserved</li>
* <li>921 : Initialization</li>
* <li>922 : Terminator codeword for Macro PDF control block</li>
* <li>923 : Sequence tag to identify the beginning of optional fields in the Macro PDF control block</li>
* <li>924 : Switch to "Byte" mode (If the total number of byte is multiple of 6)</li>
* <li>925 : Identifier for a user defined Extended Channel Interpretation (ECI)</li>
* <li>926 : Identifier for a general purpose ECI format</li>
* <li>927 : Identifier for an ECI of a character set or code page</li>
* <li>928 : Macro marker codeword to indicate the beginning of a Macro PDF Control Block</li>
* </ul>
* @protected
*/
protected $clusters = array(
array(
// cluster 0 -----------------------------------------------------------------------
0x1d5c0,
0x1eaf0,
0x1f57c,
0x1d4e0,
0x1ea78,
0x1f53e,
0x1a8c0,
0x1d470,
0x1a860,
0x15040,
// 10
0x1a830,
0x15020,
0x1adc0,
0x1d6f0,
0x1eb7c,
0x1ace0,
0x1d678,
0x1eb3e,
0x158c0,
0x1ac70,
// 20
0x15860,
0x15dc0,
0x1aef0,
0x1d77c,
0x15ce0,
0x1ae78,
0x1d73e,
0x15c70,
0x1ae3c,
0x15ef0,
// 30
0x1af7c,
0x15e78,
0x1af3e,
0x15f7c,
0x1f5fa,
0x1d2e0,
0x1e978,
0x1f4be,
0x1a4c0,
0x1d270,
// 40
0x1e93c,
0x1a460,
0x1d238,
0x14840,
0x1a430,
0x1d21c,
0x14820,
0x1a418,
0x14810,
0x1a6e0,
// 50
0x1d378,
0x1e9be,
0x14cc0,
0x1a670,
0x1d33c,
0x14c60,
0x1a638,
0x1d31e,
0x14c30,
0x1a61c,
// 60
0x14ee0,
0x1a778,
0x1d3be,
0x14e70,
0x1a73c,
0x14e38,
0x1a71e,
0x14f78,
0x1a7be,
0x14f3c,
// 70
0x14f1e,
0x1a2c0,
0x1d170,
0x1e8bc,
0x1a260,
0x1d138,
0x1e89e,
0x14440,
0x1a230,
0x1d11c,
// 80
0x14420,
0x1a218,
0x14410,
0x14408,
0x146c0,
0x1a370,
0x1d1bc,
0x14660,
0x1a338,
0x1d19e,
// 90
0x14630,
0x1a31c,
0x14618,
0x1460c,
0x14770,
0x1a3bc,
0x14738,
0x1a39e,
0x1471c,
0x147bc,
// 100
0x1a160,
0x1d0b8,
0x1e85e,
0x14240,
0x1a130,
0x1d09c,
0x14220,
0x1a118,
0x1d08e,
0x14210,
// 110
0x1a10c,
0x14208,
0x1a106,
0x14360,
0x1a1b8,
0x1d0de,
0x14330,
0x1a19c,
0x14318,
0x1a18e,
// 120
0x1430c,
0x14306,
0x1a1de,
0x1438e,
0x14140,
0x1a0b0,
0x1d05c,
0x14120,
0x1a098,
0x1d04e,
// 130
0x14110,
0x1a08c,
0x14108,
0x1a086,
0x14104,
0x141b0,
0x14198,
0x1418c,
0x140a0,
0x1d02e,
// 140
0x1a04c,
0x1a046,
0x14082,
0x1cae0,
0x1e578,
0x1f2be,
0x194c0,
0x1ca70,
0x1e53c,
0x19460,
// 150
0x1ca38,
0x1e51e,
0x12840,
0x19430,
0x12820,
0x196e0,
0x1cb78,
0x1e5be,
0x12cc0,
0x19670,
// 160
0x1cb3c,
0x12c60,
0x19638,
0x12c30,
0x12c18,
0x12ee0,
0x19778,
0x1cbbe,
0x12e70,
0x1973c,
// 170
0x12e38,
0x12e1c,
0x12f78,
0x197be,
0x12f3c,
0x12fbe,
0x1dac0,
0x1ed70,
0x1f6bc,
0x1da60,
// 180
0x1ed38,
0x1f69e,
0x1b440,
0x1da30,
0x1ed1c,
0x1b420,
0x1da18,
0x1ed0e,
0x1b410,
0x1da0c,
// 190
0x192c0,
0x1c970,
0x1e4bc,
0x1b6c0,
0x19260,
0x1c938,
0x1e49e,
0x1b660,
0x1db38,
0x1ed9e,
// 200
0x16c40,
0x12420,
0x19218,
0x1c90e,
0x16c20,
0x1b618,
0x16c10,
0x126c0,
0x19370,
0x1c9bc,
// 210
0x16ec0,
0x12660,
0x19338,
0x1c99e,
0x16e60,
0x1b738,
0x1db9e,
0x16e30,
0x12618,
0x16e18,
// 220
0x12770,
0x193bc,
0x16f70,
0x12738,
0x1939e,
0x16f38,
0x1b79e,
0x16f1c,
0x127bc,
0x16fbc,
// 230
0x1279e,
0x16f9e,
0x1d960,
0x1ecb8,
0x1f65e,
0x1b240,
0x1d930,
0x1ec9c,
0x1b220,
0x1d918,
// 240
0x1ec8e,
0x1b210,
0x1d90c,
0x1b208,
0x1b204,
0x19160,
0x1c8b8,
0x1e45e,
0x1b360,
0x19130,
// 250
0x1c89c,
0x16640,
0x12220,
0x1d99c,
0x1c88e,
0x16620,
0x12210,
0x1910c,
0x16610,
0x1b30c,
// 260
0x19106,
0x12204,
0x12360,
0x191b8,
0x1c8de,
0x16760,
0x12330,
0x1919c,
0x16730,
0x1b39c,
// 270
0x1918e,
0x16718,
0x1230c,
0x12306,
0x123b8,
0x191de,
0x167b8,
0x1239c,
0x1679c,
0x1238e,
// 280
0x1678e,
0x167de,
0x1b140,
0x1d8b0,
0x1ec5c,
0x1b120,
0x1d898,
0x1ec4e,
0x1b110,
0x1d88c,
// 290
0x1b108,
0x1d886,
0x1b104,
0x1b102,
0x12140,
0x190b0,
0x1c85c,
0x16340,
0x12120,
0x19098,
// 300
0x1c84e,
0x16320,
0x1b198,
0x1d8ce,
0x16310,
0x12108,
0x19086,
0x16308,
0x1b186,
0x16304,
// 310
0x121b0,
0x190dc,
0x163b0,
0x12198,
0x190ce,
0x16398,
0x1b1ce,
0x1638c,
0x12186,
0x16386,
// 320
0x163dc,
0x163ce,
0x1b0a0,
0x1d858,
0x1ec2e,
0x1b090,
0x1d84c,
0x1b088,
0x1d846,
0x1b084,
// 330
0x1b082,
0x120a0,
0x19058,
0x1c82e,
0x161a0,
0x12090,
0x1904c,
0x16190,
0x1b0cc,
0x19046,
// 340
0x16188,
0x12084,
0x16184,
0x12082,
0x120d8,
0x161d8,
0x161cc,
0x161c6,
0x1d82c,
0x1d826,
// 350
0x1b042,
0x1902c,
0x12048,
0x160c8,
0x160c4,
0x160c2,
0x18ac0,
0x1c570,
0x1e2bc,
0x18a60,
// 360
0x1c538,
0x11440,
0x18a30,
0x1c51c,
0x11420,
0x18a18,
0x11410,
0x11408,
0x116c0,
0x18b70,
// 370
0x1c5bc,
0x11660,
0x18b38,
0x1c59e,
0x11630,
0x18b1c,
0x11618,
0x1160c,
0x11770,
0x18bbc,
// 380
0x11738,
0x18b9e,
0x1171c,
0x117bc,
0x1179e,
0x1cd60,
0x1e6b8,
0x1f35e,
0x19a40,
0x1cd30,
// 390
0x1e69c,
0x19a20,
0x1cd18,
0x1e68e,
0x19a10,
0x1cd0c,
0x19a08,
0x1cd06,
0x18960,
0x1c4b8,
// 400
0x1e25e,
0x19b60,
0x18930,
0x1c49c,
0x13640,
0x11220,
0x1cd9c,
0x1c48e,
0x13620,
0x19b18,
// 410
0x1890c,
0x13610,
0x11208,
0x13608,
0x11360,
0x189b8,
0x1c4de,
0x13760,
0x11330,
0x1cdde,
// 420
0x13730,
0x19b9c,
0x1898e,
0x13718,
0x1130c,
0x1370c,
0x113b8,
0x189de,
0x137b8,
0x1139c,
// 430
0x1379c,
0x1138e,
0x113de,
0x137de,
0x1dd40,
0x1eeb0,
0x1f75c,
0x1dd20,
0x1ee98,
0x1f74e,
// 440
0x1dd10,
0x1ee8c,
0x1dd08,
0x1ee86,
0x1dd04,
0x19940,
0x1ccb0,
0x1e65c,
0x1bb40,
0x19920,
// 450
0x1eedc,
0x1e64e,
0x1bb20,
0x1dd98,
0x1eece,
0x1bb10,
0x19908,
0x1cc86,
0x1bb08,
0x1dd86,
// 460
0x19902,
0x11140,
0x188b0,
0x1c45c,
0x13340,
0x11120,
0x18898,
0x1c44e,
0x17740,
0x13320,
// 470
0x19998,
0x1ccce,
0x17720,
0x1bb98,
0x1ddce,
0x18886,
0x17710,
0x13308,
0x19986,
0x17708,
// 480
0x11102,
0x111b0,
0x188dc,
0x133b0,
0x11198,
0x188ce,
0x177b0,
0x13398,
0x199ce,
0x17798,
// 490
0x1bbce,
0x11186,
0x13386,
0x111dc,
0x133dc,
0x111ce,
0x177dc,
0x133ce,
0x1dca0,
0x1ee58,
// 500
0x1f72e,
0x1dc90,
0x1ee4c,
0x1dc88,
0x1ee46,
0x1dc84,
0x1dc82,
0x198a0,
0x1cc58,
0x1e62e,
// 510
0x1b9a0,
0x19890,
0x1ee6e,
0x1b990,
0x1dccc,
0x1cc46,
0x1b988,
0x19884,
0x1b984,
0x19882,
// 520
0x1b982,
0x110a0,
0x18858,
0x1c42e,
0x131a0,
0x11090,
0x1884c,
0x173a0,
0x13190,
0x198cc,
// 530
0x18846,
0x17390,
0x1b9cc,
0x11084,
0x17388,
0x13184,
0x11082,
0x13182,
0x110d8,
0x1886e,
// 540
0x131d8,
0x110cc,
0x173d8,
0x131cc,
0x110c6,
0x173cc,
0x131c6,
0x110ee,
0x173ee,
0x1dc50,
// 550
0x1ee2c,
0x1dc48,
0x1ee26,
0x1dc44,
0x1dc42,
0x19850,
0x1cc2c,
0x1b8d0,
0x19848,
0x1cc26,
// 560
0x1b8c8,
0x1dc66,
0x1b8c4,
0x19842,
0x1b8c2,
0x11050,
0x1882c,
0x130d0,
0x11048,
0x18826,
// 570
0x171d0,
0x130c8,
0x19866,
0x171c8,
0x1b8e6,
0x11042,
0x171c4,
0x130c2,
0x171c2,
0x130ec,
// 580
0x171ec,
0x171e6,
0x1ee16,
0x1dc22,
0x1cc16,
0x19824,
0x19822,
0x11028,
0x13068,
0x170e8,
// 590
0x11022,
0x13062,
0x18560,
0x10a40,
0x18530,
0x10a20,
0x18518,
0x1c28e,
0x10a10,
0x1850c,
// 600
0x10a08,
0x18506,
0x10b60,
0x185b8,
0x1c2de,
0x10b30,
0x1859c,
0x10b18,
0x1858e,
0x10b0c,
// 610
0x10b06,
0x10bb8,
0x185de,
0x10b9c,
0x10b8e,
0x10bde,
0x18d40,
0x1c6b0,
0x1e35c,
0x18d20,
// 620
0x1c698,
0x18d10,
0x1c68c,
0x18d08,
0x1c686,
0x18d04,
0x10940,
0x184b0,
0x1c25c,
0x11b40,
// 630
0x10920,
0x1c6dc,
0x1c24e,
0x11b20,
0x18d98,
0x1c6ce,
0x11b10,
0x10908,
0x18486,
0x11b08,
// 640
0x18d86,
0x10902,
0x109b0,
0x184dc,
0x11bb0,
0x10998,
0x184ce,
0x11b98,
0x18dce,
0x11b8c,
// 650
0x10986,
0x109dc,
0x11bdc,
0x109ce,
0x11bce,
0x1cea0,
0x1e758,
0x1f3ae,
0x1ce90,
0x1e74c,
// 660
0x1ce88,
0x1e746,
0x1ce84,
0x1ce82,
0x18ca0,
0x1c658,
0x19da0,
0x18c90,
0x1c64c,
0x19d90,
// 670
0x1cecc,
0x1c646,
0x19d88,
0x18c84,
0x19d84,
0x18c82,
0x19d82,
0x108a0,
0x18458,
0x119a0,
// 680
0x10890,
0x1c66e,
0x13ba0,
0x11990,
0x18ccc,
0x18446,
0x13b90,
0x19dcc,
0x10884,
0x13b88,
// 690
0x11984,
0x10882,
0x11982,
0x108d8,
0x1846e,
0x119d8,
0x108cc,
0x13bd8,
0x119cc,
0x108c6,
// 700
0x13bcc,
0x119c6,
0x108ee,
0x119ee,
0x13bee,
0x1ef50,
0x1f7ac,
0x1ef48,
0x1f7a6,
0x1ef44,
// 710
0x1ef42,
0x1ce50,
0x1e72c,
0x1ded0,
0x1ef6c,
0x1e726,
0x1dec8,
0x1ef66,
0x1dec4,
0x1ce42,
// 720
0x1dec2,
0x18c50,
0x1c62c,
0x19cd0,
0x18c48,
0x1c626,
0x1bdd0,
0x19cc8,
0x1ce66,
0x1bdc8,
// 730
0x1dee6,
0x18c42,
0x1bdc4,
0x19cc2,
0x1bdc2,
0x10850,
0x1842c,
0x118d0,
0x10848,
0x18426,
// 740
0x139d0,
0x118c8,
0x18c66,
0x17bd0,
0x139c8,
0x19ce6,
0x10842,
0x17bc8,
0x1bde6,
0x118c2,
// 750
0x17bc4,
0x1086c,
0x118ec,
0x10866,
0x139ec,
0x118e6,
0x17bec,
0x139e6,
0x17be6,
0x1ef28,
// 760
0x1f796,
0x1ef24,
0x1ef22,
0x1ce28,
0x1e716,
0x1de68,
0x1ef36,
0x1de64,
0x1ce22,
0x1de62,
// 770
0x18c28,
0x1c616,
0x19c68,
0x18c24,
0x1bce8,
0x19c64,
0x18c22,
0x1bce4,
0x19c62,
0x1bce2,
// 780
0x10828,
0x18416,
0x11868,
0x18c36,
0x138e8,
0x11864,
0x10822,
0x179e8,
0x138e4,
0x11862,
// 790
0x179e4,
0x138e2,
0x179e2,
0x11876,
0x179f6,
0x1ef12,
0x1de34,
0x1de32,
0x19c34,
0x1bc74,
// 800
0x1bc72,
0x11834,
0x13874,
0x178f4,
0x178f2,
0x10540,
0x10520,
0x18298,
0x10510,
0x10508,
// 810
0x10504,
0x105b0,
0x10598,
0x1058c,
0x10586,
0x105dc,
0x105ce,
0x186a0,
0x18690,
0x1c34c,
// 820
0x18688,
0x1c346,
0x18684,
0x18682,
0x104a0,
0x18258,
0x10da0,
0x186d8,
0x1824c,
0x10d90,
// 830
0x186cc,
0x10d88,
0x186c6,
0x10d84,
0x10482,
0x10d82,
0x104d8,
0x1826e,
0x10dd8,
0x186ee,
// 840
0x10dcc,
0x104c6,
0x10dc6,
0x104ee,
0x10dee,
0x1c750,
0x1c748,
0x1c744,
0x1c742,
0x18650,
// 850
0x18ed0,
0x1c76c,
0x1c326,
0x18ec8,
0x1c766,
0x18ec4,
0x18642,
0x18ec2,
0x10450,
0x10cd0,
// 860
0x10448,
0x18226,
0x11dd0,
0x10cc8,
0x10444,
0x11dc8,
0x10cc4,
0x10442,
0x11dc4,
0x10cc2,
// 870
0x1046c,
0x10cec,
0x10466,
0x11dec,
0x10ce6,
0x11de6,
0x1e7a8,
0x1e7a4,
0x1e7a2,
0x1c728,
// 880
0x1cf68,
0x1e7b6,
0x1cf64,
0x1c722,
0x1cf62,
0x18628,
0x1c316,
0x18e68,
0x1c736,
0x19ee8,
// 890
0x18e64,
0x18622,
0x19ee4,
0x18e62,
0x19ee2,
0x10428,
0x18216,
0x10c68,
0x18636,
0x11ce8,
// 900
0x10c64,
0x10422,
0x13de8,
0x11ce4,
0x10c62,
0x13de4,
0x11ce2,
0x10436,
0x10c76,
0x11cf6,
// 910
0x13df6,
0x1f7d4,
0x1f7d2,
0x1e794,
0x1efb4,
0x1e792,
0x1efb2,
0x1c714,
0x1cf34,
0x1c712,
// 920
0x1df74,
0x1cf32,
0x1df72,
0x18614,
0x18e34,
0x18612,
0x19e74,
0x18e32,
0x1bef4,
),
// 929
array(
// cluster 3 -----------------------------------------------------------------------
0x1f560,
0x1fab8,
0x1ea40,
0x1f530,
0x1fa9c,
0x1ea20,
0x1f518,
0x1fa8e,
0x1ea10,
0x1f50c,
// 10
0x1ea08,
0x1f506,
0x1ea04,
0x1eb60,
0x1f5b8,
0x1fade,
0x1d640,
0x1eb30,
0x1f59c,
0x1d620,
// 20
0x1eb18,
0x1f58e,
0x1d610,
0x1eb0c,
0x1d608,
0x1eb06,
0x1d604,
0x1d760,
0x1ebb8,
0x1f5de,
// 30
0x1ae40,
0x1d730,
0x1eb9c,
0x1ae20,
0x1d718,
0x1eb8e,
0x1ae10,
0x1d70c,
0x1ae08,
0x1d706,
// 40
0x1ae04,
0x1af60,
0x1d7b8,
0x1ebde,
0x15e40,
0x1af30,
0x1d79c,
0x15e20,
0x1af18,
0x1d78e,
// 50
0x15e10,
0x1af0c,
0x15e08,
0x1af06,
0x15f60,
0x1afb8,
0x1d7de,
0x15f30,
0x1af9c,
0x15f18,
// 60
0x1af8e,
0x15f0c,
0x15fb8,
0x1afde,
0x15f9c,
0x15f8e,
0x1e940,
0x1f4b0,
0x1fa5c,
0x1e920,
// 70
0x1f498,
0x1fa4e,
0x1e910,
0x1f48c,
0x1e908,
0x1f486,
0x1e904,
0x1e902,
0x1d340,
0x1e9b0,
// 80
0x1f4dc,
0x1d320,
0x1e998,
0x1f4ce,
0x1d310,
0x1e98c,
0x1d308,
0x1e986,
0x1d304,
0x1d302,
// 90
0x1a740,
0x1d3b0,
0x1e9dc,
0x1a720,
0x1d398,
0x1e9ce,
0x1a710,
0x1d38c,
0x1a708,
0x1d386,
// 100
0x1a704,
0x1a702,
0x14f40,
0x1a7b0,
0x1d3dc,
0x14f20,
0x1a798,
0x1d3ce,
0x14f10,
0x1a78c,
// 110
0x14f08,
0x1a786,
0x14f04,
0x14fb0,
0x1a7dc,
0x14f98,
0x1a7ce,
0x14f8c,
0x14f86,
0x14fdc,
// 120
0x14fce,
0x1e8a0,
0x1f458,
0x1fa2e,
0x1e890,
0x1f44c,
0x1e888,
0x1f446,
0x1e884,
0x1e882,
// 130
0x1d1a0,
0x1e8d8,
0x1f46e,
0x1d190,
0x1e8cc,
0x1d188,
0x1e8c6,
0x1d184,
0x1d182,
0x1a3a0,
// 140
0x1d1d8,
0x1e8ee,
0x1a390,
0x1d1cc,
0x1a388,
0x1d1c6,
0x1a384,
0x1a382,
0x147a0,
0x1a3d8,
// 150
0x1d1ee,
0x14790,
0x1a3cc,
0x14788,
0x1a3c6,
0x14784,
0x14782,
0x147d8,
0x1a3ee,
0x147cc,
// 160
0x147c6,
0x147ee,
0x1e850,
0x1f42c,
0x1e848,
0x1f426,
0x1e844,
0x1e842,
0x1d0d0,
0x1e86c,
// 170
0x1d0c8,
0x1e866,
0x1d0c4,
0x1d0c2,
0x1a1d0,
0x1d0ec,
0x1a1c8,
0x1d0e6,
0x1a1c4,
0x1a1c2,
// 180
0x143d0,
0x1a1ec,
0x143c8,
0x1a1e6,
0x143c4,
0x143c2,
0x143ec,
0x143e6,
0x1e828,
0x1f416,
// 190
0x1e824,
0x1e822,
0x1d068,
0x1e836,
0x1d064,
0x1d062,
0x1a0e8,
0x1d076,
0x1a0e4,
0x1a0e2,
// 200
0x141e8,
0x1a0f6,
0x141e4,
0x141e2,
0x1e814,
0x1e812,
0x1d034,
0x1d032,
0x1a074,
0x1a072,
// 210
0x1e540,
0x1f2b0,
0x1f95c,
0x1e520,
0x1f298,
0x1f94e,
0x1e510,
0x1f28c,
0x1e508,
0x1f286,
// 220
0x1e504,
0x1e502,
0x1cb40,
0x1e5b0,
0x1f2dc,
0x1cb20,
0x1e598,
0x1f2ce,
0x1cb10,
0x1e58c,
// 230
0x1cb08,
0x1e586,
0x1cb04,
0x1cb02,
0x19740,
0x1cbb0,
0x1e5dc,
0x19720,
0x1cb98,
0x1e5ce,
// 240
0x19710,
0x1cb8c,
0x19708,
0x1cb86,
0x19704,
0x19702,
0x12f40,
0x197b0,
0x1cbdc,
0x12f20,
// 250
0x19798,
0x1cbce,
0x12f10,
0x1978c,
0x12f08,
0x19786,
0x12f04,
0x12fb0,
0x197dc,
0x12f98,
// 260
0x197ce,
0x12f8c,
0x12f86,
0x12fdc,
0x12fce,
0x1f6a0,
0x1fb58,
0x16bf0,
0x1f690,
0x1fb4c,
// 270
0x169f8,
0x1f688,
0x1fb46,
0x168fc,
0x1f684,
0x1f682,
0x1e4a0,
0x1f258,
0x1f92e,
0x1eda0,
// 280
0x1e490,
0x1fb6e,
0x1ed90,
0x1f6cc,
0x1f246,
0x1ed88,
0x1e484,
0x1ed84,
0x1e482,
0x1ed82,
// 290
0x1c9a0,
0x1e4d8,
0x1f26e,
0x1dba0,
0x1c990,
0x1e4cc,
0x1db90,
0x1edcc,
0x1e4c6,
0x1db88,
// 300
0x1c984,
0x1db84,
0x1c982,
0x1db82,
0x193a0,
0x1c9d8,
0x1e4ee,
0x1b7a0,
0x19390,
0x1c9cc,
// 310
0x1b790,
0x1dbcc,
0x1c9c6,
0x1b788,
0x19384,
0x1b784,
0x19382,
0x1b782,
0x127a0,
0x193d8,
// 320
0x1c9ee,
0x16fa0,
0x12790,
0x193cc,
0x16f90,
0x1b7cc,
0x193c6,
0x16f88,
0x12784,
0x16f84,
// 330
0x12782,
0x127d8,
0x193ee,
0x16fd8,
0x127cc,
0x16fcc,
0x127c6,
0x16fc6,
0x127ee,
0x1f650,
// 340
0x1fb2c,
0x165f8,
0x1f648,
0x1fb26,
0x164fc,
0x1f644,
0x1647e,
0x1f642,
0x1e450,
0x1f22c,
// 350
0x1ecd0,
0x1e448,
0x1f226,
0x1ecc8,
0x1f666,
0x1ecc4,
0x1e442,
0x1ecc2,
0x1c8d0,
0x1e46c,
// 360
0x1d9d0,
0x1c8c8,
0x1e466,
0x1d9c8,
0x1ece6,
0x1d9c4,
0x1c8c2,
0x1d9c2,
0x191d0,
0x1c8ec,
// 370
0x1b3d0,
0x191c8,
0x1c8e6,
0x1b3c8,
0x1d9e6,
0x1b3c4,
0x191c2,
0x1b3c2,
0x123d0,
0x191ec,
// 380
0x167d0,
0x123c8,
0x191e6,
0x167c8,
0x1b3e6,
0x167c4,
0x123c2,
0x167c2,
0x123ec,
0x167ec,
// 390
0x123e6,
0x167e6,
0x1f628,
0x1fb16,
0x162fc,
0x1f624,
0x1627e,
0x1f622,
0x1e428,
0x1f216,
// 400
0x1ec68,
0x1f636,
0x1ec64,
0x1e422,
0x1ec62,
0x1c868,
0x1e436,
0x1d8e8,
0x1c864,
0x1d8e4,
// 410
0x1c862,
0x1d8e2,
0x190e8,
0x1c876,
0x1b1e8,
0x1d8f6,
0x1b1e4,
0x190e2,
0x1b1e2,
0x121e8,
// 420
0x190f6,
0x163e8,
0x121e4,
0x163e4,
0x121e2,
0x163e2,
0x121f6,
0x163f6,
0x1f614,
0x1617e,
// 430
0x1f612,
0x1e414,
0x1ec34,
0x1e412,
0x1ec32,
0x1c834,
0x1d874,
0x1c832,
0x1d872,
0x19074,
// 440
0x1b0f4,
0x19072,
0x1b0f2,
0x120f4,
0x161f4,
0x120f2,
0x161f2,
0x1f60a,
0x1e40a,
0x1ec1a,
// 450
0x1c81a,
0x1d83a,
0x1903a,
0x1b07a,
0x1e2a0,
0x1f158,
0x1f8ae,
0x1e290,
0x1f14c,
0x1e288,
// 460
0x1f146,
0x1e284,
0x1e282,
0x1c5a0,
0x1e2d8,
0x1f16e,
0x1c590,
0x1e2cc,
0x1c588,
0x1e2c6,
// 470
0x1c584,
0x1c582,
0x18ba0,
0x1c5d8,
0x1e2ee,
0x18b90,
0x1c5cc,
0x18b88,
0x1c5c6,
0x18b84,
// 480
0x18b82,
0x117a0,
0x18bd8,
0x1c5ee,
0x11790,
0x18bcc,
0x11788,
0x18bc6,
0x11784,
0x11782,
// 490
0x117d8,
0x18bee,
0x117cc,
0x117c6,
0x117ee,
0x1f350,
0x1f9ac,
0x135f8,
0x1f348,
0x1f9a6,
// 500
0x134fc,
0x1f344,
0x1347e,
0x1f342,
0x1e250,
0x1f12c,
0x1e6d0,
0x1e248,
0x1f126,
0x1e6c8,
// 510
0x1f366,
0x1e6c4,
0x1e242,
0x1e6c2,
0x1c4d0,
0x1e26c,
0x1cdd0,
0x1c4c8,
0x1e266,
0x1cdc8,
// 520
0x1e6e6,
0x1cdc4,
0x1c4c2,
0x1cdc2,
0x189d0,
0x1c4ec,
0x19bd0,
0x189c8,
0x1c4e6,
0x19bc8,
// 530
0x1cde6,
0x19bc4,
0x189c2,
0x19bc2,
0x113d0,
0x189ec,
0x137d0,
0x113c8,
0x189e6,
0x137c8,
// 540
0x19be6,
0x137c4,
0x113c2,
0x137c2,
0x113ec,
0x137ec,
0x113e6,
0x137e6,
0x1fba8,
0x175f0,
// 550
0x1bafc,
0x1fba4,
0x174f8,
0x1ba7e,
0x1fba2,
0x1747c,
0x1743e,
0x1f328,
0x1f996,
0x132fc,
// 560
0x1f768,
0x1fbb6,
0x176fc,
0x1327e,
0x1f764,
0x1f322,
0x1767e,
0x1f762,
0x1e228,
0x1f116,
// 570
0x1e668,
0x1e224,
0x1eee8,
0x1f776,
0x1e222,
0x1eee4,
0x1e662,
0x1eee2,
0x1c468,
0x1e236,
// 580
0x1cce8,
0x1c464,
0x1dde8,
0x1cce4,
0x1c462,
0x1dde4,
0x1cce2,
0x1dde2,
0x188e8,
0x1c476,
// 590
0x199e8,
0x188e4,
0x1bbe8,
0x199e4,
0x188e2,
0x1bbe4,
0x199e2,
0x1bbe2,
0x111e8,
0x188f6,
// 600
0x133e8,
0x111e4,
0x177e8,
0x133e4,
0x111e2,
0x177e4,
0x133e2,
0x177e2,
0x111f6,
0x133f6,
// 610
0x1fb94,
0x172f8,
0x1b97e,
0x1fb92,
0x1727c,
0x1723e,
0x1f314,
0x1317e,
0x1f734,
0x1f312,
// 620
0x1737e,
0x1f732,
0x1e214,
0x1e634,
0x1e212,
0x1ee74,
0x1e632,
0x1ee72,
0x1c434,
0x1cc74,
// 630
0x1c432,
0x1dcf4,
0x1cc72,
0x1dcf2,
0x18874,
0x198f4,
0x18872,
0x1b9f4,
0x198f2,
0x1b9f2,
// 640
0x110f4,
0x131f4,
0x110f2,
0x173f4,
0x131f2,
0x173f2,
0x1fb8a,
0x1717c,
0x1713e,
0x1f30a,
// 650
0x1f71a,
0x1e20a,
0x1e61a,
0x1ee3a,
0x1c41a,
0x1cc3a,
0x1dc7a,
0x1883a,
0x1987a,
0x1b8fa,
// 660
0x1107a,
0x130fa,
0x171fa,
0x170be,
0x1e150,
0x1f0ac,
0x1e148,
0x1f0a6,
0x1e144,
0x1e142,
// 670
0x1c2d0,
0x1e16c,
0x1c2c8,
0x1e166,
0x1c2c4,
0x1c2c2,
0x185d0,
0x1c2ec,
0x185c8,
0x1c2e6,
// 680
0x185c4,
0x185c2,
0x10bd0,
0x185ec,
0x10bc8,
0x185e6,
0x10bc4,
0x10bc2,
0x10bec,
0x10be6,
// 690
0x1f1a8,
0x1f8d6,
0x11afc,
0x1f1a4,
0x11a7e,
0x1f1a2,
0x1e128,
0x1f096,
0x1e368,
0x1e124,
// 700
0x1e364,
0x1e122,
0x1e362,
0x1c268,
0x1e136,
0x1c6e8,
0x1c264,
0x1c6e4,
0x1c262,
0x1c6e2,
// 710
0x184e8,
0x1c276,
0x18de8,
0x184e4,
0x18de4,
0x184e2,
0x18de2,
0x109e8,
0x184f6,
0x11be8,
// 720
0x109e4,
0x11be4,
0x109e2,
0x11be2,
0x109f6,
0x11bf6,
0x1f9d4,
0x13af8,
0x19d7e,
0x1f9d2,
// 730
0x13a7c,
0x13a3e,
0x1f194,
0x1197e,
0x1f3b4,
0x1f192,
0x13b7e,
0x1f3b2,
0x1e114,
0x1e334,
// 740
0x1e112,
0x1e774,
0x1e332,
0x1e772,
0x1c234,
0x1c674,
0x1c232,
0x1cef4,
0x1c672,
0x1cef2,
// 750
0x18474,
0x18cf4,
0x18472,
0x19df4,
0x18cf2,
0x19df2,
0x108f4,
0x119f4,
0x108f2,
0x13bf4,
// 760
0x119f2,
0x13bf2,
0x17af0,
0x1bd7c,
0x17a78,
0x1bd3e,
0x17a3c,
0x17a1e,
0x1f9ca,
0x1397c,
// 770
0x1fbda,
0x17b7c,
0x1393e,
0x17b3e,
0x1f18a,
0x1f39a,
0x1f7ba,
0x1e10a,
0x1e31a,
0x1e73a,
// 780
0x1ef7a,
0x1c21a,
0x1c63a,
0x1ce7a,
0x1defa,
0x1843a,
0x18c7a,
0x19cfa,
0x1bdfa,
0x1087a,
// 790
0x118fa,
0x139fa,
0x17978,
0x1bcbe,
0x1793c,
0x1791e,
0x138be,
0x179be,
0x178bc,
0x1789e,
// 800
0x1785e,
0x1e0a8,
0x1e0a4,
0x1e0a2,
0x1c168,
0x1e0b6,
0x1c164,
0x1c162,
0x182e8,
0x1c176,
// 810
0x182e4,
0x182e2,
0x105e8,
0x182f6,
0x105e4,
0x105e2,
0x105f6,
0x1f0d4,
0x10d7e,
0x1f0d2,
// 820
0x1e094,
0x1e1b4,
0x1e092,
0x1e1b2,
0x1c134,
0x1c374,
0x1c132,
0x1c372,
0x18274,
0x186f4,
// 830
0x18272,
0x186f2,
0x104f4,
0x10df4,
0x104f2,
0x10df2,
0x1f8ea,
0x11d7c,
0x11d3e,
0x1f0ca,
// 840
0x1f1da,
0x1e08a,
0x1e19a,
0x1e3ba,
0x1c11a,
0x1c33a,
0x1c77a,
0x1823a,
0x1867a,
0x18efa,
// 850
0x1047a,
0x10cfa,
0x11dfa,
0x13d78,
0x19ebe,
0x13d3c,
0x13d1e,
0x11cbe,
0x13dbe,
0x17d70,
// 860
0x1bebc,
0x17d38,
0x1be9e,
0x17d1c,
0x17d0e,
0x13cbc,
0x17dbc,
0x13c9e,
0x17d9e,
0x17cb8,
// 870
0x1be5e,
0x17c9c,
0x17c8e,
0x13c5e,
0x17cde,
0x17c5c,
0x17c4e,
0x17c2e,
0x1c0b4,
0x1c0b2,
// 880
0x18174,
0x18172,
0x102f4,
0x102f2,
0x1e0da,
0x1c09a,
0x1c1ba,
0x1813a,
0x1837a,
0x1027a,
// 890
0x106fa,
0x10ebe,
0x11ebc,
0x11e9e,
0x13eb8,
0x19f5e,
0x13e9c,
0x13e8e,
0x11e5e,
0x13ede,
// 900
0x17eb0,
0x1bf5c,
0x17e98,
0x1bf4e,
0x17e8c,
0x17e86,
0x13e5c,
0x17edc,
0x13e4e,
0x17ece,
// 910
0x17e58,
0x1bf2e,
0x17e4c,
0x17e46,
0x13e2e,
0x17e6e,
0x17e2c,
0x17e26,
0x10f5e,
0x11f5c,
// 920
0x11f4e,
0x13f58,
0x19fae,
0x13f4c,
0x13f46,
0x11f2e,
0x13f6e,
0x13f2c,
0x13f26,
),
// 929
array(
// cluster 6 -----------------------------------------------------------------------
0x1abe0,
0x1d5f8,
0x153c0,
0x1a9f0,
0x1d4fc,
0x151e0,
0x1a8f8,
0x1d47e,
0x150f0,
0x1a87c,
// 10
0x15078,
0x1fad0,
0x15be0,
0x1adf8,
0x1fac8,
0x159f0,
0x1acfc,
0x1fac4,
0x158f8,
0x1ac7e,
// 20
0x1fac2,
0x1587c,
0x1f5d0,
0x1faec,
0x15df8,
0x1f5c8,
0x1fae6,
0x15cfc,
0x1f5c4,
0x15c7e,
// 30
0x1f5c2,
0x1ebd0,
0x1f5ec,
0x1ebc8,
0x1f5e6,
0x1ebc4,
0x1ebc2,
0x1d7d0,
0x1ebec,
0x1d7c8,
// 40
0x1ebe6,
0x1d7c4,
0x1d7c2,
0x1afd0,
0x1d7ec,
0x1afc8,
0x1d7e6,
0x1afc4,
0x14bc0,
0x1a5f0,
// 50
0x1d2fc,
0x149e0,
0x1a4f8,
0x1d27e,
0x148f0,
0x1a47c,
0x14878,
0x1a43e,
0x1483c,
0x1fa68,
// 60
0x14df0,
0x1a6fc,
0x1fa64,
0x14cf8,
0x1a67e,
0x1fa62,
0x14c7c,
0x14c3e,
0x1f4e8,
0x1fa76,
// 70
0x14efc,
0x1f4e4,
0x14e7e,
0x1f4e2,
0x1e9e8,
0x1f4f6,
0x1e9e4,
0x1e9e2,
0x1d3e8,
0x1e9f6,
// 80
0x1d3e4,
0x1d3e2,
0x1a7e8,
0x1d3f6,
0x1a7e4,
0x1a7e2,
0x145e0,
0x1a2f8,
0x1d17e,
0x144f0,
// 90
0x1a27c,
0x14478,
0x1a23e,
0x1443c,
0x1441e,
0x1fa34,
0x146f8,
0x1a37e,
0x1fa32,
0x1467c,
// 100
0x1463e,
0x1f474,
0x1477e,
0x1f472,
0x1e8f4,
0x1e8f2,
0x1d1f4,
0x1d1f2,
0x1a3f4,
0x1a3f2,
// 110
0x142f0,
0x1a17c,
0x14278,
0x1a13e,
0x1423c,
0x1421e,
0x1fa1a,
0x1437c,
0x1433e,
0x1f43a,
// 120
0x1e87a,
0x1d0fa,
0x14178,
0x1a0be,
0x1413c,
0x1411e,
0x141be,
0x140bc,
0x1409e,
0x12bc0,
// 130
0x195f0,
0x1cafc,
0x129e0,
0x194f8,
0x1ca7e,
0x128f0,
0x1947c,
0x12878,
0x1943e,
0x1283c,
// 140
0x1f968,
0x12df0,
0x196fc,
0x1f964,
0x12cf8,
0x1967e,
0x1f962,
0x12c7c,
0x12c3e,
0x1f2e8,
// 150
0x1f976,
0x12efc,
0x1f2e4,
0x12e7e,
0x1f2e2,
0x1e5e8,
0x1f2f6,
0x1e5e4,
0x1e5e2,
0x1cbe8,
// 160
0x1e5f6,
0x1cbe4,
0x1cbe2,
0x197e8,
0x1cbf6,
0x197e4,
0x197e2,
0x1b5e0,
0x1daf8,
0x1ed7e,
// 170
0x169c0,
0x1b4f0,
0x1da7c,
0x168e0,
0x1b478,
0x1da3e,
0x16870,
0x1b43c,
0x16838,
0x1b41e,
// 180
0x1681c,
0x125e0,
0x192f8,
0x1c97e,
0x16de0,
0x124f0,
0x1927c,
0x16cf0,
0x1b67c,
0x1923e,
// 190
0x16c78,
0x1243c,
0x16c3c,
0x1241e,
0x16c1e,
0x1f934,
0x126f8,
0x1937e,
0x1fb74,
0x1f932,
// 200
0x16ef8,
0x1267c,
0x1fb72,
0x16e7c,
0x1263e,
0x16e3e,
0x1f274,
0x1277e,
0x1f6f4,
0x1f272,
// 210
0x16f7e,
0x1f6f2,
0x1e4f4,
0x1edf4,
0x1e4f2,
0x1edf2,
0x1c9f4,
0x1dbf4,
0x1c9f2,
0x1dbf2,
// 220
0x193f4,
0x193f2,
0x165c0,
0x1b2f0,
0x1d97c,
0x164e0,
0x1b278,
0x1d93e,
0x16470,
0x1b23c,
// 230
0x16438,
0x1b21e,
0x1641c,
0x1640e,
0x122f0,
0x1917c,
0x166f0,
0x12278,
0x1913e,
0x16678,
// 240
0x1b33e,
0x1663c,
0x1221e,
0x1661e,
0x1f91a,
0x1237c,
0x1fb3a,
0x1677c,
0x1233e,
0x1673e,
// 250
0x1f23a,
0x1f67a,
0x1e47a,
0x1ecfa,
0x1c8fa,
0x1d9fa,
0x191fa,
0x162e0,
0x1b178,
0x1d8be,
// 260
0x16270,
0x1b13c,
0x16238,
0x1b11e,
0x1621c,
0x1620e,
0x12178,
0x190be,
0x16378,
0x1213c,
// 270
0x1633c,
0x1211e,
0x1631e,
0x121be,
0x163be,
0x16170,
0x1b0bc,
0x16138,
0x1b09e,
0x1611c,
// 280
0x1610e,
0x120bc,
0x161bc,
0x1209e,
0x1619e,
0x160b8,
0x1b05e,
0x1609c,
0x1608e,
0x1205e,
// 290
0x160de,
0x1605c,
0x1604e,
0x115e0,
0x18af8,
0x1c57e,
0x114f0,
0x18a7c,
0x11478,
0x18a3e,
// 300
0x1143c,
0x1141e,
0x1f8b4,
0x116f8,
0x18b7e,
0x1f8b2,
0x1167c,
0x1163e,
0x1f174,
0x1177e,
// 310
0x1f172,
0x1e2f4,
0x1e2f2,
0x1c5f4,
0x1c5f2,
0x18bf4,
0x18bf2,
0x135c0,
0x19af0,
0x1cd7c,
// 320
0x134e0,
0x19a78,
0x1cd3e,
0x13470,
0x19a3c,
0x13438,
0x19a1e,
0x1341c,
0x1340e,
0x112f0,
// 330
0x1897c,
0x136f0,
0x11278,
0x1893e,
0x13678,
0x19b3e,
0x1363c,
0x1121e,
0x1361e,
0x1f89a,
// 340
0x1137c,
0x1f9ba,
0x1377c,
0x1133e,
0x1373e,
0x1f13a,
0x1f37a,
0x1e27a,
0x1e6fa,
0x1c4fa,
// 350
0x1cdfa,
0x189fa,
0x1bae0,
0x1dd78,
0x1eebe,
0x174c0,
0x1ba70,
0x1dd3c,
0x17460,
0x1ba38,
// 360
0x1dd1e,
0x17430,
0x1ba1c,
0x17418,
0x1ba0e,
0x1740c,
0x132e0,
0x19978,
0x1ccbe,
0x176e0,
// 370
0x13270,
0x1993c,
0x17670,
0x1bb3c,
0x1991e,
0x17638,
0x1321c,
0x1761c,
0x1320e,
0x1760e,
// 380
0x11178,
0x188be,
0x13378,
0x1113c,
0x17778,
0x1333c,
0x1111e,
0x1773c,
0x1331e,
0x1771e,
// 390
0x111be,
0x133be,
0x177be,
0x172c0,
0x1b970,
0x1dcbc,
0x17260,
0x1b938,
0x1dc9e,
0x17230,
// 400
0x1b91c,
0x17218,
0x1b90e,
0x1720c,
0x17206,
0x13170,
0x198bc,
0x17370,
0x13138,
0x1989e,
// 410
0x17338,
0x1b99e,
0x1731c,
0x1310e,
0x1730e,
0x110bc,
0x131bc,
0x1109e,
0x173bc,
0x1319e,
// 420
0x1739e,
0x17160,
0x1b8b8,
0x1dc5e,
0x17130,
0x1b89c,
0x17118,
0x1b88e,
0x1710c,
0x17106,
// 430
0x130b8,
0x1985e,
0x171b8,
0x1309c,
0x1719c,
0x1308e,
0x1718e,
0x1105e,
0x130de,
0x171de,
// 440
0x170b0,
0x1b85c,
0x17098,
0x1b84e,
0x1708c,
0x17086,
0x1305c,
0x170dc,
0x1304e,
0x170ce,
// 450
0x17058,
0x1b82e,
0x1704c,
0x17046,
0x1302e,
0x1706e,
0x1702c,
0x17026,
0x10af0,
0x1857c,
// 460
0x10a78,
0x1853e,
0x10a3c,
0x10a1e,
0x10b7c,
0x10b3e,
0x1f0ba,
0x1e17a,
0x1c2fa,
0x185fa,
// 470
0x11ae0,
0x18d78,
0x1c6be,
0x11a70,
0x18d3c,
0x11a38,
0x18d1e,
0x11a1c,
0x11a0e,
0x10978,
// 480
0x184be,
0x11b78,
0x1093c,
0x11b3c,
0x1091e,
0x11b1e,
0x109be,
0x11bbe,
0x13ac0,
0x19d70,
// 490
0x1cebc,
0x13a60,
0x19d38,
0x1ce9e,
0x13a30,
0x19d1c,
0x13a18,
0x19d0e,
0x13a0c,
0x13a06,
// 500
0x11970,
0x18cbc,
0x13b70,
0x11938,
0x18c9e,
0x13b38,
0x1191c,
0x13b1c,
0x1190e,
0x13b0e,
// 510
0x108bc,
0x119bc,
0x1089e,
0x13bbc,
0x1199e,
0x13b9e,
0x1bd60,
0x1deb8,
0x1ef5e,
0x17a40,
// 520
0x1bd30,
0x1de9c,
0x17a20,
0x1bd18,
0x1de8e,
0x17a10,
0x1bd0c,
0x17a08,
0x1bd06,
0x17a04,
// 530
0x13960,
0x19cb8,
0x1ce5e,
0x17b60,
0x13930,
0x19c9c,
0x17b30,
0x1bd9c,
0x19c8e,
0x17b18,
// 540
0x1390c,
0x17b0c,
0x13906,
0x17b06,
0x118b8,
0x18c5e,
0x139b8,
0x1189c,
0x17bb8,
0x1399c,
// 550
0x1188e,
0x17b9c,
0x1398e,
0x17b8e,
0x1085e,
0x118de,
0x139de,
0x17bde,
0x17940,
0x1bcb0,
// 560
0x1de5c,
0x17920,
0x1bc98,
0x1de4e,
0x17910,
0x1bc8c,
0x17908,
0x1bc86,
0x17904,
0x17902,
// 570
0x138b0,
0x19c5c,
0x179b0,
0x13898,
0x19c4e,
0x17998,
0x1bcce,
0x1798c,
0x13886,
0x17986,
// 580
0x1185c,
0x138dc,
0x1184e,
0x179dc,
0x138ce,
0x179ce,
0x178a0,
0x1bc58,
0x1de2e,
0x17890,
// 590
0x1bc4c,
0x17888,
0x1bc46,
0x17884,
0x17882,
0x13858,
0x19c2e,
0x178d8,
0x1384c,
0x178cc,
// 600
0x13846,
0x178c6,
0x1182e,
0x1386e,
0x178ee,
0x17850,
0x1bc2c,
0x17848,
0x1bc26,
0x17844,
// 610
0x17842,
0x1382c,
0x1786c,
0x13826,
0x17866,
0x17828,
0x1bc16,
0x17824,
0x17822,
0x13816,
// 620
0x17836,
0x10578,
0x182be,
0x1053c,
0x1051e,
0x105be,
0x10d70,
0x186bc,
0x10d38,
0x1869e,
// 630
0x10d1c,
0x10d0e,
0x104bc,
0x10dbc,
0x1049e,
0x10d9e,
0x11d60,
0x18eb8,
0x1c75e,
0x11d30,
// 640
0x18e9c,
0x11d18,
0x18e8e,
0x11d0c,
0x11d06,
0x10cb8,
0x1865e,
0x11db8,
0x10c9c,
0x11d9c,
// 650
0x10c8e,
0x11d8e,
0x1045e,
0x10cde,
0x11dde,
0x13d40,
0x19eb0,
0x1cf5c,
0x13d20,
0x19e98,
// 660
0x1cf4e,
0x13d10,
0x19e8c,
0x13d08,
0x19e86,
0x13d04,
0x13d02,
0x11cb0,
0x18e5c,
0x13db0,
// 670
0x11c98,
0x18e4e,
0x13d98,
0x19ece,
0x13d8c,
0x11c86,
0x13d86,
0x10c5c,
0x11cdc,
0x10c4e,
// 680
0x13ddc,
0x11cce,
0x13dce,
0x1bea0,
0x1df58,
0x1efae,
0x1be90,
0x1df4c,
0x1be88,
0x1df46,
// 690
0x1be84,
0x1be82,
0x13ca0,
0x19e58,
0x1cf2e,
0x17da0,
0x13c90,
0x19e4c,
0x17d90,
0x1becc,
// 700
0x19e46,
0x17d88,
0x13c84,
0x17d84,
0x13c82,
0x17d82,
0x11c58,
0x18e2e,
0x13cd8,
0x11c4c,
// 710
0x17dd8,
0x13ccc,
0x11c46,
0x17dcc,
0x13cc6,
0x17dc6,
0x10c2e,
0x11c6e,
0x13cee,
0x17dee,
// 720
0x1be50,
0x1df2c,
0x1be48,
0x1df26,
0x1be44,
0x1be42,
0x13c50,
0x19e2c,
0x17cd0,
0x13c48,
// 730
0x19e26,
0x17cc8,
0x1be66,
0x17cc4,
0x13c42,
0x17cc2,
0x11c2c,
0x13c6c,
0x11c26,
0x17cec,
// 740
0x13c66,
0x17ce6,
0x1be28,
0x1df16,
0x1be24,
0x1be22,
0x13c28,
0x19e16,
0x17c68,
0x13c24,
// 750
0x17c64,
0x13c22,
0x17c62,
0x11c16,
0x13c36,
0x17c76,
0x1be14,
0x1be12,
0x13c14,
0x17c34,
// 760
0x13c12,
0x17c32,
0x102bc,
0x1029e,
0x106b8,
0x1835e,
0x1069c,
0x1068e,
0x1025e,
0x106de,
// 770
0x10eb0,
0x1875c,
0x10e98,
0x1874e,
0x10e8c,
0x10e86,
0x1065c,
0x10edc,
0x1064e,
0x10ece,
// 780
0x11ea0,
0x18f58,
0x1c7ae,
0x11e90,
0x18f4c,
0x11e88,
0x18f46,
0x11e84,
0x11e82,
0x10e58,
// 790
0x1872e,
0x11ed8,
0x18f6e,
0x11ecc,
0x10e46,
0x11ec6,
0x1062e,
0x10e6e,
0x11eee,
0x19f50,
// 800
0x1cfac,
0x19f48,
0x1cfa6,
0x19f44,
0x19f42,
0x11e50,
0x18f2c,
0x13ed0,
0x19f6c,
0x18f26,
// 810
0x13ec8,
0x11e44,
0x13ec4,
0x11e42,
0x13ec2,
0x10e2c,
0x11e6c,
0x10e26,
0x13eec,
0x11e66,
// 820
0x13ee6,
0x1dfa8,
0x1efd6,
0x1dfa4,
0x1dfa2,
0x19f28,
0x1cf96,
0x1bf68,
0x19f24,
0x1bf64,
// 830
0x19f22,
0x1bf62,
0x11e28,
0x18f16,
0x13e68,
0x11e24,
0x17ee8,
0x13e64,
0x11e22,
0x17ee4,
// 840
0x13e62,
0x17ee2,
0x10e16,
0x11e36,
0x13e76,
0x17ef6,
0x1df94,
0x1df92,
0x19f14,
0x1bf34,
// 850
0x19f12,
0x1bf32,
0x11e14,
0x13e34,
0x11e12,
0x17e74,
0x13e32,
0x17e72,
0x1df8a,
0x19f0a,
// 860
0x1bf1a,
0x11e0a,
0x13e1a,
0x17e3a,
0x1035c,
0x1034e,
0x10758,
0x183ae,
0x1074c,
0x10746,
// 870
0x1032e,
0x1076e,
0x10f50,
0x187ac,
0x10f48,
0x187a6,
0x10f44,
0x10f42,
0x1072c,
0x10f6c,
// 880
0x10726,
0x10f66,
0x18fa8,
0x1c7d6,
0x18fa4,
0x18fa2,
0x10f28,
0x18796,
0x11f68,
0x18fb6,
// 890
0x11f64,
0x10f22,
0x11f62,
0x10716,
0x10f36,
0x11f76,
0x1cfd4,
0x1cfd2,
0x18f94,
0x19fb4,
// 900
0x18f92,
0x19fb2,
0x10f14,
0x11f34,
0x10f12,
0x13f74,
0x11f32,
0x13f72,
0x1cfca,
0x18f8a,
// 910
0x19f9a,
0x10f0a,
0x11f1a,
0x13f3a,
0x103ac,
0x103a6,
0x107a8,
0x183d6,
0x107a4,
0x107a2,
// 920
0x10396,
0x107b6,
0x187d4,
0x187d2,
0x10794,
0x10fb4,
0x10792,
0x10fb2,
0x1c7ea,
),
);
// end of $clusters array
/**
* Array of factors of the Reed-Solomon polynomial equations used for error correction; one sub array for each correction level (0-8).
* @protected
*/
protected $rsfactors = array(
array(
// ECL 0 (2 factors) -------------------------------------------------------------------------------
0x1b,
0x395,
),
// 2
array(
// ECL 1 (4 factors) -------------------------------------------------------------------------------
0x20a,
0x238,
0x2d3,
0x329,
),
// 4
array(
// ECL 2 (8 factors) -------------------------------------------------------------------------------
0xed,
0x134,
0x1b4,
0x11c,
0x286,
0x28d,
0x1ac,
0x17b,
),
// 8
array(
// ECL 3 (16 factors) ------------------------------------------------------------------------------
0x112,
0x232,
0xe8,
0x2f3,
0x257,
0x20c,
0x321,
0x84,
0x127,
0x74,
0x1ba,
0x1ac,
0x127,
0x2a,
0xb0,
0x41,
),
// 16
array(
// ECL 4 (32 factors) ------------------------------------------------------------------------------
0x169,
0x23f,
0x39a,
0x20d,
0xb0,
0x24a,
0x280,
0x141,
0x218,
0x2e6,
0x2a5,
0x2e6,
0x2af,
0x11c,
0xc1,
0x205,
// 16
0x111,
0x1ee,
0x107,
0x93,
0x251,
0x320,
0x23b,
0x140,
0x323,
0x85,
0xe7,
0x186,
0x2ad,
0x14a,
0x3f,
0x19a,
),
// 32
array(
// ECL 5 (64 factors) ------------------------------------------------------------------------------
0x21b,
0x1a6,
0x6,
0x5d,
0x35e,
0x303,
0x1c5,
0x6a,
0x262,
0x11f,
0x6b,
0x1f9,
0x2dd,
0x36d,
0x17d,
0x264,
// 16
0x2d3,
0x1dc,
0x1ce,
0xac,
0x1ae,
0x261,
0x35a,
0x336,
0x21f,
0x178,
0x1ff,
0x190,
0x2a0,
0x2fa,
0x11b,
0xb8,
// 32
0x1b8,
0x23,
0x207,
0x1f,
0x1cc,
0x252,
0xe1,
0x217,
0x205,
0x160,
0x25d,
0x9e,
0x28b,
0xc9,
0x1e8,
0x1f6,
// 48
0x288,
0x2dd,
0x2cd,
0x53,
0x194,
0x61,
0x118,
0x303,
0x348,
0x275,
0x4,
0x17d,
0x34b,
0x26f,
0x108,
0x21f,
),
// 64
array(
// ECL 6 (128 factors) -----------------------------------------------------------------------------
0x209,
0x136,
0x360,
0x223,
0x35a,
0x244,
0x128,
0x17b,
0x35,
0x30b,
0x381,
0x1bc,
0x190,
0x39d,
0x2ed,
0x19f,
// 16
0x336,
0x5d,
0xd9,
0xd0,
0x3a0,
0xf4,
0x247,
0x26c,
0xf6,
0x94,
0x1bf,
0x277,
0x124,
0x38c,
0x1ea,
0x2c0,
// 32
0x204,
0x102,
0x1c9,
0x38b,
0x252,
0x2d3,
0x2a2,
0x124,
0x110,
0x60,
0x2ac,
0x1b0,
0x2ae,
0x25e,
0x35c,
0x239,
// 48
0xc1,
0xdb,
0x81,
0xba,
0xec,
0x11f,
0xc0,
0x307,
0x116,
0xad,
0x28,
0x17b,
0x2c8,
0x1cf,
0x286,
0x308,
// 64
0xab,
0x1eb,
0x129,
0x2fb,
0x9c,
0x2dc,
0x5f,
0x10e,
0x1bf,
0x5a,
0x1fb,
0x30,
0xe4,
0x335,
0x328,
0x382,
// 80
0x310,
0x297,
0x273,
0x17a,
0x17e,
0x106,
0x17c,
0x25a,
0x2f2,
0x150,
0x59,
0x266,
0x57,
0x1b0,
0x29e,
0x268,
// 96
0x9d,
0x176,
0xf2,
0x2d6,
0x258,
0x10d,
0x177,
0x382,
0x34d,
0x1c6,
0x162,
0x82,
0x32e,
0x24b,
0x324,
0x22,
// 112
0xd3,
0x14a,
0x21b,
0x129,
0x33b,
0x361,
0x25,
0x205,
0x342,
0x13b,
0x226,
0x56,
0x321,
0x4,
0x6c,
0x21b,
),
// 128
array(
// ECL 7 (256 factors) -----------------------------------------------------------------------------
0x20c,
0x37e,
0x4b,
0x2fe,
0x372,
0x359,
0x4a,
0xcc,
0x52,
0x24a,
0x2c4,
0xfa,
0x389,
0x312,
0x8a,
0x2d0,
// 16
0x35a,
0xc2,
0x137,
0x391,
0x113,
0xbe,
0x177,
0x352,
0x1b6,
0x2dd,
0xc2,
0x118,
0xc9,
0x118,
0x33c,
0x2f5,
// 32
0x2c6,
0x32e,
0x397,
0x59,
0x44,
0x239,
0xb,
0xcc,
0x31c,
0x25d,
0x21c,
0x391,
0x321,
0x2bc,
0x31f,
0x89,
// 48
0x1b7,
0x1a2,
0x250,
0x29c,
0x161,
0x35b,
0x172,
0x2b6,
0x145,
0xf0,
0xd8,
0x101,
0x11c,
0x225,
0xd1,
0x374,
// 64
0x13b,
0x46,
0x149,
0x319,
0x1ea,
0x112,
0x36d,
0xa2,
0x2ed,
0x32c,
0x2ac,
0x1cd,
0x14e,
0x178,
0x351,
0x209,
// 80
0x133,
0x123,
0x323,
0x2c8,
0x13,
0x166,
0x18f,
0x38c,
0x67,
0x1ff,
0x33,
0x8,
0x205,
0xe1,
0x121,
0x1d6,
// 96
0x27d,
0x2db,
0x42,
0xff,
0x395,
0x10d,
0x1cf,
0x33e,
0x2da,
0x1b1,
0x350,
0x249,
0x88,
0x21a,
0x38a,
0x5a,
// 112
0x2,
0x122,
0x2e7,
0xc7,
0x28f,
0x387,
0x149,
0x31,
0x322,
0x244,
0x163,
0x24c,
0xbc,
0x1ce,
0xa,
0x86,
// 128
0x274,
0x140,
0x1df,
0x82,
0x2e3,
0x47,
0x107,
0x13e,
0x176,
0x259,
0xc0,
0x25d,
0x8e,
0x2a1,
0x2af,
0xea,
// 144
0x2d2,
0x180,
0xb1,
0x2f0,
0x25f,
0x280,
0x1c7,
0xc1,
0x2b1,
0x2c3,
0x325,
0x281,
0x30,
0x3c,
0x2dc,
0x26d,
// 160
0x37f,
0x220,
0x105,
0x354,
0x28f,
0x135,
0x2b9,
0x2f3,
0x2f4,
0x3c,
0xe7,
0x305,
0x1b2,
0x1a5,
0x2d6,
0x210,
// 176
0x1f7,
0x76,
0x31,
0x31b,
0x20,
0x90,
0x1f4,
0xee,
0x344,
0x18a,
0x118,
0x236,
0x13f,
0x9,
0x287,
0x226,
// 192
0x49,
0x392,
0x156,
0x7e,
0x20,
0x2a9,
0x14b,
0x318,
0x26c,
0x3c,
0x261,
0x1b9,
0xb4,
0x317,
0x37d,
0x2f2,
// 208
0x25d,
0x17f,
0xe4,
0x2ed,
0x2f8,
0xd5,
0x36,
0x129,
0x86,
0x36,
0x342,
0x12b,
0x39a,
0xbf,
0x38e,
0x214,
// 224
0x261,
0x33d,
0xbd,
0x14,
0xa7,
0x1d,
0x368,
0x1c1,
0x53,
0x192,
0x29,
0x290,
0x1f9,
0x243,
0x1e1,
0xad,
// 240
0x194,
0xfb,
0x2b0,
0x5f,
0x1f1,
0x22b,
0x282,
0x21f,
0x133,
0x9f,
0x39c,
0x22e,
0x288,
0x37,
0x1f1,
0xa,
),
// 256
array(
// ECL 8 (512 factors) -----------------------------------------------------------------------------
0x160,
0x4d,
0x175,
0x1f8,
0x23,
0x257,
0x1ac,
0xcf,
0x199,
0x23e,
0x76,
0x1f2,
0x11d,
0x17c,
0x15e,
0x1ec,
// 16
0xc5,
0x109,
0x398,
0x9b,
0x392,
0x12b,
0xe5,
0x283,
0x126,
0x367,
0x132,
0x58,
0x57,
0xc1,
0x160,
0x30d,
// 32
0x34e,
0x4b,
0x147,
0x208,
0x1b3,
0x21f,
0xcb,
0x29a,
0xf9,
0x15a,
0x30d,
0x26d,
0x280,
0x10c,
0x31a,
0x216,
// 48
0x21b,
0x30d,
0x198,
0x186,
0x284,
0x66,
0x1dc,
0x1f3,
0x122,
0x278,
0x221,
0x25,
0x35a,
0x394,
0x228,
0x29,
// 64
0x21e,
0x121,
0x7a,
0x110,
0x17f,
0x320,
0x1e5,
0x62,
0x2f0,
0x1d8,
0x2f9,
0x6b,
0x310,
0x35c,
0x292,
0x2e5,
// 80
0x122,
0xcc,
0x2a9,
0x197,
0x357,
0x55,
0x63,
0x3e,
0x1e2,
0xb4,
0x14,
0x129,
0x1c3,
0x251,
0x391,
0x8e,
// 96
0x328,
0x2ac,
0x11f,
0x218,
0x231,
0x4c,
0x28d,
0x383,
0x2d9,
0x237,
0x2e8,
0x186,
0x201,
0xc0,
0x204,
0x102,
// 112
0xf0,
0x206,
0x31a,
0x18b,
0x300,
0x350,
0x33,
0x262,
0x180,
0xa8,
0xbe,
0x33a,
0x148,
0x254,
0x312,
0x12f,
// 128
0x23a,
0x17d,
0x19f,
0x281,
0x9c,
0xed,
0x97,
0x1ad,
0x213,
0xcf,
0x2a4,
0x2c6,
0x59,
0xa8,
0x130,
0x192,
// 144
0x28,
0x2c4,
0x23f,
0xa2,
0x360,
0xe5,
0x41,
0x35d,
0x349,
0x200,
0xa4,
0x1dd,
0xdd,
0x5c,
0x166,
0x311,
// 160
0x120,
0x165,
0x352,
0x344,
0x33b,
0x2e0,
0x2c3,
0x5e,
0x8,
0x1ee,
0x72,
0x209,
0x2,
0x1f3,
0x353,
0x21f,
// 176
0x98,
0x2d9,
0x303,
0x5f,
0xf8,
0x169,
0x242,
0x143,
0x358,
0x31d,
0x121,
0x33,
0x2ac,
0x1d2,
0x215,
0x334,
// 192
0x29d,
0x2d,
0x386,
0x1c4,
0xa7,
0x156,
0xf4,
0xad,
0x23,
0x1cf,
0x28b,
0x33,
0x2bb,
0x24f,
0x1c4,
0x242,
// 208
0x25,
0x7c,
0x12a,
0x14c,
0x228,
0x2b,
0x1ab,
0x77,
0x296,
0x309,
0x1db,
0x352,
0x2fc,
0x16c,
0x242,
0x38f,
// 224
0x11b,
0x2c7,
0x1d8,
0x1a4,
0xf5,
0x120,
0x252,
0x18a,
0x1ff,
0x147,
0x24d,
0x309,
0x2bb,
0x2b0,
0x2b,
0x198,
// 240
0x34a,
0x17f,
0x2d1,
0x209,
0x230,
0x284,
0x2ca,
0x22f,
0x3e,
0x91,
0x369,
0x297,
0x2c9,
0x9f,
0x2a0,
0x2d9,
// 256
0x270,
0x3b,
0xc1,
0x1a1,
0x9e,
0xd1,
0x233,
0x234,
0x157,
0x2b5,
0x6d,
0x260,
0x233,
0x16d,
0xb5,
0x304,
// 272
0x2a5,
0x136,
0xf8,
0x161,
0x2c4,
0x19a,
0x243,
0x366,
0x269,
0x349,
0x278,
0x35c,
0x121,
0x218,
0x23,
0x309,
// 288
0x26a,
0x24a,
0x1a8,
0x341,
0x4d,
0x255,
0x15a,
0x10d,
0x2f5,
0x278,
0x2b7,
0x2ef,
0x14b,
0xf7,
0xb8,
0x2d,
// 304
0x313,
0x2a8,
0x12,
0x42,
0x197,
0x171,
0x36,
0x1ec,
0xe4,
0x265,
0x33e,
0x39a,
0x1b5,
0x207,
0x284,
0x389,
// 320
0x315,
0x1a4,
0x131,
0x1b9,
0xcf,
0x12c,
0x37c,
0x33b,
0x8d,
0x219,
0x17d,
0x296,
0x201,
0x38,
0xfc,
0x155,
// 336
0xf2,
0x31d,
0x346,
0x345,
0x2d0,
0xe0,
0x133,
0x277,
0x3d,
0x57,
0x230,
0x136,
0x2f4,
0x299,
0x18d,
0x328,
// 352
0x353,
0x135,
0x1d9,
0x31b,
0x17a,
0x1f,
0x287,
0x393,
0x1cb,
0x326,
0x24e,
0x2db,
0x1a9,
0xd8,
0x224,
0xf9,
// 368
0x141,
0x371,
0x2bb,
0x217,
0x2a1,
0x30e,
0xd2,
0x32f,
0x389,
0x12f,
0x34b,
0x39a,
0x119,
0x49,
0x1d5,
0x317,
// 384
0x294,
0xa2,
0x1f2,
0x134,
0x9b,
0x1a6,
0x38b,
0x331,
0xbb,
0x3e,
0x10,
0x1a9,
0x217,
0x150,
0x11e,
0x1b5,
// 400
0x177,
0x111,
0x262,
0x128,
0xb7,
0x39b,
0x74,
0x29b,
0x2ef,
0x161,
0x3e,
0x16e,
0x2b3,
0x17b,
0x2af,
0x34a,
// 416
0x25,
0x165,
0x2d0,
0x2e6,
0x14a,
0x5,
0x27,
0x39b,
0x137,
0x1a8,
0xf2,
0x2ed,
0x141,
0x36,
0x29d,
0x13c,
// 432
0x156,
0x12b,
0x216,
0x69,
0x29b,
0x1e8,
0x280,
0x2a0,
0x240,
0x21c,
0x13c,
0x1e6,
0x2d1,
0x262,
0x2e,
0x290,
// 448
0x1bf,
0xab,
0x268,
0x1d0,
0xbe,
0x213,
0x129,
0x141,
0x2fa,
0x2f0,
0x215,
0xaf,
0x86,
0xe,
0x17d,
0x1b1,
// 464
0x2cd,
0x2d,
0x6f,
0x14,
0x254,
0x11c,
0x2e0,
0x8a,
0x286,
0x19b,
0x36d,
0x29d,
0x8d,
0x397,
0x2d,
0x30c,
// 480
0x197,
0xa4,
0x14c,
0x383,
0xa5,
0x2d6,
0x258,
0x145,
0x1f2,
0x28f,
0x165,
0x2f0,
0x300,
0xdf,
0x351,
0x287,
// 496
0x3f,
0x136,
0x35f,
0xfb,
0x16e,
0x130,
0x11a,
0x2e2,
0x2a3,
0x19a,
0x185,
0xf4,
0x1f,
0x79,
0x12f,
0x107,
),
);
/**
* This is the class constructor.
* Creates a PDF417 object
* @param $code (string) code to represent using PDF417
* @param $ecl (int) error correction level (0-8); default -1 = automatic correction level
* @param $aspectratio (float) the width to height of the symbol (excluding quiet zones)
* @param $macro (array) information for macro block
* @public
*/
public function __construct($code, $ecl = -1, $aspectratio = 2, $macro = array())
{
}
/**
* Returns a barcode array which is readable by TCPDF
* @return array barcode array readable by TCPDF;
* @public
*/
public function getBarcodeArray()
{
}
/**
* Returns the error correction level (0-8) to be used
* @param $ecl (int) error correction level
* @param $numcw (int) number of data codewords
* @return int error correction level
* @protected
*/
protected function getErrorCorrectionLevel($ecl, $numcw)
{
}
/**
* Returns the error correction codewords
* @param $cw (array) array of codewords including Symbol Length Descriptor and pad
* @param $ecl (int) error correction level 0-8
* @return array of error correction codewords
* @protected
*/
protected function getErrorCorrection($cw, $ecl)
{
}
/**
* Create array of sequences from input
* @param $code (string) code
* @return bidimensional array containing characters and classification
* @protected
*/
protected function getInputSequences($code)
{
}
/**
* Compact data by mode.
* @param $mode (int) compaction mode number
* @param $code (string) data to compact
* @param $addmode (boolean) if true add the mode codeword at first position
* @return array of codewords
* @protected
*/
protected function getCompaction($mode, $code, $addmode = \true)
{
}
}
//============================================================+
// File name : tcpdf_images.php
// Version : 1.0.005
// Begin : 2002-08-03
// Last Update : 2014-11-15
// Author : Nicola Asuni - Tecnick.com LTD - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2002-2014 Nicola Asuni - Tecnick.com LTD
//
// This file is part of TCPDF software library.
//
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the License
// along with TCPDF. If not, see
// <http://www.tecnick.com/pagefiles/tcpdf/LICENSE.TXT>.
//
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
//
// Description :
// Static image methods used by the TCPDF class.
//
//============================================================+
/**
* @file
* This is a PHP class that contains static image methods for the TCPDF class.<br>
* @package com.tecnick.tcpdf
* @author Nicola Asuni
* @version 1.0.005
*/
/**
* @class TCPDF_IMAGES
* Static image methods used by the TCPDF class.
* @package com.tecnick.tcpdf
* @brief PHP class for generating PDF documents without requiring external extensions.
* @version 1.0.005
* @author Nicola Asuni - info@tecnick.com
*/
class TCPDF_IMAGES
{
/**
* Array of hinheritable SVG properties.
* @since 5.0.000 (2010-05-02)
* @public static
*/
public static $svginheritprop = array('clip-rule', 'color', 'color-interpolation', 'color-interpolation-filters', 'color-profile', 'color-rendering', 'cursor', 'direction', 'display', 'fill', 'fill-opacity', 'fill-rule', 'font', 'font-family', 'font-size', 'font-size-adjust', 'font-stretch', 'font-style', 'font-variant', 'font-weight', 'glyph-orientation-horizontal', 'glyph-orientation-vertical', 'image-rendering', 'kerning', 'letter-spacing', 'marker', 'marker-end', 'marker-mid', 'marker-start', 'pointer-events', 'shape-rendering', 'stroke', 'stroke-dasharray', 'stroke-dashoffset', 'stroke-linecap', 'stroke-linejoin', 'stroke-miterlimit', 'stroke-opacity', 'stroke-width', 'text-anchor', 'text-rendering', 'visibility', 'word-spacing', 'writing-mode');
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/**
* Return the image type given the file name or array returned by getimagesize() function.
* @param $imgfile (string) image file name
* @param $iminfo (array) array of image information returned by getimagesize() function.
* @return string image type
* @since 4.8.017 (2009-11-27)
* @public static
*/
public static function getImageFileType($imgfile, $iminfo = array())
{
}
/**
* Set the transparency for the given GD image.
* @param $new_image (image) GD image object
* @param $image (image) GD image object.
* return GD image object.
* @since 4.9.016 (2010-04-20)
* @public static
*/
public static function setGDImageTransparency($new_image, $image)
{
}
/**
* Convert the loaded image to a PNG and then return a structure for the PDF creator.
* This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
* @param $image (image) Image object.
* @param $tempfile (string) Temporary file name.
* return image PNG image object.
* @since 4.9.016 (2010-04-20)
* @public static
*/
public static function _toPNG($image, $tempfile)
{
}
/**
* Convert the loaded image to a JPEG and then return a structure for the PDF creator.
* This function requires GD library and write access to the directory defined on K_PATH_CACHE constant.
* @param $image (image) Image object.
* @param $quality (int) JPEG quality.
* @param $tempfile (string) Temporary file name.
* return image JPEG image object.
* @public static
*/
public static function _toJPEG($image, $quality, $tempfile)
{
}
/**
* Extract info from a JPEG file without using the GD library.
* @param $file (string) image file to parse
* @return array structure containing the image data
* @public static
*/
public static function _parsejpeg($file)
{
}
/**
* Extract info from a PNG file without using the GD library.
* @param $file (string) image file to parse
* @return array structure containing the image data
* @public static
*/
public static function _parsepng($file)
{
}
}
//============================================================+
// File name : tcpdf_fonts.php
// Version : 1.1.0
// Begin : 2008-01-01
// Last Update : 2014-12-10
// Author : Nicola Asuni - Tecnick.com LTD - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2008-2014 Nicola Asuni - Tecnick.com LTD
//
// This file is part of TCPDF software library.
//
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with TCPDF. If not, see <http://www.gnu.org/licenses/>.
//
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
//
// Description :Font methods for TCPDF library.
//
//============================================================+
/**
* @file
* Unicode data and font methods for TCPDF library.
* @author Nicola Asuni
* @package com.tecnick.tcpdf
*/
/**
* @class TCPDF_FONTS
* Font methods for TCPDF library.
* @package com.tecnick.tcpdf
* @version 1.1.0
* @author Nicola Asuni - info@tecnick.com
*/
class TCPDF_FONTS
{
/**
* Static cache used for speed up uniord performances
* @protected
*/
protected static $cache_uniord = array();
/**
* Convert and add the selected TrueType or Type1 font to the fonts folder (that must be writeable).
* @param $fontfile (string) Font file (full path).
* @param $fonttype (string) Font type. Leave empty for autodetect mode. Valid values are: TrueTypeUnicode, TrueType, Type1, CID0JP = CID-0 Japanese, CID0KR = CID-0 Korean, CID0CS = CID-0 Chinese Simplified, CID0CT = CID-0 Chinese Traditional.
* @param $enc (string) Name of the encoding table to use. Leave empty for default mode. Omit this parameter for TrueType Unicode and symbolic fonts like Symbol or ZapfDingBats.
* @param $flags (int) Unsigned 32-bit integer containing flags specifying various characteristics of the font (PDF32000:2008 - 9.8.2 Font Descriptor Flags): +1 for fixed font; +4 for symbol or +32 for non-symbol; +64 for italic. Fixed and Italic mode are generally autodetected so you have to set it to 32 = non-symbolic font (default) or 4 = symbolic font.
* @param $outpath (string) Output path for generated font files (must be writeable by the web server). Leave empty for default font folder.
* @param $platid (int) Platform ID for CMAP table to extract (when building a Unicode font for Windows this value should be 3, for Macintosh should be 1).
* @param $encid (int) Encoding ID for CMAP table to extract (when building a Unicode font for Windows this value should be 1, for Macintosh should be 0). When Platform ID is 3, legal values for Encoding ID are: 0=Symbol, 1=Unicode, 2=ShiftJIS, 3=PRC, 4=Big5, 5=Wansung, 6=Johab, 7=Reserved, 8=Reserved, 9=Reserved, 10=UCS-4.
* @param $addcbbox (boolean) If true includes the character bounding box information on the php font file.
* @param $link (boolean) If true link to system font instead of copying the font data (not transportable) - Note: do not work with Type1 fonts.
* @return (string) TCPDF font name or boolean false in case of error.
* @author Nicola Asuni
* @since 5.9.123 (2010-09-30)
* @public static
*/
public static function addTTFfont($fontfile, $fonttype = '', $enc = '', $flags = 32, $outpath = '', $platid = 3, $encid = 1, $addcbbox = \false, $link = \false)
{
}
/**
* Returs the checksum of a TTF table.
* @param $table (string) table to check
* @param $length (int) length of table in bytes
* @return int checksum
* @author Nicola Asuni
* @since 5.2.000 (2010-06-02)
* @public static
*/
public static function _getTTFtableChecksum($table, $length)
{
}
/**
* Returns a subset of the TrueType font data without the unused glyphs.
* @param $font (string) TrueType font data.
* @param $subsetchars (array) Array of used characters (the glyphs to keep).
* @return (string) A subset of TrueType font data without the unused glyphs.
* @author Nicola Asuni
* @since 5.2.000 (2010-06-02)
* @public static
*/
public static function _getTrueTypeFontSubset($font, $subsetchars)
{
}
/**
* Outputs font widths
* @param $font (array) font data
* @param $cidoffset (int) offset for CID values
* @return PDF command string for font widths
* @author Nicola Asuni
* @since 4.4.000 (2008-12-07)
* @public static
*/
public static function _putfontwidths($font, $cidoffset = 0)
{
}
/**
* Update the CIDToGIDMap string with a new value.
* @param $map (string) CIDToGIDMap.
* @param $cid (int) CID value.
* @param $gid (int) GID value.
* @return (string) CIDToGIDMap.
* @author Nicola Asuni
* @since 5.9.123 (2011-09-29)
* @public static
*/
public static function updateCIDtoGIDmap($map, $cid, $gid)
{
}
/**
* Return fonts path
* @return string
* @public static
*/
public static function _getfontpath()
{
}
/**
* Return font full path
* @param $file (string) Font file name.
* @param $fontdir (string) Font directory (set to false fto search on default directories)
* @return string Font full path or empty string
* @author Nicola Asuni
* @since 6.0.025
* @public static
*/
public static function getFontFullPath($file, $fontdir = \false)
{
}
/**
* Get a reference font size.
* @param $size (string) String containing font size value.
* @param $refsize (float) Reference font size in points.
* @return float value in points
* @public static
*/
public static function getFontRefSize($size, $refsize = 12)
{
}
// ====================================================================================================================
// REIMPLEMENTED
// ====================================================================================================================
/**
* Returns the unicode caracter specified by the value
* @param $c (int) UTF-8 value
* @param $unicode (boolean) True if we are in unicode mode, false otherwise.
* @return Returns the specified character.
* @since 2.3.000 (2008-03-05)
* @public static
*/
public static function unichr($c, $unicode = \true)
{
}
/**
* Returns the unicode caracter specified by UTF-8 value
* @param $c (int) UTF-8 value
* @return Returns the specified character.
* @public static
*/
public static function unichrUnicode($c)
{
}
/**
* Returns the unicode caracter specified by ASCII value
* @param $c (int) UTF-8 value
* @return Returns the specified character.
* @public static
*/
public static function unichrASCII($c)
{
}
/**
* Converts array of UTF-8 characters to UTF16-BE string.<br>
* Based on: http://www.faqs.org/rfcs/rfc2781.html
* <pre>
* Encoding UTF-16:
*
* Encoding of a single character from an ISO 10646 character value to
* UTF-16 proceeds as follows. Let U be the character number, no greater
* than 0x10FFFF.
*
* 1) If U < 0x10000, encode U as a 16-bit unsigned integer and
* terminate.
*
* 2) Let U' = U - 0x10000. Because U is less than or equal to 0x10FFFF,
* U' must be less than or equal to 0xFFFFF. That is, U' can be
* represented in 20 bits.
*
* 3) Initialize two 16-bit unsigned integers, W1 and W2, to 0xD800 and
* 0xDC00, respectively. These integers each have 10 bits free to
* encode the character value, for a total of 20 bits.
*
* 4) Assign the 10 high-order bits of the 20-bit U' to the 10 low-order
* bits of W1 and the 10 low-order bits of U' to the 10 low-order
* bits of W2. Terminate.
*
* Graphically, steps 2 through 4 look like:
* U' = yyyyyyyyyyxxxxxxxxxx
* W1 = 110110yyyyyyyyyy
* W2 = 110111xxxxxxxxxx
* </pre>
* @param $unicode (array) array containing UTF-8 unicode values
* @param $setbom (boolean) if true set the Byte Order Mark (BOM = 0xFEFF)
* @return string
* @protected
* @author Nicola Asuni
* @since 2.1.000 (2008-01-08)
* @public static
*/
public static function arrUTF8ToUTF16BE($unicode, $setbom = \false)
{
}
/**
* Convert an array of UTF8 values to array of unicode characters
* @param $ta (array) The input array of UTF8 values.
* @param $isunicode (boolean) True for Unicode mode, false otherwise.
* @return Return array of unicode characters
* @since 4.5.037 (2009-04-07)
* @public static
*/
public static function UTF8ArrayToUniArray($ta, $isunicode = \true)
{
}
/**
* Extract a slice of the $strarr array and return it as string.
* @param $strarr (string) The input array of characters.
* @param $start (int) the starting element of $strarr.
* @param $end (int) first element that will not be returned.
* @param $unicode (boolean) True if we are in unicode mode, false otherwise.
* @return Return part of a string
* @public static
*/
public static function UTF8ArrSubString($strarr, $start = '', $end = '', $unicode = \true)
{
}
/**
* Extract a slice of the $uniarr array and return it as string.
* @param $uniarr (string) The input array of characters.
* @param $start (int) the starting element of $strarr.
* @param $end (int) first element that will not be returned.
* @return Return part of a string
* @since 4.5.037 (2009-04-07)
* @public static
*/
public static function UniArrSubString($uniarr, $start = '', $end = '')
{
}
/**
* Converts UTF-8 characters array to array of Latin1 characters array<br>
* @param $unicode (array) array containing UTF-8 unicode values
* @return array
* @author Nicola Asuni
* @since 4.8.023 (2010-01-15)
* @public static
*/
public static function UTF8ArrToLatin1Arr($unicode)
{
}
/**
* Converts UTF-8 characters array to array of Latin1 string<br>
* @param $unicode (array) array containing UTF-8 unicode values
* @return array
* @author Nicola Asuni
* @since 4.8.023 (2010-01-15)
* @public static
*/
public static function UTF8ArrToLatin1($unicode)
{
}
/**
* Converts UTF-8 character to integer value.<br>
* Uses the getUniord() method if the value is not cached.
* @param $uch (string) character string to process.
* @return integer Unicode value
* @public static
*/
public static function uniord($uch)
{
}
/**
* Converts UTF-8 character to integer value.<br>
* Invalid byte sequences will be replaced with 0xFFFD (replacement character)<br>
* Based on: http://www.faqs.org/rfcs/rfc3629.html
* <pre>
* Char. number range | UTF-8 octet sequence
* (hexadecimal) | (binary)
* --------------------+-----------------------------------------------
* 0000 0000-0000 007F | 0xxxxxxx
* 0000 0080-0000 07FF | 110xxxxx 10xxxxxx
* 0000 0800-0000 FFFF | 1110xxxx 10xxxxxx 10xxxxxx
* 0001 0000-0010 FFFF | 11110xxx 10xxxxxx 10xxxxxx 10xxxxxx
* ---------------------------------------------------------------------
*
* ABFN notation:
* ---------------------------------------------------------------------
* UTF8-octets = *( UTF8-char )
* UTF8-char = UTF8-1 / UTF8-2 / UTF8-3 / UTF8-4
* UTF8-1 = %x00-7F
* UTF8-2 = %xC2-DF UTF8-tail
*
* UTF8-3 = %xE0 %xA0-BF UTF8-tail / %xE1-EC 2( UTF8-tail ) /
* %xED %x80-9F UTF8-tail / %xEE-EF 2( UTF8-tail )
* UTF8-4 = %xF0 %x90-BF 2( UTF8-tail ) / %xF1-F3 3( UTF8-tail ) /
* %xF4 %x80-8F 2( UTF8-tail )
* UTF8-tail = %x80-BF
* ---------------------------------------------------------------------
* </pre>
* @param $uch (string) character string to process.
* @return integer Unicode value
* @author Nicola Asuni
* @public static
*/
public static function getUniord($uch)
{
}
/**
* Converts UTF-8 strings to codepoints array.<br>
* Invalid byte sequences will be replaced with 0xFFFD (replacement character)<br>
* @param $str (string) string to process.
* @param $isunicode (boolean) True when the documetn is in Unicode mode, false otherwise.
* @param $currentfont (array) Reference to current font array.
* @return array containing codepoints (UTF-8 characters values)
* @author Nicola Asuni
* @public static
*/
public static function UTF8StringToArray($str, $isunicode = \true, &$currentfont)
{
}
/**
* Converts UTF-8 strings to Latin1 when using the standard 14 core fonts.<br>
* @param $str (string) string to process.
* @param $isunicode (boolean) True when the documetn is in Unicode mode, false otherwise.
* @param $currentfont (array) Reference to current font array.
* @return string
* @since 3.2.000 (2008-06-23)
* @public static
*/
public static function UTF8ToLatin1($str, $isunicode = \true, &$currentfont)
{
}
/**
* Converts UTF-8 strings to UTF16-BE.<br>
* @param $str (string) string to process.
* @param $setbom (boolean) if true set the Byte Order Mark (BOM = 0xFEFF)
* @param $isunicode (boolean) True when the documetn is in Unicode mode, false otherwise.
* @param $currentfont (array) Reference to current font array.
* @return string
* @author Nicola Asuni
* @since 1.53.0.TC005 (2005-01-05)
* @public static
*/
public static function UTF8ToUTF16BE($str, $setbom = \false, $isunicode = \true, &$currentfont)
{
}
/**
* Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
* @param $str (string) string to manipulate.
* @param $setbom (bool) if true set the Byte Order Mark (BOM = 0xFEFF)
* @param $forcertl (bool) if true forces RTL text direction
* @param $isunicode (boolean) True if the document is in Unicode mode, false otherwise.
* @param $currentfont (array) Reference to current font array.
* @return string
* @author Nicola Asuni
* @since 2.1.000 (2008-01-08)
* @public static
*/
public static function utf8StrRev($str, $setbom = \false, $forcertl = \false, $isunicode = \true, &$currentfont)
{
}
/**
* Reverse the RLT substrings array using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
* @param $arr (array) array of unicode values.
* @param $str (string) string to manipulate (or empty value).
* @param $setbom (bool) if true set the Byte Order Mark (BOM = 0xFEFF)
* @param $forcertl (bool) if true forces RTL text direction
* @param $isunicode (boolean) True if the document is in Unicode mode, false otherwise.
* @param $currentfont (array) Reference to current font array.
* @return string
* @author Nicola Asuni
* @since 4.9.000 (2010-03-27)
* @public static
*/
public static function utf8StrArrRev($arr, $str = '', $setbom = \false, $forcertl = \false, $isunicode = \true, &$currentfont)
{
}
/**
* Reverse the RLT substrings using the Bidirectional Algorithm (http://unicode.org/reports/tr9/).
* @param $ta (array) array of characters composing the string.
* @param $str (string) string to process
* @param $forcertl (bool) if 'R' forces RTL, if 'L' forces LTR
* @param $isunicode (boolean) True if the document is in Unicode mode, false otherwise.
* @param $currentfont (array) Reference to current font array.
* @return array of unicode chars
* @author Nicola Asuni
* @since 2.4.000 (2008-03-06)
* @public static
*/
public static function utf8Bidi($ta, $str = '', $forcertl = \false, $isunicode = \true, &$currentfont)
{
}
}
//============================================================+
// File name : tcpdf_colors.php
// Version : 1.0.004
// Begin : 2002-04-09
// Last Update : 2014-04-25
// Author : Nicola Asuni - Tecnick.com LTD - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2002-2013 Nicola Asuni - Tecnick.com LTD
//
// This file is part of TCPDF software library.
//
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with TCPDF. If not, see <http://www.gnu.org/licenses/>.
//
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
//
// Description : Array of WEB safe colors
//
//============================================================+
/**
* @file
* PHP color class for TCPDF
* @author Nicola Asuni
* @package com.tecnick.tcpdf
*/
/**
* @class TCPDF_COLORS
* PHP color class for TCPDF
* @package com.tecnick.tcpdf
* @version 1.0.004
* @author Nicola Asuni - info@tecnick.com
*/
class TCPDF_COLORS
{
/**
* Array of WEB safe colors
* @public static
*/
public static $webcolor = array('aliceblue' => 'f0f8ff', 'antiquewhite' => 'faebd7', 'aqua' => '00ffff', 'aquamarine' => '7fffd4', 'azure' => 'f0ffff', 'beige' => 'f5f5dc', 'bisque' => 'ffe4c4', 'black' => '000000', 'blanchedalmond' => 'ffebcd', 'blue' => '0000ff', 'blueviolet' => '8a2be2', 'brown' => 'a52a2a', 'burlywood' => 'deb887', 'cadetblue' => '5f9ea0', 'chartreuse' => '7fff00', 'chocolate' => 'd2691e', 'coral' => 'ff7f50', 'cornflowerblue' => '6495ed', 'cornsilk' => 'fff8dc', 'crimson' => 'dc143c', 'cyan' => '00ffff', 'darkblue' => '00008b', 'darkcyan' => '008b8b', 'darkgoldenrod' => 'b8860b', 'dkgray' => 'a9a9a9', 'darkgray' => 'a9a9a9', 'darkgrey' => 'a9a9a9', 'darkgreen' => '006400', 'darkkhaki' => 'bdb76b', 'darkmagenta' => '8b008b', 'darkolivegreen' => '556b2f', 'darkorange' => 'ff8c00', 'darkorchid' => '9932cc', 'darkred' => '8b0000', 'darksalmon' => 'e9967a', 'darkseagreen' => '8fbc8f', 'darkslateblue' => '483d8b', 'darkslategray' => '2f4f4f', 'darkslategrey' => '2f4f4f', 'darkturquoise' => '00ced1', 'darkviolet' => '9400d3', 'deeppink' => 'ff1493', 'deepskyblue' => '00bfff', 'dimgray' => '696969', 'dimgrey' => '696969', 'dodgerblue' => '1e90ff', 'firebrick' => 'b22222', 'floralwhite' => 'fffaf0', 'forestgreen' => '228b22', 'fuchsia' => 'ff00ff', 'gainsboro' => 'dcdcdc', 'ghostwhite' => 'f8f8ff', 'gold' => 'ffd700', 'goldenrod' => 'daa520', 'gray' => '808080', 'grey' => '808080', 'green' => '008000', 'greenyellow' => 'adff2f', 'honeydew' => 'f0fff0', 'hotpink' => 'ff69b4', 'indianred' => 'cd5c5c', 'indigo' => '4b0082', 'ivory' => 'fffff0', 'khaki' => 'f0e68c', 'lavender' => 'e6e6fa', 'lavenderblush' => 'fff0f5', 'lawngreen' => '7cfc00', 'lemonchiffon' => 'fffacd', 'lightblue' => 'add8e6', 'lightcoral' => 'f08080', 'lightcyan' => 'e0ffff', 'lightgoldenrodyellow' => 'fafad2', 'ltgray' => 'd3d3d3', 'lightgray' => 'd3d3d3', 'lightgrey' => 'd3d3d3', 'lightgreen' => '90ee90', 'lightpink' => 'ffb6c1', 'lightsalmon' => 'ffa07a', 'lightseagreen' => '20b2aa', 'lightskyblue' => '87cefa', 'lightslategray' => '778899', 'lightslategrey' => '778899', 'lightsteelblue' => 'b0c4de', 'lightyellow' => 'ffffe0', 'lime' => '00ff00', 'limegreen' => '32cd32', 'linen' => 'faf0e6', 'magenta' => 'ff00ff', 'maroon' => '800000', 'mediumaquamarine' => '66cdaa', 'mediumblue' => '0000cd', 'mediumorchid' => 'ba55d3', 'mediumpurple' => '9370d8', 'mediumseagreen' => '3cb371', 'mediumslateblue' => '7b68ee', 'mediumspringgreen' => '00fa9a', 'mediumturquoise' => '48d1cc', 'mediumvioletred' => 'c71585', 'midnightblue' => '191970', 'mintcream' => 'f5fffa', 'mistyrose' => 'ffe4e1', 'moccasin' => 'ffe4b5', 'navajowhite' => 'ffdead', 'navy' => '000080', 'oldlace' => 'fdf5e6', 'olive' => '808000', 'olivedrab' => '6b8e23', 'orange' => 'ffa500', 'orangered' => 'ff4500', 'orchid' => 'da70d6', 'palegoldenrod' => 'eee8aa', 'palegreen' => '98fb98', 'paleturquoise' => 'afeeee', 'palevioletred' => 'd87093', 'papayawhip' => 'ffefd5', 'peachpuff' => 'ffdab9', 'peru' => 'cd853f', 'pink' => 'ffc0cb', 'plum' => 'dda0dd', 'powderblue' => 'b0e0e6', 'purple' => '800080', 'red' => 'ff0000', 'rosybrown' => 'bc8f8f', 'royalblue' => '4169e1', 'saddlebrown' => '8b4513', 'salmon' => 'fa8072', 'sandybrown' => 'f4a460', 'seagreen' => '2e8b57', 'seashell' => 'fff5ee', 'sienna' => 'a0522d', 'silver' => 'c0c0c0', 'skyblue' => '87ceeb', 'slateblue' => '6a5acd', 'slategray' => '708090', 'slategrey' => '708090', 'snow' => 'fffafa', 'springgreen' => '00ff7f', 'steelblue' => '4682b4', 'tan' => 'd2b48c', 'teal' => '008080', 'thistle' => 'd8bfd8', 'tomato' => 'ff6347', 'turquoise' => '40e0d0', 'violet' => 'ee82ee', 'wheat' => 'f5deb3', 'white' => 'ffffff', 'whitesmoke' => 'f5f5f5', 'yellow' => 'ffff00', 'yellowgreen' => '9acd32');
// end of web colors
/**
* Array of valid JavaScript color names
* @public static
*/
public static $jscolor = array('transparent', 'black', 'white', 'red', 'green', 'blue', 'cyan', 'magenta', 'yellow', 'dkGray', 'gray', 'ltGray');
/**
* Array of Spot colors (C,M,Y,K,name)
* Color keys must be in lowercase and without spaces.
* As long as no open standard for spot colours exists, you have to buy a colour book by one of the colour manufacturers and insert the values and names of spot colours directly.
* Common industry standard spot colors are: ANPA-COLOR, DIC, FOCOLTONE, GCMI, HKS, PANTONE, TOYO, TRUMATCH.
* @public static
*/
public static $spotcolor = array(
// special registration colors
'none' => array(0, 0, 0, 0, 'None'),
'all' => array(100, 100, 100, 100, 'All'),
// standard CMYK colors
'cyan' => array(100, 0, 0, 0, 'Cyan'),
'magenta' => array(0, 100, 0, 0, 'Magenta'),
'yellow' => array(0, 0, 100, 0, 'Yellow'),
'key' => array(0, 0, 0, 100, 'Key'),
// alias
'white' => array(0, 0, 0, 0, 'White'),
'black' => array(0, 0, 0, 100, 'Black'),
// standard RGB colors
'red' => array(0, 100, 100, 0, 'Red'),
'green' => array(100, 0, 100, 0, 'Green'),
'blue' => array(100, 100, 0, 0, 'Blue'),
);
// end of spot colors
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/**
* Return the Spot color array.
* @param $name (string) Name of the spot color.
* @param $spotc (array) Reference to an array of spot colors.
* @return (array) Spot color array or false if not defined.
* @since 5.9.125 (2011-10-03)
* @public static
*/
public static function getSpotColor($name, &$spotc)
{
}
/**
* Returns an array (RGB or CMYK) from an html color name, or a six-digit (i.e. #3FE5AA), or three-digit (i.e. #7FF) hexadecimal color, or a javascript color array, or javascript color name.
* @param $hcolor (string) HTML color.
* @param $spotc (array) Reference to an array of spot colors.
* @param $defcol (array) Color to return in case of error.
* @return array RGB or CMYK color, or false in case of error.
* @public static
*/
public static function convertHTMLColorToDec($hcolor, &$spotc, $defcol = array('R' => 128, 'G' => 128, 'B' => 128))
{
}
/**
* Convert a color array into a string representation.
* @param $c (array) Array of colors.
* @return (string) The color array representation.
* @since 5.9.137 (2011-12-01)
* @public static
*/
public static function getColorStringFromArray($c)
{
}
/**
* Convert color to javascript color.
* @param $color (string) color name or "#RRGGBB"
* @protected
* @since 2.1.002 (2008-02-12)
* @public static
*/
public static function _JScolor($color)
{
}
}
//============================================================+
// File name : tcpdf_filters.php
// Version : 1.0.001
// Begin : 2011-05-23
// Last Update : 2014-04-25
// Author : Nicola Asuni - Tecnick.com LTD - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2011-2013 Nicola Asuni - Tecnick.com LTD
//
// This file is part of TCPDF software library.
//
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the License
// along with TCPDF. If not, see
// <http://www.tecnick.com/pagefiles/tcpdf/LICENSE.TXT>.
//
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
//
// Description : This is a PHP class for decoding common PDF filters (PDF 32000-2008 - 7.4 Filters).
//
//============================================================+
/**
* @file
* This is a PHP class for decoding common PDF filters (PDF 32000-2008 - 7.4 Filters).<br>
* @package com.tecnick.tcpdf
* @author Nicola Asuni
* @version 1.0.001
*/
/**
* @class TCPDF_FILTERS
* This is a PHP class for decoding common PDF filters (PDF 32000-2008 - 7.4 Filters).<br>
* @package com.tecnick.tcpdf
* @brief This is a PHP class for decoding common PDF filters.
* @version 1.0.001
* @author Nicola Asuni - info@tecnick.com
*/
class TCPDF_FILTERS
{
// -----------------------------------------------------------------------------
/**
* Get a list of available decoding filters.
* @return (array) Array of available filter decoders.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function getAvailableFilters()
{
}
/**
* Decode data using the specified filter type.
* @param $filter (string) Filter name.
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilter($filter, $data)
{
}
// --- FILTERS (PDF 32000-2008 - 7.4 Filters) ------------------------------
/**
* Standard
* Default decoding filter (leaves data unchanged).
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterStandard($data)
{
}
/**
* ASCIIHexDecode
* Decodes data encoded in an ASCII hexadecimal representation, reproducing the original binary data.
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterASCIIHexDecode($data)
{
}
/**
* ASCII85Decode
* Decodes data encoded in an ASCII base-85 representation, reproducing the original binary data.
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterASCII85Decode($data)
{
}
/**
* LZWDecode
* Decompresses data encoded using the LZW (Lempel-Ziv-Welch) adaptive compression method, reproducing the original text or binary data.
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterLZWDecode($data)
{
}
/**
* FlateDecode
* Decompresses data encoded using the zlib/deflate compression method, reproducing the original text or binary data.
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterFlateDecode($data)
{
}
/**
* RunLengthDecode
* Decompresses data encoded using a byte-oriented run-length encoding algorithm.
* @param $data (string) Data to decode.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterRunLengthDecode($data)
{
}
/**
* CCITTFaxDecode (NOT IMPLEMETED - RETURN AN EXCEPTION)
* Decompresses data encoded using the CCITT facsimile standard, reproducing the original data (typically monochrome image data at 1 bit per pixel).
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterCCITTFaxDecode($data)
{
}
/**
* JBIG2Decode (NOT IMPLEMETED - RETURN AN EXCEPTION)
* Decompresses data encoded using the JBIG2 standard, reproducing the original monochrome (1 bit per pixel) image data (or an approximation of that data).
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterJBIG2Decode($data)
{
}
/**
* DCTDecode (NOT IMPLEMETED - RETURN AN EXCEPTION)
* Decompresses data encoded using a DCT (discrete cosine transform) technique based on the JPEG standard, reproducing image sample data that approximates the original data.
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterDCTDecode($data)
{
}
/**
* JPXDecode (NOT IMPLEMETED - RETURN AN EXCEPTION)
* Decompresses data encoded using the wavelet-based JPEG2000 standard, reproducing the original image data.
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterJPXDecode($data)
{
}
/**
* Crypt (NOT IMPLEMETED - RETURN AN EXCEPTION)
* Decrypts data encrypted by a security handler, reproducing the data as it was before encryption.
* @param $data (string) Data to decode.
* @return Decoded data string.
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function decodeFilterCrypt($data)
{
}
// --- END FILTERS SECTION -------------------------------------------------
/**
* Throw an exception.
* @param $msg (string) The error message
* @since 1.0.000 (2011-05-23)
* @public static
*/
public static function Error($msg)
{
}
}
//============================================================+
// File name : tcpdf_font_data.php
// Version : 1.0.001
// Begin : 2008-01-01
// Last Update : 2013-04-01
// Author : Nicola Asuni - Tecnick.com LTD - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2008-2013 Nicola Asuni - Tecnick.com LTD
//
// This file is part of TCPDF software library.
//
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with TCPDF. If not, see <http://www.gnu.org/licenses/>.
//
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
//
// Description : Unicode data and encoding maps for TCPDF.
//
//============================================================+
/**
* @file
* Unicode data and encoding maps for TCPDF.
* @author Nicola Asuni
* @package com.tecnick.tcpdf
*/
/**
* @class TCPDF_FONT_DATA
* Unicode data and encoding maps for TCPDF.
* @package com.tecnick.tcpdf
* @version 1.0.001
* @author Nicola Asuni - info@tecnick.com
*/
class TCPDF_FONT_DATA
{
/**
* Unicode code for Left-to-Right Mark.
* @public
*/
public static $uni_LRM = 8206;
/**
* Unicode code for Right-to-Left Mark.
* @public
*/
public static $uni_RLM = 8207;
/**
* Unicode code for Left-to-Right Embedding.
* @public
*/
public static $uni_LRE = 8234;
/**
* Unicode code for Right-to-Left Embedding.
* @public
*/
public static $uni_RLE = 8235;
/**
* Unicode code for Pop Directional Format.
* @public
*/
public static $uni_PDF = 8236;
/**
* Unicode code for Left-to-Right Override.
* @public
*/
public static $uni_LRO = 8237;
/**
* Unicode code for Right-to-Left Override.
* @public
*/
public static $uni_RLO = 8238;
/**
* Pattern to test RTL (Righ-To-Left) strings using regular expressions.
* @public
*/
public static $uni_RE_PATTERN_RTL = "/(\n\t ־ # R\n\t| \xd7[\x80\x83\x86\x90-\xaa\xb0-\xb4] # R\n\t| \xdf[\x80-\xaa\xb4\xb5\xba] # R\n\t| # R\n\t| \xef\xac[\x9d\x9f\xa0-\xa8\xaa-\xb6\xb8-\xbc\xbe] # R\n\t| \xef\xad[\x80\x81\x83\x84\x86-\x8f] # R\n\t| \xf0\x90\xa0[\x80-\x85\x88\x8a-\xb5\xb7\xb8\xbc\xbf] # R\n\t| \xf0\x90\xa4[\x80-\x99] # R\n\t| \xf0\x90\xa8[\x80\x90-\x93\x95-\x97\x99-\xb3] # R\n\t| \xf0\x90\xa9[\x80-\x87\x90-\x98] # R\n\t| \xe2\x80[\xab\xae] # RLE & RLO\n\t)/x";
/**
* Pattern to test Arabic strings using regular expressions. Source: http://www.w3.org/International/questions/qa-forms-utf-8
* @public
*/
public static $uni_RE_PATTERN_ARABIC = "/(\n\t\t \xd8[\x80-\x83\x8b\x8d\x9b\x9e\x9f\xa1-\xba] # AL\n\t\t| \xd9[\x80-\x8a\xad-\xaf\xb1-\xbf] # AL\n\t\t| \xda[\x80-\xbf] # AL\n\t\t| \xdb[\x80-\x95\x9d\xa5\xa6\xae\xaf\xba-\xbf] # AL\n\t\t| \xdc[\x80-\x8d\x90\x92-\xaf] # AL\n\t\t| \xdd[\x8d-\xad] # AL\n\t\t| \xde[\x80-\xa5\xb1] # AL\n\t\t| \xef\xad[\x90-\xbf] # AL\n\t\t| \xef\xae[\x80-\xb1] # AL\n\t\t| \xef\xaf[\x93-\xbf] # AL\n\t\t| \xef[\xb0-\xb3][\x80-\xbf] # AL\n\t\t| \xef\xb4[\x80-\xbd] # AL\n\t\t| \xef\xb5[\x90-\xbf] # AL\n\t\t| \xef\xb6[\x80-\x8f\x92-\xbf] # AL\n\t\t| \xef\xb7[\x80-\x87\xb0-\xbc] # AL\n\t\t| \xef\xb9[\xb0-\xb4\xb6-\xbf] # AL\n\t\t| \xef\xba[\x80-\xbf] # AL\n\t\t| \xef\xbb[\x80-\xbc] # AL\n\t\t| \xd9[\xa0-\xa9\xab\xac] # AN\n\t\t)/x";
/**
* Array of Unicode types.
* @public
*/
public static $uni_type = array(0 => 'BN', 1 => 'BN', 2 => 'BN', 3 => 'BN', 4 => 'BN', 5 => 'BN', 6 => 'BN', 7 => 'BN', 8 => 'BN', 9 => 'S', 10 => 'B', 11 => 'S', 12 => 'WS', 13 => 'B', 14 => 'BN', 15 => 'BN', 16 => 'BN', 17 => 'BN', 18 => 'BN', 19 => 'BN', 20 => 'BN', 21 => 'BN', 22 => 'BN', 23 => 'BN', 24 => 'BN', 25 => 'BN', 26 => 'BN', 27 => 'BN', 28 => 'B', 29 => 'B', 30 => 'B', 31 => 'S', 32 => 'WS', 33 => 'ON', 34 => 'ON', 35 => 'ET', 36 => 'ET', 37 => 'ET', 38 => 'ON', 39 => 'ON', 40 => 'ON', 41 => 'ON', 42 => 'ON', 43 => 'ES', 44 => 'CS', 45 => 'ES', 46 => 'CS', 47 => 'CS', 48 => 'EN', 49 => 'EN', 50 => 'EN', 51 => 'EN', 52 => 'EN', 53 => 'EN', 54 => 'EN', 55 => 'EN', 56 => 'EN', 57 => 'EN', 58 => 'CS', 59 => 'ON', 60 => 'ON', 61 => 'ON', 62 => 'ON', 63 => 'ON', 64 => 'ON', 65 => 'L', 66 => 'L', 67 => 'L', 68 => 'L', 69 => 'L', 70 => 'L', 71 => 'L', 72 => 'L', 73 => 'L', 74 => 'L', 75 => 'L', 76 => 'L', 77 => 'L', 78 => 'L', 79 => 'L', 80 => 'L', 81 => 'L', 82 => 'L', 83 => 'L', 84 => 'L', 85 => 'L', 86 => 'L', 87 => 'L', 88 => 'L', 89 => 'L', 90 => 'L', 91 => 'ON', 92 => 'ON', 93 => 'ON', 94 => 'ON', 95 => 'ON', 96 => 'ON', 97 => 'L', 98 => 'L', 99 => 'L', 100 => 'L', 101 => 'L', 102 => 'L', 103 => 'L', 104 => 'L', 105 => 'L', 106 => 'L', 107 => 'L', 108 => 'L', 109 => 'L', 110 => 'L', 111 => 'L', 112 => 'L', 113 => 'L', 114 => 'L', 115 => 'L', 116 => 'L', 117 => 'L', 118 => 'L', 119 => 'L', 120 => 'L', 121 => 'L', 122 => 'L', 123 => 'ON', 124 => 'ON', 125 => 'ON', 126 => 'ON', 127 => 'BN', 128 => 'BN', 129 => 'BN', 130 => 'BN', 131 => 'BN', 132 => 'BN', 133 => 'B', 134 => 'BN', 135 => 'BN', 136 => 'BN', 137 => 'BN', 138 => 'BN', 139 => 'BN', 140 => 'BN', 141 => 'BN', 142 => 'BN', 143 => 'BN', 144 => 'BN', 145 => 'BN', 146 => 'BN', 147 => 'BN', 148 => 'BN', 149 => 'BN', 150 => 'BN', 151 => 'BN', 152 => 'BN', 153 => 'BN', 154 => 'BN', 155 => 'BN', 156 => 'BN', 157 => 'BN', 158 => 'BN', 159 => 'BN', 160 => 'CS', 161 => 'ON', 162 => 'ET', 163 => 'ET', 164 => 'ET', 165 => 'ET', 166 => 'ON', 167 => 'ON', 168 => 'ON', 169 => 'ON', 170 => 'L', 171 => 'ON', 172 => 'ON', 173 => 'BN', 174 => 'ON', 175 => 'ON', 176 => 'ET', 177 => 'ET', 178 => 'EN', 179 => 'EN', 180 => 'ON', 181 => 'L', 182 => 'ON', 183 => 'ON', 184 => 'ON', 185 => 'EN', 186 => 'L', 187 => 'ON', 188 => 'ON', 189 => 'ON', 190 => 'ON', 191 => 'ON', 192 => 'L', 193 => 'L', 194 => 'L', 195 => 'L', 196 => 'L', 197 => 'L', 198 => 'L', 199 => 'L', 200 => 'L', 201 => 'L', 202 => 'L', 203 => 'L', 204 => 'L', 205 => 'L', 206 => 'L', 207 => 'L', 208 => 'L', 209 => 'L', 210 => 'L', 211 => 'L', 212 => 'L', 213 => 'L', 214 => 'L', 215 => 'ON', 216 => 'L', 217 => 'L', 218 => 'L', 219 => 'L', 220 => 'L', 221 => 'L', 222 => 'L', 223 => 'L', 224 => 'L', 225 => 'L', 226 => 'L', 227 => 'L', 228 => 'L', 229 => 'L', 230 => 'L', 231 => 'L', 232 => 'L', 233 => 'L', 234 => 'L', 235 => 'L', 236 => 'L', 237 => 'L', 238 => 'L', 239 => 'L', 240 => 'L', 241 => 'L', 242 => 'L', 243 => 'L', 244 => 'L', 245 => 'L', 246 => 'L', 247 => 'ON', 248 => 'L', 249 => 'L', 250 => 'L', 251 => 'L', 252 => 'L', 253 => 'L', 254 => 'L', 255 => 'L', 256 => 'L', 257 => 'L', 258 => 'L', 259 => 'L', 260 => 'L', 261 => 'L', 262 => 'L', 263 => 'L', 264 => 'L', 265 => 'L', 266 => 'L', 267 => 'L', 268 => 'L', 269 => 'L', 270 => 'L', 271 => 'L', 272 => 'L', 273 => 'L', 274 => 'L', 275 => 'L', 276 => 'L', 277 => 'L', 278 => 'L', 279 => 'L', 280 => 'L', 281 => 'L', 282 => 'L', 283 => 'L', 284 => 'L', 285 => 'L', 286 => 'L', 287 => 'L', 288 => 'L', 289 => 'L', 290 => 'L', 291 => 'L', 292 => 'L', 293 => 'L', 294 => 'L', 295 => 'L', 296 => 'L', 297 => 'L', 298 => 'L', 299 => 'L', 300 => 'L', 301 => 'L', 302 => 'L', 303 => 'L', 304 => 'L', 305 => 'L', 306 => 'L', 307 => 'L', 308 => 'L', 309 => 'L', 310 => 'L', 311 => 'L', 312 => 'L', 313 => 'L', 314 => 'L', 315 => 'L', 316 => 'L', 317 => 'L', 318 => 'L', 319 => 'L', 320 => 'L', 321 => 'L', 322 => 'L', 323 => 'L', 324 => 'L', 325 => 'L', 326 => 'L', 327 => 'L', 328 => 'L', 329 => 'L', 330 => 'L', 331 => 'L', 332 => 'L', 333 => 'L', 334 => 'L', 335 => 'L', 336 => 'L', 337 => 'L', 338 => 'L', 339 => 'L', 340 => 'L', 341 => 'L', 342 => 'L', 343 => 'L', 344 => 'L', 345 => 'L', 346 => 'L', 347 => 'L', 348 => 'L', 349 => 'L', 350 => 'L', 351 => 'L', 352 => 'L', 353 => 'L', 354 => 'L', 355 => 'L', 356 => 'L', 357 => 'L', 358 => 'L', 359 => 'L', 360 => 'L', 361 => 'L', 362 => 'L', 363 => 'L', 364 => 'L', 365 => 'L', 366 => 'L', 367 => 'L', 368 => 'L', 369 => 'L', 370 => 'L', 371 => 'L', 372 => 'L', 373 => 'L', 374 => 'L', 375 => 'L', 376 => 'L', 377 => 'L', 378 => 'L', 379 => 'L', 380 => 'L', 381 => 'L', 382 => 'L', 383 => 'L', 384 => 'L', 385 => 'L', 386 => 'L', 387 => 'L', 388 => 'L', 389 => 'L', 390 => 'L', 391 => 'L', 392 => 'L', 393 => 'L', 394 => 'L', 395 => 'L', 396 => 'L', 397 => 'L', 398 => 'L', 399 => 'L', 400 => 'L', 401 => 'L', 402 => 'L', 403 => 'L', 404 => 'L', 405 => 'L', 406 => 'L', 407 => 'L', 408 => 'L', 409 => 'L', 410 => 'L', 411 => 'L', 412 => 'L', 413 => 'L', 414 => 'L', 415 => 'L', 416 => 'L', 417 => 'L', 418 => 'L', 419 => 'L', 420 => 'L', 421 => 'L', 422 => 'L', 423 => 'L', 424 => 'L', 425 => 'L', 426 => 'L', 427 => 'L', 428 => 'L', 429 => 'L', 430 => 'L', 431 => 'L', 432 => 'L', 433 => 'L', 434 => 'L', 435 => 'L', 436 => 'L', 437 => 'L', 438 => 'L', 439 => 'L', 440 => 'L', 441 => 'L', 442 => 'L', 443 => 'L', 444 => 'L', 445 => 'L', 446 => 'L', 447 => 'L', 448 => 'L', 449 => 'L', 450 => 'L', 451 => 'L', 452 => 'L', 453 => 'L', 454 => 'L', 455 => 'L', 456 => 'L', 457 => 'L', 458 => 'L', 459 => 'L', 460 => 'L', 461 => 'L', 462 => 'L', 463 => 'L', 464 => 'L', 465 => 'L', 466 => 'L', 467 => 'L', 468 => 'L', 469 => 'L', 470 => 'L', 471 => 'L', 472 => 'L', 473 => 'L', 474 => 'L', 475 => 'L', 476 => 'L', 477 => 'L', 478 => 'L', 479 => 'L', 480 => 'L', 481 => 'L', 482 => 'L', 483 => 'L', 484 => 'L', 485 => 'L', 486 => 'L', 487 => 'L', 488 => 'L', 489 => 'L', 490 => 'L', 491 => 'L', 492 => 'L', 493 => 'L', 494 => 'L', 495 => 'L', 496 => 'L', 497 => 'L', 498 => 'L', 499 => 'L', 500 => 'L', 501 => 'L', 502 => 'L', 503 => 'L', 504 => 'L', 505 => 'L', 506 => 'L', 507 => 'L', 508 => 'L', 509 => 'L', 510 => 'L', 511 => 'L', 512 => 'L', 513 => 'L', 514 => 'L', 515 => 'L', 516 => 'L', 517 => 'L', 518 => 'L', 519 => 'L', 520 => 'L', 521 => 'L', 522 => 'L', 523 => 'L', 524 => 'L', 525 => 'L', 526 => 'L', 527 => 'L', 528 => 'L', 529 => 'L', 530 => 'L', 531 => 'L', 532 => 'L', 533 => 'L', 534 => 'L', 535 => 'L', 536 => 'L', 537 => 'L', 538 => 'L', 539 => 'L', 540 => 'L', 541 => 'L', 542 => 'L', 543 => 'L', 544 => 'L', 545 => 'L', 546 => 'L', 547 => 'L', 548 => 'L', 549 => 'L', 550 => 'L', 551 => 'L', 552 => 'L', 553 => 'L', 554 => 'L', 555 => 'L', 556 => 'L', 557 => 'L', 558 => 'L', 559 => 'L', 560 => 'L', 561 => 'L', 562 => 'L', 563 => 'L', 564 => 'L', 565 => 'L', 566 => 'L', 567 => 'L', 568 => 'L', 569 => 'L', 570 => 'L', 571 => 'L', 572 => 'L', 573 => 'L', 574 => 'L', 575 => 'L', 576 => 'L', 577 => 'L', 578 => 'L', 579 => 'L', 580 => 'L', 581 => 'L', 582 => 'L', 583 => 'L', 584 => 'L', 585 => 'L', 586 => 'L', 587 => 'L', 588 => 'L', 589 => 'L', 590 => 'L', 591 => 'L', 592 => 'L', 593 => 'L', 594 => 'L', 595 => 'L', 596 => 'L', 597 => 'L', 598 => 'L', 599 => 'L', 600 => 'L', 601 => 'L', 602 => 'L', 603 => 'L', 604 => 'L', 605 => 'L', 606 => 'L', 607 => 'L', 608 => 'L', 609 => 'L', 610 => 'L', 611 => 'L', 612 => 'L', 613 => 'L', 614 => 'L', 615 => 'L', 616 => 'L', 617 => 'L', 618 => 'L', 619 => 'L', 620 => 'L', 621 => 'L', 622 => 'L', 623 => 'L', 624 => 'L', 625 => 'L', 626 => 'L', 627 => 'L', 628 => 'L', 629 => 'L', 630 => 'L', 631 => 'L', 632 => 'L', 633 => 'L', 634 => 'L', 635 => 'L', 636 => 'L', 637 => 'L', 638 => 'L', 639 => 'L', 640 => 'L', 641 => 'L', 642 => 'L', 643 => 'L', 644 => 'L', 645 => 'L', 646 => 'L', 647 => 'L', 648 => 'L', 649 => 'L', 650 => 'L', 651 => 'L', 652 => 'L', 653 => 'L', 654 => 'L', 655 => 'L', 656 => 'L', 657 => 'L', 658 => 'L', 659 => 'L', 660 => 'L', 661 => 'L', 662 => 'L', 663 => 'L', 664 => 'L', 665 => 'L', 666 => 'L', 667 => 'L', 668 => 'L', 669 => 'L', 670 => 'L', 671 => 'L', 672 => 'L', 673 => 'L', 674 => 'L', 675 => 'L', 676 => 'L', 677 => 'L', 678 => 'L', 679 => 'L', 680 => 'L', 681 => 'L', 682 => 'L', 683 => 'L', 684 => 'L', 685 => 'L', 686 => 'L', 687 => 'L', 688 => 'L', 689 => 'L', 690 => 'L', 691 => 'L', 692 => 'L', 693 => 'L', 694 => 'L', 695 => 'L', 696 => 'L', 697 => 'ON', 698 => 'ON', 699 => 'L', 700 => 'L', 701 => 'L', 702 => 'L', 703 => 'L', 704 => 'L', 705 => 'L', 706 => 'ON', 707 => 'ON', 708 => 'ON', 709 => 'ON', 710 => 'ON', 711 => 'ON', 712 => 'ON', 713 => 'ON', 714 => 'ON', 715 => 'ON', 716 => 'ON', 717 => 'ON', 718 => 'ON', 719 => 'ON', 720 => 'L', 721 => 'L', 722 => 'ON', 723 => 'ON', 724 => 'ON', 725 => 'ON', 726 => 'ON', 727 => 'ON', 728 => 'ON', 729 => 'ON', 730 => 'ON', 731 => 'ON', 732 => 'ON', 733 => 'ON', 734 => 'ON', 735 => 'ON', 736 => 'L', 737 => 'L', 738 => 'L', 739 => 'L', 740 => 'L', 741 => 'ON', 742 => 'ON', 743 => 'ON', 744 => 'ON', 745 => 'ON', 746 => 'ON', 747 => 'ON', 748 => 'ON', 749 => 'ON', 750 => 'L', 751 => 'ON', 752 => 'ON', 753 => 'ON', 754 => 'ON', 755 => 'ON', 756 => 'ON', 757 => 'ON', 758 => 'ON', 759 => 'ON', 760 => 'ON', 761 => 'ON', 762 => 'ON', 763 => 'ON', 764 => 'ON', 765 => 'ON', 766 => 'ON', 767 => 'ON', 768 => 'NSM', 769 => 'NSM', 770 => 'NSM', 771 => 'NSM', 772 => 'NSM', 773 => 'NSM', 774 => 'NSM', 775 => 'NSM', 776 => 'NSM', 777 => 'NSM', 778 => 'NSM', 779 => 'NSM', 780 => 'NSM', 781 => 'NSM', 782 => 'NSM', 783 => 'NSM', 784 => 'NSM', 785 => 'NSM', 786 => 'NSM', 787 => 'NSM', 788 => 'NSM', 789 => 'NSM', 790 => 'NSM', 791 => 'NSM', 792 => 'NSM', 793 => 'NSM', 794 => 'NSM', 795 => 'NSM', 796 => 'NSM', 797 => 'NSM', 798 => 'NSM', 799 => 'NSM', 800 => 'NSM', 801 => 'NSM', 802 => 'NSM', 803 => 'NSM', 804 => 'NSM', 805 => 'NSM', 806 => 'NSM', 807 => 'NSM', 808 => 'NSM', 809 => 'NSM', 810 => 'NSM', 811 => 'NSM', 812 => 'NSM', 813 => 'NSM', 814 => 'NSM', 815 => 'NSM', 816 => 'NSM', 817 => 'NSM', 818 => 'NSM', 819 => 'NSM', 820 => 'NSM', 821 => 'NSM', 822 => 'NSM', 823 => 'NSM', 824 => 'NSM', 825 => 'NSM', 826 => 'NSM', 827 => 'NSM', 828 => 'NSM', 829 => 'NSM', 830 => 'NSM', 831 => 'NSM', 832 => 'NSM', 833 => 'NSM', 834 => 'NSM', 835 => 'NSM', 836 => 'NSM', 837 => 'NSM', 838 => 'NSM', 839 => 'NSM', 840 => 'NSM', 841 => 'NSM', 842 => 'NSM', 843 => 'NSM', 844 => 'NSM', 845 => 'NSM', 846 => 'NSM', 847 => 'NSM', 848 => 'NSM', 849 => 'NSM', 850 => 'NSM', 851 => 'NSM', 852 => 'NSM', 853 => 'NSM', 854 => 'NSM', 855 => 'NSM', 856 => 'NSM', 857 => 'NSM', 858 => 'NSM', 859 => 'NSM', 860 => 'NSM', 861 => 'NSM', 862 => 'NSM', 863 => 'NSM', 864 => 'NSM', 865 => 'NSM', 866 => 'NSM', 867 => 'NSM', 868 => 'NSM', 869 => 'NSM', 870 => 'NSM', 871 => 'NSM', 872 => 'NSM', 873 => 'NSM', 874 => 'NSM', 875 => 'NSM', 876 => 'NSM', 877 => 'NSM', 878 => 'NSM', 879 => 'NSM', 884 => 'ON', 885 => 'ON', 890 => 'L', 891 => 'L', 892 => 'L', 893 => 'L', 894 => 'ON', 900 => 'ON', 901 => 'ON', 902 => 'L', 903 => 'ON', 904 => 'L', 905 => 'L', 906 => 'L', 908 => 'L', 910 => 'L', 911 => 'L', 912 => 'L', 913 => 'L', 914 => 'L', 915 => 'L', 916 => 'L', 917 => 'L', 918 => 'L', 919 => 'L', 920 => 'L', 921 => 'L', 922 => 'L', 923 => 'L', 924 => 'L', 925 => 'L', 926 => 'L', 927 => 'L', 928 => 'L', 929 => 'L', 931 => 'L', 932 => 'L', 933 => 'L', 934 => 'L', 935 => 'L', 936 => 'L', 937 => 'L', 938 => 'L', 939 => 'L', 940 => 'L', 941 => 'L', 942 => 'L', 943 => 'L', 944 => 'L', 945 => 'L', 946 => 'L', 947 => 'L', 948 => 'L', 949 => 'L', 950 => 'L', 951 => 'L', 952 => 'L', 953 => 'L', 954 => 'L', 955 => 'L', 956 => 'L', 957 => 'L', 958 => 'L', 959 => 'L', 960 => 'L', 961 => 'L', 962 => 'L', 963 => 'L', 964 => 'L', 965 => 'L', 966 => 'L', 967 => 'L', 968 => 'L', 969 => 'L', 970 => 'L', 971 => 'L', 972 => 'L', 973 => 'L', 974 => 'L', 976 => 'L', 977 => 'L', 978 => 'L', 979 => 'L', 980 => 'L', 981 => 'L', 982 => 'L', 983 => 'L', 984 => 'L', 985 => 'L', 986 => 'L', 987 => 'L', 988 => 'L', 989 => 'L', 990 => 'L', 991 => 'L', 992 => 'L', 993 => 'L', 994 => 'L', 995 => 'L', 996 => 'L', 997 => 'L', 998 => 'L', 999 => 'L', 1000 => 'L', 1001 => 'L', 1002 => 'L', 1003 => 'L', 1004 => 'L', 1005 => 'L', 1006 => 'L', 1007 => 'L', 1008 => 'L', 1009 => 'L', 1010 => 'L', 1011 => 'L', 1012 => 'L', 1013 => 'L', 1014 => 'ON', 1015 => 'L', 1016 => 'L', 1017 => 'L', 1018 => 'L', 1019 => 'L', 1020 => 'L', 1021 => 'L', 1022 => 'L', 1023 => 'L', 1024 => 'L', 1025 => 'L', 1026 => 'L', 1027 => 'L', 1028 => 'L', 1029 => 'L', 1030 => 'L', 1031 => 'L', 1032 => 'L', 1033 => 'L', 1034 => 'L', 1035 => 'L', 1036 => 'L', 1037 => 'L', 1038 => 'L', 1039 => 'L', 1040 => 'L', 1041 => 'L', 1042 => 'L', 1043 => 'L', 1044 => 'L', 1045 => 'L', 1046 => 'L', 1047 => 'L', 1048 => 'L', 1049 => 'L', 1050 => 'L', 1051 => 'L', 1052 => 'L', 1053 => 'L', 1054 => 'L', 1055 => 'L', 1056 => 'L', 1057 => 'L', 1058 => 'L', 1059 => 'L', 1060 => 'L', 1061 => 'L', 1062 => 'L', 1063 => 'L', 1064 => 'L', 1065 => 'L', 1066 => 'L', 1067 => 'L', 1068 => 'L', 1069 => 'L', 1070 => 'L', 1071 => 'L', 1072 => 'L', 1073 => 'L', 1074 => 'L', 1075 => 'L', 1076 => 'L', 1077 => 'L', 1078 => 'L', 1079 => 'L', 1080 => 'L', 1081 => 'L', 1082 => 'L', 1083 => 'L', 1084 => 'L', 1085 => 'L', 1086 => 'L', 1087 => 'L', 1088 => 'L', 1089 => 'L', 1090 => 'L', 1091 => 'L', 1092 => 'L', 1093 => 'L', 1094 => 'L', 1095 => 'L', 1096 => 'L', 1097 => 'L', 1098 => 'L', 1099 => 'L', 1100 => 'L', 1101 => 'L', 1102 => 'L', 1103 => 'L', 1104 => 'L', 1105 => 'L', 1106 => 'L', 1107 => 'L', 1108 => 'L', 1109 => 'L', 1110 => 'L', 1111 => 'L', 1112 => 'L', 1113 => 'L', 1114 => 'L', 1115 => 'L', 1116 => 'L', 1117 => 'L', 1118 => 'L', 1119 => 'L', 1120 => 'L', 1121 => 'L', 1122 => 'L', 1123 => 'L', 1124 => 'L', 1125 => 'L', 1126 => 'L', 1127 => 'L', 1128 => 'L', 1129 => 'L', 1130 => 'L', 1131 => 'L', 1132 => 'L', 1133 => 'L', 1134 => 'L', 1135 => 'L', 1136 => 'L', 1137 => 'L', 1138 => 'L', 1139 => 'L', 1140 => 'L', 1141 => 'L', 1142 => 'L', 1143 => 'L', 1144 => 'L', 1145 => 'L', 1146 => 'L', 1147 => 'L', 1148 => 'L', 1149 => 'L', 1150 => 'L', 1151 => 'L', 1152 => 'L', 1153 => 'L', 1154 => 'L', 1155 => 'NSM', 1156 => 'NSM', 1157 => 'NSM', 1158 => 'NSM', 1160 => 'NSM', 1161 => 'NSM', 1162 => 'L', 1163 => 'L', 1164 => 'L', 1165 => 'L', 1166 => 'L', 1167 => 'L', 1168 => 'L', 1169 => 'L', 1170 => 'L', 1171 => 'L', 1172 => 'L', 1173 => 'L', 1174 => 'L', 1175 => 'L', 1176 => 'L', 1177 => 'L', 1178 => 'L', 1179 => 'L', 1180 => 'L', 1181 => 'L', 1182 => 'L', 1183 => 'L', 1184 => 'L', 1185 => 'L', 1186 => 'L', 1187 => 'L', 1188 => 'L', 1189 => 'L', 1190 => 'L', 1191 => 'L', 1192 => 'L', 1193 => 'L', 1194 => 'L', 1195 => 'L', 1196 => 'L', 1197 => 'L', 1198 => 'L', 1199 => 'L', 1200 => 'L', 1201 => 'L', 1202 => 'L', 1203 => 'L', 1204 => 'L', 1205 => 'L', 1206 => 'L', 1207 => 'L', 1208 => 'L', 1209 => 'L', 1210 => 'L', 1211 => 'L', 1212 => 'L', 1213 => 'L', 1214 => 'L', 1215 => 'L', 1216 => 'L', 1217 => 'L', 1218 => 'L', 1219 => 'L', 1220 => 'L', 1221 => 'L', 1222 => 'L', 1223 => 'L', 1224 => 'L', 1225 => 'L', 1226 => 'L', 1227 => 'L', 1228 => 'L', 1229 => 'L', 1230 => 'L', 1231 => 'L', 1232 => 'L', 1233 => 'L', 1234 => 'L', 1235 => 'L', 1236 => 'L', 1237 => 'L', 1238 => 'L', 1239 => 'L', 1240 => 'L', 1241 => 'L', 1242 => 'L', 1243 => 'L', 1244 => 'L', 1245 => 'L', 1246 => 'L', 1247 => 'L', 1248 => 'L', 1249 => 'L', 1250 => 'L', 1251 => 'L', 1252 => 'L', 1253 => 'L', 1254 => 'L', 1255 => 'L', 1256 => 'L', 1257 => 'L', 1258 => 'L', 1259 => 'L', 1260 => 'L', 1261 => 'L', 1262 => 'L', 1263 => 'L', 1264 => 'L', 1265 => 'L', 1266 => 'L', 1267 => 'L', 1268 => 'L', 1269 => 'L', 1270 => 'L', 1271 => 'L', 1272 => 'L', 1273 => 'L', 1274 => 'L', 1275 => 'L', 1276 => 'L', 1277 => 'L', 1278 => 'L', 1279 => 'L', 1280 => 'L', 1281 => 'L', 1282 => 'L', 1283 => 'L', 1284 => 'L', 1285 => 'L', 1286 => 'L', 1287 => 'L', 1288 => 'L', 1289 => 'L', 1290 => 'L', 1291 => 'L', 1292 => 'L', 1293 => 'L', 1294 => 'L', 1295 => 'L', 1296 => 'L', 1297 => 'L', 1298 => 'L', 1299 => 'L', 1329 => 'L', 1330 => 'L', 1331 => 'L', 1332 => 'L', 1333 => 'L', 1334 => 'L', 1335 => 'L', 1336 => 'L', 1337 => 'L', 1338 => 'L', 1339 => 'L', 1340 => 'L', 1341 => 'L', 1342 => 'L', 1343 => 'L', 1344 => 'L', 1345 => 'L', 1346 => 'L', 1347 => 'L', 1348 => 'L', 1349 => 'L', 1350 => 'L', 1351 => 'L', 1352 => 'L', 1353 => 'L', 1354 => 'L', 1355 => 'L', 1356 => 'L', 1357 => 'L', 1358 => 'L', 1359 => 'L', 1360 => 'L', 1361 => 'L', 1362 => 'L', 1363 => 'L', 1364 => 'L', 1365 => 'L', 1366 => 'L', 1369 => 'L', 1370 => 'L', 1371 => 'L', 1372 => 'L', 1373 => 'L', 1374 => 'L', 1375 => 'L', 1377 => 'L', 1378 => 'L', 1379 => 'L', 1380 => 'L', 1381 => 'L', 1382 => 'L', 1383 => 'L', 1384 => 'L', 1385 => 'L', 1386 => 'L', 1387 => 'L', 1388 => 'L', 1389 => 'L', 1390 => 'L', 1391 => 'L', 1392 => 'L', 1393 => 'L', 1394 => 'L', 1395 => 'L', 1396 => 'L', 1397 => 'L', 1398 => 'L', 1399 => 'L', 1400 => 'L', 1401 => 'L', 1402 => 'L', 1403 => 'L', 1404 => 'L', 1405 => 'L', 1406 => 'L', 1407 => 'L', 1408 => 'L', 1409 => 'L', 1410 => 'L', 1411 => 'L', 1412 => 'L', 1413 => 'L', 1414 => 'L', 1415 => 'L', 1417 => 'L', 1418 => 'ON', 1425 => 'NSM', 1426 => 'NSM', 1427 => 'NSM', 1428 => 'NSM', 1429 => 'NSM', 1430 => 'NSM', 1431 => 'NSM', 1432 => 'NSM', 1433 => 'NSM', 1434 => 'NSM', 1435 => 'NSM', 1436 => 'NSM', 1437 => 'NSM', 1438 => 'NSM', 1439 => 'NSM', 1440 => 'NSM', 1441 => 'NSM', 1442 => 'NSM', 1443 => 'NSM', 1444 => 'NSM', 1445 => 'NSM', 1446 => 'NSM', 1447 => 'NSM', 1448 => 'NSM', 1449 => 'NSM', 1450 => 'NSM', 1451 => 'NSM', 1452 => 'NSM', 1453 => 'NSM', 1454 => 'NSM', 1455 => 'NSM', 1456 => 'NSM', 1457 => 'NSM', 1458 => 'NSM', 1459 => 'NSM', 1460 => 'NSM', 1461 => 'NSM', 1462 => 'NSM', 1463 => 'NSM', 1464 => 'NSM', 1465 => 'NSM', 1466 => 'NSM', 1467 => 'NSM', 1468 => 'NSM', 1469 => 'NSM', 1470 => 'R', 1471 => 'NSM', 1472 => 'R', 1473 => 'NSM', 1474 => 'NSM', 1475 => 'R', 1476 => 'NSM', 1477 => 'NSM', 1478 => 'R', 1479 => 'NSM', 1488 => 'R', 1489 => 'R', 1490 => 'R', 1491 => 'R', 1492 => 'R', 1493 => 'R', 1494 => 'R', 1495 => 'R', 1496 => 'R', 1497 => 'R', 1498 => 'R', 1499 => 'R', 1500 => 'R', 1501 => 'R', 1502 => 'R', 1503 => 'R', 1504 => 'R', 1505 => 'R', 1506 => 'R', 1507 => 'R', 1508 => 'R', 1509 => 'R', 1510 => 'R', 1511 => 'R', 1512 => 'R', 1513 => 'R', 1514 => 'R', 1520 => 'R', 1521 => 'R', 1522 => 'R', 1523 => 'R', 1524 => 'R', 1536 => 'AL', 1537 => 'AL', 1538 => 'AL', 1539 => 'AL', 1547 => 'AL', 1548 => 'CS', 1549 => 'AL', 1550 => 'ON', 1551 => 'ON', 1552 => 'NSM', 1553 => 'NSM', 1554 => 'NSM', 1555 => 'NSM', 1556 => 'NSM', 1557 => 'NSM', 1563 => 'AL', 1566 => 'AL', 1567 => 'AL', 1569 => 'AL', 1570 => 'AL', 1571 => 'AL', 1572 => 'AL', 1573 => 'AL', 1574 => 'AL', 1575 => 'AL', 1576 => 'AL', 1577 => 'AL', 1578 => 'AL', 1579 => 'AL', 1580 => 'AL', 1581 => 'AL', 1582 => 'AL', 1583 => 'AL', 1584 => 'AL', 1585 => 'AL', 1586 => 'AL', 1587 => 'AL', 1588 => 'AL', 1589 => 'AL', 1590 => 'AL', 1591 => 'AL', 1592 => 'AL', 1593 => 'AL', 1594 => 'AL', 1600 => 'AL', 1601 => 'AL', 1602 => 'AL', 1603 => 'AL', 1604 => 'AL', 1605 => 'AL', 1606 => 'AL', 1607 => 'AL', 1608 => 'AL', 1609 => 'AL', 1610 => 'AL', 1611 => 'NSM', 1612 => 'NSM', 1613 => 'NSM', 1614 => 'NSM', 1615 => 'NSM', 1616 => 'NSM', 1617 => 'NSM', 1618 => 'NSM', 1619 => 'NSM', 1620 => 'NSM', 1621 => 'NSM', 1622 => 'NSM', 1623 => 'NSM', 1624 => 'NSM', 1625 => 'NSM', 1626 => 'NSM', 1627 => 'NSM', 1628 => 'NSM', 1629 => 'NSM', 1630 => 'NSM', 1632 => 'AN', 1633 => 'AN', 1634 => 'AN', 1635 => 'AN', 1636 => 'AN', 1637 => 'AN', 1638 => 'AN', 1639 => 'AN', 1640 => 'AN', 1641 => 'AN', 1642 => 'ET', 1643 => 'AN', 1644 => 'AN', 1645 => 'AL', 1646 => 'AL', 1647 => 'AL', 1648 => 'NSM', 1649 => 'AL', 1650 => 'AL', 1651 => 'AL', 1652 => 'AL', 1653 => 'AL', 1654 => 'AL', 1655 => 'AL', 1656 => 'AL', 1657 => 'AL', 1658 => 'AL', 1659 => 'AL', 1660 => 'AL', 1661 => 'AL', 1662 => 'AL', 1663 => 'AL', 1664 => 'AL', 1665 => 'AL', 1666 => 'AL', 1667 => 'AL', 1668 => 'AL', 1669 => 'AL', 1670 => 'AL', 1671 => 'AL', 1672 => 'AL', 1673 => 'AL', 1674 => 'AL', 1675 => 'AL', 1676 => 'AL', 1677 => 'AL', 1678 => 'AL', 1679 => 'AL', 1680 => 'AL', 1681 => 'AL', 1682 => 'AL', 1683 => 'AL', 1684 => 'AL', 1685 => 'AL', 1686 => 'AL', 1687 => 'AL', 1688 => 'AL', 1689 => 'AL', 1690 => 'AL', 1691 => 'AL', 1692 => 'AL', 1693 => 'AL', 1694 => 'AL', 1695 => 'AL', 1696 => 'AL', 1697 => 'AL', 1698 => 'AL', 1699 => 'AL', 1700 => 'AL', 1701 => 'AL', 1702 => 'AL', 1703 => 'AL', 1704 => 'AL', 1705 => 'AL', 1706 => 'AL', 1707 => 'AL', 1708 => 'AL', 1709 => 'AL', 1710 => 'AL', 1711 => 'AL', 1712 => 'AL', 1713 => 'AL', 1714 => 'AL', 1715 => 'AL', 1716 => 'AL', 1717 => 'AL', 1718 => 'AL', 1719 => 'AL', 1720 => 'AL', 1721 => 'AL', 1722 => 'AL', 1723 => 'AL', 1724 => 'AL', 1725 => 'AL', 1726 => 'AL', 1727 => 'AL', 1728 => 'AL', 1729 => 'AL', 1730 => 'AL', 1731 => 'AL', 1732 => 'AL', 1733 => 'AL', 1734 => 'AL', 1735 => 'AL', 1736 => 'AL', 1737 => 'AL', 1738 => 'AL', 1739 => 'AL', 1740 => 'AL', 1741 => 'AL', 1742 => 'AL', 1743 => 'AL', 1744 => 'AL', 1745 => 'AL', 1746 => 'AL', 1747 => 'AL', 1748 => 'AL', 1749 => 'AL', 1750 => 'NSM', 1751 => 'NSM', 1752 => 'NSM', 1753 => 'NSM', 1754 => 'NSM', 1755 => 'NSM', 1756 => 'NSM', 1757 => 'AL', 1758 => 'NSM', 1759 => 'NSM', 1760 => 'NSM', 1761 => 'NSM', 1762 => 'NSM', 1763 => 'NSM', 1764 => 'NSM', 1765 => 'AL', 1766 => 'AL', 1767 => 'NSM', 1768 => 'NSM', 1769 => 'ON', 1770 => 'NSM', 1771 => 'NSM', 1772 => 'NSM', 1773 => 'NSM', 1774 => 'AL', 1775 => 'AL', 1776 => 'EN', 1777 => 'EN', 1778 => 'EN', 1779 => 'EN', 1780 => 'EN', 1781 => 'EN', 1782 => 'EN', 1783 => 'EN', 1784 => 'EN', 1785 => 'EN', 1786 => 'AL', 1787 => 'AL', 1788 => 'AL', 1789 => 'AL', 1790 => 'AL', 1791 => 'AL', 1792 => 'AL', 1793 => 'AL', 1794 => 'AL', 1795 => 'AL', 1796 => 'AL', 1797 => 'AL', 1798 => 'AL', 1799 => 'AL', 1800 => 'AL', 1801 => 'AL', 1802 => 'AL', 1803 => 'AL', 1804 => 'AL', 1805 => 'AL', 1807 => 'BN', 1808 => 'AL', 1809 => 'NSM', 1810 => 'AL', 1811 => 'AL', 1812 => 'AL', 1813 => 'AL', 1814 => 'AL', 1815 => 'AL', 1816 => 'AL', 1817 => 'AL', 1818 => 'AL', 1819 => 'AL', 1820 => 'AL', 1821 => 'AL', 1822 => 'AL', 1823 => 'AL', 1824 => 'AL', 1825 => 'AL', 1826 => 'AL', 1827 => 'AL', 1828 => 'AL', 1829 => 'AL', 1830 => 'AL', 1831 => 'AL', 1832 => 'AL', 1833 => 'AL', 1834 => 'AL', 1835 => 'AL', 1836 => 'AL', 1837 => 'AL', 1838 => 'AL', 1839 => 'AL', 1840 => 'NSM', 1841 => 'NSM', 1842 => 'NSM', 1843 => 'NSM', 1844 => 'NSM', 1845 => 'NSM', 1846 => 'NSM', 1847 => 'NSM', 1848 => 'NSM', 1849 => 'NSM', 1850 => 'NSM', 1851 => 'NSM', 1852 => 'NSM', 1853 => 'NSM', 1854 => 'NSM', 1855 => 'NSM', 1856 => 'NSM', 1857 => 'NSM', 1858 => 'NSM', 1859 => 'NSM', 1860 => 'NSM', 1861 => 'NSM', 1862 => 'NSM', 1863 => 'NSM', 1864 => 'NSM', 1865 => 'NSM', 1866 => 'NSM', 1869 => 'AL', 1870 => 'AL', 1871 => 'AL', 1872 => 'AL', 1873 => 'AL', 1874 => 'AL', 1875 => 'AL', 1876 => 'AL', 1877 => 'AL', 1878 => 'AL', 1879 => 'AL', 1880 => 'AL', 1881 => 'AL', 1882 => 'AL', 1883 => 'AL', 1884 => 'AL', 1885 => 'AL', 1886 => 'AL', 1887 => 'AL', 1888 => 'AL', 1889 => 'AL', 1890 => 'AL', 1891 => 'AL', 1892 => 'AL', 1893 => 'AL', 1894 => 'AL', 1895 => 'AL', 1896 => 'AL', 1897 => 'AL', 1898 => 'AL', 1899 => 'AL', 1900 => 'AL', 1901 => 'AL', 1920 => 'AL', 1921 => 'AL', 1922 => 'AL', 1923 => 'AL', 1924 => 'AL', 1925 => 'AL', 1926 => 'AL', 1927 => 'AL', 1928 => 'AL', 1929 => 'AL', 1930 => 'AL', 1931 => 'AL', 1932 => 'AL', 1933 => 'AL', 1934 => 'AL', 1935 => 'AL', 1936 => 'AL', 1937 => 'AL', 1938 => 'AL', 1939 => 'AL', 1940 => 'AL', 1941 => 'AL', 1942 => 'AL', 1943 => 'AL', 1944 => 'AL', 1945 => 'AL', 1946 => 'AL', 1947 => 'AL', 1948 => 'AL', 1949 => 'AL', 1950 => 'AL', 1951 => 'AL', 1952 => 'AL', 1953 => 'AL', 1954 => 'AL', 1955 => 'AL', 1956 => 'AL', 1957 => 'AL', 1958 => 'NSM', 1959 => 'NSM', 1960 => 'NSM', 1961 => 'NSM', 1962 => 'NSM', 1963 => 'NSM', 1964 => 'NSM', 1965 => 'NSM', 1966 => 'NSM', 1967 => 'NSM', 1968 => 'NSM', 1969 => 'AL', 1984 => 'R', 1985 => 'R', 1986 => 'R', 1987 => 'R', 1988 => 'R', 1989 => 'R', 1990 => 'R', 1991 => 'R', 1992 => 'R', 1993 => 'R', 1994 => 'R', 1995 => 'R', 1996 => 'R', 1997 => 'R', 1998 => 'R', 1999 => 'R', 2000 => 'R', 2001 => 'R', 2002 => 'R', 2003 => 'R', 2004 => 'R', 2005 => 'R', 2006 => 'R', 2007 => 'R', 2008 => 'R', 2009 => 'R', 2010 => 'R', 2011 => 'R', 2012 => 'R', 2013 => 'R', 2014 => 'R', 2015 => 'R', 2016 => 'R', 2017 => 'R', 2018 => 'R', 2019 => 'R', 2020 => 'R', 2021 => 'R', 2022 => 'R', 2023 => 'R', 2024 => 'R', 2025 => 'R', 2026 => 'R', 2027 => 'NSM', 2028 => 'NSM', 2029 => 'NSM', 2030 => 'NSM', 2031 => 'NSM', 2032 => 'NSM', 2033 => 'NSM', 2034 => 'NSM', 2035 => 'NSM', 2036 => 'R', 2037 => 'R', 2038 => 'ON', 2039 => 'ON', 2040 => 'ON', 2041 => 'ON', 2042 => 'R', 2305 => 'NSM', 2306 => 'NSM', 2307 => 'L', 2308 => 'L', 2309 => 'L', 2310 => 'L', 2311 => 'L', 2312 => 'L', 2313 => 'L', 2314 => 'L', 2315 => 'L', 2316 => 'L', 2317 => 'L', 2318 => 'L', 2319 => 'L', 2320 => 'L', 2321 => 'L', 2322 => 'L', 2323 => 'L', 2324 => 'L', 2325 => 'L', 2326 => 'L', 2327 => 'L', 2328 => 'L', 2329 => 'L', 2330 => 'L', 2331 => 'L', 2332 => 'L', 2333 => 'L', 2334 => 'L', 2335 => 'L', 2336 => 'L', 2337 => 'L', 2338 => 'L', 2339 => 'L', 2340 => 'L', 2341 => 'L', 2342 => 'L', 2343 => 'L', 2344 => 'L', 2345 => 'L', 2346 => 'L', 2347 => 'L', 2348 => 'L', 2349 => 'L', 2350 => 'L', 2351 => 'L', 2352 => 'L', 2353 => 'L', 2354 => 'L', 2355 => 'L', 2356 => 'L', 2357 => 'L', 2358 => 'L', 2359 => 'L', 2360 => 'L', 2361 => 'L', 2364 => 'NSM', 2365 => 'L', 2366 => 'L', 2367 => 'L', 2368 => 'L', 2369 => 'NSM', 2370 => 'NSM', 2371 => 'NSM', 2372 => 'NSM', 2373 => 'NSM', 2374 => 'NSM', 2375 => 'NSM', 2376 => 'NSM', 2377 => 'L', 2378 => 'L', 2379 => 'L', 2380 => 'L', 2381 => 'NSM', 2384 => 'L', 2385 => 'NSM', 2386 => 'NSM', 2387 => 'NSM', 2388 => 'NSM', 2392 => 'L', 2393 => 'L', 2394 => 'L', 2395 => 'L', 2396 => 'L', 2397 => 'L', 2398 => 'L', 2399 => 'L', 2400 => 'L', 2401 => 'L', 2402 => 'NSM', 2403 => 'NSM', 2404 => 'L', 2405 => 'L', 2406 => 'L', 2407 => 'L', 2408 => 'L', 2409 => 'L', 2410 => 'L', 2411 => 'L', 2412 => 'L', 2413 => 'L', 2414 => 'L', 2415 => 'L', 2416 => 'L', 2427 => 'L', 2428 => 'L', 2429 => 'L', 2430 => 'L', 2431 => 'L', 2433 => 'NSM', 2434 => 'L', 2435 => 'L', 2437 => 'L', 2438 => 'L', 2439 => 'L', 2440 => 'L', 2441 => 'L', 2442 => 'L', 2443 => 'L', 2444 => 'L', 2447 => 'L', 2448 => 'L', 2451 => 'L', 2452 => 'L', 2453 => 'L', 2454 => 'L', 2455 => 'L', 2456 => 'L', 2457 => 'L', 2458 => 'L', 2459 => 'L', 2460 => 'L', 2461 => 'L', 2462 => 'L', 2463 => 'L', 2464 => 'L', 2465 => 'L', 2466 => 'L', 2467 => 'L', 2468 => 'L', 2469 => 'L', 2470 => 'L', 2471 => 'L', 2472 => 'L', 2474 => 'L', 2475 => 'L', 2476 => 'L', 2477 => 'L', 2478 => 'L', 2479 => 'L', 2480 => 'L', 2482 => 'L', 2486 => 'L', 2487 => 'L', 2488 => 'L', 2489 => 'L', 2492 => 'NSM', 2493 => 'L', 2494 => 'L', 2495 => 'L', 2496 => 'L', 2497 => 'NSM', 2498 => 'NSM', 2499 => 'NSM', 2500 => 'NSM', 2503 => 'L', 2504 => 'L', 2507 => 'L', 2508 => 'L', 2509 => 'NSM', 2510 => 'L', 2519 => 'L', 2524 => 'L', 2525 => 'L', 2527 => 'L', 2528 => 'L', 2529 => 'L', 2530 => 'NSM', 2531 => 'NSM', 2534 => 'L', 2535 => 'L', 2536 => 'L', 2537 => 'L', 2538 => 'L', 2539 => 'L', 2540 => 'L', 2541 => 'L', 2542 => 'L', 2543 => 'L', 2544 => 'L', 2545 => 'L', 2546 => 'ET', 2547 => 'ET', 2548 => 'L', 2549 => 'L', 2550 => 'L', 2551 => 'L', 2552 => 'L', 2553 => 'L', 2554 => 'L', 2561 => 'NSM', 2562 => 'NSM', 2563 => 'L', 2565 => 'L', 2566 => 'L', 2567 => 'L', 2568 => 'L', 2569 => 'L', 2570 => 'L', 2575 => 'L', 2576 => 'L', 2579 => 'L', 2580 => 'L', 2581 => 'L', 2582 => 'L', 2583 => 'L', 2584 => 'L', 2585 => 'L', 2586 => 'L', 2587 => 'L', 2588 => 'L', 2589 => 'L', 2590 => 'L', 2591 => 'L', 2592 => 'L', 2593 => 'L', 2594 => 'L', 2595 => 'L', 2596 => 'L', 2597 => 'L', 2598 => 'L', 2599 => 'L', 2600 => 'L', 2602 => 'L', 2603 => 'L', 2604 => 'L', 2605 => 'L', 2606 => 'L', 2607 => 'L', 2608 => 'L', 2610 => 'L', 2611 => 'L', 2613 => 'L', 2614 => 'L', 2616 => 'L', 2617 => 'L', 2620 => 'NSM', 2622 => 'L', 2623 => 'L', 2624 => 'L', 2625 => 'NSM', 2626 => 'NSM', 2631 => 'NSM', 2632 => 'NSM', 2635 => 'NSM', 2636 => 'NSM', 2637 => 'NSM', 2649 => 'L', 2650 => 'L', 2651 => 'L', 2652 => 'L', 2654 => 'L', 2662 => 'L', 2663 => 'L', 2664 => 'L', 2665 => 'L', 2666 => 'L', 2667 => 'L', 2668 => 'L', 2669 => 'L', 2670 => 'L', 2671 => 'L', 2672 => 'NSM', 2673 => 'NSM', 2674 => 'L', 2675 => 'L', 2676 => 'L', 2689 => 'NSM', 2690 => 'NSM', 2691 => 'L', 2693 => 'L', 2694 => 'L', 2695 => 'L', 2696 => 'L', 2697 => 'L', 2698 => 'L', 2699 => 'L', 2700 => 'L', 2701 => 'L', 2703 => 'L', 2704 => 'L', 2705 => 'L', 2707 => 'L', 2708 => 'L', 2709 => 'L', 2710 => 'L', 2711 => 'L', 2712 => 'L', 2713 => 'L', 2714 => 'L', 2715 => 'L', 2716 => 'L', 2717 => 'L', 2718 => 'L', 2719 => 'L', 2720 => 'L', 2721 => 'L', 2722 => 'L', 2723 => 'L', 2724 => 'L', 2725 => 'L', 2726 => 'L', 2727 => 'L', 2728 => 'L', 2730 => 'L', 2731 => 'L', 2732 => 'L', 2733 => 'L', 2734 => 'L', 2735 => 'L', 2736 => 'L', 2738 => 'L', 2739 => 'L', 2741 => 'L', 2742 => 'L', 2743 => 'L', 2744 => 'L', 2745 => 'L', 2748 => 'NSM', 2749 => 'L', 2750 => 'L', 2751 => 'L', 2752 => 'L', 2753 => 'NSM', 2754 => 'NSM', 2755 => 'NSM', 2756 => 'NSM', 2757 => 'NSM', 2759 => 'NSM', 2760 => 'NSM', 2761 => 'L', 2763 => 'L', 2764 => 'L', 2765 => 'NSM', 2768 => 'L', 2784 => 'L', 2785 => 'L', 2786 => 'NSM', 2787 => 'NSM', 2790 => 'L', 2791 => 'L', 2792 => 'L', 2793 => 'L', 2794 => 'L', 2795 => 'L', 2796 => 'L', 2797 => 'L', 2798 => 'L', 2799 => 'L', 2801 => 'ET', 2817 => 'NSM', 2818 => 'L', 2819 => 'L', 2821 => 'L', 2822 => 'L', 2823 => 'L', 2824 => 'L', 2825 => 'L', 2826 => 'L', 2827 => 'L', 2828 => 'L', 2831 => 'L', 2832 => 'L', 2835 => 'L', 2836 => 'L', 2837 => 'L', 2838 => 'L', 2839 => 'L', 2840 => 'L', 2841 => 'L', 2842 => 'L', 2843 => 'L', 2844 => 'L', 2845 => 'L', 2846 => 'L', 2847 => 'L', 2848 => 'L', 2849 => 'L', 2850 => 'L', 2851 => 'L', 2852 => 'L', 2853 => 'L', 2854 => 'L', 2855 => 'L', 2856 => 'L', 2858 => 'L', 2859 => 'L', 2860 => 'L', 2861 => 'L', 2862 => 'L', 2863 => 'L', 2864 => 'L', 2866 => 'L', 2867 => 'L', 2869 => 'L', 2870 => 'L', 2871 => 'L', 2872 => 'L', 2873 => 'L', 2876 => 'NSM', 2877 => 'L', 2878 => 'L', 2879 => 'NSM', 2880 => 'L', 2881 => 'NSM', 2882 => 'NSM', 2883 => 'NSM', 2887 => 'L', 2888 => 'L', 2891 => 'L', 2892 => 'L', 2893 => 'NSM', 2902 => 'NSM', 2903 => 'L', 2908 => 'L', 2909 => 'L', 2911 => 'L', 2912 => 'L', 2913 => 'L', 2918 => 'L', 2919 => 'L', 2920 => 'L', 2921 => 'L', 2922 => 'L', 2923 => 'L', 2924 => 'L', 2925 => 'L', 2926 => 'L', 2927 => 'L', 2928 => 'L', 2929 => 'L', 2946 => 'NSM', 2947 => 'L', 2949 => 'L', 2950 => 'L', 2951 => 'L', 2952 => 'L', 2953 => 'L', 2954 => 'L', 2958 => 'L', 2959 => 'L', 2960 => 'L', 2962 => 'L', 2963 => 'L', 2964 => 'L', 2965 => 'L', 2969 => 'L', 2970 => 'L', 2972 => 'L', 2974 => 'L', 2975 => 'L', 2979 => 'L', 2980 => 'L', 2984 => 'L', 2985 => 'L', 2986 => 'L', 2990 => 'L', 2991 => 'L', 2992 => 'L', 2993 => 'L', 2994 => 'L', 2995 => 'L', 2996 => 'L', 2997 => 'L', 2998 => 'L', 2999 => 'L', 3000 => 'L', 3001 => 'L', 3006 => 'L', 3007 => 'L', 3008 => 'NSM', 3009 => 'L', 3010 => 'L', 3014 => 'L', 3015 => 'L', 3016 => 'L', 3018 => 'L', 3019 => 'L', 3020 => 'L', 3021 => 'NSM', 3031 => 'L', 3046 => 'L', 3047 => 'L', 3048 => 'L', 3049 => 'L', 3050 => 'L', 3051 => 'L', 3052 => 'L', 3053 => 'L', 3054 => 'L', 3055 => 'L', 3056 => 'L', 3057 => 'L', 3058 => 'L', 3059 => 'ON', 3060 => 'ON', 3061 => 'ON', 3062 => 'ON', 3063 => 'ON', 3064 => 'ON', 3065 => 'ET', 3066 => 'ON', 3073 => 'L', 3074 => 'L', 3075 => 'L', 3077 => 'L', 3078 => 'L', 3079 => 'L', 3080 => 'L', 3081 => 'L', 3082 => 'L', 3083 => 'L', 3084 => 'L', 3086 => 'L', 3087 => 'L', 3088 => 'L', 3090 => 'L', 3091 => 'L', 3092 => 'L', 3093 => 'L', 3094 => 'L', 3095 => 'L', 3096 => 'L', 3097 => 'L', 3098 => 'L', 3099 => 'L', 3100 => 'L', 3101 => 'L', 3102 => 'L', 3103 => 'L', 3104 => 'L', 3105 => 'L', 3106 => 'L', 3107 => 'L', 3108 => 'L', 3109 => 'L', 3110 => 'L', 3111 => 'L', 3112 => 'L', 3114 => 'L', 3115 => 'L', 3116 => 'L', 3117 => 'L', 3118 => 'L', 3119 => 'L', 3120 => 'L', 3121 => 'L', 3122 => 'L', 3123 => 'L', 3125 => 'L', 3126 => 'L', 3127 => 'L', 3128 => 'L', 3129 => 'L', 3134 => 'NSM', 3135 => 'NSM', 3136 => 'NSM', 3137 => 'L', 3138 => 'L', 3139 => 'L', 3140 => 'L', 3142 => 'NSM', 3143 => 'NSM', 3144 => 'NSM', 3146 => 'NSM', 3147 => 'NSM', 3148 => 'NSM', 3149 => 'NSM', 3157 => 'NSM', 3158 => 'NSM', 3168 => 'L', 3169 => 'L', 3174 => 'L', 3175 => 'L', 3176 => 'L', 3177 => 'L', 3178 => 'L', 3179 => 'L', 3180 => 'L', 3181 => 'L', 3182 => 'L', 3183 => 'L', 3202 => 'L', 3203 => 'L', 3205 => 'L', 3206 => 'L', 3207 => 'L', 3208 => 'L', 3209 => 'L', 3210 => 'L', 3211 => 'L', 3212 => 'L', 3214 => 'L', 3215 => 'L', 3216 => 'L', 3218 => 'L', 3219 => 'L', 3220 => 'L', 3221 => 'L', 3222 => 'L', 3223 => 'L', 3224 => 'L', 3225 => 'L', 3226 => 'L', 3227 => 'L', 3228 => 'L', 3229 => 'L', 3230 => 'L', 3231 => 'L', 3232 => 'L', 3233 => 'L', 3234 => 'L', 3235 => 'L', 3236 => 'L', 3237 => 'L', 3238 => 'L', 3239 => 'L', 3240 => 'L', 3242 => 'L', 3243 => 'L', 3244 => 'L', 3245 => 'L', 3246 => 'L', 3247 => 'L', 3248 => 'L', 3249 => 'L', 3250 => 'L', 3251 => 'L', 3253 => 'L', 3254 => 'L', 3255 => 'L', 3256 => 'L', 3257 => 'L', 3260 => 'NSM', 3261 => 'L', 3262 => 'L', 3263 => 'L', 3264 => 'L', 3265 => 'L', 3266 => 'L', 3267 => 'L', 3268 => 'L', 3270 => 'L', 3271 => 'L', 3272 => 'L', 3274 => 'L', 3275 => 'L', 3276 => 'NSM', 3277 => 'NSM', 3285 => 'L', 3286 => 'L', 3294 => 'L', 3296 => 'L', 3297 => 'L', 3298 => 'NSM', 3299 => 'NSM', 3302 => 'L', 3303 => 'L', 3304 => 'L', 3305 => 'L', 3306 => 'L', 3307 => 'L', 3308 => 'L', 3309 => 'L', 3310 => 'L', 3311 => 'L', 3313 => 'ON', 3314 => 'ON', 3330 => 'L', 3331 => 'L', 3333 => 'L', 3334 => 'L', 3335 => 'L', 3336 => 'L', 3337 => 'L', 3338 => 'L', 3339 => 'L', 3340 => 'L', 3342 => 'L', 3343 => 'L', 3344 => 'L', 3346 => 'L', 3347 => 'L', 3348 => 'L', 3349 => 'L', 3350 => 'L', 3351 => 'L', 3352 => 'L', 3353 => 'L', 3354 => 'L', 3355 => 'L', 3356 => 'L', 3357 => 'L', 3358 => 'L', 3359 => 'L', 3360 => 'L', 3361 => 'L', 3362 => 'L', 3363 => 'L', 3364 => 'L', 3365 => 'L', 3366 => 'L', 3367 => 'L', 3368 => 'L', 3370 => 'L', 3371 => 'L', 3372 => 'L', 3373 => 'L', 3374 => 'L', 3375 => 'L', 3376 => 'L', 3377 => 'L', 3378 => 'L', 3379 => 'L', 3380 => 'L', 3381 => 'L', 3382 => 'L', 3383 => 'L', 3384 => 'L', 3385 => 'L', 3390 => 'L', 3391 => 'L', 3392 => 'L', 3393 => 'NSM', 3394 => 'NSM', 3395 => 'NSM', 3398 => 'L', 3399 => 'L', 3400 => 'L', 3402 => 'L', 3403 => 'L', 3404 => 'L', 3405 => 'NSM', 3415 => 'L', 3424 => 'L', 3425 => 'L', 3430 => 'L', 3431 => 'L', 3432 => 'L', 3433 => 'L', 3434 => 'L', 3435 => 'L', 3436 => 'L', 3437 => 'L', 3438 => 'L', 3439 => 'L', 3458 => 'L', 3459 => 'L', 3461 => 'L', 3462 => 'L', 3463 => 'L', 3464 => 'L', 3465 => 'L', 3466 => 'L', 3467 => 'L', 3468 => 'L', 3469 => 'L', 3470 => 'L', 3471 => 'L', 3472 => 'L', 3473 => 'L', 3474 => 'L', 3475 => 'L', 3476 => 'L', 3477 => 'L', 3478 => 'L', 3482 => 'L', 3483 => 'L', 3484 => 'L', 3485 => 'L', 3486 => 'L', 3487 => 'L', 3488 => 'L', 3489 => 'L', 3490 => 'L', 3491 => 'L', 3492 => 'L', 3493 => 'L', 3494 => 'L', 3495 => 'L', 3496 => 'L', 3497 => 'L', 3498 => 'L', 3499 => 'L', 3500 => 'L', 3501 => 'L', 3502 => 'L', 3503 => 'L', 3504 => 'L', 3505 => 'L', 3507 => 'L', 3508 => 'L', 3509 => 'L', 3510 => 'L', 3511 => 'L', 3512 => 'L', 3513 => 'L', 3514 => 'L', 3515 => 'L', 3517 => 'L', 3520 => 'L', 3521 => 'L', 3522 => 'L', 3523 => 'L', 3524 => 'L', 3525 => 'L', 3526 => 'L', 3530 => 'NSM', 3535 => 'L', 3536 => 'L', 3537 => 'L', 3538 => 'NSM', 3539 => 'NSM', 3540 => 'NSM', 3542 => 'NSM', 3544 => 'L', 3545 => 'L', 3546 => 'L', 3547 => 'L', 3548 => 'L', 3549 => 'L', 3550 => 'L', 3551 => 'L', 3570 => 'L', 3571 => 'L', 3572 => 'L', 3585 => 'L', 3586 => 'L', 3587 => 'L', 3588 => 'L', 3589 => 'L', 3590 => 'L', 3591 => 'L', 3592 => 'L', 3593 => 'L', 3594 => 'L', 3595 => 'L', 3596 => 'L', 3597 => 'L', 3598 => 'L', 3599 => 'L', 3600 => 'L', 3601 => 'L', 3602 => 'L', 3603 => 'L', 3604 => 'L', 3605 => 'L', 3606 => 'L', 3607 => 'L', 3608 => 'L', 3609 => 'L', 3610 => 'L', 3611 => 'L', 3612 => 'L', 3613 => 'L', 3614 => 'L', 3615 => 'L', 3616 => 'L', 3617 => 'L', 3618 => 'L', 3619 => 'L', 3620 => 'L', 3621 => 'L', 3622 => 'L', 3623 => 'L', 3624 => 'L', 3625 => 'L', 3626 => 'L', 3627 => 'L', 3628 => 'L', 3629 => 'L', 3630 => 'L', 3631 => 'L', 3632 => 'L', 3633 => 'NSM', 3634 => 'L', 3635 => 'L', 3636 => 'NSM', 3637 => 'NSM', 3638 => 'NSM', 3639 => 'NSM', 3640 => 'NSM', 3641 => 'NSM', 3642 => 'NSM', 3647 => 'ET', 3648 => 'L', 3649 => 'L', 3650 => 'L', 3651 => 'L', 3652 => 'L', 3653 => 'L', 3654 => 'L', 3655 => 'NSM', 3656 => 'NSM', 3657 => 'NSM', 3658 => 'NSM', 3659 => 'NSM', 3660 => 'NSM', 3661 => 'NSM', 3662 => 'NSM', 3663 => 'L', 3664 => 'L', 3665 => 'L', 3666 => 'L', 3667 => 'L', 3668 => 'L', 3669 => 'L', 3670 => 'L', 3671 => 'L', 3672 => 'L', 3673 => 'L', 3674 => 'L', 3675 => 'L', 3713 => 'L', 3714 => 'L', 3716 => 'L', 3719 => 'L', 3720 => 'L', 3722 => 'L', 3725 => 'L', 3732 => 'L', 3733 => 'L', 3734 => 'L', 3735 => 'L', 3737 => 'L', 3738 => 'L', 3739 => 'L', 3740 => 'L', 3741 => 'L', 3742 => 'L', 3743 => 'L', 3745 => 'L', 3746 => 'L', 3747 => 'L', 3749 => 'L', 3751 => 'L', 3754 => 'L', 3755 => 'L', 3757 => 'L', 3758 => 'L', 3759 => 'L', 3760 => 'L', 3761 => 'NSM', 3762 => 'L', 3763 => 'L', 3764 => 'NSM', 3765 => 'NSM', 3766 => 'NSM', 3767 => 'NSM', 3768 => 'NSM', 3769 => 'NSM', 3771 => 'NSM', 3772 => 'NSM', 3773 => 'L', 3776 => 'L', 3777 => 'L', 3778 => 'L', 3779 => 'L', 3780 => 'L', 3782 => 'L', 3784 => 'NSM', 3785 => 'NSM', 3786 => 'NSM', 3787 => 'NSM', 3788 => 'NSM', 3789 => 'NSM', 3792 => 'L', 3793 => 'L', 3794 => 'L', 3795 => 'L', 3796 => 'L', 3797 => 'L', 3798 => 'L', 3799 => 'L', 3800 => 'L', 3801 => 'L', 3804 => 'L', 3805 => 'L', 3840 => 'L', 3841 => 'L', 3842 => 'L', 3843 => 'L', 3844 => 'L', 3845 => 'L', 3846 => 'L', 3847 => 'L', 3848 => 'L', 3849 => 'L', 3850 => 'L', 3851 => 'L', 3852 => 'L', 3853 => 'L', 3854 => 'L', 3855 => 'L', 3856 => 'L', 3857 => 'L', 3858 => 'L', 3859 => 'L', 3860 => 'L', 3861 => 'L', 3862 => 'L', 3863 => 'L', 3864 => 'NSM', 3865 => 'NSM', 3866 => 'L', 3867 => 'L', 3868 => 'L', 3869 => 'L', 3870 => 'L', 3871 => 'L', 3872 => 'L', 3873 => 'L', 3874 => 'L', 3875 => 'L', 3876 => 'L', 3877 => 'L', 3878 => 'L', 3879 => 'L', 3880 => 'L', 3881 => 'L', 3882 => 'L', 3883 => 'L', 3884 => 'L', 3885 => 'L', 3886 => 'L', 3887 => 'L', 3888 => 'L', 3889 => 'L', 3890 => 'L', 3891 => 'L', 3892 => 'L', 3893 => 'NSM', 3894 => 'L', 3895 => 'NSM', 3896 => 'L', 3897 => 'NSM', 3898 => 'ON', 3899 => 'ON', 3900 => 'ON', 3901 => 'ON', 3902 => 'L', 3903 => 'L', 3904 => 'L', 3905 => 'L', 3906 => 'L', 3907 => 'L', 3908 => 'L', 3909 => 'L', 3910 => 'L', 3911 => 'L', 3913 => 'L', 3914 => 'L', 3915 => 'L', 3916 => 'L', 3917 => 'L', 3918 => 'L', 3919 => 'L', 3920 => 'L', 3921 => 'L', 3922 => 'L', 3923 => 'L', 3924 => 'L', 3925 => 'L', 3926 => 'L', 3927 => 'L', 3928 => 'L', 3929 => 'L', 3930 => 'L', 3931 => 'L', 3932 => 'L', 3933 => 'L', 3934 => 'L', 3935 => 'L', 3936 => 'L', 3937 => 'L', 3938 => 'L', 3939 => 'L', 3940 => 'L', 3941 => 'L', 3942 => 'L', 3943 => 'L', 3944 => 'L', 3945 => 'L', 3946 => 'L', 3953 => 'NSM', 3954 => 'NSM', 3955 => 'NSM', 3956 => 'NSM', 3957 => 'NSM', 3958 => 'NSM', 3959 => 'NSM', 3960 => 'NSM', 3961 => 'NSM', 3962 => 'NSM', 3963 => 'NSM', 3964 => 'NSM', 3965 => 'NSM', 3966 => 'NSM', 3967 => 'L', 3968 => 'NSM', 3969 => 'NSM', 3970 => 'NSM', 3971 => 'NSM', 3972 => 'NSM', 3973 => 'L', 3974 => 'NSM', 3975 => 'NSM', 3976 => 'L', 3977 => 'L', 3978 => 'L', 3979 => 'L', 3984 => 'NSM', 3985 => 'NSM', 3986 => 'NSM', 3987 => 'NSM', 3988 => 'NSM', 3989 => 'NSM', 3990 => 'NSM', 3991 => 'NSM', 3993 => 'NSM', 3994 => 'NSM', 3995 => 'NSM', 3996 => 'NSM', 3997 => 'NSM', 3998 => 'NSM', 3999 => 'NSM', 4000 => 'NSM', 4001 => 'NSM', 4002 => 'NSM', 4003 => 'NSM', 4004 => 'NSM', 4005 => 'NSM', 4006 => 'NSM', 4007 => 'NSM', 4008 => 'NSM', 4009 => 'NSM', 4010 => 'NSM', 4011 => 'NSM', 4012 => 'NSM', 4013 => 'NSM', 4014 => 'NSM', 4015 => 'NSM', 4016 => 'NSM', 4017 => 'NSM', 4018 => 'NSM', 4019 => 'NSM', 4020 => 'NSM', 4021 => 'NSM', 4022 => 'NSM', 4023 => 'NSM', 4024 => 'NSM', 4025 => 'NSM', 4026 => 'NSM', 4027 => 'NSM', 4028 => 'NSM', 4030 => 'L', 4031 => 'L', 4032 => 'L', 4033 => 'L', 4034 => 'L', 4035 => 'L', 4036 => 'L', 4037 => 'L', 4038 => 'NSM', 4039 => 'L', 4040 => 'L', 4041 => 'L', 4042 => 'L', 4043 => 'L', 4044 => 'L', 4047 => 'L', 4048 => 'L', 4049 => 'L', 4096 => 'L', 4097 => 'L', 4098 => 'L', 4099 => 'L', 4100 => 'L', 4101 => 'L', 4102 => 'L', 4103 => 'L', 4104 => 'L', 4105 => 'L', 4106 => 'L', 4107 => 'L', 4108 => 'L', 4109 => 'L', 4110 => 'L', 4111 => 'L', 4112 => 'L', 4113 => 'L', 4114 => 'L', 4115 => 'L', 4116 => 'L', 4117 => 'L', 4118 => 'L', 4119 => 'L', 4120 => 'L', 4121 => 'L', 4122 => 'L', 4123 => 'L', 4124 => 'L', 4125 => 'L', 4126 => 'L', 4127 => 'L', 4128 => 'L', 4129 => 'L', 4131 => 'L', 4132 => 'L', 4133 => 'L', 4134 => 'L', 4135 => 'L', 4137 => 'L', 4138 => 'L', 4140 => 'L', 4141 => 'NSM', 4142 => 'NSM', 4143 => 'NSM', 4144 => 'NSM', 4145 => 'L', 4146 => 'NSM', 4150 => 'NSM', 4151 => 'NSM', 4152 => 'L', 4153 => 'NSM', 4160 => 'L', 4161 => 'L', 4162 => 'L', 4163 => 'L', 4164 => 'L', 4165 => 'L', 4166 => 'L', 4167 => 'L', 4168 => 'L', 4169 => 'L', 4170 => 'L', 4171 => 'L', 4172 => 'L', 4173 => 'L', 4174 => 'L', 4175 => 'L', 4176 => 'L', 4177 => 'L', 4178 => 'L', 4179 => 'L', 4180 => 'L', 4181 => 'L', 4182 => 'L', 4183 => 'L', 4184 => 'NSM', 4185 => 'NSM', 4256 => 'L', 4257 => 'L', 4258 => 'L', 4259 => 'L', 4260 => 'L', 4261 => 'L', 4262 => 'L', 4263 => 'L', 4264 => 'L', 4265 => 'L', 4266 => 'L', 4267 => 'L', 4268 => 'L', 4269 => 'L', 4270 => 'L', 4271 => 'L', 4272 => 'L', 4273 => 'L', 4274 => 'L', 4275 => 'L', 4276 => 'L', 4277 => 'L', 4278 => 'L', 4279 => 'L', 4280 => 'L', 4281 => 'L', 4282 => 'L', 4283 => 'L', 4284 => 'L', 4285 => 'L', 4286 => 'L', 4287 => 'L', 4288 => 'L', 4289 => 'L', 4290 => 'L', 4291 => 'L', 4292 => 'L', 4293 => 'L', 4304 => 'L', 4305 => 'L', 4306 => 'L', 4307 => 'L', 4308 => 'L', 4309 => 'L', 4310 => 'L', 4311 => 'L', 4312 => 'L', 4313 => 'L', 4314 => 'L', 4315 => 'L', 4316 => 'L', 4317 => 'L', 4318 => 'L', 4319 => 'L', 4320 => 'L', 4321 => 'L', 4322 => 'L', 4323 => 'L', 4324 => 'L', 4325 => 'L', 4326 => 'L', 4327 => 'L', 4328 => 'L', 4329 => 'L', 4330 => 'L', 4331 => 'L', 4332 => 'L', 4333 => 'L', 4334 => 'L', 4335 => 'L', 4336 => 'L', 4337 => 'L', 4338 => 'L', 4339 => 'L', 4340 => 'L', 4341 => 'L', 4342 => 'L', 4343 => 'L', 4344 => 'L', 4345 => 'L', 4346 => 'L', 4347 => 'L', 4348 => 'L', 4352 => 'L', 4353 => 'L', 4354 => 'L', 4355 => 'L', 4356 => 'L', 4357 => 'L', 4358 => 'L', 4359 => 'L', 4360 => 'L', 4361 => 'L', 4362 => 'L', 4363 => 'L', 4364 => 'L', 4365 => 'L', 4366 => 'L', 4367 => 'L', 4368 => 'L', 4369 => 'L', 4370 => 'L', 4371 => 'L', 4372 => 'L', 4373 => 'L', 4374 => 'L', 4375 => 'L', 4376 => 'L', 4377 => 'L', 4378 => 'L', 4379 => 'L', 4380 => 'L', 4381 => 'L', 4382 => 'L', 4383 => 'L', 4384 => 'L', 4385 => 'L', 4386 => 'L', 4387 => 'L', 4388 => 'L', 4389 => 'L', 4390 => 'L', 4391 => 'L', 4392 => 'L', 4393 => 'L', 4394 => 'L', 4395 => 'L', 4396 => 'L', 4397 => 'L', 4398 => 'L', 4399 => 'L', 4400 => 'L', 4401 => 'L', 4402 => 'L', 4403 => 'L', 4404 => 'L', 4405 => 'L', 4406 => 'L', 4407 => 'L', 4408 => 'L', 4409 => 'L', 4410 => 'L', 4411 => 'L', 4412 => 'L', 4413 => 'L', 4414 => 'L', 4415 => 'L', 4416 => 'L', 4417 => 'L', 4418 => 'L', 4419 => 'L', 4420 => 'L', 4421 => 'L', 4422 => 'L', 4423 => 'L', 4424 => 'L', 4425 => 'L', 4426 => 'L', 4427 => 'L', 4428 => 'L', 4429 => 'L', 4430 => 'L', 4431 => 'L', 4432 => 'L', 4433 => 'L', 4434 => 'L', 4435 => 'L', 4436 => 'L', 4437 => 'L', 4438 => 'L', 4439 => 'L', 4440 => 'L', 4441 => 'L', 4447 => 'L', 4448 => 'L', 4449 => 'L', 4450 => 'L', 4451 => 'L', 4452 => 'L', 4453 => 'L', 4454 => 'L', 4455 => 'L', 4456 => 'L', 4457 => 'L', 4458 => 'L', 4459 => 'L', 4460 => 'L', 4461 => 'L', 4462 => 'L', 4463 => 'L', 4464 => 'L', 4465 => 'L', 4466 => 'L', 4467 => 'L', 4468 => 'L', 4469 => 'L', 4470 => 'L', 4471 => 'L', 4472 => 'L', 4473 => 'L', 4474 => 'L', 4475 => 'L', 4476 => 'L', 4477 => 'L', 4478 => 'L', 4479 => 'L', 4480 => 'L', 4481 => 'L', 4482 => 'L', 4483 => 'L', 4484 => 'L', 4485 => 'L', 4486 => 'L', 4487 => 'L', 4488 => 'L', 4489 => 'L', 4490 => 'L', 4491 => 'L', 4492 => 'L', 4493 => 'L', 4494 => 'L', 4495 => 'L', 4496 => 'L', 4497 => 'L', 4498 => 'L', 4499 => 'L', 4500 => 'L', 4501 => 'L', 4502 => 'L', 4503 => 'L', 4504 => 'L', 4505 => 'L', 4506 => 'L', 4507 => 'L', 4508 => 'L', 4509 => 'L', 4510 => 'L', 4511 => 'L', 4512 => 'L', 4513 => 'L', 4514 => 'L', 4520 => 'L', 4521 => 'L', 4522 => 'L', 4523 => 'L', 4524 => 'L', 4525 => 'L', 4526 => 'L', 4527 => 'L', 4528 => 'L', 4529 => 'L', 4530 => 'L', 4531 => 'L', 4532 => 'L', 4533 => 'L', 4534 => 'L', 4535 => 'L', 4536 => 'L', 4537 => 'L', 4538 => 'L', 4539 => 'L', 4540 => 'L', 4541 => 'L', 4542 => 'L', 4543 => 'L', 4544 => 'L', 4545 => 'L', 4546 => 'L', 4547 => 'L', 4548 => 'L', 4549 => 'L', 4550 => 'L', 4551 => 'L', 4552 => 'L', 4553 => 'L', 4554 => 'L', 4555 => 'L', 4556 => 'L', 4557 => 'L', 4558 => 'L', 4559 => 'L', 4560 => 'L', 4561 => 'L', 4562 => 'L', 4563 => 'L', 4564 => 'L', 4565 => 'L', 4566 => 'L', 4567 => 'L', 4568 => 'L', 4569 => 'L', 4570 => 'L', 4571 => 'L', 4572 => 'L', 4573 => 'L', 4574 => 'L', 4575 => 'L', 4576 => 'L', 4577 => 'L', 4578 => 'L', 4579 => 'L', 4580 => 'L', 4581 => 'L', 4582 => 'L', 4583 => 'L', 4584 => 'L', 4585 => 'L', 4586 => 'L', 4587 => 'L', 4588 => 'L', 4589 => 'L', 4590 => 'L', 4591 => 'L', 4592 => 'L', 4593 => 'L', 4594 => 'L', 4595 => 'L', 4596 => 'L', 4597 => 'L', 4598 => 'L', 4599 => 'L', 4600 => 'L', 4601 => 'L', 4608 => 'L', 4609 => 'L', 4610 => 'L', 4611 => 'L', 4612 => 'L', 4613 => 'L', 4614 => 'L', 4615 => 'L', 4616 => 'L', 4617 => 'L', 4618 => 'L', 4619 => 'L', 4620 => 'L', 4621 => 'L', 4622 => 'L', 4623 => 'L', 4624 => 'L', 4625 => 'L', 4626 => 'L', 4627 => 'L', 4628 => 'L', 4629 => 'L', 4630 => 'L', 4631 => 'L', 4632 => 'L', 4633 => 'L', 4634 => 'L', 4635 => 'L', 4636 => 'L', 4637 => 'L', 4638 => 'L', 4639 => 'L', 4640 => 'L', 4641 => 'L', 4642 => 'L', 4643 => 'L', 4644 => 'L', 4645 => 'L', 4646 => 'L', 4647 => 'L', 4648 => 'L', 4649 => 'L', 4650 => 'L', 4651 => 'L', 4652 => 'L', 4653 => 'L', 4654 => 'L', 4655 => 'L', 4656 => 'L', 4657 => 'L', 4658 => 'L', 4659 => 'L', 4660 => 'L', 4661 => 'L', 4662 => 'L', 4663 => 'L', 4664 => 'L', 4665 => 'L', 4666 => 'L', 4667 => 'L', 4668 => 'L', 4669 => 'L', 4670 => 'L', 4671 => 'L', 4672 => 'L', 4673 => 'L', 4674 => 'L', 4675 => 'L', 4676 => 'L', 4677 => 'L', 4678 => 'L', 4679 => 'L', 4680 => 'L', 4682 => 'L', 4683 => 'L', 4684 => 'L', 4685 => 'L', 4688 => 'L', 4689 => 'L', 4690 => 'L', 4691 => 'L', 4692 => 'L', 4693 => 'L', 4694 => 'L', 4696 => 'L', 4698 => 'L', 4699 => 'L', 4700 => 'L', 4701 => 'L', 4704 => 'L', 4705 => 'L', 4706 => 'L', 4707 => 'L', 4708 => 'L', 4709 => 'L', 4710 => 'L', 4711 => 'L', 4712 => 'L', 4713 => 'L', 4714 => 'L', 4715 => 'L', 4716 => 'L', 4717 => 'L', 4718 => 'L', 4719 => 'L', 4720 => 'L', 4721 => 'L', 4722 => 'L', 4723 => 'L', 4724 => 'L', 4725 => 'L', 4726 => 'L', 4727 => 'L', 4728 => 'L', 4729 => 'L', 4730 => 'L', 4731 => 'L', 4732 => 'L', 4733 => 'L', 4734 => 'L', 4735 => 'L', 4736 => 'L', 4737 => 'L', 4738 => 'L', 4739 => 'L', 4740 => 'L', 4741 => 'L', 4742 => 'L', 4743 => 'L', 4744 => 'L', 4746 => 'L', 4747 => 'L', 4748 => 'L', 4749 => 'L', 4752 => 'L', 4753 => 'L', 4754 => 'L', 4755 => 'L', 4756 => 'L', 4757 => 'L', 4758 => 'L', 4759 => 'L', 4760 => 'L', 4761 => 'L', 4762 => 'L', 4763 => 'L', 4764 => 'L', 4765 => 'L', 4766 => 'L', 4767 => 'L', 4768 => 'L', 4769 => 'L', 4770 => 'L', 4771 => 'L', 4772 => 'L', 4773 => 'L', 4774 => 'L', 4775 => 'L', 4776 => 'L', 4777 => 'L', 4778 => 'L', 4779 => 'L', 4780 => 'L', 4781 => 'L', 4782 => 'L', 4783 => 'L', 4784 => 'L', 4786 => 'L', 4787 => 'L', 4788 => 'L', 4789 => 'L', 4792 => 'L', 4793 => 'L', 4794 => 'L', 4795 => 'L', 4796 => 'L', 4797 => 'L', 4798 => 'L', 4800 => 'L', 4802 => 'L', 4803 => 'L', 4804 => 'L', 4805 => 'L', 4808 => 'L', 4809 => 'L', 4810 => 'L', 4811 => 'L', 4812 => 'L', 4813 => 'L', 4814 => 'L', 4815 => 'L', 4816 => 'L', 4817 => 'L', 4818 => 'L', 4819 => 'L', 4820 => 'L', 4821 => 'L', 4822 => 'L', 4824 => 'L', 4825 => 'L', 4826 => 'L', 4827 => 'L', 4828 => 'L', 4829 => 'L', 4830 => 'L', 4831 => 'L', 4832 => 'L', 4833 => 'L', 4834 => 'L', 4835 => 'L', 4836 => 'L', 4837 => 'L', 4838 => 'L', 4839 => 'L', 4840 => 'L', 4841 => 'L', 4842 => 'L', 4843 => 'L', 4844 => 'L', 4845 => 'L', 4846 => 'L', 4847 => 'L', 4848 => 'L', 4849 => 'L', 4850 => 'L', 4851 => 'L', 4852 => 'L', 4853 => 'L', 4854 => 'L', 4855 => 'L', 4856 => 'L', 4857 => 'L', 4858 => 'L', 4859 => 'L', 4860 => 'L', 4861 => 'L', 4862 => 'L', 4863 => 'L', 4864 => 'L', 4865 => 'L', 4866 => 'L', 4867 => 'L', 4868 => 'L', 4869 => 'L', 4870 => 'L', 4871 => 'L', 4872 => 'L', 4873 => 'L', 4874 => 'L', 4875 => 'L', 4876 => 'L', 4877 => 'L', 4878 => 'L', 4879 => 'L', 4880 => 'L', 4882 => 'L', 4883 => 'L', 4884 => 'L', 4885 => 'L', 4888 => 'L', 4889 => 'L', 4890 => 'L', 4891 => 'L', 4892 => 'L', 4893 => 'L', 4894 => 'L', 4895 => 'L', 4896 => 'L', 4897 => 'L', 4898 => 'L', 4899 => 'L', 4900 => 'L', 4901 => 'L', 4902 => 'L', 4903 => 'L', 4904 => 'L', 4905 => 'L', 4906 => 'L', 4907 => 'L', 4908 => 'L', 4909 => 'L', 4910 => 'L', 4911 => 'L', 4912 => 'L', 4913 => 'L', 4914 => 'L', 4915 => 'L', 4916 => 'L', 4917 => 'L', 4918 => 'L', 4919 => 'L', 4920 => 'L', 4921 => 'L', 4922 => 'L', 4923 => 'L', 4924 => 'L', 4925 => 'L', 4926 => 'L', 4927 => 'L', 4928 => 'L', 4929 => 'L', 4930 => 'L', 4931 => 'L', 4932 => 'L', 4933 => 'L', 4934 => 'L', 4935 => 'L', 4936 => 'L', 4937 => 'L', 4938 => 'L', 4939 => 'L', 4940 => 'L', 4941 => 'L', 4942 => 'L', 4943 => 'L', 4944 => 'L', 4945 => 'L', 4946 => 'L', 4947 => 'L', 4948 => 'L', 4949 => 'L', 4950 => 'L', 4951 => 'L', 4952 => 'L', 4953 => 'L', 4954 => 'L', 4959 => 'NSM', 4960 => 'L', 4961 => 'L', 4962 => 'L', 4963 => 'L', 4964 => 'L', 4965 => 'L', 4966 => 'L', 4967 => 'L', 4968 => 'L', 4969 => 'L', 4970 => 'L', 4971 => 'L', 4972 => 'L', 4973 => 'L', 4974 => 'L', 4975 => 'L', 4976 => 'L', 4977 => 'L', 4978 => 'L', 4979 => 'L', 4980 => 'L', 4981 => 'L', 4982 => 'L', 4983 => 'L', 4984 => 'L', 4985 => 'L', 4986 => 'L', 4987 => 'L', 4988 => 'L', 4992 => 'L', 4993 => 'L', 4994 => 'L', 4995 => 'L', 4996 => 'L', 4997 => 'L', 4998 => 'L', 4999 => 'L', 5000 => 'L', 5001 => 'L', 5002 => 'L', 5003 => 'L', 5004 => 'L', 5005 => 'L', 5006 => 'L', 5007 => 'L', 5008 => 'ON', 5009 => 'ON', 5010 => 'ON', 5011 => 'ON', 5012 => 'ON', 5013 => 'ON', 5014 => 'ON', 5015 => 'ON', 5016 => 'ON', 5017 => 'ON', 5024 => 'L', 5025 => 'L', 5026 => 'L', 5027 => 'L', 5028 => 'L', 5029 => 'L', 5030 => 'L', 5031 => 'L', 5032 => 'L', 5033 => 'L', 5034 => 'L', 5035 => 'L', 5036 => 'L', 5037 => 'L', 5038 => 'L', 5039 => 'L', 5040 => 'L', 5041 => 'L', 5042 => 'L', 5043 => 'L', 5044 => 'L', 5045 => 'L', 5046 => 'L', 5047 => 'L', 5048 => 'L', 5049 => 'L', 5050 => 'L', 5051 => 'L', 5052 => 'L', 5053 => 'L', 5054 => 'L', 5055 => 'L', 5056 => 'L', 5057 => 'L', 5058 => 'L', 5059 => 'L', 5060 => 'L', 5061 => 'L', 5062 => 'L', 5063 => 'L', 5064 => 'L', 5065 => 'L', 5066 => 'L', 5067 => 'L', 5068 => 'L', 5069 => 'L', 5070 => 'L', 5071 => 'L', 5072 => 'L', 5073 => 'L', 5074 => 'L', 5075 => 'L', 5076 => 'L', 5077 => 'L', 5078 => 'L', 5079 => 'L', 5080 => 'L', 5081 => 'L', 5082 => 'L', 5083 => 'L', 5084 => 'L', 5085 => 'L', 5086 => 'L', 5087 => 'L', 5088 => 'L', 5089 => 'L', 5090 => 'L', 5091 => 'L', 5092 => 'L', 5093 => 'L', 5094 => 'L', 5095 => 'L', 5096 => 'L', 5097 => 'L', 5098 => 'L', 5099 => 'L', 5100 => 'L', 5101 => 'L', 5102 => 'L', 5103 => 'L', 5104 => 'L', 5105 => 'L', 5106 => 'L', 5107 => 'L', 5108 => 'L', 5121 => 'L', 5122 => 'L', 5123 => 'L', 5124 => 'L', 5125 => 'L', 5126 => 'L', 5127 => 'L', 5128 => 'L', 5129 => 'L', 5130 => 'L', 5131 => 'L', 5132 => 'L', 5133 => 'L', 5134 => 'L', 5135 => 'L', 5136 => 'L', 5137 => 'L', 5138 => 'L', 5139 => 'L', 5140 => 'L', 5141 => 'L', 5142 => 'L', 5143 => 'L', 5144 => 'L', 5145 => 'L', 5146 => 'L', 5147 => 'L', 5148 => 'L', 5149 => 'L', 5150 => 'L', 5151 => 'L', 5152 => 'L', 5153 => 'L', 5154 => 'L', 5155 => 'L', 5156 => 'L', 5157 => 'L', 5158 => 'L', 5159 => 'L', 5160 => 'L', 5161 => 'L', 5162 => 'L', 5163 => 'L', 5164 => 'L', 5165 => 'L', 5166 => 'L', 5167 => 'L', 5168 => 'L', 5169 => 'L', 5170 => 'L', 5171 => 'L', 5172 => 'L', 5173 => 'L', 5174 => 'L', 5175 => 'L', 5176 => 'L', 5177 => 'L', 5178 => 'L', 5179 => 'L', 5180 => 'L', 5181 => 'L', 5182 => 'L', 5183 => 'L', 5184 => 'L', 5185 => 'L', 5186 => 'L', 5187 => 'L', 5188 => 'L', 5189 => 'L', 5190 => 'L', 5191 => 'L', 5192 => 'L', 5193 => 'L', 5194 => 'L', 5195 => 'L', 5196 => 'L', 5197 => 'L', 5198 => 'L', 5199 => 'L', 5200 => 'L', 5201 => 'L', 5202 => 'L', 5203 => 'L', 5204 => 'L', 5205 => 'L', 5206 => 'L', 5207 => 'L', 5208 => 'L', 5209 => 'L', 5210 => 'L', 5211 => 'L', 5212 => 'L', 5213 => 'L', 5214 => 'L', 5215 => 'L', 5216 => 'L', 5217 => 'L', 5218 => 'L', 5219 => 'L', 5220 => 'L', 5221 => 'L', 5222 => 'L', 5223 => 'L', 5224 => 'L', 5225 => 'L', 5226 => 'L', 5227 => 'L', 5228 => 'L', 5229 => 'L', 5230 => 'L', 5231 => 'L', 5232 => 'L', 5233 => 'L', 5234 => 'L', 5235 => 'L', 5236 => 'L', 5237 => 'L', 5238 => 'L', 5239 => 'L', 5240 => 'L', 5241 => 'L', 5242 => 'L', 5243 => 'L', 5244 => 'L', 5245 => 'L', 5246 => 'L', 5247 => 'L', 5248 => 'L', 5249 => 'L', 5250 => 'L', 5251 => 'L', 5252 => 'L', 5253 => 'L', 5254 => 'L', 5255 => 'L', 5256 => 'L', 5257 => 'L', 5258 => 'L', 5259 => 'L', 5260 => 'L', 5261 => 'L', 5262 => 'L', 5263 => 'L', 5264 => 'L', 5265 => 'L', 5266 => 'L', 5267 => 'L', 5268 => 'L', 5269 => 'L', 5270 => 'L', 5271 => 'L', 5272 => 'L', 5273 => 'L', 5274 => 'L', 5275 => 'L', 5276 => 'L', 5277 => 'L', 5278 => 'L', 5279 => 'L', 5280 => 'L', 5281 => 'L', 5282 => 'L', 5283 => 'L', 5284 => 'L', 5285 => 'L', 5286 => 'L', 5287 => 'L', 5288 => 'L', 5289 => 'L', 5290 => 'L', 5291 => 'L', 5292 => 'L', 5293 => 'L', 5294 => 'L', 5295 => 'L', 5296 => 'L', 5297 => 'L', 5298 => 'L', 5299 => 'L', 5300 => 'L', 5301 => 'L', 5302 => 'L', 5303 => 'L', 5304 => 'L', 5305 => 'L', 5306 => 'L', 5307 => 'L', 5308 => 'L', 5309 => 'L', 5310 => 'L', 5311 => 'L', 5312 => 'L', 5313 => 'L', 5314 => 'L', 5315 => 'L', 5316 => 'L', 5317 => 'L', 5318 => 'L', 5319 => 'L', 5320 => 'L', 5321 => 'L', 5322 => 'L', 5323 => 'L', 5324 => 'L', 5325 => 'L', 5326 => 'L', 5327 => 'L', 5328 => 'L', 5329 => 'L', 5330 => 'L', 5331 => 'L', 5332 => 'L', 5333 => 'L', 5334 => 'L', 5335 => 'L', 5336 => 'L', 5337 => 'L', 5338 => 'L', 5339 => 'L', 5340 => 'L', 5341 => 'L', 5342 => 'L', 5343 => 'L', 5344 => 'L', 5345 => 'L', 5346 => 'L', 5347 => 'L', 5348 => 'L', 5349 => 'L', 5350 => 'L', 5351 => 'L', 5352 => 'L', 5353 => 'L', 5354 => 'L', 5355 => 'L', 5356 => 'L', 5357 => 'L', 5358 => 'L', 5359 => 'L', 5360 => 'L', 5361 => 'L', 5362 => 'L', 5363 => 'L', 5364 => 'L', 5365 => 'L', 5366 => 'L', 5367 => 'L', 5368 => 'L', 5369 => 'L', 5370 => 'L', 5371 => 'L', 5372 => 'L', 5373 => 'L', 5374 => 'L', 5375 => 'L', 5376 => 'L', 5377 => 'L', 5378 => 'L', 5379 => 'L', 5380 => 'L', 5381 => 'L', 5382 => 'L', 5383 => 'L', 5384 => 'L', 5385 => 'L', 5386 => 'L', 5387 => 'L', 5388 => 'L', 5389 => 'L', 5390 => 'L', 5391 => 'L', 5392 => 'L', 5393 => 'L', 5394 => 'L', 5395 => 'L', 5396 => 'L', 5397 => 'L', 5398 => 'L', 5399 => 'L', 5400 => 'L', 5401 => 'L', 5402 => 'L', 5403 => 'L', 5404 => 'L', 5405 => 'L', 5406 => 'L', 5407 => 'L', 5408 => 'L', 5409 => 'L', 5410 => 'L', 5411 => 'L', 5412 => 'L', 5413 => 'L', 5414 => 'L', 5415 => 'L', 5416 => 'L', 5417 => 'L', 5418 => 'L', 5419 => 'L', 5420 => 'L', 5421 => 'L', 5422 => 'L', 5423 => 'L', 5424 => 'L', 5425 => 'L', 5426 => 'L', 5427 => 'L', 5428 => 'L', 5429 => 'L', 5430 => 'L', 5431 => 'L', 5432 => 'L', 5433 => 'L', 5434 => 'L', 5435 => 'L', 5436 => 'L', 5437 => 'L', 5438 => 'L', 5439 => 'L', 5440 => 'L', 5441 => 'L', 5442 => 'L', 5443 => 'L', 5444 => 'L', 5445 => 'L', 5446 => 'L', 5447 => 'L', 5448 => 'L', 5449 => 'L', 5450 => 'L', 5451 => 'L', 5452 => 'L', 5453 => 'L', 5454 => 'L', 5455 => 'L', 5456 => 'L', 5457 => 'L', 5458 => 'L', 5459 => 'L', 5460 => 'L', 5461 => 'L', 5462 => 'L', 5463 => 'L', 5464 => 'L', 5465 => 'L', 5466 => 'L', 5467 => 'L', 5468 => 'L', 5469 => 'L', 5470 => 'L', 5471 => 'L', 5472 => 'L', 5473 => 'L', 5474 => 'L', 5475 => 'L', 5476 => 'L', 5477 => 'L', 5478 => 'L', 5479 => 'L', 5480 => 'L', 5481 => 'L', 5482 => 'L', 5483 => 'L', 5484 => 'L', 5485 => 'L', 5486 => 'L', 5487 => 'L', 5488 => 'L', 5489 => 'L', 5490 => 'L', 5491 => 'L', 5492 => 'L', 5493 => 'L', 5494 => 'L', 5495 => 'L', 5496 => 'L', 5497 => 'L', 5498 => 'L', 5499 => 'L', 5500 => 'L', 5501 => 'L', 5502 => 'L', 5503 => 'L', 5504 => 'L', 5505 => 'L', 5506 => 'L', 5507 => 'L', 5508 => 'L', 5509 => 'L', 5510 => 'L', 5511 => 'L', 5512 => 'L', 5513 => 'L', 5514 => 'L', 5515 => 'L', 5516 => 'L', 5517 => 'L', 5518 => 'L', 5519 => 'L', 5520 => 'L', 5521 => 'L', 5522 => 'L', 5523 => 'L', 5524 => 'L', 5525 => 'L', 5526 => 'L', 5527 => 'L', 5528 => 'L', 5529 => 'L', 5530 => 'L', 5531 => 'L', 5532 => 'L', 5533 => 'L', 5534 => 'L', 5535 => 'L', 5536 => 'L', 5537 => 'L', 5538 => 'L', 5539 => 'L', 5540 => 'L', 5541 => 'L', 5542 => 'L', 5543 => 'L', 5544 => 'L', 5545 => 'L', 5546 => 'L', 5547 => 'L', 5548 => 'L', 5549 => 'L', 5550 => 'L', 5551 => 'L', 5552 => 'L', 5553 => 'L', 5554 => 'L', 5555 => 'L', 5556 => 'L', 5557 => 'L', 5558 => 'L', 5559 => 'L', 5560 => 'L', 5561 => 'L', 5562 => 'L', 5563 => 'L', 5564 => 'L', 5565 => 'L', 5566 => 'L', 5567 => 'L', 5568 => 'L', 5569 => 'L', 5570 => 'L', 5571 => 'L', 5572 => 'L', 5573 => 'L', 5574 => 'L', 5575 => 'L', 5576 => 'L', 5577 => 'L', 5578 => 'L', 5579 => 'L', 5580 => 'L', 5581 => 'L', 5582 => 'L', 5583 => 'L', 5584 => 'L', 5585 => 'L', 5586 => 'L', 5587 => 'L', 5588 => 'L', 5589 => 'L', 5590 => 'L', 5591 => 'L', 5592 => 'L', 5593 => 'L', 5594 => 'L', 5595 => 'L', 5596 => 'L', 5597 => 'L', 5598 => 'L', 5599 => 'L', 5600 => 'L', 5601 => 'L', 5602 => 'L', 5603 => 'L', 5604 => 'L', 5605 => 'L', 5606 => 'L', 5607 => 'L', 5608 => 'L', 5609 => 'L', 5610 => 'L', 5611 => 'L', 5612 => 'L', 5613 => 'L', 5614 => 'L', 5615 => 'L', 5616 => 'L', 5617 => 'L', 5618 => 'L', 5619 => 'L', 5620 => 'L', 5621 => 'L', 5622 => 'L', 5623 => 'L', 5624 => 'L', 5625 => 'L', 5626 => 'L', 5627 => 'L', 5628 => 'L', 5629 => 'L', 5630 => 'L', 5631 => 'L', 5632 => 'L', 5633 => 'L', 5634 => 'L', 5635 => 'L', 5636 => 'L', 5637 => 'L', 5638 => 'L', 5639 => 'L', 5640 => 'L', 5641 => 'L', 5642 => 'L', 5643 => 'L', 5644 => 'L', 5645 => 'L', 5646 => 'L', 5647 => 'L', 5648 => 'L', 5649 => 'L', 5650 => 'L', 5651 => 'L', 5652 => 'L', 5653 => 'L', 5654 => 'L', 5655 => 'L', 5656 => 'L', 5657 => 'L', 5658 => 'L', 5659 => 'L', 5660 => 'L', 5661 => 'L', 5662 => 'L', 5663 => 'L', 5664 => 'L', 5665 => 'L', 5666 => 'L', 5667 => 'L', 5668 => 'L', 5669 => 'L', 5670 => 'L', 5671 => 'L', 5672 => 'L', 5673 => 'L', 5674 => 'L', 5675 => 'L', 5676 => 'L', 5677 => 'L', 5678 => 'L', 5679 => 'L', 5680 => 'L', 5681 => 'L', 5682 => 'L', 5683 => 'L', 5684 => 'L', 5685 => 'L', 5686 => 'L', 5687 => 'L', 5688 => 'L', 5689 => 'L', 5690 => 'L', 5691 => 'L', 5692 => 'L', 5693 => 'L', 5694 => 'L', 5695 => 'L', 5696 => 'L', 5697 => 'L', 5698 => 'L', 5699 => 'L', 5700 => 'L', 5701 => 'L', 5702 => 'L', 5703 => 'L', 5704 => 'L', 5705 => 'L', 5706 => 'L', 5707 => 'L', 5708 => 'L', 5709 => 'L', 5710 => 'L', 5711 => 'L', 5712 => 'L', 5713 => 'L', 5714 => 'L', 5715 => 'L', 5716 => 'L', 5717 => 'L', 5718 => 'L', 5719 => 'L', 5720 => 'L', 5721 => 'L', 5722 => 'L', 5723 => 'L', 5724 => 'L', 5725 => 'L', 5726 => 'L', 5727 => 'L', 5728 => 'L', 5729 => 'L', 5730 => 'L', 5731 => 'L', 5732 => 'L', 5733 => 'L', 5734 => 'L', 5735 => 'L', 5736 => 'L', 5737 => 'L', 5738 => 'L', 5739 => 'L', 5740 => 'L', 5741 => 'L', 5742 => 'L', 5743 => 'L', 5744 => 'L', 5745 => 'L', 5746 => 'L', 5747 => 'L', 5748 => 'L', 5749 => 'L', 5750 => 'L', 5760 => 'WS', 5761 => 'L', 5762 => 'L', 5763 => 'L', 5764 => 'L', 5765 => 'L', 5766 => 'L', 5767 => 'L', 5768 => 'L', 5769 => 'L', 5770 => 'L', 5771 => 'L', 5772 => 'L', 5773 => 'L', 5774 => 'L', 5775 => 'L', 5776 => 'L', 5777 => 'L', 5778 => 'L', 5779 => 'L', 5780 => 'L', 5781 => 'L', 5782 => 'L', 5783 => 'L', 5784 => 'L', 5785 => 'L', 5786 => 'L', 5787 => 'ON', 5788 => 'ON', 5792 => 'L', 5793 => 'L', 5794 => 'L', 5795 => 'L', 5796 => 'L', 5797 => 'L', 5798 => 'L', 5799 => 'L', 5800 => 'L', 5801 => 'L', 5802 => 'L', 5803 => 'L', 5804 => 'L', 5805 => 'L', 5806 => 'L', 5807 => 'L', 5808 => 'L', 5809 => 'L', 5810 => 'L', 5811 => 'L', 5812 => 'L', 5813 => 'L', 5814 => 'L', 5815 => 'L', 5816 => 'L', 5817 => 'L', 5818 => 'L', 5819 => 'L', 5820 => 'L', 5821 => 'L', 5822 => 'L', 5823 => 'L', 5824 => 'L', 5825 => 'L', 5826 => 'L', 5827 => 'L', 5828 => 'L', 5829 => 'L', 5830 => 'L', 5831 => 'L', 5832 => 'L', 5833 => 'L', 5834 => 'L', 5835 => 'L', 5836 => 'L', 5837 => 'L', 5838 => 'L', 5839 => 'L', 5840 => 'L', 5841 => 'L', 5842 => 'L', 5843 => 'L', 5844 => 'L', 5845 => 'L', 5846 => 'L', 5847 => 'L', 5848 => 'L', 5849 => 'L', 5850 => 'L', 5851 => 'L', 5852 => 'L', 5853 => 'L', 5854 => 'L', 5855 => 'L', 5856 => 'L', 5857 => 'L', 5858 => 'L', 5859 => 'L', 5860 => 'L', 5861 => 'L', 5862 => 'L', 5863 => 'L', 5864 => 'L', 5865 => 'L', 5866 => 'L', 5867 => 'L', 5868 => 'L', 5869 => 'L', 5870 => 'L', 5871 => 'L', 5872 => 'L', 5888 => 'L', 5889 => 'L', 5890 => 'L', 5891 => 'L', 5892 => 'L', 5893 => 'L', 5894 => 'L', 5895 => 'L', 5896 => 'L', 5897 => 'L', 5898 => 'L', 5899 => 'L', 5900 => 'L', 5902 => 'L', 5903 => 'L', 5904 => 'L', 5905 => 'L', 5906 => 'NSM', 5907 => 'NSM', 5908 => 'NSM', 5920 => 'L', 5921 => 'L', 5922 => 'L', 5923 => 'L', 5924 => 'L', 5925 => 'L', 5926 => 'L', 5927 => 'L', 5928 => 'L', 5929 => 'L', 5930 => 'L', 5931 => 'L', 5932 => 'L', 5933 => 'L', 5934 => 'L', 5935 => 'L', 5936 => 'L', 5937 => 'L', 5938 => 'NSM', 5939 => 'NSM', 5940 => 'NSM', 5941 => 'L', 5942 => 'L', 5952 => 'L', 5953 => 'L', 5954 => 'L', 5955 => 'L', 5956 => 'L', 5957 => 'L', 5958 => 'L', 5959 => 'L', 5960 => 'L', 5961 => 'L', 5962 => 'L', 5963 => 'L', 5964 => 'L', 5965 => 'L', 5966 => 'L', 5967 => 'L', 5968 => 'L', 5969 => 'L', 5970 => 'NSM', 5971 => 'NSM', 5984 => 'L', 5985 => 'L', 5986 => 'L', 5987 => 'L', 5988 => 'L', 5989 => 'L', 5990 => 'L', 5991 => 'L', 5992 => 'L', 5993 => 'L', 5994 => 'L', 5995 => 'L', 5996 => 'L', 5998 => 'L', 5999 => 'L', 6000 => 'L', 6002 => 'NSM', 6003 => 'NSM', 6016 => 'L', 6017 => 'L', 6018 => 'L', 6019 => 'L', 6020 => 'L', 6021 => 'L', 6022 => 'L', 6023 => 'L', 6024 => 'L', 6025 => 'L', 6026 => 'L', 6027 => 'L', 6028 => 'L', 6029 => 'L', 6030 => 'L', 6031 => 'L', 6032 => 'L', 6033 => 'L', 6034 => 'L', 6035 => 'L', 6036 => 'L', 6037 => 'L', 6038 => 'L', 6039 => 'L', 6040 => 'L', 6041 => 'L', 6042 => 'L', 6043 => 'L', 6044 => 'L', 6045 => 'L', 6046 => 'L', 6047 => 'L', 6048 => 'L', 6049 => 'L', 6050 => 'L', 6051 => 'L', 6052 => 'L', 6053 => 'L', 6054 => 'L', 6055 => 'L', 6056 => 'L', 6057 => 'L', 6058 => 'L', 6059 => 'L', 6060 => 'L', 6061 => 'L', 6062 => 'L', 6063 => 'L', 6064 => 'L', 6065 => 'L', 6066 => 'L', 6067 => 'L', 6068 => 'L', 6069 => 'L', 6070 => 'L', 6071 => 'NSM', 6072 => 'NSM', 6073 => 'NSM', 6074 => 'NSM', 6075 => 'NSM', 6076 => 'NSM', 6077 => 'NSM', 6078 => 'L', 6079 => 'L', 6080 => 'L', 6081 => 'L', 6082 => 'L', 6083 => 'L', 6084 => 'L', 6085 => 'L', 6086 => 'NSM', 6087 => 'L', 6088 => 'L', 6089 => 'NSM', 6090 => 'NSM', 6091 => 'NSM', 6092 => 'NSM', 6093 => 'NSM', 6094 => 'NSM', 6095 => 'NSM', 6096 => 'NSM', 6097 => 'NSM', 6098 => 'NSM', 6099 => 'NSM', 6100 => 'L', 6101 => 'L', 6102 => 'L', 6103 => 'L', 6104 => 'L', 6105 => 'L', 6106 => 'L', 6107 => 'ET', 6108 => 'L', 6109 => 'NSM', 6112 => 'L', 6113 => 'L', 6114 => 'L', 6115 => 'L', 6116 => 'L', 6117 => 'L', 6118 => 'L', 6119 => 'L', 6120 => 'L', 6121 => 'L', 6128 => 'ON', 6129 => 'ON', 6130 => 'ON', 6131 => 'ON', 6132 => 'ON', 6133 => 'ON', 6134 => 'ON', 6135 => 'ON', 6136 => 'ON', 6137 => 'ON', 6144 => 'ON', 6145 => 'ON', 6146 => 'ON', 6147 => 'ON', 6148 => 'ON', 6149 => 'ON', 6150 => 'ON', 6151 => 'ON', 6152 => 'ON', 6153 => 'ON', 6154 => 'ON', 6155 => 'NSM', 6156 => 'NSM', 6157 => 'NSM', 6158 => 'WS', 6160 => 'L', 6161 => 'L', 6162 => 'L', 6163 => 'L', 6164 => 'L', 6165 => 'L', 6166 => 'L', 6167 => 'L', 6168 => 'L', 6169 => 'L', 6176 => 'L', 6177 => 'L', 6178 => 'L', 6179 => 'L', 6180 => 'L', 6181 => 'L', 6182 => 'L', 6183 => 'L', 6184 => 'L', 6185 => 'L', 6186 => 'L', 6187 => 'L', 6188 => 'L', 6189 => 'L', 6190 => 'L', 6191 => 'L', 6192 => 'L', 6193 => 'L', 6194 => 'L', 6195 => 'L', 6196 => 'L', 6197 => 'L', 6198 => 'L', 6199 => 'L', 6200 => 'L', 6201 => 'L', 6202 => 'L', 6203 => 'L', 6204 => 'L', 6205 => 'L', 6206 => 'L', 6207 => 'L', 6208 => 'L', 6209 => 'L', 6210 => 'L', 6211 => 'L', 6212 => 'L', 6213 => 'L', 6214 => 'L', 6215 => 'L', 6216 => 'L', 6217 => 'L', 6218 => 'L', 6219 => 'L', 6220 => 'L', 6221 => 'L', 6222 => 'L', 6223 => 'L', 6224 => 'L', 6225 => 'L', 6226 => 'L', 6227 => 'L', 6228 => 'L', 6229 => 'L', 6230 => 'L', 6231 => 'L', 6232 => 'L', 6233 => 'L', 6234 => 'L', 6235 => 'L', 6236 => 'L', 6237 => 'L', 6238 => 'L', 6239 => 'L', 6240 => 'L', 6241 => 'L', 6242 => 'L', 6243 => 'L', 6244 => 'L', 6245 => 'L', 6246 => 'L', 6247 => 'L', 6248 => 'L', 6249 => 'L', 6250 => 'L', 6251 => 'L', 6252 => 'L', 6253 => 'L', 6254 => 'L', 6255 => 'L', 6256 => 'L', 6257 => 'L', 6258 => 'L', 6259 => 'L', 6260 => 'L', 6261 => 'L', 6262 => 'L', 6263 => 'L', 6272 => 'L', 6273 => 'L', 6274 => 'L', 6275 => 'L', 6276 => 'L', 6277 => 'L', 6278 => 'L', 6279 => 'L', 6280 => 'L', 6281 => 'L', 6282 => 'L', 6283 => 'L', 6284 => 'L', 6285 => 'L', 6286 => 'L', 6287 => 'L', 6288 => 'L', 6289 => 'L', 6290 => 'L', 6291 => 'L', 6292 => 'L', 6293 => 'L', 6294 => 'L', 6295 => 'L', 6296 => 'L', 6297 => 'L', 6298 => 'L', 6299 => 'L', 6300 => 'L', 6301 => 'L', 6302 => 'L', 6303 => 'L', 6304 => 'L', 6305 => 'L', 6306 => 'L', 6307 => 'L', 6308 => 'L', 6309 => 'L', 6310 => 'L', 6311 => 'L', 6312 => 'L', 6313 => 'NSM', 6400 => 'L', 6401 => 'L', 6402 => 'L', 6403 => 'L', 6404 => 'L', 6405 => 'L', 6406 => 'L', 6407 => 'L', 6408 => 'L', 6409 => 'L', 6410 => 'L', 6411 => 'L', 6412 => 'L', 6413 => 'L', 6414 => 'L', 6415 => 'L', 6416 => 'L', 6417 => 'L', 6418 => 'L', 6419 => 'L', 6420 => 'L', 6421 => 'L', 6422 => 'L', 6423 => 'L', 6424 => 'L', 6425 => 'L', 6426 => 'L', 6427 => 'L', 6428 => 'L', 6432 => 'NSM', 6433 => 'NSM', 6434 => 'NSM', 6435 => 'L', 6436 => 'L', 6437 => 'L', 6438 => 'L', 6439 => 'NSM', 6440 => 'NSM', 6441 => 'NSM', 6442 => 'NSM', 6443 => 'NSM', 6448 => 'L', 6449 => 'L', 6450 => 'NSM', 6451 => 'L', 6452 => 'L', 6453 => 'L', 6454 => 'L', 6455 => 'L', 6456 => 'L', 6457 => 'NSM', 6458 => 'NSM', 6459 => 'NSM', 6464 => 'ON', 6468 => 'ON', 6469 => 'ON', 6470 => 'L', 6471 => 'L', 6472 => 'L', 6473 => 'L', 6474 => 'L', 6475 => 'L', 6476 => 'L', 6477 => 'L', 6478 => 'L', 6479 => 'L', 6480 => 'L', 6481 => 'L', 6482 => 'L', 6483 => 'L', 6484 => 'L', 6485 => 'L', 6486 => 'L', 6487 => 'L', 6488 => 'L', 6489 => 'L', 6490 => 'L', 6491 => 'L', 6492 => 'L', 6493 => 'L', 6494 => 'L', 6495 => 'L', 6496 => 'L', 6497 => 'L', 6498 => 'L', 6499 => 'L', 6500 => 'L', 6501 => 'L', 6502 => 'L', 6503 => 'L', 6504 => 'L', 6505 => 'L', 6506 => 'L', 6507 => 'L', 6508 => 'L', 6509 => 'L', 6512 => 'L', 6513 => 'L', 6514 => 'L', 6515 => 'L', 6516 => 'L', 6528 => 'L', 6529 => 'L', 6530 => 'L', 6531 => 'L', 6532 => 'L', 6533 => 'L', 6534 => 'L', 6535 => 'L', 6536 => 'L', 6537 => 'L', 6538 => 'L', 6539 => 'L', 6540 => 'L', 6541 => 'L', 6542 => 'L', 6543 => 'L', 6544 => 'L', 6545 => 'L', 6546 => 'L', 6547 => 'L', 6548 => 'L', 6549 => 'L', 6550 => 'L', 6551 => 'L', 6552 => 'L', 6553 => 'L', 6554 => 'L', 6555 => 'L', 6556 => 'L', 6557 => 'L', 6558 => 'L', 6559 => 'L', 6560 => 'L', 6561 => 'L', 6562 => 'L', 6563 => 'L', 6564 => 'L', 6565 => 'L', 6566 => 'L', 6567 => 'L', 6568 => 'L', 6569 => 'L', 6576 => 'L', 6577 => 'L', 6578 => 'L', 6579 => 'L', 6580 => 'L', 6581 => 'L', 6582 => 'L', 6583 => 'L', 6584 => 'L', 6585 => 'L', 6586 => 'L', 6587 => 'L', 6588 => 'L', 6589 => 'L', 6590 => 'L', 6591 => 'L', 6592 => 'L', 6593 => 'L', 6594 => 'L', 6595 => 'L', 6596 => 'L', 6597 => 'L', 6598 => 'L', 6599 => 'L', 6600 => 'L', 6601 => 'L', 6608 => 'L', 6609 => 'L', 6610 => 'L', 6611 => 'L', 6612 => 'L', 6613 => 'L', 6614 => 'L', 6615 => 'L', 6616 => 'L', 6617 => 'L', 6622 => 'ON', 6623 => 'ON', 6624 => 'ON', 6625 => 'ON', 6626 => 'ON', 6627 => 'ON', 6628 => 'ON', 6629 => 'ON', 6630 => 'ON', 6631 => 'ON', 6632 => 'ON', 6633 => 'ON', 6634 => 'ON', 6635 => 'ON', 6636 => 'ON', 6637 => 'ON', 6638 => 'ON', 6639 => 'ON', 6640 => 'ON', 6641 => 'ON', 6642 => 'ON', 6643 => 'ON', 6644 => 'ON', 6645 => 'ON', 6646 => 'ON', 6647 => 'ON', 6648 => 'ON', 6649 => 'ON', 6650 => 'ON', 6651 => 'ON', 6652 => 'ON', 6653 => 'ON', 6654 => 'ON', 6655 => 'ON', 6656 => 'L', 6657 => 'L', 6658 => 'L', 6659 => 'L', 6660 => 'L', 6661 => 'L', 6662 => 'L', 6663 => 'L', 6664 => 'L', 6665 => 'L', 6666 => 'L', 6667 => 'L', 6668 => 'L', 6669 => 'L', 6670 => 'L', 6671 => 'L', 6672 => 'L', 6673 => 'L', 6674 => 'L', 6675 => 'L', 6676 => 'L', 6677 => 'L', 6678 => 'L', 6679 => 'NSM', 6680 => 'NSM', 6681 => 'L', 6682 => 'L', 6683 => 'L', 6686 => 'L', 6687 => 'L', 6912 => 'NSM', 6913 => 'NSM', 6914 => 'NSM', 6915 => 'NSM', 6916 => 'L', 6917 => 'L', 6918 => 'L', 6919 => 'L', 6920 => 'L', 6921 => 'L', 6922 => 'L', 6923 => 'L', 6924 => 'L', 6925 => 'L', 6926 => 'L', 6927 => 'L', 6928 => 'L', 6929 => 'L', 6930 => 'L', 6931 => 'L', 6932 => 'L', 6933 => 'L', 6934 => 'L', 6935 => 'L', 6936 => 'L', 6937 => 'L', 6938 => 'L', 6939 => 'L', 6940 => 'L', 6941 => 'L', 6942 => 'L', 6943 => 'L', 6944 => 'L', 6945 => 'L', 6946 => 'L', 6947 => 'L', 6948 => 'L', 6949 => 'L', 6950 => 'L', 6951 => 'L', 6952 => 'L', 6953 => 'L', 6954 => 'L', 6955 => 'L', 6956 => 'L', 6957 => 'L', 6958 => 'L', 6959 => 'L', 6960 => 'L', 6961 => 'L', 6962 => 'L', 6963 => 'L', 6964 => 'NSM', 6965 => 'L', 6966 => 'NSM', 6967 => 'NSM', 6968 => 'NSM', 6969 => 'NSM', 6970 => 'NSM', 6971 => 'L', 6972 => 'NSM', 6973 => 'L', 6974 => 'L', 6975 => 'L', 6976 => 'L', 6977 => 'L', 6978 => 'NSM', 6979 => 'L', 6980 => 'L', 6981 => 'L', 6982 => 'L', 6983 => 'L', 6984 => 'L', 6985 => 'L', 6986 => 'L', 6987 => 'L', 6992 => 'L', 6993 => 'L', 6994 => 'L', 6995 => 'L', 6996 => 'L', 6997 => 'L', 6998 => 'L', 6999 => 'L', 7000 => 'L', 7001 => 'L', 7002 => 'L', 7003 => 'L', 7004 => 'L', 7005 => 'L', 7006 => 'L', 7007 => 'L', 7008 => 'L', 7009 => 'L', 7010 => 'L', 7011 => 'L', 7012 => 'L', 7013 => 'L', 7014 => 'L', 7015 => 'L', 7016 => 'L', 7017 => 'L', 7018 => 'L', 7019 => 'NSM', 7020 => 'NSM', 7021 => 'NSM', 7022 => 'NSM', 7023 => 'NSM', 7024 => 'NSM', 7025 => 'NSM', 7026 => 'NSM', 7027 => 'NSM', 7028 => 'L', 7029 => 'L', 7030 => 'L', 7031 => 'L', 7032 => 'L', 7033 => 'L', 7034 => 'L', 7035 => 'L', 7036 => 'L', 7424 => 'L', 7425 => 'L', 7426 => 'L', 7427 => 'L', 7428 => 'L', 7429 => 'L', 7430 => 'L', 7431 => 'L', 7432 => 'L', 7433 => 'L', 7434 => 'L', 7435 => 'L', 7436 => 'L', 7437 => 'L', 7438 => 'L', 7439 => 'L', 7440 => 'L', 7441 => 'L', 7442 => 'L', 7443 => 'L', 7444 => 'L', 7445 => 'L', 7446 => 'L', 7447 => 'L', 7448 => 'L', 7449 => 'L', 7450 => 'L', 7451 => 'L', 7452 => 'L', 7453 => 'L', 7454 => 'L', 7455 => 'L', 7456 => 'L', 7457 => 'L', 7458 => 'L', 7459 => 'L', 7460 => 'L', 7461 => 'L', 7462 => 'L', 7463 => 'L', 7464 => 'L', 7465 => 'L', 7466 => 'L', 7467 => 'L', 7468 => 'L', 7469 => 'L', 7470 => 'L', 7471 => 'L', 7472 => 'L', 7473 => 'L', 7474 => 'L', 7475 => 'L', 7476 => 'L', 7477 => 'L', 7478 => 'L', 7479 => 'L', 7480 => 'L', 7481 => 'L', 7482 => 'L', 7483 => 'L', 7484 => 'L', 7485 => 'L', 7486 => 'L', 7487 => 'L', 7488 => 'L', 7489 => 'L', 7490 => 'L', 7491 => 'L', 7492 => 'L', 7493 => 'L', 7494 => 'L', 7495 => 'L', 7496 => 'L', 7497 => 'L', 7498 => 'L', 7499 => 'L', 7500 => 'L', 7501 => 'L', 7502 => 'L', 7503 => 'L', 7504 => 'L', 7505 => 'L', 7506 => 'L', 7507 => 'L', 7508 => 'L', 7509 => 'L', 7510 => 'L', 7511 => 'L', 7512 => 'L', 7513 => 'L', 7514 => 'L', 7515 => 'L', 7516 => 'L', 7517 => 'L', 7518 => 'L', 7519 => 'L', 7520 => 'L', 7521 => 'L', 7522 => 'L', 7523 => 'L', 7524 => 'L', 7525 => 'L', 7526 => 'L', 7527 => 'L', 7528 => 'L', 7529 => 'L', 7530 => 'L', 7531 => 'L', 7532 => 'L', 7533 => 'L', 7534 => 'L', 7535 => 'L', 7536 => 'L', 7537 => 'L', 7538 => 'L', 7539 => 'L', 7540 => 'L', 7541 => 'L', 7542 => 'L', 7543 => 'L', 7544 => 'L', 7545 => 'L', 7546 => 'L', 7547 => 'L', 7548 => 'L', 7549 => 'L', 7550 => 'L', 7551 => 'L', 7552 => 'L', 7553 => 'L', 7554 => 'L', 7555 => 'L', 7556 => 'L', 7557 => 'L', 7558 => 'L', 7559 => 'L', 7560 => 'L', 7561 => 'L', 7562 => 'L', 7563 => 'L', 7564 => 'L', 7565 => 'L', 7566 => 'L', 7567 => 'L', 7568 => 'L', 7569 => 'L', 7570 => 'L', 7571 => 'L', 7572 => 'L', 7573 => 'L', 7574 => 'L', 7575 => 'L', 7576 => 'L', 7577 => 'L', 7578 => 'L', 7579 => 'L', 7580 => 'L', 7581 => 'L', 7582 => 'L', 7583 => 'L', 7584 => 'L', 7585 => 'L', 7586 => 'L', 7587 => 'L', 7588 => 'L', 7589 => 'L', 7590 => 'L', 7591 => 'L', 7592 => 'L', 7593 => 'L', 7594 => 'L', 7595 => 'L', 7596 => 'L', 7597 => 'L', 7598 => 'L', 7599 => 'L', 7600 => 'L', 7601 => 'L', 7602 => 'L', 7603 => 'L', 7604 => 'L', 7605 => 'L', 7606 => 'L', 7607 => 'L', 7608 => 'L', 7609 => 'L', 7610 => 'L', 7611 => 'L', 7612 => 'L', 7613 => 'L', 7614 => 'L', 7615 => 'L', 7616 => 'NSM', 7617 => 'NSM', 7618 => 'NSM', 7619 => 'NSM', 7620 => 'NSM', 7621 => 'NSM', 7622 => 'NSM', 7623 => 'NSM', 7624 => 'NSM', 7625 => 'NSM', 7626 => 'NSM', 7678 => 'NSM', 7679 => 'NSM', 7680 => 'L', 7681 => 'L', 7682 => 'L', 7683 => 'L', 7684 => 'L', 7685 => 'L', 7686 => 'L', 7687 => 'L', 7688 => 'L', 7689 => 'L', 7690 => 'L', 7691 => 'L', 7692 => 'L', 7693 => 'L', 7694 => 'L', 7695 => 'L', 7696 => 'L', 7697 => 'L', 7698 => 'L', 7699 => 'L', 7700 => 'L', 7701 => 'L', 7702 => 'L', 7703 => 'L', 7704 => 'L', 7705 => 'L', 7706 => 'L', 7707 => 'L', 7708 => 'L', 7709 => 'L', 7710 => 'L', 7711 => 'L', 7712 => 'L', 7713 => 'L', 7714 => 'L', 7715 => 'L', 7716 => 'L', 7717 => 'L', 7718 => 'L', 7719 => 'L', 7720 => 'L', 7721 => 'L', 7722 => 'L', 7723 => 'L', 7724 => 'L', 7725 => 'L', 7726 => 'L', 7727 => 'L', 7728 => 'L', 7729 => 'L', 7730 => 'L', 7731 => 'L', 7732 => 'L', 7733 => 'L', 7734 => 'L', 7735 => 'L', 7736 => 'L', 7737 => 'L', 7738 => 'L', 7739 => 'L', 7740 => 'L', 7741 => 'L', 7742 => 'L', 7743 => 'L', 7744 => 'L', 7745 => 'L', 7746 => 'L', 7747 => 'L', 7748 => 'L', 7749 => 'L', 7750 => 'L', 7751 => 'L', 7752 => 'L', 7753 => 'L', 7754 => 'L', 7755 => 'L', 7756 => 'L', 7757 => 'L', 7758 => 'L', 7759 => 'L', 7760 => 'L', 7761 => 'L', 7762 => 'L', 7763 => 'L', 7764 => 'L', 7765 => 'L', 7766 => 'L', 7767 => 'L', 7768 => 'L', 7769 => 'L', 7770 => 'L', 7771 => 'L', 7772 => 'L', 7773 => 'L', 7774 => 'L', 7775 => 'L', 7776 => 'L', 7777 => 'L', 7778 => 'L', 7779 => 'L', 7780 => 'L', 7781 => 'L', 7782 => 'L', 7783 => 'L', 7784 => 'L', 7785 => 'L', 7786 => 'L', 7787 => 'L', 7788 => 'L', 7789 => 'L', 7790 => 'L', 7791 => 'L', 7792 => 'L', 7793 => 'L', 7794 => 'L', 7795 => 'L', 7796 => 'L', 7797 => 'L', 7798 => 'L', 7799 => 'L', 7800 => 'L', 7801 => 'L', 7802 => 'L', 7803 => 'L', 7804 => 'L', 7805 => 'L', 7806 => 'L', 7807 => 'L', 7808 => 'L', 7809 => 'L', 7810 => 'L', 7811 => 'L', 7812 => 'L', 7813 => 'L', 7814 => 'L', 7815 => 'L', 7816 => 'L', 7817 => 'L', 7818 => 'L', 7819 => 'L', 7820 => 'L', 7821 => 'L', 7822 => 'L', 7823 => 'L', 7824 => 'L', 7825 => 'L', 7826 => 'L', 7827 => 'L', 7828 => 'L', 7829 => 'L', 7830 => 'L', 7831 => 'L', 7832 => 'L', 7833 => 'L', 7834 => 'L', 7835 => 'L', 7840 => 'L', 7841 => 'L', 7842 => 'L', 7843 => 'L', 7844 => 'L', 7845 => 'L', 7846 => 'L', 7847 => 'L', 7848 => 'L', 7849 => 'L', 7850 => 'L', 7851 => 'L', 7852 => 'L', 7853 => 'L', 7854 => 'L', 7855 => 'L', 7856 => 'L', 7857 => 'L', 7858 => 'L', 7859 => 'L', 7860 => 'L', 7861 => 'L', 7862 => 'L', 7863 => 'L', 7864 => 'L', 7865 => 'L', 7866 => 'L', 7867 => 'L', 7868 => 'L', 7869 => 'L', 7870 => 'L', 7871 => 'L', 7872 => 'L', 7873 => 'L', 7874 => 'L', 7875 => 'L', 7876 => 'L', 7877 => 'L', 7878 => 'L', 7879 => 'L', 7880 => 'L', 7881 => 'L', 7882 => 'L', 7883 => 'L', 7884 => 'L', 7885 => 'L', 7886 => 'L', 7887 => 'L', 7888 => 'L', 7889 => 'L', 7890 => 'L', 7891 => 'L', 7892 => 'L', 7893 => 'L', 7894 => 'L', 7895 => 'L', 7896 => 'L', 7897 => 'L', 7898 => 'L', 7899 => 'L', 7900 => 'L', 7901 => 'L', 7902 => 'L', 7903 => 'L', 7904 => 'L', 7905 => 'L', 7906 => 'L', 7907 => 'L', 7908 => 'L', 7909 => 'L', 7910 => 'L', 7911 => 'L', 7912 => 'L', 7913 => 'L', 7914 => 'L', 7915 => 'L', 7916 => 'L', 7917 => 'L', 7918 => 'L', 7919 => 'L', 7920 => 'L', 7921 => 'L', 7922 => 'L', 7923 => 'L', 7924 => 'L', 7925 => 'L', 7926 => 'L', 7927 => 'L', 7928 => 'L', 7929 => 'L', 7936 => 'L', 7937 => 'L', 7938 => 'L', 7939 => 'L', 7940 => 'L', 7941 => 'L', 7942 => 'L', 7943 => 'L', 7944 => 'L', 7945 => 'L', 7946 => 'L', 7947 => 'L', 7948 => 'L', 7949 => 'L', 7950 => 'L', 7951 => 'L', 7952 => 'L', 7953 => 'L', 7954 => 'L', 7955 => 'L', 7956 => 'L', 7957 => 'L', 7960 => 'L', 7961 => 'L', 7962 => 'L', 7963 => 'L', 7964 => 'L', 7965 => 'L', 7968 => 'L', 7969 => 'L', 7970 => 'L', 7971 => 'L', 7972 => 'L', 7973 => 'L', 7974 => 'L', 7975 => 'L', 7976 => 'L', 7977 => 'L', 7978 => 'L', 7979 => 'L', 7980 => 'L', 7981 => 'L', 7982 => 'L', 7983 => 'L', 7984 => 'L', 7985 => 'L', 7986 => 'L', 7987 => 'L', 7988 => 'L', 7989 => 'L', 7990 => 'L', 7991 => 'L', 7992 => 'L', 7993 => 'L', 7994 => 'L', 7995 => 'L', 7996 => 'L', 7997 => 'L', 7998 => 'L', 7999 => 'L', 8000 => 'L', 8001 => 'L', 8002 => 'L', 8003 => 'L', 8004 => 'L', 8005 => 'L', 8008 => 'L', 8009 => 'L', 8010 => 'L', 8011 => 'L', 8012 => 'L', 8013 => 'L', 8016 => 'L', 8017 => 'L', 8018 => 'L', 8019 => 'L', 8020 => 'L', 8021 => 'L', 8022 => 'L', 8023 => 'L', 8025 => 'L', 8027 => 'L', 8029 => 'L', 8031 => 'L', 8032 => 'L', 8033 => 'L', 8034 => 'L', 8035 => 'L', 8036 => 'L', 8037 => 'L', 8038 => 'L', 8039 => 'L', 8040 => 'L', 8041 => 'L', 8042 => 'L', 8043 => 'L', 8044 => 'L', 8045 => 'L', 8046 => 'L', 8047 => 'L', 8048 => 'L', 8049 => 'L', 8050 => 'L', 8051 => 'L', 8052 => 'L', 8053 => 'L', 8054 => 'L', 8055 => 'L', 8056 => 'L', 8057 => 'L', 8058 => 'L', 8059 => 'L', 8060 => 'L', 8061 => 'L', 8064 => 'L', 8065 => 'L', 8066 => 'L', 8067 => 'L', 8068 => 'L', 8069 => 'L', 8070 => 'L', 8071 => 'L', 8072 => 'L', 8073 => 'L', 8074 => 'L', 8075 => 'L', 8076 => 'L', 8077 => 'L', 8078 => 'L', 8079 => 'L', 8080 => 'L', 8081 => 'L', 8082 => 'L', 8083 => 'L', 8084 => 'L', 8085 => 'L', 8086 => 'L', 8087 => 'L', 8088 => 'L', 8089 => 'L', 8090 => 'L', 8091 => 'L', 8092 => 'L', 8093 => 'L', 8094 => 'L', 8095 => 'L', 8096 => 'L', 8097 => 'L', 8098 => 'L', 8099 => 'L', 8100 => 'L', 8101 => 'L', 8102 => 'L', 8103 => 'L', 8104 => 'L', 8105 => 'L', 8106 => 'L', 8107 => 'L', 8108 => 'L', 8109 => 'L', 8110 => 'L', 8111 => 'L', 8112 => 'L', 8113 => 'L', 8114 => 'L', 8115 => 'L', 8116 => 'L', 8118 => 'L', 8119 => 'L', 8120 => 'L', 8121 => 'L', 8122 => 'L', 8123 => 'L', 8124 => 'L', 8125 => 'ON', 8126 => 'L', 8127 => 'ON', 8128 => 'ON', 8129 => 'ON', 8130 => 'L', 8131 => 'L', 8132 => 'L', 8134 => 'L', 8135 => 'L', 8136 => 'L', 8137 => 'L', 8138 => 'L', 8139 => 'L', 8140 => 'L', 8141 => 'ON', 8142 => 'ON', 8143 => 'ON', 8144 => 'L', 8145 => 'L', 8146 => 'L', 8147 => 'L', 8150 => 'L', 8151 => 'L', 8152 => 'L', 8153 => 'L', 8154 => 'L', 8155 => 'L', 8157 => 'ON', 8158 => 'ON', 8159 => 'ON', 8160 => 'L', 8161 => 'L', 8162 => 'L', 8163 => 'L', 8164 => 'L', 8165 => 'L', 8166 => 'L', 8167 => 'L', 8168 => 'L', 8169 => 'L', 8170 => 'L', 8171 => 'L', 8172 => 'L', 8173 => 'ON', 8174 => 'ON', 8175 => 'ON', 8178 => 'L', 8179 => 'L', 8180 => 'L', 8182 => 'L', 8183 => 'L', 8184 => 'L', 8185 => 'L', 8186 => 'L', 8187 => 'L', 8188 => 'L', 8189 => 'ON', 8190 => 'ON', 8192 => 'WS', 8193 => 'WS', 8194 => 'WS', 8195 => 'WS', 8196 => 'WS', 8197 => 'WS', 8198 => 'WS', 8199 => 'WS', 8200 => 'WS', 8201 => 'WS', 8202 => 'WS', 8203 => 'BN', 8204 => 'BN', 8205 => 'BN', 8206 => 'L', 8207 => 'R', 8208 => 'ON', 8209 => 'ON', 8210 => 'ON', 8211 => 'ON', 8212 => 'ON', 8213 => 'ON', 8214 => 'ON', 8215 => 'ON', 8216 => 'ON', 8217 => 'ON', 8218 => 'ON', 8219 => 'ON', 8220 => 'ON', 8221 => 'ON', 8222 => 'ON', 8223 => 'ON', 8224 => 'ON', 8225 => 'ON', 8226 => 'ON', 8227 => 'ON', 8228 => 'ON', 8229 => 'ON', 8230 => 'ON', 8231 => 'ON', 8232 => 'WS', 8233 => 'B', 8234 => 'LRE', 8235 => 'RLE', 8236 => 'PDF', 8237 => 'LRO', 8238 => 'RLO', 8239 => 'CS', 8240 => 'ET', 8241 => 'ET', 8242 => 'ET', 8243 => 'ET', 8244 => 'ET', 8245 => 'ON', 8246 => 'ON', 8247 => 'ON', 8248 => 'ON', 8249 => 'ON', 8250 => 'ON', 8251 => 'ON', 8252 => 'ON', 8253 => 'ON', 8254 => 'ON', 8255 => 'ON', 8256 => 'ON', 8257 => 'ON', 8258 => 'ON', 8259 => 'ON', 8260 => 'CS', 8261 => 'ON', 8262 => 'ON', 8263 => 'ON', 8264 => 'ON', 8265 => 'ON', 8266 => 'ON', 8267 => 'ON', 8268 => 'ON', 8269 => 'ON', 8270 => 'ON', 8271 => 'ON', 8272 => 'ON', 8273 => 'ON', 8274 => 'ON', 8275 => 'ON', 8276 => 'ON', 8277 => 'ON', 8278 => 'ON', 8279 => 'ON', 8280 => 'ON', 8281 => 'ON', 8282 => 'ON', 8283 => 'ON', 8284 => 'ON', 8285 => 'ON', 8286 => 'ON', 8287 => 'WS', 8288 => 'BN', 8289 => 'BN', 8290 => 'BN', 8291 => 'BN', 8298 => 'BN', 8299 => 'BN', 8300 => 'BN', 8301 => 'BN', 8302 => 'BN', 8303 => 'BN', 8304 => 'EN', 8305 => 'L', 8308 => 'EN', 8309 => 'EN', 8310 => 'EN', 8311 => 'EN', 8312 => 'EN', 8313 => 'EN', 8314 => 'ES', 8315 => 'ES', 8316 => 'ON', 8317 => 'ON', 8318 => 'ON', 8319 => 'L', 8320 => 'EN', 8321 => 'EN', 8322 => 'EN', 8323 => 'EN', 8324 => 'EN', 8325 => 'EN', 8326 => 'EN', 8327 => 'EN', 8328 => 'EN', 8329 => 'EN', 8330 => 'ES', 8331 => 'ES', 8332 => 'ON', 8333 => 'ON', 8334 => 'ON', 8336 => 'L', 8337 => 'L', 8338 => 'L', 8339 => 'L', 8340 => 'L', 8352 => 'ET', 8353 => 'ET', 8354 => 'ET', 8355 => 'ET', 8356 => 'ET', 8357 => 'ET', 8358 => 'ET', 8359 => 'ET', 8360 => 'ET', 8361 => 'ET', 8362 => 'ET', 8363 => 'ET', 8364 => 'ET', 8365 => 'ET', 8366 => 'ET', 8367 => 'ET', 8368 => 'ET', 8369 => 'ET', 8370 => 'ET', 8371 => 'ET', 8372 => 'ET', 8373 => 'ET', 8400 => 'NSM', 8401 => 'NSM', 8402 => 'NSM', 8403 => 'NSM', 8404 => 'NSM', 8405 => 'NSM', 8406 => 'NSM', 8407 => 'NSM', 8408 => 'NSM', 8409 => 'NSM', 8410 => 'NSM', 8411 => 'NSM', 8412 => 'NSM', 8413 => 'NSM', 8414 => 'NSM', 8415 => 'NSM', 8416 => 'NSM', 8417 => 'NSM', 8418 => 'NSM', 8419 => 'NSM', 8420 => 'NSM', 8421 => 'NSM', 8422 => 'NSM', 8423 => 'NSM', 8424 => 'NSM', 8425 => 'NSM', 8426 => 'NSM', 8427 => 'NSM', 8428 => 'NSM', 8429 => 'NSM', 8430 => 'NSM', 8431 => 'NSM', 8448 => 'ON', 8449 => 'ON', 8450 => 'L', 8451 => 'ON', 8452 => 'ON', 8453 => 'ON', 8454 => 'ON', 8455 => 'L', 8456 => 'ON', 8457 => 'ON', 8458 => 'L', 8459 => 'L', 8460 => 'L', 8461 => 'L', 8462 => 'L', 8463 => 'L', 8464 => 'L', 8465 => 'L', 8466 => 'L', 8467 => 'L', 8468 => 'ON', 8469 => 'L', 8470 => 'ON', 8471 => 'ON', 8472 => 'ON', 8473 => 'L', 8474 => 'L', 8475 => 'L', 8476 => 'L', 8477 => 'L', 8478 => 'ON', 8479 => 'ON', 8480 => 'ON', 8481 => 'ON', 8482 => 'ON', 8483 => 'ON', 8484 => 'L', 8485 => 'ON', 8486 => 'L', 8487 => 'ON', 8488 => 'L', 8489 => 'ON', 8490 => 'L', 8491 => 'L', 8492 => 'L', 8493 => 'L', 8494 => 'ET', 8495 => 'L', 8496 => 'L', 8497 => 'L', 8498 => 'L', 8499 => 'L', 8500 => 'L', 8501 => 'L', 8502 => 'L', 8503 => 'L', 8504 => 'L', 8505 => 'L', 8506 => 'ON', 8507 => 'ON', 8508 => 'L', 8509 => 'L', 8510 => 'L', 8511 => 'L', 8512 => 'ON', 8513 => 'ON', 8514 => 'ON', 8515 => 'ON', 8516 => 'ON', 8517 => 'L', 8518 => 'L', 8519 => 'L', 8520 => 'L', 8521 => 'L', 8522 => 'ON', 8523 => 'ON', 8524 => 'ON', 8525 => 'ON', 8526 => 'L', 8531 => 'ON', 8532 => 'ON', 8533 => 'ON', 8534 => 'ON', 8535 => 'ON', 8536 => 'ON', 8537 => 'ON', 8538 => 'ON', 8539 => 'ON', 8540 => 'ON', 8541 => 'ON', 8542 => 'ON', 8543 => 'ON', 8544 => 'L', 8545 => 'L', 8546 => 'L', 8547 => 'L', 8548 => 'L', 8549 => 'L', 8550 => 'L', 8551 => 'L', 8552 => 'L', 8553 => 'L', 8554 => 'L', 8555 => 'L', 8556 => 'L', 8557 => 'L', 8558 => 'L', 8559 => 'L', 8560 => 'L', 8561 => 'L', 8562 => 'L', 8563 => 'L', 8564 => 'L', 8565 => 'L', 8566 => 'L', 8567 => 'L', 8568 => 'L', 8569 => 'L', 8570 => 'L', 8571 => 'L', 8572 => 'L', 8573 => 'L', 8574 => 'L', 8575 => 'L', 8576 => 'L', 8577 => 'L', 8578 => 'L', 8579 => 'L', 8580 => 'L', 8592 => 'ON', 8593 => 'ON', 8594 => 'ON', 8595 => 'ON', 8596 => 'ON', 8597 => 'ON', 8598 => 'ON', 8599 => 'ON', 8600 => 'ON', 8601 => 'ON', 8602 => 'ON', 8603 => 'ON', 8604 => 'ON', 8605 => 'ON', 8606 => 'ON', 8607 => 'ON', 8608 => 'ON', 8609 => 'ON', 8610 => 'ON', 8611 => 'ON', 8612 => 'ON', 8613 => 'ON', 8614 => 'ON', 8615 => 'ON', 8616 => 'ON', 8617 => 'ON', 8618 => 'ON', 8619 => 'ON', 8620 => 'ON', 8621 => 'ON', 8622 => 'ON', 8623 => 'ON', 8624 => 'ON', 8625 => 'ON', 8626 => 'ON', 8627 => 'ON', 8628 => 'ON', 8629 => 'ON', 8630 => 'ON', 8631 => 'ON', 8632 => 'ON', 8633 => 'ON', 8634 => 'ON', 8635 => 'ON', 8636 => 'ON', 8637 => 'ON', 8638 => 'ON', 8639 => 'ON', 8640 => 'ON', 8641 => 'ON', 8642 => 'ON', 8643 => 'ON', 8644 => 'ON', 8645 => 'ON', 8646 => 'ON', 8647 => 'ON', 8648 => 'ON', 8649 => 'ON', 8650 => 'ON', 8651 => 'ON', 8652 => 'ON', 8653 => 'ON', 8654 => 'ON', 8655 => 'ON', 8656 => 'ON', 8657 => 'ON', 8658 => 'ON', 8659 => 'ON', 8660 => 'ON', 8661 => 'ON', 8662 => 'ON', 8663 => 'ON', 8664 => 'ON', 8665 => 'ON', 8666 => 'ON', 8667 => 'ON', 8668 => 'ON', 8669 => 'ON', 8670 => 'ON', 8671 => 'ON', 8672 => 'ON', 8673 => 'ON', 8674 => 'ON', 8675 => 'ON', 8676 => 'ON', 8677 => 'ON', 8678 => 'ON', 8679 => 'ON', 8680 => 'ON', 8681 => 'ON', 8682 => 'ON', 8683 => 'ON', 8684 => 'ON', 8685 => 'ON', 8686 => 'ON', 8687 => 'ON', 8688 => 'ON', 8689 => 'ON', 8690 => 'ON', 8691 => 'ON', 8692 => 'ON', 8693 => 'ON', 8694 => 'ON', 8695 => 'ON', 8696 => 'ON', 8697 => 'ON', 8698 => 'ON', 8699 => 'ON', 8700 => 'ON', 8701 => 'ON', 8702 => 'ON', 8703 => 'ON', 8704 => 'ON', 8705 => 'ON', 8706 => 'ON', 8707 => 'ON', 8708 => 'ON', 8709 => 'ON', 8710 => 'ON', 8711 => 'ON', 8712 => 'ON', 8713 => 'ON', 8714 => 'ON', 8715 => 'ON', 8716 => 'ON', 8717 => 'ON', 8718 => 'ON', 8719 => 'ON', 8720 => 'ON', 8721 => 'ON', 8722 => 'ES', 8723 => 'ET', 8724 => 'ON', 8725 => 'ON', 8726 => 'ON', 8727 => 'ON', 8728 => 'ON', 8729 => 'ON', 8730 => 'ON', 8731 => 'ON', 8732 => 'ON', 8733 => 'ON', 8734 => 'ON', 8735 => 'ON', 8736 => 'ON', 8737 => 'ON', 8738 => 'ON', 8739 => 'ON', 8740 => 'ON', 8741 => 'ON', 8742 => 'ON', 8743 => 'ON', 8744 => 'ON', 8745 => 'ON', 8746 => 'ON', 8747 => 'ON', 8748 => 'ON', 8749 => 'ON', 8750 => 'ON', 8751 => 'ON', 8752 => 'ON', 8753 => 'ON', 8754 => 'ON', 8755 => 'ON', 8756 => 'ON', 8757 => 'ON', 8758 => 'ON', 8759 => 'ON', 8760 => 'ON', 8761 => 'ON', 8762 => 'ON', 8763 => 'ON', 8764 => 'ON', 8765 => 'ON', 8766 => 'ON', 8767 => 'ON', 8768 => 'ON', 8769 => 'ON', 8770 => 'ON', 8771 => 'ON', 8772 => 'ON', 8773 => 'ON', 8774 => 'ON', 8775 => 'ON', 8776 => 'ON', 8777 => 'ON', 8778 => 'ON', 8779 => 'ON', 8780 => 'ON', 8781 => 'ON', 8782 => 'ON', 8783 => 'ON', 8784 => 'ON', 8785 => 'ON', 8786 => 'ON', 8787 => 'ON', 8788 => 'ON', 8789 => 'ON', 8790 => 'ON', 8791 => 'ON', 8792 => 'ON', 8793 => 'ON', 8794 => 'ON', 8795 => 'ON', 8796 => 'ON', 8797 => 'ON', 8798 => 'ON', 8799 => 'ON', 8800 => 'ON', 8801 => 'ON', 8802 => 'ON', 8803 => 'ON', 8804 => 'ON', 8805 => 'ON', 8806 => 'ON', 8807 => 'ON', 8808 => 'ON', 8809 => 'ON', 8810 => 'ON', 8811 => 'ON', 8812 => 'ON', 8813 => 'ON', 8814 => 'ON', 8815 => 'ON', 8816 => 'ON', 8817 => 'ON', 8818 => 'ON', 8819 => 'ON', 8820 => 'ON', 8821 => 'ON', 8822 => 'ON', 8823 => 'ON', 8824 => 'ON', 8825 => 'ON', 8826 => 'ON', 8827 => 'ON', 8828 => 'ON', 8829 => 'ON', 8830 => 'ON', 8831 => 'ON', 8832 => 'ON', 8833 => 'ON', 8834 => 'ON', 8835 => 'ON', 8836 => 'ON', 8837 => 'ON', 8838 => 'ON', 8839 => 'ON', 8840 => 'ON', 8841 => 'ON', 8842 => 'ON', 8843 => 'ON', 8844 => 'ON', 8845 => 'ON', 8846 => 'ON', 8847 => 'ON', 8848 => 'ON', 8849 => 'ON', 8850 => 'ON', 8851 => 'ON', 8852 => 'ON', 8853 => 'ON', 8854 => 'ON', 8855 => 'ON', 8856 => 'ON', 8857 => 'ON', 8858 => 'ON', 8859 => 'ON', 8860 => 'ON', 8861 => 'ON', 8862 => 'ON', 8863 => 'ON', 8864 => 'ON', 8865 => 'ON', 8866 => 'ON', 8867 => 'ON', 8868 => 'ON', 8869 => 'ON', 8870 => 'ON', 8871 => 'ON', 8872 => 'ON', 8873 => 'ON', 8874 => 'ON', 8875 => 'ON', 8876 => 'ON', 8877 => 'ON', 8878 => 'ON', 8879 => 'ON', 8880 => 'ON', 8881 => 'ON', 8882 => 'ON', 8883 => 'ON', 8884 => 'ON', 8885 => 'ON', 8886 => 'ON', 8887 => 'ON', 8888 => 'ON', 8889 => 'ON', 8890 => 'ON', 8891 => 'ON', 8892 => 'ON', 8893 => 'ON', 8894 => 'ON', 8895 => 'ON', 8896 => 'ON', 8897 => 'ON', 8898 => 'ON', 8899 => 'ON', 8900 => 'ON', 8901 => 'ON', 8902 => 'ON', 8903 => 'ON', 8904 => 'ON', 8905 => 'ON', 8906 => 'ON', 8907 => 'ON', 8908 => 'ON', 8909 => 'ON', 8910 => 'ON', 8911 => 'ON', 8912 => 'ON', 8913 => 'ON', 8914 => 'ON', 8915 => 'ON', 8916 => 'ON', 8917 => 'ON', 8918 => 'ON', 8919 => 'ON', 8920 => 'ON', 8921 => 'ON', 8922 => 'ON', 8923 => 'ON', 8924 => 'ON', 8925 => 'ON', 8926 => 'ON', 8927 => 'ON', 8928 => 'ON', 8929 => 'ON', 8930 => 'ON', 8931 => 'ON', 8932 => 'ON', 8933 => 'ON', 8934 => 'ON', 8935 => 'ON', 8936 => 'ON', 8937 => 'ON', 8938 => 'ON', 8939 => 'ON', 8940 => 'ON', 8941 => 'ON', 8942 => 'ON', 8943 => 'ON', 8944 => 'ON', 8945 => 'ON', 8946 => 'ON', 8947 => 'ON', 8948 => 'ON', 8949 => 'ON', 8950 => 'ON', 8951 => 'ON', 8952 => 'ON', 8953 => 'ON', 8954 => 'ON', 8955 => 'ON', 8956 => 'ON', 8957 => 'ON', 8958 => 'ON', 8959 => 'ON', 8960 => 'ON', 8961 => 'ON', 8962 => 'ON', 8963 => 'ON', 8964 => 'ON', 8965 => 'ON', 8966 => 'ON', 8967 => 'ON', 8968 => 'ON', 8969 => 'ON', 8970 => 'ON', 8971 => 'ON', 8972 => 'ON', 8973 => 'ON', 8974 => 'ON', 8975 => 'ON', 8976 => 'ON', 8977 => 'ON', 8978 => 'ON', 8979 => 'ON', 8980 => 'ON', 8981 => 'ON', 8982 => 'ON', 8983 => 'ON', 8984 => 'ON', 8985 => 'ON', 8986 => 'ON', 8987 => 'ON', 8988 => 'ON', 8989 => 'ON', 8990 => 'ON', 8991 => 'ON', 8992 => 'ON', 8993 => 'ON', 8994 => 'ON', 8995 => 'ON', 8996 => 'ON', 8997 => 'ON', 8998 => 'ON', 8999 => 'ON', 9000 => 'ON', 9001 => 'ON', 9002 => 'ON', 9003 => 'ON', 9004 => 'ON', 9005 => 'ON', 9006 => 'ON', 9007 => 'ON', 9008 => 'ON', 9009 => 'ON', 9010 => 'ON', 9011 => 'ON', 9012 => 'ON', 9013 => 'ON', 9014 => 'L', 9015 => 'L', 9016 => 'L', 9017 => 'L', 9018 => 'L', 9019 => 'L', 9020 => 'L', 9021 => 'L', 9022 => 'L', 9023 => 'L', 9024 => 'L', 9025 => 'L', 9026 => 'L', 9027 => 'L', 9028 => 'L', 9029 => 'L', 9030 => 'L', 9031 => 'L', 9032 => 'L', 9033 => 'L', 9034 => 'L', 9035 => 'L', 9036 => 'L', 9037 => 'L', 9038 => 'L', 9039 => 'L', 9040 => 'L', 9041 => 'L', 9042 => 'L', 9043 => 'L', 9044 => 'L', 9045 => 'L', 9046 => 'L', 9047 => 'L', 9048 => 'L', 9049 => 'L', 9050 => 'L', 9051 => 'L', 9052 => 'L', 9053 => 'L', 9054 => 'L', 9055 => 'L', 9056 => 'L', 9057 => 'L', 9058 => 'L', 9059 => 'L', 9060 => 'L', 9061 => 'L', 9062 => 'L', 9063 => 'L', 9064 => 'L', 9065 => 'L', 9066 => 'L', 9067 => 'L', 9068 => 'L', 9069 => 'L', 9070 => 'L', 9071 => 'L', 9072 => 'L', 9073 => 'L', 9074 => 'L', 9075 => 'L', 9076 => 'L', 9077 => 'L', 9078 => 'L', 9079 => 'L', 9080 => 'L', 9081 => 'L', 9082 => 'L', 9083 => 'ON', 9084 => 'ON', 9085 => 'ON', 9086 => 'ON', 9087 => 'ON', 9088 => 'ON', 9089 => 'ON', 9090 => 'ON', 9091 => 'ON', 9092 => 'ON', 9093 => 'ON', 9094 => 'ON', 9095 => 'ON', 9096 => 'ON', 9097 => 'ON', 9098 => 'ON', 9099 => 'ON', 9100 => 'ON', 9101 => 'ON', 9102 => 'ON', 9103 => 'ON', 9104 => 'ON', 9105 => 'ON', 9106 => 'ON', 9107 => 'ON', 9108 => 'ON', 9109 => 'L', 9110 => 'ON', 9111 => 'ON', 9112 => 'ON', 9113 => 'ON', 9114 => 'ON', 9115 => 'ON', 9116 => 'ON', 9117 => 'ON', 9118 => 'ON', 9119 => 'ON', 9120 => 'ON', 9121 => 'ON', 9122 => 'ON', 9123 => 'ON', 9124 => 'ON', 9125 => 'ON', 9126 => 'ON', 9127 => 'ON', 9128 => 'ON', 9129 => 'ON', 9130 => 'ON', 9131 => 'ON', 9132 => 'ON', 9133 => 'ON', 9134 => 'ON', 9135 => 'ON', 9136 => 'ON', 9137 => 'ON', 9138 => 'ON', 9139 => 'ON', 9140 => 'ON', 9141 => 'ON', 9142 => 'ON', 9143 => 'ON', 9144 => 'ON', 9145 => 'ON', 9146 => 'ON', 9147 => 'ON', 9148 => 'ON', 9149 => 'ON', 9150 => 'ON', 9151 => 'ON', 9152 => 'ON', 9153 => 'ON', 9154 => 'ON', 9155 => 'ON', 9156 => 'ON', 9157 => 'ON', 9158 => 'ON', 9159 => 'ON', 9160 => 'ON', 9161 => 'ON', 9162 => 'ON', 9163 => 'ON', 9164 => 'ON', 9165 => 'ON', 9166 => 'ON', 9167 => 'ON', 9168 => 'ON', 9169 => 'ON', 9170 => 'ON', 9171 => 'ON', 9172 => 'ON', 9173 => 'ON', 9174 => 'ON', 9175 => 'ON', 9176 => 'ON', 9177 => 'ON', 9178 => 'ON', 9179 => 'ON', 9180 => 'ON', 9181 => 'ON', 9182 => 'ON', 9183 => 'ON', 9184 => 'ON', 9185 => 'ON', 9186 => 'ON', 9187 => 'ON', 9188 => 'ON', 9189 => 'ON', 9190 => 'ON', 9191 => 'ON', 9216 => 'ON', 9217 => 'ON', 9218 => 'ON', 9219 => 'ON', 9220 => 'ON', 9221 => 'ON', 9222 => 'ON', 9223 => 'ON', 9224 => 'ON', 9225 => 'ON', 9226 => 'ON', 9227 => 'ON', 9228 => 'ON', 9229 => 'ON', 9230 => 'ON', 9231 => 'ON', 9232 => 'ON', 9233 => 'ON', 9234 => 'ON', 9235 => 'ON', 9236 => 'ON', 9237 => 'ON', 9238 => 'ON', 9239 => 'ON', 9240 => 'ON', 9241 => 'ON', 9242 => 'ON', 9243 => 'ON', 9244 => 'ON', 9245 => 'ON', 9246 => 'ON', 9247 => 'ON', 9248 => 'ON', 9249 => 'ON', 9250 => 'ON', 9251 => 'ON', 9252 => 'ON', 9253 => 'ON', 9254 => 'ON', 9280 => 'ON', 9281 => 'ON', 9282 => 'ON', 9283 => 'ON', 9284 => 'ON', 9285 => 'ON', 9286 => 'ON', 9287 => 'ON', 9288 => 'ON', 9289 => 'ON', 9290 => 'ON', 9312 => 'ON', 9313 => 'ON', 9314 => 'ON', 9315 => 'ON', 9316 => 'ON', 9317 => 'ON', 9318 => 'ON', 9319 => 'ON', 9320 => 'ON', 9321 => 'ON', 9322 => 'ON', 9323 => 'ON', 9324 => 'ON', 9325 => 'ON', 9326 => 'ON', 9327 => 'ON', 9328 => 'ON', 9329 => 'ON', 9330 => 'ON', 9331 => 'ON', 9332 => 'ON', 9333 => 'ON', 9334 => 'ON', 9335 => 'ON', 9336 => 'ON', 9337 => 'ON', 9338 => 'ON', 9339 => 'ON', 9340 => 'ON', 9341 => 'ON', 9342 => 'ON', 9343 => 'ON', 9344 => 'ON', 9345 => 'ON', 9346 => 'ON', 9347 => 'ON', 9348 => 'ON', 9349 => 'ON', 9350 => 'ON', 9351 => 'ON', 9352 => 'EN', 9353 => 'EN', 9354 => 'EN', 9355 => 'EN', 9356 => 'EN', 9357 => 'EN', 9358 => 'EN', 9359 => 'EN', 9360 => 'EN', 9361 => 'EN', 9362 => 'EN', 9363 => 'EN', 9364 => 'EN', 9365 => 'EN', 9366 => 'EN', 9367 => 'EN', 9368 => 'EN', 9369 => 'EN', 9370 => 'EN', 9371 => 'EN', 9372 => 'L', 9373 => 'L', 9374 => 'L', 9375 => 'L', 9376 => 'L', 9377 => 'L', 9378 => 'L', 9379 => 'L', 9380 => 'L', 9381 => 'L', 9382 => 'L', 9383 => 'L', 9384 => 'L', 9385 => 'L', 9386 => 'L', 9387 => 'L', 9388 => 'L', 9389 => 'L', 9390 => 'L', 9391 => 'L', 9392 => 'L', 9393 => 'L', 9394 => 'L', 9395 => 'L', 9396 => 'L', 9397 => 'L', 9398 => 'L', 9399 => 'L', 9400 => 'L', 9401 => 'L', 9402 => 'L', 9403 => 'L', 9404 => 'L', 9405 => 'L', 9406 => 'L', 9407 => 'L', 9408 => 'L', 9409 => 'L', 9410 => 'L', 9411 => 'L', 9412 => 'L', 9413 => 'L', 9414 => 'L', 9415 => 'L', 9416 => 'L', 9417 => 'L', 9418 => 'L', 9419 => 'L', 9420 => 'L', 9421 => 'L', 9422 => 'L', 9423 => 'L', 9424 => 'L', 9425 => 'L', 9426 => 'L', 9427 => 'L', 9428 => 'L', 9429 => 'L', 9430 => 'L', 9431 => 'L', 9432 => 'L', 9433 => 'L', 9434 => 'L', 9435 => 'L', 9436 => 'L', 9437 => 'L', 9438 => 'L', 9439 => 'L', 9440 => 'L', 9441 => 'L', 9442 => 'L', 9443 => 'L', 9444 => 'L', 9445 => 'L', 9446 => 'L', 9447 => 'L', 9448 => 'L', 9449 => 'L', 9450 => 'ON', 9451 => 'ON', 9452 => 'ON', 9453 => 'ON', 9454 => 'ON', 9455 => 'ON', 9456 => 'ON', 9457 => 'ON', 9458 => 'ON', 9459 => 'ON', 9460 => 'ON', 9461 => 'ON', 9462 => 'ON', 9463 => 'ON', 9464 => 'ON', 9465 => 'ON', 9466 => 'ON', 9467 => 'ON', 9468 => 'ON', 9469 => 'ON', 9470 => 'ON', 9471 => 'ON', 9472 => 'ON', 9473 => 'ON', 9474 => 'ON', 9475 => 'ON', 9476 => 'ON', 9477 => 'ON', 9478 => 'ON', 9479 => 'ON', 9480 => 'ON', 9481 => 'ON', 9482 => 'ON', 9483 => 'ON', 9484 => 'ON', 9485 => 'ON', 9486 => 'ON', 9487 => 'ON', 9488 => 'ON', 9489 => 'ON', 9490 => 'ON', 9491 => 'ON', 9492 => 'ON', 9493 => 'ON', 9494 => 'ON', 9495 => 'ON', 9496 => 'ON', 9497 => 'ON', 9498 => 'ON', 9499 => 'ON', 9500 => 'ON', 9501 => 'ON', 9502 => 'ON', 9503 => 'ON', 9504 => 'ON', 9505 => 'ON', 9506 => 'ON', 9507 => 'ON', 9508 => 'ON', 9509 => 'ON', 9510 => 'ON', 9511 => 'ON', 9512 => 'ON', 9513 => 'ON', 9514 => 'ON', 9515 => 'ON', 9516 => 'ON', 9517 => 'ON', 9518 => 'ON', 9519 => 'ON', 9520 => 'ON', 9521 => 'ON', 9522 => 'ON', 9523 => 'ON', 9524 => 'ON', 9525 => 'ON', 9526 => 'ON', 9527 => 'ON', 9528 => 'ON', 9529 => 'ON', 9530 => 'ON', 9531 => 'ON', 9532 => 'ON', 9533 => 'ON', 9534 => 'ON', 9535 => 'ON', 9536 => 'ON', 9537 => 'ON', 9538 => 'ON', 9539 => 'ON', 9540 => 'ON', 9541 => 'ON', 9542 => 'ON', 9543 => 'ON', 9544 => 'ON', 9545 => 'ON', 9546 => 'ON', 9547 => 'ON', 9548 => 'ON', 9549 => 'ON', 9550 => 'ON', 9551 => 'ON', 9552 => 'ON', 9553 => 'ON', 9554 => 'ON', 9555 => 'ON', 9556 => 'ON', 9557 => 'ON', 9558 => 'ON', 9559 => 'ON', 9560 => 'ON', 9561 => 'ON', 9562 => 'ON', 9563 => 'ON', 9564 => 'ON', 9565 => 'ON', 9566 => 'ON', 9567 => 'ON', 9568 => 'ON', 9569 => 'ON', 9570 => 'ON', 9571 => 'ON', 9572 => 'ON', 9573 => 'ON', 9574 => 'ON', 9575 => 'ON', 9576 => 'ON', 9577 => 'ON', 9578 => 'ON', 9579 => 'ON', 9580 => 'ON', 9581 => 'ON', 9582 => 'ON', 9583 => 'ON', 9584 => 'ON', 9585 => 'ON', 9586 => 'ON', 9587 => 'ON', 9588 => 'ON', 9589 => 'ON', 9590 => 'ON', 9591 => 'ON', 9592 => 'ON', 9593 => 'ON', 9594 => 'ON', 9595 => 'ON', 9596 => 'ON', 9597 => 'ON', 9598 => 'ON', 9599 => 'ON', 9600 => 'ON', 9601 => 'ON', 9602 => 'ON', 9603 => 'ON', 9604 => 'ON', 9605 => 'ON', 9606 => 'ON', 9607 => 'ON', 9608 => 'ON', 9609 => 'ON', 9610 => 'ON', 9611 => 'ON', 9612 => 'ON', 9613 => 'ON', 9614 => 'ON', 9615 => 'ON', 9616 => 'ON', 9617 => 'ON', 9618 => 'ON', 9619 => 'ON', 9620 => 'ON', 9621 => 'ON', 9622 => 'ON', 9623 => 'ON', 9624 => 'ON', 9625 => 'ON', 9626 => 'ON', 9627 => 'ON', 9628 => 'ON', 9629 => 'ON', 9630 => 'ON', 9631 => 'ON', 9632 => 'ON', 9633 => 'ON', 9634 => 'ON', 9635 => 'ON', 9636 => 'ON', 9637 => 'ON', 9638 => 'ON', 9639 => 'ON', 9640 => 'ON', 9641 => 'ON', 9642 => 'ON', 9643 => 'ON', 9644 => 'ON', 9645 => 'ON', 9646 => 'ON', 9647 => 'ON', 9648 => 'ON', 9649 => 'ON', 9650 => 'ON', 9651 => 'ON', 9652 => 'ON', 9653 => 'ON', 9654 => 'ON', 9655 => 'ON', 9656 => 'ON', 9657 => 'ON', 9658 => 'ON', 9659 => 'ON', 9660 => 'ON', 9661 => 'ON', 9662 => 'ON', 9663 => 'ON', 9664 => 'ON', 9665 => 'ON', 9666 => 'ON', 9667 => 'ON', 9668 => 'ON', 9669 => 'ON', 9670 => 'ON', 9671 => 'ON', 9672 => 'ON', 9673 => 'ON', 9674 => 'ON', 9675 => 'ON', 9676 => 'ON', 9677 => 'ON', 9678 => 'ON', 9679 => 'ON', 9680 => 'ON', 9681 => 'ON', 9682 => 'ON', 9683 => 'ON', 9684 => 'ON', 9685 => 'ON', 9686 => 'ON', 9687 => 'ON', 9688 => 'ON', 9689 => 'ON', 9690 => 'ON', 9691 => 'ON', 9692 => 'ON', 9693 => 'ON', 9694 => 'ON', 9695 => 'ON', 9696 => 'ON', 9697 => 'ON', 9698 => 'ON', 9699 => 'ON', 9700 => 'ON', 9701 => 'ON', 9702 => 'ON', 9703 => 'ON', 9704 => 'ON', 9705 => 'ON', 9706 => 'ON', 9707 => 'ON', 9708 => 'ON', 9709 => 'ON', 9710 => 'ON', 9711 => 'ON', 9712 => 'ON', 9713 => 'ON', 9714 => 'ON', 9715 => 'ON', 9716 => 'ON', 9717 => 'ON', 9718 => 'ON', 9719 => 'ON', 9720 => 'ON', 9721 => 'ON', 9722 => 'ON', 9723 => 'ON', 9724 => 'ON', 9725 => 'ON', 9726 => 'ON', 9727 => 'ON', 9728 => 'ON', 9729 => 'ON', 9730 => 'ON', 9731 => 'ON', 9732 => 'ON', 9733 => 'ON', 9734 => 'ON', 9735 => 'ON', 9736 => 'ON', 9737 => 'ON', 9738 => 'ON', 9739 => 'ON', 9740 => 'ON', 9741 => 'ON', 9742 => 'ON', 9743 => 'ON', 9744 => 'ON', 9745 => 'ON', 9746 => 'ON', 9747 => 'ON', 9748 => 'ON', 9749 => 'ON', 9750 => 'ON', 9751 => 'ON', 9752 => 'ON', 9753 => 'ON', 9754 => 'ON', 9755 => 'ON', 9756 => 'ON', 9757 => 'ON', 9758 => 'ON', 9759 => 'ON', 9760 => 'ON', 9761 => 'ON', 9762 => 'ON', 9763 => 'ON', 9764 => 'ON', 9765 => 'ON', 9766 => 'ON', 9767 => 'ON', 9768 => 'ON', 9769 => 'ON', 9770 => 'ON', 9771 => 'ON', 9772 => 'ON', 9773 => 'ON', 9774 => 'ON', 9775 => 'ON', 9776 => 'ON', 9777 => 'ON', 9778 => 'ON', 9779 => 'ON', 9780 => 'ON', 9781 => 'ON', 9782 => 'ON', 9783 => 'ON', 9784 => 'ON', 9785 => 'ON', 9786 => 'ON', 9787 => 'ON', 9788 => 'ON', 9789 => 'ON', 9790 => 'ON', 9791 => 'ON', 9792 => 'ON', 9793 => 'ON', 9794 => 'ON', 9795 => 'ON', 9796 => 'ON', 9797 => 'ON', 9798 => 'ON', 9799 => 'ON', 9800 => 'ON', 9801 => 'ON', 9802 => 'ON', 9803 => 'ON', 9804 => 'ON', 9805 => 'ON', 9806 => 'ON', 9807 => 'ON', 9808 => 'ON', 9809 => 'ON', 9810 => 'ON', 9811 => 'ON', 9812 => 'ON', 9813 => 'ON', 9814 => 'ON', 9815 => 'ON', 9816 => 'ON', 9817 => 'ON', 9818 => 'ON', 9819 => 'ON', 9820 => 'ON', 9821 => 'ON', 9822 => 'ON', 9823 => 'ON', 9824 => 'ON', 9825 => 'ON', 9826 => 'ON', 9827 => 'ON', 9828 => 'ON', 9829 => 'ON', 9830 => 'ON', 9831 => 'ON', 9832 => 'ON', 9833 => 'ON', 9834 => 'ON', 9835 => 'ON', 9836 => 'ON', 9837 => 'ON', 9838 => 'ON', 9839 => 'ON', 9840 => 'ON', 9841 => 'ON', 9842 => 'ON', 9843 => 'ON', 9844 => 'ON', 9845 => 'ON', 9846 => 'ON', 9847 => 'ON', 9848 => 'ON', 9849 => 'ON', 9850 => 'ON', 9851 => 'ON', 9852 => 'ON', 9853 => 'ON', 9854 => 'ON', 9855 => 'ON', 9856 => 'ON', 9857 => 'ON', 9858 => 'ON', 9859 => 'ON', 9860 => 'ON', 9861 => 'ON', 9862 => 'ON', 9863 => 'ON', 9864 => 'ON', 9865 => 'ON', 9866 => 'ON', 9867 => 'ON', 9868 => 'ON', 9869 => 'ON', 9870 => 'ON', 9871 => 'ON', 9872 => 'ON', 9873 => 'ON', 9874 => 'ON', 9875 => 'ON', 9876 => 'ON', 9877 => 'ON', 9878 => 'ON', 9879 => 'ON', 9880 => 'ON', 9881 => 'ON', 9882 => 'ON', 9883 => 'ON', 9884 => 'ON', 9888 => 'ON', 9889 => 'ON', 9890 => 'ON', 9891 => 'ON', 9892 => 'ON', 9893 => 'ON', 9894 => 'ON', 9895 => 'ON', 9896 => 'ON', 9897 => 'ON', 9898 => 'ON', 9899 => 'ON', 9900 => 'L', 9901 => 'ON', 9902 => 'ON', 9903 => 'ON', 9904 => 'ON', 9905 => 'ON', 9906 => 'ON', 9985 => 'ON', 9986 => 'ON', 9987 => 'ON', 9988 => 'ON', 9990 => 'ON', 9991 => 'ON', 9992 => 'ON', 9993 => 'ON', 9996 => 'ON', 9997 => 'ON', 9998 => 'ON', 9999 => 'ON', 10000 => 'ON', 10001 => 'ON', 10002 => 'ON', 10003 => 'ON', 10004 => 'ON', 10005 => 'ON', 10006 => 'ON', 10007 => 'ON', 10008 => 'ON', 10009 => 'ON', 10010 => 'ON', 10011 => 'ON', 10012 => 'ON', 10013 => 'ON', 10014 => 'ON', 10015 => 'ON', 10016 => 'ON', 10017 => 'ON', 10018 => 'ON', 10019 => 'ON', 10020 => 'ON', 10021 => 'ON', 10022 => 'ON', 10023 => 'ON', 10025 => 'ON', 10026 => 'ON', 10027 => 'ON', 10028 => 'ON', 10029 => 'ON', 10030 => 'ON', 10031 => 'ON', 10032 => 'ON', 10033 => 'ON', 10034 => 'ON', 10035 => 'ON', 10036 => 'ON', 10037 => 'ON', 10038 => 'ON', 10039 => 'ON', 10040 => 'ON', 10041 => 'ON', 10042 => 'ON', 10043 => 'ON', 10044 => 'ON', 10045 => 'ON', 10046 => 'ON', 10047 => 'ON', 10048 => 'ON', 10049 => 'ON', 10050 => 'ON', 10051 => 'ON', 10052 => 'ON', 10053 => 'ON', 10054 => 'ON', 10055 => 'ON', 10056 => 'ON', 10057 => 'ON', 10058 => 'ON', 10059 => 'ON', 10061 => 'ON', 10063 => 'ON', 10064 => 'ON', 10065 => 'ON', 10066 => 'ON', 10070 => 'ON', 10072 => 'ON', 10073 => 'ON', 10074 => 'ON', 10075 => 'ON', 10076 => 'ON', 10077 => 'ON', 10078 => 'ON', 10081 => 'ON', 10082 => 'ON', 10083 => 'ON', 10084 => 'ON', 10085 => 'ON', 10086 => 'ON', 10087 => 'ON', 10088 => 'ON', 10089 => 'ON', 10090 => 'ON', 10091 => 'ON', 10092 => 'ON', 10093 => 'ON', 10094 => 'ON', 10095 => 'ON', 10096 => 'ON', 10097 => 'ON', 10098 => 'ON', 10099 => 'ON', 10100 => 'ON', 10101 => 'ON', 10102 => 'ON', 10103 => 'ON', 10104 => 'ON', 10105 => 'ON', 10106 => 'ON', 10107 => 'ON', 10108 => 'ON', 10109 => 'ON', 10110 => 'ON', 10111 => 'ON', 10112 => 'ON', 10113 => 'ON', 10114 => 'ON', 10115 => 'ON', 10116 => 'ON', 10117 => 'ON', 10118 => 'ON', 10119 => 'ON', 10120 => 'ON', 10121 => 'ON', 10122 => 'ON', 10123 => 'ON', 10124 => 'ON', 10125 => 'ON', 10126 => 'ON', 10127 => 'ON', 10128 => 'ON', 10129 => 'ON', 10130 => 'ON', 10131 => 'ON', 10132 => 'ON', 10136 => 'ON', 10137 => 'ON', 10138 => 'ON', 10139 => 'ON', 10140 => 'ON', 10141 => 'ON', 10142 => 'ON', 10143 => 'ON', 10144 => 'ON', 10145 => 'ON', 10146 => 'ON', 10147 => 'ON', 10148 => 'ON', 10149 => 'ON', 10150 => 'ON', 10151 => 'ON', 10152 => 'ON', 10153 => 'ON', 10154 => 'ON', 10155 => 'ON', 10156 => 'ON', 10157 => 'ON', 10158 => 'ON', 10159 => 'ON', 10161 => 'ON', 10162 => 'ON', 10163 => 'ON', 10164 => 'ON', 10165 => 'ON', 10166 => 'ON', 10167 => 'ON', 10168 => 'ON', 10169 => 'ON', 10170 => 'ON', 10171 => 'ON', 10172 => 'ON', 10173 => 'ON', 10174 => 'ON', 10176 => 'ON', 10177 => 'ON', 10178 => 'ON', 10179 => 'ON', 10180 => 'ON', 10181 => 'ON', 10182 => 'ON', 10183 => 'ON', 10184 => 'ON', 10185 => 'ON', 10186 => 'ON', 10192 => 'ON', 10193 => 'ON', 10194 => 'ON', 10195 => 'ON', 10196 => 'ON', 10197 => 'ON', 10198 => 'ON', 10199 => 'ON', 10200 => 'ON', 10201 => 'ON', 10202 => 'ON', 10203 => 'ON', 10204 => 'ON', 10205 => 'ON', 10206 => 'ON', 10207 => 'ON', 10208 => 'ON', 10209 => 'ON', 10210 => 'ON', 10211 => 'ON', 10212 => 'ON', 10213 => 'ON', 10214 => 'ON', 10215 => 'ON', 10216 => 'ON', 10217 => 'ON', 10218 => 'ON', 10219 => 'ON', 10224 => 'ON', 10225 => 'ON', 10226 => 'ON', 10227 => 'ON', 10228 => 'ON', 10229 => 'ON', 10230 => 'ON', 10231 => 'ON', 10232 => 'ON', 10233 => 'ON', 10234 => 'ON', 10235 => 'ON', 10236 => 'ON', 10237 => 'ON', 10238 => 'ON', 10239 => 'ON', 10240 => 'L', 10241 => 'L', 10242 => 'L', 10243 => 'L', 10244 => 'L', 10245 => 'L', 10246 => 'L', 10247 => 'L', 10248 => 'L', 10249 => 'L', 10250 => 'L', 10251 => 'L', 10252 => 'L', 10253 => 'L', 10254 => 'L', 10255 => 'L', 10256 => 'L', 10257 => 'L', 10258 => 'L', 10259 => 'L', 10260 => 'L', 10261 => 'L', 10262 => 'L', 10263 => 'L', 10264 => 'L', 10265 => 'L', 10266 => 'L', 10267 => 'L', 10268 => 'L', 10269 => 'L', 10270 => 'L', 10271 => 'L', 10272 => 'L', 10273 => 'L', 10274 => 'L', 10275 => 'L', 10276 => 'L', 10277 => 'L', 10278 => 'L', 10279 => 'L', 10280 => 'L', 10281 => 'L', 10282 => 'L', 10283 => 'L', 10284 => 'L', 10285 => 'L', 10286 => 'L', 10287 => 'L', 10288 => 'L', 10289 => 'L', 10290 => 'L', 10291 => 'L', 10292 => 'L', 10293 => 'L', 10294 => 'L', 10295 => 'L', 10296 => 'L', 10297 => 'L', 10298 => 'L', 10299 => 'L', 10300 => 'L', 10301 => 'L', 10302 => 'L', 10303 => 'L', 10304 => 'L', 10305 => 'L', 10306 => 'L', 10307 => 'L', 10308 => 'L', 10309 => 'L', 10310 => 'L', 10311 => 'L', 10312 => 'L', 10313 => 'L', 10314 => 'L', 10315 => 'L', 10316 => 'L', 10317 => 'L', 10318 => 'L', 10319 => 'L', 10320 => 'L', 10321 => 'L', 10322 => 'L', 10323 => 'L', 10324 => 'L', 10325 => 'L', 10326 => 'L', 10327 => 'L', 10328 => 'L', 10329 => 'L', 10330 => 'L', 10331 => 'L', 10332 => 'L', 10333 => 'L', 10334 => 'L', 10335 => 'L', 10336 => 'L', 10337 => 'L', 10338 => 'L', 10339 => 'L', 10340 => 'L', 10341 => 'L', 10342 => 'L', 10343 => 'L', 10344 => 'L', 10345 => 'L', 10346 => 'L', 10347 => 'L', 10348 => 'L', 10349 => 'L', 10350 => 'L', 10351 => 'L', 10352 => 'L', 10353 => 'L', 10354 => 'L', 10355 => 'L', 10356 => 'L', 10357 => 'L', 10358 => 'L', 10359 => 'L', 10360 => 'L', 10361 => 'L', 10362 => 'L', 10363 => 'L', 10364 => 'L', 10365 => 'L', 10366 => 'L', 10367 => 'L', 10368 => 'L', 10369 => 'L', 10370 => 'L', 10371 => 'L', 10372 => 'L', 10373 => 'L', 10374 => 'L', 10375 => 'L', 10376 => 'L', 10377 => 'L', 10378 => 'L', 10379 => 'L', 10380 => 'L', 10381 => 'L', 10382 => 'L', 10383 => 'L', 10384 => 'L', 10385 => 'L', 10386 => 'L', 10387 => 'L', 10388 => 'L', 10389 => 'L', 10390 => 'L', 10391 => 'L', 10392 => 'L', 10393 => 'L', 10394 => 'L', 10395 => 'L', 10396 => 'L', 10397 => 'L', 10398 => 'L', 10399 => 'L', 10400 => 'L', 10401 => 'L', 10402 => 'L', 10403 => 'L', 10404 => 'L', 10405 => 'L', 10406 => 'L', 10407 => 'L', 10408 => 'L', 10409 => 'L', 10410 => 'L', 10411 => 'L', 10412 => 'L', 10413 => 'L', 10414 => 'L', 10415 => 'L', 10416 => 'L', 10417 => 'L', 10418 => 'L', 10419 => 'L', 10420 => 'L', 10421 => 'L', 10422 => 'L', 10423 => 'L', 10424 => 'L', 10425 => 'L', 10426 => 'L', 10427 => 'L', 10428 => 'L', 10429 => 'L', 10430 => 'L', 10431 => 'L', 10432 => 'L', 10433 => 'L', 10434 => 'L', 10435 => 'L', 10436 => 'L', 10437 => 'L', 10438 => 'L', 10439 => 'L', 10440 => 'L', 10441 => 'L', 10442 => 'L', 10443 => 'L', 10444 => 'L', 10445 => 'L', 10446 => 'L', 10447 => 'L', 10448 => 'L', 10449 => 'L', 10450 => 'L', 10451 => 'L', 10452 => 'L', 10453 => 'L', 10454 => 'L', 10455 => 'L', 10456 => 'L', 10457 => 'L', 10458 => 'L', 10459 => 'L', 10460 => 'L', 10461 => 'L', 10462 => 'L', 10463 => 'L', 10464 => 'L', 10465 => 'L', 10466 => 'L', 10467 => 'L', 10468 => 'L', 10469 => 'L', 10470 => 'L', 10471 => 'L', 10472 => 'L', 10473 => 'L', 10474 => 'L', 10475 => 'L', 10476 => 'L', 10477 => 'L', 10478 => 'L', 10479 => 'L', 10480 => 'L', 10481 => 'L', 10482 => 'L', 10483 => 'L', 10484 => 'L', 10485 => 'L', 10486 => 'L', 10487 => 'L', 10488 => 'L', 10489 => 'L', 10490 => 'L', 10491 => 'L', 10492 => 'L', 10493 => 'L', 10494 => 'L', 10495 => 'L', 10496 => 'ON', 10497 => 'ON', 10498 => 'ON', 10499 => 'ON', 10500 => 'ON', 10501 => 'ON', 10502 => 'ON', 10503 => 'ON', 10504 => 'ON', 10505 => 'ON', 10506 => 'ON', 10507 => 'ON', 10508 => 'ON', 10509 => 'ON', 10510 => 'ON', 10511 => 'ON', 10512 => 'ON', 10513 => 'ON', 10514 => 'ON', 10515 => 'ON', 10516 => 'ON', 10517 => 'ON', 10518 => 'ON', 10519 => 'ON', 10520 => 'ON', 10521 => 'ON', 10522 => 'ON', 10523 => 'ON', 10524 => 'ON', 10525 => 'ON', 10526 => 'ON', 10527 => 'ON', 10528 => 'ON', 10529 => 'ON', 10530 => 'ON', 10531 => 'ON', 10532 => 'ON', 10533 => 'ON', 10534 => 'ON', 10535 => 'ON', 10536 => 'ON', 10537 => 'ON', 10538 => 'ON', 10539 => 'ON', 10540 => 'ON', 10541 => 'ON', 10542 => 'ON', 10543 => 'ON', 10544 => 'ON', 10545 => 'ON', 10546 => 'ON', 10547 => 'ON', 10548 => 'ON', 10549 => 'ON', 10550 => 'ON', 10551 => 'ON', 10552 => 'ON', 10553 => 'ON', 10554 => 'ON', 10555 => 'ON', 10556 => 'ON', 10557 => 'ON', 10558 => 'ON', 10559 => 'ON', 10560 => 'ON', 10561 => 'ON', 10562 => 'ON', 10563 => 'ON', 10564 => 'ON', 10565 => 'ON', 10566 => 'ON', 10567 => 'ON', 10568 => 'ON', 10569 => 'ON', 10570 => 'ON', 10571 => 'ON', 10572 => 'ON', 10573 => 'ON', 10574 => 'ON', 10575 => 'ON', 10576 => 'ON', 10577 => 'ON', 10578 => 'ON', 10579 => 'ON', 10580 => 'ON', 10581 => 'ON', 10582 => 'ON', 10583 => 'ON', 10584 => 'ON', 10585 => 'ON', 10586 => 'ON', 10587 => 'ON', 10588 => 'ON', 10589 => 'ON', 10590 => 'ON', 10591 => 'ON', 10592 => 'ON', 10593 => 'ON', 10594 => 'ON', 10595 => 'ON', 10596 => 'ON', 10597 => 'ON', 10598 => 'ON', 10599 => 'ON', 10600 => 'ON', 10601 => 'ON', 10602 => 'ON', 10603 => 'ON', 10604 => 'ON', 10605 => 'ON', 10606 => 'ON', 10607 => 'ON', 10608 => 'ON', 10609 => 'ON', 10610 => 'ON', 10611 => 'ON', 10612 => 'ON', 10613 => 'ON', 10614 => 'ON', 10615 => 'ON', 10616 => 'ON', 10617 => 'ON', 10618 => 'ON', 10619 => 'ON', 10620 => 'ON', 10621 => 'ON', 10622 => 'ON', 10623 => 'ON', 10624 => 'ON', 10625 => 'ON', 10626 => 'ON', 10627 => 'ON', 10628 => 'ON', 10629 => 'ON', 10630 => 'ON', 10631 => 'ON', 10632 => 'ON', 10633 => 'ON', 10634 => 'ON', 10635 => 'ON', 10636 => 'ON', 10637 => 'ON', 10638 => 'ON', 10639 => 'ON', 10640 => 'ON', 10641 => 'ON', 10642 => 'ON', 10643 => 'ON', 10644 => 'ON', 10645 => 'ON', 10646 => 'ON', 10647 => 'ON', 10648 => 'ON', 10649 => 'ON', 10650 => 'ON', 10651 => 'ON', 10652 => 'ON', 10653 => 'ON', 10654 => 'ON', 10655 => 'ON', 10656 => 'ON', 10657 => 'ON', 10658 => 'ON', 10659 => 'ON', 10660 => 'ON', 10661 => 'ON', 10662 => 'ON', 10663 => 'ON', 10664 => 'ON', 10665 => 'ON', 10666 => 'ON', 10667 => 'ON', 10668 => 'ON', 10669 => 'ON', 10670 => 'ON', 10671 => 'ON', 10672 => 'ON', 10673 => 'ON', 10674 => 'ON', 10675 => 'ON', 10676 => 'ON', 10677 => 'ON', 10678 => 'ON', 10679 => 'ON', 10680 => 'ON', 10681 => 'ON', 10682 => 'ON', 10683 => 'ON', 10684 => 'ON', 10685 => 'ON', 10686 => 'ON', 10687 => 'ON', 10688 => 'ON', 10689 => 'ON', 10690 => 'ON', 10691 => 'ON', 10692 => 'ON', 10693 => 'ON', 10694 => 'ON', 10695 => 'ON', 10696 => 'ON', 10697 => 'ON', 10698 => 'ON', 10699 => 'ON', 10700 => 'ON', 10701 => 'ON', 10702 => 'ON', 10703 => 'ON', 10704 => 'ON', 10705 => 'ON', 10706 => 'ON', 10707 => 'ON', 10708 => 'ON', 10709 => 'ON', 10710 => 'ON', 10711 => 'ON', 10712 => 'ON', 10713 => 'ON', 10714 => 'ON', 10715 => 'ON', 10716 => 'ON', 10717 => 'ON', 10718 => 'ON', 10719 => 'ON', 10720 => 'ON', 10721 => 'ON', 10722 => 'ON', 10723 => 'ON', 10724 => 'ON', 10725 => 'ON', 10726 => 'ON', 10727 => 'ON', 10728 => 'ON', 10729 => 'ON', 10730 => 'ON', 10731 => 'ON', 10732 => 'ON', 10733 => 'ON', 10734 => 'ON', 10735 => 'ON', 10736 => 'ON', 10737 => 'ON', 10738 => 'ON', 10739 => 'ON', 10740 => 'ON', 10741 => 'ON', 10742 => 'ON', 10743 => 'ON', 10744 => 'ON', 10745 => 'ON', 10746 => 'ON', 10747 => 'ON', 10748 => 'ON', 10749 => 'ON', 10750 => 'ON', 10751 => 'ON', 10752 => 'ON', 10753 => 'ON', 10754 => 'ON', 10755 => 'ON', 10756 => 'ON', 10757 => 'ON', 10758 => 'ON', 10759 => 'ON', 10760 => 'ON', 10761 => 'ON', 10762 => 'ON', 10763 => 'ON', 10764 => 'ON', 10765 => 'ON', 10766 => 'ON', 10767 => 'ON', 10768 => 'ON', 10769 => 'ON', 10770 => 'ON', 10771 => 'ON', 10772 => 'ON', 10773 => 'ON', 10774 => 'ON', 10775 => 'ON', 10776 => 'ON', 10777 => 'ON', 10778 => 'ON', 10779 => 'ON', 10780 => 'ON', 10781 => 'ON', 10782 => 'ON', 10783 => 'ON', 10784 => 'ON', 10785 => 'ON', 10786 => 'ON', 10787 => 'ON', 10788 => 'ON', 10789 => 'ON', 10790 => 'ON', 10791 => 'ON', 10792 => 'ON', 10793 => 'ON', 10794 => 'ON', 10795 => 'ON', 10796 => 'ON', 10797 => 'ON', 10798 => 'ON', 10799 => 'ON', 10800 => 'ON', 10801 => 'ON', 10802 => 'ON', 10803 => 'ON', 10804 => 'ON', 10805 => 'ON', 10806 => 'ON', 10807 => 'ON', 10808 => 'ON', 10809 => 'ON', 10810 => 'ON', 10811 => 'ON', 10812 => 'ON', 10813 => 'ON', 10814 => 'ON', 10815 => 'ON', 10816 => 'ON', 10817 => 'ON', 10818 => 'ON', 10819 => 'ON', 10820 => 'ON', 10821 => 'ON', 10822 => 'ON', 10823 => 'ON', 10824 => 'ON', 10825 => 'ON', 10826 => 'ON', 10827 => 'ON', 10828 => 'ON', 10829 => 'ON', 10830 => 'ON', 10831 => 'ON', 10832 => 'ON', 10833 => 'ON', 10834 => 'ON', 10835 => 'ON', 10836 => 'ON', 10837 => 'ON', 10838 => 'ON', 10839 => 'ON', 10840 => 'ON', 10841 => 'ON', 10842 => 'ON', 10843 => 'ON', 10844 => 'ON', 10845 => 'ON', 10846 => 'ON', 10847 => 'ON', 10848 => 'ON', 10849 => 'ON', 10850 => 'ON', 10851 => 'ON', 10852 => 'ON', 10853 => 'ON', 10854 => 'ON', 10855 => 'ON', 10856 => 'ON', 10857 => 'ON', 10858 => 'ON', 10859 => 'ON', 10860 => 'ON', 10861 => 'ON', 10862 => 'ON', 10863 => 'ON', 10864 => 'ON', 10865 => 'ON', 10866 => 'ON', 10867 => 'ON', 10868 => 'ON', 10869 => 'ON', 10870 => 'ON', 10871 => 'ON', 10872 => 'ON', 10873 => 'ON', 10874 => 'ON', 10875 => 'ON', 10876 => 'ON', 10877 => 'ON', 10878 => 'ON', 10879 => 'ON', 10880 => 'ON', 10881 => 'ON', 10882 => 'ON', 10883 => 'ON', 10884 => 'ON', 10885 => 'ON', 10886 => 'ON', 10887 => 'ON', 10888 => 'ON', 10889 => 'ON', 10890 => 'ON', 10891 => 'ON', 10892 => 'ON', 10893 => 'ON', 10894 => 'ON', 10895 => 'ON', 10896 => 'ON', 10897 => 'ON', 10898 => 'ON', 10899 => 'ON', 10900 => 'ON', 10901 => 'ON', 10902 => 'ON', 10903 => 'ON', 10904 => 'ON', 10905 => 'ON', 10906 => 'ON', 10907 => 'ON', 10908 => 'ON', 10909 => 'ON', 10910 => 'ON', 10911 => 'ON', 10912 => 'ON', 10913 => 'ON', 10914 => 'ON', 10915 => 'ON', 10916 => 'ON', 10917 => 'ON', 10918 => 'ON', 10919 => 'ON', 10920 => 'ON', 10921 => 'ON', 10922 => 'ON', 10923 => 'ON', 10924 => 'ON', 10925 => 'ON', 10926 => 'ON', 10927 => 'ON', 10928 => 'ON', 10929 => 'ON', 10930 => 'ON', 10931 => 'ON', 10932 => 'ON', 10933 => 'ON', 10934 => 'ON', 10935 => 'ON', 10936 => 'ON', 10937 => 'ON', 10938 => 'ON', 10939 => 'ON', 10940 => 'ON', 10941 => 'ON', 10942 => 'ON', 10943 => 'ON', 10944 => 'ON', 10945 => 'ON', 10946 => 'ON', 10947 => 'ON', 10948 => 'ON', 10949 => 'ON', 10950 => 'ON', 10951 => 'ON', 10952 => 'ON', 10953 => 'ON', 10954 => 'ON', 10955 => 'ON', 10956 => 'ON', 10957 => 'ON', 10958 => 'ON', 10959 => 'ON', 10960 => 'ON', 10961 => 'ON', 10962 => 'ON', 10963 => 'ON', 10964 => 'ON', 10965 => 'ON', 10966 => 'ON', 10967 => 'ON', 10968 => 'ON', 10969 => 'ON', 10970 => 'ON', 10971 => 'ON', 10972 => 'ON', 10973 => 'ON', 10974 => 'ON', 10975 => 'ON', 10976 => 'ON', 10977 => 'ON', 10978 => 'ON', 10979 => 'ON', 10980 => 'ON', 10981 => 'ON', 10982 => 'ON', 10983 => 'ON', 10984 => 'ON', 10985 => 'ON', 10986 => 'ON', 10987 => 'ON', 10988 => 'ON', 10989 => 'ON', 10990 => 'ON', 10991 => 'ON', 10992 => 'ON', 10993 => 'ON', 10994 => 'ON', 10995 => 'ON', 10996 => 'ON', 10997 => 'ON', 10998 => 'ON', 10999 => 'ON', 11000 => 'ON', 11001 => 'ON', 11002 => 'ON', 11003 => 'ON', 11004 => 'ON', 11005 => 'ON', 11006 => 'ON', 11007 => 'ON', 11008 => 'ON', 11009 => 'ON', 11010 => 'ON', 11011 => 'ON', 11012 => 'ON', 11013 => 'ON', 11014 => 'ON', 11015 => 'ON', 11016 => 'ON', 11017 => 'ON', 11018 => 'ON', 11019 => 'ON', 11020 => 'ON', 11021 => 'ON', 11022 => 'ON', 11023 => 'ON', 11024 => 'ON', 11025 => 'ON', 11026 => 'ON', 11027 => 'ON', 11028 => 'ON', 11029 => 'ON', 11030 => 'ON', 11031 => 'ON', 11032 => 'ON', 11033 => 'ON', 11034 => 'ON', 11040 => 'ON', 11041 => 'ON', 11042 => 'ON', 11043 => 'ON', 11264 => 'L', 11265 => 'L', 11266 => 'L', 11267 => 'L', 11268 => 'L', 11269 => 'L', 11270 => 'L', 11271 => 'L', 11272 => 'L', 11273 => 'L', 11274 => 'L', 11275 => 'L', 11276 => 'L', 11277 => 'L', 11278 => 'L', 11279 => 'L', 11280 => 'L', 11281 => 'L', 11282 => 'L', 11283 => 'L', 11284 => 'L', 11285 => 'L', 11286 => 'L', 11287 => 'L', 11288 => 'L', 11289 => 'L', 11290 => 'L', 11291 => 'L', 11292 => 'L', 11293 => 'L', 11294 => 'L', 11295 => 'L', 11296 => 'L', 11297 => 'L', 11298 => 'L', 11299 => 'L', 11300 => 'L', 11301 => 'L', 11302 => 'L', 11303 => 'L', 11304 => 'L', 11305 => 'L', 11306 => 'L', 11307 => 'L', 11308 => 'L', 11309 => 'L', 11310 => 'L', 11312 => 'L', 11313 => 'L', 11314 => 'L', 11315 => 'L', 11316 => 'L', 11317 => 'L', 11318 => 'L', 11319 => 'L', 11320 => 'L', 11321 => 'L', 11322 => 'L', 11323 => 'L', 11324 => 'L', 11325 => 'L', 11326 => 'L', 11327 => 'L', 11328 => 'L', 11329 => 'L', 11330 => 'L', 11331 => 'L', 11332 => 'L', 11333 => 'L', 11334 => 'L', 11335 => 'L', 11336 => 'L', 11337 => 'L', 11338 => 'L', 11339 => 'L', 11340 => 'L', 11341 => 'L', 11342 => 'L', 11343 => 'L', 11344 => 'L', 11345 => 'L', 11346 => 'L', 11347 => 'L', 11348 => 'L', 11349 => 'L', 11350 => 'L', 11351 => 'L', 11352 => 'L', 11353 => 'L', 11354 => 'L', 11355 => 'L', 11356 => 'L', 11357 => 'L', 11358 => 'L', 11360 => 'L', 11361 => 'L', 11362 => 'L', 11363 => 'L', 11364 => 'L', 11365 => 'L', 11366 => 'L', 11367 => 'L', 11368 => 'L', 11369 => 'L', 11370 => 'L', 11371 => 'L', 11372 => 'L', 11380 => 'L', 11381 => 'L', 11382 => 'L', 11383 => 'L', 11392 => 'L', 11393 => 'L', 11394 => 'L', 11395 => 'L', 11396 => 'L', 11397 => 'L', 11398 => 'L', 11399 => 'L', 11400 => 'L', 11401 => 'L', 11402 => 'L', 11403 => 'L', 11404 => 'L', 11405 => 'L', 11406 => 'L', 11407 => 'L', 11408 => 'L', 11409 => 'L', 11410 => 'L', 11411 => 'L', 11412 => 'L', 11413 => 'L', 11414 => 'L', 11415 => 'L', 11416 => 'L', 11417 => 'L', 11418 => 'L', 11419 => 'L', 11420 => 'L', 11421 => 'L', 11422 => 'L', 11423 => 'L', 11424 => 'L', 11425 => 'L', 11426 => 'L', 11427 => 'L', 11428 => 'L', 11429 => 'L', 11430 => 'L', 11431 => 'L', 11432 => 'L', 11433 => 'L', 11434 => 'L', 11435 => 'L', 11436 => 'L', 11437 => 'L', 11438 => 'L', 11439 => 'L', 11440 => 'L', 11441 => 'L', 11442 => 'L', 11443 => 'L', 11444 => 'L', 11445 => 'L', 11446 => 'L', 11447 => 'L', 11448 => 'L', 11449 => 'L', 11450 => 'L', 11451 => 'L', 11452 => 'L', 11453 => 'L', 11454 => 'L', 11455 => 'L', 11456 => 'L', 11457 => 'L', 11458 => 'L', 11459 => 'L', 11460 => 'L', 11461 => 'L', 11462 => 'L', 11463 => 'L', 11464 => 'L', 11465 => 'L', 11466 => 'L', 11467 => 'L', 11468 => 'L', 11469 => 'L', 11470 => 'L', 11471 => 'L', 11472 => 'L', 11473 => 'L', 11474 => 'L', 11475 => 'L', 11476 => 'L', 11477 => 'L', 11478 => 'L', 11479 => 'L', 11480 => 'L', 11481 => 'L', 11482 => 'L', 11483 => 'L', 11484 => 'L', 11485 => 'L', 11486 => 'L', 11487 => 'L', 11488 => 'L', 11489 => 'L', 11490 => 'L', 11491 => 'L', 11492 => 'L', 11493 => 'ON', 11494 => 'ON', 11495 => 'ON', 11496 => 'ON', 11497 => 'ON', 11498 => 'ON', 11513 => 'ON', 11514 => 'ON', 11515 => 'ON', 11516 => 'ON', 11517 => 'ON', 11518 => 'ON', 11519 => 'ON', 11520 => 'L', 11521 => 'L', 11522 => 'L', 11523 => 'L', 11524 => 'L', 11525 => 'L', 11526 => 'L', 11527 => 'L', 11528 => 'L', 11529 => 'L', 11530 => 'L', 11531 => 'L', 11532 => 'L', 11533 => 'L', 11534 => 'L', 11535 => 'L', 11536 => 'L', 11537 => 'L', 11538 => 'L', 11539 => 'L', 11540 => 'L', 11541 => 'L', 11542 => 'L', 11543 => 'L', 11544 => 'L', 11545 => 'L', 11546 => 'L', 11547 => 'L', 11548 => 'L', 11549 => 'L', 11550 => 'L', 11551 => 'L', 11552 => 'L', 11553 => 'L', 11554 => 'L', 11555 => 'L', 11556 => 'L', 11557 => 'L', 11568 => 'L', 11569 => 'L', 11570 => 'L', 11571 => 'L', 11572 => 'L', 11573 => 'L', 11574 => 'L', 11575 => 'L', 11576 => 'L', 11577 => 'L', 11578 => 'L', 11579 => 'L', 11580 => 'L', 11581 => 'L', 11582 => 'L', 11583 => 'L', 11584 => 'L', 11585 => 'L', 11586 => 'L', 11587 => 'L', 11588 => 'L', 11589 => 'L', 11590 => 'L', 11591 => 'L', 11592 => 'L', 11593 => 'L', 11594 => 'L', 11595 => 'L', 11596 => 'L', 11597 => 'L', 11598 => 'L', 11599 => 'L', 11600 => 'L', 11601 => 'L', 11602 => 'L', 11603 => 'L', 11604 => 'L', 11605 => 'L', 11606 => 'L', 11607 => 'L', 11608 => 'L', 11609 => 'L', 11610 => 'L', 11611 => 'L', 11612 => 'L', 11613 => 'L', 11614 => 'L', 11615 => 'L', 11616 => 'L', 11617 => 'L', 11618 => 'L', 11619 => 'L', 11620 => 'L', 11621 => 'L', 11631 => 'L', 11648 => 'L', 11649 => 'L', 11650 => 'L', 11651 => 'L', 11652 => 'L', 11653 => 'L', 11654 => 'L', 11655 => 'L', 11656 => 'L', 11657 => 'L', 11658 => 'L', 11659 => 'L', 11660 => 'L', 11661 => 'L', 11662 => 'L', 11663 => 'L', 11664 => 'L', 11665 => 'L', 11666 => 'L', 11667 => 'L', 11668 => 'L', 11669 => 'L', 11670 => 'L', 11680 => 'L', 11681 => 'L', 11682 => 'L', 11683 => 'L', 11684 => 'L', 11685 => 'L', 11686 => 'L', 11688 => 'L', 11689 => 'L', 11690 => 'L', 11691 => 'L', 11692 => 'L', 11693 => 'L', 11694 => 'L', 11696 => 'L', 11697 => 'L', 11698 => 'L', 11699 => 'L', 11700 => 'L', 11701 => 'L', 11702 => 'L', 11704 => 'L', 11705 => 'L', 11706 => 'L', 11707 => 'L', 11708 => 'L', 11709 => 'L', 11710 => 'L', 11712 => 'L', 11713 => 'L', 11714 => 'L', 11715 => 'L', 11716 => 'L', 11717 => 'L', 11718 => 'L', 11720 => 'L', 11721 => 'L', 11722 => 'L', 11723 => 'L', 11724 => 'L', 11725 => 'L', 11726 => 'L', 11728 => 'L', 11729 => 'L', 11730 => 'L', 11731 => 'L', 11732 => 'L', 11733 => 'L', 11734 => 'L', 11736 => 'L', 11737 => 'L', 11738 => 'L', 11739 => 'L', 11740 => 'L', 11741 => 'L', 11742 => 'L', 11776 => 'ON', 11777 => 'ON', 11778 => 'ON', 11779 => 'ON', 11780 => 'ON', 11781 => 'ON', 11782 => 'ON', 11783 => 'ON', 11784 => 'ON', 11785 => 'ON', 11786 => 'ON', 11787 => 'ON', 11788 => 'ON', 11789 => 'ON', 11790 => 'ON', 11791 => 'ON', 11792 => 'ON', 11793 => 'ON', 11794 => 'ON', 11795 => 'ON', 11796 => 'ON', 11797 => 'ON', 11798 => 'ON', 11799 => 'ON', 11804 => 'ON', 11805 => 'ON', 11904 => 'ON', 11905 => 'ON', 11906 => 'ON', 11907 => 'ON', 11908 => 'ON', 11909 => 'ON', 11910 => 'ON', 11911 => 'ON', 11912 => 'ON', 11913 => 'ON', 11914 => 'ON', 11915 => 'ON', 11916 => 'ON', 11917 => 'ON', 11918 => 'ON', 11919 => 'ON', 11920 => 'ON', 11921 => 'ON', 11922 => 'ON', 11923 => 'ON', 11924 => 'ON', 11925 => 'ON', 11926 => 'ON', 11927 => 'ON', 11928 => 'ON', 11929 => 'ON', 11931 => 'ON', 11932 => 'ON', 11933 => 'ON', 11934 => 'ON', 11935 => 'ON', 11936 => 'ON', 11937 => 'ON', 11938 => 'ON', 11939 => 'ON', 11940 => 'ON', 11941 => 'ON', 11942 => 'ON', 11943 => 'ON', 11944 => 'ON', 11945 => 'ON', 11946 => 'ON', 11947 => 'ON', 11948 => 'ON', 11949 => 'ON', 11950 => 'ON', 11951 => 'ON', 11952 => 'ON', 11953 => 'ON', 11954 => 'ON', 11955 => 'ON', 11956 => 'ON', 11957 => 'ON', 11958 => 'ON', 11959 => 'ON', 11960 => 'ON', 11961 => 'ON', 11962 => 'ON', 11963 => 'ON', 11964 => 'ON', 11965 => 'ON', 11966 => 'ON', 11967 => 'ON', 11968 => 'ON', 11969 => 'ON', 11970 => 'ON', 11971 => 'ON', 11972 => 'ON', 11973 => 'ON', 11974 => 'ON', 11975 => 'ON', 11976 => 'ON', 11977 => 'ON', 11978 => 'ON', 11979 => 'ON', 11980 => 'ON', 11981 => 'ON', 11982 => 'ON', 11983 => 'ON', 11984 => 'ON', 11985 => 'ON', 11986 => 'ON', 11987 => 'ON', 11988 => 'ON', 11989 => 'ON', 11990 => 'ON', 11991 => 'ON', 11992 => 'ON', 11993 => 'ON', 11994 => 'ON', 11995 => 'ON', 11996 => 'ON', 11997 => 'ON', 11998 => 'ON', 11999 => 'ON', 12000 => 'ON', 12001 => 'ON', 12002 => 'ON', 12003 => 'ON', 12004 => 'ON', 12005 => 'ON', 12006 => 'ON', 12007 => 'ON', 12008 => 'ON', 12009 => 'ON', 12010 => 'ON', 12011 => 'ON', 12012 => 'ON', 12013 => 'ON', 12014 => 'ON', 12015 => 'ON', 12016 => 'ON', 12017 => 'ON', 12018 => 'ON', 12019 => 'ON', 12032 => 'ON', 12033 => 'ON', 12034 => 'ON', 12035 => 'ON', 12036 => 'ON', 12037 => 'ON', 12038 => 'ON', 12039 => 'ON', 12040 => 'ON', 12041 => 'ON', 12042 => 'ON', 12043 => 'ON', 12044 => 'ON', 12045 => 'ON', 12046 => 'ON', 12047 => 'ON', 12048 => 'ON', 12049 => 'ON', 12050 => 'ON', 12051 => 'ON', 12052 => 'ON', 12053 => 'ON', 12054 => 'ON', 12055 => 'ON', 12056 => 'ON', 12057 => 'ON', 12058 => 'ON', 12059 => 'ON', 12060 => 'ON', 12061 => 'ON', 12062 => 'ON', 12063 => 'ON', 12064 => 'ON', 12065 => 'ON', 12066 => 'ON', 12067 => 'ON', 12068 => 'ON', 12069 => 'ON', 12070 => 'ON', 12071 => 'ON', 12072 => 'ON', 12073 => 'ON', 12074 => 'ON', 12075 => 'ON', 12076 => 'ON', 12077 => 'ON', 12078 => 'ON', 12079 => 'ON', 12080 => 'ON', 12081 => 'ON', 12082 => 'ON', 12083 => 'ON', 12084 => 'ON', 12085 => 'ON', 12086 => 'ON', 12087 => 'ON', 12088 => 'ON', 12089 => 'ON', 12090 => 'ON', 12091 => 'ON', 12092 => 'ON', 12093 => 'ON', 12094 => 'ON', 12095 => 'ON', 12096 => 'ON', 12097 => 'ON', 12098 => 'ON', 12099 => 'ON', 12100 => 'ON', 12101 => 'ON', 12102 => 'ON', 12103 => 'ON', 12104 => 'ON', 12105 => 'ON', 12106 => 'ON', 12107 => 'ON', 12108 => 'ON', 12109 => 'ON', 12110 => 'ON', 12111 => 'ON', 12112 => 'ON', 12113 => 'ON', 12114 => 'ON', 12115 => 'ON', 12116 => 'ON', 12117 => 'ON', 12118 => 'ON', 12119 => 'ON', 12120 => 'ON', 12121 => 'ON', 12122 => 'ON', 12123 => 'ON', 12124 => 'ON', 12125 => 'ON', 12126 => 'ON', 12127 => 'ON', 12128 => 'ON', 12129 => 'ON', 12130 => 'ON', 12131 => 'ON', 12132 => 'ON', 12133 => 'ON', 12134 => 'ON', 12135 => 'ON', 12136 => 'ON', 12137 => 'ON', 12138 => 'ON', 12139 => 'ON', 12140 => 'ON', 12141 => 'ON', 12142 => 'ON', 12143 => 'ON', 12144 => 'ON', 12145 => 'ON', 12146 => 'ON', 12147 => 'ON', 12148 => 'ON', 12149 => 'ON', 12150 => 'ON', 12151 => 'ON', 12152 => 'ON', 12153 => 'ON', 12154 => 'ON', 12155 => 'ON', 12156 => 'ON', 12157 => 'ON', 12158 => 'ON', 12159 => 'ON', 12160 => 'ON', 12161 => 'ON', 12162 => 'ON', 12163 => 'ON', 12164 => 'ON', 12165 => 'ON', 12166 => 'ON', 12167 => 'ON', 12168 => 'ON', 12169 => 'ON', 12170 => 'ON', 12171 => 'ON', 12172 => 'ON', 12173 => 'ON', 12174 => 'ON', 12175 => 'ON', 12176 => 'ON', 12177 => 'ON', 12178 => 'ON', 12179 => 'ON', 12180 => 'ON', 12181 => 'ON', 12182 => 'ON', 12183 => 'ON', 12184 => 'ON', 12185 => 'ON', 12186 => 'ON', 12187 => 'ON', 12188 => 'ON', 12189 => 'ON', 12190 => 'ON', 12191 => 'ON', 12192 => 'ON', 12193 => 'ON', 12194 => 'ON', 12195 => 'ON', 12196 => 'ON', 12197 => 'ON', 12198 => 'ON', 12199 => 'ON', 12200 => 'ON', 12201 => 'ON', 12202 => 'ON', 12203 => 'ON', 12204 => 'ON', 12205 => 'ON', 12206 => 'ON', 12207 => 'ON', 12208 => 'ON', 12209 => 'ON', 12210 => 'ON', 12211 => 'ON', 12212 => 'ON', 12213 => 'ON', 12214 => 'ON', 12215 => 'ON', 12216 => 'ON', 12217 => 'ON', 12218 => 'ON', 12219 => 'ON', 12220 => 'ON', 12221 => 'ON', 12222 => 'ON', 12223 => 'ON', 12224 => 'ON', 12225 => 'ON', 12226 => 'ON', 12227 => 'ON', 12228 => 'ON', 12229 => 'ON', 12230 => 'ON', 12231 => 'ON', 12232 => 'ON', 12233 => 'ON', 12234 => 'ON', 12235 => 'ON', 12236 => 'ON', 12237 => 'ON', 12238 => 'ON', 12239 => 'ON', 12240 => 'ON', 12241 => 'ON', 12242 => 'ON', 12243 => 'ON', 12244 => 'ON', 12245 => 'ON', 12272 => 'ON', 12273 => 'ON', 12274 => 'ON', 12275 => 'ON', 12276 => 'ON', 12277 => 'ON', 12278 => 'ON', 12279 => 'ON', 12280 => 'ON', 12281 => 'ON', 12282 => 'ON', 12283 => 'ON', 12288 => 'WS', 12289 => 'ON', 12290 => 'ON', 12291 => 'ON', 12292 => 'ON', 12293 => 'L', 12294 => 'L', 12295 => 'L', 12296 => 'ON', 12297 => 'ON', 12298 => 'ON', 12299 => 'ON', 12300 => 'ON', 12301 => 'ON', 12302 => 'ON', 12303 => 'ON', 12304 => 'ON', 12305 => 'ON', 12306 => 'ON', 12307 => 'ON', 12308 => 'ON', 12309 => 'ON', 12310 => 'ON', 12311 => 'ON', 12312 => 'ON', 12313 => 'ON', 12314 => 'ON', 12315 => 'ON', 12316 => 'ON', 12317 => 'ON', 12318 => 'ON', 12319 => 'ON', 12320 => 'ON', 12321 => 'L', 12322 => 'L', 12323 => 'L', 12324 => 'L', 12325 => 'L', 12326 => 'L', 12327 => 'L', 12328 => 'L', 12329 => 'L', 12330 => 'NSM', 12331 => 'NSM', 12332 => 'NSM', 12333 => 'NSM', 12334 => 'NSM', 12335 => 'NSM', 12336 => 'ON', 12337 => 'L', 12338 => 'L', 12339 => 'L', 12340 => 'L', 12341 => 'L', 12342 => 'ON', 12343 => 'ON', 12344 => 'L', 12345 => 'L', 12346 => 'L', 12347 => 'L', 12348 => 'L', 12349 => 'ON', 12350 => 'ON', 12351 => 'ON', 12353 => 'L', 12354 => 'L', 12355 => 'L', 12356 => 'L', 12357 => 'L', 12358 => 'L', 12359 => 'L', 12360 => 'L', 12361 => 'L', 12362 => 'L', 12363 => 'L', 12364 => 'L', 12365 => 'L', 12366 => 'L', 12367 => 'L', 12368 => 'L', 12369 => 'L', 12370 => 'L', 12371 => 'L', 12372 => 'L', 12373 => 'L', 12374 => 'L', 12375 => 'L', 12376 => 'L', 12377 => 'L', 12378 => 'L', 12379 => 'L', 12380 => 'L', 12381 => 'L', 12382 => 'L', 12383 => 'L', 12384 => 'L', 12385 => 'L', 12386 => 'L', 12387 => 'L', 12388 => 'L', 12389 => 'L', 12390 => 'L', 12391 => 'L', 12392 => 'L', 12393 => 'L', 12394 => 'L', 12395 => 'L', 12396 => 'L', 12397 => 'L', 12398 => 'L', 12399 => 'L', 12400 => 'L', 12401 => 'L', 12402 => 'L', 12403 => 'L', 12404 => 'L', 12405 => 'L', 12406 => 'L', 12407 => 'L', 12408 => 'L', 12409 => 'L', 12410 => 'L', 12411 => 'L', 12412 => 'L', 12413 => 'L', 12414 => 'L', 12415 => 'L', 12416 => 'L', 12417 => 'L', 12418 => 'L', 12419 => 'L', 12420 => 'L', 12421 => 'L', 12422 => 'L', 12423 => 'L', 12424 => 'L', 12425 => 'L', 12426 => 'L', 12427 => 'L', 12428 => 'L', 12429 => 'L', 12430 => 'L', 12431 => 'L', 12432 => 'L', 12433 => 'L', 12434 => 'L', 12435 => 'L', 12436 => 'L', 12437 => 'L', 12438 => 'L', 12441 => 'NSM', 12442 => 'NSM', 12443 => 'ON', 12444 => 'ON', 12445 => 'L', 12446 => 'L', 12447 => 'L', 12448 => 'ON', 12449 => 'L', 12450 => 'L', 12451 => 'L', 12452 => 'L', 12453 => 'L', 12454 => 'L', 12455 => 'L', 12456 => 'L', 12457 => 'L', 12458 => 'L', 12459 => 'L', 12460 => 'L', 12461 => 'L', 12462 => 'L', 12463 => 'L', 12464 => 'L', 12465 => 'L', 12466 => 'L', 12467 => 'L', 12468 => 'L', 12469 => 'L', 12470 => 'L', 12471 => 'L', 12472 => 'L', 12473 => 'L', 12474 => 'L', 12475 => 'L', 12476 => 'L', 12477 => 'L', 12478 => 'L', 12479 => 'L', 12480 => 'L', 12481 => 'L', 12482 => 'L', 12483 => 'L', 12484 => 'L', 12485 => 'L', 12486 => 'L', 12487 => 'L', 12488 => 'L', 12489 => 'L', 12490 => 'L', 12491 => 'L', 12492 => 'L', 12493 => 'L', 12494 => 'L', 12495 => 'L', 12496 => 'L', 12497 => 'L', 12498 => 'L', 12499 => 'L', 12500 => 'L', 12501 => 'L', 12502 => 'L', 12503 => 'L', 12504 => 'L', 12505 => 'L', 12506 => 'L', 12507 => 'L', 12508 => 'L', 12509 => 'L', 12510 => 'L', 12511 => 'L', 12512 => 'L', 12513 => 'L', 12514 => 'L', 12515 => 'L', 12516 => 'L', 12517 => 'L', 12518 => 'L', 12519 => 'L', 12520 => 'L', 12521 => 'L', 12522 => 'L', 12523 => 'L', 12524 => 'L', 12525 => 'L', 12526 => 'L', 12527 => 'L', 12528 => 'L', 12529 => 'L', 12530 => 'L', 12531 => 'L', 12532 => 'L', 12533 => 'L', 12534 => 'L', 12535 => 'L', 12536 => 'L', 12537 => 'L', 12538 => 'L', 12539 => 'ON', 12540 => 'L', 12541 => 'L', 12542 => 'L', 12543 => 'L', 12549 => 'L', 12550 => 'L', 12551 => 'L', 12552 => 'L', 12553 => 'L', 12554 => 'L', 12555 => 'L', 12556 => 'L', 12557 => 'L', 12558 => 'L', 12559 => 'L', 12560 => 'L', 12561 => 'L', 12562 => 'L', 12563 => 'L', 12564 => 'L', 12565 => 'L', 12566 => 'L', 12567 => 'L', 12568 => 'L', 12569 => 'L', 12570 => 'L', 12571 => 'L', 12572 => 'L', 12573 => 'L', 12574 => 'L', 12575 => 'L', 12576 => 'L', 12577 => 'L', 12578 => 'L', 12579 => 'L', 12580 => 'L', 12581 => 'L', 12582 => 'L', 12583 => 'L', 12584 => 'L', 12585 => 'L', 12586 => 'L', 12587 => 'L', 12588 => 'L', 12593 => 'L', 12594 => 'L', 12595 => 'L', 12596 => 'L', 12597 => 'L', 12598 => 'L', 12599 => 'L', 12600 => 'L', 12601 => 'L', 12602 => 'L', 12603 => 'L', 12604 => 'L', 12605 => 'L', 12606 => 'L', 12607 => 'L', 12608 => 'L', 12609 => 'L', 12610 => 'L', 12611 => 'L', 12612 => 'L', 12613 => 'L', 12614 => 'L', 12615 => 'L', 12616 => 'L', 12617 => 'L', 12618 => 'L', 12619 => 'L', 12620 => 'L', 12621 => 'L', 12622 => 'L', 12623 => 'L', 12624 => 'L', 12625 => 'L', 12626 => 'L', 12627 => 'L', 12628 => 'L', 12629 => 'L', 12630 => 'L', 12631 => 'L', 12632 => 'L', 12633 => 'L', 12634 => 'L', 12635 => 'L', 12636 => 'L', 12637 => 'L', 12638 => 'L', 12639 => 'L', 12640 => 'L', 12641 => 'L', 12642 => 'L', 12643 => 'L', 12644 => 'L', 12645 => 'L', 12646 => 'L', 12647 => 'L', 12648 => 'L', 12649 => 'L', 12650 => 'L', 12651 => 'L', 12652 => 'L', 12653 => 'L', 12654 => 'L', 12655 => 'L', 12656 => 'L', 12657 => 'L', 12658 => 'L', 12659 => 'L', 12660 => 'L', 12661 => 'L', 12662 => 'L', 12663 => 'L', 12664 => 'L', 12665 => 'L', 12666 => 'L', 12667 => 'L', 12668 => 'L', 12669 => 'L', 12670 => 'L', 12671 => 'L', 12672 => 'L', 12673 => 'L', 12674 => 'L', 12675 => 'L', 12676 => 'L', 12677 => 'L', 12678 => 'L', 12679 => 'L', 12680 => 'L', 12681 => 'L', 12682 => 'L', 12683 => 'L', 12684 => 'L', 12685 => 'L', 12686 => 'L', 12688 => 'L', 12689 => 'L', 12690 => 'L', 12691 => 'L', 12692 => 'L', 12693 => 'L', 12694 => 'L', 12695 => 'L', 12696 => 'L', 12697 => 'L', 12698 => 'L', 12699 => 'L', 12700 => 'L', 12701 => 'L', 12702 => 'L', 12703 => 'L', 12704 => 'L', 12705 => 'L', 12706 => 'L', 12707 => 'L', 12708 => 'L', 12709 => 'L', 12710 => 'L', 12711 => 'L', 12712 => 'L', 12713 => 'L', 12714 => 'L', 12715 => 'L', 12716 => 'L', 12717 => 'L', 12718 => 'L', 12719 => 'L', 12720 => 'L', 12721 => 'L', 12722 => 'L', 12723 => 'L', 12724 => 'L', 12725 => 'L', 12726 => 'L', 12727 => 'L', 12736 => 'ON', 12737 => 'ON', 12738 => 'ON', 12739 => 'ON', 12740 => 'ON', 12741 => 'ON', 12742 => 'ON', 12743 => 'ON', 12744 => 'ON', 12745 => 'ON', 12746 => 'ON', 12747 => 'ON', 12748 => 'ON', 12749 => 'ON', 12750 => 'ON', 12751 => 'ON', 12784 => 'L', 12785 => 'L', 12786 => 'L', 12787 => 'L', 12788 => 'L', 12789 => 'L', 12790 => 'L', 12791 => 'L', 12792 => 'L', 12793 => 'L', 12794 => 'L', 12795 => 'L', 12796 => 'L', 12797 => 'L', 12798 => 'L', 12799 => 'L', 12800 => 'L', 12801 => 'L', 12802 => 'L', 12803 => 'L', 12804 => 'L', 12805 => 'L', 12806 => 'L', 12807 => 'L', 12808 => 'L', 12809 => 'L', 12810 => 'L', 12811 => 'L', 12812 => 'L', 12813 => 'L', 12814 => 'L', 12815 => 'L', 12816 => 'L', 12817 => 'L', 12818 => 'L', 12819 => 'L', 12820 => 'L', 12821 => 'L', 12822 => 'L', 12823 => 'L', 12824 => 'L', 12825 => 'L', 12826 => 'L', 12827 => 'L', 12828 => 'L', 12829 => 'ON', 12830 => 'ON', 12832 => 'L', 12833 => 'L', 12834 => 'L', 12835 => 'L', 12836 => 'L', 12837 => 'L', 12838 => 'L', 12839 => 'L', 12840 => 'L', 12841 => 'L', 12842 => 'L', 12843 => 'L', 12844 => 'L', 12845 => 'L', 12846 => 'L', 12847 => 'L', 12848 => 'L', 12849 => 'L', 12850 => 'L', 12851 => 'L', 12852 => 'L', 12853 => 'L', 12854 => 'L', 12855 => 'L', 12856 => 'L', 12857 => 'L', 12858 => 'L', 12859 => 'L', 12860 => 'L', 12861 => 'L', 12862 => 'L', 12863 => 'L', 12864 => 'L', 12865 => 'L', 12866 => 'L', 12867 => 'L', 12880 => 'ON', 12881 => 'ON', 12882 => 'ON', 12883 => 'ON', 12884 => 'ON', 12885 => 'ON', 12886 => 'ON', 12887 => 'ON', 12888 => 'ON', 12889 => 'ON', 12890 => 'ON', 12891 => 'ON', 12892 => 'ON', 12893 => 'ON', 12894 => 'ON', 12895 => 'ON', 12896 => 'L', 12897 => 'L', 12898 => 'L', 12899 => 'L', 12900 => 'L', 12901 => 'L', 12902 => 'L', 12903 => 'L', 12904 => 'L', 12905 => 'L', 12906 => 'L', 12907 => 'L', 12908 => 'L', 12909 => 'L', 12910 => 'L', 12911 => 'L', 12912 => 'L', 12913 => 'L', 12914 => 'L', 12915 => 'L', 12916 => 'L', 12917 => 'L', 12918 => 'L', 12919 => 'L', 12920 => 'L', 12921 => 'L', 12922 => 'L', 12923 => 'L', 12924 => 'ON', 12925 => 'ON', 12926 => 'ON', 12927 => 'L', 12928 => 'L', 12929 => 'L', 12930 => 'L', 12931 => 'L', 12932 => 'L', 12933 => 'L', 12934 => 'L', 12935 => 'L', 12936 => 'L', 12937 => 'L', 12938 => 'L', 12939 => 'L', 12940 => 'L', 12941 => 'L', 12942 => 'L', 12943 => 'L', 12944 => 'L', 12945 => 'L', 12946 => 'L', 12947 => 'L', 12948 => 'L', 12949 => 'L', 12950 => 'L', 12951 => 'L', 12952 => 'L', 12953 => 'L', 12954 => 'L', 12955 => 'L', 12956 => 'L', 12957 => 'L', 12958 => 'L', 12959 => 'L', 12960 => 'L', 12961 => 'L', 12962 => 'L', 12963 => 'L', 12964 => 'L', 12965 => 'L', 12966 => 'L', 12967 => 'L', 12968 => 'L', 12969 => 'L', 12970 => 'L', 12971 => 'L', 12972 => 'L', 12973 => 'L', 12974 => 'L', 12975 => 'L', 12976 => 'L', 12977 => 'ON', 12978 => 'ON', 12979 => 'ON', 12980 => 'ON', 12981 => 'ON', 12982 => 'ON', 12983 => 'ON', 12984 => 'ON', 12985 => 'ON', 12986 => 'ON', 12987 => 'ON', 12988 => 'ON', 12989 => 'ON', 12990 => 'ON', 12991 => 'ON', 12992 => 'L', 12993 => 'L', 12994 => 'L', 12995 => 'L', 12996 => 'L', 12997 => 'L', 12998 => 'L', 12999 => 'L', 13000 => 'L', 13001 => 'L', 13002 => 'L', 13003 => 'L', 13004 => 'ON', 13005 => 'ON', 13006 => 'ON', 13007 => 'ON', 13008 => 'L', 13009 => 'L', 13010 => 'L', 13011 => 'L', 13012 => 'L', 13013 => 'L', 13014 => 'L', 13015 => 'L', 13016 => 'L', 13017 => 'L', 13018 => 'L', 13019 => 'L', 13020 => 'L', 13021 => 'L', 13022 => 'L', 13023 => 'L', 13024 => 'L', 13025 => 'L', 13026 => 'L', 13027 => 'L', 13028 => 'L', 13029 => 'L', 13030 => 'L', 13031 => 'L', 13032 => 'L', 13033 => 'L', 13034 => 'L', 13035 => 'L', 13036 => 'L', 13037 => 'L', 13038 => 'L', 13039 => 'L', 13040 => 'L', 13041 => 'L', 13042 => 'L', 13043 => 'L', 13044 => 'L', 13045 => 'L', 13046 => 'L', 13047 => 'L', 13048 => 'L', 13049 => 'L', 13050 => 'L', 13051 => 'L', 13052 => 'L', 13053 => 'L', 13054 => 'L', 13056 => 'L', 13057 => 'L', 13058 => 'L', 13059 => 'L', 13060 => 'L', 13061 => 'L', 13062 => 'L', 13063 => 'L', 13064 => 'L', 13065 => 'L', 13066 => 'L', 13067 => 'L', 13068 => 'L', 13069 => 'L', 13070 => 'L', 13071 => 'L', 13072 => 'L', 13073 => 'L', 13074 => 'L', 13075 => 'L', 13076 => 'L', 13077 => 'L', 13078 => 'L', 13079 => 'L', 13080 => 'L', 13081 => 'L', 13082 => 'L', 13083 => 'L', 13084 => 'L', 13085 => 'L', 13086 => 'L', 13087 => 'L', 13088 => 'L', 13089 => 'L', 13090 => 'L', 13091 => 'L', 13092 => 'L', 13093 => 'L', 13094 => 'L', 13095 => 'L', 13096 => 'L', 13097 => 'L', 13098 => 'L', 13099 => 'L', 13100 => 'L', 13101 => 'L', 13102 => 'L', 13103 => 'L', 13104 => 'L', 13105 => 'L', 13106 => 'L', 13107 => 'L', 13108 => 'L', 13109 => 'L', 13110 => 'L', 13111 => 'L', 13112 => 'L', 13113 => 'L', 13114 => 'L', 13115 => 'L', 13116 => 'L', 13117 => 'L', 13118 => 'L', 13119 => 'L', 13120 => 'L', 13121 => 'L', 13122 => 'L', 13123 => 'L', 13124 => 'L', 13125 => 'L', 13126 => 'L', 13127 => 'L', 13128 => 'L', 13129 => 'L', 13130 => 'L', 13131 => 'L', 13132 => 'L', 13133 => 'L', 13134 => 'L', 13135 => 'L', 13136 => 'L', 13137 => 'L', 13138 => 'L', 13139 => 'L', 13140 => 'L', 13141 => 'L', 13142 => 'L', 13143 => 'L', 13144 => 'L', 13145 => 'L', 13146 => 'L', 13147 => 'L', 13148 => 'L', 13149 => 'L', 13150 => 'L', 13151 => 'L', 13152 => 'L', 13153 => 'L', 13154 => 'L', 13155 => 'L', 13156 => 'L', 13157 => 'L', 13158 => 'L', 13159 => 'L', 13160 => 'L', 13161 => 'L', 13162 => 'L', 13163 => 'L', 13164 => 'L', 13165 => 'L', 13166 => 'L', 13167 => 'L', 13168 => 'L', 13169 => 'L', 13170 => 'L', 13171 => 'L', 13172 => 'L', 13173 => 'L', 13174 => 'L', 13175 => 'ON', 13176 => 'ON', 13177 => 'ON', 13178 => 'ON', 13179 => 'L', 13180 => 'L', 13181 => 'L', 13182 => 'L', 13183 => 'L', 13184 => 'L', 13185 => 'L', 13186 => 'L', 13187 => 'L', 13188 => 'L', 13189 => 'L', 13190 => 'L', 13191 => 'L', 13192 => 'L', 13193 => 'L', 13194 => 'L', 13195 => 'L', 13196 => 'L', 13197 => 'L', 13198 => 'L', 13199 => 'L', 13200 => 'L', 13201 => 'L', 13202 => 'L', 13203 => 'L', 13204 => 'L', 13205 => 'L', 13206 => 'L', 13207 => 'L', 13208 => 'L', 13209 => 'L', 13210 => 'L', 13211 => 'L', 13212 => 'L', 13213 => 'L', 13214 => 'L', 13215 => 'L', 13216 => 'L', 13217 => 'L', 13218 => 'L', 13219 => 'L', 13220 => 'L', 13221 => 'L', 13222 => 'L', 13223 => 'L', 13224 => 'L', 13225 => 'L', 13226 => 'L', 13227 => 'L', 13228 => 'L', 13229 => 'L', 13230 => 'L', 13231 => 'L', 13232 => 'L', 13233 => 'L', 13234 => 'L', 13235 => 'L', 13236 => 'L', 13237 => 'L', 13238 => 'L', 13239 => 'L', 13240 => 'L', 13241 => 'L', 13242 => 'L', 13243 => 'L', 13244 => 'L', 13245 => 'L', 13246 => 'L', 13247 => 'L', 13248 => 'L', 13249 => 'L', 13250 => 'L', 13251 => 'L', 13252 => 'L', 13253 => 'L', 13254 => 'L', 13255 => 'L', 13256 => 'L', 13257 => 'L', 13258 => 'L', 13259 => 'L', 13260 => 'L', 13261 => 'L', 13262 => 'L', 13263 => 'L', 13264 => 'L', 13265 => 'L', 13266 => 'L', 13267 => 'L', 13268 => 'L', 13269 => 'L', 13270 => 'L', 13271 => 'L', 13272 => 'L', 13273 => 'L', 13274 => 'L', 13275 => 'L', 13276 => 'L', 13277 => 'L', 13278 => 'ON', 13279 => 'ON', 13280 => 'L', 13281 => 'L', 13282 => 'L', 13283 => 'L', 13284 => 'L', 13285 => 'L', 13286 => 'L', 13287 => 'L', 13288 => 'L', 13289 => 'L', 13290 => 'L', 13291 => 'L', 13292 => 'L', 13293 => 'L', 13294 => 'L', 13295 => 'L', 13296 => 'L', 13297 => 'L', 13298 => 'L', 13299 => 'L', 13300 => 'L', 13301 => 'L', 13302 => 'L', 13303 => 'L', 13304 => 'L', 13305 => 'L', 13306 => 'L', 13307 => 'L', 13308 => 'L', 13309 => 'L', 13310 => 'L', 13311 => 'ON', 13312 => 'L', 19893 => 'L', 19904 => 'ON', 19905 => 'ON', 19906 => 'ON', 19907 => 'ON', 19908 => 'ON', 19909 => 'ON', 19910 => 'ON', 19911 => 'ON', 19912 => 'ON', 19913 => 'ON', 19914 => 'ON', 19915 => 'ON', 19916 => 'ON', 19917 => 'ON', 19918 => 'ON', 19919 => 'ON', 19920 => 'ON', 19921 => 'ON', 19922 => 'ON', 19923 => 'ON', 19924 => 'ON', 19925 => 'ON', 19926 => 'ON', 19927 => 'ON', 19928 => 'ON', 19929 => 'ON', 19930 => 'ON', 19931 => 'ON', 19932 => 'ON', 19933 => 'ON', 19934 => 'ON', 19935 => 'ON', 19936 => 'ON', 19937 => 'ON', 19938 => 'ON', 19939 => 'ON', 19940 => 'ON', 19941 => 'ON', 19942 => 'ON', 19943 => 'ON', 19944 => 'ON', 19945 => 'ON', 19946 => 'ON', 19947 => 'ON', 19948 => 'ON', 19949 => 'ON', 19950 => 'ON', 19951 => 'ON', 19952 => 'ON', 19953 => 'ON', 19954 => 'ON', 19955 => 'ON', 19956 => 'ON', 19957 => 'ON', 19958 => 'ON', 19959 => 'ON', 19960 => 'ON', 19961 => 'ON', 19962 => 'ON', 19963 => 'ON', 19964 => 'ON', 19965 => 'ON', 19966 => 'ON', 19967 => 'ON', 19968 => 'L', 40891 => 'L', 40960 => 'L', 40961 => 'L', 40962 => 'L', 40963 => 'L', 40964 => 'L', 40965 => 'L', 40966 => 'L', 40967 => 'L', 40968 => 'L', 40969 => 'L', 40970 => 'L', 40971 => 'L', 40972 => 'L', 40973 => 'L', 40974 => 'L', 40975 => 'L', 40976 => 'L', 40977 => 'L', 40978 => 'L', 40979 => 'L', 40980 => 'L', 40981 => 'L', 40982 => 'L', 40983 => 'L', 40984 => 'L', 40985 => 'L', 40986 => 'L', 40987 => 'L', 40988 => 'L', 40989 => 'L', 40990 => 'L', 40991 => 'L', 40992 => 'L', 40993 => 'L', 40994 => 'L', 40995 => 'L', 40996 => 'L', 40997 => 'L', 40998 => 'L', 40999 => 'L', 41000 => 'L', 41001 => 'L', 41002 => 'L', 41003 => 'L', 41004 => 'L', 41005 => 'L', 41006 => 'L', 41007 => 'L', 41008 => 'L', 41009 => 'L', 41010 => 'L', 41011 => 'L', 41012 => 'L', 41013 => 'L', 41014 => 'L', 41015 => 'L', 41016 => 'L', 41017 => 'L', 41018 => 'L', 41019 => 'L', 41020 => 'L', 41021 => 'L', 41022 => 'L', 41023 => 'L', 41024 => 'L', 41025 => 'L', 41026 => 'L', 41027 => 'L', 41028 => 'L', 41029 => 'L', 41030 => 'L', 41031 => 'L', 41032 => 'L', 41033 => 'L', 41034 => 'L', 41035 => 'L', 41036 => 'L', 41037 => 'L', 41038 => 'L', 41039 => 'L', 41040 => 'L', 41041 => 'L', 41042 => 'L', 41043 => 'L', 41044 => 'L', 41045 => 'L', 41046 => 'L', 41047 => 'L', 41048 => 'L', 41049 => 'L', 41050 => 'L', 41051 => 'L', 41052 => 'L', 41053 => 'L', 41054 => 'L', 41055 => 'L', 41056 => 'L', 41057 => 'L', 41058 => 'L', 41059 => 'L', 41060 => 'L', 41061 => 'L', 41062 => 'L', 41063 => 'L', 41064 => 'L', 41065 => 'L', 41066 => 'L', 41067 => 'L', 41068 => 'L', 41069 => 'L', 41070 => 'L', 41071 => 'L', 41072 => 'L', 41073 => 'L', 41074 => 'L', 41075 => 'L', 41076 => 'L', 41077 => 'L', 41078 => 'L', 41079 => 'L', 41080 => 'L', 41081 => 'L', 41082 => 'L', 41083 => 'L', 41084 => 'L', 41085 => 'L', 41086 => 'L', 41087 => 'L', 41088 => 'L', 41089 => 'L', 41090 => 'L', 41091 => 'L', 41092 => 'L', 41093 => 'L', 41094 => 'L', 41095 => 'L', 41096 => 'L', 41097 => 'L', 41098 => 'L', 41099 => 'L', 41100 => 'L', 41101 => 'L', 41102 => 'L', 41103 => 'L', 41104 => 'L', 41105 => 'L', 41106 => 'L', 41107 => 'L', 41108 => 'L', 41109 => 'L', 41110 => 'L', 41111 => 'L', 41112 => 'L', 41113 => 'L', 41114 => 'L', 41115 => 'L', 41116 => 'L', 41117 => 'L', 41118 => 'L', 41119 => 'L', 41120 => 'L', 41121 => 'L', 41122 => 'L', 41123 => 'L', 41124 => 'L', 41125 => 'L', 41126 => 'L', 41127 => 'L', 41128 => 'L', 41129 => 'L', 41130 => 'L', 41131 => 'L', 41132 => 'L', 41133 => 'L', 41134 => 'L', 41135 => 'L', 41136 => 'L', 41137 => 'L', 41138 => 'L', 41139 => 'L', 41140 => 'L', 41141 => 'L', 41142 => 'L', 41143 => 'L', 41144 => 'L', 41145 => 'L', 41146 => 'L', 41147 => 'L', 41148 => 'L', 41149 => 'L', 41150 => 'L', 41151 => 'L', 41152 => 'L', 41153 => 'L', 41154 => 'L', 41155 => 'L', 41156 => 'L', 41157 => 'L', 41158 => 'L', 41159 => 'L', 41160 => 'L', 41161 => 'L', 41162 => 'L', 41163 => 'L', 41164 => 'L', 41165 => 'L', 41166 => 'L', 41167 => 'L', 41168 => 'L', 41169 => 'L', 41170 => 'L', 41171 => 'L', 41172 => 'L', 41173 => 'L', 41174 => 'L', 41175 => 'L', 41176 => 'L', 41177 => 'L', 41178 => 'L', 41179 => 'L', 41180 => 'L', 41181 => 'L', 41182 => 'L', 41183 => 'L', 41184 => 'L', 41185 => 'L', 41186 => 'L', 41187 => 'L', 41188 => 'L', 41189 => 'L', 41190 => 'L', 41191 => 'L', 41192 => 'L', 41193 => 'L', 41194 => 'L', 41195 => 'L', 41196 => 'L', 41197 => 'L', 41198 => 'L', 41199 => 'L', 41200 => 'L', 41201 => 'L', 41202 => 'L', 41203 => 'L', 41204 => 'L', 41205 => 'L', 41206 => 'L', 41207 => 'L', 41208 => 'L', 41209 => 'L', 41210 => 'L', 41211 => 'L', 41212 => 'L', 41213 => 'L', 41214 => 'L', 41215 => 'L', 41216 => 'L', 41217 => 'L', 41218 => 'L', 41219 => 'L', 41220 => 'L', 41221 => 'L', 41222 => 'L', 41223 => 'L', 41224 => 'L', 41225 => 'L', 41226 => 'L', 41227 => 'L', 41228 => 'L', 41229 => 'L', 41230 => 'L', 41231 => 'L', 41232 => 'L', 41233 => 'L', 41234 => 'L', 41235 => 'L', 41236 => 'L', 41237 => 'L', 41238 => 'L', 41239 => 'L', 41240 => 'L', 41241 => 'L', 41242 => 'L', 41243 => 'L', 41244 => 'L', 41245 => 'L', 41246 => 'L', 41247 => 'L', 41248 => 'L', 41249 => 'L', 41250 => 'L', 41251 => 'L', 41252 => 'L', 41253 => 'L', 41254 => 'L', 41255 => 'L', 41256 => 'L', 41257 => 'L', 41258 => 'L', 41259 => 'L', 41260 => 'L', 41261 => 'L', 41262 => 'L', 41263 => 'L', 41264 => 'L', 41265 => 'L', 41266 => 'L', 41267 => 'L', 41268 => 'L', 41269 => 'L', 41270 => 'L', 41271 => 'L', 41272 => 'L', 41273 => 'L', 41274 => 'L', 41275 => 'L', 41276 => 'L', 41277 => 'L', 41278 => 'L', 41279 => 'L', 41280 => 'L', 41281 => 'L', 41282 => 'L', 41283 => 'L', 41284 => 'L', 41285 => 'L', 41286 => 'L', 41287 => 'L', 41288 => 'L', 41289 => 'L', 41290 => 'L', 41291 => 'L', 41292 => 'L', 41293 => 'L', 41294 => 'L', 41295 => 'L', 41296 => 'L', 41297 => 'L', 41298 => 'L', 41299 => 'L', 41300 => 'L', 41301 => 'L', 41302 => 'L', 41303 => 'L', 41304 => 'L', 41305 => 'L', 41306 => 'L', 41307 => 'L', 41308 => 'L', 41309 => 'L', 41310 => 'L', 41311 => 'L', 41312 => 'L', 41313 => 'L', 41314 => 'L', 41315 => 'L', 41316 => 'L', 41317 => 'L', 41318 => 'L', 41319 => 'L', 41320 => 'L', 41321 => 'L', 41322 => 'L', 41323 => 'L', 41324 => 'L', 41325 => 'L', 41326 => 'L', 41327 => 'L', 41328 => 'L', 41329 => 'L', 41330 => 'L', 41331 => 'L', 41332 => 'L', 41333 => 'L', 41334 => 'L', 41335 => 'L', 41336 => 'L', 41337 => 'L', 41338 => 'L', 41339 => 'L', 41340 => 'L', 41341 => 'L', 41342 => 'L', 41343 => 'L', 41344 => 'L', 41345 => 'L', 41346 => 'L', 41347 => 'L', 41348 => 'L', 41349 => 'L', 41350 => 'L', 41351 => 'L', 41352 => 'L', 41353 => 'L', 41354 => 'L', 41355 => 'L', 41356 => 'L', 41357 => 'L', 41358 => 'L', 41359 => 'L', 41360 => 'L', 41361 => 'L', 41362 => 'L', 41363 => 'L', 41364 => 'L', 41365 => 'L', 41366 => 'L', 41367 => 'L', 41368 => 'L', 41369 => 'L', 41370 => 'L', 41371 => 'L', 41372 => 'L', 41373 => 'L', 41374 => 'L', 41375 => 'L', 41376 => 'L', 41377 => 'L', 41378 => 'L', 41379 => 'L', 41380 => 'L', 41381 => 'L', 41382 => 'L', 41383 => 'L', 41384 => 'L', 41385 => 'L', 41386 => 'L', 41387 => 'L', 41388 => 'L', 41389 => 'L', 41390 => 'L', 41391 => 'L', 41392 => 'L', 41393 => 'L', 41394 => 'L', 41395 => 'L', 41396 => 'L', 41397 => 'L', 41398 => 'L', 41399 => 'L', 41400 => 'L', 41401 => 'L', 41402 => 'L', 41403 => 'L', 41404 => 'L', 41405 => 'L', 41406 => 'L', 41407 => 'L', 41408 => 'L', 41409 => 'L', 41410 => 'L', 41411 => 'L', 41412 => 'L', 41413 => 'L', 41414 => 'L', 41415 => 'L', 41416 => 'L', 41417 => 'L', 41418 => 'L', 41419 => 'L', 41420 => 'L', 41421 => 'L', 41422 => 'L', 41423 => 'L', 41424 => 'L', 41425 => 'L', 41426 => 'L', 41427 => 'L', 41428 => 'L', 41429 => 'L', 41430 => 'L', 41431 => 'L', 41432 => 'L', 41433 => 'L', 41434 => 'L', 41435 => 'L', 41436 => 'L', 41437 => 'L', 41438 => 'L', 41439 => 'L', 41440 => 'L', 41441 => 'L', 41442 => 'L', 41443 => 'L', 41444 => 'L', 41445 => 'L', 41446 => 'L', 41447 => 'L', 41448 => 'L', 41449 => 'L', 41450 => 'L', 41451 => 'L', 41452 => 'L', 41453 => 'L', 41454 => 'L', 41455 => 'L', 41456 => 'L', 41457 => 'L', 41458 => 'L', 41459 => 'L', 41460 => 'L', 41461 => 'L', 41462 => 'L', 41463 => 'L', 41464 => 'L', 41465 => 'L', 41466 => 'L', 41467 => 'L', 41468 => 'L', 41469 => 'L', 41470 => 'L', 41471 => 'L', 41472 => 'L', 41473 => 'L', 41474 => 'L', 41475 => 'L', 41476 => 'L', 41477 => 'L', 41478 => 'L', 41479 => 'L', 41480 => 'L', 41481 => 'L', 41482 => 'L', 41483 => 'L', 41484 => 'L', 41485 => 'L', 41486 => 'L', 41487 => 'L', 41488 => 'L', 41489 => 'L', 41490 => 'L', 41491 => 'L', 41492 => 'L', 41493 => 'L', 41494 => 'L', 41495 => 'L', 41496 => 'L', 41497 => 'L', 41498 => 'L', 41499 => 'L', 41500 => 'L', 41501 => 'L', 41502 => 'L', 41503 => 'L', 41504 => 'L', 41505 => 'L', 41506 => 'L', 41507 => 'L', 41508 => 'L', 41509 => 'L', 41510 => 'L', 41511 => 'L', 41512 => 'L', 41513 => 'L', 41514 => 'L', 41515 => 'L', 41516 => 'L', 41517 => 'L', 41518 => 'L', 41519 => 'L', 41520 => 'L', 41521 => 'L', 41522 => 'L', 41523 => 'L', 41524 => 'L', 41525 => 'L', 41526 => 'L', 41527 => 'L', 41528 => 'L', 41529 => 'L', 41530 => 'L', 41531 => 'L', 41532 => 'L', 41533 => 'L', 41534 => 'L', 41535 => 'L', 41536 => 'L', 41537 => 'L', 41538 => 'L', 41539 => 'L', 41540 => 'L', 41541 => 'L', 41542 => 'L', 41543 => 'L', 41544 => 'L', 41545 => 'L', 41546 => 'L', 41547 => 'L', 41548 => 'L', 41549 => 'L', 41550 => 'L', 41551 => 'L', 41552 => 'L', 41553 => 'L', 41554 => 'L', 41555 => 'L', 41556 => 'L', 41557 => 'L', 41558 => 'L', 41559 => 'L', 41560 => 'L', 41561 => 'L', 41562 => 'L', 41563 => 'L', 41564 => 'L', 41565 => 'L', 41566 => 'L', 41567 => 'L', 41568 => 'L', 41569 => 'L', 41570 => 'L', 41571 => 'L', 41572 => 'L', 41573 => 'L', 41574 => 'L', 41575 => 'L', 41576 => 'L', 41577 => 'L', 41578 => 'L', 41579 => 'L', 41580 => 'L', 41581 => 'L', 41582 => 'L', 41583 => 'L', 41584 => 'L', 41585 => 'L', 41586 => 'L', 41587 => 'L', 41588 => 'L', 41589 => 'L', 41590 => 'L', 41591 => 'L', 41592 => 'L', 41593 => 'L', 41594 => 'L', 41595 => 'L', 41596 => 'L', 41597 => 'L', 41598 => 'L', 41599 => 'L', 41600 => 'L', 41601 => 'L', 41602 => 'L', 41603 => 'L', 41604 => 'L', 41605 => 'L', 41606 => 'L', 41607 => 'L', 41608 => 'L', 41609 => 'L', 41610 => 'L', 41611 => 'L', 41612 => 'L', 41613 => 'L', 41614 => 'L', 41615 => 'L', 41616 => 'L', 41617 => 'L', 41618 => 'L', 41619 => 'L', 41620 => 'L', 41621 => 'L', 41622 => 'L', 41623 => 'L', 41624 => 'L', 41625 => 'L', 41626 => 'L', 41627 => 'L', 41628 => 'L', 41629 => 'L', 41630 => 'L', 41631 => 'L', 41632 => 'L', 41633 => 'L', 41634 => 'L', 41635 => 'L', 41636 => 'L', 41637 => 'L', 41638 => 'L', 41639 => 'L', 41640 => 'L', 41641 => 'L', 41642 => 'L', 41643 => 'L', 41644 => 'L', 41645 => 'L', 41646 => 'L', 41647 => 'L', 41648 => 'L', 41649 => 'L', 41650 => 'L', 41651 => 'L', 41652 => 'L', 41653 => 'L', 41654 => 'L', 41655 => 'L', 41656 => 'L', 41657 => 'L', 41658 => 'L', 41659 => 'L', 41660 => 'L', 41661 => 'L', 41662 => 'L', 41663 => 'L', 41664 => 'L', 41665 => 'L', 41666 => 'L', 41667 => 'L', 41668 => 'L', 41669 => 'L', 41670 => 'L', 41671 => 'L', 41672 => 'L', 41673 => 'L', 41674 => 'L', 41675 => 'L', 41676 => 'L', 41677 => 'L', 41678 => 'L', 41679 => 'L', 41680 => 'L', 41681 => 'L', 41682 => 'L', 41683 => 'L', 41684 => 'L', 41685 => 'L', 41686 => 'L', 41687 => 'L', 41688 => 'L', 41689 => 'L', 41690 => 'L', 41691 => 'L', 41692 => 'L', 41693 => 'L', 41694 => 'L', 41695 => 'L', 41696 => 'L', 41697 => 'L', 41698 => 'L', 41699 => 'L', 41700 => 'L', 41701 => 'L', 41702 => 'L', 41703 => 'L', 41704 => 'L', 41705 => 'L', 41706 => 'L', 41707 => 'L', 41708 => 'L', 41709 => 'L', 41710 => 'L', 41711 => 'L', 41712 => 'L', 41713 => 'L', 41714 => 'L', 41715 => 'L', 41716 => 'L', 41717 => 'L', 41718 => 'L', 41719 => 'L', 41720 => 'L', 41721 => 'L', 41722 => 'L', 41723 => 'L', 41724 => 'L', 41725 => 'L', 41726 => 'L', 41727 => 'L', 41728 => 'L', 41729 => 'L', 41730 => 'L', 41731 => 'L', 41732 => 'L', 41733 => 'L', 41734 => 'L', 41735 => 'L', 41736 => 'L', 41737 => 'L', 41738 => 'L', 41739 => 'L', 41740 => 'L', 41741 => 'L', 41742 => 'L', 41743 => 'L', 41744 => 'L', 41745 => 'L', 41746 => 'L', 41747 => 'L', 41748 => 'L', 41749 => 'L', 41750 => 'L', 41751 => 'L', 41752 => 'L', 41753 => 'L', 41754 => 'L', 41755 => 'L', 41756 => 'L', 41757 => 'L', 41758 => 'L', 41759 => 'L', 41760 => 'L', 41761 => 'L', 41762 => 'L', 41763 => 'L', 41764 => 'L', 41765 => 'L', 41766 => 'L', 41767 => 'L', 41768 => 'L', 41769 => 'L', 41770 => 'L', 41771 => 'L', 41772 => 'L', 41773 => 'L', 41774 => 'L', 41775 => 'L', 41776 => 'L', 41777 => 'L', 41778 => 'L', 41779 => 'L', 41780 => 'L', 41781 => 'L', 41782 => 'L', 41783 => 'L', 41784 => 'L', 41785 => 'L', 41786 => 'L', 41787 => 'L', 41788 => 'L', 41789 => 'L', 41790 => 'L', 41791 => 'L', 41792 => 'L', 41793 => 'L', 41794 => 'L', 41795 => 'L', 41796 => 'L', 41797 => 'L', 41798 => 'L', 41799 => 'L', 41800 => 'L', 41801 => 'L', 41802 => 'L', 41803 => 'L', 41804 => 'L', 41805 => 'L', 41806 => 'L', 41807 => 'L', 41808 => 'L', 41809 => 'L', 41810 => 'L', 41811 => 'L', 41812 => 'L', 41813 => 'L', 41814 => 'L', 41815 => 'L', 41816 => 'L', 41817 => 'L', 41818 => 'L', 41819 => 'L', 41820 => 'L', 41821 => 'L', 41822 => 'L', 41823 => 'L', 41824 => 'L', 41825 => 'L', 41826 => 'L', 41827 => 'L', 41828 => 'L', 41829 => 'L', 41830 => 'L', 41831 => 'L', 41832 => 'L', 41833 => 'L', 41834 => 'L', 41835 => 'L', 41836 => 'L', 41837 => 'L', 41838 => 'L', 41839 => 'L', 41840 => 'L', 41841 => 'L', 41842 => 'L', 41843 => 'L', 41844 => 'L', 41845 => 'L', 41846 => 'L', 41847 => 'L', 41848 => 'L', 41849 => 'L', 41850 => 'L', 41851 => 'L', 41852 => 'L', 41853 => 'L', 41854 => 'L', 41855 => 'L', 41856 => 'L', 41857 => 'L', 41858 => 'L', 41859 => 'L', 41860 => 'L', 41861 => 'L', 41862 => 'L', 41863 => 'L', 41864 => 'L', 41865 => 'L', 41866 => 'L', 41867 => 'L', 41868 => 'L', 41869 => 'L', 41870 => 'L', 41871 => 'L', 41872 => 'L', 41873 => 'L', 41874 => 'L', 41875 => 'L', 41876 => 'L', 41877 => 'L', 41878 => 'L', 41879 => 'L', 41880 => 'L', 41881 => 'L', 41882 => 'L', 41883 => 'L', 41884 => 'L', 41885 => 'L', 41886 => 'L', 41887 => 'L', 41888 => 'L', 41889 => 'L', 41890 => 'L', 41891 => 'L', 41892 => 'L', 41893 => 'L', 41894 => 'L', 41895 => 'L', 41896 => 'L', 41897 => 'L', 41898 => 'L', 41899 => 'L', 41900 => 'L', 41901 => 'L', 41902 => 'L', 41903 => 'L', 41904 => 'L', 41905 => 'L', 41906 => 'L', 41907 => 'L', 41908 => 'L', 41909 => 'L', 41910 => 'L', 41911 => 'L', 41912 => 'L', 41913 => 'L', 41914 => 'L', 41915 => 'L', 41916 => 'L', 41917 => 'L', 41918 => 'L', 41919 => 'L', 41920 => 'L', 41921 => 'L', 41922 => 'L', 41923 => 'L', 41924 => 'L', 41925 => 'L', 41926 => 'L', 41927 => 'L', 41928 => 'L', 41929 => 'L', 41930 => 'L', 41931 => 'L', 41932 => 'L', 41933 => 'L', 41934 => 'L', 41935 => 'L', 41936 => 'L', 41937 => 'L', 41938 => 'L', 41939 => 'L', 41940 => 'L', 41941 => 'L', 41942 => 'L', 41943 => 'L', 41944 => 'L', 41945 => 'L', 41946 => 'L', 41947 => 'L', 41948 => 'L', 41949 => 'L', 41950 => 'L', 41951 => 'L', 41952 => 'L', 41953 => 'L', 41954 => 'L', 41955 => 'L', 41956 => 'L', 41957 => 'L', 41958 => 'L', 41959 => 'L', 41960 => 'L', 41961 => 'L', 41962 => 'L', 41963 => 'L', 41964 => 'L', 41965 => 'L', 41966 => 'L', 41967 => 'L', 41968 => 'L', 41969 => 'L', 41970 => 'L', 41971 => 'L', 41972 => 'L', 41973 => 'L', 41974 => 'L', 41975 => 'L', 41976 => 'L', 41977 => 'L', 41978 => 'L', 41979 => 'L', 41980 => 'L', 41981 => 'L', 41982 => 'L', 41983 => 'L', 41984 => 'L', 41985 => 'L', 41986 => 'L', 41987 => 'L', 41988 => 'L', 41989 => 'L', 41990 => 'L', 41991 => 'L', 41992 => 'L', 41993 => 'L', 41994 => 'L', 41995 => 'L', 41996 => 'L', 41997 => 'L', 41998 => 'L', 41999 => 'L', 42000 => 'L', 42001 => 'L', 42002 => 'L', 42003 => 'L', 42004 => 'L', 42005 => 'L', 42006 => 'L', 42007 => 'L', 42008 => 'L', 42009 => 'L', 42010 => 'L', 42011 => 'L', 42012 => 'L', 42013 => 'L', 42014 => 'L', 42015 => 'L', 42016 => 'L', 42017 => 'L', 42018 => 'L', 42019 => 'L', 42020 => 'L', 42021 => 'L', 42022 => 'L', 42023 => 'L', 42024 => 'L', 42025 => 'L', 42026 => 'L', 42027 => 'L', 42028 => 'L', 42029 => 'L', 42030 => 'L', 42031 => 'L', 42032 => 'L', 42033 => 'L', 42034 => 'L', 42035 => 'L', 42036 => 'L', 42037 => 'L', 42038 => 'L', 42039 => 'L', 42040 => 'L', 42041 => 'L', 42042 => 'L', 42043 => 'L', 42044 => 'L', 42045 => 'L', 42046 => 'L', 42047 => 'L', 42048 => 'L', 42049 => 'L', 42050 => 'L', 42051 => 'L', 42052 => 'L', 42053 => 'L', 42054 => 'L', 42055 => 'L', 42056 => 'L', 42057 => 'L', 42058 => 'L', 42059 => 'L', 42060 => 'L', 42061 => 'L', 42062 => 'L', 42063 => 'L', 42064 => 'L', 42065 => 'L', 42066 => 'L', 42067 => 'L', 42068 => 'L', 42069 => 'L', 42070 => 'L', 42071 => 'L', 42072 => 'L', 42073 => 'L', 42074 => 'L', 42075 => 'L', 42076 => 'L', 42077 => 'L', 42078 => 'L', 42079 => 'L', 42080 => 'L', 42081 => 'L', 42082 => 'L', 42083 => 'L', 42084 => 'L', 42085 => 'L', 42086 => 'L', 42087 => 'L', 42088 => 'L', 42089 => 'L', 42090 => 'L', 42091 => 'L', 42092 => 'L', 42093 => 'L', 42094 => 'L', 42095 => 'L', 42096 => 'L', 42097 => 'L', 42098 => 'L', 42099 => 'L', 42100 => 'L', 42101 => 'L', 42102 => 'L', 42103 => 'L', 42104 => 'L', 42105 => 'L', 42106 => 'L', 42107 => 'L', 42108 => 'L', 42109 => 'L', 42110 => 'L', 42111 => 'L', 42112 => 'L', 42113 => 'L', 42114 => 'L', 42115 => 'L', 42116 => 'L', 42117 => 'L', 42118 => 'L', 42119 => 'L', 42120 => 'L', 42121 => 'L', 42122 => 'L', 42123 => 'L', 42124 => 'L', 42128 => 'ON', 42129 => 'ON', 42130 => 'ON', 42131 => 'ON', 42132 => 'ON', 42133 => 'ON', 42134 => 'ON', 42135 => 'ON', 42136 => 'ON', 42137 => 'ON', 42138 => 'ON', 42139 => 'ON', 42140 => 'ON', 42141 => 'ON', 42142 => 'ON', 42143 => 'ON', 42144 => 'ON', 42145 => 'ON', 42146 => 'ON', 42147 => 'ON', 42148 => 'ON', 42149 => 'ON', 42150 => 'ON', 42151 => 'ON', 42152 => 'ON', 42153 => 'ON', 42154 => 'ON', 42155 => 'ON', 42156 => 'ON', 42157 => 'ON', 42158 => 'ON', 42159 => 'ON', 42160 => 'ON', 42161 => 'ON', 42162 => 'ON', 42163 => 'ON', 42164 => 'ON', 42165 => 'ON', 42166 => 'ON', 42167 => 'ON', 42168 => 'ON', 42169 => 'ON', 42170 => 'ON', 42171 => 'ON', 42172 => 'ON', 42173 => 'ON', 42174 => 'ON', 42175 => 'ON', 42176 => 'ON', 42177 => 'ON', 42178 => 'ON', 42179 => 'ON', 42180 => 'ON', 42181 => 'ON', 42182 => 'ON', 42752 => 'ON', 42753 => 'ON', 42754 => 'ON', 42755 => 'ON', 42756 => 'ON', 42757 => 'ON', 42758 => 'ON', 42759 => 'ON', 42760 => 'ON', 42761 => 'ON', 42762 => 'ON', 42763 => 'ON', 42764 => 'ON', 42765 => 'ON', 42766 => 'ON', 42767 => 'ON', 42768 => 'ON', 42769 => 'ON', 42770 => 'ON', 42771 => 'ON', 42772 => 'ON', 42773 => 'ON', 42774 => 'ON', 42775 => 'ON', 42776 => 'ON', 42777 => 'ON', 42778 => 'ON', 42784 => 'ON', 42785 => 'ON', 43008 => 'L', 43009 => 'L', 43010 => 'NSM', 43011 => 'L', 43012 => 'L', 43013 => 'L', 43014 => 'NSM', 43015 => 'L', 43016 => 'L', 43017 => 'L', 43018 => 'L', 43019 => 'NSM', 43020 => 'L', 43021 => 'L', 43022 => 'L', 43023 => 'L', 43024 => 'L', 43025 => 'L', 43026 => 'L', 43027 => 'L', 43028 => 'L', 43029 => 'L', 43030 => 'L', 43031 => 'L', 43032 => 'L', 43033 => 'L', 43034 => 'L', 43035 => 'L', 43036 => 'L', 43037 => 'L', 43038 => 'L', 43039 => 'L', 43040 => 'L', 43041 => 'L', 43042 => 'L', 43043 => 'L', 43044 => 'L', 43045 => 'NSM', 43046 => 'NSM', 43047 => 'L', 43048 => 'ON', 43049 => 'ON', 43050 => 'ON', 43051 => 'ON', 43072 => 'L', 43073 => 'L', 43074 => 'L', 43075 => 'L', 43076 => 'L', 43077 => 'L', 43078 => 'L', 43079 => 'L', 43080 => 'L', 43081 => 'L', 43082 => 'L', 43083 => 'L', 43084 => 'L', 43085 => 'L', 43086 => 'L', 43087 => 'L', 43088 => 'L', 43089 => 'L', 43090 => 'L', 43091 => 'L', 43092 => 'L', 43093 => 'L', 43094 => 'L', 43095 => 'L', 43096 => 'L', 43097 => 'L', 43098 => 'L', 43099 => 'L', 43100 => 'L', 43101 => 'L', 43102 => 'L', 43103 => 'L', 43104 => 'L', 43105 => 'L', 43106 => 'L', 43107 => 'L', 43108 => 'L', 43109 => 'L', 43110 => 'L', 43111 => 'L', 43112 => 'L', 43113 => 'L', 43114 => 'L', 43115 => 'L', 43116 => 'L', 43117 => 'L', 43118 => 'L', 43119 => 'L', 43120 => 'L', 43121 => 'L', 43122 => 'L', 43123 => 'L', 43124 => 'ON', 43125 => 'ON', 43126 => 'ON', 43127 => 'ON', 44032 => 'L', 55203 => 'L', 55296 => 'L', 56191 => 'L', 56192 => 'L', 56319 => 'L', 56320 => 'L', 57343 => 'L', 57344 => 'L', 63743 => 'L', 63744 => 'L', 63745 => 'L', 63746 => 'L', 63747 => 'L', 63748 => 'L', 63749 => 'L', 63750 => 'L', 63751 => 'L', 63752 => 'L', 63753 => 'L', 63754 => 'L', 63755 => 'L', 63756 => 'L', 63757 => 'L', 63758 => 'L', 63759 => 'L', 63760 => 'L', 63761 => 'L', 63762 => 'L', 63763 => 'L', 63764 => 'L', 63765 => 'L', 63766 => 'L', 63767 => 'L', 63768 => 'L', 63769 => 'L', 63770 => 'L', 63771 => 'L', 63772 => 'L', 63773 => 'L', 63774 => 'L', 63775 => 'L', 63776 => 'L', 63777 => 'L', 63778 => 'L', 63779 => 'L', 63780 => 'L', 63781 => 'L', 63782 => 'L', 63783 => 'L', 63784 => 'L', 63785 => 'L', 63786 => 'L', 63787 => 'L', 63788 => 'L', 63789 => 'L', 63790 => 'L', 63791 => 'L', 63792 => 'L', 63793 => 'L', 63794 => 'L', 63795 => 'L', 63796 => 'L', 63797 => 'L', 63798 => 'L', 63799 => 'L', 63800 => 'L', 63801 => 'L', 63802 => 'L', 63803 => 'L', 63804 => 'L', 63805 => 'L', 63806 => 'L', 63807 => 'L', 63808 => 'L', 63809 => 'L', 63810 => 'L', 63811 => 'L', 63812 => 'L', 63813 => 'L', 63814 => 'L', 63815 => 'L', 63816 => 'L', 63817 => 'L', 63818 => 'L', 63819 => 'L', 63820 => 'L', 63821 => 'L', 63822 => 'L', 63823 => 'L', 63824 => 'L', 63825 => 'L', 63826 => 'L', 63827 => 'L', 63828 => 'L', 63829 => 'L', 63830 => 'L', 63831 => 'L', 63832 => 'L', 63833 => 'L', 63834 => 'L', 63835 => 'L', 63836 => 'L', 63837 => 'L', 63838 => 'L', 63839 => 'L', 63840 => 'L', 63841 => 'L', 63842 => 'L', 63843 => 'L', 63844 => 'L', 63845 => 'L', 63846 => 'L', 63847 => 'L', 63848 => 'L', 63849 => 'L', 63850 => 'L', 63851 => 'L', 63852 => 'L', 63853 => 'L', 63854 => 'L', 63855 => 'L', 63856 => 'L', 63857 => 'L', 63858 => 'L', 63859 => 'L', 63860 => 'L', 63861 => 'L', 63862 => 'L', 63863 => 'L', 63864 => 'L', 63865 => 'L', 63866 => 'L', 63867 => 'L', 63868 => 'L', 63869 => 'L', 63870 => 'L', 63871 => 'L', 63872 => 'L', 63873 => 'L', 63874 => 'L', 63875 => 'L', 63876 => 'L', 63877 => 'L', 63878 => 'L', 63879 => 'L', 63880 => 'L', 63881 => 'L', 63882 => 'L', 63883 => 'L', 63884 => 'L', 63885 => 'L', 63886 => 'L', 63887 => 'L', 63888 => 'L', 63889 => 'L', 63890 => 'L', 63891 => 'L', 63892 => 'L', 63893 => 'L', 63894 => 'L', 63895 => 'L', 63896 => 'L', 63897 => 'L', 63898 => 'L', 63899 => 'L', 63900 => 'L', 63901 => 'L', 63902 => 'L', 63903 => 'L', 63904 => 'L', 63905 => 'L', 63906 => 'L', 63907 => 'L', 63908 => 'L', 63909 => 'L', 63910 => 'L', 63911 => 'L', 63912 => 'L', 63913 => 'L', 63914 => 'L', 63915 => 'L', 63916 => 'L', 63917 => 'L', 63918 => 'L', 63919 => 'L', 63920 => 'L', 63921 => 'L', 63922 => 'L', 63923 => 'L', 63924 => 'L', 63925 => 'L', 63926 => 'L', 63927 => 'L', 63928 => 'L', 63929 => 'L', 63930 => 'L', 63931 => 'L', 63932 => 'L', 63933 => 'L', 63934 => 'L', 63935 => 'L', 63936 => 'L', 63937 => 'L', 63938 => 'L', 63939 => 'L', 63940 => 'L', 63941 => 'L', 63942 => 'L', 63943 => 'L', 63944 => 'L', 63945 => 'L', 63946 => 'L', 63947 => 'L', 63948 => 'L', 63949 => 'L', 63950 => 'L', 63951 => 'L', 63952 => 'L', 63953 => 'L', 63954 => 'L', 63955 => 'L', 63956 => 'L', 63957 => 'L', 63958 => 'L', 63959 => 'L', 63960 => 'L', 63961 => 'L', 63962 => 'L', 63963 => 'L', 63964 => 'L', 63965 => 'L', 63966 => 'L', 63967 => 'L', 63968 => 'L', 63969 => 'L', 63970 => 'L', 63971 => 'L', 63972 => 'L', 63973 => 'L', 63974 => 'L', 63975 => 'L', 63976 => 'L', 63977 => 'L', 63978 => 'L', 63979 => 'L', 63980 => 'L', 63981 => 'L', 63982 => 'L', 63983 => 'L', 63984 => 'L', 63985 => 'L', 63986 => 'L', 63987 => 'L', 63988 => 'L', 63989 => 'L', 63990 => 'L', 63991 => 'L', 63992 => 'L', 63993 => 'L', 63994 => 'L', 63995 => 'L', 63996 => 'L', 63997 => 'L', 63998 => 'L', 63999 => 'L', 64000 => 'L', 64001 => 'L', 64002 => 'L', 64003 => 'L', 64004 => 'L', 64005 => 'L', 64006 => 'L', 64007 => 'L', 64008 => 'L', 64009 => 'L', 64010 => 'L', 64011 => 'L', 64012 => 'L', 64013 => 'L', 64014 => 'L', 64015 => 'L', 64016 => 'L', 64017 => 'L', 64018 => 'L', 64019 => 'L', 64020 => 'L', 64021 => 'L', 64022 => 'L', 64023 => 'L', 64024 => 'L', 64025 => 'L', 64026 => 'L', 64027 => 'L', 64028 => 'L', 64029 => 'L', 64030 => 'L', 64031 => 'L', 64032 => 'L', 64033 => 'L', 64034 => 'L', 64035 => 'L', 64036 => 'L', 64037 => 'L', 64038 => 'L', 64039 => 'L', 64040 => 'L', 64041 => 'L', 64042 => 'L', 64043 => 'L', 64044 => 'L', 64045 => 'L', 64048 => 'L', 64049 => 'L', 64050 => 'L', 64051 => 'L', 64052 => 'L', 64053 => 'L', 64054 => 'L', 64055 => 'L', 64056 => 'L', 64057 => 'L', 64058 => 'L', 64059 => 'L', 64060 => 'L', 64061 => 'L', 64062 => 'L', 64063 => 'L', 64064 => 'L', 64065 => 'L', 64066 => 'L', 64067 => 'L', 64068 => 'L', 64069 => 'L', 64070 => 'L', 64071 => 'L', 64072 => 'L', 64073 => 'L', 64074 => 'L', 64075 => 'L', 64076 => 'L', 64077 => 'L', 64078 => 'L', 64079 => 'L', 64080 => 'L', 64081 => 'L', 64082 => 'L', 64083 => 'L', 64084 => 'L', 64085 => 'L', 64086 => 'L', 64087 => 'L', 64088 => 'L', 64089 => 'L', 64090 => 'L', 64091 => 'L', 64092 => 'L', 64093 => 'L', 64094 => 'L', 64095 => 'L', 64096 => 'L', 64097 => 'L', 64098 => 'L', 64099 => 'L', 64100 => 'L', 64101 => 'L', 64102 => 'L', 64103 => 'L', 64104 => 'L', 64105 => 'L', 64106 => 'L', 64112 => 'L', 64113 => 'L', 64114 => 'L', 64115 => 'L', 64116 => 'L', 64117 => 'L', 64118 => 'L', 64119 => 'L', 64120 => 'L', 64121 => 'L', 64122 => 'L', 64123 => 'L', 64124 => 'L', 64125 => 'L', 64126 => 'L', 64127 => 'L', 64128 => 'L', 64129 => 'L', 64130 => 'L', 64131 => 'L', 64132 => 'L', 64133 => 'L', 64134 => 'L', 64135 => 'L', 64136 => 'L', 64137 => 'L', 64138 => 'L', 64139 => 'L', 64140 => 'L', 64141 => 'L', 64142 => 'L', 64143 => 'L', 64144 => 'L', 64145 => 'L', 64146 => 'L', 64147 => 'L', 64148 => 'L', 64149 => 'L', 64150 => 'L', 64151 => 'L', 64152 => 'L', 64153 => 'L', 64154 => 'L', 64155 => 'L', 64156 => 'L', 64157 => 'L', 64158 => 'L', 64159 => 'L', 64160 => 'L', 64161 => 'L', 64162 => 'L', 64163 => 'L', 64164 => 'L', 64165 => 'L', 64166 => 'L', 64167 => 'L', 64168 => 'L', 64169 => 'L', 64170 => 'L', 64171 => 'L', 64172 => 'L', 64173 => 'L', 64174 => 'L', 64175 => 'L', 64176 => 'L', 64177 => 'L', 64178 => 'L', 64179 => 'L', 64180 => 'L', 64181 => 'L', 64182 => 'L', 64183 => 'L', 64184 => 'L', 64185 => 'L', 64186 => 'L', 64187 => 'L', 64188 => 'L', 64189 => 'L', 64190 => 'L', 64191 => 'L', 64192 => 'L', 64193 => 'L', 64194 => 'L', 64195 => 'L', 64196 => 'L', 64197 => 'L', 64198 => 'L', 64199 => 'L', 64200 => 'L', 64201 => 'L', 64202 => 'L', 64203 => 'L', 64204 => 'L', 64205 => 'L', 64206 => 'L', 64207 => 'L', 64208 => 'L', 64209 => 'L', 64210 => 'L', 64211 => 'L', 64212 => 'L', 64213 => 'L', 64214 => 'L', 64215 => 'L', 64216 => 'L', 64217 => 'L', 64256 => 'L', 64257 => 'L', 64258 => 'L', 64259 => 'L', 64260 => 'L', 64261 => 'L', 64262 => 'L', 64275 => 'L', 64276 => 'L', 64277 => 'L', 64278 => 'L', 64279 => 'L', 64285 => 'R', 64286 => 'NSM', 64287 => 'R', 64288 => 'R', 64289 => 'R', 64290 => 'R', 64291 => 'R', 64292 => 'R', 64293 => 'R', 64294 => 'R', 64295 => 'R', 64296 => 'R', 64297 => 'ES', 64298 => 'R', 64299 => 'R', 64300 => 'R', 64301 => 'R', 64302 => 'R', 64303 => 'R', 64304 => 'R', 64305 => 'R', 64306 => 'R', 64307 => 'R', 64308 => 'R', 64309 => 'R', 64310 => 'R', 64312 => 'R', 64313 => 'R', 64314 => 'R', 64315 => 'R', 64316 => 'R', 64318 => 'R', 64320 => 'R', 64321 => 'R', 64323 => 'R', 64324 => 'R', 64326 => 'R', 64327 => 'R', 64328 => 'R', 64329 => 'R', 64330 => 'R', 64331 => 'R', 64332 => 'R', 64333 => 'R', 64334 => 'R', 64335 => 'R', 64336 => 'AL', 64337 => 'AL', 64338 => 'AL', 64339 => 'AL', 64340 => 'AL', 64341 => 'AL', 64342 => 'AL', 64343 => 'AL', 64344 => 'AL', 64345 => 'AL', 64346 => 'AL', 64347 => 'AL', 64348 => 'AL', 64349 => 'AL', 64350 => 'AL', 64351 => 'AL', 64352 => 'AL', 64353 => 'AL', 64354 => 'AL', 64355 => 'AL', 64356 => 'AL', 64357 => 'AL', 64358 => 'AL', 64359 => 'AL', 64360 => 'AL', 64361 => 'AL', 64362 => 'AL', 64363 => 'AL', 64364 => 'AL', 64365 => 'AL', 64366 => 'AL', 64367 => 'AL', 64368 => 'AL', 64369 => 'AL', 64370 => 'AL', 64371 => 'AL', 64372 => 'AL', 64373 => 'AL', 64374 => 'AL', 64375 => 'AL', 64376 => 'AL', 64377 => 'AL', 64378 => 'AL', 64379 => 'AL', 64380 => 'AL', 64381 => 'AL', 64382 => 'AL', 64383 => 'AL', 64384 => 'AL', 64385 => 'AL', 64386 => 'AL', 64387 => 'AL', 64388 => 'AL', 64389 => 'AL', 64390 => 'AL', 64391 => 'AL', 64392 => 'AL', 64393 => 'AL', 64394 => 'AL', 64395 => 'AL', 64396 => 'AL', 64397 => 'AL', 64398 => 'AL', 64399 => 'AL', 64400 => 'AL', 64401 => 'AL', 64402 => 'AL', 64403 => 'AL', 64404 => 'AL', 64405 => 'AL', 64406 => 'AL', 64407 => 'AL', 64408 => 'AL', 64409 => 'AL', 64410 => 'AL', 64411 => 'AL', 64412 => 'AL', 64413 => 'AL', 64414 => 'AL', 64415 => 'AL', 64416 => 'AL', 64417 => 'AL', 64418 => 'AL', 64419 => 'AL', 64420 => 'AL', 64421 => 'AL', 64422 => 'AL', 64423 => 'AL', 64424 => 'AL', 64425 => 'AL', 64426 => 'AL', 64427 => 'AL', 64428 => 'AL', 64429 => 'AL', 64430 => 'AL', 64431 => 'AL', 64432 => 'AL', 64433 => 'AL', 64467 => 'AL', 64468 => 'AL', 64469 => 'AL', 64470 => 'AL', 64471 => 'AL', 64472 => 'AL', 64473 => 'AL', 64474 => 'AL', 64475 => 'AL', 64476 => 'AL', 64477 => 'AL', 64478 => 'AL', 64479 => 'AL', 64480 => 'AL', 64481 => 'AL', 64482 => 'AL', 64483 => 'AL', 64484 => 'AL', 64485 => 'AL', 64486 => 'AL', 64487 => 'AL', 64488 => 'AL', 64489 => 'AL', 64490 => 'AL', 64491 => 'AL', 64492 => 'AL', 64493 => 'AL', 64494 => 'AL', 64495 => 'AL', 64496 => 'AL', 64497 => 'AL', 64498 => 'AL', 64499 => 'AL', 64500 => 'AL', 64501 => 'AL', 64502 => 'AL', 64503 => 'AL', 64504 => 'AL', 64505 => 'AL', 64506 => 'AL', 64507 => 'AL', 64508 => 'AL', 64509 => 'AL', 64510 => 'AL', 64511 => 'AL', 64512 => 'AL', 64513 => 'AL', 64514 => 'AL', 64515 => 'AL', 64516 => 'AL', 64517 => 'AL', 64518 => 'AL', 64519 => 'AL', 64520 => 'AL', 64521 => 'AL', 64522 => 'AL', 64523 => 'AL', 64524 => 'AL', 64525 => 'AL', 64526 => 'AL', 64527 => 'AL', 64528 => 'AL', 64529 => 'AL', 64530 => 'AL', 64531 => 'AL', 64532 => 'AL', 64533 => 'AL', 64534 => 'AL', 64535 => 'AL', 64536 => 'AL', 64537 => 'AL', 64538 => 'AL', 64539 => 'AL', 64540 => 'AL', 64541 => 'AL', 64542 => 'AL', 64543 => 'AL', 64544 => 'AL', 64545 => 'AL', 64546 => 'AL', 64547 => 'AL', 64548 => 'AL', 64549 => 'AL', 64550 => 'AL', 64551 => 'AL', 64552 => 'AL', 64553 => 'AL', 64554 => 'AL', 64555 => 'AL', 64556 => 'AL', 64557 => 'AL', 64558 => 'AL', 64559 => 'AL', 64560 => 'AL', 64561 => 'AL', 64562 => 'AL', 64563 => 'AL', 64564 => 'AL', 64565 => 'AL', 64566 => 'AL', 64567 => 'AL', 64568 => 'AL', 64569 => 'AL', 64570 => 'AL', 64571 => 'AL', 64572 => 'AL', 64573 => 'AL', 64574 => 'AL', 64575 => 'AL', 64576 => 'AL', 64577 => 'AL', 64578 => 'AL', 64579 => 'AL', 64580 => 'AL', 64581 => 'AL', 64582 => 'AL', 64583 => 'AL', 64584 => 'AL', 64585 => 'AL', 64586 => 'AL', 64587 => 'AL', 64588 => 'AL', 64589 => 'AL', 64590 => 'AL', 64591 => 'AL', 64592 => 'AL', 64593 => 'AL', 64594 => 'AL', 64595 => 'AL', 64596 => 'AL', 64597 => 'AL', 64598 => 'AL', 64599 => 'AL', 64600 => 'AL', 64601 => 'AL', 64602 => 'AL', 64603 => 'AL', 64604 => 'AL', 64605 => 'AL', 64606 => 'AL', 64607 => 'AL', 64608 => 'AL', 64609 => 'AL', 64610 => 'AL', 64611 => 'AL', 64612 => 'AL', 64613 => 'AL', 64614 => 'AL', 64615 => 'AL', 64616 => 'AL', 64617 => 'AL', 64618 => 'AL', 64619 => 'AL', 64620 => 'AL', 64621 => 'AL', 64622 => 'AL', 64623 => 'AL', 64624 => 'AL', 64625 => 'AL', 64626 => 'AL', 64627 => 'AL', 64628 => 'AL', 64629 => 'AL', 64630 => 'AL', 64631 => 'AL', 64632 => 'AL', 64633 => 'AL', 64634 => 'AL', 64635 => 'AL', 64636 => 'AL', 64637 => 'AL', 64638 => 'AL', 64639 => 'AL', 64640 => 'AL', 64641 => 'AL', 64642 => 'AL', 64643 => 'AL', 64644 => 'AL', 64645 => 'AL', 64646 => 'AL', 64647 => 'AL', 64648 => 'AL', 64649 => 'AL', 64650 => 'AL', 64651 => 'AL', 64652 => 'AL', 64653 => 'AL', 64654 => 'AL', 64655 => 'AL', 64656 => 'AL', 64657 => 'AL', 64658 => 'AL', 64659 => 'AL', 64660 => 'AL', 64661 => 'AL', 64662 => 'AL', 64663 => 'AL', 64664 => 'AL', 64665 => 'AL', 64666 => 'AL', 64667 => 'AL', 64668 => 'AL', 64669 => 'AL', 64670 => 'AL', 64671 => 'AL', 64672 => 'AL', 64673 => 'AL', 64674 => 'AL', 64675 => 'AL', 64676 => 'AL', 64677 => 'AL', 64678 => 'AL', 64679 => 'AL', 64680 => 'AL', 64681 => 'AL', 64682 => 'AL', 64683 => 'AL', 64684 => 'AL', 64685 => 'AL', 64686 => 'AL', 64687 => 'AL', 64688 => 'AL', 64689 => 'AL', 64690 => 'AL', 64691 => 'AL', 64692 => 'AL', 64693 => 'AL', 64694 => 'AL', 64695 => 'AL', 64696 => 'AL', 64697 => 'AL', 64698 => 'AL', 64699 => 'AL', 64700 => 'AL', 64701 => 'AL', 64702 => 'AL', 64703 => 'AL', 64704 => 'AL', 64705 => 'AL', 64706 => 'AL', 64707 => 'AL', 64708 => 'AL', 64709 => 'AL', 64710 => 'AL', 64711 => 'AL', 64712 => 'AL', 64713 => 'AL', 64714 => 'AL', 64715 => 'AL', 64716 => 'AL', 64717 => 'AL', 64718 => 'AL', 64719 => 'AL', 64720 => 'AL', 64721 => 'AL', 64722 => 'AL', 64723 => 'AL', 64724 => 'AL', 64725 => 'AL', 64726 => 'AL', 64727 => 'AL', 64728 => 'AL', 64729 => 'AL', 64730 => 'AL', 64731 => 'AL', 64732 => 'AL', 64733 => 'AL', 64734 => 'AL', 64735 => 'AL', 64736 => 'AL', 64737 => 'AL', 64738 => 'AL', 64739 => 'AL', 64740 => 'AL', 64741 => 'AL', 64742 => 'AL', 64743 => 'AL', 64744 => 'AL', 64745 => 'AL', 64746 => 'AL', 64747 => 'AL', 64748 => 'AL', 64749 => 'AL', 64750 => 'AL', 64751 => 'AL', 64752 => 'AL', 64753 => 'AL', 64754 => 'AL', 64755 => 'AL', 64756 => 'AL', 64757 => 'AL', 64758 => 'AL', 64759 => 'AL', 64760 => 'AL', 64761 => 'AL', 64762 => 'AL', 64763 => 'AL', 64764 => 'AL', 64765 => 'AL', 64766 => 'AL', 64767 => 'AL', 64768 => 'AL', 64769 => 'AL', 64770 => 'AL', 64771 => 'AL', 64772 => 'AL', 64773 => 'AL', 64774 => 'AL', 64775 => 'AL', 64776 => 'AL', 64777 => 'AL', 64778 => 'AL', 64779 => 'AL', 64780 => 'AL', 64781 => 'AL', 64782 => 'AL', 64783 => 'AL', 64784 => 'AL', 64785 => 'AL', 64786 => 'AL', 64787 => 'AL', 64788 => 'AL', 64789 => 'AL', 64790 => 'AL', 64791 => 'AL', 64792 => 'AL', 64793 => 'AL', 64794 => 'AL', 64795 => 'AL', 64796 => 'AL', 64797 => 'AL', 64798 => 'AL', 64799 => 'AL', 64800 => 'AL', 64801 => 'AL', 64802 => 'AL', 64803 => 'AL', 64804 => 'AL', 64805 => 'AL', 64806 => 'AL', 64807 => 'AL', 64808 => 'AL', 64809 => 'AL', 64810 => 'AL', 64811 => 'AL', 64812 => 'AL', 64813 => 'AL', 64814 => 'AL', 64815 => 'AL', 64816 => 'AL', 64817 => 'AL', 64818 => 'AL', 64819 => 'AL', 64820 => 'AL', 64821 => 'AL', 64822 => 'AL', 64823 => 'AL', 64824 => 'AL', 64825 => 'AL', 64826 => 'AL', 64827 => 'AL', 64828 => 'AL', 64829 => 'AL', 64830 => 'ON', 64831 => 'ON', 64848 => 'AL', 64849 => 'AL', 64850 => 'AL', 64851 => 'AL', 64852 => 'AL', 64853 => 'AL', 64854 => 'AL', 64855 => 'AL', 64856 => 'AL', 64857 => 'AL', 64858 => 'AL', 64859 => 'AL', 64860 => 'AL', 64861 => 'AL', 64862 => 'AL', 64863 => 'AL', 64864 => 'AL', 64865 => 'AL', 64866 => 'AL', 64867 => 'AL', 64868 => 'AL', 64869 => 'AL', 64870 => 'AL', 64871 => 'AL', 64872 => 'AL', 64873 => 'AL', 64874 => 'AL', 64875 => 'AL', 64876 => 'AL', 64877 => 'AL', 64878 => 'AL', 64879 => 'AL', 64880 => 'AL', 64881 => 'AL', 64882 => 'AL', 64883 => 'AL', 64884 => 'AL', 64885 => 'AL', 64886 => 'AL', 64887 => 'AL', 64888 => 'AL', 64889 => 'AL', 64890 => 'AL', 64891 => 'AL', 64892 => 'AL', 64893 => 'AL', 64894 => 'AL', 64895 => 'AL', 64896 => 'AL', 64897 => 'AL', 64898 => 'AL', 64899 => 'AL', 64900 => 'AL', 64901 => 'AL', 64902 => 'AL', 64903 => 'AL', 64904 => 'AL', 64905 => 'AL', 64906 => 'AL', 64907 => 'AL', 64908 => 'AL', 64909 => 'AL', 64910 => 'AL', 64911 => 'AL', 64914 => 'AL', 64915 => 'AL', 64916 => 'AL', 64917 => 'AL', 64918 => 'AL', 64919 => 'AL', 64920 => 'AL', 64921 => 'AL', 64922 => 'AL', 64923 => 'AL', 64924 => 'AL', 64925 => 'AL', 64926 => 'AL', 64927 => 'AL', 64928 => 'AL', 64929 => 'AL', 64930 => 'AL', 64931 => 'AL', 64932 => 'AL', 64933 => 'AL', 64934 => 'AL', 64935 => 'AL', 64936 => 'AL', 64937 => 'AL', 64938 => 'AL', 64939 => 'AL', 64940 => 'AL', 64941 => 'AL', 64942 => 'AL', 64943 => 'AL', 64944 => 'AL', 64945 => 'AL', 64946 => 'AL', 64947 => 'AL', 64948 => 'AL', 64949 => 'AL', 64950 => 'AL', 64951 => 'AL', 64952 => 'AL', 64953 => 'AL', 64954 => 'AL', 64955 => 'AL', 64956 => 'AL', 64957 => 'AL', 64958 => 'AL', 64959 => 'AL', 64960 => 'AL', 64961 => 'AL', 64962 => 'AL', 64963 => 'AL', 64964 => 'AL', 64965 => 'AL', 64966 => 'AL', 64967 => 'AL', 65008 => 'AL', 65009 => 'AL', 65010 => 'AL', 65011 => 'AL', 65012 => 'AL', 65013 => 'AL', 65014 => 'AL', 65015 => 'AL', 65016 => 'AL', 65017 => 'AL', 65018 => 'AL', 65019 => 'AL', 65020 => 'AL', 65021 => 'ON', 65024 => 'NSM', 65025 => 'NSM', 65026 => 'NSM', 65027 => 'NSM', 65028 => 'NSM', 65029 => 'NSM', 65030 => 'NSM', 65031 => 'NSM', 65032 => 'NSM', 65033 => 'NSM', 65034 => 'NSM', 65035 => 'NSM', 65036 => 'NSM', 65037 => 'NSM', 65038 => 'NSM', 65039 => 'NSM', 65040 => 'ON', 65041 => 'ON', 65042 => 'ON', 65043 => 'ON', 65044 => 'ON', 65045 => 'ON', 65046 => 'ON', 65047 => 'ON', 65048 => 'ON', 65049 => 'ON', 65056 => 'NSM', 65057 => 'NSM', 65058 => 'NSM', 65059 => 'NSM', 65072 => 'ON', 65073 => 'ON', 65074 => 'ON', 65075 => 'ON', 65076 => 'ON', 65077 => 'ON', 65078 => 'ON', 65079 => 'ON', 65080 => 'ON', 65081 => 'ON', 65082 => 'ON', 65083 => 'ON', 65084 => 'ON', 65085 => 'ON', 65086 => 'ON', 65087 => 'ON', 65088 => 'ON', 65089 => 'ON', 65090 => 'ON', 65091 => 'ON', 65092 => 'ON', 65093 => 'ON', 65094 => 'ON', 65095 => 'ON', 65096 => 'ON', 65097 => 'ON', 65098 => 'ON', 65099 => 'ON', 65100 => 'ON', 65101 => 'ON', 65102 => 'ON', 65103 => 'ON', 65104 => 'CS', 65105 => 'ON', 65106 => 'CS', 65108 => 'ON', 65109 => 'CS', 65110 => 'ON', 65111 => 'ON', 65112 => 'ON', 65113 => 'ON', 65114 => 'ON', 65115 => 'ON', 65116 => 'ON', 65117 => 'ON', 65118 => 'ON', 65119 => 'ET', 65120 => 'ON', 65121 => 'ON', 65122 => 'ES', 65123 => 'ES', 65124 => 'ON', 65125 => 'ON', 65126 => 'ON', 65128 => 'ON', 65129 => 'ET', 65130 => 'ET', 65131 => 'ON', 65136 => 'AL', 65137 => 'AL', 65138 => 'AL', 65139 => 'AL', 65140 => 'AL', 65142 => 'AL', 65143 => 'AL', 65144 => 'AL', 65145 => 'AL', 65146 => 'AL', 65147 => 'AL', 65148 => 'AL', 65149 => 'AL', 65150 => 'AL', 65151 => 'AL', 65152 => 'AL', 65153 => 'AL', 65154 => 'AL', 65155 => 'AL', 65156 => 'AL', 65157 => 'AL', 65158 => 'AL', 65159 => 'AL', 65160 => 'AL', 65161 => 'AL', 65162 => 'AL', 65163 => 'AL', 65164 => 'AL', 65165 => 'AL', 65166 => 'AL', 65167 => 'AL', 65168 => 'AL', 65169 => 'AL', 65170 => 'AL', 65171 => 'AL', 65172 => 'AL', 65173 => 'AL', 65174 => 'AL', 65175 => 'AL', 65176 => 'AL', 65177 => 'AL', 65178 => 'AL', 65179 => 'AL', 65180 => 'AL', 65181 => 'AL', 65182 => 'AL', 65183 => 'AL', 65184 => 'AL', 65185 => 'AL', 65186 => 'AL', 65187 => 'AL', 65188 => 'AL', 65189 => 'AL', 65190 => 'AL', 65191 => 'AL', 65192 => 'AL', 65193 => 'AL', 65194 => 'AL', 65195 => 'AL', 65196 => 'AL', 65197 => 'AL', 65198 => 'AL', 65199 => 'AL', 65200 => 'AL', 65201 => 'AL', 65202 => 'AL', 65203 => 'AL', 65204 => 'AL', 65205 => 'AL', 65206 => 'AL', 65207 => 'AL', 65208 => 'AL', 65209 => 'AL', 65210 => 'AL', 65211 => 'AL', 65212 => 'AL', 65213 => 'AL', 65214 => 'AL', 65215 => 'AL', 65216 => 'AL', 65217 => 'AL', 65218 => 'AL', 65219 => 'AL', 65220 => 'AL', 65221 => 'AL', 65222 => 'AL', 65223 => 'AL', 65224 => 'AL', 65225 => 'AL', 65226 => 'AL', 65227 => 'AL', 65228 => 'AL', 65229 => 'AL', 65230 => 'AL', 65231 => 'AL', 65232 => 'AL', 65233 => 'AL', 65234 => 'AL', 65235 => 'AL', 65236 => 'AL', 65237 => 'AL', 65238 => 'AL', 65239 => 'AL', 65240 => 'AL', 65241 => 'AL', 65242 => 'AL', 65243 => 'AL', 65244 => 'AL', 65245 => 'AL', 65246 => 'AL', 65247 => 'AL', 65248 => 'AL', 65249 => 'AL', 65250 => 'AL', 65251 => 'AL', 65252 => 'AL', 65253 => 'AL', 65254 => 'AL', 65255 => 'AL', 65256 => 'AL', 65257 => 'AL', 65258 => 'AL', 65259 => 'AL', 65260 => 'AL', 65261 => 'AL', 65262 => 'AL', 65263 => 'AL', 65264 => 'AL', 65265 => 'AL', 65266 => 'AL', 65267 => 'AL', 65268 => 'AL', 65269 => 'AL', 65270 => 'AL', 65271 => 'AL', 65272 => 'AL', 65273 => 'AL', 65274 => 'AL', 65275 => 'AL', 65276 => 'AL', 65279 => 'BN', 65281 => 'ON', 65282 => 'ON', 65283 => 'ET', 65284 => 'ET', 65285 => 'ET', 65286 => 'ON', 65287 => 'ON', 65288 => 'ON', 65289 => 'ON', 65290 => 'ON', 65291 => 'ES', 65292 => 'CS', 65293 => 'ES', 65294 => 'CS', 65295 => 'CS', 65296 => 'EN', 65297 => 'EN', 65298 => 'EN', 65299 => 'EN', 65300 => 'EN', 65301 => 'EN', 65302 => 'EN', 65303 => 'EN', 65304 => 'EN', 65305 => 'EN', 65306 => 'CS', 65307 => 'ON', 65308 => 'ON', 65309 => 'ON', 65310 => 'ON', 65311 => 'ON', 65312 => 'ON', 65313 => 'L', 65314 => 'L', 65315 => 'L', 65316 => 'L', 65317 => 'L', 65318 => 'L', 65319 => 'L', 65320 => 'L', 65321 => 'L', 65322 => 'L', 65323 => 'L', 65324 => 'L', 65325 => 'L', 65326 => 'L', 65327 => 'L', 65328 => 'L', 65329 => 'L', 65330 => 'L', 65331 => 'L', 65332 => 'L', 65333 => 'L', 65334 => 'L', 65335 => 'L', 65336 => 'L', 65337 => 'L', 65338 => 'L', 65339 => 'ON', 65340 => 'ON', 65341 => 'ON', 65342 => 'ON', 65343 => 'ON', 65344 => 'ON', 65345 => 'L', 65346 => 'L', 65347 => 'L', 65348 => 'L', 65349 => 'L', 65350 => 'L', 65351 => 'L', 65352 => 'L', 65353 => 'L', 65354 => 'L', 65355 => 'L', 65356 => 'L', 65357 => 'L', 65358 => 'L', 65359 => 'L', 65360 => 'L', 65361 => 'L', 65362 => 'L', 65363 => 'L', 65364 => 'L', 65365 => 'L', 65366 => 'L', 65367 => 'L', 65368 => 'L', 65369 => 'L', 65370 => 'L', 65371 => 'ON', 65372 => 'ON', 65373 => 'ON', 65374 => 'ON', 65375 => 'ON', 65376 => 'ON', 65377 => 'ON', 65378 => 'ON', 65379 => 'ON', 65380 => 'ON', 65381 => 'ON', 65382 => 'L', 65383 => 'L', 65384 => 'L', 65385 => 'L', 65386 => 'L', 65387 => 'L', 65388 => 'L', 65389 => 'L', 65390 => 'L', 65391 => 'L', 65392 => 'L', 65393 => 'L', 65394 => 'L', 65395 => 'L', 65396 => 'L', 65397 => 'L', 65398 => 'L', 65399 => 'L', 65400 => 'L', 65401 => 'L', 65402 => 'L', 65403 => 'L', 65404 => 'L', 65405 => 'L', 65406 => 'L', 65407 => 'L', 65408 => 'L', 65409 => 'L', 65410 => 'L', 65411 => 'L', 65412 => 'L', 65413 => 'L', 65414 => 'L', 65415 => 'L', 65416 => 'L', 65417 => 'L', 65418 => 'L', 65419 => 'L', 65420 => 'L', 65421 => 'L', 65422 => 'L', 65423 => 'L', 65424 => 'L', 65425 => 'L', 65426 => 'L', 65427 => 'L', 65428 => 'L', 65429 => 'L', 65430 => 'L', 65431 => 'L', 65432 => 'L', 65433 => 'L', 65434 => 'L', 65435 => 'L', 65436 => 'L', 65437 => 'L', 65438 => 'L', 65439 => 'L', 65440 => 'L', 65441 => 'L', 65442 => 'L', 65443 => 'L', 65444 => 'L', 65445 => 'L', 65446 => 'L', 65447 => 'L', 65448 => 'L', 65449 => 'L', 65450 => 'L', 65451 => 'L', 65452 => 'L', 65453 => 'L', 65454 => 'L', 65455 => 'L', 65456 => 'L', 65457 => 'L', 65458 => 'L', 65459 => 'L', 65460 => 'L', 65461 => 'L', 65462 => 'L', 65463 => 'L', 65464 => 'L', 65465 => 'L', 65466 => 'L', 65467 => 'L', 65468 => 'L', 65469 => 'L', 65470 => 'L', 65474 => 'L', 65475 => 'L', 65476 => 'L', 65477 => 'L', 65478 => 'L', 65479 => 'L', 65482 => 'L', 65483 => 'L', 65484 => 'L', 65485 => 'L', 65486 => 'L', 65487 => 'L', 65490 => 'L', 65491 => 'L', 65492 => 'L', 65493 => 'L', 65494 => 'L', 65495 => 'L', 65498 => 'L', 65499 => 'L', 65500 => 'L', 65504 => 'ET', 65505 => 'ET', 65506 => 'ON', 65507 => 'ON', 65508 => 'ON', 65509 => 'ET', 65510 => 'ET', 65512 => 'ON', 65513 => 'ON', 65514 => 'ON', 65515 => 'ON', 65516 => 'ON', 65517 => 'ON', 65518 => 'ON', 65529 => 'ON', 65530 => 'ON', 65531 => 'ON', 65532 => 'ON', 65533 => 'ON', 65536 => 'L', 65537 => 'L', 65538 => 'L', 65539 => 'L', 65540 => 'L', 65541 => 'L', 65542 => 'L', 65543 => 'L', 65544 => 'L', 65545 => 'L', 65546 => 'L', 65547 => 'L', 65549 => 'L', 65550 => 'L', 65551 => 'L', 65552 => 'L', 65553 => 'L', 65554 => 'L', 65555 => 'L', 65556 => 'L', 65557 => 'L', 65558 => 'L', 65559 => 'L', 65560 => 'L', 65561 => 'L', 65562 => 'L', 65563 => 'L', 65564 => 'L', 65565 => 'L', 65566 => 'L', 65567 => 'L', 65568 => 'L', 65569 => 'L', 65570 => 'L', 65571 => 'L', 65572 => 'L', 65573 => 'L', 65574 => 'L', 65576 => 'L', 65577 => 'L', 65578 => 'L', 65579 => 'L', 65580 => 'L', 65581 => 'L', 65582 => 'L', 65583 => 'L', 65584 => 'L', 65585 => 'L', 65586 => 'L', 65587 => 'L', 65588 => 'L', 65589 => 'L', 65590 => 'L', 65591 => 'L', 65592 => 'L', 65593 => 'L', 65594 => 'L', 65596 => 'L', 65597 => 'L', 65599 => 'L', 65600 => 'L', 65601 => 'L', 65602 => 'L', 65603 => 'L', 65604 => 'L', 65605 => 'L', 65606 => 'L', 65607 => 'L', 65608 => 'L', 65609 => 'L', 65610 => 'L', 65611 => 'L', 65612 => 'L', 65613 => 'L', 65616 => 'L', 65617 => 'L', 65618 => 'L', 65619 => 'L', 65620 => 'L', 65621 => 'L', 65622 => 'L', 65623 => 'L', 65624 => 'L', 65625 => 'L', 65626 => 'L', 65627 => 'L', 65628 => 'L', 65629 => 'L', 65664 => 'L', 65665 => 'L', 65666 => 'L', 65667 => 'L', 65668 => 'L', 65669 => 'L', 65670 => 'L', 65671 => 'L', 65672 => 'L', 65673 => 'L', 65674 => 'L', 65675 => 'L', 65676 => 'L', 65677 => 'L', 65678 => 'L', 65679 => 'L', 65680 => 'L', 65681 => 'L', 65682 => 'L', 65683 => 'L', 65684 => 'L', 65685 => 'L', 65686 => 'L', 65687 => 'L', 65688 => 'L', 65689 => 'L', 65690 => 'L', 65691 => 'L', 65692 => 'L', 65693 => 'L', 65694 => 'L', 65695 => 'L', 65696 => 'L', 65697 => 'L', 65698 => 'L', 65699 => 'L', 65700 => 'L', 65701 => 'L', 65702 => 'L', 65703 => 'L', 65704 => 'L', 65705 => 'L', 65706 => 'L', 65707 => 'L', 65708 => 'L', 65709 => 'L', 65710 => 'L', 65711 => 'L', 65712 => 'L', 65713 => 'L', 65714 => 'L', 65715 => 'L', 65716 => 'L', 65717 => 'L', 65718 => 'L', 65719 => 'L', 65720 => 'L', 65721 => 'L', 65722 => 'L', 65723 => 'L', 65724 => 'L', 65725 => 'L', 65726 => 'L', 65727 => 'L', 65728 => 'L', 65729 => 'L', 65730 => 'L', 65731 => 'L', 65732 => 'L', 65733 => 'L', 65734 => 'L', 65735 => 'L', 65736 => 'L', 65737 => 'L', 65738 => 'L', 65739 => 'L', 65740 => 'L', 65741 => 'L', 65742 => 'L', 65743 => 'L', 65744 => 'L', 65745 => 'L', 65746 => 'L', 65747 => 'L', 65748 => 'L', 65749 => 'L', 65750 => 'L', 65751 => 'L', 65752 => 'L', 65753 => 'L', 65754 => 'L', 65755 => 'L', 65756 => 'L', 65757 => 'L', 65758 => 'L', 65759 => 'L', 65760 => 'L', 65761 => 'L', 65762 => 'L', 65763 => 'L', 65764 => 'L', 65765 => 'L', 65766 => 'L', 65767 => 'L', 65768 => 'L', 65769 => 'L', 65770 => 'L', 65771 => 'L', 65772 => 'L', 65773 => 'L', 65774 => 'L', 65775 => 'L', 65776 => 'L', 65777 => 'L', 65778 => 'L', 65779 => 'L', 65780 => 'L', 65781 => 'L', 65782 => 'L', 65783 => 'L', 65784 => 'L', 65785 => 'L', 65786 => 'L', 65792 => 'L', 65793 => 'ON', 65794 => 'L', 65799 => 'L', 65800 => 'L', 65801 => 'L', 65802 => 'L', 65803 => 'L', 65804 => 'L', 65805 => 'L', 65806 => 'L', 65807 => 'L', 65808 => 'L', 65809 => 'L', 65810 => 'L', 65811 => 'L', 65812 => 'L', 65813 => 'L', 65814 => 'L', 65815 => 'L', 65816 => 'L', 65817 => 'L', 65818 => 'L', 65819 => 'L', 65820 => 'L', 65821 => 'L', 65822 => 'L', 65823 => 'L', 65824 => 'L', 65825 => 'L', 65826 => 'L', 65827 => 'L', 65828 => 'L', 65829 => 'L', 65830 => 'L', 65831 => 'L', 65832 => 'L', 65833 => 'L', 65834 => 'L', 65835 => 'L', 65836 => 'L', 65837 => 'L', 65838 => 'L', 65839 => 'L', 65840 => 'L', 65841 => 'L', 65842 => 'L', 65843 => 'L', 65847 => 'L', 65848 => 'L', 65849 => 'L', 65850 => 'L', 65851 => 'L', 65852 => 'L', 65853 => 'L', 65854 => 'L', 65855 => 'L', 65856 => 'ON', 65857 => 'ON', 65858 => 'ON', 65859 => 'ON', 65860 => 'ON', 65861 => 'ON', 65862 => 'ON', 65863 => 'ON', 65864 => 'ON', 65865 => 'ON', 65866 => 'ON', 65867 => 'ON', 65868 => 'ON', 65869 => 'ON', 65870 => 'ON', 65871 => 'ON', 65872 => 'ON', 65873 => 'ON', 65874 => 'ON', 65875 => 'ON', 65876 => 'ON', 65877 => 'ON', 65878 => 'ON', 65879 => 'ON', 65880 => 'ON', 65881 => 'ON', 65882 => 'ON', 65883 => 'ON', 65884 => 'ON', 65885 => 'ON', 65886 => 'ON', 65887 => 'ON', 65888 => 'ON', 65889 => 'ON', 65890 => 'ON', 65891 => 'ON', 65892 => 'ON', 65893 => 'ON', 65894 => 'ON', 65895 => 'ON', 65896 => 'ON', 65897 => 'ON', 65898 => 'ON', 65899 => 'ON', 65900 => 'ON', 65901 => 'ON', 65902 => 'ON', 65903 => 'ON', 65904 => 'ON', 65905 => 'ON', 65906 => 'ON', 65907 => 'ON', 65908 => 'ON', 65909 => 'ON', 65910 => 'ON', 65911 => 'ON', 65912 => 'ON', 65913 => 'ON', 65914 => 'ON', 65915 => 'ON', 65916 => 'ON', 65917 => 'ON', 65918 => 'ON', 65919 => 'ON', 65920 => 'ON', 65921 => 'ON', 65922 => 'ON', 65923 => 'ON', 65924 => 'ON', 65925 => 'ON', 65926 => 'ON', 65927 => 'ON', 65928 => 'ON', 65929 => 'ON', 65930 => 'ON', 66304 => 'L', 66305 => 'L', 66306 => 'L', 66307 => 'L', 66308 => 'L', 66309 => 'L', 66310 => 'L', 66311 => 'L', 66312 => 'L', 66313 => 'L', 66314 => 'L', 66315 => 'L', 66316 => 'L', 66317 => 'L', 66318 => 'L', 66319 => 'L', 66320 => 'L', 66321 => 'L', 66322 => 'L', 66323 => 'L', 66324 => 'L', 66325 => 'L', 66326 => 'L', 66327 => 'L', 66328 => 'L', 66329 => 'L', 66330 => 'L', 66331 => 'L', 66332 => 'L', 66333 => 'L', 66334 => 'L', 66336 => 'L', 66337 => 'L', 66338 => 'L', 66339 => 'L', 66352 => 'L', 66353 => 'L', 66354 => 'L', 66355 => 'L', 66356 => 'L', 66357 => 'L', 66358 => 'L', 66359 => 'L', 66360 => 'L', 66361 => 'L', 66362 => 'L', 66363 => 'L', 66364 => 'L', 66365 => 'L', 66366 => 'L', 66367 => 'L', 66368 => 'L', 66369 => 'L', 66370 => 'L', 66371 => 'L', 66372 => 'L', 66373 => 'L', 66374 => 'L', 66375 => 'L', 66376 => 'L', 66377 => 'L', 66378 => 'L', 66432 => 'L', 66433 => 'L', 66434 => 'L', 66435 => 'L', 66436 => 'L', 66437 => 'L', 66438 => 'L', 66439 => 'L', 66440 => 'L', 66441 => 'L', 66442 => 'L', 66443 => 'L', 66444 => 'L', 66445 => 'L', 66446 => 'L', 66447 => 'L', 66448 => 'L', 66449 => 'L', 66450 => 'L', 66451 => 'L', 66452 => 'L', 66453 => 'L', 66454 => 'L', 66455 => 'L', 66456 => 'L', 66457 => 'L', 66458 => 'L', 66459 => 'L', 66460 => 'L', 66461 => 'L', 66463 => 'L', 66464 => 'L', 66465 => 'L', 66466 => 'L', 66467 => 'L', 66468 => 'L', 66469 => 'L', 66470 => 'L', 66471 => 'L', 66472 => 'L', 66473 => 'L', 66474 => 'L', 66475 => 'L', 66476 => 'L', 66477 => 'L', 66478 => 'L', 66479 => 'L', 66480 => 'L', 66481 => 'L', 66482 => 'L', 66483 => 'L', 66484 => 'L', 66485 => 'L', 66486 => 'L', 66487 => 'L', 66488 => 'L', 66489 => 'L', 66490 => 'L', 66491 => 'L', 66492 => 'L', 66493 => 'L', 66494 => 'L', 66495 => 'L', 66496 => 'L', 66497 => 'L', 66498 => 'L', 66499 => 'L', 66504 => 'L', 66505 => 'L', 66506 => 'L', 66507 => 'L', 66508 => 'L', 66509 => 'L', 66510 => 'L', 66511 => 'L', 66512 => 'L', 66513 => 'L', 66514 => 'L', 66515 => 'L', 66516 => 'L', 66517 => 'L', 66560 => 'L', 66561 => 'L', 66562 => 'L', 66563 => 'L', 66564 => 'L', 66565 => 'L', 66566 => 'L', 66567 => 'L', 66568 => 'L', 66569 => 'L', 66570 => 'L', 66571 => 'L', 66572 => 'L', 66573 => 'L', 66574 => 'L', 66575 => 'L', 66576 => 'L', 66577 => 'L', 66578 => 'L', 66579 => 'L', 66580 => 'L', 66581 => 'L', 66582 => 'L', 66583 => 'L', 66584 => 'L', 66585 => 'L', 66586 => 'L', 66587 => 'L', 66588 => 'L', 66589 => 'L', 66590 => 'L', 66591 => 'L', 66592 => 'L', 66593 => 'L', 66594 => 'L', 66595 => 'L', 66596 => 'L', 66597 => 'L', 66598 => 'L', 66599 => 'L', 66600 => 'L', 66601 => 'L', 66602 => 'L', 66603 => 'L', 66604 => 'L', 66605 => 'L', 66606 => 'L', 66607 => 'L', 66608 => 'L', 66609 => 'L', 66610 => 'L', 66611 => 'L', 66612 => 'L', 66613 => 'L', 66614 => 'L', 66615 => 'L', 66616 => 'L', 66617 => 'L', 66618 => 'L', 66619 => 'L', 66620 => 'L', 66621 => 'L', 66622 => 'L', 66623 => 'L', 66624 => 'L', 66625 => 'L', 66626 => 'L', 66627 => 'L', 66628 => 'L', 66629 => 'L', 66630 => 'L', 66631 => 'L', 66632 => 'L', 66633 => 'L', 66634 => 'L', 66635 => 'L', 66636 => 'L', 66637 => 'L', 66638 => 'L', 66639 => 'L', 66640 => 'L', 66641 => 'L', 66642 => 'L', 66643 => 'L', 66644 => 'L', 66645 => 'L', 66646 => 'L', 66647 => 'L', 66648 => 'L', 66649 => 'L', 66650 => 'L', 66651 => 'L', 66652 => 'L', 66653 => 'L', 66654 => 'L', 66655 => 'L', 66656 => 'L', 66657 => 'L', 66658 => 'L', 66659 => 'L', 66660 => 'L', 66661 => 'L', 66662 => 'L', 66663 => 'L', 66664 => 'L', 66665 => 'L', 66666 => 'L', 66667 => 'L', 66668 => 'L', 66669 => 'L', 66670 => 'L', 66671 => 'L', 66672 => 'L', 66673 => 'L', 66674 => 'L', 66675 => 'L', 66676 => 'L', 66677 => 'L', 66678 => 'L', 66679 => 'L', 66680 => 'L', 66681 => 'L', 66682 => 'L', 66683 => 'L', 66684 => 'L', 66685 => 'L', 66686 => 'L', 66687 => 'L', 66688 => 'L', 66689 => 'L', 66690 => 'L', 66691 => 'L', 66692 => 'L', 66693 => 'L', 66694 => 'L', 66695 => 'L', 66696 => 'L', 66697 => 'L', 66698 => 'L', 66699 => 'L', 66700 => 'L', 66701 => 'L', 66702 => 'L', 66703 => 'L', 66704 => 'L', 66705 => 'L', 66706 => 'L', 66707 => 'L', 66708 => 'L', 66709 => 'L', 66710 => 'L', 66711 => 'L', 66712 => 'L', 66713 => 'L', 66714 => 'L', 66715 => 'L', 66716 => 'L', 66717 => 'L', 66720 => 'L', 66721 => 'L', 66722 => 'L', 66723 => 'L', 66724 => 'L', 66725 => 'L', 66726 => 'L', 66727 => 'L', 66728 => 'L', 66729 => 'L', 67584 => 'R', 67585 => 'R', 67586 => 'R', 67587 => 'R', 67588 => 'R', 67589 => 'R', 67592 => 'R', 67594 => 'R', 67595 => 'R', 67596 => 'R', 67597 => 'R', 67598 => 'R', 67599 => 'R', 67600 => 'R', 67601 => 'R', 67602 => 'R', 67603 => 'R', 67604 => 'R', 67605 => 'R', 67606 => 'R', 67607 => 'R', 67608 => 'R', 67609 => 'R', 67610 => 'R', 67611 => 'R', 67612 => 'R', 67613 => 'R', 67614 => 'R', 67615 => 'R', 67616 => 'R', 67617 => 'R', 67618 => 'R', 67619 => 'R', 67620 => 'R', 67621 => 'R', 67622 => 'R', 67623 => 'R', 67624 => 'R', 67625 => 'R', 67626 => 'R', 67627 => 'R', 67628 => 'R', 67629 => 'R', 67630 => 'R', 67631 => 'R', 67632 => 'R', 67633 => 'R', 67634 => 'R', 67635 => 'R', 67636 => 'R', 67637 => 'R', 67639 => 'R', 67640 => 'R', 67644 => 'R', 67647 => 'R', 67840 => 'R', 67841 => 'R', 67842 => 'R', 67843 => 'R', 67844 => 'R', 67845 => 'R', 67846 => 'R', 67847 => 'R', 67848 => 'R', 67849 => 'R', 67850 => 'R', 67851 => 'R', 67852 => 'R', 67853 => 'R', 67854 => 'R', 67855 => 'R', 67856 => 'R', 67857 => 'R', 67858 => 'R', 67859 => 'R', 67860 => 'R', 67861 => 'R', 67862 => 'R', 67863 => 'R', 67864 => 'R', 67865 => 'R', 67871 => 'ON', 68096 => 'R', 68097 => 'NSM', 68098 => 'NSM', 68099 => 'NSM', 68101 => 'NSM', 68102 => 'NSM', 68108 => 'NSM', 68109 => 'NSM', 68110 => 'NSM', 68111 => 'NSM', 68112 => 'R', 68113 => 'R', 68114 => 'R', 68115 => 'R', 68117 => 'R', 68118 => 'R', 68119 => 'R', 68121 => 'R', 68122 => 'R', 68123 => 'R', 68124 => 'R', 68125 => 'R', 68126 => 'R', 68127 => 'R', 68128 => 'R', 68129 => 'R', 68130 => 'R', 68131 => 'R', 68132 => 'R', 68133 => 'R', 68134 => 'R', 68135 => 'R', 68136 => 'R', 68137 => 'R', 68138 => 'R', 68139 => 'R', 68140 => 'R', 68141 => 'R', 68142 => 'R', 68143 => 'R', 68144 => 'R', 68145 => 'R', 68146 => 'R', 68147 => 'R', 68152 => 'NSM', 68153 => 'NSM', 68154 => 'NSM', 68159 => 'NSM', 68160 => 'R', 68161 => 'R', 68162 => 'R', 68163 => 'R', 68164 => 'R', 68165 => 'R', 68166 => 'R', 68167 => 'R', 68176 => 'R', 68177 => 'R', 68178 => 'R', 68179 => 'R', 68180 => 'R', 68181 => 'R', 68182 => 'R', 68183 => 'R', 68184 => 'R', 73728 => 'L', 73729 => 'L', 73730 => 'L', 73731 => 'L', 73732 => 'L', 73733 => 'L', 73734 => 'L', 73735 => 'L', 73736 => 'L', 73737 => 'L', 73738 => 'L', 73739 => 'L', 73740 => 'L', 73741 => 'L', 73742 => 'L', 73743 => 'L', 73744 => 'L', 73745 => 'L', 73746 => 'L', 73747 => 'L', 73748 => 'L', 73749 => 'L', 73750 => 'L', 73751 => 'L', 73752 => 'L', 73753 => 'L', 73754 => 'L', 73755 => 'L', 73756 => 'L', 73757 => 'L', 73758 => 'L', 73759 => 'L', 73760 => 'L', 73761 => 'L', 73762 => 'L', 73763 => 'L', 73764 => 'L', 73765 => 'L', 73766 => 'L', 73767 => 'L', 73768 => 'L', 73769 => 'L', 73770 => 'L', 73771 => 'L', 73772 => 'L', 73773 => 'L', 73774 => 'L', 73775 => 'L', 73776 => 'L', 73777 => 'L', 73778 => 'L', 73779 => 'L', 73780 => 'L', 73781 => 'L', 73782 => 'L', 73783 => 'L', 73784 => 'L', 73785 => 'L', 73786 => 'L', 73787 => 'L', 73788 => 'L', 73789 => 'L', 73790 => 'L', 73791 => 'L', 73792 => 'L', 73793 => 'L', 73794 => 'L', 73795 => 'L', 73796 => 'L', 73797 => 'L', 73798 => 'L', 73799 => 'L', 73800 => 'L', 73801 => 'L', 73802 => 'L', 73803 => 'L', 73804 => 'L', 73805 => 'L', 73806 => 'L', 73807 => 'L', 73808 => 'L', 73809 => 'L', 73810 => 'L', 73811 => 'L', 73812 => 'L', 73813 => 'L', 73814 => 'L', 73815 => 'L', 73816 => 'L', 73817 => 'L', 73818 => 'L', 73819 => 'L', 73820 => 'L', 73821 => 'L', 73822 => 'L', 73823 => 'L', 73824 => 'L', 73825 => 'L', 73826 => 'L', 73827 => 'L', 73828 => 'L', 73829 => 'L', 73830 => 'L', 73831 => 'L', 73832 => 'L', 73833 => 'L', 73834 => 'L', 73835 => 'L', 73836 => 'L', 73837 => 'L', 73838 => 'L', 73839 => 'L', 73840 => 'L', 73841 => 'L', 73842 => 'L', 73843 => 'L', 73844 => 'L', 73845 => 'L', 73846 => 'L', 73847 => 'L', 73848 => 'L', 73849 => 'L', 73850 => 'L', 73851 => 'L', 73852 => 'L', 73853 => 'L', 73854 => 'L', 73855 => 'L', 73856 => 'L', 73857 => 'L', 73858 => 'L', 73859 => 'L', 73860 => 'L', 73861 => 'L', 73862 => 'L', 73863 => 'L', 73864 => 'L', 73865 => 'L', 73866 => 'L', 73867 => 'L', 73868 => 'L', 73869 => 'L', 73870 => 'L', 73871 => 'L', 73872 => 'L', 73873 => 'L', 73874 => 'L', 73875 => 'L', 73876 => 'L', 73877 => 'L', 73878 => 'L', 73879 => 'L', 73880 => 'L', 73881 => 'L', 73882 => 'L', 73883 => 'L', 73884 => 'L', 73885 => 'L', 73886 => 'L', 73887 => 'L', 73888 => 'L', 73889 => 'L', 73890 => 'L', 73891 => 'L', 73892 => 'L', 73893 => 'L', 73894 => 'L', 73895 => 'L', 73896 => 'L', 73897 => 'L', 73898 => 'L', 73899 => 'L', 73900 => 'L', 73901 => 'L', 73902 => 'L', 73903 => 'L', 73904 => 'L', 73905 => 'L', 73906 => 'L', 73907 => 'L', 73908 => 'L', 73909 => 'L', 73910 => 'L', 73911 => 'L', 73912 => 'L', 73913 => 'L', 73914 => 'L', 73915 => 'L', 73916 => 'L', 73917 => 'L', 73918 => 'L', 73919 => 'L', 73920 => 'L', 73921 => 'L', 73922 => 'L', 73923 => 'L', 73924 => 'L', 73925 => 'L', 73926 => 'L', 73927 => 'L', 73928 => 'L', 73929 => 'L', 73930 => 'L', 73931 => 'L', 73932 => 'L', 73933 => 'L', 73934 => 'L', 73935 => 'L', 73936 => 'L', 73937 => 'L', 73938 => 'L', 73939 => 'L', 73940 => 'L', 73941 => 'L', 73942 => 'L', 73943 => 'L', 73944 => 'L', 73945 => 'L', 73946 => 'L', 73947 => 'L', 73948 => 'L', 73949 => 'L', 73950 => 'L', 73951 => 'L', 73952 => 'L', 73953 => 'L', 73954 => 'L', 73955 => 'L', 73956 => 'L', 73957 => 'L', 73958 => 'L', 73959 => 'L', 73960 => 'L', 73961 => 'L', 73962 => 'L', 73963 => 'L', 73964 => 'L', 73965 => 'L', 73966 => 'L', 73967 => 'L', 73968 => 'L', 73969 => 'L', 73970 => 'L', 73971 => 'L', 73972 => 'L', 73973 => 'L', 73974 => 'L', 73975 => 'L', 73976 => 'L', 73977 => 'L', 73978 => 'L', 73979 => 'L', 73980 => 'L', 73981 => 'L', 73982 => 'L', 73983 => 'L', 73984 => 'L', 73985 => 'L', 73986 => 'L', 73987 => 'L', 73988 => 'L', 73989 => 'L', 73990 => 'L', 73991 => 'L', 73992 => 'L', 73993 => 'L', 73994 => 'L', 73995 => 'L', 73996 => 'L', 73997 => 'L', 73998 => 'L', 73999 => 'L', 74000 => 'L', 74001 => 'L', 74002 => 'L', 74003 => 'L', 74004 => 'L', 74005 => 'L', 74006 => 'L', 74007 => 'L', 74008 => 'L', 74009 => 'L', 74010 => 'L', 74011 => 'L', 74012 => 'L', 74013 => 'L', 74014 => 'L', 74015 => 'L', 74016 => 'L', 74017 => 'L', 74018 => 'L', 74019 => 'L', 74020 => 'L', 74021 => 'L', 74022 => 'L', 74023 => 'L', 74024 => 'L', 74025 => 'L', 74026 => 'L', 74027 => 'L', 74028 => 'L', 74029 => 'L', 74030 => 'L', 74031 => 'L', 74032 => 'L', 74033 => 'L', 74034 => 'L', 74035 => 'L', 74036 => 'L', 74037 => 'L', 74038 => 'L', 74039 => 'L', 74040 => 'L', 74041 => 'L', 74042 => 'L', 74043 => 'L', 74044 => 'L', 74045 => 'L', 74046 => 'L', 74047 => 'L', 74048 => 'L', 74049 => 'L', 74050 => 'L', 74051 => 'L', 74052 => 'L', 74053 => 'L', 74054 => 'L', 74055 => 'L', 74056 => 'L', 74057 => 'L', 74058 => 'L', 74059 => 'L', 74060 => 'L', 74061 => 'L', 74062 => 'L', 74063 => 'L', 74064 => 'L', 74065 => 'L', 74066 => 'L', 74067 => 'L', 74068 => 'L', 74069 => 'L', 74070 => 'L', 74071 => 'L', 74072 => 'L', 74073 => 'L', 74074 => 'L', 74075 => 'L', 74076 => 'L', 74077 => 'L', 74078 => 'L', 74079 => 'L', 74080 => 'L', 74081 => 'L', 74082 => 'L', 74083 => 'L', 74084 => 'L', 74085 => 'L', 74086 => 'L', 74087 => 'L', 74088 => 'L', 74089 => 'L', 74090 => 'L', 74091 => 'L', 74092 => 'L', 74093 => 'L', 74094 => 'L', 74095 => 'L', 74096 => 'L', 74097 => 'L', 74098 => 'L', 74099 => 'L', 74100 => 'L', 74101 => 'L', 74102 => 'L', 74103 => 'L', 74104 => 'L', 74105 => 'L', 74106 => 'L', 74107 => 'L', 74108 => 'L', 74109 => 'L', 74110 => 'L', 74111 => 'L', 74112 => 'L', 74113 => 'L', 74114 => 'L', 74115 => 'L', 74116 => 'L', 74117 => 'L', 74118 => 'L', 74119 => 'L', 74120 => 'L', 74121 => 'L', 74122 => 'L', 74123 => 'L', 74124 => 'L', 74125 => 'L', 74126 => 'L', 74127 => 'L', 74128 => 'L', 74129 => 'L', 74130 => 'L', 74131 => 'L', 74132 => 'L', 74133 => 'L', 74134 => 'L', 74135 => 'L', 74136 => 'L', 74137 => 'L', 74138 => 'L', 74139 => 'L', 74140 => 'L', 74141 => 'L', 74142 => 'L', 74143 => 'L', 74144 => 'L', 74145 => 'L', 74146 => 'L', 74147 => 'L', 74148 => 'L', 74149 => 'L', 74150 => 'L', 74151 => 'L', 74152 => 'L', 74153 => 'L', 74154 => 'L', 74155 => 'L', 74156 => 'L', 74157 => 'L', 74158 => 'L', 74159 => 'L', 74160 => 'L', 74161 => 'L', 74162 => 'L', 74163 => 'L', 74164 => 'L', 74165 => 'L', 74166 => 'L', 74167 => 'L', 74168 => 'L', 74169 => 'L', 74170 => 'L', 74171 => 'L', 74172 => 'L', 74173 => 'L', 74174 => 'L', 74175 => 'L', 74176 => 'L', 74177 => 'L', 74178 => 'L', 74179 => 'L', 74180 => 'L', 74181 => 'L', 74182 => 'L', 74183 => 'L', 74184 => 'L', 74185 => 'L', 74186 => 'L', 74187 => 'L', 74188 => 'L', 74189 => 'L', 74190 => 'L', 74191 => 'L', 74192 => 'L', 74193 => 'L', 74194 => 'L', 74195 => 'L', 74196 => 'L', 74197 => 'L', 74198 => 'L', 74199 => 'L', 74200 => 'L', 74201 => 'L', 74202 => 'L', 74203 => 'L', 74204 => 'L', 74205 => 'L', 74206 => 'L', 74207 => 'L', 74208 => 'L', 74209 => 'L', 74210 => 'L', 74211 => 'L', 74212 => 'L', 74213 => 'L', 74214 => 'L', 74215 => 'L', 74216 => 'L', 74217 => 'L', 74218 => 'L', 74219 => 'L', 74220 => 'L', 74221 => 'L', 74222 => 'L', 74223 => 'L', 74224 => 'L', 74225 => 'L', 74226 => 'L', 74227 => 'L', 74228 => 'L', 74229 => 'L', 74230 => 'L', 74231 => 'L', 74232 => 'L', 74233 => 'L', 74234 => 'L', 74235 => 'L', 74236 => 'L', 74237 => 'L', 74238 => 'L', 74239 => 'L', 74240 => 'L', 74241 => 'L', 74242 => 'L', 74243 => 'L', 74244 => 'L', 74245 => 'L', 74246 => 'L', 74247 => 'L', 74248 => 'L', 74249 => 'L', 74250 => 'L', 74251 => 'L', 74252 => 'L', 74253 => 'L', 74254 => 'L', 74255 => 'L', 74256 => 'L', 74257 => 'L', 74258 => 'L', 74259 => 'L', 74260 => 'L', 74261 => 'L', 74262 => 'L', 74263 => 'L', 74264 => 'L', 74265 => 'L', 74266 => 'L', 74267 => 'L', 74268 => 'L', 74269 => 'L', 74270 => 'L', 74271 => 'L', 74272 => 'L', 74273 => 'L', 74274 => 'L', 74275 => 'L', 74276 => 'L', 74277 => 'L', 74278 => 'L', 74279 => 'L', 74280 => 'L', 74281 => 'L', 74282 => 'L', 74283 => 'L', 74284 => 'L', 74285 => 'L', 74286 => 'L', 74287 => 'L', 74288 => 'L', 74289 => 'L', 74290 => 'L', 74291 => 'L', 74292 => 'L', 74293 => 'L', 74294 => 'L', 74295 => 'L', 74296 => 'L', 74297 => 'L', 74298 => 'L', 74299 => 'L', 74300 => 'L', 74301 => 'L', 74302 => 'L', 74303 => 'L', 74304 => 'L', 74305 => 'L', 74306 => 'L', 74307 => 'L', 74308 => 'L', 74309 => 'L', 74310 => 'L', 74311 => 'L', 74312 => 'L', 74313 => 'L', 74314 => 'L', 74315 => 'L', 74316 => 'L', 74317 => 'L', 74318 => 'L', 74319 => 'L', 74320 => 'L', 74321 => 'L', 74322 => 'L', 74323 => 'L', 74324 => 'L', 74325 => 'L', 74326 => 'L', 74327 => 'L', 74328 => 'L', 74329 => 'L', 74330 => 'L', 74331 => 'L', 74332 => 'L', 74333 => 'L', 74334 => 'L', 74335 => 'L', 74336 => 'L', 74337 => 'L', 74338 => 'L', 74339 => 'L', 74340 => 'L', 74341 => 'L', 74342 => 'L', 74343 => 'L', 74344 => 'L', 74345 => 'L', 74346 => 'L', 74347 => 'L', 74348 => 'L', 74349 => 'L', 74350 => 'L', 74351 => 'L', 74352 => 'L', 74353 => 'L', 74354 => 'L', 74355 => 'L', 74356 => 'L', 74357 => 'L', 74358 => 'L', 74359 => 'L', 74360 => 'L', 74361 => 'L', 74362 => 'L', 74363 => 'L', 74364 => 'L', 74365 => 'L', 74366 => 'L', 74367 => 'L', 74368 => 'L', 74369 => 'L', 74370 => 'L', 74371 => 'L', 74372 => 'L', 74373 => 'L', 74374 => 'L', 74375 => 'L', 74376 => 'L', 74377 => 'L', 74378 => 'L', 74379 => 'L', 74380 => 'L', 74381 => 'L', 74382 => 'L', 74383 => 'L', 74384 => 'L', 74385 => 'L', 74386 => 'L', 74387 => 'L', 74388 => 'L', 74389 => 'L', 74390 => 'L', 74391 => 'L', 74392 => 'L', 74393 => 'L', 74394 => 'L', 74395 => 'L', 74396 => 'L', 74397 => 'L', 74398 => 'L', 74399 => 'L', 74400 => 'L', 74401 => 'L', 74402 => 'L', 74403 => 'L', 74404 => 'L', 74405 => 'L', 74406 => 'L', 74407 => 'L', 74408 => 'L', 74409 => 'L', 74410 => 'L', 74411 => 'L', 74412 => 'L', 74413 => 'L', 74414 => 'L', 74415 => 'L', 74416 => 'L', 74417 => 'L', 74418 => 'L', 74419 => 'L', 74420 => 'L', 74421 => 'L', 74422 => 'L', 74423 => 'L', 74424 => 'L', 74425 => 'L', 74426 => 'L', 74427 => 'L', 74428 => 'L', 74429 => 'L', 74430 => 'L', 74431 => 'L', 74432 => 'L', 74433 => 'L', 74434 => 'L', 74435 => 'L', 74436 => 'L', 74437 => 'L', 74438 => 'L', 74439 => 'L', 74440 => 'L', 74441 => 'L', 74442 => 'L', 74443 => 'L', 74444 => 'L', 74445 => 'L', 74446 => 'L', 74447 => 'L', 74448 => 'L', 74449 => 'L', 74450 => 'L', 74451 => 'L', 74452 => 'L', 74453 => 'L', 74454 => 'L', 74455 => 'L', 74456 => 'L', 74457 => 'L', 74458 => 'L', 74459 => 'L', 74460 => 'L', 74461 => 'L', 74462 => 'L', 74463 => 'L', 74464 => 'L', 74465 => 'L', 74466 => 'L', 74467 => 'L', 74468 => 'L', 74469 => 'L', 74470 => 'L', 74471 => 'L', 74472 => 'L', 74473 => 'L', 74474 => 'L', 74475 => 'L', 74476 => 'L', 74477 => 'L', 74478 => 'L', 74479 => 'L', 74480 => 'L', 74481 => 'L', 74482 => 'L', 74483 => 'L', 74484 => 'L', 74485 => 'L', 74486 => 'L', 74487 => 'L', 74488 => 'L', 74489 => 'L', 74490 => 'L', 74491 => 'L', 74492 => 'L', 74493 => 'L', 74494 => 'L', 74495 => 'L', 74496 => 'L', 74497 => 'L', 74498 => 'L', 74499 => 'L', 74500 => 'L', 74501 => 'L', 74502 => 'L', 74503 => 'L', 74504 => 'L', 74505 => 'L', 74506 => 'L', 74507 => 'L', 74508 => 'L', 74509 => 'L', 74510 => 'L', 74511 => 'L', 74512 => 'L', 74513 => 'L', 74514 => 'L', 74515 => 'L', 74516 => 'L', 74517 => 'L', 74518 => 'L', 74519 => 'L', 74520 => 'L', 74521 => 'L', 74522 => 'L', 74523 => 'L', 74524 => 'L', 74525 => 'L', 74526 => 'L', 74527 => 'L', 74528 => 'L', 74529 => 'L', 74530 => 'L', 74531 => 'L', 74532 => 'L', 74533 => 'L', 74534 => 'L', 74535 => 'L', 74536 => 'L', 74537 => 'L', 74538 => 'L', 74539 => 'L', 74540 => 'L', 74541 => 'L', 74542 => 'L', 74543 => 'L', 74544 => 'L', 74545 => 'L', 74546 => 'L', 74547 => 'L', 74548 => 'L', 74549 => 'L', 74550 => 'L', 74551 => 'L', 74552 => 'L', 74553 => 'L', 74554 => 'L', 74555 => 'L', 74556 => 'L', 74557 => 'L', 74558 => 'L', 74559 => 'L', 74560 => 'L', 74561 => 'L', 74562 => 'L', 74563 => 'L', 74564 => 'L', 74565 => 'L', 74566 => 'L', 74567 => 'L', 74568 => 'L', 74569 => 'L', 74570 => 'L', 74571 => 'L', 74572 => 'L', 74573 => 'L', 74574 => 'L', 74575 => 'L', 74576 => 'L', 74577 => 'L', 74578 => 'L', 74579 => 'L', 74580 => 'L', 74581 => 'L', 74582 => 'L', 74583 => 'L', 74584 => 'L', 74585 => 'L', 74586 => 'L', 74587 => 'L', 74588 => 'L', 74589 => 'L', 74590 => 'L', 74591 => 'L', 74592 => 'L', 74593 => 'L', 74594 => 'L', 74595 => 'L', 74596 => 'L', 74597 => 'L', 74598 => 'L', 74599 => 'L', 74600 => 'L', 74601 => 'L', 74602 => 'L', 74603 => 'L', 74604 => 'L', 74605 => 'L', 74606 => 'L', 74752 => 'L', 74753 => 'L', 74754 => 'L', 74755 => 'L', 74756 => 'L', 74757 => 'L', 74758 => 'L', 74759 => 'L', 74760 => 'L', 74761 => 'L', 74762 => 'L', 74763 => 'L', 74764 => 'L', 74765 => 'L', 74766 => 'L', 74767 => 'L', 74768 => 'L', 74769 => 'L', 74770 => 'L', 74771 => 'L', 74772 => 'L', 74773 => 'L', 74774 => 'L', 74775 => 'L', 74776 => 'L', 74777 => 'L', 74778 => 'L', 74779 => 'L', 74780 => 'L', 74781 => 'L', 74782 => 'L', 74783 => 'L', 74784 => 'L', 74785 => 'L', 74786 => 'L', 74787 => 'L', 74788 => 'L', 74789 => 'L', 74790 => 'L', 74791 => 'L', 74792 => 'L', 74793 => 'L', 74794 => 'L', 74795 => 'L', 74796 => 'L', 74797 => 'L', 74798 => 'L', 74799 => 'L', 74800 => 'L', 74801 => 'L', 74802 => 'L', 74803 => 'L', 74804 => 'L', 74805 => 'L', 74806 => 'L', 74807 => 'L', 74808 => 'L', 74809 => 'L', 74810 => 'L', 74811 => 'L', 74812 => 'L', 74813 => 'L', 74814 => 'L', 74815 => 'L', 74816 => 'L', 74817 => 'L', 74818 => 'L', 74819 => 'L', 74820 => 'L', 74821 => 'L', 74822 => 'L', 74823 => 'L', 74824 => 'L', 74825 => 'L', 74826 => 'L', 74827 => 'L', 74828 => 'L', 74829 => 'L', 74830 => 'L', 74831 => 'L', 74832 => 'L', 74833 => 'L', 74834 => 'L', 74835 => 'L', 74836 => 'L', 74837 => 'L', 74838 => 'L', 74839 => 'L', 74840 => 'L', 74841 => 'L', 74842 => 'L', 74843 => 'L', 74844 => 'L', 74845 => 'L', 74846 => 'L', 74847 => 'L', 74848 => 'L', 74849 => 'L', 74850 => 'L', 74864 => 'L', 74865 => 'L', 74866 => 'L', 74867 => 'L', 118784 => 'L', 118785 => 'L', 118786 => 'L', 118787 => 'L', 118788 => 'L', 118789 => 'L', 118790 => 'L', 118791 => 'L', 118792 => 'L', 118793 => 'L', 118794 => 'L', 118795 => 'L', 118796 => 'L', 118797 => 'L', 118798 => 'L', 118799 => 'L', 118800 => 'L', 118801 => 'L', 118802 => 'L', 118803 => 'L', 118804 => 'L', 118805 => 'L', 118806 => 'L', 118807 => 'L', 118808 => 'L', 118809 => 'L', 118810 => 'L', 118811 => 'L', 118812 => 'L', 118813 => 'L', 118814 => 'L', 118815 => 'L', 118816 => 'L', 118817 => 'L', 118818 => 'L', 118819 => 'L', 118820 => 'L', 118821 => 'L', 118822 => 'L', 118823 => 'L', 118824 => 'L', 118825 => 'L', 118826 => 'L', 118827 => 'L', 118828 => 'L', 118829 => 'L', 118830 => 'L', 118831 => 'L', 118832 => 'L', 118833 => 'L', 118834 => 'L', 118835 => 'L', 118836 => 'L', 118837 => 'L', 118838 => 'L', 118839 => 'L', 118840 => 'L', 118841 => 'L', 118842 => 'L', 118843 => 'L', 118844 => 'L', 118845 => 'L', 118846 => 'L', 118847 => 'L', 118848 => 'L', 118849 => 'L', 118850 => 'L', 118851 => 'L', 118852 => 'L', 118853 => 'L', 118854 => 'L', 118855 => 'L', 118856 => 'L', 118857 => 'L', 118858 => 'L', 118859 => 'L', 118860 => 'L', 118861 => 'L', 118862 => 'L', 118863 => 'L', 118864 => 'L', 118865 => 'L', 118866 => 'L', 118867 => 'L', 118868 => 'L', 118869 => 'L', 118870 => 'L', 118871 => 'L', 118872 => 'L', 118873 => 'L', 118874 => 'L', 118875 => 'L', 118876 => 'L', 118877 => 'L', 118878 => 'L', 118879 => 'L', 118880 => 'L', 118881 => 'L', 118882 => 'L', 118883 => 'L', 118884 => 'L', 118885 => 'L', 118886 => 'L', 118887 => 'L', 118888 => 'L', 118889 => 'L', 118890 => 'L', 118891 => 'L', 118892 => 'L', 118893 => 'L', 118894 => 'L', 118895 => 'L', 118896 => 'L', 118897 => 'L', 118898 => 'L', 118899 => 'L', 118900 => 'L', 118901 => 'L', 118902 => 'L', 118903 => 'L', 118904 => 'L', 118905 => 'L', 118906 => 'L', 118907 => 'L', 118908 => 'L', 118909 => 'L', 118910 => 'L', 118911 => 'L', 118912 => 'L', 118913 => 'L', 118914 => 'L', 118915 => 'L', 118916 => 'L', 118917 => 'L', 118918 => 'L', 118919 => 'L', 118920 => 'L', 118921 => 'L', 118922 => 'L', 118923 => 'L', 118924 => 'L', 118925 => 'L', 118926 => 'L', 118927 => 'L', 118928 => 'L', 118929 => 'L', 118930 => 'L', 118931 => 'L', 118932 => 'L', 118933 => 'L', 118934 => 'L', 118935 => 'L', 118936 => 'L', 118937 => 'L', 118938 => 'L', 118939 => 'L', 118940 => 'L', 118941 => 'L', 118942 => 'L', 118943 => 'L', 118944 => 'L', 118945 => 'L', 118946 => 'L', 118947 => 'L', 118948 => 'L', 118949 => 'L', 118950 => 'L', 118951 => 'L', 118952 => 'L', 118953 => 'L', 118954 => 'L', 118955 => 'L', 118956 => 'L', 118957 => 'L', 118958 => 'L', 118959 => 'L', 118960 => 'L', 118961 => 'L', 118962 => 'L', 118963 => 'L', 118964 => 'L', 118965 => 'L', 118966 => 'L', 118967 => 'L', 118968 => 'L', 118969 => 'L', 118970 => 'L', 118971 => 'L', 118972 => 'L', 118973 => 'L', 118974 => 'L', 118975 => 'L', 118976 => 'L', 118977 => 'L', 118978 => 'L', 118979 => 'L', 118980 => 'L', 118981 => 'L', 118982 => 'L', 118983 => 'L', 118984 => 'L', 118985 => 'L', 118986 => 'L', 118987 => 'L', 118988 => 'L', 118989 => 'L', 118990 => 'L', 118991 => 'L', 118992 => 'L', 118993 => 'L', 118994 => 'L', 118995 => 'L', 118996 => 'L', 118997 => 'L', 118998 => 'L', 118999 => 'L', 119000 => 'L', 119001 => 'L', 119002 => 'L', 119003 => 'L', 119004 => 'L', 119005 => 'L', 119006 => 'L', 119007 => 'L', 119008 => 'L', 119009 => 'L', 119010 => 'L', 119011 => 'L', 119012 => 'L', 119013 => 'L', 119014 => 'L', 119015 => 'L', 119016 => 'L', 119017 => 'L', 119018 => 'L', 119019 => 'L', 119020 => 'L', 119021 => 'L', 119022 => 'L', 119023 => 'L', 119024 => 'L', 119025 => 'L', 119026 => 'L', 119027 => 'L', 119028 => 'L', 119029 => 'L', 119040 => 'L', 119041 => 'L', 119042 => 'L', 119043 => 'L', 119044 => 'L', 119045 => 'L', 119046 => 'L', 119047 => 'L', 119048 => 'L', 119049 => 'L', 119050 => 'L', 119051 => 'L', 119052 => 'L', 119053 => 'L', 119054 => 'L', 119055 => 'L', 119056 => 'L', 119057 => 'L', 119058 => 'L', 119059 => 'L', 119060 => 'L', 119061 => 'L', 119062 => 'L', 119063 => 'L', 119064 => 'L', 119065 => 'L', 119066 => 'L', 119067 => 'L', 119068 => 'L', 119069 => 'L', 119070 => 'L', 119071 => 'L', 119072 => 'L', 119073 => 'L', 119074 => 'L', 119075 => 'L', 119076 => 'L', 119077 => 'L', 119078 => 'L', 119082 => 'L', 119083 => 'L', 119084 => 'L', 119085 => 'L', 119086 => 'L', 119087 => 'L', 119088 => 'L', 119089 => 'L', 119090 => 'L', 119091 => 'L', 119092 => 'L', 119093 => 'L', 119094 => 'L', 119095 => 'L', 119096 => 'L', 119097 => 'L', 119098 => 'L', 119099 => 'L', 119100 => 'L', 119101 => 'L', 119102 => 'L', 119103 => 'L', 119104 => 'L', 119105 => 'L', 119106 => 'L', 119107 => 'L', 119108 => 'L', 119109 => 'L', 119110 => 'L', 119111 => 'L', 119112 => 'L', 119113 => 'L', 119114 => 'L', 119115 => 'L', 119116 => 'L', 119117 => 'L', 119118 => 'L', 119119 => 'L', 119120 => 'L', 119121 => 'L', 119122 => 'L', 119123 => 'L', 119124 => 'L', 119125 => 'L', 119126 => 'L', 119127 => 'L', 119128 => 'L', 119129 => 'L', 119130 => 'L', 119131 => 'L', 119132 => 'L', 119133 => 'L', 119134 => 'L', 119135 => 'L', 119136 => 'L', 119137 => 'L', 119138 => 'L', 119139 => 'L', 119140 => 'L', 119141 => 'L', 119142 => 'L', 119143 => 'NSM', 119144 => 'NSM', 119145 => 'NSM', 119146 => 'L', 119147 => 'L', 119148 => 'L', 119149 => 'L', 119150 => 'L', 119151 => 'L', 119152 => 'L', 119153 => 'L', 119154 => 'L', 119155 => 'BN', 119156 => 'BN', 119157 => 'BN', 119158 => 'BN', 119159 => 'BN', 119160 => 'BN', 119161 => 'BN', 119162 => 'BN', 119163 => 'NSM', 119164 => 'NSM', 119165 => 'NSM', 119166 => 'NSM', 119167 => 'NSM', 119168 => 'NSM', 119169 => 'NSM', 119170 => 'NSM', 119171 => 'L', 119172 => 'L', 119173 => 'NSM', 119174 => 'NSM', 119175 => 'NSM', 119176 => 'NSM', 119177 => 'NSM', 119178 => 'NSM', 119179 => 'NSM', 119180 => 'L', 119181 => 'L', 119182 => 'L', 119183 => 'L', 119184 => 'L', 119185 => 'L', 119186 => 'L', 119187 => 'L', 119188 => 'L', 119189 => 'L', 119190 => 'L', 119191 => 'L', 119192 => 'L', 119193 => 'L', 119194 => 'L', 119195 => 'L', 119196 => 'L', 119197 => 'L', 119198 => 'L', 119199 => 'L', 119200 => 'L', 119201 => 'L', 119202 => 'L', 119203 => 'L', 119204 => 'L', 119205 => 'L', 119206 => 'L', 119207 => 'L', 119208 => 'L', 119209 => 'L', 119210 => 'NSM', 119211 => 'NSM', 119212 => 'NSM', 119213 => 'NSM', 119214 => 'L', 119215 => 'L', 119216 => 'L', 119217 => 'L', 119218 => 'L', 119219 => 'L', 119220 => 'L', 119221 => 'L', 119222 => 'L', 119223 => 'L', 119224 => 'L', 119225 => 'L', 119226 => 'L', 119227 => 'L', 119228 => 'L', 119229 => 'L', 119230 => 'L', 119231 => 'L', 119232 => 'L', 119233 => 'L', 119234 => 'L', 119235 => 'L', 119236 => 'L', 119237 => 'L', 119238 => 'L', 119239 => 'L', 119240 => 'L', 119241 => 'L', 119242 => 'L', 119243 => 'L', 119244 => 'L', 119245 => 'L', 119246 => 'L', 119247 => 'L', 119248 => 'L', 119249 => 'L', 119250 => 'L', 119251 => 'L', 119252 => 'L', 119253 => 'L', 119254 => 'L', 119255 => 'L', 119256 => 'L', 119257 => 'L', 119258 => 'L', 119259 => 'L', 119260 => 'L', 119261 => 'L', 119296 => 'ON', 119297 => 'ON', 119298 => 'ON', 119299 => 'ON', 119300 => 'ON', 119301 => 'ON', 119302 => 'ON', 119303 => 'ON', 119304 => 'ON', 119305 => 'ON', 119306 => 'ON', 119307 => 'ON', 119308 => 'ON', 119309 => 'ON', 119310 => 'ON', 119311 => 'ON', 119312 => 'ON', 119313 => 'ON', 119314 => 'ON', 119315 => 'ON', 119316 => 'ON', 119317 => 'ON', 119318 => 'ON', 119319 => 'ON', 119320 => 'ON', 119321 => 'ON', 119322 => 'ON', 119323 => 'ON', 119324 => 'ON', 119325 => 'ON', 119326 => 'ON', 119327 => 'ON', 119328 => 'ON', 119329 => 'ON', 119330 => 'ON', 119331 => 'ON', 119332 => 'ON', 119333 => 'ON', 119334 => 'ON', 119335 => 'ON', 119336 => 'ON', 119337 => 'ON', 119338 => 'ON', 119339 => 'ON', 119340 => 'ON', 119341 => 'ON', 119342 => 'ON', 119343 => 'ON', 119344 => 'ON', 119345 => 'ON', 119346 => 'ON', 119347 => 'ON', 119348 => 'ON', 119349 => 'ON', 119350 => 'ON', 119351 => 'ON', 119352 => 'ON', 119353 => 'ON', 119354 => 'ON', 119355 => 'ON', 119356 => 'ON', 119357 => 'ON', 119358 => 'ON', 119359 => 'ON', 119360 => 'ON', 119361 => 'ON', 119362 => 'NSM', 119363 => 'NSM', 119364 => 'NSM', 119365 => 'ON', 119552 => 'ON', 119553 => 'ON', 119554 => 'ON', 119555 => 'ON', 119556 => 'ON', 119557 => 'ON', 119558 => 'ON', 119559 => 'ON', 119560 => 'ON', 119561 => 'ON', 119562 => 'ON', 119563 => 'ON', 119564 => 'ON', 119565 => 'ON', 119566 => 'ON', 119567 => 'ON', 119568 => 'ON', 119569 => 'ON', 119570 => 'ON', 119571 => 'ON', 119572 => 'ON', 119573 => 'ON', 119574 => 'ON', 119575 => 'ON', 119576 => 'ON', 119577 => 'ON', 119578 => 'ON', 119579 => 'ON', 119580 => 'ON', 119581 => 'ON', 119582 => 'ON', 119583 => 'ON', 119584 => 'ON', 119585 => 'ON', 119586 => 'ON', 119587 => 'ON', 119588 => 'ON', 119589 => 'ON', 119590 => 'ON', 119591 => 'ON', 119592 => 'ON', 119593 => 'ON', 119594 => 'ON', 119595 => 'ON', 119596 => 'ON', 119597 => 'ON', 119598 => 'ON', 119599 => 'ON', 119600 => 'ON', 119601 => 'ON', 119602 => 'ON', 119603 => 'ON', 119604 => 'ON', 119605 => 'ON', 119606 => 'ON', 119607 => 'ON', 119608 => 'ON', 119609 => 'ON', 119610 => 'ON', 119611 => 'ON', 119612 => 'ON', 119613 => 'ON', 119614 => 'ON', 119615 => 'ON', 119616 => 'ON', 119617 => 'ON', 119618 => 'ON', 119619 => 'ON', 119620 => 'ON', 119621 => 'ON', 119622 => 'ON', 119623 => 'ON', 119624 => 'ON', 119625 => 'ON', 119626 => 'ON', 119627 => 'ON', 119628 => 'ON', 119629 => 'ON', 119630 => 'ON', 119631 => 'ON', 119632 => 'ON', 119633 => 'ON', 119634 => 'ON', 119635 => 'ON', 119636 => 'ON', 119637 => 'ON', 119638 => 'ON', 119648 => 'L', 119649 => 'L', 119650 => 'L', 119651 => 'L', 119652 => 'L', 119653 => 'L', 119654 => 'L', 119655 => 'L', 119656 => 'L', 119657 => 'L', 119658 => 'L', 119659 => 'L', 119660 => 'L', 119661 => 'L', 119662 => 'L', 119663 => 'L', 119664 => 'L', 119665 => 'L', 119808 => 'L', 119809 => 'L', 119810 => 'L', 119811 => 'L', 119812 => 'L', 119813 => 'L', 119814 => 'L', 119815 => 'L', 119816 => 'L', 119817 => 'L', 119818 => 'L', 119819 => 'L', 119820 => 'L', 119821 => 'L', 119822 => 'L', 119823 => 'L', 119824 => 'L', 119825 => 'L', 119826 => 'L', 119827 => 'L', 119828 => 'L', 119829 => 'L', 119830 => 'L', 119831 => 'L', 119832 => 'L', 119833 => 'L', 119834 => 'L', 119835 => 'L', 119836 => 'L', 119837 => 'L', 119838 => 'L', 119839 => 'L', 119840 => 'L', 119841 => 'L', 119842 => 'L', 119843 => 'L', 119844 => 'L', 119845 => 'L', 119846 => 'L', 119847 => 'L', 119848 => 'L', 119849 => 'L', 119850 => 'L', 119851 => 'L', 119852 => 'L', 119853 => 'L', 119854 => 'L', 119855 => 'L', 119856 => 'L', 119857 => 'L', 119858 => 'L', 119859 => 'L', 119860 => 'L', 119861 => 'L', 119862 => 'L', 119863 => 'L', 119864 => 'L', 119865 => 'L', 119866 => 'L', 119867 => 'L', 119868 => 'L', 119869 => 'L', 119870 => 'L', 119871 => 'L', 119872 => 'L', 119873 => 'L', 119874 => 'L', 119875 => 'L', 119876 => 'L', 119877 => 'L', 119878 => 'L', 119879 => 'L', 119880 => 'L', 119881 => 'L', 119882 => 'L', 119883 => 'L', 119884 => 'L', 119885 => 'L', 119886 => 'L', 119887 => 'L', 119888 => 'L', 119889 => 'L', 119890 => 'L', 119891 => 'L', 119892 => 'L', 119894 => 'L', 119895 => 'L', 119896 => 'L', 119897 => 'L', 119898 => 'L', 119899 => 'L', 119900 => 'L', 119901 => 'L', 119902 => 'L', 119903 => 'L', 119904 => 'L', 119905 => 'L', 119906 => 'L', 119907 => 'L', 119908 => 'L', 119909 => 'L', 119910 => 'L', 119911 => 'L', 119912 => 'L', 119913 => 'L', 119914 => 'L', 119915 => 'L', 119916 => 'L', 119917 => 'L', 119918 => 'L', 119919 => 'L', 119920 => 'L', 119921 => 'L', 119922 => 'L', 119923 => 'L', 119924 => 'L', 119925 => 'L', 119926 => 'L', 119927 => 'L', 119928 => 'L', 119929 => 'L', 119930 => 'L', 119931 => 'L', 119932 => 'L', 119933 => 'L', 119934 => 'L', 119935 => 'L', 119936 => 'L', 119937 => 'L', 119938 => 'L', 119939 => 'L', 119940 => 'L', 119941 => 'L', 119942 => 'L', 119943 => 'L', 119944 => 'L', 119945 => 'L', 119946 => 'L', 119947 => 'L', 119948 => 'L', 119949 => 'L', 119950 => 'L', 119951 => 'L', 119952 => 'L', 119953 => 'L', 119954 => 'L', 119955 => 'L', 119956 => 'L', 119957 => 'L', 119958 => 'L', 119959 => 'L', 119960 => 'L', 119961 => 'L', 119962 => 'L', 119963 => 'L', 119964 => 'L', 119966 => 'L', 119967 => 'L', 119970 => 'L', 119973 => 'L', 119974 => 'L', 119977 => 'L', 119978 => 'L', 119979 => 'L', 119980 => 'L', 119982 => 'L', 119983 => 'L', 119984 => 'L', 119985 => 'L', 119986 => 'L', 119987 => 'L', 119988 => 'L', 119989 => 'L', 119990 => 'L', 119991 => 'L', 119992 => 'L', 119993 => 'L', 119995 => 'L', 119997 => 'L', 119998 => 'L', 119999 => 'L', 120000 => 'L', 120001 => 'L', 120002 => 'L', 120003 => 'L', 120005 => 'L', 120006 => 'L', 120007 => 'L', 120008 => 'L', 120009 => 'L', 120010 => 'L', 120011 => 'L', 120012 => 'L', 120013 => 'L', 120014 => 'L', 120015 => 'L', 120016 => 'L', 120017 => 'L', 120018 => 'L', 120019 => 'L', 120020 => 'L', 120021 => 'L', 120022 => 'L', 120023 => 'L', 120024 => 'L', 120025 => 'L', 120026 => 'L', 120027 => 'L', 120028 => 'L', 120029 => 'L', 120030 => 'L', 120031 => 'L', 120032 => 'L', 120033 => 'L', 120034 => 'L', 120035 => 'L', 120036 => 'L', 120037 => 'L', 120038 => 'L', 120039 => 'L', 120040 => 'L', 120041 => 'L', 120042 => 'L', 120043 => 'L', 120044 => 'L', 120045 => 'L', 120046 => 'L', 120047 => 'L', 120048 => 'L', 120049 => 'L', 120050 => 'L', 120051 => 'L', 120052 => 'L', 120053 => 'L', 120054 => 'L', 120055 => 'L', 120056 => 'L', 120057 => 'L', 120058 => 'L', 120059 => 'L', 120060 => 'L', 120061 => 'L', 120062 => 'L', 120063 => 'L', 120064 => 'L', 120065 => 'L', 120066 => 'L', 120067 => 'L', 120068 => 'L', 120069 => 'L', 120071 => 'L', 120072 => 'L', 120073 => 'L', 120074 => 'L', 120077 => 'L', 120078 => 'L', 120079 => 'L', 120080 => 'L', 120081 => 'L', 120082 => 'L', 120083 => 'L', 120084 => 'L', 120086 => 'L', 120087 => 'L', 120088 => 'L', 120089 => 'L', 120090 => 'L', 120091 => 'L', 120092 => 'L', 120094 => 'L', 120095 => 'L', 120096 => 'L', 120097 => 'L', 120098 => 'L', 120099 => 'L', 120100 => 'L', 120101 => 'L', 120102 => 'L', 120103 => 'L', 120104 => 'L', 120105 => 'L', 120106 => 'L', 120107 => 'L', 120108 => 'L', 120109 => 'L', 120110 => 'L', 120111 => 'L', 120112 => 'L', 120113 => 'L', 120114 => 'L', 120115 => 'L', 120116 => 'L', 120117 => 'L', 120118 => 'L', 120119 => 'L', 120120 => 'L', 120121 => 'L', 120123 => 'L', 120124 => 'L', 120125 => 'L', 120126 => 'L', 120128 => 'L', 120129 => 'L', 120130 => 'L', 120131 => 'L', 120132 => 'L', 120134 => 'L', 120138 => 'L', 120139 => 'L', 120140 => 'L', 120141 => 'L', 120142 => 'L', 120143 => 'L', 120144 => 'L', 120146 => 'L', 120147 => 'L', 120148 => 'L', 120149 => 'L', 120150 => 'L', 120151 => 'L', 120152 => 'L', 120153 => 'L', 120154 => 'L', 120155 => 'L', 120156 => 'L', 120157 => 'L', 120158 => 'L', 120159 => 'L', 120160 => 'L', 120161 => 'L', 120162 => 'L', 120163 => 'L', 120164 => 'L', 120165 => 'L', 120166 => 'L', 120167 => 'L', 120168 => 'L', 120169 => 'L', 120170 => 'L', 120171 => 'L', 120172 => 'L', 120173 => 'L', 120174 => 'L', 120175 => 'L', 120176 => 'L', 120177 => 'L', 120178 => 'L', 120179 => 'L', 120180 => 'L', 120181 => 'L', 120182 => 'L', 120183 => 'L', 120184 => 'L', 120185 => 'L', 120186 => 'L', 120187 => 'L', 120188 => 'L', 120189 => 'L', 120190 => 'L', 120191 => 'L', 120192 => 'L', 120193 => 'L', 120194 => 'L', 120195 => 'L', 120196 => 'L', 120197 => 'L', 120198 => 'L', 120199 => 'L', 120200 => 'L', 120201 => 'L', 120202 => 'L', 120203 => 'L', 120204 => 'L', 120205 => 'L', 120206 => 'L', 120207 => 'L', 120208 => 'L', 120209 => 'L', 120210 => 'L', 120211 => 'L', 120212 => 'L', 120213 => 'L', 120214 => 'L', 120215 => 'L', 120216 => 'L', 120217 => 'L', 120218 => 'L', 120219 => 'L', 120220 => 'L', 120221 => 'L', 120222 => 'L', 120223 => 'L', 120224 => 'L', 120225 => 'L', 120226 => 'L', 120227 => 'L', 120228 => 'L', 120229 => 'L', 120230 => 'L', 120231 => 'L', 120232 => 'L', 120233 => 'L', 120234 => 'L', 120235 => 'L', 120236 => 'L', 120237 => 'L', 120238 => 'L', 120239 => 'L', 120240 => 'L', 120241 => 'L', 120242 => 'L', 120243 => 'L', 120244 => 'L', 120245 => 'L', 120246 => 'L', 120247 => 'L', 120248 => 'L', 120249 => 'L', 120250 => 'L', 120251 => 'L', 120252 => 'L', 120253 => 'L', 120254 => 'L', 120255 => 'L', 120256 => 'L', 120257 => 'L', 120258 => 'L', 120259 => 'L', 120260 => 'L', 120261 => 'L', 120262 => 'L', 120263 => 'L', 120264 => 'L', 120265 => 'L', 120266 => 'L', 120267 => 'L', 120268 => 'L', 120269 => 'L', 120270 => 'L', 120271 => 'L', 120272 => 'L', 120273 => 'L', 120274 => 'L', 120275 => 'L', 120276 => 'L', 120277 => 'L', 120278 => 'L', 120279 => 'L', 120280 => 'L', 120281 => 'L', 120282 => 'L', 120283 => 'L', 120284 => 'L', 120285 => 'L', 120286 => 'L', 120287 => 'L', 120288 => 'L', 120289 => 'L', 120290 => 'L', 120291 => 'L', 120292 => 'L', 120293 => 'L', 120294 => 'L', 120295 => 'L', 120296 => 'L', 120297 => 'L', 120298 => 'L', 120299 => 'L', 120300 => 'L', 120301 => 'L', 120302 => 'L', 120303 => 'L', 120304 => 'L', 120305 => 'L', 120306 => 'L', 120307 => 'L', 120308 => 'L', 120309 => 'L', 120310 => 'L', 120311 => 'L', 120312 => 'L', 120313 => 'L', 120314 => 'L', 120315 => 'L', 120316 => 'L', 120317 => 'L', 120318 => 'L', 120319 => 'L', 120320 => 'L', 120321 => 'L', 120322 => 'L', 120323 => 'L', 120324 => 'L', 120325 => 'L', 120326 => 'L', 120327 => 'L', 120328 => 'L', 120329 => 'L', 120330 => 'L', 120331 => 'L', 120332 => 'L', 120333 => 'L', 120334 => 'L', 120335 => 'L', 120336 => 'L', 120337 => 'L', 120338 => 'L', 120339 => 'L', 120340 => 'L', 120341 => 'L', 120342 => 'L', 120343 => 'L', 120344 => 'L', 120345 => 'L', 120346 => 'L', 120347 => 'L', 120348 => 'L', 120349 => 'L', 120350 => 'L', 120351 => 'L', 120352 => 'L', 120353 => 'L', 120354 => 'L', 120355 => 'L', 120356 => 'L', 120357 => 'L', 120358 => 'L', 120359 => 'L', 120360 => 'L', 120361 => 'L', 120362 => 'L', 120363 => 'L', 120364 => 'L', 120365 => 'L', 120366 => 'L', 120367 => 'L', 120368 => 'L', 120369 => 'L', 120370 => 'L', 120371 => 'L', 120372 => 'L', 120373 => 'L', 120374 => 'L', 120375 => 'L', 120376 => 'L', 120377 => 'L', 120378 => 'L', 120379 => 'L', 120380 => 'L', 120381 => 'L', 120382 => 'L', 120383 => 'L', 120384 => 'L', 120385 => 'L', 120386 => 'L', 120387 => 'L', 120388 => 'L', 120389 => 'L', 120390 => 'L', 120391 => 'L', 120392 => 'L', 120393 => 'L', 120394 => 'L', 120395 => 'L', 120396 => 'L', 120397 => 'L', 120398 => 'L', 120399 => 'L', 120400 => 'L', 120401 => 'L', 120402 => 'L', 120403 => 'L', 120404 => 'L', 120405 => 'L', 120406 => 'L', 120407 => 'L', 120408 => 'L', 120409 => 'L', 120410 => 'L', 120411 => 'L', 120412 => 'L', 120413 => 'L', 120414 => 'L', 120415 => 'L', 120416 => 'L', 120417 => 'L', 120418 => 'L', 120419 => 'L', 120420 => 'L', 120421 => 'L', 120422 => 'L', 120423 => 'L', 120424 => 'L', 120425 => 'L', 120426 => 'L', 120427 => 'L', 120428 => 'L', 120429 => 'L', 120430 => 'L', 120431 => 'L', 120432 => 'L', 120433 => 'L', 120434 => 'L', 120435 => 'L', 120436 => 'L', 120437 => 'L', 120438 => 'L', 120439 => 'L', 120440 => 'L', 120441 => 'L', 120442 => 'L', 120443 => 'L', 120444 => 'L', 120445 => 'L', 120446 => 'L', 120447 => 'L', 120448 => 'L', 120449 => 'L', 120450 => 'L', 120451 => 'L', 120452 => 'L', 120453 => 'L', 120454 => 'L', 120455 => 'L', 120456 => 'L', 120457 => 'L', 120458 => 'L', 120459 => 'L', 120460 => 'L', 120461 => 'L', 120462 => 'L', 120463 => 'L', 120464 => 'L', 120465 => 'L', 120466 => 'L', 120467 => 'L', 120468 => 'L', 120469 => 'L', 120470 => 'L', 120471 => 'L', 120472 => 'L', 120473 => 'L', 120474 => 'L', 120475 => 'L', 120476 => 'L', 120477 => 'L', 120478 => 'L', 120479 => 'L', 120480 => 'L', 120481 => 'L', 120482 => 'L', 120483 => 'L', 120484 => 'L', 120485 => 'L', 120488 => 'L', 120489 => 'L', 120490 => 'L', 120491 => 'L', 120492 => 'L', 120493 => 'L', 120494 => 'L', 120495 => 'L', 120496 => 'L', 120497 => 'L', 120498 => 'L', 120499 => 'L', 120500 => 'L', 120501 => 'L', 120502 => 'L', 120503 => 'L', 120504 => 'L', 120505 => 'L', 120506 => 'L', 120507 => 'L', 120508 => 'L', 120509 => 'L', 120510 => 'L', 120511 => 'L', 120512 => 'L', 120513 => 'L', 120514 => 'L', 120515 => 'L', 120516 => 'L', 120517 => 'L', 120518 => 'L', 120519 => 'L', 120520 => 'L', 120521 => 'L', 120522 => 'L', 120523 => 'L', 120524 => 'L', 120525 => 'L', 120526 => 'L', 120527 => 'L', 120528 => 'L', 120529 => 'L', 120530 => 'L', 120531 => 'L', 120532 => 'L', 120533 => 'L', 120534 => 'L', 120535 => 'L', 120536 => 'L', 120537 => 'L', 120538 => 'L', 120539 => 'L', 120540 => 'L', 120541 => 'L', 120542 => 'L', 120543 => 'L', 120544 => 'L', 120545 => 'L', 120546 => 'L', 120547 => 'L', 120548 => 'L', 120549 => 'L', 120550 => 'L', 120551 => 'L', 120552 => 'L', 120553 => 'L', 120554 => 'L', 120555 => 'L', 120556 => 'L', 120557 => 'L', 120558 => 'L', 120559 => 'L', 120560 => 'L', 120561 => 'L', 120562 => 'L', 120563 => 'L', 120564 => 'L', 120565 => 'L', 120566 => 'L', 120567 => 'L', 120568 => 'L', 120569 => 'L', 120570 => 'L', 120571 => 'L', 120572 => 'L', 120573 => 'L', 120574 => 'L', 120575 => 'L', 120576 => 'L', 120577 => 'L', 120578 => 'L', 120579 => 'L', 120580 => 'L', 120581 => 'L', 120582 => 'L', 120583 => 'L', 120584 => 'L', 120585 => 'L', 120586 => 'L', 120587 => 'L', 120588 => 'L', 120589 => 'L', 120590 => 'L', 120591 => 'L', 120592 => 'L', 120593 => 'L', 120594 => 'L', 120595 => 'L', 120596 => 'L', 120597 => 'L', 120598 => 'L', 120599 => 'L', 120600 => 'L', 120601 => 'L', 120602 => 'L', 120603 => 'L', 120604 => 'L', 120605 => 'L', 120606 => 'L', 120607 => 'L', 120608 => 'L', 120609 => 'L', 120610 => 'L', 120611 => 'L', 120612 => 'L', 120613 => 'L', 120614 => 'L', 120615 => 'L', 120616 => 'L', 120617 => 'L', 120618 => 'L', 120619 => 'L', 120620 => 'L', 120621 => 'L', 120622 => 'L', 120623 => 'L', 120624 => 'L', 120625 => 'L', 120626 => 'L', 120627 => 'L', 120628 => 'L', 120629 => 'L', 120630 => 'L', 120631 => 'L', 120632 => 'L', 120633 => 'L', 120634 => 'L', 120635 => 'L', 120636 => 'L', 120637 => 'L', 120638 => 'L', 120639 => 'L', 120640 => 'L', 120641 => 'L', 120642 => 'L', 120643 => 'L', 120644 => 'L', 120645 => 'L', 120646 => 'L', 120647 => 'L', 120648 => 'L', 120649 => 'L', 120650 => 'L', 120651 => 'L', 120652 => 'L', 120653 => 'L', 120654 => 'L', 120655 => 'L', 120656 => 'L', 120657 => 'L', 120658 => 'L', 120659 => 'L', 120660 => 'L', 120661 => 'L', 120662 => 'L', 120663 => 'L', 120664 => 'L', 120665 => 'L', 120666 => 'L', 120667 => 'L', 120668 => 'L', 120669 => 'L', 120670 => 'L', 120671 => 'L', 120672 => 'L', 120673 => 'L', 120674 => 'L', 120675 => 'L', 120676 => 'L', 120677 => 'L', 120678 => 'L', 120679 => 'L', 120680 => 'L', 120681 => 'L', 120682 => 'L', 120683 => 'L', 120684 => 'L', 120685 => 'L', 120686 => 'L', 120687 => 'L', 120688 => 'L', 120689 => 'L', 120690 => 'L', 120691 => 'L', 120692 => 'L', 120693 => 'L', 120694 => 'L', 120695 => 'L', 120696 => 'L', 120697 => 'L', 120698 => 'L', 120699 => 'L', 120700 => 'L', 120701 => 'L', 120702 => 'L', 120703 => 'L', 120704 => 'L', 120705 => 'L', 120706 => 'L', 120707 => 'L', 120708 => 'L', 120709 => 'L', 120710 => 'L', 120711 => 'L', 120712 => 'L', 120713 => 'L', 120714 => 'L', 120715 => 'L', 120716 => 'L', 120717 => 'L', 120718 => 'L', 120719 => 'L', 120720 => 'L', 120721 => 'L', 120722 => 'L', 120723 => 'L', 120724 => 'L', 120725 => 'L', 120726 => 'L', 120727 => 'L', 120728 => 'L', 120729 => 'L', 120730 => 'L', 120731 => 'L', 120732 => 'L', 120733 => 'L', 120734 => 'L', 120735 => 'L', 120736 => 'L', 120737 => 'L', 120738 => 'L', 120739 => 'L', 120740 => 'L', 120741 => 'L', 120742 => 'L', 120743 => 'L', 120744 => 'L', 120745 => 'L', 120746 => 'L', 120747 => 'L', 120748 => 'L', 120749 => 'L', 120750 => 'L', 120751 => 'L', 120752 => 'L', 120753 => 'L', 120754 => 'L', 120755 => 'L', 120756 => 'L', 120757 => 'L', 120758 => 'L', 120759 => 'L', 120760 => 'L', 120761 => 'L', 120762 => 'L', 120763 => 'L', 120764 => 'L', 120765 => 'L', 120766 => 'L', 120767 => 'L', 120768 => 'L', 120769 => 'L', 120770 => 'L', 120771 => 'L', 120772 => 'L', 120773 => 'L', 120774 => 'L', 120775 => 'L', 120776 => 'L', 120777 => 'L', 120778 => 'L', 120779 => 'L', 120782 => 'EN', 120783 => 'EN', 120784 => 'EN', 120785 => 'EN', 120786 => 'EN', 120787 => 'EN', 120788 => 'EN', 120789 => 'EN', 120790 => 'EN', 120791 => 'EN', 120792 => 'EN', 120793 => 'EN', 120794 => 'EN', 120795 => 'EN', 120796 => 'EN', 120797 => 'EN', 120798 => 'EN', 120799 => 'EN', 120800 => 'EN', 120801 => 'EN', 120802 => 'EN', 120803 => 'EN', 120804 => 'EN', 120805 => 'EN', 120806 => 'EN', 120807 => 'EN', 120808 => 'EN', 120809 => 'EN', 120810 => 'EN', 120811 => 'EN', 120812 => 'EN', 120813 => 'EN', 120814 => 'EN', 120815 => 'EN', 120816 => 'EN', 120817 => 'EN', 120818 => 'EN', 120819 => 'EN', 120820 => 'EN', 120821 => 'EN', 120822 => 'EN', 120823 => 'EN', 120824 => 'EN', 120825 => 'EN', 120826 => 'EN', 120827 => 'EN', 120828 => 'EN', 120829 => 'EN', 120830 => 'EN', 120831 => 'EN', 131072 => 'L', 173782 => 'L', 194560 => 'L', 194561 => 'L', 194562 => 'L', 194563 => 'L', 194564 => 'L', 194565 => 'L', 194566 => 'L', 194567 => 'L', 194568 => 'L', 194569 => 'L', 194570 => 'L', 194571 => 'L', 194572 => 'L', 194573 => 'L', 194574 => 'L', 194575 => 'L', 194576 => 'L', 194577 => 'L', 194578 => 'L', 194579 => 'L', 194580 => 'L', 194581 => 'L', 194582 => 'L', 194583 => 'L', 194584 => 'L', 194585 => 'L', 194586 => 'L', 194587 => 'L', 194588 => 'L', 194589 => 'L', 194590 => 'L', 194591 => 'L', 194592 => 'L', 194593 => 'L', 194594 => 'L', 194595 => 'L', 194596 => 'L', 194597 => 'L', 194598 => 'L', 194599 => 'L', 194600 => 'L', 194601 => 'L', 194602 => 'L', 194603 => 'L', 194604 => 'L', 194605 => 'L', 194606 => 'L', 194607 => 'L', 194608 => 'L', 194609 => 'L', 194610 => 'L', 194611 => 'L', 194612 => 'L', 194613 => 'L', 194614 => 'L', 194615 => 'L', 194616 => 'L', 194617 => 'L', 194618 => 'L', 194619 => 'L', 194620 => 'L', 194621 => 'L', 194622 => 'L', 194623 => 'L', 194624 => 'L', 194625 => 'L', 194626 => 'L', 194627 => 'L', 194628 => 'L', 194629 => 'L', 194630 => 'L', 194631 => 'L', 194632 => 'L', 194633 => 'L', 194634 => 'L', 194635 => 'L', 194636 => 'L', 194637 => 'L', 194638 => 'L', 194639 => 'L', 194640 => 'L', 194641 => 'L', 194642 => 'L', 194643 => 'L', 194644 => 'L', 194645 => 'L', 194646 => 'L', 194647 => 'L', 194648 => 'L', 194649 => 'L', 194650 => 'L', 194651 => 'L', 194652 => 'L', 194653 => 'L', 194654 => 'L', 194655 => 'L', 194656 => 'L', 194657 => 'L', 194658 => 'L', 194659 => 'L', 194660 => 'L', 194661 => 'L', 194662 => 'L', 194663 => 'L', 194664 => 'L', 194665 => 'L', 194666 => 'L', 194667 => 'L', 194668 => 'L', 194669 => 'L', 194670 => 'L', 194671 => 'L', 194672 => 'L', 194673 => 'L', 194674 => 'L', 194675 => 'L', 194676 => 'L', 194677 => 'L', 194678 => 'L', 194679 => 'L', 194680 => 'L', 194681 => 'L', 194682 => 'L', 194683 => 'L', 194684 => 'L', 194685 => 'L', 194686 => 'L', 194687 => 'L', 194688 => 'L', 194689 => 'L', 194690 => 'L', 194691 => 'L', 194692 => 'L', 194693 => 'L', 194694 => 'L', 194695 => 'L', 194696 => 'L', 194697 => 'L', 194698 => 'L', 194699 => 'L', 194700 => 'L', 194701 => 'L', 194702 => 'L', 194703 => 'L', 194704 => 'L', 194705 => 'L', 194706 => 'L', 194707 => 'L', 194708 => 'L', 194709 => 'L', 194710 => 'L', 194711 => 'L', 194712 => 'L', 194713 => 'L', 194714 => 'L', 194715 => 'L', 194716 => 'L', 194717 => 'L', 194718 => 'L', 194719 => 'L', 194720 => 'L', 194721 => 'L', 194722 => 'L', 194723 => 'L', 194724 => 'L', 194725 => 'L', 194726 => 'L', 194727 => 'L', 194728 => 'L', 194729 => 'L', 194730 => 'L', 194731 => 'L', 194732 => 'L', 194733 => 'L', 194734 => 'L', 194735 => 'L', 194736 => 'L', 194737 => 'L', 194738 => 'L', 194739 => 'L', 194740 => 'L', 194741 => 'L', 194742 => 'L', 194743 => 'L', 194744 => 'L', 194745 => 'L', 194746 => 'L', 194747 => 'L', 194748 => 'L', 194749 => 'L', 194750 => 'L', 194751 => 'L', 194752 => 'L', 194753 => 'L', 194754 => 'L', 194755 => 'L', 194756 => 'L', 194757 => 'L', 194758 => 'L', 194759 => 'L', 194760 => 'L', 194761 => 'L', 194762 => 'L', 194763 => 'L', 194764 => 'L', 194765 => 'L', 194766 => 'L', 194767 => 'L', 194768 => 'L', 194769 => 'L', 194770 => 'L', 194771 => 'L', 194772 => 'L', 194773 => 'L', 194774 => 'L', 194775 => 'L', 194776 => 'L', 194777 => 'L', 194778 => 'L', 194779 => 'L', 194780 => 'L', 194781 => 'L', 194782 => 'L', 194783 => 'L', 194784 => 'L', 194785 => 'L', 194786 => 'L', 194787 => 'L', 194788 => 'L', 194789 => 'L', 194790 => 'L', 194791 => 'L', 194792 => 'L', 194793 => 'L', 194794 => 'L', 194795 => 'L', 194796 => 'L', 194797 => 'L', 194798 => 'L', 194799 => 'L', 194800 => 'L', 194801 => 'L', 194802 => 'L', 194803 => 'L', 194804 => 'L', 194805 => 'L', 194806 => 'L', 194807 => 'L', 194808 => 'L', 194809 => 'L', 194810 => 'L', 194811 => 'L', 194812 => 'L', 194813 => 'L', 194814 => 'L', 194815 => 'L', 194816 => 'L', 194817 => 'L', 194818 => 'L', 194819 => 'L', 194820 => 'L', 194821 => 'L', 194822 => 'L', 194823 => 'L', 194824 => 'L', 194825 => 'L', 194826 => 'L', 194827 => 'L', 194828 => 'L', 194829 => 'L', 194830 => 'L', 194831 => 'L', 194832 => 'L', 194833 => 'L', 194834 => 'L', 194835 => 'L', 194836 => 'L', 194837 => 'L', 194838 => 'L', 194839 => 'L', 194840 => 'L', 194841 => 'L', 194842 => 'L', 194843 => 'L', 194844 => 'L', 194845 => 'L', 194846 => 'L', 194847 => 'L', 194848 => 'L', 194849 => 'L', 194850 => 'L', 194851 => 'L', 194852 => 'L', 194853 => 'L', 194854 => 'L', 194855 => 'L', 194856 => 'L', 194857 => 'L', 194858 => 'L', 194859 => 'L', 194860 => 'L', 194861 => 'L', 194862 => 'L', 194863 => 'L', 194864 => 'L', 194865 => 'L', 194866 => 'L', 194867 => 'L', 194868 => 'L', 194869 => 'L', 194870 => 'L', 194871 => 'L', 194872 => 'L', 194873 => 'L', 194874 => 'L', 194875 => 'L', 194876 => 'L', 194877 => 'L', 194878 => 'L', 194879 => 'L', 194880 => 'L', 194881 => 'L', 194882 => 'L', 194883 => 'L', 194884 => 'L', 194885 => 'L', 194886 => 'L', 194887 => 'L', 194888 => 'L', 194889 => 'L', 194890 => 'L', 194891 => 'L', 194892 => 'L', 194893 => 'L', 194894 => 'L', 194895 => 'L', 194896 => 'L', 194897 => 'L', 194898 => 'L', 194899 => 'L', 194900 => 'L', 194901 => 'L', 194902 => 'L', 194903 => 'L', 194904 => 'L', 194905 => 'L', 194906 => 'L', 194907 => 'L', 194908 => 'L', 194909 => 'L', 194910 => 'L', 194911 => 'L', 194912 => 'L', 194913 => 'L', 194914 => 'L', 194915 => 'L', 194916 => 'L', 194917 => 'L', 194918 => 'L', 194919 => 'L', 194920 => 'L', 194921 => 'L', 194922 => 'L', 194923 => 'L', 194924 => 'L', 194925 => 'L', 194926 => 'L', 194927 => 'L', 194928 => 'L', 194929 => 'L', 194930 => 'L', 194931 => 'L', 194932 => 'L', 194933 => 'L', 194934 => 'L', 194935 => 'L', 194936 => 'L', 194937 => 'L', 194938 => 'L', 194939 => 'L', 194940 => 'L', 194941 => 'L', 194942 => 'L', 194943 => 'L', 194944 => 'L', 194945 => 'L', 194946 => 'L', 194947 => 'L', 194948 => 'L', 194949 => 'L', 194950 => 'L', 194951 => 'L', 194952 => 'L', 194953 => 'L', 194954 => 'L', 194955 => 'L', 194956 => 'L', 194957 => 'L', 194958 => 'L', 194959 => 'L', 194960 => 'L', 194961 => 'L', 194962 => 'L', 194963 => 'L', 194964 => 'L', 194965 => 'L', 194966 => 'L', 194967 => 'L', 194968 => 'L', 194969 => 'L', 194970 => 'L', 194971 => 'L', 194972 => 'L', 194973 => 'L', 194974 => 'L', 194975 => 'L', 194976 => 'L', 194977 => 'L', 194978 => 'L', 194979 => 'L', 194980 => 'L', 194981 => 'L', 194982 => 'L', 194983 => 'L', 194984 => 'L', 194985 => 'L', 194986 => 'L', 194987 => 'L', 194988 => 'L', 194989 => 'L', 194990 => 'L', 194991 => 'L', 194992 => 'L', 194993 => 'L', 194994 => 'L', 194995 => 'L', 194996 => 'L', 194997 => 'L', 194998 => 'L', 194999 => 'L', 195000 => 'L', 195001 => 'L', 195002 => 'L', 195003 => 'L', 195004 => 'L', 195005 => 'L', 195006 => 'L', 195007 => 'L', 195008 => 'L', 195009 => 'L', 195010 => 'L', 195011 => 'L', 195012 => 'L', 195013 => 'L', 195014 => 'L', 195015 => 'L', 195016 => 'L', 195017 => 'L', 195018 => 'L', 195019 => 'L', 195020 => 'L', 195021 => 'L', 195022 => 'L', 195023 => 'L', 195024 => 'L', 195025 => 'L', 195026 => 'L', 195027 => 'L', 195028 => 'L', 195029 => 'L', 195030 => 'L', 195031 => 'L', 195032 => 'L', 195033 => 'L', 195034 => 'L', 195035 => 'L', 195036 => 'L', 195037 => 'L', 195038 => 'L', 195039 => 'L', 195040 => 'L', 195041 => 'L', 195042 => 'L', 195043 => 'L', 195044 => 'L', 195045 => 'L', 195046 => 'L', 195047 => 'L', 195048 => 'L', 195049 => 'L', 195050 => 'L', 195051 => 'L', 195052 => 'L', 195053 => 'L', 195054 => 'L', 195055 => 'L', 195056 => 'L', 195057 => 'L', 195058 => 'L', 195059 => 'L', 195060 => 'L', 195061 => 'L', 195062 => 'L', 195063 => 'L', 195064 => 'L', 195065 => 'L', 195066 => 'L', 195067 => 'L', 195068 => 'L', 195069 => 'L', 195070 => 'L', 195071 => 'L', 195072 => 'L', 195073 => 'L', 195074 => 'L', 195075 => 'L', 195076 => 'L', 195077 => 'L', 195078 => 'L', 195079 => 'L', 195080 => 'L', 195081 => 'L', 195082 => 'L', 195083 => 'L', 195084 => 'L', 195085 => 'L', 195086 => 'L', 195087 => 'L', 195088 => 'L', 195089 => 'L', 195090 => 'L', 195091 => 'L', 195092 => 'L', 195093 => 'L', 195094 => 'L', 195095 => 'L', 195096 => 'L', 195097 => 'L', 195098 => 'L', 195099 => 'L', 195100 => 'L', 195101 => 'L', 917505 => 'BN', 917536 => 'BN', 917537 => 'BN', 917538 => 'BN', 917539 => 'BN', 917540 => 'BN', 917541 => 'BN', 917542 => 'BN', 917543 => 'BN', 917544 => 'BN', 917545 => 'BN', 917546 => 'BN', 917547 => 'BN', 917548 => 'BN', 917549 => 'BN', 917550 => 'BN', 917551 => 'BN', 917552 => 'BN', 917553 => 'BN', 917554 => 'BN', 917555 => 'BN', 917556 => 'BN', 917557 => 'BN', 917558 => 'BN', 917559 => 'BN', 917560 => 'BN', 917561 => 'BN', 917562 => 'BN', 917563 => 'BN', 917564 => 'BN', 917565 => 'BN', 917566 => 'BN', 917567 => 'BN', 917568 => 'BN', 917569 => 'BN', 917570 => 'BN', 917571 => 'BN', 917572 => 'BN', 917573 => 'BN', 917574 => 'BN', 917575 => 'BN', 917576 => 'BN', 917577 => 'BN', 917578 => 'BN', 917579 => 'BN', 917580 => 'BN', 917581 => 'BN', 917582 => 'BN', 917583 => 'BN', 917584 => 'BN', 917585 => 'BN', 917586 => 'BN', 917587 => 'BN', 917588 => 'BN', 917589 => 'BN', 917590 => 'BN', 917591 => 'BN', 917592 => 'BN', 917593 => 'BN', 917594 => 'BN', 917595 => 'BN', 917596 => 'BN', 917597 => 'BN', 917598 => 'BN', 917599 => 'BN', 917600 => 'BN', 917601 => 'BN', 917602 => 'BN', 917603 => 'BN', 917604 => 'BN', 917605 => 'BN', 917606 => 'BN', 917607 => 'BN', 917608 => 'BN', 917609 => 'BN', 917610 => 'BN', 917611 => 'BN', 917612 => 'BN', 917613 => 'BN', 917614 => 'BN', 917615 => 'BN', 917616 => 'BN', 917617 => 'BN', 917618 => 'BN', 917619 => 'BN', 917620 => 'BN', 917621 => 'BN', 917622 => 'BN', 917623 => 'BN', 917624 => 'BN', 917625 => 'BN', 917626 => 'BN', 917627 => 'BN', 917628 => 'BN', 917629 => 'BN', 917630 => 'BN', 917631 => 'BN', 917760 => 'NSM', 917761 => 'NSM', 917762 => 'NSM', 917763 => 'NSM', 917764 => 'NSM', 917765 => 'NSM', 917766 => 'NSM', 917767 => 'NSM', 917768 => 'NSM', 917769 => 'NSM', 917770 => 'NSM', 917771 => 'NSM', 917772 => 'NSM', 917773 => 'NSM', 917774 => 'NSM', 917775 => 'NSM', 917776 => 'NSM', 917777 => 'NSM', 917778 => 'NSM', 917779 => 'NSM', 917780 => 'NSM', 917781 => 'NSM', 917782 => 'NSM', 917783 => 'NSM', 917784 => 'NSM', 917785 => 'NSM', 917786 => 'NSM', 917787 => 'NSM', 917788 => 'NSM', 917789 => 'NSM', 917790 => 'NSM', 917791 => 'NSM', 917792 => 'NSM', 917793 => 'NSM', 917794 => 'NSM', 917795 => 'NSM', 917796 => 'NSM', 917797 => 'NSM', 917798 => 'NSM', 917799 => 'NSM', 917800 => 'NSM', 917801 => 'NSM', 917802 => 'NSM', 917803 => 'NSM', 917804 => 'NSM', 917805 => 'NSM', 917806 => 'NSM', 917807 => 'NSM', 917808 => 'NSM', 917809 => 'NSM', 917810 => 'NSM', 917811 => 'NSM', 917812 => 'NSM', 917813 => 'NSM', 917814 => 'NSM', 917815 => 'NSM', 917816 => 'NSM', 917817 => 'NSM', 917818 => 'NSM', 917819 => 'NSM', 917820 => 'NSM', 917821 => 'NSM', 917822 => 'NSM', 917823 => 'NSM', 917824 => 'NSM', 917825 => 'NSM', 917826 => 'NSM', 917827 => 'NSM', 917828 => 'NSM', 917829 => 'NSM', 917830 => 'NSM', 917831 => 'NSM', 917832 => 'NSM', 917833 => 'NSM', 917834 => 'NSM', 917835 => 'NSM', 917836 => 'NSM', 917837 => 'NSM', 917838 => 'NSM', 917839 => 'NSM', 917840 => 'NSM', 917841 => 'NSM', 917842 => 'NSM', 917843 => 'NSM', 917844 => 'NSM', 917845 => 'NSM', 917846 => 'NSM', 917847 => 'NSM', 917848 => 'NSM', 917849 => 'NSM', 917850 => 'NSM', 917851 => 'NSM', 917852 => 'NSM', 917853 => 'NSM', 917854 => 'NSM', 917855 => 'NSM', 917856 => 'NSM', 917857 => 'NSM', 917858 => 'NSM', 917859 => 'NSM', 917860 => 'NSM', 917861 => 'NSM', 917862 => 'NSM', 917863 => 'NSM', 917864 => 'NSM', 917865 => 'NSM', 917866 => 'NSM', 917867 => 'NSM', 917868 => 'NSM', 917869 => 'NSM', 917870 => 'NSM', 917871 => 'NSM', 917872 => 'NSM', 917873 => 'NSM', 917874 => 'NSM', 917875 => 'NSM', 917876 => 'NSM', 917877 => 'NSM', 917878 => 'NSM', 917879 => 'NSM', 917880 => 'NSM', 917881 => 'NSM', 917882 => 'NSM', 917883 => 'NSM', 917884 => 'NSM', 917885 => 'NSM', 917886 => 'NSM', 917887 => 'NSM', 917888 => 'NSM', 917889 => 'NSM', 917890 => 'NSM', 917891 => 'NSM', 917892 => 'NSM', 917893 => 'NSM', 917894 => 'NSM', 917895 => 'NSM', 917896 => 'NSM', 917897 => 'NSM', 917898 => 'NSM', 917899 => 'NSM', 917900 => 'NSM', 917901 => 'NSM', 917902 => 'NSM', 917903 => 'NSM', 917904 => 'NSM', 917905 => 'NSM', 917906 => 'NSM', 917907 => 'NSM', 917908 => 'NSM', 917909 => 'NSM', 917910 => 'NSM', 917911 => 'NSM', 917912 => 'NSM', 917913 => 'NSM', 917914 => 'NSM', 917915 => 'NSM', 917916 => 'NSM', 917917 => 'NSM', 917918 => 'NSM', 917919 => 'NSM', 917920 => 'NSM', 917921 => 'NSM', 917922 => 'NSM', 917923 => 'NSM', 917924 => 'NSM', 917925 => 'NSM', 917926 => 'NSM', 917927 => 'NSM', 917928 => 'NSM', 917929 => 'NSM', 917930 => 'NSM', 917931 => 'NSM', 917932 => 'NSM', 917933 => 'NSM', 917934 => 'NSM', 917935 => 'NSM', 917936 => 'NSM', 917937 => 'NSM', 917938 => 'NSM', 917939 => 'NSM', 917940 => 'NSM', 917941 => 'NSM', 917942 => 'NSM', 917943 => 'NSM', 917944 => 'NSM', 917945 => 'NSM', 917946 => 'NSM', 917947 => 'NSM', 917948 => 'NSM', 917949 => 'NSM', 917950 => 'NSM', 917951 => 'NSM', 917952 => 'NSM', 917953 => 'NSM', 917954 => 'NSM', 917955 => 'NSM', 917956 => 'NSM', 917957 => 'NSM', 917958 => 'NSM', 917959 => 'NSM', 917960 => 'NSM', 917961 => 'NSM', 917962 => 'NSM', 917963 => 'NSM', 917964 => 'NSM', 917965 => 'NSM', 917966 => 'NSM', 917967 => 'NSM', 917968 => 'NSM', 917969 => 'NSM', 917970 => 'NSM', 917971 => 'NSM', 917972 => 'NSM', 917973 => 'NSM', 917974 => 'NSM', 917975 => 'NSM', 917976 => 'NSM', 917977 => 'NSM', 917978 => 'NSM', 917979 => 'NSM', 917980 => 'NSM', 917981 => 'NSM', 917982 => 'NSM', 917983 => 'NSM', 917984 => 'NSM', 917985 => 'NSM', 917986 => 'NSM', 917987 => 'NSM', 917988 => 'NSM', 917989 => 'NSM', 917990 => 'NSM', 917991 => 'NSM', 917992 => 'NSM', 917993 => 'NSM', 917994 => 'NSM', 917995 => 'NSM', 917996 => 'NSM', 917997 => 'NSM', 917998 => 'NSM', 917999 => 'NSM', 983040 => 'L', 1048573 => 'L', 1048576 => 'L', 1114109 => 'L');
/**
* Mirror unicode characters. For information on bidi mirroring, see UAX #9: Bidirectional Algorithm, at http://www.unicode.org/unicode/reports/tr9/
* @public
*/
public static $uni_mirror = array(0x28 => 0x29, 0x29 => 0x28, 0x3c => 0x3e, 0x3e => 0x3c, 0x5b => 0x5d, 0x5d => 0x5b, 0x7b => 0x7d, 0x7d => 0x7b, 0xab => 0xbb, 0xbb => 0xab, 0xf3a => 0xf3b, 0xf3b => 0xf3a, 0xf3c => 0xf3d, 0xf3d => 0xf3c, 0x169b => 0x169c, 0x169c => 0x169b, 0x2018 => 0x2019, 0x2019 => 0x2018, 0x201c => 0x201d, 0x201d => 0x201c, 0x2039 => 0x203a, 0x203a => 0x2039, 0x2045 => 0x2046, 0x2046 => 0x2045, 0x207d => 0x207e, 0x207e => 0x207d, 0x208d => 0x208e, 0x208e => 0x208d, 0x2208 => 0x220b, 0x2209 => 0x220c, 0x220a => 0x220d, 0x220b => 0x2208, 0x220c => 0x2209, 0x220d => 0x220a, 0x2215 => 0x29f5, 0x223c => 0x223d, 0x223d => 0x223c, 0x2243 => 0x22cd, 0x2252 => 0x2253, 0x2253 => 0x2252, 0x2254 => 0x2255, 0x2255 => 0x2254, 0x2264 => 0x2265, 0x2265 => 0x2264, 0x2266 => 0x2267, 0x2267 => 0x2266, 0x2268 => 0x2269, 0x2269 => 0x2268, 0x226a => 0x226b, 0x226b => 0x226a, 0x226e => 0x226f, 0x226f => 0x226e, 0x2270 => 0x2271, 0x2271 => 0x2270, 0x2272 => 0x2273, 0x2273 => 0x2272, 0x2274 => 0x2275, 0x2275 => 0x2274, 0x2276 => 0x2277, 0x2277 => 0x2276, 0x2278 => 0x2279, 0x2279 => 0x2278, 0x227a => 0x227b, 0x227b => 0x227a, 0x227c => 0x227d, 0x227d => 0x227c, 0x227e => 0x227f, 0x227f => 0x227e, 0x2280 => 0x2281, 0x2281 => 0x2280, 0x2282 => 0x2283, 0x2283 => 0x2282, 0x2284 => 0x2285, 0x2285 => 0x2284, 0x2286 => 0x2287, 0x2287 => 0x2286, 0x2288 => 0x2289, 0x2289 => 0x2288, 0x228a => 0x228b, 0x228b => 0x228a, 0x228f => 0x2290, 0x2290 => 0x228f, 0x2291 => 0x2292, 0x2292 => 0x2291, 0x2298 => 0x29b8, 0x22a2 => 0x22a3, 0x22a3 => 0x22a2, 0x22a6 => 0x2ade, 0x22a8 => 0x2ae4, 0x22a9 => 0x2ae3, 0x22ab => 0x2ae5, 0x22b0 => 0x22b1, 0x22b1 => 0x22b0, 0x22b2 => 0x22b3, 0x22b3 => 0x22b2, 0x22b4 => 0x22b5, 0x22b5 => 0x22b4, 0x22b6 => 0x22b7, 0x22b7 => 0x22b6, 0x22c9 => 0x22ca, 0x22ca => 0x22c9, 0x22cb => 0x22cc, 0x22cc => 0x22cb, 0x22cd => 0x2243, 0x22d0 => 0x22d1, 0x22d1 => 0x22d0, 0x22d6 => 0x22d7, 0x22d7 => 0x22d6, 0x22d8 => 0x22d9, 0x22d9 => 0x22d8, 0x22da => 0x22db, 0x22db => 0x22da, 0x22dc => 0x22dd, 0x22dd => 0x22dc, 0x22de => 0x22df, 0x22df => 0x22de, 0x22e0 => 0x22e1, 0x22e1 => 0x22e0, 0x22e2 => 0x22e3, 0x22e3 => 0x22e2, 0x22e4 => 0x22e5, 0x22e5 => 0x22e4, 0x22e6 => 0x22e7, 0x22e7 => 0x22e6, 0x22e8 => 0x22e9, 0x22e9 => 0x22e8, 0x22ea => 0x22eb, 0x22eb => 0x22ea, 0x22ec => 0x22ed, 0x22ed => 0x22ec, 0x22f0 => 0x22f1, 0x22f1 => 0x22f0, 0x22f2 => 0x22fa, 0x22f3 => 0x22fb, 0x22f4 => 0x22fc, 0x22f6 => 0x22fd, 0x22f7 => 0x22fe, 0x22fa => 0x22f2, 0x22fb => 0x22f3, 0x22fc => 0x22f4, 0x22fd => 0x22f6, 0x22fe => 0x22f7, 0x2308 => 0x2309, 0x2309 => 0x2308, 0x230a => 0x230b, 0x230b => 0x230a, 0x2329 => 0x232a, 0x232a => 0x2329, 0x2768 => 0x2769, 0x2769 => 0x2768, 0x276a => 0x276b, 0x276b => 0x276a, 0x276c => 0x276d, 0x276d => 0x276c, 0x276e => 0x276f, 0x276f => 0x276e, 0x2770 => 0x2771, 0x2771 => 0x2770, 0x2772 => 0x2773, 0x2773 => 0x2772, 0x2774 => 0x2775, 0x2775 => 0x2774, 0x27c3 => 0x27c4, 0x27c4 => 0x27c3, 0x27c5 => 0x27c6, 0x27c6 => 0x27c5, 0x27d5 => 0x27d6, 0x27d6 => 0x27d5, 0x27dd => 0x27de, 0x27de => 0x27dd, 0x27e2 => 0x27e3, 0x27e3 => 0x27e2, 0x27e4 => 0x27e5, 0x27e5 => 0x27e4, 0x27e6 => 0x27e7, 0x27e7 => 0x27e6, 0x27e8 => 0x27e9, 0x27e9 => 0x27e8, 0x27ea => 0x27eb, 0x27eb => 0x27ea, 0x2983 => 0x2984, 0x2984 => 0x2983, 0x2985 => 0x2986, 0x2986 => 0x2985, 0x2987 => 0x2988, 0x2988 => 0x2987, 0x2989 => 0x298a, 0x298a => 0x2989, 0x298b => 0x298c, 0x298c => 0x298b, 0x298d => 0x2990, 0x298e => 0x298f, 0x298f => 0x298e, 0x2990 => 0x298d, 0x2991 => 0x2992, 0x2992 => 0x2991, 0x2993 => 0x2994, 0x2994 => 0x2993, 0x2995 => 0x2996, 0x2996 => 0x2995, 0x2997 => 0x2998, 0x2998 => 0x2997, 0x29b8 => 0x2298, 0x29c0 => 0x29c1, 0x29c1 => 0x29c0, 0x29c4 => 0x29c5, 0x29c5 => 0x29c4, 0x29cf => 0x29d0, 0x29d0 => 0x29cf, 0x29d1 => 0x29d2, 0x29d2 => 0x29d1, 0x29d4 => 0x29d5, 0x29d5 => 0x29d4, 0x29d8 => 0x29d9, 0x29d9 => 0x29d8, 0x29da => 0x29db, 0x29db => 0x29da, 0x29f5 => 0x2215, 0x29f8 => 0x29f9, 0x29f9 => 0x29f8, 0x29fc => 0x29fd, 0x29fd => 0x29fc, 0x2a2b => 0x2a2c, 0x2a2c => 0x2a2b, 0x2a2d => 0x2a2e, 0x2a2e => 0x2a2d, 0x2a34 => 0x2a35, 0x2a35 => 0x2a34, 0x2a3c => 0x2a3d, 0x2a3d => 0x2a3c, 0x2a64 => 0x2a65, 0x2a65 => 0x2a64, 0x2a79 => 0x2a7a, 0x2a7a => 0x2a79, 0x2a7d => 0x2a7e, 0x2a7e => 0x2a7d, 0x2a7f => 0x2a80, 0x2a80 => 0x2a7f, 0x2a81 => 0x2a82, 0x2a82 => 0x2a81, 0x2a83 => 0x2a84, 0x2a84 => 0x2a83, 0x2a8b => 0x2a8c, 0x2a8c => 0x2a8b, 0x2a91 => 0x2a92, 0x2a92 => 0x2a91, 0x2a93 => 0x2a94, 0x2a94 => 0x2a93, 0x2a95 => 0x2a96, 0x2a96 => 0x2a95, 0x2a97 => 0x2a98, 0x2a98 => 0x2a97, 0x2a99 => 0x2a9a, 0x2a9a => 0x2a99, 0x2a9b => 0x2a9c, 0x2a9c => 0x2a9b, 0x2aa1 => 0x2aa2, 0x2aa2 => 0x2aa1, 0x2aa6 => 0x2aa7, 0x2aa7 => 0x2aa6, 0x2aa8 => 0x2aa9, 0x2aa9 => 0x2aa8, 0x2aaa => 0x2aab, 0x2aab => 0x2aaa, 0x2aac => 0x2aad, 0x2aad => 0x2aac, 0x2aaf => 0x2ab0, 0x2ab0 => 0x2aaf, 0x2ab3 => 0x2ab4, 0x2ab4 => 0x2ab3, 0x2abb => 0x2abc, 0x2abc => 0x2abb, 0x2abd => 0x2abe, 0x2abe => 0x2abd, 0x2abf => 0x2ac0, 0x2ac0 => 0x2abf, 0x2ac1 => 0x2ac2, 0x2ac2 => 0x2ac1, 0x2ac3 => 0x2ac4, 0x2ac4 => 0x2ac3, 0x2ac5 => 0x2ac6, 0x2ac6 => 0x2ac5, 0x2acd => 0x2ace, 0x2ace => 0x2acd, 0x2acf => 0x2ad0, 0x2ad0 => 0x2acf, 0x2ad1 => 0x2ad2, 0x2ad2 => 0x2ad1, 0x2ad3 => 0x2ad4, 0x2ad4 => 0x2ad3, 0x2ad5 => 0x2ad6, 0x2ad6 => 0x2ad5, 0x2ade => 0x22a6, 0x2ae3 => 0x22a9, 0x2ae4 => 0x22a8, 0x2ae5 => 0x22ab, 0x2aec => 0x2aed, 0x2aed => 0x2aec, 0x2af7 => 0x2af8, 0x2af8 => 0x2af7, 0x2af9 => 0x2afa, 0x2afa => 0x2af9, 0x2e02 => 0x2e03, 0x2e03 => 0x2e02, 0x2e04 => 0x2e05, 0x2e05 => 0x2e04, 0x2e09 => 0x2e0a, 0x2e0a => 0x2e09, 0x2e0c => 0x2e0d, 0x2e0d => 0x2e0c, 0x2e1c => 0x2e1d, 0x2e1d => 0x2e1c, 0x3008 => 0x3009, 0x3009 => 0x3008, 0x300a => 0x300b, 0x300b => 0x300a, 0x300c => 0x300d, 0x300d => 0x300c, 0x300e => 0x300f, 0x300f => 0x300e, 0x3010 => 0x3011, 0x3011 => 0x3010, 0x3014 => 0x3015, 0x3015 => 0x3014, 0x3016 => 0x3017, 0x3017 => 0x3016, 0x3018 => 0x3019, 0x3019 => 0x3018, 0x301a => 0x301b, 0x301b => 0x301a, 0x301d => 0x301e, 0x301e => 0x301d, 0xfe59 => 0xfe5a, 0xfe5a => 0xfe59, 0xfe5b => 0xfe5c, 0xfe5c => 0xfe5b, 0xfe5d => 0xfe5e, 0xfe5e => 0xfe5d, 0xfe64 => 0xfe65, 0xfe65 => 0xfe64, 0xff08 => 0xff09, 0xff09 => 0xff08, 0xff1c => 0xff1e, 0xff1e => 0xff1c, 0xff3b => 0xff3d, 0xff3d => 0xff3b, 0xff5b => 0xff5d, 0xff5d => 0xff5b, 0xff5f => 0xff60, 0xff60 => 0xff5f, 0xff62 => 0xff63, 0xff63 => 0xff62);
/**
* Arabic shape substitutions: char code => (isolated, final, initial, medial).
* @public
*/
public static $uni_arabicsubst = array(1569 => array(65152), 1570 => array(65153, 65154, 65153, 65154), 1571 => array(65155, 65156, 65155, 65156), 1572 => array(65157, 65158), 1573 => array(65159, 65160, 65159, 65160), 1574 => array(65161, 65162, 65163, 65164), 1575 => array(65165, 65166, 65165, 65166), 1576 => array(65167, 65168, 65169, 65170), 1577 => array(65171, 65172), 1578 => array(65173, 65174, 65175, 65176), 1579 => array(65177, 65178, 65179, 65180), 1580 => array(65181, 65182, 65183, 65184), 1581 => array(65185, 65186, 65187, 65188), 1582 => array(65189, 65190, 65191, 65192), 1583 => array(65193, 65194, 65193, 65194), 1584 => array(65195, 65196, 65195, 65196), 1585 => array(65197, 65198, 65197, 65198), 1586 => array(65199, 65200, 65199, 65200), 1587 => array(65201, 65202, 65203, 65204), 1588 => array(65205, 65206, 65207, 65208), 1589 => array(65209, 65210, 65211, 65212), 1590 => array(65213, 65214, 65215, 65216), 1591 => array(65217, 65218, 65219, 65220), 1592 => array(65221, 65222, 65223, 65224), 1593 => array(65225, 65226, 65227, 65228), 1594 => array(65229, 65230, 65231, 65232), 1601 => array(65233, 65234, 65235, 65236), 1602 => array(65237, 65238, 65239, 65240), 1603 => array(65241, 65242, 65243, 65244), 1604 => array(65245, 65246, 65247, 65248), 1605 => array(65249, 65250, 65251, 65252), 1606 => array(65253, 65254, 65255, 65256), 1607 => array(65257, 65258, 65259, 65260), 1608 => array(65261, 65262, 65261, 65262), 1609 => array(65263, 65264, 64488, 64489), 1610 => array(65265, 65266, 65267, 65268), 1649 => array(64336, 64337), 1655 => array(64477), 1657 => array(64358, 64359, 64360, 64361), 1658 => array(64350, 64351, 64352, 64353), 1659 => array(64338, 64339, 64340, 64341), 1662 => array(64342, 64343, 64344, 64345), 1663 => array(64354, 64355, 64356, 64357), 1664 => array(64346, 64347, 64348, 64349), 1667 => array(64374, 64375, 64376, 64377), 1668 => array(64370, 64371, 64372, 64373), 1670 => array(64378, 64379, 64380, 64381), 1671 => array(64382, 64383, 64384, 64385), 1672 => array(64392, 64393), 1676 => array(64388, 64389), 1677 => array(64386, 64387), 1678 => array(64390, 64391), 1681 => array(64396, 64397), 1688 => array(64394, 64395, 64394, 64395), 1700 => array(64362, 64363, 64364, 64365), 1702 => array(64366, 64367, 64368, 64369), 1705 => array(64398, 64399, 64400, 64401), 1709 => array(64467, 64468, 64469, 64470), 1711 => array(64402, 64403, 64404, 64405), 1713 => array(64410, 64411, 64412, 64413), 1715 => array(64406, 64407, 64408, 64409), 1722 => array(64414, 64415), 1723 => array(64416, 64417, 64418, 64419), 1726 => array(64426, 64427, 64428, 64429), 1728 => array(64420, 64421), 1729 => array(64422, 64423, 64424, 64425), 1733 => array(64480, 64481), 1734 => array(64473, 64474), 1735 => array(64471, 64472), 1736 => array(64475, 64476), 1737 => array(64482, 64483), 1739 => array(64478, 64479), 1740 => array(64508, 64509, 64510, 64511), 1744 => array(64484, 64485, 64486, 64487), 1746 => array(64430, 64431), 1747 => array(64432, 64433));
/**
* Arabic laa letter: (char code => isolated, final, initial, medial).
* @public
*/
public static $uni_laa_array = array(1570 => array(65269, 65270, 65269, 65270), 1571 => array(65271, 65272, 65271, 65272), 1573 => array(65273, 65274, 65273, 65274), 1575 => array(65275, 65276, 65275, 65276));
/**
* Array of character substitutions for sequences of two diacritics symbols.
* Putting the combining mark and character in the same glyph allows us to avoid the two marks overlapping each other in an illegible manner.
* second NSM char code => substitution char
* @public
*/
public static $uni_diacritics = array(
1612 => 64606,
# Shadda + Dammatan
1613 => 64607,
# Shadda + Kasratan
1614 => 64608,
# Shadda + Fatha
1615 => 64609,
# Shadda + Damma
1616 => 64610,
);
/**
* Array of character substitutions from UTF-8 Unicode to Latin1.
* @public
*/
public static $uni_utf8tolatin = array(
8364 => 128,
# Euro1
338 => 140,
# OE
352 => 138,
# Scaron
376 => 159,
# Ydieresis
381 => 142,
# Zcaron2
8226 => 149,
# bullet3
710 => 136,
# circumflex
8224 => 134,
# dagger
8225 => 135,
# daggerdbl
8230 => 133,
# ellipsis
8212 => 151,
# emdash
8211 => 150,
# endash
402 => 131,
# florin
8249 => 139,
# guilsinglleft
8250 => 155,
# guilsinglright
339 => 156,
# oe
8240 => 137,
# perthousand
8222 => 132,
# quotedblbase
8220 => 147,
# quotedblleft
8221 => 148,
# quotedblright
8216 => 145,
# quoteleft
8217 => 146,
# quoteright
8218 => 130,
# quotesinglbase
353 => 154,
# scaron
732 => 152,
# tilde
8482 => 153,
# trademark
382 => 158,
);
/**
* Array of Encoding Maps.
* @public static
*/
public static $encmap = array(
// encoding map for: cp874
'cp874' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'Euro', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => 'ellipsis', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => 'quoteleft', 146 => 'quoteright', 147 => 'quotedblleft', 148 => 'quotedblright', 149 => 'bullet', 150 => 'endash', 151 => 'emdash', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'kokaithai', 162 => 'khokhaithai', 163 => 'khokhuatthai', 164 => 'khokhwaithai', 165 => 'khokhonthai', 166 => 'khorakhangthai', 167 => 'ngonguthai', 168 => 'chochanthai', 169 => 'chochingthai', 170 => 'chochangthai', 171 => 'sosothai', 172 => 'chochoethai', 173 => 'yoyingthai', 174 => 'dochadathai', 175 => 'topatakthai', 176 => 'thothanthai', 177 => 'thonangmonthothai', 178 => 'thophuthaothai', 179 => 'nonenthai', 180 => 'dodekthai', 181 => 'totaothai', 182 => 'thothungthai', 183 => 'thothahanthai', 184 => 'thothongthai', 185 => 'nonuthai', 186 => 'bobaimaithai', 187 => 'poplathai', 188 => 'phophungthai', 189 => 'fofathai', 190 => 'phophanthai', 191 => 'fofanthai', 192 => 'phosamphaothai', 193 => 'momathai', 194 => 'yoyakthai', 195 => 'roruathai', 196 => 'ruthai', 197 => 'lolingthai', 198 => 'luthai', 199 => 'wowaenthai', 200 => 'sosalathai', 201 => 'sorusithai', 202 => 'sosuathai', 203 => 'hohipthai', 204 => 'lochulathai', 205 => 'oangthai', 206 => 'honokhukthai', 207 => 'paiyannoithai', 208 => 'saraathai', 209 => 'maihanakatthai', 210 => 'saraaathai', 211 => 'saraamthai', 212 => 'saraithai', 213 => 'saraiithai', 214 => 'sarauethai', 215 => 'saraueethai', 216 => 'sarauthai', 217 => 'sarauuthai', 218 => 'phinthuthai', 219 => '.notdef', 220 => '.notdef', 221 => '.notdef', 222 => '.notdef', 223 => 'bahtthai', 224 => 'saraethai', 225 => 'saraaethai', 226 => 'saraothai', 227 => 'saraaimaimuanthai', 228 => 'saraaimaimalaithai', 229 => 'lakkhangyaothai', 230 => 'maiyamokthai', 231 => 'maitaikhuthai', 232 => 'maiekthai', 233 => 'maithothai', 234 => 'maitrithai', 235 => 'maichattawathai', 236 => 'thanthakhatthai', 237 => 'nikhahitthai', 238 => 'yamakkanthai', 239 => 'fongmanthai', 240 => 'zerothai', 241 => 'onethai', 242 => 'twothai', 243 => 'threethai', 244 => 'fourthai', 245 => 'fivethai', 246 => 'sixthai', 247 => 'seventhai', 248 => 'eightthai', 249 => 'ninethai', 250 => 'angkhankhuthai', 251 => 'khomutthai', 252 => '.notdef', 253 => '.notdef', 254 => '.notdef', 255 => '.notdef'),
// encoding map for: cp1250
'cp1250' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'Euro', 129 => '.notdef', 130 => 'quotesinglbase', 131 => '.notdef', 132 => 'quotedblbase', 133 => 'ellipsis', 134 => 'dagger', 135 => 'daggerdbl', 136 => '.notdef', 137 => 'perthousand', 138 => 'Scaron', 139 => 'guilsinglleft', 140 => 'Sacute', 141 => 'Tcaron', 142 => 'Zcaron', 143 => 'Zacute', 144 => '.notdef', 145 => 'quoteleft', 146 => 'quoteright', 147 => 'quotedblleft', 148 => 'quotedblright', 149 => 'bullet', 150 => 'endash', 151 => 'emdash', 152 => '.notdef', 153 => 'trademark', 154 => 'scaron', 155 => 'guilsinglright', 156 => 'sacute', 157 => 'tcaron', 158 => 'zcaron', 159 => 'zacute', 160 => 'space', 161 => 'caron', 162 => 'breve', 163 => 'Lslash', 164 => 'currency', 165 => 'Aogonek', 166 => 'brokenbar', 167 => 'section', 168 => 'dieresis', 169 => 'copyright', 170 => 'Scedilla', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'Zdotaccent', 176 => 'degree', 177 => 'plusminus', 178 => 'ogonek', 179 => 'lslash', 180 => 'acute', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'cedilla', 185 => 'aogonek', 186 => 'scedilla', 187 => 'guillemotright', 188 => 'Lcaron', 189 => 'hungarumlaut', 190 => 'lcaron', 191 => 'zdotaccent', 192 => 'Racute', 193 => 'Aacute', 194 => 'Acircumflex', 195 => 'Abreve', 196 => 'Adieresis', 197 => 'Lacute', 198 => 'Cacute', 199 => 'Ccedilla', 200 => 'Ccaron', 201 => 'Eacute', 202 => 'Eogonek', 203 => 'Edieresis', 204 => 'Ecaron', 205 => 'Iacute', 206 => 'Icircumflex', 207 => 'Dcaron', 208 => 'Dcroat', 209 => 'Nacute', 210 => 'Ncaron', 211 => 'Oacute', 212 => 'Ocircumflex', 213 => 'Ohungarumlaut', 214 => 'Odieresis', 215 => 'multiply', 216 => 'Rcaron', 217 => 'Uring', 218 => 'Uacute', 219 => 'Uhungarumlaut', 220 => 'Udieresis', 221 => 'Yacute', 222 => 'Tcommaaccent', 223 => 'germandbls', 224 => 'racute', 225 => 'aacute', 226 => 'acircumflex', 227 => 'abreve', 228 => 'adieresis', 229 => 'lacute', 230 => 'cacute', 231 => 'ccedilla', 232 => 'ccaron', 233 => 'eacute', 234 => 'eogonek', 235 => 'edieresis', 236 => 'ecaron', 237 => 'iacute', 238 => 'icircumflex', 239 => 'dcaron', 240 => 'dcroat', 241 => 'nacute', 242 => 'ncaron', 243 => 'oacute', 244 => 'ocircumflex', 245 => 'ohungarumlaut', 246 => 'odieresis', 247 => 'divide', 248 => 'rcaron', 249 => 'uring', 250 => 'uacute', 251 => 'uhungarumlaut', 252 => 'udieresis', 253 => 'yacute', 254 => 'tcommaaccent', 255 => 'dotaccent'),
// encoding map for: cp1251
'cp1251' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'afii10051', 129 => 'afii10052', 130 => 'quotesinglbase', 131 => 'afii10100', 132 => 'quotedblbase', 133 => 'ellipsis', 134 => 'dagger', 135 => 'daggerdbl', 136 => 'Euro', 137 => 'perthousand', 138 => 'afii10058', 139 => 'guilsinglleft', 140 => 'afii10059', 141 => 'afii10061', 142 => 'afii10060', 143 => 'afii10145', 144 => 'afii10099', 145 => 'quoteleft', 146 => 'quoteright', 147 => 'quotedblleft', 148 => 'quotedblright', 149 => 'bullet', 150 => 'endash', 151 => 'emdash', 152 => '.notdef', 153 => 'trademark', 154 => 'afii10106', 155 => 'guilsinglright', 156 => 'afii10107', 157 => 'afii10109', 158 => 'afii10108', 159 => 'afii10193', 160 => 'space', 161 => 'afii10062', 162 => 'afii10110', 163 => 'afii10057', 164 => 'currency', 165 => 'afii10050', 166 => 'brokenbar', 167 => 'section', 168 => 'afii10023', 169 => 'copyright', 170 => 'afii10053', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'afii10056', 176 => 'degree', 177 => 'plusminus', 178 => 'afii10055', 179 => 'afii10103', 180 => 'afii10098', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'afii10071', 185 => 'afii61352', 186 => 'afii10101', 187 => 'guillemotright', 188 => 'afii10105', 189 => 'afii10054', 190 => 'afii10102', 191 => 'afii10104', 192 => 'afii10017', 193 => 'afii10018', 194 => 'afii10019', 195 => 'afii10020', 196 => 'afii10021', 197 => 'afii10022', 198 => 'afii10024', 199 => 'afii10025', 200 => 'afii10026', 201 => 'afii10027', 202 => 'afii10028', 203 => 'afii10029', 204 => 'afii10030', 205 => 'afii10031', 206 => 'afii10032', 207 => 'afii10033', 208 => 'afii10034', 209 => 'afii10035', 210 => 'afii10036', 211 => 'afii10037', 212 => 'afii10038', 213 => 'afii10039', 214 => 'afii10040', 215 => 'afii10041', 216 => 'afii10042', 217 => 'afii10043', 218 => 'afii10044', 219 => 'afii10045', 220 => 'afii10046', 221 => 'afii10047', 222 => 'afii10048', 223 => 'afii10049', 224 => 'afii10065', 225 => 'afii10066', 226 => 'afii10067', 227 => 'afii10068', 228 => 'afii10069', 229 => 'afii10070', 230 => 'afii10072', 231 => 'afii10073', 232 => 'afii10074', 233 => 'afii10075', 234 => 'afii10076', 235 => 'afii10077', 236 => 'afii10078', 237 => 'afii10079', 238 => 'afii10080', 239 => 'afii10081', 240 => 'afii10082', 241 => 'afii10083', 242 => 'afii10084', 243 => 'afii10085', 244 => 'afii10086', 245 => 'afii10087', 246 => 'afii10088', 247 => 'afii10089', 248 => 'afii10090', 249 => 'afii10091', 250 => 'afii10092', 251 => 'afii10093', 252 => 'afii10094', 253 => 'afii10095', 254 => 'afii10096', 255 => 'afii10097'),
// encoding map for: cp1252
'cp1252' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'Euro', 129 => '.notdef', 130 => 'quotesinglbase', 131 => 'florin', 132 => 'quotedblbase', 133 => 'ellipsis', 134 => 'dagger', 135 => 'daggerdbl', 136 => 'circumflex', 137 => 'perthousand', 138 => 'Scaron', 139 => 'guilsinglleft', 140 => 'OE', 141 => '.notdef', 142 => 'Zcaron', 143 => '.notdef', 144 => '.notdef', 145 => 'quoteleft', 146 => 'quoteright', 147 => 'quotedblleft', 148 => 'quotedblright', 149 => 'bullet', 150 => 'endash', 151 => 'emdash', 152 => 'tilde', 153 => 'trademark', 154 => 'scaron', 155 => 'guilsinglright', 156 => 'oe', 157 => '.notdef', 158 => 'zcaron', 159 => 'Ydieresis', 160 => 'space', 161 => 'exclamdown', 162 => 'cent', 163 => 'sterling', 164 => 'currency', 165 => 'yen', 166 => 'brokenbar', 167 => 'section', 168 => 'dieresis', 169 => 'copyright', 170 => 'ordfeminine', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'macron', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'acute', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'cedilla', 185 => 'onesuperior', 186 => 'ordmasculine', 187 => 'guillemotright', 188 => 'onequarter', 189 => 'onehalf', 190 => 'threequarters', 191 => 'questiondown', 192 => 'Agrave', 193 => 'Aacute', 194 => 'Acircumflex', 195 => 'Atilde', 196 => 'Adieresis', 197 => 'Aring', 198 => 'AE', 199 => 'Ccedilla', 200 => 'Egrave', 201 => 'Eacute', 202 => 'Ecircumflex', 203 => 'Edieresis', 204 => 'Igrave', 205 => 'Iacute', 206 => 'Icircumflex', 207 => 'Idieresis', 208 => 'Eth', 209 => 'Ntilde', 210 => 'Ograve', 211 => 'Oacute', 212 => 'Ocircumflex', 213 => 'Otilde', 214 => 'Odieresis', 215 => 'multiply', 216 => 'Oslash', 217 => 'Ugrave', 218 => 'Uacute', 219 => 'Ucircumflex', 220 => 'Udieresis', 221 => 'Yacute', 222 => 'Thorn', 223 => 'germandbls', 224 => 'agrave', 225 => 'aacute', 226 => 'acircumflex', 227 => 'atilde', 228 => 'adieresis', 229 => 'aring', 230 => 'ae', 231 => 'ccedilla', 232 => 'egrave', 233 => 'eacute', 234 => 'ecircumflex', 235 => 'edieresis', 236 => 'igrave', 237 => 'iacute', 238 => 'icircumflex', 239 => 'idieresis', 240 => 'eth', 241 => 'ntilde', 242 => 'ograve', 243 => 'oacute', 244 => 'ocircumflex', 245 => 'otilde', 246 => 'odieresis', 247 => 'divide', 248 => 'oslash', 249 => 'ugrave', 250 => 'uacute', 251 => 'ucircumflex', 252 => 'udieresis', 253 => 'yacute', 254 => 'thorn', 255 => 'ydieresis'),
// encoding map for: cp1253
'cp1253' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'Euro', 129 => '.notdef', 130 => 'quotesinglbase', 131 => 'florin', 132 => 'quotedblbase', 133 => 'ellipsis', 134 => 'dagger', 135 => 'daggerdbl', 136 => '.notdef', 137 => 'perthousand', 138 => '.notdef', 139 => 'guilsinglleft', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => 'quoteleft', 146 => 'quoteright', 147 => 'quotedblleft', 148 => 'quotedblright', 149 => 'bullet', 150 => 'endash', 151 => 'emdash', 152 => '.notdef', 153 => 'trademark', 154 => '.notdef', 155 => 'guilsinglright', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'dieresistonos', 162 => 'Alphatonos', 163 => 'sterling', 164 => 'currency', 165 => 'yen', 166 => 'brokenbar', 167 => 'section', 168 => 'dieresis', 169 => 'copyright', 170 => '.notdef', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'afii00208', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'tonos', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'Epsilontonos', 185 => 'Etatonos', 186 => 'Iotatonos', 187 => 'guillemotright', 188 => 'Omicrontonos', 189 => 'onehalf', 190 => 'Upsilontonos', 191 => 'Omegatonos', 192 => 'iotadieresistonos', 193 => 'Alpha', 194 => 'Beta', 195 => 'Gamma', 196 => 'Delta', 197 => 'Epsilon', 198 => 'Zeta', 199 => 'Eta', 200 => 'Theta', 201 => 'Iota', 202 => 'Kappa', 203 => 'Lambda', 204 => 'Mu', 205 => 'Nu', 206 => 'Xi', 207 => 'Omicron', 208 => 'Pi', 209 => 'Rho', 210 => '.notdef', 211 => 'Sigma', 212 => 'Tau', 213 => 'Upsilon', 214 => 'Phi', 215 => 'Chi', 216 => 'Psi', 217 => 'Omega', 218 => 'Iotadieresis', 219 => 'Upsilondieresis', 220 => 'alphatonos', 221 => 'epsilontonos', 222 => 'etatonos', 223 => 'iotatonos', 224 => 'upsilondieresistonos', 225 => 'alpha', 226 => 'beta', 227 => 'gamma', 228 => 'delta', 229 => 'epsilon', 230 => 'zeta', 231 => 'eta', 232 => 'theta', 233 => 'iota', 234 => 'kappa', 235 => 'lambda', 236 => 'mu', 237 => 'nu', 238 => 'xi', 239 => 'omicron', 240 => 'pi', 241 => 'rho', 242 => 'sigma1', 243 => 'sigma', 244 => 'tau', 245 => 'upsilon', 246 => 'phi', 247 => 'chi', 248 => 'psi', 249 => 'omega', 250 => 'iotadieresis', 251 => 'upsilondieresis', 252 => 'omicrontonos', 253 => 'upsilontonos', 254 => 'omegatonos', 255 => '.notdef'),
// encoding map for: cp1254
'cp1254' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'Euro', 129 => '.notdef', 130 => 'quotesinglbase', 131 => 'florin', 132 => 'quotedblbase', 133 => 'ellipsis', 134 => 'dagger', 135 => 'daggerdbl', 136 => 'circumflex', 137 => 'perthousand', 138 => 'Scaron', 139 => 'guilsinglleft', 140 => 'OE', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => 'quoteleft', 146 => 'quoteright', 147 => 'quotedblleft', 148 => 'quotedblright', 149 => 'bullet', 150 => 'endash', 151 => 'emdash', 152 => 'tilde', 153 => 'trademark', 154 => 'scaron', 155 => 'guilsinglright', 156 => 'oe', 157 => '.notdef', 158 => '.notdef', 159 => 'Ydieresis', 160 => 'space', 161 => 'exclamdown', 162 => 'cent', 163 => 'sterling', 164 => 'currency', 165 => 'yen', 166 => 'brokenbar', 167 => 'section', 168 => 'dieresis', 169 => 'copyright', 170 => 'ordfeminine', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'macron', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'acute', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'cedilla', 185 => 'onesuperior', 186 => 'ordmasculine', 187 => 'guillemotright', 188 => 'onequarter', 189 => 'onehalf', 190 => 'threequarters', 191 => 'questiondown', 192 => 'Agrave', 193 => 'Aacute', 194 => 'Acircumflex', 195 => 'Atilde', 196 => 'Adieresis', 197 => 'Aring', 198 => 'AE', 199 => 'Ccedilla', 200 => 'Egrave', 201 => 'Eacute', 202 => 'Ecircumflex', 203 => 'Edieresis', 204 => 'Igrave', 205 => 'Iacute', 206 => 'Icircumflex', 207 => 'Idieresis', 208 => 'Gbreve', 209 => 'Ntilde', 210 => 'Ograve', 211 => 'Oacute', 212 => 'Ocircumflex', 213 => 'Otilde', 214 => 'Odieresis', 215 => 'multiply', 216 => 'Oslash', 217 => 'Ugrave', 218 => 'Uacute', 219 => 'Ucircumflex', 220 => 'Udieresis', 221 => 'Idotaccent', 222 => 'Scedilla', 223 => 'germandbls', 224 => 'agrave', 225 => 'aacute', 226 => 'acircumflex', 227 => 'atilde', 228 => 'adieresis', 229 => 'aring', 230 => 'ae', 231 => 'ccedilla', 232 => 'egrave', 233 => 'eacute', 234 => 'ecircumflex', 235 => 'edieresis', 236 => 'igrave', 237 => 'iacute', 238 => 'icircumflex', 239 => 'idieresis', 240 => 'gbreve', 241 => 'ntilde', 242 => 'ograve', 243 => 'oacute', 244 => 'ocircumflex', 245 => 'otilde', 246 => 'odieresis', 247 => 'divide', 248 => 'oslash', 249 => 'ugrave', 250 => 'uacute', 251 => 'ucircumflex', 252 => 'udieresis', 253 => 'dotlessi', 254 => 'scedilla', 255 => 'ydieresis'),
// encoding map for: cp1255
'cp1255' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'Euro', 129 => '.notdef', 130 => 'quotesinglbase', 131 => 'florin', 132 => 'quotedblbase', 133 => 'ellipsis', 134 => 'dagger', 135 => 'daggerdbl', 136 => 'circumflex', 137 => 'perthousand', 138 => '.notdef', 139 => 'guilsinglleft', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => 'quoteleft', 146 => 'quoteright', 147 => 'quotedblleft', 148 => 'quotedblright', 149 => 'bullet', 150 => 'endash', 151 => 'emdash', 152 => 'tilde', 153 => 'trademark', 154 => '.notdef', 155 => 'guilsinglright', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'exclamdown', 162 => 'cent', 163 => 'sterling', 164 => 'afii57636', 165 => 'yen', 166 => 'brokenbar', 167 => 'section', 168 => 'dieresis', 169 => 'copyright', 170 => 'multiply', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'sfthyphen', 174 => 'registered', 175 => 'macron', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'acute', 181 => 'mu', 182 => 'paragraph', 183 => 'middot', 184 => 'cedilla', 185 => 'onesuperior', 186 => 'divide', 187 => 'guillemotright', 188 => 'onequarter', 189 => 'onehalf', 190 => 'threequarters', 191 => 'questiondown', 192 => 'afii57799', 193 => 'afii57801', 194 => 'afii57800', 195 => 'afii57802', 196 => 'afii57793', 197 => 'afii57794', 198 => 'afii57795', 199 => 'afii57798', 200 => 'afii57797', 201 => 'afii57806', 202 => '.notdef', 203 => 'afii57796', 204 => 'afii57807', 205 => 'afii57839', 206 => 'afii57645', 207 => 'afii57841', 208 => 'afii57842', 209 => 'afii57804', 210 => 'afii57803', 211 => 'afii57658', 212 => 'afii57716', 213 => 'afii57717', 214 => 'afii57718', 215 => 'gereshhebrew', 216 => 'gershayimhebrew', 217 => '.notdef', 218 => '.notdef', 219 => '.notdef', 220 => '.notdef', 221 => '.notdef', 222 => '.notdef', 223 => '.notdef', 224 => 'afii57664', 225 => 'afii57665', 226 => 'afii57666', 227 => 'afii57667', 228 => 'afii57668', 229 => 'afii57669', 230 => 'afii57670', 231 => 'afii57671', 232 => 'afii57672', 233 => 'afii57673', 234 => 'afii57674', 235 => 'afii57675', 236 => 'afii57676', 237 => 'afii57677', 238 => 'afii57678', 239 => 'afii57679', 240 => 'afii57680', 241 => 'afii57681', 242 => 'afii57682', 243 => 'afii57683', 244 => 'afii57684', 245 => 'afii57685', 246 => 'afii57686', 247 => 'afii57687', 248 => 'afii57688', 249 => 'afii57689', 250 => 'afii57690', 251 => '.notdef', 252 => '.notdef', 253 => 'afii299', 254 => 'afii300', 255 => '.notdef'),
// encoding map for: cp1256
'cp1256' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'Euro', 129 => 'afii57506', 130 => 'quotesinglbase', 131 => 'florin', 132 => 'quotedblbase', 133 => 'ellipsis', 134 => 'dagger', 135 => 'daggerdbl', 136 => 'circumflex', 137 => 'perthousand', 138 => 'afii57511', 139 => 'guilsinglleft', 140 => 'OE', 141 => 'afii57507', 142 => 'afii57508', 143 => 'afii57512', 144 => 'afii57509', 145 => 'quoteleft', 146 => 'quoteright', 147 => 'quotedblleft', 148 => 'quotedblright', 149 => 'bullet', 150 => 'endash', 151 => 'emdash', 152 => '.notdef', 153 => 'trademark', 154 => 'afii57513', 155 => 'guilsinglright', 156 => 'oe', 157 => 'afii61664', 158 => 'afii301', 159 => 'afii57514', 160 => 'space', 161 => 'afii57388', 162 => 'cent', 163 => 'sterling', 164 => 'currency', 165 => 'yen', 166 => 'brokenbar', 167 => 'section', 168 => 'dieresis', 169 => 'copyright', 170 => '.notdef', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'macron', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'acute', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'cedilla', 185 => 'onesuperior', 186 => 'afii57403', 187 => 'guillemotright', 188 => 'onequarter', 189 => 'onehalf', 190 => 'threequarters', 191 => 'afii57407', 192 => '.notdef', 193 => 'afii57409', 194 => 'afii57410', 195 => 'afii57411', 196 => 'afii57412', 197 => 'afii57413', 198 => 'afii57414', 199 => 'afii57415', 200 => 'afii57416', 201 => 'afii57417', 202 => 'afii57418', 203 => 'afii57419', 204 => 'afii57420', 205 => 'afii57421', 206 => 'afii57422', 207 => 'afii57423', 208 => 'afii57424', 209 => 'afii57425', 210 => 'afii57426', 211 => 'afii57427', 212 => 'afii57428', 213 => 'afii57429', 214 => 'afii57430', 215 => 'multiply', 216 => 'afii57431', 217 => 'afii57432', 218 => 'afii57433', 219 => 'afii57434', 220 => 'afii57440', 221 => 'afii57441', 222 => 'afii57442', 223 => 'afii57443', 224 => 'agrave', 225 => 'afii57444', 226 => 'acircumflex', 227 => 'afii57445', 228 => 'afii57446', 229 => 'afii57470', 230 => 'afii57448', 231 => 'ccedilla', 232 => 'egrave', 233 => 'eacute', 234 => 'ecircumflex', 235 => 'edieresis', 236 => 'afii57449', 237 => 'afii57450', 238 => 'icircumflex', 239 => 'idieresis', 240 => 'afii57451', 241 => 'afii57452', 242 => 'afii57453', 243 => 'afii57454', 244 => 'ocircumflex', 245 => 'afii57455', 246 => 'afii57456', 247 => 'divide', 248 => 'afii57457', 249 => 'ugrave', 250 => 'afii57458', 251 => 'ucircumflex', 252 => 'udieresis', 253 => 'afii299', 254 => 'afii300', 255 => 'afii57519'),
// encoding map for: cp1257
'cp1257' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'Euro', 129 => '.notdef', 130 => 'quotesinglbase', 131 => '.notdef', 132 => 'quotedblbase', 133 => 'ellipsis', 134 => 'dagger', 135 => 'daggerdbl', 136 => '.notdef', 137 => 'perthousand', 138 => '.notdef', 139 => 'guilsinglleft', 140 => '.notdef', 141 => 'dieresis', 142 => 'caron', 143 => 'cedilla', 144 => '.notdef', 145 => 'quoteleft', 146 => 'quoteright', 147 => 'quotedblleft', 148 => 'quotedblright', 149 => 'bullet', 150 => 'endash', 151 => 'emdash', 152 => '.notdef', 153 => 'trademark', 154 => '.notdef', 155 => 'guilsinglright', 156 => '.notdef', 157 => 'macron', 158 => 'ogonek', 159 => '.notdef', 160 => 'space', 161 => '.notdef', 162 => 'cent', 163 => 'sterling', 164 => 'currency', 165 => '.notdef', 166 => 'brokenbar', 167 => 'section', 168 => 'Oslash', 169 => 'copyright', 170 => 'Rcommaaccent', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'AE', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'acute', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'oslash', 185 => 'onesuperior', 186 => 'rcommaaccent', 187 => 'guillemotright', 188 => 'onequarter', 189 => 'onehalf', 190 => 'threequarters', 191 => 'ae', 192 => 'Aogonek', 193 => 'Iogonek', 194 => 'Amacron', 195 => 'Cacute', 196 => 'Adieresis', 197 => 'Aring', 198 => 'Eogonek', 199 => 'Emacron', 200 => 'Ccaron', 201 => 'Eacute', 202 => 'Zacute', 203 => 'Edotaccent', 204 => 'Gcommaaccent', 205 => 'Kcommaaccent', 206 => 'Imacron', 207 => 'Lcommaaccent', 208 => 'Scaron', 209 => 'Nacute', 210 => 'Ncommaaccent', 211 => 'Oacute', 212 => 'Omacron', 213 => 'Otilde', 214 => 'Odieresis', 215 => 'multiply', 216 => 'Uogonek', 217 => 'Lslash', 218 => 'Sacute', 219 => 'Umacron', 220 => 'Udieresis', 221 => 'Zdotaccent', 222 => 'Zcaron', 223 => 'germandbls', 224 => 'aogonek', 225 => 'iogonek', 226 => 'amacron', 227 => 'cacute', 228 => 'adieresis', 229 => 'aring', 230 => 'eogonek', 231 => 'emacron', 232 => 'ccaron', 233 => 'eacute', 234 => 'zacute', 235 => 'edotaccent', 236 => 'gcommaaccent', 237 => 'kcommaaccent', 238 => 'imacron', 239 => 'lcommaaccent', 240 => 'scaron', 241 => 'nacute', 242 => 'ncommaaccent', 243 => 'oacute', 244 => 'omacron', 245 => 'otilde', 246 => 'odieresis', 247 => 'divide', 248 => 'uogonek', 249 => 'lslash', 250 => 'sacute', 251 => 'umacron', 252 => 'udieresis', 253 => 'zdotaccent', 254 => 'zcaron', 255 => 'dotaccent'),
// encoding map for: cp1258
'cp1258' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'Euro', 129 => '.notdef', 130 => 'quotesinglbase', 131 => 'florin', 132 => 'quotedblbase', 133 => 'ellipsis', 134 => 'dagger', 135 => 'daggerdbl', 136 => 'circumflex', 137 => 'perthousand', 138 => '.notdef', 139 => 'guilsinglleft', 140 => 'OE', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => 'quoteleft', 146 => 'quoteright', 147 => 'quotedblleft', 148 => 'quotedblright', 149 => 'bullet', 150 => 'endash', 151 => 'emdash', 152 => 'tilde', 153 => 'trademark', 154 => '.notdef', 155 => 'guilsinglright', 156 => 'oe', 157 => '.notdef', 158 => '.notdef', 159 => 'Ydieresis', 160 => 'space', 161 => 'exclamdown', 162 => 'cent', 163 => 'sterling', 164 => 'currency', 165 => 'yen', 166 => 'brokenbar', 167 => 'section', 168 => 'dieresis', 169 => 'copyright', 170 => 'ordfeminine', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'macron', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'acute', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'cedilla', 185 => 'onesuperior', 186 => 'ordmasculine', 187 => 'guillemotright', 188 => 'onequarter', 189 => 'onehalf', 190 => 'threequarters', 191 => 'questiondown', 192 => 'Agrave', 193 => 'Aacute', 194 => 'Acircumflex', 195 => 'Abreve', 196 => 'Adieresis', 197 => 'Aring', 198 => 'AE', 199 => 'Ccedilla', 200 => 'Egrave', 201 => 'Eacute', 202 => 'Ecircumflex', 203 => 'Edieresis', 204 => 'gravecomb', 205 => 'Iacute', 206 => 'Icircumflex', 207 => 'Idieresis', 208 => 'Dcroat', 209 => 'Ntilde', 210 => 'hookabovecomb', 211 => 'Oacute', 212 => 'Ocircumflex', 213 => 'Ohorn', 214 => 'Odieresis', 215 => 'multiply', 216 => 'Oslash', 217 => 'Ugrave', 218 => 'Uacute', 219 => 'Ucircumflex', 220 => 'Udieresis', 221 => 'Uhorn', 222 => 'tildecomb', 223 => 'germandbls', 224 => 'agrave', 225 => 'aacute', 226 => 'acircumflex', 227 => 'abreve', 228 => 'adieresis', 229 => 'aring', 230 => 'ae', 231 => 'ccedilla', 232 => 'egrave', 233 => 'eacute', 234 => 'ecircumflex', 235 => 'edieresis', 236 => 'acutecomb', 237 => 'iacute', 238 => 'icircumflex', 239 => 'idieresis', 240 => 'dcroat', 241 => 'ntilde', 242 => 'dotbelowcomb', 243 => 'oacute', 244 => 'ocircumflex', 245 => 'ohorn', 246 => 'odieresis', 247 => 'divide', 248 => 'oslash', 249 => 'ugrave', 250 => 'uacute', 251 => 'ucircumflex', 252 => 'udieresis', 253 => 'uhorn', 254 => 'dong', 255 => 'ydieresis'),
// encoding map for: iso-8859-1
'iso-8859-1' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => '.notdef', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => '.notdef', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => '.notdef', 146 => '.notdef', 147 => '.notdef', 148 => '.notdef', 149 => '.notdef', 150 => '.notdef', 151 => '.notdef', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'exclamdown', 162 => 'cent', 163 => 'sterling', 164 => 'currency', 165 => 'yen', 166 => 'brokenbar', 167 => 'section', 168 => 'dieresis', 169 => 'copyright', 170 => 'ordfeminine', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'macron', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'acute', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'cedilla', 185 => 'onesuperior', 186 => 'ordmasculine', 187 => 'guillemotright', 188 => 'onequarter', 189 => 'onehalf', 190 => 'threequarters', 191 => 'questiondown', 192 => 'Agrave', 193 => 'Aacute', 194 => 'Acircumflex', 195 => 'Atilde', 196 => 'Adieresis', 197 => 'Aring', 198 => 'AE', 199 => 'Ccedilla', 200 => 'Egrave', 201 => 'Eacute', 202 => 'Ecircumflex', 203 => 'Edieresis', 204 => 'Igrave', 205 => 'Iacute', 206 => 'Icircumflex', 207 => 'Idieresis', 208 => 'Eth', 209 => 'Ntilde', 210 => 'Ograve', 211 => 'Oacute', 212 => 'Ocircumflex', 213 => 'Otilde', 214 => 'Odieresis', 215 => 'multiply', 216 => 'Oslash', 217 => 'Ugrave', 218 => 'Uacute', 219 => 'Ucircumflex', 220 => 'Udieresis', 221 => 'Yacute', 222 => 'Thorn', 223 => 'germandbls', 224 => 'agrave', 225 => 'aacute', 226 => 'acircumflex', 227 => 'atilde', 228 => 'adieresis', 229 => 'aring', 230 => 'ae', 231 => 'ccedilla', 232 => 'egrave', 233 => 'eacute', 234 => 'ecircumflex', 235 => 'edieresis', 236 => 'igrave', 237 => 'iacute', 238 => 'icircumflex', 239 => 'idieresis', 240 => 'eth', 241 => 'ntilde', 242 => 'ograve', 243 => 'oacute', 244 => 'ocircumflex', 245 => 'otilde', 246 => 'odieresis', 247 => 'divide', 248 => 'oslash', 249 => 'ugrave', 250 => 'uacute', 251 => 'ucircumflex', 252 => 'udieresis', 253 => 'yacute', 254 => 'thorn', 255 => 'ydieresis'),
// encoding map for: iso-8859-2
'iso-8859-2' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => '.notdef', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => '.notdef', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => '.notdef', 146 => '.notdef', 147 => '.notdef', 148 => '.notdef', 149 => '.notdef', 150 => '.notdef', 151 => '.notdef', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'Aogonek', 162 => 'breve', 163 => 'Lslash', 164 => 'currency', 165 => 'Lcaron', 166 => 'Sacute', 167 => 'section', 168 => 'dieresis', 169 => 'Scaron', 170 => 'Scedilla', 171 => 'Tcaron', 172 => 'Zacute', 173 => 'hyphen', 174 => 'Zcaron', 175 => 'Zdotaccent', 176 => 'degree', 177 => 'aogonek', 178 => 'ogonek', 179 => 'lslash', 180 => 'acute', 181 => 'lcaron', 182 => 'sacute', 183 => 'caron', 184 => 'cedilla', 185 => 'scaron', 186 => 'scedilla', 187 => 'tcaron', 188 => 'zacute', 189 => 'hungarumlaut', 190 => 'zcaron', 191 => 'zdotaccent', 192 => 'Racute', 193 => 'Aacute', 194 => 'Acircumflex', 195 => 'Abreve', 196 => 'Adieresis', 197 => 'Lacute', 198 => 'Cacute', 199 => 'Ccedilla', 200 => 'Ccaron', 201 => 'Eacute', 202 => 'Eogonek', 203 => 'Edieresis', 204 => 'Ecaron', 205 => 'Iacute', 206 => 'Icircumflex', 207 => 'Dcaron', 208 => 'Dcroat', 209 => 'Nacute', 210 => 'Ncaron', 211 => 'Oacute', 212 => 'Ocircumflex', 213 => 'Ohungarumlaut', 214 => 'Odieresis', 215 => 'multiply', 216 => 'Rcaron', 217 => 'Uring', 218 => 'Uacute', 219 => 'Uhungarumlaut', 220 => 'Udieresis', 221 => 'Yacute', 222 => 'Tcommaaccent', 223 => 'germandbls', 224 => 'racute', 225 => 'aacute', 226 => 'acircumflex', 227 => 'abreve', 228 => 'adieresis', 229 => 'lacute', 230 => 'cacute', 231 => 'ccedilla', 232 => 'ccaron', 233 => 'eacute', 234 => 'eogonek', 235 => 'edieresis', 236 => 'ecaron', 237 => 'iacute', 238 => 'icircumflex', 239 => 'dcaron', 240 => 'dcroat', 241 => 'nacute', 242 => 'ncaron', 243 => 'oacute', 244 => 'ocircumflex', 245 => 'ohungarumlaut', 246 => 'odieresis', 247 => 'divide', 248 => 'rcaron', 249 => 'uring', 250 => 'uacute', 251 => 'uhungarumlaut', 252 => 'udieresis', 253 => 'yacute', 254 => 'tcommaaccent', 255 => 'dotaccent'),
// encoding map for: iso-8859-4
'iso-8859-4' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => '.notdef', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => '.notdef', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => '.notdef', 146 => '.notdef', 147 => '.notdef', 148 => '.notdef', 149 => '.notdef', 150 => '.notdef', 151 => '.notdef', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'Aogonek', 162 => 'kgreenlandic', 163 => 'Rcommaaccent', 164 => 'currency', 165 => 'Itilde', 166 => 'Lcommaaccent', 167 => 'section', 168 => 'dieresis', 169 => 'Scaron', 170 => 'Emacron', 171 => 'Gcommaaccent', 172 => 'Tbar', 173 => 'hyphen', 174 => 'Zcaron', 175 => 'macron', 176 => 'degree', 177 => 'aogonek', 178 => 'ogonek', 179 => 'rcommaaccent', 180 => 'acute', 181 => 'itilde', 182 => 'lcommaaccent', 183 => 'caron', 184 => 'cedilla', 185 => 'scaron', 186 => 'emacron', 187 => 'gcommaaccent', 188 => 'tbar', 189 => 'Eng', 190 => 'zcaron', 191 => 'eng', 192 => 'Amacron', 193 => 'Aacute', 194 => 'Acircumflex', 195 => 'Atilde', 196 => 'Adieresis', 197 => 'Aring', 198 => 'AE', 199 => 'Iogonek', 200 => 'Ccaron', 201 => 'Eacute', 202 => 'Eogonek', 203 => 'Edieresis', 204 => 'Edotaccent', 205 => 'Iacute', 206 => 'Icircumflex', 207 => 'Imacron', 208 => 'Dcroat', 209 => 'Ncommaaccent', 210 => 'Omacron', 211 => 'Kcommaaccent', 212 => 'Ocircumflex', 213 => 'Otilde', 214 => 'Odieresis', 215 => 'multiply', 216 => 'Oslash', 217 => 'Uogonek', 218 => 'Uacute', 219 => 'Ucircumflex', 220 => 'Udieresis', 221 => 'Utilde', 222 => 'Umacron', 223 => 'germandbls', 224 => 'amacron', 225 => 'aacute', 226 => 'acircumflex', 227 => 'atilde', 228 => 'adieresis', 229 => 'aring', 230 => 'ae', 231 => 'iogonek', 232 => 'ccaron', 233 => 'eacute', 234 => 'eogonek', 235 => 'edieresis', 236 => 'edotaccent', 237 => 'iacute', 238 => 'icircumflex', 239 => 'imacron', 240 => 'dcroat', 241 => 'ncommaaccent', 242 => 'omacron', 243 => 'kcommaaccent', 244 => 'ocircumflex', 245 => 'otilde', 246 => 'odieresis', 247 => 'divide', 248 => 'oslash', 249 => 'uogonek', 250 => 'uacute', 251 => 'ucircumflex', 252 => 'udieresis', 253 => 'utilde', 254 => 'umacron', 255 => 'dotaccent'),
// encoding map for: iso-8859-5
'iso-8859-5' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => '.notdef', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => '.notdef', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => '.notdef', 146 => '.notdef', 147 => '.notdef', 148 => '.notdef', 149 => '.notdef', 150 => '.notdef', 151 => '.notdef', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'afii10023', 162 => 'afii10051', 163 => 'afii10052', 164 => 'afii10053', 165 => 'afii10054', 166 => 'afii10055', 167 => 'afii10056', 168 => 'afii10057', 169 => 'afii10058', 170 => 'afii10059', 171 => 'afii10060', 172 => 'afii10061', 173 => 'hyphen', 174 => 'afii10062', 175 => 'afii10145', 176 => 'afii10017', 177 => 'afii10018', 178 => 'afii10019', 179 => 'afii10020', 180 => 'afii10021', 181 => 'afii10022', 182 => 'afii10024', 183 => 'afii10025', 184 => 'afii10026', 185 => 'afii10027', 186 => 'afii10028', 187 => 'afii10029', 188 => 'afii10030', 189 => 'afii10031', 190 => 'afii10032', 191 => 'afii10033', 192 => 'afii10034', 193 => 'afii10035', 194 => 'afii10036', 195 => 'afii10037', 196 => 'afii10038', 197 => 'afii10039', 198 => 'afii10040', 199 => 'afii10041', 200 => 'afii10042', 201 => 'afii10043', 202 => 'afii10044', 203 => 'afii10045', 204 => 'afii10046', 205 => 'afii10047', 206 => 'afii10048', 207 => 'afii10049', 208 => 'afii10065', 209 => 'afii10066', 210 => 'afii10067', 211 => 'afii10068', 212 => 'afii10069', 213 => 'afii10070', 214 => 'afii10072', 215 => 'afii10073', 216 => 'afii10074', 217 => 'afii10075', 218 => 'afii10076', 219 => 'afii10077', 220 => 'afii10078', 221 => 'afii10079', 222 => 'afii10080', 223 => 'afii10081', 224 => 'afii10082', 225 => 'afii10083', 226 => 'afii10084', 227 => 'afii10085', 228 => 'afii10086', 229 => 'afii10087', 230 => 'afii10088', 231 => 'afii10089', 232 => 'afii10090', 233 => 'afii10091', 234 => 'afii10092', 235 => 'afii10093', 236 => 'afii10094', 237 => 'afii10095', 238 => 'afii10096', 239 => 'afii10097', 240 => 'afii61352', 241 => 'afii10071', 242 => 'afii10099', 243 => 'afii10100', 244 => 'afii10101', 245 => 'afii10102', 246 => 'afii10103', 247 => 'afii10104', 248 => 'afii10105', 249 => 'afii10106', 250 => 'afii10107', 251 => 'afii10108', 252 => 'afii10109', 253 => 'section', 254 => 'afii10110', 255 => 'afii10193'),
// encoding map for: iso-8859-7
'iso-8859-7' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => '.notdef', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => '.notdef', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => '.notdef', 146 => '.notdef', 147 => '.notdef', 148 => '.notdef', 149 => '.notdef', 150 => '.notdef', 151 => '.notdef', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'quoteleft', 162 => 'quoteright', 163 => 'sterling', 164 => '.notdef', 165 => '.notdef', 166 => 'brokenbar', 167 => 'section', 168 => 'dieresis', 169 => 'copyright', 170 => '.notdef', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => '.notdef', 175 => 'afii00208', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'tonos', 181 => 'dieresistonos', 182 => 'Alphatonos', 183 => 'periodcentered', 184 => 'Epsilontonos', 185 => 'Etatonos', 186 => 'Iotatonos', 187 => 'guillemotright', 188 => 'Omicrontonos', 189 => 'onehalf', 190 => 'Upsilontonos', 191 => 'Omegatonos', 192 => 'iotadieresistonos', 193 => 'Alpha', 194 => 'Beta', 195 => 'Gamma', 196 => 'Delta', 197 => 'Epsilon', 198 => 'Zeta', 199 => 'Eta', 200 => 'Theta', 201 => 'Iota', 202 => 'Kappa', 203 => 'Lambda', 204 => 'Mu', 205 => 'Nu', 206 => 'Xi', 207 => 'Omicron', 208 => 'Pi', 209 => 'Rho', 210 => '.notdef', 211 => 'Sigma', 212 => 'Tau', 213 => 'Upsilon', 214 => 'Phi', 215 => 'Chi', 216 => 'Psi', 217 => 'Omega', 218 => 'Iotadieresis', 219 => 'Upsilondieresis', 220 => 'alphatonos', 221 => 'epsilontonos', 222 => 'etatonos', 223 => 'iotatonos', 224 => 'upsilondieresistonos', 225 => 'alpha', 226 => 'beta', 227 => 'gamma', 228 => 'delta', 229 => 'epsilon', 230 => 'zeta', 231 => 'eta', 232 => 'theta', 233 => 'iota', 234 => 'kappa', 235 => 'lambda', 236 => 'mu', 237 => 'nu', 238 => 'xi', 239 => 'omicron', 240 => 'pi', 241 => 'rho', 242 => 'sigma1', 243 => 'sigma', 244 => 'tau', 245 => 'upsilon', 246 => 'phi', 247 => 'chi', 248 => 'psi', 249 => 'omega', 250 => 'iotadieresis', 251 => 'upsilondieresis', 252 => 'omicrontonos', 253 => 'upsilontonos', 254 => 'omegatonos', 255 => '.notdef'),
// encoding map for: iso-8859-9
'iso-8859-9' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => '.notdef', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => '.notdef', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => '.notdef', 146 => '.notdef', 147 => '.notdef', 148 => '.notdef', 149 => '.notdef', 150 => '.notdef', 151 => '.notdef', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'exclamdown', 162 => 'cent', 163 => 'sterling', 164 => 'currency', 165 => 'yen', 166 => 'brokenbar', 167 => 'section', 168 => 'dieresis', 169 => 'copyright', 170 => 'ordfeminine', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'macron', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'acute', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'cedilla', 185 => 'onesuperior', 186 => 'ordmasculine', 187 => 'guillemotright', 188 => 'onequarter', 189 => 'onehalf', 190 => 'threequarters', 191 => 'questiondown', 192 => 'Agrave', 193 => 'Aacute', 194 => 'Acircumflex', 195 => 'Atilde', 196 => 'Adieresis', 197 => 'Aring', 198 => 'AE', 199 => 'Ccedilla', 200 => 'Egrave', 201 => 'Eacute', 202 => 'Ecircumflex', 203 => 'Edieresis', 204 => 'Igrave', 205 => 'Iacute', 206 => 'Icircumflex', 207 => 'Idieresis', 208 => 'Gbreve', 209 => 'Ntilde', 210 => 'Ograve', 211 => 'Oacute', 212 => 'Ocircumflex', 213 => 'Otilde', 214 => 'Odieresis', 215 => 'multiply', 216 => 'Oslash', 217 => 'Ugrave', 218 => 'Uacute', 219 => 'Ucircumflex', 220 => 'Udieresis', 221 => 'Idotaccent', 222 => 'Scedilla', 223 => 'germandbls', 224 => 'agrave', 225 => 'aacute', 226 => 'acircumflex', 227 => 'atilde', 228 => 'adieresis', 229 => 'aring', 230 => 'ae', 231 => 'ccedilla', 232 => 'egrave', 233 => 'eacute', 234 => 'ecircumflex', 235 => 'edieresis', 236 => 'igrave', 237 => 'iacute', 238 => 'icircumflex', 239 => 'idieresis', 240 => 'gbreve', 241 => 'ntilde', 242 => 'ograve', 243 => 'oacute', 244 => 'ocircumflex', 245 => 'otilde', 246 => 'odieresis', 247 => 'divide', 248 => 'oslash', 249 => 'ugrave', 250 => 'uacute', 251 => 'ucircumflex', 252 => 'udieresis', 253 => 'dotlessi', 254 => 'scedilla', 255 => 'ydieresis'),
// encoding map for: iso-8859-11
'iso-8859-11' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => '.notdef', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => '.notdef', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => '.notdef', 146 => '.notdef', 147 => '.notdef', 148 => '.notdef', 149 => '.notdef', 150 => '.notdef', 151 => '.notdef', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'kokaithai', 162 => 'khokhaithai', 163 => 'khokhuatthai', 164 => 'khokhwaithai', 165 => 'khokhonthai', 166 => 'khorakhangthai', 167 => 'ngonguthai', 168 => 'chochanthai', 169 => 'chochingthai', 170 => 'chochangthai', 171 => 'sosothai', 172 => 'chochoethai', 173 => 'yoyingthai', 174 => 'dochadathai', 175 => 'topatakthai', 176 => 'thothanthai', 177 => 'thonangmonthothai', 178 => 'thophuthaothai', 179 => 'nonenthai', 180 => 'dodekthai', 181 => 'totaothai', 182 => 'thothungthai', 183 => 'thothahanthai', 184 => 'thothongthai', 185 => 'nonuthai', 186 => 'bobaimaithai', 187 => 'poplathai', 188 => 'phophungthai', 189 => 'fofathai', 190 => 'phophanthai', 191 => 'fofanthai', 192 => 'phosamphaothai', 193 => 'momathai', 194 => 'yoyakthai', 195 => 'roruathai', 196 => 'ruthai', 197 => 'lolingthai', 198 => 'luthai', 199 => 'wowaenthai', 200 => 'sosalathai', 201 => 'sorusithai', 202 => 'sosuathai', 203 => 'hohipthai', 204 => 'lochulathai', 205 => 'oangthai', 206 => 'honokhukthai', 207 => 'paiyannoithai', 208 => 'saraathai', 209 => 'maihanakatthai', 210 => 'saraaathai', 211 => 'saraamthai', 212 => 'saraithai', 213 => 'saraiithai', 214 => 'sarauethai', 215 => 'saraueethai', 216 => 'sarauthai', 217 => 'sarauuthai', 218 => 'phinthuthai', 219 => '.notdef', 220 => '.notdef', 221 => '.notdef', 222 => '.notdef', 223 => 'bahtthai', 224 => 'saraethai', 225 => 'saraaethai', 226 => 'saraothai', 227 => 'saraaimaimuanthai', 228 => 'saraaimaimalaithai', 229 => 'lakkhangyaothai', 230 => 'maiyamokthai', 231 => 'maitaikhuthai', 232 => 'maiekthai', 233 => 'maithothai', 234 => 'maitrithai', 235 => 'maichattawathai', 236 => 'thanthakhatthai', 237 => 'nikhahitthai', 238 => 'yamakkanthai', 239 => 'fongmanthai', 240 => 'zerothai', 241 => 'onethai', 242 => 'twothai', 243 => 'threethai', 244 => 'fourthai', 245 => 'fivethai', 246 => 'sixthai', 247 => 'seventhai', 248 => 'eightthai', 249 => 'ninethai', 250 => 'angkhankhuthai', 251 => 'khomutthai', 252 => '.notdef', 253 => '.notdef', 254 => '.notdef', 255 => '.notdef'),
// encoding map for: iso-8859-15
'iso-8859-15' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => '.notdef', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => '.notdef', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => '.notdef', 146 => '.notdef', 147 => '.notdef', 148 => '.notdef', 149 => '.notdef', 150 => '.notdef', 151 => '.notdef', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'exclamdown', 162 => 'cent', 163 => 'sterling', 164 => 'Euro', 165 => 'yen', 166 => 'Scaron', 167 => 'section', 168 => 'scaron', 169 => 'copyright', 170 => 'ordfeminine', 171 => 'guillemotleft', 172 => 'logicalnot', 173 => 'hyphen', 174 => 'registered', 175 => 'macron', 176 => 'degree', 177 => 'plusminus', 178 => 'twosuperior', 179 => 'threesuperior', 180 => 'Zcaron', 181 => 'mu', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'zcaron', 185 => 'onesuperior', 186 => 'ordmasculine', 187 => 'guillemotright', 188 => 'OE', 189 => 'oe', 190 => 'Ydieresis', 191 => 'questiondown', 192 => 'Agrave', 193 => 'Aacute', 194 => 'Acircumflex', 195 => 'Atilde', 196 => 'Adieresis', 197 => 'Aring', 198 => 'AE', 199 => 'Ccedilla', 200 => 'Egrave', 201 => 'Eacute', 202 => 'Ecircumflex', 203 => 'Edieresis', 204 => 'Igrave', 205 => 'Iacute', 206 => 'Icircumflex', 207 => 'Idieresis', 208 => 'Eth', 209 => 'Ntilde', 210 => 'Ograve', 211 => 'Oacute', 212 => 'Ocircumflex', 213 => 'Otilde', 214 => 'Odieresis', 215 => 'multiply', 216 => 'Oslash', 217 => 'Ugrave', 218 => 'Uacute', 219 => 'Ucircumflex', 220 => 'Udieresis', 221 => 'Yacute', 222 => 'Thorn', 223 => 'germandbls', 224 => 'agrave', 225 => 'aacute', 226 => 'acircumflex', 227 => 'atilde', 228 => 'adieresis', 229 => 'aring', 230 => 'ae', 231 => 'ccedilla', 232 => 'egrave', 233 => 'eacute', 234 => 'ecircumflex', 235 => 'edieresis', 236 => 'igrave', 237 => 'iacute', 238 => 'icircumflex', 239 => 'idieresis', 240 => 'eth', 241 => 'ntilde', 242 => 'ograve', 243 => 'oacute', 244 => 'ocircumflex', 245 => 'otilde', 246 => 'odieresis', 247 => 'divide', 248 => 'oslash', 249 => 'ugrave', 250 => 'uacute', 251 => 'ucircumflex', 252 => 'udieresis', 253 => 'yacute', 254 => 'thorn', 255 => 'ydieresis'),
// encoding map for: iso-8859-16
'iso-8859-16' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => '.notdef', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => '.notdef', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => '.notdef', 146 => '.notdef', 147 => '.notdef', 148 => '.notdef', 149 => '.notdef', 150 => '.notdef', 151 => '.notdef', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'space', 161 => 'Aogonek', 162 => 'aogonek', 163 => 'Lslash', 164 => 'Euro', 165 => 'quotedblbase', 166 => 'Scaron', 167 => 'section', 168 => 'scaron', 169 => 'copyright', 170 => 'Scommaaccent', 171 => 'guillemotleft', 172 => 'Zacute', 173 => 'hyphen', 174 => 'zacute', 175 => 'Zdotaccent', 176 => 'degree', 177 => 'plusminus', 178 => 'Ccaron', 179 => 'lslash', 180 => 'Zcaron', 181 => 'quotedblright', 182 => 'paragraph', 183 => 'periodcentered', 184 => 'zcaron', 185 => 'ccaron', 186 => 'scommaaccent', 187 => 'guillemotright', 188 => 'OE', 189 => 'oe', 190 => 'Ydieresis', 191 => 'zdotaccent', 192 => 'Agrave', 193 => 'Aacute', 194 => 'Acircumflex', 195 => 'Abreve', 196 => 'Adieresis', 197 => 'Cacute', 198 => 'AE', 199 => 'Ccedilla', 200 => 'Egrave', 201 => 'Eacute', 202 => 'Ecircumflex', 203 => 'Edieresis', 204 => 'Igrave', 205 => 'Iacute', 206 => 'Icircumflex', 207 => 'Idieresis', 208 => 'Dcroat', 209 => 'Nacute', 210 => 'Ograve', 211 => 'Oacute', 212 => 'Ocircumflex', 213 => 'Ohungarumlaut', 214 => 'Odieresis', 215 => 'Sacute', 216 => 'Uhungarumlaut', 217 => 'Ugrave', 218 => 'Uacute', 219 => 'Ucircumflex', 220 => 'Udieresis', 221 => 'Eogonek', 222 => 'Tcommaaccent', 223 => 'germandbls', 224 => 'agrave', 225 => 'aacute', 226 => 'acircumflex', 227 => 'abreve', 228 => 'adieresis', 229 => 'cacute', 230 => 'ae', 231 => 'ccedilla', 232 => 'egrave', 233 => 'eacute', 234 => 'ecircumflex', 235 => 'edieresis', 236 => 'igrave', 237 => 'iacute', 238 => 'icircumflex', 239 => 'idieresis', 240 => 'dcroat', 241 => 'nacute', 242 => 'ograve', 243 => 'oacute', 244 => 'ocircumflex', 245 => 'ohungarumlaut', 246 => 'odieresis', 247 => 'sacute', 248 => 'uhungarumlaut', 249 => 'ugrave', 250 => 'uacute', 251 => 'ucircumflex', 252 => 'udieresis', 253 => 'eogonek', 254 => 'tcommaaccent', 255 => 'ydieresis'),
// encoding map for: koi8-r
'koi8-r' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'SF100000', 129 => 'SF110000', 130 => 'SF010000', 131 => 'SF030000', 132 => 'SF020000', 133 => 'SF040000', 134 => 'SF080000', 135 => 'SF090000', 136 => 'SF060000', 137 => 'SF070000', 138 => 'SF050000', 139 => 'upblock', 140 => 'dnblock', 141 => 'block', 142 => 'lfblock', 143 => 'rtblock', 144 => 'ltshade', 145 => 'shade', 146 => 'dkshade', 147 => 'integraltp', 148 => 'filledbox', 149 => 'periodcentered', 150 => 'radical', 151 => 'approxequal', 152 => 'lessequal', 153 => 'greaterequal', 154 => 'space', 155 => 'integralbt', 156 => 'degree', 157 => 'twosuperior', 158 => 'periodcentered', 159 => 'divide', 160 => 'SF430000', 161 => 'SF240000', 162 => 'SF510000', 163 => 'afii10071', 164 => 'SF520000', 165 => 'SF390000', 166 => 'SF220000', 167 => 'SF210000', 168 => 'SF250000', 169 => 'SF500000', 170 => 'SF490000', 171 => 'SF380000', 172 => 'SF280000', 173 => 'SF270000', 174 => 'SF260000', 175 => 'SF360000', 176 => 'SF370000', 177 => 'SF420000', 178 => 'SF190000', 179 => 'afii10023', 180 => 'SF200000', 181 => 'SF230000', 182 => 'SF470000', 183 => 'SF480000', 184 => 'SF410000', 185 => 'SF450000', 186 => 'SF460000', 187 => 'SF400000', 188 => 'SF540000', 189 => 'SF530000', 190 => 'SF440000', 191 => 'copyright', 192 => 'afii10096', 193 => 'afii10065', 194 => 'afii10066', 195 => 'afii10088', 196 => 'afii10069', 197 => 'afii10070', 198 => 'afii10086', 199 => 'afii10068', 200 => 'afii10087', 201 => 'afii10074', 202 => 'afii10075', 203 => 'afii10076', 204 => 'afii10077', 205 => 'afii10078', 206 => 'afii10079', 207 => 'afii10080', 208 => 'afii10081', 209 => 'afii10097', 210 => 'afii10082', 211 => 'afii10083', 212 => 'afii10084', 213 => 'afii10085', 214 => 'afii10072', 215 => 'afii10067', 216 => 'afii10094', 217 => 'afii10093', 218 => 'afii10073', 219 => 'afii10090', 220 => 'afii10095', 221 => 'afii10091', 222 => 'afii10089', 223 => 'afii10092', 224 => 'afii10048', 225 => 'afii10017', 226 => 'afii10018', 227 => 'afii10040', 228 => 'afii10021', 229 => 'afii10022', 230 => 'afii10038', 231 => 'afii10020', 232 => 'afii10039', 233 => 'afii10026', 234 => 'afii10027', 235 => 'afii10028', 236 => 'afii10029', 237 => 'afii10030', 238 => 'afii10031', 239 => 'afii10032', 240 => 'afii10033', 241 => 'afii10049', 242 => 'afii10034', 243 => 'afii10035', 244 => 'afii10036', 245 => 'afii10037', 246 => 'afii10024', 247 => 'afii10019', 248 => 'afii10046', 249 => 'afii10045', 250 => 'afii10025', 251 => 'afii10042', 252 => 'afii10047', 253 => 'afii10043', 254 => 'afii10041', 255 => 'afii10044'),
// encoding map for: koi8-u
'koi8-u' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'quotedbl', 35 => 'numbersign', 36 => 'dollar', 37 => 'percent', 38 => 'ampersand', 39 => 'quotesingle', 40 => 'parenleft', 41 => 'parenright', 42 => 'asterisk', 43 => 'plus', 44 => 'comma', 45 => 'hyphen', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'at', 65 => 'A', 66 => 'B', 67 => 'C', 68 => 'D', 69 => 'E', 70 => 'F', 71 => 'G', 72 => 'H', 73 => 'I', 74 => 'J', 75 => 'K', 76 => 'L', 77 => 'M', 78 => 'N', 79 => 'O', 80 => 'P', 81 => 'Q', 82 => 'R', 83 => 'S', 84 => 'T', 85 => 'U', 86 => 'V', 87 => 'W', 88 => 'X', 89 => 'Y', 90 => 'Z', 91 => 'bracketleft', 92 => 'backslash', 93 => 'bracketright', 94 => 'asciicircum', 95 => 'underscore', 96 => 'grave', 97 => 'a', 98 => 'b', 99 => 'c', 100 => 'd', 101 => 'e', 102 => 'f', 103 => 'g', 104 => 'h', 105 => 'i', 106 => 'j', 107 => 'k', 108 => 'l', 109 => 'm', 110 => 'n', 111 => 'o', 112 => 'p', 113 => 'q', 114 => 'r', 115 => 's', 116 => 't', 117 => 'u', 118 => 'v', 119 => 'w', 120 => 'x', 121 => 'y', 122 => 'z', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'asciitilde', 127 => '.notdef', 128 => 'SF100000', 129 => 'SF110000', 130 => 'SF010000', 131 => 'SF030000', 132 => 'SF020000', 133 => 'SF040000', 134 => 'SF080000', 135 => 'SF090000', 136 => 'SF060000', 137 => 'SF070000', 138 => 'SF050000', 139 => 'upblock', 140 => 'dnblock', 141 => 'block', 142 => 'lfblock', 143 => 'rtblock', 144 => 'ltshade', 145 => 'shade', 146 => 'dkshade', 147 => 'integraltp', 148 => 'filledbox', 149 => 'bullet', 150 => 'radical', 151 => 'approxequal', 152 => 'lessequal', 153 => 'greaterequal', 154 => 'space', 155 => 'integralbt', 156 => 'degree', 157 => 'twosuperior', 158 => 'periodcentered', 159 => 'divide', 160 => 'SF430000', 161 => 'SF240000', 162 => 'SF510000', 163 => 'afii10071', 164 => 'afii10101', 165 => 'SF390000', 166 => 'afii10103', 167 => 'afii10104', 168 => 'SF250000', 169 => 'SF500000', 170 => 'SF490000', 171 => 'SF380000', 172 => 'SF280000', 173 => 'afii10098', 174 => 'SF260000', 175 => 'SF360000', 176 => 'SF370000', 177 => 'SF420000', 178 => 'SF190000', 179 => 'afii10023', 180 => 'afii10053', 181 => 'SF230000', 182 => 'afii10055', 183 => 'afii10056', 184 => 'SF410000', 185 => 'SF450000', 186 => 'SF460000', 187 => 'SF400000', 188 => 'SF540000', 189 => 'afii10050', 190 => 'SF440000', 191 => 'copyright', 192 => 'afii10096', 193 => 'afii10065', 194 => 'afii10066', 195 => 'afii10088', 196 => 'afii10069', 197 => 'afii10070', 198 => 'afii10086', 199 => 'afii10068', 200 => 'afii10087', 201 => 'afii10074', 202 => 'afii10075', 203 => 'afii10076', 204 => 'afii10077', 205 => 'afii10078', 206 => 'afii10079', 207 => 'afii10080', 208 => 'afii10081', 209 => 'afii10097', 210 => 'afii10082', 211 => 'afii10083', 212 => 'afii10084', 213 => 'afii10085', 214 => 'afii10072', 215 => 'afii10067', 216 => 'afii10094', 217 => 'afii10093', 218 => 'afii10073', 219 => 'afii10090', 220 => 'afii10095', 221 => 'afii10091', 222 => 'afii10089', 223 => 'afii10092', 224 => 'afii10048', 225 => 'afii10017', 226 => 'afii10018', 227 => 'afii10040', 228 => 'afii10021', 229 => 'afii10022', 230 => 'afii10038', 231 => 'afii10020', 232 => 'afii10039', 233 => 'afii10026', 234 => 'afii10027', 235 => 'afii10028', 236 => 'afii10029', 237 => 'afii10030', 238 => 'afii10031', 239 => 'afii10032', 240 => 'afii10033', 241 => 'afii10049', 242 => 'afii10034', 243 => 'afii10035', 244 => 'afii10036', 245 => 'afii10037', 246 => 'afii10024', 247 => 'afii10019', 248 => 'afii10046', 249 => 'afii10045', 250 => 'afii10025', 251 => 'afii10042', 252 => 'afii10047', 253 => 'afii10043', 254 => 'afii10041', 255 => 'afii10044'),
// encoding map for: symbol
'symbol' => array(0 => '.notdef', 1 => '.notdef', 2 => '.notdef', 3 => '.notdef', 4 => '.notdef', 5 => '.notdef', 6 => '.notdef', 7 => '.notdef', 8 => '.notdef', 9 => '.notdef', 10 => '.notdef', 11 => '.notdef', 12 => '.notdef', 13 => '.notdef', 14 => '.notdef', 15 => '.notdef', 16 => '.notdef', 17 => '.notdef', 18 => '.notdef', 19 => '.notdef', 20 => '.notdef', 21 => '.notdef', 22 => '.notdef', 23 => '.notdef', 24 => '.notdef', 25 => '.notdef', 26 => '.notdef', 27 => '.notdef', 28 => '.notdef', 29 => '.notdef', 30 => '.notdef', 31 => '.notdef', 32 => 'space', 33 => 'exclam', 34 => 'universal', 35 => 'numbersign', 36 => 'existential', 37 => 'percent', 38 => 'ampersand', 39 => 'suchthat', 40 => 'parenleft', 41 => 'parenright', 42 => 'asteriskmath', 43 => 'plus', 44 => 'comma', 45 => 'minus', 46 => 'period', 47 => 'slash', 48 => 'zero', 49 => 'one', 50 => 'two', 51 => 'three', 52 => 'four', 53 => 'five', 54 => 'six', 55 => 'seven', 56 => 'eight', 57 => 'nine', 58 => 'colon', 59 => 'semicolon', 60 => 'less', 61 => 'equal', 62 => 'greater', 63 => 'question', 64 => 'congruent', 65 => 'Alpha', 66 => 'Beta', 67 => 'Chi', 68 => 'Delta', 69 => 'Epsilon', 70 => 'Phi', 71 => 'Gamma', 72 => 'Eta', 73 => 'Iota', 74 => 'theta1', 75 => 'Kappa', 76 => 'Lambda', 77 => 'Mu', 78 => 'Nu', 79 => 'Omicron', 80 => 'Pi', 81 => 'Theta', 82 => 'Rho', 83 => 'Sigma', 84 => 'Tau', 85 => 'Upsilon', 86 => 'sigma1', 87 => 'Omega', 88 => 'Xi', 89 => 'Psi', 90 => 'Zeta', 91 => 'bracketleft', 92 => 'therefore', 93 => 'bracketright', 94 => 'perpendicular', 95 => 'underscore', 96 => 'radicalex', 97 => 'alpha', 98 => 'beta', 99 => 'chi', 100 => 'delta', 101 => 'epsilon', 102 => 'phi', 103 => 'gamma', 104 => 'eta', 105 => 'iota', 106 => 'phi1', 107 => 'kappa', 108 => 'lambda', 109 => 'mu', 110 => 'nu', 111 => 'omicron', 112 => 'pi', 113 => 'theta', 114 => 'rho', 115 => 'sigma', 116 => 'tau', 117 => 'upsilon', 118 => 'omega1', 119 => 'omega', 120 => 'xi', 121 => 'psi', 122 => 'zeta', 123 => 'braceleft', 124 => 'bar', 125 => 'braceright', 126 => 'similar', 127 => '.notdef', 128 => '.notdef', 129 => '.notdef', 130 => '.notdef', 131 => '.notdef', 132 => '.notdef', 133 => '.notdef', 134 => '.notdef', 135 => '.notdef', 136 => '.notdef', 137 => '.notdef', 138 => '.notdef', 139 => '.notdef', 140 => '.notdef', 141 => '.notdef', 142 => '.notdef', 143 => '.notdef', 144 => '.notdef', 145 => '.notdef', 146 => '.notdef', 147 => '.notdef', 148 => '.notdef', 149 => '.notdef', 150 => '.notdef', 151 => '.notdef', 152 => '.notdef', 153 => '.notdef', 154 => '.notdef', 155 => '.notdef', 156 => '.notdef', 157 => '.notdef', 158 => '.notdef', 159 => '.notdef', 160 => 'Euro', 161 => 'Upsilon1', 162 => 'minute', 163 => 'lessequal', 164 => 'fraction', 165 => 'infinity', 166 => 'florin', 167 => 'club', 168 => 'diamond', 169 => 'heart', 170 => 'spade', 171 => 'arrowboth', 172 => 'arrowleft', 173 => 'arrowup', 174 => 'arrowright', 175 => 'arrowdown', 176 => 'degree', 177 => 'plusminus', 178 => 'second', 179 => 'greaterequal', 180 => 'multiply', 181 => 'proportional', 182 => 'partialdiff', 183 => 'bullet', 184 => 'divide', 185 => 'notequal', 186 => 'equivalence', 187 => 'approxequal', 188 => 'ellipsis', 189 => 'arrowvertex', 190 => 'arrowhorizex', 191 => 'carriagereturn', 192 => 'aleph', 193 => 'Ifraktur', 194 => 'Rfraktur', 195 => 'weierstrass', 196 => 'circlemultiply', 197 => 'circleplus', 198 => 'emptyset', 199 => 'intersection', 200 => 'union', 201 => 'propersuperset', 202 => 'reflexsuperset', 203 => 'notsubset', 204 => 'propersubset', 205 => 'reflexsubset', 206 => 'element', 207 => 'notelement', 208 => 'angle', 209 => 'gradient', 210 => 'registerserif', 211 => 'copyrightserif', 212 => 'trademarkserif', 213 => 'product', 214 => 'radical', 215 => 'dotmath', 216 => 'logicalnot', 217 => 'logicaland', 218 => 'logicalor', 219 => 'arrowdblboth', 220 => 'arrowdblleft', 221 => 'arrowdblup', 222 => 'arrowdblright', 223 => 'arrowdbldown', 224 => 'lozenge', 225 => 'angleleft', 226 => 'registersans', 227 => 'copyrightsans', 228 => 'trademarksans', 229 => 'summation', 230 => 'parenlefttp', 231 => 'parenleftex', 232 => 'parenleftbt', 233 => 'bracketlefttp', 234 => 'bracketleftex', 235 => 'bracketleftbt', 236 => 'bracelefttp', 237 => 'braceleftmid', 238 => 'braceleftbt', 239 => 'braceex', 240 => '.notdef', 241 => 'angleright', 242 => 'integral', 243 => 'integraltp', 244 => 'integralex', 245 => 'integralbt', 246 => 'parenrighttp', 247 => 'parenrightex', 248 => 'parenrightbt', 249 => 'bracketrighttp', 250 => 'bracketrightex', 251 => 'bracketrightbt', 252 => 'bracerighttp', 253 => 'bracerightmid', 254 => 'bracerightbt', 255 => '.notdef', 1226 => 'registered', 1227 => 'copyright', 1228 => 'trademark'),
);
// end of encoding maps
/**
* ToUnicode map for Identity-H stream
* @public static
*/
public static $uni_identity_h = "/CIDInit /ProcSet findresource begin\n12 dict begin\nbegincmap\n/CIDSystemInfo << /Registry (Adobe) /Ordering (UCS) /Supplement 0 >> def\n/CMapName /Adobe-Identity-UCS def\n/CMapType 2 def\n/WMode 0 def\n1 begincodespacerange\n<0000> <FFFF>\nendcodespacerange\n100 beginbfrange\n<0000> <00ff> <0000>\n<0100> <01ff> <0100>\n<0200> <02ff> <0200>\n<0300> <03ff> <0300>\n<0400> <04ff> <0400>\n<0500> <05ff> <0500>\n<0600> <06ff> <0600>\n<0700> <07ff> <0700>\n<0800> <08ff> <0800>\n<0900> <09ff> <0900>\n<0a00> <0aff> <0a00>\n<0b00> <0bff> <0b00>\n<0c00> <0cff> <0c00>\n<0d00> <0dff> <0d00>\n<0e00> <0eff> <0e00>\n<0f00> <0fff> <0f00>\n<1000> <10ff> <1000>\n<1100> <11ff> <1100>\n<1200> <12ff> <1200>\n<1300> <13ff> <1300>\n<1400> <14ff> <1400>\n<1500> <15ff> <1500>\n<1600> <16ff> <1600>\n<1700> <17ff> <1700>\n<1800> <18ff> <1800>\n<1900> <19ff> <1900>\n<1a00> <1aff> <1a00>\n<1b00> <1bff> <1b00>\n<1c00> <1cff> <1c00>\n<1d00> <1dff> <1d00>\n<1e00> <1eff> <1e00>\n<1f00> <1fff> <1f00>\n<2000> <20ff> <2000>\n<2100> <21ff> <2100>\n<2200> <22ff> <2200>\n<2300> <23ff> <2300>\n<2400> <24ff> <2400>\n<2500> <25ff> <2500>\n<2600> <26ff> <2600>\n<2700> <27ff> <2700>\n<2800> <28ff> <2800>\n<2900> <29ff> <2900>\n<2a00> <2aff> <2a00>\n<2b00> <2bff> <2b00>\n<2c00> <2cff> <2c00>\n<2d00> <2dff> <2d00>\n<2e00> <2eff> <2e00>\n<2f00> <2fff> <2f00>\n<3000> <30ff> <3000>\n<3100> <31ff> <3100>\n<3200> <32ff> <3200>\n<3300> <33ff> <3300>\n<3400> <34ff> <3400>\n<3500> <35ff> <3500>\n<3600> <36ff> <3600>\n<3700> <37ff> <3700>\n<3800> <38ff> <3800>\n<3900> <39ff> <3900>\n<3a00> <3aff> <3a00>\n<3b00> <3bff> <3b00>\n<3c00> <3cff> <3c00>\n<3d00> <3dff> <3d00>\n<3e00> <3eff> <3e00>\n<3f00> <3fff> <3f00>\n<4000> <40ff> <4000>\n<4100> <41ff> <4100>\n<4200> <42ff> <4200>\n<4300> <43ff> <4300>\n<4400> <44ff> <4400>\n<4500> <45ff> <4500>\n<4600> <46ff> <4600>\n<4700> <47ff> <4700>\n<4800> <48ff> <4800>\n<4900> <49ff> <4900>\n<4a00> <4aff> <4a00>\n<4b00> <4bff> <4b00>\n<4c00> <4cff> <4c00>\n<4d00> <4dff> <4d00>\n<4e00> <4eff> <4e00>\n<4f00> <4fff> <4f00>\n<5000> <50ff> <5000>\n<5100> <51ff> <5100>\n<5200> <52ff> <5200>\n<5300> <53ff> <5300>\n<5400> <54ff> <5400>\n<5500> <55ff> <5500>\n<5600> <56ff> <5600>\n<5700> <57ff> <5700>\n<5800> <58ff> <5800>\n<5900> <59ff> <5900>\n<5a00> <5aff> <5a00>\n<5b00> <5bff> <5b00>\n<5c00> <5cff> <5c00>\n<5d00> <5dff> <5d00>\n<5e00> <5eff> <5e00>\n<5f00> <5fff> <5f00>\n<6000> <60ff> <6000>\n<6100> <61ff> <6100>\n<6200> <62ff> <6200>\n<6300> <63ff> <6300>\nendbfrange\n100 beginbfrange\n<6400> <64ff> <6400>\n<6500> <65ff> <6500>\n<6600> <66ff> <6600>\n<6700> <67ff> <6700>\n<6800> <68ff> <6800>\n<6900> <69ff> <6900>\n<6a00> <6aff> <6a00>\n<6b00> <6bff> <6b00>\n<6c00> <6cff> <6c00>\n<6d00> <6dff> <6d00>\n<6e00> <6eff> <6e00>\n<6f00> <6fff> <6f00>\n<7000> <70ff> <7000>\n<7100> <71ff> <7100>\n<7200> <72ff> <7200>\n<7300> <73ff> <7300>\n<7400> <74ff> <7400>\n<7500> <75ff> <7500>\n<7600> <76ff> <7600>\n<7700> <77ff> <7700>\n<7800> <78ff> <7800>\n<7900> <79ff> <7900>\n<7a00> <7aff> <7a00>\n<7b00> <7bff> <7b00>\n<7c00> <7cff> <7c00>\n<7d00> <7dff> <7d00>\n<7e00> <7eff> <7e00>\n<7f00> <7fff> <7f00>\n<8000> <80ff> <8000>\n<8100> <81ff> <8100>\n<8200> <82ff> <8200>\n<8300> <83ff> <8300>\n<8400> <84ff> <8400>\n<8500> <85ff> <8500>\n<8600> <86ff> <8600>\n<8700> <87ff> <8700>\n<8800> <88ff> <8800>\n<8900> <89ff> <8900>\n<8a00> <8aff> <8a00>\n<8b00> <8bff> <8b00>\n<8c00> <8cff> <8c00>\n<8d00> <8dff> <8d00>\n<8e00> <8eff> <8e00>\n<8f00> <8fff> <8f00>\n<9000> <90ff> <9000>\n<9100> <91ff> <9100>\n<9200> <92ff> <9200>\n<9300> <93ff> <9300>\n<9400> <94ff> <9400>\n<9500> <95ff> <9500>\n<9600> <96ff> <9600>\n<9700> <97ff> <9700>\n<9800> <98ff> <9800>\n<9900> <99ff> <9900>\n<9a00> <9aff> <9a00>\n<9b00> <9bff> <9b00>\n<9c00> <9cff> <9c00>\n<9d00> <9dff> <9d00>\n<9e00> <9eff> <9e00>\n<9f00> <9fff> <9f00>\n<a000> <a0ff> <a000>\n<a100> <a1ff> <a100>\n<a200> <a2ff> <a200>\n<a300> <a3ff> <a300>\n<a400> <a4ff> <a400>\n<a500> <a5ff> <a500>\n<a600> <a6ff> <a600>\n<a700> <a7ff> <a700>\n<a800> <a8ff> <a800>\n<a900> <a9ff> <a900>\n<aa00> <aaff> <aa00>\n<ab00> <abff> <ab00>\n<ac00> <acff> <ac00>\n<ad00> <adff> <ad00>\n<ae00> <aeff> <ae00>\n<af00> <afff> <af00>\n<b000> <b0ff> <b000>\n<b100> <b1ff> <b100>\n<b200> <b2ff> <b200>\n<b300> <b3ff> <b300>\n<b400> <b4ff> <b400>\n<b500> <b5ff> <b500>\n<b600> <b6ff> <b600>\n<b700> <b7ff> <b700>\n<b800> <b8ff> <b800>\n<b900> <b9ff> <b900>\n<ba00> <baff> <ba00>\n<bb00> <bbff> <bb00>\n<bc00> <bcff> <bc00>\n<bd00> <bdff> <bd00>\n<be00> <beff> <be00>\n<bf00> <bfff> <bf00>\n<c000> <c0ff> <c000>\n<c100> <c1ff> <c100>\n<c200> <c2ff> <c200>\n<c300> <c3ff> <c300>\n<c400> <c4ff> <c400>\n<c500> <c5ff> <c500>\n<c600> <c6ff> <c600>\n<c700> <c7ff> <c700>\nendbfrange\n56 beginbfrange\n<c800> <c8ff> <c800>\n<c900> <c9ff> <c900>\n<ca00> <caff> <ca00>\n<cb00> <cbff> <cb00>\n<cc00> <ccff> <cc00>\n<cd00> <cdff> <cd00>\n<ce00> <ceff> <ce00>\n<cf00> <cfff> <cf00>\n<d000> <d0ff> <d000>\n<d100> <d1ff> <d100>\n<d200> <d2ff> <d200>\n<d300> <d3ff> <d300>\n<d400> <d4ff> <d400>\n<d500> <d5ff> <d500>\n<d600> <d6ff> <d600>\n<d700> <d7ff> <d700>\n<d800> <d8ff> <d800>\n<d900> <d9ff> <d900>\n<da00> <daff> <da00>\n<db00> <dbff> <db00>\n<dc00> <dcff> <dc00>\n<dd00> <ddff> <dd00>\n<de00> <deff> <de00>\n<df00> <dfff> <df00>\n<e000> <e0ff> <e000>\n<e100> <e1ff> <e100>\n<e200> <e2ff> <e200>\n<e300> <e3ff> <e300>\n<e400> <e4ff> <e400>\n<e500> <e5ff> <e500>\n<e600> <e6ff> <e600>\n<e700> <e7ff> <e700>\n<e800> <e8ff> <e800>\n<e900> <e9ff> <e900>\n<ea00> <eaff> <ea00>\n<eb00> <ebff> <eb00>\n<ec00> <ecff> <ec00>\n<ed00> <edff> <ed00>\n<ee00> <eeff> <ee00>\n<ef00> <efff> <ef00>\n<f000> <f0ff> <f000>\n<f100> <f1ff> <f100>\n<f200> <f2ff> <f200>\n<f300> <f3ff> <f300>\n<f400> <f4ff> <f400>\n<f500> <f5ff> <f500>\n<f600> <f6ff> <f600>\n<f700> <f7ff> <f700>\n<f800> <f8ff> <f800>\n<f900> <f9ff> <f900>\n<fa00> <faff> <fa00>\n<fb00> <fbff> <fb00>\n<fc00> <fcff> <fc00>\n<fd00> <fdff> <fd00>\n<fe00> <feff> <fe00>\n<ff00> <ffff> <ff00>\nendbfrange\nendcmap\nCMapName currentdict /CMap defineresource pop\nend\nend";
}
//============================================================+
// File name : tcpdf_static.php
// Version : 1.1.3
// Begin : 2002-08-03
// Last Update : 2015-04-28
// Author : Nicola Asuni - Tecnick.com LTD - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2002-2015 Nicola Asuni - Tecnick.com LTD
//
// This file is part of TCPDF software library.
//
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the License
// along with TCPDF. If not, see
// <http://www.tecnick.com/pagefiles/tcpdf/LICENSE.TXT>.
//
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
//
// Description :
// Static methods used by the TCPDF class.
//
//============================================================+
/**
* @file
* This is a PHP class that contains static methods for the TCPDF class.<br>
* @package com.tecnick.tcpdf
* @author Nicola Asuni
* @version 1.1.2
*/
/**
* @class TCPDF_STATIC
* Static methods used by the TCPDF class.
* @package com.tecnick.tcpdf
* @brief PHP class for generating PDF documents without requiring external extensions.
* @version 1.1.1
* @author Nicola Asuni - info@tecnick.com
*/
class TCPDF_STATIC
{
/**
* String alias for total number of pages.
* @public static
*/
public static $alias_tot_pages = '{:ptp:}';
/**
* String alias for page number.
* @public static
*/
public static $alias_num_page = '{:pnp:}';
/**
* String alias for total number of pages in a single group.
* @public static
*/
public static $alias_group_tot_pages = '{:ptg:}';
/**
* String alias for group page number.
* @public static
*/
public static $alias_group_num_page = '{:png:}';
/**
* String alias for right shift compensation used to correctly align page numbers on the right.
* @public static
*/
public static $alias_right_shift = '{rsc:';
/**
* Encryption padding string.
* @public static
*/
public static $enc_padding = "(\xbfN^Nu\x8aAd\x00NV\xff\xfa\x01\x08..\x00\xb6\xd0h>\x80/\f\xa9\xfedSiz";
/**
* ByteRange placemark used during digital signature process.
* @since 4.6.028 (2009-08-25)
* @public static
*/
public static $byterange_string = '/ByteRange[0 ********** ********** **********]';
/**
* Array page boxes names
* @public static
*/
public static $pageboxes = array('MediaBox', 'CropBox', 'BleedBox', 'TrimBox', 'ArtBox');
// - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
/**
* Return the current TCPDF version.
* @return TCPDF version string
* @since 5.9.012 (2010-11-10)
* @public static
*/
public static function getTCPDFVersion()
{
}
/**
* Return the current TCPDF producer.
* @return TCPDF producer string
* @since 6.0.000 (2013-03-16)
* @public static
*/
public static function getTCPDFProducer()
{
}
/**
* Sets the current active configuration setting of magic_quotes_runtime (if the set_magic_quotes_runtime function exist)
* @param $mqr (boolean) FALSE for off, TRUE for on.
* @since 4.6.025 (2009-08-17)
* @public static
*/
public static function set_mqr($mqr)
{
}
/**
* Gets the current active configuration setting of magic_quotes_runtime (if the get_magic_quotes_runtime function exist)
* @return Returns 0 if magic quotes runtime is off or get_magic_quotes_runtime doesn't exist, 1 otherwise.
* @since 4.6.025 (2009-08-17)
* @public static
*/
public static function get_mqr()
{
}
/**
* Check if the URL exist.
* @param $url (string) URL to check.
* @return Boolean true if the URl exist, false otherwise.
* @since 5.9.204 (2013-01-28)
* @public static
*/
public static function isValidURL($url)
{
}
/**
* Removes SHY characters from text.
* Unicode Data:<ul>
* <li>Name : SOFT HYPHEN, commonly abbreviated as SHY</li>
* <li>HTML Entity (decimal): "&#173;"</li>
* <li>HTML Entity (hex): "&#xad;"</li>
* <li>HTML Entity (named): "&shy;"</li>
* <li>How to type in Microsoft Windows: [Alt +00AD] or [Alt 0173]</li>
* <li>UTF-8 (hex): 0xC2 0xAD (c2ad)</li>
* <li>UTF-8 character: chr(194).chr(173)</li>
* </ul>
* @param $txt (string) input string
* @param $unicode (boolean) True if we are in unicode mode, false otherwise.
* @return string without SHY characters.
* @since (4.5.019) 2009-02-28
* @public static
*/
public static function removeSHY($txt = '', $unicode = \true)
{
}
/**
* Get the border mode accounting for multicell position (opens bottom side of multicell crossing pages)
* @param $brd (mixed) Indicates if borders must be drawn around the cell block. The value can be a number:<ul><li>0: no border (default)</li><li>1: frame</li></ul>or a string containing some or all of the following characters (in any order):<ul><li>L: left</li><li>T: top</li><li>R: right</li><li>B: bottom</li></ul> or an array of line styles for each border group: array('LTRB' => array('width' => 2, 'cap' => 'butt', 'join' => 'miter', 'dash' => 0, 'color' => array(0, 0, 0)))
* @param $position (string) multicell position: 'start', 'middle', 'end'
* @param $opencell (boolean) True when the cell is left open at the page bottom, false otherwise.
* @return border mode array
* @since 4.4.002 (2008-12-09)
* @public static
*/
public static function getBorderMode($brd, $position = 'start', $opencell = \true)
{
}
/**
* Determine whether a string is empty.
* @param $str (string) string to be checked
* @return boolean true if string is empty
* @since 4.5.044 (2009-04-16)
* @public static
*/
public static function empty_string($str)
{
}
/**
* Returns a temporary filename for caching object on filesystem.
* @param $type (string) Type of file (name of the subdir on the tcpdf cache folder).
* @param $file_id (string) TCPDF file_id.
* @return string filename.
* @since 4.5.000 (2008-12-31)
* @public static
*/
public static function getObjFilename($type = 'tmp', $file_id = '')
{
}
/**
* Add "\" before "\", "(" and ")"
* @param $s (string) string to escape.
* @return string escaped string.
* @public static
*/
public static function _escape($s)
{
}
/**
* Escape some special characters (< > &) for XML output.
* @param $str (string) Input string to convert.
* @return converted string
* @since 5.9.121 (2011-09-28)
* @public static
*/
public static function _escapeXML($str)
{
}
/**
* Creates a copy of a class object
* @param $object (object) class object to be cloned
* @return cloned object
* @since 4.5.029 (2009-03-19)
* @public static
*/
public static function objclone($object)
{
}
/**
* Output input data and compress it if possible.
* @param $data (string) Data to output.
* @param $length (int) Data length in bytes.
* @since 5.9.086
* @public static
*/
public static function sendOutputData($data, $length)
{
}
/**
* Replace page number aliases with number.
* @param $page (string) Page content.
* @param $replace (array) Array of replacements (array keys are replacement strings, values are alias arrays).
* @param $diff (int) If passed, this will be set to the total char number difference between alias and replacements.
* @return replaced page content and updated $diff parameter as array.
* @public static
*/
public static function replacePageNumAliases($page, $replace, $diff = 0)
{
}
/**
* Returns timestamp in seconds from formatted date-time.
* @param $date (string) Formatted date-time.
* @return int seconds.
* @since 5.9.152 (2012-03-23)
* @public static
*/
public static function getTimestamp($date)
{
}
/**
* Returns a formatted date-time.
* @param $time (int) Time in seconds.
* @return string escaped date string.
* @since 5.9.152 (2012-03-23)
* @public static
*/
public static function getFormattedDate($time)
{
}
/**
* Returns a string containing random data to be used as a seed for encryption methods.
* @param $seed (string) starting seed value
* @return string containing random data
* @author Nicola Asuni
* @since 5.9.006 (2010-10-19)
* @public static
*/
public static function getRandomSeed($seed = '')
{
}
/**
* Encrypts a string using MD5 and returns it's value as a binary string.
* @param $str (string) input string
* @return String MD5 encrypted binary string
* @since 2.0.000 (2008-01-02)
* @public static
*/
public static function _md5_16($str)
{
}
/**
* Returns the input text exrypted using AES algorithm and the specified key.
* This method requires openssl or mcrypt. Text is padded to 16bytes blocks
* @param $key (string) encryption key
* @param $text (String) input text to be encrypted
* @return String encrypted text
* @author Nicola Asuni
* @since 5.0.005 (2010-05-11)
* @public static
*/
public static function _AES($key, $text)
{
}
/**
* Returns the input text exrypted using AES algorithm and the specified key.
* This method requires openssl or mcrypt. Text is not padded
* @param $key (string) encryption key
* @param $text (String) input text to be encrypted
* @return String encrypted text
* @author Nicola Asuni
* @since TODO
* @public static
*/
public static function _AESnopad($key, $text)
{
}
/**
* Returns the input text encrypted using RC4 algorithm and the specified key.
* RC4 is the standard encryption algorithm used in PDF format
* @param $key (string) Encryption key.
* @param $text (String) Input text to be encrypted.
* @param $last_enc_key (String) Reference to last RC4 key encrypted.
* @param $last_enc_key_c (String) Reference to last RC4 computed key.
* @return String encrypted text
* @since 2.0.000 (2008-01-02)
* @author Klemen Vodopivec, Nicola Asuni
* @public static
*/
public static function _RC4($key, $text, &$last_enc_key, &$last_enc_key_c)
{
}
/**
* Return the permission code used on encryption (P value).
* @param $permissions (Array) the set of permissions (specify the ones you want to block).
* @param $mode (int) encryption strength: 0 = RC4 40 bit; 1 = RC4 128 bit; 2 = AES 128 bit; 3 = AES 256 bit.
* @since 5.0.005 (2010-05-12)
* @author Nicola Asuni
* @public static
*/
public static function getUserPermissionCode($permissions, $mode = 0)
{
}
/**
* Convert hexadecimal string to string
* @param $bs (string) byte-string to convert
* @return String
* @since 5.0.005 (2010-05-12)
* @author Nicola Asuni
* @public static
*/
public static function convertHexStringToString($bs)
{
}
/**
* Convert string to hexadecimal string (byte string)
* @param $s (string) string to convert
* @return byte string
* @since 5.0.010 (2010-05-17)
* @author Nicola Asuni
* @public static
*/
public static function convertStringToHexString($s)
{
}
/**
* Convert encryption P value to a string of bytes, low-order byte first.
* @param $protection (string) 32bit encryption permission value (P value)
* @return String
* @since 5.0.005 (2010-05-12)
* @author Nicola Asuni
* @public static
*/
public static function getEncPermissionsString($protection)
{
}
/**
* Encode a name object.
* @param $name (string) Name object to encode.
* @return (string) Encoded name object.
* @author Nicola Asuni
* @since 5.9.097 (2011-06-23)
* @public static
*/
public static function encodeNameObject($name)
{
}
/**
* Convert JavaScript form fields properties array to Annotation Properties array.
* @param $prop (array) javascript field properties. Possible values are described on official Javascript for Acrobat API reference.
* @param $spot_colors (array) Reference to spot colors array.
* @param $rtl (boolean) True if in Right-To-Left text direction mode, false otherwise.
* @return array of annotation properties
* @author Nicola Asuni
* @since 4.8.000 (2009-09-06)
* @public static
*/
public static function getAnnotOptFromJSProp($prop, &$spot_colors, $rtl = \false)
{
}
/**
* Format the page numbers.
* This method can be overriden for custom formats.
* @param $num (int) page number
* @since 4.2.005 (2008-11-06)
* @public static
*/
public static function formatPageNumber($num)
{
}
/**
* Format the page numbers on the Table Of Content.
* This method can be overriden for custom formats.
* @param $num (int) page number
* @since 4.5.001 (2009-01-04)
* @see addTOC(), addHTMLTOC()
* @public static
*/
public static function formatTOCPageNumber($num)
{
}
/**
* Extracts the CSS properties from a CSS string.
* @param $cssdata (string) string containing CSS definitions.
* @return An array where the keys are the CSS selectors and the values are the CSS properties.
* @author Nicola Asuni
* @since 5.1.000 (2010-05-25)
* @public static
*/
public static function extractCSSproperties($cssdata)
{
}
/**
* Cleanup HTML code (requires HTML Tidy library).
* @param $html (string) htmlcode to fix
* @param $default_css (string) CSS commands to add
* @param $tagvs (array) parameters for setHtmlVSpace method
* @param $tidy_options (array) options for tidy_parse_string function
* @param $tagvspaces (array) Array of vertical spaces for tags.
* @return string XHTML code cleaned up
* @author Nicola Asuni
* @since 5.9.017 (2010-11-16)
* @see setHtmlVSpace()
* @public static
*/
public static function fixHTMLCode($html, $default_css = '', $tagvs = '', $tidy_options = '', &$tagvspaces)
{
}
/**
* Returns true if the CSS selector is valid for the selected HTML tag
* @param $dom (array) array of HTML tags and properties
* @param $key (int) key of the current HTML tag
* @param $selector (string) CSS selector string
* @return true if the selector is valid, false otherwise
* @since 5.1.000 (2010-05-25)
* @public static
*/
public static function isValidCSSSelectorForTag($dom, $key, $selector)
{
}
/**
* Returns the styles array that apply for the selected HTML tag.
* @param $dom (array) array of HTML tags and properties
* @param $key (int) key of the current HTML tag
* @param $css (array) array of CSS properties
* @return array containing CSS properties
* @since 5.1.000 (2010-05-25)
* @public static
*/
public static function getCSSdataArray($dom, $key, $css)
{
}
/**
* Compact CSS data array into single string.
* @param $css (array) array of CSS properties
* @return string containing merged CSS properties
* @since 5.9.070 (2011-04-19)
* @public static
*/
public static function getTagStyleFromCSSarray($css)
{
}
/**
* Returns the Roman representation of an integer number
* @param $number (int) number to convert
* @return string roman representation of the specified number
* @since 4.4.004 (2008-12-10)
* @public static
*/
public static function intToRoman($number)
{
}
/**
* Find position of last occurrence of a substring in a string
* @param $haystack (string) The string to search in.
* @param $needle (string) substring to search.
* @param $offset (int) May be specified to begin searching an arbitrary number of characters into the string.
* @return Returns the position where the needle exists. Returns FALSE if the needle was not found.
* @since 4.8.038 (2010-03-13)
* @public static
*/
public static function revstrpos($haystack, $needle, $offset = 0)
{
}
/**
* Returns an array of hyphenation patterns.
* @param $file (string) TEX file containing hypenation patterns. TEX pattrns can be downloaded from http://www.ctan.org/tex-archive/language/hyph-utf8/tex/generic/hyph-utf8/patterns/
* @return array of hyphenation patterns
* @author Nicola Asuni
* @since 4.9.012 (2010-04-12)
* @public static
*/
public static function getHyphenPatternsFromTEX($file)
{
}
/**
* Get the Path-Painting Operators.
* @param $style (string) Style of rendering. Possible values are:
* <ul>
* <li>S or D: Stroke the path.</li>
* <li>s or d: Close and stroke the path.</li>
* <li>f or F: Fill the path, using the nonzero winding number rule to determine the region to fill.</li>
* <li>f* or F*: Fill the path, using the even-odd rule to determine the region to fill.</li>
* <li>B or FD or DF: Fill and then stroke the path, using the nonzero winding number rule to determine the region to fill.</li>
* <li>B* or F*D or DF*: Fill and then stroke the path, using the even-odd rule to determine the region to fill.</li>
* <li>b or fd or df: Close, fill, and then stroke the path, using the nonzero winding number rule to determine the region to fill.</li>
* <li>b or f*d or df*: Close, fill, and then stroke the path, using the even-odd rule to determine the region to fill.</li>
* <li>CNZ: Clipping mode using the even-odd rule to determine which regions lie inside the clipping path.</li>
* <li>CEO: Clipping mode using the nonzero winding number rule to determine which regions lie inside the clipping path</li>
* <li>n: End the path object without filling or stroking it.</li>
* </ul>
* @param $default (string) default style
* @author Nicola Asuni
* @since 5.0.000 (2010-04-30)
* @public static
*/
public static function getPathPaintOperator($style, $default = 'S')
{
}
/**
* Get the product of two SVG tranformation matrices
* @param $ta (array) first SVG tranformation matrix
* @param $tb (array) second SVG tranformation matrix
* @return transformation array
* @author Nicola Asuni
* @since 5.0.000 (2010-05-02)
* @public static
*/
public static function getTransformationMatrixProduct($ta, $tb)
{
}
/**
* Get the tranformation matrix from SVG transform attribute
* @param $attribute (string) transformation
* @return array of transformations
* @author Nicola Asuni
* @since 5.0.000 (2010-05-02)
* @public static
*/
public static function getSVGTransformMatrix($attribute)
{
}
/**
* Returns the angle in radiants between two vectors
* @param $x1 (int) X coordinate of first vector point
* @param $y1 (int) Y coordinate of first vector point
* @param $x2 (int) X coordinate of second vector point
* @param $y2 (int) Y coordinate of second vector point
* @author Nicola Asuni
* @since 5.0.000 (2010-05-04)
* @public static
*/
public static function getVectorsAngle($x1, $y1, $x2, $y2)
{
}
/**
* Split string by a regular expression.
* This is a wrapper for the preg_split function to avoid the bug: https://bugs.php.net/bug.php?id=45850
* @param $pattern (string) The regular expression pattern to search for without the modifiers, as a string.
* @param $modifiers (string) The modifiers part of the pattern,
* @param $subject (string) The input string.
* @param $limit (int) If specified, then only substrings up to limit are returned with the rest of the string being placed in the last substring. A limit of -1, 0 or NULL means "no limit" and, as is standard across PHP, you can use NULL to skip to the flags parameter.
* @param $flags (int) The flags as specified on the preg_split PHP function.
* @return Returns an array containing substrings of subject split along boundaries matched by pattern.modifier
* @author Nicola Asuni
* @since 6.0.023
* @public static
*/
public static function pregSplit($pattern, $modifiers, $subject, $limit = \NULL, $flags = \NULL)
{
}
/**
* Wrapper to use fopen only with local files
* @param filename (string) Name of the file to open
* @param $mode (string)
* @return Returns a file pointer resource on success, or FALSE on error.
* @public static
*/
public static function fopenLocal($filename, $mode)
{
}
/**
* Check if the URL exist.
* @param url (string) URL to check.
* @return Returns TRUE if the URL exists; FALSE otherwise.
* @public static
*/
public static function url_exists($url)
{
}
/**
* Wrapper for file_exists.
* Checks whether a file or directory exists.
* Only allows some protocols and local files.
* @param filename (string) Path to the file or directory.
* @return Returns TRUE if the file or directory specified by filename exists; FALSE otherwise.
* @public static
*/
public static function file_exists($filename)
{
}
/**
* Reads entire file into a string.
* The file can be also an URL.
* @param $file (string) Name of the file or URL to read.
* @return The function returns the read data or FALSE on failure.
* @author Nicola Asuni
* @since 6.0.025
* @public static
*/
public static function fileGetContents($file)
{
}
/**
* Get ULONG from string (Big Endian 32-bit unsigned integer).
* @param $str (string) string from where to extract value
* @param $offset (int) point from where to read the data
* @return int 32 bit value
* @author Nicola Asuni
* @since 5.2.000 (2010-06-02)
* @public static
*/
public static function _getULONG($str, $offset)
{
}
/**
* Get USHORT from string (Big Endian 16-bit unsigned integer).
* @param $str (string) string from where to extract value
* @param $offset (int) point from where to read the data
* @return int 16 bit value
* @author Nicola Asuni
* @since 5.2.000 (2010-06-02)
* @public static
*/
public static function _getUSHORT($str, $offset)
{
}
/**
* Get SHORT from string (Big Endian 16-bit signed integer).
* @param $str (string) String from where to extract value.
* @param $offset (int) Point from where to read the data.
* @return int 16 bit value
* @author Nicola Asuni
* @since 5.2.000 (2010-06-02)
* @public static
*/
public static function _getSHORT($str, $offset)
{
}
/**
* Get FWORD from string (Big Endian 16-bit signed integer).
* @param $str (string) String from where to extract value.
* @param $offset (int) Point from where to read the data.
* @return int 16 bit value
* @author Nicola Asuni
* @since 5.9.123 (2011-09-30)
* @public static
*/
public static function _getFWORD($str, $offset)
{
}
/**
* Get UFWORD from string (Big Endian 16-bit unsigned integer).
* @param $str (string) string from where to extract value
* @param $offset (int) point from where to read the data
* @return int 16 bit value
* @author Nicola Asuni
* @since 5.9.123 (2011-09-30)
* @public static
*/
public static function _getUFWORD($str, $offset)
{
}
/**
* Get FIXED from string (32-bit signed fixed-point number (16.16).
* @param $str (string) string from where to extract value
* @param $offset (int) point from where to read the data
* @return int 16 bit value
* @author Nicola Asuni
* @since 5.9.123 (2011-09-30)
* @public static
*/
public static function _getFIXED($str, $offset)
{
}
/**
* Get BYTE from string (8-bit unsigned integer).
* @param $str (string) String from where to extract value.
* @param $offset (int) Point from where to read the data.
* @return int 8 bit value
* @author Nicola Asuni
* @since 5.2.000 (2010-06-02)
* @public static
*/
public static function _getBYTE($str, $offset)
{
}
/**
* Binary-safe and URL-safe file read.
* Reads up to length bytes from the file pointer referenced by handle. Reading stops as soon as one of the following conditions is met: length bytes have been read; EOF (end of file) is reached.
* @param $handle (resource)
* @param $length (int)
* @return Returns the read string or FALSE in case of error.
* @author Nicola Asuni
* @since 4.5.027 (2009-03-16)
* @public static
*/
public static function rfread($handle, $length)
{
}
/**
* Read a 4-byte (32 bit) integer from file.
* @param $f (string) file name.
* @return 4-byte integer
* @public static
*/
public static function _freadint($f)
{
}
/**
* Array of page formats
* measures are calculated in this way: (inches * 72) or (millimeters * 72 / 25.4)
* @public static
*/
public static $page_formats = array(
// ISO 216 A Series + 2 SIS 014711 extensions
'A0' => array(2383.937, 3370.394),
// = ( 841 x 1189 ) mm = ( 33.11 x 46.81 ) in
'A1' => array(1683.78, 2383.937),
// = ( 594 x 841 ) mm = ( 23.39 x 33.11 ) in
'A2' => array(1190.551, 1683.78),
// = ( 420 x 594 ) mm = ( 16.54 x 23.39 ) in
'A3' => array(841.89, 1190.551),
// = ( 297 x 420 ) mm = ( 11.69 x 16.54 ) in
'A4' => array(595.276, 841.89),
// = ( 210 x 297 ) mm = ( 8.27 x 11.69 ) in
'A5' => array(419.528, 595.276),
// = ( 148 x 210 ) mm = ( 5.83 x 8.27 ) in
'A6' => array(297.638, 419.528),
// = ( 105 x 148 ) mm = ( 4.13 x 5.83 ) in
'A7' => array(209.764, 297.638),
// = ( 74 x 105 ) mm = ( 2.91 x 4.13 ) in
'A8' => array(147.402, 209.764),
// = ( 52 x 74 ) mm = ( 2.05 x 2.91 ) in
'A9' => array(104.882, 147.402),
// = ( 37 x 52 ) mm = ( 1.46 x 2.05 ) in
'A10' => array(73.70099999999999, 104.882),
// = ( 26 x 37 ) mm = ( 1.02 x 1.46 ) in
'A11' => array(51.024, 73.70099999999999),
// = ( 18 x 26 ) mm = ( 0.71 x 1.02 ) in
'A12' => array(36.85, 51.024),
// = ( 13 x 18 ) mm = ( 0.51 x 0.71 ) in
// ISO 216 B Series + 2 SIS 014711 extensions
'B0' => array(2834.646, 4008.189),
// = ( 1000 x 1414 ) mm = ( 39.37 x 55.67 ) in
'B1' => array(2004.094, 2834.646),
// = ( 707 x 1000 ) mm = ( 27.83 x 39.37 ) in
'B2' => array(1417.323, 2004.094),
// = ( 500 x 707 ) mm = ( 19.69 x 27.83 ) in
'B3' => array(1000.63, 1417.323),
// = ( 353 x 500 ) mm = ( 13.90 x 19.69 ) in
'B4' => array(708.6609999999999, 1000.63),
// = ( 250 x 353 ) mm = ( 9.84 x 13.90 ) in
'B5' => array(498.898, 708.6609999999999),
// = ( 176 x 250 ) mm = ( 6.93 x 9.84 ) in
'B6' => array(354.331, 498.898),
// = ( 125 x 176 ) mm = ( 4.92 x 6.93 ) in
'B7' => array(249.449, 354.331),
// = ( 88 x 125 ) mm = ( 3.46 x 4.92 ) in
'B8' => array(175.748, 249.449),
// = ( 62 x 88 ) mm = ( 2.44 x 3.46 ) in
'B9' => array(124.724, 175.748),
// = ( 44 x 62 ) mm = ( 1.73 x 2.44 ) in
'B10' => array(87.874, 124.724),
// = ( 31 x 44 ) mm = ( 1.22 x 1.73 ) in
'B11' => array(62.362, 87.874),
// = ( 22 x 31 ) mm = ( 0.87 x 1.22 ) in
'B12' => array(42.52, 62.362),
// = ( 15 x 22 ) mm = ( 0.59 x 0.87 ) in
// ISO 216 C Series + 2 SIS 014711 extensions + 5 EXTENSION
'C0' => array(2599.37, 3676.535),
// = ( 917 x 1297 ) mm = ( 36.10 x 51.06 ) in
'C1' => array(1836.85, 2599.37),
// = ( 648 x 917 ) mm = ( 25.51 x 36.10 ) in
'C2' => array(1298.268, 1836.85),
// = ( 458 x 648 ) mm = ( 18.03 x 25.51 ) in
'C3' => array(918.425, 1298.268),
// = ( 324 x 458 ) mm = ( 12.76 x 18.03 ) in
'C4' => array(649.134, 918.425),
// = ( 229 x 324 ) mm = ( 9.02 x 12.76 ) in
'C5' => array(459.213, 649.134),
// = ( 162 x 229 ) mm = ( 6.38 x 9.02 ) in
'C6' => array(323.15, 459.213),
// = ( 114 x 162 ) mm = ( 4.49 x 6.38 ) in
'C7' => array(229.606, 323.15),
// = ( 81 x 114 ) mm = ( 3.19 x 4.49 ) in
'C8' => array(161.575, 229.606),
// = ( 57 x 81 ) mm = ( 2.24 x 3.19 ) in
'C9' => array(113.386, 161.575),
// = ( 40 x 57 ) mm = ( 1.57 x 2.24 ) in
'C10' => array(79.37, 113.386),
// = ( 28 x 40 ) mm = ( 1.10 x 1.57 ) in
'C11' => array(56.693, 79.37),
// = ( 20 x 28 ) mm = ( 0.79 x 1.10 ) in
'C12' => array(39.685, 56.693),
// = ( 14 x 20 ) mm = ( 0.55 x 0.79 ) in
'C76' => array(229.606, 459.213),
// = ( 81 x 162 ) mm = ( 3.19 x 6.38 ) in
'DL' => array(311.811, 623.622),
// = ( 110 x 220 ) mm = ( 4.33 x 8.66 ) in
'DLE' => array(323.15, 637.795),
// = ( 114 x 225 ) mm = ( 4.49 x 8.86 ) in
'DLX' => array(340.158, 666.1420000000001),
// = ( 120 x 235 ) mm = ( 4.72 x 9.25 ) in
'DLP' => array(280.63, 595.276),
// = ( 99 x 210 ) mm = ( 3.90 x 8.27 ) in (1/3 A4)
// SIS 014711 E Series
'E0' => array(2491.654, 3517.795),
// = ( 879 x 1241 ) mm = ( 34.61 x 48.86 ) in
'E1' => array(1757.48, 2491.654),
// = ( 620 x 879 ) mm = ( 24.41 x 34.61 ) in
'E2' => array(1247.244, 1757.48),
// = ( 440 x 620 ) mm = ( 17.32 x 24.41 ) in
'E3' => array(878.74, 1247.244),
// = ( 310 x 440 ) mm = ( 12.20 x 17.32 ) in
'E4' => array(623.622, 878.74),
// = ( 220 x 310 ) mm = ( 8.66 x 12.20 ) in
'E5' => array(439.37, 623.622),
// = ( 155 x 220 ) mm = ( 6.10 x 8.66 ) in
'E6' => array(311.811, 439.37),
// = ( 110 x 155 ) mm = ( 4.33 x 6.10 ) in
'E7' => array(221.102, 311.811),
// = ( 78 x 110 ) mm = ( 3.07 x 4.33 ) in
'E8' => array(155.906, 221.102),
// = ( 55 x 78 ) mm = ( 2.17 x 3.07 ) in
'E9' => array(110.551, 155.906),
// = ( 39 x 55 ) mm = ( 1.54 x 2.17 ) in
'E10' => array(76.535, 110.551),
// = ( 27 x 39 ) mm = ( 1.06 x 1.54 ) in
'E11' => array(53.858, 76.535),
// = ( 19 x 27 ) mm = ( 0.75 x 1.06 ) in
'E12' => array(36.85, 53.858),
// = ( 13 x 19 ) mm = ( 0.51 x 0.75 ) in
// SIS 014711 G Series
'G0' => array(2715.591, 3838.11),
// = ( 958 x 1354 ) mm = ( 37.72 x 53.31 ) in
'G1' => array(1919.055, 2715.591),
// = ( 677 x 958 ) mm = ( 26.65 x 37.72 ) in
'G2' => array(1357.795, 1919.055),
// = ( 479 x 677 ) mm = ( 18.86 x 26.65 ) in
'G3' => array(958.11, 1357.795),
// = ( 338 x 479 ) mm = ( 13.31 x 18.86 ) in
'G4' => array(677.48, 958.11),
// = ( 239 x 338 ) mm = ( 9.41 x 13.31 ) in
'G5' => array(479.055, 677.48),
// = ( 169 x 239 ) mm = ( 6.65 x 9.41 ) in
'G6' => array(337.323, 479.055),
// = ( 119 x 169 ) mm = ( 4.69 x 6.65 ) in
'G7' => array(238.11, 337.323),
// = ( 84 x 119 ) mm = ( 3.31 x 4.69 ) in
'G8' => array(167.244, 238.11),
// = ( 59 x 84 ) mm = ( 2.32 x 3.31 ) in
'G9' => array(119.055, 167.244),
// = ( 42 x 59 ) mm = ( 1.65 x 2.32 ) in
'G10' => array(82.205, 119.055),
// = ( 29 x 42 ) mm = ( 1.14 x 1.65 ) in
'G11' => array(59.528, 82.205),
// = ( 21 x 29 ) mm = ( 0.83 x 1.14 ) in
'G12' => array(39.685, 59.528),
// = ( 14 x 21 ) mm = ( 0.55 x 0.83 ) in
// ISO Press
'RA0' => array(2437.795, 3458.268),
// = ( 860 x 1220 ) mm = ( 33.86 x 48.03 ) in
'RA1' => array(1729.134, 2437.795),
// = ( 610 x 860 ) mm = ( 24.02 x 33.86 ) in
'RA2' => array(1218.898, 1729.134),
// = ( 430 x 610 ) mm = ( 16.93 x 24.02 ) in
'RA3' => array(864.567, 1218.898),
// = ( 305 x 430 ) mm = ( 12.01 x 16.93 ) in
'RA4' => array(609.449, 864.567),
// = ( 215 x 305 ) mm = ( 8.46 x 12.01 ) in
'SRA0' => array(2551.181, 3628.346),
// = ( 900 x 1280 ) mm = ( 35.43 x 50.39 ) in
'SRA1' => array(1814.173, 2551.181),
// = ( 640 x 900 ) mm = ( 25.20 x 35.43 ) in
'SRA2' => array(1275.591, 1814.173),
// = ( 450 x 640 ) mm = ( 17.72 x 25.20 ) in
'SRA3' => array(907.087, 1275.591),
// = ( 320 x 450 ) mm = ( 12.60 x 17.72 ) in
'SRA4' => array(637.795, 907.087),
// = ( 225 x 320 ) mm = ( 8.86 x 12.60 ) in
// German DIN 476
'4A0' => array(4767.874, 6740.787),
// = ( 1682 x 2378 ) mm = ( 66.22 x 93.62 ) in
'2A0' => array(3370.394, 4767.874),
// = ( 1189 x 1682 ) mm = ( 46.81 x 66.22 ) in
// Variations on the ISO Standard
'A2_EXTRA' => array(1261.417, 1754.646),
// = ( 445 x 619 ) mm = ( 17.52 x 24.37 ) in
'A3+' => array(932.598, 1369.134),
// = ( 329 x 483 ) mm = ( 12.95 x 19.02 ) in
'A3_EXTRA' => array(912.756, 1261.417),
// = ( 322 x 445 ) mm = ( 12.68 x 17.52 ) in
'A3_SUPER' => array(864.567, 1440.0),
// = ( 305 x 508 ) mm = ( 12.01 x 20.00 ) in
'SUPER_A3' => array(864.567, 1380.472),
// = ( 305 x 487 ) mm = ( 12.01 x 19.17 ) in
'A4_EXTRA' => array(666.1420000000001, 912.756),
// = ( 235 x 322 ) mm = ( 9.25 x 12.68 ) in
'A4_SUPER' => array(649.134, 912.756),
// = ( 229 x 322 ) mm = ( 9.02 x 12.68 ) in
'SUPER_A4' => array(643.465, 1009.134),
// = ( 227 x 356 ) mm = ( 8.94 x 14.02 ) in
'A4_LONG' => array(595.276, 986.457),
// = ( 210 x 348 ) mm = ( 8.27 x 13.70 ) in
'F4' => array(595.276, 935.433),
// = ( 210 x 330 ) mm = ( 8.27 x 12.99 ) in
'SO_B5_EXTRA' => array(572.598, 782.362),
// = ( 202 x 276 ) mm = ( 7.95 x 10.87 ) in
'A5_EXTRA' => array(490.394, 666.1420000000001),
// = ( 173 x 235 ) mm = ( 6.81 x 9.25 ) in
// ANSI Series
'ANSI_E' => array(2448.0, 3168.0),
// = ( 864 x 1118 ) mm = ( 34.00 x 44.00 ) in
'ANSI_D' => array(1584.0, 2448.0),
// = ( 559 x 864 ) mm = ( 22.00 x 34.00 ) in
'ANSI_C' => array(1224.0, 1584.0),
// = ( 432 x 559 ) mm = ( 17.00 x 22.00 ) in
'ANSI_B' => array(792.0, 1224.0),
// = ( 279 x 432 ) mm = ( 11.00 x 17.00 ) in
'ANSI_A' => array(612.0, 792.0),
// = ( 216 x 279 ) mm = ( 8.50 x 11.00 ) in
// Traditional 'Loose' North American Paper Sizes
'USLEDGER' => array(1224.0, 792.0),
// = ( 432 x 279 ) mm = ( 17.00 x 11.00 ) in
'LEDGER' => array(1224.0, 792.0),
// = ( 432 x 279 ) mm = ( 17.00 x 11.00 ) in
'ORGANIZERK' => array(792.0, 1224.0),
// = ( 279 x 432 ) mm = ( 11.00 x 17.00 ) in
'BIBLE' => array(792.0, 1224.0),
// = ( 279 x 432 ) mm = ( 11.00 x 17.00 ) in
'USTABLOID' => array(792.0, 1224.0),
// = ( 279 x 432 ) mm = ( 11.00 x 17.00 ) in
'TABLOID' => array(792.0, 1224.0),
// = ( 279 x 432 ) mm = ( 11.00 x 17.00 ) in
'ORGANIZERM' => array(612.0, 792.0),
// = ( 216 x 279 ) mm = ( 8.50 x 11.00 ) in
'USLETTER' => array(612.0, 792.0),
// = ( 216 x 279 ) mm = ( 8.50 x 11.00 ) in
'LETTER' => array(612.0, 792.0),
// = ( 216 x 279 ) mm = ( 8.50 x 11.00 ) in
'USLEGAL' => array(612.0, 1008.0),
// = ( 216 x 356 ) mm = ( 8.50 x 14.00 ) in
'LEGAL' => array(612.0, 1008.0),
// = ( 216 x 356 ) mm = ( 8.50 x 14.00 ) in
'GOVERNMENTLETTER' => array(576.0, 756.0),
// = ( 203 x 267 ) mm = ( 8.00 x 10.50 ) in
'GLETTER' => array(576.0, 756.0),
// = ( 203 x 267 ) mm = ( 8.00 x 10.50 ) in
'JUNIORLEGAL' => array(576.0, 360.0),
// = ( 203 x 127 ) mm = ( 8.00 x 5.00 ) in
'JLEGAL' => array(576.0, 360.0),
// = ( 203 x 127 ) mm = ( 8.00 x 5.00 ) in
// Other North American Paper Sizes
'QUADDEMY' => array(2520.0, 3240.0),
// = ( 889 x 1143 ) mm = ( 35.00 x 45.00 ) in
'SUPER_B' => array(936.0, 1368.0),
// = ( 330 x 483 ) mm = ( 13.00 x 19.00 ) in
'QUARTO' => array(648.0, 792.0),
// = ( 229 x 279 ) mm = ( 9.00 x 11.00 ) in
'GOVERNMENTLEGAL' => array(612.0, 936.0),
// = ( 216 x 330 ) mm = ( 8.50 x 13.00 ) in
'FOLIO' => array(612.0, 936.0),
// = ( 216 x 330 ) mm = ( 8.50 x 13.00 ) in
'MONARCH' => array(522.0, 756.0),
// = ( 184 x 267 ) mm = ( 7.25 x 10.50 ) in
'EXECUTIVE' => array(522.0, 756.0),
// = ( 184 x 267 ) mm = ( 7.25 x 10.50 ) in
'ORGANIZERL' => array(396.0, 612.0),
// = ( 140 x 216 ) mm = ( 5.50 x 8.50 ) in
'STATEMENT' => array(396.0, 612.0),
// = ( 140 x 216 ) mm = ( 5.50 x 8.50 ) in
'MEMO' => array(396.0, 612.0),
// = ( 140 x 216 ) mm = ( 5.50 x 8.50 ) in
'FOOLSCAP' => array(595.4400000000001, 936.0),
// = ( 210 x 330 ) mm = ( 8.27 x 13.00 ) in
'COMPACT' => array(306.0, 486.0),
// = ( 108 x 171 ) mm = ( 4.25 x 6.75 ) in
'ORGANIZERJ' => array(198.0, 360.0),
// = ( 70 x 127 ) mm = ( 2.75 x 5.00 ) in
// Canadian standard CAN 2-9.60M
'P1' => array(1587.402, 2437.795),
// = ( 560 x 860 ) mm = ( 22.05 x 33.86 ) in
'P2' => array(1218.898, 1587.402),
// = ( 430 x 560 ) mm = ( 16.93 x 22.05 ) in
'P3' => array(793.701, 1218.898),
// = ( 280 x 430 ) mm = ( 11.02 x 16.93 ) in
'P4' => array(609.449, 793.701),
// = ( 215 x 280 ) mm = ( 8.46 x 11.02 ) in
'P5' => array(396.85, 609.449),
// = ( 140 x 215 ) mm = ( 5.51 x 8.46 ) in
'P6' => array(303.307, 396.85),
// = ( 107 x 140 ) mm = ( 4.21 x 5.51 ) in
// North American Architectural Sizes
'ARCH_E' => array(2592.0, 3456.0),
// = ( 914 x 1219 ) mm = ( 36.00 x 48.00 ) in
'ARCH_E1' => array(2160.0, 3024.0),
// = ( 762 x 1067 ) mm = ( 30.00 x 42.00 ) in
'ARCH_D' => array(1728.0, 2592.0),
// = ( 610 x 914 ) mm = ( 24.00 x 36.00 ) in
'BROADSHEET' => array(1296.0, 1728.0),
// = ( 457 x 610 ) mm = ( 18.00 x 24.00 ) in
'ARCH_C' => array(1296.0, 1728.0),
// = ( 457 x 610 ) mm = ( 18.00 x 24.00 ) in
'ARCH_B' => array(864.0, 1296.0),
// = ( 305 x 457 ) mm = ( 12.00 x 18.00 ) in
'ARCH_A' => array(648.0, 864.0),
// = ( 229 x 305 ) mm = ( 9.00 x 12.00 ) in
// -- North American Envelope Sizes
// - Announcement Envelopes
'ANNENV_A2' => array(314.64, 414.0),
// = ( 111 x 146 ) mm = ( 4.37 x 5.75 ) in
'ANNENV_A6' => array(342.0, 468.0),
// = ( 121 x 165 ) mm = ( 4.75 x 6.50 ) in
'ANNENV_A7' => array(378.0, 522.0),
// = ( 133 x 184 ) mm = ( 5.25 x 7.25 ) in
'ANNENV_A8' => array(396.0, 584.64),
// = ( 140 x 206 ) mm = ( 5.50 x 8.12 ) in
'ANNENV_A10' => array(450.0, 692.64),
// = ( 159 x 244 ) mm = ( 6.25 x 9.62 ) in
'ANNENV_SLIM' => array(278.64, 638.64),
// = ( 98 x 225 ) mm = ( 3.87 x 8.87 ) in
// - Commercial Envelopes
'COMMENV_N6_1/4' => array(252.0, 432.0),
// = ( 89 x 152 ) mm = ( 3.50 x 6.00 ) in
'COMMENV_N6_3/4' => array(260.64, 468.0),
// = ( 92 x 165 ) mm = ( 3.62 x 6.50 ) in
'COMMENV_N8' => array(278.64, 540.0),
// = ( 98 x 191 ) mm = ( 3.87 x 7.50 ) in
'COMMENV_N9' => array(278.64, 638.64),
// = ( 98 x 225 ) mm = ( 3.87 x 8.87 ) in
'COMMENV_N10' => array(296.64, 684.0),
// = ( 105 x 241 ) mm = ( 4.12 x 9.50 ) in
'COMMENV_N11' => array(324.0, 746.64),
// = ( 114 x 263 ) mm = ( 4.50 x 10.37 ) in
'COMMENV_N12' => array(342.0, 792.0),
// = ( 121 x 279 ) mm = ( 4.75 x 11.00 ) in
'COMMENV_N14' => array(360.0, 828.0),
// = ( 127 x 292 ) mm = ( 5.00 x 11.50 ) in
// - Catalogue Envelopes
'CATENV_N1' => array(432.0, 648.0),
// = ( 152 x 229 ) mm = ( 6.00 x 9.00 ) in
'CATENV_N1_3/4' => array(468.0, 684.0),
// = ( 165 x 241 ) mm = ( 6.50 x 9.50 ) in
'CATENV_N2' => array(468.0, 720.0),
// = ( 165 x 254 ) mm = ( 6.50 x 10.00 ) in
'CATENV_N3' => array(504.0, 720.0),
// = ( 178 x 254 ) mm = ( 7.00 x 10.00 ) in
'CATENV_N6' => array(540.0, 756.0),
// = ( 191 x 267 ) mm = ( 7.50 x 10.50 ) in
'CATENV_N7' => array(576.0, 792.0),
// = ( 203 x 279 ) mm = ( 8.00 x 11.00 ) in
'CATENV_N8' => array(594.0, 810.0),
// = ( 210 x 286 ) mm = ( 8.25 x 11.25 ) in
'CATENV_N9_1/2' => array(612.0, 756.0),
// = ( 216 x 267 ) mm = ( 8.50 x 10.50 ) in
'CATENV_N9_3/4' => array(630.0, 810.0),
// = ( 222 x 286 ) mm = ( 8.75 x 11.25 ) in
'CATENV_N10_1/2' => array(648.0, 864.0),
// = ( 229 x 305 ) mm = ( 9.00 x 12.00 ) in
'CATENV_N12_1/2' => array(684.0, 900.0),
// = ( 241 x 318 ) mm = ( 9.50 x 12.50 ) in
'CATENV_N13_1/2' => array(720.0, 936.0),
// = ( 254 x 330 ) mm = ( 10.00 x 13.00 ) in
'CATENV_N14_1/4' => array(810.0, 882.0),
// = ( 286 x 311 ) mm = ( 11.25 x 12.25 ) in
'CATENV_N14_1/2' => array(828.0, 1044.0),
// = ( 292 x 368 ) mm = ( 11.50 x 14.50 ) in
// Japanese (JIS P 0138-61) Standard B-Series
'JIS_B0' => array(2919.685, 4127.244),
// = ( 1030 x 1456 ) mm = ( 40.55 x 57.32 ) in
'JIS_B1' => array(2063.622, 2919.685),
// = ( 728 x 1030 ) mm = ( 28.66 x 40.55 ) in
'JIS_B2' => array(1459.843, 2063.622),
// = ( 515 x 728 ) mm = ( 20.28 x 28.66 ) in
'JIS_B3' => array(1031.811, 1459.843),
// = ( 364 x 515 ) mm = ( 14.33 x 20.28 ) in
'JIS_B4' => array(728.504, 1031.811),
// = ( 257 x 364 ) mm = ( 10.12 x 14.33 ) in
'JIS_B5' => array(515.9059999999999, 728.504),
// = ( 182 x 257 ) mm = ( 7.17 x 10.12 ) in
'JIS_B6' => array(362.835, 515.9059999999999),
// = ( 128 x 182 ) mm = ( 5.04 x 7.17 ) in
'JIS_B7' => array(257.953, 362.835),
// = ( 91 x 128 ) mm = ( 3.58 x 5.04 ) in
'JIS_B8' => array(181.417, 257.953),
// = ( 64 x 91 ) mm = ( 2.52 x 3.58 ) in
'JIS_B9' => array(127.559, 181.417),
// = ( 45 x 64 ) mm = ( 1.77 x 2.52 ) in
'JIS_B10' => array(90.709, 127.559),
// = ( 32 x 45 ) mm = ( 1.26 x 1.77 ) in
'JIS_B11' => array(62.362, 90.709),
// = ( 22 x 32 ) mm = ( 0.87 x 1.26 ) in
'JIS_B12' => array(45.354, 62.362),
// = ( 16 x 22 ) mm = ( 0.63 x 0.87 ) in
// PA Series
'PA0' => array(2381.102, 3174.803),
// = ( 840 x 1120 ) mm = ( 33.07 x 44.09 ) in
'PA1' => array(1587.402, 2381.102),
// = ( 560 x 840 ) mm = ( 22.05 x 33.07 ) in
'PA2' => array(1190.551, 1587.402),
// = ( 420 x 560 ) mm = ( 16.54 x 22.05 ) in
'PA3' => array(793.701, 1190.551),
// = ( 280 x 420 ) mm = ( 11.02 x 16.54 ) in
'PA4' => array(595.276, 793.701),
// = ( 210 x 280 ) mm = ( 8.27 x 11.02 ) in
'PA5' => array(396.85, 595.276),
// = ( 140 x 210 ) mm = ( 5.51 x 8.27 ) in
'PA6' => array(297.638, 396.85),
// = ( 105 x 140 ) mm = ( 4.13 x 5.51 ) in
'PA7' => array(198.425, 297.638),
// = ( 70 x 105 ) mm = ( 2.76 x 4.13 ) in
'PA8' => array(147.402, 198.425),
// = ( 52 x 70 ) mm = ( 2.05 x 2.76 ) in
'PA9' => array(99.21299999999999, 147.402),
// = ( 35 x 52 ) mm = ( 1.38 x 2.05 ) in
'PA10' => array(73.70099999999999, 99.21299999999999),
// = ( 26 x 35 ) mm = ( 1.02 x 1.38 ) in
// Standard Photographic Print Sizes
'PASSPORT_PHOTO' => array(99.21299999999999, 127.559),
// = ( 35 x 45 ) mm = ( 1.38 x 1.77 ) in
'E' => array(233.858, 340.157),
// = ( 82 x 120 ) mm = ( 3.25 x 4.72 ) in
'L' => array(252.283, 360.0),
// = ( 89 x 127 ) mm = ( 3.50 x 5.00 ) in
'3R' => array(252.283, 360.0),
// = ( 89 x 127 ) mm = ( 3.50 x 5.00 ) in
'KG' => array(289.134, 430.866),
// = ( 102 x 152 ) mm = ( 4.02 x 5.98 ) in
'4R' => array(289.134, 430.866),
// = ( 102 x 152 ) mm = ( 4.02 x 5.98 ) in
'4D' => array(340.157, 430.866),
// = ( 120 x 152 ) mm = ( 4.72 x 5.98 ) in
'2L' => array(360.0, 504.567),
// = ( 127 x 178 ) mm = ( 5.00 x 7.01 ) in
'5R' => array(360.0, 504.567),
// = ( 127 x 178 ) mm = ( 5.00 x 7.01 ) in
'8P' => array(430.866, 575.433),
// = ( 152 x 203 ) mm = ( 5.98 x 7.99 ) in
'6R' => array(430.866, 575.433),
// = ( 152 x 203 ) mm = ( 5.98 x 7.99 ) in
'6P' => array(575.433, 720.0),
// = ( 203 x 254 ) mm = ( 7.99 x 10.00 ) in
'8R' => array(575.433, 720.0),
// = ( 203 x 254 ) mm = ( 7.99 x 10.00 ) in
'6PW' => array(575.433, 864.567),
// = ( 203 x 305 ) mm = ( 7.99 x 12.01 ) in
'S8R' => array(575.433, 864.567),
// = ( 203 x 305 ) mm = ( 7.99 x 12.01 ) in
'4P' => array(720.0, 864.567),
// = ( 254 x 305 ) mm = ( 10.00 x 12.01 ) in
'10R' => array(720.0, 864.567),
// = ( 254 x 305 ) mm = ( 10.00 x 12.01 ) in
'4PW' => array(720.0, 1080.0),
// = ( 254 x 381 ) mm = ( 10.00 x 15.00 ) in
'S10R' => array(720.0, 1080.0),
// = ( 254 x 381 ) mm = ( 10.00 x 15.00 ) in
'11R' => array(790.866, 1009.134),
// = ( 279 x 356 ) mm = ( 10.98 x 14.02 ) in
'S11R' => array(790.866, 1224.567),
// = ( 279 x 432 ) mm = ( 10.98 x 17.01 ) in
'12R' => array(864.567, 1080.0),
// = ( 305 x 381 ) mm = ( 12.01 x 15.00 ) in
'S12R' => array(864.567, 1292.598),
// = ( 305 x 456 ) mm = ( 12.01 x 17.95 ) in
// Common Newspaper Sizes
'NEWSPAPER_BROADSHEET' => array(2125.984, 1700.787),
// = ( 750 x 600 ) mm = ( 29.53 x 23.62 ) in
'NEWSPAPER_BERLINER' => array(1332.283, 892.913),
// = ( 470 x 315 ) mm = ( 18.50 x 12.40 ) in
'NEWSPAPER_TABLOID' => array(1218.898, 793.701),
// = ( 430 x 280 ) mm = ( 16.93 x 11.02 ) in
'NEWSPAPER_COMPACT' => array(1218.898, 793.701),
// = ( 430 x 280 ) mm = ( 16.93 x 11.02 ) in
// Business Cards
'CREDIT_CARD' => array(153.014, 242.646),
// = ( 54 x 86 ) mm = ( 2.13 x 3.37 ) in
'BUSINESS_CARD' => array(153.014, 242.646),
// = ( 54 x 86 ) mm = ( 2.13 x 3.37 ) in
'BUSINESS_CARD_ISO7810' => array(153.014, 242.646),
// = ( 54 x 86 ) mm = ( 2.13 x 3.37 ) in
'BUSINESS_CARD_ISO216' => array(147.402, 209.764),
// = ( 52 x 74 ) mm = ( 2.05 x 2.91 ) in
'BUSINESS_CARD_IT' => array(155.906, 240.945),
// = ( 55 x 85 ) mm = ( 2.17 x 3.35 ) in
'BUSINESS_CARD_UK' => array(155.906, 240.945),
// = ( 55 x 85 ) mm = ( 2.17 x 3.35 ) in
'BUSINESS_CARD_FR' => array(155.906, 240.945),
// = ( 55 x 85 ) mm = ( 2.17 x 3.35 ) in
'BUSINESS_CARD_DE' => array(155.906, 240.945),
// = ( 55 x 85 ) mm = ( 2.17 x 3.35 ) in
'BUSINESS_CARD_ES' => array(155.906, 240.945),
// = ( 55 x 85 ) mm = ( 2.17 x 3.35 ) in
'BUSINESS_CARD_CA' => array(144.567, 252.283),
// = ( 51 x 89 ) mm = ( 2.01 x 3.50 ) in
'BUSINESS_CARD_US' => array(144.567, 252.283),
// = ( 51 x 89 ) mm = ( 2.01 x 3.50 ) in
'BUSINESS_CARD_JP' => array(155.906, 257.953),
// = ( 55 x 91 ) mm = ( 2.17 x 3.58 ) in
'BUSINESS_CARD_HK' => array(153.071, 255.118),
// = ( 54 x 90 ) mm = ( 2.13 x 3.54 ) in
'BUSINESS_CARD_AU' => array(155.906, 255.118),
// = ( 55 x 90 ) mm = ( 2.17 x 3.54 ) in
'BUSINESS_CARD_DK' => array(155.906, 255.118),
// = ( 55 x 90 ) mm = ( 2.17 x 3.54 ) in
'BUSINESS_CARD_SE' => array(155.906, 255.118),
// = ( 55 x 90 ) mm = ( 2.17 x 3.54 ) in
'BUSINESS_CARD_RU' => array(141.732, 255.118),
// = ( 50 x 90 ) mm = ( 1.97 x 3.54 ) in
'BUSINESS_CARD_CZ' => array(141.732, 255.118),
// = ( 50 x 90 ) mm = ( 1.97 x 3.54 ) in
'BUSINESS_CARD_FI' => array(141.732, 255.118),
// = ( 50 x 90 ) mm = ( 1.97 x 3.54 ) in
'BUSINESS_CARD_HU' => array(141.732, 255.118),
// = ( 50 x 90 ) mm = ( 1.97 x 3.54 ) in
'BUSINESS_CARD_IL' => array(141.732, 255.118),
// = ( 50 x 90 ) mm = ( 1.97 x 3.54 ) in
// Billboards
'4SHEET' => array(2880.0, 4320.0),
// = ( 1016 x 1524 ) mm = ( 40.00 x 60.00 ) in
'6SHEET' => array(3401.575, 5102.362),
// = ( 1200 x 1800 ) mm = ( 47.24 x 70.87 ) in
'12SHEET' => array(8640.0, 4320.0),
// = ( 3048 x 1524 ) mm = (120.00 x 60.00 ) in
'16SHEET' => array(5760.0, 8640.0),
// = ( 2032 x 3048 ) mm = ( 80.00 x 120.00) in
'32SHEET' => array(11520.0, 8640.0),
// = ( 4064 x 3048 ) mm = (160.00 x 120.00) in
'48SHEET' => array(17280.0, 8640.0),
// = ( 6096 x 3048 ) mm = (240.00 x 120.00) in
'64SHEET' => array(23040.0, 8640.0),
// = ( 8128 x 3048 ) mm = (320.00 x 120.00) in
'96SHEET' => array(34560.0, 8640.0),
// = (12192 x 3048 ) mm = (480.00 x 120.00) in
// -- Old European Sizes
// - Old Imperial English Sizes
'EN_EMPEROR' => array(3456.0, 5184.0),
// = ( 1219 x 1829 ) mm = ( 48.00 x 72.00 ) in
'EN_ANTIQUARIAN' => array(2232.0, 3816.0),
// = ( 787 x 1346 ) mm = ( 31.00 x 53.00 ) in
'EN_GRAND_EAGLE' => array(2070.0, 3024.0),
// = ( 730 x 1067 ) mm = ( 28.75 x 42.00 ) in
'EN_DOUBLE_ELEPHANT' => array(1926.0, 2880.0),
// = ( 679 x 1016 ) mm = ( 26.75 x 40.00 ) in
'EN_ATLAS' => array(1872.0, 2448.0),
// = ( 660 x 864 ) mm = ( 26.00 x 34.00 ) in
'EN_COLOMBIER' => array(1692.0, 2484.0),
// = ( 597 x 876 ) mm = ( 23.50 x 34.50 ) in
'EN_ELEPHANT' => array(1656.0, 2016.0),
// = ( 584 x 711 ) mm = ( 23.00 x 28.00 ) in
'EN_DOUBLE_DEMY' => array(1620.0, 2556.0),
// = ( 572 x 902 ) mm = ( 22.50 x 35.50 ) in
'EN_IMPERIAL' => array(1584.0, 2160.0),
// = ( 559 x 762 ) mm = ( 22.00 x 30.00 ) in
'EN_PRINCESS' => array(1548.0, 2016.0),
// = ( 546 x 711 ) mm = ( 21.50 x 28.00 ) in
'EN_CARTRIDGE' => array(1512.0, 1872.0),
// = ( 533 x 660 ) mm = ( 21.00 x 26.00 ) in
'EN_DOUBLE_LARGE_POST' => array(1512.0, 2376.0),
// = ( 533 x 838 ) mm = ( 21.00 x 33.00 ) in
'EN_ROYAL' => array(1440.0, 1800.0),
// = ( 508 x 635 ) mm = ( 20.00 x 25.00 ) in
'EN_SHEET' => array(1404.0, 1692.0),
// = ( 495 x 597 ) mm = ( 19.50 x 23.50 ) in
'EN_HALF_POST' => array(1404.0, 1692.0),
// = ( 495 x 597 ) mm = ( 19.50 x 23.50 ) in
'EN_SUPER_ROYAL' => array(1368.0, 1944.0),
// = ( 483 x 686 ) mm = ( 19.00 x 27.00 ) in
'EN_DOUBLE_POST' => array(1368.0, 2196.0),
// = ( 483 x 775 ) mm = ( 19.00 x 30.50 ) in
'EN_MEDIUM' => array(1260.0, 1656.0),
// = ( 445 x 584 ) mm = ( 17.50 x 23.00 ) in
'EN_DEMY' => array(1260.0, 1620.0),
// = ( 445 x 572 ) mm = ( 17.50 x 22.50 ) in
'EN_LARGE_POST' => array(1188.0, 1512.0),
// = ( 419 x 533 ) mm = ( 16.50 x 21.00 ) in
'EN_COPY_DRAUGHT' => array(1152.0, 1440.0),
// = ( 406 x 508 ) mm = ( 16.00 x 20.00 ) in
'EN_POST' => array(1116.0, 1386.0),
// = ( 394 x 489 ) mm = ( 15.50 x 19.25 ) in
'EN_CROWN' => array(1080.0, 1440.0),
// = ( 381 x 508 ) mm = ( 15.00 x 20.00 ) in
'EN_PINCHED_POST' => array(1062.0, 1332.0),
// = ( 375 x 470 ) mm = ( 14.75 x 18.50 ) in
'EN_BRIEF' => array(972.0, 1152.0),
// = ( 343 x 406 ) mm = ( 13.50 x 16.00 ) in
'EN_FOOLSCAP' => array(972.0, 1224.0),
// = ( 343 x 432 ) mm = ( 13.50 x 17.00 ) in
'EN_SMALL_FOOLSCAP' => array(954.0, 1188.0),
// = ( 337 x 419 ) mm = ( 13.25 x 16.50 ) in
'EN_POTT' => array(900.0, 1080.0),
// = ( 318 x 381 ) mm = ( 12.50 x 15.00 ) in
// - Old Imperial Belgian Sizes
'BE_GRAND_AIGLE' => array(1984.252, 2948.031),
// = ( 700 x 1040 ) mm = ( 27.56 x 40.94 ) in
'BE_COLOMBIER' => array(1757.48, 2409.449),
// = ( 620 x 850 ) mm = ( 24.41 x 33.46 ) in
'BE_DOUBLE_CARRE' => array(1757.48, 2607.874),
// = ( 620 x 920 ) mm = ( 24.41 x 36.22 ) in
'BE_ELEPHANT' => array(1746.142, 2182.677),
// = ( 616 x 770 ) mm = ( 24.25 x 30.31 ) in
'BE_PETIT_AIGLE' => array(1700.787, 2381.102),
// = ( 600 x 840 ) mm = ( 23.62 x 33.07 ) in
'BE_GRAND_JESUS' => array(1559.055, 2069.291),
// = ( 550 x 730 ) mm = ( 21.65 x 28.74 ) in
'BE_JESUS' => array(1530.709, 2069.291),
// = ( 540 x 730 ) mm = ( 21.26 x 28.74 ) in
'BE_RAISIN' => array(1417.323, 1842.52),
// = ( 500 x 650 ) mm = ( 19.69 x 25.59 ) in
'BE_GRAND_MEDIAN' => array(1303.937, 1714.961),
// = ( 460 x 605 ) mm = ( 18.11 x 23.82 ) in
'BE_DOUBLE_POSTE' => array(1233.071, 1601.575),
// = ( 435 x 565 ) mm = ( 17.13 x 22.24 ) in
'BE_COQUILLE' => array(1218.898, 1587.402),
// = ( 430 x 560 ) mm = ( 16.93 x 22.05 ) in
'BE_PETIT_MEDIAN' => array(1176.378, 1502.362),
// = ( 415 x 530 ) mm = ( 16.34 x 20.87 ) in
'BE_RUCHE' => array(1020.472, 1303.937),
// = ( 360 x 460 ) mm = ( 14.17 x 18.11 ) in
'BE_PROPATRIA' => array(977.953, 1218.898),
// = ( 345 x 430 ) mm = ( 13.58 x 16.93 ) in
'BE_LYS' => array(898.583, 1125.354),
// = ( 317 x 397 ) mm = ( 12.48 x 15.63 ) in
'BE_POT' => array(870.236, 1088.504),
// = ( 307 x 384 ) mm = ( 12.09 x 15.12 ) in
'BE_ROSETTE' => array(765.354, 983.622),
// = ( 270 x 347 ) mm = ( 10.63 x 13.66 ) in
// - Old Imperial French Sizes
'FR_UNIVERS' => array(2834.646, 3685.039),
// = ( 1000 x 1300 ) mm = ( 39.37 x 51.18 ) in
'FR_DOUBLE_COLOMBIER' => array(2551.181, 3571.654),
// = ( 900 x 1260 ) mm = ( 35.43 x 49.61 ) in
'FR_GRANDE_MONDE' => array(2551.181, 3571.654),
// = ( 900 x 1260 ) mm = ( 35.43 x 49.61 ) in
'FR_DOUBLE_SOLEIL' => array(2267.717, 3401.575),
// = ( 800 x 1200 ) mm = ( 31.50 x 47.24 ) in
'FR_DOUBLE_JESUS' => array(2154.331, 3174.803),
// = ( 760 x 1120 ) mm = ( 29.92 x 44.09 ) in
'FR_GRAND_AIGLE' => array(2125.984, 3004.724),
// = ( 750 x 1060 ) mm = ( 29.53 x 41.73 ) in
'FR_PETIT_AIGLE' => array(1984.252, 2664.567),
// = ( 700 x 940 ) mm = ( 27.56 x 37.01 ) in
'FR_DOUBLE_RAISIN' => array(1842.52, 2834.646),
// = ( 650 x 1000 ) mm = ( 25.59 x 39.37 ) in
'FR_JOURNAL' => array(1842.52, 2664.567),
// = ( 650 x 940 ) mm = ( 25.59 x 37.01 ) in
'FR_COLOMBIER_AFFICHE' => array(1785.827, 2551.181),
// = ( 630 x 900 ) mm = ( 24.80 x 35.43 ) in
'FR_DOUBLE_CAVALIER' => array(1757.48, 2607.874),
// = ( 620 x 920 ) mm = ( 24.41 x 36.22 ) in
'FR_CLOCHE' => array(1700.787, 2267.717),
// = ( 600 x 800 ) mm = ( 23.62 x 31.50 ) in
'FR_SOLEIL' => array(1700.787, 2267.717),
// = ( 600 x 800 ) mm = ( 23.62 x 31.50 ) in
'FR_DOUBLE_CARRE' => array(1587.402, 2551.181),
// = ( 560 x 900 ) mm = ( 22.05 x 35.43 ) in
'FR_DOUBLE_COQUILLE' => array(1587.402, 2494.488),
// = ( 560 x 880 ) mm = ( 22.05 x 34.65 ) in
'FR_JESUS' => array(1587.402, 2154.331),
// = ( 560 x 760 ) mm = ( 22.05 x 29.92 ) in
'FR_RAISIN' => array(1417.323, 1842.52),
// = ( 500 x 650 ) mm = ( 19.69 x 25.59 ) in
'FR_CAVALIER' => array(1303.937, 1757.48),
// = ( 460 x 620 ) mm = ( 18.11 x 24.41 ) in
'FR_DOUBLE_COURONNE' => array(1303.937, 2040.945),
// = ( 460 x 720 ) mm = ( 18.11 x 28.35 ) in
'FR_CARRE' => array(1275.591, 1587.402),
// = ( 450 x 560 ) mm = ( 17.72 x 22.05 ) in
'FR_COQUILLE' => array(1247.244, 1587.402),
// = ( 440 x 560 ) mm = ( 17.32 x 22.05 ) in
'FR_DOUBLE_TELLIERE' => array(1247.244, 1927.559),
// = ( 440 x 680 ) mm = ( 17.32 x 26.77 ) in
'FR_DOUBLE_CLOCHE' => array(1133.858, 1700.787),
// = ( 400 x 600 ) mm = ( 15.75 x 23.62 ) in
'FR_DOUBLE_POT' => array(1133.858, 1757.48),
// = ( 400 x 620 ) mm = ( 15.75 x 24.41 ) in
'FR_ECU' => array(1133.858, 1474.016),
// = ( 400 x 520 ) mm = ( 15.75 x 20.47 ) in
'FR_COURONNE' => array(1020.472, 1303.937),
// = ( 360 x 460 ) mm = ( 14.17 x 18.11 ) in
'FR_TELLIERE' => array(963.78, 1247.244),
// = ( 340 x 440 ) mm = ( 13.39 x 17.32 ) in
'FR_POT' => array(878.74, 1133.858),
);
/**
* Get page dimensions from format name.
* @param $format (mixed) The format name @see self::$page_format<ul>
* @return array containing page width and height in points
* @since 5.0.010 (2010-05-17)
* @public static
*/
public static function getPageSizeFromFormat($format)
{
}
/**
* Set page boundaries.
* @param $page (int) page number
* @param $type (string) valid values are: <ul><li>'MediaBox' : the boundaries of the physical medium on which the page shall be displayed or printed;</li><li>'CropBox' : the visible region of default user space;</li><li>'BleedBox' : the region to which the contents of the page shall be clipped when output in a production environment;</li><li>'TrimBox' : the intended dimensions of the finished page after trimming;</li><li>'ArtBox' : the page's meaningful content (including potential white space).</li></ul>
* @param $llx (float) lower-left x coordinate in user units.
* @param $lly (float) lower-left y coordinate in user units.
* @param $urx (float) upper-right x coordinate in user units.
* @param $ury (float) upper-right y coordinate in user units.
* @param $points (boolean) If true uses user units as unit of measure, otherwise uses PDF points.
* @param $k (float) Scale factor (number of points in user unit).
* @param $pagedim (array) Array of page dimensions.
* @return pagedim array of page dimensions.
* @since 5.0.010 (2010-05-17)
* @public static
*/
public static function setPageBoxes($page, $type, $llx, $lly, $urx, $ury, $points = \false, $k, $pagedim = array())
{
}
/**
* Swap X and Y coordinates of page boxes (change page boxes orientation).
* @param $page (int) page number
* @param $pagedim (array) Array of page dimensions.
* @return pagedim array of page dimensions.
* @since 5.0.010 (2010-05-17)
* @public static
*/
public static function swapPageBoxCoordinates($page, $pagedim)
{
}
/**
* Get the canonical page layout mode.
* @param $layout (string) The page layout. Possible values are:<ul><li>SinglePage Display one page at a time</li><li>OneColumn Display the pages in one column</li><li>TwoColumnLeft Display the pages in two columns, with odd-numbered pages on the left</li><li>TwoColumnRight Display the pages in two columns, with odd-numbered pages on the right</li><li>TwoPageLeft (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the left</li><li>TwoPageRight (PDF 1.5) Display the pages two at a time, with odd-numbered pages on the right</li></ul>
* @return (string) Canonical page layout name.
* @public static
*/
public static function getPageLayoutMode($layout = 'SinglePage')
{
}
/**
* Get the canonical page layout mode.
* @param $mode (string) A name object specifying how the document should be displayed when opened:<ul><li>UseNone Neither document outline nor thumbnail images visible</li><li>UseOutlines Document outline visible</li><li>UseThumbs Thumbnail images visible</li><li>FullScreen Full-screen mode, with no menu bar, window controls, or any other window visible</li><li>UseOC (PDF 1.5) Optional content group panel visible</li><li>UseAttachments (PDF 1.6) Attachments panel visible</li></ul>
* @return (string) Canonical page mode name.
* @public static
*/
public static function getPageMode($mode = 'UseNone')
{
}
}
/**
* @class TCPDF_PARSER
* This is a PHP class for parsing PDF documents.<br>
* @package com.tecnick.tcpdf
* @brief This is a PHP class for parsing PDF documents..
* @version 1.0.15
* @author Nicola Asuni - info@tecnick.com
*/
class TCPDF_PARSER
{
/**
* XREF data.
* @protected
*/
protected $xref = array();
/**
* Array of PDF objects.
* @protected
*/
protected $objects = array();
// -----------------------------------------------------------------------------
/**
* Parse a PDF document an return an array of objects.
* @param $data (string) PDF data to parse.
* @param $cfg (array) Array of configuration parameters:
* 'die_for_errors' : if true termitate the program execution in case of error, otherwise thows an exception;
* 'ignore_filter_decoding_errors' : if true ignore filter decoding errors;
* 'ignore_missing_filter_decoders' : if true ignore missing filter decoding errors.
* @public
* @since 1.0.000 (2011-05-24)
*/
public function __construct($data, $cfg = array())
{
}
/**
* Set the configuration parameters.
* @param $cfg (array) Array of configuration parameters:
* 'die_for_errors' : if true termitate the program execution in case of error, otherwise thows an exception;
* 'ignore_filter_decoding_errors' : if true ignore filter decoding errors;
* 'ignore_missing_filter_decoders' : if true ignore missing filter decoding errors.
* @public
*/
protected function setConfig($cfg)
{
}
/**
* Return an array of parsed PDF document objects.
* @return (array) Array of parsed PDF document objects.
* @public
* @since 1.0.000 (2011-06-26)
*/
public function getParsedData()
{
}
/**
* Get Cross-Reference (xref) table and trailer data from PDF document data.
* @param $offset (int) xref offset (if know).
* @param $xref (array) previous xref array (if any).
* @return Array containing xref and trailer data.
* @protected
* @since 1.0.000 (2011-05-24)
*/
protected function getXrefData($offset = 0, $xref = array())
{
}
/**
* Decode the Cross-Reference section
* @param $startxref (int) Offset at which the xref section starts (position of the 'xref' keyword).
* @param $xref (array) Previous xref array (if any).
* @return Array containing xref and trailer data.
* @protected
* @since 1.0.000 (2011-06-20)
*/
protected function decodeXref($startxref, $xref = array())
{
}
/**
* Decode the Cross-Reference Stream section
* @param $startxref (int) Offset at which the xref section starts.
* @param $xref (array) Previous xref array (if any).
* @return Array containing xref and trailer data.
* @protected
* @since 1.0.003 (2013-03-16)
*/
protected function decodeXrefStream($startxref, $xref = array())
{
}
/**
* Get object type, raw value and offset to next object
* @param $offset (int) Object offset.
* @return array containing object type, raw value and offset to next object
* @protected
* @since 1.0.000 (2011-06-20)
*/
protected function getRawObject($offset = 0)
{
}
/**
* Get content of indirect object.
* @param $obj_ref (string) Object number and generation number separated by underscore character.
* @param $offset (int) Object offset.
* @param $decoding (boolean) If true decode streams.
* @return array containing object data.
* @protected
* @since 1.0.000 (2011-05-24)
*/
protected function getIndirectObject($obj_ref, $offset = 0, $decoding = \true)
{
}
/**
* Get the content of object, resolving indect object reference if necessary.
* @param $obj (string) Object value.
* @return array containing object data.
* @protected
* @since 1.0.000 (2011-06-26)
*/
protected function getObjectVal($obj)
{
}
/**
* Decode the specified stream.
* @param $sdic (array) Stream's dictionary array.
* @param $stream (string) Stream to decode.
* @return array containing decoded stream data and remaining filters.
* @protected
* @since 1.0.000 (2011-06-22)
*/
protected function decodeStream($sdic, $stream)
{
}
/**
* Throw an exception or print an error message and die if the K_TCPDF_PARSER_THROW_EXCEPTION_ERROR constant is set to true.
* @param $msg (string) The error message
* @public
* @since 1.0.000 (2011-05-23)
*/
public function Error($msg)
{
}
}
/**
* @class TCPDF_IMPORT
* !!! THIS CLASS IS UNDER DEVELOPMENT !!!
* PHP class extension of the TCPDF (http://www.tcpdf.org) library to import existing PDF documents.<br>
* @package com.tecnick.tcpdf
* @brief PHP class extension of the TCPDF library to import existing PDF documents.
* @version 1.0.001
* @author Nicola Asuni - info@tecnick.com
*/
class TCPDF_IMPORT extends \TCPDF
{
/**
* Import an existing PDF document
* @param $filename (string) Filename of the PDF document to import.
* @return true in case of success, false otherwise
* @public
* @since 1.0.000 (2011-05-24)
*/
public function importPDF($filename)
{
}
}
//============================================================+
// File name : tcpdf_barcodes_2d.php
// Version : 1.0.015
// Begin : 2009-04-07
// Last Update : 2014-05-20
// Author : Nicola Asuni - Tecnick.com LTD - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2009-2014 Nicola Asuni - Tecnick.com LTD
//
// This file is part of TCPDF software library.
//
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with TCPDF. If not, see <http://www.gnu.org/licenses/>.
//
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
//
// Description : PHP class to creates array representations for
// 2D barcodes to be used with TCPDF.
//
//============================================================+
/**
* @file
* PHP class to creates array representations for 2D barcodes to be used with TCPDF.
* @package com.tecnick.tcpdf
* @author Nicola Asuni
* @version 1.0.015
*/
/**
* @class TCPDF2DBarcode
* PHP class to creates array representations for 2D barcodes to be used with TCPDF (http://www.tcpdf.org).
* @package com.tecnick.tcpdf
* @version 1.0.015
* @author Nicola Asuni
*/
class TCPDF2DBarcode
{
/**
* Array representation of barcode.
* @protected
*/
protected $barcode_array = \false;
/**
* This is the class constructor.
* Return an array representations for 2D barcodes:<ul>
* <li>$arrcode['code'] code to be printed on text label</li>
* <li>$arrcode['num_rows'] required number of rows</li>
* <li>$arrcode['num_cols'] required number of columns</li>
* <li>$arrcode['bcode'][$r][$c] value of the cell is $r row and $c column (0 = transparent, 1 = black)</li></ul>
* @param $code (string) code to print
* @param $type (string) type of barcode: <ul><li>DATAMATRIX : Datamatrix (ISO/IEC 16022)</li><li>PDF417 : PDF417 (ISO/IEC 15438:2006)</li><li>PDF417,a,e,t,s,f,o0,o1,o2,o3,o4,o5,o6 : PDF417 with parameters: a = aspect ratio (width/height); e = error correction level (0-8); t = total number of macro segments; s = macro segment index (0-99998); f = file ID; o0 = File Name (text); o1 = Segment Count (numeric); o2 = Time Stamp (numeric); o3 = Sender (text); o4 = Addressee (text); o5 = File Size (numeric); o6 = Checksum (numeric). NOTES: Parameters t, s and f are required for a Macro Control Block, all other parametrs are optional. To use a comma character ',' on text options, replace it with the character 255: "\xff".</li><li>QRCODE : QRcode Low error correction</li><li>QRCODE,L : QRcode Low error correction</li><li>QRCODE,M : QRcode Medium error correction</li><li>QRCODE,Q : QRcode Better error correction</li><li>QRCODE,H : QR-CODE Best error correction</li><li>RAW: raw mode - comma-separad list of array rows</li><li>RAW2: raw mode - array rows are surrounded by square parenthesis.</li><li>TEST : Test matrix</li></ul>
*/
public function __construct($code, $type)
{
}
/**
* Return an array representations of barcode.
* @return array
*/
public function getBarcodeArray()
{
}
/**
* Send barcode as SVG image object to the standard output.
* @param $w (int) Width of a single rectangle element in user units.
* @param $h (int) Height of a single rectangle element in user units.
* @param $color (string) Foreground color (in SVG format) for bar elements (background is transparent).
* @public
*/
public function getBarcodeSVG($w = 3, $h = 3, $color = 'black')
{
}
/**
* Return a SVG string representation of barcode.
* @param $w (int) Width of a single rectangle element in user units.
* @param $h (int) Height of a single rectangle element in user units.
* @param $color (string) Foreground color (in SVG format) for bar elements (background is transparent).
* @return string SVG code.
* @public
*/
public function getBarcodeSVGcode($w = 3, $h = 3, $color = 'black')
{
}
/**
* Return an HTML representation of barcode.
* @param $w (int) Width of a single rectangle element in pixels.
* @param $h (int) Height of a single rectangle element in pixels.
* @param $color (string) Foreground color for bar elements (background is transparent).
* @return string HTML code.
* @public
*/
public function getBarcodeHTML($w = 10, $h = 10, $color = 'black')
{
}
/**
* Send a PNG image representation of barcode (requires GD or Imagick library).
* @param $w (int) Width of a single rectangle element in pixels.
* @param $h (int) Height of a single rectangle element in pixels.
* @param $color (array) RGB (0-255) foreground color for bar elements (background is transparent).
* @public
*/
public function getBarcodePNG($w = 3, $h = 3, $color = array(0, 0, 0))
{
}
/**
* Return a PNG image representation of barcode (requires GD or Imagick library).
* @param $w (int) Width of a single rectangle element in pixels.
* @param $h (int) Height of a single rectangle element in pixels.
* @param $color (array) RGB (0-255) foreground color for bar elements (background is transparent).
* @return image or false in case of error.
* @public
*/
public function getBarcodePngData($w = 3, $h = 3, $color = array(0, 0, 0))
{
}
/**
* Set the barcode.
* @param $code (string) code to print
* @param $type (string) type of barcode: <ul><li>DATAMATRIX : Datamatrix (ISO/IEC 16022)</li><li>PDF417 : PDF417 (ISO/IEC 15438:2006)</li><li>PDF417,a,e,t,s,f,o0,o1,o2,o3,o4,o5,o6 : PDF417 with parameters: a = aspect ratio (width/height); e = error correction level (0-8); t = total number of macro segments; s = macro segment index (0-99998); f = file ID; o0 = File Name (text); o1 = Segment Count (numeric); o2 = Time Stamp (numeric); o3 = Sender (text); o4 = Addressee (text); o5 = File Size (numeric); o6 = Checksum (numeric). NOTES: Parameters t, s and f are required for a Macro Control Block, all other parametrs are optional. To use a comma character ',' on text options, replace it with the character 255: "\xff".</li><li>QRCODE : QRcode Low error correction</li><li>QRCODE,L : QRcode Low error correction</li><li>QRCODE,M : QRcode Medium error correction</li><li>QRCODE,Q : QRcode Better error correction</li><li>QRCODE,H : QR-CODE Best error correction</li><li>RAW: raw mode - comma-separad list of array rows</li><li>RAW2: raw mode - array rows are surrounded by square parenthesis.</li><li>TEST : Test matrix</li></ul>
* @return array
*/
public function setBarcode($code, $type)
{
}
}
//============================================================+
// File name : tcpdf_barcodes_1d.php
// Version : 1.0.027
// Begin : 2008-06-09
// Last Update : 2014-10-20
// Author : Nicola Asuni - Tecnick.com LTD - www.tecnick.com - info@tecnick.com
// License : GNU-LGPL v3 (http://www.gnu.org/copyleft/lesser.html)
// -------------------------------------------------------------------
// Copyright (C) 2008-2014 Nicola Asuni - Tecnick.com LTD
//
// This file is part of TCPDF software library.
//
// TCPDF is free software: you can redistribute it and/or modify it
// under the terms of the GNU Lesser General Public License as
// published by the Free Software Foundation, either version 3 of the
// License, or (at your option) any later version.
//
// TCPDF is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with TCPDF. If not, see <http://www.gnu.org/licenses/>.
//
// See LICENSE.TXT file for more information.
// -------------------------------------------------------------------
//
// Description : PHP class to creates array representations for
// common 1D barcodes to be used with TCPDF.
//
//============================================================+
/**
* @file
* PHP class to creates array representations for common 1D barcodes to be used with TCPDF.
* @package com.tecnick.tcpdf
* @author Nicola Asuni
* @version 1.0.027
*/
/**
* @class TCPDFBarcode
* PHP class to creates array representations for common 1D barcodes to be used with TCPDF (http://www.tcpdf.org).<br>
* @package com.tecnick.tcpdf
* @version 1.0.027
* @author Nicola Asuni
*/
class TCPDFBarcode
{
/**
* Array representation of barcode.
* @protected
*/
protected $barcode_array;
/**
* This is the class constructor.
* Return an array representations for common 1D barcodes:<ul>
* <li>$arrcode['code'] code to be printed on text label</li>
* <li>$arrcode['maxh'] max barcode height</li>
* <li>$arrcode['maxw'] max barcode width</li>
* <li>$arrcode['bcode'][$k] single bar or space in $k position</li>
* <li>$arrcode['bcode'][$k]['t'] bar type: true = bar, false = space.</li>
* <li>$arrcode['bcode'][$k]['w'] bar width in units.</li>
* <li>$arrcode['bcode'][$k]['h'] bar height in units.</li>
* <li>$arrcode['bcode'][$k]['p'] bar top position (0 = top, 1 = middle)</li></ul>
* @param $code (string) code to print
* @param $type (string) type of barcode: <ul><li>C39 : CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.</li><li>C39+ : CODE 39 with checksum</li><li>C39E : CODE 39 EXTENDED</li><li>C39E+ : CODE 39 EXTENDED + CHECKSUM</li><li>C93 : CODE 93 - USS-93</li><li>S25 : Standard 2 of 5</li><li>S25+ : Standard 2 of 5 + CHECKSUM</li><li>I25 : Interleaved 2 of 5</li><li>I25+ : Interleaved 2 of 5 + CHECKSUM</li><li>C128 : CODE 128</li><li>C128A : CODE 128 A</li><li>C128B : CODE 128 B</li><li>C128C : CODE 128 C</li><li>EAN2 : 2-Digits UPC-Based Extension</li><li>EAN5 : 5-Digits UPC-Based Extension</li><li>EAN8 : EAN 8</li><li>EAN13 : EAN 13</li><li>UPCA : UPC-A</li><li>UPCE : UPC-E</li><li>MSI : MSI (Variation of Plessey code)</li><li>MSI+ : MSI + CHECKSUM (modulo 11)</li><li>POSTNET : POSTNET</li><li>PLANET : PLANET</li><li>RMS4CC : RMS4CC (Royal Mail 4-state Customer Code) - CBC (Customer Bar Code)</li><li>KIX : KIX (Klant index - Customer index)</li><li>IMB: Intelligent Mail Barcode - Onecode - USPS-B-3200</li><li>CODABAR : CODABAR</li><li>CODE11 : CODE 11</li><li>PHARMA : PHARMACODE</li><li>PHARMA2T : PHARMACODE TWO-TRACKS</li></ul>
* @public
*/
public function __construct($code, $type)
{
}
/**
* Return an array representations of barcode.
* @return array
* @public
*/
public function getBarcodeArray()
{
}
/**
* Send barcode as SVG image object to the standard output.
* @param $w (int) Minimum width of a single bar in user units.
* @param $h (int) Height of barcode in user units.
* @param $color (string) Foreground color (in SVG format) for bar elements (background is transparent).
* @public
*/
public function getBarcodeSVG($w = 2, $h = 30, $color = 'black')
{
}
/**
* Return a SVG string representation of barcode.
* @param $w (int) Minimum width of a single bar in user units.
* @param $h (int) Height of barcode in user units.
* @param $color (string) Foreground color (in SVG format) for bar elements (background is transparent).
* @return string SVG code.
* @public
*/
public function getBarcodeSVGcode($w = 2, $h = 30, $color = 'black')
{
}
/**
* Return an HTML representation of barcode.
* @param $w (int) Width of a single bar element in pixels.
* @param $h (int) Height of a single bar element in pixels.
* @param $color (string) Foreground color for bar elements (background is transparent).
* @return string HTML code.
* @public
*/
public function getBarcodeHTML($w = 2, $h = 30, $color = 'black')
{
}
/**
* Send a PNG image representation of barcode (requires GD or Imagick library).
* @param $w (int) Width of a single bar element in pixels.
* @param $h (int) Height of a single bar element in pixels.
* @param $color (array) RGB (0-255) foreground color for bar elements (background is transparent).
* @public
*/
public function getBarcodePNG($w = 2, $h = 30, $color = array(0, 0, 0))
{
}
/**
* Return a PNG image representation of barcode (requires GD or Imagick library).
* @param $w (int) Width of a single bar element in pixels.
* @param $h (int) Height of a single bar element in pixels.
* @param $color (array) RGB (0-255) foreground color for bar elements (background is transparent).
* @return image or false in case of error.
* @public
*/
public function getBarcodePngData($w = 2, $h = 30, $color = array(0, 0, 0))
{
}
/**
* Set the barcode.
* @param $code (string) code to print
* @param $type (string) type of barcode: <ul><li>C39 : CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.</li><li>C39+ : CODE 39 with checksum</li><li>C39E : CODE 39 EXTENDED</li><li>C39E+ : CODE 39 EXTENDED + CHECKSUM</li><li>C93 : CODE 93 - USS-93</li><li>S25 : Standard 2 of 5</li><li>S25+ : Standard 2 of 5 + CHECKSUM</li><li>I25 : Interleaved 2 of 5</li><li>I25+ : Interleaved 2 of 5 + CHECKSUM</li><li>C128 : CODE 128</li><li>C128A : CODE 128 A</li><li>C128B : CODE 128 B</li><li>C128C : CODE 128 C</li><li>EAN2 : 2-Digits UPC-Based Extension</li><li>EAN5 : 5-Digits UPC-Based Extension</li><li>EAN8 : EAN 8</li><li>EAN13 : EAN 13</li><li>UPCA : UPC-A</li><li>UPCE : UPC-E</li><li>MSI : MSI (Variation of Plessey code)</li><li>MSI+ : MSI + CHECKSUM (modulo 11)</li><li>POSTNET : POSTNET</li><li>PLANET : PLANET</li><li>RMS4CC : RMS4CC (Royal Mail 4-state Customer Code) - CBC (Customer Bar Code)</li><li>KIX : KIX (Klant index - Customer index)</li><li>IMB: Intelligent Mail Barcode - Onecode - USPS-B-3200</li><li>IMBPRE: Pre-processed Intelligent Mail Barcode - Onecode - USPS-B-3200, using only F,A,D,T letters</li><li>CODABAR : CODABAR</li><li>CODE11 : CODE 11</li><li>PHARMA : PHARMACODE</li><li>PHARMA2T : PHARMACODE TWO-TRACKS</li></ul>
* @return array barcode array
* @public
*/
public function setBarcode($code, $type)
{
}
/**
* CODE 39 - ANSI MH10.8M-1983 - USD-3 - 3 of 9.
* General-purpose code in very wide use world-wide
* @param $code (string) code to represent.
* @param $extended (boolean) if true uses the extended mode.
* @param $checksum (boolean) if true add a checksum to the code.
* @return array barcode representation.
* @protected
*/
protected function barcode_code39($code, $extended = \false, $checksum = \false)
{
}
/**
* Encode a string to be used for CODE 39 Extended mode.
* @param $code (string) code to represent.
* @return encoded string.
* @protected
*/
protected function encode_code39_ext($code)
{
}
/**
* Calculate CODE 39 checksum (modulo 43).
* @param $code (string) code to represent.
* @return char checksum.
* @protected
*/
protected function checksum_code39($code)
{
}
/**
* CODE 93 - USS-93
* Compact code similar to Code 39
* @param $code (string) code to represent.
* @return array barcode representation.
* @protected
*/
protected function barcode_code93($code)
{
}
/**
* Calculate CODE 93 checksum (modulo 47).
* @param $code (string) code to represent.
* @return string checksum code.
* @protected
*/
protected function checksum_code93($code)
{
}
/**
* Checksum for standard 2 of 5 barcodes.
* @param $code (string) code to process.
* @return int checksum.
* @protected
*/
protected function checksum_s25($code)
{
}
/**
* MSI.
* Variation of Plessey code, with similar applications
* Contains digits (0 to 9) and encodes the data only in the width of bars.
* @param $code (string) code to represent.
* @param $checksum (boolean) if true add a checksum to the code (modulo 11)
* @return array barcode representation.
* @protected
*/
protected function barcode_msi($code, $checksum = \false)
{
}
/**
* Standard 2 of 5 barcodes.
* Used in airline ticket marking, photofinishing
* Contains digits (0 to 9) and encodes the data only in the width of bars.
* @param $code (string) code to represent.
* @param $checksum (boolean) if true add a checksum to the code
* @return array barcode representation.
* @protected
*/
protected function barcode_s25($code, $checksum = \false)
{
}
/**
* Convert binary barcode sequence to TCPDF barcode array.
* @param $seq (string) barcode as binary sequence.
* @param $bararray (array) barcode array.
* òparam array $bararray TCPDF barcode array to fill up
* @return array barcode representation.
* @protected
*/
protected function binseq_to_array($seq, $bararray)
{
}
/**
* Interleaved 2 of 5 barcodes.
* Compact numeric code, widely used in industry, air cargo
* Contains digits (0 to 9) and encodes the data in the width of both bars and spaces.
* @param $code (string) code to represent.
* @param $checksum (boolean) if true add a checksum to the code
* @return array barcode representation.
* @protected
*/
protected function barcode_i25($code, $checksum = \false)
{
}
/**
* C128 barcodes.
* Very capable code, excellent density, high reliability; in very wide use world-wide
* @param $code (string) code to represent.
* @param $type (string) barcode type: A, B, C or empty for automatic switch (AUTO mode)
* @return array barcode representation.
* @protected
*/
protected function barcode_c128($code, $type = '')
{
}
/**
* Split text code in A/B sequence for 128 code
* @param $code (string) code to split.
* @return array sequence
* @protected
*/
protected function get128ABsequence($code)
{
}
/**
* EAN13 and UPC-A barcodes.
* EAN13: European Article Numbering international retail product code
* UPC-A: Universal product code seen on almost all retail products in the USA and Canada
* UPC-E: Short version of UPC symbol
* @param $code (string) code to represent.
* @param $len (string) barcode type: 6 = UPC-E, 8 = EAN8, 13 = EAN13, 12 = UPC-A
* @return array barcode representation.
* @protected
*/
protected function barcode_eanupc($code, $len = 13)
{
}
/**
* UPC-Based Extensions
* 2-Digit Ext.: Used to indicate magazines and newspaper issue numbers
* 5-Digit Ext.: Used to mark suggested retail price of books
* @param $code (string) code to represent.
* @param $len (string) barcode type: 2 = 2-Digit, 5 = 5-Digit
* @return array barcode representation.
* @protected
*/
protected function barcode_eanext($code, $len = 5)
{
}
/**
* POSTNET and PLANET barcodes.
* Used by U.S. Postal Service for automated mail sorting
* @param $code (string) zip code to represent. Must be a string containing a zip code of the form DDDDD or DDDDD-DDDD.
* @param $planet (boolean) if true print the PLANET barcode, otherwise print POSTNET
* @return array barcode representation.
* @protected
*/
protected function barcode_postnet($code, $planet = \false)
{
}
/**
* RMS4CC - CBC - KIX
* RMS4CC (Royal Mail 4-state Customer Code) - CBC (Customer Bar Code) - KIX (Klant index - Customer index)
* RM4SCC is the name of the barcode symbology used by the Royal Mail for its Cleanmail service.
* @param $code (string) code to print
* @param $kix (boolean) if true prints the KIX variation (doesn't use the start and end symbols, and the checksum) - in this case the house number must be sufficed with an X and placed at the end of the code.
* @return array barcode representation.
* @protected
*/
protected function barcode_rms4cc($code, $kix = \false)
{
}
/**
* CODABAR barcodes.
* Older code often used in library systems, sometimes in blood banks
* @param $code (string) code to represent.
* @return array barcode representation.
* @protected
*/
protected function barcode_codabar($code)
{
}
/**
* CODE11 barcodes.
* Used primarily for labeling telecommunications equipment
* @param $code (string) code to represent.
* @return array barcode representation.
* @protected
*/
protected function barcode_code11($code)
{
}
/**
* Pharmacode
* Contains digits (0 to 9)
* @param $code (string) code to represent.
* @return array barcode representation.
* @protected
*/
protected function barcode_pharmacode($code)
{
}
/**
* Pharmacode two-track
* Contains digits (0 to 9)
* @param $code (string) code to represent.
* @return array barcode representation.
* @protected
*/
protected function barcode_pharmacode2t($code)
{
}
/**
* IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200
* (requires PHP bcmath extension)
* Intelligent Mail barcode is a 65-bar code for use on mail in the United States.
* The fields are described as follows:<ul><li>The Barcode Identifier shall be assigned by USPS to encode the presort identification that is currently printed in human readable form on the optional endorsement line (OEL) as well as for future USPS use. This shall be two digits, with the second digit in the range of 0–4. The allowable encoding ranges shall be 00–04, 10–14, 20–24, 30–34, 40–44, 50–54, 60–64, 70–74, 80–84, and 90–94.</li><li>The Service Type Identifier shall be assigned by USPS for any combination of services requested on the mailpiece. The allowable encoding range shall be 000http://it2.php.net/manual/en/function.dechex.php–999. Each 3-digit value shall correspond to a particular mail class with a particular combination of service(s). Each service program, such as OneCode Confirm and OneCode ACS, shall provide the list of Service Type Identifier values.</li><li>The Mailer or Customer Identifier shall be assigned by USPS as a unique, 6 or 9 digit number that identifies a business entity. The allowable encoding range for the 6 digit Mailer ID shall be 000000- 899999, while the allowable encoding range for the 9 digit Mailer ID shall be 900000000-999999999.</li><li>The Serial or Sequence Number shall be assigned by the mailer for uniquely identifying and tracking mailpieces. The allowable encoding range shall be 000000000–999999999 when used with a 6 digit Mailer ID and 000000-999999 when used with a 9 digit Mailer ID. e. The Delivery Point ZIP Code shall be assigned by the mailer for routing the mailpiece. This shall replace POSTNET for routing the mailpiece to its final delivery point. The length may be 0, 5, 9, or 11 digits. The allowable encoding ranges shall be no ZIP Code, 00000–99999, 000000000–999999999, and 00000000000–99999999999.</li></ul>
* @param $code (string) code to print, separate the ZIP (routing code) from the rest using a minus char '-' (BarcodeID_ServiceTypeID_MailerID_SerialNumber-RoutingCode)
* @return array barcode representation.
* @protected
*/
protected function barcode_imb($code)
{
}
/**
* IMB - Intelligent Mail Barcode - Onecode - USPS-B-3200
*
* @param $code (string) pre-formatted IMB barcode (65 chars "FADT")
* @return array barcode representation.
* @protected
*/
protected function barcode_imb_pre($code)
{
}
/**
* Convert large integer number to hexadecimal representation.
* (requires PHP bcmath extension)
* @param $number (string) number to convert specified as a string
* @return string hexadecimal representation
*/
public function dec_to_hex($number)
{
}
/**
* Convert large hexadecimal number to decimal representation (string).
* (requires PHP bcmath extension)
* @param $hex (string) hexadecimal number to convert specified as a string
* @return string hexadecimal representation
*/
public function hex_to_dec($hex)
{
}
/**
* Intelligent Mail Barcode calculation of Frame Check Sequence
* @param $code_arr (string) array of hexadecimal values (13 bytes holding 102 bits right justified).
* @return int 11 bit Frame Check Sequence as integer (decimal base)
* @protected
*/
protected function imb_crc11fcs($code_arr)
{
}
/**
* Reverse unsigned short value
* @param $num (int) value to reversr
* @return int reversed value
* @protected
*/
protected function imb_reverse_us($num)
{
}
/**
* generate Nof13 tables used for Intelligent Mail Barcode
* @param $n (int) is the type of table: 2 for 2of13 table, 5 for 5of13table
* @param $size (int) size of table (78 for n=2 and 1287 for n=5)
* @return array requested table
* @protected
*/
protected function imb_tables($n, $size)
{
}
}
}
namespace JmesPath {
/**
* Provides a simple environment based search.
*
* The runtime utilized by the Env class can be customized via environment
* variables. If the JP_PHP_COMPILE environment variable is specified, then the
* CompilerRuntime will be utilized. If set to "on", JMESPath expressions will
* be cached to the system's temp directory. Set the environment variable to
* a string to cache expressions to a specific directory.
*/
final class Env
{
const COMPILE_DIR = 'JP_PHP_COMPILE';
/**
* Returns data from the input array that matches a JMESPath expression.
*
* @param string $expression JMESPath expression to evaluate
* @param mixed $data JSON-like data to search
*
* @return mixed|null Returns the matching data or null
*/
public static function search($expression, $data)
{
}
/**
* Creates a JMESPath runtime based on environment variables and extensions
* available on a system.
*
* @return callable
*/
public static function createRuntime()
{
}
/**
* Delete all previously compiled JMESPath files from the JP_COMPILE_DIR
* directory or sys_get_temp_dir().
*
* @return int Returns the number of deleted files.
*/
public static function cleanCompileDir()
{
}
}
/**
* Provides CLI debugging information for the AST and Compiler runtimes.
*/
class DebugRuntime
{
public function __construct(callable $runtime, $output = null)
{
}
public function __invoke($expression, $data)
{
}
}
class Utils
{
static $typeMap = ['boolean' => 'boolean', 'string' => 'string', 'NULL' => 'null', 'double' => 'number', 'float' => 'number', 'integer' => 'number'];
/**
* Returns true if the value is truthy
*
* @param mixed $value Value to check
*
* @return bool
*/
public static function isTruthy($value)
{
}
/**
* Gets the JMESPath type equivalent of a PHP variable.
*
* @param mixed $arg PHP variable
* @return string Returns the JSON data type
* @throws \InvalidArgumentException when an unknown type is given.
*/
public static function type($arg)
{
}
/**
* Determine if the provided value is a JMESPath compatible object.
*
* @param mixed $value
*
* @return bool
*/
public static function isObject($value)
{
}
/**
* Determine if the provided value is a JMESPath compatible array.
*
* @param mixed $value
*
* @return bool
*/
public static function isArray($value)
{
}
/**
* JSON aware value comparison function.
*
* @param mixed $a First value to compare
* @param mixed $b Second value to compare
*
* @return bool
*/
public static function isEqual($a, $b)
{
}
/**
* JMESPath requires a stable sorting algorithm, so here we'll implement
* a simple Schwartzian transform that uses array index positions as tie
* breakers.
*
* @param array $data List or map of data to sort
* @param callable $sortFn Callable used to sort values
*
* @return array Returns the sorted array
* @link http://en.wikipedia.org/wiki/Schwartzian_transform
*/
public static function stableSort(array $data, callable $sortFn)
{
}
/**
* Creates a Python-style slice of a string or array.
*
* @param array|string $value Value to slice
* @param int|null $start Starting position
* @param int|null $stop Stop position
* @param int $step Step (1, 2, -1, -2, etc.)
*
* @return array|string
* @throws \InvalidArgumentException
*/
public static function slice($value, $start = null, $stop = null, $step = 1)
{
}
}
/**
* Compiles JMESPath expressions to PHP source code and executes it.
*
* JMESPath file names are stored in the cache directory using the following
* logic to determine the filename:
*
* 1. Start with the string "jmespath_"
* 2. Append the MD5 checksum of the expression.
* 3. Append ".php"
*/
class CompilerRuntime
{
/**
* @param string $dir Directory used to store compiled PHP files.
* @param Parser $parser JMESPath parser to utilize
* @throws \RuntimeException if the cache directory cannot be created
*/
public function __construct($dir = null, \JmesPath\Parser $parser = null)
{
}
/**
* Returns data from the provided input that matches a given JMESPath
* expression.
*
* @param string $expression JMESPath expression to evaluate
* @param mixed $data Data to search. This data should be data that
* is similar to data returned from json_decode
* using associative arrays rather than objects.
*
* @return mixed|null Returns the matching data or null
* @throws \RuntimeException
*/
public function __invoke($expression, $data)
{
}
}
/**
* Syntax errors raise this exception that gives context
*/
class SyntaxErrorException extends \InvalidArgumentException
{
/**
* @param string $expectedTypesOrMessage Expected array of tokens or message
* @param array $token Current token
* @param string $expression Expression input
*/
public function __construct($expectedTypesOrMessage, array $token, $expression)
{
}
}
/**
* Uses an external tree visitor to interpret an AST.
*/
class AstRuntime
{
public function __construct(\JmesPath\Parser $parser = null, callable $fnDispatcher = null)
{
}
/**
* Returns data from the provided input that matches a given JMESPath
* expression.
*
* @param string $expression JMESPath expression to evaluate
* @param mixed $data Data to search. This data should be data that
* is similar to data returned from json_decode
* using associative arrays rather than objects.
*
* @return mixed|null Returns the matching data or null
*/
public function __invoke($expression, $data)
{
}
}
/**
* Tree visitor used to evaluates JMESPath AST expressions.
*/
class TreeInterpreter
{
/**
* @param callable $fnDispatcher Function dispatching function that accepts
* a function name argument and an array of
* function arguments and returns the result.
*/
public function __construct(callable $fnDispatcher = null)
{
}
/**
* Visits each node in a JMESPath AST and returns the evaluated result.
*
* @param array $node JMESPath AST node
* @param mixed $data Data to evaluate
*
* @return mixed
*/
public function visit(array $node, $data)
{
}
}
/**
* Tree visitor used to compile JMESPath expressions into native PHP code.
*/
class TreeCompiler
{
/**
* @param array $ast AST to compile.
* @param string $fnName The name of the function to generate.
* @param string $expr Expression being compiled.
*
* @return string
*/
public function visit(array $ast, $fnName, $expr)
{
}
/** @internal */
public function __call($method, $args)
{
}
}
/**
* Tokenizes JMESPath expressions
*/
class Lexer
{
const T_DOT = 'dot';
const T_STAR = 'star';
const T_COMMA = 'comma';
const T_COLON = 'colon';
const T_CURRENT = 'current';
const T_EXPREF = 'expref';
const T_LPAREN = 'lparen';
const T_RPAREN = 'rparen';
const T_LBRACE = 'lbrace';
const T_RBRACE = 'rbrace';
const T_LBRACKET = 'lbracket';
const T_RBRACKET = 'rbracket';
const T_FLATTEN = 'flatten';
const T_IDENTIFIER = 'identifier';
const T_NUMBER = 'number';
const T_QUOTED_IDENTIFIER = 'quoted_identifier';
const T_UNKNOWN = 'unknown';
const T_PIPE = 'pipe';
const T_OR = 'or';
const T_AND = 'and';
const T_NOT = 'not';
const T_FILTER = 'filter';
const T_LITERAL = 'literal';
const T_EOF = 'eof';
const T_COMPARATOR = 'comparator';
const STATE_IDENTIFIER = 0;
const STATE_NUMBER = 1;
const STATE_SINGLE_CHAR = 2;
const STATE_WHITESPACE = 3;
const STATE_STRING_LITERAL = 4;
const STATE_QUOTED_STRING = 5;
const STATE_JSON_LITERAL = 6;
const STATE_LBRACKET = 7;
const STATE_PIPE = 8;
const STATE_LT = 9;
const STATE_GT = 10;
const STATE_EQ = 11;
const STATE_NOT = 12;
const STATE_AND = 13;
/**
* Tokenize the JMESPath expression into an array of tokens hashes that
* contain a 'type', 'value', and 'key'.
*
* @param string $input JMESPath input
*
* @return array
* @throws SyntaxErrorException
*/
public function tokenize($input)
{
}
}
/**
* Dispatches to named JMESPath functions using a single function that has the
* following signature:
*
* mixed $result = fn(string $function_name, array $args)
*/
class FnDispatcher
{
/**
* Gets a cached instance of the default function implementations.
*
* @return FnDispatcher
*/
public static function getInstance()
{
}
/**
* @param string $fn Function name.
* @param array $args Function arguments.
*
* @return mixed
*/
public function __invoke($fn, array $args)
{
}
/** @internal Pass function name validation off to runtime */
public function __call($name, $args)
{
}
}
/**
* JMESPath Pratt parser
* @link http://hall.org.ua/halls/wizzard/pdf/Vaughan.Pratt.TDOP.pdf
*/
class Parser
{
/**
* @param Lexer $lexer Lexer used to tokenize expressions
*/
public function __construct(\JmesPath\Lexer $lexer = null)
{
}
/**
* Parses a JMESPath expression into an AST
*
* @param string $expression JMESPath expression to compile
*
* @return array Returns an array based AST
* @throws SyntaxErrorException
*/
public function parse($expression)
{
}
/**
* @internal Handles undefined tokens without paying the cost of validation
*/
public function __call($method, $args)
{
}
}
}
namespace Google\Auth {
/**
* ApplicationDefaultCredentials obtains the default credentials for
* authorizing a request to a Google service.
*
* Application Default Credentials are described here:
* https://developers.google.com/accounts/docs/application-default-credentials
*
* This class implements the search for the application default credentials as
* described in the link.
*
* It provides three factory methods:
* - #get returns the computed credentials object
* - #getSubscriber returns an AuthTokenSubscriber built from the credentials object
* - #getMiddleware returns an AuthTokenMiddleware built from the credentials object
*
* This allows it to be used as follows with GuzzleHttp\Client:
*
* use Google\Auth\ApplicationDefaultCredentials;
* use GuzzleHttp\Client;
* use GuzzleHttp\HandlerStack;
*
* $middleware = ApplicationDefaultCredentials::getMiddleware(
* 'https://www.googleapis.com/auth/taskqueue'
* );
* $stack = HandlerStack::create();
* $stack->push($middleware);
*
* $client = new Client([
* 'handler' => $stack,
* 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
* 'auth' => 'google_auth' // authorize all requests
* ]);
*
* $res = $client->get('myproject/taskqueues/myqueue');
*/
class ApplicationDefaultCredentials
{
/**
* Obtains an AuthTokenSubscriber that uses the default FetchAuthTokenInterface
* implementation to use in this environment.
*
* If supplied, $scope is used to in creating the credentials instance if
* this does not fallback to the compute engine defaults.
*
* @param string|array scope the scope of the access request, expressed
* either as an Array or as a space-delimited String.
* @param callable $httpHandler callback which delivers psr7 request
* @param array $cacheConfig configuration for the cache when it's present
* @param CacheItemPoolInterface $cache an implementation of CacheItemPoolInterface
*
* @return AuthTokenSubscriber
*
* @throws DomainException if no implementation can be obtained.
*/
public static function getSubscriber($scope = null, callable $httpHandler = null, array $cacheConfig = null, \Psr\Cache\CacheItemPoolInterface $cache = null)
{
}
/**
* Obtains an AuthTokenMiddleware that uses the default FetchAuthTokenInterface
* implementation to use in this environment.
*
* If supplied, $scope is used to in creating the credentials instance if
* this does not fallback to the compute engine defaults.
*
* @param string|array scope the scope of the access request, expressed
* either as an Array or as a space-delimited String.
* @param callable $httpHandler callback which delivers psr7 request
* @param array $cacheConfig configuration for the cache when it's present
* @param CacheItemPoolInterface $cache
*
* @return AuthTokenMiddleware
*
* @throws DomainException if no implementation can be obtained.
*/
public static function getMiddleware($scope = null, callable $httpHandler = null, array $cacheConfig = null, \Psr\Cache\CacheItemPoolInterface $cache = null)
{
}
/**
* Obtains the default FetchAuthTokenInterface implementation to use
* in this environment.
*
* If supplied, $scope is used to in creating the credentials instance if
* this does not fallback to the Compute Engine defaults.
*
* @param string|array scope the scope of the access request, expressed
* either as an Array or as a space-delimited String.
* @param callable $httpHandler callback which delivers psr7 request
* @param array $cacheConfig configuration for the cache when it's present
* @param CacheItemPoolInterface $cache
*
* @return CredentialsLoader
*
* @throws DomainException if no implementation can be obtained.
*/
public static function getCredentials($scope = null, callable $httpHandler = null, array $cacheConfig = null, \Psr\Cache\CacheItemPoolInterface $cache = null)
{
}
}
/**
* An interface implemented by objects that can fetch auth tokens.
*/
interface FetchAuthTokenInterface
{
/**
* Fetches the auth tokens based on the current state.
*
* @param callable $httpHandler callback which delivers psr7 request
*
* @return array a hash of auth tokens
*/
public function fetchAuthToken(callable $httpHandler = null);
/**
* Obtains a key that can used to cache the results of #fetchAuthToken.
*
* If the value is empty, the auth token is not cached.
*
* @return string a key that may be used to cache the auth token.
*/
public function getCacheKey();
/**
* Returns an associative array with the token and
* expiration time.
*
* @return null|array {
* The last received access token.
*
* @var string $access_token The access token string.
* @var int $expires_at The time the token expires as a UNIX timestamp.
* }
*/
public function getLastReceivedToken();
}
/**
* CredentialsLoader contains the behaviour used to locate and find default
* credentials files on the file system.
*/
abstract class CredentialsLoader implements \Google\Auth\FetchAuthTokenInterface
{
const TOKEN_CREDENTIAL_URI = 'https://www.googleapis.com/oauth2/v4/token';
const ENV_VAR = 'GOOGLE_APPLICATION_CREDENTIALS';
const WELL_KNOWN_PATH = 'gcloud/application_default_credentials.json';
const NON_WINDOWS_WELL_KNOWN_PATH_BASE = '.config';
const AUTH_METADATA_KEY = 'Authorization';
/**
* Load a JSON key from the path specified in the environment.
*
* Load a JSON key from the path specified in the environment
* variable GOOGLE_APPLICATION_CREDENTIALS. Return null if
* GOOGLE_APPLICATION_CREDENTIALS is not specified.
*
* @return array JSON key | null
*/
public static function fromEnv()
{
}
/**
* Load a JSON key from a well known path.
*
* The well known path is OS dependent:
* - windows: %APPDATA%/gcloud/application_default_credentials.json
* - others: $HOME/.config/gcloud/application_default_credentials.json
*
* If the file does not exists, this returns null.
*
* @return array JSON key | null
*/
public static function fromWellKnownFile()
{
}
/**
* Create a new Credentials instance.
*
* @param string|array scope the scope of the access request, expressed
* either as an Array or as a space-delimited String.
* @param array $jsonKey the JSON credentials.
*
* @return ServiceAccountCredentials|UserRefreshCredentials
*/
public static function makeCredentials($scope, array $jsonKey)
{
}
/**
* export a callback function which updates runtime metadata.
*
* @return array updateMetadata function
*/
public function getUpdateMetadataFunc()
{
}
/**
* Updates metadata with the authorization token.
*
* @param array $metadata metadata hashmap
* @param string $authUri optional auth uri
* @param callable $httpHandler callback which delivers psr7 request
*
* @return array updated metadata hashmap
*/
public function updateMetadata($metadata, $authUri = null, callable $httpHandler = null)
{
}
}
}
namespace Google\Auth\Credentials {
/**
* ServiceAccountCredentials supports authorization using a Google service
* account.
*
* (cf https://developers.google.com/accounts/docs/OAuth2ServiceAccount)
*
* It's initialized using the json key file that's downloadable from developer
* console, which should contain a private_key and client_email fields that it
* uses.
*
* Use it with AuthTokenMiddleware to authorize http requests:
*
* use Google\Auth\Credentials\ServiceAccountCredentials;
* use Google\Auth\Middleware\AuthTokenMiddleware;
* use GuzzleHttp\Client;
* use GuzzleHttp\HandlerStack;
*
* $sa = new ServiceAccountCredentials(
* 'https://www.googleapis.com/auth/taskqueue',
* '/path/to/your/json/key_file.json'
* );
* $middleware = new AuthTokenMiddleware($sa);
* $stack = HandlerStack::create();
* $stack->push($middleware);
*
* $client = new Client([
* 'handler' => $stack,
* 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
* 'auth' => 'google_auth' // authorize all requests
* ]);
*
* $res = $client->get('myproject/taskqueues/myqueue');
*/
class ServiceAccountCredentials extends \Google\Auth\CredentialsLoader
{
/**
* The OAuth2 instance used to conduct authorization.
*
* @var OAuth2
*/
protected $auth;
/**
* Create a new ServiceAccountCredentials.
*
* @param string|array $scope the scope of the access request, expressed
* either as an Array or as a space-delimited String.
* @param string|array $jsonKey JSON credential file path or JSON credentials
* as an associative array
* @param string $sub an email address account to impersonate, in situations when
* the service account has been delegated domain wide access.
*/
public function __construct($scope, $jsonKey, $sub = null)
{
}
/**
* @param callable $httpHandler
*
* @return array
*/
public function fetchAuthToken(callable $httpHandler = null)
{
}
/**
* @return string
*/
public function getCacheKey()
{
}
/**
* @return array
*/
public function getLastReceivedToken()
{
}
/**
* Updates metadata with the authorization token.
*
* @param array $metadata metadata hashmap
* @param string $authUri optional auth uri
* @param callable $httpHandler callback which delivers psr7 request
*
* @return array updated metadata hashmap
*/
public function updateMetadata($metadata, $authUri = null, callable $httpHandler = null)
{
}
/**
* @param string $sub an email address account to impersonate, in situations when
* the service account has been delegated domain wide access.
*/
public function setSub($sub)
{
}
}
/**
* GCECredentials supports authorization on Google Compute Engine.
*
* It can be used to authorize requests using the AuthTokenMiddleware, but will
* only succeed if being run on GCE:
*
* use Google\Auth\Credentials\GCECredentials;
* use Google\Auth\Middleware\AuthTokenMiddleware;
* use GuzzleHttp\Client;
* use GuzzleHttp\HandlerStack;
*
* $gce = new GCECredentials();
* $middleware = new AuthTokenMiddleware($gce);
* $stack = HandlerStack::create();
* $stack->push($middleware);
*
* $client = new Client([
* 'handler' => $stack,
* 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
* 'auth' => 'google_auth'
* ]);
*
* $res = $client->get('myproject/taskqueues/myqueue');
*/
class GCECredentials extends \Google\Auth\CredentialsLoader
{
const cacheKey = 'GOOGLE_AUTH_PHP_GCE';
/**
* The metadata IP address on appengine instances.
*
* The IP is used instead of the domain 'metadata' to avoid slow responses
* when not on Compute Engine.
*/
const METADATA_IP = '169.254.169.254';
/**
* The metadata path of the default token.
*/
const TOKEN_URI_PATH = 'v1/instance/service-accounts/default/token';
/**
* The header whose presence indicates GCE presence.
*/
const FLAVOR_HEADER = 'Metadata-Flavor';
/**
* Result of fetchAuthToken.
*/
protected $lastReceivedToken;
/**
* The full uri for accessing the default token.
*
* @return string
*/
public static function getTokenUri()
{
}
/**
* Determines if this an App Engine Flexible instance, by accessing the
* GAE_VM environment variable.
*
* @return true if this an App Engine Flexible Instance, false otherwise
*/
public static function onAppEngineFlexible()
{
}
/**
* Determines if this a GCE instance, by accessing the expected metadata
* host.
* If $httpHandler is not specified a the default HttpHandler is used.
*
* @param callable $httpHandler callback which delivers psr7 request
*
* @return true if this a GCEInstance false otherwise
*/
public static function onGce(callable $httpHandler = null)
{
}
/**
* Implements FetchAuthTokenInterface#fetchAuthToken.
*
* Fetches the auth tokens from the GCE metadata host if it is available.
* If $httpHandler is not specified a the default HttpHandler is used.
*
* @param callable $httpHandler callback which delivers psr7 request
*
* @return array the response
*
* @throws \Exception
*/
public function fetchAuthToken(callable $httpHandler = null)
{
}
/**
* @return string
*/
public function getCacheKey()
{
}
/**
* @return array|null
*/
public function getLastReceivedToken()
{
}
}
/**
* Authenticates requests using User Refresh credentials.
*
* This class allows authorizing requests from user refresh tokens.
*
* This the end of the result of a 3LO flow. E.g, the end result of
* 'gcloud auth login' saves a file with these contents in well known
* location
*
* @see [Application Default Credentials](http://goo.gl/mkAHpZ)
*/
class UserRefreshCredentials extends \Google\Auth\CredentialsLoader
{
/**
* The OAuth2 instance used to conduct authorization.
*
* @var OAuth2
*/
protected $auth;
/**
* Create a new UserRefreshCredentials.
*
* @param string|array $scope the scope of the access request, expressed
* either as an Array or as a space-delimited String.
* @param string|array $jsonKey JSON credential file path or JSON credentials
* as an associative array
*/
public function __construct($scope, $jsonKey)
{
}
/**
* @param callable $httpHandler
*
* @return array
*/
public function fetchAuthToken(callable $httpHandler = null)
{
}
/**
* @return string
*/
public function getCacheKey()
{
}
/**
* @return array
*/
public function getLastReceivedToken()
{
}
}
/**
* AppIdentityCredentials supports authorization on Google App Engine.
*
* It can be used to authorize requests using the AuthTokenMiddleware or
* AuthTokenSubscriber, but will only succeed if being run on App Engine:
*
* use Google\Auth\Credentials\AppIdentityCredentials;
* use Google\Auth\Middleware\AuthTokenMiddleware;
* use GuzzleHttp\Client;
* use GuzzleHttp\HandlerStack;
*
* $gae = new AppIdentityCredentials('https://www.googleapis.com/auth/books');
* $middleware = new AuthTokenMiddleware($gae);
* $stack = HandlerStack::create();
* $stack->push($middleware);
*
* $client = new Client([
* 'handler' => $stack,
* 'base_uri' => 'https://www.googleapis.com/books/v1',
* 'auth' => 'google_auth'
* ]);
*
* $res = $client->get('volumes?q=Henry+David+Thoreau&country=US');
*/
class AppIdentityCredentials extends \Google\Auth\CredentialsLoader
{
/**
* Result of fetchAuthToken.
*
* @array
*/
protected $lastReceivedToken;
public function __construct($scope = array())
{
}
/**
* Determines if this an App Engine instance, by accessing the SERVER_SOFTWARE
* environment variable.
*
* @return true if this an App Engine Instance, false otherwise
*/
public static function onAppEngine()
{
}
/**
* Implements FetchAuthTokenInterface#fetchAuthToken.
*
* Fetches the auth tokens using the AppIdentityService if available.
* As the AppIdentityService uses protobufs to fetch the access token,
* the GuzzleHttp\ClientInterface instance passed in will not be used.
*
* @param callable $httpHandler callback which delivers psr7 request
*
* @return array the auth metadata:
* array(2) {
* ["access_token"]=>
* string(3) "xyz"
* ["expiration_time"]=>
* string(10) "1444339905"
* }
*
* @throws \Exception
*/
public function fetchAuthToken(callable $httpHandler = null)
{
}
/**
* @return array|null
*/
public function getLastReceivedToken()
{
}
/**
* Caching is handled by the underlying AppIdentityService, return empty string
* to prevent caching.
*
* @return string
*/
public function getCacheKey()
{
}
}
/**
* Authenticates requests using IAM credentials.
*/
class IAMCredentials
{
const SELECTOR_KEY = 'x-goog-iam-authority-selector';
const TOKEN_KEY = 'x-goog-iam-authorization-token';
/**
* @param $selector string the IAM selector
* @param $token string the IAM token
*/
public function __construct($selector, $token)
{
}
/**
* export a callback function which updates runtime metadata.
*
* @return array updateMetadata function
*/
public function getUpdateMetadataFunc()
{
}
/**
* Updates metadata with the appropriate header metadata.
*
* @param array $metadata metadata hashmap
* @param string $unusedAuthUri optional auth uri
* @param callable $httpHandler callback which delivers psr7 request
* Note: this param is unused here, only included here for
* consistency with other credentials class
*
* @return array updated metadata hashmap
*/
public function updateMetadata($metadata, $unusedAuthUri = null, callable $httpHandler = null)
{
}
}
/**
* Authenticates requests using Google's Service Account credentials via
* JWT Access.
*
* This class allows authorizing requests for service accounts directly
* from credentials from a json key file downloaded from the developer
* console (via 'Generate new Json Key'). It is not part of any OAuth2
* flow, rather it creates a JWT and sends that as a credential.
*/
class ServiceAccountJwtAccessCredentials extends \Google\Auth\CredentialsLoader
{
/**
* The OAuth2 instance used to conduct authorization.
*
* @var OAuth2
*/
protected $auth;
/**
* Create a new ServiceAccountJwtAccessCredentials.
*
* @param string|array $jsonKey JSON credential file path or JSON credentials
* as an associative array
*/
public function __construct($jsonKey)
{
}
/**
* Updates metadata with the authorization token.
*
* @param array $metadata metadata hashmap
* @param string $authUri optional auth uri
* @param callable $httpHandler callback which delivers psr7 request
*
* @return array updated metadata hashmap
*/
public function updateMetadata($metadata, $authUri = null, callable $httpHandler = null)
{
}
/**
* Implements FetchAuthTokenInterface#fetchAuthToken.
*
* @param callable $httpHandler
*
* @return array|void
*/
public function fetchAuthToken(callable $httpHandler = null)
{
}
/**
* @return string
*/
public function getCacheKey()
{
}
/**
* @return array
*/
public function getLastReceivedToken()
{
}
}
}
namespace Google\Auth\Middleware {
/**
* AuthTokenMiddleware is a Guzzle Middleware that adds an Authorization header
* provided by an object implementing FetchAuthTokenInterface.
*
* The FetchAuthTokenInterface#fetchAuthToken is used to obtain a hash; one of
* the values value in that hash is added as the authorization header.
*
* Requests will be accessed with the authorization header:
*
* 'Authorization' 'Bearer <value of auth_token>'
*/
class AuthTokenMiddleware
{
/**
* Creates a new AuthTokenMiddleware.
*
* @param FetchAuthTokenInterface $fetcher is used to fetch the auth token
* @param callable $httpHandler (optional) callback which delivers psr7 request
* @param callable $tokenCallback (optional) function to be called when a new token is fetched.
*/
public function __construct(\Google\Auth\FetchAuthTokenInterface $fetcher, callable $httpHandler = null, callable $tokenCallback = null)
{
}
/**
* Updates the request with an Authorization header when auth is 'google_auth'.
*
* use Google\Auth\Middleware\AuthTokenMiddleware;
* use Google\Auth\OAuth2;
* use GuzzleHttp\Client;
* use GuzzleHttp\HandlerStack;
*
* $config = [..<oauth config param>.];
* $oauth2 = new OAuth2($config)
* $middleware = new AuthTokenMiddleware($oauth2);
* $stack = HandlerStack::create();
* $stack->push($middleware);
*
* $client = new Client([
* 'handler' => $stack,
* 'base_uri' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
* 'auth' => 'google_auth' // authorize all requests
* ]);
*
* $res = $client->get('myproject/taskqueues/myqueue');
*
* @param callable $handler
*
* @return \Closure
*/
public function __invoke(callable $handler)
{
}
}
/**
* SimpleMiddleware is a Guzzle Middleware that implements Google's Simple API
* access.
*
* Requests are accessed using the Simple API access developer key.
*/
class SimpleMiddleware
{
/**
* Create a new Simple plugin.
*
* The configuration array expects one option
* - key: required, otherwise InvalidArgumentException is thrown
*
* @param array $config Configuration array
*/
public function __construct(array $config)
{
}
/**
* Updates the request query with the developer key if auth is set to simple.
*
* use Google\Auth\Middleware\SimpleMiddleware;
* use GuzzleHttp\Client;
* use GuzzleHttp\HandlerStack;
*
* $my_key = 'is not the same as yours';
* $middleware = new SimpleMiddleware(['key' => $my_key]);
* $stack = HandlerStack::create();
* $stack->push($middleware);
*
* $client = new Client([
* 'handler' => $stack,
* 'base_uri' => 'https://www.googleapis.com/discovery/v1/',
* 'auth' => 'simple'
* ]);
*
* $res = $client->get('drive/v2/rest');
*
* @param callable $handler
*
* @return \Closure
*/
public function __invoke(callable $handler)
{
}
}
}
namespace Google\Auth {
trait CacheTrait
{
/**
* Gets the cached value if it is present in the cache when that is
* available.
*/
private function getCachedValue($k)
{
}
/**
* Saves the value in the cache when that is available.
*/
private function setCachedValue($k, $v)
{
}
private function getFullCacheKey($key)
{
}
}
}
namespace Google\Auth\Middleware {
/**
* ScopedAccessTokenMiddleware is a Guzzle Middleware that adds an Authorization
* header provided by a closure.
*
* The closure returns an access token, taking the scope, either a single
* string or an array of strings, as its value. If provided, a cache will be
* used to preserve the access token for a given lifetime.
*
* Requests will be accessed with the authorization header:
*
* 'Authorization' 'Bearer <value of auth_token>'
*/
class ScopedAccessTokenMiddleware
{
use \Google\Auth\CacheTrait;
const DEFAULT_CACHE_LIFETIME = 1500;
/**
* Creates a new ScopedAccessTokenMiddleware.
*
* @param callable $tokenFunc a token generator function
* @param array|string $scopes the token authentication scopes
* @param array $cacheConfig configuration for the cache when it's present
* @param CacheItemPoolInterface $cache an implementation of CacheItemPoolInterface
*/
public function __construct(callable $tokenFunc, $scopes, array $cacheConfig = null, \Psr\Cache\CacheItemPoolInterface $cache = null)
{
}
/**
* Updates the request with an Authorization header when auth is 'scoped'.
*
* E.g this could be used to authenticate using the AppEngine
* AppIdentityService.
*
* use google\appengine\api\app_identity\AppIdentityService;
* use Google\Auth\Middleware\ScopedAccessTokenMiddleware;
* use GuzzleHttp\Client;
* use GuzzleHttp\HandlerStack;
*
* $scope = 'https://www.googleapis.com/auth/taskqueue'
* $middleware = new ScopedAccessTokenMiddleware(
* 'AppIdentityService::getAccessToken',
* $scope,
* [ 'prefix' => 'Google\Auth\ScopedAccessToken::' ],
* $cache = new Memcache()
* );
* $stack = HandlerStack::create();
* $stack->push($middleware);
*
* $client = new Client([
* 'handler' => $stack,
* 'base_url' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
* 'auth' => 'google_auth' // authorize all requests
* ]);
*
* $res = $client->get('myproject/taskqueues/myqueue');
*
* @param callable $handler
*
* @return \Closure
*/
public function __invoke(callable $handler)
{
}
}
}
namespace Google\Auth {
/**
* A class to implement caching for any object implementing
* FetchAuthTokenInterface
*/
class FetchAuthTokenCache implements \Google\Auth\FetchAuthTokenInterface
{
use \Google\Auth\CacheTrait;
public function __construct(\Google\Auth\FetchAuthTokenInterface $fetcher, array $cacheConfig = null, \Psr\Cache\CacheItemPoolInterface $cache)
{
}
/**
* Implements FetchAuthTokenInterface#fetchAuthToken.
*
* Checks the cache for a valid auth token and fetches the auth tokens
* from the supplied fetcher.
*
* @param callable $httpHandler callback which delivers psr7 request
*
* @return array the response
*
* @throws \Exception
*/
public function fetchAuthToken(callable $httpHandler = null)
{
}
/**
* @return string
*/
public function getCacheKey()
{
}
/**
* @return array|null
*/
public function getLastReceivedToken()
{
}
}
}
namespace Google\Auth\HttpHandler {
class Guzzle6HttpHandler
{
/**
* @param ClientInterface $client
*/
public function __construct(\GuzzleHttp\ClientInterface $client)
{
}
/**
* Accepts a PSR-7 request and an array of options and returns a PSR-7 response.
*
* @param RequestInterface $request
* @param array $options
*
* @return ResponseInterface
*/
public function __invoke(\Psr\Http\Message\RequestInterface $request, array $options = [])
{
}
}
class HttpHandlerFactory
{
/**
* Builds out a default http handler for the installed version of guzzle.
*
* @param ClientInterface $client
*
* @return Guzzle5HttpHandler|Guzzle6HttpHandler
*
* @throws \Exception
*/
public static function build(\GuzzleHttp\ClientInterface $client = null)
{
}
}
class Guzzle5HttpHandler
{
/**
* @param ClientInterface $client
*/
public function __construct(\GuzzleHttp\ClientInterface $client)
{
}
/**
* Accepts a PSR-7 Request and an array of options and returns a PSR-7 response.
*
* @param RequestInterface $request
* @param array $options
*
* @return ResponseInterface
*/
public function __invoke(\Psr\Http\Message\RequestInterface $request, array $options = [])
{
}
}
}
namespace Google\Auth\Cache {
/**
* Simple in-memory cache implementation.
*/
final class MemoryCacheItemPool implements \Psr\Cache\CacheItemPoolInterface
{
/**
* {@inheritdoc}
*/
public function getItem($key)
{
}
/**
* {@inheritdoc}
*/
public function getItems(array $keys = [])
{
}
/**
* {@inheritdoc}
*/
public function hasItem($key)
{
}
/**
* {@inheritdoc}
*/
public function clear()
{
}
/**
* {@inheritdoc}
*/
public function deleteItem($key)
{
}
/**
* {@inheritdoc}
*/
public function deleteItems(array $keys)
{
}
/**
* {@inheritdoc}
*/
public function save(\Psr\Cache\CacheItemInterface $item)
{
}
/**
* {@inheritdoc}
*/
public function saveDeferred(\Psr\Cache\CacheItemInterface $item)
{
}
/**
* {@inheritdoc}
*/
public function commit()
{
}
}
/**
* A cache item.
*/
final class Item implements \Psr\Cache\CacheItemInterface
{
/**
* @param string $key
*/
public function __construct($key)
{
}
/**
* {@inheritdoc}
*/
public function getKey()
{
}
/**
* {@inheritdoc}
*/
public function get()
{
}
/**
* {@inheritdoc}
*/
public function isHit()
{
}
/**
* {@inheritdoc}
*/
public function set($value)
{
}
/**
* {@inheritdoc}
*/
public function expiresAt($expiration)
{
}
/**
* {@inheritdoc}
*/
public function expiresAfter($time)
{
}
}
class InvalidArgumentException extends \InvalidArgumentException implements \Psr\Cache\InvalidArgumentException
{
}
}
namespace Google\Auth\Subscriber {
/**
* ScopedAccessTokenSubscriber is a Guzzle Subscriber that adds an Authorization
* header provided by a closure.
*
* The closure returns an access token, taking the scope, either a single
* string or an array of strings, as its value. If provided, a cache will be
* used to preserve the access token for a given lifetime.
*
* Requests will be accessed with the authorization header:
*
* 'Authorization' 'Bearer <access token obtained from the closure>'
*/
class ScopedAccessTokenSubscriber implements \GuzzleHttp\Event\SubscriberInterface
{
use \Google\Auth\CacheTrait;
const DEFAULT_CACHE_LIFETIME = 1500;
/**
* Creates a new ScopedAccessTokenSubscriber.
*
* @param callable $tokenFunc a token generator function
* @param array|string $scopes the token authentication scopes
* @param array $cacheConfig configuration for the cache when it's present
* @param CacheItemPoolInterface $cache an implementation of CacheItemPoolInterface
*/
public function __construct(callable $tokenFunc, $scopes, array $cacheConfig = null, \Psr\Cache\CacheItemPoolInterface $cache = null)
{
}
/**
* @return array
*/
public function getEvents()
{
}
/**
* Updates the request with an Authorization header when auth is 'scoped'.
*
* E.g this could be used to authenticate using the AppEngine
* AppIdentityService.
*
* use google\appengine\api\app_identity\AppIdentityService;
* use Google\Auth\Subscriber\ScopedAccessTokenSubscriber;
* use GuzzleHttp\Client;
*
* $scope = 'https://www.googleapis.com/auth/taskqueue'
* $subscriber = new ScopedAccessToken(
* 'AppIdentityService::getAccessToken',
* $scope,
* ['prefix' => 'Google\Auth\ScopedAccessToken::'],
* $cache = new Memcache()
* );
*
* $client = new Client([
* 'base_url' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
* 'defaults' => ['auth' => 'scoped']
* ]);
* $client->getEmitter()->attach($subscriber);
*
* $res = $client->get('myproject/taskqueues/myqueue');
*
* @param BeforeEvent $event
*/
public function onBefore(\GuzzleHttp\Event\BeforeEvent $event)
{
}
}
/**
* SimpleSubscriber is a Guzzle Subscriber that implements Google's Simple API
* access.
*
* Requests are accessed using the Simple API access developer key.
*/
class SimpleSubscriber implements \GuzzleHttp\Event\SubscriberInterface
{
/**
* Create a new Simple plugin.
*
* The configuration array expects one option
* - key: required, otherwise InvalidArgumentException is thrown
*
* @param array $config Configuration array
*/
public function __construct(array $config)
{
}
/**
* @return array
*/
public function getEvents()
{
}
/**
* Updates the request query with the developer key if auth is set to simple.
*
* use Google\Auth\Subscriber\SimpleSubscriber;
* use GuzzleHttp\Client;
*
* $my_key = 'is not the same as yours';
* $subscriber = new SimpleSubscriber(['key' => $my_key]);
*
* $client = new Client([
* 'base_url' => 'https://www.googleapis.com/discovery/v1/',
* 'defaults' => ['auth' => 'simple']
* ]);
* $client->getEmitter()->attach($subscriber);
*
* $res = $client->get('drive/v2/rest');
*
* @param BeforeEvent $event
*/
public function onBefore(\GuzzleHttp\Event\BeforeEvent $event)
{
}
}
/**
* AuthTokenSubscriber is a Guzzle Subscriber that adds an Authorization header
* provided by an object implementing FetchAuthTokenInterface.
*
* The FetchAuthTokenInterface#fetchAuthToken is used to obtain a hash; one of
* the values value in that hash is added as the authorization header.
*
* Requests will be accessed with the authorization header:
*
* 'Authorization' 'Bearer <value of auth_token>'
*/
class AuthTokenSubscriber implements \GuzzleHttp\Event\SubscriberInterface
{
/**
* Creates a new AuthTokenSubscriber.
*
* @param FetchAuthTokenInterface $fetcher is used to fetch the auth token
* @param callable $httpHandler (optional) http client to fetch the token.
* @param callable $tokenCallback (optional) function to be called when a new token is fetched.
*/
public function __construct(\Google\Auth\FetchAuthTokenInterface $fetcher, callable $httpHandler = null, callable $tokenCallback = null)
{
}
/**
* @return array
*/
public function getEvents()
{
}
/**
* Updates the request with an Authorization header when auth is 'fetched_auth_token'.
*
* use GuzzleHttp\Client;
* use Google\Auth\OAuth2;
* use Google\Auth\Subscriber\AuthTokenSubscriber;
*
* $config = [..<oauth config param>.];
* $oauth2 = new OAuth2($config)
* $subscriber = new AuthTokenSubscriber($oauth2);
*
* $client = new Client([
* 'base_url' => 'https://www.googleapis.com/taskqueue/v1beta2/projects/',
* 'defaults' => ['auth' => 'google_auth']
* ]);
* $client->getEmitter()->attach($subscriber);
*
* $res = $client->get('myproject/taskqueues/myqueue');
*
* @param BeforeEvent $event
*/
public function onBefore(\GuzzleHttp\Event\BeforeEvent $event)
{
}
}
}
namespace Google\Auth {
/**
* OAuth2 supports authentication by OAuth2 2-legged flows.
*
* It primary supports
* - service account authorization
* - authorization where a user already has an access token
*/
class OAuth2 implements \Google\Auth\FetchAuthTokenInterface
{
const DEFAULT_EXPIRY_SECONDS = 3600;
// 1 hour
const DEFAULT_SKEW_SECONDS = 60;
// 1 minute
const JWT_URN = 'urn:ietf:params:oauth:grant-type:jwt-bearer';
/**
* TODO: determine known methods from the keys of JWT::methods.
*/
public static $knownSigningAlgorithms = array('HS256', 'HS512', 'HS384', 'RS256');
/**
* The well known grant types.
*
* @var array
*/
public static $knownGrantTypes = array('authorization_code', 'refresh_token', 'password', 'client_credentials');
/**
* Create a new OAuthCredentials.
*
* The configuration array accepts various options
*
* - authorizationUri
* The authorization server's HTTP endpoint capable of
* authenticating the end-user and obtaining authorization.
*
* - tokenCredentialUri
* The authorization server's HTTP endpoint capable of issuing
* tokens and refreshing expired tokens.
*
* - clientId
* A unique identifier issued to the client to identify itself to the
* authorization server.
*
* - clientSecret
* A shared symmetric secret issued by the authorization server,
* which is used to authenticate the client.
*
* - scope
* The scope of the access request, expressed either as an Array
* or as a space-delimited String.
*
* - state
* An arbitrary string designed to allow the client to maintain state.
*
* - redirectUri
* The redirection URI used in the initial request.
*
* - username
* The resource owner's username.
*
* - password
* The resource owner's password.
*
* - issuer
* Issuer ID when using assertion profile
*
* - audience
* Target audience for assertions
*
* - expiry
* Number of seconds assertions are valid for
*
* - signingKey
* Signing key when using assertion profile
*
* - refreshToken
* The refresh token associated with the access token
* to be refreshed.
*
* - accessToken
* The current access token for this client.
*
* - idToken
* The current ID token for this client.
*
* - extensionParams
* When using an extension grant type, this is the set of parameters used
* by that extension.
*
* @param array $config Configuration array
*/
public function __construct(array $config)
{
}
/**
* Verifies the idToken if present.
*
* - if none is present, return null
* - if present, but invalid, raises DomainException.
* - otherwise returns the payload in the idtoken as a PHP object.
*
* if $publicKey is null, the key is decoded without being verified.
*
* @param string $publicKey The public key to use to authenticate the token
* @param array $allowed_algs List of supported verification algorithms
*
* @return null|object
*/
public function verifyIdToken($publicKey = null, $allowed_algs = array())
{
}
/**
* Obtains the encoded jwt from the instance data.
*
* @param array $config array optional configuration parameters
*
* @return string
*/
public function toJwt(array $config = [])
{
}
/**
* Generates a request for token credentials.
*
* @return RequestInterface the authorization Url.
*/
public function generateCredentialsRequest()
{
}
/**
* Fetches the auth tokens based on the current state.
*
* @param callable $httpHandler callback which delivers psr7 request
*
* @return array the response
*/
public function fetchAuthToken(callable $httpHandler = null)
{
}
/**
* Obtains a key that can used to cache the results of #fetchAuthToken.
*
* The key is derived from the scopes.
*
* @return string a key that may be used to cache the auth token.
*/
public function getCacheKey()
{
}
/**
* Parses the fetched tokens.
*
* @param ResponseInterface $resp the response.
*
* @return array the tokens parsed from the response body.
*
* @throws \Exception
*/
public function parseTokenResponse(\Psr\Http\Message\ResponseInterface $resp)
{
}
/**
* Updates an OAuth 2.0 client.
*
* @example
* client.updateToken([
* 'refresh_token' => 'n4E9O119d',
* 'access_token' => 'FJQbwq9',
* 'expires_in' => 3600
* ])
*
* @param array $config
* The configuration parameters related to the token.
*
* - refresh_token
* The refresh token associated with the access token
* to be refreshed.
*
* - access_token
* The current access token for this client.
*
* - id_token
* The current ID token for this client.
*
* - expires_in
* The time in seconds until access token expiration.
*
* - expires_at
* The time as an integer number of seconds since the Epoch
*
* - issued_at
* The timestamp that the token was issued at.
*/
public function updateToken(array $config)
{
}
/**
* Builds the authorization Uri that the user should be redirected to.
*
* @param array $config configuration options that customize the return url
*
* @return UriInterface the authorization Url.
*
* @throws InvalidArgumentException
*/
public function buildFullAuthorizationUri(array $config = [])
{
}
/**
* Sets the authorization server's HTTP endpoint capable of authenticating
* the end-user and obtaining authorization.
*
* @param string $uri
*/
public function setAuthorizationUri($uri)
{
}
/**
* Gets the authorization server's HTTP endpoint capable of authenticating
* the end-user and obtaining authorization.
*
* @return UriInterface
*/
public function getAuthorizationUri()
{
}
/**
* Gets the authorization server's HTTP endpoint capable of issuing tokens
* and refreshing expired tokens.
*
* @return string
*/
public function getTokenCredentialUri()
{
}
/**
* Sets the authorization server's HTTP endpoint capable of issuing tokens
* and refreshing expired tokens.
*
* @param string $uri
*/
public function setTokenCredentialUri($uri)
{
}
/**
* Gets the redirection URI used in the initial request.
*
* @return string
*/
public function getRedirectUri()
{
}
/**
* Sets the redirection URI used in the initial request.
*
* @param string $uri
*/
public function setRedirectUri($uri)
{
}
/**
* Gets the scope of the access requests as a space-delimited String.
*
* @return string
*/
public function getScope()
{
}
/**
* Sets the scope of the access request, expressed either as an Array or as
* a space-delimited String.
*
* @param string|array $scope
*
* @throws InvalidArgumentException
*/
public function setScope($scope)
{
}
/**
* Gets the current grant type.
*
* @return string
*/
public function getGrantType()
{
}
/**
* Sets the current grant type.
*
* @param $grantType
*
* @throws InvalidArgumentException
*/
public function setGrantType($grantType)
{
}
/**
* Gets an arbitrary string designed to allow the client to maintain state.
*
* @return string
*/
public function getState()
{
}
/**
* Sets an arbitrary string designed to allow the client to maintain state.
*
* @param string $state
*/
public function setState($state)
{
}
/**
* Gets the authorization code issued to this client.
*/
public function getCode()
{
}
/**
* Sets the authorization code issued to this client.
*
* @param string $code
*/
public function setCode($code)
{
}
/**
* Gets the resource owner's username.
*/
public function getUsername()
{
}
/**
* Sets the resource owner's username.
*
* @param string $username
*/
public function setUsername($username)
{
}
/**
* Gets the resource owner's password.
*/
public function getPassword()
{
}
/**
* Sets the resource owner's password.
*
* @param $password
*/
public function setPassword($password)
{
}
/**
* Sets a unique identifier issued to the client to identify itself to the
* authorization server.
*/
public function getClientId()
{
}
/**
* Sets a unique identifier issued to the client to identify itself to the
* authorization server.
*
* @param $clientId
*/
public function setClientId($clientId)
{
}
/**
* Gets a shared symmetric secret issued by the authorization server, which
* is used to authenticate the client.
*/
public function getClientSecret()
{
}
/**
* Sets a shared symmetric secret issued by the authorization server, which
* is used to authenticate the client.
*
* @param $clientSecret
*/
public function setClientSecret($clientSecret)
{
}
/**
* Gets the Issuer ID when using assertion profile.
*/
public function getIssuer()
{
}
/**
* Sets the Issuer ID when using assertion profile.
*
* @param string $issuer
*/
public function setIssuer($issuer)
{
}
/**
* Gets the target sub when issuing assertions.
*/
public function getSub()
{
}
/**
* Sets the target sub when issuing assertions.
*
* @param string $sub
*/
public function setSub($sub)
{
}
/**
* Gets the target audience when issuing assertions.
*/
public function getAudience()
{
}
/**
* Sets the target audience when issuing assertions.
*
* @param string $audience
*/
public function setAudience($audience)
{
}
/**
* Gets the signing key when using an assertion profile.
*/
public function getSigningKey()
{
}
/**
* Sets the signing key when using an assertion profile.
*
* @param string $signingKey
*/
public function setSigningKey($signingKey)
{
}
/**
* Gets the signing algorithm when using an assertion profile.
*
* @return string
*/
public function getSigningAlgorithm()
{
}
/**
* Sets the signing algorithm when using an assertion profile.
*
* @param string $signingAlgorithm
*/
public function setSigningAlgorithm($signingAlgorithm)
{
}
/**
* Gets the set of parameters used by extension when using an extension
* grant type.
*/
public function getExtensionParams()
{
}
/**
* Sets the set of parameters used by extension when using an extension
* grant type.
*
* @param $extensionParams
*/
public function setExtensionParams($extensionParams)
{
}
/**
* Gets the number of seconds assertions are valid for.
*/
public function getExpiry()
{
}
/**
* Sets the number of seconds assertions are valid for.
*
* @param int $expiry
*/
public function setExpiry($expiry)
{
}
/**
* Gets the lifetime of the access token in seconds.
*/
public function getExpiresIn()
{
}
/**
* Sets the lifetime of the access token in seconds.
*
* @param int $expiresIn
*/
public function setExpiresIn($expiresIn)
{
}
/**
* Gets the time the current access token expires at.
*
* @return int
*/
public function getExpiresAt()
{
}
/**
* Returns true if the acccess token has expired.
*
* @return bool
*/
public function isExpired()
{
}
/**
* Sets the time the current access token expires at.
*
* @param int $expiresAt
*/
public function setExpiresAt($expiresAt)
{
}
/**
* Gets the time the current access token was issued at.
*/
public function getIssuedAt()
{
}
/**
* Sets the time the current access token was issued at.
*
* @param int $issuedAt
*/
public function setIssuedAt($issuedAt)
{
}
/**
* Gets the current access token.
*/
public function getAccessToken()
{
}
/**
* Sets the current access token.
*
* @param string $accessToken
*/
public function setAccessToken($accessToken)
{
}
/**
* Gets the current ID token.
*/
public function getIdToken()
{
}
/**
* Sets the current ID token.
*
* @param $idToken
*/
public function setIdToken($idToken)
{
}
/**
* Gets the refresh token associated with the current access token.
*/
public function getRefreshToken()
{
}
/**
* Sets the refresh token associated with the current access token.
*
* @param $refreshToken
*/
public function setRefreshToken($refreshToken)
{
}
/**
* The expiration of the last received token.
*
* @return array
*/
public function getLastReceivedToken()
{
}
}
}
namespace {
/**
* The Google API Client
* https://github.com/google/google-api-php-client
*/
class Google_Client
{
const LIBVER = "2.1.2";
const USER_AGENT_SUFFIX = "google-api-php-client/";
const OAUTH2_REVOKE_URI = 'https://accounts.google.com/o/oauth2/revoke';
const OAUTH2_TOKEN_URI = 'https://www.googleapis.com/oauth2/v4/token';
const OAUTH2_AUTH_URL = 'https://accounts.google.com/o/oauth2/auth';
const API_BASE_PATH = 'https://www.googleapis.com';
/** @var array $scopes */
// Scopes requested by the client
protected $requestedScopes = [];
/**
* Construct the Google Client.
*
* @param array $config
*/
public function __construct(array $config = array())
{
}
/**
* Get a string containing the version of the library.
*
* @return string
*/
public function getLibraryVersion()
{
}
/**
* For backwards compatibility
* alias for fetchAccessTokenWithAuthCode
*
* @param $code string code from accounts.google.com
* @return array access token
* @deprecated
*/
public function authenticate($code)
{
}
/**
* Attempt to exchange a code for an valid authentication token.
* Helper wrapped around the OAuth 2.0 implementation.
*
* @param $code string code from accounts.google.com
* @return array access token
*/
public function fetchAccessTokenWithAuthCode($code)
{
}
/**
* For backwards compatibility
* alias for fetchAccessTokenWithAssertion
*
* @return array access token
* @deprecated
*/
public function refreshTokenWithAssertion()
{
}
/**
* Fetches a fresh access token with a given assertion token.
* @param $assertionCredentials optional.
* @return array access token
*/
public function fetchAccessTokenWithAssertion(\GuzzleHttp\ClientInterface $authHttp = \null)
{
}
/**
* For backwards compatibility
* alias for fetchAccessTokenWithRefreshToken
*
* @param string $refreshToken
* @return array access token
*/
public function refreshToken($refreshToken)
{
}
/**
* Fetches a fresh OAuth 2.0 access token with the given refresh token.
* @param string $refreshToken
* @return array access token
*/
public function fetchAccessTokenWithRefreshToken($refreshToken = \null)
{
}
/**
* Create a URL to obtain user authorization.
* The authorization endpoint allows the user to first
* authenticate, and then grant/deny the access request.
* @param string|array $scope The scope is expressed as an array or list of space-delimited strings.
* @return string
*/
public function createAuthUrl($scope = \null)
{
}
/**
* Adds auth listeners to the HTTP client based on the credentials
* set in the Google API Client object
*
* @param GuzzleHttp\ClientInterface $http the http client object.
* @return GuzzleHttp\ClientInterface the http client object
*/
public function authorize(\GuzzleHttp\ClientInterface $http = \null)
{
}
/**
* Set the configuration to use application default credentials for
* authentication
*
* @see https://developers.google.com/identity/protocols/application-default-credentials
* @param boolean $useAppCreds
*/
public function useApplicationDefaultCredentials($useAppCreds = \true)
{
}
/**
* To prevent useApplicationDefaultCredentials from inappropriately being
* called in a conditional
*
* @see https://developers.google.com/identity/protocols/application-default-credentials
*/
public function isUsingApplicationDefaultCredentials()
{
}
/**
* @param string|array $token
* @throws InvalidArgumentException
*/
public function setAccessToken($token)
{
}
public function getAccessToken()
{
}
public function getRefreshToken()
{
}
/**
* Returns if the access_token is expired.
* @return bool Returns True if the access_token is expired.
*/
public function isAccessTokenExpired()
{
}
public function getAuth()
{
}
public function setAuth($auth)
{
}
/**
* Set the OAuth 2.0 Client ID.
* @param string $clientId
*/
public function setClientId($clientId)
{
}
public function getClientId()
{
}
/**
* Set the OAuth 2.0 Client Secret.
* @param string $clientSecret
*/
public function setClientSecret($clientSecret)
{
}
public function getClientSecret()
{
}
/**
* Set the OAuth 2.0 Redirect URI.
* @param string $redirectUri
*/
public function setRedirectUri($redirectUri)
{
}
public function getRedirectUri()
{
}
/**
* Set OAuth 2.0 "state" parameter to achieve per-request customization.
* @see http://tools.ietf.org/html/draft-ietf-oauth-v2-22#section-3.1.2.2
* @param string $state
*/
public function setState($state)
{
}
/**
* @param string $accessType Possible values for access_type include:
* {@code "offline"} to request offline access from the user.
* {@code "online"} to request online access from the user.
*/
public function setAccessType($accessType)
{
}
/**
* @param string $approvalPrompt Possible values for approval_prompt include:
* {@code "force"} to force the approval UI to appear.
* {@code "auto"} to request auto-approval when possible. (This is the default value)
*/
public function setApprovalPrompt($approvalPrompt)
{
}
/**
* Set the login hint, email address or sub id.
* @param string $loginHint
*/
public function setLoginHint($loginHint)
{
}
/**
* Set the application name, this is included in the User-Agent HTTP header.
* @param string $applicationName
*/
public function setApplicationName($applicationName)
{
}
/**
* If 'plus.login' is included in the list of requested scopes, you can use
* this method to define types of app activities that your app will write.
* You can find a list of available types here:
* @link https://developers.google.com/+/api/moment-types
*
* @param array $requestVisibleActions Array of app activity types
*/
public function setRequestVisibleActions($requestVisibleActions)
{
}
/**
* Set the developer key to use, these are obtained through the API Console.
* @see http://code.google.com/apis/console-help/#generatingdevkeys
* @param string $developerKey
*/
public function setDeveloperKey($developerKey)
{
}
/**
* Set the hd (hosted domain) parameter streamlines the login process for
* Google Apps hosted accounts. By including the domain of the user, you
* restrict sign-in to accounts at that domain.
* @param $hd string - the domain to use.
*/
public function setHostedDomain($hd)
{
}
/**
* Set the prompt hint. Valid values are none, consent and select_account.
* If no value is specified and the user has not previously authorized
* access, then the user is shown a consent screen.
* @param $prompt string
*/
public function setPrompt($prompt)
{
}
/**
* openid.realm is a parameter from the OpenID 2.0 protocol, not from OAuth
* 2.0. It is used in OpenID 2.0 requests to signify the URL-space for which
* an authentication request is valid.
* @param $realm string - the URL-space to use.
*/
public function setOpenidRealm($realm)
{
}
/**
* If this is provided with the value true, and the authorization request is
* granted, the authorization will include any previous authorizations
* granted to this user/application combination for other scopes.
* @param $include boolean - the URL-space to use.
*/
public function setIncludeGrantedScopes($include)
{
}
/**
* sets function to be called when an access token is fetched
* @param callable $tokenCallback - function ($cacheKey, $accessToken)
*/
public function setTokenCallback(callable $tokenCallback)
{
}
/**
* Revoke an OAuth2 access token or refresh token. This method will revoke the current access
* token, if a token isn't provided.
*
* @param string|null $token The token (access token or a refresh token) that should be revoked.
* @return boolean Returns True if the revocation was successful, otherwise False.
*/
public function revokeToken($token = \null)
{
}
/**
* Verify an id_token. This method will verify the current id_token, if one
* isn't provided.
*
* @throws LogicException
* @param string|null $idToken The token (id_token) that should be verified.
* @return array|false Returns the token payload as an array if the verification was
* successful, false otherwise.
*/
public function verifyIdToken($idToken = \null)
{
}
/**
* Set the scopes to be requested. Must be called before createAuthUrl().
* Will remove any previously configured scopes.
* @param array $scopes, ie: array('https://www.googleapis.com/auth/plus.login',
* 'https://www.googleapis.com/auth/moderator')
*/
public function setScopes($scopes)
{
}
/**
* This functions adds a scope to be requested as part of the OAuth2.0 flow.
* Will append any scopes not previously requested to the scope parameter.
* A single string will be treated as a scope to request. An array of strings
* will each be appended.
* @param $scope_or_scopes string|array e.g. "profile"
*/
public function addScope($scope_or_scopes)
{
}
/**
* Returns the list of scopes requested by the client
* @return array the list of scopes
*
*/
public function getScopes()
{
}
/**
* @return array
* @visible For Testing
*/
public function prepareScopes()
{
}
/**
* Helper method to execute deferred HTTP requests.
*
* @param $request Psr\Http\Message\RequestInterface|Google_Http_Batch
* @throws Google_Exception
* @return object of the type of the expected class or Psr\Http\Message\ResponseInterface.
*/
public function execute(\Psr\Http\Message\RequestInterface $request, $expectedClass = \null)
{
}
/**
* Declare whether batch calls should be used. This may increase throughput
* by making multiple requests in one connection.
*
* @param boolean $useBatch True if the batch support should
* be enabled. Defaults to False.
*/
public function setUseBatch($useBatch)
{
}
/**
* Are we running in Google AppEngine?
* return bool
*/
public function isAppEngine()
{
}
public function setConfig($name, $value)
{
}
public function getConfig($name, $default = \null)
{
}
/**
* For backwards compatibility
* alias for setAuthConfig
*
* @param string $file the configuration file
* @throws Google_Exception
* @deprecated
*/
public function setAuthConfigFile($file)
{
}
/**
* Set the auth config from new or deprecated JSON config.
* This structure should match the file downloaded from
* the "Download JSON" button on in the Google Developer
* Console.
* @param string|array $config the configuration json
* @throws Google_Exception
*/
public function setAuthConfig($config)
{
}
/**
* Use when the service account has been delegated domain wide access.
*
* @param string subject an email address account to impersonate
*/
public function setSubject($subject)
{
}
/**
* Declare whether making API calls should make the call immediately, or
* return a request which can be called with ->execute();
*
* @param boolean $defer True if calls should not be executed right away.
*/
public function setDefer($defer)
{
}
/**
* Whether or not to return raw requests
* @return boolean
*/
public function shouldDefer()
{
}
/**
* @return Google\Auth\OAuth2 implementation
*/
public function getOAuth2Service()
{
}
/**
* create a default google auth object
*/
protected function createOAuth2Service()
{
}
/**
* Set the Cache object
* @param Psr\Cache\CacheItemPoolInterface $cache
*/
public function setCache(\Psr\Cache\CacheItemPoolInterface $cache)
{
}
/**
* @return Psr\Cache\CacheItemPoolInterface Cache implementation
*/
public function getCache()
{
}
/**
* @return Google\Auth\CacheInterface Cache implementation
*/
public function setCacheConfig(array $cacheConfig)
{
}
/**
* Set the Logger object
* @param Psr\Log\LoggerInterface $logger
*/
public function setLogger(\Psr\Log\LoggerInterface $logger)
{
}
/**
* @return Psr\Log\LoggerInterface implementation
*/
public function getLogger()
{
}
protected function createDefaultLogger()
{
}
protected function createDefaultCache()
{
}
/**
* Set the Http Client object
* @param GuzzleHttp\ClientInterface $http
*/
public function setHttpClient(\GuzzleHttp\ClientInterface $http)
{
}
/**
* @return GuzzleHttp\ClientInterface implementation
*/
public function getHttpClient()
{
}
protected function createDefaultHttpClient()
{
}
protected function getAuthHandler()
{
}
}
/*
* Copyright 2011 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* This class defines attributes, valid values, and usage which is generated
* from a given json schema.
* http://tools.ietf.org/html/draft-zyp-json-schema-03#section-5
*
*/
class Google_Model implements \ArrayAccess
{
/**
* If you need to specify a NULL JSON value, use Google_Model::NULL_VALUE
* instead - it will be replaced when converting to JSON with a real null.
*/
const NULL_VALUE = "{}gapi-php-null";
protected $internal_gapi_mappings = array();
protected $modelData = array();
protected $processed = array();
/**
* Polymorphic - accepts a variable number of arguments dependent
* on the type of the model subclass.
*/
public final function __construct()
{
}
/**
* Getter that handles passthrough access to the data array, and lazy object creation.
* @param string $key Property name.
* @return mixed The value if any, or null.
*/
public function __get($key)
{
}
/**
* Initialize this object's properties from an array.
*
* @param array $array Used to seed this object's properties.
* @return void
*/
protected function mapTypes($array)
{
}
/**
* Blank initialiser to be used in subclasses to do post-construction initialisation - this
* avoids the need for subclasses to have to implement the variadics handling in their
* constructors.
*/
protected function gapiInit()
{
}
/**
* Create a simplified object suitable for straightforward
* conversion to JSON. This is relatively expensive
* due to the usage of reflection, but shouldn't be called
* a whole lot, and is the most straightforward way to filter.
*/
public function toSimpleObject()
{
}
/**
* Returns true only if the array is associative.
* @param array $array
* @return bool True if the array is associative.
*/
protected function isAssociativeArray($array)
{
}
/**
* Verify if $obj is an array.
* @throws Google_Exception Thrown if $obj isn't an array.
* @param array $obj Items that should be validated.
* @param string $method Method expecting an array as an argument.
*/
public function assertIsArray($obj, $method)
{
}
public function offsetExists($offset)
{
}
public function offsetGet($offset)
{
}
public function offsetSet($offset, $value)
{
}
public function offsetUnset($offset)
{
}
protected function keyType($key)
{
}
protected function dataType($key)
{
}
public function __isset($key)
{
}
public function __unset($key)
{
}
}
/*
* Copyright 2013 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class Google_Exception extends \Exception
{
}
/**
* Implements the actual methods/resources of the discovered Google API using magic function
* calling overloading (__call()), which on call will see if the method name (plus.activities.list)
* is available in this service, and if so construct an apiHttpRequest representing it.
*
*/
class Google_Service_Resource
{
public function __construct($service, $serviceName, $resourceName, $resource)
{
}
/**
* TODO: This function needs simplifying.
* @param $name
* @param $arguments
* @param $expectedClass - optional, the expected class name
* @return Google_Http_Request|expectedClass
* @throws Google_Exception
*/
public function call($name, $arguments, $expectedClass = \null)
{
}
protected function convertToArrayAndStripNulls($o)
{
}
/**
* Parse/expand request parameters and create a fully qualified
* request uri.
* @static
* @param string $restPath
* @param array $params
* @return string $requestUrl
*/
public function createRequestUri($restPath, $params)
{
}
}
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class Google_Service_Exception extends \Google_Exception
{
/**
* Optional list of errors returned in a JSON body of an HTTP error response.
*/
protected $errors = array();
/**
* Override default constructor to add the ability to set $errors and a retry
* map.
*
* @param string $message
* @param int $code
* @param Exception|null $previous
* @param [{string, string}] errors List of errors returned in an HTTP
* response. Defaults to [].
* @param array|null $retryMap Map of errors with retry counts.
*/
public function __construct($message, $code = 0, \Exception $previous = \null, $errors = array())
{
}
/**
* An example of the possible errors returned.
*
* {
* "domain": "global",
* "reason": "authError",
* "message": "Invalid Credentials",
* "locationType": "header",
* "location": "Authorization",
* }
*
* @return [{string, string}] List of errors return in an HTTP response or [].
*/
public function getErrors()
{
}
}
/**
*
*/
class Google_AuthHandler_Guzzle6AuthHandler
{
protected $cache;
protected $cacheConfig;
public function __construct(\Psr\Cache\CacheItemPoolInterface $cache = \null, array $cacheConfig = [])
{
}
public function attachCredentials(\GuzzleHttp\ClientInterface $http, \Google\Auth\CredentialsLoader $credentials, callable $tokenCallback = \null)
{
}
public function attachToken(\GuzzleHttp\ClientInterface $http, array $token, array $scopes)
{
}
public function attachKey(\GuzzleHttp\ClientInterface $http, $key)
{
}
}
/**
*
*/
class Google_AuthHandler_Guzzle5AuthHandler
{
protected $cache;
protected $cacheConfig;
public function __construct(\Psr\Cache\CacheItemPoolInterface $cache = \null, array $cacheConfig = [])
{
}
public function attachCredentials(\GuzzleHttp\ClientInterface $http, \Google\Auth\CredentialsLoader $credentials, callable $tokenCallback = \null)
{
}
public function attachToken(\GuzzleHttp\ClientInterface $http, array $token, array $scopes)
{
}
public function attachKey(\GuzzleHttp\ClientInterface $http, $key)
{
}
}
class Google_AuthHandler_AuthHandlerFactory
{
/**
* Builds out a default http handler for the installed version of guzzle.
*
* @return Google_AuthHandler_Guzzle5AuthHandler|Google_AuthHandler_Guzzle6AuthHandler
* @throws Exception
*/
public static function build($cache = \null, array $cacheConfig = [])
{
}
}
/*
* Copyright 2013 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Implementation of levels 1-3 of the URI Template spec.
* @see http://tools.ietf.org/html/rfc6570
*/
class Google_Utils_UriTemplate
{
const TYPE_MAP = "1";
const TYPE_LIST = "2";
const TYPE_SCALAR = "4";
public function parse($string, array $parameters)
{
}
public function combine($key, $parameters, $sep, $combine, $reserved, $tag_empty, $combine_on_empty)
{
}
}
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class Google_Task_Exception extends \Google_Exception
{
}
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* Interface for checking how many times a given task can be retried following
* a failure.
*/
interface Google_Task_Retryable
{
}
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* A task runner with exponential backoff support.
*
* @see https://developers.google.com/drive/web/handle-errors#implementing_exponential_backoff
*/
class Google_Task_Runner
{
const TASK_RETRY_NEVER = 0;
const TASK_RETRY_ONCE = 1;
const TASK_RETRY_ALWAYS = -1;
/**
* @var array $retryMap Map of errors with retry counts.
*/
protected $retryMap = [
'500' => self::TASK_RETRY_ALWAYS,
'503' => self::TASK_RETRY_ALWAYS,
'rateLimitExceeded' => self::TASK_RETRY_ALWAYS,
'userRateLimitExceeded' => self::TASK_RETRY_ALWAYS,
6 => self::TASK_RETRY_ALWAYS,
// CURLE_COULDNT_RESOLVE_HOST
7 => self::TASK_RETRY_ALWAYS,
// CURLE_COULDNT_CONNECT
28 => self::TASK_RETRY_ALWAYS,
// CURLE_OPERATION_TIMEOUTED
35 => self::TASK_RETRY_ALWAYS,
// CURLE_SSL_CONNECT_ERROR
52 => self::TASK_RETRY_ALWAYS,
];
/**
* Creates a new task runner with exponential backoff support.
*
* @param array $config The task runner config
* @param string $name The name of the current task (used for logging)
* @param callable $action The task to run and possibly retry
* @param array $arguments The task arguments
* @throws Google_Task_Exception when misconfigured
*/
public function __construct($config, $name, $action, array $arguments = array())
{
}
/**
* Checks if a retry can be attempted.
*
* @return boolean
*/
public function canAttempt()
{
}
/**
* Runs the task and (if applicable) automatically retries when errors occur.
*
* @return mixed
* @throws Google_Task_Retryable on failure when no retries are available.
*/
public function run()
{
}
/**
* Runs a task once, if possible. This is useful for bypassing the `run()`
* loop.
*
* NOTE: If this is not the first attempt, this function will sleep in
* accordance to the backoff configurations before running the task.
*
* @return boolean
*/
public function attempt()
{
}
/**
* Gets the number of times the associated task can be retried.
*
* NOTE: -1 is returned if the task can be retried indefinitely
*
* @return integer
*/
public function allowedRetries($code, $errors = array())
{
}
public function setRetryMap($retryMap)
{
}
}
/**
* Manage large file uploads, which may be media but can be any type
* of sizable data.
*/
class Google_Http_MediaFileUpload
{
const UPLOAD_MEDIA_TYPE = 'media';
const UPLOAD_MULTIPART_TYPE = 'multipart';
const UPLOAD_RESUMABLE_TYPE = 'resumable';
/**
* @param $mimeType string
* @param $data string The bytes you want to upload.
* @param $resumable bool
* @param bool $chunkSize File will be uploaded in chunks of this many bytes.
* only used if resumable=True
*/
public function __construct(\Google_Client $client, \Psr\Http\Message\RequestInterface $request, $mimeType, $data, $resumable = \false, $chunkSize = \false)
{
}
/**
* Set the size of the file that is being uploaded.
* @param $size - int file size in bytes
*/
public function setFileSize($size)
{
}
/**
* Return the progress on the upload
* @return int progress in bytes uploaded.
*/
public function getProgress()
{
}
/**
* Send the next part of the file to upload.
* @param [$chunk] the next set of bytes to send. If false will used $data passed
* at construct time.
*/
public function nextChunk($chunk = \false)
{
}
/**
* Return the HTTP result code from the last call made.
* @return int code
*/
public function getHttpResultCode()
{
}
/**
* Resume a previously unfinished upload
* @param $resumeUri the resume-URI of the unfinished, resumable upload.
*/
public function resume($resumeUri)
{
}
/**
* Valid upload types:
* - resumable (UPLOAD_RESUMABLE_TYPE)
* - media (UPLOAD_MEDIA_TYPE)
* - multipart (UPLOAD_MULTIPART_TYPE)
* @param $meta
* @return string
* @visible for testing
*/
public function getUploadType($meta)
{
}
public function getResumeUri()
{
}
public function setChunkSize($chunkSize)
{
}
public function getRequest()
{
}
}
/**
* This class implements the RESTful transport of apiServiceRequest()'s
*/
class Google_Http_REST
{
/**
* Executes a Psr\Http\Message\RequestInterface and (if applicable) automatically retries
* when errors occur.
*
* @param Google_Client $client
* @param Psr\Http\Message\RequestInterface $req
* @return array decoded result
* @throws Google_Service_Exception on server side error (ie: not authenticated,
* invalid or malformed post body, invalid url)
*/
public static function execute(\GuzzleHttp\ClientInterface $client, \Psr\Http\Message\RequestInterface $request, $expectedClass = \null, $config = array(), $retryMap = \null)
{
}
/**
* Executes a Psr\Http\Message\RequestInterface
*
* @param Google_Client $client
* @param Psr\Http\Message\RequestInterface $request
* @return array decoded result
* @throws Google_Service_Exception on server side error (ie: not authenticated,
* invalid or malformed post body, invalid url)
*/
public static function doExecute(\GuzzleHttp\ClientInterface $client, \Psr\Http\Message\RequestInterface $request, $expectedClass = \null)
{
}
/**
* Decode an HTTP Response.
* @static
* @throws Google_Service_Exception
* @param Psr\Http\Message\RequestInterface $response The http response to be decoded.
* @param Psr\Http\Message\ResponseInterface $response
* @return mixed|null
*/
public static function decodeHttpResponse(\Psr\Http\Message\ResponseInterface $response, \Psr\Http\Message\RequestInterface $request = \null, $expectedClass = \null)
{
}
}
/**
* Class to handle batched requests to the Google API service.
*/
class Google_Http_Batch
{
const BATCH_PATH = 'batch';
public function __construct(\Google_Client $client, $boundary = \false, $rootUrl = \null, $batchPath = \null)
{
}
public function add(\Psr\Http\Message\RequestInterface $request, $key = \false)
{
}
public function execute()
{
}
public function parseResponse(\Psr\Http\Message\ResponseInterface $response, $classes = array())
{
}
}
/**
* Extension to the regular Google_Model that automatically
* exposes the items array for iteration, so you can just
* iterate over the object rather than a reference inside.
*/
class Google_Collection extends \Google_Model implements \Iterator, \Countable
{
protected $collection_key = 'items';
public function rewind()
{
}
public function current()
{
}
public function key()
{
}
public function next()
{
}
public function valid()
{
}
public function count()
{
}
public function offsetExists($offset)
{
}
public function offsetGet($offset)
{
}
public function offsetSet($offset, $value)
{
}
public function offsetUnset($offset)
{
}
}
/**
* Wrapper around Google Access Tokens which provides convenience functions
*
*/
class Google_AccessToken_Verify
{
const FEDERATED_SIGNON_CERT_URL = 'https://www.googleapis.com/oauth2/v3/certs';
const OAUTH2_ISSUER = 'accounts.google.com';
const OAUTH2_ISSUER_HTTPS = 'https://accounts.google.com';
/**
* Instantiates the class, but does not initiate the login flow, leaving it
* to the discretion of the caller.
*/
public function __construct(\GuzzleHttp\ClientInterface $http = \null, \Psr\Cache\CacheItemPoolInterface $cache = \null, $jwt = \null)
{
}
/**
* Verifies an id token and returns the authenticated apiLoginTicket.
* Throws an exception if the id token is not valid.
* The audience parameter can be used to control which id tokens are
* accepted. By default, the id token must have been issued to this OAuth2 client.
*
* @param $audience
* @return array the token payload, if successful
*/
public function verifyIdToken($idToken, $audience = \null)
{
}
}
/**
* Wrapper around Google Access Tokens which provides convenience functions
*
*/
class Google_AccessToken_Revoke
{
/**
* Instantiates the class, but does not initiate the login flow, leaving it
* to the discretion of the caller.
*/
public function __construct(\GuzzleHttp\ClientInterface $http = \null)
{
}
/**
* Revoke an OAuth2 access token or refresh token. This method will revoke the current access
* token, if a token isn't provided.
*
* @param string|array $token The token (access token or a refresh token) that should be revoked.
* @return boolean Returns True if the revocation was successful, otherwise False.
*/
public function revokeToken($token)
{
}
}
/*
* Copyright 2010 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
class Google_Service
{
public $batchPath;
public $rootUrl;
public $version;
public $servicePath;
public $availableScopes;
public $resource;
public function __construct(\Google_Client $client)
{
}
/**
* Return the associated Google_Client class.
* @return Google_Client
*/
public function getClient()
{
}
/**
* Create a new HTTP Batch handler for this service
*
* @return Google_Http_Batch
*/
public function createBatch()
{
}
}
}
namespace ReCaptcha {
/**
* reCAPTCHA client.
*/
class ReCaptcha
{
/**
* Version of this client library.
* @const string
*/
const VERSION = 'php_1.1.2';
/**
* Create a configured instance to use the reCAPTCHA service.
*
* @param string $secret shared secret between site and reCAPTCHA server.
* @param RequestMethod $requestMethod method used to send the request. Defaults to POST.
*/
public function __construct($secret, \ReCaptcha\RequestMethod $requestMethod = null)
{
}
/**
* Calls the reCAPTCHA siteverify API to verify whether the user passes
* CAPTCHA test.
*
* @param string $response The value of 'g-recaptcha-response' in the submitted form.
* @param string $remoteIp The end user's IP address.
* @return Response Response from the service.
*/
public function verify($response, $remoteIp = null)
{
}
}
/**
* Stores and formats the parameters for the request to the reCAPTCHA service.
*/
class RequestParameters
{
/**
* Initialise parameters.
*
* @param string $secret Site secret.
* @param string $response Value from g-captcha-response form field.
* @param string $remoteIp User's IP address.
* @param string $version Version of this client library.
*/
public function __construct($secret, $response, $remoteIp = null, $version = null)
{
}
/**
* Array representation.
*
* @return array Array formatted parameters.
*/
public function toArray()
{
}
/**
* Query string representation for HTTP request.
*
* @return string Query string formatted parameters.
*/
public function toQueryString()
{
}
}
}
namespace ReCaptcha\RequestMethod {
/**
* Convenience wrapper around the cURL functions to allow mocking.
*/
class Curl
{
/**
* @see http://php.net/curl_init
* @param string $url
* @return resource cURL handle
*/
public function init($url = null)
{
}
/**
* @see http://php.net/curl_setopt_array
* @param resource $ch
* @param array $options
* @return bool
*/
public function setoptArray($ch, array $options)
{
}
/**
* @see http://php.net/curl_exec
* @param resource $ch
* @return mixed
*/
public function exec($ch)
{
}
/**
* @see http://php.net/curl_close
* @param resource $ch
*/
public function close($ch)
{
}
}
}
namespace ReCaptcha {
/**
* Method used to send the request to the service.
*/
interface RequestMethod
{
/**
* Submit the request with the specified parameters.
*
* @param RequestParameters $params Request parameters
* @return string Body of the reCAPTCHA response
*/
public function submit(\ReCaptcha\RequestParameters $params);
}
}
namespace ReCaptcha\RequestMethod {
/**
* Sends a POST request to the reCAPTCHA service, but makes use of fsockopen()
* instead of get_file_contents(). This is to account for people who may be on
* servers where allow_furl_open is disabled.
*/
class SocketPost implements \ReCaptcha\RequestMethod
{
/**
* reCAPTCHA service host.
* @const string
*/
const RECAPTCHA_HOST = 'www.google.com';
/**
* @const string reCAPTCHA service path
*/
const SITE_VERIFY_PATH = '/recaptcha/api/siteverify';
/**
* @const string Bad request error
*/
const BAD_REQUEST = '{"success": false, "error-codes": ["invalid-request"]}';
/**
* @const string Bad response error
*/
const BAD_RESPONSE = '{"success": false, "error-codes": ["invalid-response"]}';
/**
* Constructor
*
* @param \ReCaptcha\RequestMethod\Socket $socket optional socket, injectable for testing
*/
public function __construct(\ReCaptcha\RequestMethod\Socket $socket = null)
{
}
/**
* Submit the POST request with the specified parameters.
*
* @param RequestParameters $params Request parameters
* @return string Body of the reCAPTCHA response
*/
public function submit(\ReCaptcha\RequestParameters $params)
{
}
}
/**
* Sends cURL request to the reCAPTCHA service.
* Note: this requires the cURL extension to be enabled in PHP
* @see http://php.net/manual/en/book.curl.php
*/
class CurlPost implements \ReCaptcha\RequestMethod
{
/**
* URL to which requests are sent via cURL.
* @const string
*/
const SITE_VERIFY_URL = 'https://www.google.com/recaptcha/api/siteverify';
public function __construct(\ReCaptcha\RequestMethod\Curl $curl = null)
{
}
/**
* Submit the cURL request with the specified parameters.
*
* @param RequestParameters $params Request parameters
* @return string Body of the reCAPTCHA response
*/
public function submit(\ReCaptcha\RequestParameters $params)
{
}
}
/**
* Sends POST requests to the reCAPTCHA service.
*/
class Post implements \ReCaptcha\RequestMethod
{
/**
* URL to which requests are POSTed.
* @const string
*/
const SITE_VERIFY_URL = 'https://www.google.com/recaptcha/api/siteverify';
/**
* Submit the POST request with the specified parameters.
*
* @param RequestParameters $params Request parameters
* @return string Body of the reCAPTCHA response
*/
public function submit(\ReCaptcha\RequestParameters $params)
{
}
}
/**
* Convenience wrapper around native socket and file functions to allow for
* mocking.
*/
class Socket
{
/**
* fsockopen
*
* @see http://php.net/fsockopen
* @param string $hostname
* @param int $port
* @param int $errno
* @param string $errstr
* @param float $timeout
* @return resource
*/
public function fsockopen($hostname, $port = -1, &$errno = 0, &$errstr = '', $timeout = null)
{
}
/**
* fwrite
*
* @see http://php.net/fwrite
* @param string $string
* @param int $length
* @return int | bool
*/
public function fwrite($string, $length = null)
{
}
/**
* fgets
*
* @see http://php.net/fgets
* @param int $length
* @return string
*/
public function fgets($length = null)
{
}
/**
* feof
*
* @see http://php.net/feof
* @return bool
*/
public function feof()
{
}
/**
* fclose
*
* @see http://php.net/fclose
* @return bool
*/
public function fclose()
{
}
}
}
namespace ReCaptcha {
/**
* The response returned from the service.
*/
class Response
{
/**
* Build the response from the expected JSON returned by the service.
*
* @param string $json
* @return \ReCaptcha\Response
*/
public static function fromJson($json)
{
}
/**
* Constructor.
*
* @param boolean $success
* @param array $errorCodes
*/
public function __construct($success, array $errorCodes = array())
{
}
/**
* Is success?
*
* @return boolean
*/
public function isSuccess()
{
}
/**
* Get error codes.
*
* @return array
*/
public function getErrorCodes()
{
}
}
}
namespace Aws {
/**
* Represents an AWS client.
*/
interface AwsClientInterface
{
/**
* Creates and executes a command for an operation by name.
*
* Suffixing an operation name with "Async" will return a
* promise that can be used to execute commands asynchronously.
*
* @param string $name Name of the command to execute.
* @param array $arguments Arguments to pass to the getCommand method.
*
* @return ResultInterface
* @throws \Exception
*/
public function __call($name, array $arguments);
/**
* Create a command for an operation name.
*
* Special keys may be set on the command to control how it behaves,
* including:
*
* - @http: Associative array of transfer specific options to apply to the
* request that is serialized for this command. Available keys include
* "proxy", "verify", "timeout", "connect_timeout", "debug", "delay", and
* "headers".
*
* @param string $name Name of the operation to use in the command
* @param array $args Arguments to pass to the command
*
* @return CommandInterface
* @throws \InvalidArgumentException if no command can be found by name
*/
public function getCommand($name, array $args = []);
/**
* Execute a single command.
*
* @param CommandInterface $command Command to execute
*
* @return ResultInterface
* @throws \Exception
*/
public function execute(\Aws\CommandInterface $command);
/**
* Execute a command asynchronously.
*
* @param CommandInterface $command Command to execute
*
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function executeAsync(\Aws\CommandInterface $command);
/**
* Returns a promise that is fulfilled with an
* {@see \Aws\Credentials\CredentialsInterface} object.
*
* If you need the credentials synchronously, then call the wait() method
* on the returned promise.
*
* @return PromiseInterface
*/
public function getCredentials();
/**
* Get the region to which the client is configured to send requests.
*
* @return string
*/
public function getRegion();
/**
* Gets the default endpoint, or base URL, used by the client.
*
* @return UriInterface
*/
public function getEndpoint();
/**
* Get the service description associated with the client.
*
* @return \Aws\Api\Service
*/
public function getApi();
/**
* Get a client configuration value.
*
* @param string|null $option The option to retrieve. Pass null to retrieve
* all options.
* @return mixed|null
*/
public function getConfig($option = null);
/**
* Get the handler list used to transfer commands.
*
* This list can be modified to add middleware or to change the underlying
* handler used to send HTTP requests.
*
* @return HandlerList
*/
public function getHandlerList();
/**
* Get a resource iterator for the specified operation.
*
* @param string $name Name of the iterator to retrieve.
* @param array $args Command arguments to use with each command.
*
* @return \Iterator
* @throws \UnexpectedValueException if the iterator config is invalid.
*/
public function getIterator($name, array $args = []);
/**
* Get a result paginator for the specified operation.
*
* @param string $name Name of the operation used for iterator
* @param array $args Command args to be used with each command
*
* @return \Aws\ResultPaginator
* @throws \UnexpectedValueException if the iterator config is invalid.
*/
public function getPaginator($name, array $args = []);
/**
* Wait until a resource is in a particular state.
*
* @param string|callable $name Name of the waiter that defines the wait
* configuration and conditions.
* @param array $args Args to be used with each command executed
* by the waiter. Waiter configuration options
* can be provided in an associative array in
* the @waiter key.
* @return void
* @throws \UnexpectedValueException if the waiter is invalid.
*/
public function waitUntil($name, array $args = []);
/**
* Get a waiter that waits until a resource is in a particular state.
*
* Retrieving a waiter can be useful when you wish to wait asynchronously:
*
* $waiter = $client->getWaiter('foo', ['bar' => 'baz']);
* $waiter->promise()->then(function () { echo 'Done!'; });
*
* @param string|callable $name Name of the waiter that defines the wait
* configuration and conditions.
* @param array $args Args to be used with each command executed
* by the waiter. Waiter configuration options
* can be provided in an associative array in
* the @waiter key.
* @return \Aws\Waiter
* @throws \UnexpectedValueException if the waiter is invalid.
*/
public function getWaiter($name, array $args = []);
}
/**
* A trait providing generic functionality for interacting with Amazon Web
* Services. This is meant to be used in classes implementing
* \Aws\AwsClientInterface
*/
trait AwsClientTrait
{
public function getPaginator($name, array $args = [])
{
}
public function getIterator($name, array $args = [])
{
}
public function waitUntil($name, array $args = [])
{
}
public function getWaiter($name, array $args = [])
{
}
public function execute(\Aws\CommandInterface $command)
{
}
public function executeAsync(\Aws\CommandInterface $command)
{
}
public function __call($name, array $args)
{
}
/**
* @param string $name
* @param array $args
*
* @return CommandInterface
*/
public abstract function getCommand($name, array $args = []);
/**
* @return Service
*/
public abstract function getApi();
}
/**
* Default AWS client implementation
*/
class AwsClient implements \Aws\AwsClientInterface
{
use \Aws\AwsClientTrait;
/**
* Get an array of client constructor arguments used by the client.
*
* @return array
*/
public static function getArguments()
{
}
/**
* The client constructor accepts the following options:
*
* - api_provider: (callable) An optional PHP callable that accepts a
* type, service, and version argument, and returns an array of
* corresponding configuration data. The type value can be one of api,
* waiter, or paginator.
* - credentials:
* (Aws\Credentials\CredentialsInterface|array|bool|callable) Specifies
* the credentials used to sign requests. Provide an
* Aws\Credentials\CredentialsInterface object, an associative array of
* "key", "secret", and an optional "token" key, `false` to use null
* credentials, or a callable credentials provider used to create
* credentials or return null. See Aws\Credentials\CredentialProvider for
* a list of built-in credentials providers. If no credentials are
* provided, the SDK will attempt to load them from the environment.
* - debug: (bool|array) Set to true to display debug information when
* sending requests. Alternatively, you can provide an associative array
* with the following keys: logfn: (callable) Function that is invoked
* with log messages; stream_size: (int) When the size of a stream is
* greater than this number, the stream data will not be logged (set to
* "0" to not log any stream data); scrub_auth: (bool) Set to false to
* disable the scrubbing of auth data from the logged messages; http:
* (bool) Set to false to disable the "debug" feature of lower level HTTP
* adapters (e.g., verbose curl output).
* - stats: (bool|array) Set to true to gather transfer statistics on
* requests sent. Alternatively, you can provide an associative array with
* the following keys: retries: (bool) Set to false to disable reporting
* on retries attempted; http: (bool) Set to true to enable collecting
* statistics from lower level HTTP adapters (e.g., values returned in
* GuzzleHttp\TransferStats). HTTP handlers must support an
* `http_stats_receiver` option for this to have an effect; timer: (bool)
* Set to true to enable a command timer that reports the total wall clock
* time spent on an operation in seconds.
* - endpoint: (string) The full URI of the webservice. This is only
* required when connecting to a custom endpoint (e.g., a local version
* of S3).
* - endpoint_provider: (callable) An optional PHP callable that
* accepts a hash of options including a "service" and "region" key and
* returns NULL or a hash of endpoint data, of which the "endpoint" key
* is required. See Aws\Endpoint\EndpointProvider for a list of built-in
* providers.
* - handler: (callable) A handler that accepts a command object,
* request object and returns a promise that is fulfilled with an
* Aws\ResultInterface object or rejected with an
* Aws\Exception\AwsException. A handler does not accept a next handler
* as it is terminal and expected to fulfill a command. If no handler is
* provided, a default Guzzle handler will be utilized.
* - http: (array, default=array(0)) Set to an array of SDK request
* options to apply to each request (e.g., proxy, verify, etc.).
* - http_handler: (callable) An HTTP handler is a function that
* accepts a PSR-7 request object and returns a promise that is fulfilled
* with a PSR-7 response object or rejected with an array of exception
* data. NOTE: This option supersedes any provided "handler" option.
* - idempotency_auto_fill: (bool|callable) Set to false to disable SDK to
* populate parameters that enabled 'idempotencyToken' trait with a random
* UUID v4 value on your behalf. Using default value 'true' still allows
* parameter value to be overwritten when provided. Note: auto-fill only
* works when cryptographically secure random bytes generator functions
* (random_bytes, openssl_random_pseudo_bytes or mcrypt_create_iv) can be
* found. You may also provide a callable source of random bytes.
* - profile: (string) Allows you to specify which profile to use when
* credentials are created from the AWS credentials file in your HOME
* directory. This setting overrides the AWS_PROFILE environment
* variable. Note: Specifying "profile" will cause the "credentials" key
* to be ignored.
* - region: (string, required) Region to connect to. See
* http://docs.aws.amazon.com/general/latest/gr/rande.html for a list of
* available regions.
* - retries: (int, default=int(3)) Configures the maximum number of
* allowed retries for a client (pass 0 to disable retries).
* - scheme: (string, default=string(5) "https") URI scheme to use when
* connecting connect. The SDK will utilize "https" endpoints (i.e.,
* utilize SSL/TLS connections) by default. You can attempt to connect to
* a service over an unencrypted "http" endpoint by setting ``scheme`` to
* "http".
* - signature_provider: (callable) A callable that accepts a signature
* version name (e.g., "v4"), a service name, and region, and
* returns a SignatureInterface object or null. This provider is used to
* create signers utilized by the client. See
* Aws\Signature\SignatureProvider for a list of built-in providers
* - signature_version: (string) A string representing a custom
* signature version to use with a service (e.g., v4). Note that
* per/operation signature version MAY override this requested signature
* version.
* - validate: (bool, default=bool(true)) Set to false to disable
* client-side parameter validation.
* - version: (string, required) The version of the webservice to
* utilize (e.g., 2006-03-01).
*
* @param array $args Client configuration arguments.
*
* @throws \InvalidArgumentException if any required options are missing or
* the service is not supported.
*/
public function __construct(array $args)
{
}
public function getHandlerList()
{
}
public function getConfig($option = null)
{
}
public function getCredentials()
{
}
public function getEndpoint()
{
}
public function getRegion()
{
}
public function getApi()
{
}
public function getCommand($name, array $args = [])
{
}
public function __sleep()
{
}
/**
* Get the signature_provider function of the client.
*
* @return callable
*/
protected final function getSignatureProvider()
{
}
/**
* Returns a service model and doc model with any necessary changes
* applied.
*
* @param array $api Array of service data being documented.
* @param array $docs Array of doc model data.
*
* @return array Tuple containing a [Service, DocModel]
*
* @internal This should only used to document the service API.
* @codeCoverageIgnore
*/
public static function applyDocFilters(array $api, array $docs)
{
}
/**
* @deprecated
* @return static
*/
public static function factory(array $config = [])
{
}
}
}
namespace Aws\Shield {
/**
* This client is used to interact with the **AWS Shield** service.
* @method \Aws\Result associateDRTLogBucket(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateDRTLogBucketAsync(array $args = [])
* @method \Aws\Result associateDRTRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateDRTRoleAsync(array $args = [])
* @method \Aws\Result createProtection(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProtectionAsync(array $args = [])
* @method \Aws\Result createSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSubscriptionAsync(array $args = [])
* @method \Aws\Result deleteProtection(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProtectionAsync(array $args = [])
* @method \Aws\Result deleteSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSubscriptionAsync(array $args = [])
* @method \Aws\Result describeAttack(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAttackAsync(array $args = [])
* @method \Aws\Result describeDRTAccess(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDRTAccessAsync(array $args = [])
* @method \Aws\Result describeEmergencyContactSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEmergencyContactSettingsAsync(array $args = [])
* @method \Aws\Result describeProtection(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProtectionAsync(array $args = [])
* @method \Aws\Result describeSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSubscriptionAsync(array $args = [])
* @method \Aws\Result disassociateDRTLogBucket(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateDRTLogBucketAsync(array $args = [])
* @method \Aws\Result disassociateDRTRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateDRTRoleAsync(array $args = [])
* @method \Aws\Result getSubscriptionState(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSubscriptionStateAsync(array $args = [])
* @method \Aws\Result listAttacks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAttacksAsync(array $args = [])
* @method \Aws\Result listProtections(array $args = [])
* @method \GuzzleHttp\Promise\Promise listProtectionsAsync(array $args = [])
* @method \Aws\Result updateEmergencyContactSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEmergencyContactSettingsAsync(array $args = [])
* @method \Aws\Result updateSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSubscriptionAsync(array $args = [])
*/
class ShieldClient extends \Aws\AwsClient
{
}
}
namespace Aws {
/**
* Interface for adding and retrieving client-side monitoring events
*/
interface MonitoringEventsInterface
{
/**
* Get client-side monitoring events attached to this object. Each event is
* represented as an associative array within the returned array.
*
* @return array
*/
public function getMonitoringEvents();
/**
* Prepend a client-side monitoring event to this object's event list
*
* @param array $event
*/
public function prependMonitoringEvent(array $event);
/**
* Append a client-side monitoring event to this object's event list
*
* @param array $event
*/
public function appendMonitoringEvent(array $event);
}
interface ResponseContainerInterface
{
/**
* Get the received HTTP response if any.
*
* @return ResponseInterface|null
*/
public function getResponse();
}
trait HasMonitoringEventsTrait
{
private $monitoringEvents = [];
/**
* Get client-side monitoring events attached to this object. Each event is
* represented as an associative array within the returned array.
*
* @return array
*/
public function getMonitoringEvents()
{
}
/**
* Prepend a client-side monitoring event to this object's event list
*
* @param array $event
*/
public function prependMonitoringEvent(array $event)
{
}
/**
* Append a client-side monitoring event to this object's event list
*
* @param array $event
*/
public function appendMonitoringEvent(array $event)
{
}
}
}
namespace Aws\Exception {
/**
* Represents an AWS exception that is thrown when a command fails.
*/
class AwsException extends \RuntimeException implements \Aws\MonitoringEventsInterface, \Aws\ResponseContainerInterface
{
use \Aws\HasMonitoringEventsTrait;
/**
* @param string $message Exception message
* @param CommandInterface $command
* @param array $context Exception context
* @param \Exception $previous Previous exception (if any)
*/
public function __construct($message, \Aws\CommandInterface $command, array $context = [], \Exception $previous = null)
{
}
public function __toString()
{
}
/**
* Get the command that was executed.
*
* @return CommandInterface
*/
public function getCommand()
{
}
/**
* Get the concise error message if any.
*
* @return string|null
*/
public function getAwsErrorMessage()
{
}
/**
* Get the sent HTTP request if any.
*
* @return RequestInterface|null
*/
public function getRequest()
{
}
/**
* Get the received HTTP response if any.
*
* @return ResponseInterface|null
*/
public function getResponse()
{
}
/**
* Get the result of the exception if available
*
* @return ResultInterface|null
*/
public function getResult()
{
}
/**
* Returns true if this is a connection error.
*
* @return bool
*/
public function isConnectionError()
{
}
/**
* If available, gets the HTTP status code of the corresponding response
*
* @return int|null
*/
public function getStatusCode()
{
}
/**
* Get the request ID of the error. This value is only present if a
* response was received and is not present in the event of a networking
* error.
*
* @return string|null Returns null if no response was received
*/
public function getAwsRequestId()
{
}
/**
* Get the AWS error type.
*
* @return string|null Returns null if no response was received
*/
public function getAwsErrorType()
{
}
/**
* Get the AWS error code.
*
* @return string|null Returns null if no response was received
*/
public function getAwsErrorCode()
{
}
/**
* Get all transfer information as an associative array if no $name
* argument is supplied, or gets a specific transfer statistic if
* a $name attribute is supplied (e.g., 'retries_attempted').
*
* @param string $name Name of the transfer stat to retrieve
*
* @return mixed|null|array
*/
public function getTransferInfo($name = null)
{
}
/**
* Replace the transfer information associated with an exception.
*
* @param array $info
*/
public function setTransferInfo(array $info)
{
}
}
}
namespace Aws\Shield\Exception {
/**
* Represents an error interacting with the **AWS Shield** service.
*/
class ShieldException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* Represents a simple cache interface.
*/
interface CacheInterface
{
/**
* Get a cache item by key.
*
* @param string $key Key to retrieve.
*
* @return mixed|null Returns the value or null if not found.
*/
public function get($key);
/**
* Set a cache key value.
*
* @param string $key Key to set
* @param mixed $value Value to set.
* @param int $ttl Number of seconds the item is allowed to live. Set
* to 0 to allow an unlimited lifetime.
*/
public function set($key, $value, $ttl = 0);
/**
* Remove a cache key.
*
* @param string $key Key to remove.
*/
public function remove($key);
}
class DoctrineCacheAdapter implements \Aws\CacheInterface, \Doctrine\Common\Cache\Cache
{
public function __construct(\Doctrine\Common\Cache\Cache $cache)
{
}
public function get($key)
{
}
public function fetch($key)
{
}
public function set($key, $value, $ttl = 0)
{
}
public function save($key, $value, $ttl = 0)
{
}
public function remove($key)
{
}
public function delete($key)
{
}
public function contains($key)
{
}
public function getStats()
{
}
}
}
namespace Aws\Emr {
/**
* This client is used to interact with the **Amazon Elastic MapReduce (Amazon EMR)** service.
*
* @method \Aws\Result addInstanceFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise addInstanceFleetAsync(array $args = [])
* @method \Aws\Result addInstanceGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise addInstanceGroupsAsync(array $args = [])
* @method \Aws\Result addJobFlowSteps(array $args = [])
* @method \GuzzleHttp\Promise\Promise addJobFlowStepsAsync(array $args = [])
* @method \Aws\Result addTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsAsync(array $args = [])
* @method \Aws\Result cancelSteps(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelStepsAsync(array $args = [])
* @method \Aws\Result createSecurityConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSecurityConfigurationAsync(array $args = [])
* @method \Aws\Result deleteSecurityConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSecurityConfigurationAsync(array $args = [])
* @method \Aws\Result describeCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterAsync(array $args = [])
* @method \Aws\Result describeJobFlows(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeJobFlowsAsync(array $args = [])
* @method \Aws\Result describeSecurityConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSecurityConfigurationAsync(array $args = [])
* @method \Aws\Result describeStep(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStepAsync(array $args = [])
* @method \Aws\Result listBootstrapActions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBootstrapActionsAsync(array $args = [])
* @method \Aws\Result listClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise listClustersAsync(array $args = [])
* @method \Aws\Result listInstanceFleets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInstanceFleetsAsync(array $args = [])
* @method \Aws\Result listInstanceGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInstanceGroupsAsync(array $args = [])
* @method \Aws\Result listInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInstancesAsync(array $args = [])
* @method \Aws\Result listSecurityConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSecurityConfigurationsAsync(array $args = [])
* @method \Aws\Result listSteps(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStepsAsync(array $args = [])
* @method \Aws\Result modifyInstanceFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyInstanceFleetAsync(array $args = [])
* @method \Aws\Result modifyInstanceGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyInstanceGroupsAsync(array $args = [])
* @method \Aws\Result putAutoScalingPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putAutoScalingPolicyAsync(array $args = [])
* @method \Aws\Result removeAutoScalingPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeAutoScalingPolicyAsync(array $args = [])
* @method \Aws\Result removeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsAsync(array $args = [])
* @method \Aws\Result runJobFlow(array $args = [])
* @method \GuzzleHttp\Promise\Promise runJobFlowAsync(array $args = [])
* @method \Aws\Result setTerminationProtection(array $args = [])
* @method \GuzzleHttp\Promise\Promise setTerminationProtectionAsync(array $args = [])
* @method \Aws\Result setVisibleToAllUsers(array $args = [])
* @method \GuzzleHttp\Promise\Promise setVisibleToAllUsersAsync(array $args = [])
* @method \Aws\Result terminateJobFlows(array $args = [])
* @method \GuzzleHttp\Promise\Promise terminateJobFlowsAsync(array $args = [])
*/
class EmrClient extends \Aws\AwsClient
{
}
}
namespace Aws\Emr\Exception {
/**
* Represents an error interacting with the Amazon Elastic MapReduce service.
*/
class EmrException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Route53 {
/**
* This client is used to interact with the **Amazon Route 53** service.
*
* @method \Aws\Result associateVPCWithHostedZone(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateVPCWithHostedZoneAsync(array $args = [])
* @method \Aws\Result changeResourceRecordSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise changeResourceRecordSetsAsync(array $args = [])
* @method \Aws\Result changeTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise changeTagsForResourceAsync(array $args = [])
* @method \Aws\Result createHealthCheck(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHealthCheckAsync(array $args = [])
* @method \Aws\Result createHostedZone(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHostedZoneAsync(array $args = [])
* @method \Aws\Result createQueryLoggingConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise createQueryLoggingConfigAsync(array $args = [])
* @method \Aws\Result createReusableDelegationSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createReusableDelegationSetAsync(array $args = [])
* @method \Aws\Result createTrafficPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTrafficPolicyAsync(array $args = [])
* @method \Aws\Result createTrafficPolicyInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTrafficPolicyInstanceAsync(array $args = [])
* @method \Aws\Result createTrafficPolicyVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTrafficPolicyVersionAsync(array $args = [])
* @method \Aws\Result createVPCAssociationAuthorization(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVPCAssociationAuthorizationAsync(array $args = [])
* @method \Aws\Result deleteHealthCheck(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteHealthCheckAsync(array $args = [])
* @method \Aws\Result deleteHostedZone(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteHostedZoneAsync(array $args = [])
* @method \Aws\Result deleteQueryLoggingConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteQueryLoggingConfigAsync(array $args = [])
* @method \Aws\Result deleteReusableDelegationSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReusableDelegationSetAsync(array $args = [])
* @method \Aws\Result deleteTrafficPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTrafficPolicyAsync(array $args = [])
* @method \Aws\Result deleteTrafficPolicyInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTrafficPolicyInstanceAsync(array $args = [])
* @method \Aws\Result deleteVPCAssociationAuthorization(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVPCAssociationAuthorizationAsync(array $args = [])
* @method \Aws\Result disassociateVPCFromHostedZone(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateVPCFromHostedZoneAsync(array $args = [])
* @method \Aws\Result getAccountLimit(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAccountLimitAsync(array $args = [])
* @method \Aws\Result getChange(array $args = [])
* @method \GuzzleHttp\Promise\Promise getChangeAsync(array $args = [])
* @method \Aws\Result getCheckerIpRanges(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCheckerIpRangesAsync(array $args = [])
* @method \Aws\Result getGeoLocation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGeoLocationAsync(array $args = [])
* @method \Aws\Result getHealthCheck(array $args = [])
* @method \GuzzleHttp\Promise\Promise getHealthCheckAsync(array $args = [])
* @method \Aws\Result getHealthCheckCount(array $args = [])
* @method \GuzzleHttp\Promise\Promise getHealthCheckCountAsync(array $args = [])
* @method \Aws\Result getHealthCheckLastFailureReason(array $args = [])
* @method \GuzzleHttp\Promise\Promise getHealthCheckLastFailureReasonAsync(array $args = [])
* @method \Aws\Result getHealthCheckStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getHealthCheckStatusAsync(array $args = [])
* @method \Aws\Result getHostedZone(array $args = [])
* @method \GuzzleHttp\Promise\Promise getHostedZoneAsync(array $args = [])
* @method \Aws\Result getHostedZoneCount(array $args = [])
* @method \GuzzleHttp\Promise\Promise getHostedZoneCountAsync(array $args = [])
* @method \Aws\Result getHostedZoneLimit(array $args = [])
* @method \GuzzleHttp\Promise\Promise getHostedZoneLimitAsync(array $args = [])
* @method \Aws\Result getQueryLoggingConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise getQueryLoggingConfigAsync(array $args = [])
* @method \Aws\Result getReusableDelegationSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getReusableDelegationSetAsync(array $args = [])
* @method \Aws\Result getReusableDelegationSetLimit(array $args = [])
* @method \GuzzleHttp\Promise\Promise getReusableDelegationSetLimitAsync(array $args = [])
* @method \Aws\Result getTrafficPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTrafficPolicyAsync(array $args = [])
* @method \Aws\Result getTrafficPolicyInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTrafficPolicyInstanceAsync(array $args = [])
* @method \Aws\Result getTrafficPolicyInstanceCount(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTrafficPolicyInstanceCountAsync(array $args = [])
* @method \Aws\Result listGeoLocations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGeoLocationsAsync(array $args = [])
* @method \Aws\Result listHealthChecks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listHealthChecksAsync(array $args = [])
* @method \Aws\Result listHostedZones(array $args = [])
* @method \GuzzleHttp\Promise\Promise listHostedZonesAsync(array $args = [])
* @method \Aws\Result listHostedZonesByName(array $args = [])
* @method \GuzzleHttp\Promise\Promise listHostedZonesByNameAsync(array $args = [])
* @method \Aws\Result listQueryLoggingConfigs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listQueryLoggingConfigsAsync(array $args = [])
* @method \Aws\Result listResourceRecordSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourceRecordSetsAsync(array $args = [])
* @method \Aws\Result listReusableDelegationSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listReusableDelegationSetsAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result listTagsForResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourcesAsync(array $args = [])
* @method \Aws\Result listTrafficPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTrafficPoliciesAsync(array $args = [])
* @method \Aws\Result listTrafficPolicyInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTrafficPolicyInstancesAsync(array $args = [])
* @method \Aws\Result listTrafficPolicyInstancesByHostedZone(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTrafficPolicyInstancesByHostedZoneAsync(array $args = [])
* @method \Aws\Result listTrafficPolicyInstancesByPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTrafficPolicyInstancesByPolicyAsync(array $args = [])
* @method \Aws\Result listTrafficPolicyVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTrafficPolicyVersionsAsync(array $args = [])
* @method \Aws\Result listVPCAssociationAuthorizations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listVPCAssociationAuthorizationsAsync(array $args = [])
* @method \Aws\Result testDNSAnswer(array $args = [])
* @method \GuzzleHttp\Promise\Promise testDNSAnswerAsync(array $args = [])
* @method \Aws\Result updateHealthCheck(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateHealthCheckAsync(array $args = [])
* @method \Aws\Result updateHostedZoneComment(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateHostedZoneCommentAsync(array $args = [])
* @method \Aws\Result updateTrafficPolicyComment(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTrafficPolicyCommentAsync(array $args = [])
* @method \Aws\Result updateTrafficPolicyInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTrafficPolicyInstanceAsync(array $args = [])
*/
class Route53Client extends \Aws\AwsClient
{
public function __construct(array $args)
{
}
}
}
namespace Aws\Route53\Exception {
/**
* Represents an error interacting with the Amazon Route 53 service.
*/
class Route53Exception extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Credentials {
/**
* Credential provider that provides credentials via assuming a role
* More Information, see: http://docs.aws.amazon.com/aws-sdk-php/v3/api/api-sts-2011-06-15.html#assumerole
*/
class AssumeRoleCredentialProvider
{
const ERROR_MSG = "Missing required 'AssumeRoleCredentialProvider' configuration option: ";
/**
* The constructor requires following configure parameters:
* - client: a StsClient
* - assume_role_params: Parameters used to make assumeRole call
*
* @param array $config Configuration options
* @throws \InvalidArgumentException
*/
public function __construct(array $config = [])
{
}
/**
* Loads assume role credentials.
*
* @return PromiseInterface
*/
public function __invoke()
{
}
}
/**
* Provides access to the AWS credentials used for accessing AWS services: AWS
* access key ID, secret access key, and security token. These credentials are
* used to securely sign requests to AWS services.
*/
interface CredentialsInterface
{
/**
* Returns the AWS access key ID for this credentials object.
*
* @return string
*/
public function getAccessKeyId();
/**
* Returns the AWS secret access key for this credentials object.
*
* @return string
*/
public function getSecretKey();
/**
* Get the associated security token if available
*
* @return string|null
*/
public function getSecurityToken();
/**
* Get the UNIX timestamp in which the credentials will expire
*
* @return int|null
*/
public function getExpiration();
/**
* Check if the credentials are expired
*
* @return bool
*/
public function isExpired();
/**
* Converts the credentials to an associative array.
*
* @return array
*/
public function toArray();
}
/**
* Basic implementation of the AWS Credentials interface that allows callers to
* pass in the AWS Access Key and AWS Secret Access Key in the constructor.
*/
class Credentials implements \Aws\Credentials\CredentialsInterface, \Serializable
{
/**
* Constructs a new BasicAWSCredentials object, with the specified AWS
* access key and AWS secret key
*
* @param string $key AWS access key ID
* @param string $secret AWS secret access key
* @param string $token Security token to use
* @param int $expires UNIX timestamp for when credentials expire
*/
public function __construct($key, $secret, $token = null, $expires = null)
{
}
public static function __set_state(array $state)
{
}
public function getAccessKeyId()
{
}
public function getSecretKey()
{
}
public function getSecurityToken()
{
}
public function getExpiration()
{
}
public function isExpired()
{
}
public function toArray()
{
}
public function serialize()
{
}
public function unserialize($serialized)
{
}
}
/**
* Credential provider that fetches credentials with GET request.
* ECS environment variable is used in constructing request URI.
*/
class EcsCredentialProvider
{
const SERVER_URI = 'http://169.254.170.2';
const ENV_URI = "AWS_CONTAINER_CREDENTIALS_RELATIVE_URI";
/**
* The constructor accepts following options:
* - timeout: (optional) Connection timeout, in seconds, default 1.0
* - client: An EcsClient to make request from
*
* @param array $config Configuration options
*/
public function __construct(array $config = [])
{
}
/**
* Load ECS credentials
*
* @return PromiseInterface
*/
public function __invoke()
{
}
}
/**
* Credential provider that provides credentials from the EC2 metadata server.
*/
class InstanceProfileProvider
{
const SERVER_URI = 'http://169.254.169.254/latest/';
const CRED_PATH = 'meta-data/iam/security-credentials/';
const ENV_DISABLE = 'AWS_EC2_METADATA_DISABLED';
/**
* The constructor accepts the following options:
*
* - timeout: Connection timeout, in seconds.
* - profile: Optional EC2 profile name, if known.
*
* @param array $config Configuration options.
*/
public function __construct(array $config = [])
{
}
/**
* Loads instance profile credentials.
*
* @return PromiseInterface
*/
public function __invoke()
{
}
}
/**
* Credential providers are functions that accept no arguments and return a
* promise that is fulfilled with an {@see \Aws\Credentials\CredentialsInterface}
* or rejected with an {@see \Aws\Exception\CredentialsException}.
*
* <code>
* use Aws\Credentials\CredentialProvider;
* $provider = CredentialProvider::defaultProvider();
* // Returns a CredentialsInterface or throws.
* $creds = $provider()->wait();
* </code>
*
* Credential providers can be composed to create credentials using conditional
* logic that can create different credentials in different environments. You
* can compose multiple providers into a single provider using
* {@see Aws\Credentials\CredentialProvider::chain}. This function accepts
* providers as variadic arguments and returns a new function that will invoke
* each provider until a successful set of credentials is returned.
*
* <code>
* // First try an INI file at this location.
* $a = CredentialProvider::ini(null, '/path/to/file.ini');
* // Then try an INI file at this location.
* $b = CredentialProvider::ini(null, '/path/to/other-file.ini');
* // Then try loading from environment variables.
* $c = CredentialProvider::env();
* // Combine the three providers together.
* $composed = CredentialProvider::chain($a, $b, $c);
* // Returns a promise that is fulfilled with credentials or throws.
* $promise = $composed();
* // Wait on the credentials to resolve.
* $creds = $promise->wait();
* </code>
*/
class CredentialProvider
{
const ENV_KEY = 'AWS_ACCESS_KEY_ID';
const ENV_SECRET = 'AWS_SECRET_ACCESS_KEY';
const ENV_SESSION = 'AWS_SESSION_TOKEN';
const ENV_PROFILE = 'AWS_PROFILE';
/**
* Create a default credential provider that first checks for environment
* variables, then checks for the "default" profile in ~/.aws/credentials,
* then checks for "profile default" profile in ~/.aws/config (which is
* the default profile of AWS CLI), then tries to make a GET Request to
* fetch credentials if Ecs environment variable is presented, and finally
* checks for EC2 instance profile credentials.
*
* This provider is automatically wrapped in a memoize function that caches
* previously provided credentials.
*
* @param array $config Optional array of ecs/instance profile credentials
* provider options.
*
* @return callable
*/
public static function defaultProvider(array $config = [])
{
}
/**
* Create a credential provider function from a set of static credentials.
*
* @param CredentialsInterface $creds
*
* @return callable
*/
public static function fromCredentials(\Aws\Credentials\CredentialsInterface $creds)
{
}
/**
* Creates an aggregate credentials provider that invokes the provided
* variadic providers one after the other until a provider returns
* credentials.
*
* @return callable
*/
public static function chain()
{
}
/**
* Wraps a credential provider and caches previously provided credentials.
*
* Ensures that cached credentials are refreshed when they expire.
*
* @param callable $provider Credentials provider function to wrap.
*
* @return callable
*/
public static function memoize(callable $provider)
{
}
/**
* Wraps a credential provider and saves provided credentials in an
* instance of Aws\CacheInterface. Forwards calls when no credentials found
* in cache and updates cache with the results.
*
* Defaults to using a simple file-based cache when none provided.
*
* @param callable $provider Credentials provider function to wrap
* @param CacheInterface $cache Cache to store credentials
* @param string|null $cacheKey (optional) Cache key to use
*
* @return callable
*/
public static function cache(callable $provider, \Aws\CacheInterface $cache, $cacheKey = null)
{
}
/**
* Provider that creates credentials from environment variables
* AWS_ACCESS_KEY_ID, AWS_SECRET_ACCESS_KEY, and AWS_SESSION_TOKEN.
*
* @return callable
*/
public static function env()
{
}
/**
* Credential provider that creates credentials using instance profile
* credentials.
*
* @param array $config Array of configuration data.
*
* @return InstanceProfileProvider
* @see Aws\Credentials\InstanceProfileProvider for $config details.
*/
public static function instanceProfile(array $config = [])
{
}
/**
* Credential provider that creates credentials using
* ecs credentials by a GET request, whose uri is specified
* by environment variable
*
* @param array $config Array of configuration data.
*
* @return EcsCredentialProvider
* @see Aws\Credentials\EcsCredentialProvider for $config details.
*/
public static function ecsCredentials(array $config = [])
{
}
/**
* Credential provider that creates credentials using assume role
*
* @param array $config Array of configuration data
* @return callable
* @see Aws\Credentials\AssumeRoleCredentialProvider for $config details.
*/
public static function assumeRole(array $config = [])
{
}
/**
* Credentials provider that creates credentials using an ini file stored
* in the current user's home directory.
*
* @param string|null $profile Profile to use. If not specified will use
* the "default" profile in "~/.aws/credentials".
* @param string|null $filename If provided, uses a custom filename rather
* than looking in the home directory.
*
* @return callable
*/
public static function ini($profile = null, $filename = null)
{
}
}
}
namespace Aws\Organizations {
/**
* This client is used to interact with the **AWS Organizations** service.
* @method \Aws\Result acceptHandshake(array $args = [])
* @method \GuzzleHttp\Promise\Promise acceptHandshakeAsync(array $args = [])
* @method \Aws\Result attachPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachPolicyAsync(array $args = [])
* @method \Aws\Result cancelHandshake(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelHandshakeAsync(array $args = [])
* @method \Aws\Result createAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAccountAsync(array $args = [])
* @method \Aws\Result createOrganization(array $args = [])
* @method \GuzzleHttp\Promise\Promise createOrganizationAsync(array $args = [])
* @method \Aws\Result createOrganizationalUnit(array $args = [])
* @method \GuzzleHttp\Promise\Promise createOrganizationalUnitAsync(array $args = [])
* @method \Aws\Result createPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPolicyAsync(array $args = [])
* @method \Aws\Result declineHandshake(array $args = [])
* @method \GuzzleHttp\Promise\Promise declineHandshakeAsync(array $args = [])
* @method \Aws\Result deleteOrganization(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteOrganizationAsync(array $args = [])
* @method \Aws\Result deleteOrganizationalUnit(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteOrganizationalUnitAsync(array $args = [])
* @method \Aws\Result deletePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePolicyAsync(array $args = [])
* @method \Aws\Result describeAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAccountAsync(array $args = [])
* @method \Aws\Result describeCreateAccountStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCreateAccountStatusAsync(array $args = [])
* @method \Aws\Result describeHandshake(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeHandshakeAsync(array $args = [])
* @method \Aws\Result describeOrganization(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOrganizationAsync(array $args = [])
* @method \Aws\Result describeOrganizationalUnit(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOrganizationalUnitAsync(array $args = [])
* @method \Aws\Result describePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePolicyAsync(array $args = [])
* @method \Aws\Result detachPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachPolicyAsync(array $args = [])
* @method \Aws\Result disableAWSServiceAccess(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableAWSServiceAccessAsync(array $args = [])
* @method \Aws\Result disablePolicyType(array $args = [])
* @method \GuzzleHttp\Promise\Promise disablePolicyTypeAsync(array $args = [])
* @method \Aws\Result enableAWSServiceAccess(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableAWSServiceAccessAsync(array $args = [])
* @method \Aws\Result enableAllFeatures(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableAllFeaturesAsync(array $args = [])
* @method \Aws\Result enablePolicyType(array $args = [])
* @method \GuzzleHttp\Promise\Promise enablePolicyTypeAsync(array $args = [])
* @method \Aws\Result inviteAccountToOrganization(array $args = [])
* @method \GuzzleHttp\Promise\Promise inviteAccountToOrganizationAsync(array $args = [])
* @method \Aws\Result leaveOrganization(array $args = [])
* @method \GuzzleHttp\Promise\Promise leaveOrganizationAsync(array $args = [])
* @method \Aws\Result listAWSServiceAccessForOrganization(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAWSServiceAccessForOrganizationAsync(array $args = [])
* @method \Aws\Result listAccounts(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAccountsAsync(array $args = [])
* @method \Aws\Result listAccountsForParent(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAccountsForParentAsync(array $args = [])
* @method \Aws\Result listChildren(array $args = [])
* @method \GuzzleHttp\Promise\Promise listChildrenAsync(array $args = [])
* @method \Aws\Result listCreateAccountStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCreateAccountStatusAsync(array $args = [])
* @method \Aws\Result listHandshakesForAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise listHandshakesForAccountAsync(array $args = [])
* @method \Aws\Result listHandshakesForOrganization(array $args = [])
* @method \GuzzleHttp\Promise\Promise listHandshakesForOrganizationAsync(array $args = [])
* @method \Aws\Result listOrganizationalUnitsForParent(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOrganizationalUnitsForParentAsync(array $args = [])
* @method \Aws\Result listParents(array $args = [])
* @method \GuzzleHttp\Promise\Promise listParentsAsync(array $args = [])
* @method \Aws\Result listPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPoliciesAsync(array $args = [])
* @method \Aws\Result listPoliciesForTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPoliciesForTargetAsync(array $args = [])
* @method \Aws\Result listRoots(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRootsAsync(array $args = [])
* @method \Aws\Result listTargetsForPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTargetsForPolicyAsync(array $args = [])
* @method \Aws\Result moveAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise moveAccountAsync(array $args = [])
* @method \Aws\Result removeAccountFromOrganization(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeAccountFromOrganizationAsync(array $args = [])
* @method \Aws\Result updateOrganizationalUnit(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateOrganizationalUnitAsync(array $args = [])
* @method \Aws\Result updatePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePolicyAsync(array $args = [])
*/
class OrganizationsClient extends \Aws\AwsClient
{
}
}
namespace Aws\Organizations\Exception {
/**
* Represents an error interacting with the **AWS Organizations** service.
*/
class OrganizationsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\TranscribeService {
/**
* This client is used to interact with the **Amazon Transcribe Service** service.
* @method \Aws\Result createVocabulary(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVocabularyAsync(array $args = [])
* @method \Aws\Result deleteVocabulary(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVocabularyAsync(array $args = [])
* @method \Aws\Result getTranscriptionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTranscriptionJobAsync(array $args = [])
* @method \Aws\Result getVocabulary(array $args = [])
* @method \GuzzleHttp\Promise\Promise getVocabularyAsync(array $args = [])
* @method \Aws\Result listTranscriptionJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTranscriptionJobsAsync(array $args = [])
* @method \Aws\Result listVocabularies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listVocabulariesAsync(array $args = [])
* @method \Aws\Result startTranscriptionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise startTranscriptionJobAsync(array $args = [])
* @method \Aws\Result updateVocabulary(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateVocabularyAsync(array $args = [])
*/
class TranscribeServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws\TranscribeService\Exception {
/**
* Represents an error interacting with the **Amazon Transcribe Service** service.
*/
class TranscribeServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Rekognition {
/**
* This client is used to interact with the **Amazon Rekognition** service.
* @method \Aws\Result compareFaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise compareFacesAsync(array $args = [])
* @method \Aws\Result createCollection(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCollectionAsync(array $args = [])
* @method \Aws\Result createStreamProcessor(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStreamProcessorAsync(array $args = [])
* @method \Aws\Result deleteCollection(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCollectionAsync(array $args = [])
* @method \Aws\Result deleteFaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFacesAsync(array $args = [])
* @method \Aws\Result deleteStreamProcessor(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStreamProcessorAsync(array $args = [])
* @method \Aws\Result describeCollection(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCollectionAsync(array $args = [])
* @method \Aws\Result describeStreamProcessor(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStreamProcessorAsync(array $args = [])
* @method \Aws\Result detectFaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise detectFacesAsync(array $args = [])
* @method \Aws\Result detectLabels(array $args = [])
* @method \GuzzleHttp\Promise\Promise detectLabelsAsync(array $args = [])
* @method \Aws\Result detectModerationLabels(array $args = [])
* @method \GuzzleHttp\Promise\Promise detectModerationLabelsAsync(array $args = [])
* @method \Aws\Result detectText(array $args = [])
* @method \GuzzleHttp\Promise\Promise detectTextAsync(array $args = [])
* @method \Aws\Result getCelebrityInfo(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCelebrityInfoAsync(array $args = [])
* @method \Aws\Result getCelebrityRecognition(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCelebrityRecognitionAsync(array $args = [])
* @method \Aws\Result getContentModeration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getContentModerationAsync(array $args = [])
* @method \Aws\Result getFaceDetection(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFaceDetectionAsync(array $args = [])
* @method \Aws\Result getFaceSearch(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFaceSearchAsync(array $args = [])
* @method \Aws\Result getLabelDetection(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLabelDetectionAsync(array $args = [])
* @method \Aws\Result getPersonTracking(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPersonTrackingAsync(array $args = [])
* @method \Aws\Result indexFaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise indexFacesAsync(array $args = [])
* @method \Aws\Result listCollections(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCollectionsAsync(array $args = [])
* @method \Aws\Result listFaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFacesAsync(array $args = [])
* @method \Aws\Result listStreamProcessors(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStreamProcessorsAsync(array $args = [])
* @method \Aws\Result recognizeCelebrities(array $args = [])
* @method \GuzzleHttp\Promise\Promise recognizeCelebritiesAsync(array $args = [])
* @method \Aws\Result searchFaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchFacesAsync(array $args = [])
* @method \Aws\Result searchFacesByImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchFacesByImageAsync(array $args = [])
* @method \Aws\Result startCelebrityRecognition(array $args = [])
* @method \GuzzleHttp\Promise\Promise startCelebrityRecognitionAsync(array $args = [])
* @method \Aws\Result startContentModeration(array $args = [])
* @method \GuzzleHttp\Promise\Promise startContentModerationAsync(array $args = [])
* @method \Aws\Result startFaceDetection(array $args = [])
* @method \GuzzleHttp\Promise\Promise startFaceDetectionAsync(array $args = [])
* @method \Aws\Result startFaceSearch(array $args = [])
* @method \GuzzleHttp\Promise\Promise startFaceSearchAsync(array $args = [])
* @method \Aws\Result startLabelDetection(array $args = [])
* @method \GuzzleHttp\Promise\Promise startLabelDetectionAsync(array $args = [])
* @method \Aws\Result startPersonTracking(array $args = [])
* @method \GuzzleHttp\Promise\Promise startPersonTrackingAsync(array $args = [])
* @method \Aws\Result startStreamProcessor(array $args = [])
* @method \GuzzleHttp\Promise\Promise startStreamProcessorAsync(array $args = [])
* @method \Aws\Result stopStreamProcessor(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopStreamProcessorAsync(array $args = [])
*/
class RekognitionClient extends \Aws\AwsClient
{
}
}
namespace Aws\Rekognition\Exception {
/**
* Represents an error interacting with the **Amazon Rekognition** service.
*/
class RekognitionException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\signer {
/**
* This client is used to interact with the **AWS Signer** service.
* @method \Aws\Result cancelSigningProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelSigningProfileAsync(array $args = [])
* @method \Aws\Result describeSigningJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSigningJobAsync(array $args = [])
* @method \Aws\Result getSigningPlatform(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSigningPlatformAsync(array $args = [])
* @method \Aws\Result getSigningProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSigningProfileAsync(array $args = [])
* @method \Aws\Result listSigningJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSigningJobsAsync(array $args = [])
* @method \Aws\Result listSigningPlatforms(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSigningPlatformsAsync(array $args = [])
* @method \Aws\Result listSigningProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSigningProfilesAsync(array $args = [])
* @method \Aws\Result putSigningProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise putSigningProfileAsync(array $args = [])
* @method \Aws\Result startSigningJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise startSigningJobAsync(array $args = [])
*/
class signerClient extends \Aws\AwsClient
{
}
}
namespace Aws\signer\Exception {
/**
* Represents an error interacting with the **AWS Signer** service.
*/
class signerException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Rds {
/**
* This client is used to interact with the **Amazon Relational Database Service (Amazon RDS)**.
*
* @method \Aws\Result addSourceIdentifierToSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise addSourceIdentifierToSubscriptionAsync(array $args = [])
* @method \Aws\Result addTagsToResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToResourceAsync(array $args = [])
* @method \Aws\Result authorizeDBSecurityGroupIngress(array $args = [])
* @method \GuzzleHttp\Promise\Promise authorizeDBSecurityGroupIngressAsync(array $args = [])
* @method \Aws\Result copyDBParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyDBParameterGroupAsync(array $args = [])
* @method \Aws\Result copyDBSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyDBSnapshotAsync(array $args = [])
* @method \Aws\Result copyOptionGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyOptionGroupAsync(array $args = [])
* @method \Aws\Result createDBInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBInstanceAsync(array $args = [])
* @method \Aws\Result createDBInstanceReadReplica(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBInstanceReadReplicaAsync(array $args = [])
* @method \Aws\Result createDBParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBParameterGroupAsync(array $args = [])
* @method \Aws\Result createDBSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBSecurityGroupAsync(array $args = [])
* @method \Aws\Result createDBSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBSnapshotAsync(array $args = [])
* @method \Aws\Result createDBSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBSubnetGroupAsync(array $args = [])
* @method \Aws\Result createEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEventSubscriptionAsync(array $args = [])
* @method \Aws\Result createOptionGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createOptionGroupAsync(array $args = [])
* @method \Aws\Result deleteDBInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBInstanceAsync(array $args = [])
* @method \Aws\Result deleteDBParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBParameterGroupAsync(array $args = [])
* @method \Aws\Result deleteDBSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBSecurityGroupAsync(array $args = [])
* @method \Aws\Result deleteDBSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBSnapshotAsync(array $args = [])
* @method \Aws\Result deleteDBSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBSubnetGroupAsync(array $args = [])
* @method \Aws\Result deleteEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEventSubscriptionAsync(array $args = [])
* @method \Aws\Result deleteOptionGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteOptionGroupAsync(array $args = [])
* @method \Aws\Result describeDBEngineVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBEngineVersionsAsync(array $args = [])
* @method \Aws\Result describeDBInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBInstancesAsync(array $args = [])
* @method \Aws\Result describeDBLogFiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBLogFilesAsync(array $args = [])
* @method \Aws\Result describeDBParameterGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBParameterGroupsAsync(array $args = [])
* @method \Aws\Result describeDBParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBParametersAsync(array $args = [])
* @method \Aws\Result describeDBSecurityGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBSecurityGroupsAsync(array $args = [])
* @method \Aws\Result describeDBSnapshots(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBSnapshotsAsync(array $args = [])
* @method \Aws\Result describeDBSubnetGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBSubnetGroupsAsync(array $args = [])
* @method \Aws\Result describeEngineDefaultParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEngineDefaultParametersAsync(array $args = [])
* @method \Aws\Result describeEventCategories(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventCategoriesAsync(array $args = [])
* @method \Aws\Result describeEventSubscriptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventSubscriptionsAsync(array $args = [])
* @method \Aws\Result describeEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventsAsync(array $args = [])
* @method \Aws\Result describeOptionGroupOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOptionGroupOptionsAsync(array $args = [])
* @method \Aws\Result describeOptionGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOptionGroupsAsync(array $args = [])
* @method \Aws\Result describeOrderableDBInstanceOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOrderableDBInstanceOptionsAsync(array $args = [])
* @method \Aws\Result describeReservedDBInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedDBInstancesAsync(array $args = [])
* @method \Aws\Result describeReservedDBInstancesOfferings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedDBInstancesOfferingsAsync(array $args = [])
* @method \Aws\Result downloadDBLogFilePortion(array $args = [])
* @method \GuzzleHttp\Promise\Promise downloadDBLogFilePortionAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result modifyDBInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyDBInstanceAsync(array $args = [])
* @method \Aws\Result modifyDBParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyDBParameterGroupAsync(array $args = [])
* @method \Aws\Result modifyDBSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyDBSubnetGroupAsync(array $args = [])
* @method \Aws\Result modifyEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyEventSubscriptionAsync(array $args = [])
* @method \Aws\Result modifyOptionGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyOptionGroupAsync(array $args = [])
* @method \Aws\Result promoteReadReplica(array $args = [])
* @method \GuzzleHttp\Promise\Promise promoteReadReplicaAsync(array $args = [])
* @method \Aws\Result purchaseReservedDBInstancesOffering(array $args = [])
* @method \GuzzleHttp\Promise\Promise purchaseReservedDBInstancesOfferingAsync(array $args = [])
* @method \Aws\Result rebootDBInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootDBInstanceAsync(array $args = [])
* @method \Aws\Result removeSourceIdentifierFromSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeSourceIdentifierFromSubscriptionAsync(array $args = [])
* @method \Aws\Result removeTagsFromResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromResourceAsync(array $args = [])
* @method \Aws\Result resetDBParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetDBParameterGroupAsync(array $args = [])
* @method \Aws\Result restoreDBInstanceFromDBSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreDBInstanceFromDBSnapshotAsync(array $args = [])
* @method \Aws\Result restoreDBInstanceToPointInTime(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreDBInstanceToPointInTimeAsync(array $args = [])
* @method \Aws\Result revokeDBSecurityGroupIngress(array $args = [])
* @method \GuzzleHttp\Promise\Promise revokeDBSecurityGroupIngressAsync(array $args = [])
* @method \Aws\Result addRoleToDBCluster(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise addRoleToDBClusterAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result applyPendingMaintenanceAction(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise applyPendingMaintenanceActionAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result backtrackDBCluster(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise backtrackDBClusterAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result copyDBClusterParameterGroup(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise copyDBClusterParameterGroupAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result copyDBClusterSnapshot(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise copyDBClusterSnapshotAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result createDBCluster(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise createDBClusterAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result createDBClusterParameterGroup(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise createDBClusterParameterGroupAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result createDBClusterSnapshot(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise createDBClusterSnapshotAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result deleteDBCluster(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise deleteDBClusterAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result deleteDBClusterParameterGroup(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise deleteDBClusterParameterGroupAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result deleteDBClusterSnapshot(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise deleteDBClusterSnapshotAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeAccountAttributes(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeAccountAttributesAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeCertificates(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeCertificatesAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeDBClusterBacktracks(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeDBClusterBacktracksAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeDBClusterParameterGroups(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeDBClusterParameterGroupsAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeDBClusterParameters(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeDBClusterParametersAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeDBClusterSnapshotAttributes(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeDBClusterSnapshotAttributesAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeDBClusterSnapshots(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeDBClusterSnapshotsAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeDBClusters(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeDBClustersAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeDBSnapshotAttributes(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeDBSnapshotAttributesAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeEngineDefaultClusterParameters(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeEngineDefaultClusterParametersAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describePendingMaintenanceActions(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describePendingMaintenanceActionsAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeSourceRegions(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeSourceRegionsAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result describeValidDBInstanceModifications(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise describeValidDBInstanceModificationsAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result failoverDBCluster(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise failoverDBClusterAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result modifyCurrentDBClusterCapacity(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise modifyCurrentDBClusterCapacityAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result modifyDBCluster(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise modifyDBClusterAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result modifyDBClusterParameterGroup(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise modifyDBClusterParameterGroupAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result modifyDBClusterSnapshotAttribute(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise modifyDBClusterSnapshotAttributeAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result modifyDBSnapshot(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise modifyDBSnapshotAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result modifyDBSnapshotAttribute(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise modifyDBSnapshotAttributeAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result promoteReadReplicaDBCluster(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise promoteReadReplicaDBClusterAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result removeRoleFromDBCluster(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise removeRoleFromDBClusterAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result resetDBClusterParameterGroup(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise resetDBClusterParameterGroupAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result restoreDBClusterFromS3(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise restoreDBClusterFromS3Async(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result restoreDBClusterFromSnapshot(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise restoreDBClusterFromSnapshotAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result restoreDBClusterToPointInTime(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise restoreDBClusterToPointInTimeAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result restoreDBInstanceFromS3(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise restoreDBInstanceFromS3Async(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result startDBCluster(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise startDBClusterAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result startDBInstance(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise startDBInstanceAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result stopDBCluster(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise stopDBClusterAsync(array $args = []) (supported in versions 2014-10-31)
* @method \Aws\Result stopDBInstance(array $args = []) (supported in versions 2014-10-31)
* @method \GuzzleHttp\Promise\Promise stopDBInstanceAsync(array $args = []) (supported in versions 2014-10-31)
*/
class RdsClient extends \Aws\AwsClient
{
public function __construct(array $args)
{
}
/**
* @internal
* @codeCoverageIgnore
*/
public static function applyDocFilters(array $api, array $docs)
{
}
}
/**
* Generates RDS auth tokens for use with IAM authentication.
*/
class AuthTokenGenerator
{
/**
* The constructor takes an instance of Credentials or a CredentialProvider
*
* @param callable|Credentials $creds
*/
public function __construct($creds)
{
}
/**
* Create the token for database login
*
* @param string $endpoint The database hostname with port number specified
* (e.g., host:port)
* @param string $region The region where the database is located
* @param string $username The username to login as
*
* @return string Token generated
*/
public function createToken($endpoint, $region, $username)
{
}
}
}
namespace Aws\Rds\Exception {
/**
* Represents an error interacting with the Amazon Relational Database Service.
*/
class RdsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CostandUsageReportService {
/**
* This client is used to interact with the **AWS Cost and Usage Report Service** service.
* @method \Aws\Result deleteReportDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReportDefinitionAsync(array $args = [])
* @method \Aws\Result describeReportDefinitions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReportDefinitionsAsync(array $args = [])
* @method \Aws\Result putReportDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise putReportDefinitionAsync(array $args = [])
*/
class CostandUsageReportServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws\CostandUsageReportService\Exception {
/**
* Represents an error interacting with the **AWS Cost and Usage Report Service** service.
*/
class CostandUsageReportServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Redshift\Exception {
/**
* Represents an error interacting with the Amazon Redshift service.
*/
class RedshiftException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Redshift {
/**
* This client is used to interact with the **Amazon Redshift** service.
*
* @method \Aws\Result acceptReservedNodeExchange(array $args = [])
* @method \GuzzleHttp\Promise\Promise acceptReservedNodeExchangeAsync(array $args = [])
* @method \Aws\Result authorizeClusterSecurityGroupIngress(array $args = [])
* @method \GuzzleHttp\Promise\Promise authorizeClusterSecurityGroupIngressAsync(array $args = [])
* @method \Aws\Result authorizeSnapshotAccess(array $args = [])
* @method \GuzzleHttp\Promise\Promise authorizeSnapshotAccessAsync(array $args = [])
* @method \Aws\Result copyClusterSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyClusterSnapshotAsync(array $args = [])
* @method \Aws\Result createCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClusterAsync(array $args = [])
* @method \Aws\Result createClusterParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClusterParameterGroupAsync(array $args = [])
* @method \Aws\Result createClusterSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClusterSecurityGroupAsync(array $args = [])
* @method \Aws\Result createClusterSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClusterSnapshotAsync(array $args = [])
* @method \Aws\Result createClusterSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClusterSubnetGroupAsync(array $args = [])
* @method \Aws\Result createEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEventSubscriptionAsync(array $args = [])
* @method \Aws\Result createHsmClientCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHsmClientCertificateAsync(array $args = [])
* @method \Aws\Result createHsmConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHsmConfigurationAsync(array $args = [])
* @method \Aws\Result createSnapshotCopyGrant(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSnapshotCopyGrantAsync(array $args = [])
* @method \Aws\Result createTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTagsAsync(array $args = [])
* @method \Aws\Result deleteCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClusterAsync(array $args = [])
* @method \Aws\Result deleteClusterParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClusterParameterGroupAsync(array $args = [])
* @method \Aws\Result deleteClusterSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClusterSecurityGroupAsync(array $args = [])
* @method \Aws\Result deleteClusterSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClusterSnapshotAsync(array $args = [])
* @method \Aws\Result deleteClusterSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClusterSubnetGroupAsync(array $args = [])
* @method \Aws\Result deleteEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEventSubscriptionAsync(array $args = [])
* @method \Aws\Result deleteHsmClientCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteHsmClientCertificateAsync(array $args = [])
* @method \Aws\Result deleteHsmConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteHsmConfigurationAsync(array $args = [])
* @method \Aws\Result deleteSnapshotCopyGrant(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSnapshotCopyGrantAsync(array $args = [])
* @method \Aws\Result deleteTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTagsAsync(array $args = [])
* @method \Aws\Result describeClusterDbRevisions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterDbRevisionsAsync(array $args = [])
* @method \Aws\Result describeClusterParameterGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterParameterGroupsAsync(array $args = [])
* @method \Aws\Result describeClusterParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterParametersAsync(array $args = [])
* @method \Aws\Result describeClusterSecurityGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterSecurityGroupsAsync(array $args = [])
* @method \Aws\Result describeClusterSnapshots(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterSnapshotsAsync(array $args = [])
* @method \Aws\Result describeClusterSubnetGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterSubnetGroupsAsync(array $args = [])
* @method \Aws\Result describeClusterTracks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterTracksAsync(array $args = [])
* @method \Aws\Result describeClusterVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterVersionsAsync(array $args = [])
* @method \Aws\Result describeClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClustersAsync(array $args = [])
* @method \Aws\Result describeDefaultClusterParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDefaultClusterParametersAsync(array $args = [])
* @method \Aws\Result describeEventCategories(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventCategoriesAsync(array $args = [])
* @method \Aws\Result describeEventSubscriptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventSubscriptionsAsync(array $args = [])
* @method \Aws\Result describeEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventsAsync(array $args = [])
* @method \Aws\Result describeHsmClientCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeHsmClientCertificatesAsync(array $args = [])
* @method \Aws\Result describeHsmConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeHsmConfigurationsAsync(array $args = [])
* @method \Aws\Result describeLoggingStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoggingStatusAsync(array $args = [])
* @method \Aws\Result describeOrderableClusterOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOrderableClusterOptionsAsync(array $args = [])
* @method \Aws\Result describeReservedNodeOfferings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedNodeOfferingsAsync(array $args = [])
* @method \Aws\Result describeReservedNodes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedNodesAsync(array $args = [])
* @method \Aws\Result describeResize(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeResizeAsync(array $args = [])
* @method \Aws\Result describeSnapshotCopyGrants(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSnapshotCopyGrantsAsync(array $args = [])
* @method \Aws\Result describeTableRestoreStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTableRestoreStatusAsync(array $args = [])
* @method \Aws\Result describeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagsAsync(array $args = [])
* @method \Aws\Result disableLogging(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableLoggingAsync(array $args = [])
* @method \Aws\Result disableSnapshotCopy(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableSnapshotCopyAsync(array $args = [])
* @method \Aws\Result enableLogging(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableLoggingAsync(array $args = [])
* @method \Aws\Result enableSnapshotCopy(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableSnapshotCopyAsync(array $args = [])
* @method \Aws\Result getClusterCredentials(array $args = [])
* @method \GuzzleHttp\Promise\Promise getClusterCredentialsAsync(array $args = [])
* @method \Aws\Result getReservedNodeExchangeOfferings(array $args = [])
* @method \GuzzleHttp\Promise\Promise getReservedNodeExchangeOfferingsAsync(array $args = [])
* @method \Aws\Result modifyCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyClusterAsync(array $args = [])
* @method \Aws\Result modifyClusterDbRevision(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyClusterDbRevisionAsync(array $args = [])
* @method \Aws\Result modifyClusterIamRoles(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyClusterIamRolesAsync(array $args = [])
* @method \Aws\Result modifyClusterParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyClusterParameterGroupAsync(array $args = [])
* @method \Aws\Result modifyClusterSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyClusterSubnetGroupAsync(array $args = [])
* @method \Aws\Result modifyEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyEventSubscriptionAsync(array $args = [])
* @method \Aws\Result modifySnapshotCopyRetentionPeriod(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifySnapshotCopyRetentionPeriodAsync(array $args = [])
* @method \Aws\Result purchaseReservedNodeOffering(array $args = [])
* @method \GuzzleHttp\Promise\Promise purchaseReservedNodeOfferingAsync(array $args = [])
* @method \Aws\Result rebootCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootClusterAsync(array $args = [])
* @method \Aws\Result resetClusterParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetClusterParameterGroupAsync(array $args = [])
* @method \Aws\Result resizeCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise resizeClusterAsync(array $args = [])
* @method \Aws\Result restoreFromClusterSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreFromClusterSnapshotAsync(array $args = [])
* @method \Aws\Result restoreTableFromClusterSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreTableFromClusterSnapshotAsync(array $args = [])
* @method \Aws\Result revokeClusterSecurityGroupIngress(array $args = [])
* @method \GuzzleHttp\Promise\Promise revokeClusterSecurityGroupIngressAsync(array $args = [])
* @method \Aws\Result revokeSnapshotAccess(array $args = [])
* @method \GuzzleHttp\Promise\Promise revokeSnapshotAccessAsync(array $args = [])
* @method \Aws\Result rotateEncryptionKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise rotateEncryptionKeyAsync(array $args = [])
*/
class RedshiftClient extends \Aws\AwsClient
{
}
}
namespace Aws\CloudFormation {
/**
* This client is used to interact with the **AWS CloudFormation** service.
*
* @method \Aws\Result cancelUpdateStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelUpdateStackAsync(array $args = [])
* @method \Aws\Result continueUpdateRollback(array $args = [])
* @method \GuzzleHttp\Promise\Promise continueUpdateRollbackAsync(array $args = [])
* @method \Aws\Result createChangeSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createChangeSetAsync(array $args = [])
* @method \Aws\Result createStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStackAsync(array $args = [])
* @method \Aws\Result createStackInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStackInstancesAsync(array $args = [])
* @method \Aws\Result createStackSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStackSetAsync(array $args = [])
* @method \Aws\Result deleteChangeSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteChangeSetAsync(array $args = [])
* @method \Aws\Result deleteStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStackAsync(array $args = [])
* @method \Aws\Result deleteStackInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStackInstancesAsync(array $args = [])
* @method \Aws\Result deleteStackSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStackSetAsync(array $args = [])
* @method \Aws\Result describeAccountLimits(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAccountLimitsAsync(array $args = [])
* @method \Aws\Result describeChangeSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeChangeSetAsync(array $args = [])
* @method \Aws\Result describeStackEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStackEventsAsync(array $args = [])
* @method \Aws\Result describeStackInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStackInstanceAsync(array $args = [])
* @method \Aws\Result describeStackResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStackResourceAsync(array $args = [])
* @method \Aws\Result describeStackResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStackResourcesAsync(array $args = [])
* @method \Aws\Result describeStackSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStackSetAsync(array $args = [])
* @method \Aws\Result describeStackSetOperation(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStackSetOperationAsync(array $args = [])
* @method \Aws\Result describeStacks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStacksAsync(array $args = [])
* @method \Aws\Result estimateTemplateCost(array $args = [])
* @method \GuzzleHttp\Promise\Promise estimateTemplateCostAsync(array $args = [])
* @method \Aws\Result executeChangeSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise executeChangeSetAsync(array $args = [])
* @method \Aws\Result getStackPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getStackPolicyAsync(array $args = [])
* @method \Aws\Result getTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTemplateAsync(array $args = [])
* @method \Aws\Result getTemplateSummary(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTemplateSummaryAsync(array $args = [])
* @method \Aws\Result listChangeSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listChangeSetsAsync(array $args = [])
* @method \Aws\Result listExports(array $args = [])
* @method \GuzzleHttp\Promise\Promise listExportsAsync(array $args = [])
* @method \Aws\Result listImports(array $args = [])
* @method \GuzzleHttp\Promise\Promise listImportsAsync(array $args = [])
* @method \Aws\Result listStackInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStackInstancesAsync(array $args = [])
* @method \Aws\Result listStackResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStackResourcesAsync(array $args = [])
* @method \Aws\Result listStackSetOperationResults(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStackSetOperationResultsAsync(array $args = [])
* @method \Aws\Result listStackSetOperations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStackSetOperationsAsync(array $args = [])
* @method \Aws\Result listStackSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStackSetsAsync(array $args = [])
* @method \Aws\Result listStacks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStacksAsync(array $args = [])
* @method \Aws\Result setStackPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise setStackPolicyAsync(array $args = [])
* @method \Aws\Result signalResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise signalResourceAsync(array $args = [])
* @method \Aws\Result stopStackSetOperation(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopStackSetOperationAsync(array $args = [])
* @method \Aws\Result updateStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateStackAsync(array $args = [])
* @method \Aws\Result updateStackInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateStackInstancesAsync(array $args = [])
* @method \Aws\Result updateStackSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateStackSetAsync(array $args = [])
* @method \Aws\Result updateTerminationProtection(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTerminationProtectionAsync(array $args = [])
* @method \Aws\Result validateTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise validateTemplateAsync(array $args = [])
*/
class CloudFormationClient extends \Aws\AwsClient
{
}
}
namespace Aws\CloudFormation\Exception {
/**
* Represents an error interacting with the AWS CloudFormation service.
*/
class CloudFormationException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudWatchLogs {
/**
* This client is used to interact with the **Amazon CloudWatch Logs** service.
*
* @method \Aws\Result associateKmsKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateKmsKeyAsync(array $args = [])
* @method \Aws\Result cancelExportTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelExportTaskAsync(array $args = [])
* @method \Aws\Result createExportTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise createExportTaskAsync(array $args = [])
* @method \Aws\Result createLogGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLogGroupAsync(array $args = [])
* @method \Aws\Result createLogStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLogStreamAsync(array $args = [])
* @method \Aws\Result deleteDestination(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDestinationAsync(array $args = [])
* @method \Aws\Result deleteLogGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLogGroupAsync(array $args = [])
* @method \Aws\Result deleteLogStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLogStreamAsync(array $args = [])
* @method \Aws\Result deleteMetricFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMetricFilterAsync(array $args = [])
* @method \Aws\Result deleteResourcePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteResourcePolicyAsync(array $args = [])
* @method \Aws\Result deleteRetentionPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRetentionPolicyAsync(array $args = [])
* @method \Aws\Result deleteSubscriptionFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSubscriptionFilterAsync(array $args = [])
* @method \Aws\Result describeDestinations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDestinationsAsync(array $args = [])
* @method \Aws\Result describeExportTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeExportTasksAsync(array $args = [])
* @method \Aws\Result describeLogGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLogGroupsAsync(array $args = [])
* @method \Aws\Result describeLogStreams(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLogStreamsAsync(array $args = [])
* @method \Aws\Result describeMetricFilters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMetricFiltersAsync(array $args = [])
* @method \Aws\Result describeResourcePolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeResourcePoliciesAsync(array $args = [])
* @method \Aws\Result describeSubscriptionFilters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSubscriptionFiltersAsync(array $args = [])
* @method \Aws\Result disassociateKmsKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateKmsKeyAsync(array $args = [])
* @method \Aws\Result filterLogEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise filterLogEventsAsync(array $args = [])
* @method \Aws\Result getLogEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLogEventsAsync(array $args = [])
* @method \Aws\Result listTagsLogGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsLogGroupAsync(array $args = [])
* @method \Aws\Result putDestination(array $args = [])
* @method \GuzzleHttp\Promise\Promise putDestinationAsync(array $args = [])
* @method \Aws\Result putDestinationPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putDestinationPolicyAsync(array $args = [])
* @method \Aws\Result putLogEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise putLogEventsAsync(array $args = [])
* @method \Aws\Result putMetricFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise putMetricFilterAsync(array $args = [])
* @method \Aws\Result putResourcePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putResourcePolicyAsync(array $args = [])
* @method \Aws\Result putRetentionPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRetentionPolicyAsync(array $args = [])
* @method \Aws\Result putSubscriptionFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise putSubscriptionFilterAsync(array $args = [])
* @method \Aws\Result tagLogGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagLogGroupAsync(array $args = [])
* @method \Aws\Result testMetricFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise testMetricFilterAsync(array $args = [])
* @method \Aws\Result untagLogGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagLogGroupAsync(array $args = [])
*/
class CloudWatchLogsClient extends \Aws\AwsClient
{
}
}
namespace Aws\CloudWatchLogs\Exception {
/**
* Represents an error interacting with the Amazon CloudWatch Logs service.
*/
class CloudWatchLogsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Polly {
/**
* This client is used to interact with the **Amazon Polly** service.
* @method \Aws\Result deleteLexicon(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLexiconAsync(array $args = [])
* @method \Aws\Result describeVoices(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVoicesAsync(array $args = [])
* @method \Aws\Result getLexicon(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLexiconAsync(array $args = [])
* @method \Aws\Result getSpeechSynthesisTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSpeechSynthesisTaskAsync(array $args = [])
* @method \Aws\Result listLexicons(array $args = [])
* @method \GuzzleHttp\Promise\Promise listLexiconsAsync(array $args = [])
* @method \Aws\Result listSpeechSynthesisTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSpeechSynthesisTasksAsync(array $args = [])
* @method \Aws\Result putLexicon(array $args = [])
* @method \GuzzleHttp\Promise\Promise putLexiconAsync(array $args = [])
* @method \Aws\Result startSpeechSynthesisTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise startSpeechSynthesisTaskAsync(array $args = [])
* @method \Aws\Result synthesizeSpeech(array $args = [])
* @method \GuzzleHttp\Promise\Promise synthesizeSpeechAsync(array $args = [])
*/
class PollyClient extends \Aws\AwsClient
{
/**
* Create a pre-signed URL for Polly operation `SynthesizeSpeech`
*
* @param array $args parameters array for `SynthesizeSpeech`
* More information @see Aws\Polly\PollyClient::SynthesizeSpeech
*
* @return string
*/
public function createSynthesizeSpeechPreSignedUrl(array $args)
{
}
}
}
namespace Aws\Polly\Exception {
/**
* Represents an error interacting with the **Amazon Polly** service.
*/
class PollyException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudHsm {
/**
* This client is used to interact with **AWS CloudHSM**.
*
* @method \Aws\Result addTagsToResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToResourceAsync(array $args = [])
* @method \Aws\Result createHapg(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHapgAsync(array $args = [])
* @method \Aws\Result createHsm(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHsmAsync(array $args = [])
* @method \Aws\Result createLunaClient(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLunaClientAsync(array $args = [])
* @method \Aws\Result deleteHapg(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteHapgAsync(array $args = [])
* @method \Aws\Result deleteHsm(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteHsmAsync(array $args = [])
* @method \Aws\Result deleteLunaClient(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLunaClientAsync(array $args = [])
* @method \Aws\Result describeHapg(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeHapgAsync(array $args = [])
* @method \Aws\Result describeHsm(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeHsmAsync(array $args = [])
* @method \Aws\Result describeLunaClient(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLunaClientAsync(array $args = [])
* @method \Aws\Result getConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise getConfigAsync(array $args = [])
* @method \Aws\Result listAvailableZones(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAvailableZonesAsync(array $args = [])
* @method \Aws\Result listHapgs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listHapgsAsync(array $args = [])
* @method \Aws\Result listHsms(array $args = [])
* @method \GuzzleHttp\Promise\Promise listHsmsAsync(array $args = [])
* @method \Aws\Result listLunaClients(array $args = [])
* @method \GuzzleHttp\Promise\Promise listLunaClientsAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result modifyHapg(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyHapgAsync(array $args = [])
* @method \Aws\Result modifyHsm(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyHsmAsync(array $args = [])
* @method \Aws\Result modifyLunaClient(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyLunaClientAsync(array $args = [])
* @method \Aws\Result removeTagsFromResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromResourceAsync(array $args = [])
*/
class CloudHsmClient extends \Aws\AwsClient
{
public function __call($name, array $args)
{
}
/**
* @internal
* @codeCoverageIgnore
*/
public static function applyDocFilters(array $api, array $docs)
{
}
}
}
namespace Aws\CloudHsm\Exception {
/**
* AWS CloudHSM exception.
*/
class CloudHsmException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\DynamoDbStreams {
/**
* This client is used to interact with the **Amazon DynamoDb Streams** service.
*
* @method \Aws\Result describeStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStreamAsync(array $args = [])
* @method \Aws\Result getRecords(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRecordsAsync(array $args = [])
* @method \Aws\Result getShardIterator(array $args = [])
* @method \GuzzleHttp\Promise\Promise getShardIteratorAsync(array $args = [])
* @method \Aws\Result listStreams(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStreamsAsync(array $args = [])
*/
class DynamoDbStreamsClient extends \Aws\AwsClient
{
public static function getArguments()
{
}
}
}
namespace Aws\DynamoDbStreams\Exception {
/**
* Represents an error interacting with the Amazon DynamoDB Streams service.
*/
class DynamoDbStreamsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* @internal Resolves a hash of client arguments to construct a client.
*/
class ClientResolver
{
/**
* Gets an array of default client arguments, each argument containing a
* hash of the following:
*
* - type: (string, required) option type described as follows:
* - value: The default option type.
* - config: The provided value is made available in the client's
* getConfig() method.
* - valid: (array, required) Valid PHP types or class names. Note: null
* is not an allowed type.
* - required: (bool, callable) Whether or not the argument is required.
* Provide a function that accepts an array of arguments and returns a
* string to provide a custom error message.
* - default: (mixed) The default value of the argument if not provided. If
* a function is provided, then it will be invoked to provide a default
* value. The function is provided the array of options and is expected
* to return the default value of the option. The default value can be a
* closure and can not be a callable string that is not part of the
* defaultArgs array.
* - doc: (string) The argument documentation string.
* - fn: (callable) Function used to apply the argument. The function
* accepts the provided value, array of arguments by reference, and an
* event emitter.
*
* Note: Order is honored and important when applying arguments.
*
* @return array
*/
public static function getDefaultArguments()
{
}
/**
* @param array $argDefinitions Client arguments.
*/
public function __construct(array $argDefinitions)
{
}
/**
* Resolves client configuration options and attached event listeners.
* Check for missing keys in passed arguments
*
* @param array $args Provided constructor arguments.
* @param HandlerList $list Handler list to augment.
*
* @return array Returns the array of provided options.
* @throws \InvalidArgumentException
* @see Aws\AwsClient::__construct for a list of available options.
*/
public function resolve(array $args, \Aws\HandlerList $list)
{
}
public static function _apply_retries($value, array &$args, \Aws\HandlerList $list)
{
}
public static function _apply_credentials($value, array &$args)
{
}
public static function _apply_api_provider(callable $value, array &$args)
{
}
public static function _apply_endpoint_provider(callable $value, array &$args)
{
}
public static function _apply_serializer($value, array &$args, \Aws\HandlerList $list)
{
}
public static function _apply_debug($value, array &$args, \Aws\HandlerList $list)
{
}
public static function _apply_stats($value, array &$args, \Aws\HandlerList $list)
{
}
public static function _apply_profile($_, array &$args)
{
}
public static function _apply_validate($value, array &$args, \Aws\HandlerList $list)
{
}
public static function _apply_handler($value, array &$args, \Aws\HandlerList $list)
{
}
public static function _default_handler(array &$args)
{
}
public static function _apply_http_handler($value, array &$args, \Aws\HandlerList $list)
{
}
public static function _apply_user_agent($value, array &$args, \Aws\HandlerList $list)
{
}
public static function _apply_endpoint($value, array &$args, \Aws\HandlerList $list)
{
}
public static function _apply_idempotency_auto_fill($value, array &$args, \Aws\HandlerList $list)
{
}
public static function _default_endpoint_provider(array $args)
{
}
public static function _default_serializer(array $args)
{
}
public static function _default_signature_provider()
{
}
public static function _default_signature_version(array &$args)
{
}
public static function _default_signing_name(array &$args)
{
}
public static function _default_signing_region(array &$args)
{
}
public static function _missing_version(array $args)
{
}
public static function _missing_region(array $args)
{
}
}
}
namespace Aws\MQ {
/**
* This client is used to interact with the **AmazonMQ** service.
* @method \Aws\Result createBroker(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBrokerAsync(array $args = [])
* @method \Aws\Result createConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise createConfigurationAsync(array $args = [])
* @method \Aws\Result createUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserAsync(array $args = [])
* @method \Aws\Result deleteBroker(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBrokerAsync(array $args = [])
* @method \Aws\Result deleteUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserAsync(array $args = [])
* @method \Aws\Result describeBroker(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeBrokerAsync(array $args = [])
* @method \Aws\Result describeConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigurationAsync(array $args = [])
* @method \Aws\Result describeConfigurationRevision(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigurationRevisionAsync(array $args = [])
* @method \Aws\Result describeUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserAsync(array $args = [])
* @method \Aws\Result listBrokers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBrokersAsync(array $args = [])
* @method \Aws\Result listConfigurationRevisions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listConfigurationRevisionsAsync(array $args = [])
* @method \Aws\Result listConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listConfigurationsAsync(array $args = [])
* @method \Aws\Result listUsers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUsersAsync(array $args = [])
* @method \Aws\Result rebootBroker(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootBrokerAsync(array $args = [])
* @method \Aws\Result updateBroker(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateBrokerAsync(array $args = [])
* @method \Aws\Result updateConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateConfigurationAsync(array $args = [])
* @method \Aws\Result updateUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserAsync(array $args = [])
*/
class MQClient extends \Aws\AwsClient
{
}
}
namespace Aws\MQ\Exception {
/**
* Represents an error interacting with the **AmazonMQ** service.
*/
class MQException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Sms {
/**
* This client is used to interact with the **AWS Server Migration Service** service.
* @method \Aws\Result createReplicationJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createReplicationJobAsync(array $args = [])
* @method \Aws\Result deleteReplicationJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReplicationJobAsync(array $args = [])
* @method \Aws\Result deleteServerCatalog(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteServerCatalogAsync(array $args = [])
* @method \Aws\Result disassociateConnector(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateConnectorAsync(array $args = [])
* @method \Aws\Result getConnectors(array $args = [])
* @method \GuzzleHttp\Promise\Promise getConnectorsAsync(array $args = [])
* @method \Aws\Result getReplicationJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise getReplicationJobsAsync(array $args = [])
* @method \Aws\Result getReplicationRuns(array $args = [])
* @method \GuzzleHttp\Promise\Promise getReplicationRunsAsync(array $args = [])
* @method \Aws\Result getServers(array $args = [])
* @method \GuzzleHttp\Promise\Promise getServersAsync(array $args = [])
* @method \Aws\Result importServerCatalog(array $args = [])
* @method \GuzzleHttp\Promise\Promise importServerCatalogAsync(array $args = [])
* @method \Aws\Result startOnDemandReplicationRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise startOnDemandReplicationRunAsync(array $args = [])
* @method \Aws\Result updateReplicationJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateReplicationJobAsync(array $args = [])
*/
class SmsClient extends \Aws\AwsClient
{
}
}
namespace Aws\Sms\Exception {
/**
* Represents an error interacting with the **AWS Server Migration Service** service.
*/
class SmsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ACMPCA {
/**
* This client is used to interact with the **AWS Certificate Manager Private Certificate Authority** service.
* @method \Aws\Result createCertificateAuthority(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCertificateAuthorityAsync(array $args = [])
* @method \Aws\Result createCertificateAuthorityAuditReport(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCertificateAuthorityAuditReportAsync(array $args = [])
* @method \Aws\Result deleteCertificateAuthority(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCertificateAuthorityAsync(array $args = [])
* @method \Aws\Result describeCertificateAuthority(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCertificateAuthorityAsync(array $args = [])
* @method \Aws\Result describeCertificateAuthorityAuditReport(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCertificateAuthorityAuditReportAsync(array $args = [])
* @method \Aws\Result getCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCertificateAsync(array $args = [])
* @method \Aws\Result getCertificateAuthorityCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCertificateAuthorityCertificateAsync(array $args = [])
* @method \Aws\Result getCertificateAuthorityCsr(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCertificateAuthorityCsrAsync(array $args = [])
* @method \Aws\Result importCertificateAuthorityCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise importCertificateAuthorityCertificateAsync(array $args = [])
* @method \Aws\Result issueCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise issueCertificateAsync(array $args = [])
* @method \Aws\Result listCertificateAuthorities(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCertificateAuthoritiesAsync(array $args = [])
* @method \Aws\Result listTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsAsync(array $args = [])
* @method \Aws\Result restoreCertificateAuthority(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreCertificateAuthorityAsync(array $args = [])
* @method \Aws\Result revokeCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise revokeCertificateAsync(array $args = [])
* @method \Aws\Result tagCertificateAuthority(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagCertificateAuthorityAsync(array $args = [])
* @method \Aws\Result untagCertificateAuthority(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagCertificateAuthorityAsync(array $args = [])
* @method \Aws\Result updateCertificateAuthority(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCertificateAuthorityAsync(array $args = [])
*/
class ACMPCAClient extends \Aws\AwsClient
{
}
}
namespace Aws\ACMPCA\Exception {
/**
* Represents an error interacting with the **AWS Certificate Manager Private Certificate Authority** service.
*/
class ACMPCAException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Ec2 {
/**
* Client used to interact with Amazon EC2.
*
* @method \Aws\Result acceptVpcPeeringConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise acceptVpcPeeringConnectionAsync(array $args = [])
* @method \Aws\Result allocateAddress(array $args = [])
* @method \GuzzleHttp\Promise\Promise allocateAddressAsync(array $args = [])
* @method \Aws\Result allocateHosts(array $args = [])
* @method \GuzzleHttp\Promise\Promise allocateHostsAsync(array $args = [])
* @method \Aws\Result assignPrivateIpAddresses(array $args = [])
* @method \GuzzleHttp\Promise\Promise assignPrivateIpAddressesAsync(array $args = [])
* @method \Aws\Result associateAddress(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateAddressAsync(array $args = [])
* @method \Aws\Result associateDhcpOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateDhcpOptionsAsync(array $args = [])
* @method \Aws\Result associateRouteTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateRouteTableAsync(array $args = [])
* @method \Aws\Result attachClassicLinkVpc(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachClassicLinkVpcAsync(array $args = [])
* @method \Aws\Result attachInternetGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachInternetGatewayAsync(array $args = [])
* @method \Aws\Result attachNetworkInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachNetworkInterfaceAsync(array $args = [])
* @method \Aws\Result attachVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachVolumeAsync(array $args = [])
* @method \Aws\Result attachVpnGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachVpnGatewayAsync(array $args = [])
* @method \Aws\Result authorizeSecurityGroupEgress(array $args = [])
* @method \GuzzleHttp\Promise\Promise authorizeSecurityGroupEgressAsync(array $args = [])
* @method \Aws\Result authorizeSecurityGroupIngress(array $args = [])
* @method \GuzzleHttp\Promise\Promise authorizeSecurityGroupIngressAsync(array $args = [])
* @method \Aws\Result bundleInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise bundleInstanceAsync(array $args = [])
* @method \Aws\Result cancelBundleTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelBundleTaskAsync(array $args = [])
* @method \Aws\Result cancelConversionTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelConversionTaskAsync(array $args = [])
* @method \Aws\Result cancelExportTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelExportTaskAsync(array $args = [])
* @method \Aws\Result cancelImportTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelImportTaskAsync(array $args = [])
* @method \Aws\Result cancelReservedInstancesListing(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelReservedInstancesListingAsync(array $args = [])
* @method \Aws\Result cancelSpotFleetRequests(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelSpotFleetRequestsAsync(array $args = [])
* @method \Aws\Result cancelSpotInstanceRequests(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelSpotInstanceRequestsAsync(array $args = [])
* @method \Aws\Result confirmProductInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise confirmProductInstanceAsync(array $args = [])
* @method \Aws\Result copyImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyImageAsync(array $args = [])
* @method \Aws\Result copySnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise copySnapshotAsync(array $args = [])
* @method \Aws\Result createCustomerGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCustomerGatewayAsync(array $args = [])
* @method \Aws\Result createDhcpOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDhcpOptionsAsync(array $args = [])
* @method \Aws\Result createFlowLogs(array $args = [])
* @method \GuzzleHttp\Promise\Promise createFlowLogsAsync(array $args = [])
* @method \Aws\Result createImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise createImageAsync(array $args = [])
* @method \Aws\Result createInstanceExportTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInstanceExportTaskAsync(array $args = [])
* @method \Aws\Result createInternetGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInternetGatewayAsync(array $args = [])
* @method \Aws\Result createKeyPair(array $args = [])
* @method \GuzzleHttp\Promise\Promise createKeyPairAsync(array $args = [])
* @method \Aws\Result createNatGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNatGatewayAsync(array $args = [])
* @method \Aws\Result createNetworkAcl(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNetworkAclAsync(array $args = [])
* @method \Aws\Result createNetworkAclEntry(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNetworkAclEntryAsync(array $args = [])
* @method \Aws\Result createNetworkInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNetworkInterfaceAsync(array $args = [])
* @method \Aws\Result createPlacementGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPlacementGroupAsync(array $args = [])
* @method \Aws\Result createReservedInstancesListing(array $args = [])
* @method \GuzzleHttp\Promise\Promise createReservedInstancesListingAsync(array $args = [])
* @method \Aws\Result createRoute(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRouteAsync(array $args = [])
* @method \Aws\Result createRouteTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRouteTableAsync(array $args = [])
* @method \Aws\Result createSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSecurityGroupAsync(array $args = [])
* @method \Aws\Result createSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSnapshotAsync(array $args = [])
* @method \Aws\Result createSpotDatafeedSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSpotDatafeedSubscriptionAsync(array $args = [])
* @method \Aws\Result createSubnet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSubnetAsync(array $args = [])
* @method \Aws\Result createTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTagsAsync(array $args = [])
* @method \Aws\Result createVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVolumeAsync(array $args = [])
* @method \Aws\Result createVpc(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVpcAsync(array $args = [])
* @method \Aws\Result createVpcEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVpcEndpointAsync(array $args = [])
* @method \Aws\Result createVpcPeeringConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVpcPeeringConnectionAsync(array $args = [])
* @method \Aws\Result createVpnConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVpnConnectionAsync(array $args = [])
* @method \Aws\Result createVpnConnectionRoute(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVpnConnectionRouteAsync(array $args = [])
* @method \Aws\Result createVpnGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVpnGatewayAsync(array $args = [])
* @method \Aws\Result deleteCustomerGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCustomerGatewayAsync(array $args = [])
* @method \Aws\Result deleteDhcpOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDhcpOptionsAsync(array $args = [])
* @method \Aws\Result deleteFlowLogs(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFlowLogsAsync(array $args = [])
* @method \Aws\Result deleteInternetGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInternetGatewayAsync(array $args = [])
* @method \Aws\Result deleteKeyPair(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteKeyPairAsync(array $args = [])
* @method \Aws\Result deleteNatGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNatGatewayAsync(array $args = [])
* @method \Aws\Result deleteNetworkAcl(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNetworkAclAsync(array $args = [])
* @method \Aws\Result deleteNetworkAclEntry(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNetworkAclEntryAsync(array $args = [])
* @method \Aws\Result deleteNetworkInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNetworkInterfaceAsync(array $args = [])
* @method \Aws\Result deletePlacementGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePlacementGroupAsync(array $args = [])
* @method \Aws\Result deleteRoute(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRouteAsync(array $args = [])
* @method \Aws\Result deleteRouteTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRouteTableAsync(array $args = [])
* @method \Aws\Result deleteSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSecurityGroupAsync(array $args = [])
* @method \Aws\Result deleteSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSnapshotAsync(array $args = [])
* @method \Aws\Result deleteSpotDatafeedSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSpotDatafeedSubscriptionAsync(array $args = [])
* @method \Aws\Result deleteSubnet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSubnetAsync(array $args = [])
* @method \Aws\Result deleteTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTagsAsync(array $args = [])
* @method \Aws\Result deleteVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVolumeAsync(array $args = [])
* @method \Aws\Result deleteVpc(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVpcAsync(array $args = [])
* @method \Aws\Result deleteVpcEndpoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVpcEndpointsAsync(array $args = [])
* @method \Aws\Result deleteVpcPeeringConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVpcPeeringConnectionAsync(array $args = [])
* @method \Aws\Result deleteVpnConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVpnConnectionAsync(array $args = [])
* @method \Aws\Result deleteVpnConnectionRoute(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVpnConnectionRouteAsync(array $args = [])
* @method \Aws\Result deleteVpnGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVpnGatewayAsync(array $args = [])
* @method \Aws\Result deregisterImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterImageAsync(array $args = [])
* @method \Aws\Result describeAccountAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAccountAttributesAsync(array $args = [])
* @method \Aws\Result describeAddresses(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAddressesAsync(array $args = [])
* @method \Aws\Result describeAvailabilityZones(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAvailabilityZonesAsync(array $args = [])
* @method \Aws\Result describeBundleTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeBundleTasksAsync(array $args = [])
* @method \Aws\Result describeClassicLinkInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClassicLinkInstancesAsync(array $args = [])
* @method \Aws\Result describeConversionTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConversionTasksAsync(array $args = [])
* @method \Aws\Result describeCustomerGateways(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCustomerGatewaysAsync(array $args = [])
* @method \Aws\Result describeDhcpOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDhcpOptionsAsync(array $args = [])
* @method \Aws\Result describeExportTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeExportTasksAsync(array $args = [])
* @method \Aws\Result describeFlowLogs(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeFlowLogsAsync(array $args = [])
* @method \Aws\Result describeHosts(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeHostsAsync(array $args = [])
* @method \Aws\Result describeIdFormat(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeIdFormatAsync(array $args = [])
* @method \Aws\Result describeImageAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeImageAttributeAsync(array $args = [])
* @method \Aws\Result describeImages(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeImagesAsync(array $args = [])
* @method \Aws\Result describeImportImageTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeImportImageTasksAsync(array $args = [])
* @method \Aws\Result describeImportSnapshotTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeImportSnapshotTasksAsync(array $args = [])
* @method \Aws\Result describeInstanceAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstanceAttributeAsync(array $args = [])
* @method \Aws\Result describeInstanceStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstanceStatusAsync(array $args = [])
* @method \Aws\Result describeInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstancesAsync(array $args = [])
* @method \Aws\Result describeInternetGateways(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInternetGatewaysAsync(array $args = [])
* @method \Aws\Result describeKeyPairs(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeKeyPairsAsync(array $args = [])
* @method \Aws\Result describeMovingAddresses(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMovingAddressesAsync(array $args = [])
* @method \Aws\Result describeNatGateways(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNatGatewaysAsync(array $args = [])
* @method \Aws\Result describeNetworkAcls(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNetworkAclsAsync(array $args = [])
* @method \Aws\Result describeNetworkInterfaceAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNetworkInterfaceAttributeAsync(array $args = [])
* @method \Aws\Result describeNetworkInterfaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNetworkInterfacesAsync(array $args = [])
* @method \Aws\Result describePlacementGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePlacementGroupsAsync(array $args = [])
* @method \Aws\Result describePrefixLists(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePrefixListsAsync(array $args = [])
* @method \Aws\Result describeRegions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRegionsAsync(array $args = [])
* @method \Aws\Result describeReservedInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedInstancesAsync(array $args = [])
* @method \Aws\Result describeReservedInstancesListings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedInstancesListingsAsync(array $args = [])
* @method \Aws\Result describeReservedInstancesModifications(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedInstancesModificationsAsync(array $args = [])
* @method \Aws\Result describeReservedInstancesOfferings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedInstancesOfferingsAsync(array $args = [])
* @method \Aws\Result describeRouteTables(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRouteTablesAsync(array $args = [])
* @method \Aws\Result describeScheduledInstanceAvailability(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScheduledInstanceAvailabilityAsync(array $args = [])
* @method \Aws\Result describeScheduledInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScheduledInstancesAsync(array $args = [])
* @method \Aws\Result describeSecurityGroupReferences(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSecurityGroupReferencesAsync(array $args = [])
* @method \Aws\Result describeSecurityGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSecurityGroupsAsync(array $args = [])
* @method \Aws\Result describeSnapshotAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSnapshotAttributeAsync(array $args = [])
* @method \Aws\Result describeSnapshots(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSnapshotsAsync(array $args = [])
* @method \Aws\Result describeSpotDatafeedSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSpotDatafeedSubscriptionAsync(array $args = [])
* @method \Aws\Result describeSpotFleetInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSpotFleetInstancesAsync(array $args = [])
* @method \Aws\Result describeSpotFleetRequestHistory(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSpotFleetRequestHistoryAsync(array $args = [])
* @method \Aws\Result describeSpotFleetRequests(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSpotFleetRequestsAsync(array $args = [])
* @method \Aws\Result describeSpotInstanceRequests(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSpotInstanceRequestsAsync(array $args = [])
* @method \Aws\Result describeSpotPriceHistory(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSpotPriceHistoryAsync(array $args = [])
* @method \Aws\Result describeStaleSecurityGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStaleSecurityGroupsAsync(array $args = [])
* @method \Aws\Result describeSubnets(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSubnetsAsync(array $args = [])
* @method \Aws\Result describeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagsAsync(array $args = [])
* @method \Aws\Result describeVolumeAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVolumeAttributeAsync(array $args = [])
* @method \Aws\Result describeVolumeStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVolumeStatusAsync(array $args = [])
* @method \Aws\Result describeVolumes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVolumesAsync(array $args = [])
* @method \Aws\Result describeVpcAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpcAttributeAsync(array $args = [])
* @method \Aws\Result describeVpcClassicLink(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpcClassicLinkAsync(array $args = [])
* @method \Aws\Result describeVpcClassicLinkDnsSupport(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpcClassicLinkDnsSupportAsync(array $args = [])
* @method \Aws\Result describeVpcEndpointServices(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpcEndpointServicesAsync(array $args = [])
* @method \Aws\Result describeVpcEndpoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpcEndpointsAsync(array $args = [])
* @method \Aws\Result describeVpcPeeringConnections(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpcPeeringConnectionsAsync(array $args = [])
* @method \Aws\Result describeVpcs(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpcsAsync(array $args = [])
* @method \Aws\Result describeVpnConnections(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpnConnectionsAsync(array $args = [])
* @method \Aws\Result describeVpnGateways(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpnGatewaysAsync(array $args = [])
* @method \Aws\Result detachClassicLinkVpc(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachClassicLinkVpcAsync(array $args = [])
* @method \Aws\Result detachInternetGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachInternetGatewayAsync(array $args = [])
* @method \Aws\Result detachNetworkInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachNetworkInterfaceAsync(array $args = [])
* @method \Aws\Result detachVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachVolumeAsync(array $args = [])
* @method \Aws\Result detachVpnGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachVpnGatewayAsync(array $args = [])
* @method \Aws\Result disableVgwRoutePropagation(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableVgwRoutePropagationAsync(array $args = [])
* @method \Aws\Result disableVpcClassicLink(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableVpcClassicLinkAsync(array $args = [])
* @method \Aws\Result disableVpcClassicLinkDnsSupport(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableVpcClassicLinkDnsSupportAsync(array $args = [])
* @method \Aws\Result disassociateAddress(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateAddressAsync(array $args = [])
* @method \Aws\Result disassociateRouteTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateRouteTableAsync(array $args = [])
* @method \Aws\Result enableVgwRoutePropagation(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableVgwRoutePropagationAsync(array $args = [])
* @method \Aws\Result enableVolumeIO(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableVolumeIOAsync(array $args = [])
* @method \Aws\Result enableVpcClassicLink(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableVpcClassicLinkAsync(array $args = [])
* @method \Aws\Result enableVpcClassicLinkDnsSupport(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableVpcClassicLinkDnsSupportAsync(array $args = [])
* @method \Aws\Result getConsoleOutput(array $args = [])
* @method \GuzzleHttp\Promise\Promise getConsoleOutputAsync(array $args = [])
* @method \Aws\Result getConsoleScreenshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise getConsoleScreenshotAsync(array $args = [])
* @method \Aws\Result getPasswordData(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPasswordDataAsync(array $args = [])
* @method \Aws\Result importImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise importImageAsync(array $args = [])
* @method \Aws\Result importInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise importInstanceAsync(array $args = [])
* @method \Aws\Result importKeyPair(array $args = [])
* @method \GuzzleHttp\Promise\Promise importKeyPairAsync(array $args = [])
* @method \Aws\Result importSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise importSnapshotAsync(array $args = [])
* @method \Aws\Result importVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise importVolumeAsync(array $args = [])
* @method \Aws\Result modifyHosts(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyHostsAsync(array $args = [])
* @method \Aws\Result modifyIdFormat(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyIdFormatAsync(array $args = [])
* @method \Aws\Result modifyImageAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyImageAttributeAsync(array $args = [])
* @method \Aws\Result modifyInstanceAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyInstanceAttributeAsync(array $args = [])
* @method \Aws\Result modifyInstancePlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyInstancePlacementAsync(array $args = [])
* @method \Aws\Result modifyNetworkInterfaceAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyNetworkInterfaceAttributeAsync(array $args = [])
* @method \Aws\Result modifyReservedInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyReservedInstancesAsync(array $args = [])
* @method \Aws\Result modifySnapshotAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifySnapshotAttributeAsync(array $args = [])
* @method \Aws\Result modifySpotFleetRequest(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifySpotFleetRequestAsync(array $args = [])
* @method \Aws\Result modifySubnetAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifySubnetAttributeAsync(array $args = [])
* @method \Aws\Result modifyVolumeAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyVolumeAttributeAsync(array $args = [])
* @method \Aws\Result modifyVpcAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyVpcAttributeAsync(array $args = [])
* @method \Aws\Result modifyVpcEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyVpcEndpointAsync(array $args = [])
* @method \Aws\Result modifyVpcPeeringConnectionOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyVpcPeeringConnectionOptionsAsync(array $args = [])
* @method \Aws\Result monitorInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise monitorInstancesAsync(array $args = [])
* @method \Aws\Result moveAddressToVpc(array $args = [])
* @method \GuzzleHttp\Promise\Promise moveAddressToVpcAsync(array $args = [])
* @method \Aws\Result purchaseReservedInstancesOffering(array $args = [])
* @method \GuzzleHttp\Promise\Promise purchaseReservedInstancesOfferingAsync(array $args = [])
* @method \Aws\Result purchaseScheduledInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise purchaseScheduledInstancesAsync(array $args = [])
* @method \Aws\Result rebootInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootInstancesAsync(array $args = [])
* @method \Aws\Result registerImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerImageAsync(array $args = [])
* @method \Aws\Result rejectVpcPeeringConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise rejectVpcPeeringConnectionAsync(array $args = [])
* @method \Aws\Result releaseAddress(array $args = [])
* @method \GuzzleHttp\Promise\Promise releaseAddressAsync(array $args = [])
* @method \Aws\Result releaseHosts(array $args = [])
* @method \GuzzleHttp\Promise\Promise releaseHostsAsync(array $args = [])
* @method \Aws\Result replaceNetworkAclAssociation(array $args = [])
* @method \GuzzleHttp\Promise\Promise replaceNetworkAclAssociationAsync(array $args = [])
* @method \Aws\Result replaceNetworkAclEntry(array $args = [])
* @method \GuzzleHttp\Promise\Promise replaceNetworkAclEntryAsync(array $args = [])
* @method \Aws\Result replaceRoute(array $args = [])
* @method \GuzzleHttp\Promise\Promise replaceRouteAsync(array $args = [])
* @method \Aws\Result replaceRouteTableAssociation(array $args = [])
* @method \GuzzleHttp\Promise\Promise replaceRouteTableAssociationAsync(array $args = [])
* @method \Aws\Result reportInstanceStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise reportInstanceStatusAsync(array $args = [])
* @method \Aws\Result requestSpotFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise requestSpotFleetAsync(array $args = [])
* @method \Aws\Result requestSpotInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise requestSpotInstancesAsync(array $args = [])
* @method \Aws\Result resetImageAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetImageAttributeAsync(array $args = [])
* @method \Aws\Result resetInstanceAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetInstanceAttributeAsync(array $args = [])
* @method \Aws\Result resetNetworkInterfaceAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetNetworkInterfaceAttributeAsync(array $args = [])
* @method \Aws\Result resetSnapshotAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetSnapshotAttributeAsync(array $args = [])
* @method \Aws\Result restoreAddressToClassic(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreAddressToClassicAsync(array $args = [])
* @method \Aws\Result revokeSecurityGroupEgress(array $args = [])
* @method \GuzzleHttp\Promise\Promise revokeSecurityGroupEgressAsync(array $args = [])
* @method \Aws\Result revokeSecurityGroupIngress(array $args = [])
* @method \GuzzleHttp\Promise\Promise revokeSecurityGroupIngressAsync(array $args = [])
* @method \Aws\Result runInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise runInstancesAsync(array $args = [])
* @method \Aws\Result runScheduledInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise runScheduledInstancesAsync(array $args = [])
* @method \Aws\Result startInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise startInstancesAsync(array $args = [])
* @method \Aws\Result stopInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopInstancesAsync(array $args = [])
* @method \Aws\Result terminateInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise terminateInstancesAsync(array $args = [])
* @method \Aws\Result unassignPrivateIpAddresses(array $args = [])
* @method \GuzzleHttp\Promise\Promise unassignPrivateIpAddressesAsync(array $args = [])
* @method \Aws\Result unmonitorInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise unmonitorInstancesAsync(array $args = [])
* @method \Aws\Result describeHostReservationOfferings(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeHostReservationOfferingsAsync(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \Aws\Result describeHostReservations(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeHostReservationsAsync(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \Aws\Result describeIdentityIdFormat(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeIdentityIdFormatAsync(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \Aws\Result getHostReservationPurchasePreview(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \GuzzleHttp\Promise\Promise getHostReservationPurchasePreviewAsync(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \Aws\Result modifyIdentityIdFormat(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \GuzzleHttp\Promise\Promise modifyIdentityIdFormatAsync(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \Aws\Result purchaseHostReservation(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \GuzzleHttp\Promise\Promise purchaseHostReservationAsync(array $args = []) (supported in versions 2016-04-01, 2016-09-15, 2016-11-15)
* @method \Aws\Result acceptReservedInstancesExchangeQuote(array $args = []) (supported in versions 2016-09-15, 2016-11-15)
* @method \GuzzleHttp\Promise\Promise acceptReservedInstancesExchangeQuoteAsync(array $args = []) (supported in versions 2016-09-15, 2016-11-15)
* @method \Aws\Result getReservedInstancesExchangeQuote(array $args = []) (supported in versions 2016-09-15, 2016-11-15)
* @method \GuzzleHttp\Promise\Promise getReservedInstancesExchangeQuoteAsync(array $args = []) (supported in versions 2016-09-15, 2016-11-15)
* @method \Aws\Result acceptVpcEndpointConnections(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise acceptVpcEndpointConnectionsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result assignIpv6Addresses(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise assignIpv6AddressesAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result associateIamInstanceProfile(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise associateIamInstanceProfileAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result associateSubnetCidrBlock(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise associateSubnetCidrBlockAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result associateVpcCidrBlock(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise associateVpcCidrBlockAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result copyFpgaImage(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise copyFpgaImageAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result createDefaultSubnet(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise createDefaultSubnetAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result createDefaultVpc(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise createDefaultVpcAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result createEgressOnlyInternetGateway(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise createEgressOnlyInternetGatewayAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result createFleet(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise createFleetAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result createFpgaImage(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise createFpgaImageAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result createLaunchTemplate(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise createLaunchTemplateAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result createLaunchTemplateVersion(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise createLaunchTemplateVersionAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result createNetworkInterfacePermission(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise createNetworkInterfacePermissionAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result createVpcEndpointConnectionNotification(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise createVpcEndpointConnectionNotificationAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result createVpcEndpointServiceConfiguration(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise createVpcEndpointServiceConfigurationAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result deleteEgressOnlyInternetGateway(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise deleteEgressOnlyInternetGatewayAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result deleteFleets(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise deleteFleetsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result deleteFpgaImage(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise deleteFpgaImageAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result deleteLaunchTemplate(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise deleteLaunchTemplateAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result deleteLaunchTemplateVersions(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise deleteLaunchTemplateVersionsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result deleteNetworkInterfacePermission(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise deleteNetworkInterfacePermissionAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result deleteVpcEndpointConnectionNotifications(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise deleteVpcEndpointConnectionNotificationsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result deleteVpcEndpointServiceConfigurations(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise deleteVpcEndpointServiceConfigurationsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeAggregateIdFormat(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeAggregateIdFormatAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeEgressOnlyInternetGateways(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeEgressOnlyInternetGatewaysAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeElasticGpus(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeElasticGpusAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeFleetHistory(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeFleetHistoryAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeFleetInstances(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeFleetInstancesAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeFleets(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeFleetsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeFpgaImageAttribute(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeFpgaImageAttributeAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeFpgaImages(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeFpgaImagesAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeIamInstanceProfileAssociations(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeIamInstanceProfileAssociationsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeInstanceCreditSpecifications(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeInstanceCreditSpecificationsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeLaunchTemplateVersions(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeLaunchTemplateVersionsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeLaunchTemplates(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeLaunchTemplatesAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeNetworkInterfacePermissions(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeNetworkInterfacePermissionsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describePrincipalIdFormat(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describePrincipalIdFormatAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeVolumesModifications(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeVolumesModificationsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeVpcEndpointConnectionNotifications(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeVpcEndpointConnectionNotificationsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeVpcEndpointConnections(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeVpcEndpointConnectionsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeVpcEndpointServiceConfigurations(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeVpcEndpointServiceConfigurationsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result describeVpcEndpointServicePermissions(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise describeVpcEndpointServicePermissionsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result disassociateIamInstanceProfile(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise disassociateIamInstanceProfileAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result disassociateSubnetCidrBlock(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise disassociateSubnetCidrBlockAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result disassociateVpcCidrBlock(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise disassociateVpcCidrBlockAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result getLaunchTemplateData(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise getLaunchTemplateDataAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result modifyFleet(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise modifyFleetAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result modifyFpgaImageAttribute(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise modifyFpgaImageAttributeAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result modifyInstanceCreditSpecification(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise modifyInstanceCreditSpecificationAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result modifyLaunchTemplate(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise modifyLaunchTemplateAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result modifyVolume(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise modifyVolumeAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result modifyVpcEndpointConnectionNotification(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise modifyVpcEndpointConnectionNotificationAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result modifyVpcEndpointServiceConfiguration(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise modifyVpcEndpointServiceConfigurationAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result modifyVpcEndpointServicePermissions(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise modifyVpcEndpointServicePermissionsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result modifyVpcTenancy(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise modifyVpcTenancyAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result rejectVpcEndpointConnections(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise rejectVpcEndpointConnectionsAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result replaceIamInstanceProfileAssociation(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise replaceIamInstanceProfileAssociationAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result resetFpgaImageAttribute(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise resetFpgaImageAttributeAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result unassignIpv6Addresses(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise unassignIpv6AddressesAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result updateSecurityGroupRuleDescriptionsEgress(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise updateSecurityGroupRuleDescriptionsEgressAsync(array $args = []) (supported in versions 2016-11-15)
* @method \Aws\Result updateSecurityGroupRuleDescriptionsIngress(array $args = []) (supported in versions 2016-11-15)
* @method \GuzzleHttp\Promise\Promise updateSecurityGroupRuleDescriptionsIngressAsync(array $args = []) (supported in versions 2016-11-15)
*/
class Ec2Client extends \Aws\AwsClient
{
public function __construct(array $args)
{
}
/**
* @internal
* @codeCoverageIgnore
*/
public static function applyDocFilters(array $api, array $docs)
{
}
}
}
namespace Aws\Ec2\Exception {
/**
* Represents an error interacting with the Amazon Elastic Compute Cloud service.
*/
class Ec2Exception extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ElastiCache {
/**
* This client is used to interact with the **Amazon ElastiCache** service.
*
* @method \Aws\Result addTagsToResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToResourceAsync(array $args = [])
* @method \Aws\Result authorizeCacheSecurityGroupIngress(array $args = [])
* @method \GuzzleHttp\Promise\Promise authorizeCacheSecurityGroupIngressAsync(array $args = [])
* @method \Aws\Result copySnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise copySnapshotAsync(array $args = [])
* @method \Aws\Result createCacheCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCacheClusterAsync(array $args = [])
* @method \Aws\Result createCacheParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCacheParameterGroupAsync(array $args = [])
* @method \Aws\Result createCacheSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCacheSecurityGroupAsync(array $args = [])
* @method \Aws\Result createCacheSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCacheSubnetGroupAsync(array $args = [])
* @method \Aws\Result createReplicationGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createReplicationGroupAsync(array $args = [])
* @method \Aws\Result createSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSnapshotAsync(array $args = [])
* @method \Aws\Result decreaseReplicaCount(array $args = [])
* @method \GuzzleHttp\Promise\Promise decreaseReplicaCountAsync(array $args = [])
* @method \Aws\Result deleteCacheCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCacheClusterAsync(array $args = [])
* @method \Aws\Result deleteCacheParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCacheParameterGroupAsync(array $args = [])
* @method \Aws\Result deleteCacheSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCacheSecurityGroupAsync(array $args = [])
* @method \Aws\Result deleteCacheSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCacheSubnetGroupAsync(array $args = [])
* @method \Aws\Result deleteReplicationGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReplicationGroupAsync(array $args = [])
* @method \Aws\Result deleteSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSnapshotAsync(array $args = [])
* @method \Aws\Result describeCacheClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCacheClustersAsync(array $args = [])
* @method \Aws\Result describeCacheEngineVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCacheEngineVersionsAsync(array $args = [])
* @method \Aws\Result describeCacheParameterGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCacheParameterGroupsAsync(array $args = [])
* @method \Aws\Result describeCacheParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCacheParametersAsync(array $args = [])
* @method \Aws\Result describeCacheSecurityGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCacheSecurityGroupsAsync(array $args = [])
* @method \Aws\Result describeCacheSubnetGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCacheSubnetGroupsAsync(array $args = [])
* @method \Aws\Result describeEngineDefaultParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEngineDefaultParametersAsync(array $args = [])
* @method \Aws\Result describeEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventsAsync(array $args = [])
* @method \Aws\Result describeReplicationGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReplicationGroupsAsync(array $args = [])
* @method \Aws\Result describeReservedCacheNodes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedCacheNodesAsync(array $args = [])
* @method \Aws\Result describeReservedCacheNodesOfferings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedCacheNodesOfferingsAsync(array $args = [])
* @method \Aws\Result describeSnapshots(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSnapshotsAsync(array $args = [])
* @method \Aws\Result increaseReplicaCount(array $args = [])
* @method \GuzzleHttp\Promise\Promise increaseReplicaCountAsync(array $args = [])
* @method \Aws\Result listAllowedNodeTypeModifications(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAllowedNodeTypeModificationsAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result modifyCacheCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyCacheClusterAsync(array $args = [])
* @method \Aws\Result modifyCacheParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyCacheParameterGroupAsync(array $args = [])
* @method \Aws\Result modifyCacheSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyCacheSubnetGroupAsync(array $args = [])
* @method \Aws\Result modifyReplicationGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyReplicationGroupAsync(array $args = [])
* @method \Aws\Result modifyReplicationGroupShardConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyReplicationGroupShardConfigurationAsync(array $args = [])
* @method \Aws\Result purchaseReservedCacheNodesOffering(array $args = [])
* @method \GuzzleHttp\Promise\Promise purchaseReservedCacheNodesOfferingAsync(array $args = [])
* @method \Aws\Result rebootCacheCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootCacheClusterAsync(array $args = [])
* @method \Aws\Result removeTagsFromResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromResourceAsync(array $args = [])
* @method \Aws\Result resetCacheParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetCacheParameterGroupAsync(array $args = [])
* @method \Aws\Result revokeCacheSecurityGroupIngress(array $args = [])
* @method \GuzzleHttp\Promise\Promise revokeCacheSecurityGroupIngressAsync(array $args = [])
* @method \Aws\Result testFailover(array $args = [])
* @method \GuzzleHttp\Promise\Promise testFailoverAsync(array $args = [])
*/
class ElastiCacheClient extends \Aws\AwsClient
{
}
}
namespace Aws\ElastiCache\Exception {
/**
* Represents an error interacting with the Amazon ElastiCache service.
*/
class ElastiCacheException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudHSMV2 {
/**
* This client is used to interact with the **AWS CloudHSM V2** service.
* @method \Aws\Result copyBackupToRegion(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyBackupToRegionAsync(array $args = [])
* @method \Aws\Result createCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClusterAsync(array $args = [])
* @method \Aws\Result createHsm(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHsmAsync(array $args = [])
* @method \Aws\Result deleteBackup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBackupAsync(array $args = [])
* @method \Aws\Result deleteCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClusterAsync(array $args = [])
* @method \Aws\Result deleteHsm(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteHsmAsync(array $args = [])
* @method \Aws\Result describeBackups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeBackupsAsync(array $args = [])
* @method \Aws\Result describeClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClustersAsync(array $args = [])
* @method \Aws\Result initializeCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise initializeClusterAsync(array $args = [])
* @method \Aws\Result listTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsAsync(array $args = [])
* @method \Aws\Result restoreBackup(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreBackupAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
*/
class CloudHSMV2Client extends \Aws\AwsClient
{
}
}
namespace Aws\CloudHSMV2\Exception {
/**
* Represents an error interacting with the **AWS CloudHSM V2** service.
*/
class CloudHSMV2Exception extends \Aws\Exception\AwsException
{
}
}
namespace Aws\MediaLive\Exception {
/**
* Represents an error interacting with the **AWS Elemental MediaLive** service.
*/
class MediaLiveException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\MediaLive {
/**
* This client is used to interact with the **AWS Elemental MediaLive** service.
* @method \Aws\Result batchUpdateSchedule(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchUpdateScheduleAsync(array $args = [])
* @method \Aws\Result createChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise createChannelAsync(array $args = [])
* @method \Aws\Result createInput(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInputAsync(array $args = [])
* @method \Aws\Result createInputSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInputSecurityGroupAsync(array $args = [])
* @method \Aws\Result deleteChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteChannelAsync(array $args = [])
* @method \Aws\Result deleteInput(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInputAsync(array $args = [])
* @method \Aws\Result deleteInputSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInputSecurityGroupAsync(array $args = [])
* @method \Aws\Result deleteReservation(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReservationAsync(array $args = [])
* @method \Aws\Result describeChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeChannelAsync(array $args = [])
* @method \Aws\Result describeInput(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInputAsync(array $args = [])
* @method \Aws\Result describeInputSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInputSecurityGroupAsync(array $args = [])
* @method \Aws\Result describeOffering(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOfferingAsync(array $args = [])
* @method \Aws\Result describeReservation(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservationAsync(array $args = [])
* @method \Aws\Result describeSchedule(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScheduleAsync(array $args = [])
* @method \Aws\Result listChannels(array $args = [])
* @method \GuzzleHttp\Promise\Promise listChannelsAsync(array $args = [])
* @method \Aws\Result listInputSecurityGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInputSecurityGroupsAsync(array $args = [])
* @method \Aws\Result listInputs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInputsAsync(array $args = [])
* @method \Aws\Result listOfferings(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOfferingsAsync(array $args = [])
* @method \Aws\Result listReservations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listReservationsAsync(array $args = [])
* @method \Aws\Result purchaseOffering(array $args = [])
* @method \GuzzleHttp\Promise\Promise purchaseOfferingAsync(array $args = [])
* @method \Aws\Result startChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise startChannelAsync(array $args = [])
* @method \Aws\Result stopChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopChannelAsync(array $args = [])
* @method \Aws\Result updateChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateChannelAsync(array $args = [])
* @method \Aws\Result updateInput(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateInputAsync(array $args = [])
* @method \Aws\Result updateInputSecurityGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateInputSecurityGroupAsync(array $args = [])
*/
class MediaLiveClient extends \Aws\AwsClient
{
}
}
namespace Aws\FMS {
/**
* This client is used to interact with the **Firewall Management Service** service.
* @method \Aws\Result associateAdminAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateAdminAccountAsync(array $args = [])
* @method \Aws\Result deleteNotificationChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNotificationChannelAsync(array $args = [])
* @method \Aws\Result deletePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePolicyAsync(array $args = [])
* @method \Aws\Result disassociateAdminAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateAdminAccountAsync(array $args = [])
* @method \Aws\Result getAdminAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAdminAccountAsync(array $args = [])
* @method \Aws\Result getComplianceDetail(array $args = [])
* @method \GuzzleHttp\Promise\Promise getComplianceDetailAsync(array $args = [])
* @method \Aws\Result getNotificationChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getNotificationChannelAsync(array $args = [])
* @method \Aws\Result getPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPolicyAsync(array $args = [])
* @method \Aws\Result listComplianceStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise listComplianceStatusAsync(array $args = [])
* @method \Aws\Result listMemberAccounts(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMemberAccountsAsync(array $args = [])
* @method \Aws\Result listPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPoliciesAsync(array $args = [])
* @method \Aws\Result putNotificationChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise putNotificationChannelAsync(array $args = [])
* @method \Aws\Result putPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putPolicyAsync(array $args = [])
*/
class FMSClient extends \Aws\AwsClient
{
}
}
namespace Aws\FMS\Exception {
/**
* Represents an error interacting with the **Firewall Management Service** service.
*/
class FMSException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Ecs {
/**
* This client is used to interact with **Amazon ECS**.
*
* @method \Aws\Result createCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClusterAsync(array $args = [])
* @method \Aws\Result createService(array $args = [])
* @method \GuzzleHttp\Promise\Promise createServiceAsync(array $args = [])
* @method \Aws\Result deleteAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAttributesAsync(array $args = [])
* @method \Aws\Result deleteCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClusterAsync(array $args = [])
* @method \Aws\Result deleteService(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteServiceAsync(array $args = [])
* @method \Aws\Result deregisterContainerInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterContainerInstanceAsync(array $args = [])
* @method \Aws\Result deregisterTaskDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterTaskDefinitionAsync(array $args = [])
* @method \Aws\Result describeClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClustersAsync(array $args = [])
* @method \Aws\Result describeContainerInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeContainerInstancesAsync(array $args = [])
* @method \Aws\Result describeServices(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeServicesAsync(array $args = [])
* @method \Aws\Result describeTaskDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTaskDefinitionAsync(array $args = [])
* @method \Aws\Result describeTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTasksAsync(array $args = [])
* @method \Aws\Result discoverPollEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise discoverPollEndpointAsync(array $args = [])
* @method \Aws\Result listAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAttributesAsync(array $args = [])
* @method \Aws\Result listClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise listClustersAsync(array $args = [])
* @method \Aws\Result listContainerInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise listContainerInstancesAsync(array $args = [])
* @method \Aws\Result listServices(array $args = [])
* @method \GuzzleHttp\Promise\Promise listServicesAsync(array $args = [])
* @method \Aws\Result listTaskDefinitionFamilies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTaskDefinitionFamiliesAsync(array $args = [])
* @method \Aws\Result listTaskDefinitions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTaskDefinitionsAsync(array $args = [])
* @method \Aws\Result listTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTasksAsync(array $args = [])
* @method \Aws\Result putAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise putAttributesAsync(array $args = [])
* @method \Aws\Result registerContainerInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerContainerInstanceAsync(array $args = [])
* @method \Aws\Result registerTaskDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerTaskDefinitionAsync(array $args = [])
* @method \Aws\Result runTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise runTaskAsync(array $args = [])
* @method \Aws\Result startTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise startTaskAsync(array $args = [])
* @method \Aws\Result stopTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopTaskAsync(array $args = [])
* @method \Aws\Result submitContainerStateChange(array $args = [])
* @method \GuzzleHttp\Promise\Promise submitContainerStateChangeAsync(array $args = [])
* @method \Aws\Result submitTaskStateChange(array $args = [])
* @method \GuzzleHttp\Promise\Promise submitTaskStateChangeAsync(array $args = [])
* @method \Aws\Result updateContainerAgent(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateContainerAgentAsync(array $args = [])
* @method \Aws\Result updateContainerInstancesState(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateContainerInstancesStateAsync(array $args = [])
* @method \Aws\Result updateService(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateServiceAsync(array $args = [])
*/
class EcsClient extends \Aws\AwsClient
{
}
}
namespace Aws\Ecs\Exception {
/**
* Amazon ECS exception.
*/
class EcsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudWatch {
/**
* This client is used to interact with the **Amazon CloudWatch** service.
*
* @method \Aws\Result deleteAlarms(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAlarmsAsync(array $args = [])
* @method \Aws\Result deleteDashboards(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDashboardsAsync(array $args = [])
* @method \Aws\Result describeAlarmHistory(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAlarmHistoryAsync(array $args = [])
* @method \Aws\Result describeAlarms(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAlarmsAsync(array $args = [])
* @method \Aws\Result describeAlarmsForMetric(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAlarmsForMetricAsync(array $args = [])
* @method \Aws\Result disableAlarmActions(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableAlarmActionsAsync(array $args = [])
* @method \Aws\Result enableAlarmActions(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableAlarmActionsAsync(array $args = [])
* @method \Aws\Result getDashboard(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDashboardAsync(array $args = [])
* @method \Aws\Result getMetricData(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMetricDataAsync(array $args = [])
* @method \Aws\Result getMetricStatistics(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMetricStatisticsAsync(array $args = [])
* @method \Aws\Result getMetricWidgetImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMetricWidgetImageAsync(array $args = [])
* @method \Aws\Result listDashboards(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDashboardsAsync(array $args = [])
* @method \Aws\Result listMetrics(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMetricsAsync(array $args = [])
* @method \Aws\Result putDashboard(array $args = [])
* @method \GuzzleHttp\Promise\Promise putDashboardAsync(array $args = [])
* @method \Aws\Result putMetricAlarm(array $args = [])
* @method \GuzzleHttp\Promise\Promise putMetricAlarmAsync(array $args = [])
* @method \Aws\Result putMetricData(array $args = [])
* @method \GuzzleHttp\Promise\Promise putMetricDataAsync(array $args = [])
* @method \Aws\Result setAlarmState(array $args = [])
* @method \GuzzleHttp\Promise\Promise setAlarmStateAsync(array $args = [])
*/
class CloudWatchClient extends \Aws\AwsClient
{
}
}
namespace Aws\CloudWatch\Exception {
/**
* Represents an error interacting with the Amazon CloudWatch service.
*/
class CloudWatchException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudWatchEvents\Exception {
/**
* Represents an error interacting with the **Amazon CloudWatch Events** service.
*/
class CloudWatchEventsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudWatchEvents {
/**
* This client is used to interact with the **Amazon CloudWatch Events** service.
*
* @method \Aws\Result deleteRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRuleAsync(array $args = [])
* @method \Aws\Result describeEventBus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventBusAsync(array $args = [])
* @method \Aws\Result describeRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRuleAsync(array $args = [])
* @method \Aws\Result disableRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableRuleAsync(array $args = [])
* @method \Aws\Result enableRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableRuleAsync(array $args = [])
* @method \Aws\Result listRuleNamesByTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRuleNamesByTargetAsync(array $args = [])
* @method \Aws\Result listRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRulesAsync(array $args = [])
* @method \Aws\Result listTargetsByRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTargetsByRuleAsync(array $args = [])
* @method \Aws\Result putEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise putEventsAsync(array $args = [])
* @method \Aws\Result putPermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise putPermissionAsync(array $args = [])
* @method \Aws\Result putRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRuleAsync(array $args = [])
* @method \Aws\Result putTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise putTargetsAsync(array $args = [])
* @method \Aws\Result removePermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise removePermissionAsync(array $args = [])
* @method \Aws\Result removeTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTargetsAsync(array $args = [])
* @method \Aws\Result testEventPattern(array $args = [])
* @method \GuzzleHttp\Promise\Promise testEventPatternAsync(array $args = [])
*/
class CloudWatchEventsClient extends \Aws\AwsClient
{
}
}
namespace Aws\Sqs {
/**
* Client used to interact Amazon Simple Queue Service (Amazon SQS)
*
* @method \Aws\Result addPermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise addPermissionAsync(array $args = [])
* @method \Aws\Result changeMessageVisibility(array $args = [])
* @method \GuzzleHttp\Promise\Promise changeMessageVisibilityAsync(array $args = [])
* @method \Aws\Result changeMessageVisibilityBatch(array $args = [])
* @method \GuzzleHttp\Promise\Promise changeMessageVisibilityBatchAsync(array $args = [])
* @method \Aws\Result createQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise createQueueAsync(array $args = [])
* @method \Aws\Result deleteMessage(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMessageAsync(array $args = [])
* @method \Aws\Result deleteMessageBatch(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMessageBatchAsync(array $args = [])
* @method \Aws\Result deleteQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteQueueAsync(array $args = [])
* @method \Aws\Result getQueueAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getQueueAttributesAsync(array $args = [])
* @method \Aws\Result getQueueUrl(array $args = [])
* @method \GuzzleHttp\Promise\Promise getQueueUrlAsync(array $args = [])
* @method \Aws\Result listDeadLetterSourceQueues(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeadLetterSourceQueuesAsync(array $args = [])
* @method \Aws\Result listQueueTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listQueueTagsAsync(array $args = [])
* @method \Aws\Result listQueues(array $args = [])
* @method \GuzzleHttp\Promise\Promise listQueuesAsync(array $args = [])
* @method \Aws\Result purgeQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise purgeQueueAsync(array $args = [])
* @method \Aws\Result receiveMessage(array $args = [])
* @method \GuzzleHttp\Promise\Promise receiveMessageAsync(array $args = [])
* @method \Aws\Result removePermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise removePermissionAsync(array $args = [])
* @method \Aws\Result sendMessage(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendMessageAsync(array $args = [])
* @method \Aws\Result sendMessageBatch(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendMessageBatchAsync(array $args = [])
* @method \Aws\Result setQueueAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise setQueueAttributesAsync(array $args = [])
* @method \Aws\Result tagQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagQueueAsync(array $args = [])
* @method \Aws\Result untagQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagQueueAsync(array $args = [])
*/
class SqsClient extends \Aws\AwsClient
{
public function __construct(array $config)
{
}
/**
* Converts a queue URL into a queue ARN.
*
* @param string $queueUrl The queue URL to perform the action on.
* Retrieved when the queue is first created.
*
* @return string An ARN representation of the queue URL.
*/
public function getQueueArn($queueUrl)
{
}
}
}
namespace Aws\Sqs\Exception {
/**
* Represents an error interacting with the Amazon Simple Queue Service.
*/
class SqsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CognitoIdentityProvider {
/**
* This client is used to interact with the **Amazon Cognito Identity Provider** service.
*
* @method \Aws\Result addCustomAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise addCustomAttributesAsync(array $args = [])
* @method \Aws\Result adminAddUserToGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminAddUserToGroupAsync(array $args = [])
* @method \Aws\Result adminConfirmSignUp(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminConfirmSignUpAsync(array $args = [])
* @method \Aws\Result adminCreateUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminCreateUserAsync(array $args = [])
* @method \Aws\Result adminDeleteUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminDeleteUserAsync(array $args = [])
* @method \Aws\Result adminDeleteUserAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminDeleteUserAttributesAsync(array $args = [])
* @method \Aws\Result adminDisableProviderForUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminDisableProviderForUserAsync(array $args = [])
* @method \Aws\Result adminDisableUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminDisableUserAsync(array $args = [])
* @method \Aws\Result adminEnableUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminEnableUserAsync(array $args = [])
* @method \Aws\Result adminForgetDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminForgetDeviceAsync(array $args = [])
* @method \Aws\Result adminGetDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminGetDeviceAsync(array $args = [])
* @method \Aws\Result adminGetUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminGetUserAsync(array $args = [])
* @method \Aws\Result adminInitiateAuth(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminInitiateAuthAsync(array $args = [])
* @method \Aws\Result adminLinkProviderForUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminLinkProviderForUserAsync(array $args = [])
* @method \Aws\Result adminListDevices(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminListDevicesAsync(array $args = [])
* @method \Aws\Result adminListGroupsForUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminListGroupsForUserAsync(array $args = [])
* @method \Aws\Result adminListUserAuthEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminListUserAuthEventsAsync(array $args = [])
* @method \Aws\Result adminRemoveUserFromGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminRemoveUserFromGroupAsync(array $args = [])
* @method \Aws\Result adminResetUserPassword(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminResetUserPasswordAsync(array $args = [])
* @method \Aws\Result adminRespondToAuthChallenge(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminRespondToAuthChallengeAsync(array $args = [])
* @method \Aws\Result adminSetUserMFAPreference(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminSetUserMFAPreferenceAsync(array $args = [])
* @method \Aws\Result adminSetUserSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminSetUserSettingsAsync(array $args = [])
* @method \Aws\Result adminUpdateAuthEventFeedback(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminUpdateAuthEventFeedbackAsync(array $args = [])
* @method \Aws\Result adminUpdateDeviceStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminUpdateDeviceStatusAsync(array $args = [])
* @method \Aws\Result adminUpdateUserAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminUpdateUserAttributesAsync(array $args = [])
* @method \Aws\Result adminUserGlobalSignOut(array $args = [])
* @method \GuzzleHttp\Promise\Promise adminUserGlobalSignOutAsync(array $args = [])
* @method \Aws\Result associateSoftwareToken(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateSoftwareTokenAsync(array $args = [])
* @method \Aws\Result changePassword(array $args = [])
* @method \GuzzleHttp\Promise\Promise changePasswordAsync(array $args = [])
* @method \Aws\Result confirmDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise confirmDeviceAsync(array $args = [])
* @method \Aws\Result confirmForgotPassword(array $args = [])
* @method \GuzzleHttp\Promise\Promise confirmForgotPasswordAsync(array $args = [])
* @method \Aws\Result confirmSignUp(array $args = [])
* @method \GuzzleHttp\Promise\Promise confirmSignUpAsync(array $args = [])
* @method \Aws\Result createGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGroupAsync(array $args = [])
* @method \Aws\Result createIdentityProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise createIdentityProviderAsync(array $args = [])
* @method \Aws\Result createResourceServer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createResourceServerAsync(array $args = [])
* @method \Aws\Result createUserImportJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserImportJobAsync(array $args = [])
* @method \Aws\Result createUserPool(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserPoolAsync(array $args = [])
* @method \Aws\Result createUserPoolClient(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserPoolClientAsync(array $args = [])
* @method \Aws\Result createUserPoolDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserPoolDomainAsync(array $args = [])
* @method \Aws\Result deleteGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGroupAsync(array $args = [])
* @method \Aws\Result deleteIdentityProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIdentityProviderAsync(array $args = [])
* @method \Aws\Result deleteResourceServer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteResourceServerAsync(array $args = [])
* @method \Aws\Result deleteUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserAsync(array $args = [])
* @method \Aws\Result deleteUserAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserAttributesAsync(array $args = [])
* @method \Aws\Result deleteUserPool(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserPoolAsync(array $args = [])
* @method \Aws\Result deleteUserPoolClient(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserPoolClientAsync(array $args = [])
* @method \Aws\Result deleteUserPoolDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserPoolDomainAsync(array $args = [])
* @method \Aws\Result describeIdentityProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeIdentityProviderAsync(array $args = [])
* @method \Aws\Result describeResourceServer(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeResourceServerAsync(array $args = [])
* @method \Aws\Result describeRiskConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRiskConfigurationAsync(array $args = [])
* @method \Aws\Result describeUserImportJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserImportJobAsync(array $args = [])
* @method \Aws\Result describeUserPool(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserPoolAsync(array $args = [])
* @method \Aws\Result describeUserPoolClient(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserPoolClientAsync(array $args = [])
* @method \Aws\Result describeUserPoolDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserPoolDomainAsync(array $args = [])
* @method \Aws\Result forgetDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise forgetDeviceAsync(array $args = [])
* @method \Aws\Result forgotPassword(array $args = [])
* @method \GuzzleHttp\Promise\Promise forgotPasswordAsync(array $args = [])
* @method \Aws\Result getCSVHeader(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCSVHeaderAsync(array $args = [])
* @method \Aws\Result getDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeviceAsync(array $args = [])
* @method \Aws\Result getGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGroupAsync(array $args = [])
* @method \Aws\Result getIdentityProviderByIdentifier(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIdentityProviderByIdentifierAsync(array $args = [])
* @method \Aws\Result getSigningCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSigningCertificateAsync(array $args = [])
* @method \Aws\Result getUICustomization(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUICustomizationAsync(array $args = [])
* @method \Aws\Result getUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUserAsync(array $args = [])
* @method \Aws\Result getUserAttributeVerificationCode(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUserAttributeVerificationCodeAsync(array $args = [])
* @method \Aws\Result getUserPoolMfaConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUserPoolMfaConfigAsync(array $args = [])
* @method \Aws\Result globalSignOut(array $args = [])
* @method \GuzzleHttp\Promise\Promise globalSignOutAsync(array $args = [])
* @method \Aws\Result initiateAuth(array $args = [])
* @method \GuzzleHttp\Promise\Promise initiateAuthAsync(array $args = [])
* @method \Aws\Result listDevices(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDevicesAsync(array $args = [])
* @method \Aws\Result listGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupsAsync(array $args = [])
* @method \Aws\Result listIdentityProviders(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIdentityProvidersAsync(array $args = [])
* @method \Aws\Result listResourceServers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourceServersAsync(array $args = [])
* @method \Aws\Result listUserImportJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUserImportJobsAsync(array $args = [])
* @method \Aws\Result listUserPoolClients(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUserPoolClientsAsync(array $args = [])
* @method \Aws\Result listUserPools(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUserPoolsAsync(array $args = [])
* @method \Aws\Result listUsers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUsersAsync(array $args = [])
* @method \Aws\Result listUsersInGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUsersInGroupAsync(array $args = [])
* @method \Aws\Result resendConfirmationCode(array $args = [])
* @method \GuzzleHttp\Promise\Promise resendConfirmationCodeAsync(array $args = [])
* @method \Aws\Result respondToAuthChallenge(array $args = [])
* @method \GuzzleHttp\Promise\Promise respondToAuthChallengeAsync(array $args = [])
* @method \Aws\Result setRiskConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise setRiskConfigurationAsync(array $args = [])
* @method \Aws\Result setUICustomization(array $args = [])
* @method \GuzzleHttp\Promise\Promise setUICustomizationAsync(array $args = [])
* @method \Aws\Result setUserMFAPreference(array $args = [])
* @method \GuzzleHttp\Promise\Promise setUserMFAPreferenceAsync(array $args = [])
* @method \Aws\Result setUserPoolMfaConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise setUserPoolMfaConfigAsync(array $args = [])
* @method \Aws\Result setUserSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise setUserSettingsAsync(array $args = [])
* @method \Aws\Result signUp(array $args = [])
* @method \GuzzleHttp\Promise\Promise signUpAsync(array $args = [])
* @method \Aws\Result startUserImportJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise startUserImportJobAsync(array $args = [])
* @method \Aws\Result stopUserImportJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopUserImportJobAsync(array $args = [])
* @method \Aws\Result updateAuthEventFeedback(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAuthEventFeedbackAsync(array $args = [])
* @method \Aws\Result updateDeviceStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDeviceStatusAsync(array $args = [])
* @method \Aws\Result updateGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGroupAsync(array $args = [])
* @method \Aws\Result updateIdentityProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateIdentityProviderAsync(array $args = [])
* @method \Aws\Result updateResourceServer(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateResourceServerAsync(array $args = [])
* @method \Aws\Result updateUserAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserAttributesAsync(array $args = [])
* @method \Aws\Result updateUserPool(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserPoolAsync(array $args = [])
* @method \Aws\Result updateUserPoolClient(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserPoolClientAsync(array $args = [])
* @method \Aws\Result verifySoftwareToken(array $args = [])
* @method \GuzzleHttp\Promise\Promise verifySoftwareTokenAsync(array $args = [])
* @method \Aws\Result verifyUserAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise verifyUserAttributeAsync(array $args = [])
*/
class CognitoIdentityProviderClient extends \Aws\AwsClient
{
}
}
namespace Aws\CognitoIdentityProvider\Exception {
/**
* Represents an error interacting with the **Amazon Cognito Identity Provider** service.
*/
class CognitoIdentityProviderException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* "Waiters" are associated with an AWS resource (e.g., EC2 instance), and poll
* that resource and until it is in a particular state.
* The Waiter object produces a promise that is either a.) resolved once the
* waiting conditions are met, or b.) rejected if the waiting conditions cannot
* be met or has exceeded the number of allowed attempts at meeting the
* conditions. You can use waiters in a blocking or non-blocking way, depending
* on whether you call wait() on the promise.
* The configuration for the waiter must include information about the operation
* and the conditions for wait completion.
*/
class Waiter implements \GuzzleHttp\Promise\PromisorInterface
{
/**
* The array of configuration options include:
*
* - acceptors: (array) Array of acceptor options
* - delay: (int) Number of seconds to delay between attempts
* - maxAttempts: (int) Maximum number of attempts before failing
* - operation: (string) Name of the API operation to use for polling
* - before: (callable) Invoked before attempts. Accepts command and tries.
*
* @param AwsClientInterface $client Client used to execute commands.
* @param string $name Waiter name.
* @param array $args Command arguments.
* @param array $config Waiter config that overrides defaults.
*
* @throws \InvalidArgumentException if the configuration is incomplete.
*/
public function __construct(\Aws\AwsClientInterface $client, $name, array $args = [], array $config = [])
{
}
public function promise()
{
}
}
}
namespace Aws\Swf {
/**
* Amazon Simple Workflow Service (Amazon SWF) client.
*
* @method \Aws\Result countClosedWorkflowExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise countClosedWorkflowExecutionsAsync(array $args = [])
* @method \Aws\Result countOpenWorkflowExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise countOpenWorkflowExecutionsAsync(array $args = [])
* @method \Aws\Result countPendingActivityTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise countPendingActivityTasksAsync(array $args = [])
* @method \Aws\Result countPendingDecisionTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise countPendingDecisionTasksAsync(array $args = [])
* @method \Aws\Result deprecateActivityType(array $args = [])
* @method \GuzzleHttp\Promise\Promise deprecateActivityTypeAsync(array $args = [])
* @method \Aws\Result deprecateDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise deprecateDomainAsync(array $args = [])
* @method \Aws\Result deprecateWorkflowType(array $args = [])
* @method \GuzzleHttp\Promise\Promise deprecateWorkflowTypeAsync(array $args = [])
* @method \Aws\Result describeActivityType(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeActivityTypeAsync(array $args = [])
* @method \Aws\Result describeDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDomainAsync(array $args = [])
* @method \Aws\Result describeWorkflowExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeWorkflowExecutionAsync(array $args = [])
* @method \Aws\Result describeWorkflowType(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeWorkflowTypeAsync(array $args = [])
* @method \Aws\Result getWorkflowExecutionHistory(array $args = [])
* @method \GuzzleHttp\Promise\Promise getWorkflowExecutionHistoryAsync(array $args = [])
* @method \Aws\Result listActivityTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listActivityTypesAsync(array $args = [])
* @method \Aws\Result listClosedWorkflowExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listClosedWorkflowExecutionsAsync(array $args = [])
* @method \Aws\Result listDomains(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDomainsAsync(array $args = [])
* @method \Aws\Result listOpenWorkflowExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOpenWorkflowExecutionsAsync(array $args = [])
* @method \Aws\Result listWorkflowTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listWorkflowTypesAsync(array $args = [])
* @method \Aws\Result pollForActivityTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise pollForActivityTaskAsync(array $args = [])
* @method \Aws\Result pollForDecisionTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise pollForDecisionTaskAsync(array $args = [])
* @method \Aws\Result recordActivityTaskHeartbeat(array $args = [])
* @method \GuzzleHttp\Promise\Promise recordActivityTaskHeartbeatAsync(array $args = [])
* @method \Aws\Result registerActivityType(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerActivityTypeAsync(array $args = [])
* @method \Aws\Result registerDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerDomainAsync(array $args = [])
* @method \Aws\Result registerWorkflowType(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerWorkflowTypeAsync(array $args = [])
* @method \Aws\Result requestCancelWorkflowExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise requestCancelWorkflowExecutionAsync(array $args = [])
* @method \Aws\Result respondActivityTaskCanceled(array $args = [])
* @method \GuzzleHttp\Promise\Promise respondActivityTaskCanceledAsync(array $args = [])
* @method \Aws\Result respondActivityTaskCompleted(array $args = [])
* @method \GuzzleHttp\Promise\Promise respondActivityTaskCompletedAsync(array $args = [])
* @method \Aws\Result respondActivityTaskFailed(array $args = [])
* @method \GuzzleHttp\Promise\Promise respondActivityTaskFailedAsync(array $args = [])
* @method \Aws\Result respondDecisionTaskCompleted(array $args = [])
* @method \GuzzleHttp\Promise\Promise respondDecisionTaskCompletedAsync(array $args = [])
* @method \Aws\Result signalWorkflowExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise signalWorkflowExecutionAsync(array $args = [])
* @method \Aws\Result startWorkflowExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise startWorkflowExecutionAsync(array $args = [])
* @method \Aws\Result terminateWorkflowExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise terminateWorkflowExecutionAsync(array $args = [])
*/
class SwfClient extends \Aws\AwsClient
{
}
}
namespace Aws\Swf\Exception {
/**
* Represents an error interacting with the Amazon Simple Workflow Service.
*/
class SwfException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Pinpoint {
/**
* This client is used to interact with the **Amazon Pinpoint** service.
* @method \Aws\Result createApp(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAppAsync(array $args = [])
* @method \Aws\Result createCampaign(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCampaignAsync(array $args = [])
* @method \Aws\Result createExportJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createExportJobAsync(array $args = [])
* @method \Aws\Result createImportJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createImportJobAsync(array $args = [])
* @method \Aws\Result createSegment(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSegmentAsync(array $args = [])
* @method \Aws\Result deleteAdmChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAdmChannelAsync(array $args = [])
* @method \Aws\Result deleteApnsChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApnsChannelAsync(array $args = [])
* @method \Aws\Result deleteApnsSandboxChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApnsSandboxChannelAsync(array $args = [])
* @method \Aws\Result deleteApnsVoipChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApnsVoipChannelAsync(array $args = [])
* @method \Aws\Result deleteApnsVoipSandboxChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApnsVoipSandboxChannelAsync(array $args = [])
* @method \Aws\Result deleteApp(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAppAsync(array $args = [])
* @method \Aws\Result deleteBaiduChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBaiduChannelAsync(array $args = [])
* @method \Aws\Result deleteCampaign(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCampaignAsync(array $args = [])
* @method \Aws\Result deleteEmailChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEmailChannelAsync(array $args = [])
* @method \Aws\Result deleteEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEndpointAsync(array $args = [])
* @method \Aws\Result deleteEventStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEventStreamAsync(array $args = [])
* @method \Aws\Result deleteGcmChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGcmChannelAsync(array $args = [])
* @method \Aws\Result deleteSegment(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSegmentAsync(array $args = [])
* @method \Aws\Result deleteSmsChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSmsChannelAsync(array $args = [])
* @method \Aws\Result deleteUserEndpoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserEndpointsAsync(array $args = [])
* @method \Aws\Result getAdmChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAdmChannelAsync(array $args = [])
* @method \Aws\Result getApnsChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApnsChannelAsync(array $args = [])
* @method \Aws\Result getApnsSandboxChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApnsSandboxChannelAsync(array $args = [])
* @method \Aws\Result getApnsVoipChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApnsVoipChannelAsync(array $args = [])
* @method \Aws\Result getApnsVoipSandboxChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApnsVoipSandboxChannelAsync(array $args = [])
* @method \Aws\Result getApp(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAppAsync(array $args = [])
* @method \Aws\Result getApplicationSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApplicationSettingsAsync(array $args = [])
* @method \Aws\Result getApps(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAppsAsync(array $args = [])
* @method \Aws\Result getBaiduChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBaiduChannelAsync(array $args = [])
* @method \Aws\Result getCampaign(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCampaignAsync(array $args = [])
* @method \Aws\Result getCampaignActivities(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCampaignActivitiesAsync(array $args = [])
* @method \Aws\Result getCampaignVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCampaignVersionAsync(array $args = [])
* @method \Aws\Result getCampaignVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCampaignVersionsAsync(array $args = [])
* @method \Aws\Result getCampaigns(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCampaignsAsync(array $args = [])
* @method \Aws\Result getChannels(array $args = [])
* @method \GuzzleHttp\Promise\Promise getChannelsAsync(array $args = [])
* @method \Aws\Result getEmailChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getEmailChannelAsync(array $args = [])
* @method \Aws\Result getEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise getEndpointAsync(array $args = [])
* @method \Aws\Result getEventStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise getEventStreamAsync(array $args = [])
* @method \Aws\Result getExportJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise getExportJobAsync(array $args = [])
* @method \Aws\Result getExportJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise getExportJobsAsync(array $args = [])
* @method \Aws\Result getGcmChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGcmChannelAsync(array $args = [])
* @method \Aws\Result getImportJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise getImportJobAsync(array $args = [])
* @method \Aws\Result getImportJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise getImportJobsAsync(array $args = [])
* @method \Aws\Result getSegment(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSegmentAsync(array $args = [])
* @method \Aws\Result getSegmentExportJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSegmentExportJobsAsync(array $args = [])
* @method \Aws\Result getSegmentImportJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSegmentImportJobsAsync(array $args = [])
* @method \Aws\Result getSegmentVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSegmentVersionAsync(array $args = [])
* @method \Aws\Result getSegmentVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSegmentVersionsAsync(array $args = [])
* @method \Aws\Result getSegments(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSegmentsAsync(array $args = [])
* @method \Aws\Result getSmsChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSmsChannelAsync(array $args = [])
* @method \Aws\Result getUserEndpoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUserEndpointsAsync(array $args = [])
* @method \Aws\Result phoneNumberValidate(array $args = [])
* @method \GuzzleHttp\Promise\Promise phoneNumberValidateAsync(array $args = [])
* @method \Aws\Result putEventStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise putEventStreamAsync(array $args = [])
* @method \Aws\Result putEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise putEventsAsync(array $args = [])
* @method \Aws\Result removeAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeAttributesAsync(array $args = [])
* @method \Aws\Result sendMessages(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendMessagesAsync(array $args = [])
* @method \Aws\Result sendUsersMessages(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendUsersMessagesAsync(array $args = [])
* @method \Aws\Result updateAdmChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAdmChannelAsync(array $args = [])
* @method \Aws\Result updateApnsChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApnsChannelAsync(array $args = [])
* @method \Aws\Result updateApnsSandboxChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApnsSandboxChannelAsync(array $args = [])
* @method \Aws\Result updateApnsVoipChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApnsVoipChannelAsync(array $args = [])
* @method \Aws\Result updateApnsVoipSandboxChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApnsVoipSandboxChannelAsync(array $args = [])
* @method \Aws\Result updateApplicationSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApplicationSettingsAsync(array $args = [])
* @method \Aws\Result updateBaiduChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateBaiduChannelAsync(array $args = [])
* @method \Aws\Result updateCampaign(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCampaignAsync(array $args = [])
* @method \Aws\Result updateEmailChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEmailChannelAsync(array $args = [])
* @method \Aws\Result updateEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEndpointAsync(array $args = [])
* @method \Aws\Result updateEndpointsBatch(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEndpointsBatchAsync(array $args = [])
* @method \Aws\Result updateGcmChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGcmChannelAsync(array $args = [])
* @method \Aws\Result updateSegment(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSegmentAsync(array $args = [])
* @method \Aws\Result updateSmsChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSmsChannelAsync(array $args = [])
*/
class PinpointClient extends \Aws\AwsClient
{
public function __call($name, array $args)
{
}
/**
* @internal
* @codeCoverageIgnore
*/
public static function applyDocFilters(array $api, array $docs)
{
}
}
}
namespace Aws\Pinpoint\Exception {
/**
* Represents an error interacting with the **Amazon Pinpoint** service.
*/
class PinpointException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\WafRegional {
/**
* This client is used to interact with the **AWS WAF Regional** service.
* @method \Aws\Result associateWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateWebACLAsync(array $args = [])
* @method \Aws\Result createByteMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createByteMatchSetAsync(array $args = [])
* @method \Aws\Result createGeoMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGeoMatchSetAsync(array $args = [])
* @method \Aws\Result createIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createIPSetAsync(array $args = [])
* @method \Aws\Result createRateBasedRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRateBasedRuleAsync(array $args = [])
* @method \Aws\Result createRegexMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRegexMatchSetAsync(array $args = [])
* @method \Aws\Result createRegexPatternSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRegexPatternSetAsync(array $args = [])
* @method \Aws\Result createRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRuleAsync(array $args = [])
* @method \Aws\Result createRuleGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRuleGroupAsync(array $args = [])
* @method \Aws\Result createSizeConstraintSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSizeConstraintSetAsync(array $args = [])
* @method \Aws\Result createSqlInjectionMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSqlInjectionMatchSetAsync(array $args = [])
* @method \Aws\Result createWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise createWebACLAsync(array $args = [])
* @method \Aws\Result createXssMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createXssMatchSetAsync(array $args = [])
* @method \Aws\Result deleteByteMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteByteMatchSetAsync(array $args = [])
* @method \Aws\Result deleteGeoMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGeoMatchSetAsync(array $args = [])
* @method \Aws\Result deleteIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIPSetAsync(array $args = [])
* @method \Aws\Result deleteLoggingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLoggingConfigurationAsync(array $args = [])
* @method \Aws\Result deletePermissionPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePermissionPolicyAsync(array $args = [])
* @method \Aws\Result deleteRateBasedRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRateBasedRuleAsync(array $args = [])
* @method \Aws\Result deleteRegexMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRegexMatchSetAsync(array $args = [])
* @method \Aws\Result deleteRegexPatternSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRegexPatternSetAsync(array $args = [])
* @method \Aws\Result deleteRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRuleAsync(array $args = [])
* @method \Aws\Result deleteRuleGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRuleGroupAsync(array $args = [])
* @method \Aws\Result deleteSizeConstraintSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSizeConstraintSetAsync(array $args = [])
* @method \Aws\Result deleteSqlInjectionMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSqlInjectionMatchSetAsync(array $args = [])
* @method \Aws\Result deleteWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteWebACLAsync(array $args = [])
* @method \Aws\Result deleteXssMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteXssMatchSetAsync(array $args = [])
* @method \Aws\Result disassociateWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateWebACLAsync(array $args = [])
* @method \Aws\Result getByteMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getByteMatchSetAsync(array $args = [])
* @method \Aws\Result getChangeToken(array $args = [])
* @method \GuzzleHttp\Promise\Promise getChangeTokenAsync(array $args = [])
* @method \Aws\Result getChangeTokenStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getChangeTokenStatusAsync(array $args = [])
* @method \Aws\Result getGeoMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGeoMatchSetAsync(array $args = [])
* @method \Aws\Result getIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIPSetAsync(array $args = [])
* @method \Aws\Result getLoggingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLoggingConfigurationAsync(array $args = [])
* @method \Aws\Result getPermissionPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPermissionPolicyAsync(array $args = [])
* @method \Aws\Result getRateBasedRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRateBasedRuleAsync(array $args = [])
* @method \Aws\Result getRateBasedRuleManagedKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRateBasedRuleManagedKeysAsync(array $args = [])
* @method \Aws\Result getRegexMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRegexMatchSetAsync(array $args = [])
* @method \Aws\Result getRegexPatternSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRegexPatternSetAsync(array $args = [])
* @method \Aws\Result getRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRuleAsync(array $args = [])
* @method \Aws\Result getRuleGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRuleGroupAsync(array $args = [])
* @method \Aws\Result getSampledRequests(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSampledRequestsAsync(array $args = [])
* @method \Aws\Result getSizeConstraintSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSizeConstraintSetAsync(array $args = [])
* @method \Aws\Result getSqlInjectionMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSqlInjectionMatchSetAsync(array $args = [])
* @method \Aws\Result getWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise getWebACLAsync(array $args = [])
* @method \Aws\Result getWebACLForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise getWebACLForResourceAsync(array $args = [])
* @method \Aws\Result getXssMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getXssMatchSetAsync(array $args = [])
* @method \Aws\Result listActivatedRulesInRuleGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise listActivatedRulesInRuleGroupAsync(array $args = [])
* @method \Aws\Result listByteMatchSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listByteMatchSetsAsync(array $args = [])
* @method \Aws\Result listGeoMatchSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGeoMatchSetsAsync(array $args = [])
* @method \Aws\Result listIPSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIPSetsAsync(array $args = [])
* @method \Aws\Result listLoggingConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listLoggingConfigurationsAsync(array $args = [])
* @method \Aws\Result listRateBasedRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRateBasedRulesAsync(array $args = [])
* @method \Aws\Result listRegexMatchSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRegexMatchSetsAsync(array $args = [])
* @method \Aws\Result listRegexPatternSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRegexPatternSetsAsync(array $args = [])
* @method \Aws\Result listResourcesForWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourcesForWebACLAsync(array $args = [])
* @method \Aws\Result listRuleGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRuleGroupsAsync(array $args = [])
* @method \Aws\Result listRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRulesAsync(array $args = [])
* @method \Aws\Result listSizeConstraintSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSizeConstraintSetsAsync(array $args = [])
* @method \Aws\Result listSqlInjectionMatchSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSqlInjectionMatchSetsAsync(array $args = [])
* @method \Aws\Result listSubscribedRuleGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSubscribedRuleGroupsAsync(array $args = [])
* @method \Aws\Result listWebACLs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listWebACLsAsync(array $args = [])
* @method \Aws\Result listXssMatchSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listXssMatchSetsAsync(array $args = [])
* @method \Aws\Result putLoggingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putLoggingConfigurationAsync(array $args = [])
* @method \Aws\Result putPermissionPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putPermissionPolicyAsync(array $args = [])
* @method \Aws\Result updateByteMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateByteMatchSetAsync(array $args = [])
* @method \Aws\Result updateGeoMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGeoMatchSetAsync(array $args = [])
* @method \Aws\Result updateIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateIPSetAsync(array $args = [])
* @method \Aws\Result updateRateBasedRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRateBasedRuleAsync(array $args = [])
* @method \Aws\Result updateRegexMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRegexMatchSetAsync(array $args = [])
* @method \Aws\Result updateRegexPatternSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRegexPatternSetAsync(array $args = [])
* @method \Aws\Result updateRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRuleAsync(array $args = [])
* @method \Aws\Result updateRuleGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRuleGroupAsync(array $args = [])
* @method \Aws\Result updateSizeConstraintSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSizeConstraintSetAsync(array $args = [])
* @method \Aws\Result updateSqlInjectionMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSqlInjectionMatchSetAsync(array $args = [])
* @method \Aws\Result updateWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateWebACLAsync(array $args = [])
* @method \Aws\Result updateXssMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateXssMatchSetAsync(array $args = [])
*/
class WafRegionalClient extends \Aws\AwsClient
{
}
}
namespace Aws\WafRegional\Exception {
/**
* Represents an error interacting with the **AWS WAF Regional** service.
*/
class WafRegionalException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* Stream decorator that calculates a rolling hash of the stream as it is read.
*/
class HashingStream implements \Psr\Http\Message\StreamInterface
{
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
/**
* @param StreamInterface $stream Stream that is being read.
* @param HashInterface $hash Hash used to calculate checksum.
* @param callable $onComplete Optional function invoked when the
* hash calculation is completed.
*/
public function __construct(\Psr\Http\Message\StreamInterface $stream, \Aws\HashInterface $hash, callable $onComplete = null)
{
}
public function read($length)
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
}
}
namespace Aws\Lambda {
/**
* This client is used to interact with AWS Lambda
*
* @method \Aws\Result addPermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise addPermissionAsync(array $args = [])
* @method \Aws\Result createAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAliasAsync(array $args = [])
* @method \Aws\Result createEventSourceMapping(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEventSourceMappingAsync(array $args = [])
* @method \Aws\Result createFunction(array $args = [])
* @method \GuzzleHttp\Promise\Promise createFunctionAsync(array $args = [])
* @method \Aws\Result deleteAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAliasAsync(array $args = [])
* @method \Aws\Result deleteEventSourceMapping(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEventSourceMappingAsync(array $args = [])
* @method \Aws\Result deleteFunction(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFunctionAsync(array $args = [])
* @method \Aws\Result deleteFunctionConcurrency(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFunctionConcurrencyAsync(array $args = [])
* @method \Aws\Result getAccountSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAccountSettingsAsync(array $args = [])
* @method \Aws\Result getAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAliasAsync(array $args = [])
* @method \Aws\Result getEventSourceMapping(array $args = [])
* @method \GuzzleHttp\Promise\Promise getEventSourceMappingAsync(array $args = [])
* @method \Aws\Result getFunction(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFunctionAsync(array $args = [])
* @method \Aws\Result getFunctionConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFunctionConfigurationAsync(array $args = [])
* @method \Aws\Result getPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPolicyAsync(array $args = [])
* @method \Aws\Result invoke(array $args = [])
* @method \GuzzleHttp\Promise\Promise invokeAsync(array $args = [])
* @method \Aws\Result invokeAsync(array $args = [])
* @method \GuzzleHttp\Promise\Promise invokeAsyncAsync(array $args = [])
* @method \Aws\Result listAliases(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAliasesAsync(array $args = [])
* @method \Aws\Result listEventSourceMappings(array $args = [])
* @method \GuzzleHttp\Promise\Promise listEventSourceMappingsAsync(array $args = [])
* @method \Aws\Result listFunctions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFunctionsAsync(array $args = [])
* @method \Aws\Result listTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsAsync(array $args = [])
* @method \Aws\Result listVersionsByFunction(array $args = [])
* @method \GuzzleHttp\Promise\Promise listVersionsByFunctionAsync(array $args = [])
* @method \Aws\Result publishVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise publishVersionAsync(array $args = [])
* @method \Aws\Result putFunctionConcurrency(array $args = [])
* @method \GuzzleHttp\Promise\Promise putFunctionConcurrencyAsync(array $args = [])
* @method \Aws\Result removePermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise removePermissionAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAliasAsync(array $args = [])
* @method \Aws\Result updateEventSourceMapping(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEventSourceMappingAsync(array $args = [])
* @method \Aws\Result updateFunctionCode(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFunctionCodeAsync(array $args = [])
* @method \Aws\Result updateFunctionConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFunctionConfigurationAsync(array $args = [])
*/
class LambdaClient extends \Aws\AwsClient
{
/**
* {@inheritdoc}
*/
public function __construct(array $args)
{
}
/**
* Provides a middleware that sets default Curl options for the command
*
* @return callable
*/
public function getDefaultCurlOptionsMiddleware()
{
}
}
}
namespace Aws\Lambda\Exception {
/**
* Represents an error interacting with AWS Lambda
*/
class LambdaException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Kms {
/**
* This client is used to interact with the **AWS Key Management Service**.
*
* @method \Aws\Result cancelKeyDeletion(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelKeyDeletionAsync(array $args = [])
* @method \Aws\Result createAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAliasAsync(array $args = [])
* @method \Aws\Result createGrant(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGrantAsync(array $args = [])
* @method \Aws\Result createKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise createKeyAsync(array $args = [])
* @method \Aws\Result decrypt(array $args = [])
* @method \GuzzleHttp\Promise\Promise decryptAsync(array $args = [])
* @method \Aws\Result deleteAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAliasAsync(array $args = [])
* @method \Aws\Result deleteImportedKeyMaterial(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteImportedKeyMaterialAsync(array $args = [])
* @method \Aws\Result describeKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeKeyAsync(array $args = [])
* @method \Aws\Result disableKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableKeyAsync(array $args = [])
* @method \Aws\Result disableKeyRotation(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableKeyRotationAsync(array $args = [])
* @method \Aws\Result enableKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableKeyAsync(array $args = [])
* @method \Aws\Result enableKeyRotation(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableKeyRotationAsync(array $args = [])
* @method \Aws\Result encrypt(array $args = [])
* @method \GuzzleHttp\Promise\Promise encryptAsync(array $args = [])
* @method \Aws\Result generateDataKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise generateDataKeyAsync(array $args = [])
* @method \Aws\Result generateDataKeyWithoutPlaintext(array $args = [])
* @method \GuzzleHttp\Promise\Promise generateDataKeyWithoutPlaintextAsync(array $args = [])
* @method \Aws\Result generateRandom(array $args = [])
* @method \GuzzleHttp\Promise\Promise generateRandomAsync(array $args = [])
* @method \Aws\Result getKeyPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getKeyPolicyAsync(array $args = [])
* @method \Aws\Result getKeyRotationStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getKeyRotationStatusAsync(array $args = [])
* @method \Aws\Result getParametersForImport(array $args = [])
* @method \GuzzleHttp\Promise\Promise getParametersForImportAsync(array $args = [])
* @method \Aws\Result importKeyMaterial(array $args = [])
* @method \GuzzleHttp\Promise\Promise importKeyMaterialAsync(array $args = [])
* @method \Aws\Result listAliases(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAliasesAsync(array $args = [])
* @method \Aws\Result listGrants(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGrantsAsync(array $args = [])
* @method \Aws\Result listKeyPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listKeyPoliciesAsync(array $args = [])
* @method \Aws\Result listKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise listKeysAsync(array $args = [])
* @method \Aws\Result listResourceTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourceTagsAsync(array $args = [])
* @method \Aws\Result listRetirableGrants(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRetirableGrantsAsync(array $args = [])
* @method \Aws\Result putKeyPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putKeyPolicyAsync(array $args = [])
* @method \Aws\Result reEncrypt(array $args = [])
* @method \GuzzleHttp\Promise\Promise reEncryptAsync(array $args = [])
* @method \Aws\Result retireGrant(array $args = [])
* @method \GuzzleHttp\Promise\Promise retireGrantAsync(array $args = [])
* @method \Aws\Result revokeGrant(array $args = [])
* @method \GuzzleHttp\Promise\Promise revokeGrantAsync(array $args = [])
* @method \Aws\Result scheduleKeyDeletion(array $args = [])
* @method \GuzzleHttp\Promise\Promise scheduleKeyDeletionAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAliasAsync(array $args = [])
* @method \Aws\Result updateKeyDescription(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateKeyDescriptionAsync(array $args = [])
*/
class KmsClient extends \Aws\AwsClient
{
}
}
namespace Aws\Kms\Exception {
/**
* Represents an error interacting with the AWS Key Management Service.
*/
class KmsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\DeviceFarm {
/**
* This client is used to interact with the **Amazon DeviceFarm** service.
*
* @method \Aws\Result createDevicePool(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDevicePoolAsync(array $args = [])
* @method \Aws\Result createInstanceProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInstanceProfileAsync(array $args = [])
* @method \Aws\Result createNetworkProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNetworkProfileAsync(array $args = [])
* @method \Aws\Result createProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProjectAsync(array $args = [])
* @method \Aws\Result createRemoteAccessSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRemoteAccessSessionAsync(array $args = [])
* @method \Aws\Result createUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUploadAsync(array $args = [])
* @method \Aws\Result createVPCEConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVPCEConfigurationAsync(array $args = [])
* @method \Aws\Result deleteDevicePool(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDevicePoolAsync(array $args = [])
* @method \Aws\Result deleteInstanceProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInstanceProfileAsync(array $args = [])
* @method \Aws\Result deleteNetworkProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNetworkProfileAsync(array $args = [])
* @method \Aws\Result deleteProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProjectAsync(array $args = [])
* @method \Aws\Result deleteRemoteAccessSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRemoteAccessSessionAsync(array $args = [])
* @method \Aws\Result deleteRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRunAsync(array $args = [])
* @method \Aws\Result deleteUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUploadAsync(array $args = [])
* @method \Aws\Result deleteVPCEConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVPCEConfigurationAsync(array $args = [])
* @method \Aws\Result getAccountSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAccountSettingsAsync(array $args = [])
* @method \Aws\Result getDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeviceAsync(array $args = [])
* @method \Aws\Result getDeviceInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeviceInstanceAsync(array $args = [])
* @method \Aws\Result getDevicePool(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDevicePoolAsync(array $args = [])
* @method \Aws\Result getDevicePoolCompatibility(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDevicePoolCompatibilityAsync(array $args = [])
* @method \Aws\Result getInstanceProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstanceProfileAsync(array $args = [])
* @method \Aws\Result getJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobAsync(array $args = [])
* @method \Aws\Result getNetworkProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise getNetworkProfileAsync(array $args = [])
* @method \Aws\Result getOfferingStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOfferingStatusAsync(array $args = [])
* @method \Aws\Result getProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise getProjectAsync(array $args = [])
* @method \Aws\Result getRemoteAccessSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRemoteAccessSessionAsync(array $args = [])
* @method \Aws\Result getRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRunAsync(array $args = [])
* @method \Aws\Result getSuite(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSuiteAsync(array $args = [])
* @method \Aws\Result getTest(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTestAsync(array $args = [])
* @method \Aws\Result getUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUploadAsync(array $args = [])
* @method \Aws\Result getVPCEConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getVPCEConfigurationAsync(array $args = [])
* @method \Aws\Result installToRemoteAccessSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise installToRemoteAccessSessionAsync(array $args = [])
* @method \Aws\Result listArtifacts(array $args = [])
* @method \GuzzleHttp\Promise\Promise listArtifactsAsync(array $args = [])
* @method \Aws\Result listDeviceInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeviceInstancesAsync(array $args = [])
* @method \Aws\Result listDevicePools(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDevicePoolsAsync(array $args = [])
* @method \Aws\Result listDevices(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDevicesAsync(array $args = [])
* @method \Aws\Result listInstanceProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInstanceProfilesAsync(array $args = [])
* @method \Aws\Result listJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobsAsync(array $args = [])
* @method \Aws\Result listNetworkProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise listNetworkProfilesAsync(array $args = [])
* @method \Aws\Result listOfferingPromotions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOfferingPromotionsAsync(array $args = [])
* @method \Aws\Result listOfferingTransactions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOfferingTransactionsAsync(array $args = [])
* @method \Aws\Result listOfferings(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOfferingsAsync(array $args = [])
* @method \Aws\Result listProjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise listProjectsAsync(array $args = [])
* @method \Aws\Result listRemoteAccessSessions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRemoteAccessSessionsAsync(array $args = [])
* @method \Aws\Result listRuns(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRunsAsync(array $args = [])
* @method \Aws\Result listSamples(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSamplesAsync(array $args = [])
* @method \Aws\Result listSuites(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSuitesAsync(array $args = [])
* @method \Aws\Result listTests(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTestsAsync(array $args = [])
* @method \Aws\Result listUniqueProblems(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUniqueProblemsAsync(array $args = [])
* @method \Aws\Result listUploads(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUploadsAsync(array $args = [])
* @method \Aws\Result listVPCEConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listVPCEConfigurationsAsync(array $args = [])
* @method \Aws\Result purchaseOffering(array $args = [])
* @method \GuzzleHttp\Promise\Promise purchaseOfferingAsync(array $args = [])
* @method \Aws\Result renewOffering(array $args = [])
* @method \GuzzleHttp\Promise\Promise renewOfferingAsync(array $args = [])
* @method \Aws\Result scheduleRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise scheduleRunAsync(array $args = [])
* @method \Aws\Result stopJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopJobAsync(array $args = [])
* @method \Aws\Result stopRemoteAccessSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopRemoteAccessSessionAsync(array $args = [])
* @method \Aws\Result stopRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopRunAsync(array $args = [])
* @method \Aws\Result updateDeviceInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDeviceInstanceAsync(array $args = [])
* @method \Aws\Result updateDevicePool(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDevicePoolAsync(array $args = [])
* @method \Aws\Result updateInstanceProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateInstanceProfileAsync(array $args = [])
* @method \Aws\Result updateNetworkProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateNetworkProfileAsync(array $args = [])
* @method \Aws\Result updateProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateProjectAsync(array $args = [])
* @method \Aws\Result updateUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUploadAsync(array $args = [])
* @method \Aws\Result updateVPCEConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateVPCEConfigurationAsync(array $args = [])
*/
class DeviceFarmClient extends \Aws\AwsClient
{
}
}
namespace Aws\DeviceFarm\Exception {
/**
* Represents an error interacting with the Amazon DeviceFarm service.
*/
class DeviceFarmException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\WorkMail {
/**
* This client is used to interact with the **Amazon WorkMail** service.
* @method \Aws\Result associateDelegateToResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateDelegateToResourceAsync(array $args = [])
* @method \Aws\Result associateMemberToGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateMemberToGroupAsync(array $args = [])
* @method \Aws\Result createAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAliasAsync(array $args = [])
* @method \Aws\Result createGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGroupAsync(array $args = [])
* @method \Aws\Result createResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise createResourceAsync(array $args = [])
* @method \Aws\Result createUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserAsync(array $args = [])
* @method \Aws\Result deleteAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAliasAsync(array $args = [])
* @method \Aws\Result deleteGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGroupAsync(array $args = [])
* @method \Aws\Result deleteMailboxPermissions(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMailboxPermissionsAsync(array $args = [])
* @method \Aws\Result deleteResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteResourceAsync(array $args = [])
* @method \Aws\Result deleteUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserAsync(array $args = [])
* @method \Aws\Result deregisterFromWorkMail(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterFromWorkMailAsync(array $args = [])
* @method \Aws\Result describeGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeGroupAsync(array $args = [])
* @method \Aws\Result describeOrganization(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOrganizationAsync(array $args = [])
* @method \Aws\Result describeResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeResourceAsync(array $args = [])
* @method \Aws\Result describeUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserAsync(array $args = [])
* @method \Aws\Result disassociateDelegateFromResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateDelegateFromResourceAsync(array $args = [])
* @method \Aws\Result disassociateMemberFromGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateMemberFromGroupAsync(array $args = [])
* @method \Aws\Result listAliases(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAliasesAsync(array $args = [])
* @method \Aws\Result listGroupMembers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupMembersAsync(array $args = [])
* @method \Aws\Result listGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupsAsync(array $args = [])
* @method \Aws\Result listMailboxPermissions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMailboxPermissionsAsync(array $args = [])
* @method \Aws\Result listOrganizations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOrganizationsAsync(array $args = [])
* @method \Aws\Result listResourceDelegates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourceDelegatesAsync(array $args = [])
* @method \Aws\Result listResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourcesAsync(array $args = [])
* @method \Aws\Result listUsers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUsersAsync(array $args = [])
* @method \Aws\Result putMailboxPermissions(array $args = [])
* @method \GuzzleHttp\Promise\Promise putMailboxPermissionsAsync(array $args = [])
* @method \Aws\Result registerToWorkMail(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerToWorkMailAsync(array $args = [])
* @method \Aws\Result resetPassword(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetPasswordAsync(array $args = [])
* @method \Aws\Result updatePrimaryEmailAddress(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePrimaryEmailAddressAsync(array $args = [])
* @method \Aws\Result updateResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateResourceAsync(array $args = [])
*/
class WorkMailClient extends \Aws\AwsClient
{
}
}
namespace Aws\WorkMail\Exception {
/**
* Represents an error interacting with the **Amazon WorkMail** service.
*/
class WorkMailException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudSearch {
/**
* This client is used to interact with the **Amazon CloudSearch** service.
*
* @method \Aws\Result buildSuggesters(array $args = [])
* @method \GuzzleHttp\Promise\Promise buildSuggestersAsync(array $args = [])
* @method \Aws\Result createDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDomainAsync(array $args = [])
* @method \Aws\Result defineAnalysisScheme(array $args = [])
* @method \GuzzleHttp\Promise\Promise defineAnalysisSchemeAsync(array $args = [])
* @method \Aws\Result defineExpression(array $args = [])
* @method \GuzzleHttp\Promise\Promise defineExpressionAsync(array $args = [])
* @method \Aws\Result defineIndexField(array $args = [])
* @method \GuzzleHttp\Promise\Promise defineIndexFieldAsync(array $args = [])
* @method \Aws\Result defineSuggester(array $args = [])
* @method \GuzzleHttp\Promise\Promise defineSuggesterAsync(array $args = [])
* @method \Aws\Result deleteAnalysisScheme(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAnalysisSchemeAsync(array $args = [])
* @method \Aws\Result deleteDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDomainAsync(array $args = [])
* @method \Aws\Result deleteExpression(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteExpressionAsync(array $args = [])
* @method \Aws\Result deleteIndexField(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIndexFieldAsync(array $args = [])
* @method \Aws\Result deleteSuggester(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSuggesterAsync(array $args = [])
* @method \Aws\Result describeAnalysisSchemes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAnalysisSchemesAsync(array $args = [])
* @method \Aws\Result describeAvailabilityOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAvailabilityOptionsAsync(array $args = [])
* @method \Aws\Result describeDomains(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDomainsAsync(array $args = [])
* @method \Aws\Result describeExpressions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeExpressionsAsync(array $args = [])
* @method \Aws\Result describeIndexFields(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeIndexFieldsAsync(array $args = [])
* @method \Aws\Result describeScalingParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScalingParametersAsync(array $args = [])
* @method \Aws\Result describeServiceAccessPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeServiceAccessPoliciesAsync(array $args = [])
* @method \Aws\Result describeSuggesters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSuggestersAsync(array $args = [])
* @method \Aws\Result indexDocuments(array $args = [])
* @method \GuzzleHttp\Promise\Promise indexDocumentsAsync(array $args = [])
* @method \Aws\Result listDomainNames(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDomainNamesAsync(array $args = [])
* @method \Aws\Result updateAvailabilityOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAvailabilityOptionsAsync(array $args = [])
* @method \Aws\Result updateScalingParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateScalingParametersAsync(array $args = [])
* @method \Aws\Result updateServiceAccessPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateServiceAccessPoliciesAsync(array $args = [])
*/
class CloudSearchClient extends \Aws\AwsClient
{
}
}
namespace Aws\CloudSearch\Exception {
/**
* Represents an error interacting with the Amazon CloudSearch service.
*/
class CloudSearchException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\SageMakerRuntime {
/**
* This client is used to interact with the **Amazon SageMaker Runtime** service.
* @method \Aws\Result invokeEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise invokeEndpointAsync(array $args = [])
*/
class SageMakerRuntimeClient extends \Aws\AwsClient
{
}
}
namespace Aws\SageMakerRuntime\Exception {
/**
* Represents an error interacting with the **Amazon SageMaker Runtime** service.
*/
class SageMakerRuntimeException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Athena {
/**
* This client is used to interact with the **Amazon Athena** service.
* @method \Aws\Result batchGetNamedQuery(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetNamedQueryAsync(array $args = [])
* @method \Aws\Result batchGetQueryExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetQueryExecutionAsync(array $args = [])
* @method \Aws\Result createNamedQuery(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNamedQueryAsync(array $args = [])
* @method \Aws\Result deleteNamedQuery(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNamedQueryAsync(array $args = [])
* @method \Aws\Result getNamedQuery(array $args = [])
* @method \GuzzleHttp\Promise\Promise getNamedQueryAsync(array $args = [])
* @method \Aws\Result getQueryExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise getQueryExecutionAsync(array $args = [])
* @method \Aws\Result getQueryResults(array $args = [])
* @method \GuzzleHttp\Promise\Promise getQueryResultsAsync(array $args = [])
* @method \Aws\Result listNamedQueries(array $args = [])
* @method \GuzzleHttp\Promise\Promise listNamedQueriesAsync(array $args = [])
* @method \Aws\Result listQueryExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listQueryExecutionsAsync(array $args = [])
* @method \Aws\Result startQueryExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise startQueryExecutionAsync(array $args = [])
* @method \Aws\Result stopQueryExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopQueryExecutionAsync(array $args = [])
*/
class AthenaClient extends \Aws\AwsClient
{
}
}
namespace Aws\Athena\Exception {
/**
* Represents an error interacting with the **Amazon Athena** service.
*/
class AthenaException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudFront {
class CookieSigner
{
/**
* @param $keyPairId string ID of the key pair
* @param $privateKey string Path to the private key used for signing
*
* @throws \RuntimeException if the openssl extension is missing
* @throws \InvalidArgumentException if the private key cannot be found.
*/
public function __construct($keyPairId, $privateKey)
{
}
/**
* Create a signed Amazon CloudFront Cookie.
*
* @param string $url URL to sign (can include query string
* and wildcards). Not required
* when passing a custom $policy.
* @param string|integer|null $expires UTC Unix timestamp used when signing
* with a canned policy. Not required
* when passing a custom $policy.
* @param string $policy JSON policy. Use this option when
* creating a signed cookie for a custom
* policy.
*
* @return array The authenticated cookie parameters
* @throws \InvalidArgumentException if the URL provided is invalid
* @link http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-signed-cookies.html
*/
public function getSignedCookie($url = null, $expires = null, $policy = null)
{
}
}
/**
* @internal
*/
class Signer
{
/**
* A signer for creating the signature values used in CloudFront signed URLs
* and signed cookies.
*
* @param $keyPairId string ID of the key pair
* @param $privateKey string Path to the private key used for signing
*
* @throws \RuntimeException if the openssl extension is missing
* @throws \InvalidArgumentException if the private key cannot be found.
*/
public function __construct($keyPairId, $privateKey)
{
}
/**
* Create the values used to construct signed URLs and cookies.
*
* @param string $resource The CloudFront resource to which
* this signature will grant access.
* Not used when a custom policy is
* provided.
* @param string|integer|null $expires UTC Unix timestamp used when
* signing with a canned policy.
* Not required when passing a
* custom $policy.
* @param string $policy JSON policy. Use this option when
* creating a signature for a custom
* policy.
*
* @return array The values needed to construct a signed URL or cookie
* @throws \InvalidArgumentException when not provided either a policy or a
* resource and a expires
*
* @link http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/private-content-signed-cookies.html
*/
public function getSignature($resource = null, $expires = null, $policy = null)
{
}
}
/**
* Creates signed URLs for Amazon CloudFront resources.
*/
class UrlSigner
{
/**
* @param $keyPairId string ID of the key pair
* @param $privateKey string Path to the private key used for signing
*
* @throws \RuntimeException if the openssl extension is missing
* @throws \InvalidArgumentException if the private key cannot be found.
*/
public function __construct($keyPairId, $privateKey)
{
}
/**
* Create a signed Amazon CloudFront URL.
*
* Keep in mind that URLs meant for use in media/flash players may have
* different requirements for URL formats (e.g. some require that the
* extension be removed, some require the file name to be prefixed
* - mp4:<path>, some require you to add "/cfx/st" into your URL).
*
* @param string $url URL to sign (can include query
* string string and wildcards)
* @param string|integer|null $expires UTC Unix timestamp used when signing
* with a canned policy. Not required
* when passing a custom $policy.
* @param string $policy JSON policy. Use this option when
* creating a signed URL for a custom
* policy.
*
* @return string The file URL with authentication parameters
* @throws \InvalidArgumentException if the URL provided is invalid
* @link http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/WorkingWithStreamingDistributions.html
*/
public function getSignedUrl($url, $expires = null, $policy = null)
{
}
}
}
namespace Aws\CloudFront\Exception {
/**
* Represents an error interacting with the Amazon CloudFront service.
*/
class CloudFrontException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudFront {
/**
* This client is used to interact with the **Amazon CloudFront** service.
*
* @method \Aws\Result createCloudFrontOriginAccessIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCloudFrontOriginAccessIdentityAsync(array $args = [])
* @method \Aws\Result createDistribution(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDistributionAsync(array $args = [])
* @method \Aws\Result createInvalidation(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInvalidationAsync(array $args = [])
* @method \Aws\Result createStreamingDistribution(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStreamingDistributionAsync(array $args = [])
* @method \Aws\Result deleteCloudFrontOriginAccessIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCloudFrontOriginAccessIdentityAsync(array $args = [])
* @method \Aws\Result deleteDistribution(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDistributionAsync(array $args = [])
* @method \Aws\Result deleteStreamingDistribution(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStreamingDistributionAsync(array $args = [])
* @method \Aws\Result getCloudFrontOriginAccessIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCloudFrontOriginAccessIdentityAsync(array $args = [])
* @method \Aws\Result getCloudFrontOriginAccessIdentityConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCloudFrontOriginAccessIdentityConfigAsync(array $args = [])
* @method \Aws\Result getDistribution(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDistributionAsync(array $args = [])
* @method \Aws\Result getDistributionConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDistributionConfigAsync(array $args = [])
* @method \Aws\Result getInvalidation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInvalidationAsync(array $args = [])
* @method \Aws\Result getStreamingDistribution(array $args = [])
* @method \GuzzleHttp\Promise\Promise getStreamingDistributionAsync(array $args = [])
* @method \Aws\Result getStreamingDistributionConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise getStreamingDistributionConfigAsync(array $args = [])
* @method \Aws\Result listCloudFrontOriginAccessIdentities(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCloudFrontOriginAccessIdentitiesAsync(array $args = [])
* @method \Aws\Result listDistributions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDistributionsAsync(array $args = [])
* @method \Aws\Result listDistributionsByWebACLId(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDistributionsByWebACLIdAsync(array $args = [])
* @method \Aws\Result listInvalidations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInvalidationsAsync(array $args = [])
* @method \Aws\Result listStreamingDistributions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStreamingDistributionsAsync(array $args = [])
* @method \Aws\Result updateCloudFrontOriginAccessIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCloudFrontOriginAccessIdentityAsync(array $args = [])
* @method \Aws\Result updateDistribution(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDistributionAsync(array $args = [])
* @method \Aws\Result updateStreamingDistribution(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateStreamingDistributionAsync(array $args = [])
* @method \Aws\Result createDistributionWithTags(array $args = []) (supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise createDistributionWithTagsAsync(array $args = []) (supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18)
* @method \Aws\Result createStreamingDistributionWithTags(array $args = []) (supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise createStreamingDistributionWithTagsAsync(array $args = []) (supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18)
* @method \Aws\Result listTagsForResource(array $args = []) (supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = []) (supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18)
* @method \Aws\Result tagResource(array $args = []) (supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = []) (supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18)
* @method \Aws\Result untagResource(array $args = []) (supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = []) (supported in versions 2016-08-01, 2016-08-20, 2016-09-07, 2016-09-29, 2016-11-25, 2017-03-25, 2017-10-30, 2018-06-18)
* @method \Aws\Result deleteServiceLinkedRole(array $args = []) (supported in versions 2017-03-25)
* @method \GuzzleHttp\Promise\Promise deleteServiceLinkedRoleAsync(array $args = []) (supported in versions 2017-03-25)
* @method \Aws\Result createFieldLevelEncryptionConfig(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise createFieldLevelEncryptionConfigAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result createFieldLevelEncryptionProfile(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise createFieldLevelEncryptionProfileAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result createPublicKey(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise createPublicKeyAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result deleteFieldLevelEncryptionConfig(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise deleteFieldLevelEncryptionConfigAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result deleteFieldLevelEncryptionProfile(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise deleteFieldLevelEncryptionProfileAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result deletePublicKey(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise deletePublicKeyAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result getFieldLevelEncryption(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise getFieldLevelEncryptionAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result getFieldLevelEncryptionConfig(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise getFieldLevelEncryptionConfigAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result getFieldLevelEncryptionProfile(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise getFieldLevelEncryptionProfileAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result getFieldLevelEncryptionProfileConfig(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise getFieldLevelEncryptionProfileConfigAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result getPublicKey(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise getPublicKeyAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result getPublicKeyConfig(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise getPublicKeyConfigAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result listFieldLevelEncryptionConfigs(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise listFieldLevelEncryptionConfigsAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result listFieldLevelEncryptionProfiles(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise listFieldLevelEncryptionProfilesAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result listPublicKeys(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise listPublicKeysAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result updateFieldLevelEncryptionConfig(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise updateFieldLevelEncryptionConfigAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result updateFieldLevelEncryptionProfile(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise updateFieldLevelEncryptionProfileAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \Aws\Result updatePublicKey(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
* @method \GuzzleHttp\Promise\Promise updatePublicKeyAsync(array $args = []) (supported in versions 2017-10-30, 2018-06-18)
*/
class CloudFrontClient extends \Aws\AwsClient
{
/**
* Create a signed Amazon CloudFront URL.
*
* This method accepts an array of configuration options:
*
* - url: (string) URL of the resource being signed (can include query
* string and wildcards). For example: rtmp://s5c39gqb8ow64r.cloudfront.net/videos/mp3_name.mp3
* http://d111111abcdef8.cloudfront.net/images/horizon.jpg?size=large&license=yes
* - policy: (string) JSON policy. Use this option when creating a signed
* URL for a custom policy.
* - expires: (int) UTC Unix timestamp used when signing with a canned
* policy. Not required when passing a custom 'policy' option.
* - key_pair_id: (string) The ID of the key pair used to sign CloudFront
* URLs for private distributions.
* - private_key: (string) The filepath ot the private key used to sign
* CloudFront URLs for private distributions.
*
* @param array $options Array of configuration options used when signing
*
* @return string Signed URL with authentication parameters
* @throws \InvalidArgumentException if url, key_pair_id, or private_key
* were not specified.
* @link http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/WorkingWithStreamingDistributions.html
*/
public function getSignedUrl(array $options)
{
}
/**
* Create a signed Amazon CloudFront cookie.
*
* This method accepts an array of configuration options:
*
* - url: (string) URL of the resource being signed (can include query
* string and wildcards). For example: http://d111111abcdef8.cloudfront.net/images/horizon.jpg?size=large&license=yes
* - policy: (string) JSON policy. Use this option when creating a signed
* URL for a custom policy.
* - expires: (int) UTC Unix timestamp used when signing with a canned
* policy. Not required when passing a custom 'policy' option.
* - key_pair_id: (string) The ID of the key pair used to sign CloudFront
* URLs for private distributions.
* - private_key: (string) The filepath ot the private key used to sign
* CloudFront URLs for private distributions.
*
* @param array $options Array of configuration options used when signing
*
* @return array Key => value pairs of signed cookies to set
* @throws \InvalidArgumentException if url, key_pair_id, or private_key
* were not specified.
* @link http://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/WorkingWithStreamingDistributions.html
*/
public function getSignedCookie(array $options)
{
}
}
}
namespace Aws\Translate {
/**
* This client is used to interact with the **Amazon Translate** service.
* @method \Aws\Result translateText(array $args = [])
* @method \GuzzleHttp\Promise\Promise translateTextAsync(array $args = [])
*/
class TranslateClient extends \Aws\AwsClient
{
}
}
namespace Aws\Translate\Exception {
/**
* Represents an error interacting with the **Amazon Translate** service.
*/
class TranslateException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Inspector {
/**
* This client is used to interact with the **Amazon Inspector** service.
*
* @method \Aws\Result addAttributesToFindings(array $args = [])
* @method \GuzzleHttp\Promise\Promise addAttributesToFindingsAsync(array $args = [])
* @method \Aws\Result createAssessmentTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAssessmentTargetAsync(array $args = [])
* @method \Aws\Result createAssessmentTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAssessmentTemplateAsync(array $args = [])
* @method \Aws\Result createExclusionsPreview(array $args = [])
* @method \GuzzleHttp\Promise\Promise createExclusionsPreviewAsync(array $args = [])
* @method \Aws\Result createResourceGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createResourceGroupAsync(array $args = [])
* @method \Aws\Result deleteAssessmentRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAssessmentRunAsync(array $args = [])
* @method \Aws\Result deleteAssessmentTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAssessmentTargetAsync(array $args = [])
* @method \Aws\Result deleteAssessmentTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAssessmentTemplateAsync(array $args = [])
* @method \Aws\Result describeAssessmentRuns(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAssessmentRunsAsync(array $args = [])
* @method \Aws\Result describeAssessmentTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAssessmentTargetsAsync(array $args = [])
* @method \Aws\Result describeAssessmentTemplates(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAssessmentTemplatesAsync(array $args = [])
* @method \Aws\Result describeCrossAccountAccessRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCrossAccountAccessRoleAsync(array $args = [])
* @method \Aws\Result describeExclusions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeExclusionsAsync(array $args = [])
* @method \Aws\Result describeFindings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeFindingsAsync(array $args = [])
* @method \Aws\Result describeResourceGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeResourceGroupsAsync(array $args = [])
* @method \Aws\Result describeRulesPackages(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRulesPackagesAsync(array $args = [])
* @method \Aws\Result getAssessmentReport(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAssessmentReportAsync(array $args = [])
* @method \Aws\Result getExclusionsPreview(array $args = [])
* @method \GuzzleHttp\Promise\Promise getExclusionsPreviewAsync(array $args = [])
* @method \Aws\Result getTelemetryMetadata(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTelemetryMetadataAsync(array $args = [])
* @method \Aws\Result listAssessmentRunAgents(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAssessmentRunAgentsAsync(array $args = [])
* @method \Aws\Result listAssessmentRuns(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAssessmentRunsAsync(array $args = [])
* @method \Aws\Result listAssessmentTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAssessmentTargetsAsync(array $args = [])
* @method \Aws\Result listAssessmentTemplates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAssessmentTemplatesAsync(array $args = [])
* @method \Aws\Result listEventSubscriptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listEventSubscriptionsAsync(array $args = [])
* @method \Aws\Result listExclusions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listExclusionsAsync(array $args = [])
* @method \Aws\Result listFindings(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFindingsAsync(array $args = [])
* @method \Aws\Result listRulesPackages(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRulesPackagesAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result previewAgents(array $args = [])
* @method \GuzzleHttp\Promise\Promise previewAgentsAsync(array $args = [])
* @method \Aws\Result registerCrossAccountAccessRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerCrossAccountAccessRoleAsync(array $args = [])
* @method \Aws\Result removeAttributesFromFindings(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeAttributesFromFindingsAsync(array $args = [])
* @method \Aws\Result setTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise setTagsForResourceAsync(array $args = [])
* @method \Aws\Result startAssessmentRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise startAssessmentRunAsync(array $args = [])
* @method \Aws\Result stopAssessmentRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopAssessmentRunAsync(array $args = [])
* @method \Aws\Result subscribeToEvent(array $args = [])
* @method \GuzzleHttp\Promise\Promise subscribeToEventAsync(array $args = [])
* @method \Aws\Result unsubscribeFromEvent(array $args = [])
* @method \GuzzleHttp\Promise\Promise unsubscribeFromEventAsync(array $args = [])
* @method \Aws\Result updateAssessmentTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAssessmentTargetAsync(array $args = [])
*/
class InspectorClient extends \Aws\AwsClient
{
}
}
namespace Aws\Inspector\Exception {
/**
* Represents an error interacting with the **Amazon Inspector** service.
*/
class InspectorException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Iot {
/**
* This client is used to interact with the **AWS IoT** service.
*
* @method \Aws\Result acceptCertificateTransfer(array $args = [])
* @method \GuzzleHttp\Promise\Promise acceptCertificateTransferAsync(array $args = [])
* @method \Aws\Result addThingToThingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise addThingToThingGroupAsync(array $args = [])
* @method \Aws\Result associateTargetsWithJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateTargetsWithJobAsync(array $args = [])
* @method \Aws\Result attachPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachPolicyAsync(array $args = [])
* @method \Aws\Result attachPrincipalPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachPrincipalPolicyAsync(array $args = [])
* @method \Aws\Result attachSecurityProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachSecurityProfileAsync(array $args = [])
* @method \Aws\Result attachThingPrincipal(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachThingPrincipalAsync(array $args = [])
* @method \Aws\Result cancelAuditTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelAuditTaskAsync(array $args = [])
* @method \Aws\Result cancelCertificateTransfer(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelCertificateTransferAsync(array $args = [])
* @method \Aws\Result cancelJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelJobAsync(array $args = [])
* @method \Aws\Result cancelJobExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelJobExecutionAsync(array $args = [])
* @method \Aws\Result clearDefaultAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise clearDefaultAuthorizerAsync(array $args = [])
* @method \Aws\Result createAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAuthorizerAsync(array $args = [])
* @method \Aws\Result createCertificateFromCsr(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCertificateFromCsrAsync(array $args = [])
* @method \Aws\Result createJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createJobAsync(array $args = [])
* @method \Aws\Result createKeysAndCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise createKeysAndCertificateAsync(array $args = [])
* @method \Aws\Result createOTAUpdate(array $args = [])
* @method \GuzzleHttp\Promise\Promise createOTAUpdateAsync(array $args = [])
* @method \Aws\Result createPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPolicyAsync(array $args = [])
* @method \Aws\Result createPolicyVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPolicyVersionAsync(array $args = [])
* @method \Aws\Result createRoleAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRoleAliasAsync(array $args = [])
* @method \Aws\Result createScheduledAudit(array $args = [])
* @method \GuzzleHttp\Promise\Promise createScheduledAuditAsync(array $args = [])
* @method \Aws\Result createSecurityProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSecurityProfileAsync(array $args = [])
* @method \Aws\Result createStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStreamAsync(array $args = [])
* @method \Aws\Result createThing(array $args = [])
* @method \GuzzleHttp\Promise\Promise createThingAsync(array $args = [])
* @method \Aws\Result createThingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createThingGroupAsync(array $args = [])
* @method \Aws\Result createThingType(array $args = [])
* @method \GuzzleHttp\Promise\Promise createThingTypeAsync(array $args = [])
* @method \Aws\Result createTopicRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTopicRuleAsync(array $args = [])
* @method \Aws\Result deleteAccountAuditConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAccountAuditConfigurationAsync(array $args = [])
* @method \Aws\Result deleteAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAuthorizerAsync(array $args = [])
* @method \Aws\Result deleteCACertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCACertificateAsync(array $args = [])
* @method \Aws\Result deleteCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCertificateAsync(array $args = [])
* @method \Aws\Result deleteJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteJobAsync(array $args = [])
* @method \Aws\Result deleteJobExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteJobExecutionAsync(array $args = [])
* @method \Aws\Result deleteOTAUpdate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteOTAUpdateAsync(array $args = [])
* @method \Aws\Result deletePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePolicyAsync(array $args = [])
* @method \Aws\Result deletePolicyVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePolicyVersionAsync(array $args = [])
* @method \Aws\Result deleteRegistrationCode(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRegistrationCodeAsync(array $args = [])
* @method \Aws\Result deleteRoleAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRoleAliasAsync(array $args = [])
* @method \Aws\Result deleteScheduledAudit(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteScheduledAuditAsync(array $args = [])
* @method \Aws\Result deleteSecurityProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSecurityProfileAsync(array $args = [])
* @method \Aws\Result deleteStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStreamAsync(array $args = [])
* @method \Aws\Result deleteThing(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteThingAsync(array $args = [])
* @method \Aws\Result deleteThingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteThingGroupAsync(array $args = [])
* @method \Aws\Result deleteThingType(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteThingTypeAsync(array $args = [])
* @method \Aws\Result deleteTopicRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTopicRuleAsync(array $args = [])
* @method \Aws\Result deleteV2LoggingLevel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteV2LoggingLevelAsync(array $args = [])
* @method \Aws\Result deprecateThingType(array $args = [])
* @method \GuzzleHttp\Promise\Promise deprecateThingTypeAsync(array $args = [])
* @method \Aws\Result describeAccountAuditConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAccountAuditConfigurationAsync(array $args = [])
* @method \Aws\Result describeAuditTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAuditTaskAsync(array $args = [])
* @method \Aws\Result describeAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAuthorizerAsync(array $args = [])
* @method \Aws\Result describeCACertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCACertificateAsync(array $args = [])
* @method \Aws\Result describeCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCertificateAsync(array $args = [])
* @method \Aws\Result describeDefaultAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDefaultAuthorizerAsync(array $args = [])
* @method \Aws\Result describeEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEndpointAsync(array $args = [])
* @method \Aws\Result describeEventConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventConfigurationsAsync(array $args = [])
* @method \Aws\Result describeIndex(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeIndexAsync(array $args = [])
* @method \Aws\Result describeJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeJobAsync(array $args = [])
* @method \Aws\Result describeJobExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeJobExecutionAsync(array $args = [])
* @method \Aws\Result describeRoleAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRoleAliasAsync(array $args = [])
* @method \Aws\Result describeScheduledAudit(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScheduledAuditAsync(array $args = [])
* @method \Aws\Result describeSecurityProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSecurityProfileAsync(array $args = [])
* @method \Aws\Result describeStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStreamAsync(array $args = [])
* @method \Aws\Result describeThing(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeThingAsync(array $args = [])
* @method \Aws\Result describeThingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeThingGroupAsync(array $args = [])
* @method \Aws\Result describeThingRegistrationTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeThingRegistrationTaskAsync(array $args = [])
* @method \Aws\Result describeThingType(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeThingTypeAsync(array $args = [])
* @method \Aws\Result detachPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachPolicyAsync(array $args = [])
* @method \Aws\Result detachPrincipalPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachPrincipalPolicyAsync(array $args = [])
* @method \Aws\Result detachSecurityProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachSecurityProfileAsync(array $args = [])
* @method \Aws\Result detachThingPrincipal(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachThingPrincipalAsync(array $args = [])
* @method \Aws\Result disableTopicRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableTopicRuleAsync(array $args = [])
* @method \Aws\Result enableTopicRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableTopicRuleAsync(array $args = [])
* @method \Aws\Result getEffectivePolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise getEffectivePoliciesAsync(array $args = [])
* @method \Aws\Result getIndexingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIndexingConfigurationAsync(array $args = [])
* @method \Aws\Result getJobDocument(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobDocumentAsync(array $args = [])
* @method \Aws\Result getLoggingOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLoggingOptionsAsync(array $args = [])
* @method \Aws\Result getOTAUpdate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOTAUpdateAsync(array $args = [])
* @method \Aws\Result getPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPolicyAsync(array $args = [])
* @method \Aws\Result getPolicyVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPolicyVersionAsync(array $args = [])
* @method \Aws\Result getRegistrationCode(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRegistrationCodeAsync(array $args = [])
* @method \Aws\Result getTopicRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTopicRuleAsync(array $args = [])
* @method \Aws\Result getV2LoggingOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getV2LoggingOptionsAsync(array $args = [])
* @method \Aws\Result listActiveViolations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listActiveViolationsAsync(array $args = [])
* @method \Aws\Result listAttachedPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAttachedPoliciesAsync(array $args = [])
* @method \Aws\Result listAuditFindings(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAuditFindingsAsync(array $args = [])
* @method \Aws\Result listAuditTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAuditTasksAsync(array $args = [])
* @method \Aws\Result listAuthorizers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAuthorizersAsync(array $args = [])
* @method \Aws\Result listCACertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCACertificatesAsync(array $args = [])
* @method \Aws\Result listCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCertificatesAsync(array $args = [])
* @method \Aws\Result listCertificatesByCA(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCertificatesByCAAsync(array $args = [])
* @method \Aws\Result listIndices(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIndicesAsync(array $args = [])
* @method \Aws\Result listJobExecutionsForJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobExecutionsForJobAsync(array $args = [])
* @method \Aws\Result listJobExecutionsForThing(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobExecutionsForThingAsync(array $args = [])
* @method \Aws\Result listJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobsAsync(array $args = [])
* @method \Aws\Result listOTAUpdates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOTAUpdatesAsync(array $args = [])
* @method \Aws\Result listOutgoingCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOutgoingCertificatesAsync(array $args = [])
* @method \Aws\Result listPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPoliciesAsync(array $args = [])
* @method \Aws\Result listPolicyPrincipals(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPolicyPrincipalsAsync(array $args = [])
* @method \Aws\Result listPolicyVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPolicyVersionsAsync(array $args = [])
* @method \Aws\Result listPrincipalPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPrincipalPoliciesAsync(array $args = [])
* @method \Aws\Result listPrincipalThings(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPrincipalThingsAsync(array $args = [])
* @method \Aws\Result listRoleAliases(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRoleAliasesAsync(array $args = [])
* @method \Aws\Result listScheduledAudits(array $args = [])
* @method \GuzzleHttp\Promise\Promise listScheduledAuditsAsync(array $args = [])
* @method \Aws\Result listSecurityProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSecurityProfilesAsync(array $args = [])
* @method \Aws\Result listSecurityProfilesForTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSecurityProfilesForTargetAsync(array $args = [])
* @method \Aws\Result listStreams(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStreamsAsync(array $args = [])
* @method \Aws\Result listTargetsForPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTargetsForPolicyAsync(array $args = [])
* @method \Aws\Result listTargetsForSecurityProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTargetsForSecurityProfileAsync(array $args = [])
* @method \Aws\Result listThingGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listThingGroupsAsync(array $args = [])
* @method \Aws\Result listThingGroupsForThing(array $args = [])
* @method \GuzzleHttp\Promise\Promise listThingGroupsForThingAsync(array $args = [])
* @method \Aws\Result listThingPrincipals(array $args = [])
* @method \GuzzleHttp\Promise\Promise listThingPrincipalsAsync(array $args = [])
* @method \Aws\Result listThingRegistrationTaskReports(array $args = [])
* @method \GuzzleHttp\Promise\Promise listThingRegistrationTaskReportsAsync(array $args = [])
* @method \Aws\Result listThingRegistrationTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listThingRegistrationTasksAsync(array $args = [])
* @method \Aws\Result listThingTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listThingTypesAsync(array $args = [])
* @method \Aws\Result listThings(array $args = [])
* @method \GuzzleHttp\Promise\Promise listThingsAsync(array $args = [])
* @method \Aws\Result listThingsInThingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise listThingsInThingGroupAsync(array $args = [])
* @method \Aws\Result listTopicRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTopicRulesAsync(array $args = [])
* @method \Aws\Result listV2LoggingLevels(array $args = [])
* @method \GuzzleHttp\Promise\Promise listV2LoggingLevelsAsync(array $args = [])
* @method \Aws\Result listViolationEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise listViolationEventsAsync(array $args = [])
* @method \Aws\Result registerCACertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerCACertificateAsync(array $args = [])
* @method \Aws\Result registerCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerCertificateAsync(array $args = [])
* @method \Aws\Result registerThing(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerThingAsync(array $args = [])
* @method \Aws\Result rejectCertificateTransfer(array $args = [])
* @method \GuzzleHttp\Promise\Promise rejectCertificateTransferAsync(array $args = [])
* @method \Aws\Result removeThingFromThingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeThingFromThingGroupAsync(array $args = [])
* @method \Aws\Result replaceTopicRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise replaceTopicRuleAsync(array $args = [])
* @method \Aws\Result searchIndex(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchIndexAsync(array $args = [])
* @method \Aws\Result setDefaultAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise setDefaultAuthorizerAsync(array $args = [])
* @method \Aws\Result setDefaultPolicyVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise setDefaultPolicyVersionAsync(array $args = [])
* @method \Aws\Result setLoggingOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise setLoggingOptionsAsync(array $args = [])
* @method \Aws\Result setV2LoggingLevel(array $args = [])
* @method \GuzzleHttp\Promise\Promise setV2LoggingLevelAsync(array $args = [])
* @method \Aws\Result setV2LoggingOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise setV2LoggingOptionsAsync(array $args = [])
* @method \Aws\Result startOnDemandAuditTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise startOnDemandAuditTaskAsync(array $args = [])
* @method \Aws\Result startThingRegistrationTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise startThingRegistrationTaskAsync(array $args = [])
* @method \Aws\Result stopThingRegistrationTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopThingRegistrationTaskAsync(array $args = [])
* @method \Aws\Result testAuthorization(array $args = [])
* @method \GuzzleHttp\Promise\Promise testAuthorizationAsync(array $args = [])
* @method \Aws\Result testInvokeAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise testInvokeAuthorizerAsync(array $args = [])
* @method \Aws\Result transferCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise transferCertificateAsync(array $args = [])
* @method \Aws\Result updateAccountAuditConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAccountAuditConfigurationAsync(array $args = [])
* @method \Aws\Result updateAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAuthorizerAsync(array $args = [])
* @method \Aws\Result updateCACertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCACertificateAsync(array $args = [])
* @method \Aws\Result updateCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCertificateAsync(array $args = [])
* @method \Aws\Result updateEventConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEventConfigurationsAsync(array $args = [])
* @method \Aws\Result updateIndexingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateIndexingConfigurationAsync(array $args = [])
* @method \Aws\Result updateRoleAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRoleAliasAsync(array $args = [])
* @method \Aws\Result updateScheduledAudit(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateScheduledAuditAsync(array $args = [])
* @method \Aws\Result updateSecurityProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSecurityProfileAsync(array $args = [])
* @method \Aws\Result updateStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateStreamAsync(array $args = [])
* @method \Aws\Result updateThing(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateThingAsync(array $args = [])
* @method \Aws\Result updateThingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateThingGroupAsync(array $args = [])
* @method \Aws\Result updateThingGroupsForThing(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateThingGroupsForThingAsync(array $args = [])
* @method \Aws\Result validateSecurityProfileBehaviors(array $args = [])
* @method \GuzzleHttp\Promise\Promise validateSecurityProfileBehaviorsAsync(array $args = [])
*/
class IotClient extends \Aws\AwsClient
{
}
}
namespace Aws\Iot\Exception {
/**
* Represents an error interacting with the **AWS IoT** service.
*/
class IotException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Acm {
/**
* This client is used to interact with the **AWS Certificate Manager** service.
*
* @method \Aws\Result addTagsToCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToCertificateAsync(array $args = [])
* @method \Aws\Result deleteCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCertificateAsync(array $args = [])
* @method \Aws\Result describeCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCertificateAsync(array $args = [])
* @method \Aws\Result exportCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise exportCertificateAsync(array $args = [])
* @method \Aws\Result getCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCertificateAsync(array $args = [])
* @method \Aws\Result importCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise importCertificateAsync(array $args = [])
* @method \Aws\Result listCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCertificatesAsync(array $args = [])
* @method \Aws\Result listTagsForCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForCertificateAsync(array $args = [])
* @method \Aws\Result removeTagsFromCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromCertificateAsync(array $args = [])
* @method \Aws\Result requestCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise requestCertificateAsync(array $args = [])
* @method \Aws\Result resendValidationEmail(array $args = [])
* @method \GuzzleHttp\Promise\Promise resendValidationEmailAsync(array $args = [])
* @method \Aws\Result updateCertificateOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCertificateOptionsAsync(array $args = [])
*/
class AcmClient extends \Aws\AwsClient
{
}
}
namespace Aws\Acm\Exception {
/**
* Represents an error interacting with the **AWS Certificate Manager** service.
*/
class AcmException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\KinesisAnalytics {
/**
* This client is used to interact with the **Amazon Kinesis Analytics** service.
* @method \Aws\Result addApplicationCloudWatchLoggingOption(array $args = [])
* @method \GuzzleHttp\Promise\Promise addApplicationCloudWatchLoggingOptionAsync(array $args = [])
* @method \Aws\Result addApplicationInput(array $args = [])
* @method \GuzzleHttp\Promise\Promise addApplicationInputAsync(array $args = [])
* @method \Aws\Result addApplicationInputProcessingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise addApplicationInputProcessingConfigurationAsync(array $args = [])
* @method \Aws\Result addApplicationOutput(array $args = [])
* @method \GuzzleHttp\Promise\Promise addApplicationOutputAsync(array $args = [])
* @method \Aws\Result addApplicationReferenceDataSource(array $args = [])
* @method \GuzzleHttp\Promise\Promise addApplicationReferenceDataSourceAsync(array $args = [])
* @method \Aws\Result createApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise createApplicationAsync(array $args = [])
* @method \Aws\Result deleteApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApplicationAsync(array $args = [])
* @method \Aws\Result deleteApplicationCloudWatchLoggingOption(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApplicationCloudWatchLoggingOptionAsync(array $args = [])
* @method \Aws\Result deleteApplicationInputProcessingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApplicationInputProcessingConfigurationAsync(array $args = [])
* @method \Aws\Result deleteApplicationOutput(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApplicationOutputAsync(array $args = [])
* @method \Aws\Result deleteApplicationReferenceDataSource(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApplicationReferenceDataSourceAsync(array $args = [])
* @method \Aws\Result describeApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeApplicationAsync(array $args = [])
* @method \Aws\Result discoverInputSchema(array $args = [])
* @method \GuzzleHttp\Promise\Promise discoverInputSchemaAsync(array $args = [])
* @method \Aws\Result listApplications(array $args = [])
* @method \GuzzleHttp\Promise\Promise listApplicationsAsync(array $args = [])
* @method \Aws\Result startApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise startApplicationAsync(array $args = [])
* @method \Aws\Result stopApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopApplicationAsync(array $args = [])
* @method \Aws\Result updateApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApplicationAsync(array $args = [])
*/
class KinesisAnalyticsClient extends \Aws\AwsClient
{
}
}
namespace Aws\KinesisAnalytics\Exception {
/**
* Represents an error interacting with the **Amazon Kinesis Analytics** service.
*/
class KinesisAnalyticsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ElasticTranscoder\Exception {
/**
* Represents an error interacting with the Amazon Elastic Transcoder service.
*/
class ElasticTranscoderException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ElasticTranscoder {
/**
* This client is used to interact with the **Amazon Elastic Transcoder** service.
*
* @method \Aws\Result cancelJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelJobAsync(array $args = [])
* @method \Aws\Result createJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createJobAsync(array $args = [])
* @method \Aws\Result createPipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPipelineAsync(array $args = [])
* @method \Aws\Result createPreset(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPresetAsync(array $args = [])
* @method \Aws\Result deletePipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePipelineAsync(array $args = [])
* @method \Aws\Result deletePreset(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePresetAsync(array $args = [])
* @method \Aws\Result listJobsByPipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobsByPipelineAsync(array $args = [])
* @method \Aws\Result listJobsByStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobsByStatusAsync(array $args = [])
* @method \Aws\Result listPipelines(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPipelinesAsync(array $args = [])
* @method \Aws\Result listPresets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPresetsAsync(array $args = [])
* @method \Aws\Result readJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise readJobAsync(array $args = [])
* @method \Aws\Result readPipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise readPipelineAsync(array $args = [])
* @method \Aws\Result readPreset(array $args = [])
* @method \GuzzleHttp\Promise\Promise readPresetAsync(array $args = [])
* @method \Aws\Result testRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise testRoleAsync(array $args = [])
* @method \Aws\Result updatePipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePipelineAsync(array $args = [])
* @method \Aws\Result updatePipelineNotifications(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePipelineNotificationsAsync(array $args = [])
* @method \Aws\Result updatePipelineStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePipelineStatusAsync(array $args = [])
*/
class ElasticTranscoderClient extends \Aws\AwsClient
{
}
}
namespace Aws\LexRuntimeService {
/**
* This client is used to interact with the **Amazon Lex Runtime Service** service.
* @method \Aws\Result postContent(array $args = [])
* @method \GuzzleHttp\Promise\Promise postContentAsync(array $args = [])
* @method \Aws\Result postText(array $args = [])
* @method \GuzzleHttp\Promise\Promise postTextAsync(array $args = [])
*/
class LexRuntimeServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws\LexRuntimeService\Exception {
/**
* Represents an error interacting with the **Amazon Lex Runtime Service** service.
*/
class LexRuntimeServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\MediaStoreData {
/**
* This client is used to interact with the **AWS Elemental MediaStore Data Plane** service.
* @method \Aws\Result deleteObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteObjectAsync(array $args = [])
* @method \Aws\Result describeObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeObjectAsync(array $args = [])
* @method \Aws\Result getObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectAsync(array $args = [])
* @method \Aws\Result listItems(array $args = [])
* @method \GuzzleHttp\Promise\Promise listItemsAsync(array $args = [])
* @method \Aws\Result putObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise putObjectAsync(array $args = [])
*/
class MediaStoreDataClient extends \Aws\AwsClient
{
}
}
namespace Aws\MediaStoreData\Exception {
/**
* Represents an error interacting with the **AWS Elemental MediaStore Data Plane** service.
*/
class MediaStoreDataException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\DLM {
/**
* This client is used to interact with the **Amazon Data Lifecycle Manager** service.
* @method \Aws\Result createLifecyclePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLifecyclePolicyAsync(array $args = [])
* @method \Aws\Result deleteLifecyclePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLifecyclePolicyAsync(array $args = [])
* @method \Aws\Result getLifecyclePolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLifecyclePoliciesAsync(array $args = [])
* @method \Aws\Result getLifecyclePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLifecyclePolicyAsync(array $args = [])
* @method \Aws\Result updateLifecyclePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateLifecyclePolicyAsync(array $args = [])
*/
class DLMClient extends \Aws\AwsClient
{
}
}
namespace Aws\DLM\Exception {
/**
* Represents an error interacting with the **Amazon Data Lifecycle Manager** service.
*/
class DLMException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Iam {
/**
* This client is used to interact with the **AWS Identity and Access Management (AWS IAM)** service.
*
* @method \Aws\Result addClientIDToOpenIDConnectProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise addClientIDToOpenIDConnectProviderAsync(array $args = [])
* @method \Aws\Result addRoleToInstanceProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise addRoleToInstanceProfileAsync(array $args = [])
* @method \Aws\Result addUserToGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise addUserToGroupAsync(array $args = [])
* @method \Aws\Result attachGroupPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachGroupPolicyAsync(array $args = [])
* @method \Aws\Result attachRolePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachRolePolicyAsync(array $args = [])
* @method \Aws\Result attachUserPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachUserPolicyAsync(array $args = [])
* @method \Aws\Result changePassword(array $args = [])
* @method \GuzzleHttp\Promise\Promise changePasswordAsync(array $args = [])
* @method \Aws\Result createAccessKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAccessKeyAsync(array $args = [])
* @method \Aws\Result createAccountAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAccountAliasAsync(array $args = [])
* @method \Aws\Result createGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGroupAsync(array $args = [])
* @method \Aws\Result createInstanceProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInstanceProfileAsync(array $args = [])
* @method \Aws\Result createLoginProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLoginProfileAsync(array $args = [])
* @method \Aws\Result createOpenIDConnectProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise createOpenIDConnectProviderAsync(array $args = [])
* @method \Aws\Result createPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPolicyAsync(array $args = [])
* @method \Aws\Result createPolicyVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPolicyVersionAsync(array $args = [])
* @method \Aws\Result createRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRoleAsync(array $args = [])
* @method \Aws\Result createSAMLProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSAMLProviderAsync(array $args = [])
* @method \Aws\Result createServiceLinkedRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise createServiceLinkedRoleAsync(array $args = [])
* @method \Aws\Result createServiceSpecificCredential(array $args = [])
* @method \GuzzleHttp\Promise\Promise createServiceSpecificCredentialAsync(array $args = [])
* @method \Aws\Result createUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserAsync(array $args = [])
* @method \Aws\Result createVirtualMFADevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVirtualMFADeviceAsync(array $args = [])
* @method \Aws\Result deactivateMFADevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise deactivateMFADeviceAsync(array $args = [])
* @method \Aws\Result deleteAccessKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAccessKeyAsync(array $args = [])
* @method \Aws\Result deleteAccountAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAccountAliasAsync(array $args = [])
* @method \Aws\Result deleteAccountPasswordPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAccountPasswordPolicyAsync(array $args = [])
* @method \Aws\Result deleteGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGroupAsync(array $args = [])
* @method \Aws\Result deleteGroupPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGroupPolicyAsync(array $args = [])
* @method \Aws\Result deleteInstanceProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInstanceProfileAsync(array $args = [])
* @method \Aws\Result deleteLoginProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLoginProfileAsync(array $args = [])
* @method \Aws\Result deleteOpenIDConnectProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteOpenIDConnectProviderAsync(array $args = [])
* @method \Aws\Result deletePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePolicyAsync(array $args = [])
* @method \Aws\Result deletePolicyVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePolicyVersionAsync(array $args = [])
* @method \Aws\Result deleteRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRoleAsync(array $args = [])
* @method \Aws\Result deleteRolePermissionsBoundary(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRolePermissionsBoundaryAsync(array $args = [])
* @method \Aws\Result deleteRolePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRolePolicyAsync(array $args = [])
* @method \Aws\Result deleteSAMLProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSAMLProviderAsync(array $args = [])
* @method \Aws\Result deleteSSHPublicKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSSHPublicKeyAsync(array $args = [])
* @method \Aws\Result deleteServerCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteServerCertificateAsync(array $args = [])
* @method \Aws\Result deleteServiceLinkedRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteServiceLinkedRoleAsync(array $args = [])
* @method \Aws\Result deleteServiceSpecificCredential(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteServiceSpecificCredentialAsync(array $args = [])
* @method \Aws\Result deleteSigningCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSigningCertificateAsync(array $args = [])
* @method \Aws\Result deleteUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserAsync(array $args = [])
* @method \Aws\Result deleteUserPermissionsBoundary(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserPermissionsBoundaryAsync(array $args = [])
* @method \Aws\Result deleteUserPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserPolicyAsync(array $args = [])
* @method \Aws\Result deleteVirtualMFADevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVirtualMFADeviceAsync(array $args = [])
* @method \Aws\Result detachGroupPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachGroupPolicyAsync(array $args = [])
* @method \Aws\Result detachRolePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachRolePolicyAsync(array $args = [])
* @method \Aws\Result detachUserPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachUserPolicyAsync(array $args = [])
* @method \Aws\Result enableMFADevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableMFADeviceAsync(array $args = [])
* @method \Aws\Result generateCredentialReport(array $args = [])
* @method \GuzzleHttp\Promise\Promise generateCredentialReportAsync(array $args = [])
* @method \Aws\Result getAccessKeyLastUsed(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAccessKeyLastUsedAsync(array $args = [])
* @method \Aws\Result getAccountAuthorizationDetails(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAccountAuthorizationDetailsAsync(array $args = [])
* @method \Aws\Result getAccountPasswordPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAccountPasswordPolicyAsync(array $args = [])
* @method \Aws\Result getAccountSummary(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAccountSummaryAsync(array $args = [])
* @method \Aws\Result getContextKeysForCustomPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getContextKeysForCustomPolicyAsync(array $args = [])
* @method \Aws\Result getContextKeysForPrincipalPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getContextKeysForPrincipalPolicyAsync(array $args = [])
* @method \Aws\Result getCredentialReport(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCredentialReportAsync(array $args = [])
* @method \Aws\Result getGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGroupAsync(array $args = [])
* @method \Aws\Result getGroupPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGroupPolicyAsync(array $args = [])
* @method \Aws\Result getInstanceProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstanceProfileAsync(array $args = [])
* @method \Aws\Result getLoginProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLoginProfileAsync(array $args = [])
* @method \Aws\Result getOpenIDConnectProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOpenIDConnectProviderAsync(array $args = [])
* @method \Aws\Result getPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPolicyAsync(array $args = [])
* @method \Aws\Result getPolicyVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPolicyVersionAsync(array $args = [])
* @method \Aws\Result getRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRoleAsync(array $args = [])
* @method \Aws\Result getRolePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRolePolicyAsync(array $args = [])
* @method \Aws\Result getSAMLProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSAMLProviderAsync(array $args = [])
* @method \Aws\Result getSSHPublicKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSSHPublicKeyAsync(array $args = [])
* @method \Aws\Result getServerCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getServerCertificateAsync(array $args = [])
* @method \Aws\Result getServiceLinkedRoleDeletionStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getServiceLinkedRoleDeletionStatusAsync(array $args = [])
* @method \Aws\Result getUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUserAsync(array $args = [])
* @method \Aws\Result getUserPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUserPolicyAsync(array $args = [])
* @method \Aws\Result listAccessKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAccessKeysAsync(array $args = [])
* @method \Aws\Result listAccountAliases(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAccountAliasesAsync(array $args = [])
* @method \Aws\Result listAttachedGroupPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAttachedGroupPoliciesAsync(array $args = [])
* @method \Aws\Result listAttachedRolePolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAttachedRolePoliciesAsync(array $args = [])
* @method \Aws\Result listAttachedUserPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAttachedUserPoliciesAsync(array $args = [])
* @method \Aws\Result listEntitiesForPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise listEntitiesForPolicyAsync(array $args = [])
* @method \Aws\Result listGroupPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupPoliciesAsync(array $args = [])
* @method \Aws\Result listGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupsAsync(array $args = [])
* @method \Aws\Result listGroupsForUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupsForUserAsync(array $args = [])
* @method \Aws\Result listInstanceProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInstanceProfilesAsync(array $args = [])
* @method \Aws\Result listInstanceProfilesForRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInstanceProfilesForRoleAsync(array $args = [])
* @method \Aws\Result listMFADevices(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMFADevicesAsync(array $args = [])
* @method \Aws\Result listOpenIDConnectProviders(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOpenIDConnectProvidersAsync(array $args = [])
* @method \Aws\Result listPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPoliciesAsync(array $args = [])
* @method \Aws\Result listPolicyVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPolicyVersionsAsync(array $args = [])
* @method \Aws\Result listRolePolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRolePoliciesAsync(array $args = [])
* @method \Aws\Result listRoles(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRolesAsync(array $args = [])
* @method \Aws\Result listSAMLProviders(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSAMLProvidersAsync(array $args = [])
* @method \Aws\Result listSSHPublicKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSSHPublicKeysAsync(array $args = [])
* @method \Aws\Result listServerCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listServerCertificatesAsync(array $args = [])
* @method \Aws\Result listServiceSpecificCredentials(array $args = [])
* @method \GuzzleHttp\Promise\Promise listServiceSpecificCredentialsAsync(array $args = [])
* @method \Aws\Result listSigningCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSigningCertificatesAsync(array $args = [])
* @method \Aws\Result listUserPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUserPoliciesAsync(array $args = [])
* @method \Aws\Result listUsers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUsersAsync(array $args = [])
* @method \Aws\Result listVirtualMFADevices(array $args = [])
* @method \GuzzleHttp\Promise\Promise listVirtualMFADevicesAsync(array $args = [])
* @method \Aws\Result putGroupPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putGroupPolicyAsync(array $args = [])
* @method \Aws\Result putRolePermissionsBoundary(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRolePermissionsBoundaryAsync(array $args = [])
* @method \Aws\Result putRolePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRolePolicyAsync(array $args = [])
* @method \Aws\Result putUserPermissionsBoundary(array $args = [])
* @method \GuzzleHttp\Promise\Promise putUserPermissionsBoundaryAsync(array $args = [])
* @method \Aws\Result putUserPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putUserPolicyAsync(array $args = [])
* @method \Aws\Result removeClientIDFromOpenIDConnectProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeClientIDFromOpenIDConnectProviderAsync(array $args = [])
* @method \Aws\Result removeRoleFromInstanceProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeRoleFromInstanceProfileAsync(array $args = [])
* @method \Aws\Result removeUserFromGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeUserFromGroupAsync(array $args = [])
* @method \Aws\Result resetServiceSpecificCredential(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetServiceSpecificCredentialAsync(array $args = [])
* @method \Aws\Result resyncMFADevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise resyncMFADeviceAsync(array $args = [])
* @method \Aws\Result setDefaultPolicyVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise setDefaultPolicyVersionAsync(array $args = [])
* @method \Aws\Result simulateCustomPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise simulateCustomPolicyAsync(array $args = [])
* @method \Aws\Result simulatePrincipalPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise simulatePrincipalPolicyAsync(array $args = [])
* @method \Aws\Result updateAccessKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAccessKeyAsync(array $args = [])
* @method \Aws\Result updateAccountPasswordPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAccountPasswordPolicyAsync(array $args = [])
* @method \Aws\Result updateAssumeRolePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAssumeRolePolicyAsync(array $args = [])
* @method \Aws\Result updateGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGroupAsync(array $args = [])
* @method \Aws\Result updateLoginProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateLoginProfileAsync(array $args = [])
* @method \Aws\Result updateOpenIDConnectProviderThumbprint(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateOpenIDConnectProviderThumbprintAsync(array $args = [])
* @method \Aws\Result updateRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRoleAsync(array $args = [])
* @method \Aws\Result updateRoleDescription(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRoleDescriptionAsync(array $args = [])
* @method \Aws\Result updateSAMLProvider(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSAMLProviderAsync(array $args = [])
* @method \Aws\Result updateSSHPublicKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSSHPublicKeyAsync(array $args = [])
* @method \Aws\Result updateServerCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateServerCertificateAsync(array $args = [])
* @method \Aws\Result updateServiceSpecificCredential(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateServiceSpecificCredentialAsync(array $args = [])
* @method \Aws\Result updateSigningCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSigningCertificateAsync(array $args = [])
* @method \Aws\Result updateUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserAsync(array $args = [])
* @method \Aws\Result uploadSSHPublicKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadSSHPublicKeyAsync(array $args = [])
* @method \Aws\Result uploadServerCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadServerCertificateAsync(array $args = [])
* @method \Aws\Result uploadSigningCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadSigningCertificateAsync(array $args = [])
*/
class IamClient extends \Aws\AwsClient
{
}
}
namespace Aws\Iam\Exception {
/**
* Represents an error interacting with the AWS Identity and Access Management service.
*/
class IamException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ServiceDiscovery {
/**
* This client is used to interact with the **Amazon Route 53 Auto Naming** service.
* @method \Aws\Result createPrivateDnsNamespace(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPrivateDnsNamespaceAsync(array $args = [])
* @method \Aws\Result createPublicDnsNamespace(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPublicDnsNamespaceAsync(array $args = [])
* @method \Aws\Result createService(array $args = [])
* @method \GuzzleHttp\Promise\Promise createServiceAsync(array $args = [])
* @method \Aws\Result deleteNamespace(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNamespaceAsync(array $args = [])
* @method \Aws\Result deleteService(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteServiceAsync(array $args = [])
* @method \Aws\Result deregisterInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterInstanceAsync(array $args = [])
* @method \Aws\Result getInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstanceAsync(array $args = [])
* @method \Aws\Result getInstancesHealthStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstancesHealthStatusAsync(array $args = [])
* @method \Aws\Result getNamespace(array $args = [])
* @method \GuzzleHttp\Promise\Promise getNamespaceAsync(array $args = [])
* @method \Aws\Result getOperation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOperationAsync(array $args = [])
* @method \Aws\Result getService(array $args = [])
* @method \GuzzleHttp\Promise\Promise getServiceAsync(array $args = [])
* @method \Aws\Result listInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInstancesAsync(array $args = [])
* @method \Aws\Result listNamespaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise listNamespacesAsync(array $args = [])
* @method \Aws\Result listOperations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOperationsAsync(array $args = [])
* @method \Aws\Result listServices(array $args = [])
* @method \GuzzleHttp\Promise\Promise listServicesAsync(array $args = [])
* @method \Aws\Result registerInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerInstanceAsync(array $args = [])
* @method \Aws\Result updateInstanceCustomHealthStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateInstanceCustomHealthStatusAsync(array $args = [])
* @method \Aws\Result updateService(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateServiceAsync(array $args = [])
*/
class ServiceDiscoveryClient extends \Aws\AwsClient
{
}
}
namespace Aws\ServiceDiscovery\Exception {
/**
* Represents an error interacting with the **Amazon Route 53 Auto Naming** service.
*/
class ServiceDiscoveryException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Multipart {
/**
* Encapsulates the execution of a multipart upload to S3 or Glacier.
*
* @internal
*/
abstract class AbstractUploadManager implements \GuzzleHttp\Promise\PromisorInterface
{
const DEFAULT_CONCURRENCY = 5;
/** @var Client Client used for the upload. */
protected $client;
/** @var array Configuration used to perform the upload. */
protected $config;
/** @var array Service-specific information about the upload workflow. */
protected $info;
/** @var PromiseInterface Promise that represents the multipart upload. */
protected $promise;
/** @var UploadState State used to manage the upload. */
protected $state;
/**
* @param Client $client
* @param array $config
*/
public function __construct(\Aws\AwsClientInterface $client, array $config = [])
{
}
/**
* Returns the current state of the upload
*
* @return UploadState
*/
public function getState()
{
}
/**
* Upload the source using multipart upload operations.
*
* @return Result The result of the CompleteMultipartUpload operation.
* @throws \LogicException if the upload is already complete or aborted.
* @throws MultipartUploadException if an upload operation fails.
*/
public function upload()
{
}
/**
* Upload the source asynchronously using multipart upload operations.
*
* @return PromiseInterface
*/
public function promise()
{
}
protected function getConfig()
{
}
/**
* Provides service-specific information about the multipart upload
* workflow.
*
* This array of data should include the keys: 'command', 'id', and 'part_num'.
*
* @return array
*/
protected abstract function loadUploadWorkflowInfo();
/**
* Determines the part size to use for upload parts.
*
* Examines the provided partSize value and the source to determine the
* best possible part size.
*
* @throws \InvalidArgumentException if the part size is invalid.
*
* @return int
*/
protected abstract function determinePartSize();
/**
* Uses information from the Command and Result to determine which part was
* uploaded and mark it as uploaded in the upload's state.
*
* @param CommandInterface $command
* @param ResultInterface $result
*/
protected abstract function handleResult(\Aws\CommandInterface $command, \Aws\ResultInterface $result);
/**
* Gets the service-specific parameters used to initiate the upload.
*
* @return array
*/
protected abstract function getInitiateParams();
/**
* Gets the service-specific parameters used to complete the upload.
*
* @return array
*/
protected abstract function getCompleteParams();
/**
* Executes a MUP command with all of the parameters for the operation.
*
* @param string $operation Name of the operation.
* @param array $params Service-specific params for the operation.
*
* @return PromiseInterface
*/
protected function execCommand($operation, array $params)
{
}
/**
* Returns a middleware for processing responses of part upload operations.
*
* - Adds an onFulfilled callback that calls the service-specific
* handleResult method on the Result of the operation.
* - Adds an onRejected callback that adds the error to an array of errors.
* - Has a passedByRef $errors arg that the exceptions get added to. The
* caller should use that &$errors array to do error handling.
*
* @param array $errors Errors from upload operations are added to this.
*
* @return callable
*/
protected function getResultHandler(&$errors = [])
{
}
/**
* Creates a generator that yields part data for the upload's source.
*
* Yields associative arrays of parameters that are ultimately merged in
* with others to form the complete parameters of a command. This can
* include the Body parameter, which is a limited stream (i.e., a Stream
* object, decorated with a LimitStream).
*
* @param callable $resultHandler
*
* @return \Generator
*/
protected abstract function getUploadCommands(callable $resultHandler);
}
abstract class AbstractUploader extends \Aws\Multipart\AbstractUploadManager
{
/** @var Stream Source of the data to be uploaded. */
protected $source;
/**
* @param Client $client
* @param mixed $source
* @param array $config
*/
public function __construct(\Aws\AwsClientInterface $client, $source, array $config = [])
{
}
/**
* Create a stream for a part that starts at the current position and
* has a length of the upload part size (or less with the final part).
*
* @param Stream $stream
*
* @return Psr7\LimitStream
*/
protected function limitPartStream(\Psr\Http\Message\StreamInterface $stream)
{
}
protected function getUploadCommands(callable $resultHandler)
{
}
/**
* Generates the parameters for an upload part by analyzing a range of the
* source starting from the current offset up to the part size.
*
* @param bool $seekable
* @param int $number
*
* @return array|null
*/
protected abstract function createPart($seekable, $number);
}
}
namespace Aws\Glacier {
/**
* Encapsulates the execution of a multipart upload to Glacier.
*/
class MultipartUploader extends \Aws\Multipart\AbstractUploader
{
const PART_MIN_SIZE = 1048576;
/**
* Creates an UploadState object for a multipart upload by querying the
* service for the specified upload's information.
*
* @param GlacierClient $client GlacierClient object to use.
* @param string $vaultName Vault name for the multipart upload.
* @param string $uploadId Upload ID for the multipart upload.
* @param string $accountId Account ID for the multipart upload.
*
* @return UploadState
*/
public static function getStateFromService(\Aws\Glacier\GlacierClient $client, $vaultName, $uploadId, $accountId = '-')
{
}
/**
* Creates a multipart upload for a Glacier archive.
*
* The valid configuration options are as follows:
*
* - account_id: (string, default=string('-')) Account ID for the archive
* being uploaded, if different from the account making the request.
* - archive_description: (string) Description of the archive.
* - before_complete: (callable) Callback to invoke before the
* `CompleteMultipartUpload` operation. The callback should have a
* function signature like `function (Aws\Command $command) {...}`.
* - before_initiate: (callable) Callback to invoke before the
* `InitiateMultipartUpload` operation. The callback should have a
* function signature like `function (Aws\Command $command) {...}`.
* - before_upload: (callable) Callback to invoke before any
* `UploadMultipartPart` operations. The callback should have a function
* signature like `function (Aws\Command $command) {...}`.
* - concurrency: (int, default=int(3)) Maximum number of concurrent
* `UploadMultipartPart` operations allowed during the multipart upload.
* - part_size: (int, default=int(1048576)) Part size, in bytes, to use when
* doing a multipart upload. This must between 1 MB and 4 GB, and must be
* a power of 2 (in megabytes).
* - prepare_data_source: (callable) Callback to invoke before starting the
* multipart upload workflow. The callback should have a function
* signature like `function () {...}`.
* - state: (Aws\Multipart\UploadState) An object that represents the state
* of the multipart upload and that is used to resume a previous upload.
* When this options is provided, the `account_id`, `key`, and `part_size`
* options are ignored.
* - vault_name: (string, required) Vault name to use for the archive being
* uploaded.
*
* @param GlacierClient $client Client used for the upload.
* @param mixed $source Source of the data to upload.
* @param array $config Configuration used to perform the upload.
*/
public function __construct(\Aws\Glacier\GlacierClient $client, $source, array $config = [])
{
}
protected function loadUploadWorkflowInfo()
{
}
protected function determinePartSize()
{
}
protected function createPart($seekable, $number)
{
}
protected function handleResult(\Aws\CommandInterface $command, \Aws\ResultInterface $result)
{
}
protected function getInitiateParams()
{
}
protected function getCompleteParams()
{
}
}
/**
* This client is used to interact with the **Amazon Glacier** service.
*
* @method \Aws\Result abortMultipartUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise abortMultipartUploadAsync(array $args = [])
* @method \Aws\Result abortVaultLock(array $args = [])
* @method \GuzzleHttp\Promise\Promise abortVaultLockAsync(array $args = [])
* @method \Aws\Result addTagsToVault(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToVaultAsync(array $args = [])
* @method \Aws\Result completeMultipartUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise completeMultipartUploadAsync(array $args = [])
* @method \Aws\Result completeVaultLock(array $args = [])
* @method \GuzzleHttp\Promise\Promise completeVaultLockAsync(array $args = [])
* @method \Aws\Result createVault(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVaultAsync(array $args = [])
* @method \Aws\Result deleteArchive(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteArchiveAsync(array $args = [])
* @method \Aws\Result deleteVault(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVaultAsync(array $args = [])
* @method \Aws\Result deleteVaultAccessPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVaultAccessPolicyAsync(array $args = [])
* @method \Aws\Result deleteVaultNotifications(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVaultNotificationsAsync(array $args = [])
* @method \Aws\Result describeJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeJobAsync(array $args = [])
* @method \Aws\Result describeVault(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVaultAsync(array $args = [])
* @method \Aws\Result getDataRetrievalPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDataRetrievalPolicyAsync(array $args = [])
* @method \Aws\Result getJobOutput(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobOutputAsync(array $args = [])
* @method \Aws\Result getVaultAccessPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getVaultAccessPolicyAsync(array $args = [])
* @method \Aws\Result getVaultLock(array $args = [])
* @method \GuzzleHttp\Promise\Promise getVaultLockAsync(array $args = [])
* @method \Aws\Result getVaultNotifications(array $args = [])
* @method \GuzzleHttp\Promise\Promise getVaultNotificationsAsync(array $args = [])
* @method \Aws\Result initiateJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise initiateJobAsync(array $args = [])
* @method \Aws\Result initiateMultipartUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise initiateMultipartUploadAsync(array $args = [])
* @method \Aws\Result initiateVaultLock(array $args = [])
* @method \GuzzleHttp\Promise\Promise initiateVaultLockAsync(array $args = [])
* @method \Aws\Result listJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobsAsync(array $args = [])
* @method \Aws\Result listMultipartUploads(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMultipartUploadsAsync(array $args = [])
* @method \Aws\Result listParts(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPartsAsync(array $args = [])
* @method \Aws\Result listProvisionedCapacity(array $args = [])
* @method \GuzzleHttp\Promise\Promise listProvisionedCapacityAsync(array $args = [])
* @method \Aws\Result listTagsForVault(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForVaultAsync(array $args = [])
* @method \Aws\Result listVaults(array $args = [])
* @method \GuzzleHttp\Promise\Promise listVaultsAsync(array $args = [])
* @method \Aws\Result purchaseProvisionedCapacity(array $args = [])
* @method \GuzzleHttp\Promise\Promise purchaseProvisionedCapacityAsync(array $args = [])
* @method \Aws\Result removeTagsFromVault(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromVaultAsync(array $args = [])
* @method \Aws\Result setDataRetrievalPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise setDataRetrievalPolicyAsync(array $args = [])
* @method \Aws\Result setVaultAccessPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise setVaultAccessPolicyAsync(array $args = [])
* @method \Aws\Result setVaultNotifications(array $args = [])
* @method \GuzzleHttp\Promise\Promise setVaultNotificationsAsync(array $args = [])
* @method \Aws\Result uploadArchive(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadArchiveAsync(array $args = [])
* @method \Aws\Result uploadMultipartPart(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadMultipartPartAsync(array $args = [])
*/
class GlacierClient extends \Aws\AwsClient
{
public function __construct(array $args)
{
}
/**
* {@inheritdoc}
*
* Sets the default accountId to "-" for all operations.
*/
public function getCommand($name, array $args = [])
{
}
/**
* @internal
* @codeCoverageIgnore
*/
public static function applyDocFilters(array $api, array $docs)
{
}
}
}
namespace Aws {
/**
* Interface that allows implementing various incremental hashes.
*/
interface HashInterface
{
/**
* Adds data to the hash.
*
* @param string $data Data to add to the hash
*/
public function update($data);
/**
* Finalizes the incremental hash and returns the resulting digest.
*
* @return string
*/
public function complete();
/**
* Removes all data from the hash, effectively starting a new hash.
*/
public function reset();
}
}
namespace Aws\Glacier {
/**
* Encapsulates the creation of a tree hash from streamed data
*/
class TreeHash implements \Aws\HashInterface
{
const MB = 1048576;
const EMPTY_HASH = 'e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855';
public function __construct($algorithm = 'sha256')
{
}
/**
* {@inheritdoc}
* @throws \LogicException if the root tree hash is already calculated
*/
public function update($data)
{
}
/**
* Add a checksum to the tree hash directly
*
* @param string $checksum The checksum to add
* @param bool $inBinaryForm TRUE if checksum is in binary form
*
* @return self
* @throws \LogicException if the root tree hash is already calculated
*/
public function addChecksum($checksum, $inBinaryForm = false)
{
}
public function complete()
{
}
public function reset()
{
}
}
}
namespace Aws\Glacier\Exception {
/**
* Represents an error interacting with the Amazon Glacier service.
*/
class GlacierException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ResourceGroups {
/**
* This client is used to interact with the **AWS Resource Groups** service.
* @method \Aws\Result createGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGroupAsync(array $args = [])
* @method \Aws\Result deleteGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGroupAsync(array $args = [])
* @method \Aws\Result getGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGroupAsync(array $args = [])
* @method \Aws\Result getGroupQuery(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGroupQueryAsync(array $args = [])
* @method \Aws\Result getTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTagsAsync(array $args = [])
* @method \Aws\Result listGroupResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupResourcesAsync(array $args = [])
* @method \Aws\Result listGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupsAsync(array $args = [])
* @method \Aws\Result searchResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchResourcesAsync(array $args = [])
* @method \Aws\Result tag(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagAsync(array $args = [])
* @method \Aws\Result untag(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagAsync(array $args = [])
* @method \Aws\Result updateGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGroupAsync(array $args = [])
* @method \Aws\Result updateGroupQuery(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGroupQueryAsync(array $args = [])
*/
class ResourceGroupsClient extends \Aws\AwsClient
{
}
}
namespace Aws\ResourceGroups\Exception {
/**
* Represents an error interacting with the **AWS Resource Groups** service.
*/
class ResourceGroupsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\SnowBall\Exception {
/**
* Represents an error interacting with the **Amazon Import/Export Snowball** service.
*/
class SnowBallException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\SnowBall {
/**
* This client is used to interact with the **Amazon Import/Export Snowball** service.
* @method \Aws\Result cancelCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelClusterAsync(array $args = [])
* @method \Aws\Result cancelJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelJobAsync(array $args = [])
* @method \Aws\Result createAddress(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAddressAsync(array $args = [])
* @method \Aws\Result createCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClusterAsync(array $args = [])
* @method \Aws\Result createJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createJobAsync(array $args = [])
* @method \Aws\Result describeAddress(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAddressAsync(array $args = [])
* @method \Aws\Result describeAddresses(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAddressesAsync(array $args = [])
* @method \Aws\Result describeCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterAsync(array $args = [])
* @method \Aws\Result describeJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeJobAsync(array $args = [])
* @method \Aws\Result getJobManifest(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobManifestAsync(array $args = [])
* @method \Aws\Result getJobUnlockCode(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobUnlockCodeAsync(array $args = [])
* @method \Aws\Result getSnowballUsage(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSnowballUsageAsync(array $args = [])
* @method \Aws\Result listClusterJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listClusterJobsAsync(array $args = [])
* @method \Aws\Result listClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise listClustersAsync(array $args = [])
* @method \Aws\Result listCompatibleImages(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCompatibleImagesAsync(array $args = [])
* @method \Aws\Result listJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobsAsync(array $args = [])
* @method \Aws\Result updateCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateClusterAsync(array $args = [])
* @method \Aws\Result updateJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateJobAsync(array $args = [])
*/
class SnowBallClient extends \Aws\AwsClient
{
}
}
namespace Aws\Kinesis {
/**
* This client is used to interact with the **Amazon Kinesis** service.
*
* @method \Aws\Result addTagsToStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToStreamAsync(array $args = [])
* @method \Aws\Result createStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStreamAsync(array $args = [])
* @method \Aws\Result decreaseStreamRetentionPeriod(array $args = [])
* @method \GuzzleHttp\Promise\Promise decreaseStreamRetentionPeriodAsync(array $args = [])
* @method \Aws\Result deleteStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStreamAsync(array $args = [])
* @method \Aws\Result deregisterStreamConsumer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterStreamConsumerAsync(array $args = [])
* @method \Aws\Result describeLimits(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLimitsAsync(array $args = [])
* @method \Aws\Result describeStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStreamAsync(array $args = [])
* @method \Aws\Result describeStreamConsumer(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStreamConsumerAsync(array $args = [])
* @method \Aws\Result describeStreamSummary(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStreamSummaryAsync(array $args = [])
* @method \Aws\Result disableEnhancedMonitoring(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableEnhancedMonitoringAsync(array $args = [])
* @method \Aws\Result enableEnhancedMonitoring(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableEnhancedMonitoringAsync(array $args = [])
* @method \Aws\Result getRecords(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRecordsAsync(array $args = [])
* @method \Aws\Result getShardIterator(array $args = [])
* @method \GuzzleHttp\Promise\Promise getShardIteratorAsync(array $args = [])
* @method \Aws\Result increaseStreamRetentionPeriod(array $args = [])
* @method \GuzzleHttp\Promise\Promise increaseStreamRetentionPeriodAsync(array $args = [])
* @method \Aws\Result listShards(array $args = [])
* @method \GuzzleHttp\Promise\Promise listShardsAsync(array $args = [])
* @method \Aws\Result listStreamConsumers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStreamConsumersAsync(array $args = [])
* @method \Aws\Result listStreams(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStreamsAsync(array $args = [])
* @method \Aws\Result listTagsForStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForStreamAsync(array $args = [])
* @method \Aws\Result mergeShards(array $args = [])
* @method \GuzzleHttp\Promise\Promise mergeShardsAsync(array $args = [])
* @method \Aws\Result putRecord(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRecordAsync(array $args = [])
* @method \Aws\Result putRecords(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRecordsAsync(array $args = [])
* @method \Aws\Result registerStreamConsumer(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerStreamConsumerAsync(array $args = [])
* @method \Aws\Result removeTagsFromStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromStreamAsync(array $args = [])
* @method \Aws\Result splitShard(array $args = [])
* @method \GuzzleHttp\Promise\Promise splitShardAsync(array $args = [])
* @method \Aws\Result startStreamEncryption(array $args = [])
* @method \GuzzleHttp\Promise\Promise startStreamEncryptionAsync(array $args = [])
* @method \Aws\Result stopStreamEncryption(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopStreamEncryptionAsync(array $args = [])
* @method \Aws\Result updateShardCount(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateShardCountAsync(array $args = [])
*/
class KinesisClient extends \Aws\AwsClient
{
}
}
namespace Aws\Kinesis\Exception {
/**
* Represents an error interacting with the Amazon Kinesis service.
*/
class KinesisException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Pricing {
/**
* This client is used to interact with the **AWS Price List Service** service.
* @method \Aws\Result describeServices(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeServicesAsync(array $args = [])
* @method \Aws\Result getAttributeValues(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAttributeValuesAsync(array $args = [])
* @method \Aws\Result getProducts(array $args = [])
* @method \GuzzleHttp\Promise\Promise getProductsAsync(array $args = [])
*/
class PricingClient extends \Aws\AwsClient
{
}
}
namespace Aws\Pricing\Exception {
/**
* Represents an error interacting with the **AWS Price List Service** service.
*/
class PricingException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\KinesisVideoMedia\Exception {
/**
* Represents an error interacting with the **Amazon Kinesis Video Streams Media** service.
*/
class KinesisVideoMediaException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\KinesisVideoMedia {
/**
* This client is used to interact with the **Amazon Kinesis Video Streams Media** service.
* @method \Aws\Result getMedia(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMediaAsync(array $args = [])
*/
class KinesisVideoMediaClient extends \Aws\AwsClient
{
}
}
namespace Aws\CodeCommit {
/**
* This client is used to interact with the **AWS CodeCommit** service.
*
* @method \Aws\Result batchGetRepositories(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetRepositoriesAsync(array $args = [])
* @method \Aws\Result createBranch(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBranchAsync(array $args = [])
* @method \Aws\Result createPullRequest(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPullRequestAsync(array $args = [])
* @method \Aws\Result createRepository(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRepositoryAsync(array $args = [])
* @method \Aws\Result deleteBranch(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBranchAsync(array $args = [])
* @method \Aws\Result deleteCommentContent(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCommentContentAsync(array $args = [])
* @method \Aws\Result deleteFile(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFileAsync(array $args = [])
* @method \Aws\Result deleteRepository(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRepositoryAsync(array $args = [])
* @method \Aws\Result describePullRequestEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePullRequestEventsAsync(array $args = [])
* @method \Aws\Result getBlob(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBlobAsync(array $args = [])
* @method \Aws\Result getBranch(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBranchAsync(array $args = [])
* @method \Aws\Result getComment(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCommentAsync(array $args = [])
* @method \Aws\Result getCommentsForComparedCommit(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCommentsForComparedCommitAsync(array $args = [])
* @method \Aws\Result getCommentsForPullRequest(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCommentsForPullRequestAsync(array $args = [])
* @method \Aws\Result getCommit(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCommitAsync(array $args = [])
* @method \Aws\Result getDifferences(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDifferencesAsync(array $args = [])
* @method \Aws\Result getFile(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFileAsync(array $args = [])
* @method \Aws\Result getFolder(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFolderAsync(array $args = [])
* @method \Aws\Result getMergeConflicts(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMergeConflictsAsync(array $args = [])
* @method \Aws\Result getPullRequest(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPullRequestAsync(array $args = [])
* @method \Aws\Result getRepository(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRepositoryAsync(array $args = [])
* @method \Aws\Result getRepositoryTriggers(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRepositoryTriggersAsync(array $args = [])
* @method \Aws\Result listBranches(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBranchesAsync(array $args = [])
* @method \Aws\Result listPullRequests(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPullRequestsAsync(array $args = [])
* @method \Aws\Result listRepositories(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRepositoriesAsync(array $args = [])
* @method \Aws\Result mergePullRequestByFastForward(array $args = [])
* @method \GuzzleHttp\Promise\Promise mergePullRequestByFastForwardAsync(array $args = [])
* @method \Aws\Result postCommentForComparedCommit(array $args = [])
* @method \GuzzleHttp\Promise\Promise postCommentForComparedCommitAsync(array $args = [])
* @method \Aws\Result postCommentForPullRequest(array $args = [])
* @method \GuzzleHttp\Promise\Promise postCommentForPullRequestAsync(array $args = [])
* @method \Aws\Result postCommentReply(array $args = [])
* @method \GuzzleHttp\Promise\Promise postCommentReplyAsync(array $args = [])
* @method \Aws\Result putFile(array $args = [])
* @method \GuzzleHttp\Promise\Promise putFileAsync(array $args = [])
* @method \Aws\Result putRepositoryTriggers(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRepositoryTriggersAsync(array $args = [])
* @method \Aws\Result testRepositoryTriggers(array $args = [])
* @method \GuzzleHttp\Promise\Promise testRepositoryTriggersAsync(array $args = [])
* @method \Aws\Result updateComment(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCommentAsync(array $args = [])
* @method \Aws\Result updateDefaultBranch(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDefaultBranchAsync(array $args = [])
* @method \Aws\Result updatePullRequestDescription(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePullRequestDescriptionAsync(array $args = [])
* @method \Aws\Result updatePullRequestStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePullRequestStatusAsync(array $args = [])
* @method \Aws\Result updatePullRequestTitle(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePullRequestTitleAsync(array $args = [])
* @method \Aws\Result updateRepositoryDescription(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRepositoryDescriptionAsync(array $args = [])
* @method \Aws\Result updateRepositoryName(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRepositoryNameAsync(array $args = [])
*/
class CodeCommitClient extends \Aws\AwsClient
{
}
}
namespace Aws\CodeCommit\Exception {
/**
* Represents an error interacting with the **AWS CodeCommit** service.
*/
class CodeCommitException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\MediaPackage {
/**
* This client is used to interact with the **AWS Elemental MediaPackage** service.
* @method \Aws\Result createChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise createChannelAsync(array $args = [])
* @method \Aws\Result createOriginEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise createOriginEndpointAsync(array $args = [])
* @method \Aws\Result deleteChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteChannelAsync(array $args = [])
* @method \Aws\Result deleteOriginEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteOriginEndpointAsync(array $args = [])
* @method \Aws\Result describeChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeChannelAsync(array $args = [])
* @method \Aws\Result describeOriginEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOriginEndpointAsync(array $args = [])
* @method \Aws\Result listChannels(array $args = [])
* @method \GuzzleHttp\Promise\Promise listChannelsAsync(array $args = [])
* @method \Aws\Result listOriginEndpoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOriginEndpointsAsync(array $args = [])
* @method \Aws\Result rotateChannelCredentials(array $args = [])
* @method \GuzzleHttp\Promise\Promise rotateChannelCredentialsAsync(array $args = [])
* @method \Aws\Result rotateIngestEndpointCredentials(array $args = [])
* @method \GuzzleHttp\Promise\Promise rotateIngestEndpointCredentialsAsync(array $args = [])
* @method \Aws\Result updateChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateChannelAsync(array $args = [])
* @method \Aws\Result updateOriginEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateOriginEndpointAsync(array $args = [])
*/
class MediaPackageClient extends \Aws\AwsClient
{
}
}
namespace Aws\MediaPackage\Exception {
/**
* Represents an error interacting with the **AWS Elemental MediaPackage** service.
*/
class MediaPackageException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\AutoScalingPlans {
/**
* This client is used to interact with the **AWS Auto Scaling Plans** service.
* @method \Aws\Result createScalingPlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise createScalingPlanAsync(array $args = [])
* @method \Aws\Result deleteScalingPlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteScalingPlanAsync(array $args = [])
* @method \Aws\Result describeScalingPlanResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScalingPlanResourcesAsync(array $args = [])
* @method \Aws\Result describeScalingPlans(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScalingPlansAsync(array $args = [])
* @method \Aws\Result updateScalingPlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateScalingPlanAsync(array $args = [])
*/
class AutoScalingPlansClient extends \Aws\AwsClient
{
}
}
namespace Aws\AutoScalingPlans\Exception {
/**
* Represents an error interacting with the **AWS Auto Scaling Plans** service.
*/
class AutoScalingPlansException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ServiceCatalog {
/**
* This client is used to interact with the **AWS Service Catalog** service.
* @method \Aws\Result acceptPortfolioShare(array $args = [])
* @method \GuzzleHttp\Promise\Promise acceptPortfolioShareAsync(array $args = [])
* @method \Aws\Result associatePrincipalWithPortfolio(array $args = [])
* @method \GuzzleHttp\Promise\Promise associatePrincipalWithPortfolioAsync(array $args = [])
* @method \Aws\Result associateProductWithPortfolio(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateProductWithPortfolioAsync(array $args = [])
* @method \Aws\Result associateTagOptionWithResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateTagOptionWithResourceAsync(array $args = [])
* @method \Aws\Result copyProduct(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyProductAsync(array $args = [])
* @method \Aws\Result createConstraint(array $args = [])
* @method \GuzzleHttp\Promise\Promise createConstraintAsync(array $args = [])
* @method \Aws\Result createPortfolio(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPortfolioAsync(array $args = [])
* @method \Aws\Result createPortfolioShare(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPortfolioShareAsync(array $args = [])
* @method \Aws\Result createProduct(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProductAsync(array $args = [])
* @method \Aws\Result createProvisionedProductPlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProvisionedProductPlanAsync(array $args = [])
* @method \Aws\Result createProvisioningArtifact(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProvisioningArtifactAsync(array $args = [])
* @method \Aws\Result createTagOption(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTagOptionAsync(array $args = [])
* @method \Aws\Result deleteConstraint(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConstraintAsync(array $args = [])
* @method \Aws\Result deletePortfolio(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePortfolioAsync(array $args = [])
* @method \Aws\Result deletePortfolioShare(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePortfolioShareAsync(array $args = [])
* @method \Aws\Result deleteProduct(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProductAsync(array $args = [])
* @method \Aws\Result deleteProvisionedProductPlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProvisionedProductPlanAsync(array $args = [])
* @method \Aws\Result deleteProvisioningArtifact(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProvisioningArtifactAsync(array $args = [])
* @method \Aws\Result deleteTagOption(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTagOptionAsync(array $args = [])
* @method \Aws\Result describeConstraint(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConstraintAsync(array $args = [])
* @method \Aws\Result describeCopyProductStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCopyProductStatusAsync(array $args = [])
* @method \Aws\Result describePortfolio(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePortfolioAsync(array $args = [])
* @method \Aws\Result describeProduct(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProductAsync(array $args = [])
* @method \Aws\Result describeProductAsAdmin(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProductAsAdminAsync(array $args = [])
* @method \Aws\Result describeProductView(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProductViewAsync(array $args = [])
* @method \Aws\Result describeProvisionedProduct(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProvisionedProductAsync(array $args = [])
* @method \Aws\Result describeProvisionedProductPlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProvisionedProductPlanAsync(array $args = [])
* @method \Aws\Result describeProvisioningArtifact(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProvisioningArtifactAsync(array $args = [])
* @method \Aws\Result describeProvisioningParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProvisioningParametersAsync(array $args = [])
* @method \Aws\Result describeRecord(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRecordAsync(array $args = [])
* @method \Aws\Result describeTagOption(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagOptionAsync(array $args = [])
* @method \Aws\Result disassociatePrincipalFromPortfolio(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociatePrincipalFromPortfolioAsync(array $args = [])
* @method \Aws\Result disassociateProductFromPortfolio(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateProductFromPortfolioAsync(array $args = [])
* @method \Aws\Result disassociateTagOptionFromResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateTagOptionFromResourceAsync(array $args = [])
* @method \Aws\Result executeProvisionedProductPlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise executeProvisionedProductPlanAsync(array $args = [])
* @method \Aws\Result listAcceptedPortfolioShares(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAcceptedPortfolioSharesAsync(array $args = [])
* @method \Aws\Result listConstraintsForPortfolio(array $args = [])
* @method \GuzzleHttp\Promise\Promise listConstraintsForPortfolioAsync(array $args = [])
* @method \Aws\Result listLaunchPaths(array $args = [])
* @method \GuzzleHttp\Promise\Promise listLaunchPathsAsync(array $args = [])
* @method \Aws\Result listPortfolioAccess(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPortfolioAccessAsync(array $args = [])
* @method \Aws\Result listPortfolios(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPortfoliosAsync(array $args = [])
* @method \Aws\Result listPortfoliosForProduct(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPortfoliosForProductAsync(array $args = [])
* @method \Aws\Result listPrincipalsForPortfolio(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPrincipalsForPortfolioAsync(array $args = [])
* @method \Aws\Result listProvisionedProductPlans(array $args = [])
* @method \GuzzleHttp\Promise\Promise listProvisionedProductPlansAsync(array $args = [])
* @method \Aws\Result listProvisioningArtifacts(array $args = [])
* @method \GuzzleHttp\Promise\Promise listProvisioningArtifactsAsync(array $args = [])
* @method \Aws\Result listRecordHistory(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRecordHistoryAsync(array $args = [])
* @method \Aws\Result listResourcesForTagOption(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourcesForTagOptionAsync(array $args = [])
* @method \Aws\Result listTagOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagOptionsAsync(array $args = [])
* @method \Aws\Result provisionProduct(array $args = [])
* @method \GuzzleHttp\Promise\Promise provisionProductAsync(array $args = [])
* @method \Aws\Result rejectPortfolioShare(array $args = [])
* @method \GuzzleHttp\Promise\Promise rejectPortfolioShareAsync(array $args = [])
* @method \Aws\Result scanProvisionedProducts(array $args = [])
* @method \GuzzleHttp\Promise\Promise scanProvisionedProductsAsync(array $args = [])
* @method \Aws\Result searchProducts(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchProductsAsync(array $args = [])
* @method \Aws\Result searchProductsAsAdmin(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchProductsAsAdminAsync(array $args = [])
* @method \Aws\Result searchProvisionedProducts(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchProvisionedProductsAsync(array $args = [])
* @method \Aws\Result terminateProvisionedProduct(array $args = [])
* @method \GuzzleHttp\Promise\Promise terminateProvisionedProductAsync(array $args = [])
* @method \Aws\Result updateConstraint(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateConstraintAsync(array $args = [])
* @method \Aws\Result updatePortfolio(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePortfolioAsync(array $args = [])
* @method \Aws\Result updateProduct(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateProductAsync(array $args = [])
* @method \Aws\Result updateProvisionedProduct(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateProvisionedProductAsync(array $args = [])
* @method \Aws\Result updateProvisioningArtifact(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateProvisioningArtifactAsync(array $args = [])
* @method \Aws\Result updateTagOption(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTagOptionAsync(array $args = [])
*/
class ServiceCatalogClient extends \Aws\AwsClient
{
}
}
namespace Aws\ServiceCatalog\Exception {
/**
* Represents an error interacting with the **AWS Service Catalog** service.
*/
class ServiceCatalogException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\DataPipeline {
/**
* This client is used to interact with the **AWS Data Pipeline** service.
*
* @method \Aws\Result activatePipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise activatePipelineAsync(array $args = [])
* @method \Aws\Result addTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsAsync(array $args = [])
* @method \Aws\Result createPipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPipelineAsync(array $args = [])
* @method \Aws\Result deactivatePipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise deactivatePipelineAsync(array $args = [])
* @method \Aws\Result deletePipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePipelineAsync(array $args = [])
* @method \Aws\Result describeObjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeObjectsAsync(array $args = [])
* @method \Aws\Result describePipelines(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePipelinesAsync(array $args = [])
* @method \Aws\Result evaluateExpression(array $args = [])
* @method \GuzzleHttp\Promise\Promise evaluateExpressionAsync(array $args = [])
* @method \Aws\Result getPipelineDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPipelineDefinitionAsync(array $args = [])
* @method \Aws\Result listPipelines(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPipelinesAsync(array $args = [])
* @method \Aws\Result pollForTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise pollForTaskAsync(array $args = [])
* @method \Aws\Result putPipelineDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise putPipelineDefinitionAsync(array $args = [])
* @method \Aws\Result queryObjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise queryObjectsAsync(array $args = [])
* @method \Aws\Result removeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsAsync(array $args = [])
* @method \Aws\Result reportTaskProgress(array $args = [])
* @method \GuzzleHttp\Promise\Promise reportTaskProgressAsync(array $args = [])
* @method \Aws\Result reportTaskRunnerHeartbeat(array $args = [])
* @method \GuzzleHttp\Promise\Promise reportTaskRunnerHeartbeatAsync(array $args = [])
* @method \Aws\Result setStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise setStatusAsync(array $args = [])
* @method \Aws\Result setTaskStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise setTaskStatusAsync(array $args = [])
* @method \Aws\Result validatePipelineDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise validatePipelineDefinitionAsync(array $args = [])
*/
class DataPipelineClient extends \Aws\AwsClient
{
}
}
namespace Aws\DataPipeline\Exception {
/**
* Represents an error interacting with the AWS Data Pipeline service.
*/
class DataPipelineException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudDirectory {
/**
* This client is used to interact with the **Amazon CloudDirectory** service.
* @method \Aws\Result addFacetToObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise addFacetToObjectAsync(array $args = [])
* @method \Aws\Result applySchema(array $args = [])
* @method \GuzzleHttp\Promise\Promise applySchemaAsync(array $args = [])
* @method \Aws\Result attachObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachObjectAsync(array $args = [])
* @method \Aws\Result attachPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachPolicyAsync(array $args = [])
* @method \Aws\Result attachToIndex(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachToIndexAsync(array $args = [])
* @method \Aws\Result attachTypedLink(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachTypedLinkAsync(array $args = [])
* @method \Aws\Result batchRead(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchReadAsync(array $args = [])
* @method \Aws\Result batchWrite(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchWriteAsync(array $args = [])
* @method \Aws\Result createDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDirectoryAsync(array $args = [])
* @method \Aws\Result createFacet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createFacetAsync(array $args = [])
* @method \Aws\Result createIndex(array $args = [])
* @method \GuzzleHttp\Promise\Promise createIndexAsync(array $args = [])
* @method \Aws\Result createObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise createObjectAsync(array $args = [])
* @method \Aws\Result createSchema(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSchemaAsync(array $args = [])
* @method \Aws\Result createTypedLinkFacet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTypedLinkFacetAsync(array $args = [])
* @method \Aws\Result deleteDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDirectoryAsync(array $args = [])
* @method \Aws\Result deleteFacet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFacetAsync(array $args = [])
* @method \Aws\Result deleteObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteObjectAsync(array $args = [])
* @method \Aws\Result deleteSchema(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSchemaAsync(array $args = [])
* @method \Aws\Result deleteTypedLinkFacet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTypedLinkFacetAsync(array $args = [])
* @method \Aws\Result detachFromIndex(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachFromIndexAsync(array $args = [])
* @method \Aws\Result detachObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachObjectAsync(array $args = [])
* @method \Aws\Result detachPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachPolicyAsync(array $args = [])
* @method \Aws\Result detachTypedLink(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachTypedLinkAsync(array $args = [])
* @method \Aws\Result disableDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableDirectoryAsync(array $args = [])
* @method \Aws\Result enableDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableDirectoryAsync(array $args = [])
* @method \Aws\Result getAppliedSchemaVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAppliedSchemaVersionAsync(array $args = [])
* @method \Aws\Result getDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDirectoryAsync(array $args = [])
* @method \Aws\Result getFacet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFacetAsync(array $args = [])
* @method \Aws\Result getLinkAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLinkAttributesAsync(array $args = [])
* @method \Aws\Result getObjectAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectAttributesAsync(array $args = [])
* @method \Aws\Result getObjectInformation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectInformationAsync(array $args = [])
* @method \Aws\Result getSchemaAsJson(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSchemaAsJsonAsync(array $args = [])
* @method \Aws\Result getTypedLinkFacetInformation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTypedLinkFacetInformationAsync(array $args = [])
* @method \Aws\Result listAppliedSchemaArns(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAppliedSchemaArnsAsync(array $args = [])
* @method \Aws\Result listAttachedIndices(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAttachedIndicesAsync(array $args = [])
* @method \Aws\Result listDevelopmentSchemaArns(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDevelopmentSchemaArnsAsync(array $args = [])
* @method \Aws\Result listDirectories(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDirectoriesAsync(array $args = [])
* @method \Aws\Result listFacetAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFacetAttributesAsync(array $args = [])
* @method \Aws\Result listFacetNames(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFacetNamesAsync(array $args = [])
* @method \Aws\Result listIncomingTypedLinks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIncomingTypedLinksAsync(array $args = [])
* @method \Aws\Result listIndex(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIndexAsync(array $args = [])
* @method \Aws\Result listObjectAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectAttributesAsync(array $args = [])
* @method \Aws\Result listObjectChildren(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectChildrenAsync(array $args = [])
* @method \Aws\Result listObjectParentPaths(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectParentPathsAsync(array $args = [])
* @method \Aws\Result listObjectParents(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectParentsAsync(array $args = [])
* @method \Aws\Result listObjectPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectPoliciesAsync(array $args = [])
* @method \Aws\Result listOutgoingTypedLinks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOutgoingTypedLinksAsync(array $args = [])
* @method \Aws\Result listPolicyAttachments(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPolicyAttachmentsAsync(array $args = [])
* @method \Aws\Result listPublishedSchemaArns(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPublishedSchemaArnsAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result listTypedLinkFacetAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTypedLinkFacetAttributesAsync(array $args = [])
* @method \Aws\Result listTypedLinkFacetNames(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTypedLinkFacetNamesAsync(array $args = [])
* @method \Aws\Result lookupPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise lookupPolicyAsync(array $args = [])
* @method \Aws\Result publishSchema(array $args = [])
* @method \GuzzleHttp\Promise\Promise publishSchemaAsync(array $args = [])
* @method \Aws\Result putSchemaFromJson(array $args = [])
* @method \GuzzleHttp\Promise\Promise putSchemaFromJsonAsync(array $args = [])
* @method \Aws\Result removeFacetFromObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeFacetFromObjectAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateFacet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFacetAsync(array $args = [])
* @method \Aws\Result updateLinkAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateLinkAttributesAsync(array $args = [])
* @method \Aws\Result updateObjectAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateObjectAttributesAsync(array $args = [])
* @method \Aws\Result updateSchema(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSchemaAsync(array $args = [])
* @method \Aws\Result updateTypedLinkFacet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTypedLinkFacetAsync(array $args = [])
* @method \Aws\Result upgradeAppliedSchema(array $args = [])
* @method \GuzzleHttp\Promise\Promise upgradeAppliedSchemaAsync(array $args = [])
* @method \Aws\Result upgradePublishedSchema(array $args = [])
* @method \GuzzleHttp\Promise\Promise upgradePublishedSchemaAsync(array $args = [])
* @method \Aws\Result listManagedSchemaArns(array $args = []) (supported in versions 2017-01-11)
* @method \GuzzleHttp\Promise\Promise listManagedSchemaArnsAsync(array $args = []) (supported in versions 2017-01-11)
*/
class CloudDirectoryClient extends \Aws\AwsClient
{
}
}
namespace Aws\CloudDirectory\Exception {
/**
* Represents an error interacting with the **Amazon CloudDirectory** service.
*/
class CloudDirectoryException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\GameLift {
/**
* This client is used to interact with the **Amazon GameLift** service.
*
* @method \Aws\Result acceptMatch(array $args = [])
* @method \GuzzleHttp\Promise\Promise acceptMatchAsync(array $args = [])
* @method \Aws\Result createAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAliasAsync(array $args = [])
* @method \Aws\Result createBuild(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBuildAsync(array $args = [])
* @method \Aws\Result createFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createFleetAsync(array $args = [])
* @method \Aws\Result createGameSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGameSessionAsync(array $args = [])
* @method \Aws\Result createGameSessionQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGameSessionQueueAsync(array $args = [])
* @method \Aws\Result createMatchmakingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise createMatchmakingConfigurationAsync(array $args = [])
* @method \Aws\Result createMatchmakingRuleSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createMatchmakingRuleSetAsync(array $args = [])
* @method \Aws\Result createPlayerSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPlayerSessionAsync(array $args = [])
* @method \Aws\Result createPlayerSessions(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPlayerSessionsAsync(array $args = [])
* @method \Aws\Result createVpcPeeringAuthorization(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVpcPeeringAuthorizationAsync(array $args = [])
* @method \Aws\Result createVpcPeeringConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVpcPeeringConnectionAsync(array $args = [])
* @method \Aws\Result deleteAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAliasAsync(array $args = [])
* @method \Aws\Result deleteBuild(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBuildAsync(array $args = [])
* @method \Aws\Result deleteFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFleetAsync(array $args = [])
* @method \Aws\Result deleteGameSessionQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGameSessionQueueAsync(array $args = [])
* @method \Aws\Result deleteMatchmakingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMatchmakingConfigurationAsync(array $args = [])
* @method \Aws\Result deleteScalingPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteScalingPolicyAsync(array $args = [])
* @method \Aws\Result deleteVpcPeeringAuthorization(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVpcPeeringAuthorizationAsync(array $args = [])
* @method \Aws\Result deleteVpcPeeringConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVpcPeeringConnectionAsync(array $args = [])
* @method \Aws\Result describeAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAliasAsync(array $args = [])
* @method \Aws\Result describeBuild(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeBuildAsync(array $args = [])
* @method \Aws\Result describeEC2InstanceLimits(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEC2InstanceLimitsAsync(array $args = [])
* @method \Aws\Result describeFleetAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeFleetAttributesAsync(array $args = [])
* @method \Aws\Result describeFleetCapacity(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeFleetCapacityAsync(array $args = [])
* @method \Aws\Result describeFleetEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeFleetEventsAsync(array $args = [])
* @method \Aws\Result describeFleetPortSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeFleetPortSettingsAsync(array $args = [])
* @method \Aws\Result describeFleetUtilization(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeFleetUtilizationAsync(array $args = [])
* @method \Aws\Result describeGameSessionDetails(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeGameSessionDetailsAsync(array $args = [])
* @method \Aws\Result describeGameSessionPlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeGameSessionPlacementAsync(array $args = [])
* @method \Aws\Result describeGameSessionQueues(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeGameSessionQueuesAsync(array $args = [])
* @method \Aws\Result describeGameSessions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeGameSessionsAsync(array $args = [])
* @method \Aws\Result describeInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstancesAsync(array $args = [])
* @method \Aws\Result describeMatchmaking(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMatchmakingAsync(array $args = [])
* @method \Aws\Result describeMatchmakingConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMatchmakingConfigurationsAsync(array $args = [])
* @method \Aws\Result describeMatchmakingRuleSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMatchmakingRuleSetsAsync(array $args = [])
* @method \Aws\Result describePlayerSessions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePlayerSessionsAsync(array $args = [])
* @method \Aws\Result describeRuntimeConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRuntimeConfigurationAsync(array $args = [])
* @method \Aws\Result describeScalingPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScalingPoliciesAsync(array $args = [])
* @method \Aws\Result describeVpcPeeringAuthorizations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpcPeeringAuthorizationsAsync(array $args = [])
* @method \Aws\Result describeVpcPeeringConnections(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVpcPeeringConnectionsAsync(array $args = [])
* @method \Aws\Result getGameSessionLogUrl(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGameSessionLogUrlAsync(array $args = [])
* @method \Aws\Result getInstanceAccess(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstanceAccessAsync(array $args = [])
* @method \Aws\Result listAliases(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAliasesAsync(array $args = [])
* @method \Aws\Result listBuilds(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBuildsAsync(array $args = [])
* @method \Aws\Result listFleets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFleetsAsync(array $args = [])
* @method \Aws\Result putScalingPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putScalingPolicyAsync(array $args = [])
* @method \Aws\Result requestUploadCredentials(array $args = [])
* @method \GuzzleHttp\Promise\Promise requestUploadCredentialsAsync(array $args = [])
* @method \Aws\Result resolveAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise resolveAliasAsync(array $args = [])
* @method \Aws\Result searchGameSessions(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchGameSessionsAsync(array $args = [])
* @method \Aws\Result startFleetActions(array $args = [])
* @method \GuzzleHttp\Promise\Promise startFleetActionsAsync(array $args = [])
* @method \Aws\Result startGameSessionPlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise startGameSessionPlacementAsync(array $args = [])
* @method \Aws\Result startMatchBackfill(array $args = [])
* @method \GuzzleHttp\Promise\Promise startMatchBackfillAsync(array $args = [])
* @method \Aws\Result startMatchmaking(array $args = [])
* @method \GuzzleHttp\Promise\Promise startMatchmakingAsync(array $args = [])
* @method \Aws\Result stopFleetActions(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopFleetActionsAsync(array $args = [])
* @method \Aws\Result stopGameSessionPlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopGameSessionPlacementAsync(array $args = [])
* @method \Aws\Result stopMatchmaking(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopMatchmakingAsync(array $args = [])
* @method \Aws\Result updateAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAliasAsync(array $args = [])
* @method \Aws\Result updateBuild(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateBuildAsync(array $args = [])
* @method \Aws\Result updateFleetAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFleetAttributesAsync(array $args = [])
* @method \Aws\Result updateFleetCapacity(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFleetCapacityAsync(array $args = [])
* @method \Aws\Result updateFleetPortSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFleetPortSettingsAsync(array $args = [])
* @method \Aws\Result updateGameSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGameSessionAsync(array $args = [])
* @method \Aws\Result updateGameSessionQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGameSessionQueueAsync(array $args = [])
* @method \Aws\Result updateMatchmakingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateMatchmakingConfigurationAsync(array $args = [])
* @method \Aws\Result updateRuntimeConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRuntimeConfigurationAsync(array $args = [])
* @method \Aws\Result validateMatchmakingRuleSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise validateMatchmakingRuleSetAsync(array $args = [])
*/
class GameLiftClient extends \Aws\AwsClient
{
}
}
namespace Aws\GameLift\Exception {
/**
* Represents an error interacting with the **Amazon GameLift** service.
*/
class GameLiftException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ResourceGroupsTaggingAPI\Exception {
/**
* Represents an error interacting with the **AWS Resource Groups Tagging API** service.
*/
class ResourceGroupsTaggingAPIException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ResourceGroupsTaggingAPI {
/**
* This client is used to interact with the **AWS Resource Groups Tagging API** service.
* @method \Aws\Result getResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise getResourcesAsync(array $args = [])
* @method \Aws\Result getTagKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTagKeysAsync(array $args = [])
* @method \Aws\Result getTagValues(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTagValuesAsync(array $args = [])
* @method \Aws\Result tagResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourcesAsync(array $args = [])
* @method \Aws\Result untagResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourcesAsync(array $args = [])
*/
class ResourceGroupsTaggingAPIClient extends \Aws\AwsClient
{
}
}
namespace Aws\KinesisVideoArchivedMedia {
/**
* This client is used to interact with the **Amazon Kinesis Video Streams Archived Media** service.
* @method \Aws\Result getHLSStreamingSessionURL(array $args = [])
* @method \GuzzleHttp\Promise\Promise getHLSStreamingSessionURLAsync(array $args = [])
* @method \Aws\Result getMediaForFragmentList(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMediaForFragmentListAsync(array $args = [])
* @method \Aws\Result listFragments(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFragmentsAsync(array $args = [])
*/
class KinesisVideoArchivedMediaClient extends \Aws\AwsClient
{
}
}
namespace Aws\KinesisVideoArchivedMedia\Exception {
/**
* Represents an error interacting with the **Amazon Kinesis Video Streams Archived Media** service.
*/
class KinesisVideoArchivedMediaException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\DatabaseMigrationService {
/**
* This client is used to interact with the **AWS Database Migration Service** service.
* @method \Aws\Result addTagsToResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToResourceAsync(array $args = [])
* @method \Aws\Result createEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEndpointAsync(array $args = [])
* @method \Aws\Result createEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEventSubscriptionAsync(array $args = [])
* @method \Aws\Result createReplicationInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise createReplicationInstanceAsync(array $args = [])
* @method \Aws\Result createReplicationSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createReplicationSubnetGroupAsync(array $args = [])
* @method \Aws\Result createReplicationTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise createReplicationTaskAsync(array $args = [])
* @method \Aws\Result deleteCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCertificateAsync(array $args = [])
* @method \Aws\Result deleteEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEndpointAsync(array $args = [])
* @method \Aws\Result deleteEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEventSubscriptionAsync(array $args = [])
* @method \Aws\Result deleteReplicationInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReplicationInstanceAsync(array $args = [])
* @method \Aws\Result deleteReplicationSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReplicationSubnetGroupAsync(array $args = [])
* @method \Aws\Result deleteReplicationTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReplicationTaskAsync(array $args = [])
* @method \Aws\Result describeAccountAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAccountAttributesAsync(array $args = [])
* @method \Aws\Result describeCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCertificatesAsync(array $args = [])
* @method \Aws\Result describeConnections(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConnectionsAsync(array $args = [])
* @method \Aws\Result describeEndpointTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEndpointTypesAsync(array $args = [])
* @method \Aws\Result describeEndpoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEndpointsAsync(array $args = [])
* @method \Aws\Result describeEventCategories(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventCategoriesAsync(array $args = [])
* @method \Aws\Result describeEventSubscriptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventSubscriptionsAsync(array $args = [])
* @method \Aws\Result describeEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventsAsync(array $args = [])
* @method \Aws\Result describeOrderableReplicationInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOrderableReplicationInstancesAsync(array $args = [])
* @method \Aws\Result describeRefreshSchemasStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRefreshSchemasStatusAsync(array $args = [])
* @method \Aws\Result describeReplicationInstanceTaskLogs(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReplicationInstanceTaskLogsAsync(array $args = [])
* @method \Aws\Result describeReplicationInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReplicationInstancesAsync(array $args = [])
* @method \Aws\Result describeReplicationSubnetGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReplicationSubnetGroupsAsync(array $args = [])
* @method \Aws\Result describeReplicationTaskAssessmentResults(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReplicationTaskAssessmentResultsAsync(array $args = [])
* @method \Aws\Result describeReplicationTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReplicationTasksAsync(array $args = [])
* @method \Aws\Result describeSchemas(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSchemasAsync(array $args = [])
* @method \Aws\Result describeTableStatistics(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTableStatisticsAsync(array $args = [])
* @method \Aws\Result importCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise importCertificateAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result modifyEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyEndpointAsync(array $args = [])
* @method \Aws\Result modifyEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyEventSubscriptionAsync(array $args = [])
* @method \Aws\Result modifyReplicationInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyReplicationInstanceAsync(array $args = [])
* @method \Aws\Result modifyReplicationSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyReplicationSubnetGroupAsync(array $args = [])
* @method \Aws\Result modifyReplicationTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyReplicationTaskAsync(array $args = [])
* @method \Aws\Result rebootReplicationInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootReplicationInstanceAsync(array $args = [])
* @method \Aws\Result refreshSchemas(array $args = [])
* @method \GuzzleHttp\Promise\Promise refreshSchemasAsync(array $args = [])
* @method \Aws\Result reloadTables(array $args = [])
* @method \GuzzleHttp\Promise\Promise reloadTablesAsync(array $args = [])
* @method \Aws\Result removeTagsFromResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromResourceAsync(array $args = [])
* @method \Aws\Result startReplicationTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise startReplicationTaskAsync(array $args = [])
* @method \Aws\Result startReplicationTaskAssessment(array $args = [])
* @method \GuzzleHttp\Promise\Promise startReplicationTaskAssessmentAsync(array $args = [])
* @method \Aws\Result stopReplicationTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopReplicationTaskAsync(array $args = [])
* @method \Aws\Result testConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise testConnectionAsync(array $args = [])
*/
class DatabaseMigrationServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws\DatabaseMigrationService\Exception {
/**
* Represents an error interacting with the **AWS Database Migration Service** service.
*/
class DatabaseMigrationServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\IoT1ClickProjects {
/**
* This client is used to interact with the **AWS IoT 1-Click Projects Service** service.
* @method \Aws\Result associateDeviceWithPlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateDeviceWithPlacementAsync(array $args = [])
* @method \Aws\Result createPlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPlacementAsync(array $args = [])
* @method \Aws\Result createProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProjectAsync(array $args = [])
* @method \Aws\Result deletePlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePlacementAsync(array $args = [])
* @method \Aws\Result deleteProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProjectAsync(array $args = [])
* @method \Aws\Result describePlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePlacementAsync(array $args = [])
* @method \Aws\Result describeProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProjectAsync(array $args = [])
* @method \Aws\Result disassociateDeviceFromPlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateDeviceFromPlacementAsync(array $args = [])
* @method \Aws\Result getDevicesInPlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDevicesInPlacementAsync(array $args = [])
* @method \Aws\Result listPlacements(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPlacementsAsync(array $args = [])
* @method \Aws\Result listProjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise listProjectsAsync(array $args = [])
* @method \Aws\Result updatePlacement(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePlacementAsync(array $args = [])
* @method \Aws\Result updateProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateProjectAsync(array $args = [])
*/
class IoT1ClickProjectsClient extends \Aws\AwsClient
{
}
}
namespace Aws\IoT1ClickProjects\Exception {
/**
* Represents an error interacting with the **AWS IoT 1-Click Projects Service** service.
*/
class IoT1ClickProjectsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* Traces state changes between middlewares.
*/
class TraceMiddleware
{
/**
* Configuration array can contain the following key value pairs.
*
* - logfn: (callable) Function that is invoked with log messages. By
* default, PHP's "echo" function will be utilized.
* - stream_size: (int) When the size of a stream is greater than this
* number, the stream data will not be logged. Set to "0" to not log any
* stream data.
* - scrub_auth: (bool) Set to false to disable the scrubbing of auth data
* from the logged messages.
* - http: (bool) Set to false to disable the "debug" feature of lower
* level HTTP adapters (e.g., verbose curl output).
* - auth_strings: (array) A mapping of authentication string regular
* expressions to scrubbed strings. These mappings are passed directly to
* preg_replace (e.g., preg_replace($key, $value, $debugOutput) if
* "scrub_auth" is set to true.
* - auth_headers: (array) A mapping of header names known to contain
* sensitive data to what the scrubbed value should be. The value of any
* headers contained in this array will be replaced with the if
* "scrub_auth" is set to true.
*/
public function __construct(array $config = [])
{
}
public function __invoke($step, $name)
{
}
}
/**
* Returns promises that are rejected or fulfilled using a queue of
* Aws\ResultInterface and Aws\Exception\AwsException objects.
*/
class MockHandler implements \Countable
{
/**
* The passed in value must be an array of {@see Aws\ResultInterface} or
* {@see AwsException} objects that acts as a queue of results or
* exceptions to return each time the handler is invoked.
*
* @param array $resultOrQueue
* @param callable $onFulfilled Callback to invoke when the return value is fulfilled.
* @param callable $onRejected Callback to invoke when the return value is rejected.
*/
public function __construct(array $resultOrQueue = [], callable $onFulfilled = null, callable $onRejected = null)
{
}
/**
* Adds one or more variadic ResultInterface or AwsException objects to the
* queue.
*/
public function append()
{
}
/**
* Adds one or more \Exception or \Throwable to the queue
*/
public function appendException()
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\RequestInterface $request)
{
}
/**
* Get the last received request.
*
* @return RequestInterface
*/
public function getLastRequest()
{
}
/**
* Get the last received command.
*
* @return CommandInterface
*/
public function getLastCommand()
{
}
/**
* Returns the number of remaining items in the queue.
*
* @return int
*/
public function count()
{
}
}
}
namespace Aws\Ssm\Exception {
/**
* Amazon EC2 Simple Systems Manager exception.
*/
class SsmException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Ssm {
/**
* Amazon EC2 Simple Systems Manager client.
*
* @method \Aws\Result addTagsToResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToResourceAsync(array $args = [])
* @method \Aws\Result cancelCommand(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelCommandAsync(array $args = [])
* @method \Aws\Result createActivation(array $args = [])
* @method \GuzzleHttp\Promise\Promise createActivationAsync(array $args = [])
* @method \Aws\Result createAssociation(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAssociationAsync(array $args = [])
* @method \Aws\Result createAssociationBatch(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAssociationBatchAsync(array $args = [])
* @method \Aws\Result createDocument(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDocumentAsync(array $args = [])
* @method \Aws\Result createMaintenanceWindow(array $args = [])
* @method \GuzzleHttp\Promise\Promise createMaintenanceWindowAsync(array $args = [])
* @method \Aws\Result createPatchBaseline(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPatchBaselineAsync(array $args = [])
* @method \Aws\Result createResourceDataSync(array $args = [])
* @method \GuzzleHttp\Promise\Promise createResourceDataSyncAsync(array $args = [])
* @method \Aws\Result deleteActivation(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteActivationAsync(array $args = [])
* @method \Aws\Result deleteAssociation(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAssociationAsync(array $args = [])
* @method \Aws\Result deleteDocument(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDocumentAsync(array $args = [])
* @method \Aws\Result deleteInventory(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInventoryAsync(array $args = [])
* @method \Aws\Result deleteMaintenanceWindow(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMaintenanceWindowAsync(array $args = [])
* @method \Aws\Result deleteParameter(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteParameterAsync(array $args = [])
* @method \Aws\Result deleteParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteParametersAsync(array $args = [])
* @method \Aws\Result deletePatchBaseline(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePatchBaselineAsync(array $args = [])
* @method \Aws\Result deleteResourceDataSync(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteResourceDataSyncAsync(array $args = [])
* @method \Aws\Result deregisterManagedInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterManagedInstanceAsync(array $args = [])
* @method \Aws\Result deregisterPatchBaselineForPatchGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterPatchBaselineForPatchGroupAsync(array $args = [])
* @method \Aws\Result deregisterTargetFromMaintenanceWindow(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterTargetFromMaintenanceWindowAsync(array $args = [])
* @method \Aws\Result deregisterTaskFromMaintenanceWindow(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterTaskFromMaintenanceWindowAsync(array $args = [])
* @method \Aws\Result describeActivations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeActivationsAsync(array $args = [])
* @method \Aws\Result describeAssociation(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAssociationAsync(array $args = [])
* @method \Aws\Result describeAssociationExecutionTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAssociationExecutionTargetsAsync(array $args = [])
* @method \Aws\Result describeAssociationExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAssociationExecutionsAsync(array $args = [])
* @method \Aws\Result describeAutomationExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAutomationExecutionsAsync(array $args = [])
* @method \Aws\Result describeAutomationStepExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAutomationStepExecutionsAsync(array $args = [])
* @method \Aws\Result describeAvailablePatches(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAvailablePatchesAsync(array $args = [])
* @method \Aws\Result describeDocument(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDocumentAsync(array $args = [])
* @method \Aws\Result describeDocumentPermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDocumentPermissionAsync(array $args = [])
* @method \Aws\Result describeEffectiveInstanceAssociations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEffectiveInstanceAssociationsAsync(array $args = [])
* @method \Aws\Result describeEffectivePatchesForPatchBaseline(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEffectivePatchesForPatchBaselineAsync(array $args = [])
* @method \Aws\Result describeInstanceAssociationsStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstanceAssociationsStatusAsync(array $args = [])
* @method \Aws\Result describeInstanceInformation(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstanceInformationAsync(array $args = [])
* @method \Aws\Result describeInstancePatchStates(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstancePatchStatesAsync(array $args = [])
* @method \Aws\Result describeInstancePatchStatesForPatchGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstancePatchStatesForPatchGroupAsync(array $args = [])
* @method \Aws\Result describeInstancePatches(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstancePatchesAsync(array $args = [])
* @method \Aws\Result describeInventoryDeletions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInventoryDeletionsAsync(array $args = [])
* @method \Aws\Result describeMaintenanceWindowExecutionTaskInvocations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMaintenanceWindowExecutionTaskInvocationsAsync(array $args = [])
* @method \Aws\Result describeMaintenanceWindowExecutionTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMaintenanceWindowExecutionTasksAsync(array $args = [])
* @method \Aws\Result describeMaintenanceWindowExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMaintenanceWindowExecutionsAsync(array $args = [])
* @method \Aws\Result describeMaintenanceWindowTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMaintenanceWindowTargetsAsync(array $args = [])
* @method \Aws\Result describeMaintenanceWindowTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMaintenanceWindowTasksAsync(array $args = [])
* @method \Aws\Result describeMaintenanceWindows(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMaintenanceWindowsAsync(array $args = [])
* @method \Aws\Result describeParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeParametersAsync(array $args = [])
* @method \Aws\Result describePatchBaselines(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePatchBaselinesAsync(array $args = [])
* @method \Aws\Result describePatchGroupState(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePatchGroupStateAsync(array $args = [])
* @method \Aws\Result describePatchGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePatchGroupsAsync(array $args = [])
* @method \Aws\Result describeSessions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSessionsAsync(array $args = [])
* @method \Aws\Result getAutomationExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAutomationExecutionAsync(array $args = [])
* @method \Aws\Result getCommandInvocation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCommandInvocationAsync(array $args = [])
* @method \Aws\Result getConnectionStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getConnectionStatusAsync(array $args = [])
* @method \Aws\Result getDefaultPatchBaseline(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDefaultPatchBaselineAsync(array $args = [])
* @method \Aws\Result getDeployablePatchSnapshotForInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeployablePatchSnapshotForInstanceAsync(array $args = [])
* @method \Aws\Result getDocument(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDocumentAsync(array $args = [])
* @method \Aws\Result getInventory(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInventoryAsync(array $args = [])
* @method \Aws\Result getInventorySchema(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInventorySchemaAsync(array $args = [])
* @method \Aws\Result getMaintenanceWindow(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMaintenanceWindowAsync(array $args = [])
* @method \Aws\Result getMaintenanceWindowExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMaintenanceWindowExecutionAsync(array $args = [])
* @method \Aws\Result getMaintenanceWindowExecutionTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMaintenanceWindowExecutionTaskAsync(array $args = [])
* @method \Aws\Result getMaintenanceWindowExecutionTaskInvocation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMaintenanceWindowExecutionTaskInvocationAsync(array $args = [])
* @method \Aws\Result getMaintenanceWindowTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMaintenanceWindowTaskAsync(array $args = [])
* @method \Aws\Result getParameter(array $args = [])
* @method \GuzzleHttp\Promise\Promise getParameterAsync(array $args = [])
* @method \Aws\Result getParameterHistory(array $args = [])
* @method \GuzzleHttp\Promise\Promise getParameterHistoryAsync(array $args = [])
* @method \Aws\Result getParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise getParametersAsync(array $args = [])
* @method \Aws\Result getParametersByPath(array $args = [])
* @method \GuzzleHttp\Promise\Promise getParametersByPathAsync(array $args = [])
* @method \Aws\Result getPatchBaseline(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPatchBaselineAsync(array $args = [])
* @method \Aws\Result getPatchBaselineForPatchGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPatchBaselineForPatchGroupAsync(array $args = [])
* @method \Aws\Result labelParameterVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise labelParameterVersionAsync(array $args = [])
* @method \Aws\Result listAssociationVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAssociationVersionsAsync(array $args = [])
* @method \Aws\Result listAssociations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAssociationsAsync(array $args = [])
* @method \Aws\Result listCommandInvocations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCommandInvocationsAsync(array $args = [])
* @method \Aws\Result listCommands(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCommandsAsync(array $args = [])
* @method \Aws\Result listComplianceItems(array $args = [])
* @method \GuzzleHttp\Promise\Promise listComplianceItemsAsync(array $args = [])
* @method \Aws\Result listComplianceSummaries(array $args = [])
* @method \GuzzleHttp\Promise\Promise listComplianceSummariesAsync(array $args = [])
* @method \Aws\Result listDocumentVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDocumentVersionsAsync(array $args = [])
* @method \Aws\Result listDocuments(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDocumentsAsync(array $args = [])
* @method \Aws\Result listInventoryEntries(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInventoryEntriesAsync(array $args = [])
* @method \Aws\Result listResourceComplianceSummaries(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourceComplianceSummariesAsync(array $args = [])
* @method \Aws\Result listResourceDataSync(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourceDataSyncAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result modifyDocumentPermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyDocumentPermissionAsync(array $args = [])
* @method \Aws\Result putComplianceItems(array $args = [])
* @method \GuzzleHttp\Promise\Promise putComplianceItemsAsync(array $args = [])
* @method \Aws\Result putInventory(array $args = [])
* @method \GuzzleHttp\Promise\Promise putInventoryAsync(array $args = [])
* @method \Aws\Result putParameter(array $args = [])
* @method \GuzzleHttp\Promise\Promise putParameterAsync(array $args = [])
* @method \Aws\Result registerDefaultPatchBaseline(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerDefaultPatchBaselineAsync(array $args = [])
* @method \Aws\Result registerPatchBaselineForPatchGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerPatchBaselineForPatchGroupAsync(array $args = [])
* @method \Aws\Result registerTargetWithMaintenanceWindow(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerTargetWithMaintenanceWindowAsync(array $args = [])
* @method \Aws\Result registerTaskWithMaintenanceWindow(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerTaskWithMaintenanceWindowAsync(array $args = [])
* @method \Aws\Result removeTagsFromResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromResourceAsync(array $args = [])
* @method \Aws\Result resumeSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise resumeSessionAsync(array $args = [])
* @method \Aws\Result sendAutomationSignal(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendAutomationSignalAsync(array $args = [])
* @method \Aws\Result sendCommand(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendCommandAsync(array $args = [])
* @method \Aws\Result startAssociationsOnce(array $args = [])
* @method \GuzzleHttp\Promise\Promise startAssociationsOnceAsync(array $args = [])
* @method \Aws\Result startAutomationExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise startAutomationExecutionAsync(array $args = [])
* @method \Aws\Result startSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise startSessionAsync(array $args = [])
* @method \Aws\Result stopAutomationExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopAutomationExecutionAsync(array $args = [])
* @method \Aws\Result terminateSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise terminateSessionAsync(array $args = [])
* @method \Aws\Result updateAssociation(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAssociationAsync(array $args = [])
* @method \Aws\Result updateAssociationStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAssociationStatusAsync(array $args = [])
* @method \Aws\Result updateDocument(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDocumentAsync(array $args = [])
* @method \Aws\Result updateDocumentDefaultVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDocumentDefaultVersionAsync(array $args = [])
* @method \Aws\Result updateMaintenanceWindow(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateMaintenanceWindowAsync(array $args = [])
* @method \Aws\Result updateMaintenanceWindowTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateMaintenanceWindowTargetAsync(array $args = [])
* @method \Aws\Result updateMaintenanceWindowTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateMaintenanceWindowTaskAsync(array $args = [])
* @method \Aws\Result updateManagedInstanceRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateManagedInstanceRoleAsync(array $args = [])
* @method \Aws\Result updatePatchBaseline(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePatchBaselineAsync(array $args = [])
*/
class SsmClient extends \Aws\AwsClient
{
}
}
namespace Aws\Efs\Exception {
/**
* Amazon EFS exception.
*/
class EfsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Efs {
/**
* This client is used to interact with **Amazon EFS**.
*
* @method \Aws\Result createFileSystem(array $args = [])
* @method \GuzzleHttp\Promise\Promise createFileSystemAsync(array $args = [])
* @method \Aws\Result createMountTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise createMountTargetAsync(array $args = [])
* @method \Aws\Result createTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTagsAsync(array $args = [])
* @method \Aws\Result deleteFileSystem(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFileSystemAsync(array $args = [])
* @method \Aws\Result deleteMountTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMountTargetAsync(array $args = [])
* @method \Aws\Result deleteTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTagsAsync(array $args = [])
* @method \Aws\Result describeFileSystems(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeFileSystemsAsync(array $args = [])
* @method \Aws\Result describeMountTargetSecurityGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMountTargetSecurityGroupsAsync(array $args = [])
* @method \Aws\Result describeMountTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMountTargetsAsync(array $args = [])
* @method \Aws\Result describeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagsAsync(array $args = [])
* @method \Aws\Result modifyMountTargetSecurityGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyMountTargetSecurityGroupsAsync(array $args = [])
* @method \Aws\Result updateFileSystem(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFileSystemAsync(array $args = [])
*/
class EfsClient extends \Aws\AwsClient
{
}
}
namespace Aws\CodeDeploy {
/**
* This client is used to interact with AWS CodeDeploy
*
* @method \Aws\Result addTagsToOnPremisesInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToOnPremisesInstancesAsync(array $args = [])
* @method \Aws\Result batchGetApplicationRevisions(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetApplicationRevisionsAsync(array $args = [])
* @method \Aws\Result batchGetApplications(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetApplicationsAsync(array $args = [])
* @method \Aws\Result batchGetDeploymentGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetDeploymentGroupsAsync(array $args = [])
* @method \Aws\Result batchGetDeploymentInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetDeploymentInstancesAsync(array $args = [])
* @method \Aws\Result batchGetDeployments(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetDeploymentsAsync(array $args = [])
* @method \Aws\Result batchGetOnPremisesInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetOnPremisesInstancesAsync(array $args = [])
* @method \Aws\Result continueDeployment(array $args = [])
* @method \GuzzleHttp\Promise\Promise continueDeploymentAsync(array $args = [])
* @method \Aws\Result createApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise createApplicationAsync(array $args = [])
* @method \Aws\Result createDeployment(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDeploymentAsync(array $args = [])
* @method \Aws\Result createDeploymentConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDeploymentConfigAsync(array $args = [])
* @method \Aws\Result createDeploymentGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDeploymentGroupAsync(array $args = [])
* @method \Aws\Result deleteApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApplicationAsync(array $args = [])
* @method \Aws\Result deleteDeploymentConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDeploymentConfigAsync(array $args = [])
* @method \Aws\Result deleteDeploymentGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDeploymentGroupAsync(array $args = [])
* @method \Aws\Result deleteGitHubAccountToken(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGitHubAccountTokenAsync(array $args = [])
* @method \Aws\Result deregisterOnPremisesInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterOnPremisesInstanceAsync(array $args = [])
* @method \Aws\Result getApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApplicationAsync(array $args = [])
* @method \Aws\Result getApplicationRevision(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApplicationRevisionAsync(array $args = [])
* @method \Aws\Result getDeployment(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeploymentAsync(array $args = [])
* @method \Aws\Result getDeploymentConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeploymentConfigAsync(array $args = [])
* @method \Aws\Result getDeploymentGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeploymentGroupAsync(array $args = [])
* @method \Aws\Result getDeploymentInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeploymentInstanceAsync(array $args = [])
* @method \Aws\Result getOnPremisesInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOnPremisesInstanceAsync(array $args = [])
* @method \Aws\Result listApplicationRevisions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listApplicationRevisionsAsync(array $args = [])
* @method \Aws\Result listApplications(array $args = [])
* @method \GuzzleHttp\Promise\Promise listApplicationsAsync(array $args = [])
* @method \Aws\Result listDeploymentConfigs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeploymentConfigsAsync(array $args = [])
* @method \Aws\Result listDeploymentGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeploymentGroupsAsync(array $args = [])
* @method \Aws\Result listDeploymentInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeploymentInstancesAsync(array $args = [])
* @method \Aws\Result listDeployments(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeploymentsAsync(array $args = [])
* @method \Aws\Result listGitHubAccountTokenNames(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGitHubAccountTokenNamesAsync(array $args = [])
* @method \Aws\Result listOnPremisesInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOnPremisesInstancesAsync(array $args = [])
* @method \Aws\Result putLifecycleEventHookExecutionStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise putLifecycleEventHookExecutionStatusAsync(array $args = [])
* @method \Aws\Result registerApplicationRevision(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerApplicationRevisionAsync(array $args = [])
* @method \Aws\Result registerOnPremisesInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerOnPremisesInstanceAsync(array $args = [])
* @method \Aws\Result removeTagsFromOnPremisesInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromOnPremisesInstancesAsync(array $args = [])
* @method \Aws\Result skipWaitTimeForInstanceTermination(array $args = [])
* @method \GuzzleHttp\Promise\Promise skipWaitTimeForInstanceTerminationAsync(array $args = [])
* @method \Aws\Result stopDeployment(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopDeploymentAsync(array $args = [])
* @method \Aws\Result updateApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApplicationAsync(array $args = [])
* @method \Aws\Result updateDeploymentGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDeploymentGroupAsync(array $args = [])
*/
class CodeDeployClient extends \Aws\AwsClient
{
}
}
namespace Aws\CodeDeploy\Exception {
/**
* Represents an error interacting with AWS CodeDeploy.
*/
class CodeDeployException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* @internal Middleware that auto fills parameters with `idempotencyToken` trait
*/
class IdempotencyTokenMiddleware
{
/**
* Creates a middleware that populates operation parameter
* with trait 'idempotencyToken' enabled with a random UUIDv4
*
* One of following functions needs to be available
* in order to generate random bytes used for UUID
* (SDK will attempt to utilize function in following order):
* - random_bytes (requires PHP 7.0 or above)
* - openssl_random_pseudo_bytes (requires 'openssl' module enabled)
* - mcrypt_create_iv (requires 'mcrypt' module enabled)
*
* You may also supply a custom bytes generator as an optional second
* parameter.
*
* @param \Aws\Api\Service $service
* @param callable|null $bytesGenerator
*
* @return callable
*/
public static function wrap(\Aws\Api\Service $service, callable $bytesGenerator = null)
{
}
public function __construct(callable $nextHandler, \Aws\Api\Service $service, callable $bytesGenerator = null)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\RequestInterface $request = null)
{
}
}
/**
* @internal Adds computed values to service operations that need presigned url.
*/
class PresignUrlMiddleware
{
public function __construct(array $options, callable $endpointProvider, \Aws\AwsClientInterface $client, callable $nextHandler)
{
}
public static function wrap(\Aws\AwsClientInterface $client, callable $endpointProvider, array $options = [])
{
}
public function __invoke(\Aws\CommandInterface $cmd, \Psr\Http\Message\RequestInterface $request = null)
{
}
}
}
namespace Aws\DirectConnect {
/**
* This client is used to interact with the **AWS Direct Connect** service.
*
* @method \Aws\Result allocateConnectionOnInterconnect(array $args = [])
* @method \GuzzleHttp\Promise\Promise allocateConnectionOnInterconnectAsync(array $args = [])
* @method \Aws\Result allocateHostedConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise allocateHostedConnectionAsync(array $args = [])
* @method \Aws\Result allocatePrivateVirtualInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise allocatePrivateVirtualInterfaceAsync(array $args = [])
* @method \Aws\Result allocatePublicVirtualInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise allocatePublicVirtualInterfaceAsync(array $args = [])
* @method \Aws\Result associateConnectionWithLag(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateConnectionWithLagAsync(array $args = [])
* @method \Aws\Result associateHostedConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateHostedConnectionAsync(array $args = [])
* @method \Aws\Result associateVirtualInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateVirtualInterfaceAsync(array $args = [])
* @method \Aws\Result confirmConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise confirmConnectionAsync(array $args = [])
* @method \Aws\Result confirmPrivateVirtualInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise confirmPrivateVirtualInterfaceAsync(array $args = [])
* @method \Aws\Result confirmPublicVirtualInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise confirmPublicVirtualInterfaceAsync(array $args = [])
* @method \Aws\Result createBGPPeer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBGPPeerAsync(array $args = [])
* @method \Aws\Result createConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise createConnectionAsync(array $args = [])
* @method \Aws\Result createDirectConnectGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDirectConnectGatewayAsync(array $args = [])
* @method \Aws\Result createDirectConnectGatewayAssociation(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDirectConnectGatewayAssociationAsync(array $args = [])
* @method \Aws\Result createInterconnect(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInterconnectAsync(array $args = [])
* @method \Aws\Result createLag(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLagAsync(array $args = [])
* @method \Aws\Result createPrivateVirtualInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPrivateVirtualInterfaceAsync(array $args = [])
* @method \Aws\Result createPublicVirtualInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPublicVirtualInterfaceAsync(array $args = [])
* @method \Aws\Result deleteBGPPeer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBGPPeerAsync(array $args = [])
* @method \Aws\Result deleteConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConnectionAsync(array $args = [])
* @method \Aws\Result deleteDirectConnectGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDirectConnectGatewayAsync(array $args = [])
* @method \Aws\Result deleteDirectConnectGatewayAssociation(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDirectConnectGatewayAssociationAsync(array $args = [])
* @method \Aws\Result deleteInterconnect(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInterconnectAsync(array $args = [])
* @method \Aws\Result deleteLag(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLagAsync(array $args = [])
* @method \Aws\Result deleteVirtualInterface(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVirtualInterfaceAsync(array $args = [])
* @method \Aws\Result describeConnectionLoa(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConnectionLoaAsync(array $args = [])
* @method \Aws\Result describeConnections(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConnectionsAsync(array $args = [])
* @method \Aws\Result describeConnectionsOnInterconnect(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConnectionsOnInterconnectAsync(array $args = [])
* @method \Aws\Result describeDirectConnectGatewayAssociations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDirectConnectGatewayAssociationsAsync(array $args = [])
* @method \Aws\Result describeDirectConnectGatewayAttachments(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDirectConnectGatewayAttachmentsAsync(array $args = [])
* @method \Aws\Result describeDirectConnectGateways(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDirectConnectGatewaysAsync(array $args = [])
* @method \Aws\Result describeHostedConnections(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeHostedConnectionsAsync(array $args = [])
* @method \Aws\Result describeInterconnectLoa(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInterconnectLoaAsync(array $args = [])
* @method \Aws\Result describeInterconnects(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInterconnectsAsync(array $args = [])
* @method \Aws\Result describeLags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLagsAsync(array $args = [])
* @method \Aws\Result describeLoa(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoaAsync(array $args = [])
* @method \Aws\Result describeLocations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLocationsAsync(array $args = [])
* @method \Aws\Result describeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagsAsync(array $args = [])
* @method \Aws\Result describeVirtualGateways(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVirtualGatewaysAsync(array $args = [])
* @method \Aws\Result describeVirtualInterfaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVirtualInterfacesAsync(array $args = [])
* @method \Aws\Result disassociateConnectionFromLag(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateConnectionFromLagAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateLag(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateLagAsync(array $args = [])
*/
class DirectConnectClient extends \Aws\AwsClient
{
}
}
namespace Aws\DirectConnect\Exception {
/**
* Represents an error interacting with the AWS Direct Connect service.
*/
class DirectConnectException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\MigrationHub {
/**
* This client is used to interact with the **AWS Migration Hub** service.
* @method \Aws\Result associateCreatedArtifact(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateCreatedArtifactAsync(array $args = [])
* @method \Aws\Result associateDiscoveredResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateDiscoveredResourceAsync(array $args = [])
* @method \Aws\Result createProgressUpdateStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProgressUpdateStreamAsync(array $args = [])
* @method \Aws\Result deleteProgressUpdateStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProgressUpdateStreamAsync(array $args = [])
* @method \Aws\Result describeApplicationState(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeApplicationStateAsync(array $args = [])
* @method \Aws\Result describeMigrationTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMigrationTaskAsync(array $args = [])
* @method \Aws\Result disassociateCreatedArtifact(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateCreatedArtifactAsync(array $args = [])
* @method \Aws\Result disassociateDiscoveredResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateDiscoveredResourceAsync(array $args = [])
* @method \Aws\Result importMigrationTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise importMigrationTaskAsync(array $args = [])
* @method \Aws\Result listCreatedArtifacts(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCreatedArtifactsAsync(array $args = [])
* @method \Aws\Result listDiscoveredResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDiscoveredResourcesAsync(array $args = [])
* @method \Aws\Result listMigrationTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMigrationTasksAsync(array $args = [])
* @method \Aws\Result listProgressUpdateStreams(array $args = [])
* @method \GuzzleHttp\Promise\Promise listProgressUpdateStreamsAsync(array $args = [])
* @method \Aws\Result notifyApplicationState(array $args = [])
* @method \GuzzleHttp\Promise\Promise notifyApplicationStateAsync(array $args = [])
* @method \Aws\Result notifyMigrationTaskState(array $args = [])
* @method \GuzzleHttp\Promise\Promise notifyMigrationTaskStateAsync(array $args = [])
* @method \Aws\Result putResourceAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise putResourceAttributesAsync(array $args = [])
*/
class MigrationHubClient extends \Aws\AwsClient
{
}
}
namespace Aws\MigrationHub\Exception {
/**
* Represents an error interacting with the **AWS Migration Hub** service.
*/
class MigrationHubException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* Simple in-memory LRU cache that limits the number of cached entries.
*
* The LRU cache is implemented using PHP's ordered associative array. When
* accessing an element, the element is removed from the hash and re-added to
* ensure that recently used items are always at the end of the list while
* least recently used are at the beginning. When a value is added to the
* cache, if the number of cached items exceeds the allowed number, the first
* N number of items are removed from the array.
*/
class LruArrayCache implements \Aws\CacheInterface, \Countable
{
/**
* @param int $maxItems Maximum number of allowed cache items.
*/
public function __construct($maxItems = 1000)
{
}
public function get($key)
{
}
public function set($key, $value, $ttl = 0)
{
}
public function remove($key)
{
}
public function count()
{
}
}
}
namespace Aws\ServerlessApplicationRepository {
/**
* This client is used to interact with the **AWSServerlessApplicationRepository** service.
* @method \Aws\Result createApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise createApplicationAsync(array $args = [])
* @method \Aws\Result createApplicationVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createApplicationVersionAsync(array $args = [])
* @method \Aws\Result createCloudFormationChangeSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCloudFormationChangeSetAsync(array $args = [])
* @method \Aws\Result deleteApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApplicationAsync(array $args = [])
* @method \Aws\Result getApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApplicationAsync(array $args = [])
* @method \Aws\Result getApplicationPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApplicationPolicyAsync(array $args = [])
* @method \Aws\Result listApplicationVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listApplicationVersionsAsync(array $args = [])
* @method \Aws\Result listApplications(array $args = [])
* @method \GuzzleHttp\Promise\Promise listApplicationsAsync(array $args = [])
* @method \Aws\Result putApplicationPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putApplicationPolicyAsync(array $args = [])
* @method \Aws\Result updateApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApplicationAsync(array $args = [])
*/
class ServerlessApplicationRepositoryClient extends \Aws\AwsClient
{
}
}
namespace Aws\ServerlessApplicationRepository\Exception {
/**
* Represents an error interacting with the **AWSServerlessApplicationRepository** service.
*/
class ServerlessApplicationRepositoryException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CostExplorer {
/**
* This client is used to interact with the **AWS Cost Explorer Service** service.
* @method \Aws\Result getCostAndUsage(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCostAndUsageAsync(array $args = [])
* @method \Aws\Result getDimensionValues(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDimensionValuesAsync(array $args = [])
* @method \Aws\Result getReservationCoverage(array $args = [])
* @method \GuzzleHttp\Promise\Promise getReservationCoverageAsync(array $args = [])
* @method \Aws\Result getReservationPurchaseRecommendation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getReservationPurchaseRecommendationAsync(array $args = [])
* @method \Aws\Result getReservationUtilization(array $args = [])
* @method \GuzzleHttp\Promise\Promise getReservationUtilizationAsync(array $args = [])
* @method \Aws\Result getTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTagsAsync(array $args = [])
*/
class CostExplorerClient extends \Aws\AwsClient
{
}
}
namespace Aws\CostExplorer\Exception {
/**
* Represents an error interacting with the **AWS Cost Explorer Service** service.
*/
class CostExplorerException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
class PsrCacheAdapter implements \Aws\CacheInterface
{
public function __construct(\Psr\Cache\CacheItemPoolInterface $pool)
{
}
public function get($key)
{
}
public function set($key, $value, $ttl = 0)
{
}
public function remove($key)
{
}
}
}
namespace Aws\DAX {
/**
* This client is used to interact with the **Amazon DynamoDB Accelerator (DAX)** service.
* @method \Aws\Result createCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClusterAsync(array $args = [])
* @method \Aws\Result createParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createParameterGroupAsync(array $args = [])
* @method \Aws\Result createSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSubnetGroupAsync(array $args = [])
* @method \Aws\Result decreaseReplicationFactor(array $args = [])
* @method \GuzzleHttp\Promise\Promise decreaseReplicationFactorAsync(array $args = [])
* @method \Aws\Result deleteCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClusterAsync(array $args = [])
* @method \Aws\Result deleteParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteParameterGroupAsync(array $args = [])
* @method \Aws\Result deleteSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSubnetGroupAsync(array $args = [])
* @method \Aws\Result describeClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClustersAsync(array $args = [])
* @method \Aws\Result describeDefaultParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDefaultParametersAsync(array $args = [])
* @method \Aws\Result describeEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventsAsync(array $args = [])
* @method \Aws\Result describeParameterGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeParameterGroupsAsync(array $args = [])
* @method \Aws\Result describeParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeParametersAsync(array $args = [])
* @method \Aws\Result describeSubnetGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSubnetGroupsAsync(array $args = [])
* @method \Aws\Result increaseReplicationFactor(array $args = [])
* @method \GuzzleHttp\Promise\Promise increaseReplicationFactorAsync(array $args = [])
* @method \Aws\Result listTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsAsync(array $args = [])
* @method \Aws\Result rebootNode(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootNodeAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateClusterAsync(array $args = [])
* @method \Aws\Result updateParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateParameterGroupAsync(array $args = [])
* @method \Aws\Result updateSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSubnetGroupAsync(array $args = [])
*/
class DAXClient extends \Aws\AwsClient
{
}
}
namespace Aws\DAX\Exception {
/**
* Represents an error interacting with the **Amazon DynamoDB Accelerator (DAX)** service.
*/
class DAXException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Sfn {
/**
* This client is used to interact with the **AWS Step Functions** service.
* @method \Aws\Result createActivity(array $args = [])
* @method \GuzzleHttp\Promise\Promise createActivityAsync(array $args = [])
* @method \Aws\Result createStateMachine(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStateMachineAsync(array $args = [])
* @method \Aws\Result deleteActivity(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteActivityAsync(array $args = [])
* @method \Aws\Result deleteStateMachine(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStateMachineAsync(array $args = [])
* @method \Aws\Result describeActivity(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeActivityAsync(array $args = [])
* @method \Aws\Result describeExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeExecutionAsync(array $args = [])
* @method \Aws\Result describeStateMachine(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStateMachineAsync(array $args = [])
* @method \Aws\Result describeStateMachineForExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStateMachineForExecutionAsync(array $args = [])
* @method \Aws\Result getActivityTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise getActivityTaskAsync(array $args = [])
* @method \Aws\Result getExecutionHistory(array $args = [])
* @method \GuzzleHttp\Promise\Promise getExecutionHistoryAsync(array $args = [])
* @method \Aws\Result listActivities(array $args = [])
* @method \GuzzleHttp\Promise\Promise listActivitiesAsync(array $args = [])
* @method \Aws\Result listExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listExecutionsAsync(array $args = [])
* @method \Aws\Result listStateMachines(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStateMachinesAsync(array $args = [])
* @method \Aws\Result sendTaskFailure(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendTaskFailureAsync(array $args = [])
* @method \Aws\Result sendTaskHeartbeat(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendTaskHeartbeatAsync(array $args = [])
* @method \Aws\Result sendTaskSuccess(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendTaskSuccessAsync(array $args = [])
* @method \Aws\Result startExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise startExecutionAsync(array $args = [])
* @method \Aws\Result stopExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopExecutionAsync(array $args = [])
* @method \Aws\Result updateStateMachine(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateStateMachineAsync(array $args = [])
*/
class SfnClient extends \Aws\AwsClient
{
}
}
namespace Aws\Sfn\Exception {
/**
* Represents an error interacting with the **AWS Step Functions** service.
*/
class SfnException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ConfigService\Exception {
/**
* Represents an error interacting with the AWS Config service.
*/
class ConfigServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ConfigService {
/**
* This client is used to interact with AWS Config.
*
* @method \Aws\Result batchGetResourceConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetResourceConfigAsync(array $args = [])
* @method \Aws\Result deleteAggregationAuthorization(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAggregationAuthorizationAsync(array $args = [])
* @method \Aws\Result deleteConfigRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConfigRuleAsync(array $args = [])
* @method \Aws\Result deleteConfigurationAggregator(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConfigurationAggregatorAsync(array $args = [])
* @method \Aws\Result deleteConfigurationRecorder(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConfigurationRecorderAsync(array $args = [])
* @method \Aws\Result deleteDeliveryChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDeliveryChannelAsync(array $args = [])
* @method \Aws\Result deleteEvaluationResults(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEvaluationResultsAsync(array $args = [])
* @method \Aws\Result deletePendingAggregationRequest(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePendingAggregationRequestAsync(array $args = [])
* @method \Aws\Result deleteRetentionConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRetentionConfigurationAsync(array $args = [])
* @method \Aws\Result deliverConfigSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise deliverConfigSnapshotAsync(array $args = [])
* @method \Aws\Result describeAggregateComplianceByConfigRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAggregateComplianceByConfigRulesAsync(array $args = [])
* @method \Aws\Result describeAggregationAuthorizations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAggregationAuthorizationsAsync(array $args = [])
* @method \Aws\Result describeComplianceByConfigRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeComplianceByConfigRuleAsync(array $args = [])
* @method \Aws\Result describeComplianceByResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeComplianceByResourceAsync(array $args = [])
* @method \Aws\Result describeConfigRuleEvaluationStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigRuleEvaluationStatusAsync(array $args = [])
* @method \Aws\Result describeConfigRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigRulesAsync(array $args = [])
* @method \Aws\Result describeConfigurationAggregatorSourcesStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigurationAggregatorSourcesStatusAsync(array $args = [])
* @method \Aws\Result describeConfigurationAggregators(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigurationAggregatorsAsync(array $args = [])
* @method \Aws\Result describeConfigurationRecorderStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigurationRecorderStatusAsync(array $args = [])
* @method \Aws\Result describeConfigurationRecorders(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigurationRecordersAsync(array $args = [])
* @method \Aws\Result describeDeliveryChannelStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDeliveryChannelStatusAsync(array $args = [])
* @method \Aws\Result describeDeliveryChannels(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDeliveryChannelsAsync(array $args = [])
* @method \Aws\Result describePendingAggregationRequests(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePendingAggregationRequestsAsync(array $args = [])
* @method \Aws\Result describeRetentionConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRetentionConfigurationsAsync(array $args = [])
* @method \Aws\Result getAggregateComplianceDetailsByConfigRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAggregateComplianceDetailsByConfigRuleAsync(array $args = [])
* @method \Aws\Result getAggregateConfigRuleComplianceSummary(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAggregateConfigRuleComplianceSummaryAsync(array $args = [])
* @method \Aws\Result getComplianceDetailsByConfigRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise getComplianceDetailsByConfigRuleAsync(array $args = [])
* @method \Aws\Result getComplianceDetailsByResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise getComplianceDetailsByResourceAsync(array $args = [])
* @method \Aws\Result getComplianceSummaryByConfigRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise getComplianceSummaryByConfigRuleAsync(array $args = [])
* @method \Aws\Result getComplianceSummaryByResourceType(array $args = [])
* @method \GuzzleHttp\Promise\Promise getComplianceSummaryByResourceTypeAsync(array $args = [])
* @method \Aws\Result getDiscoveredResourceCounts(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDiscoveredResourceCountsAsync(array $args = [])
* @method \Aws\Result getResourceConfigHistory(array $args = [])
* @method \GuzzleHttp\Promise\Promise getResourceConfigHistoryAsync(array $args = [])
* @method \Aws\Result listDiscoveredResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDiscoveredResourcesAsync(array $args = [])
* @method \Aws\Result putAggregationAuthorization(array $args = [])
* @method \GuzzleHttp\Promise\Promise putAggregationAuthorizationAsync(array $args = [])
* @method \Aws\Result putConfigRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise putConfigRuleAsync(array $args = [])
* @method \Aws\Result putConfigurationAggregator(array $args = [])
* @method \GuzzleHttp\Promise\Promise putConfigurationAggregatorAsync(array $args = [])
* @method \Aws\Result putConfigurationRecorder(array $args = [])
* @method \GuzzleHttp\Promise\Promise putConfigurationRecorderAsync(array $args = [])
* @method \Aws\Result putDeliveryChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise putDeliveryChannelAsync(array $args = [])
* @method \Aws\Result putEvaluations(array $args = [])
* @method \GuzzleHttp\Promise\Promise putEvaluationsAsync(array $args = [])
* @method \Aws\Result putRetentionConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRetentionConfigurationAsync(array $args = [])
* @method \Aws\Result startConfigRulesEvaluation(array $args = [])
* @method \GuzzleHttp\Promise\Promise startConfigRulesEvaluationAsync(array $args = [])
* @method \Aws\Result startConfigurationRecorder(array $args = [])
* @method \GuzzleHttp\Promise\Promise startConfigurationRecorderAsync(array $args = [])
* @method \Aws\Result stopConfigurationRecorder(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopConfigurationRecorderAsync(array $args = [])
*/
class ConfigServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws {
final class Middleware
{
/**
* Middleware used to allow a command parameter (e.g., "SourceFile") to
* be used to specify the source of data for an upload operation.
*
* @param Service $api
* @param string $bodyParameter
* @param string $sourceParameter
*
* @return callable
*/
public static function sourceFile(\Aws\Api\Service $api, $bodyParameter = 'Body', $sourceParameter = 'SourceFile')
{
}
/**
* Adds a middleware that uses client-side validation.
*
* @param Service $api API being accessed.
*
* @return callable
*/
public static function validation(\Aws\Api\Service $api, \Aws\Api\Validator $validator = null)
{
}
/**
* Builds an HTTP request for a command.
*
* @param callable $serializer Function used to serialize a request for a
* command.
* @return callable
*/
public static function requestBuilder(callable $serializer)
{
}
/**
* Creates a middleware that signs requests for a command.
*
* @param callable $credProvider Credentials provider function that
* returns a promise that is resolved
* with a CredentialsInterface object.
* @param callable $signatureFunction Function that accepts a Command
* object and returns a
* SignatureInterface.
*
* @return callable
*/
public static function signer(callable $credProvider, callable $signatureFunction)
{
}
/**
* Creates a middleware that invokes a callback at a given step.
*
* The tap callback accepts a CommandInterface and RequestInterface as
* arguments but is not expected to return a new value or proxy to
* downstream middleware. It's simply a way to "tap" into the handler chain
* to debug or get an intermediate value.
*
* @param callable $fn Tap function
*
* @return callable
*/
public static function tap(callable $fn)
{
}
/**
* Middleware wrapper function that retries requests based on the boolean
* result of invoking the provided "decider" function.
*
* If no delay function is provided, a simple implementation of exponential
* backoff will be utilized.
*
* @param callable $decider Function that accepts the number of retries,
* a request, [result], and [exception] and
* returns true if the command is to be retried.
* @param callable $delay Function that accepts the number of retries and
* returns the number of milliseconds to delay.
* @param bool $stats Whether to collect statistics on retries and the
* associated delay.
*
* @return callable
*/
public static function retry(callable $decider = null, callable $delay = null, $stats = false)
{
}
/**
* Middleware wrapper function that adds an invocation id header to
* requests, which is only applied after the build step.
*
* This is a uniquely generated UUID to identify initial and subsequent
* retries as part of a complete request lifecycle.
*
* @return callable
*/
public static function invocationId()
{
}
/**
* Middleware wrapper function that adds a Content-Type header to requests.
* This is only done when the Content-Type has not already been set, and the
* request body's URI is available. It then checks the file extension of the
* URI to determine the mime-type.
*
* @param array $operations Operations that Content-Type should be added to.
*
* @return callable
*/
public static function contentType(array $operations)
{
}
/**
* Tracks command and request history using a history container.
*
* This is useful for testing.
*
* @param History $history History container to store entries.
*
* @return callable
*/
public static function history(\Aws\History $history)
{
}
/**
* Creates a middleware that applies a map function to requests as they
* pass through the middleware.
*
* @param callable $f Map function that accepts a RequestInterface and
* returns a RequestInterface.
*
* @return callable
*/
public static function mapRequest(callable $f)
{
}
/**
* Creates a middleware that applies a map function to commands as they
* pass through the middleware.
*
* @param callable $f Map function that accepts a command and returns a
* command.
*
* @return callable
*/
public static function mapCommand(callable $f)
{
}
/**
* Creates a middleware that applies a map function to results.
*
* @param callable $f Map function that accepts an Aws\ResultInterface and
* returns an Aws\ResultInterface.
*
* @return callable
*/
public static function mapResult(callable $f)
{
}
public static function timer()
{
}
}
}
namespace Aws\DirectoryService {
/**
* AWS Directory Service client
*
* @method \Aws\Result acceptSharedDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise acceptSharedDirectoryAsync(array $args = [])
* @method \Aws\Result addIpRoutes(array $args = [])
* @method \GuzzleHttp\Promise\Promise addIpRoutesAsync(array $args = [])
* @method \Aws\Result addTagsToResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToResourceAsync(array $args = [])
* @method \Aws\Result cancelSchemaExtension(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelSchemaExtensionAsync(array $args = [])
* @method \Aws\Result connectDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise connectDirectoryAsync(array $args = [])
* @method \Aws\Result createAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAliasAsync(array $args = [])
* @method \Aws\Result createComputer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createComputerAsync(array $args = [])
* @method \Aws\Result createConditionalForwarder(array $args = [])
* @method \GuzzleHttp\Promise\Promise createConditionalForwarderAsync(array $args = [])
* @method \Aws\Result createDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDirectoryAsync(array $args = [])
* @method \Aws\Result createLogSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLogSubscriptionAsync(array $args = [])
* @method \Aws\Result createMicrosoftAD(array $args = [])
* @method \GuzzleHttp\Promise\Promise createMicrosoftADAsync(array $args = [])
* @method \Aws\Result createSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSnapshotAsync(array $args = [])
* @method \Aws\Result createTrust(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTrustAsync(array $args = [])
* @method \Aws\Result deleteConditionalForwarder(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConditionalForwarderAsync(array $args = [])
* @method \Aws\Result deleteDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDirectoryAsync(array $args = [])
* @method \Aws\Result deleteLogSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLogSubscriptionAsync(array $args = [])
* @method \Aws\Result deleteSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSnapshotAsync(array $args = [])
* @method \Aws\Result deleteTrust(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTrustAsync(array $args = [])
* @method \Aws\Result deregisterEventTopic(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterEventTopicAsync(array $args = [])
* @method \Aws\Result describeConditionalForwarders(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConditionalForwardersAsync(array $args = [])
* @method \Aws\Result describeDirectories(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDirectoriesAsync(array $args = [])
* @method \Aws\Result describeDomainControllers(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDomainControllersAsync(array $args = [])
* @method \Aws\Result describeEventTopics(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventTopicsAsync(array $args = [])
* @method \Aws\Result describeSharedDirectories(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSharedDirectoriesAsync(array $args = [])
* @method \Aws\Result describeSnapshots(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSnapshotsAsync(array $args = [])
* @method \Aws\Result describeTrusts(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTrustsAsync(array $args = [])
* @method \Aws\Result disableRadius(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableRadiusAsync(array $args = [])
* @method \Aws\Result disableSso(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableSsoAsync(array $args = [])
* @method \Aws\Result enableRadius(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableRadiusAsync(array $args = [])
* @method \Aws\Result enableSso(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableSsoAsync(array $args = [])
* @method \Aws\Result getDirectoryLimits(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDirectoryLimitsAsync(array $args = [])
* @method \Aws\Result getSnapshotLimits(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSnapshotLimitsAsync(array $args = [])
* @method \Aws\Result listIpRoutes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIpRoutesAsync(array $args = [])
* @method \Aws\Result listLogSubscriptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listLogSubscriptionsAsync(array $args = [])
* @method \Aws\Result listSchemaExtensions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSchemaExtensionsAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result registerEventTopic(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerEventTopicAsync(array $args = [])
* @method \Aws\Result rejectSharedDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise rejectSharedDirectoryAsync(array $args = [])
* @method \Aws\Result removeIpRoutes(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeIpRoutesAsync(array $args = [])
* @method \Aws\Result removeTagsFromResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromResourceAsync(array $args = [])
* @method \Aws\Result resetUserPassword(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetUserPasswordAsync(array $args = [])
* @method \Aws\Result restoreFromSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreFromSnapshotAsync(array $args = [])
* @method \Aws\Result shareDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise shareDirectoryAsync(array $args = [])
* @method \Aws\Result startSchemaExtension(array $args = [])
* @method \GuzzleHttp\Promise\Promise startSchemaExtensionAsync(array $args = [])
* @method \Aws\Result unshareDirectory(array $args = [])
* @method \GuzzleHttp\Promise\Promise unshareDirectoryAsync(array $args = [])
* @method \Aws\Result updateConditionalForwarder(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateConditionalForwarderAsync(array $args = [])
* @method \Aws\Result updateNumberOfDomainControllers(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateNumberOfDomainControllersAsync(array $args = [])
* @method \Aws\Result updateRadius(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRadiusAsync(array $args = [])
* @method \Aws\Result updateTrust(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTrustAsync(array $args = [])
* @method \Aws\Result verifyTrust(array $args = [])
* @method \GuzzleHttp\Promise\Promise verifyTrustAsync(array $args = [])
*/
class DirectoryServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws\DirectoryService\Exception {
/**
* AWS Directory Service Exception
*/
class DirectoryServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\IoTAnalytics {
/**
* This client is used to interact with the **AWS IoT Analytics** service.
* @method \Aws\Result batchPutMessage(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchPutMessageAsync(array $args = [])
* @method \Aws\Result cancelPipelineReprocessing(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelPipelineReprocessingAsync(array $args = [])
* @method \Aws\Result createChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise createChannelAsync(array $args = [])
* @method \Aws\Result createDataset(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDatasetAsync(array $args = [])
* @method \Aws\Result createDatasetContent(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDatasetContentAsync(array $args = [])
* @method \Aws\Result createDatastore(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDatastoreAsync(array $args = [])
* @method \Aws\Result createPipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPipelineAsync(array $args = [])
* @method \Aws\Result deleteChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteChannelAsync(array $args = [])
* @method \Aws\Result deleteDataset(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDatasetAsync(array $args = [])
* @method \Aws\Result deleteDatasetContent(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDatasetContentAsync(array $args = [])
* @method \Aws\Result deleteDatastore(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDatastoreAsync(array $args = [])
* @method \Aws\Result deletePipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePipelineAsync(array $args = [])
* @method \Aws\Result describeChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeChannelAsync(array $args = [])
* @method \Aws\Result describeDataset(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDatasetAsync(array $args = [])
* @method \Aws\Result describeDatastore(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDatastoreAsync(array $args = [])
* @method \Aws\Result describeLoggingOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoggingOptionsAsync(array $args = [])
* @method \Aws\Result describePipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePipelineAsync(array $args = [])
* @method \Aws\Result getDatasetContent(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDatasetContentAsync(array $args = [])
* @method \Aws\Result listChannels(array $args = [])
* @method \GuzzleHttp\Promise\Promise listChannelsAsync(array $args = [])
* @method \Aws\Result listDatasetContents(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDatasetContentsAsync(array $args = [])
* @method \Aws\Result listDatasets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDatasetsAsync(array $args = [])
* @method \Aws\Result listDatastores(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDatastoresAsync(array $args = [])
* @method \Aws\Result listPipelines(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPipelinesAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result putLoggingOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise putLoggingOptionsAsync(array $args = [])
* @method \Aws\Result runPipelineActivity(array $args = [])
* @method \GuzzleHttp\Promise\Promise runPipelineActivityAsync(array $args = [])
* @method \Aws\Result sampleChannelData(array $args = [])
* @method \GuzzleHttp\Promise\Promise sampleChannelDataAsync(array $args = [])
* @method \Aws\Result startPipelineReprocessing(array $args = [])
* @method \GuzzleHttp\Promise\Promise startPipelineReprocessingAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateChannel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateChannelAsync(array $args = [])
* @method \Aws\Result updateDataset(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDatasetAsync(array $args = [])
* @method \Aws\Result updateDatastore(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDatastoreAsync(array $args = [])
* @method \Aws\Result updatePipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePipelineAsync(array $args = [])
*/
class IoTAnalyticsClient extends \Aws\AwsClient
{
}
}
namespace Aws\IoTAnalytics\Exception {
/**
* Represents an error interacting with the **AWS IoT Analytics** service.
*/
class IoTAnalyticsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CodePipeline {
/**
* This client is used to interact with the **Amazon CodePipeline** service.
*
* @method \Aws\Result acknowledgeJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise acknowledgeJobAsync(array $args = [])
* @method \Aws\Result acknowledgeThirdPartyJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise acknowledgeThirdPartyJobAsync(array $args = [])
* @method \Aws\Result createCustomActionType(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCustomActionTypeAsync(array $args = [])
* @method \Aws\Result createPipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPipelineAsync(array $args = [])
* @method \Aws\Result deleteCustomActionType(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCustomActionTypeAsync(array $args = [])
* @method \Aws\Result deletePipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePipelineAsync(array $args = [])
* @method \Aws\Result deleteWebhook(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteWebhookAsync(array $args = [])
* @method \Aws\Result deregisterWebhookWithThirdParty(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterWebhookWithThirdPartyAsync(array $args = [])
* @method \Aws\Result disableStageTransition(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableStageTransitionAsync(array $args = [])
* @method \Aws\Result enableStageTransition(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableStageTransitionAsync(array $args = [])
* @method \Aws\Result getJobDetails(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobDetailsAsync(array $args = [])
* @method \Aws\Result getPipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPipelineAsync(array $args = [])
* @method \Aws\Result getPipelineExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPipelineExecutionAsync(array $args = [])
* @method \Aws\Result getPipelineState(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPipelineStateAsync(array $args = [])
* @method \Aws\Result getThirdPartyJobDetails(array $args = [])
* @method \GuzzleHttp\Promise\Promise getThirdPartyJobDetailsAsync(array $args = [])
* @method \Aws\Result listActionTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listActionTypesAsync(array $args = [])
* @method \Aws\Result listPipelineExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPipelineExecutionsAsync(array $args = [])
* @method \Aws\Result listPipelines(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPipelinesAsync(array $args = [])
* @method \Aws\Result listWebhooks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listWebhooksAsync(array $args = [])
* @method \Aws\Result pollForJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise pollForJobsAsync(array $args = [])
* @method \Aws\Result pollForThirdPartyJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise pollForThirdPartyJobsAsync(array $args = [])
* @method \Aws\Result putActionRevision(array $args = [])
* @method \GuzzleHttp\Promise\Promise putActionRevisionAsync(array $args = [])
* @method \Aws\Result putApprovalResult(array $args = [])
* @method \GuzzleHttp\Promise\Promise putApprovalResultAsync(array $args = [])
* @method \Aws\Result putJobFailureResult(array $args = [])
* @method \GuzzleHttp\Promise\Promise putJobFailureResultAsync(array $args = [])
* @method \Aws\Result putJobSuccessResult(array $args = [])
* @method \GuzzleHttp\Promise\Promise putJobSuccessResultAsync(array $args = [])
* @method \Aws\Result putThirdPartyJobFailureResult(array $args = [])
* @method \GuzzleHttp\Promise\Promise putThirdPartyJobFailureResultAsync(array $args = [])
* @method \Aws\Result putThirdPartyJobSuccessResult(array $args = [])
* @method \GuzzleHttp\Promise\Promise putThirdPartyJobSuccessResultAsync(array $args = [])
* @method \Aws\Result putWebhook(array $args = [])
* @method \GuzzleHttp\Promise\Promise putWebhookAsync(array $args = [])
* @method \Aws\Result registerWebhookWithThirdParty(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerWebhookWithThirdPartyAsync(array $args = [])
* @method \Aws\Result retryStageExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise retryStageExecutionAsync(array $args = [])
* @method \Aws\Result startPipelineExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise startPipelineExecutionAsync(array $args = [])
* @method \Aws\Result updatePipeline(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePipelineAsync(array $args = [])
*/
class CodePipelineClient extends \Aws\AwsClient
{
}
}
namespace Aws\CodePipeline\Exception {
/**
* Represents an error interacting with the Amazon CodePipeline service.
*/
class CodePipelineException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Lightsail\Exception {
/**
* Represents an error interacting with the **Amazon Lightsail** service.
*/
class LightsailException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Lightsail {
/**
* This client is used to interact with the **Amazon Lightsail** service.
* @method \Aws\Result allocateStaticIp(array $args = [])
* @method \GuzzleHttp\Promise\Promise allocateStaticIpAsync(array $args = [])
* @method \Aws\Result attachDisk(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachDiskAsync(array $args = [])
* @method \Aws\Result attachInstancesToLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachInstancesToLoadBalancerAsync(array $args = [])
* @method \Aws\Result attachLoadBalancerTlsCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachLoadBalancerTlsCertificateAsync(array $args = [])
* @method \Aws\Result attachStaticIp(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachStaticIpAsync(array $args = [])
* @method \Aws\Result closeInstancePublicPorts(array $args = [])
* @method \GuzzleHttp\Promise\Promise closeInstancePublicPortsAsync(array $args = [])
* @method \Aws\Result createDisk(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDiskAsync(array $args = [])
* @method \Aws\Result createDiskFromSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDiskFromSnapshotAsync(array $args = [])
* @method \Aws\Result createDiskSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDiskSnapshotAsync(array $args = [])
* @method \Aws\Result createDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDomainAsync(array $args = [])
* @method \Aws\Result createDomainEntry(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDomainEntryAsync(array $args = [])
* @method \Aws\Result createInstanceSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInstanceSnapshotAsync(array $args = [])
* @method \Aws\Result createInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInstancesAsync(array $args = [])
* @method \Aws\Result createInstancesFromSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInstancesFromSnapshotAsync(array $args = [])
* @method \Aws\Result createKeyPair(array $args = [])
* @method \GuzzleHttp\Promise\Promise createKeyPairAsync(array $args = [])
* @method \Aws\Result createLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLoadBalancerAsync(array $args = [])
* @method \Aws\Result createLoadBalancerTlsCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLoadBalancerTlsCertificateAsync(array $args = [])
* @method \Aws\Result deleteDisk(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDiskAsync(array $args = [])
* @method \Aws\Result deleteDiskSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDiskSnapshotAsync(array $args = [])
* @method \Aws\Result deleteDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDomainAsync(array $args = [])
* @method \Aws\Result deleteDomainEntry(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDomainEntryAsync(array $args = [])
* @method \Aws\Result deleteInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInstanceAsync(array $args = [])
* @method \Aws\Result deleteInstanceSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInstanceSnapshotAsync(array $args = [])
* @method \Aws\Result deleteKeyPair(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteKeyPairAsync(array $args = [])
* @method \Aws\Result deleteLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLoadBalancerAsync(array $args = [])
* @method \Aws\Result deleteLoadBalancerTlsCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLoadBalancerTlsCertificateAsync(array $args = [])
* @method \Aws\Result detachDisk(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachDiskAsync(array $args = [])
* @method \Aws\Result detachInstancesFromLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachInstancesFromLoadBalancerAsync(array $args = [])
* @method \Aws\Result detachStaticIp(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachStaticIpAsync(array $args = [])
* @method \Aws\Result downloadDefaultKeyPair(array $args = [])
* @method \GuzzleHttp\Promise\Promise downloadDefaultKeyPairAsync(array $args = [])
* @method \Aws\Result getActiveNames(array $args = [])
* @method \GuzzleHttp\Promise\Promise getActiveNamesAsync(array $args = [])
* @method \Aws\Result getBlueprints(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBlueprintsAsync(array $args = [])
* @method \Aws\Result getBundles(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBundlesAsync(array $args = [])
* @method \Aws\Result getDisk(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDiskAsync(array $args = [])
* @method \Aws\Result getDiskSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDiskSnapshotAsync(array $args = [])
* @method \Aws\Result getDiskSnapshots(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDiskSnapshotsAsync(array $args = [])
* @method \Aws\Result getDisks(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDisksAsync(array $args = [])
* @method \Aws\Result getDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDomainAsync(array $args = [])
* @method \Aws\Result getDomains(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDomainsAsync(array $args = [])
* @method \Aws\Result getInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstanceAsync(array $args = [])
* @method \Aws\Result getInstanceAccessDetails(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstanceAccessDetailsAsync(array $args = [])
* @method \Aws\Result getInstanceMetricData(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstanceMetricDataAsync(array $args = [])
* @method \Aws\Result getInstancePortStates(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstancePortStatesAsync(array $args = [])
* @method \Aws\Result getInstanceSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstanceSnapshotAsync(array $args = [])
* @method \Aws\Result getInstanceSnapshots(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstanceSnapshotsAsync(array $args = [])
* @method \Aws\Result getInstanceState(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstanceStateAsync(array $args = [])
* @method \Aws\Result getInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInstancesAsync(array $args = [])
* @method \Aws\Result getKeyPair(array $args = [])
* @method \GuzzleHttp\Promise\Promise getKeyPairAsync(array $args = [])
* @method \Aws\Result getKeyPairs(array $args = [])
* @method \GuzzleHttp\Promise\Promise getKeyPairsAsync(array $args = [])
* @method \Aws\Result getLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLoadBalancerAsync(array $args = [])
* @method \Aws\Result getLoadBalancerMetricData(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLoadBalancerMetricDataAsync(array $args = [])
* @method \Aws\Result getLoadBalancerTlsCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLoadBalancerTlsCertificatesAsync(array $args = [])
* @method \Aws\Result getLoadBalancers(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLoadBalancersAsync(array $args = [])
* @method \Aws\Result getOperation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOperationAsync(array $args = [])
* @method \Aws\Result getOperations(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOperationsAsync(array $args = [])
* @method \Aws\Result getOperationsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOperationsForResourceAsync(array $args = [])
* @method \Aws\Result getRegions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRegionsAsync(array $args = [])
* @method \Aws\Result getStaticIp(array $args = [])
* @method \GuzzleHttp\Promise\Promise getStaticIpAsync(array $args = [])
* @method \Aws\Result getStaticIps(array $args = [])
* @method \GuzzleHttp\Promise\Promise getStaticIpsAsync(array $args = [])
* @method \Aws\Result importKeyPair(array $args = [])
* @method \GuzzleHttp\Promise\Promise importKeyPairAsync(array $args = [])
* @method \Aws\Result isVpcPeered(array $args = [])
* @method \GuzzleHttp\Promise\Promise isVpcPeeredAsync(array $args = [])
* @method \Aws\Result openInstancePublicPorts(array $args = [])
* @method \GuzzleHttp\Promise\Promise openInstancePublicPortsAsync(array $args = [])
* @method \Aws\Result peerVpc(array $args = [])
* @method \GuzzleHttp\Promise\Promise peerVpcAsync(array $args = [])
* @method \Aws\Result putInstancePublicPorts(array $args = [])
* @method \GuzzleHttp\Promise\Promise putInstancePublicPortsAsync(array $args = [])
* @method \Aws\Result rebootInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootInstanceAsync(array $args = [])
* @method \Aws\Result releaseStaticIp(array $args = [])
* @method \GuzzleHttp\Promise\Promise releaseStaticIpAsync(array $args = [])
* @method \Aws\Result startInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise startInstanceAsync(array $args = [])
* @method \Aws\Result stopInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopInstanceAsync(array $args = [])
* @method \Aws\Result unpeerVpc(array $args = [])
* @method \GuzzleHttp\Promise\Promise unpeerVpcAsync(array $args = [])
* @method \Aws\Result updateDomainEntry(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDomainEntryAsync(array $args = [])
* @method \Aws\Result updateLoadBalancerAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateLoadBalancerAttributeAsync(array $args = [])
*/
class LightsailClient extends \Aws\AwsClient
{
}
}
namespace Aws\Firehose {
/**
* This client is used to interact with the **Amazon Kinesis Firehose** service.
*
* @method \Aws\Result createDeliveryStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDeliveryStreamAsync(array $args = [])
* @method \Aws\Result deleteDeliveryStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDeliveryStreamAsync(array $args = [])
* @method \Aws\Result describeDeliveryStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDeliveryStreamAsync(array $args = [])
* @method \Aws\Result listDeliveryStreams(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeliveryStreamsAsync(array $args = [])
* @method \Aws\Result listTagsForDeliveryStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForDeliveryStreamAsync(array $args = [])
* @method \Aws\Result putRecord(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRecordAsync(array $args = [])
* @method \Aws\Result putRecordBatch(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRecordBatchAsync(array $args = [])
* @method \Aws\Result tagDeliveryStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagDeliveryStreamAsync(array $args = [])
* @method \Aws\Result untagDeliveryStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagDeliveryStreamAsync(array $args = [])
* @method \Aws\Result updateDestination(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDestinationAsync(array $args = [])
*/
class FirehoseClient extends \Aws\AwsClient
{
}
}
namespace Aws\Firehose\Exception {
/**
* Represents an error interacting with the **Amazon Kinesis Firehose** service.
*/
class FirehoseException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Appstream {
/**
* This client is used to interact with the **Amazon AppStream** service.
* @method \Aws\Result associateFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateFleetAsync(array $args = [])
* @method \Aws\Result copyImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyImageAsync(array $args = [])
* @method \Aws\Result createDirectoryConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDirectoryConfigAsync(array $args = [])
* @method \Aws\Result createFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createFleetAsync(array $args = [])
* @method \Aws\Result createImageBuilder(array $args = [])
* @method \GuzzleHttp\Promise\Promise createImageBuilderAsync(array $args = [])
* @method \Aws\Result createImageBuilderStreamingURL(array $args = [])
* @method \GuzzleHttp\Promise\Promise createImageBuilderStreamingURLAsync(array $args = [])
* @method \Aws\Result createStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStackAsync(array $args = [])
* @method \Aws\Result createStreamingURL(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStreamingURLAsync(array $args = [])
* @method \Aws\Result deleteDirectoryConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDirectoryConfigAsync(array $args = [])
* @method \Aws\Result deleteFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFleetAsync(array $args = [])
* @method \Aws\Result deleteImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteImageAsync(array $args = [])
* @method \Aws\Result deleteImageBuilder(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteImageBuilderAsync(array $args = [])
* @method \Aws\Result deleteImagePermissions(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteImagePermissionsAsync(array $args = [])
* @method \Aws\Result deleteStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStackAsync(array $args = [])
* @method \Aws\Result describeDirectoryConfigs(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDirectoryConfigsAsync(array $args = [])
* @method \Aws\Result describeFleets(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeFleetsAsync(array $args = [])
* @method \Aws\Result describeImageBuilders(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeImageBuildersAsync(array $args = [])
* @method \Aws\Result describeImagePermissions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeImagePermissionsAsync(array $args = [])
* @method \Aws\Result describeImages(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeImagesAsync(array $args = [])
* @method \Aws\Result describeSessions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSessionsAsync(array $args = [])
* @method \Aws\Result describeStacks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStacksAsync(array $args = [])
* @method \Aws\Result disassociateFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateFleetAsync(array $args = [])
* @method \Aws\Result expireSession(array $args = [])
* @method \GuzzleHttp\Promise\Promise expireSessionAsync(array $args = [])
* @method \Aws\Result listAssociatedFleets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAssociatedFleetsAsync(array $args = [])
* @method \Aws\Result listAssociatedStacks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAssociatedStacksAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result startFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise startFleetAsync(array $args = [])
* @method \Aws\Result startImageBuilder(array $args = [])
* @method \GuzzleHttp\Promise\Promise startImageBuilderAsync(array $args = [])
* @method \Aws\Result stopFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopFleetAsync(array $args = [])
* @method \Aws\Result stopImageBuilder(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopImageBuilderAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateDirectoryConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDirectoryConfigAsync(array $args = [])
* @method \Aws\Result updateFleet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFleetAsync(array $args = [])
* @method \Aws\Result updateImagePermissions(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateImagePermissionsAsync(array $args = [])
* @method \Aws\Result updateStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateStackAsync(array $args = [])
*/
class AppstreamClient extends \Aws\AwsClient
{
}
}
namespace Aws\Appstream\Exception {
/**
* Represents an error interacting with the **Amazon AppStream** service.
*/
class AppstreamException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Batch {
/**
* This client is used to interact with the **AWS Batch** service.
* @method \Aws\Result cancelJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelJobAsync(array $args = [])
* @method \Aws\Result createComputeEnvironment(array $args = [])
* @method \GuzzleHttp\Promise\Promise createComputeEnvironmentAsync(array $args = [])
* @method \Aws\Result createJobQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise createJobQueueAsync(array $args = [])
* @method \Aws\Result deleteComputeEnvironment(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteComputeEnvironmentAsync(array $args = [])
* @method \Aws\Result deleteJobQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteJobQueueAsync(array $args = [])
* @method \Aws\Result deregisterJobDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterJobDefinitionAsync(array $args = [])
* @method \Aws\Result describeComputeEnvironments(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeComputeEnvironmentsAsync(array $args = [])
* @method \Aws\Result describeJobDefinitions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeJobDefinitionsAsync(array $args = [])
* @method \Aws\Result describeJobQueues(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeJobQueuesAsync(array $args = [])
* @method \Aws\Result describeJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeJobsAsync(array $args = [])
* @method \Aws\Result listJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobsAsync(array $args = [])
* @method \Aws\Result registerJobDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerJobDefinitionAsync(array $args = [])
* @method \Aws\Result submitJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise submitJobAsync(array $args = [])
* @method \Aws\Result terminateJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise terminateJobAsync(array $args = [])
* @method \Aws\Result updateComputeEnvironment(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateComputeEnvironmentAsync(array $args = [])
* @method \Aws\Result updateJobQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateJobQueueAsync(array $args = [])
*/
class BatchClient extends \Aws\AwsClient
{
}
}
namespace Aws\Batch\Exception {
/**
* Represents an error interacting with the **AWS Batch** service.
*/
class BatchException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\IoT1ClickDevicesService {
/**
* This client is used to interact with the **AWS IoT 1-Click Devices Service** service.
* @method \Aws\Result claimDevicesByClaimCode(array $args = [])
* @method \GuzzleHttp\Promise\Promise claimDevicesByClaimCodeAsync(array $args = [])
* @method \Aws\Result describeDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDeviceAsync(array $args = [])
* @method \Aws\Result finalizeDeviceClaim(array $args = [])
* @method \GuzzleHttp\Promise\Promise finalizeDeviceClaimAsync(array $args = [])
* @method \Aws\Result getDeviceMethods(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeviceMethodsAsync(array $args = [])
* @method \Aws\Result initiateDeviceClaim(array $args = [])
* @method \GuzzleHttp\Promise\Promise initiateDeviceClaimAsync(array $args = [])
* @method \Aws\Result invokeDeviceMethod(array $args = [])
* @method \GuzzleHttp\Promise\Promise invokeDeviceMethodAsync(array $args = [])
* @method \Aws\Result listDeviceEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeviceEventsAsync(array $args = [])
* @method \Aws\Result listDevices(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDevicesAsync(array $args = [])
* @method \Aws\Result unclaimDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise unclaimDeviceAsync(array $args = [])
* @method \Aws\Result updateDeviceState(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDeviceStateAsync(array $args = [])
*/
class IoT1ClickDevicesServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws\IoT1ClickDevicesService\Exception {
/**
* Represents an error interacting with the **AWS IoT 1-Click Devices Service** service.
*/
class IoT1ClickDevicesServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
class MultiRegionClient implements \Aws\AwsClientInterface
{
use \Aws\AwsClientTrait;
public static function getArguments()
{
}
/**
* The multi-region client constructor accepts the following options:
*
* - client_factory: (callable) An optional callable that takes an array of
* client configuration arguments and returns a regionalized client.
* - partition: (Aws\Endpoint\Partition|string) AWS partition to connect to.
* Valid partitions include "aws," "aws-cn," and "aws-us-gov." Used to
* restrict the scope of the mapRegions method.
* - region: (string) Region to connect to when no override is provided.
* Used to create the default client factory and determine the appropriate
* AWS partition when present.
*
* @param array $args Client configuration arguments.
*/
public function __construct(array $args = [])
{
}
/**
* Get the region to which the client is configured to send requests by
* default.
*
* @return string
*/
public function getRegion()
{
}
/**
* Create a command for an operation name.
*
* Special keys may be set on the command to control how it behaves,
* including:
*
* - @http: Associative array of transfer specific options to apply to the
* request that is serialized for this command. Available keys include
* "proxy", "verify", "timeout", "connect_timeout", "debug", "delay", and
* "headers".
* - @region: The region to which the command should be sent.
*
* @param string $name Name of the operation to use in the command
* @param array $args Arguments to pass to the command
*
* @return CommandInterface
* @throws \InvalidArgumentException if no command can be found by name
*/
public function getCommand($name, array $args = [])
{
}
public function getConfig($option = null)
{
}
public function getCredentials()
{
}
public function getHandlerList()
{
}
public function getApi()
{
}
public function getEndpoint()
{
}
/**
* @param string $region Omit this argument or pass in an empty string to
* allow the configured client factory to apply the
* region.
*
* @return AwsClientInterface
*/
protected function getClientFromPool($region = '')
{
}
}
/**
* A command object encapsulates the input parameters used to control the
* creation of a HTTP request and processing of a HTTP response.
*
* Using the toArray() method will return the input parameters of the command
* as an associative array.
*/
interface CommandInterface extends \ArrayAccess, \Countable, \IteratorAggregate
{
/**
* Converts the command parameters to an array
*
* @return array
*/
public function toArray();
/**
* Get the name of the command
*
* @return string
*/
public function getName();
/**
* Check if the command has a parameter by name.
*
* @param string $name Name of the parameter to check
*
* @return bool
*/
public function hasParam($name);
/**
* Get the handler list used to transfer the command.
*
* @return HandlerList
*/
public function getHandlerList();
}
/**
* Iterator that yields each page of results of a pageable operation.
*/
class ResultPaginator implements \Iterator
{
/**
* @param AwsClientInterface $client
* @param string $operation
* @param array $args
* @param array $config
*/
public function __construct(\Aws\AwsClientInterface $client, $operation, array $args, array $config)
{
}
/**
* Runs a paginator asynchronously and uses a callback to handle results.
*
* The callback should have the signature: function (Aws\Result $result).
* A non-null return value from the callback will be yielded by the
* promise. This means that you can return promises from the callback that
* will need to be resolved before continuing iteration over the remaining
* items, essentially merging in other promises to the iteration. The last
* non-null value returned by the callback will be the result that fulfills
* the promise to any downstream promises.
*
* @param callable $handleResult Callback for handling each page of results.
* The callback accepts the result that was
* yielded as a single argument. If the
* callback returns a promise, the promise
* will be merged into the coroutine.
*
* @return Promise\Promise
*/
public function each(callable $handleResult)
{
}
/**
* Returns an iterator that iterates over the values of applying a JMESPath
* search to each result yielded by the iterator as a flat sequence.
*
* @param string $expression JMESPath expression to apply to each result.
*
* @return \Iterator
*/
public function search($expression)
{
}
/**
* @return Result
*/
public function current()
{
}
public function key()
{
}
public function next()
{
}
public function valid()
{
}
public function rewind()
{
}
}
}
namespace Aws\MarketplaceCommerceAnalytics {
/**
* This client is used to interact with the **AWS Marketplace Commerce Analytics** service.
*
* @method \Aws\Result generateDataSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise generateDataSetAsync(array $args = [])
* @method \Aws\Result startSupportDataExport(array $args = [])
* @method \GuzzleHttp\Promise\Promise startSupportDataExportAsync(array $args = [])
*/
class MarketplaceCommerceAnalyticsClient extends \Aws\AwsClient
{
}
}
namespace Aws\MarketplaceCommerceAnalytics\Exception {
/**
* Represents an error interacting with the **AWS Marketplace Commerce Analytics** service.
*/
class MarketplaceCommerceAnalyticsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\MarketplaceMetering {
/**
* This client is used to interact with the **AWSMarketplace Metering** service.
* @method \Aws\Result batchMeterUsage(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchMeterUsageAsync(array $args = [])
* @method \Aws\Result meterUsage(array $args = [])
* @method \GuzzleHttp\Promise\Promise meterUsageAsync(array $args = [])
* @method \Aws\Result resolveCustomer(array $args = [])
* @method \GuzzleHttp\Promise\Promise resolveCustomerAsync(array $args = [])
*/
class MarketplaceMeteringClient extends \Aws\AwsClient
{
}
}
namespace Aws\MarketplaceMetering\Exception {
/**
* Represents an error interacting with the **AWSMarketplace Metering** service.
*/
class MarketplaceMeteringException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Sns {
/**
* This client is used to interact with the **Amazon Simple Notification Service (Amazon SNS)**.
*
* @method \Aws\Result addPermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise addPermissionAsync(array $args = [])
* @method \Aws\Result checkIfPhoneNumberIsOptedOut(array $args = [])
* @method \GuzzleHttp\Promise\Promise checkIfPhoneNumberIsOptedOutAsync(array $args = [])
* @method \Aws\Result confirmSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise confirmSubscriptionAsync(array $args = [])
* @method \Aws\Result createPlatformApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPlatformApplicationAsync(array $args = [])
* @method \Aws\Result createPlatformEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPlatformEndpointAsync(array $args = [])
* @method \Aws\Result createTopic(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTopicAsync(array $args = [])
* @method \Aws\Result deleteEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEndpointAsync(array $args = [])
* @method \Aws\Result deletePlatformApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePlatformApplicationAsync(array $args = [])
* @method \Aws\Result deleteTopic(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTopicAsync(array $args = [])
* @method \Aws\Result getEndpointAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getEndpointAttributesAsync(array $args = [])
* @method \Aws\Result getPlatformApplicationAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPlatformApplicationAttributesAsync(array $args = [])
* @method \Aws\Result getSMSAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSMSAttributesAsync(array $args = [])
* @method \Aws\Result getSubscriptionAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSubscriptionAttributesAsync(array $args = [])
* @method \Aws\Result getTopicAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTopicAttributesAsync(array $args = [])
* @method \Aws\Result listEndpointsByPlatformApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise listEndpointsByPlatformApplicationAsync(array $args = [])
* @method \Aws\Result listPhoneNumbersOptedOut(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPhoneNumbersOptedOutAsync(array $args = [])
* @method \Aws\Result listPlatformApplications(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPlatformApplicationsAsync(array $args = [])
* @method \Aws\Result listSubscriptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSubscriptionsAsync(array $args = [])
* @method \Aws\Result listSubscriptionsByTopic(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSubscriptionsByTopicAsync(array $args = [])
* @method \Aws\Result listTopics(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTopicsAsync(array $args = [])
* @method \Aws\Result optInPhoneNumber(array $args = [])
* @method \GuzzleHttp\Promise\Promise optInPhoneNumberAsync(array $args = [])
* @method \Aws\Result publish(array $args = [])
* @method \GuzzleHttp\Promise\Promise publishAsync(array $args = [])
* @method \Aws\Result removePermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise removePermissionAsync(array $args = [])
* @method \Aws\Result setEndpointAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise setEndpointAttributesAsync(array $args = [])
* @method \Aws\Result setPlatformApplicationAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise setPlatformApplicationAttributesAsync(array $args = [])
* @method \Aws\Result setSMSAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise setSMSAttributesAsync(array $args = [])
* @method \Aws\Result setSubscriptionAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise setSubscriptionAttributesAsync(array $args = [])
* @method \Aws\Result setTopicAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise setTopicAttributesAsync(array $args = [])
* @method \Aws\Result subscribe(array $args = [])
* @method \GuzzleHttp\Promise\Promise subscribeAsync(array $args = [])
* @method \Aws\Result unsubscribe(array $args = [])
* @method \GuzzleHttp\Promise\Promise unsubscribeAsync(array $args = [])
*/
class SnsClient extends \Aws\AwsClient
{
}
}
namespace Aws\Sns\Exception {
/**
* Represents an error interacting with the Amazon Simple Notification Service.
*/
class SnsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* @internal Middleware that retries failures.
*/
class RetryMiddleware
{
public function __construct(callable $decider, callable $delay, callable $nextHandler, $collectStats = false)
{
}
/**
* Creates a default AWS retry decider function.
*
* @param int $maxRetries
*
* @return callable
*/
public static function createDefaultDecider($maxRetries = 3)
{
}
/**
* Delay function that calculates an exponential delay.
*
* Exponential backoff with jitter, 100ms base, 20 sec ceiling
*
* @param $retries - The number of retries that have already been attempted
*
* @return int
*
* @link https://aws.amazon.com/blogs/architecture/exponential-backoff-and-jitter/
*/
public static function exponentialDelay($retries)
{
}
/**
* @param CommandInterface $command
* @param RequestInterface $request
*
* @return PromiseInterface
*/
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\RequestInterface $request = null)
{
}
}
}
namespace Aws\Ses {
/**
* This client is used to interact with the **Amazon Simple Email Service (Amazon SES)**.
*
* @method \Aws\Result cloneReceiptRuleSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise cloneReceiptRuleSetAsync(array $args = [])
* @method \Aws\Result createConfigurationSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createConfigurationSetAsync(array $args = [])
* @method \Aws\Result createConfigurationSetEventDestination(array $args = [])
* @method \GuzzleHttp\Promise\Promise createConfigurationSetEventDestinationAsync(array $args = [])
* @method \Aws\Result createConfigurationSetTrackingOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise createConfigurationSetTrackingOptionsAsync(array $args = [])
* @method \Aws\Result createCustomVerificationEmailTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCustomVerificationEmailTemplateAsync(array $args = [])
* @method \Aws\Result createReceiptFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise createReceiptFilterAsync(array $args = [])
* @method \Aws\Result createReceiptRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise createReceiptRuleAsync(array $args = [])
* @method \Aws\Result createReceiptRuleSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createReceiptRuleSetAsync(array $args = [])
* @method \Aws\Result createTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTemplateAsync(array $args = [])
* @method \Aws\Result deleteConfigurationSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConfigurationSetAsync(array $args = [])
* @method \Aws\Result deleteConfigurationSetEventDestination(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConfigurationSetEventDestinationAsync(array $args = [])
* @method \Aws\Result deleteConfigurationSetTrackingOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConfigurationSetTrackingOptionsAsync(array $args = [])
* @method \Aws\Result deleteCustomVerificationEmailTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCustomVerificationEmailTemplateAsync(array $args = [])
* @method \Aws\Result deleteIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIdentityAsync(array $args = [])
* @method \Aws\Result deleteIdentityPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIdentityPolicyAsync(array $args = [])
* @method \Aws\Result deleteReceiptFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReceiptFilterAsync(array $args = [])
* @method \Aws\Result deleteReceiptRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReceiptRuleAsync(array $args = [])
* @method \Aws\Result deleteReceiptRuleSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteReceiptRuleSetAsync(array $args = [])
* @method \Aws\Result deleteTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTemplateAsync(array $args = [])
* @method \Aws\Result deleteVerifiedEmailAddress(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVerifiedEmailAddressAsync(array $args = [])
* @method \Aws\Result describeActiveReceiptRuleSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeActiveReceiptRuleSetAsync(array $args = [])
* @method \Aws\Result describeConfigurationSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigurationSetAsync(array $args = [])
* @method \Aws\Result describeReceiptRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReceiptRuleAsync(array $args = [])
* @method \Aws\Result describeReceiptRuleSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReceiptRuleSetAsync(array $args = [])
* @method \Aws\Result getAccountSendingEnabled(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAccountSendingEnabledAsync(array $args = [])
* @method \Aws\Result getCustomVerificationEmailTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCustomVerificationEmailTemplateAsync(array $args = [])
* @method \Aws\Result getIdentityDkimAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIdentityDkimAttributesAsync(array $args = [])
* @method \Aws\Result getIdentityMailFromDomainAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIdentityMailFromDomainAttributesAsync(array $args = [])
* @method \Aws\Result getIdentityNotificationAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIdentityNotificationAttributesAsync(array $args = [])
* @method \Aws\Result getIdentityPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIdentityPoliciesAsync(array $args = [])
* @method \Aws\Result getIdentityVerificationAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIdentityVerificationAttributesAsync(array $args = [])
* @method \Aws\Result getSendQuota(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSendQuotaAsync(array $args = [])
* @method \Aws\Result getSendStatistics(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSendStatisticsAsync(array $args = [])
* @method \Aws\Result getTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTemplateAsync(array $args = [])
* @method \Aws\Result listConfigurationSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listConfigurationSetsAsync(array $args = [])
* @method \Aws\Result listCustomVerificationEmailTemplates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCustomVerificationEmailTemplatesAsync(array $args = [])
* @method \Aws\Result listIdentities(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIdentitiesAsync(array $args = [])
* @method \Aws\Result listIdentityPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIdentityPoliciesAsync(array $args = [])
* @method \Aws\Result listReceiptFilters(array $args = [])
* @method \GuzzleHttp\Promise\Promise listReceiptFiltersAsync(array $args = [])
* @method \Aws\Result listReceiptRuleSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listReceiptRuleSetsAsync(array $args = [])
* @method \Aws\Result listTemplates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTemplatesAsync(array $args = [])
* @method \Aws\Result listVerifiedEmailAddresses(array $args = [])
* @method \GuzzleHttp\Promise\Promise listVerifiedEmailAddressesAsync(array $args = [])
* @method \Aws\Result putIdentityPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putIdentityPolicyAsync(array $args = [])
* @method \Aws\Result reorderReceiptRuleSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise reorderReceiptRuleSetAsync(array $args = [])
* @method \Aws\Result sendBounce(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendBounceAsync(array $args = [])
* @method \Aws\Result sendBulkTemplatedEmail(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendBulkTemplatedEmailAsync(array $args = [])
* @method \Aws\Result sendCustomVerificationEmail(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendCustomVerificationEmailAsync(array $args = [])
* @method \Aws\Result sendEmail(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendEmailAsync(array $args = [])
* @method \Aws\Result sendRawEmail(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendRawEmailAsync(array $args = [])
* @method \Aws\Result sendTemplatedEmail(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendTemplatedEmailAsync(array $args = [])
* @method \Aws\Result setActiveReceiptRuleSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise setActiveReceiptRuleSetAsync(array $args = [])
* @method \Aws\Result setIdentityDkimEnabled(array $args = [])
* @method \GuzzleHttp\Promise\Promise setIdentityDkimEnabledAsync(array $args = [])
* @method \Aws\Result setIdentityFeedbackForwardingEnabled(array $args = [])
* @method \GuzzleHttp\Promise\Promise setIdentityFeedbackForwardingEnabledAsync(array $args = [])
* @method \Aws\Result setIdentityHeadersInNotificationsEnabled(array $args = [])
* @method \GuzzleHttp\Promise\Promise setIdentityHeadersInNotificationsEnabledAsync(array $args = [])
* @method \Aws\Result setIdentityMailFromDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise setIdentityMailFromDomainAsync(array $args = [])
* @method \Aws\Result setIdentityNotificationTopic(array $args = [])
* @method \GuzzleHttp\Promise\Promise setIdentityNotificationTopicAsync(array $args = [])
* @method \Aws\Result setReceiptRulePosition(array $args = [])
* @method \GuzzleHttp\Promise\Promise setReceiptRulePositionAsync(array $args = [])
* @method \Aws\Result testRenderTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise testRenderTemplateAsync(array $args = [])
* @method \Aws\Result updateAccountSendingEnabled(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAccountSendingEnabledAsync(array $args = [])
* @method \Aws\Result updateConfigurationSetEventDestination(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateConfigurationSetEventDestinationAsync(array $args = [])
* @method \Aws\Result updateConfigurationSetReputationMetricsEnabled(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateConfigurationSetReputationMetricsEnabledAsync(array $args = [])
* @method \Aws\Result updateConfigurationSetSendingEnabled(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateConfigurationSetSendingEnabledAsync(array $args = [])
* @method \Aws\Result updateConfigurationSetTrackingOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateConfigurationSetTrackingOptionsAsync(array $args = [])
* @method \Aws\Result updateCustomVerificationEmailTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCustomVerificationEmailTemplateAsync(array $args = [])
* @method \Aws\Result updateReceiptRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateReceiptRuleAsync(array $args = [])
* @method \Aws\Result updateTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTemplateAsync(array $args = [])
* @method \Aws\Result verifyDomainDkim(array $args = [])
* @method \GuzzleHttp\Promise\Promise verifyDomainDkimAsync(array $args = [])
* @method \Aws\Result verifyDomainIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise verifyDomainIdentityAsync(array $args = [])
* @method \Aws\Result verifyEmailAddress(array $args = [])
* @method \GuzzleHttp\Promise\Promise verifyEmailAddressAsync(array $args = [])
* @method \Aws\Result verifyEmailIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise verifyEmailIdentityAsync(array $args = [])
*/
class SesClient extends \Aws\AwsClient
{
/**
* Create an SMTP password for a given IAM user's credentials.
*
* The SMTP username is the Access Key ID for the provided credentials.
*
* @link http://docs.aws.amazon.com/ses/latest/DeveloperGuide/smtp-credentials.html#smtp-credentials-convert
*
* @param CredentialsInterface $creds
*
* @return string
*/
public static function generateSmtpPassword(\Aws\Credentials\CredentialsInterface $creds)
{
}
/**
* @internal
* @codeCoverageIgnore
*/
public static function applyDocFilters(array $api, array $docs)
{
}
}
}
namespace Aws\Ses\Exception {
/**
* Represents an error interacting with the Amazon Simple Email Service.
*/
class SesException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\IoTJobsDataPlane\Exception {
/**
* Represents an error interacting with the **AWS IoT Jobs Data Plane** service.
*/
class IoTJobsDataPlaneException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\IoTJobsDataPlane {
/**
* This client is used to interact with the **AWS IoT Jobs Data Plane** service.
* @method \Aws\Result describeJobExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeJobExecutionAsync(array $args = [])
* @method \Aws\Result getPendingJobExecutions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPendingJobExecutionsAsync(array $args = [])
* @method \Aws\Result startNextPendingJobExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise startNextPendingJobExecutionAsync(array $args = [])
* @method \Aws\Result updateJobExecution(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateJobExecutionAsync(array $args = [])
*/
class IoTJobsDataPlaneClient extends \Aws\AwsClient
{
}
}
namespace Aws {
/**
* Builds AWS clients based on configuration settings.
*
* @method \Aws\ACMPCA\ACMPCAClient createACMPCA(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionACMPCA(array $args = [])
* @method \Aws\Acm\AcmClient createAcm(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionAcm(array $args = [])
* @method \Aws\AlexaForBusiness\AlexaForBusinessClient createAlexaForBusiness(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionAlexaForBusiness(array $args = [])
* @method \Aws\ApiGateway\ApiGatewayClient createApiGateway(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionApiGateway(array $args = [])
* @method \Aws\AppSync\AppSyncClient createAppSync(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionAppSync(array $args = [])
* @method \Aws\ApplicationAutoScaling\ApplicationAutoScalingClient createApplicationAutoScaling(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionApplicationAutoScaling(array $args = [])
* @method \Aws\ApplicationDiscoveryService\ApplicationDiscoveryServiceClient createApplicationDiscoveryService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionApplicationDiscoveryService(array $args = [])
* @method \Aws\Appstream\AppstreamClient createAppstream(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionAppstream(array $args = [])
* @method \Aws\Athena\AthenaClient createAthena(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionAthena(array $args = [])
* @method \Aws\AutoScaling\AutoScalingClient createAutoScaling(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionAutoScaling(array $args = [])
* @method \Aws\AutoScalingPlans\AutoScalingPlansClient createAutoScalingPlans(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionAutoScalingPlans(array $args = [])
* @method \Aws\Batch\BatchClient createBatch(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionBatch(array $args = [])
* @method \Aws\Budgets\BudgetsClient createBudgets(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionBudgets(array $args = [])
* @method \Aws\Cloud9\Cloud9Client createCloud9(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloud9(array $args = [])
* @method \Aws\CloudDirectory\CloudDirectoryClient createCloudDirectory(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudDirectory(array $args = [])
* @method \Aws\CloudFormation\CloudFormationClient createCloudFormation(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudFormation(array $args = [])
* @method \Aws\CloudFront\CloudFrontClient createCloudFront(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudFront(array $args = [])
* @method \Aws\CloudHSMV2\CloudHSMV2Client createCloudHSMV2(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudHSMV2(array $args = [])
* @method \Aws\CloudHsm\CloudHsmClient createCloudHsm(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudHsm(array $args = [])
* @method \Aws\CloudSearch\CloudSearchClient createCloudSearch(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudSearch(array $args = [])
* @method \Aws\CloudSearchDomain\CloudSearchDomainClient createCloudSearchDomain(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudSearchDomain(array $args = [])
* @method \Aws\CloudTrail\CloudTrailClient createCloudTrail(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudTrail(array $args = [])
* @method \Aws\CloudWatch\CloudWatchClient createCloudWatch(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudWatch(array $args = [])
* @method \Aws\CloudWatchEvents\CloudWatchEventsClient createCloudWatchEvents(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudWatchEvents(array $args = [])
* @method \Aws\CloudWatchLogs\CloudWatchLogsClient createCloudWatchLogs(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCloudWatchLogs(array $args = [])
* @method \Aws\CodeBuild\CodeBuildClient createCodeBuild(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCodeBuild(array $args = [])
* @method \Aws\CodeCommit\CodeCommitClient createCodeCommit(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCodeCommit(array $args = [])
* @method \Aws\CodeDeploy\CodeDeployClient createCodeDeploy(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCodeDeploy(array $args = [])
* @method \Aws\CodePipeline\CodePipelineClient createCodePipeline(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCodePipeline(array $args = [])
* @method \Aws\CodeStar\CodeStarClient createCodeStar(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCodeStar(array $args = [])
* @method \Aws\CognitoIdentity\CognitoIdentityClient createCognitoIdentity(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCognitoIdentity(array $args = [])
* @method \Aws\CognitoIdentityProvider\CognitoIdentityProviderClient createCognitoIdentityProvider(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCognitoIdentityProvider(array $args = [])
* @method \Aws\CognitoSync\CognitoSyncClient createCognitoSync(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCognitoSync(array $args = [])
* @method \Aws\Comprehend\ComprehendClient createComprehend(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionComprehend(array $args = [])
* @method \Aws\ConfigService\ConfigServiceClient createConfigService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionConfigService(array $args = [])
* @method \Aws\Connect\ConnectClient createConnect(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionConnect(array $args = [])
* @method \Aws\CostExplorer\CostExplorerClient createCostExplorer(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCostExplorer(array $args = [])
* @method \Aws\CostandUsageReportService\CostandUsageReportServiceClient createCostandUsageReportService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionCostandUsageReportService(array $args = [])
* @method \Aws\DAX\DAXClient createDAX(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionDAX(array $args = [])
* @method \Aws\DLM\DLMClient createDLM(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionDLM(array $args = [])
* @method \Aws\DataPipeline\DataPipelineClient createDataPipeline(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionDataPipeline(array $args = [])
* @method \Aws\DatabaseMigrationService\DatabaseMigrationServiceClient createDatabaseMigrationService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionDatabaseMigrationService(array $args = [])
* @method \Aws\DeviceFarm\DeviceFarmClient createDeviceFarm(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionDeviceFarm(array $args = [])
* @method \Aws\DirectConnect\DirectConnectClient createDirectConnect(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionDirectConnect(array $args = [])
* @method \Aws\DirectoryService\DirectoryServiceClient createDirectoryService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionDirectoryService(array $args = [])
* @method \Aws\DynamoDb\DynamoDbClient createDynamoDb(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionDynamoDb(array $args = [])
* @method \Aws\DynamoDbStreams\DynamoDbStreamsClient createDynamoDbStreams(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionDynamoDbStreams(array $args = [])
* @method \Aws\EKS\EKSClient createEKS(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionEKS(array $args = [])
* @method \Aws\Ec2\Ec2Client createEc2(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionEc2(array $args = [])
* @method \Aws\Ecr\EcrClient createEcr(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionEcr(array $args = [])
* @method \Aws\Ecs\EcsClient createEcs(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionEcs(array $args = [])
* @method \Aws\Efs\EfsClient createEfs(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionEfs(array $args = [])
* @method \Aws\ElastiCache\ElastiCacheClient createElastiCache(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionElastiCache(array $args = [])
* @method \Aws\ElasticBeanstalk\ElasticBeanstalkClient createElasticBeanstalk(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionElasticBeanstalk(array $args = [])
* @method \Aws\ElasticLoadBalancing\ElasticLoadBalancingClient createElasticLoadBalancing(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionElasticLoadBalancing(array $args = [])
* @method \Aws\ElasticLoadBalancingV2\ElasticLoadBalancingV2Client createElasticLoadBalancingV2(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionElasticLoadBalancingV2(array $args = [])
* @method \Aws\ElasticTranscoder\ElasticTranscoderClient createElasticTranscoder(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionElasticTranscoder(array $args = [])
* @method \Aws\ElasticsearchService\ElasticsearchServiceClient createElasticsearchService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionElasticsearchService(array $args = [])
* @method \Aws\Emr\EmrClient createEmr(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionEmr(array $args = [])
* @method \Aws\FMS\FMSClient createFMS(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionFMS(array $args = [])
* @method \Aws\Firehose\FirehoseClient createFirehose(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionFirehose(array $args = [])
* @method \Aws\GameLift\GameLiftClient createGameLift(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionGameLift(array $args = [])
* @method \Aws\Glacier\GlacierClient createGlacier(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionGlacier(array $args = [])
* @method \Aws\Glue\GlueClient createGlue(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionGlue(array $args = [])
* @method \Aws\Greengrass\GreengrassClient createGreengrass(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionGreengrass(array $args = [])
* @method \Aws\GuardDuty\GuardDutyClient createGuardDuty(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionGuardDuty(array $args = [])
* @method \Aws\Health\HealthClient createHealth(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionHealth(array $args = [])
* @method \Aws\Iam\IamClient createIam(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionIam(array $args = [])
* @method \Aws\ImportExport\ImportExportClient createImportExport(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionImportExport(array $args = [])
* @method \Aws\Inspector\InspectorClient createInspector(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionInspector(array $args = [])
* @method \Aws\IoT1ClickDevicesService\IoT1ClickDevicesServiceClient createIoT1ClickDevicesService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionIoT1ClickDevicesService(array $args = [])
* @method \Aws\IoT1ClickProjects\IoT1ClickProjectsClient createIoT1ClickProjects(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionIoT1ClickProjects(array $args = [])
* @method \Aws\IoTAnalytics\IoTAnalyticsClient createIoTAnalytics(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionIoTAnalytics(array $args = [])
* @method \Aws\IoTJobsDataPlane\IoTJobsDataPlaneClient createIoTJobsDataPlane(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionIoTJobsDataPlane(array $args = [])
* @method \Aws\Iot\IotClient createIot(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionIot(array $args = [])
* @method \Aws\IotDataPlane\IotDataPlaneClient createIotDataPlane(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionIotDataPlane(array $args = [])
* @method \Aws\Kinesis\KinesisClient createKinesis(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionKinesis(array $args = [])
* @method \Aws\KinesisAnalytics\KinesisAnalyticsClient createKinesisAnalytics(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionKinesisAnalytics(array $args = [])
* @method \Aws\KinesisVideo\KinesisVideoClient createKinesisVideo(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionKinesisVideo(array $args = [])
* @method \Aws\KinesisVideoArchivedMedia\KinesisVideoArchivedMediaClient createKinesisVideoArchivedMedia(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionKinesisVideoArchivedMedia(array $args = [])
* @method \Aws\KinesisVideoMedia\KinesisVideoMediaClient createKinesisVideoMedia(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionKinesisVideoMedia(array $args = [])
* @method \Aws\Kms\KmsClient createKms(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionKms(array $args = [])
* @method \Aws\Lambda\LambdaClient createLambda(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionLambda(array $args = [])
* @method \Aws\LexModelBuildingService\LexModelBuildingServiceClient createLexModelBuildingService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionLexModelBuildingService(array $args = [])
* @method \Aws\LexRuntimeService\LexRuntimeServiceClient createLexRuntimeService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionLexRuntimeService(array $args = [])
* @method \Aws\Lightsail\LightsailClient createLightsail(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionLightsail(array $args = [])
* @method \Aws\MQ\MQClient createMQ(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMQ(array $args = [])
* @method \Aws\MTurk\MTurkClient createMTurk(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMTurk(array $args = [])
* @method \Aws\MachineLearning\MachineLearningClient createMachineLearning(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMachineLearning(array $args = [])
* @method \Aws\Macie\MacieClient createMacie(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMacie(array $args = [])
* @method \Aws\MarketplaceCommerceAnalytics\MarketplaceCommerceAnalyticsClient createMarketplaceCommerceAnalytics(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMarketplaceCommerceAnalytics(array $args = [])
* @method \Aws\MarketplaceEntitlementService\MarketplaceEntitlementServiceClient createMarketplaceEntitlementService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMarketplaceEntitlementService(array $args = [])
* @method \Aws\MarketplaceMetering\MarketplaceMeteringClient createMarketplaceMetering(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMarketplaceMetering(array $args = [])
* @method \Aws\MediaConvert\MediaConvertClient createMediaConvert(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMediaConvert(array $args = [])
* @method \Aws\MediaLive\MediaLiveClient createMediaLive(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMediaLive(array $args = [])
* @method \Aws\MediaPackage\MediaPackageClient createMediaPackage(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMediaPackage(array $args = [])
* @method \Aws\MediaStore\MediaStoreClient createMediaStore(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMediaStore(array $args = [])
* @method \Aws\MediaStoreData\MediaStoreDataClient createMediaStoreData(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMediaStoreData(array $args = [])
* @method \Aws\MediaTailor\MediaTailorClient createMediaTailor(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMediaTailor(array $args = [])
* @method \Aws\MigrationHub\MigrationHubClient createMigrationHub(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMigrationHub(array $args = [])
* @method \Aws\Mobile\MobileClient createMobile(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionMobile(array $args = [])
* @method \Aws\Neptune\NeptuneClient createNeptune(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionNeptune(array $args = [])
* @method \Aws\OpsWorks\OpsWorksClient createOpsWorks(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionOpsWorks(array $args = [])
* @method \Aws\OpsWorksCM\OpsWorksCMClient createOpsWorksCM(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionOpsWorksCM(array $args = [])
* @method \Aws\Organizations\OrganizationsClient createOrganizations(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionOrganizations(array $args = [])
* @method \Aws\PI\PIClient createPI(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionPI(array $args = [])
* @method \Aws\Pinpoint\PinpointClient createPinpoint(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionPinpoint(array $args = [])
* @method \Aws\Polly\PollyClient createPolly(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionPolly(array $args = [])
* @method \Aws\Pricing\PricingClient createPricing(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionPricing(array $args = [])
* @method \Aws\Rds\RdsClient createRds(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionRds(array $args = [])
* @method \Aws\Redshift\RedshiftClient createRedshift(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionRedshift(array $args = [])
* @method \Aws\Rekognition\RekognitionClient createRekognition(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionRekognition(array $args = [])
* @method \Aws\ResourceGroups\ResourceGroupsClient createResourceGroups(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionResourceGroups(array $args = [])
* @method \Aws\ResourceGroupsTaggingAPI\ResourceGroupsTaggingAPIClient createResourceGroupsTaggingAPI(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionResourceGroupsTaggingAPI(array $args = [])
* @method \Aws\Route53\Route53Client createRoute53(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionRoute53(array $args = [])
* @method \Aws\Route53Domains\Route53DomainsClient createRoute53Domains(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionRoute53Domains(array $args = [])
* @method \Aws\S3\S3Client createS3(array $args = [])
* @method \Aws\S3\S3MultiRegionClient createMultiRegionS3(array $args = [])
* @method \Aws\SageMaker\SageMakerClient createSageMaker(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSageMaker(array $args = [])
* @method \Aws\SageMakerRuntime\SageMakerRuntimeClient createSageMakerRuntime(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSageMakerRuntime(array $args = [])
* @method \Aws\SecretsManager\SecretsManagerClient createSecretsManager(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSecretsManager(array $args = [])
* @method \Aws\ServerlessApplicationRepository\ServerlessApplicationRepositoryClient createServerlessApplicationRepository(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionServerlessApplicationRepository(array $args = [])
* @method \Aws\ServiceCatalog\ServiceCatalogClient createServiceCatalog(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionServiceCatalog(array $args = [])
* @method \Aws\ServiceDiscovery\ServiceDiscoveryClient createServiceDiscovery(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionServiceDiscovery(array $args = [])
* @method \Aws\Ses\SesClient createSes(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSes(array $args = [])
* @method \Aws\Sfn\SfnClient createSfn(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSfn(array $args = [])
* @method \Aws\Shield\ShieldClient createShield(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionShield(array $args = [])
* @method \Aws\Sms\SmsClient createSms(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSms(array $args = [])
* @method \Aws\SnowBall\SnowBallClient createSnowBall(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSnowBall(array $args = [])
* @method \Aws\Sns\SnsClient createSns(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSns(array $args = [])
* @method \Aws\Sqs\SqsClient createSqs(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSqs(array $args = [])
* @method \Aws\Ssm\SsmClient createSsm(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSsm(array $args = [])
* @method \Aws\StorageGateway\StorageGatewayClient createStorageGateway(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionStorageGateway(array $args = [])
* @method \Aws\Sts\StsClient createSts(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSts(array $args = [])
* @method \Aws\Support\SupportClient createSupport(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSupport(array $args = [])
* @method \Aws\Swf\SwfClient createSwf(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionSwf(array $args = [])
* @method \Aws\TranscribeService\TranscribeServiceClient createTranscribeService(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionTranscribeService(array $args = [])
* @method \Aws\Translate\TranslateClient createTranslate(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionTranslate(array $args = [])
* @method \Aws\Waf\WafClient createWaf(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionWaf(array $args = [])
* @method \Aws\WafRegional\WafRegionalClient createWafRegional(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionWafRegional(array $args = [])
* @method \Aws\WorkDocs\WorkDocsClient createWorkDocs(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionWorkDocs(array $args = [])
* @method \Aws\WorkMail\WorkMailClient createWorkMail(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionWorkMail(array $args = [])
* @method \Aws\WorkSpaces\WorkSpacesClient createWorkSpaces(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionWorkSpaces(array $args = [])
* @method \Aws\XRay\XRayClient createXRay(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionXRay(array $args = [])
* @method \Aws\signer\signerClient createsigner(array $args = [])
* @method \Aws\MultiRegionClient createMultiRegionsigner(array $args = [])
*/
class Sdk
{
const VERSION = '3.69.2';
/**
* Constructs a new SDK object with an associative array of default
* client settings.
*
* @param array $args
*
* @throws \InvalidArgumentException
* @see Aws\AwsClient::__construct for a list of available options.
*/
public function __construct(array $args = [])
{
}
public function __call($name, array $args)
{
}
/**
* Get a client by name using an array of constructor options.
*
* @param string $name Service name or namespace (e.g., DynamoDb, s3).
* @param array $args Arguments to configure the client.
*
* @return AwsClientInterface
* @throws \InvalidArgumentException if any required options are missing or
* the service is not supported.
* @see Aws\AwsClient::__construct for a list of available options for args.
*/
public function createClient($name, array $args = [])
{
}
public function createMultiRegionClient($name, array $args = [])
{
}
/**
* Determine the endpoint prefix from a client namespace.
*
* @param string $name Namespace name
*
* @return string
* @internal
* @deprecated Use the `\Aws\manifest()` function instead.
*/
public static function getEndpointPrefix($name)
{
}
}
}
namespace Aws\SecretsManager\Exception {
/**
* Represents an error interacting with the **AWS Secrets Manager** service.
*/
class SecretsManagerException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\SecretsManager {
/**
* This client is used to interact with the **AWS Secrets Manager** service.
* @method \Aws\Result cancelRotateSecret(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelRotateSecretAsync(array $args = [])
* @method \Aws\Result createSecret(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSecretAsync(array $args = [])
* @method \Aws\Result deleteResourcePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteResourcePolicyAsync(array $args = [])
* @method \Aws\Result deleteSecret(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSecretAsync(array $args = [])
* @method \Aws\Result describeSecret(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSecretAsync(array $args = [])
* @method \Aws\Result getRandomPassword(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRandomPasswordAsync(array $args = [])
* @method \Aws\Result getResourcePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getResourcePolicyAsync(array $args = [])
* @method \Aws\Result getSecretValue(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSecretValueAsync(array $args = [])
* @method \Aws\Result listSecretVersionIds(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSecretVersionIdsAsync(array $args = [])
* @method \Aws\Result listSecrets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSecretsAsync(array $args = [])
* @method \Aws\Result putResourcePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putResourcePolicyAsync(array $args = [])
* @method \Aws\Result putSecretValue(array $args = [])
* @method \GuzzleHttp\Promise\Promise putSecretValueAsync(array $args = [])
* @method \Aws\Result restoreSecret(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreSecretAsync(array $args = [])
* @method \Aws\Result rotateSecret(array $args = [])
* @method \GuzzleHttp\Promise\Promise rotateSecretAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateSecret(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSecretAsync(array $args = [])
* @method \Aws\Result updateSecretVersionStage(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSecretVersionStageAsync(array $args = [])
*/
class SecretsManagerClient extends \Aws\AwsClient
{
}
}
namespace Aws\AutoScaling {
/**
* Auto Scaling client.
*
* @method \Aws\Result attachInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachInstancesAsync(array $args = [])
* @method \Aws\Result attachLoadBalancerTargetGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachLoadBalancerTargetGroupsAsync(array $args = [])
* @method \Aws\Result attachLoadBalancers(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachLoadBalancersAsync(array $args = [])
* @method \Aws\Result batchDeleteScheduledAction(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDeleteScheduledActionAsync(array $args = [])
* @method \Aws\Result batchPutScheduledUpdateGroupAction(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchPutScheduledUpdateGroupActionAsync(array $args = [])
* @method \Aws\Result completeLifecycleAction(array $args = [])
* @method \GuzzleHttp\Promise\Promise completeLifecycleActionAsync(array $args = [])
* @method \Aws\Result createAutoScalingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAutoScalingGroupAsync(array $args = [])
* @method \Aws\Result createLaunchConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLaunchConfigurationAsync(array $args = [])
* @method \Aws\Result createOrUpdateTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise createOrUpdateTagsAsync(array $args = [])
* @method \Aws\Result deleteAutoScalingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAutoScalingGroupAsync(array $args = [])
* @method \Aws\Result deleteLaunchConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLaunchConfigurationAsync(array $args = [])
* @method \Aws\Result deleteLifecycleHook(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLifecycleHookAsync(array $args = [])
* @method \Aws\Result deleteNotificationConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNotificationConfigurationAsync(array $args = [])
* @method \Aws\Result deletePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePolicyAsync(array $args = [])
* @method \Aws\Result deleteScheduledAction(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteScheduledActionAsync(array $args = [])
* @method \Aws\Result deleteTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTagsAsync(array $args = [])
* @method \Aws\Result describeAccountLimits(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAccountLimitsAsync(array $args = [])
* @method \Aws\Result describeAdjustmentTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAdjustmentTypesAsync(array $args = [])
* @method \Aws\Result describeAutoScalingGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAutoScalingGroupsAsync(array $args = [])
* @method \Aws\Result describeAutoScalingInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAutoScalingInstancesAsync(array $args = [])
* @method \Aws\Result describeAutoScalingNotificationTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAutoScalingNotificationTypesAsync(array $args = [])
* @method \Aws\Result describeLaunchConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLaunchConfigurationsAsync(array $args = [])
* @method \Aws\Result describeLifecycleHookTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLifecycleHookTypesAsync(array $args = [])
* @method \Aws\Result describeLifecycleHooks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLifecycleHooksAsync(array $args = [])
* @method \Aws\Result describeLoadBalancerTargetGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoadBalancerTargetGroupsAsync(array $args = [])
* @method \Aws\Result describeLoadBalancers(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoadBalancersAsync(array $args = [])
* @method \Aws\Result describeMetricCollectionTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMetricCollectionTypesAsync(array $args = [])
* @method \Aws\Result describeNotificationConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNotificationConfigurationsAsync(array $args = [])
* @method \Aws\Result describePolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePoliciesAsync(array $args = [])
* @method \Aws\Result describeScalingActivities(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScalingActivitiesAsync(array $args = [])
* @method \Aws\Result describeScalingProcessTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScalingProcessTypesAsync(array $args = [])
* @method \Aws\Result describeScheduledActions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScheduledActionsAsync(array $args = [])
* @method \Aws\Result describeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagsAsync(array $args = [])
* @method \Aws\Result describeTerminationPolicyTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTerminationPolicyTypesAsync(array $args = [])
* @method \Aws\Result detachInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachInstancesAsync(array $args = [])
* @method \Aws\Result detachLoadBalancerTargetGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachLoadBalancerTargetGroupsAsync(array $args = [])
* @method \Aws\Result detachLoadBalancers(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachLoadBalancersAsync(array $args = [])
* @method \Aws\Result disableMetricsCollection(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableMetricsCollectionAsync(array $args = [])
* @method \Aws\Result enableMetricsCollection(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableMetricsCollectionAsync(array $args = [])
* @method \Aws\Result enterStandby(array $args = [])
* @method \GuzzleHttp\Promise\Promise enterStandbyAsync(array $args = [])
* @method \Aws\Result executePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise executePolicyAsync(array $args = [])
* @method \Aws\Result exitStandby(array $args = [])
* @method \GuzzleHttp\Promise\Promise exitStandbyAsync(array $args = [])
* @method \Aws\Result putLifecycleHook(array $args = [])
* @method \GuzzleHttp\Promise\Promise putLifecycleHookAsync(array $args = [])
* @method \Aws\Result putNotificationConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putNotificationConfigurationAsync(array $args = [])
* @method \Aws\Result putScalingPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putScalingPolicyAsync(array $args = [])
* @method \Aws\Result putScheduledUpdateGroupAction(array $args = [])
* @method \GuzzleHttp\Promise\Promise putScheduledUpdateGroupActionAsync(array $args = [])
* @method \Aws\Result recordLifecycleActionHeartbeat(array $args = [])
* @method \GuzzleHttp\Promise\Promise recordLifecycleActionHeartbeatAsync(array $args = [])
* @method \Aws\Result resumeProcesses(array $args = [])
* @method \GuzzleHttp\Promise\Promise resumeProcessesAsync(array $args = [])
* @method \Aws\Result setDesiredCapacity(array $args = [])
* @method \GuzzleHttp\Promise\Promise setDesiredCapacityAsync(array $args = [])
* @method \Aws\Result setInstanceHealth(array $args = [])
* @method \GuzzleHttp\Promise\Promise setInstanceHealthAsync(array $args = [])
* @method \Aws\Result setInstanceProtection(array $args = [])
* @method \GuzzleHttp\Promise\Promise setInstanceProtectionAsync(array $args = [])
* @method \Aws\Result suspendProcesses(array $args = [])
* @method \GuzzleHttp\Promise\Promise suspendProcessesAsync(array $args = [])
* @method \Aws\Result terminateInstanceInAutoScalingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise terminateInstanceInAutoScalingGroupAsync(array $args = [])
* @method \Aws\Result updateAutoScalingGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAutoScalingGroupAsync(array $args = [])
*/
class AutoScalingClient extends \Aws\AwsClient
{
}
}
namespace Aws\AutoScaling\Exception {
/**
* Represents an error while interacting with the Auto Scaling service.
*/
class AutoScalingException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* Builds a single handler function from zero or more middleware functions and
* a handler. The handler function is then used to send command objects and
* return a promise that is resolved with an AWS result object.
*
* The "front" of the list is invoked before the "end" of the list. You can add
* middleware to the front of the list using one of the "prepend" method, and
* the end of the list using one of the "append" method. The last function
* invoked in a handler list is the handler (a function that does not accept a
* next handler but rather is responsible for returning a promise that is
* fulfilled with an Aws\ResultInterface object).
*
* Handlers are ordered using a "step" that describes the step at which the
* SDK is when sending a command. The available steps are:
*
* - init: The command is being initialized, allowing you to do things like add
* default options.
* - validate: The command is being validated before it is serialized
* - build: The command is being serialized into an HTTP request. A middleware
* in this step MUST serialize an HTTP request and populate the "@request"
* parameter of a command with the request such that it is available to
* subsequent middleware.
* - sign: The request is being signed and prepared to be sent over the wire.
*
* Middleware can be registered with a name to allow you to easily add a
* middleware before or after another middleware by name. This also allows you
* to remove a middleware by name (in addition to removing by instance).
*/
class HandlerList implements \Countable
{
const INIT = 'init';
const VALIDATE = 'validate';
const BUILD = 'build';
const SIGN = 'sign';
const ATTEMPT = 'attempt';
/**
* @param callable $handler HTTP handler.
*/
public function __construct(callable $handler = null)
{
}
/**
* Dumps a string representation of the list.
*
* @return string
*/
public function __toString()
{
}
/**
* Set the HTTP handler that actually returns a response.
*
* @param callable $handler Function that accepts a request and array of
* options and returns a Promise.
*/
public function setHandler(callable $handler)
{
}
/**
* Returns true if the builder has a handler.
*
* @return bool
*/
public function hasHandler()
{
}
/**
* Append a middleware to the init step.
*
* @param callable $middleware Middleware function to add.
* @param string $name Name of the middleware.
*/
public function appendInit(callable $middleware, $name = null)
{
}
/**
* Prepend a middleware to the init step.
*
* @param callable $middleware Middleware function to add.
* @param string $name Name of the middleware.
*/
public function prependInit(callable $middleware, $name = null)
{
}
/**
* Append a middleware to the validate step.
*
* @param callable $middleware Middleware function to add.
* @param string $name Name of the middleware.
*/
public function appendValidate(callable $middleware, $name = null)
{
}
/**
* Prepend a middleware to the validate step.
*
* @param callable $middleware Middleware function to add.
* @param string $name Name of the middleware.
*/
public function prependValidate(callable $middleware, $name = null)
{
}
/**
* Append a middleware to the build step.
*
* @param callable $middleware Middleware function to add.
* @param string $name Name of the middleware.
*/
public function appendBuild(callable $middleware, $name = null)
{
}
/**
* Prepend a middleware to the build step.
*
* @param callable $middleware Middleware function to add.
* @param string $name Name of the middleware.
*/
public function prependBuild(callable $middleware, $name = null)
{
}
/**
* Append a middleware to the sign step.
*
* @param callable $middleware Middleware function to add.
* @param string $name Name of the middleware.
*/
public function appendSign(callable $middleware, $name = null)
{
}
/**
* Prepend a middleware to the sign step.
*
* @param callable $middleware Middleware function to add.
* @param string $name Name of the middleware.
*/
public function prependSign(callable $middleware, $name = null)
{
}
/**
* Append a middleware to the attempt step.
*
* @param callable $middleware Middleware function to add.
* @param string $name Name of the middleware.
*/
public function appendAttempt(callable $middleware, $name = null)
{
}
/**
* Prepend a middleware to the attempt step.
*
* @param callable $middleware Middleware function to add.
* @param string $name Name of the middleware.
*/
public function prependAttempt(callable $middleware, $name = null)
{
}
/**
* Add a middleware before the given middleware by name.
*
* @param string|callable $findName Add before this
* @param string $withName Optional name to give the middleware
* @param callable $middleware Middleware to add.
*/
public function before($findName, $withName, callable $middleware)
{
}
/**
* Add a middleware after the given middleware by name.
*
* @param string|callable $findName Add after this
* @param string $withName Optional name to give the middleware
* @param callable $middleware Middleware to add.
*/
public function after($findName, $withName, callable $middleware)
{
}
/**
* Remove a middleware by name or by instance from the list.
*
* @param string|callable $nameOrInstance Middleware to remove.
*/
public function remove($nameOrInstance)
{
}
/**
* Interpose a function between each middleware (e.g., allowing for a trace
* through the middleware layers).
*
* The interpose function is a function that accepts a "step" argument as a
* string and a "name" argument string. This function must then return a
* function that accepts the next handler in the list. This function must
* then return a function that accepts a CommandInterface and optional
* RequestInterface and returns a promise that is fulfilled with an
* Aws\ResultInterface or rejected with an Aws\Exception\AwsException
* object.
*
* @param callable|null $fn Pass null to remove any previously set function
*/
public function interpose(callable $fn = null)
{
}
/**
* Compose the middleware and handler into a single callable function.
*
* @return callable
*/
public function resolve()
{
}
public function count()
{
}
}
}
namespace Aws\MediaConvert {
/**
* This client is used to interact with the **AWS Elemental MediaConvert** service.
* @method \Aws\Result cancelJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelJobAsync(array $args = [])
* @method \Aws\Result createJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createJobAsync(array $args = [])
* @method \Aws\Result createJobTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise createJobTemplateAsync(array $args = [])
* @method \Aws\Result createPreset(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPresetAsync(array $args = [])
* @method \Aws\Result createQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise createQueueAsync(array $args = [])
* @method \Aws\Result deleteJobTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteJobTemplateAsync(array $args = [])
* @method \Aws\Result deletePreset(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePresetAsync(array $args = [])
* @method \Aws\Result deleteQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteQueueAsync(array $args = [])
* @method \Aws\Result describeEndpoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEndpointsAsync(array $args = [])
* @method \Aws\Result getJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobAsync(array $args = [])
* @method \Aws\Result getJobTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobTemplateAsync(array $args = [])
* @method \Aws\Result getPreset(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPresetAsync(array $args = [])
* @method \Aws\Result getQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise getQueueAsync(array $args = [])
* @method \Aws\Result listJobTemplates(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobTemplatesAsync(array $args = [])
* @method \Aws\Result listJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobsAsync(array $args = [])
* @method \Aws\Result listPresets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPresetsAsync(array $args = [])
* @method \Aws\Result listQueues(array $args = [])
* @method \GuzzleHttp\Promise\Promise listQueuesAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateJobTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateJobTemplateAsync(array $args = [])
* @method \Aws\Result updatePreset(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePresetAsync(array $args = [])
* @method \Aws\Result updateQueue(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateQueueAsync(array $args = [])
*/
class MediaConvertClient extends \Aws\AwsClient
{
}
}
namespace Aws\MediaConvert\Exception {
/**
* Represents an error interacting with the **AWS Elemental MediaConvert** service.
*/
class MediaConvertException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\StorageGateway {
/**
* AWS Storage Gateway client.
*
* @method \Aws\Result activateGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise activateGatewayAsync(array $args = [])
* @method \Aws\Result addCache(array $args = [])
* @method \GuzzleHttp\Promise\Promise addCacheAsync(array $args = [])
* @method \Aws\Result addTagsToResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToResourceAsync(array $args = [])
* @method \Aws\Result addUploadBuffer(array $args = [])
* @method \GuzzleHttp\Promise\Promise addUploadBufferAsync(array $args = [])
* @method \Aws\Result addWorkingStorage(array $args = [])
* @method \GuzzleHttp\Promise\Promise addWorkingStorageAsync(array $args = [])
* @method \Aws\Result cancelArchival(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelArchivalAsync(array $args = [])
* @method \Aws\Result cancelRetrieval(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelRetrievalAsync(array $args = [])
* @method \Aws\Result createCachediSCSIVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCachediSCSIVolumeAsync(array $args = [])
* @method \Aws\Result createNFSFileShare(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNFSFileShareAsync(array $args = [])
* @method \Aws\Result createSMBFileShare(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSMBFileShareAsync(array $args = [])
* @method \Aws\Result createSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSnapshotAsync(array $args = [])
* @method \Aws\Result createSnapshotFromVolumeRecoveryPoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSnapshotFromVolumeRecoveryPointAsync(array $args = [])
* @method \Aws\Result createStorediSCSIVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStorediSCSIVolumeAsync(array $args = [])
* @method \Aws\Result createTapeWithBarcode(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTapeWithBarcodeAsync(array $args = [])
* @method \Aws\Result createTapes(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTapesAsync(array $args = [])
* @method \Aws\Result deleteBandwidthRateLimit(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBandwidthRateLimitAsync(array $args = [])
* @method \Aws\Result deleteChapCredentials(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteChapCredentialsAsync(array $args = [])
* @method \Aws\Result deleteFileShare(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFileShareAsync(array $args = [])
* @method \Aws\Result deleteGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGatewayAsync(array $args = [])
* @method \Aws\Result deleteSnapshotSchedule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSnapshotScheduleAsync(array $args = [])
* @method \Aws\Result deleteTape(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTapeAsync(array $args = [])
* @method \Aws\Result deleteTapeArchive(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTapeArchiveAsync(array $args = [])
* @method \Aws\Result deleteVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVolumeAsync(array $args = [])
* @method \Aws\Result describeBandwidthRateLimit(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeBandwidthRateLimitAsync(array $args = [])
* @method \Aws\Result describeCache(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCacheAsync(array $args = [])
* @method \Aws\Result describeCachediSCSIVolumes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCachediSCSIVolumesAsync(array $args = [])
* @method \Aws\Result describeChapCredentials(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeChapCredentialsAsync(array $args = [])
* @method \Aws\Result describeGatewayInformation(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeGatewayInformationAsync(array $args = [])
* @method \Aws\Result describeMaintenanceStartTime(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMaintenanceStartTimeAsync(array $args = [])
* @method \Aws\Result describeNFSFileShares(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNFSFileSharesAsync(array $args = [])
* @method \Aws\Result describeSMBFileShares(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSMBFileSharesAsync(array $args = [])
* @method \Aws\Result describeSMBSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSMBSettingsAsync(array $args = [])
* @method \Aws\Result describeSnapshotSchedule(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSnapshotScheduleAsync(array $args = [])
* @method \Aws\Result describeStorediSCSIVolumes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStorediSCSIVolumesAsync(array $args = [])
* @method \Aws\Result describeTapeArchives(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTapeArchivesAsync(array $args = [])
* @method \Aws\Result describeTapeRecoveryPoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTapeRecoveryPointsAsync(array $args = [])
* @method \Aws\Result describeTapes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTapesAsync(array $args = [])
* @method \Aws\Result describeUploadBuffer(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUploadBufferAsync(array $args = [])
* @method \Aws\Result describeVTLDevices(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVTLDevicesAsync(array $args = [])
* @method \Aws\Result describeWorkingStorage(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeWorkingStorageAsync(array $args = [])
* @method \Aws\Result disableGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableGatewayAsync(array $args = [])
* @method \Aws\Result joinDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise joinDomainAsync(array $args = [])
* @method \Aws\Result listFileShares(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFileSharesAsync(array $args = [])
* @method \Aws\Result listGateways(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGatewaysAsync(array $args = [])
* @method \Aws\Result listLocalDisks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listLocalDisksAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result listTapes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTapesAsync(array $args = [])
* @method \Aws\Result listVolumeInitiators(array $args = [])
* @method \GuzzleHttp\Promise\Promise listVolumeInitiatorsAsync(array $args = [])
* @method \Aws\Result listVolumeRecoveryPoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise listVolumeRecoveryPointsAsync(array $args = [])
* @method \Aws\Result listVolumes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listVolumesAsync(array $args = [])
* @method \Aws\Result notifyWhenUploaded(array $args = [])
* @method \GuzzleHttp\Promise\Promise notifyWhenUploadedAsync(array $args = [])
* @method \Aws\Result refreshCache(array $args = [])
* @method \GuzzleHttp\Promise\Promise refreshCacheAsync(array $args = [])
* @method \Aws\Result removeTagsFromResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromResourceAsync(array $args = [])
* @method \Aws\Result resetCache(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetCacheAsync(array $args = [])
* @method \Aws\Result retrieveTapeArchive(array $args = [])
* @method \GuzzleHttp\Promise\Promise retrieveTapeArchiveAsync(array $args = [])
* @method \Aws\Result retrieveTapeRecoveryPoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise retrieveTapeRecoveryPointAsync(array $args = [])
* @method \Aws\Result setLocalConsolePassword(array $args = [])
* @method \GuzzleHttp\Promise\Promise setLocalConsolePasswordAsync(array $args = [])
* @method \Aws\Result setSMBGuestPassword(array $args = [])
* @method \GuzzleHttp\Promise\Promise setSMBGuestPasswordAsync(array $args = [])
* @method \Aws\Result shutdownGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise shutdownGatewayAsync(array $args = [])
* @method \Aws\Result startGateway(array $args = [])
* @method \GuzzleHttp\Promise\Promise startGatewayAsync(array $args = [])
* @method \Aws\Result updateBandwidthRateLimit(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateBandwidthRateLimitAsync(array $args = [])
* @method \Aws\Result updateChapCredentials(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateChapCredentialsAsync(array $args = [])
* @method \Aws\Result updateGatewayInformation(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGatewayInformationAsync(array $args = [])
* @method \Aws\Result updateGatewaySoftwareNow(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGatewaySoftwareNowAsync(array $args = [])
* @method \Aws\Result updateMaintenanceStartTime(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateMaintenanceStartTimeAsync(array $args = [])
* @method \Aws\Result updateNFSFileShare(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateNFSFileShareAsync(array $args = [])
* @method \Aws\Result updateSMBFileShare(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSMBFileShareAsync(array $args = [])
* @method \Aws\Result updateSnapshotSchedule(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSnapshotScheduleAsync(array $args = [])
* @method \Aws\Result updateVTLDeviceType(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateVTLDeviceTypeAsync(array $args = [])
*/
class StorageGatewayClient extends \Aws\AwsClient
{
}
}
namespace Aws\StorageGateway\Exception {
/**
* Represents an error interacting with the AWS Storage Gateway service.
*/
class StorageGatewayException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Route53Domains {
/**
* This client is used to interact with the **Amazon Route 53 Domains** service.
*
* @method \Aws\Result checkDomainAvailability(array $args = [])
* @method \GuzzleHttp\Promise\Promise checkDomainAvailabilityAsync(array $args = [])
* @method \Aws\Result checkDomainTransferability(array $args = [])
* @method \GuzzleHttp\Promise\Promise checkDomainTransferabilityAsync(array $args = [])
* @method \Aws\Result deleteTagsForDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTagsForDomainAsync(array $args = [])
* @method \Aws\Result disableDomainAutoRenew(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableDomainAutoRenewAsync(array $args = [])
* @method \Aws\Result disableDomainTransferLock(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableDomainTransferLockAsync(array $args = [])
* @method \Aws\Result enableDomainAutoRenew(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableDomainAutoRenewAsync(array $args = [])
* @method \Aws\Result enableDomainTransferLock(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableDomainTransferLockAsync(array $args = [])
* @method \Aws\Result getContactReachabilityStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getContactReachabilityStatusAsync(array $args = [])
* @method \Aws\Result getDomainDetail(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDomainDetailAsync(array $args = [])
* @method \Aws\Result getDomainSuggestions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDomainSuggestionsAsync(array $args = [])
* @method \Aws\Result getOperationDetail(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOperationDetailAsync(array $args = [])
* @method \Aws\Result listDomains(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDomainsAsync(array $args = [])
* @method \Aws\Result listOperations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listOperationsAsync(array $args = [])
* @method \Aws\Result listTagsForDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForDomainAsync(array $args = [])
* @method \Aws\Result registerDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerDomainAsync(array $args = [])
* @method \Aws\Result renewDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise renewDomainAsync(array $args = [])
* @method \Aws\Result resendContactReachabilityEmail(array $args = [])
* @method \GuzzleHttp\Promise\Promise resendContactReachabilityEmailAsync(array $args = [])
* @method \Aws\Result retrieveDomainAuthCode(array $args = [])
* @method \GuzzleHttp\Promise\Promise retrieveDomainAuthCodeAsync(array $args = [])
* @method \Aws\Result transferDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise transferDomainAsync(array $args = [])
* @method \Aws\Result updateDomainContact(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDomainContactAsync(array $args = [])
* @method \Aws\Result updateDomainContactPrivacy(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDomainContactPrivacyAsync(array $args = [])
* @method \Aws\Result updateDomainNameservers(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDomainNameserversAsync(array $args = [])
* @method \Aws\Result updateTagsForDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTagsForDomainAsync(array $args = [])
* @method \Aws\Result viewBilling(array $args = [])
* @method \GuzzleHttp\Promise\Promise viewBillingAsync(array $args = [])
*/
class Route53DomainsClient extends \Aws\AwsClient
{
}
}
namespace Aws\Route53Domains\Exception {
/**
* Represents an error interacting with the Amazon Route 53 Domains service.
*/
class Route53DomainsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Neptune\Exception {
/**
* Represents an error interacting with the **Amazon Neptune** service.
*/
class NeptuneException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Neptune {
/**
* This client is used to interact with the **Amazon Neptune** service.
* @method \Aws\Result addRoleToDBCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise addRoleToDBClusterAsync(array $args = [])
* @method \Aws\Result addSourceIdentifierToSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise addSourceIdentifierToSubscriptionAsync(array $args = [])
* @method \Aws\Result addTagsToResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsToResourceAsync(array $args = [])
* @method \Aws\Result applyPendingMaintenanceAction(array $args = [])
* @method \GuzzleHttp\Promise\Promise applyPendingMaintenanceActionAsync(array $args = [])
* @method \Aws\Result copyDBClusterParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyDBClusterParameterGroupAsync(array $args = [])
* @method \Aws\Result copyDBClusterSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyDBClusterSnapshotAsync(array $args = [])
* @method \Aws\Result copyDBParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyDBParameterGroupAsync(array $args = [])
* @method \Aws\Result createDBCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBClusterAsync(array $args = [])
* @method \Aws\Result createDBClusterParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBClusterParameterGroupAsync(array $args = [])
* @method \Aws\Result createDBClusterSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBClusterSnapshotAsync(array $args = [])
* @method \Aws\Result createDBInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBInstanceAsync(array $args = [])
* @method \Aws\Result createDBParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBParameterGroupAsync(array $args = [])
* @method \Aws\Result createDBSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDBSubnetGroupAsync(array $args = [])
* @method \Aws\Result createEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEventSubscriptionAsync(array $args = [])
* @method \Aws\Result deleteDBCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBClusterAsync(array $args = [])
* @method \Aws\Result deleteDBClusterParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBClusterParameterGroupAsync(array $args = [])
* @method \Aws\Result deleteDBClusterSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBClusterSnapshotAsync(array $args = [])
* @method \Aws\Result deleteDBInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBInstanceAsync(array $args = [])
* @method \Aws\Result deleteDBParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBParameterGroupAsync(array $args = [])
* @method \Aws\Result deleteDBSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDBSubnetGroupAsync(array $args = [])
* @method \Aws\Result deleteEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEventSubscriptionAsync(array $args = [])
* @method \Aws\Result describeDBClusterParameterGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBClusterParameterGroupsAsync(array $args = [])
* @method \Aws\Result describeDBClusterParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBClusterParametersAsync(array $args = [])
* @method \Aws\Result describeDBClusterSnapshotAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBClusterSnapshotAttributesAsync(array $args = [])
* @method \Aws\Result describeDBClusterSnapshots(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBClusterSnapshotsAsync(array $args = [])
* @method \Aws\Result describeDBClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBClustersAsync(array $args = [])
* @method \Aws\Result describeDBEngineVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBEngineVersionsAsync(array $args = [])
* @method \Aws\Result describeDBInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBInstancesAsync(array $args = [])
* @method \Aws\Result describeDBParameterGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBParameterGroupsAsync(array $args = [])
* @method \Aws\Result describeDBParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBParametersAsync(array $args = [])
* @method \Aws\Result describeDBSubnetGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDBSubnetGroupsAsync(array $args = [])
* @method \Aws\Result describeEngineDefaultClusterParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEngineDefaultClusterParametersAsync(array $args = [])
* @method \Aws\Result describeEngineDefaultParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEngineDefaultParametersAsync(array $args = [])
* @method \Aws\Result describeEventCategories(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventCategoriesAsync(array $args = [])
* @method \Aws\Result describeEventSubscriptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventSubscriptionsAsync(array $args = [])
* @method \Aws\Result describeEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventsAsync(array $args = [])
* @method \Aws\Result describeOrderableDBInstanceOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOrderableDBInstanceOptionsAsync(array $args = [])
* @method \Aws\Result describePendingMaintenanceActions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePendingMaintenanceActionsAsync(array $args = [])
* @method \Aws\Result describeValidDBInstanceModifications(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeValidDBInstanceModificationsAsync(array $args = [])
* @method \Aws\Result failoverDBCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise failoverDBClusterAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result modifyDBCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyDBClusterAsync(array $args = [])
* @method \Aws\Result modifyDBClusterParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyDBClusterParameterGroupAsync(array $args = [])
* @method \Aws\Result modifyDBClusterSnapshotAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyDBClusterSnapshotAttributeAsync(array $args = [])
* @method \Aws\Result modifyDBInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyDBInstanceAsync(array $args = [])
* @method \Aws\Result modifyDBParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyDBParameterGroupAsync(array $args = [])
* @method \Aws\Result modifyDBSubnetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyDBSubnetGroupAsync(array $args = [])
* @method \Aws\Result modifyEventSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyEventSubscriptionAsync(array $args = [])
* @method \Aws\Result promoteReadReplicaDBCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise promoteReadReplicaDBClusterAsync(array $args = [])
* @method \Aws\Result rebootDBInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootDBInstanceAsync(array $args = [])
* @method \Aws\Result removeRoleFromDBCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeRoleFromDBClusterAsync(array $args = [])
* @method \Aws\Result removeSourceIdentifierFromSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeSourceIdentifierFromSubscriptionAsync(array $args = [])
* @method \Aws\Result removeTagsFromResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsFromResourceAsync(array $args = [])
* @method \Aws\Result resetDBClusterParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetDBClusterParameterGroupAsync(array $args = [])
* @method \Aws\Result resetDBParameterGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetDBParameterGroupAsync(array $args = [])
* @method \Aws\Result restoreDBClusterFromSnapshot(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreDBClusterFromSnapshotAsync(array $args = [])
* @method \Aws\Result restoreDBClusterToPointInTime(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreDBClusterToPointInTimeAsync(array $args = [])
*/
class NeptuneClient extends \Aws\AwsClient
{
}
}
namespace Aws\Waf\Exception {
/**
* Represents an error interacting with the **AWS WAF** service.
*/
class WafException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Waf {
/**
* This client is used to interact with the **AWS WAF** service.
*
* @method \Aws\Result createByteMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createByteMatchSetAsync(array $args = [])
* @method \Aws\Result createGeoMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGeoMatchSetAsync(array $args = [])
* @method \Aws\Result createIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createIPSetAsync(array $args = [])
* @method \Aws\Result createRateBasedRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRateBasedRuleAsync(array $args = [])
* @method \Aws\Result createRegexMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRegexMatchSetAsync(array $args = [])
* @method \Aws\Result createRegexPatternSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRegexPatternSetAsync(array $args = [])
* @method \Aws\Result createRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRuleAsync(array $args = [])
* @method \Aws\Result createRuleGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRuleGroupAsync(array $args = [])
* @method \Aws\Result createSizeConstraintSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSizeConstraintSetAsync(array $args = [])
* @method \Aws\Result createSqlInjectionMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSqlInjectionMatchSetAsync(array $args = [])
* @method \Aws\Result createWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise createWebACLAsync(array $args = [])
* @method \Aws\Result createXssMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createXssMatchSetAsync(array $args = [])
* @method \Aws\Result deleteByteMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteByteMatchSetAsync(array $args = [])
* @method \Aws\Result deleteGeoMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGeoMatchSetAsync(array $args = [])
* @method \Aws\Result deleteIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIPSetAsync(array $args = [])
* @method \Aws\Result deleteLoggingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLoggingConfigurationAsync(array $args = [])
* @method \Aws\Result deletePermissionPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePermissionPolicyAsync(array $args = [])
* @method \Aws\Result deleteRateBasedRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRateBasedRuleAsync(array $args = [])
* @method \Aws\Result deleteRegexMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRegexMatchSetAsync(array $args = [])
* @method \Aws\Result deleteRegexPatternSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRegexPatternSetAsync(array $args = [])
* @method \Aws\Result deleteRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRuleAsync(array $args = [])
* @method \Aws\Result deleteRuleGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRuleGroupAsync(array $args = [])
* @method \Aws\Result deleteSizeConstraintSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSizeConstraintSetAsync(array $args = [])
* @method \Aws\Result deleteSqlInjectionMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSqlInjectionMatchSetAsync(array $args = [])
* @method \Aws\Result deleteWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteWebACLAsync(array $args = [])
* @method \Aws\Result deleteXssMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteXssMatchSetAsync(array $args = [])
* @method \Aws\Result getByteMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getByteMatchSetAsync(array $args = [])
* @method \Aws\Result getChangeToken(array $args = [])
* @method \GuzzleHttp\Promise\Promise getChangeTokenAsync(array $args = [])
* @method \Aws\Result getChangeTokenStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getChangeTokenStatusAsync(array $args = [])
* @method \Aws\Result getGeoMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGeoMatchSetAsync(array $args = [])
* @method \Aws\Result getIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIPSetAsync(array $args = [])
* @method \Aws\Result getLoggingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLoggingConfigurationAsync(array $args = [])
* @method \Aws\Result getPermissionPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPermissionPolicyAsync(array $args = [])
* @method \Aws\Result getRateBasedRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRateBasedRuleAsync(array $args = [])
* @method \Aws\Result getRateBasedRuleManagedKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRateBasedRuleManagedKeysAsync(array $args = [])
* @method \Aws\Result getRegexMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRegexMatchSetAsync(array $args = [])
* @method \Aws\Result getRegexPatternSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRegexPatternSetAsync(array $args = [])
* @method \Aws\Result getRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRuleAsync(array $args = [])
* @method \Aws\Result getRuleGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRuleGroupAsync(array $args = [])
* @method \Aws\Result getSampledRequests(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSampledRequestsAsync(array $args = [])
* @method \Aws\Result getSizeConstraintSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSizeConstraintSetAsync(array $args = [])
* @method \Aws\Result getSqlInjectionMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSqlInjectionMatchSetAsync(array $args = [])
* @method \Aws\Result getWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise getWebACLAsync(array $args = [])
* @method \Aws\Result getXssMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getXssMatchSetAsync(array $args = [])
* @method \Aws\Result listActivatedRulesInRuleGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise listActivatedRulesInRuleGroupAsync(array $args = [])
* @method \Aws\Result listByteMatchSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listByteMatchSetsAsync(array $args = [])
* @method \Aws\Result listGeoMatchSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGeoMatchSetsAsync(array $args = [])
* @method \Aws\Result listIPSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIPSetsAsync(array $args = [])
* @method \Aws\Result listLoggingConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listLoggingConfigurationsAsync(array $args = [])
* @method \Aws\Result listRateBasedRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRateBasedRulesAsync(array $args = [])
* @method \Aws\Result listRegexMatchSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRegexMatchSetsAsync(array $args = [])
* @method \Aws\Result listRegexPatternSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRegexPatternSetsAsync(array $args = [])
* @method \Aws\Result listRuleGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRuleGroupsAsync(array $args = [])
* @method \Aws\Result listRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRulesAsync(array $args = [])
* @method \Aws\Result listSizeConstraintSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSizeConstraintSetsAsync(array $args = [])
* @method \Aws\Result listSqlInjectionMatchSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSqlInjectionMatchSetsAsync(array $args = [])
* @method \Aws\Result listSubscribedRuleGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSubscribedRuleGroupsAsync(array $args = [])
* @method \Aws\Result listWebACLs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listWebACLsAsync(array $args = [])
* @method \Aws\Result listXssMatchSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listXssMatchSetsAsync(array $args = [])
* @method \Aws\Result putLoggingConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putLoggingConfigurationAsync(array $args = [])
* @method \Aws\Result putPermissionPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putPermissionPolicyAsync(array $args = [])
* @method \Aws\Result updateByteMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateByteMatchSetAsync(array $args = [])
* @method \Aws\Result updateGeoMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGeoMatchSetAsync(array $args = [])
* @method \Aws\Result updateIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateIPSetAsync(array $args = [])
* @method \Aws\Result updateRateBasedRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRateBasedRuleAsync(array $args = [])
* @method \Aws\Result updateRegexMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRegexMatchSetAsync(array $args = [])
* @method \Aws\Result updateRegexPatternSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRegexPatternSetAsync(array $args = [])
* @method \Aws\Result updateRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRuleAsync(array $args = [])
* @method \Aws\Result updateRuleGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRuleGroupAsync(array $args = [])
* @method \Aws\Result updateSizeConstraintSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSizeConstraintSetAsync(array $args = [])
* @method \Aws\Result updateSqlInjectionMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSqlInjectionMatchSetAsync(array $args = [])
* @method \Aws\Result updateWebACL(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateWebACLAsync(array $args = [])
* @method \Aws\Result updateXssMatchSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateXssMatchSetAsync(array $args = [])
*/
class WafClient extends \Aws\AwsClient
{
}
}
namespace Aws\EKS\Exception {
/**
* Represents an error interacting with the **Amazon Elastic Container Service for Kubernetes** service.
*/
class EKSException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\EKS {
/**
* This client is used to interact with the **Amazon Elastic Container Service for Kubernetes** service.
* @method \Aws\Result createCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClusterAsync(array $args = [])
* @method \Aws\Result deleteCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClusterAsync(array $args = [])
* @method \Aws\Result describeCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeClusterAsync(array $args = [])
* @method \Aws\Result listClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise listClustersAsync(array $args = [])
*/
class EKSClient extends \Aws\AwsClient
{
}
}
namespace Aws\Sts {
/**
* This client is used to interact with the **AWS Security Token Service (AWS STS)**.
*
* @method \Aws\Result assumeRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise assumeRoleAsync(array $args = [])
* @method \Aws\Result assumeRoleWithSAML(array $args = [])
* @method \GuzzleHttp\Promise\Promise assumeRoleWithSAMLAsync(array $args = [])
* @method \Aws\Result assumeRoleWithWebIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise assumeRoleWithWebIdentityAsync(array $args = [])
* @method \Aws\Result decodeAuthorizationMessage(array $args = [])
* @method \GuzzleHttp\Promise\Promise decodeAuthorizationMessageAsync(array $args = [])
* @method \Aws\Result getCallerIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCallerIdentityAsync(array $args = [])
* @method \Aws\Result getFederationToken(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFederationTokenAsync(array $args = [])
* @method \Aws\Result getSessionToken(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSessionTokenAsync(array $args = [])
*/
class StsClient extends \Aws\AwsClient
{
/**
* Creates credentials from the result of an STS operations
*
* @param Result $result Result of an STS operation
*
* @return Credentials
* @throws \InvalidArgumentException if the result contains no credentials
*/
public function createCredentials(\Aws\Result $result)
{
}
}
}
namespace Aws\Sts\Exception {
/**
* AWS Security Token Service exception.
*/
class StsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ApplicationDiscoveryService\Exception {
/**
* Represents an error interacting with the **AWS Application Discovery Service** service.
*/
class ApplicationDiscoveryServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ApplicationDiscoveryService {
/**
* This client is used to interact with the **AWS Application Discovery Service** service.
* @method \Aws\Result associateConfigurationItemsToApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateConfigurationItemsToApplicationAsync(array $args = [])
* @method \Aws\Result createApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise createApplicationAsync(array $args = [])
* @method \Aws\Result createTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTagsAsync(array $args = [])
* @method \Aws\Result deleteApplications(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApplicationsAsync(array $args = [])
* @method \Aws\Result deleteTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTagsAsync(array $args = [])
* @method \Aws\Result describeAgents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAgentsAsync(array $args = [])
* @method \Aws\Result describeConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigurationsAsync(array $args = [])
* @method \Aws\Result describeContinuousExports(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeContinuousExportsAsync(array $args = [])
* @method \Aws\Result describeExportConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeExportConfigurationsAsync(array $args = [])
* @method \Aws\Result describeExportTasks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeExportTasksAsync(array $args = [])
* @method \Aws\Result describeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagsAsync(array $args = [])
* @method \Aws\Result disassociateConfigurationItemsFromApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateConfigurationItemsFromApplicationAsync(array $args = [])
* @method \Aws\Result exportConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise exportConfigurationsAsync(array $args = [])
* @method \Aws\Result getDiscoverySummary(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDiscoverySummaryAsync(array $args = [])
* @method \Aws\Result listConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listConfigurationsAsync(array $args = [])
* @method \Aws\Result listServerNeighbors(array $args = [])
* @method \GuzzleHttp\Promise\Promise listServerNeighborsAsync(array $args = [])
* @method \Aws\Result startContinuousExport(array $args = [])
* @method \GuzzleHttp\Promise\Promise startContinuousExportAsync(array $args = [])
* @method \Aws\Result startDataCollectionByAgentIds(array $args = [])
* @method \GuzzleHttp\Promise\Promise startDataCollectionByAgentIdsAsync(array $args = [])
* @method \Aws\Result startExportTask(array $args = [])
* @method \GuzzleHttp\Promise\Promise startExportTaskAsync(array $args = [])
* @method \Aws\Result stopContinuousExport(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopContinuousExportAsync(array $args = [])
* @method \Aws\Result stopDataCollectionByAgentIds(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopDataCollectionByAgentIdsAsync(array $args = [])
* @method \Aws\Result updateApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApplicationAsync(array $args = [])
*/
class ApplicationDiscoveryServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws\Api {
/**
* Base class that is used by most API shapes
*/
abstract class AbstractModel implements \ArrayAccess
{
/** @var array */
protected $definition;
/** @var ShapeMap */
protected $shapeMap;
/**
* @param array $definition Service description
* @param ShapeMap $shapeMap Shapemap used for creating shapes
*/
public function __construct(array $definition, \Aws\Api\ShapeMap $shapeMap)
{
}
public function toArray()
{
}
public function offsetGet($offset)
{
}
public function offsetSet($offset, $value)
{
}
public function offsetExists($offset)
{
}
public function offsetUnset($offset)
{
}
protected function shapeAt($key)
{
}
protected function shapeFor(array $definition)
{
}
}
/**
* Base class representing a modeled shape.
*/
class Shape extends \Aws\Api\AbstractModel
{
/**
* Get a concrete shape for the given definition.
*
* @param array $definition
* @param ShapeMap $shapeMap
*
* @return mixed
* @throws \RuntimeException if the type is invalid
*/
public static function create(array $definition, \Aws\Api\ShapeMap $shapeMap)
{
}
/**
* Get the type of the shape
*
* @return string
*/
public function getType()
{
}
/**
* Get the name of the shape
*
* @return string
*/
public function getName()
{
}
}
/**
* Represents a structure shape and resolve member shape references.
*/
class StructureShape extends \Aws\Api\Shape
{
public function __construct(array $definition, \Aws\Api\ShapeMap $shapeMap)
{
}
/**
* Gets a list of all members
*
* @return Shape[]
*/
public function getMembers()
{
}
/**
* Check if a specific member exists by name.
*
* @param string $name Name of the member to check
*
* @return bool
*/
public function hasMember($name)
{
}
/**
* Retrieve a member by name.
*
* @param string $name Name of the member to retrieve
*
* @return Shape
* @throws \InvalidArgumentException if the member is not found.
*/
public function getMember($name)
{
}
}
}
namespace Aws\Api\Parser {
/**
* @internal
*/
abstract class AbstractParser
{
/** @var \Aws\Api\Service Representation of the service API*/
protected $api;
/** @var callable */
protected $parser;
/**
* @param Service $api Service description.
*/
public function __construct(\Aws\Api\Service $api)
{
}
/**
* @param CommandInterface $command Command that was executed.
* @param ResponseInterface $response Response that was received.
*
* @return ResultInterface
*/
public abstract function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\ResponseInterface $response);
public abstract function parseMemberFromStream(\Psr\Http\Message\StreamInterface $stream, \Aws\Api\StructureShape $member, $response);
}
trait PayloadParserTrait
{
/**
* @param string $json
*
* @throws ParserException
*
* @return array
*/
private function parseJson($json, $response)
{
}
/**
* @param string $xml
*
* @throws ParserException
*
* @return \SimpleXMLElement
*/
private function parseXml($xml, $response)
{
}
}
/**
* @internal
*/
abstract class AbstractRestParser extends \Aws\Api\Parser\AbstractParser
{
use \Aws\Api\Parser\PayloadParserTrait;
/**
* Parses a payload from a response.
*
* @param ResponseInterface $response Response to parse.
* @param StructureShape $member Member to parse
* @param array $result Result value
*
* @return mixed
*/
protected abstract function payload(\Psr\Http\Message\ResponseInterface $response, \Aws\Api\StructureShape $member, array &$result);
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\ResponseInterface $response)
{
}
}
/**
* @internal Implements REST-JSON parsing (e.g., Glacier, Elastic Transcoder)
*/
class RestJsonParser extends \Aws\Api\Parser\AbstractRestParser
{
use \Aws\Api\Parser\PayloadParserTrait;
/**
* @param Service $api Service description
* @param JsonParser $parser JSON body builder
*/
public function __construct(\Aws\Api\Service $api, \Aws\Api\Parser\JsonParser $parser = null)
{
}
protected function payload(\Psr\Http\Message\ResponseInterface $response, \Aws\Api\StructureShape $member, array &$result)
{
}
public function parseMemberFromStream(\Psr\Http\Message\StreamInterface $stream, \Aws\Api\StructureShape $member, $response)
{
}
}
/**
* @internal Implements REST-XML parsing (e.g., S3, CloudFront, etc...)
*/
class RestXmlParser extends \Aws\Api\Parser\AbstractRestParser
{
use \Aws\Api\Parser\PayloadParserTrait;
/**
* @param Service $api Service description
* @param XmlParser $parser XML body parser
*/
public function __construct(\Aws\Api\Service $api, \Aws\Api\Parser\XmlParser $parser = null)
{
}
protected function payload(\Psr\Http\Message\ResponseInterface $response, \Aws\Api\StructureShape $member, array &$result)
{
}
public function parseMemberFromStream(\Psr\Http\Message\StreamInterface $stream, \Aws\Api\StructureShape $member, $response)
{
}
}
/**
* @internal Implements a decoder for a binary encoded event stream that will
* decode, validate, and provide individual events from the stream.
*/
class EventParsingIterator implements \Iterator
{
public function __construct(\Psr\Http\Message\StreamInterface $stream, \Aws\Api\StructureShape $shape, \Aws\Api\Parser\AbstractParser $parser)
{
}
public function current()
{
}
public function key()
{
}
public function next()
{
}
public function rewind()
{
}
public function valid()
{
}
}
/**
* @internal Decorates a parser and validates the x-amz-crc32 header.
*/
class Crc32ValidatingParser extends \Aws\Api\Parser\AbstractParser
{
/**
* @param callable $parser Parser to wrap.
*/
public function __construct(callable $parser)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\ResponseInterface $response)
{
}
public function parseMemberFromStream(\Psr\Http\Message\StreamInterface $stream, \Aws\Api\StructureShape $member, $response)
{
}
}
/**
* @internal Parses query (XML) responses (e.g., EC2, SQS, and many others)
*/
class QueryParser extends \Aws\Api\Parser\AbstractParser
{
use \Aws\Api\Parser\PayloadParserTrait;
/**
* @param Service $api Service description
* @param XmlParser $xmlParser Optional XML parser
* @param bool $honorResultWrapper Set to false to disable the peeling
* back of result wrappers from the
* output structure.
*/
public function __construct(\Aws\Api\Service $api, \Aws\Api\Parser\XmlParser $xmlParser = null, $honorResultWrapper = true)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\ResponseInterface $response)
{
}
public function parseMemberFromStream(\Psr\Http\Message\StreamInterface $stream, \Aws\Api\StructureShape $member, $response)
{
}
}
/**
* @internal Implements standard JSON parsing.
*/
class JsonParser
{
public function parse(\Aws\Api\Shape $shape, $value)
{
}
}
}
namespace Aws\Api\Parser\Exception {
class ParserException extends \RuntimeException implements \Aws\MonitoringEventsInterface, \Aws\ResponseContainerInterface
{
use \Aws\HasMonitoringEventsTrait;
public function __construct($message = '', $code = 0, $previous = null, array $context = [])
{
}
/**
* Get the received HTTP response if any.
*
* @return ResponseInterface|null
*/
public function getResponse()
{
}
}
}
namespace Aws\Api\Parser {
/**
* @internal Implements JSON-RPC parsing (e.g., DynamoDB)
*/
class JsonRpcParser extends \Aws\Api\Parser\AbstractParser
{
use \Aws\Api\Parser\PayloadParserTrait;
/**
* @param Service $api Service description
* @param JsonParser $parser JSON body builder
*/
public function __construct(\Aws\Api\Service $api, \Aws\Api\Parser\JsonParser $parser = null)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\ResponseInterface $response)
{
}
public function parseMemberFromStream(\Psr\Http\Message\StreamInterface $stream, \Aws\Api\StructureShape $member, $response)
{
}
}
/**
* @internal Implements standard XML parsing for REST-XML and Query protocols.
*/
class XmlParser
{
public function parse(\Aws\Api\StructureShape $shape, \SimpleXMLElement $value)
{
}
}
/**
* @internal Implements a decoder for a binary encoded event stream that will
* decode, validate, and provide individual events from the stream.
*/
class DecodingEventStreamIterator implements \Iterator
{
const HEADERS = 'headers';
const PAYLOAD = 'payload';
const LENGTH_TOTAL = 'total_length';
const LENGTH_HEADERS = 'headers_length';
const CRC_PRELUDE = 'prelude_crc';
const BYTES_PRELUDE = 12;
const BYTES_TRAILING = 4;
/**
* DecodingEventStreamIterator constructor.
*
* @param StreamInterface $stream
*/
public function __construct(\Psr\Http\Message\StreamInterface $stream)
{
}
// Iterator Functionality
/**
* @return array
*/
public function current()
{
}
/**
* @return int
*/
public function key()
{
}
public function next()
{
}
public function rewind()
{
}
/**
* @return bool
*/
public function valid()
{
}
}
}
namespace Aws\Api {
/**
* Builds shape based on shape references.
*/
class ShapeMap
{
/**
* @param array $shapeModels Associative array of shape definitions.
*/
public function __construct(array $shapeModels)
{
}
/**
* Get an array of shape names.
*
* @return array
*/
public function getShapeNames()
{
}
/**
* Resolve a shape reference
*
* @param array $shapeRef Shape reference shape
*
* @return Shape
* @throws \InvalidArgumentException
*/
public function resolve(array $shapeRef)
{
}
}
/**
* Encapsulates the documentation strings for a given service-version and
* provides methods for extracting the desired parts related to a service,
* operation, error, or shape (i.e., parameter).
*/
class DocModel
{
/**
* @param array $docs
*
* @throws \RuntimeException
*/
public function __construct(array $docs)
{
}
/**
* Convert the doc model to an array.
*
* @return array
*/
public function toArray()
{
}
/**
* Retrieves documentation about the service.
*
* @return null|string
*/
public function getServiceDocs()
{
}
/**
* Retrieves documentation about an operation.
*
* @param string $operation Name of the operation
*
* @return null|string
*/
public function getOperationDocs($operation)
{
}
/**
* Retrieves documentation about an error.
*
* @param string $error Name of the error
*
* @return null|string
*/
public function getErrorDocs($error)
{
}
/**
* Retrieves documentation about a shape, specific to the context.
*
* @param string $shapeName Name of the shape.
* @param string $parentName Name of the parent/context shape.
* @param string $ref Name used by the context to reference the shape.
*
* @return null|string
*/
public function getShapeDocs($shapeName, $parentName, $ref)
{
}
}
/**
* DateTime overrides that make DateTime work more seamlessly as a string,
* with JSON documents, and with JMESPath.
*/
class DateTimeResult extends \DateTime implements \JsonSerializable
{
/**
* Create a new DateTimeResult from a unix timestamp.
*
* @param $unixTimestamp
*
* @return DateTimeResult
*/
public static function fromEpoch($unixTimestamp)
{
}
/**
* Serialize the DateTimeResult as an ISO 8601 date string.
*
* @return string
*/
public function __toString()
{
}
/**
* Serialize the date as an ISO 8601 date when serializing as JSON.
*
* @return mixed|string
*/
public function jsonSerialize()
{
}
}
/**
* Represents a map shape.
*/
class MapShape extends \Aws\Api\Shape
{
public function __construct(array $definition, \Aws\Api\ShapeMap $shapeMap)
{
}
/**
* @return Shape
* @throws \RuntimeException if no value is specified
*/
public function getValue()
{
}
/**
* @return Shape
*/
public function getKey()
{
}
}
/**
* Represents a timestamp shape.
*/
class TimestampShape extends \Aws\Api\Shape
{
public function __construct(array $definition, \Aws\Api\ShapeMap $shapeMap)
{
}
/**
* Formats a timestamp value for a service.
*
* @param mixed $value Value to format
* @param string $format Format used to serialize the value
*
* @return int|string
* @throws \UnexpectedValueException if the format is unknown.
* @throws \InvalidArgumentException if the value is an unsupported type.
*/
public static function format($value, $format)
{
}
}
/**
* Represents an API operation.
*/
class Operation extends \Aws\Api\AbstractModel
{
public function __construct(array $definition, \Aws\Api\ShapeMap $shapeMap)
{
}
/**
* Returns an associative array of the HTTP attribute of the operation:
*
* - method: HTTP method of the operation
* - requestUri: URI of the request (can include URI template placeholders)
*
* @return array
*/
public function getHttp()
{
}
/**
* Get the input shape of the operation.
*
* @return StructureShape
*/
public function getInput()
{
}
/**
* Get the output shape of the operation.
*
* @return StructureShape
*/
public function getOutput()
{
}
/**
* Get an array of operation error shapes.
*
* @return Shape[]
*/
public function getErrors()
{
}
}
}
namespace Aws\Api\ErrorParser {
/**
* Provides basic JSON error parsing functionality.
*/
trait JsonParserTrait
{
use \Aws\Api\Parser\PayloadParserTrait;
private function genericHandler(\Psr\Http\Message\ResponseInterface $response)
{
}
}
/**
* Parsers JSON-RPC errors.
*/
class JsonRpcErrorParser
{
use \Aws\Api\ErrorParser\JsonParserTrait;
public function __invoke(\Psr\Http\Message\ResponseInterface $response)
{
}
}
/**
* Parses XML errors.
*/
class XmlErrorParser
{
use \Aws\Api\Parser\PayloadParserTrait;
public function __invoke(\Psr\Http\Message\ResponseInterface $response)
{
}
}
/**
* Parses JSON-REST errors.
*/
class RestJsonErrorParser
{
use \Aws\Api\ErrorParser\JsonParserTrait;
public function __invoke(\Psr\Http\Message\ResponseInterface $response)
{
}
}
}
namespace Aws\Api {
/**
* Represents a list shape.
*/
class ListShape extends \Aws\Api\Shape
{
public function __construct(array $definition, \Aws\Api\ShapeMap $shapeMap)
{
}
/**
* @return Shape
* @throws \RuntimeException if no member is specified
*/
public function getMember()
{
}
}
}
namespace Aws\Api\Serializer {
/**
* Serializes HTTP locations like header, uri, payload, etc...
* @internal
*/
abstract class RestSerializer
{
/**
* @param Service $api Service API description
* @param string $endpoint Endpoint to connect to
*/
public function __construct(\Aws\Api\Service $api, $endpoint)
{
}
/**
* @param CommandInterface $command Command to serialized
*
* @return RequestInterface
*/
public function __invoke(\Aws\CommandInterface $command)
{
}
/**
* Modifies a hash of request options for a payload body.
*
* @param StructureShape $member Member to serialize
* @param array $value Value to serialize
* @param array $opts Request options to modify.
*/
protected abstract function payload(\Aws\Api\StructureShape $member, array $value, array &$opts);
}
/**
* Serializes requests for the REST-JSON protocol.
* @internal
*/
class RestJsonSerializer extends \Aws\Api\Serializer\RestSerializer
{
/**
* @param Service $api Service API description
* @param string $endpoint Endpoint to connect to
* @param JsonBody $jsonFormatter Optional JSON formatter to use
*/
public function __construct(\Aws\Api\Service $api, $endpoint, \Aws\Api\Serializer\JsonBody $jsonFormatter = null)
{
}
protected function payload(\Aws\Api\StructureShape $member, array $value, array &$opts)
{
}
}
/**
* @internal
*/
class QueryParamBuilder
{
protected function queryName(\Aws\Api\Shape $shape, $default = null)
{
}
protected function isFlat(\Aws\Api\Shape $shape)
{
}
public function __invoke(\Aws\Api\StructureShape $shape, array $params)
{
}
protected function format(\Aws\Api\Shape $shape, $value, $prefix, array &$query)
{
}
protected function format_structure(\Aws\Api\StructureShape $shape, array $value, $prefix, &$query)
{
}
protected function format_list(\Aws\Api\ListShape $shape, array $value, $prefix, &$query)
{
}
protected function format_map(\Aws\Api\MapShape $shape, array $value, $prefix, array &$query)
{
}
protected function format_blob(\Aws\Api\Shape $shape, $value, $prefix, array &$query)
{
}
protected function format_timestamp(\Aws\Api\TimestampShape $shape, $value, $prefix, array &$query)
{
}
protected function format_boolean(\Aws\Api\Shape $shape, $value, $prefix, array &$query)
{
}
}
/**
* @internal
*/
class Ec2ParamBuilder extends \Aws\Api\Serializer\QueryParamBuilder
{
protected function queryName(\Aws\Api\Shape $shape, $default = null)
{
}
protected function isFlat(\Aws\Api\Shape $shape)
{
}
protected function format_list(\Aws\Api\ListShape $shape, array $value, $prefix, &$query)
{
}
}
/**
* Formats the JSON body of a JSON-REST or JSON-RPC operation.
* @internal
*/
class JsonBody
{
public function __construct(\Aws\Api\Service $api)
{
}
/**
* Gets the JSON Content-Type header for a service API
*
* @param Service $service
*
* @return string
*/
public static function getContentType(\Aws\Api\Service $service)
{
}
/**
* Builds the JSON body based on an array of arguments.
*
* @param Shape $shape Operation being constructed
* @param array $args Associative array of arguments
*
* @return string
*/
public function build(\Aws\Api\Shape $shape, array $args)
{
}
}
/**
* @internal Formats the XML body of a REST-XML services.
*/
class XmlBody
{
/**
* @param Service $api API being used to create the XML body.
*/
public function __construct(\Aws\Api\Service $api)
{
}
/**
* Builds the XML body based on an array of arguments.
*
* @param Shape $shape Operation being constructed
* @param array $args Associative array of arguments
*
* @return string
*/
public function build(\Aws\Api\Shape $shape, array $args)
{
}
}
/**
* Prepares a JSON-RPC request for transfer.
* @internal
*/
class JsonRpcSerializer
{
/**
* @param Service $api Service description
* @param string $endpoint Endpoint to connect to
* @param JsonBody $jsonFormatter Optional JSON formatter to use
*/
public function __construct(\Aws\Api\Service $api, $endpoint, \Aws\Api\Serializer\JsonBody $jsonFormatter = null)
{
}
/**
* When invoked with an AWS command, returns a serialization array
* containing "method", "uri", "headers", and "body" key value pairs.
*
* @param CommandInterface $command
*
* @return RequestInterface
*/
public function __invoke(\Aws\CommandInterface $command)
{
}
}
/**
* Serializes a query protocol request.
* @internal
*/
class QuerySerializer
{
public function __construct(\Aws\Api\Service $api, $endpoint, callable $paramBuilder = null)
{
}
/**
* When invoked with an AWS command, returns a serialization array
* containing "method", "uri", "headers", and "body" key value pairs.
*
* @param CommandInterface $command
*
* @return RequestInterface
*/
public function __invoke(\Aws\CommandInterface $command)
{
}
}
/**
* @internal
*/
class RestXmlSerializer extends \Aws\Api\Serializer\RestSerializer
{
/**
* @param Service $api Service API description
* @param string $endpoint Endpoint to connect to
* @param XmlBody $xmlBody Optional XML formatter to use
*/
public function __construct(\Aws\Api\Service $api, $endpoint, \Aws\Api\Serializer\XmlBody $xmlBody = null)
{
}
protected function payload(\Aws\Api\StructureShape $member, array $value, array &$opts)
{
}
}
}
namespace Aws\Api {
/**
* API providers.
*
* An API provider is a function that accepts a type, service, and version and
* returns an array of API data on success or NULL if no API data can be created
* for the provided arguments.
*
* You can wrap your calls to an API provider with the
* {@see ApiProvider::resolve} method to ensure that API data is created. If the
* API data is not created, then the resolve() method will throw a
* {@see Aws\Exception\UnresolvedApiException}.
*
* use Aws\Api\ApiProvider;
* $provider = ApiProvider::defaultProvider();
* // Returns an array or NULL.
* $data = $provider('api', 's3', '2006-03-01');
* // Returns an array or throws.
* $data = ApiProvider::resolve($provider, 'api', 'elasticfood', '2020-01-01');
*
* You can compose multiple providers into a single provider using
* {@see Aws\or_chain}. This method accepts providers as arguments and
* returns a new function that will invoke each provider until a non-null value
* is returned.
*
* $a = ApiProvider::filesystem(sys_get_temp_dir() . '/aws-beta-models');
* $b = ApiProvider::manifest();
*
* $c = \Aws\or_chain($a, $b);
* $data = $c('api', 'betaservice', '2015-08-08'); // $a handles this.
* $data = $c('api', 's3', '2006-03-01'); // $b handles this.
* $data = $c('api', 'invalid', '2014-12-15'); // Neither handles this.
*/
class ApiProvider
{
/**
* Resolves an API provider and ensures a non-null return value.
*
* @param callable $provider Provider function to invoke.
* @param string $type Type of data ('api', 'waiter', 'paginator').
* @param string $service Service name.
* @param string $version API version.
*
* @return array
* @throws UnresolvedApiException
*/
public static function resolve(callable $provider, $type, $service, $version)
{
}
/**
* Default SDK API provider.
*
* This provider loads pre-built manifest data from the `data` directory.
*
* @return self
*/
public static function defaultProvider()
{
}
/**
* Loads API data after resolving the version to the latest, compatible,
* available version based on the provided manifest data.
*
* Manifest data is essentially an associative array of service names to
* associative arrays of API version aliases.
*
* [
* ...
* 'ec2' => [
* 'latest' => '2014-10-01',
* '2014-10-01' => '2014-10-01',
* '2014-09-01' => '2014-10-01',
* '2014-06-15' => '2014-10-01',
* ...
* ],
* 'ecs' => [...],
* 'elasticache' => [...],
* ...
* ]
*
* @param string $dir Directory containing service models.
* @param array $manifest The API version manifest data.
*
* @return self
*/
public static function manifest($dir, array $manifest)
{
}
/**
* Loads API data from the specified directory.
*
* If "latest" is specified as the version, this provider must glob the
* directory to find which is the latest available version.
*
* @param string $dir Directory containing service models.
*
* @return self
* @throws \InvalidArgumentException if the provided `$dir` is invalid.
*/
public static function filesystem($dir)
{
}
/**
* Retrieves a list of valid versions for the specified service.
*
* @param string $service Service name
*
* @return array
*/
public function getVersions($service)
{
}
/**
* Execute the the provider.
*
* @param string $type Type of data ('api', 'waiter', 'paginator').
* @param string $service Service name.
* @param string $version API version.
*
* @return array|null
*/
public function __invoke($type, $service, $version)
{
}
}
/**
* Validates a schema against a hash of input.
*/
class Validator
{
/**
* @param array $constraints Associative array of constraints to enforce.
* Accepts the following keys: "required", "min",
* "max", and "pattern". If a key is not
* provided, the constraint will assume false.
*/
public function __construct(array $constraints = null)
{
}
/**
* Validates the given input against the schema.
*
* @param string $name Operation name
* @param Shape $shape Shape to validate
* @param array $input Input to validate
*
* @throws \InvalidArgumentException if the input is invalid.
*/
public function validate($name, \Aws\Api\Shape $shape, array $input)
{
}
}
/**
* Represents a web service API model.
*/
class Service extends \Aws\Api\AbstractModel
{
/**
* @param array $definition
* @param callable $provider
*
* @internal param array $definition Service description
*/
public function __construct(array $definition, callable $provider)
{
}
/**
* Creates a request serializer for the provided API object.
*
* @param Service $api API that contains a protocol.
* @param string $endpoint Endpoint to send requests to.
*
* @return callable
* @throws \UnexpectedValueException
*/
public static function createSerializer(\Aws\Api\Service $api, $endpoint)
{
}
/**
* Creates an error parser for the given protocol.
*
* @param string $protocol Protocol to parse (e.g., query, json, etc.)
*
* @return callable
* @throws \UnexpectedValueException
*/
public static function createErrorParser($protocol)
{
}
/**
* Applies the listeners needed to parse client models.
*
* @param Service $api API to create a parser for
* @return callable
* @throws \UnexpectedValueException
*/
public static function createParser(\Aws\Api\Service $api)
{
}
/**
* Get the full name of the service
*
* @return string
*/
public function getServiceFullName()
{
}
/**
* Get the service id
*
* @return string
*/
public function getServiceId()
{
}
/**
* Get the API version of the service
*
* @return string
*/
public function getApiVersion()
{
}
/**
* Get the API version of the service
*
* @return string
*/
public function getEndpointPrefix()
{
}
/**
* Get the signing name used by the service.
*
* @return string
*/
public function getSigningName()
{
}
/**
* Get the service name.
*
* @return string
*/
public function getServiceName()
{
}
/**
* Get the default signature version of the service.
*
* Note: this method assumes "v4" when not specified in the model.
*
* @return string
*/
public function getSignatureVersion()
{
}
/**
* Get the protocol used by the service.
*
* @return string
*/
public function getProtocol()
{
}
/**
* Get the uid string used by the service
*
* @return string
*/
public function getUid()
{
}
/**
* Check if the description has a specific operation by name.
*
* @param string $name Operation to check by name
*
* @return bool
*/
public function hasOperation($name)
{
}
/**
* Get an operation by name.
*
* @param string $name Operation to retrieve by name
*
* @return Operation
* @throws \InvalidArgumentException If the operation is not found
*/
public function getOperation($name)
{
}
/**
* Get all of the operations of the description.
*
* @return Operation[]
*/
public function getOperations()
{
}
/**
* Get all of the service metadata or a specific metadata key value.
*
* @param string|null $key Key to retrieve or null to retrieve all metadata
*
* @return mixed Returns the result or null if the key is not found
*/
public function getMetadata($key = null)
{
}
/**
* Gets an associative array of available paginator configurations where
* the key is the name of the paginator, and the value is the paginator
* configuration.
*
* @return array
* @unstable The configuration format of paginators may change in the future
*/
public function getPaginators()
{
}
/**
* Determines if the service has a paginator by name.
*
* @param string $name Name of the paginator.
*
* @return bool
*/
public function hasPaginator($name)
{
}
/**
* Retrieve a paginator by name.
*
* @param string $name Paginator to retrieve by name. This argument is
* typically the operation name.
* @return array
* @throws \UnexpectedValueException if the paginator does not exist.
* @unstable The configuration format of paginators may change in the future
*/
public function getPaginatorConfig($name)
{
}
/**
* Gets an associative array of available waiter configurations where the
* key is the name of the waiter, and the value is the waiter
* configuration.
*
* @return array
*/
public function getWaiters()
{
}
/**
* Determines if the service has a waiter by name.
*
* @param string $name Name of the waiter.
*
* @return bool
*/
public function hasWaiter($name)
{
}
/**
* Get a waiter configuration by name.
*
* @param string $name Name of the waiter by name.
*
* @return array
* @throws \UnexpectedValueException if the waiter does not exist.
*/
public function getWaiterConfig($name)
{
}
/**
* Get the shape map used by the API.
*
* @return ShapeMap
*/
public function getShapeMap()
{
}
}
}
namespace Aws\ImportExport {
/**
* This client is used to interact with the **AWS Import/Export** service.
* @method \Aws\Result cancelJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise cancelJobAsync(array $args = [])
* @method \Aws\Result createJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createJobAsync(array $args = [])
* @method \Aws\Result getShippingLabel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getShippingLabelAsync(array $args = [])
* @method \Aws\Result getStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getStatusAsync(array $args = [])
* @method \Aws\Result listJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listJobsAsync(array $args = [])
* @method \Aws\Result updateJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateJobAsync(array $args = [])
*/
class ImportExportClient extends \Aws\AwsClient
{
}
}
namespace Aws\ImportExport\Exception {
/**
* Represents an error interacting with the **AWS Import/Export** service.
*/
class ImportExportException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Comprehend {
/**
* This client is used to interact with the **Amazon Comprehend** service.
* @method \Aws\Result batchDetectDominantLanguage(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDetectDominantLanguageAsync(array $args = [])
* @method \Aws\Result batchDetectEntities(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDetectEntitiesAsync(array $args = [])
* @method \Aws\Result batchDetectKeyPhrases(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDetectKeyPhrasesAsync(array $args = [])
* @method \Aws\Result batchDetectSentiment(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDetectSentimentAsync(array $args = [])
* @method \Aws\Result batchDetectSyntax(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDetectSyntaxAsync(array $args = [])
* @method \Aws\Result describeDominantLanguageDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDominantLanguageDetectionJobAsync(array $args = [])
* @method \Aws\Result describeEntitiesDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEntitiesDetectionJobAsync(array $args = [])
* @method \Aws\Result describeKeyPhrasesDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeKeyPhrasesDetectionJobAsync(array $args = [])
* @method \Aws\Result describeSentimentDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSentimentDetectionJobAsync(array $args = [])
* @method \Aws\Result describeTopicsDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTopicsDetectionJobAsync(array $args = [])
* @method \Aws\Result detectDominantLanguage(array $args = [])
* @method \GuzzleHttp\Promise\Promise detectDominantLanguageAsync(array $args = [])
* @method \Aws\Result detectEntities(array $args = [])
* @method \GuzzleHttp\Promise\Promise detectEntitiesAsync(array $args = [])
* @method \Aws\Result detectKeyPhrases(array $args = [])
* @method \GuzzleHttp\Promise\Promise detectKeyPhrasesAsync(array $args = [])
* @method \Aws\Result detectSentiment(array $args = [])
* @method \GuzzleHttp\Promise\Promise detectSentimentAsync(array $args = [])
* @method \Aws\Result detectSyntax(array $args = [])
* @method \GuzzleHttp\Promise\Promise detectSyntaxAsync(array $args = [])
* @method \Aws\Result listDominantLanguageDetectionJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDominantLanguageDetectionJobsAsync(array $args = [])
* @method \Aws\Result listEntitiesDetectionJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listEntitiesDetectionJobsAsync(array $args = [])
* @method \Aws\Result listKeyPhrasesDetectionJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listKeyPhrasesDetectionJobsAsync(array $args = [])
* @method \Aws\Result listSentimentDetectionJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSentimentDetectionJobsAsync(array $args = [])
* @method \Aws\Result listTopicsDetectionJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTopicsDetectionJobsAsync(array $args = [])
* @method \Aws\Result startDominantLanguageDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise startDominantLanguageDetectionJobAsync(array $args = [])
* @method \Aws\Result startEntitiesDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise startEntitiesDetectionJobAsync(array $args = [])
* @method \Aws\Result startKeyPhrasesDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise startKeyPhrasesDetectionJobAsync(array $args = [])
* @method \Aws\Result startSentimentDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise startSentimentDetectionJobAsync(array $args = [])
* @method \Aws\Result startTopicsDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise startTopicsDetectionJobAsync(array $args = [])
* @method \Aws\Result stopDominantLanguageDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopDominantLanguageDetectionJobAsync(array $args = [])
* @method \Aws\Result stopEntitiesDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopEntitiesDetectionJobAsync(array $args = [])
* @method \Aws\Result stopKeyPhrasesDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopKeyPhrasesDetectionJobAsync(array $args = [])
* @method \Aws\Result stopSentimentDetectionJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopSentimentDetectionJobAsync(array $args = [])
*/
class ComprehendClient extends \Aws\AwsClient
{
}
}
namespace Aws\Comprehend\Exception {
/**
* Represents an error interacting with the **Amazon Comprehend** service.
*/
class ComprehendException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* Converts an HTTP handler into a Command HTTP handler.
*
* HTTP handlers have the following signature:
* function(RequestInterface $request, array $options) : PromiseInterface
*
* The promise returned form an HTTP handler must resolve to a PSR-7 response
* object when fulfilled or an error array when rejected. The error array
* can contain the following data:
*
* - exception: (required, Exception) Exception that was encountered.
* - response: (ResponseInterface) PSR-7 response that was received (if a
* response) was received.
* - connection_error: (bool) True if the error is the result of failing to
* connect.
*/
class WrappedHttpHandler
{
/**
* @param callable $httpHandler Function that accepts a request and array
* of request options and returns a promise
* that fulfills with a response or rejects
* with an error array.
* @param callable $parser Function that accepts a response object
* and returns an AWS result object.
* @param callable $errorParser Function that parses a response object
* into AWS error data.
* @param string $exceptionClass Exception class to throw.
* @param bool $collectStats Whether to collect HTTP transfer
* information.
*/
public function __construct(callable $httpHandler, callable $parser, callable $errorParser, $exceptionClass = 'Aws\\Exception\\AwsException', $collectStats = false)
{
}
/**
* Calls the simpler HTTP specific handler and wraps the returned promise
* with AWS specific values (e.g., a result object or AWS exception).
*
* @param CommandInterface $command Command being executed.
* @param RequestInterface $request Request to send.
*
* @return Promise\PromiseInterface
*/
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\RequestInterface $request)
{
}
}
}
namespace Aws\Budgets\Exception {
/**
* Represents an error interacting with the **AWS Budgets** service.
*/
class BudgetsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Budgets {
/**
* This client is used to interact with the **AWS Budgets** service.
* @method \Aws\Result createBudget(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBudgetAsync(array $args = [])
* @method \Aws\Result createNotification(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNotificationAsync(array $args = [])
* @method \Aws\Result createSubscriber(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSubscriberAsync(array $args = [])
* @method \Aws\Result deleteBudget(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBudgetAsync(array $args = [])
* @method \Aws\Result deleteNotification(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNotificationAsync(array $args = [])
* @method \Aws\Result deleteSubscriber(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSubscriberAsync(array $args = [])
* @method \Aws\Result describeBudget(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeBudgetAsync(array $args = [])
* @method \Aws\Result describeBudgets(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeBudgetsAsync(array $args = [])
* @method \Aws\Result describeNotificationsForBudget(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNotificationsForBudgetAsync(array $args = [])
* @method \Aws\Result describeSubscribersForNotification(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSubscribersForNotificationAsync(array $args = [])
* @method \Aws\Result updateBudget(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateBudgetAsync(array $args = [])
* @method \Aws\Result updateNotification(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateNotificationAsync(array $args = [])
* @method \Aws\Result updateSubscriber(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSubscriberAsync(array $args = [])
*/
class BudgetsClient extends \Aws\AwsClient
{
}
}
namespace Aws {
/**
* Incremental hashing using PHP's hash functions.
*/
class PhpHash implements \Aws\HashInterface
{
/**
* @param string $algo Hashing algorithm. One of PHP's hash_algos()
* return values (e.g. md5, sha1, etc...).
* @param array $options Associative array of hashing options:
* - key: Secret key used with the hashing algorithm.
* - base64: Set to true to base64 encode the value when complete.
*/
public function __construct($algo, array $options = [])
{
}
public function update($data)
{
}
public function complete()
{
}
public function reset()
{
}
}
}
namespace Aws\MediaStore {
/**
* This client is used to interact with the **AWS Elemental MediaStore** service.
* @method \Aws\Result createContainer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createContainerAsync(array $args = [])
* @method \Aws\Result deleteContainer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteContainerAsync(array $args = [])
* @method \Aws\Result deleteContainerPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteContainerPolicyAsync(array $args = [])
* @method \Aws\Result deleteCorsPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCorsPolicyAsync(array $args = [])
* @method \Aws\Result describeContainer(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeContainerAsync(array $args = [])
* @method \Aws\Result getContainerPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getContainerPolicyAsync(array $args = [])
* @method \Aws\Result getCorsPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCorsPolicyAsync(array $args = [])
* @method \Aws\Result listContainers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listContainersAsync(array $args = [])
* @method \Aws\Result putContainerPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putContainerPolicyAsync(array $args = [])
* @method \Aws\Result putCorsPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putCorsPolicyAsync(array $args = [])
*/
class MediaStoreClient extends \Aws\AwsClient
{
}
}
namespace Aws\MediaStore\Exception {
/**
* Represents an error interacting with the **AWS Elemental MediaStore** service.
*/
class MediaStoreException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Support {
/**
* AWS Support client.
*
* @method \Aws\Result addAttachmentsToSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise addAttachmentsToSetAsync(array $args = [])
* @method \Aws\Result addCommunicationToCase(array $args = [])
* @method \GuzzleHttp\Promise\Promise addCommunicationToCaseAsync(array $args = [])
* @method \Aws\Result createCase(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCaseAsync(array $args = [])
* @method \Aws\Result describeAttachment(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAttachmentAsync(array $args = [])
* @method \Aws\Result describeCases(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCasesAsync(array $args = [])
* @method \Aws\Result describeCommunications(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCommunicationsAsync(array $args = [])
* @method \Aws\Result describeServices(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeServicesAsync(array $args = [])
* @method \Aws\Result describeSeverityLevels(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSeverityLevelsAsync(array $args = [])
* @method \Aws\Result describeTrustedAdvisorCheckRefreshStatuses(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTrustedAdvisorCheckRefreshStatusesAsync(array $args = [])
* @method \Aws\Result describeTrustedAdvisorCheckResult(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTrustedAdvisorCheckResultAsync(array $args = [])
* @method \Aws\Result describeTrustedAdvisorCheckSummaries(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTrustedAdvisorCheckSummariesAsync(array $args = [])
* @method \Aws\Result describeTrustedAdvisorChecks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTrustedAdvisorChecksAsync(array $args = [])
* @method \Aws\Result refreshTrustedAdvisorCheck(array $args = [])
* @method \GuzzleHttp\Promise\Promise refreshTrustedAdvisorCheckAsync(array $args = [])
* @method \Aws\Result resolveCase(array $args = [])
* @method \GuzzleHttp\Promise\Promise resolveCaseAsync(array $args = [])
*/
class SupportClient extends \Aws\AwsClient
{
}
}
namespace Aws\Support\Exception {
/**
* AWS Support service exception.
*/
class SupportException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\WorkDocs {
/**
* This client is used to interact with the **Amazon WorkDocs** service.
* @method \Aws\Result abortDocumentVersionUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise abortDocumentVersionUploadAsync(array $args = [])
* @method \Aws\Result activateUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise activateUserAsync(array $args = [])
* @method \Aws\Result addResourcePermissions(array $args = [])
* @method \GuzzleHttp\Promise\Promise addResourcePermissionsAsync(array $args = [])
* @method \Aws\Result createComment(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCommentAsync(array $args = [])
* @method \Aws\Result createCustomMetadata(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCustomMetadataAsync(array $args = [])
* @method \Aws\Result createFolder(array $args = [])
* @method \GuzzleHttp\Promise\Promise createFolderAsync(array $args = [])
* @method \Aws\Result createLabels(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLabelsAsync(array $args = [])
* @method \Aws\Result createNotificationSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNotificationSubscriptionAsync(array $args = [])
* @method \Aws\Result createUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserAsync(array $args = [])
* @method \Aws\Result deactivateUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise deactivateUserAsync(array $args = [])
* @method \Aws\Result deleteComment(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCommentAsync(array $args = [])
* @method \Aws\Result deleteCustomMetadata(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCustomMetadataAsync(array $args = [])
* @method \Aws\Result deleteDocument(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDocumentAsync(array $args = [])
* @method \Aws\Result deleteFolder(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFolderAsync(array $args = [])
* @method \Aws\Result deleteFolderContents(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFolderContentsAsync(array $args = [])
* @method \Aws\Result deleteLabels(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLabelsAsync(array $args = [])
* @method \Aws\Result deleteNotificationSubscription(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNotificationSubscriptionAsync(array $args = [])
* @method \Aws\Result deleteUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserAsync(array $args = [])
* @method \Aws\Result describeActivities(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeActivitiesAsync(array $args = [])
* @method \Aws\Result describeComments(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCommentsAsync(array $args = [])
* @method \Aws\Result describeDocumentVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDocumentVersionsAsync(array $args = [])
* @method \Aws\Result describeFolderContents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeFolderContentsAsync(array $args = [])
* @method \Aws\Result describeGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeGroupsAsync(array $args = [])
* @method \Aws\Result describeNotificationSubscriptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNotificationSubscriptionsAsync(array $args = [])
* @method \Aws\Result describeResourcePermissions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeResourcePermissionsAsync(array $args = [])
* @method \Aws\Result describeRootFolders(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRootFoldersAsync(array $args = [])
* @method \Aws\Result describeUsers(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUsersAsync(array $args = [])
* @method \Aws\Result getCurrentUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCurrentUserAsync(array $args = [])
* @method \Aws\Result getDocument(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDocumentAsync(array $args = [])
* @method \Aws\Result getDocumentPath(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDocumentPathAsync(array $args = [])
* @method \Aws\Result getDocumentVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDocumentVersionAsync(array $args = [])
* @method \Aws\Result getFolder(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFolderAsync(array $args = [])
* @method \Aws\Result getFolderPath(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFolderPathAsync(array $args = [])
* @method \Aws\Result initiateDocumentVersionUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise initiateDocumentVersionUploadAsync(array $args = [])
* @method \Aws\Result removeAllResourcePermissions(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeAllResourcePermissionsAsync(array $args = [])
* @method \Aws\Result removeResourcePermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeResourcePermissionAsync(array $args = [])
* @method \Aws\Result updateDocument(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDocumentAsync(array $args = [])
* @method \Aws\Result updateDocumentVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDocumentVersionAsync(array $args = [])
* @method \Aws\Result updateFolder(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFolderAsync(array $args = [])
* @method \Aws\Result updateUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserAsync(array $args = [])
*/
class WorkDocsClient extends \Aws\AwsClient
{
}
}
namespace Aws\WorkDocs\Exception {
/**
* Represents an error interacting with the **Amazon WorkDocs** service.
*/
class WorkDocsException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudTrail {
/**
* The `Aws\CloudTrail\LogRecordIterator` provides an easy way to iterate over
* log records from log files generated by AWS CloudTrail.
*
* CloudTrail log files contain data about your AWS API calls and are stored in
* Amazon S3 at a predictable path based on a bucket name, a key prefix, an
* account ID, a region, and date information. The files are gzipped and
* contain structured data in JSON format. This class allows you to specify
* options via its factory methods, including a date range, and emits each log
* record from any log files that match the provided options.
*
* A log record containing data about an AWS API call is yielded for each
* iteration on this object.
*/
class LogRecordIterator implements \OuterIterator
{
/**
* @param S3Client $s3Client
* @param CloudTrailClient $cloudTrailClient
* @param array $options
*
* @return LogRecordIterator
*/
public static function forTrail(\Aws\S3\S3Client $s3Client, \Aws\CloudTrail\CloudTrailClient $cloudTrailClient, array $options = [])
{
}
/**
* @param S3Client $s3Client
* @param string $s3BucketName
* @param array $options
*
* @return LogRecordIterator
*/
public static function forBucket(\Aws\S3\S3Client $s3Client, $s3BucketName, array $options = [])
{
}
/**
* @param S3Client $s3Client
* @param string $s3BucketName
* @param string $s3ObjectKey
*
* @return LogRecordIterator
*/
public static function forFile(\Aws\S3\S3Client $s3Client, $s3BucketName, $s3ObjectKey)
{
}
/**
* @param LogFileReader $logFileReader
* @param \Iterator $logFileIterator
*/
public function __construct(\Aws\CloudTrail\LogFileReader $logFileReader, \Iterator $logFileIterator)
{
}
/**
* Returns the current log record as an array.
*
* @return array|false
*/
public function current()
{
}
public function next()
{
}
public function key()
{
}
public function valid()
{
}
public function rewind()
{
}
public function getInnerIterator()
{
}
}
/**
* The `Aws\CloudTrail\LogFileIterator` provides an easy way to iterate over
* log file generated by AWS CloudTrail.
*
* CloudTrail log files contain data about your AWS API calls and are stored in
* Amazon S3 at a predictable path based on a bucket name, a key prefix, an
* account ID, a region, and date information. This class allows you to specify
* options, including a date range, and emits each log file that match the
* provided options.
*
* Yields an array containing the Amazon S3 bucket and key of the log file.
*/
class LogFileIterator extends \IteratorIterator
{
// For internal use
const DEFAULT_TRAIL_NAME = 'Default';
const PREFIX_TEMPLATE = 'prefix/AWSLogs/account/CloudTrail/region/date/';
const PREFIX_WILDCARD = '*';
// Option names used internally or externally
const TRAIL_NAME = 'trail_name';
const KEY_PREFIX = 'key_prefix';
const START_DATE = 'start_date';
const END_DATE = 'end_date';
const ACCOUNT_ID = 'account_id';
const LOG_REGION = 'log_region';
/**
* Constructs a LogRecordIterator. This factory method is used if the name
* of the S3 bucket containing your logs is not known. This factory method
* uses a CloudTrail client and the trail name (or "Default") to find the
* information about the trail necessary for constructing the
* LogRecordIterator.
*
* @param S3Client $s3Client
* @param CloudTrailClient $cloudTrailClient
* @param array $options
*
* @return LogRecordIterator
* @throws \InvalidArgumentException
* @see LogRecordIterator::__contruct
*/
public static function forTrail(\Aws\S3\S3Client $s3Client, \Aws\CloudTrail\CloudTrailClient $cloudTrailClient, array $options = [])
{
}
/**
* Constructs a LogFileIterator using the specified options:
*
* - trail_name: The name of the trail that is generating our logs. If
* none is provided, then "Default" will be used, since that is the name
* of the trail created in the AWS Management Console.
* - key_prefix: The S3 key prefix of your log files. This value will be
* overwritten when using the `fromTrail()` method. However, if you are
* using the constructor, then this value will be used.
* - start_date: The timestamp of the beginning of date range of the log
* records you want to read. You can pass this in as a `DateTime` object,
* integer (unix timestamp), or a string compatible with `strtotime()`.
* - end_date: The timestamp of the end of date range of the log records
* you want to read. You can pass this in as a `DateTime` object, integer
* (unix timestamp), or a string compatible with `strtotime()`.
* - account_id: This is your AWS account ID, which is the 12-digit number
* found on the *Account Identifiers* section of the *AWS Security
* Credentials* page. See https://console.aws.amazon.com/iam/home?#security_credential
* - log_region: Region of the services of the log records you want to read.
*
* @param S3Client $s3Client
* @param string $s3BucketName
* @param array $options
*/
public function __construct(\Aws\S3\S3Client $s3Client, $s3BucketName, array $options = [])
{
}
/**
* An override of the typical current behavior of \IteratorIterator to
* format the output such that the bucket and key are returned in an array
*
* @return array|bool
*/
public function current()
{
}
}
/**
* This client is used to interact with the **AWS CloudTrail** service.
*
* @method \Aws\Result addTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsAsync(array $args = [])
* @method \Aws\Result createTrail(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTrailAsync(array $args = [])
* @method \Aws\Result deleteTrail(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTrailAsync(array $args = [])
* @method \Aws\Result describeTrails(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTrailsAsync(array $args = [])
* @method \Aws\Result getEventSelectors(array $args = [])
* @method \GuzzleHttp\Promise\Promise getEventSelectorsAsync(array $args = [])
* @method \Aws\Result getTrailStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTrailStatusAsync(array $args = [])
* @method \Aws\Result listPublicKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPublicKeysAsync(array $args = [])
* @method \Aws\Result listTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsAsync(array $args = [])
* @method \Aws\Result lookupEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise lookupEventsAsync(array $args = [])
* @method \Aws\Result putEventSelectors(array $args = [])
* @method \GuzzleHttp\Promise\Promise putEventSelectorsAsync(array $args = [])
* @method \Aws\Result removeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsAsync(array $args = [])
* @method \Aws\Result startLogging(array $args = [])
* @method \GuzzleHttp\Promise\Promise startLoggingAsync(array $args = [])
* @method \Aws\Result stopLogging(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopLoggingAsync(array $args = [])
* @method \Aws\Result updateTrail(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTrailAsync(array $args = [])
*/
class CloudTrailClient extends \Aws\AwsClient
{
}
/**
* This class provides an easy way to read log files generated by AWS
* CloudTrail.
*
* CloudTrail log files contain data about your AWS API calls and are stored in
* Amazon S3. The log files are gzipped and contain structured data in JSON
* format. This class will automatically ungzip and decode the data, and return
* the data as a array of log records
*/
class LogFileReader
{
/**
* @param S3Client $s3Client S3 client used to retrieve objects
*/
public function __construct(\Aws\S3\S3Client $s3Client)
{
}
/**
* Downloads, unzips, and reads a CloudTrail log file from Amazon S3
*
* @param string $s3BucketName The bucket name of the log file in Amazon S3
* @param string $logFileKey The key of the log file in Amazon S3
*
* @return array
*/
public function read($s3BucketName, $logFileKey)
{
}
}
}
namespace Aws\CloudTrail\Exception {
/**
* Represents an error interacting with the AWS CloudTrail service.
*/
class CloudTrailException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CognitoSync\Exception {
/**
* Represents an error interacting with the Amazon Cognito Sync service.
*/
class CognitoSyncException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CognitoSync {
/**
* This client is used to interact with the **Amazon Cognito Sync** service.
*
* @method \Aws\Result bulkPublish(array $args = [])
* @method \GuzzleHttp\Promise\Promise bulkPublishAsync(array $args = [])
* @method \Aws\Result deleteDataset(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDatasetAsync(array $args = [])
* @method \Aws\Result describeDataset(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDatasetAsync(array $args = [])
* @method \Aws\Result describeIdentityPoolUsage(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeIdentityPoolUsageAsync(array $args = [])
* @method \Aws\Result describeIdentityUsage(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeIdentityUsageAsync(array $args = [])
* @method \Aws\Result getBulkPublishDetails(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBulkPublishDetailsAsync(array $args = [])
* @method \Aws\Result getCognitoEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCognitoEventsAsync(array $args = [])
* @method \Aws\Result getIdentityPoolConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIdentityPoolConfigurationAsync(array $args = [])
* @method \Aws\Result listDatasets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDatasetsAsync(array $args = [])
* @method \Aws\Result listIdentityPoolUsage(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIdentityPoolUsageAsync(array $args = [])
* @method \Aws\Result listRecords(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRecordsAsync(array $args = [])
* @method \Aws\Result registerDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerDeviceAsync(array $args = [])
* @method \Aws\Result setCognitoEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise setCognitoEventsAsync(array $args = [])
* @method \Aws\Result setIdentityPoolConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise setIdentityPoolConfigurationAsync(array $args = [])
* @method \Aws\Result subscribeToDataset(array $args = [])
* @method \GuzzleHttp\Promise\Promise subscribeToDatasetAsync(array $args = [])
* @method \Aws\Result unsubscribeFromDataset(array $args = [])
* @method \GuzzleHttp\Promise\Promise unsubscribeFromDatasetAsync(array $args = [])
* @method \Aws\Result updateRecords(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRecordsAsync(array $args = [])
*/
class CognitoSyncClient extends \Aws\AwsClient
{
}
}
namespace Aws\AppSync {
/**
* This client is used to interact with the **AWS AppSync** service.
* @method \Aws\Result createApiKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise createApiKeyAsync(array $args = [])
* @method \Aws\Result createDataSource(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDataSourceAsync(array $args = [])
* @method \Aws\Result createGraphqlApi(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGraphqlApiAsync(array $args = [])
* @method \Aws\Result createResolver(array $args = [])
* @method \GuzzleHttp\Promise\Promise createResolverAsync(array $args = [])
* @method \Aws\Result createType(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTypeAsync(array $args = [])
* @method \Aws\Result deleteApiKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApiKeyAsync(array $args = [])
* @method \Aws\Result deleteDataSource(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDataSourceAsync(array $args = [])
* @method \Aws\Result deleteGraphqlApi(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGraphqlApiAsync(array $args = [])
* @method \Aws\Result deleteResolver(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteResolverAsync(array $args = [])
* @method \Aws\Result deleteType(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTypeAsync(array $args = [])
* @method \Aws\Result getDataSource(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDataSourceAsync(array $args = [])
* @method \Aws\Result getGraphqlApi(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGraphqlApiAsync(array $args = [])
* @method \Aws\Result getIntrospectionSchema(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIntrospectionSchemaAsync(array $args = [])
* @method \Aws\Result getResolver(array $args = [])
* @method \GuzzleHttp\Promise\Promise getResolverAsync(array $args = [])
* @method \Aws\Result getSchemaCreationStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSchemaCreationStatusAsync(array $args = [])
* @method \Aws\Result getType(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTypeAsync(array $args = [])
* @method \Aws\Result listApiKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise listApiKeysAsync(array $args = [])
* @method \Aws\Result listDataSources(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDataSourcesAsync(array $args = [])
* @method \Aws\Result listGraphqlApis(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGraphqlApisAsync(array $args = [])
* @method \Aws\Result listResolvers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResolversAsync(array $args = [])
* @method \Aws\Result listTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTypesAsync(array $args = [])
* @method \Aws\Result startSchemaCreation(array $args = [])
* @method \GuzzleHttp\Promise\Promise startSchemaCreationAsync(array $args = [])
* @method \Aws\Result updateApiKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApiKeyAsync(array $args = [])
* @method \Aws\Result updateDataSource(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDataSourceAsync(array $args = [])
* @method \Aws\Result updateGraphqlApi(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGraphqlApiAsync(array $args = [])
* @method \Aws\Result updateResolver(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateResolverAsync(array $args = [])
* @method \Aws\Result updateType(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTypeAsync(array $args = [])
*/
class AppSyncClient extends \Aws\AwsClient
{
}
}
namespace Aws\AppSync\Exception {
/**
* Represents an error interacting with the **AWS AppSync** service.
*/
class AppSyncException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\AlexaForBusiness\Exception {
/**
* Represents an error interacting with the **Alexa For Business** service.
*/
class AlexaForBusinessException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\AlexaForBusiness {
/**
* This client is used to interact with the **Alexa For Business** service.
* @method \Aws\Result associateContactWithAddressBook(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateContactWithAddressBookAsync(array $args = [])
* @method \Aws\Result associateDeviceWithRoom(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateDeviceWithRoomAsync(array $args = [])
* @method \Aws\Result associateSkillGroupWithRoom(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateSkillGroupWithRoomAsync(array $args = [])
* @method \Aws\Result createAddressBook(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAddressBookAsync(array $args = [])
* @method \Aws\Result createContact(array $args = [])
* @method \GuzzleHttp\Promise\Promise createContactAsync(array $args = [])
* @method \Aws\Result createProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProfileAsync(array $args = [])
* @method \Aws\Result createRoom(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRoomAsync(array $args = [])
* @method \Aws\Result createSkillGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSkillGroupAsync(array $args = [])
* @method \Aws\Result createUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserAsync(array $args = [])
* @method \Aws\Result deleteAddressBook(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAddressBookAsync(array $args = [])
* @method \Aws\Result deleteContact(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteContactAsync(array $args = [])
* @method \Aws\Result deleteProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProfileAsync(array $args = [])
* @method \Aws\Result deleteRoom(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRoomAsync(array $args = [])
* @method \Aws\Result deleteRoomSkillParameter(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRoomSkillParameterAsync(array $args = [])
* @method \Aws\Result deleteSkillGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSkillGroupAsync(array $args = [])
* @method \Aws\Result deleteUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserAsync(array $args = [])
* @method \Aws\Result disassociateContactFromAddressBook(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateContactFromAddressBookAsync(array $args = [])
* @method \Aws\Result disassociateDeviceFromRoom(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateDeviceFromRoomAsync(array $args = [])
* @method \Aws\Result disassociateSkillGroupFromRoom(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateSkillGroupFromRoomAsync(array $args = [])
* @method \Aws\Result getAddressBook(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAddressBookAsync(array $args = [])
* @method \Aws\Result getContact(array $args = [])
* @method \GuzzleHttp\Promise\Promise getContactAsync(array $args = [])
* @method \Aws\Result getDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeviceAsync(array $args = [])
* @method \Aws\Result getProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise getProfileAsync(array $args = [])
* @method \Aws\Result getRoom(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRoomAsync(array $args = [])
* @method \Aws\Result getRoomSkillParameter(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRoomSkillParameterAsync(array $args = [])
* @method \Aws\Result getSkillGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSkillGroupAsync(array $args = [])
* @method \Aws\Result listDeviceEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeviceEventsAsync(array $args = [])
* @method \Aws\Result listSkills(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSkillsAsync(array $args = [])
* @method \Aws\Result listTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsAsync(array $args = [])
* @method \Aws\Result putRoomSkillParameter(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRoomSkillParameterAsync(array $args = [])
* @method \Aws\Result resolveRoom(array $args = [])
* @method \GuzzleHttp\Promise\Promise resolveRoomAsync(array $args = [])
* @method \Aws\Result revokeInvitation(array $args = [])
* @method \GuzzleHttp\Promise\Promise revokeInvitationAsync(array $args = [])
* @method \Aws\Result searchAddressBooks(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchAddressBooksAsync(array $args = [])
* @method \Aws\Result searchContacts(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchContactsAsync(array $args = [])
* @method \Aws\Result searchDevices(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchDevicesAsync(array $args = [])
* @method \Aws\Result searchProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchProfilesAsync(array $args = [])
* @method \Aws\Result searchRooms(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchRoomsAsync(array $args = [])
* @method \Aws\Result searchSkillGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchSkillGroupsAsync(array $args = [])
* @method \Aws\Result searchUsers(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchUsersAsync(array $args = [])
* @method \Aws\Result sendInvitation(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendInvitationAsync(array $args = [])
* @method \Aws\Result startDeviceSync(array $args = [])
* @method \GuzzleHttp\Promise\Promise startDeviceSyncAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateAddressBook(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAddressBookAsync(array $args = [])
* @method \Aws\Result updateContact(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateContactAsync(array $args = [])
* @method \Aws\Result updateDevice(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDeviceAsync(array $args = [])
* @method \Aws\Result updateProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateProfileAsync(array $args = [])
* @method \Aws\Result updateRoom(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRoomAsync(array $args = [])
* @method \Aws\Result updateSkillGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSkillGroupAsync(array $args = [])
*/
class AlexaForBusinessClient extends \Aws\AwsClient
{
}
}
namespace Aws\DynamoDb {
/**
* The session connection provides the underlying logic for interacting with
* Amazon DynamoDB and performs all of the reading and writing operations.
*/
interface SessionConnectionInterface
{
/**
* Reads session data from DynamoDB
*
* @param string $id Session ID
*
* @return array
*/
public function read($id);
/**
* Writes session data to DynamoDB
*
* @param string $id Session ID
* @param string $data Serialized session data
* @param bool $isChanged Whether or not the data has changed
*
* @return bool
*/
public function write($id, $data, $isChanged);
/**
* Deletes session record from DynamoDB
*
* @param string $id Session ID
*
* @return bool
*/
public function delete($id);
/**
* Performs garbage collection on the sessions stored in the DynamoDB
*
* @return bool
*/
public function deleteExpired();
}
/**
* The standard connection performs the read and write operations to DynamoDB.
*/
class StandardSessionConnection implements \Aws\DynamoDb\SessionConnectionInterface
{
/** @var DynamoDbClient The DynamoDB client */
protected $client;
/** @var array The session handler config options */
protected $config;
/**
* @param DynamoDbClient $client DynamoDB client
* @param array $config Session handler config
*/
public function __construct(\Aws\DynamoDb\DynamoDbClient $client, array $config = [])
{
}
public function read($id)
{
}
public function write($id, $data, $isChanged)
{
}
public function delete($id)
{
}
public function deleteExpired()
{
}
/**
* @param string $key
*
* @return array
*/
protected function formatKey($key)
{
}
/**
* @param string $error
*
* @return bool
*/
protected function triggerError($error)
{
}
}
/**
* The locking connection adds locking logic to the read operation.
*/
class LockingSessionConnection extends \Aws\DynamoDb\StandardSessionConnection
{
public function __construct(\Aws\DynamoDb\DynamoDbClient $client, array $config = [])
{
}
/**
* {@inheritdoc}
* Retries the request until the lock can be acquired
*/
public function read($id)
{
}
}
/**
* Special object to represent a DynamoDB set (SS/NS/BS) value.
*/
class SetValue implements \JsonSerializable, \Countable, \IteratorAggregate
{
/**
* @param array $values Values in the set.
*/
public function __construct(array $values)
{
}
/**
* Get the values formatted for PHP and JSON.
*
* @return array
*/
public function toArray()
{
}
public function count()
{
}
public function getIterator()
{
}
public function jsonSerialize()
{
}
}
/**
* Special object to represent a DynamoDB binary (B) value.
*/
class BinaryValue implements \JsonSerializable
{
/**
* @param mixed $value A binary value compatible with Guzzle streams.
*
* @see GuzzleHttp\Stream\Stream::factory
*/
public function __construct($value)
{
}
public function jsonSerialize()
{
}
public function __toString()
{
}
}
/**
* Provides an interface for using Amazon DynamoDB as a session store by hooking
* into PHP's session handler hooks. Once registered, You may use the native
* `$_SESSION` superglobal and session functions, and the sessions will be
* stored automatically in DynamoDB. DynamoDB is a great session storage
* solution due to its speed, scalability, and fault tolerance.
*
* For maximum performance, we recommend that you keep the size of your sessions
* small. Locking is disabled by default, since it can drive up latencies and
* costs under high traffic. Only turn it on if you need it.
*
* By far, the most expensive operation is garbage collection. Therefore, we
* encourage you to carefully consider your session garbage collection strategy.
* Note: the DynamoDB Session Handler does not allow garbage collection to be
* triggered randomly. You must run garbage collection manually or through other
* automated means using a cron job or similar scheduling technique.
*/
class SessionHandler implements \SessionHandlerInterface
{
/**
* Creates a new DynamoDB Session Handler.
*
* The configuration array accepts the following array keys and values:
* - table_name: Name of table to store the sessions.
* - hash_key: Name of hash key in table. Default: "id".
* - session_lifetime: Lifetime of inactive sessions expiration.
* - consistent_read: Whether or not to use consistent reads.
* - batch_config: Batch options used for garbage collection.
* - locking: Whether or not to use session locking.
* - max_lock_wait_time: Max time (s) to wait for lock acquisition.
* - min_lock_retry_microtime: Min time (µs) to wait between lock attempts.
* - max_lock_retry_microtime: Max time (µs) to wait between lock attempts.
*
* @param DynamoDbClient $client Client for doing DynamoDB operations
* @param array $config Configuration for the Session Handler
*
* @return SessionHandler
*/
public static function fromClient(\Aws\DynamoDb\DynamoDbClient $client, array $config = [])
{
}
/**
* @param SessionConnectionInterface $connection
*/
public function __construct(\Aws\DynamoDb\SessionConnectionInterface $connection)
{
}
/**
* Register the DynamoDB session handler.
*
* @return bool Whether or not the handler was registered.
* @codeCoverageIgnore
*/
public function register()
{
}
/**
* Open a session for writing. Triggered by session_start().
*
* @param string $savePath Session save path.
* @param string $sessionName Session name.
*
* @return bool Whether or not the operation succeeded.
*/
public function open($savePath, $sessionName)
{
}
/**
* Close a session from writing.
*
* @return bool Success
*/
public function close()
{
}
/**
* Read a session stored in DynamoDB.
*
* @param string $id Session ID.
*
* @return string Session data.
*/
public function read($id)
{
}
/**
* Write a session to DynamoDB.
*
* @param string $id Session ID.
* @param string $data Serialized session data to write.
*
* @return bool Whether or not the operation succeeded.
*/
public function write($id, $data)
{
}
/**
* Delete a session stored in DynamoDB.
*
* @param string $id Session ID.
*
* @return bool Whether or not the operation succeeded.
*/
public function destroy($id)
{
}
/**
* Satisfies the session handler interface, but does nothing. To do garbage
* collection, you must manually call the garbageCollect() method.
*
* @param int $maxLifetime Ignored.
*
* @return bool Whether or not the operation succeeded.
* @codeCoverageIgnore
*/
public function gc($maxLifetime)
{
}
/**
* Triggers garbage collection on expired sessions.
* @codeCoverageIgnore
*/
public function garbageCollect()
{
}
}
/**
* The WriteRequestBatch is an object that is capable of efficiently sending
* DynamoDB BatchWriteItem requests from queued up put and delete item requests.
* requests. The batch attempts to send the requests with the fewest requests
* to DynamoDB as possible and also re-queues any unprocessed items to ensure
* that all items are sent.
*/
class WriteRequestBatch
{
/**
* Creates a WriteRequestBatch object that is capable of efficiently sending
* DynamoDB BatchWriteItem requests from queued up Put and Delete requests.
*
* @param DynamoDbClient $client DynamoDB client used to send batches.
* @param array $config Batch configuration options.
* - table: (string) DynamoDB table used by the batch, this can be
* overridden for each individual put() or delete() call.
* - batch_size: (int) The size of each batch (default: 25). The batch
* size must be between 2 and 25. If you are sending batches of large
* items, you may consider lowering the batch size, otherwise, you
* should use 25.
* - pool_size: (int) This number dictates how many BatchWriteItem
* requests you would like to do in parallel. For example, if the
* "batch_size" is 25, and "pool_size" is 3, then you would send 3
* BatchWriteItem requests at a time, each with 25 items. Please keep
* your throughput in mind when choosing the "pool_size" option.
* - autoflush: (bool) This option allows the batch to automatically
* flush once there are enough items (i.e., "batch_size" * "pool_size")
* in the queue. This defaults to true, so you must set this to false
* to stop autoflush.
* - before: (callable) Executed before every BatchWriteItem operation.
* It should accept an \Aws\CommandInterface object as its argument.
* - error: Executed if an error was encountered executing a,
* BatchWriteItem operation, otherwise errors are ignored. It should
* accept an \Aws\Exception\AwsException as its argument.
*
* @throws \InvalidArgumentException if the batch size is not between 2 and 25.
*/
public function __construct(\Aws\DynamoDb\DynamoDbClient $client, array $config = [])
{
}
/**
* Adds a put item request to the batch.
*
* @param array $item Data for an item to put. Format:
* [
* 'attribute1' => ['type' => 'value'],
* 'attribute2' => ['type' => 'value'],
* ...
* ]
* @param string|null $table The name of the table. This must be specified
* unless the "table" option was provided in the
* config of the WriteRequestBatch.
*
* @return $this
*/
public function put(array $item, $table = null)
{
}
/**
* Adds a delete item request to the batch.
*
* @param array $key Key of an item to delete. Format:
* [
* 'key1' => ['type' => 'value'],
* ...
* ]
* @param string|null $table The name of the table. This must be specified
* unless the "table" option was provided in the
* config of the WriteRequestBatch.
*
* @return $this
*/
public function delete(array $key, $table = null)
{
}
/**
* Flushes the batch by combining all the queued put and delete requests
* into BatchWriteItem commands and executing them. Unprocessed items are
* automatically re-queued.
*
* @param bool $untilEmpty If true, flushing will continue until the queue
* is completely empty. This will make sure that
* unprocessed items are all eventually sent.
*
* @return $this
*/
public function flush($untilEmpty = true)
{
}
}
}
namespace Aws\DynamoDb\Exception {
/**
* Represents an error interacting with the Amazon DynamoDB service.
*/
class DynamoDbException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\DynamoDb {
/**
* This client is used to interact with the **Amazon DynamoDB** service.
*
* @method \Aws\Result batchGetItem(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetItemAsync(array $args = [])
* @method \Aws\Result batchWriteItem(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchWriteItemAsync(array $args = [])
* @method \Aws\Result createTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTableAsync(array $args = [])
* @method \Aws\Result deleteItem(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteItemAsync(array $args = [])
* @method \Aws\Result deleteTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTableAsync(array $args = [])
* @method \Aws\Result describeTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTableAsync(array $args = [])
* @method \Aws\Result getItem(array $args = [])
* @method \GuzzleHttp\Promise\Promise getItemAsync(array $args = [])
* @method \Aws\Result listTables(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTablesAsync(array $args = [])
* @method \Aws\Result putItem(array $args = [])
* @method \GuzzleHttp\Promise\Promise putItemAsync(array $args = [])
* @method \Aws\Result query(array $args = [])
* @method \GuzzleHttp\Promise\Promise queryAsync(array $args = [])
* @method \Aws\Result scan(array $args = [])
* @method \GuzzleHttp\Promise\Promise scanAsync(array $args = [])
* @method \Aws\Result updateItem(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateItemAsync(array $args = [])
* @method \Aws\Result updateTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTableAsync(array $args = [])
* @method \Aws\Result createBackup(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise createBackupAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result createGlobalTable(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise createGlobalTableAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result deleteBackup(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise deleteBackupAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result describeBackup(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise describeBackupAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result describeContinuousBackups(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise describeContinuousBackupsAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result describeEndpoints(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise describeEndpointsAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result describeGlobalTable(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise describeGlobalTableAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result describeGlobalTableSettings(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise describeGlobalTableSettingsAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result describeLimits(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise describeLimitsAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result describeTimeToLive(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise describeTimeToLiveAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result listBackups(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise listBackupsAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result listGlobalTables(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise listGlobalTablesAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result listTagsOfResource(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise listTagsOfResourceAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result restoreTableFromBackup(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise restoreTableFromBackupAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result restoreTableToPointInTime(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise restoreTableToPointInTimeAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result tagResource(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result untagResource(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result updateContinuousBackups(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise updateContinuousBackupsAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result updateGlobalTable(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise updateGlobalTableAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result updateGlobalTableSettings(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise updateGlobalTableSettingsAsync(array $args = []) (supported in versions 2012-08-10)
* @method \Aws\Result updateTimeToLive(array $args = []) (supported in versions 2012-08-10)
* @method \GuzzleHttp\Promise\Promise updateTimeToLiveAsync(array $args = []) (supported in versions 2012-08-10)
*/
class DynamoDbClient extends \Aws\AwsClient
{
public static function getArguments()
{
}
/**
* Convenience method for instantiating and registering the DynamoDB
* Session handler with this DynamoDB client object.
*
* @param array $config Array of options for the session handler factory
*
* @return SessionHandler
*/
public function registerSessionHandler(array $config = [])
{
}
/** @internal */
public static function _applyRetryConfig($value, array &$args, \Aws\HandlerList $list)
{
}
/** @internal */
public static function _applyApiProvider($value, array &$args, \Aws\HandlerList $list)
{
}
}
/**
* Special object to represent a DynamoDB Number (N) value.
*/
class NumberValue implements \JsonSerializable
{
/**
* @param string|int|float $value A number value.
*/
public function __construct($value)
{
}
public function jsonSerialize()
{
}
public function __toString()
{
}
}
/**
* Marshals and unmarshals JSON documents and PHP arrays into DynamoDB items.
*/
class Marshaler
{
/**
* Instantiates a DynamoDB Marshaler.
*
* The following options are valid.
*
* - ignore_invalid: (bool) Set to `true` if invalid values should be
* ignored (i.e., not included) during marshaling.
* - nullify_invalid: (bool) Set to `true` if invalid values should be set
* to null.
* - wrap_numbers: (bool) Set to `true` to wrap numbers with `NumberValue`
* objects during unmarshaling to preserve the precision.
*
* @param array $options Marshaler options
*/
public function __construct(array $options = [])
{
}
/**
* Creates a special object to represent a DynamoDB binary (B) value.
*
* This helps disambiguate binary values from string (S) values.
*
* @param mixed $value A binary value compatible with Guzzle streams.
*
* @return BinaryValue
* @see GuzzleHttp\Stream\Stream::factory
*/
public function binary($value)
{
}
/**
* Creates a special object to represent a DynamoDB number (N) value.
*
* This helps maintain the precision of large integer/float in PHP.
*
* @param string|int|float $value A number value.
*
* @return NumberValue
*/
public function number($value)
{
}
/**
* Creates a special object to represent a DynamoDB set (SS/NS/BS) value.
*
* This helps disambiguate set values from list (L) values.
*
* @param array $values The values of the set.
*
* @return SetValue
*
*/
public function set(array $values)
{
}
/**
* Marshal a JSON document from a string to a DynamoDB item.
*
* The result is an array formatted in the proper parameter structure
* required by the DynamoDB API for items.
*
* @param string $json A valid JSON document.
*
* @return array Item formatted for DynamoDB.
* @throws \InvalidArgumentException if the JSON is invalid.
*/
public function marshalJson($json)
{
}
/**
* Marshal a native PHP array of data to a DynamoDB item.
*
* The result is an array formatted in the proper parameter structure
* required by the DynamoDB API for items.
*
* @param array|\stdClass $item An associative array of data.
*
* @return array Item formatted for DynamoDB.
*/
public function marshalItem($item)
{
}
/**
* Marshal a native PHP value into a DynamoDB attribute value.
*
* The result is an associative array that is formatted in the proper
* `[TYPE => VALUE]` parameter structure required by the DynamoDB API.
*
* @param mixed $value A scalar, array, or `stdClass` value.
*
* @return array Attribute formatted for DynamoDB.
* @throws \UnexpectedValueException if the value cannot be marshaled.
*/
public function marshalValue($value)
{
}
/**
* Unmarshal a document (item) from a DynamoDB operation result into a JSON
* document string.
*
* @param array $data Item/document from a DynamoDB result.
* @param int $jsonEncodeFlags Flags to use with `json_encode()`.
*
* @return string
*/
public function unmarshalJson(array $data, $jsonEncodeFlags = 0)
{
}
/**
* Unmarshal an item from a DynamoDB operation result into a native PHP
* array. If you set $mapAsObject to true, then a stdClass value will be
* returned instead.
*
* @param array $data Item from a DynamoDB result.
* @param bool $mapAsObject Whether maps should be represented as stdClass.
*
* @return array|\stdClass
*/
public function unmarshalItem(array $data, $mapAsObject = false)
{
}
/**
* Unmarshal a value from a DynamoDB operation result into a native PHP
* value. Will return a scalar, array, or (if you set $mapAsObject to true)
* stdClass value.
*
* @param array $value Value from a DynamoDB result.
* @param bool $mapAsObject Whether maps should be represented as stdClass.
*
* @return mixed
* @throws \UnexpectedValueException
*/
public function unmarshalValue(array $value, $mapAsObject = false)
{
}
}
}
namespace Aws\XRay {
/**
* This client is used to interact with the **AWS X-Ray** service.
* @method \Aws\Result batchGetTraces(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetTracesAsync(array $args = [])
* @method \Aws\Result createSamplingRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSamplingRuleAsync(array $args = [])
* @method \Aws\Result deleteSamplingRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSamplingRuleAsync(array $args = [])
* @method \Aws\Result getEncryptionConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise getEncryptionConfigAsync(array $args = [])
* @method \Aws\Result getSamplingRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSamplingRulesAsync(array $args = [])
* @method \Aws\Result getSamplingStatisticSummaries(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSamplingStatisticSummariesAsync(array $args = [])
* @method \Aws\Result getSamplingTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSamplingTargetsAsync(array $args = [])
* @method \Aws\Result getServiceGraph(array $args = [])
* @method \GuzzleHttp\Promise\Promise getServiceGraphAsync(array $args = [])
* @method \Aws\Result getTraceGraph(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTraceGraphAsync(array $args = [])
* @method \Aws\Result getTraceSummaries(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTraceSummariesAsync(array $args = [])
* @method \Aws\Result putEncryptionConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise putEncryptionConfigAsync(array $args = [])
* @method \Aws\Result putTelemetryRecords(array $args = [])
* @method \GuzzleHttp\Promise\Promise putTelemetryRecordsAsync(array $args = [])
* @method \Aws\Result putTraceSegments(array $args = [])
* @method \GuzzleHttp\Promise\Promise putTraceSegmentsAsync(array $args = [])
* @method \Aws\Result updateSamplingRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSamplingRuleAsync(array $args = [])
*/
class XRayClient extends \Aws\AwsClient
{
}
}
namespace Aws\XRay\Exception {
/**
* Represents an error interacting with the **AWS X-Ray** service.
*/
class XRayException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CodeStar {
/**
* This client is used to interact with the **AWS CodeStar** service.
* @method \Aws\Result associateTeamMember(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateTeamMemberAsync(array $args = [])
* @method \Aws\Result createProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProjectAsync(array $args = [])
* @method \Aws\Result createUserProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserProfileAsync(array $args = [])
* @method \Aws\Result deleteProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProjectAsync(array $args = [])
* @method \Aws\Result deleteUserProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserProfileAsync(array $args = [])
* @method \Aws\Result describeProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProjectAsync(array $args = [])
* @method \Aws\Result describeUserProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserProfileAsync(array $args = [])
* @method \Aws\Result disassociateTeamMember(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateTeamMemberAsync(array $args = [])
* @method \Aws\Result listProjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise listProjectsAsync(array $args = [])
* @method \Aws\Result listResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourcesAsync(array $args = [])
* @method \Aws\Result listTagsForProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForProjectAsync(array $args = [])
* @method \Aws\Result listTeamMembers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTeamMembersAsync(array $args = [])
* @method \Aws\Result listUserProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUserProfilesAsync(array $args = [])
* @method \Aws\Result tagProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagProjectAsync(array $args = [])
* @method \Aws\Result untagProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagProjectAsync(array $args = [])
* @method \Aws\Result updateProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateProjectAsync(array $args = [])
* @method \Aws\Result updateTeamMember(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTeamMemberAsync(array $args = [])
* @method \Aws\Result updateUserProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserProfileAsync(array $args = [])
*/
class CodeStarClient extends \Aws\AwsClient
{
}
}
namespace Aws\CodeStar\Exception {
/**
* Represents an error interacting with the **AWS CodeStar** service.
*/
class CodeStarException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\KinesisVideo {
/**
* This client is used to interact with the **Amazon Kinesis Video Streams** service.
* @method \Aws\Result createStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStreamAsync(array $args = [])
* @method \Aws\Result deleteStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStreamAsync(array $args = [])
* @method \Aws\Result describeStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStreamAsync(array $args = [])
* @method \Aws\Result getDataEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDataEndpointAsync(array $args = [])
* @method \Aws\Result listStreams(array $args = [])
* @method \GuzzleHttp\Promise\Promise listStreamsAsync(array $args = [])
* @method \Aws\Result listTagsForStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForStreamAsync(array $args = [])
* @method \Aws\Result tagStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagStreamAsync(array $args = [])
* @method \Aws\Result untagStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagStreamAsync(array $args = [])
* @method \Aws\Result updateDataRetention(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDataRetentionAsync(array $args = [])
* @method \Aws\Result updateStream(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateStreamAsync(array $args = [])
*/
class KinesisVideoClient extends \Aws\AwsClient
{
}
}
namespace Aws\KinesisVideo\Exception {
/**
* Represents an error interacting with the **Amazon Kinesis Video Streams** service.
*/
class KinesisVideoException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Handler\GuzzleV6 {
/**
* A request handler that sends PSR-7-compatible requests with Guzzle 6.
*/
class GuzzleHandler
{
/**
* @param ClientInterface $client
*/
public function __construct(\GuzzleHttp\ClientInterface $client = null)
{
}
/**
* @param Psr7Request $request
* @param array $options
*
* @return Promise\Promise
*/
public function __invoke(\Psr\Http\Message\RequestInterface $request, array $options = [])
{
}
}
}
namespace Aws\Handler\GuzzleV5 {
/**
* Adapts a Guzzle 5 Stream to a PSR-7 Stream.
*
* @codeCoverageIgnore
*/
class PsrStream implements \Psr\Http\Message\StreamInterface
{
use \GuzzleHttp\Stream\StreamDecoratorTrait;
public function __construct(\GuzzleHttp\Stream\StreamInterface $stream)
{
}
public function rewind()
{
}
public function getContents()
{
}
}
/**
* Adapts a PSR-7 Stream to a Guzzle 5 Stream.
*
* @codeCoverageIgnore
*/
class GuzzleStream implements \GuzzleHttp\Stream\StreamInterface
{
use \GuzzleHttp\Stream\StreamDecoratorTrait;
public function __construct(\Psr\Http\Message\StreamInterface $stream)
{
}
}
/**
* A request handler that sends PSR-7-compatible requests with Guzzle 5.
*
* The handler accepts a PSR-7 Request object and an array of transfer options
* and returns a Guzzle 6 Promise. The promise is either resolved with a
* PSR-7 Response object or rejected with an array of error data.
*
* @codeCoverageIgnore
*/
class GuzzleHandler
{
/**
* @param ClientInterface $client
*/
public function __construct(\GuzzleHttp\ClientInterface $client = null)
{
}
/**
* @param Psr7Request $request
* @param array $options
*
* @return Promise\Promise
*/
public function __invoke(\Psr\Http\Message\RequestInterface $request, array $options = [])
{
}
}
}
namespace Aws\PI\Exception {
/**
* Represents an error interacting with the **AWS Performance Insights** service.
*/
class PIException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\PI {
/**
* This client is used to interact with the **AWS Performance Insights** service.
* @method \Aws\Result describeDimensionKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDimensionKeysAsync(array $args = [])
* @method \Aws\Result getResourceMetrics(array $args = [])
* @method \GuzzleHttp\Promise\Promise getResourceMetricsAsync(array $args = [])
*/
class PIClient extends \Aws\AwsClient
{
}
}
namespace Aws\Mobile {
/**
* This client is used to interact with the **AWS Mobile** service.
* @method \Aws\Result createProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProjectAsync(array $args = [])
* @method \Aws\Result deleteProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProjectAsync(array $args = [])
* @method \Aws\Result describeBundle(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeBundleAsync(array $args = [])
* @method \Aws\Result describeProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeProjectAsync(array $args = [])
* @method \Aws\Result exportBundle(array $args = [])
* @method \GuzzleHttp\Promise\Promise exportBundleAsync(array $args = [])
* @method \Aws\Result exportProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise exportProjectAsync(array $args = [])
* @method \Aws\Result listBundles(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBundlesAsync(array $args = [])
* @method \Aws\Result listProjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise listProjectsAsync(array $args = [])
* @method \Aws\Result updateProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateProjectAsync(array $args = [])
*/
class MobileClient extends \Aws\AwsClient
{
}
}
namespace Aws\Mobile\Exception {
/**
* Represents an error interacting with the **AWS Mobile** service.
*/
class MobileException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Signature {
/**
* Interface used to provide interchangeable strategies for signing requests
* using the various AWS signature protocols.
*/
interface SignatureInterface
{
/**
* Signs the specified request with an AWS signing protocol by using the
* provided AWS account credentials and adding the required headers to the
* request.
*
* @param RequestInterface $request Request to sign
* @param CredentialsInterface $credentials Signing credentials
*
* @return RequestInterface Returns the modified request.
*/
public function signRequest(\Psr\Http\Message\RequestInterface $request, \Aws\Credentials\CredentialsInterface $credentials);
/**
* Create a pre-signed request.
*
* @param RequestInterface $request Request to sign
* @param CredentialsInterface $credentials Credentials used to sign
* @param int|string|\DateTime $expires The time at which the URL should
* expire. This can be a Unix timestamp, a PHP DateTime object, or a
* string that can be evaluated by strtotime.
*
* @return RequestInterface
*/
public function presign(\Psr\Http\Message\RequestInterface $request, \Aws\Credentials\CredentialsInterface $credentials, $expires);
}
/**
* Provides signature calculation for SignatureV4.
*/
trait SignatureTrait
{
/** @var array Cache of previously signed values */
private $cache = [];
/** @var int Size of the hash cache */
private $cacheSize = 0;
private function createScope($shortDate, $region, $service)
{
}
private function getSigningKey($shortDate, $region, $service, $secretKey)
{
}
}
/**
* Signature Version 4
* @link http://docs.aws.amazon.com/general/latest/gr/signature-version-4.html
*/
class SignatureV4 implements \Aws\Signature\SignatureInterface
{
use \Aws\Signature\SignatureTrait;
const ISO8601_BASIC = 'Ymd\\THis\\Z';
const UNSIGNED_PAYLOAD = 'UNSIGNED-PAYLOAD';
const AMZ_CONTENT_SHA256_HEADER = 'X-Amz-Content-Sha256';
/**
* @param string $service Service name to use when signing
* @param string $region Region name to use when signing
* @param array $options Array of configuration options used when signing
* - unsigned-body: Flag to make request have unsigned payload.
* Unsigned body is used primarily for streaming requests.
*/
public function __construct($service, $region, array $options = [])
{
}
public function signRequest(\Psr\Http\Message\RequestInterface $request, \Aws\Credentials\CredentialsInterface $credentials)
{
}
public function presign(\Psr\Http\Message\RequestInterface $request, \Aws\Credentials\CredentialsInterface $credentials, $expires, array $options = [])
{
}
/**
* Converts a POST request to a GET request by moving POST fields into the
* query string.
*
* Useful for pre-signing query protocol requests.
*
* @param RequestInterface $request Request to clone
*
* @return RequestInterface
* @throws \InvalidArgumentException if the method is not POST
*/
public static function convertPostToGet(\Psr\Http\Message\RequestInterface $request)
{
}
protected function getPayload(\Psr\Http\Message\RequestInterface $request)
{
}
protected function getPresignedPayload(\Psr\Http\Message\RequestInterface $request)
{
}
protected function createCanonicalizedPath($path)
{
}
}
/**
* Signature providers.
*
* A signature provider is a function that accepts a version, service, and
* region and returns a {@see SignatureInterface} object on success or NULL if
* no signature can be created from the provided arguments.
*
* You can wrap your calls to a signature provider with the
* {@see SignatureProvider::resolve} function to ensure that a signature object
* is created. If a signature object is not created, then the resolve()
* function will throw a {@see Aws\Exception\UnresolvedSignatureException}.
*
* use Aws\Signature\SignatureProvider;
* $provider = SignatureProvider::defaultProvider();
* // Returns a SignatureInterface or NULL.
* $signer = $provider('v4', 's3', 'us-west-2');
* // Returns a SignatureInterface or throws.
* $signer = SignatureProvider::resolve($provider, 'no', 's3', 'foo');
*
* You can compose multiple providers into a single provider using
* {@see Aws\or_chain}. This function accepts providers as arguments and
* returns a new function that will invoke each provider until a non-null value
* is returned.
*
* $a = SignatureProvider::defaultProvider();
* $b = function ($version, $service, $region) {
* if ($version === 'foo') {
* return new MyFooSignature();
* }
* };
* $c = \Aws\or_chain($a, $b);
* $signer = $c('v4', 'abc', '123'); // $a handles this.
* $signer = $c('foo', 'abc', '123'); // $b handles this.
* $nullValue = $c('???', 'abc', '123'); // Neither can handle this.
*/
class SignatureProvider
{
/**
* Resolves and signature provider and ensures a non-null return value.
*
* @param callable $provider Provider function to invoke.
* @param string $version Signature version.
* @param string $service Service name.
* @param string $region Region name.
*
* @return SignatureInterface
* @throws UnresolvedSignatureException
*/
public static function resolve(callable $provider, $version, $service, $region)
{
}
/**
* Default SDK signature provider.
*
* @return callable
*/
public static function defaultProvider()
{
}
/**
* Creates a signature provider that caches previously created signature
* objects. The computed cache key is the concatenation of the version,
* service, and region.
*
* @param callable $provider Signature provider to wrap.
*
* @return callable
*/
public static function memoize(callable $provider)
{
}
/**
* Creates signature objects from known signature versions.
*
* This provider currently recognizes the following signature versions:
*
* - v4: Signature version 4.
* - anonymous: Does not sign requests.
*
* @return callable
*/
public static function version()
{
}
}
/**
* Provides anonymous client access (does not sign requests).
*/
class AnonymousSignature implements \Aws\Signature\SignatureInterface
{
public function signRequest(\Psr\Http\Message\RequestInterface $request, \Aws\Credentials\CredentialsInterface $credentials)
{
}
public function presign(\Psr\Http\Message\RequestInterface $request, \Aws\Credentials\CredentialsInterface $credentials, $expires)
{
}
}
/**
* Amazon S3 signature version 4 support.
*/
class S3SignatureV4 extends \Aws\Signature\SignatureV4
{
/**
* Always add a x-amz-content-sha-256 for data integrity.
*/
public function signRequest(\Psr\Http\Message\RequestInterface $request, \Aws\Credentials\CredentialsInterface $credentials)
{
}
/**
* Always add a x-amz-content-sha-256 for data integrity.
*/
public function presign(\Psr\Http\Message\RequestInterface $request, \Aws\Credentials\CredentialsInterface $credentials, $expires, array $options = [])
{
}
/**
* Override used to allow pre-signed URLs to be created for an
* in-determinate request payload.
*/
protected function getPresignedPayload(\Psr\Http\Message\RequestInterface $request)
{
}
/**
* Amazon S3 does not double-encode the path component in the canonical request
*/
protected function createCanonicalizedPath($path)
{
}
}
}
namespace Aws\S3 {
/**
* Converts malformed responses to a retryable error type.
*
* @internal
*/
class RetryableMalformedResponseParser extends \Aws\Api\Parser\AbstractParser
{
public function __construct(callable $parser, $exceptionClass = \Aws\Exception\AwsException::class)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\ResponseInterface $response)
{
}
public function parseMemberFromStream(\Psr\Http\Message\StreamInterface $stream, \Aws\Api\StructureShape $member, $response)
{
}
}
/**
* Used to update the URL used for S3 requests to support:
* S3 Accelerate, S3 DualStack or Both. It will build to
* host style paths unless specified, including for S3
* DualStack.
*
* IMPORTANT: this middleware must be added after the "build" step.
*
* @internal
*/
class S3EndpointMiddleware
{
const NO_PATTERN = 0;
const DUALSTACK = 1;
const ACCELERATE = 2;
const ACCELERATE_DUALSTACK = 3;
const PATH_STYLE = 4;
const HOST_STYLE = 5;
/**
* Create a middleware wrapper function
*
* @param string $region
* @param array $options
*
* @return callable
*/
public static function wrap($region, array $options)
{
}
public function __construct(callable $nextHandler, $region, array $options)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\RequestInterface $request)
{
}
}
/**
* Copies objects from one S3 location to another, utilizing a multipart copy
* when appropriate.
*/
class ObjectCopier implements \GuzzleHttp\Promise\PromisorInterface
{
const DEFAULT_MULTIPART_THRESHOLD = \Aws\S3\MultipartUploader::PART_MAX_SIZE;
/**
* @param S3ClientInterface $client The S3 Client used to execute
* the copy command(s).
* @param array $source The object to copy, specified as
* an array with a 'Bucket' and
* 'Key' keys. Provide a
* 'VersionID' key to copy a
* specified version of an object.
* @param array $destination The bucket and key to which to
* copy the $source, specified as
* an array with a 'Bucket' and
* 'Key' keys.
* @param string $acl ACL to apply to the copy
* (default: private).
* @param array $options Options used to configure the
* copy process. Options passed in
* through 'params' are added to
* the sub commands.
*
* @throws InvalidArgumentException
*/
public function __construct(\Aws\S3\S3ClientInterface $client, array $source, array $destination, $acl = 'private', array $options = [])
{
}
/**
* Perform the configured copy asynchronously. Returns a promise that is
* fulfilled with the result of the CompleteMultipartUpload or CopyObject
* operation or rejected with an exception.
*/
public function promise()
{
}
/**
* Perform the configured copy synchronously. Returns the result of the
* CompleteMultipartUpload or CopyObject operation.
*
* @return Result
*
* @throws S3Exception
* @throws MultipartUploadException
*/
public function copy()
{
}
}
/**
* Throws a PermanentRedirectException exception when a 301 redirect is
* encountered.
*
* @internal
*/
class PermanentRedirectMiddleware
{
/**
* Create a middleware wrapper function.
*
* @return callable
*/
public static function wrap()
{
}
/**
* @param callable $nextHandler Next handler to invoke.
*/
public function __construct(callable $nextHandler)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\RequestInterface $request = null)
{
}
}
/**
* Transfers files from the local filesystem to S3 or from S3 to the local
* filesystem.
*
* This class does not support copying from the local filesystem to somewhere
* else on the local filesystem or from one S3 bucket to another.
*/
class Transfer implements \GuzzleHttp\Promise\PromisorInterface
{
/**
* When providing the $source argument, you may provide a string referencing
* the path to a directory on disk to upload, an s3 scheme URI that contains
* the bucket and key (e.g., "s3://bucket/key"), or an \Iterator object
* that yields strings containing filenames that are the path to a file on
* disk or an s3 scheme URI. The "/key" portion of an s3 URI is optional.
*
* When providing an iterator for the $source argument, you must also
* provide a 'base_dir' key value pair in the $options argument.
*
* The $dest argument can be the path to a directory on disk or an s3
* scheme URI (e.g., "s3://bucket/key").
*
* The options array can contain the following key value pairs:
*
* - base_dir: (string) Base directory of the source, if $source is an
* iterator. If the $source option is not an array, then this option is
* ignored.
* - before: (callable) A callback to invoke before each transfer. The
* callback accepts a single argument: Aws\CommandInterface $command.
* The provided command will be either a GetObject, PutObject,
* InitiateMultipartUpload, or UploadPart command.
* - mup_threshold: (int) Size in bytes in which a multipart upload should
* be used instead of PutObject. Defaults to 20971520 (20 MB).
* - concurrency: (int, default=5) Number of files to upload concurrently.
* The ideal concurrency value will vary based on the number of files
* being uploaded and the average size of each file. Generally speaking,
* smaller files benefit from a higher concurrency while larger files
* will not.
* - debug: (bool) Set to true to print out debug information for
* transfers. Set to an fopen() resource to write to a specific stream
* rather than writing to STDOUT.
*
* @param S3ClientInterface $client Client used for transfers.
* @param string|Iterator $source Where the files are transferred from.
* @param string $dest Where the files are transferred to.
* @param array $options Hash of options.
*/
public function __construct(\Aws\S3\S3ClientInterface $client, $source, $dest, array $options = [])
{
}
/**
* Transfers the files.
*/
public function promise()
{
}
/**
* Transfers the files synchronously.
*/
public function transfer()
{
}
}
/**
* Uploads an object to S3, using a PutObject command or a multipart upload as
* appropriate.
*/
class ObjectUploader implements \GuzzleHttp\Promise\PromisorInterface
{
const DEFAULT_MULTIPART_THRESHOLD = 16777216;
/**
* @param S3ClientInterface $client The S3 Client used to execute
* the upload command(s).
* @param string $bucket Bucket to upload the object.
* @param string $key Key of the object.
* @param mixed $body Object data to upload. Can be a
* StreamInterface, PHP stream
* resource, or a string of data to
* upload.
* @param string $acl ACL to apply to the copy
* (default: private).
* @param array $options Options used to configure the
* copy process. Options passed in
* through 'params' are added to
* the sub command(s).
*/
public function __construct(\Aws\S3\S3ClientInterface $client, $bucket, $key, $body, $acl = 'private', array $options = [])
{
}
public function promise()
{
}
public function upload()
{
}
}
/**
* Apply required or optional MD5s to requests before sending.
*
* IMPORTANT: This middleware must be added after the "build" step.
*
* @internal
*/
class ApplyChecksumMiddleware
{
/**
* Create a middleware wrapper function.
*
* @return callable
*/
public static function wrap()
{
}
public function __construct(callable $nextHandler)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\RequestInterface $request)
{
}
}
/**
* Simplifies the SSE-C process by encoding and hashing the key.
* @internal
*/
class SSECMiddleware
{
/**
* Provide the URI scheme of the client sending requests.
*
* @param string $endpointScheme URI scheme (http/https).
*
* @return callable
*/
public static function wrap($endpointScheme)
{
}
public function __construct($endpointScheme, callable $nextHandler)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\RequestInterface $request = null)
{
}
}
/**
* Injects ObjectURL into the result of the PutObject operation.
*
* @internal
*/
class PutObjectUrlMiddleware
{
/**
* Create a middleware wrapper function.
*
* @return callable
*/
public static function wrap()
{
}
/**
* @param callable $nextHandler Next handler to invoke.
*/
public function __construct(callable $nextHandler)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\RequestInterface $request = null)
{
}
}
interface S3ClientInterface extends \Aws\AwsClientInterface
{
/**
* Create a pre-signed URL for the given S3 command object.
*
* @param CommandInterface $command Command to create a pre-signed
* URL for.
* @param int|string|\DateTime $expires The time at which the URL should
* expire. This can be a Unix
* timestamp, a PHP DateTime object,
* or a string that can be evaluated
* by strtotime().
*
* @return RequestInterface
*/
public function createPresignedRequest(\Aws\CommandInterface $command, $expires);
/**
* Returns the URL to an object identified by its bucket and key.
*
* The URL returned by this method is not signed nor does it ensure the the
* bucket and key given to the method exist. If you need a signed URL, then
* use the {@see \Aws\S3\S3Client::createPresignedRequest} method and get
* the URI of the signed request.
*
* @param string $bucket The name of the bucket where the object is located
* @param string $key The key of the object
*
* @return string The URL to the object
*/
public function getObjectUrl($bucket, $key);
/**
* Determines whether or not a bucket exists by name.
*
* @param string $bucket The name of the bucket
*
* @return bool
*/
public function doesBucketExist($bucket);
/**
* Determines whether or not an object exists by name.
*
* @param string $bucket The name of the bucket
* @param string $key The key of the object
* @param array $options Additional options available in the HeadObject
* operation (e.g., VersionId).
*
* @return bool
*/
public function doesObjectExist($bucket, $key, array $options = []);
/**
* Register the Amazon S3 stream wrapper with this client instance.
*/
public function registerStreamWrapper();
/**
* Deletes objects from Amazon S3 that match the result of a ListObjects
* operation. For example, this allows you to do things like delete all
* objects that match a specific key prefix.
*
* @param string $bucket Bucket that contains the object keys
* @param string $prefix Optionally delete only objects under this key prefix
* @param string $regex Delete only objects that match this regex
* @param array $options Aws\S3\BatchDelete options array.
*
* @see Aws\S3\S3Client::listObjects
* @throws \RuntimeException if no prefix and no regex is given
*/
public function deleteMatchingObjects($bucket, $prefix = '', $regex = '', array $options = []);
/**
* Deletes objects from Amazon S3 that match the result of a ListObjects
* operation. For example, this allows you to do things like delete all
* objects that match a specific key prefix.
*
* @param string $bucket Bucket that contains the object keys
* @param string $prefix Optionally delete only objects under this key prefix
* @param string $regex Delete only objects that match this regex
* @param array $options Aws\S3\BatchDelete options array.
*
* @see Aws\S3\S3Client::listObjects
*
* @return PromiseInterface A promise that is settled when matching
* objects are deleted.
*/
public function deleteMatchingObjectsAsync($bucket, $prefix = '', $regex = '', array $options = []);
/**
* Upload a file, stream, or string to a bucket.
*
* If the upload size exceeds the specified threshold, the upload will be
* performed using concurrent multipart uploads.
*
* The options array accepts the following options:
*
* - before_upload: (callable) Callback to invoke before any upload
* operations during the upload process. The callback should have a
* function signature like `function (Aws\Command $command) {...}`.
* - concurrency: (int, default=int(3)) Maximum number of concurrent
* `UploadPart` operations allowed during a multipart upload.
* - mup_threshold: (int, default=int(16777216)) The size, in bytes, allowed
* before the upload must be sent via a multipart upload. Default: 16 MB.
* - params: (array, default=array([])) Custom parameters to use with the
* upload. For single uploads, they must correspond to those used for the
* `PutObject` operation. For multipart uploads, they correspond to the
* parameters of the `CreateMultipartUpload` operation.
* - part_size: (int) Part size to use when doing a multipart upload.
*
* @param string $bucket Bucket to upload the object.
* @param string $key Key of the object.
* @param mixed $body Object data to upload. Can be a
* StreamInterface, PHP stream resource, or a
* string of data to upload.
* @param string $acl ACL to apply to the object (default: private).
* @param array $options Options used to configure the upload process.
*
* @see Aws\S3\MultipartUploader for more info about multipart uploads.
* @return ResultInterface Returns the result of the upload.
*/
public function upload($bucket, $key, $body, $acl = 'private', array $options = []);
/**
* Upload a file, stream, or string to a bucket asynchronously.
*
* @param string $bucket Bucket to upload the object.
* @param string $key Key of the object.
* @param mixed $body Object data to upload. Can be a
* StreamInterface, PHP stream resource, or a
* string of data to upload.
* @param string $acl ACL to apply to the object (default: private).
* @param array $options Options used to configure the upload process.
*
* @see self::upload
* @return PromiseInterface Returns a promise that will be fulfilled
* with the result of the upload.
*/
public function uploadAsync($bucket, $key, $body, $acl = 'private', array $options = []);
/**
* Copy an object of any size to a different location.
*
* If the upload size exceeds the maximum allowable size for direct S3
* copying, a multipart copy will be used.
*
* The options array accepts the following options:
*
* - before_upload: (callable) Callback to invoke before any upload
* operations during the upload process. The callback should have a
* function signature like `function (Aws\Command $command) {...}`.
* - concurrency: (int, default=int(5)) Maximum number of concurrent
* `UploadPart` operations allowed during a multipart upload.
* - params: (array, default=array([])) Custom parameters to use with the
* upload. For single uploads, they must correspond to those used for the
* `CopyObject` operation. For multipart uploads, they correspond to the
* parameters of the `CreateMultipartUpload` operation.
* - part_size: (int) Part size to use when doing a multipart upload.
*
* @param string $fromBucket Bucket where the copy source resides.
* @param string $fromKey Key of the copy source.
* @param string $destBucket Bucket to which to copy the object.
* @param string $destKey Key to which to copy the object.
* @param string $acl ACL to apply to the copy (default: private).
* @param array $options Options used to configure the upload process.
*
* @see Aws\S3\MultipartCopy for more info about multipart uploads.
* @return ResultInterface Returns the result of the copy.
*/
public function copy($fromBucket, $fromKey, $destBucket, $destKey, $acl = 'private', array $options = []);
/**
* Copy an object of any size to a different location asynchronously.
*
* @param string $fromBucket Bucket where the copy source resides.
* @param string $fromKey Key of the copy source.
* @param string $destBucket Bucket to which to copy the object.
* @param string $destKey Key to which to copy the object.
* @param string $acl ACL to apply to the copy (default: private).
* @param array $options Options used to configure the upload process.
*
* @see self::copy for more info about the parameters above.
* @return PromiseInterface Returns a promise that will be fulfilled
* with the result of the copy.
*/
public function copyAsync($fromBucket, $fromKey, $destBucket, $destKey, $acl = 'private', array $options = []);
/**
* Recursively uploads all files in a given directory to a given bucket.
*
* @param string $directory Full path to a directory to upload
* @param string $bucket Name of the bucket
* @param string $keyPrefix Virtual directory key prefix to add to each upload
* @param array $options Options available in Aws\S3\Transfer::__construct
*
* @see Aws\S3\Transfer for more options and customization
*/
public function uploadDirectory($directory, $bucket, $keyPrefix = null, array $options = []);
/**
* Recursively uploads all files in a given directory to a given bucket.
*
* @param string $directory Full path to a directory to upload
* @param string $bucket Name of the bucket
* @param string $keyPrefix Virtual directory key prefix to add to each upload
* @param array $options Options available in Aws\S3\Transfer::__construct
*
* @see Aws\S3\Transfer for more options and customization
*
* @return PromiseInterface A promise that is settled when the upload is
* complete.
*/
public function uploadDirectoryAsync($directory, $bucket, $keyPrefix = null, array $options = []);
/**
* Downloads a bucket to the local filesystem
*
* @param string $directory Directory to download to
* @param string $bucket Bucket to download from
* @param string $keyPrefix Only download objects that use this key prefix
* @param array $options Options available in Aws\S3\Transfer::__construct
*/
public function downloadBucket($directory, $bucket, $keyPrefix = '', array $options = []);
/**
* Downloads a bucket to the local filesystem
*
* @param string $directory Directory to download to
* @param string $bucket Bucket to download from
* @param string $keyPrefix Only download objects that use this key prefix
* @param array $options Options available in Aws\S3\Transfer::__construct
*
* @return PromiseInterface A promise that is settled when the download is
* complete.
*/
public function downloadBucketAsync($directory, $bucket, $keyPrefix = '', array $options = []);
/**
* Returns the region in which a given bucket is located.
*
* @param string $bucketName
*
* @return string
*/
public function determineBucketRegion($bucketName);
/**
* Returns a promise fulfilled with the region in which a given bucket is
* located.
*
* @param string $bucketName
*
* @return PromiseInterface
*/
public function determineBucketRegionAsync($bucketName);
}
/**
* A trait providing S3-specific functionality. This is meant to be used in
* classes implementing \Aws\S3\S3ClientInterface
*/
trait S3ClientTrait
{
use \Aws\Api\Parser\PayloadParserTrait;
/**
* @see S3ClientInterface::upload()
*/
public function upload($bucket, $key, $body, $acl = 'private', array $options = [])
{
}
/**
* @see S3ClientInterface::uploadAsync()
*/
public function uploadAsync($bucket, $key, $body, $acl = 'private', array $options = [])
{
}
/**
* @see S3ClientInterface::copy()
*/
public function copy($fromB, $fromK, $destB, $destK, $acl = 'private', array $opts = [])
{
}
/**
* @see S3ClientInterface::copyAsync()
*/
public function copyAsync($fromB, $fromK, $destB, $destK, $acl = 'private', array $opts = [])
{
}
/**
* @see S3ClientInterface::registerStreamWrapper()
*/
public function registerStreamWrapper()
{
}
/**
* @see S3ClientInterface::deleteMatchingObjects()
*/
public function deleteMatchingObjects($bucket, $prefix = '', $regex = '', array $options = [])
{
}
/**
* @see S3ClientInterface::deleteMatchingObjectsAsync()
*/
public function deleteMatchingObjectsAsync($bucket, $prefix = '', $regex = '', array $options = [])
{
}
/**
* @see S3ClientInterface::uploadDirectory()
*/
public function uploadDirectory($directory, $bucket, $keyPrefix = null, array $options = [])
{
}
/**
* @see S3ClientInterface::uploadDirectoryAsync()
*/
public function uploadDirectoryAsync($directory, $bucket, $keyPrefix = null, array $options = [])
{
}
/**
* @see S3ClientInterface::downloadBucket()
*/
public function downloadBucket($directory, $bucket, $keyPrefix = '', array $options = [])
{
}
/**
* @see S3ClientInterface::downloadBucketAsync()
*/
public function downloadBucketAsync($directory, $bucket, $keyPrefix = '', array $options = [])
{
}
/**
* @see S3ClientInterface::determineBucketRegion()
*/
public function determineBucketRegion($bucketName)
{
}
/**
* @see S3ClientInterface::determineBucketRegionAsync()
*
* @param string $bucketName
*
* @return PromiseInterface
*/
public function determineBucketRegionAsync($bucketName)
{
}
private function determineBucketRegionFromExceptionBody(\Psr\Http\Message\ResponseInterface $response)
{
}
/**
* @see S3ClientInterface::doesBucketExist()
*/
public function doesBucketExist($bucket)
{
}
/**
* @see S3ClientInterface::doesObjectExist()
*/
public function doesObjectExist($bucket, $key, array $options = [])
{
}
/**
* Determines whether or not a resource exists using a command
*
* @param CommandInterface $command Command used to poll for the resource
*
* @return bool
* @throws S3Exception|\Exception if there is an unhandled exception
*/
private function checkExistenceWithCommand(\Aws\CommandInterface $command)
{
}
/**
* @see S3ClientInterface::execute()
*/
public abstract function execute(\Aws\CommandInterface $command);
/**
* @see S3ClientInterface::getCommand()
*/
public abstract function getCommand($name, array $args = []);
/**
* @see S3ClientInterface::getHandlerList()
*
* @return HandlerList
*/
public abstract function getHandlerList();
/**
* @see S3ClientInterface::getIterator()
*
* @return \Iterator
*/
public abstract function getIterator($name, array $args = []);
}
/**
* **Amazon Simple Storage Service** multi-region client.
*
* @method \Aws\Result abortMultipartUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise abortMultipartUploadAsync(array $args = [])
* @method \Aws\Result completeMultipartUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise completeMultipartUploadAsync(array $args = [])
* @method \Aws\Result copyObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyObjectAsync(array $args = [])
* @method \Aws\Result createBucket(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBucketAsync(array $args = [])
* @method \Aws\Result createMultipartUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise createMultipartUploadAsync(array $args = [])
* @method \Aws\Result deleteBucket(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketAsync(array $args = [])
* @method \Aws\Result deleteBucketAnalyticsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketAnalyticsConfigurationAsync(array $args = [])
* @method \Aws\Result deleteBucketCors(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketCorsAsync(array $args = [])
* @method \Aws\Result deleteBucketEncryption(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketEncryptionAsync(array $args = [])
* @method \Aws\Result deleteBucketInventoryConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketInventoryConfigurationAsync(array $args = [])
* @method \Aws\Result deleteBucketLifecycle(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketLifecycleAsync(array $args = [])
* @method \Aws\Result deleteBucketMetricsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketMetricsConfigurationAsync(array $args = [])
* @method \Aws\Result deleteBucketPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketPolicyAsync(array $args = [])
* @method \Aws\Result deleteBucketReplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketReplicationAsync(array $args = [])
* @method \Aws\Result deleteBucketTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketTaggingAsync(array $args = [])
* @method \Aws\Result deleteBucketWebsite(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketWebsiteAsync(array $args = [])
* @method \Aws\Result deleteObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteObjectAsync(array $args = [])
* @method \Aws\Result deleteObjectTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteObjectTaggingAsync(array $args = [])
* @method \Aws\Result deleteObjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteObjectsAsync(array $args = [])
* @method \Aws\Result getBucketAccelerateConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketAccelerateConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketAcl(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketAclAsync(array $args = [])
* @method \Aws\Result getBucketAnalyticsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketAnalyticsConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketCors(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketCorsAsync(array $args = [])
* @method \Aws\Result getBucketEncryption(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketEncryptionAsync(array $args = [])
* @method \Aws\Result getBucketInventoryConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketInventoryConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketLifecycle(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketLifecycleAsync(array $args = [])
* @method \Aws\Result getBucketLifecycleConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketLifecycleConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketLocation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketLocationAsync(array $args = [])
* @method \Aws\Result getBucketLogging(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketLoggingAsync(array $args = [])
* @method \Aws\Result getBucketMetricsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketMetricsConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketNotification(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketNotificationAsync(array $args = [])
* @method \Aws\Result getBucketNotificationConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketNotificationConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketPolicyAsync(array $args = [])
* @method \Aws\Result getBucketReplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketReplicationAsync(array $args = [])
* @method \Aws\Result getBucketRequestPayment(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketRequestPaymentAsync(array $args = [])
* @method \Aws\Result getBucketTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketTaggingAsync(array $args = [])
* @method \Aws\Result getBucketVersioning(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketVersioningAsync(array $args = [])
* @method \Aws\Result getBucketWebsite(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketWebsiteAsync(array $args = [])
* @method \Aws\Result getObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectAsync(array $args = [])
* @method \Aws\Result getObjectAcl(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectAclAsync(array $args = [])
* @method \Aws\Result getObjectTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectTaggingAsync(array $args = [])
* @method \Aws\Result getObjectTorrent(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectTorrentAsync(array $args = [])
* @method \Aws\Result headBucket(array $args = [])
* @method \GuzzleHttp\Promise\Promise headBucketAsync(array $args = [])
* @method \Aws\Result headObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise headObjectAsync(array $args = [])
* @method \Aws\Result listBucketAnalyticsConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBucketAnalyticsConfigurationsAsync(array $args = [])
* @method \Aws\Result listBucketInventoryConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBucketInventoryConfigurationsAsync(array $args = [])
* @method \Aws\Result listBucketMetricsConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBucketMetricsConfigurationsAsync(array $args = [])
* @method \Aws\Result listBuckets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBucketsAsync(array $args = [])
* @method \Aws\Result listMultipartUploads(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMultipartUploadsAsync(array $args = [])
* @method \Aws\Result listObjectVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectVersionsAsync(array $args = [])
* @method \Aws\Result listObjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectsAsync(array $args = [])
* @method \Aws\Result listObjectsV2(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectsV2Async(array $args = [])
* @method \Aws\Result listParts(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPartsAsync(array $args = [])
* @method \Aws\Result putBucketAccelerateConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketAccelerateConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketAcl(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketAclAsync(array $args = [])
* @method \Aws\Result putBucketAnalyticsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketAnalyticsConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketCors(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketCorsAsync(array $args = [])
* @method \Aws\Result putBucketEncryption(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketEncryptionAsync(array $args = [])
* @method \Aws\Result putBucketInventoryConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketInventoryConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketLifecycle(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketLifecycleAsync(array $args = [])
* @method \Aws\Result putBucketLifecycleConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketLifecycleConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketLogging(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketLoggingAsync(array $args = [])
* @method \Aws\Result putBucketMetricsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketMetricsConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketNotification(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketNotificationAsync(array $args = [])
* @method \Aws\Result putBucketNotificationConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketNotificationConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketPolicyAsync(array $args = [])
* @method \Aws\Result putBucketReplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketReplicationAsync(array $args = [])
* @method \Aws\Result putBucketRequestPayment(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketRequestPaymentAsync(array $args = [])
* @method \Aws\Result putBucketTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketTaggingAsync(array $args = [])
* @method \Aws\Result putBucketVersioning(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketVersioningAsync(array $args = [])
* @method \Aws\Result putBucketWebsite(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketWebsiteAsync(array $args = [])
* @method \Aws\Result putObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise putObjectAsync(array $args = [])
* @method \Aws\Result putObjectAcl(array $args = [])
* @method \GuzzleHttp\Promise\Promise putObjectAclAsync(array $args = [])
* @method \Aws\Result putObjectTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise putObjectTaggingAsync(array $args = [])
* @method \Aws\Result restoreObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreObjectAsync(array $args = [])
* @method \Aws\Result selectObjectContent(array $args = [])
* @method \GuzzleHttp\Promise\Promise selectObjectContentAsync(array $args = [])
* @method \Aws\Result uploadPart(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadPartAsync(array $args = [])
* @method \Aws\Result uploadPartCopy(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadPartCopyAsync(array $args = [])
*/
class S3MultiRegionClient extends \Aws\MultiRegionClient implements \Aws\S3\S3ClientInterface
{
use \Aws\S3\S3ClientTrait;
public static function getArguments()
{
}
public function __construct(array $args)
{
}
public function createPresignedRequest(\Aws\CommandInterface $command, $expires)
{
}
public function getObjectUrl($bucket, $key)
{
}
public function determineBucketRegionAsync($bucketName)
{
}
}
/**
* @deprecated
*/
class PostObject
{
/**
* Constructs the PostObject.
*
* @param S3ClientInterface $client Client used with the POST object
* @param string $bucket Bucket to use
* @param array $formInputs Associative array of form input
* fields.
* @param string|array $jsonPolicy JSON encoded POST policy document.
* The policy will be base64 encoded
* and applied to the form on your
* behalf.
*/
public function __construct(\Aws\S3\S3ClientInterface $client, $bucket, array $formInputs, $jsonPolicy)
{
}
/**
* Gets the S3 client.
*
* @return S3ClientInterface
*/
public function getClient()
{
}
/**
* Gets the bucket name.
*
* @return string
*/
public function getBucket()
{
}
/**
* Gets the form attributes as an array.
*
* @return array
*/
public function getFormAttributes()
{
}
/**
* Set a form attribute.
*
* @param string $attribute Form attribute to set.
* @param string $value Value to set.
*/
public function setFormAttribute($attribute, $value)
{
}
/**
* Gets the form inputs as an array.
*
* @return array
*/
public function getFormInputs()
{
}
/**
* Set a form input.
*
* @param string $field Field name to set
* @param string $value Value to set.
*/
public function setFormInput($field, $value)
{
}
/**
* Gets the raw JSON policy.
*
* @return string
*/
public function getJsonPolicy()
{
}
protected function getPolicyAndSignature(\Aws\Credentials\CredentialsInterface $creds)
{
}
}
/**
* Extracts a region, bucket, key, and and if a URI is in path-style
*/
class S3UriParser
{
/**
* Parses a URL or S3 StreamWrapper Uri (s3://) into an associative array
* of Amazon S3 data including:
*
* - bucket: The Amazon S3 bucket (null if none)
* - key: The Amazon S3 key (null if none)
* - path_style: Set to true if using path style, or false if not
* - region: Set to a string if a non-class endpoint is used or null.
*
* @param string|UriInterface $uri
*
* @return array
* @throws \InvalidArgumentException
*/
public function parse($uri)
{
}
}
trait MultipartUploadingTrait
{
/**
* Creates an UploadState object for a multipart upload by querying the
* service for the specified upload's information.
*
* @param S3ClientInterface $client S3Client used for the upload.
* @param string $bucket Bucket for the multipart upload.
* @param string $key Object key for the multipart upload.
* @param string $uploadId Upload ID for the multipart upload.
*
* @return UploadState
*/
public static function getStateFromService(\Aws\S3\S3ClientInterface $client, $bucket, $key, $uploadId)
{
}
protected function handleResult(\Aws\CommandInterface $command, \Aws\ResultInterface $result)
{
}
protected abstract function extractETag(\Aws\ResultInterface $result);
protected function getCompleteParams()
{
}
protected function determinePartSize()
{
}
protected function getInitiateParams()
{
}
/**
* @return UploadState
*/
protected abstract function getState();
/**
* @return array
*/
protected abstract function getConfig();
/**
* @return int
*/
protected abstract function getSourceSize();
/**
* @return string|null
*/
protected abstract function getSourceMimeType();
}
/**
* Encapsulates the execution of a multipart upload to S3 or Glacier.
*/
class MultipartUploader extends \Aws\Multipart\AbstractUploader
{
use \Aws\S3\MultipartUploadingTrait;
const PART_MIN_SIZE = 5242880;
const PART_MAX_SIZE = 5368709120;
const PART_MAX_NUM = 10000;
/**
* Creates a multipart upload for an S3 object.
*
* The valid configuration options are as follows:
*
* - acl: (string) ACL to set on the object being upload. Objects are
* private by default.
* - before_complete: (callable) Callback to invoke before the
* `CompleteMultipartUpload` operation. The callback should have a
* function signature like `function (Aws\Command $command) {...}`.
* - before_initiate: (callable) Callback to invoke before the
* `CreateMultipartUpload` operation. The callback should have a function
* signature like `function (Aws\Command $command) {...}`.
* - before_upload: (callable) Callback to invoke before any `UploadPart`
* operations. The callback should have a function signature like
* `function (Aws\Command $command) {...}`.
* - bucket: (string, required) Name of the bucket to which the object is
* being uploaded.
* - concurrency: (int, default=int(5)) Maximum number of concurrent
* `UploadPart` operations allowed during the multipart upload.
* - key: (string, required) Key to use for the object being uploaded.
* - params: (array) An array of key/value parameters that will be applied
* to each of the sub-commands run by the uploader as a base.
* Auto-calculated options will override these parameters. If you need
* more granularity over parameters to each sub-command, use the before_*
* options detailed above to update the commands directly.
* - part_size: (int, default=int(5242880)) Part size, in bytes, to use when
* doing a multipart upload. This must between 5 MB and 5 GB, inclusive.
* - prepare_data_source: (callable) Callback to invoke before starting the
* multipart upload workflow. The callback should have a function
* signature like `function () {...}`.
* - state: (Aws\Multipart\UploadState) An object that represents the state
* of the multipart upload and that is used to resume a previous upload.
* When this option is provided, the `bucket`, `key`, and `part_size`
* options are ignored.
*
* @param S3ClientInterface $client Client used for the upload.
* @param mixed $source Source of the data to upload.
* @param array $config Configuration used to perform the upload.
*/
public function __construct(\Aws\S3\S3ClientInterface $client, $source, array $config = [])
{
}
protected function loadUploadWorkflowInfo()
{
}
protected function createPart($seekable, $number)
{
}
protected function extractETag(\Aws\ResultInterface $result)
{
}
protected function getSourceMimeType()
{
}
protected function getSourceSize()
{
}
}
/**
* Encapsulates the logic for getting the data for an S3 object POST upload form
*
* @link http://docs.aws.amazon.com/AmazonS3/latest/API/RESTObjectPOST.html
* @link http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-post-example.html
*/
class PostObjectV4
{
use \Aws\Signature\SignatureTrait;
/**
* Constructs the PostObject.
*
* The options array accepts the following keys:
* @link http://docs.aws.amazon.com/AmazonS3/latest/API/sigv4-query-string-auth.html
*
* @param S3ClientInterface $client Client used with the POST object
* @param string $bucket Bucket to use
* @param array $formInputs Associative array of form input
* fields.
* @param array $options Policy condition options
* @param mixed $expiration Upload expiration time value. By
* default: 1 hour valid period.
*/
public function __construct(\Aws\S3\S3ClientInterface $client, $bucket, array $formInputs, array $options = [], $expiration = '+1 hours')
{
}
/**
* Gets the S3 client.
*
* @return S3ClientInterface
*/
public function getClient()
{
}
/**
* Gets the bucket name.
*
* @return string
*/
public function getBucket()
{
}
/**
* Gets the form attributes as an array.
*
* @return array
*/
public function getFormAttributes()
{
}
/**
* Set a form attribute.
*
* @param string $attribute Form attribute to set.
* @param string $value Value to set.
*/
public function setFormAttribute($attribute, $value)
{
}
/**
* Gets the form inputs as an array.
*
* @return array
*/
public function getFormInputs()
{
}
/**
* Set a form input.
*
* @param string $field Field name to set
* @param string $value Value to set.
*/
public function setFormInput($field, $value)
{
}
protected function getPolicyAndSignature(\Aws\Credentials\CredentialsInterface $credentials, array $policy)
{
}
}
class MultipartCopy extends \Aws\Multipart\AbstractUploadManager
{
use \Aws\S3\MultipartUploadingTrait;
/**
* Creates a multipart upload for copying an S3 object.
*
* The valid configuration options are as follows:
*
* - acl: (string) ACL to set on the object being upload. Objects are
* private by default.
* - before_complete: (callable) Callback to invoke before the
* `CompleteMultipartUpload` operation. The callback should have a
* function signature like `function (Aws\Command $command) {...}`.
* - before_initiate: (callable) Callback to invoke before the
* `CreateMultipartUpload` operation. The callback should have a function
* signature like `function (Aws\Command $command) {...}`.
* - before_upload: (callable) Callback to invoke before `UploadPartCopy`
* operations. The callback should have a function signature like
* `function (Aws\Command $command) {...}`.
* - bucket: (string, required) Name of the bucket to which the object is
* being uploaded.
* - concurrency: (int, default=int(5)) Maximum number of concurrent
* `UploadPart` operations allowed during the multipart upload.
* - key: (string, required) Key to use for the object being uploaded.
* - params: (array) An array of key/value parameters that will be applied
* to each of the sub-commands run by the uploader as a base.
* Auto-calculated options will override these parameters. If you need
* more granularity over parameters to each sub-command, use the before_*
* options detailed above to update the commands directly.
* - part_size: (int, default=int(5242880)) Part size, in bytes, to use when
* doing a multipart upload. This must between 5 MB and 5 GB, inclusive.
* - state: (Aws\Multipart\UploadState) An object that represents the state
* of the multipart upload and that is used to resume a previous upload.
* When this option is provided, the `bucket`, `key`, and `part_size`
* options are ignored.
* - source_metadata: (Aws\ResultInterface) An object that represents the
* result of executing a HeadObject command on the copy source.
*
* @param S3ClientInterface $client Client used for the upload.
* @param string $source Location of the data to be copied
* (in the form /<bucket>/<key>).
* @param array $config Configuration used to perform the upload.
*/
public function __construct(\Aws\S3\S3ClientInterface $client, $source, array $config = [])
{
}
/**
* An alias of the self::upload method.
*
* @see self::upload
*/
public function copy()
{
}
protected function loadUploadWorkflowInfo()
{
}
protected function getUploadCommands(callable $resultHandler)
{
}
protected function extractETag(\Aws\ResultInterface $result)
{
}
protected function getSourceMimeType()
{
}
protected function getSourceSize()
{
}
}
/**
* Amazon S3 stream wrapper to use "s3://<bucket>/<key>" files with PHP
* streams, supporting "r", "w", "a", "x".
*
* # Opening "r" (read only) streams:
*
* Read only streams are truly streaming by default and will not allow you to
* seek. This is because data read from the stream is not kept in memory or on
* the local filesystem. You can force a "r" stream to be seekable by setting
* the "seekable" stream context option true. This will allow true streaming of
* data from Amazon S3, but will maintain a buffer of previously read bytes in
* a 'php://temp' stream to allow seeking to previously read bytes from the
* stream.
*
* You may pass any GetObject parameters as 's3' stream context options. These
* options will affect how the data is downloaded from Amazon S3.
*
* # Opening "w" and "x" (write only) streams:
*
* Because Amazon S3 requires a Content-Length header, write only streams will
* maintain a 'php://temp' stream to buffer data written to the stream until
* the stream is flushed (usually by closing the stream with fclose).
*
* You may pass any PutObject parameters as 's3' stream context options. These
* options will affect how the data is uploaded to Amazon S3.
*
* When opening an "x" stream, the file must exist on Amazon S3 for the stream
* to open successfully.
*
* # Opening "a" (write only append) streams:
*
* Similar to "w" streams, opening append streams requires that the data be
* buffered in a "php://temp" stream. Append streams will attempt to download
* the contents of an object in Amazon S3, seek to the end of the object, then
* allow you to append to the contents of the object. The data will then be
* uploaded using a PutObject operation when the stream is flushed (usually
* with fclose).
*
* You may pass any GetObject and/or PutObject parameters as 's3' stream
* context options. These options will affect how the data is downloaded and
* uploaded from Amazon S3.
*
* Stream context options:
*
* - "seekable": Set to true to create a seekable "r" (read only) stream by
* using a php://temp stream buffer
* - For "unlink" only: Any option that can be passed to the DeleteObject
* operation
*/
class StreamWrapper
{
/** @var resource|null Stream context (this is set by PHP) */
public $context;
/**
* Register the 's3://' stream wrapper
*
* @param S3ClientInterface $client Client to use with the stream wrapper
* @param string $protocol Protocol to register as.
* @param CacheInterface $cache Default cache for the protocol.
*/
public static function register(\Aws\S3\S3ClientInterface $client, $protocol = 's3', \Aws\CacheInterface $cache = null)
{
}
public function stream_close()
{
}
public function stream_open($path, $mode, $options, &$opened_path)
{
}
public function stream_eof()
{
}
public function stream_flush()
{
}
public function stream_read($count)
{
}
public function stream_seek($offset, $whence = SEEK_SET)
{
}
public function stream_tell()
{
}
public function stream_write($data)
{
}
public function unlink($path)
{
}
public function stream_stat()
{
}
/**
* Provides information for is_dir, is_file, filesize, etc. Works on
* buckets, keys, and prefixes.
* @link http://www.php.net/manual/en/streamwrapper.url-stat.php
*/
public function url_stat($path, $flags)
{
}
/**
* Support for mkdir().
*
* @param string $path Directory which should be created.
* @param int $mode Permissions. 700-range permissions map to
* ACL_PUBLIC. 600-range permissions map to
* ACL_AUTH_READ. All other permissions map to
* ACL_PRIVATE. Expects octal form.
* @param int $options A bitwise mask of values, such as
* STREAM_MKDIR_RECURSIVE.
*
* @return bool
* @link http://www.php.net/manual/en/streamwrapper.mkdir.php
*/
public function mkdir($path, $mode, $options)
{
}
public function rmdir($path, $options)
{
}
/**
* Support for opendir().
*
* The opendir() method of the Amazon S3 stream wrapper supports a stream
* context option of "listFilter". listFilter must be a callable that
* accepts an associative array of object data and returns true if the
* object should be yielded when iterating the keys in a bucket.
*
* @param string $path The path to the directory
* (e.g. "s3://dir[</prefix>]")
* @param string $options Unused option variable
*
* @return bool true on success
* @see http://www.php.net/manual/en/function.opendir.php
*/
public function dir_opendir($path, $options)
{
}
/**
* Close the directory listing handles
*
* @return bool true on success
*/
public function dir_closedir()
{
}
/**
* This method is called in response to rewinddir()
*
* @return boolean true on success
*/
public function dir_rewinddir()
{
}
/**
* This method is called in response to readdir()
*
* @return string Should return a string representing the next filename, or
* false if there is no next file.
* @link http://www.php.net/manual/en/function.readdir.php
*/
public function dir_readdir()
{
}
/**
* Called in response to rename() to rename a file or directory. Currently
* only supports renaming objects.
*
* @param string $path_from the path to the file to rename
* @param string $path_to the new path to the file
*
* @return bool true if file was successfully renamed
* @link http://www.php.net/manual/en/function.rename.php
*/
public function rename($path_from, $path_to)
{
}
public function stream_cast($cast_as)
{
}
}
/**
* Efficiently deletes many objects from a single Amazon S3 bucket using an
* iterator that yields keys. Deletes are made using the DeleteObjects API
* operation.
*
* $s3 = new Aws\S3\Client([
* 'region' => 'us-west-2',
* 'version' => 'latest'
* ]);
*
* $listObjectsParams = ['Bucket' => 'foo', 'Prefix' => 'starts/with/'];
* $delete = Aws\S3\BatchDelete::fromListObjects($s3, $listObjectsParams);
* // Asynchronously delete
* $promise = $delete->promise();
* // Force synchronous completion
* $delete->delete();
*
* When using one of the batch delete creational static methods, you can supply
* an associative array of options:
*
* - before: Function invoked before executing a command. The function is
* passed the command that is about to be executed. This can be useful
* for logging, adding custom request headers, etc.
* - batch_size: The size of each delete batch. Defaults to 1000.
*
* @link http://docs.aws.amazon.com/AmazonS3/latest/API/multiobjectdeleteapi.html
*/
class BatchDelete implements \GuzzleHttp\Promise\PromisorInterface
{
/**
* Creates a BatchDelete object from all of the paginated results of a
* ListObjects operation. Each result that is returned by the ListObjects
* operation will be deleted.
*
* @param AwsClientInterface $client AWS Client to use.
* @param array $listObjectsParams ListObjects API parameters
* @param array $options BatchDelete options.
*
* @return BatchDelete
*/
public static function fromListObjects(\Aws\AwsClientInterface $client, array $listObjectsParams, array $options = [])
{
}
/**
* Creates a BatchDelete object from an iterator that yields results.
*
* @param AwsClientInterface $client AWS Client to use to execute commands
* @param string $bucket Bucket where the objects are stored
* @param \Iterator $iter Iterator that yields assoc arrays
* @param array $options BatchDelete options
*
* @return BatchDelete
*/
public static function fromIterator(\Aws\AwsClientInterface $client, $bucket, \Iterator $iter, array $options = [])
{
}
public function promise()
{
}
/**
* Synchronously deletes all of the objects.
*
* @throws DeleteMultipleObjectsException on error.
*/
public function delete()
{
}
}
/**
* Converts errors returned with a status code of 200 to a retryable error type.
*
* @internal
*/
class AmbiguousSuccessParser extends \Aws\Api\Parser\AbstractParser
{
public function __construct(callable $parser, callable $errorParser, $exceptionClass = \Aws\Exception\AwsException::class)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\ResponseInterface $response)
{
}
public function parseMemberFromStream(\Psr\Http\Message\StreamInterface $stream, \Aws\Api\StructureShape $member, $response)
{
}
}
/**
* @internal Decorates a parser for the S3 service to correctly handle the
* GetBucketLocation operation.
*/
class GetBucketLocationParser extends \Aws\Api\Parser\AbstractParser
{
/**
* @param callable $parser Parser to wrap.
*/
public function __construct(callable $parser)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\ResponseInterface $response)
{
}
public function parseMemberFromStream(\Psr\Http\Message\StreamInterface $stream, \Aws\Api\StructureShape $member, $response)
{
}
}
}
namespace Aws\Exception {
class MultipartUploadException extends \RuntimeException implements \Aws\MonitoringEventsInterface
{
use \Aws\HasMonitoringEventsTrait;
/**
* @param UploadState $state Upload state at time of the exception.
* @param \Exception|array $prev Exception being thrown.
*/
public function __construct(\Aws\Multipart\UploadState $state, $prev = null)
{
}
/**
* Get the state of the transfer
*
* @return UploadState
*/
public function getState()
{
}
}
}
namespace Aws\S3\Exception {
class S3MultipartUploadException extends \Aws\Exception\MultipartUploadException
{
/**
* @param UploadState $state Upload state at time of the exception.
* @param \Exception|array $prev Exception being thrown. Could be an array of
* AwsExceptions being thrown when uploading parts
* for one object, or an instance of AwsException
* for a specific Multipart error being thrown in
* the MultipartUpload process.
*/
public function __construct(\Aws\Multipart\UploadState $state, $prev = null)
{
}
/**
* Get the Bucket information of the transfer object
*
* @return string|null Returns null when 'Bucket' information
* is unavailable.
*/
public function getBucket()
{
}
/**
* Get the Key information of the transfer object
*
* @return string|null Returns null when 'Key' information
* is unavailable.
*/
public function getKey()
{
}
/**
* Get the source file name of the transfer object
*
* @return string|null Returns null when metadata of the stream
* wrapped in 'Body' parameter is unavailable.
*/
public function getSourceFileName()
{
}
}
/**
* Exception thrown when errors occur while deleting objects using a
* {@see S3\BatchDelete} object.
*/
class DeleteMultipleObjectsException extends \Exception implements \Aws\MonitoringEventsInterface
{
use \Aws\HasMonitoringEventsTrait;
/**
* @param array $deleted Array of successfully deleted keys
* @param array $errors Array of errors that were encountered
*/
public function __construct(array $deleted, array $errors)
{
}
/**
* Create a single error message from multiple errors.
*
* @param array $errors Errors encountered
*
* @return string
*/
public static function createMessageFromErrors(array $errors)
{
}
/**
* Get the errored objects
*
* @return array Returns an array of associative arrays, each containing
* a 'Code', 'Message', and 'Key' key.
*/
public function getErrors()
{
}
/**
* Get the successfully deleted objects
*
* @return array Returns an array of associative arrays, each containing
* a 'Key' and optionally 'DeleteMarker' and
* 'DeleterMarkerVersionId'
*/
public function getDeleted()
{
}
}
/**
* Represents an error interacting with the Amazon Simple Storage Service.
*/
class S3Exception extends \Aws\Exception\AwsException
{
}
class PermanentRedirectException extends \Aws\S3\Exception\S3Exception
{
}
}
namespace Aws\S3 {
/**
* Used to update the host used for S3 requests in the case of using a
* "bucket endpoint" or CNAME bucket.
*
* IMPORTANT: this middleware must be added after the "build" step.
*
* @internal
*/
class BucketEndpointMiddleware
{
/**
* Create a middleware wrapper function.
*
* @return callable
*/
public static function wrap()
{
}
public function __construct(callable $nextHandler)
{
}
public function __invoke(\Aws\CommandInterface $command, \Psr\Http\Message\RequestInterface $request)
{
}
}
/**
* Client used to interact with **Amazon Simple Storage Service (Amazon S3)**.
*
* @method \Aws\Result abortMultipartUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise abortMultipartUploadAsync(array $args = [])
* @method \Aws\Result completeMultipartUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise completeMultipartUploadAsync(array $args = [])
* @method \Aws\Result copyObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise copyObjectAsync(array $args = [])
* @method \Aws\Result createBucket(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBucketAsync(array $args = [])
* @method \Aws\Result createMultipartUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise createMultipartUploadAsync(array $args = [])
* @method \Aws\Result deleteBucket(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketAsync(array $args = [])
* @method \Aws\Result deleteBucketAnalyticsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketAnalyticsConfigurationAsync(array $args = [])
* @method \Aws\Result deleteBucketCors(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketCorsAsync(array $args = [])
* @method \Aws\Result deleteBucketEncryption(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketEncryptionAsync(array $args = [])
* @method \Aws\Result deleteBucketInventoryConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketInventoryConfigurationAsync(array $args = [])
* @method \Aws\Result deleteBucketLifecycle(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketLifecycleAsync(array $args = [])
* @method \Aws\Result deleteBucketMetricsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketMetricsConfigurationAsync(array $args = [])
* @method \Aws\Result deleteBucketPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketPolicyAsync(array $args = [])
* @method \Aws\Result deleteBucketReplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketReplicationAsync(array $args = [])
* @method \Aws\Result deleteBucketTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketTaggingAsync(array $args = [])
* @method \Aws\Result deleteBucketWebsite(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBucketWebsiteAsync(array $args = [])
* @method \Aws\Result deleteObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteObjectAsync(array $args = [])
* @method \Aws\Result deleteObjectTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteObjectTaggingAsync(array $args = [])
* @method \Aws\Result deleteObjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteObjectsAsync(array $args = [])
* @method \Aws\Result getBucketAccelerateConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketAccelerateConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketAcl(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketAclAsync(array $args = [])
* @method \Aws\Result getBucketAnalyticsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketAnalyticsConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketCors(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketCorsAsync(array $args = [])
* @method \Aws\Result getBucketEncryption(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketEncryptionAsync(array $args = [])
* @method \Aws\Result getBucketInventoryConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketInventoryConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketLifecycle(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketLifecycleAsync(array $args = [])
* @method \Aws\Result getBucketLifecycleConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketLifecycleConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketLocation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketLocationAsync(array $args = [])
* @method \Aws\Result getBucketLogging(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketLoggingAsync(array $args = [])
* @method \Aws\Result getBucketMetricsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketMetricsConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketNotification(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketNotificationAsync(array $args = [])
* @method \Aws\Result getBucketNotificationConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketNotificationConfigurationAsync(array $args = [])
* @method \Aws\Result getBucketPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketPolicyAsync(array $args = [])
* @method \Aws\Result getBucketReplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketReplicationAsync(array $args = [])
* @method \Aws\Result getBucketRequestPayment(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketRequestPaymentAsync(array $args = [])
* @method \Aws\Result getBucketTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketTaggingAsync(array $args = [])
* @method \Aws\Result getBucketVersioning(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketVersioningAsync(array $args = [])
* @method \Aws\Result getBucketWebsite(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBucketWebsiteAsync(array $args = [])
* @method \Aws\Result getObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectAsync(array $args = [])
* @method \Aws\Result getObjectAcl(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectAclAsync(array $args = [])
* @method \Aws\Result getObjectTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectTaggingAsync(array $args = [])
* @method \Aws\Result getObjectTorrent(array $args = [])
* @method \GuzzleHttp\Promise\Promise getObjectTorrentAsync(array $args = [])
* @method \Aws\Result headBucket(array $args = [])
* @method \GuzzleHttp\Promise\Promise headBucketAsync(array $args = [])
* @method \Aws\Result headObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise headObjectAsync(array $args = [])
* @method \Aws\Result listBucketAnalyticsConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBucketAnalyticsConfigurationsAsync(array $args = [])
* @method \Aws\Result listBucketInventoryConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBucketInventoryConfigurationsAsync(array $args = [])
* @method \Aws\Result listBucketMetricsConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBucketMetricsConfigurationsAsync(array $args = [])
* @method \Aws\Result listBuckets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBucketsAsync(array $args = [])
* @method \Aws\Result listMultipartUploads(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMultipartUploadsAsync(array $args = [])
* @method \Aws\Result listObjectVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectVersionsAsync(array $args = [])
* @method \Aws\Result listObjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectsAsync(array $args = [])
* @method \Aws\Result listObjectsV2(array $args = [])
* @method \GuzzleHttp\Promise\Promise listObjectsV2Async(array $args = [])
* @method \Aws\Result listParts(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPartsAsync(array $args = [])
* @method \Aws\Result putBucketAccelerateConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketAccelerateConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketAcl(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketAclAsync(array $args = [])
* @method \Aws\Result putBucketAnalyticsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketAnalyticsConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketCors(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketCorsAsync(array $args = [])
* @method \Aws\Result putBucketEncryption(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketEncryptionAsync(array $args = [])
* @method \Aws\Result putBucketInventoryConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketInventoryConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketLifecycle(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketLifecycleAsync(array $args = [])
* @method \Aws\Result putBucketLifecycleConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketLifecycleConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketLogging(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketLoggingAsync(array $args = [])
* @method \Aws\Result putBucketMetricsConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketMetricsConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketNotification(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketNotificationAsync(array $args = [])
* @method \Aws\Result putBucketNotificationConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketNotificationConfigurationAsync(array $args = [])
* @method \Aws\Result putBucketPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketPolicyAsync(array $args = [])
* @method \Aws\Result putBucketReplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketReplicationAsync(array $args = [])
* @method \Aws\Result putBucketRequestPayment(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketRequestPaymentAsync(array $args = [])
* @method \Aws\Result putBucketTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketTaggingAsync(array $args = [])
* @method \Aws\Result putBucketVersioning(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketVersioningAsync(array $args = [])
* @method \Aws\Result putBucketWebsite(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBucketWebsiteAsync(array $args = [])
* @method \Aws\Result putObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise putObjectAsync(array $args = [])
* @method \Aws\Result putObjectAcl(array $args = [])
* @method \GuzzleHttp\Promise\Promise putObjectAclAsync(array $args = [])
* @method \Aws\Result putObjectTagging(array $args = [])
* @method \GuzzleHttp\Promise\Promise putObjectTaggingAsync(array $args = [])
* @method \Aws\Result restoreObject(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreObjectAsync(array $args = [])
* @method \Aws\Result selectObjectContent(array $args = [])
* @method \GuzzleHttp\Promise\Promise selectObjectContentAsync(array $args = [])
* @method \Aws\Result uploadPart(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadPartAsync(array $args = [])
* @method \Aws\Result uploadPartCopy(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadPartCopyAsync(array $args = [])
*/
class S3Client extends \Aws\AwsClient implements \Aws\S3\S3ClientInterface
{
use \Aws\S3\S3ClientTrait;
public static function getArguments()
{
}
/**
* {@inheritdoc}
*
* In addition to the options available to
* {@see Aws\AwsClient::__construct}, S3Client accepts the following
* options:
*
* - bucket_endpoint: (bool) Set to true to send requests to a
* hardcoded bucket endpoint rather than create an endpoint as a result
* of injecting the bucket into the URL. This option is useful for
* interacting with CNAME endpoints.
* - calculate_md5: (bool) Set to false to disable calculating an MD5
* for all Amazon S3 signed uploads.
* - use_accelerate_endpoint: (bool) Set to true to send requests to an S3
* Accelerate endpoint by default. Can be enabled or disabled on
* individual operations by setting '@use_accelerate_endpoint' to true or
* false. Note: you must enable S3 Accelerate on a bucket before it can be
* accessed via an Accelerate endpoint.
* - use_dual_stack_endpoint: (bool) Set to true to send requests to an S3
* Dual Stack endpoint by default, which enables IPv6 Protocol.
* Can be enabled or disabled on individual operations by setting
* '@use_dual_stack_endpoint\' to true or false. Note:
* you cannot use it together with an accelerate endpoint.
* - use_path_style_endpoint: (bool) Set to true to send requests to an S3
* path style endpoint by default.
* Can be enabled or disabled on individual operations by setting
* '@use_path_style_endpoint\' to true or false. Note:
* you cannot use it together with an accelerate endpoint.
*
* @param array $args
*/
public function __construct(array $args)
{
}
/**
* Determine if a string is a valid name for a DNS compatible Amazon S3
* bucket.
*
* DNS compatible bucket names can be used as a subdomain in a URL (e.g.,
* "<bucket>.s3.amazonaws.com").
*
* @param string $bucket Bucket name to check.
*
* @return bool
*/
public static function isBucketDnsCompatible($bucket)
{
}
public function createPresignedRequest(\Aws\CommandInterface $command, $expires)
{
}
public function getObjectUrl($bucket, $key)
{
}
/**
* Raw URL encode a key and allow for '/' characters
*
* @param string $key Key to encode
*
* @return string Returns the encoded key
*/
public static function encodeKey($key)
{
}
/** @internal */
public static function _applyRetryConfig($value, $_, \Aws\HandlerList $list)
{
}
/** @internal */
public static function _applyApiProvider($value, array &$args, \Aws\HandlerList $list)
{
}
/**
* @internal
* @codeCoverageIgnore
*/
public static function applyDocFilters(array $api, array $docs)
{
}
}
}
namespace Aws\Crypto {
interface MetadataStrategyInterface
{
/**
* Places the information in the MetadataEnvelope to the strategy specific
* location. Populates the PutObject arguments with any information
* necessary for loading.
*
* @param MetadataEnvelope $envelope Encryption data to save according to
* the strategy.
* @param array $args Starting arguments for PutObject.
*
* @return array Updated arguments for PutObject.
*/
public function save(\Aws\Crypto\MetadataEnvelope $envelope, array $args);
/**
* Generates a MetadataEnvelope according to the specific strategy using the
* passed arguments.
*
* @param array $args Arguments from Command and Result that contains
* S3 Object information, relevant headers, and command
* configuration.
*
* @return MetadataEnvelope
*/
public function load(array $args);
}
}
namespace Aws\S3\Crypto {
/**
* Stores and reads encryption MetadataEnvelope information in a file on Amazon
* S3.
*
* A file with the contents of a MetadataEnvelope will be created or read from
* alongside the base file on Amazon S3. The provided client will be used for
* reading or writing this object. A specified suffix (default of '.instruction'
* will be applied to each of the operations involved with the instruction file.
*
* If there is a failure after an instruction file has been uploaded, it will
* not be automatically deleted.
*/
class InstructionFileMetadataStrategy implements \Aws\Crypto\MetadataStrategyInterface
{
const DEFAULT_FILE_SUFFIX = '.instruction';
/**
* @param S3Client $client Client for use in uploading the instruction file.
* @param string|null $suffix Optional override suffix for instruction file
* object keys.
*/
public function __construct(\Aws\S3\S3Client $client, $suffix = null)
{
}
/**
* Places the information in the MetadataEnvelope to a location on S3.
*
* @param MetadataEnvelope $envelope Encryption data to save according to
* the strategy.
* @param array $args Starting arguments for PutObject, used for saving
* extra the instruction file.
*
* @return array Updated arguments for PutObject.
*/
public function save(\Aws\Crypto\MetadataEnvelope $envelope, array $args)
{
}
/**
* Uses the strategy's client to retrieve the instruction file from S3 and generates
* a MetadataEnvelope from its contents.
*
* @param array $args Arguments from Command and Result that contains
* S3 Object information, relevant headers, and command
* configuration.
*
* @return MetadataEnvelope
*/
public function load(array $args)
{
}
}
}
namespace Aws\Crypto {
trait EncryptionTrait
{
private static $allowedOptions = ['Cipher' => true, 'KeySize' => true, 'Aad' => true];
/**
* Dependency to generate a CipherMethod from a set of inputs for loading
* in to an AesEncryptingStream.
*
* @param string $cipherName Name of the cipher to generate for encrypting.
* @param string $iv Base Initialization Vector for the cipher.
* @param int $keySize Size of the encryption key, in bits, that will be
* used.
*
* @return Cipher\CipherMethod
*
* @internal
*/
protected abstract function buildCipherMethod($cipherName, $iv, $keySize);
/**
* Builds an AesStreamInterface and populates encryption metadata into the
* supplied envelope.
*
* @param Stream $plaintext Plain-text data to be encrypted using the
* materials, algorithm, and data provided.
* @param array $cipherOptions Options for use in determining the cipher to
* be used for encrypting data.
* @param MaterialsProvider $provider A provider to supply and encrypt
* materials used in encryption.
* @param MetadataEnvelope $envelope A storage envelope for encryption
* metadata to be added to.
*
* @return AesStreamInterface
*
* @throws \InvalidArgumentException Thrown when a value in $cipherOptions
* is not valid.
*
* @internal
*/
protected function encrypt(\GuzzleHttp\Psr7\Stream $plaintext, array $cipherOptions, \Aws\Crypto\MaterialsProvider $provider, \Aws\Crypto\MetadataEnvelope $envelope)
{
}
/**
* Generates a stream that wraps the plaintext with the proper cipher and
* uses the content encryption key (CEK) to encrypt the data when read.
*
* @param Stream $plaintext Plain-text data to be encrypted using the
* materials, algorithm, and data provided.
* @param string $cek A content encryption key for use by the stream for
* encrypting the plaintext data.
* @param array $cipherOptions Options for use in determining the cipher to
* be used for encrypting data.
*
* @return [AesStreamInterface, string]
*
* @internal
*/
protected function getEncryptingStream(\GuzzleHttp\Psr7\Stream $plaintext, $cek, &$cipherOptions)
{
}
}
}
namespace Aws\Crypto\Cipher {
trait CipherBuilderTrait
{
/**
* Returns an identifier recognizable by `openssl_*` functions, such as
* `aes-256-cbc` or `aes-128-ctr`.
*
* @param string $cipherName Name of the cipher being used for encrypting
* or decrypting.
* @param int $keySize Size of the encryption key, in bits, that will be
* used.
*
* @return string
*/
protected function getCipherOpenSslName($cipherName, $keySize)
{
}
/**
* Constructs a CipherMethod for the given name, initialized with the other
* data passed for use in encrypting or decrypting.
*
* @param string $cipherName Name of the cipher to generate for encrypting.
* @param string $iv Base Initialization Vector for the cipher.
* @param int $keySize Size of the encryption key, in bits, that will be
* used.
*
* @return CipherMethod
*
* @internal
*/
protected function buildCipherMethod($cipherName, $iv, $keySize)
{
}
/**
* Performs a reverse lookup to get the openssl_* cipher name from the
* AESName passed in from the MetadataEnvelope.
*
* @param $aesName
*
* @return string
*
* @internal
*/
protected function getCipherFromAesName($aesName)
{
}
}
}
namespace Aws\S3\Crypto {
trait CryptoParamsTrait
{
protected function getMaterialsProvider(array $args)
{
}
protected function getInstructionFileSuffix(array $args)
{
}
protected function determineGetObjectStrategy($result, $instructionFileSuffix)
{
}
protected function getMetadataStrategy(array $args, $instructionFileSuffix)
{
}
}
/**
* Encapsulates the execution of a multipart upload of an encrypted object to S3.
*/
class S3EncryptionMultipartUploader extends \Aws\S3\MultipartUploader
{
use \Aws\Crypto\EncryptionTrait, \Aws\Crypto\Cipher\CipherBuilderTrait, \Aws\S3\Crypto\CryptoParamsTrait;
/**
* Returns if the passed cipher name is supported for encryption by the SDK.
*
* @param string $cipherName The name of a cipher to verify is registered.
*
* @return bool If the cipher passed is in our supported list.
*/
public static function isSupportedCipher($cipherName)
{
}
/**
* Creates a multipart upload for an S3 object after encrypting it.
*
* The required configuration options are as follows:
*
* - @MaterialsProvider: (MaterialsProvider) Provides Cek, Iv, and Cek
* encrypting/decrypting for encryption metadata.
* - @CipherOptions: (array) Cipher options for encrypting data. A Cipher
* is required. Accepts the following options:
* - Cipher: (string) cbc|gcm
* See also: AbstractCryptoClient::$supportedCiphers
* - KeySize: (int) 128|192|256
* See also: MaterialsProvider::$supportedKeySizes
* - Aad: (string) Additional authentication data. This option is
* passed directly to OpenSSL when using gcm. It is ignored when
* using cbc.
* - bucket: (string) Name of the bucket to which the object is
* being uploaded.
* - key: (string) Key to use for the object being uploaded.
*
* The optional configuration arguments are as follows:
*
* - @MetadataStrategy: (MetadataStrategy|string|null) Strategy for storing
* MetadataEnvelope information. Defaults to using a
* HeadersMetadataStrategy. Can either be a class implementing
* MetadataStrategy, a class name of a predefined strategy, or empty/null
* to default.
* - @InstructionFileSuffix: (string|null) Suffix used when writing to an
* instruction file if an using an InstructionFileMetadataHandler was
* determined.
* - acl: (string) ACL to set on the object being upload. Objects are
* private by default.
* - before_complete: (callable) Callback to invoke before the
* `CompleteMultipartUpload` operation. The callback should have a
* function signature like `function (Aws\Command $command) {...}`.
* - before_initiate: (callable) Callback to invoke before the
* `CreateMultipartUpload` operation. The callback should have a function
* signature like `function (Aws\Command $command) {...}`.
* - before_upload: (callable) Callback to invoke before any `UploadPart`
* operations. The callback should have a function signature like
* `function (Aws\Command $command) {...}`.
* - concurrency: (int, default=int(5)) Maximum number of concurrent
* `UploadPart` operations allowed during the multipart upload.
* - params: (array) An array of key/value parameters that will be applied
* to each of the sub-commands run by the uploader as a base.
* Auto-calculated options will override these parameters. If you need
* more granularity over parameters to each sub-command, use the before_*
* options detailed above to update the commands directly.
* - part_size: (int, default=int(5242880)) Part size, in bytes, to use when
* doing a multipart upload. This must between 5 MB and 5 GB, inclusive.
* - state: (Aws\Multipart\UploadState) An object that represents the state
* of the multipart upload and that is used to resume a previous upload.
* When this option is provided, the `bucket`, `key`, and `part_size`
* options are ignored.
*
* @param S3ClientInterface $client Client used for the upload.
* @param mixed $source Source of the data to upload.
* @param array $config Configuration used to perform the upload.
*/
public function __construct(\Aws\S3\S3ClientInterface $client, $source, array $config = [])
{
}
}
class HeadersMetadataStrategy implements \Aws\Crypto\MetadataStrategyInterface
{
/**
* Places the information in the MetadataEnvelope in to the Meatadata for
* the PutObject request of the encrypted object.
*
* @param MetadataEnvelope $envelope Encryption data to save according to
* the strategy.
* @param array $args Arguments for PutObject that can be manipulated to
* store strategy related information.
*
* @return array Updated arguments for PutObject.
*/
public function save(\Aws\Crypto\MetadataEnvelope $envelope, array $args)
{
}
/**
* Generates a MetadataEnvelope according to the Metadata headers from the
* GetObject result.
*
* @param array $args Arguments from Command and Result that contains
* S3 Object information, relevant headers, and command
* configuration.
*
* @return MetadataEnvelope
*/
public function load(array $args)
{
}
}
}
namespace Aws\Crypto {
/**
* @internal
*/
abstract class AbstractCryptoClient
{
public static $supportedCiphers = ['cbc', 'gcm'];
/**
* Returns if the passed cipher name is supported for encryption by the SDK.
*
* @param string $cipherName The name of a cipher to verify is registered.
*
* @return bool If the cipher passed is in our supported list.
*/
public static function isSupportedCipher($cipherName)
{
}
/**
* Returns an identifier recognizable by `openssl_*` functions, such as
* `aes-256-cbc` or `aes-128-ctr`.
*
* @param string $cipherName Name of the cipher being used for encrypting
* or decrypting.
* @param int $keySize Size of the encryption key, in bits, that will be
* used.
*
* @return string
*/
protected abstract function getCipherOpenSslName($cipherName, $keySize);
/**
* Constructs a CipherMethod for the given name, initialized with the other
* data passed for use in encrypting or decrypting.
*
* @param string $cipherName Name of the cipher to generate for encrypting.
* @param string $iv Base Initialization Vector for the cipher.
* @param int $keySize Size of the encryption key, in bits, that will be
* used.
*
* @return CipherMethod
*
* @internal
*/
protected abstract function buildCipherMethod($cipherName, $iv, $keySize);
/**
* Performs a reverse lookup to get the openssl_* cipher name from the
* AESName passed in from the MetadataEnvelope.
*
* @param $aesName
*
* @return string
*
* @internal
*/
protected abstract function getCipherFromAesName($aesName);
/**
* Dependency to provide an interface for building an encryption stream for
* data given cipher details, metadata, and materials to do so.
*
* @param Stream $plaintext Plain-text data to be encrypted using the
* materials, algorithm, and data provided.
* @param array $cipherOptions Options for use in determining the cipher to
* be used for encrypting data.
* @param MaterialsProvider $provider A provider to supply and encrypt
* materials used in encryption.
* @param MetadataEnvelope $envelope A storage envelope for encryption
* metadata to be added to.
*
* @return AesStreamInterface
*
* @internal
*/
public abstract function encrypt(\GuzzleHttp\Psr7\Stream $plaintext, array $cipherOptions, \Aws\Crypto\MaterialsProvider $provider, \Aws\Crypto\MetadataEnvelope $envelope);
/**
* Dependency to provide an interface for building a decryption stream for
* cipher text given metadata and materials to do so.
*
* @param string $cipherText Plain-text data to be decrypted using the
* materials, algorithm, and data provided.
* @param MaterialsProvider $provider A provider to supply and encrypt
* materials used in encryption.
* @param MetadataEnvelope $envelope A storage envelope for encryption
* metadata to be read from.
* @param array $cipherOptions Additional verification options.
*
* @return AesStreamInterface
*
* @internal
*/
public abstract function decrypt($cipherText, \Aws\Crypto\MaterialsProvider $provider, \Aws\Crypto\MetadataEnvelope $envelope, array $cipherOptions = []);
}
trait DecryptionTrait
{
/**
* Dependency to reverse lookup the openssl_* cipher name from the AESName
* in the MetadataEnvelope.
*
* @param $aesName
*
* @return string
*
* @internal
*/
protected abstract function getCipherFromAesName($aesName);
/**
* Dependency to generate a CipherMethod from a set of inputs for loading
* in to an AesDecryptingStream.
*
* @param string $cipherName Name of the cipher to generate for decrypting.
* @param string $iv Base Initialization Vector for the cipher.
* @param int $keySize Size of the encryption key, in bits, that will be
* used.
*
* @return Cipher\CipherMethod
*
* @internal
*/
protected abstract function buildCipherMethod($cipherName, $iv, $keySize);
/**
* Builds an AesStreamInterface using cipher options loaded from the
* MetadataEnvelope and MaterialsProvider.
*
* @param string $cipherText Plain-text data to be encrypted using the
* materials, algorithm, and data provided.
* @param MaterialsProvider $provider A provider to supply and encrypt
* materials used in encryption.
* @param MetadataEnvelope $envelope A storage envelope for encryption
* metadata to be read from.
* @param array $cipherOptions Additional verification options.
*
* @return AesStreamInterface
*
* @throws \InvalidArgumentException Thrown when a value in $cipherOptions
* is not valid.
*
* @internal
*/
protected function decrypt($cipherText, \Aws\Crypto\MaterialsProvider $provider, \Aws\Crypto\MetadataEnvelope $envelope, array $cipherOptions = [])
{
}
private function getTagFromCiphertextStream(\GuzzleHttp\Psr7\Stream $cipherText, $tagLength)
{
}
private function getStrippedCiphertextStream(\GuzzleHttp\Psr7\Stream $cipherText, $tagLength)
{
}
/**
* Generates a stream that wraps the cipher text with the proper cipher and
* uses the content encryption key (CEK) to decrypt the data when read.
*
* @param string $cipherText Plain-text data to be encrypted using the
* materials, algorithm, and data provided.
* @param string $cek A content encryption key for use by the stream for
* encrypting the plaintext data.
* @param array $cipherOptions Options for use in determining the cipher to
* be used for encrypting data.
*
* @return AesStreamInterface
*
* @internal
*/
protected function getDecryptingStream($cipherText, $cek, $cipherOptions)
{
}
}
}
namespace Aws\S3\Crypto {
/**
* Provides a wrapper for an S3Client that supplies functionality to encrypt
* data on putObject[Async] calls and decrypt data on getObject[Async] calls.
*/
class S3EncryptionClient extends \Aws\Crypto\AbstractCryptoClient
{
use \Aws\Crypto\EncryptionTrait, \Aws\Crypto\DecryptionTrait, \Aws\Crypto\Cipher\CipherBuilderTrait, \Aws\S3\Crypto\CryptoParamsTrait;
/**
* @param S3Client $client The S3Client to be used for true uploading and
* retrieving objects from S3 when using the
* encryption client.
* @param string|null $instructionFileSuffix Suffix for a client wide
* default when using instruction
* files for metadata storage.
*/
public function __construct(\Aws\S3\S3Client $client, $instructionFileSuffix = null)
{
}
/**
* Encrypts the data in the 'Body' field of $args and promises to upload it
* to the specified location on S3.
*
* @param array $args Arguments for encrypting an object and uploading it
* to S3 via PutObject.
*
* The required configuration arguments are as follows:
*
* - @MaterialsProvider: (MaterialsProvider) Provides Cek, Iv, and Cek
* encrypting/decrypting for encryption metadata.
* - @CipherOptions: (array) Cipher options for encrypting data. Only the
* Cipher option is required. Accepts the following:
* - Cipher: (string) cbc|gcm
* See also: AbstractCryptoClient::$supportedCiphers
* - KeySize: (int) 128|192|256
* See also: MaterialsProvider::$supportedKeySizes
* - Aad: (string) Additional authentication data. This option is
* passed directly to OpenSSL when using gcm. It is ignored when
* using cbc.
*
* The optional configuration arguments are as follows:
*
* - @MetadataStrategy: (MetadataStrategy|string|null) Strategy for storing
* MetadataEnvelope information. Defaults to using a
* HeadersMetadataStrategy. Can either be a class implementing
* MetadataStrategy, a class name of a predefined strategy, or empty/null
* to default.
* - @InstructionFileSuffix: (string|null) Suffix used when writing to an
* instruction file if using an InstructionFileMetadataHandler.
*
* @return PromiseInterface
*
* @throws \InvalidArgumentException Thrown when arguments above are not
* passed or are passed incorrectly.
*/
public function putObjectAsync(array $args)
{
}
/**
* Encrypts the data in the 'Body' field of $args and uploads it to the
* specified location on S3.
*
* @param array $args Arguments for encrypting an object and uploading it
* to S3 via PutObject.
*
* The required configuration arguments are as follows:
*
* - @MaterialsProvider: (MaterialsProvider) Provides Cek, Iv, and Cek
* encrypting/decrypting for encryption metadata.
* - @CipherOptions: (array) Cipher options for encrypting data. A Cipher
* is required. Accepts the following options:
* - Cipher: (string) cbc|gcm
* See also: AbstractCryptoClient::$supportedCiphers
* - KeySize: (int) 128|192|256
* See also: MaterialsProvider::$supportedKeySizes
* - Aad: (string) Additional authentication data. This option is
* passed directly to OpenSSL when using gcm. It is ignored when
* using cbc.
*
* The optional configuration arguments are as follows:
*
* - @MetadataStrategy: (MetadataStrategy|string|null) Strategy for storing
* MetadataEnvelope information. Defaults to using a
* HeadersMetadataStrategy. Can either be a class implementing
* MetadataStrategy, a class name of a predefined strategy, or empty/null
* to default.
* - @InstructionFileSuffix: (string|null) Suffix used when writing to an
* instruction file if an using an InstructionFileMetadataHandler was
* determined.
*
* @return \Aws\Result PutObject call result with the details of uploading
* the encrypted file.
*
* @throws \InvalidArgumentException Thrown when arguments above are not
* passed or are passed incorrectly.
*/
public function putObject(array $args)
{
}
/**
* Promises to retrieve an object from S3 and decrypt the data in the
* 'Body' field.
*
* @param array $args Arguments for retrieving an object from S3 via
* GetObject and decrypting it.
*
* The required configuration argument is as follows:
*
* - @MaterialsProvider: (MaterialsProvider) Provides Cek, Iv, and Cek
* encrypting/decrypting for decryption metadata. May have data loaded
* from the MetadataEnvelope upon decryption.
*
* The optional configuration arguments are as follows:
*
* - SaveAs: (string) The path to a file on disk to save the decrypted
* object data. This will be handled by file_put_contents instead of the
* Guzzle sink.
*
* - @MetadataStrategy: (MetadataStrategy|string|null) Strategy for reading
* MetadataEnvelope information. Defaults to determining based on object
* response headers. Can either be a class implementing MetadataStrategy,
* a class name of a predefined strategy, or empty/null to default.
* - @InstructionFileSuffix: (string) Suffix used when looking for an
* instruction file if an InstructionFileMetadataHandler is being used.
* - @CipherOptions: (array) Cipher options for decrypting data. A Cipher
* is required. Accepts the following options:
* - Aad: (string) Additional authentication data. This option is
* passed directly to OpenSSL when using gcm. It is ignored when
* using cbc.
*
* @return PromiseInterface
*
* @throws \InvalidArgumentException Thrown when required arguments are not
* passed or are passed incorrectly.
*/
public function getObjectAsync(array $args)
{
}
/**
* Retrieves an object from S3 and decrypts the data in the 'Body' field.
*
* @param array $args Arguments for retrieving an object from S3 via
* GetObject and decrypting it.
*
* The required configuration argument is as follows:
*
* - @MaterialsProvider: (MaterialsProvider) Provides Cek, Iv, and Cek
* encrypting/decrypting for decryption metadata. May have data loaded
* from the MetadataEnvelope upon decryption.
*
* The optional configuration arguments are as follows:
*
* - SaveAs: (string) The path to a file on disk to save the decrypted
* object data. This will be handled by file_put_contents instead of the
* Guzzle sink.
* - @InstructionFileSuffix: (string|null) Suffix used when looking for an
* instruction file if an InstructionFileMetadataHandler was detected.
* - @CipherOptions: (array) Cipher options for encrypting data. A Cipher
* is required. Accepts the following options:
* - Aad: (string) Additional authentication data. This option is
* passed directly to OpenSSL when using gcm. It is ignored when
* using cbc.
*
* @return \Aws\Result GetObject call result with the 'Body' field
* wrapped in a decryption stream with its metadata
* information.
*
* @throws \InvalidArgumentException Thrown when arguments above are not
* passed or are passed incorrectly.
*/
public function getObject(array $args)
{
}
}
}
namespace Aws {
/**
* Trait implementing ToArrayInterface, \ArrayAccess, \Countable, and
* \IteratorAggregate
*/
trait HasDataTrait
{
/** @var array */
private $data = [];
public function getIterator()
{
}
/**
* This method returns a reference to the variable to allow for indirect
* array modification (e.g., $foo['bar']['baz'] = 'qux').
*
* @param $offset
*
* @return mixed|null
*/
public function &offsetGet($offset)
{
}
public function offsetSet($offset, $value)
{
}
public function offsetExists($offset)
{
}
public function offsetUnset($offset)
{
}
public function toArray()
{
}
public function count()
{
}
}
/**
* AWS command object.
*/
class Command implements \Aws\CommandInterface
{
use \Aws\HasDataTrait;
/**
* Accepts an associative array of command options, including:
*
* - @http: (array) Associative array of transfer options.
*
* @param string $name Name of the command
* @param array $args Arguments to pass to the command
* @param HandlerList $list Handler list
*/
public function __construct($name, array $args = [], \Aws\HandlerList $list = null)
{
}
public function __clone()
{
}
public function getName()
{
}
public function hasParam($name)
{
}
public function getHandlerList()
{
}
/** @deprecated */
public function get($name)
{
}
}
}
namespace Aws\Endpoint {
/**
* Represents a section of the AWS cloud.
*/
interface PartitionInterface
{
/**
* Returns the partition's short name, e.g., 'aws,' 'aws-cn,' or
* 'aws-us-gov.'
*
* @return string
*/
public function getName();
/**
* Determine if this partition contains the provided region. Include the
* name of the service to inspect non-regional endpoints
*
* @param string $region
* @param string $service
*
* @return bool
*/
public function isRegionMatch($region, $service);
/**
* Return the endpoints supported by a given service.
*
* @param string $service Identifier of the service
* whose endpoints should be
* listed (e.g., 's3' or 'ses')
* @param bool $allowNonRegionalEndpoints Set to `true` to include
* endpoints that are not AWS
* regions (e.g., 'local' for
* DynamoDB or
* 'fips-us-gov-west-1' for S3)
*
* @return string[]
*/
public function getAvailableEndpoints($service, $allowNonRegionalEndpoints = false);
/**
* A partition must be invokable as an endpoint provider.
*
* @see EndpointProvider
*
* @param array $args
* @return array
*/
public function __invoke(array $args = []);
}
/**
* Default implementation of an AWS partition.
*/
final class Partition implements \ArrayAccess, \Aws\Endpoint\PartitionInterface
{
use \Aws\HasDataTrait;
/**
* The partition constructor accepts the following options:
*
* - `partition`: (string, required) The partition name as specified in an
* ARN (e.g., `aws`)
* - `partitionName`: (string) The human readable name of the partition
* (e.g., "AWS Standard")
* - `dnsSuffix`: (string, required) The DNS suffix of the partition. This
* value is used to determine how endpoints in the partition are resolved.
* - `regionRegex`: (string) A PCRE regular expression that specifies the
* pattern that region names in the endpoint adhere to.
* - `regions`: (array, required) A map of the regions in the partition.
* Each key is the region as present in a hostname (e.g., `us-east-1`),
* and each value is a structure containing region information.
* - `defaults`: (array) A map of default key value pairs to apply to each
* endpoint of the partition. Any value in an `endpoint` definition will
* supersede any values specified in `defaults`.
* - `services`: (array, required) A map of service endpoint prefix name
* (the value found in a hostname) to information about the service.
*
* @param array $definition
*
* @throws Iae if any required options are missing
*/
public function __construct(array $definition)
{
}
public function getName()
{
}
public function isRegionMatch($region, $service)
{
}
public function getAvailableEndpoints($service, $allowNonRegionalEndpoints = false)
{
}
public function __invoke(array $args = [])
{
}
}
/**
* Provides endpoints based on an endpoint pattern configuration array.
*/
class PatternEndpointProvider
{
/**
* @param array $patterns Hash of endpoint patterns mapping to endpoint
* configurations.
*/
public function __construct(array $patterns)
{
}
public function __invoke(array $args = [])
{
}
}
/**
* Endpoint providers.
*
* An endpoint provider is a function that accepts a hash of endpoint options,
* including but not limited to "service" and "region" key value pairs. The
* endpoint provider function returns a hash of endpoint data, which MUST
* include an "endpoint" key value pair that represents the resolved endpoint
* or NULL if an endpoint cannot be determined.
*
* You can wrap your calls to an endpoint provider with the
* {@see EndpointProvider::resolve} function to ensure that an endpoint hash is
* created. If an endpoint hash is not created, then the resolve() function
* will throw an {@see Aws\Exception\UnresolvedEndpointException}.
*
* use Aws\Endpoint\EndpointProvider;
* $provider = EndpointProvider::defaultProvider();
* // Returns an array or NULL.
* $endpoint = $provider(['service' => 'ec2', 'region' => 'us-west-2']);
* // Returns an endpoint array or throws.
* $endpoint = EndpointProvider::resolve($provider, [
* 'service' => 'ec2',
* 'region' => 'us-west-2'
* ]);
*
* You can compose multiple providers into a single provider using
* {@see Aws\or_chain}. This function accepts providers as arguments and
* returns a new function that will invoke each provider until a non-null value
* is returned.
*
* $a = function (array $args) {
* if ($args['region'] === 'my-test-region') {
* return ['endpoint' => 'http://localhost:123/api'];
* }
* };
* $b = EndpointProvider::defaultProvider();
* $c = \Aws\or_chain($a, $b);
* $config = ['service' => 'ec2', 'region' => 'my-test-region'];
* $res = $c($config); // $a handles this.
* $config['region'] = 'us-west-2';
* $res = $c($config); // $b handles this.
*/
class EndpointProvider
{
/**
* Resolves and endpoint provider and ensures a non-null return value.
*
* @param callable $provider Provider function to invoke.
* @param array $args Endpoint arguments to pass to the provider.
*
* @return array
* @throws UnresolvedEndpointException
*/
public static function resolve(callable $provider, array $args = [])
{
}
/**
* Creates and returns the default SDK endpoint provider.
*
* @deprecated Use an instance of \Aws\Endpoint\Partition instead.
*
* @return callable
*/
public static function defaultProvider()
{
}
/**
* Creates and returns an endpoint provider that uses patterns from an
* array.
*
* @param array $patterns Endpoint patterns
*
* @return callable
*/
public static function patterns(array $patterns)
{
}
}
class PartitionEndpointProvider
{
public function __construct(array $partitions, $defaultPartition = 'aws')
{
}
public function __invoke(array $args = [])
{
}
/**
* Returns the partition containing the provided region or the default
* partition if no match is found.
*
* @param string $region
* @param string $service
*
* @return Partition
*/
public function getPartition($region, $service)
{
}
/**
* Returns the partition with the provided name or null if no partition with
* the provided name can be found.
*
* @param string $name
*
* @return Partition|null
*/
public function getPartitionByName($name)
{
}
/**
* Creates and returns the default SDK partition provider.
*
* @return PartitionEndpointProvider
*/
public static function defaultProvider()
{
}
/**
* Copy endpoint data for other prefixes used by a given service
*
* @param $data
* @param $prefixData
* @return array
*/
public static function mergePrefixData($data, $prefixData)
{
}
}
}
namespace Aws\Health {
/**
* This client is used to interact with the **AWS Health APIs and Notifications** service.
* @method \Aws\Result describeAffectedEntities(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAffectedEntitiesAsync(array $args = [])
* @method \Aws\Result describeEntityAggregates(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEntityAggregatesAsync(array $args = [])
* @method \Aws\Result describeEventAggregates(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventAggregatesAsync(array $args = [])
* @method \Aws\Result describeEventDetails(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventDetailsAsync(array $args = [])
* @method \Aws\Result describeEventTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventTypesAsync(array $args = [])
* @method \Aws\Result describeEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventsAsync(array $args = [])
*/
class HealthClient extends \Aws\AwsClient
{
}
}
namespace Aws\Health\Exception {
/**
* Represents an error interacting with the **AWS Health APIs and Notifications** service.
*/
class HealthException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ElasticBeanstalk {
/**
* This client is used to interact with the **AWS Elastic Beanstalk** service.
*
* @method \Aws\Result abortEnvironmentUpdate(array $args = [])
* @method \GuzzleHttp\Promise\Promise abortEnvironmentUpdateAsync(array $args = [])
* @method \Aws\Result applyEnvironmentManagedAction(array $args = [])
* @method \GuzzleHttp\Promise\Promise applyEnvironmentManagedActionAsync(array $args = [])
* @method \Aws\Result checkDNSAvailability(array $args = [])
* @method \GuzzleHttp\Promise\Promise checkDNSAvailabilityAsync(array $args = [])
* @method \Aws\Result composeEnvironments(array $args = [])
* @method \GuzzleHttp\Promise\Promise composeEnvironmentsAsync(array $args = [])
* @method \Aws\Result createApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise createApplicationAsync(array $args = [])
* @method \Aws\Result createApplicationVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createApplicationVersionAsync(array $args = [])
* @method \Aws\Result createConfigurationTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise createConfigurationTemplateAsync(array $args = [])
* @method \Aws\Result createEnvironment(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEnvironmentAsync(array $args = [])
* @method \Aws\Result createPlatformVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPlatformVersionAsync(array $args = [])
* @method \Aws\Result createStorageLocation(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStorageLocationAsync(array $args = [])
* @method \Aws\Result deleteApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApplicationAsync(array $args = [])
* @method \Aws\Result deleteApplicationVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApplicationVersionAsync(array $args = [])
* @method \Aws\Result deleteConfigurationTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConfigurationTemplateAsync(array $args = [])
* @method \Aws\Result deleteEnvironmentConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEnvironmentConfigurationAsync(array $args = [])
* @method \Aws\Result deletePlatformVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePlatformVersionAsync(array $args = [])
* @method \Aws\Result describeAccountAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAccountAttributesAsync(array $args = [])
* @method \Aws\Result describeApplicationVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeApplicationVersionsAsync(array $args = [])
* @method \Aws\Result describeApplications(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeApplicationsAsync(array $args = [])
* @method \Aws\Result describeConfigurationOptions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigurationOptionsAsync(array $args = [])
* @method \Aws\Result describeConfigurationSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeConfigurationSettingsAsync(array $args = [])
* @method \Aws\Result describeEnvironmentHealth(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEnvironmentHealthAsync(array $args = [])
* @method \Aws\Result describeEnvironmentManagedActionHistory(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEnvironmentManagedActionHistoryAsync(array $args = [])
* @method \Aws\Result describeEnvironmentManagedActions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEnvironmentManagedActionsAsync(array $args = [])
* @method \Aws\Result describeEnvironmentResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEnvironmentResourcesAsync(array $args = [])
* @method \Aws\Result describeEnvironments(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEnvironmentsAsync(array $args = [])
* @method \Aws\Result describeEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventsAsync(array $args = [])
* @method \Aws\Result describeInstancesHealth(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstancesHealthAsync(array $args = [])
* @method \Aws\Result describePlatformVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePlatformVersionAsync(array $args = [])
* @method \Aws\Result listAvailableSolutionStacks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAvailableSolutionStacksAsync(array $args = [])
* @method \Aws\Result listPlatformVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPlatformVersionsAsync(array $args = [])
* @method \Aws\Result listTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsForResourceAsync(array $args = [])
* @method \Aws\Result rebuildEnvironment(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebuildEnvironmentAsync(array $args = [])
* @method \Aws\Result requestEnvironmentInfo(array $args = [])
* @method \GuzzleHttp\Promise\Promise requestEnvironmentInfoAsync(array $args = [])
* @method \Aws\Result restartAppServer(array $args = [])
* @method \GuzzleHttp\Promise\Promise restartAppServerAsync(array $args = [])
* @method \Aws\Result retrieveEnvironmentInfo(array $args = [])
* @method \GuzzleHttp\Promise\Promise retrieveEnvironmentInfoAsync(array $args = [])
* @method \Aws\Result swapEnvironmentCNAMEs(array $args = [])
* @method \GuzzleHttp\Promise\Promise swapEnvironmentCNAMEsAsync(array $args = [])
* @method \Aws\Result terminateEnvironment(array $args = [])
* @method \GuzzleHttp\Promise\Promise terminateEnvironmentAsync(array $args = [])
* @method \Aws\Result updateApplication(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApplicationAsync(array $args = [])
* @method \Aws\Result updateApplicationResourceLifecycle(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApplicationResourceLifecycleAsync(array $args = [])
* @method \Aws\Result updateApplicationVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApplicationVersionAsync(array $args = [])
* @method \Aws\Result updateConfigurationTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateConfigurationTemplateAsync(array $args = [])
* @method \Aws\Result updateEnvironment(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEnvironmentAsync(array $args = [])
* @method \Aws\Result updateTagsForResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTagsForResourceAsync(array $args = [])
* @method \Aws\Result validateConfigurationSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise validateConfigurationSettingsAsync(array $args = [])
*/
class ElasticBeanstalkClient extends \Aws\AwsClient
{
}
}
namespace Aws\ElasticBeanstalk\Exception {
/**
* Represents an error interacting with the AWS Elastic Beanstalk service.
*/
class ElasticBeanstalkException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\MarketplaceEntitlementService {
/**
* This client is used to interact with the **AWS Marketplace Entitlement Service** service.
* @method \Aws\Result getEntitlements(array $args = [])
* @method \GuzzleHttp\Promise\Promise getEntitlementsAsync(array $args = [])
*/
class MarketplaceEntitlementServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws\MarketplaceEntitlementService\Exception {
/**
* Represents an error interacting with the **AWS Marketplace Entitlement Service** service.
*/
class MarketplaceEntitlementServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Connect {
/**
* This client is used to interact with the **Amazon Connect Service** service.
* @method \Aws\Result createUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserAsync(array $args = [])
* @method \Aws\Result deleteUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserAsync(array $args = [])
* @method \Aws\Result describeUser(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserAsync(array $args = [])
* @method \Aws\Result describeUserHierarchyGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserHierarchyGroupAsync(array $args = [])
* @method \Aws\Result describeUserHierarchyStructure(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserHierarchyStructureAsync(array $args = [])
* @method \Aws\Result getCurrentMetricData(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCurrentMetricDataAsync(array $args = [])
* @method \Aws\Result getFederationToken(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFederationTokenAsync(array $args = [])
* @method \Aws\Result getMetricData(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMetricDataAsync(array $args = [])
* @method \Aws\Result listRoutingProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise listRoutingProfilesAsync(array $args = [])
* @method \Aws\Result listSecurityProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSecurityProfilesAsync(array $args = [])
* @method \Aws\Result listUserHierarchyGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUserHierarchyGroupsAsync(array $args = [])
* @method \Aws\Result listUsers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listUsersAsync(array $args = [])
* @method \Aws\Result startOutboundVoiceContact(array $args = [])
* @method \GuzzleHttp\Promise\Promise startOutboundVoiceContactAsync(array $args = [])
* @method \Aws\Result stopContact(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopContactAsync(array $args = [])
* @method \Aws\Result updateContactAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateContactAttributesAsync(array $args = [])
* @method \Aws\Result updateUserHierarchy(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserHierarchyAsync(array $args = [])
* @method \Aws\Result updateUserIdentityInfo(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserIdentityInfoAsync(array $args = [])
* @method \Aws\Result updateUserPhoneConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserPhoneConfigAsync(array $args = [])
* @method \Aws\Result updateUserRoutingProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserRoutingProfileAsync(array $args = [])
* @method \Aws\Result updateUserSecurityProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserSecurityProfilesAsync(array $args = [])
*/
class ConnectClient extends \Aws\AwsClient
{
}
}
namespace Aws\Connect\Exception {
/**
* Represents an error interacting with the **Amazon Connect Service** service.
*/
class ConnectException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CloudSearchDomain {
/**
* This client is used to search and upload documents to an **Amazon CloudSearch** Domain.
*
* @method \Aws\Result search(array $args = [])
* @method \GuzzleHttp\Promise\Promise searchAsync(array $args = [])
* @method \Aws\Result suggest(array $args = [])
* @method \GuzzleHttp\Promise\Promise suggestAsync(array $args = [])
* @method \Aws\Result uploadDocuments(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadDocumentsAsync(array $args = [])
*/
class CloudSearchDomainClient extends \Aws\AwsClient
{
public function __construct(array $args)
{
}
public static function getArguments()
{
}
/**
* Converts default GET request to a POST request
*
* Avoiding length restriction in query
*
* @param RequestInterface $r GET request to be converted
* @return RequestInterface $req converted POST request
*/
public static function convertGetToPost(\Psr\Http\Message\RequestInterface $r)
{
}
}
}
namespace Aws\CloudSearchDomain\Exception {
/**
* Represents an error interacting with an Amazon CloudSearch Domain.
*/
class CloudSearchDomainException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ClientSideMonitoring {
/**
* Provides access to client-side monitoring configuration options:
* 'client_id', 'enabled', 'port'
*/
interface ConfigurationInterface
{
/**
* Checks whether or not client-side monitoring is enabled.
*
* @return bool
*/
public function isEnabled();
/**
* Returns the Client ID, if available.
*
* @return string|null
*/
public function getClientId();
/**
* Returns the configured port.
*
* @return int|null
*/
public function getPort();
/**
* Returns the configuration as an associative array.
*
* @return array
*/
public function toArray();
}
class Configuration implements \Aws\ClientSideMonitoring\ConfigurationInterface
{
/**
* Constructs a new Configuration object with the specified CSM options set.
*
* @param mixed $enabled
* @param string|int $port
* @param string $clientId
*/
public function __construct($enabled, $port, $clientId = '')
{
}
/**
* {@inheritdoc}
*/
public function isEnabled()
{
}
/**
* {@inheritdoc}
*/
public function getClientId()
{
}
/**
* {@inheritdoc}
*/
public function getPort()
{
}
/**
* {@inheritdoc}
*/
public function toArray()
{
}
}
/**
* @internal
*/
interface MonitoringMiddlewareInterface
{
/**
* Data for event properties to be sent to the monitoring agent.
*
* @param RequestInterface $request
* @return array
*/
public static function getRequestData(\Psr\Http\Message\RequestInterface $request);
/**
* Data for event properties to be sent to the monitoring agent.
*
* @param ResultInterface|AwsException|\Exception $klass
* @return array
*/
public static function getResponseData($klass);
public function __invoke(\Aws\CommandInterface $cmd, \Psr\Http\Message\RequestInterface $request);
}
/**
* @internal
*/
abstract class AbstractMonitoringMiddleware implements \Aws\ClientSideMonitoring\MonitoringMiddlewareInterface
{
protected $credentialProvider;
protected $region;
protected $service;
protected static function getAwsExceptionHeader(\Aws\Exception\AwsException $e, $headerName)
{
}
protected static function getResultHeader(\Aws\ResultInterface $result, $headerName)
{
}
protected static function getExceptionHeader(\Exception $e, $headerName)
{
}
/**
* Standard middleware wrapper function with CSM options passed in.
*
* @param callable $credentialProvider
* @param mixed $options
* @param string $region
* @param string $service
* @return callable
*/
public static function wrap(callable $credentialProvider, $options, $region, $service)
{
}
/**
* Constructor stores the passed in handler and options.
*
* @param callable $handler
* @param callable $credentialProvider
* @param array $options
* @param $region
* @param $service
*/
public function __construct(callable $handler, callable $credentialProvider, $options, $region, $service)
{
}
/**
* Standard invoke pattern for middleware execution to be implemented by
* child classes.
*
* @param CommandInterface $cmd
* @param RequestInterface $request
* @return Promise\PromiseInterface
*/
public function __invoke(\Aws\CommandInterface $cmd, \Psr\Http\Message\RequestInterface $request)
{
}
/**
* Returns $eventData array with information from the request and command.
*
* @param CommandInterface $cmd
* @param RequestInterface $request
* @param array $event
* @return array
*/
protected function populateRequestEventData(\Aws\CommandInterface $cmd, \Psr\Http\Message\RequestInterface $request, array $event)
{
}
/**
* Returns $eventData array with information from the response, including
* the calculation for attempt latency.
*
* @param ResultInterface|\Exception $result
* @param array $event
* @return array
*/
protected function populateResultEventData($result, array $event)
{
}
}
/**
* @internal
*/
class ApiCallMonitoringMiddleware extends \Aws\ClientSideMonitoring\AbstractMonitoringMiddleware
{
/**
* {@inheritdoc}
*/
public static function getRequestData(\Psr\Http\Message\RequestInterface $request)
{
}
/**
* {@inheritdoc}
*/
public static function getResponseData($klass)
{
}
/**
* {@inheritdoc}
*/
protected function populateRequestEventData(\Aws\CommandInterface $cmd, \Psr\Http\Message\RequestInterface $request, array $event)
{
}
/**
* {@inheritdoc}
*/
protected function populateResultEventData($result, array $event)
{
}
}
/**
* A configuration provider is a function that accepts no arguments and returns
* a promise that is fulfilled with a {@see \Aws\ClientSideMonitoring\ConfigurationInterface}
* or rejected with an {@see \Aws\ClientSideMonitoring\Exception\ConfigurationException}.
*
* <code>
* use Aws\ClientSideMonitoring\ConfigurationProvider;
* $provider = ConfigurationProvider::defaultProvider();
* // Returns a ConfigurationInterface or throws.
* $config = $provider()->wait();
* </code>
*
* Configuration providers can be composed to create configuration using
* conditional logic that can create different configurations in different
* environments. You can compose multiple providers into a single provider using
* {@see Aws\ClientSideMonitoring\ConfigurationProvider::chain}. This function
* accepts providers as variadic arguments and returns a new function that will
* invoke each provider until a successful configuration is returned.
*
* <code>
* // First try an INI file at this location.
* $a = ConfigurationProvider::ini(null, '/path/to/file.ini');
* // Then try an INI file at this location.
* $b = ConfigurationProvider::ini(null, '/path/to/other-file.ini');
* // Then try loading from environment variables.
* $c = ConfigurationProvider::env();
* // Combine the three providers together.
* $composed = ConfigurationProvider::chain($a, $b, $c);
* // Returns a promise that is fulfilled with a configuration or throws.
* $promise = $composed();
* // Wait on the configuration to resolve.
* $config = $promise->wait();
* </code>
*/
class ConfigurationProvider
{
const CACHE_KEY = 'aws_cached_csm_config';
const DEFAULT_CLIENT_ID = '';
const DEFAULT_ENABLED = false;
const DEFAULT_PORT = 31000;
const ENV_CLIENT_ID = 'AWS_CSM_CLIENT_ID';
const ENV_ENABLED = 'AWS_CSM_ENABLED';
const ENV_PORT = 'AWS_CSM_PORT';
const ENV_PROFILE = 'AWS_PROFILE';
/**
* Wraps a credential provider and saves provided credentials in an
* instance of Aws\CacheInterface. Forwards calls when no credentials found
* in cache and updates cache with the results.
*
* @param callable $provider Credentials provider function to wrap
* @param CacheInterface $cache Cache to store credentials
* @param string|null $cacheKey (optional) Cache key to use
*
* @return callable
*/
public static function cache(callable $provider, \Aws\CacheInterface $cache, $cacheKey = null)
{
}
/**
* Creates an aggregate credentials provider that invokes the provided
* variadic providers one after the other until a provider returns
* credentials.
*
* @return callable
*/
public static function chain()
{
}
/**
* Create a default CSM config provider that first checks for environment
* variables, then checks for a specified profile in ~/.aws/config, then
* checks for the "aws_csm" profile in ~/.aws/config, and failing those uses
* a default fallback set of configuration options.
*
* This provider is automatically wrapped in a memoize function that caches
* previously provided config options.
*
* @param array $config Optional array of ecs/instance profile credentials
* provider options.
*
* @return callable
*/
public static function defaultProvider(array $config = [])
{
}
/**
* Provider that creates CSM config from environment variables.
*
* @return callable
*/
public static function env()
{
}
/**
* Fallback config options when other sources are not set.
*
* @return callable
*/
public static function fallback()
{
}
/**
* CSM config provider that creates CSM config using an ini file stored
* in the current user's home directory.
*
* @param string|null $profile Profile to use. If not specified will use
* the "aws_csm" profile in "~/.aws/config".
* @param string|null $filename If provided, uses a custom filename rather
* than looking in the home directory.
*
* @return callable
*/
public static function ini($profile = null, $filename = null)
{
}
/**
* Wraps a CSM config provider and caches previously provided configuration.
*
* Ensures that cached configuration is refreshed when it expires.
*
* @param callable $provider CSM config provider function to wrap.
*
* @return callable
*/
public static function memoize(callable $provider)
{
}
/**
* Unwraps a configuration object in whatever valid form it is in,
* always returning a ConfigurationInterface object.
*
* @param mixed $config
* @return ConfigurationInterface
* @throws \InvalidArgumentException
*/
public static function unwrap($config)
{
}
}
/**
* @internal
*/
class ApiCallAttemptMonitoringMiddleware extends \Aws\ClientSideMonitoring\AbstractMonitoringMiddleware
{
/**
* {@inheritdoc}
*/
public static function getRequestData(\Psr\Http\Message\RequestInterface $request)
{
}
/**
* {@inheritdoc}
*/
public static function getResponseData($klass)
{
}
/**
* {@inheritdoc}
*/
protected function populateRequestEventData(\Aws\CommandInterface $cmd, \Psr\Http\Message\RequestInterface $request, array $event)
{
}
/**
* {@inheritdoc}
*/
protected function populateResultEventData($result, array $event)
{
}
}
}
namespace Aws\ClientSideMonitoring\Exception {
/**
* Represents an error interacting with configuration for client-side monitoring.
*/
class ConfigurationException extends \RuntimeException implements \Aws\MonitoringEventsInterface
{
use \Aws\HasMonitoringEventsTrait;
}
}
namespace Aws\Greengrass {
/**
* This client is used to interact with the **AWS Greengrass** service.
* @method \Aws\Result associateRoleToGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateRoleToGroupAsync(array $args = [])
* @method \Aws\Result associateServiceRoleToAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateServiceRoleToAccountAsync(array $args = [])
* @method \Aws\Result createCoreDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCoreDefinitionAsync(array $args = [])
* @method \Aws\Result createCoreDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCoreDefinitionVersionAsync(array $args = [])
* @method \Aws\Result createDeployment(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDeploymentAsync(array $args = [])
* @method \Aws\Result createDeviceDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDeviceDefinitionAsync(array $args = [])
* @method \Aws\Result createDeviceDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDeviceDefinitionVersionAsync(array $args = [])
* @method \Aws\Result createFunctionDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise createFunctionDefinitionAsync(array $args = [])
* @method \Aws\Result createFunctionDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createFunctionDefinitionVersionAsync(array $args = [])
* @method \Aws\Result createGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGroupAsync(array $args = [])
* @method \Aws\Result createGroupCertificateAuthority(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGroupCertificateAuthorityAsync(array $args = [])
* @method \Aws\Result createGroupVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createGroupVersionAsync(array $args = [])
* @method \Aws\Result createLoggerDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLoggerDefinitionAsync(array $args = [])
* @method \Aws\Result createLoggerDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLoggerDefinitionVersionAsync(array $args = [])
* @method \Aws\Result createResourceDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise createResourceDefinitionAsync(array $args = [])
* @method \Aws\Result createResourceDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createResourceDefinitionVersionAsync(array $args = [])
* @method \Aws\Result createSoftwareUpdateJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSoftwareUpdateJobAsync(array $args = [])
* @method \Aws\Result createSubscriptionDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSubscriptionDefinitionAsync(array $args = [])
* @method \Aws\Result createSubscriptionDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSubscriptionDefinitionVersionAsync(array $args = [])
* @method \Aws\Result deleteCoreDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCoreDefinitionAsync(array $args = [])
* @method \Aws\Result deleteDeviceDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDeviceDefinitionAsync(array $args = [])
* @method \Aws\Result deleteFunctionDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFunctionDefinitionAsync(array $args = [])
* @method \Aws\Result deleteGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGroupAsync(array $args = [])
* @method \Aws\Result deleteLoggerDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLoggerDefinitionAsync(array $args = [])
* @method \Aws\Result deleteResourceDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteResourceDefinitionAsync(array $args = [])
* @method \Aws\Result deleteSubscriptionDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSubscriptionDefinitionAsync(array $args = [])
* @method \Aws\Result disassociateRoleFromGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateRoleFromGroupAsync(array $args = [])
* @method \Aws\Result disassociateServiceRoleFromAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateServiceRoleFromAccountAsync(array $args = [])
* @method \Aws\Result getAssociatedRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAssociatedRoleAsync(array $args = [])
* @method \Aws\Result getConnectivityInfo(array $args = [])
* @method \GuzzleHttp\Promise\Promise getConnectivityInfoAsync(array $args = [])
* @method \Aws\Result getCoreDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCoreDefinitionAsync(array $args = [])
* @method \Aws\Result getCoreDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCoreDefinitionVersionAsync(array $args = [])
* @method \Aws\Result getDeploymentStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeploymentStatusAsync(array $args = [])
* @method \Aws\Result getDeviceDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeviceDefinitionAsync(array $args = [])
* @method \Aws\Result getDeviceDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeviceDefinitionVersionAsync(array $args = [])
* @method \Aws\Result getFunctionDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFunctionDefinitionAsync(array $args = [])
* @method \Aws\Result getFunctionDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFunctionDefinitionVersionAsync(array $args = [])
* @method \Aws\Result getGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGroupAsync(array $args = [])
* @method \Aws\Result getGroupCertificateAuthority(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGroupCertificateAuthorityAsync(array $args = [])
* @method \Aws\Result getGroupCertificateConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGroupCertificateConfigurationAsync(array $args = [])
* @method \Aws\Result getGroupVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGroupVersionAsync(array $args = [])
* @method \Aws\Result getLoggerDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLoggerDefinitionAsync(array $args = [])
* @method \Aws\Result getLoggerDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLoggerDefinitionVersionAsync(array $args = [])
* @method \Aws\Result getResourceDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise getResourceDefinitionAsync(array $args = [])
* @method \Aws\Result getResourceDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getResourceDefinitionVersionAsync(array $args = [])
* @method \Aws\Result getServiceRoleForAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise getServiceRoleForAccountAsync(array $args = [])
* @method \Aws\Result getSubscriptionDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSubscriptionDefinitionAsync(array $args = [])
* @method \Aws\Result getSubscriptionDefinitionVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSubscriptionDefinitionVersionAsync(array $args = [])
* @method \Aws\Result listCoreDefinitionVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCoreDefinitionVersionsAsync(array $args = [])
* @method \Aws\Result listCoreDefinitions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCoreDefinitionsAsync(array $args = [])
* @method \Aws\Result listDeployments(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeploymentsAsync(array $args = [])
* @method \Aws\Result listDeviceDefinitionVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeviceDefinitionVersionsAsync(array $args = [])
* @method \Aws\Result listDeviceDefinitions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDeviceDefinitionsAsync(array $args = [])
* @method \Aws\Result listFunctionDefinitionVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFunctionDefinitionVersionsAsync(array $args = [])
* @method \Aws\Result listFunctionDefinitions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFunctionDefinitionsAsync(array $args = [])
* @method \Aws\Result listGroupCertificateAuthorities(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupCertificateAuthoritiesAsync(array $args = [])
* @method \Aws\Result listGroupVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupVersionsAsync(array $args = [])
* @method \Aws\Result listGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise listGroupsAsync(array $args = [])
* @method \Aws\Result listLoggerDefinitionVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listLoggerDefinitionVersionsAsync(array $args = [])
* @method \Aws\Result listLoggerDefinitions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listLoggerDefinitionsAsync(array $args = [])
* @method \Aws\Result listResourceDefinitionVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourceDefinitionVersionsAsync(array $args = [])
* @method \Aws\Result listResourceDefinitions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listResourceDefinitionsAsync(array $args = [])
* @method \Aws\Result listSubscriptionDefinitionVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSubscriptionDefinitionVersionsAsync(array $args = [])
* @method \Aws\Result listSubscriptionDefinitions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listSubscriptionDefinitionsAsync(array $args = [])
* @method \Aws\Result resetDeployments(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetDeploymentsAsync(array $args = [])
* @method \Aws\Result updateConnectivityInfo(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateConnectivityInfoAsync(array $args = [])
* @method \Aws\Result updateCoreDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCoreDefinitionAsync(array $args = [])
* @method \Aws\Result updateDeviceDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDeviceDefinitionAsync(array $args = [])
* @method \Aws\Result updateFunctionDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFunctionDefinitionAsync(array $args = [])
* @method \Aws\Result updateGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGroupAsync(array $args = [])
* @method \Aws\Result updateGroupCertificateConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGroupCertificateConfigurationAsync(array $args = [])
* @method \Aws\Result updateLoggerDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateLoggerDefinitionAsync(array $args = [])
* @method \Aws\Result updateResourceDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateResourceDefinitionAsync(array $args = [])
* @method \Aws\Result updateSubscriptionDefinition(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateSubscriptionDefinitionAsync(array $args = [])
*/
class GreengrassClient extends \Aws\AwsClient
{
}
}
namespace Aws\Greengrass\Exception {
/**
* Represents an error interacting with the **AWS Greengrass** service.
*/
class GreengrassException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Glue {
/**
* This client is used to interact with the **AWS Glue** service.
* @method \Aws\Result batchCreatePartition(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchCreatePartitionAsync(array $args = [])
* @method \Aws\Result batchDeleteConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDeleteConnectionAsync(array $args = [])
* @method \Aws\Result batchDeletePartition(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDeletePartitionAsync(array $args = [])
* @method \Aws\Result batchDeleteTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDeleteTableAsync(array $args = [])
* @method \Aws\Result batchDeleteTableVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDeleteTableVersionAsync(array $args = [])
* @method \Aws\Result batchGetPartition(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetPartitionAsync(array $args = [])
* @method \Aws\Result batchStopJobRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchStopJobRunAsync(array $args = [])
* @method \Aws\Result createClassifier(array $args = [])
* @method \GuzzleHttp\Promise\Promise createClassifierAsync(array $args = [])
* @method \Aws\Result createConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise createConnectionAsync(array $args = [])
* @method \Aws\Result createCrawler(array $args = [])
* @method \GuzzleHttp\Promise\Promise createCrawlerAsync(array $args = [])
* @method \Aws\Result createDatabase(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDatabaseAsync(array $args = [])
* @method \Aws\Result createDevEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDevEndpointAsync(array $args = [])
* @method \Aws\Result createJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createJobAsync(array $args = [])
* @method \Aws\Result createPartition(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPartitionAsync(array $args = [])
* @method \Aws\Result createScript(array $args = [])
* @method \GuzzleHttp\Promise\Promise createScriptAsync(array $args = [])
* @method \Aws\Result createSecurityConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSecurityConfigurationAsync(array $args = [])
* @method \Aws\Result createTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTableAsync(array $args = [])
* @method \Aws\Result createTrigger(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTriggerAsync(array $args = [])
* @method \Aws\Result createUserDefinedFunction(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserDefinedFunctionAsync(array $args = [])
* @method \Aws\Result deleteClassifier(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClassifierAsync(array $args = [])
* @method \Aws\Result deleteConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteConnectionAsync(array $args = [])
* @method \Aws\Result deleteCrawler(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteCrawlerAsync(array $args = [])
* @method \Aws\Result deleteDatabase(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDatabaseAsync(array $args = [])
* @method \Aws\Result deleteDevEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDevEndpointAsync(array $args = [])
* @method \Aws\Result deleteJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteJobAsync(array $args = [])
* @method \Aws\Result deletePartition(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePartitionAsync(array $args = [])
* @method \Aws\Result deleteSecurityConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSecurityConfigurationAsync(array $args = [])
* @method \Aws\Result deleteTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTableAsync(array $args = [])
* @method \Aws\Result deleteTableVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTableVersionAsync(array $args = [])
* @method \Aws\Result deleteTrigger(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTriggerAsync(array $args = [])
* @method \Aws\Result deleteUserDefinedFunction(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserDefinedFunctionAsync(array $args = [])
* @method \Aws\Result getCatalogImportStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCatalogImportStatusAsync(array $args = [])
* @method \Aws\Result getClassifier(array $args = [])
* @method \GuzzleHttp\Promise\Promise getClassifierAsync(array $args = [])
* @method \Aws\Result getClassifiers(array $args = [])
* @method \GuzzleHttp\Promise\Promise getClassifiersAsync(array $args = [])
* @method \Aws\Result getConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise getConnectionAsync(array $args = [])
* @method \Aws\Result getConnections(array $args = [])
* @method \GuzzleHttp\Promise\Promise getConnectionsAsync(array $args = [])
* @method \Aws\Result getCrawler(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCrawlerAsync(array $args = [])
* @method \Aws\Result getCrawlerMetrics(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCrawlerMetricsAsync(array $args = [])
* @method \Aws\Result getCrawlers(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCrawlersAsync(array $args = [])
* @method \Aws\Result getDataCatalogEncryptionSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDataCatalogEncryptionSettingsAsync(array $args = [])
* @method \Aws\Result getDatabase(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDatabaseAsync(array $args = [])
* @method \Aws\Result getDatabases(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDatabasesAsync(array $args = [])
* @method \Aws\Result getDataflowGraph(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDataflowGraphAsync(array $args = [])
* @method \Aws\Result getDevEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDevEndpointAsync(array $args = [])
* @method \Aws\Result getDevEndpoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDevEndpointsAsync(array $args = [])
* @method \Aws\Result getJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobAsync(array $args = [])
* @method \Aws\Result getJobRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobRunAsync(array $args = [])
* @method \Aws\Result getJobRuns(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobRunsAsync(array $args = [])
* @method \Aws\Result getJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise getJobsAsync(array $args = [])
* @method \Aws\Result getMapping(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMappingAsync(array $args = [])
* @method \Aws\Result getPartition(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPartitionAsync(array $args = [])
* @method \Aws\Result getPartitions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPartitionsAsync(array $args = [])
* @method \Aws\Result getPlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPlanAsync(array $args = [])
* @method \Aws\Result getSecurityConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSecurityConfigurationAsync(array $args = [])
* @method \Aws\Result getSecurityConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSecurityConfigurationsAsync(array $args = [])
* @method \Aws\Result getTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTableAsync(array $args = [])
* @method \Aws\Result getTableVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTableVersionAsync(array $args = [])
* @method \Aws\Result getTableVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTableVersionsAsync(array $args = [])
* @method \Aws\Result getTables(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTablesAsync(array $args = [])
* @method \Aws\Result getTrigger(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTriggerAsync(array $args = [])
* @method \Aws\Result getTriggers(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTriggersAsync(array $args = [])
* @method \Aws\Result getUserDefinedFunction(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUserDefinedFunctionAsync(array $args = [])
* @method \Aws\Result getUserDefinedFunctions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUserDefinedFunctionsAsync(array $args = [])
* @method \Aws\Result importCatalogToGlue(array $args = [])
* @method \GuzzleHttp\Promise\Promise importCatalogToGlueAsync(array $args = [])
* @method \Aws\Result putDataCatalogEncryptionSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise putDataCatalogEncryptionSettingsAsync(array $args = [])
* @method \Aws\Result resetJobBookmark(array $args = [])
* @method \GuzzleHttp\Promise\Promise resetJobBookmarkAsync(array $args = [])
* @method \Aws\Result startCrawler(array $args = [])
* @method \GuzzleHttp\Promise\Promise startCrawlerAsync(array $args = [])
* @method \Aws\Result startCrawlerSchedule(array $args = [])
* @method \GuzzleHttp\Promise\Promise startCrawlerScheduleAsync(array $args = [])
* @method \Aws\Result startJobRun(array $args = [])
* @method \GuzzleHttp\Promise\Promise startJobRunAsync(array $args = [])
* @method \Aws\Result startTrigger(array $args = [])
* @method \GuzzleHttp\Promise\Promise startTriggerAsync(array $args = [])
* @method \Aws\Result stopCrawler(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopCrawlerAsync(array $args = [])
* @method \Aws\Result stopCrawlerSchedule(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopCrawlerScheduleAsync(array $args = [])
* @method \Aws\Result stopTrigger(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopTriggerAsync(array $args = [])
* @method \Aws\Result updateClassifier(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateClassifierAsync(array $args = [])
* @method \Aws\Result updateConnection(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateConnectionAsync(array $args = [])
* @method \Aws\Result updateCrawler(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCrawlerAsync(array $args = [])
* @method \Aws\Result updateCrawlerSchedule(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateCrawlerScheduleAsync(array $args = [])
* @method \Aws\Result updateDatabase(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDatabaseAsync(array $args = [])
* @method \Aws\Result updateDevEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDevEndpointAsync(array $args = [])
* @method \Aws\Result updateJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateJobAsync(array $args = [])
* @method \Aws\Result updatePartition(array $args = [])
* @method \GuzzleHttp\Promise\Promise updatePartitionAsync(array $args = [])
* @method \Aws\Result updateTable(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTableAsync(array $args = [])
* @method \Aws\Result updateTrigger(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateTriggerAsync(array $args = [])
* @method \Aws\Result updateUserDefinedFunction(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserDefinedFunctionAsync(array $args = [])
*/
class GlueClient extends \Aws\AwsClient
{
}
}
namespace Aws\Glue\Exception {
/**
* Represents an error interacting with the **AWS Glue** service.
*/
class GlueException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ApplicationAutoScaling\Exception {
/**
* Represents an error interacting with the **Application Auto Scaling** service.
*/
class ApplicationAutoScalingException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ApplicationAutoScaling {
/**
* This client is used to interact with the **Application Auto Scaling** service.
* @method \Aws\Result deleteScalingPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteScalingPolicyAsync(array $args = [])
* @method \Aws\Result deleteScheduledAction(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteScheduledActionAsync(array $args = [])
* @method \Aws\Result deregisterScalableTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterScalableTargetAsync(array $args = [])
* @method \Aws\Result describeScalableTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScalableTargetsAsync(array $args = [])
* @method \Aws\Result describeScalingActivities(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScalingActivitiesAsync(array $args = [])
* @method \Aws\Result describeScalingPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScalingPoliciesAsync(array $args = [])
* @method \Aws\Result describeScheduledActions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeScheduledActionsAsync(array $args = [])
* @method \Aws\Result putScalingPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putScalingPolicyAsync(array $args = [])
* @method \Aws\Result putScheduledAction(array $args = [])
* @method \GuzzleHttp\Promise\Promise putScheduledActionAsync(array $args = [])
* @method \Aws\Result registerScalableTarget(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerScalableTargetAsync(array $args = [])
*/
class ApplicationAutoScalingClient extends \Aws\AwsClient
{
}
}
namespace Aws\LexModelBuildingService {
/**
* This client is used to interact with the **Amazon Lex Model Building Service** service.
* @method \Aws\Result createBotVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBotVersionAsync(array $args = [])
* @method \Aws\Result createIntentVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createIntentVersionAsync(array $args = [])
* @method \Aws\Result createSlotTypeVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSlotTypeVersionAsync(array $args = [])
* @method \Aws\Result deleteBot(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBotAsync(array $args = [])
* @method \Aws\Result deleteBotAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBotAliasAsync(array $args = [])
* @method \Aws\Result deleteBotChannelAssociation(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBotChannelAssociationAsync(array $args = [])
* @method \Aws\Result deleteBotVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBotVersionAsync(array $args = [])
* @method \Aws\Result deleteIntent(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIntentAsync(array $args = [])
* @method \Aws\Result deleteIntentVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIntentVersionAsync(array $args = [])
* @method \Aws\Result deleteSlotType(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSlotTypeAsync(array $args = [])
* @method \Aws\Result deleteSlotTypeVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteSlotTypeVersionAsync(array $args = [])
* @method \Aws\Result deleteUtterances(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUtterancesAsync(array $args = [])
* @method \Aws\Result getBot(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBotAsync(array $args = [])
* @method \Aws\Result getBotAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBotAliasAsync(array $args = [])
* @method \Aws\Result getBotAliases(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBotAliasesAsync(array $args = [])
* @method \Aws\Result getBotChannelAssociation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBotChannelAssociationAsync(array $args = [])
* @method \Aws\Result getBotChannelAssociations(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBotChannelAssociationsAsync(array $args = [])
* @method \Aws\Result getBotVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBotVersionsAsync(array $args = [])
* @method \Aws\Result getBots(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBotsAsync(array $args = [])
* @method \Aws\Result getBuiltinIntent(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBuiltinIntentAsync(array $args = [])
* @method \Aws\Result getBuiltinIntents(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBuiltinIntentsAsync(array $args = [])
* @method \Aws\Result getBuiltinSlotTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBuiltinSlotTypesAsync(array $args = [])
* @method \Aws\Result getExport(array $args = [])
* @method \GuzzleHttp\Promise\Promise getExportAsync(array $args = [])
* @method \Aws\Result getImport(array $args = [])
* @method \GuzzleHttp\Promise\Promise getImportAsync(array $args = [])
* @method \Aws\Result getIntent(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIntentAsync(array $args = [])
* @method \Aws\Result getIntentVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIntentVersionsAsync(array $args = [])
* @method \Aws\Result getIntents(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIntentsAsync(array $args = [])
* @method \Aws\Result getSlotType(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSlotTypeAsync(array $args = [])
* @method \Aws\Result getSlotTypeVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSlotTypeVersionsAsync(array $args = [])
* @method \Aws\Result getSlotTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSlotTypesAsync(array $args = [])
* @method \Aws\Result getUtterancesView(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUtterancesViewAsync(array $args = [])
* @method \Aws\Result putBot(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBotAsync(array $args = [])
* @method \Aws\Result putBotAlias(array $args = [])
* @method \GuzzleHttp\Promise\Promise putBotAliasAsync(array $args = [])
* @method \Aws\Result putIntent(array $args = [])
* @method \GuzzleHttp\Promise\Promise putIntentAsync(array $args = [])
* @method \Aws\Result putSlotType(array $args = [])
* @method \GuzzleHttp\Promise\Promise putSlotTypeAsync(array $args = [])
* @method \Aws\Result startImport(array $args = [])
* @method \GuzzleHttp\Promise\Promise startImportAsync(array $args = [])
*/
class LexModelBuildingServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws\LexModelBuildingService\Exception {
/**
* Represents an error interacting with the **Amazon Lex Model Building Service** service.
*/
class LexModelBuildingServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ElasticLoadBalancing {
/**
* This client is used to interact with the **Elastic Load Balancing** service.
*
* @method \Aws\Result addTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsAsync(array $args = [])
* @method \Aws\Result applySecurityGroupsToLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise applySecurityGroupsToLoadBalancerAsync(array $args = [])
* @method \Aws\Result attachLoadBalancerToSubnets(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachLoadBalancerToSubnetsAsync(array $args = [])
* @method \Aws\Result configureHealthCheck(array $args = [])
* @method \GuzzleHttp\Promise\Promise configureHealthCheckAsync(array $args = [])
* @method \Aws\Result createAppCookieStickinessPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAppCookieStickinessPolicyAsync(array $args = [])
* @method \Aws\Result createLBCookieStickinessPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLBCookieStickinessPolicyAsync(array $args = [])
* @method \Aws\Result createLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLoadBalancerAsync(array $args = [])
* @method \Aws\Result createLoadBalancerListeners(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLoadBalancerListenersAsync(array $args = [])
* @method \Aws\Result createLoadBalancerPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLoadBalancerPolicyAsync(array $args = [])
* @method \Aws\Result deleteLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLoadBalancerAsync(array $args = [])
* @method \Aws\Result deleteLoadBalancerListeners(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLoadBalancerListenersAsync(array $args = [])
* @method \Aws\Result deleteLoadBalancerPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLoadBalancerPolicyAsync(array $args = [])
* @method \Aws\Result deregisterInstancesFromLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterInstancesFromLoadBalancerAsync(array $args = [])
* @method \Aws\Result describeAccountLimits(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAccountLimitsAsync(array $args = [])
* @method \Aws\Result describeInstanceHealth(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstanceHealthAsync(array $args = [])
* @method \Aws\Result describeLoadBalancerAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoadBalancerAttributesAsync(array $args = [])
* @method \Aws\Result describeLoadBalancerPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoadBalancerPoliciesAsync(array $args = [])
* @method \Aws\Result describeLoadBalancerPolicyTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoadBalancerPolicyTypesAsync(array $args = [])
* @method \Aws\Result describeLoadBalancers(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoadBalancersAsync(array $args = [])
* @method \Aws\Result describeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagsAsync(array $args = [])
* @method \Aws\Result detachLoadBalancerFromSubnets(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachLoadBalancerFromSubnetsAsync(array $args = [])
* @method \Aws\Result disableAvailabilityZonesForLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise disableAvailabilityZonesForLoadBalancerAsync(array $args = [])
* @method \Aws\Result enableAvailabilityZonesForLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise enableAvailabilityZonesForLoadBalancerAsync(array $args = [])
* @method \Aws\Result modifyLoadBalancerAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyLoadBalancerAttributesAsync(array $args = [])
* @method \Aws\Result registerInstancesWithLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerInstancesWithLoadBalancerAsync(array $args = [])
* @method \Aws\Result removeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsAsync(array $args = [])
* @method \Aws\Result setLoadBalancerListenerSSLCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise setLoadBalancerListenerSSLCertificateAsync(array $args = [])
* @method \Aws\Result setLoadBalancerPoliciesForBackendServer(array $args = [])
* @method \GuzzleHttp\Promise\Promise setLoadBalancerPoliciesForBackendServerAsync(array $args = [])
* @method \Aws\Result setLoadBalancerPoliciesOfListener(array $args = [])
* @method \GuzzleHttp\Promise\Promise setLoadBalancerPoliciesOfListenerAsync(array $args = [])
*/
class ElasticLoadBalancingClient extends \Aws\AwsClient
{
}
}
namespace Aws\ElasticLoadBalancing\Exception {
/**
* Represents an error interacting with the Elastic Load Balancing service.
*/
class ElasticLoadBalancingException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\OpsWorksCM\Exception {
/**
* Represents an error interacting with the **AWS OpsWorks for Chef Automate** service.
*/
class OpsWorksCMException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\OpsWorksCM {
/**
* This client is used to interact with the **AWS OpsWorks for Chef Automate** service.
* @method \Aws\Result associateNode(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateNodeAsync(array $args = [])
* @method \Aws\Result createBackup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBackupAsync(array $args = [])
* @method \Aws\Result createServer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createServerAsync(array $args = [])
* @method \Aws\Result deleteBackup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBackupAsync(array $args = [])
* @method \Aws\Result deleteServer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteServerAsync(array $args = [])
* @method \Aws\Result describeAccountAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAccountAttributesAsync(array $args = [])
* @method \Aws\Result describeBackups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeBackupsAsync(array $args = [])
* @method \Aws\Result describeEvents(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEventsAsync(array $args = [])
* @method \Aws\Result describeNodeAssociationStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNodeAssociationStatusAsync(array $args = [])
* @method \Aws\Result describeServers(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeServersAsync(array $args = [])
* @method \Aws\Result disassociateNode(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateNodeAsync(array $args = [])
* @method \Aws\Result exportServerEngineAttribute(array $args = [])
* @method \GuzzleHttp\Promise\Promise exportServerEngineAttributeAsync(array $args = [])
* @method \Aws\Result restoreServer(array $args = [])
* @method \GuzzleHttp\Promise\Promise restoreServerAsync(array $args = [])
* @method \Aws\Result startMaintenance(array $args = [])
* @method \GuzzleHttp\Promise\Promise startMaintenanceAsync(array $args = [])
* @method \Aws\Result updateServer(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateServerAsync(array $args = [])
* @method \Aws\Result updateServerEngineAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateServerEngineAttributesAsync(array $args = [])
*/
class OpsWorksCMClient extends \Aws\AwsClient
{
}
}
namespace Aws {
/**
* Represents an AWS result object that is returned from executing an operation.
*/
interface ResultInterface extends \ArrayAccess, \IteratorAggregate, \Countable
{
/**
* Provides debug information about the result object
*
* @return string
*/
public function __toString();
/**
* Convert the result to an array.
*
* @return array
*/
public function toArray();
/**
* Check if the model contains a key by name
*
* @param string $name Name of the key to retrieve
*
* @return bool
*/
public function hasKey($name);
/**
* Get a specific key value from the result model.
*
* @param string $key Key to retrieve.
*
* @return mixed|null Value of the key or NULL if not found.
*/
public function get($key);
/**
* Returns the result of executing a JMESPath expression on the contents
* of the Result model.
*
* $result = $client->execute($command);
* $jpResult = $result->search('foo.*.bar[?baz > `10`]');
*
* @param string $expression JMESPath expression to execute
*
* @return mixed Returns the result of the JMESPath expression.
* @link http://jmespath.readthedocs.org/en/latest/ JMESPath documentation
*/
public function search($expression);
}
}
namespace Aws\OpsWorks {
/**
* This client is used to interact with the **AWS OpsWorks** service.
*
* @method \Aws\Result assignInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise assignInstanceAsync(array $args = [])
* @method \Aws\Result assignVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise assignVolumeAsync(array $args = [])
* @method \Aws\Result associateElasticIp(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateElasticIpAsync(array $args = [])
* @method \Aws\Result attachElasticLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise attachElasticLoadBalancerAsync(array $args = [])
* @method \Aws\Result cloneStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise cloneStackAsync(array $args = [])
* @method \Aws\Result createApp(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAppAsync(array $args = [])
* @method \Aws\Result createDeployment(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDeploymentAsync(array $args = [])
* @method \Aws\Result createInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise createInstanceAsync(array $args = [])
* @method \Aws\Result createLayer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLayerAsync(array $args = [])
* @method \Aws\Result createStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStackAsync(array $args = [])
* @method \Aws\Result createUserProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUserProfileAsync(array $args = [])
* @method \Aws\Result deleteApp(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAppAsync(array $args = [])
* @method \Aws\Result deleteInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInstanceAsync(array $args = [])
* @method \Aws\Result deleteLayer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLayerAsync(array $args = [])
* @method \Aws\Result deleteStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStackAsync(array $args = [])
* @method \Aws\Result deleteUserProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUserProfileAsync(array $args = [])
* @method \Aws\Result deregisterEcsCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterEcsClusterAsync(array $args = [])
* @method \Aws\Result deregisterElasticIp(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterElasticIpAsync(array $args = [])
* @method \Aws\Result deregisterInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterInstanceAsync(array $args = [])
* @method \Aws\Result deregisterRdsDbInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterRdsDbInstanceAsync(array $args = [])
* @method \Aws\Result deregisterVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterVolumeAsync(array $args = [])
* @method \Aws\Result describeAgentVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAgentVersionsAsync(array $args = [])
* @method \Aws\Result describeApps(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAppsAsync(array $args = [])
* @method \Aws\Result describeCommands(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeCommandsAsync(array $args = [])
* @method \Aws\Result describeDeployments(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDeploymentsAsync(array $args = [])
* @method \Aws\Result describeEcsClusters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEcsClustersAsync(array $args = [])
* @method \Aws\Result describeElasticIps(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeElasticIpsAsync(array $args = [])
* @method \Aws\Result describeElasticLoadBalancers(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeElasticLoadBalancersAsync(array $args = [])
* @method \Aws\Result describeInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeInstancesAsync(array $args = [])
* @method \Aws\Result describeLayers(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLayersAsync(array $args = [])
* @method \Aws\Result describeLoadBasedAutoScaling(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoadBasedAutoScalingAsync(array $args = [])
* @method \Aws\Result describeMyUserProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMyUserProfileAsync(array $args = [])
* @method \Aws\Result describeOperatingSystems(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeOperatingSystemsAsync(array $args = [])
* @method \Aws\Result describePermissions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describePermissionsAsync(array $args = [])
* @method \Aws\Result describeRaidArrays(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRaidArraysAsync(array $args = [])
* @method \Aws\Result describeRdsDbInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRdsDbInstancesAsync(array $args = [])
* @method \Aws\Result describeServiceErrors(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeServiceErrorsAsync(array $args = [])
* @method \Aws\Result describeStackProvisioningParameters(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStackProvisioningParametersAsync(array $args = [])
* @method \Aws\Result describeStackSummary(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStackSummaryAsync(array $args = [])
* @method \Aws\Result describeStacks(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeStacksAsync(array $args = [])
* @method \Aws\Result describeTimeBasedAutoScaling(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTimeBasedAutoScalingAsync(array $args = [])
* @method \Aws\Result describeUserProfiles(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeUserProfilesAsync(array $args = [])
* @method \Aws\Result describeVolumes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeVolumesAsync(array $args = [])
* @method \Aws\Result detachElasticLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise detachElasticLoadBalancerAsync(array $args = [])
* @method \Aws\Result disassociateElasticIp(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateElasticIpAsync(array $args = [])
* @method \Aws\Result getHostnameSuggestion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getHostnameSuggestionAsync(array $args = [])
* @method \Aws\Result grantAccess(array $args = [])
* @method \GuzzleHttp\Promise\Promise grantAccessAsync(array $args = [])
* @method \Aws\Result listTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsAsync(array $args = [])
* @method \Aws\Result rebootInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootInstanceAsync(array $args = [])
* @method \Aws\Result registerEcsCluster(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerEcsClusterAsync(array $args = [])
* @method \Aws\Result registerElasticIp(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerElasticIpAsync(array $args = [])
* @method \Aws\Result registerInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerInstanceAsync(array $args = [])
* @method \Aws\Result registerRdsDbInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerRdsDbInstanceAsync(array $args = [])
* @method \Aws\Result registerVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerVolumeAsync(array $args = [])
* @method \Aws\Result setLoadBasedAutoScaling(array $args = [])
* @method \GuzzleHttp\Promise\Promise setLoadBasedAutoScalingAsync(array $args = [])
* @method \Aws\Result setPermission(array $args = [])
* @method \GuzzleHttp\Promise\Promise setPermissionAsync(array $args = [])
* @method \Aws\Result setTimeBasedAutoScaling(array $args = [])
* @method \GuzzleHttp\Promise\Promise setTimeBasedAutoScalingAsync(array $args = [])
* @method \Aws\Result startInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise startInstanceAsync(array $args = [])
* @method \Aws\Result startStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise startStackAsync(array $args = [])
* @method \Aws\Result stopInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopInstanceAsync(array $args = [])
* @method \Aws\Result stopStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopStackAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result unassignInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise unassignInstanceAsync(array $args = [])
* @method \Aws\Result unassignVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise unassignVolumeAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateApp(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAppAsync(array $args = [])
* @method \Aws\Result updateElasticIp(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateElasticIpAsync(array $args = [])
* @method \Aws\Result updateInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateInstanceAsync(array $args = [])
* @method \Aws\Result updateLayer(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateLayerAsync(array $args = [])
* @method \Aws\Result updateMyUserProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateMyUserProfileAsync(array $args = [])
* @method \Aws\Result updateRdsDbInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRdsDbInstanceAsync(array $args = [])
* @method \Aws\Result updateStack(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateStackAsync(array $args = [])
* @method \Aws\Result updateUserProfile(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUserProfileAsync(array $args = [])
* @method \Aws\Result updateVolume(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateVolumeAsync(array $args = [])
*/
class OpsWorksClient extends \Aws\AwsClient
{
}
}
namespace Aws\OpsWorks\Exception {
/**
* Represents an error interacting with the AWS OpsWorks service.
*/
class OpsWorksException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* Represents a history container that is required when using the history
* middleware.
*/
class History implements \Countable, \IteratorAggregate
{
/**
* @param int $maxEntries Maximum number of entries to store.
*/
public function __construct($maxEntries = 10)
{
}
public function count()
{
}
public function getIterator()
{
}
/**
* Get the last finished command seen by the history container.
*
* @return CommandInterface
* @throws \LogicException if no commands have been seen.
*/
public function getLastCommand()
{
}
/**
* Get the last finished request seen by the history container.
*
* @return RequestInterface
* @throws \LogicException if no requests have been seen.
*/
public function getLastRequest()
{
}
/**
* Get the last received result or exception.
*
* @return ResultInterface|AwsException
* @throws \LogicException if no return values have been received.
*/
public function getLastReturn()
{
}
/**
* Initiate an entry being added to the history.
*
* @param CommandInterface $cmd Command be executed.
* @param RequestInterface $req Request being sent.
*
* @return string Returns the ticket used to finish the entry.
*/
public function start(\Aws\CommandInterface $cmd, \Psr\Http\Message\RequestInterface $req)
{
}
/**
* Finish adding an entry to the history container.
*
* @param string $ticket Ticket returned from the start call.
* @param mixed $result The result (an exception or AwsResult).
*/
public function finish($ticket, $result)
{
}
/**
* Flush the history
*/
public function clear()
{
}
/**
* Converts the history to an array.
*
* @return array
*/
public function toArray()
{
}
}
}
namespace Aws\Cloud9 {
/**
* This client is used to interact with the **AWS Cloud9** service.
* @method \Aws\Result createEnvironmentEC2(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEnvironmentEC2Async(array $args = [])
* @method \Aws\Result createEnvironmentMembership(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEnvironmentMembershipAsync(array $args = [])
* @method \Aws\Result deleteEnvironment(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEnvironmentAsync(array $args = [])
* @method \Aws\Result deleteEnvironmentMembership(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEnvironmentMembershipAsync(array $args = [])
* @method \Aws\Result describeEnvironmentMemberships(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEnvironmentMembershipsAsync(array $args = [])
* @method \Aws\Result describeEnvironmentStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEnvironmentStatusAsync(array $args = [])
* @method \Aws\Result describeEnvironments(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEnvironmentsAsync(array $args = [])
* @method \Aws\Result listEnvironments(array $args = [])
* @method \GuzzleHttp\Promise\Promise listEnvironmentsAsync(array $args = [])
* @method \Aws\Result updateEnvironment(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEnvironmentAsync(array $args = [])
* @method \Aws\Result updateEnvironmentMembership(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEnvironmentMembershipAsync(array $args = [])
*/
class Cloud9Client extends \Aws\AwsClient
{
}
}
namespace Aws\Cloud9\Exception {
/**
* Represents an error interacting with the **AWS Cloud9** service.
*/
class Cloud9Exception extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Macie\Exception {
/**
* Represents an error interacting with the **Amazon Macie** service.
*/
class MacieException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Macie {
/**
* This client is used to interact with the **Amazon Macie** service.
* @method \Aws\Result associateMemberAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateMemberAccountAsync(array $args = [])
* @method \Aws\Result associateS3Resources(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateS3ResourcesAsync(array $args = [])
* @method \Aws\Result disassociateMemberAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateMemberAccountAsync(array $args = [])
* @method \Aws\Result disassociateS3Resources(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateS3ResourcesAsync(array $args = [])
* @method \Aws\Result listMemberAccounts(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMemberAccountsAsync(array $args = [])
* @method \Aws\Result listS3Resources(array $args = [])
* @method \GuzzleHttp\Promise\Promise listS3ResourcesAsync(array $args = [])
* @method \Aws\Result updateS3Resources(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateS3ResourcesAsync(array $args = [])
*/
class MacieClient extends \Aws\AwsClient
{
}
}
namespace Aws\Exception {
class CredentialsException extends \RuntimeException implements \Aws\MonitoringEventsInterface
{
use \Aws\HasMonitoringEventsTrait;
}
class UnresolvedSignatureException extends \RuntimeException implements \Aws\MonitoringEventsInterface
{
use \Aws\HasMonitoringEventsTrait;
}
class UnresolvedApiException extends \RuntimeException implements \Aws\MonitoringEventsInterface
{
use \Aws\HasMonitoringEventsTrait;
}
class CouldNotCreateChecksumException extends \RuntimeException implements \Aws\MonitoringEventsInterface
{
use \Aws\HasMonitoringEventsTrait;
public function __construct($algorithm, \Exception $previous = null)
{
}
}
/**
* Represents an exception that was supplied via an EventStream.
*/
class EventStreamDataException extends \RuntimeException
{
public function __construct($code, $message)
{
}
/**
* Get the AWS error code.
*
* @return string|null Returns null if no response was received
*/
public function getAwsErrorCode()
{
}
/**
* Get the concise error message if any.
*
* @return string|null
*/
public function getAwsErrorMessage()
{
}
}
class UnresolvedEndpointException extends \RuntimeException implements \Aws\MonitoringEventsInterface
{
use \Aws\HasMonitoringEventsTrait;
}
}
namespace Aws\ApiGateway {
/**
* This client is used to interact with the **AWS API Gateway** service.
*
* @method \Aws\Result createApiKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise createApiKeyAsync(array $args = [])
* @method \Aws\Result createAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAuthorizerAsync(array $args = [])
* @method \Aws\Result createBasePathMapping(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBasePathMappingAsync(array $args = [])
* @method \Aws\Result createDeployment(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDeploymentAsync(array $args = [])
* @method \Aws\Result createDocumentationPart(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDocumentationPartAsync(array $args = [])
* @method \Aws\Result createDocumentationVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDocumentationVersionAsync(array $args = [])
* @method \Aws\Result createDomainName(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDomainNameAsync(array $args = [])
* @method \Aws\Result createModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise createModelAsync(array $args = [])
* @method \Aws\Result createRequestValidator(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRequestValidatorAsync(array $args = [])
* @method \Aws\Result createResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise createResourceAsync(array $args = [])
* @method \Aws\Result createRestApi(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRestApiAsync(array $args = [])
* @method \Aws\Result createStage(array $args = [])
* @method \GuzzleHttp\Promise\Promise createStageAsync(array $args = [])
* @method \Aws\Result createUsagePlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUsagePlanAsync(array $args = [])
* @method \Aws\Result createUsagePlanKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise createUsagePlanKeyAsync(array $args = [])
* @method \Aws\Result createVpcLink(array $args = [])
* @method \GuzzleHttp\Promise\Promise createVpcLinkAsync(array $args = [])
* @method \Aws\Result deleteApiKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteApiKeyAsync(array $args = [])
* @method \Aws\Result deleteAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteAuthorizerAsync(array $args = [])
* @method \Aws\Result deleteBasePathMapping(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBasePathMappingAsync(array $args = [])
* @method \Aws\Result deleteClientCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteClientCertificateAsync(array $args = [])
* @method \Aws\Result deleteDeployment(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDeploymentAsync(array $args = [])
* @method \Aws\Result deleteDocumentationPart(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDocumentationPartAsync(array $args = [])
* @method \Aws\Result deleteDocumentationVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDocumentationVersionAsync(array $args = [])
* @method \Aws\Result deleteDomainName(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDomainNameAsync(array $args = [])
* @method \Aws\Result deleteGatewayResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteGatewayResponseAsync(array $args = [])
* @method \Aws\Result deleteIntegration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIntegrationAsync(array $args = [])
* @method \Aws\Result deleteIntegrationResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIntegrationResponseAsync(array $args = [])
* @method \Aws\Result deleteMethod(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMethodAsync(array $args = [])
* @method \Aws\Result deleteMethodResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMethodResponseAsync(array $args = [])
* @method \Aws\Result deleteModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteModelAsync(array $args = [])
* @method \Aws\Result deleteRequestValidator(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRequestValidatorAsync(array $args = [])
* @method \Aws\Result deleteResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteResourceAsync(array $args = [])
* @method \Aws\Result deleteRestApi(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRestApiAsync(array $args = [])
* @method \Aws\Result deleteStage(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteStageAsync(array $args = [])
* @method \Aws\Result deleteUsagePlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUsagePlanAsync(array $args = [])
* @method \Aws\Result deleteUsagePlanKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteUsagePlanKeyAsync(array $args = [])
* @method \Aws\Result deleteVpcLink(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteVpcLinkAsync(array $args = [])
* @method \Aws\Result flushStageAuthorizersCache(array $args = [])
* @method \GuzzleHttp\Promise\Promise flushStageAuthorizersCacheAsync(array $args = [])
* @method \Aws\Result flushStageCache(array $args = [])
* @method \GuzzleHttp\Promise\Promise flushStageCacheAsync(array $args = [])
* @method \Aws\Result generateClientCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise generateClientCertificateAsync(array $args = [])
* @method \Aws\Result getAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAccountAsync(array $args = [])
* @method \Aws\Result getApiKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApiKeyAsync(array $args = [])
* @method \Aws\Result getApiKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise getApiKeysAsync(array $args = [])
* @method \Aws\Result getAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAuthorizerAsync(array $args = [])
* @method \Aws\Result getAuthorizers(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAuthorizersAsync(array $args = [])
* @method \Aws\Result getBasePathMapping(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBasePathMappingAsync(array $args = [])
* @method \Aws\Result getBasePathMappings(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBasePathMappingsAsync(array $args = [])
* @method \Aws\Result getClientCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getClientCertificateAsync(array $args = [])
* @method \Aws\Result getClientCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise getClientCertificatesAsync(array $args = [])
* @method \Aws\Result getDeployment(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeploymentAsync(array $args = [])
* @method \Aws\Result getDeployments(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDeploymentsAsync(array $args = [])
* @method \Aws\Result getDocumentationPart(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDocumentationPartAsync(array $args = [])
* @method \Aws\Result getDocumentationParts(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDocumentationPartsAsync(array $args = [])
* @method \Aws\Result getDocumentationVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDocumentationVersionAsync(array $args = [])
* @method \Aws\Result getDocumentationVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDocumentationVersionsAsync(array $args = [])
* @method \Aws\Result getDomainName(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDomainNameAsync(array $args = [])
* @method \Aws\Result getDomainNames(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDomainNamesAsync(array $args = [])
* @method \Aws\Result getExport(array $args = [])
* @method \GuzzleHttp\Promise\Promise getExportAsync(array $args = [])
* @method \Aws\Result getGatewayResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGatewayResponseAsync(array $args = [])
* @method \Aws\Result getGatewayResponses(array $args = [])
* @method \GuzzleHttp\Promise\Promise getGatewayResponsesAsync(array $args = [])
* @method \Aws\Result getIntegration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIntegrationAsync(array $args = [])
* @method \Aws\Result getIntegrationResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIntegrationResponseAsync(array $args = [])
* @method \Aws\Result getMethod(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMethodAsync(array $args = [])
* @method \Aws\Result getMethodResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMethodResponseAsync(array $args = [])
* @method \Aws\Result getModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getModelAsync(array $args = [])
* @method \Aws\Result getModelTemplate(array $args = [])
* @method \GuzzleHttp\Promise\Promise getModelTemplateAsync(array $args = [])
* @method \Aws\Result getModels(array $args = [])
* @method \GuzzleHttp\Promise\Promise getModelsAsync(array $args = [])
* @method \Aws\Result getRequestValidator(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRequestValidatorAsync(array $args = [])
* @method \Aws\Result getRequestValidators(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRequestValidatorsAsync(array $args = [])
* @method \Aws\Result getResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise getResourceAsync(array $args = [])
* @method \Aws\Result getResources(array $args = [])
* @method \GuzzleHttp\Promise\Promise getResourcesAsync(array $args = [])
* @method \Aws\Result getRestApi(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRestApiAsync(array $args = [])
* @method \Aws\Result getRestApis(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRestApisAsync(array $args = [])
* @method \Aws\Result getSdk(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSdkAsync(array $args = [])
* @method \Aws\Result getSdkType(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSdkTypeAsync(array $args = [])
* @method \Aws\Result getSdkTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise getSdkTypesAsync(array $args = [])
* @method \Aws\Result getStage(array $args = [])
* @method \GuzzleHttp\Promise\Promise getStageAsync(array $args = [])
* @method \Aws\Result getStages(array $args = [])
* @method \GuzzleHttp\Promise\Promise getStagesAsync(array $args = [])
* @method \Aws\Result getTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise getTagsAsync(array $args = [])
* @method \Aws\Result getUsage(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUsageAsync(array $args = [])
* @method \Aws\Result getUsagePlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUsagePlanAsync(array $args = [])
* @method \Aws\Result getUsagePlanKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUsagePlanKeyAsync(array $args = [])
* @method \Aws\Result getUsagePlanKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUsagePlanKeysAsync(array $args = [])
* @method \Aws\Result getUsagePlans(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUsagePlansAsync(array $args = [])
* @method \Aws\Result getVpcLink(array $args = [])
* @method \GuzzleHttp\Promise\Promise getVpcLinkAsync(array $args = [])
* @method \Aws\Result getVpcLinks(array $args = [])
* @method \GuzzleHttp\Promise\Promise getVpcLinksAsync(array $args = [])
* @method \Aws\Result importApiKeys(array $args = [])
* @method \GuzzleHttp\Promise\Promise importApiKeysAsync(array $args = [])
* @method \Aws\Result importDocumentationParts(array $args = [])
* @method \GuzzleHttp\Promise\Promise importDocumentationPartsAsync(array $args = [])
* @method \Aws\Result importRestApi(array $args = [])
* @method \GuzzleHttp\Promise\Promise importRestApiAsync(array $args = [])
* @method \Aws\Result putGatewayResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise putGatewayResponseAsync(array $args = [])
* @method \Aws\Result putIntegration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putIntegrationAsync(array $args = [])
* @method \Aws\Result putIntegrationResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise putIntegrationResponseAsync(array $args = [])
* @method \Aws\Result putMethod(array $args = [])
* @method \GuzzleHttp\Promise\Promise putMethodAsync(array $args = [])
* @method \Aws\Result putMethodResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise putMethodResponseAsync(array $args = [])
* @method \Aws\Result putRestApi(array $args = [])
* @method \GuzzleHttp\Promise\Promise putRestApiAsync(array $args = [])
* @method \Aws\Result tagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise tagResourceAsync(array $args = [])
* @method \Aws\Result testInvokeAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise testInvokeAuthorizerAsync(array $args = [])
* @method \Aws\Result testInvokeMethod(array $args = [])
* @method \GuzzleHttp\Promise\Promise testInvokeMethodAsync(array $args = [])
* @method \Aws\Result untagResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise untagResourceAsync(array $args = [])
* @method \Aws\Result updateAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAccountAsync(array $args = [])
* @method \Aws\Result updateApiKey(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateApiKeyAsync(array $args = [])
* @method \Aws\Result updateAuthorizer(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateAuthorizerAsync(array $args = [])
* @method \Aws\Result updateBasePathMapping(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateBasePathMappingAsync(array $args = [])
* @method \Aws\Result updateClientCertificate(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateClientCertificateAsync(array $args = [])
* @method \Aws\Result updateDeployment(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDeploymentAsync(array $args = [])
* @method \Aws\Result updateDocumentationPart(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDocumentationPartAsync(array $args = [])
* @method \Aws\Result updateDocumentationVersion(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDocumentationVersionAsync(array $args = [])
* @method \Aws\Result updateDomainName(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDomainNameAsync(array $args = [])
* @method \Aws\Result updateGatewayResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateGatewayResponseAsync(array $args = [])
* @method \Aws\Result updateIntegration(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateIntegrationAsync(array $args = [])
* @method \Aws\Result updateIntegrationResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateIntegrationResponseAsync(array $args = [])
* @method \Aws\Result updateMethod(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateMethodAsync(array $args = [])
* @method \Aws\Result updateMethodResponse(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateMethodResponseAsync(array $args = [])
* @method \Aws\Result updateModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateModelAsync(array $args = [])
* @method \Aws\Result updateRequestValidator(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRequestValidatorAsync(array $args = [])
* @method \Aws\Result updateResource(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateResourceAsync(array $args = [])
* @method \Aws\Result updateRestApi(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRestApiAsync(array $args = [])
* @method \Aws\Result updateStage(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateStageAsync(array $args = [])
* @method \Aws\Result updateUsage(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUsageAsync(array $args = [])
* @method \Aws\Result updateUsagePlan(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateUsagePlanAsync(array $args = [])
* @method \Aws\Result updateVpcLink(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateVpcLinkAsync(array $args = [])
*/
class ApiGatewayClient extends \Aws\AwsClient
{
public function __construct(array $args)
{
}
public static function _add_accept_header(callable $handler)
{
}
}
}
namespace Aws\ApiGateway\Exception {
/**
* Represents an error interacting with the **AWS API Gateway** service.
*/
class ApiGatewayException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* Loads JSON files and compiles them into PHP arrays.
*
* @internal Please use json_decode instead.
* @deprecated
*/
class JsonCompiler
{
const CACHE_ENV = 'AWS_PHP_CACHE_DIR';
/**
* Loads a JSON file from cache or from the JSON file directly.
*
* @param string $path Path to the JSON file to load.
*
* @return mixed
*/
public function load($path)
{
}
}
}
namespace Aws\Ecr {
/**
* This client is used to interact with the **Amazon EC2 Container Registry** service.
*
* @method \Aws\Result batchCheckLayerAvailability(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchCheckLayerAvailabilityAsync(array $args = [])
* @method \Aws\Result batchDeleteImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDeleteImageAsync(array $args = [])
* @method \Aws\Result batchGetImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetImageAsync(array $args = [])
* @method \Aws\Result completeLayerUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise completeLayerUploadAsync(array $args = [])
* @method \Aws\Result createRepository(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRepositoryAsync(array $args = [])
* @method \Aws\Result deleteLifecyclePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLifecyclePolicyAsync(array $args = [])
* @method \Aws\Result deleteRepository(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRepositoryAsync(array $args = [])
* @method \Aws\Result deleteRepositoryPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRepositoryPolicyAsync(array $args = [])
* @method \Aws\Result describeImages(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeImagesAsync(array $args = [])
* @method \Aws\Result describeRepositories(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRepositoriesAsync(array $args = [])
* @method \Aws\Result getAuthorizationToken(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAuthorizationTokenAsync(array $args = [])
* @method \Aws\Result getDownloadUrlForLayer(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDownloadUrlForLayerAsync(array $args = [])
* @method \Aws\Result getLifecyclePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLifecyclePolicyAsync(array $args = [])
* @method \Aws\Result getLifecyclePolicyPreview(array $args = [])
* @method \GuzzleHttp\Promise\Promise getLifecyclePolicyPreviewAsync(array $args = [])
* @method \Aws\Result getRepositoryPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise getRepositoryPolicyAsync(array $args = [])
* @method \Aws\Result initiateLayerUpload(array $args = [])
* @method \GuzzleHttp\Promise\Promise initiateLayerUploadAsync(array $args = [])
* @method \Aws\Result listImages(array $args = [])
* @method \GuzzleHttp\Promise\Promise listImagesAsync(array $args = [])
* @method \Aws\Result putImage(array $args = [])
* @method \GuzzleHttp\Promise\Promise putImageAsync(array $args = [])
* @method \Aws\Result putLifecyclePolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise putLifecyclePolicyAsync(array $args = [])
* @method \Aws\Result setRepositoryPolicy(array $args = [])
* @method \GuzzleHttp\Promise\Promise setRepositoryPolicyAsync(array $args = [])
* @method \Aws\Result startLifecyclePolicyPreview(array $args = [])
* @method \GuzzleHttp\Promise\Promise startLifecyclePolicyPreviewAsync(array $args = [])
* @method \Aws\Result uploadLayerPart(array $args = [])
* @method \GuzzleHttp\Promise\Promise uploadLayerPartAsync(array $args = [])
*/
class EcrClient extends \Aws\AwsClient
{
}
}
namespace Aws\Ecr\Exception {
/**
* Represents an error interacting with the **Amazon EC2 Container Registry** service.
*/
class EcrException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\GuardDuty {
/**
* This client is used to interact with the **Amazon GuardDuty** service.
* @method \Aws\Result acceptInvitation(array $args = [])
* @method \GuzzleHttp\Promise\Promise acceptInvitationAsync(array $args = [])
* @method \Aws\Result archiveFindings(array $args = [])
* @method \GuzzleHttp\Promise\Promise archiveFindingsAsync(array $args = [])
* @method \Aws\Result createDetector(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDetectorAsync(array $args = [])
* @method \Aws\Result createFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise createFilterAsync(array $args = [])
* @method \Aws\Result createIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createIPSetAsync(array $args = [])
* @method \Aws\Result createMembers(array $args = [])
* @method \GuzzleHttp\Promise\Promise createMembersAsync(array $args = [])
* @method \Aws\Result createSampleFindings(array $args = [])
* @method \GuzzleHttp\Promise\Promise createSampleFindingsAsync(array $args = [])
* @method \Aws\Result createThreatIntelSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise createThreatIntelSetAsync(array $args = [])
* @method \Aws\Result declineInvitations(array $args = [])
* @method \GuzzleHttp\Promise\Promise declineInvitationsAsync(array $args = [])
* @method \Aws\Result deleteDetector(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDetectorAsync(array $args = [])
* @method \Aws\Result deleteFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteFilterAsync(array $args = [])
* @method \Aws\Result deleteIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIPSetAsync(array $args = [])
* @method \Aws\Result deleteInvitations(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteInvitationsAsync(array $args = [])
* @method \Aws\Result deleteMembers(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMembersAsync(array $args = [])
* @method \Aws\Result deleteThreatIntelSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteThreatIntelSetAsync(array $args = [])
* @method \Aws\Result disassociateFromMasterAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateFromMasterAccountAsync(array $args = [])
* @method \Aws\Result disassociateMembers(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateMembersAsync(array $args = [])
* @method \Aws\Result getDetector(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDetectorAsync(array $args = [])
* @method \Aws\Result getFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFilterAsync(array $args = [])
* @method \Aws\Result getFindings(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFindingsAsync(array $args = [])
* @method \Aws\Result getFindingsStatistics(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFindingsStatisticsAsync(array $args = [])
* @method \Aws\Result getIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIPSetAsync(array $args = [])
* @method \Aws\Result getInvitationsCount(array $args = [])
* @method \GuzzleHttp\Promise\Promise getInvitationsCountAsync(array $args = [])
* @method \Aws\Result getMasterAccount(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMasterAccountAsync(array $args = [])
* @method \Aws\Result getMembers(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMembersAsync(array $args = [])
* @method \Aws\Result getThreatIntelSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise getThreatIntelSetAsync(array $args = [])
* @method \Aws\Result inviteMembers(array $args = [])
* @method \GuzzleHttp\Promise\Promise inviteMembersAsync(array $args = [])
* @method \Aws\Result listDetectors(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDetectorsAsync(array $args = [])
* @method \Aws\Result listFilters(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFiltersAsync(array $args = [])
* @method \Aws\Result listFindings(array $args = [])
* @method \GuzzleHttp\Promise\Promise listFindingsAsync(array $args = [])
* @method \Aws\Result listIPSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIPSetsAsync(array $args = [])
* @method \Aws\Result listInvitations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listInvitationsAsync(array $args = [])
* @method \Aws\Result listMembers(array $args = [])
* @method \GuzzleHttp\Promise\Promise listMembersAsync(array $args = [])
* @method \Aws\Result listThreatIntelSets(array $args = [])
* @method \GuzzleHttp\Promise\Promise listThreatIntelSetsAsync(array $args = [])
* @method \Aws\Result startMonitoringMembers(array $args = [])
* @method \GuzzleHttp\Promise\Promise startMonitoringMembersAsync(array $args = [])
* @method \Aws\Result stopMonitoringMembers(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopMonitoringMembersAsync(array $args = [])
* @method \Aws\Result unarchiveFindings(array $args = [])
* @method \GuzzleHttp\Promise\Promise unarchiveFindingsAsync(array $args = [])
* @method \Aws\Result updateDetector(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDetectorAsync(array $args = [])
* @method \Aws\Result updateFilter(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFilterAsync(array $args = [])
* @method \Aws\Result updateFindingsFeedback(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateFindingsFeedbackAsync(array $args = [])
* @method \Aws\Result updateIPSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateIPSetAsync(array $args = [])
* @method \Aws\Result updateThreatIntelSet(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateThreatIntelSetAsync(array $args = [])
*/
class GuardDutyClient extends \Aws\AwsClient
{
}
}
namespace Aws\GuardDuty\Exception {
/**
* Represents an error interacting with the **Amazon GuardDuty** service.
*/
class GuardDutyException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\WorkSpaces\Exception {
/**
* Represents an error while interacting with Amazon WorkSpaces.
*/
class WorkSpacesException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\WorkSpaces {
/**
* Amazon WorkSpaces client.
*
* @method \Aws\Result associateIpGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateIpGroupsAsync(array $args = [])
* @method \Aws\Result authorizeIpRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise authorizeIpRulesAsync(array $args = [])
* @method \Aws\Result createIpGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createIpGroupAsync(array $args = [])
* @method \Aws\Result createTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTagsAsync(array $args = [])
* @method \Aws\Result createWorkspaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise createWorkspacesAsync(array $args = [])
* @method \Aws\Result deleteIpGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIpGroupAsync(array $args = [])
* @method \Aws\Result deleteTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTagsAsync(array $args = [])
* @method \Aws\Result describeIpGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeIpGroupsAsync(array $args = [])
* @method \Aws\Result describeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagsAsync(array $args = [])
* @method \Aws\Result describeWorkspaceBundles(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeWorkspaceBundlesAsync(array $args = [])
* @method \Aws\Result describeWorkspaceDirectories(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeWorkspaceDirectoriesAsync(array $args = [])
* @method \Aws\Result describeWorkspaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeWorkspacesAsync(array $args = [])
* @method \Aws\Result describeWorkspacesConnectionStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeWorkspacesConnectionStatusAsync(array $args = [])
* @method \Aws\Result disassociateIpGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateIpGroupsAsync(array $args = [])
* @method \Aws\Result modifyWorkspaceProperties(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyWorkspacePropertiesAsync(array $args = [])
* @method \Aws\Result modifyWorkspaceState(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyWorkspaceStateAsync(array $args = [])
* @method \Aws\Result rebootWorkspaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebootWorkspacesAsync(array $args = [])
* @method \Aws\Result rebuildWorkspaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise rebuildWorkspacesAsync(array $args = [])
* @method \Aws\Result revokeIpRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise revokeIpRulesAsync(array $args = [])
* @method \Aws\Result startWorkspaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise startWorkspacesAsync(array $args = [])
* @method \Aws\Result stopWorkspaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopWorkspacesAsync(array $args = [])
* @method \Aws\Result terminateWorkspaces(array $args = [])
* @method \GuzzleHttp\Promise\Promise terminateWorkspacesAsync(array $args = [])
* @method \Aws\Result updateRulesOfIpGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateRulesOfIpGroupAsync(array $args = [])
*/
class WorkSpacesClient extends \Aws\AwsClient
{
}
}
namespace Aws {
/**
* AWS result.
*/
class Result implements \Aws\ResultInterface, \Aws\MonitoringEventsInterface
{
use \Aws\HasDataTrait;
use \Aws\HasMonitoringEventsTrait;
public function __construct(array $data = [])
{
}
public function hasKey($name)
{
}
public function get($key)
{
}
public function search($expression)
{
}
public function __toString()
{
}
/**
* @deprecated
*/
public function getPath($path)
{
}
}
}
namespace Aws\Crypto {
abstract class MaterialsProvider
{
/**
* Returns if the requested size is supported by AES.
*
* @param int $keySize Size of the requested key in bits.
*
* @return bool
*/
public static function isSupportedKeySize($keySize)
{
}
/**
* Performs further initialization of the MaterialsProvider based on the
* data inside the MetadataEnvelope.
*
* @param MetadataEnvelope $envelope A storage envelope for encryption
* metadata to be read from.
*
* @return MaterialsProvider
*
* @throws \RuntimeException Thrown when there is an empty or improperly
* formed materials description in the envelope.
*
* @internal
*/
public abstract function fromDecryptionEnvelope(\Aws\Crypto\MetadataEnvelope $envelope);
/**
* Returns the material description for this Provider so it can be verified
* by encryption mechanisms.
*
* @return string
*/
public abstract function getMaterialsDescription();
/**
* Returns the wrap algorithm name for this Provider.
*
* @return string
*/
public abstract function getWrapAlgorithmName();
/**
* Takes a content encryption key (CEK) and description to return an
* encrypted key according to the Provider's specifications.
*
* @param string $unencryptedCek Key for use in encrypting other data
* that itself needs to be encrypted by the
* Provider.
* @param string $materialDescription Material Description for use in
* encrypting the $cek.
*
* @return string
*/
public abstract function encryptCek($unencryptedCek, $materialDescription);
/**
* Takes an encrypted content encryption key (CEK) and material description
* for use decrypting the key according to the Provider's specifications.
*
* @param string $encryptedCek Encrypted key to be decrypted by the Provider
* for use decrypting other data.
* @param string $materialDescription Material Description for use in
* encrypting the $cek.
*
* @return string
*/
public abstract function decryptCek($encryptedCek, $materialDescription);
/**
* @param string $keySize Length of a cipher key in bits for generating a
* random content encryption key (CEK).
*
* @return string
*/
public function generateCek($keySize)
{
}
/**
* @param string $openSslName Cipher OpenSSL name to use for generating
* an initialization vector.
*
* @return string
*/
public function generateIv($openSslName)
{
}
}
interface AesStreamInterface extends \Psr\Http\Message\StreamInterface
{
/**
* Returns an identifier recognizable by `openssl_*` functions, such as
* `aes-256-cbc` or `aes-128-ctr`.
*
* @return string
*/
public function getOpenSslName();
/**
* Returns an AES recognizable name, such as 'AES/GCM/NoPadding'.
*
* @return string
*/
public function getAesName();
/**
* Returns the IV that should be used to initialize the next block in
* encrypt or decrypt.
*
* @return string
*/
public function getCurrentIv();
}
/**
* @internal Represents a stream of data to be encrypted with a passed cipher.
*/
class AesEncryptingStream implements \Aws\Crypto\AesStreamInterface
{
const BLOCK_SIZE = 16;
// 128 bits
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
/**
* @param StreamInterface $plainText
* @param string $key
* @param CipherMethod $cipherMethod
*/
public function __construct(\Psr\Http\Message\StreamInterface $plainText, $key, \Aws\Crypto\Cipher\CipherMethod $cipherMethod)
{
}
public function getOpenSslName()
{
}
public function getAesName()
{
}
public function getCurrentIv()
{
}
public function getSize()
{
}
public function isWritable()
{
}
public function read($length)
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
}
/**
* Uses KMS to supply materials for encrypting and decrypting data.
*/
class KmsMaterialsProvider extends \Aws\Crypto\MaterialsProvider
{
/**
* @param KmsClient $kmsClient A KMS Client for use encrypting and
* decrypting keys.
* @param string $kmsKeyId The private KMS key id to be used for encrypting
* and decrypting keys.
*/
public function __construct(\Aws\Kms\KmsClient $kmsClient, $kmsKeyId = null)
{
}
public function fromDecryptionEnvelope(\Aws\Crypto\MetadataEnvelope $envelope)
{
}
/**
* The KMS key id for use in matching this Provider to its keys,
* consistently with other SDKs as 'kms_cmk_id'.
*
* @return array
*/
public function getMaterialsDescription()
{
}
public function getWrapAlgorithmName()
{
}
/**
* Takes a content encryption key (CEK) and description to return an encrypted
* key by using KMS' Encrypt API.
*
* @param string $unencryptedCek Key for use in encrypting other data
* that itself needs to be encrypted by the
* Provider.
* @param string $materialDescription Material Description for use in
* encrypting the $cek.
*
* @return string
*/
public function encryptCek($unencryptedCek, $materialDescription)
{
}
/**
* Takes an encrypted content encryption key (CEK) and material description
* for use decrypting the key by using KMS' Decrypt API.
*
* @param string $encryptedCek Encrypted key to be decrypted by the Provider
* for use decrypting other data.
* @param string $materialDescription Material Description for use in
* encrypting the $cek.
*
* @return string
*/
public function decryptCek($encryptedCek, $materialDescription)
{
}
}
}
namespace Aws\Crypto\Cipher {
interface CipherMethod
{
/**
* Returns an identifier recognizable by `openssl_*` functions, such as
* `aes-256-cbc` or `aes-128-ctr`.
*
* @return string
*/
public function getOpenSslName();
/**
* Returns an AES recognizable name, such as 'AES/GCM/NoPadding'.
*
* @return string
*/
public function getAesName();
/**
* Returns the IV that should be used to initialize the next block in
* encrypt or decrypt.
*
* @return string
*/
public function getCurrentIv();
/**
* Indicates whether the cipher method used with this IV requires padding
* the final block to make sure the plaintext is evenly divisible by the
* block size.
*
* @return boolean
*/
public function requiresPadding();
/**
* Adjust the return of this::getCurrentIv to reflect a seek performed on
* the encryption stream using this IV object.
*
* @param int $offset
* @param int $whence
*
* @throws LogicException Thrown if the requested seek is not supported by
* this IV implementation. For example, a CBC IV
* only supports a full rewind ($offset === 0 &&
* $whence === SEEK_SET)
*/
public function seek($offset, $whence = SEEK_SET);
/**
* Take account of the last cipher text block to adjust the return of
* this::getCurrentIv
*
* @param string $cipherTextBlock
*/
public function update($cipherTextBlock);
}
/**
* An implementation of the CBC cipher for use with an AesEncryptingStream or
* AesDecrypting stream.
*/
class Cbc implements \Aws\Crypto\Cipher\CipherMethod
{
const BLOCK_SIZE = 16;
/**
* @param string $iv Base Initialization Vector for the cipher.
* @param int $keySize Size of the encryption key, in bits, that will be
* used.
*
* @throws InvalidArgumentException Thrown if the passed iv does not match
* the iv length required by the cipher.
*/
public function __construct($iv, $keySize = 256)
{
}
public function getOpenSslName()
{
}
public function getAesName()
{
}
public function getCurrentIv()
{
}
public function requiresPadding()
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
public function update($cipherTextBlock)
{
}
}
}
namespace Aws\Crypto {
/**
* @internal Represents a stream of data to be decrypted with passed cipher.
*/
class AesDecryptingStream implements \Aws\Crypto\AesStreamInterface
{
const BLOCK_SIZE = 16;
// 128 bits
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
/**
* @param StreamInterface $cipherText
* @param string $key
* @param CipherMethod $cipherMethod
*/
public function __construct(\Psr\Http\Message\StreamInterface $cipherText, $key, \Aws\Crypto\Cipher\CipherMethod $cipherMethod)
{
}
public function getOpenSslName()
{
}
public function getAesName()
{
}
public function getCurrentIv()
{
}
public function getSize()
{
}
public function isWritable()
{
}
public function read($length)
{
}
public function seek($offset, $whence = SEEK_SET)
{
}
}
/**
* Stores encryption metadata for reading and writing.
*
* @internal
*/
class MetadataEnvelope implements \ArrayAccess, \IteratorAggregate, \JsonSerializable
{
use \Aws\HasDataTrait;
const CONTENT_KEY_V2_HEADER = 'x-amz-key-v2';
const IV_HEADER = 'x-amz-iv';
const MATERIALS_DESCRIPTION_HEADER = 'x-amz-matdesc';
const KEY_WRAP_ALGORITHM_HEADER = 'x-amz-wrap-alg';
const CONTENT_CRYPTO_SCHEME_HEADER = 'x-amz-cek-alg';
const CRYPTO_TAG_LENGTH_HEADER = 'x-amz-tag-len';
const UNENCRYPTED_CONTENT_MD5_HEADER = 'x-amz-unencrypted-content-md5';
const UNENCRYPTED_CONTENT_LENGTH_HEADER = 'x-amz-unencrypted-content-length';
public static function getConstantValues()
{
}
public function offsetSet($name, $value)
{
}
public function jsonSerialize()
{
}
}
/**
* @internal Represents a stream of data to be gcm encrypted.
*/
class AesGcmEncryptingStream implements \Aws\Crypto\AesStreamInterface
{
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
/**
* @param StreamInterface $plaintext
* @param string $key
* @param string $initializationVector
* @param string $aad
* @param int $tagLength
* @param int $keySize
*/
public function __construct(\Psr\Http\Message\StreamInterface $plaintext, $key, $initializationVector, $aad = '', $tagLength = 16, $keySize = 256)
{
}
public function getOpenSslName()
{
}
public function getAesName()
{
}
public function getCurrentIv()
{
}
public function createStream()
{
}
/**
* @return string
*/
public function getTag()
{
}
public function isWritable()
{
}
}
/**
* @internal Represents a stream of data to be gcm decrypted.
*/
class AesGcmDecryptingStream implements \Aws\Crypto\AesStreamInterface
{
use \GuzzleHttp\Psr7\StreamDecoratorTrait;
/**
* @param StreamInterface $cipherText
* @param string $key
* @param string $initializationVector
* @param string $tag
* @param string $aad
* @param int $tagLength
* @param int $keySize
*/
public function __construct(\Psr\Http\Message\StreamInterface $cipherText, $key, $initializationVector, $tag, $aad = '', $tagLength = 128, $keySize = 256)
{
}
public function getOpenSslName()
{
}
public function getAesName()
{
}
public function getCurrentIv()
{
}
public function createStream()
{
}
public function isWritable()
{
}
}
}
namespace Aws\IotDataPlane {
/**
* This client is used to interact with the **AWS IoT Data Plane** service.
*
* @method \Aws\Result deleteThingShadow(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteThingShadowAsync(array $args = [])
* @method \Aws\Result getThingShadow(array $args = [])
* @method \GuzzleHttp\Promise\Promise getThingShadowAsync(array $args = [])
* @method \Aws\Result publish(array $args = [])
* @method \GuzzleHttp\Promise\Promise publishAsync(array $args = [])
* @method \Aws\Result updateThingShadow(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateThingShadowAsync(array $args = [])
*/
class IotDataPlaneClient extends \Aws\AwsClient
{
}
}
namespace Aws\IotDataPlane\Exception {
/**
* Represents an error interacting with the **AWS IoT Data Plane** service.
*/
class IotDataPlaneException extends \Aws\Exception\AwsException
{
}
}
namespace Aws {
/**
* Sends and iterator of commands concurrently using a capped pool size.
*
* The pool will read command objects from an iterator until it is cancelled or
* until the iterator is consumed.
*/
class CommandPool implements \GuzzleHttp\Promise\PromisorInterface
{
/**
* The CommandPool constructor accepts a hash of configuration options:
*
* - concurrency: (callable|int) Maximum number of commands to execute
* concurrently. Provide a function to resize the pool dynamically. The
* function will be provided the current number of pending requests and
* is expected to return an integer representing the new pool size limit.
* - before: (callable) function to invoke before sending each command. The
* before function accepts the command and the key of the iterator of the
* command. You can mutate the command as needed in the before function
* before sending the command.
* - fulfilled: (callable) Function to invoke when a promise is fulfilled.
* The function is provided the result object, id of the iterator that the
* result came from, and the aggregate promise that can be resolved/rejected
* if you need to short-circuit the pool.
* - rejected: (callable) Function to invoke when a promise is rejected.
* The function is provided an AwsException object, id of the iterator that
* the exception came from, and the aggregate promise that can be
* resolved/rejected if you need to short-circuit the pool.
* - preserve_iterator_keys: (bool) Retain the iterator key when generating
* the commands.
*
* @param AwsClientInterface $client Client used to execute commands.
* @param array|\Iterator $commands Iterable that yields commands.
* @param array $config Associative array of options.
*/
public function __construct(\Aws\AwsClientInterface $client, $commands, array $config = [])
{
}
/**
* @return \GuzzleHttp\Promise\PromiseInterface
*/
public function promise()
{
}
/**
* Executes a pool synchronously and aggregates the results of the pool
* into an indexed array in the same order as the passed in array.
*
* @param AwsClientInterface $client Client used to execute commands.
* @param mixed $commands Iterable that yields commands.
* @param array $config Configuration options.
*
* @return array
* @see \Aws\CommandPool::__construct for available configuration options.
*/
public static function batch(\Aws\AwsClientInterface $client, $commands, array $config = [])
{
}
}
}
namespace Aws\MediaTailor\Exception {
/**
* Represents an error interacting with the **AWS MediaTailor** service.
*/
class MediaTailorException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\MediaTailor {
/**
* This client is used to interact with the **AWS MediaTailor** service.
* @method \Aws\Result deletePlaybackConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise deletePlaybackConfigurationAsync(array $args = [])
* @method \Aws\Result getPlaybackConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise getPlaybackConfigurationAsync(array $args = [])
* @method \Aws\Result listPlaybackConfigurations(array $args = [])
* @method \GuzzleHttp\Promise\Promise listPlaybackConfigurationsAsync(array $args = [])
* @method \Aws\Result putPlaybackConfiguration(array $args = [])
* @method \GuzzleHttp\Promise\Promise putPlaybackConfigurationAsync(array $args = [])
*/
class MediaTailorClient extends \Aws\AwsClient
{
}
}
namespace Aws\CodeBuild {
/**
* This client is used to interact with the **AWS CodeBuild** service.
* @method \Aws\Result batchDeleteBuilds(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchDeleteBuildsAsync(array $args = [])
* @method \Aws\Result batchGetBuilds(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetBuildsAsync(array $args = [])
* @method \Aws\Result batchGetProjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise batchGetProjectsAsync(array $args = [])
* @method \Aws\Result createProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise createProjectAsync(array $args = [])
* @method \Aws\Result createWebhook(array $args = [])
* @method \GuzzleHttp\Promise\Promise createWebhookAsync(array $args = [])
* @method \Aws\Result deleteProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteProjectAsync(array $args = [])
* @method \Aws\Result deleteWebhook(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteWebhookAsync(array $args = [])
* @method \Aws\Result invalidateProjectCache(array $args = [])
* @method \GuzzleHttp\Promise\Promise invalidateProjectCacheAsync(array $args = [])
* @method \Aws\Result listBuilds(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBuildsAsync(array $args = [])
* @method \Aws\Result listBuildsForProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBuildsForProjectAsync(array $args = [])
* @method \Aws\Result listCuratedEnvironmentImages(array $args = [])
* @method \GuzzleHttp\Promise\Promise listCuratedEnvironmentImagesAsync(array $args = [])
* @method \Aws\Result listProjects(array $args = [])
* @method \GuzzleHttp\Promise\Promise listProjectsAsync(array $args = [])
* @method \Aws\Result startBuild(array $args = [])
* @method \GuzzleHttp\Promise\Promise startBuildAsync(array $args = [])
* @method \Aws\Result stopBuild(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopBuildAsync(array $args = [])
* @method \Aws\Result updateProject(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateProjectAsync(array $args = [])
* @method \Aws\Result updateWebhook(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateWebhookAsync(array $args = [])
*/
class CodeBuildClient extends \Aws\AwsClient
{
}
}
namespace Aws\CodeBuild\Exception {
/**
* Represents an error interacting with the **AWS CodeBuild** service.
*/
class CodeBuildException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\CognitoIdentity {
class CognitoIdentityProvider
{
public function __construct($poolId, array $clientOptions, array $logins = [], $accountId = null)
{
}
public function __invoke()
{
}
public function updateLogin($key, $value)
{
}
}
/**
* This client is used to interact with the **Amazon Cognito Identity** service.
*
* @method \Aws\Result createIdentityPool(array $args = [])
* @method \GuzzleHttp\Promise\Promise createIdentityPoolAsync(array $args = [])
* @method \Aws\Result deleteIdentities(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIdentitiesAsync(array $args = [])
* @method \Aws\Result deleteIdentityPool(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteIdentityPoolAsync(array $args = [])
* @method \Aws\Result describeIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeIdentityAsync(array $args = [])
* @method \Aws\Result describeIdentityPool(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeIdentityPoolAsync(array $args = [])
* @method \Aws\Result getCredentialsForIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCredentialsForIdentityAsync(array $args = [])
* @method \Aws\Result getId(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIdAsync(array $args = [])
* @method \Aws\Result getIdentityPoolRoles(array $args = [])
* @method \GuzzleHttp\Promise\Promise getIdentityPoolRolesAsync(array $args = [])
* @method \Aws\Result getOpenIdToken(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOpenIdTokenAsync(array $args = [])
* @method \Aws\Result getOpenIdTokenForDeveloperIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise getOpenIdTokenForDeveloperIdentityAsync(array $args = [])
* @method \Aws\Result listIdentities(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIdentitiesAsync(array $args = [])
* @method \Aws\Result listIdentityPools(array $args = [])
* @method \GuzzleHttp\Promise\Promise listIdentityPoolsAsync(array $args = [])
* @method \Aws\Result lookupDeveloperIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise lookupDeveloperIdentityAsync(array $args = [])
* @method \Aws\Result mergeDeveloperIdentities(array $args = [])
* @method \GuzzleHttp\Promise\Promise mergeDeveloperIdentitiesAsync(array $args = [])
* @method \Aws\Result setIdentityPoolRoles(array $args = [])
* @method \GuzzleHttp\Promise\Promise setIdentityPoolRolesAsync(array $args = [])
* @method \Aws\Result unlinkDeveloperIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise unlinkDeveloperIdentityAsync(array $args = [])
* @method \Aws\Result unlinkIdentity(array $args = [])
* @method \GuzzleHttp\Promise\Promise unlinkIdentityAsync(array $args = [])
* @method \Aws\Result updateIdentityPool(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateIdentityPoolAsync(array $args = [])
*/
class CognitoIdentityClient extends \Aws\AwsClient
{
}
}
namespace Aws\CognitoIdentity\Exception {
/**
* Represents an error interacting with the Amazon Cognito Identity Logs service.
*/
class CognitoIdentityException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ElasticLoadBalancingV2 {
/**
* This client is used to interact with the **Elastic Load Balancing** service.
* @method \Aws\Result addListenerCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise addListenerCertificatesAsync(array $args = [])
* @method \Aws\Result addTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsAsync(array $args = [])
* @method \Aws\Result createListener(array $args = [])
* @method \GuzzleHttp\Promise\Promise createListenerAsync(array $args = [])
* @method \Aws\Result createLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise createLoadBalancerAsync(array $args = [])
* @method \Aws\Result createRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRuleAsync(array $args = [])
* @method \Aws\Result createTargetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTargetGroupAsync(array $args = [])
* @method \Aws\Result deleteListener(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteListenerAsync(array $args = [])
* @method \Aws\Result deleteLoadBalancer(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteLoadBalancerAsync(array $args = [])
* @method \Aws\Result deleteRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRuleAsync(array $args = [])
* @method \Aws\Result deleteTargetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTargetGroupAsync(array $args = [])
* @method \Aws\Result deregisterTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise deregisterTargetsAsync(array $args = [])
* @method \Aws\Result describeAccountLimits(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeAccountLimitsAsync(array $args = [])
* @method \Aws\Result describeListenerCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeListenerCertificatesAsync(array $args = [])
* @method \Aws\Result describeListeners(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeListenersAsync(array $args = [])
* @method \Aws\Result describeLoadBalancerAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoadBalancerAttributesAsync(array $args = [])
* @method \Aws\Result describeLoadBalancers(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeLoadBalancersAsync(array $args = [])
* @method \Aws\Result describeRules(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeRulesAsync(array $args = [])
* @method \Aws\Result describeSSLPolicies(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeSSLPoliciesAsync(array $args = [])
* @method \Aws\Result describeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagsAsync(array $args = [])
* @method \Aws\Result describeTargetGroupAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTargetGroupAttributesAsync(array $args = [])
* @method \Aws\Result describeTargetGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTargetGroupsAsync(array $args = [])
* @method \Aws\Result describeTargetHealth(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTargetHealthAsync(array $args = [])
* @method \Aws\Result modifyListener(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyListenerAsync(array $args = [])
* @method \Aws\Result modifyLoadBalancerAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyLoadBalancerAttributesAsync(array $args = [])
* @method \Aws\Result modifyRule(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyRuleAsync(array $args = [])
* @method \Aws\Result modifyTargetGroup(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyTargetGroupAsync(array $args = [])
* @method \Aws\Result modifyTargetGroupAttributes(array $args = [])
* @method \GuzzleHttp\Promise\Promise modifyTargetGroupAttributesAsync(array $args = [])
* @method \Aws\Result registerTargets(array $args = [])
* @method \GuzzleHttp\Promise\Promise registerTargetsAsync(array $args = [])
* @method \Aws\Result removeListenerCertificates(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeListenerCertificatesAsync(array $args = [])
* @method \Aws\Result removeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsAsync(array $args = [])
* @method \Aws\Result setIpAddressType(array $args = [])
* @method \GuzzleHttp\Promise\Promise setIpAddressTypeAsync(array $args = [])
* @method \Aws\Result setRulePriorities(array $args = [])
* @method \GuzzleHttp\Promise\Promise setRulePrioritiesAsync(array $args = [])
* @method \Aws\Result setSecurityGroups(array $args = [])
* @method \GuzzleHttp\Promise\Promise setSecurityGroupsAsync(array $args = [])
* @method \Aws\Result setSubnets(array $args = [])
* @method \GuzzleHttp\Promise\Promise setSubnetsAsync(array $args = [])
*/
class ElasticLoadBalancingV2Client extends \Aws\AwsClient
{
}
}
namespace Aws\ElasticLoadBalancingV2\Exception {
/**
* Represents an error interacting with the **Elastic Load Balancing** service.
*/
class ElasticLoadBalancingV2Exception extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ElasticsearchService\Exception {
/**
* Represents an error interacting with the **Amazon Elasticsearch Service** service.
*/
class ElasticsearchServiceException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\ElasticsearchService {
/**
* This client is used to interact with the **Amazon Elasticsearch Service** service.
*
* @method \Aws\Result addTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsAsync(array $args = [])
* @method \Aws\Result createElasticsearchDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise createElasticsearchDomainAsync(array $args = [])
* @method \Aws\Result deleteElasticsearchDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteElasticsearchDomainAsync(array $args = [])
* @method \Aws\Result deleteElasticsearchServiceRole(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteElasticsearchServiceRoleAsync(array $args = [])
* @method \Aws\Result describeElasticsearchDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeElasticsearchDomainAsync(array $args = [])
* @method \Aws\Result describeElasticsearchDomainConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeElasticsearchDomainConfigAsync(array $args = [])
* @method \Aws\Result describeElasticsearchDomains(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeElasticsearchDomainsAsync(array $args = [])
* @method \Aws\Result describeElasticsearchInstanceTypeLimits(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeElasticsearchInstanceTypeLimitsAsync(array $args = [])
* @method \Aws\Result describeReservedElasticsearchInstanceOfferings(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedElasticsearchInstanceOfferingsAsync(array $args = [])
* @method \Aws\Result describeReservedElasticsearchInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeReservedElasticsearchInstancesAsync(array $args = [])
* @method \Aws\Result getCompatibleElasticsearchVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise getCompatibleElasticsearchVersionsAsync(array $args = [])
* @method \Aws\Result getUpgradeHistory(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUpgradeHistoryAsync(array $args = [])
* @method \Aws\Result getUpgradeStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise getUpgradeStatusAsync(array $args = [])
* @method \Aws\Result listDomainNames(array $args = [])
* @method \GuzzleHttp\Promise\Promise listDomainNamesAsync(array $args = [])
* @method \Aws\Result listElasticsearchInstanceTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listElasticsearchInstanceTypesAsync(array $args = [])
* @method \Aws\Result listElasticsearchVersions(array $args = [])
* @method \GuzzleHttp\Promise\Promise listElasticsearchVersionsAsync(array $args = [])
* @method \Aws\Result listTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsAsync(array $args = [])
* @method \Aws\Result purchaseReservedElasticsearchInstanceOffering(array $args = [])
* @method \GuzzleHttp\Promise\Promise purchaseReservedElasticsearchInstanceOfferingAsync(array $args = [])
* @method \Aws\Result removeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise removeTagsAsync(array $args = [])
* @method \Aws\Result updateElasticsearchDomainConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateElasticsearchDomainConfigAsync(array $args = [])
* @method \Aws\Result upgradeElasticsearchDomain(array $args = [])
* @method \GuzzleHttp\Promise\Promise upgradeElasticsearchDomainAsync(array $args = [])
*/
class ElasticsearchServiceClient extends \Aws\AwsClient
{
}
}
namespace Aws\MachineLearning {
/**
* Amazon Machine Learning client.
*
* @method \Aws\Result addTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsAsync(array $args = [])
* @method \Aws\Result createBatchPrediction(array $args = [])
* @method \GuzzleHttp\Promise\Promise createBatchPredictionAsync(array $args = [])
* @method \Aws\Result createDataSourceFromRDS(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDataSourceFromRDSAsync(array $args = [])
* @method \Aws\Result createDataSourceFromRedshift(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDataSourceFromRedshiftAsync(array $args = [])
* @method \Aws\Result createDataSourceFromS3(array $args = [])
* @method \GuzzleHttp\Promise\Promise createDataSourceFromS3Async(array $args = [])
* @method \Aws\Result createEvaluation(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEvaluationAsync(array $args = [])
* @method \Aws\Result createMLModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise createMLModelAsync(array $args = [])
* @method \Aws\Result createRealtimeEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise createRealtimeEndpointAsync(array $args = [])
* @method \Aws\Result deleteBatchPrediction(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteBatchPredictionAsync(array $args = [])
* @method \Aws\Result deleteDataSource(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteDataSourceAsync(array $args = [])
* @method \Aws\Result deleteEvaluation(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEvaluationAsync(array $args = [])
* @method \Aws\Result deleteMLModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteMLModelAsync(array $args = [])
* @method \Aws\Result deleteRealtimeEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteRealtimeEndpointAsync(array $args = [])
* @method \Aws\Result deleteTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTagsAsync(array $args = [])
* @method \Aws\Result describeBatchPredictions(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeBatchPredictionsAsync(array $args = [])
* @method \Aws\Result describeDataSources(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeDataSourcesAsync(array $args = [])
* @method \Aws\Result describeEvaluations(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEvaluationsAsync(array $args = [])
* @method \Aws\Result describeMLModels(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeMLModelsAsync(array $args = [])
* @method \Aws\Result describeTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTagsAsync(array $args = [])
* @method \Aws\Result getBatchPrediction(array $args = [])
* @method \GuzzleHttp\Promise\Promise getBatchPredictionAsync(array $args = [])
* @method \Aws\Result getDataSource(array $args = [])
* @method \GuzzleHttp\Promise\Promise getDataSourceAsync(array $args = [])
* @method \Aws\Result getEvaluation(array $args = [])
* @method \GuzzleHttp\Promise\Promise getEvaluationAsync(array $args = [])
* @method \Aws\Result getMLModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise getMLModelAsync(array $args = [])
* @method \Aws\Result predict(array $args = [])
* @method \GuzzleHttp\Promise\Promise predictAsync(array $args = [])
* @method \Aws\Result updateBatchPrediction(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateBatchPredictionAsync(array $args = [])
* @method \Aws\Result updateDataSource(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateDataSourceAsync(array $args = [])
* @method \Aws\Result updateEvaluation(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEvaluationAsync(array $args = [])
* @method \Aws\Result updateMLModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateMLModelAsync(array $args = [])
*/
class MachineLearningClient extends \Aws\AwsClient
{
public function __construct(array $config)
{
}
}
}
namespace Aws\MachineLearning\Exception {
/**
* Amazon Machine Learning exception.
*/
class MachineLearningException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\SageMaker\Exception {
/**
* Represents an error interacting with the **Amazon SageMaker Service** service.
*/
class SageMakerException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\SageMaker {
/**
* This client is used to interact with the **Amazon SageMaker Service** service.
* @method \Aws\Result addTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise addTagsAsync(array $args = [])
* @method \Aws\Result createEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEndpointAsync(array $args = [])
* @method \Aws\Result createEndpointConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise createEndpointConfigAsync(array $args = [])
* @method \Aws\Result createHyperParameterTuningJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHyperParameterTuningJobAsync(array $args = [])
* @method \Aws\Result createModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise createModelAsync(array $args = [])
* @method \Aws\Result createNotebookInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNotebookInstanceAsync(array $args = [])
* @method \Aws\Result createNotebookInstanceLifecycleConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise createNotebookInstanceLifecycleConfigAsync(array $args = [])
* @method \Aws\Result createPresignedNotebookInstanceUrl(array $args = [])
* @method \GuzzleHttp\Promise\Promise createPresignedNotebookInstanceUrlAsync(array $args = [])
* @method \Aws\Result createTrainingJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTrainingJobAsync(array $args = [])
* @method \Aws\Result createTransformJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise createTransformJobAsync(array $args = [])
* @method \Aws\Result deleteEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEndpointAsync(array $args = [])
* @method \Aws\Result deleteEndpointConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteEndpointConfigAsync(array $args = [])
* @method \Aws\Result deleteModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteModelAsync(array $args = [])
* @method \Aws\Result deleteNotebookInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNotebookInstanceAsync(array $args = [])
* @method \Aws\Result deleteNotebookInstanceLifecycleConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteNotebookInstanceLifecycleConfigAsync(array $args = [])
* @method \Aws\Result deleteTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteTagsAsync(array $args = [])
* @method \Aws\Result describeEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEndpointAsync(array $args = [])
* @method \Aws\Result describeEndpointConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeEndpointConfigAsync(array $args = [])
* @method \Aws\Result describeHyperParameterTuningJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeHyperParameterTuningJobAsync(array $args = [])
* @method \Aws\Result describeModel(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeModelAsync(array $args = [])
* @method \Aws\Result describeNotebookInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNotebookInstanceAsync(array $args = [])
* @method \Aws\Result describeNotebookInstanceLifecycleConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeNotebookInstanceLifecycleConfigAsync(array $args = [])
* @method \Aws\Result describeTrainingJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTrainingJobAsync(array $args = [])
* @method \Aws\Result describeTransformJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise describeTransformJobAsync(array $args = [])
* @method \Aws\Result listEndpointConfigs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listEndpointConfigsAsync(array $args = [])
* @method \Aws\Result listEndpoints(array $args = [])
* @method \GuzzleHttp\Promise\Promise listEndpointsAsync(array $args = [])
* @method \Aws\Result listHyperParameterTuningJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listHyperParameterTuningJobsAsync(array $args = [])
* @method \Aws\Result listModels(array $args = [])
* @method \GuzzleHttp\Promise\Promise listModelsAsync(array $args = [])
* @method \Aws\Result listNotebookInstanceLifecycleConfigs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listNotebookInstanceLifecycleConfigsAsync(array $args = [])
* @method \Aws\Result listNotebookInstances(array $args = [])
* @method \GuzzleHttp\Promise\Promise listNotebookInstancesAsync(array $args = [])
* @method \Aws\Result listTags(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTagsAsync(array $args = [])
* @method \Aws\Result listTrainingJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTrainingJobsAsync(array $args = [])
* @method \Aws\Result listTrainingJobsForHyperParameterTuningJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTrainingJobsForHyperParameterTuningJobAsync(array $args = [])
* @method \Aws\Result listTransformJobs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listTransformJobsAsync(array $args = [])
* @method \Aws\Result startNotebookInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise startNotebookInstanceAsync(array $args = [])
* @method \Aws\Result stopHyperParameterTuningJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopHyperParameterTuningJobAsync(array $args = [])
* @method \Aws\Result stopNotebookInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopNotebookInstanceAsync(array $args = [])
* @method \Aws\Result stopTrainingJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopTrainingJobAsync(array $args = [])
* @method \Aws\Result stopTransformJob(array $args = [])
* @method \GuzzleHttp\Promise\Promise stopTransformJobAsync(array $args = [])
* @method \Aws\Result updateEndpoint(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEndpointAsync(array $args = [])
* @method \Aws\Result updateEndpointWeightsAndCapacities(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateEndpointWeightsAndCapacitiesAsync(array $args = [])
* @method \Aws\Result updateNotebookInstance(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateNotebookInstanceAsync(array $args = [])
* @method \Aws\Result updateNotebookInstanceLifecycleConfig(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateNotebookInstanceLifecycleConfigAsync(array $args = [])
*/
class SageMakerClient extends \Aws\AwsClient
{
}
}
namespace Aws\MTurk {
/**
* This client is used to interact with the **Amazon Mechanical Turk Requester Service** service.
* @method \Aws\Result acceptQualificationRequest(array $args = [])
* @method \GuzzleHttp\Promise\Promise acceptQualificationRequestAsync(array $args = [])
* @method \Aws\Result approveAssignment(array $args = [])
* @method \GuzzleHttp\Promise\Promise approveAssignmentAsync(array $args = [])
* @method \Aws\Result associateQualificationWithWorker(array $args = [])
* @method \GuzzleHttp\Promise\Promise associateQualificationWithWorkerAsync(array $args = [])
* @method \Aws\Result createAdditionalAssignmentsForHIT(array $args = [])
* @method \GuzzleHttp\Promise\Promise createAdditionalAssignmentsForHITAsync(array $args = [])
* @method \Aws\Result createHIT(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHITAsync(array $args = [])
* @method \Aws\Result createHITType(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHITTypeAsync(array $args = [])
* @method \Aws\Result createHITWithHITType(array $args = [])
* @method \GuzzleHttp\Promise\Promise createHITWithHITTypeAsync(array $args = [])
* @method \Aws\Result createQualificationType(array $args = [])
* @method \GuzzleHttp\Promise\Promise createQualificationTypeAsync(array $args = [])
* @method \Aws\Result createWorkerBlock(array $args = [])
* @method \GuzzleHttp\Promise\Promise createWorkerBlockAsync(array $args = [])
* @method \Aws\Result deleteHIT(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteHITAsync(array $args = [])
* @method \Aws\Result deleteQualificationType(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteQualificationTypeAsync(array $args = [])
* @method \Aws\Result deleteWorkerBlock(array $args = [])
* @method \GuzzleHttp\Promise\Promise deleteWorkerBlockAsync(array $args = [])
* @method \Aws\Result disassociateQualificationFromWorker(array $args = [])
* @method \GuzzleHttp\Promise\Promise disassociateQualificationFromWorkerAsync(array $args = [])
* @method \Aws\Result getAccountBalance(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAccountBalanceAsync(array $args = [])
* @method \Aws\Result getAssignment(array $args = [])
* @method \GuzzleHttp\Promise\Promise getAssignmentAsync(array $args = [])
* @method \Aws\Result getFileUploadURL(array $args = [])
* @method \GuzzleHttp\Promise\Promise getFileUploadURLAsync(array $args = [])
* @method \Aws\Result getHIT(array $args = [])
* @method \GuzzleHttp\Promise\Promise getHITAsync(array $args = [])
* @method \Aws\Result getQualificationScore(array $args = [])
* @method \GuzzleHttp\Promise\Promise getQualificationScoreAsync(array $args = [])
* @method \Aws\Result getQualificationType(array $args = [])
* @method \GuzzleHttp\Promise\Promise getQualificationTypeAsync(array $args = [])
* @method \Aws\Result listAssignmentsForHIT(array $args = [])
* @method \GuzzleHttp\Promise\Promise listAssignmentsForHITAsync(array $args = [])
* @method \Aws\Result listBonusPayments(array $args = [])
* @method \GuzzleHttp\Promise\Promise listBonusPaymentsAsync(array $args = [])
* @method \Aws\Result listHITs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listHITsAsync(array $args = [])
* @method \Aws\Result listHITsForQualificationType(array $args = [])
* @method \GuzzleHttp\Promise\Promise listHITsForQualificationTypeAsync(array $args = [])
* @method \Aws\Result listQualificationRequests(array $args = [])
* @method \GuzzleHttp\Promise\Promise listQualificationRequestsAsync(array $args = [])
* @method \Aws\Result listQualificationTypes(array $args = [])
* @method \GuzzleHttp\Promise\Promise listQualificationTypesAsync(array $args = [])
* @method \Aws\Result listReviewPolicyResultsForHIT(array $args = [])
* @method \GuzzleHttp\Promise\Promise listReviewPolicyResultsForHITAsync(array $args = [])
* @method \Aws\Result listReviewableHITs(array $args = [])
* @method \GuzzleHttp\Promise\Promise listReviewableHITsAsync(array $args = [])
* @method \Aws\Result listWorkerBlocks(array $args = [])
* @method \GuzzleHttp\Promise\Promise listWorkerBlocksAsync(array $args = [])
* @method \Aws\Result listWorkersWithQualificationType(array $args = [])
* @method \GuzzleHttp\Promise\Promise listWorkersWithQualificationTypeAsync(array $args = [])
* @method \Aws\Result notifyWorkers(array $args = [])
* @method \GuzzleHttp\Promise\Promise notifyWorkersAsync(array $args = [])
* @method \Aws\Result rejectAssignment(array $args = [])
* @method \GuzzleHttp\Promise\Promise rejectAssignmentAsync(array $args = [])
* @method \Aws\Result rejectQualificationRequest(array $args = [])
* @method \GuzzleHttp\Promise\Promise rejectQualificationRequestAsync(array $args = [])
* @method \Aws\Result sendBonus(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendBonusAsync(array $args = [])
* @method \Aws\Result sendTestEventNotification(array $args = [])
* @method \GuzzleHttp\Promise\Promise sendTestEventNotificationAsync(array $args = [])
* @method \Aws\Result updateExpirationForHIT(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateExpirationForHITAsync(array $args = [])
* @method \Aws\Result updateHITReviewStatus(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateHITReviewStatusAsync(array $args = [])
* @method \Aws\Result updateHITTypeOfHIT(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateHITTypeOfHITAsync(array $args = [])
* @method \Aws\Result updateNotificationSettings(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateNotificationSettingsAsync(array $args = [])
* @method \Aws\Result updateQualificationType(array $args = [])
* @method \GuzzleHttp\Promise\Promise updateQualificationTypeAsync(array $args = [])
*/
class MTurkClient extends \Aws\AwsClient
{
}
}
namespace Aws\MTurk\Exception {
/**
* Represents an error interacting with the **Amazon Mechanical Turk Requester Service** service.
*/
class MTurkException extends \Aws\Exception\AwsException
{
}
}
namespace Aws\Multipart {
/**
* Representation of the multipart upload.
*
* This object keeps track of the state of the upload, including the status and
* which parts have been uploaded.
*/
class UploadState
{
const CREATED = 0;
const INITIATED = 1;
const COMPLETED = 2;
/**
* @param array $id Params used to identity the upload.
*/
public function __construct(array $id)
{
}
/**
* Get the upload's ID, which is a tuple of parameters that can uniquely
* identify the upload.
*
* @return array
*/
public function getId()
{
}
/**
* Set's the "upload_id", or 3rd part of the upload's ID. This typically
* only needs to be done after initiating an upload.
*
* @param string $key The param key of the upload_id.
* @param string $value The param value of the upload_id.
*/
public function setUploadId($key, $value)
{
}
/**
* Get the part size.
*
* @return int
*/
public function getPartSize()
{
}
/**
* Set the part size.
*
* @param $partSize int Size of upload parts.
*/
public function setPartSize($partSize)
{
}
/**
* Marks a part as being uploaded.
*
* @param int $partNumber The part number.
* @param array $partData Data from the upload operation that needs to be
* recalled during the complete operation.
*/
public function markPartAsUploaded($partNumber, array $partData = [])
{
}
/**
* Returns whether a part has been uploaded.
*
* @param int $partNumber The part number.
*
* @return bool
*/
public function hasPartBeenUploaded($partNumber)
{
}
/**
* Returns a sorted list of all the uploaded parts.
*
* @return array
*/
public function getUploadedParts()
{
}
/**
* Set the status of the upload.
*
* @param int $status Status is an integer code defined by the constants
* CREATED, INITIATED, and COMPLETED on this class.
*/
public function setStatus($status)
{
}
/**
* Determines whether the upload state is in the INITIATED status.
*
* @return bool
*/
public function isInitiated()
{
}
/**
* Determines whether the upload state is in the COMPLETED status.
*
* @return bool
*/
public function isCompleted()
{
}
}
}
namespace Middlewares\Utils {
/**
* Simple class to create response instances of PSR-7 classes.
*/
class ResponseFactory implements \Interop\Http\Factory\ResponseFactoryInterface
{
/**
* {@inheritdoc}
*/
public function createResponse($code = 200)
{
}
}
class Dispatcher
{
/**
* Static helper to create and dispatch a request.
*
* @param MiddlewareInterface[]
* @param ServerRequestInterface|null $request
*
* @return ResponseInterface
*/
public static function run(array $stack, \Psr\Http\Message\ServerRequestInterface $request = null)
{
}
/**
* @param MiddlewareInterface[] $stack middleware stack (with at least one middleware component)
*/
public function __construct(array $stack)
{
}
/**
* Dispatches the middleware stack and returns the resulting `ResponseInterface`.
*
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function dispatch(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
/**
* Simple class to create server request instances of PSR-7 classes.
*/
class ServerRequestFactory implements \Interop\Http\Factory\ServerRequestFactoryInterface
{
/**
* {@inheritdoc}
*/
public function createServerRequest(array $server, $method = null, $uri = null)
{
}
}
/**
* Simple class to create instances of PSR-7 classes.
*/
abstract class Factory
{
/**
* Set a custom ResponseFactory.
*
* @param ResponseFactoryInterface $responseFactory
*/
public static function setResponseFactory(\Interop\Http\Factory\ResponseFactoryInterface $responseFactory)
{
}
/**
* Set a custom StreamFactory.
*
* @param StreamFactoryInterface $streamFactory
*/
public static function setStreamFactory(\Interop\Http\Factory\StreamFactoryInterface $streamFactory)
{
}
/**
* Set a custom UriFactory.
*
* @param UriFactoryInterface $uriFactory
*/
public static function setUriFactory(\Interop\Http\Factory\UriFactoryInterface $uriFactory)
{
}
/**
* Set a custom ServerRequestFactory.
*
* @param ServerRequestFactoryInterface $serverRequestFactory
*/
public static function setServerRequestFactory(\Interop\Http\Factory\ServerRequestFactoryInterface $serverRequestFactory)
{
}
/**
* Creates a Response instance.
*
* @param int $code The status code
*
* @return ResponseInterface
*/
public static function createResponse($code = 200)
{
}
/**
* Creates a Stream instance.
*
* @param resource $resource A resource returned by fopen
*
* @return StreamInterface
*/
public static function createStream($resource = null)
{
}
/**
* Creates an Uri instance.
*
* @param string $uri
*
* @return UriInterface
*/
public static function createUri($uri = '')
{
}
/**
* Creates a ServerRequest instance.
*
* @param array $server
* @param string $method
* @param string $uri
*
* @return ServerRequest
*/
public static function createServerRequest(array $server = [], $method = 'GET', $uri = '/')
{
}
}
}
namespace Middlewares\Utils\CallableResolver {
/**
* Simple interface to resolve callableish values.
*/
interface CallableResolverInterface
{
/**
* Resolves a callable.
*
* @param mixed $callable
* @param array $args
*
* @throws RuntimeException If it's not callable
*
* @return callable
*/
public function resolve($callable, array $args = []);
}
/**
* Common logic for callable resolvers.
*/
abstract class Resolver implements \Middlewares\Utils\CallableResolver\CallableResolverInterface
{
/**
* Resolves a callable from a string.
*
* @param string $callable
*
* @return array|string
*/
protected function resolveString($callable)
{
}
}
/**
* Resolve a callable using reflection.
*/
final class ReflectionResolver extends \Middlewares\Utils\CallableResolver\Resolver
{
public function resolve($callable, array $args = [])
{
}
}
/**
* Resolve a callable using a container.
*/
final class ContainerResolver extends \Middlewares\Utils\CallableResolver\Resolver
{
public function __construct(\Interop\Container\ContainerInterface $container)
{
}
public function resolve($callable, array $args = [])
{
}
}
}
namespace Middlewares\Utils {
class Delegate implements \Interop\Http\ServerMiddleware\DelegateInterface
{
/**
* @param callable $callback function (RequestInterface $request) : ResponseInterface
*/
public function __construct(callable $callback)
{
}
/**
* @param ServerRequestInterface $request
*
* @return ResponseInterface
*/
public function process(\Psr\Http\Message\ServerRequestInterface $request)
{
}
}
class CallableMiddleware implements \Interop\Http\ServerMiddleware\MiddlewareInterface
{
/**
* Constructor.
*
* @param callable $handler
*/
public function __construct(callable $handler)
{
}
/**
* Process a server request and return a response.
*
* @param ServerRequestInterface $request
* @param DelegateInterface $delegate
*
* @return ResponseInterface
*/
public function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
/**
* Simple class to create instances of PSR-7 streams.
*/
class StreamFactory implements \Interop\Http\Factory\StreamFactoryInterface
{
/**
* {@inheritdoc}
*/
public function createStream($content = '')
{
}
/**
* {@inheritdoc}
*/
public function createStreamFromFile($file, $mode = 'r')
{
}
/**
* {@inheritdoc}
*/
public function createStreamFromResource($resource)
{
}
}
/**
* Simple class to execute callables and returns responses.
*/
abstract class CallableHandler
{
/**
* Execute the callable.
*
* @param callable $callable
* @param array $arguments
*
* @return ResponseInterface
*/
public static function execute($callable, array $arguments = [])
{
}
}
/**
* Simple class to create instances of PSR-7 uri.
*/
class UriFactory implements \Interop\Http\Factory\UriFactoryInterface
{
/**
* {@inheritdoc}
*/
public function createUri($uri = '')
{
}
}
}
namespace Middlewares {
class FastRoute implements \Interop\Http\ServerMiddleware\MiddlewareInterface
{
/**
* Set the Dispatcher instance.
*
* @param Dispatcher $router
*/
public function __construct(\FastRoute\Dispatcher $router)
{
}
/**
* Set the resolver used to create the controllers.
*
* @param ContainerInterface $container
*
* @return self
*/
public function resolver(\Interop\Container\ContainerInterface $container)
{
}
/**
* Extra arguments passed to the callable.
*
* @return self
*/
public function arguments()
{
}
/**
* Process a server request and return a response.
*
* @param ServerRequestInterface $request
* @param DelegateInterface $delegate
*
* @return ResponseInterface
*/
public function process(\Psr\Http\Message\ServerRequestInterface $request, \Interop\Http\ServerMiddleware\DelegateInterface $delegate)
{
}
}
}
namespace {
/**
* Smarty Method ConfigLoad
*
* Smarty::configLoad() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_ConfigLoad
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* load a config file, optionally load just selected sections
*
* @api Smarty::configLoad()
* @link http://www.smarty.net/docs/en/api.config.load.tpl
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param string $config_file filename
* @param mixed $sections array of section names, single
* section or null
*
* @return \Smarty|\Smarty_Internal_Data|\Smarty_Internal_Template
* @throws \Exception
*/
public function configLoad(\Smarty_Internal_Data $data, $config_file, $sections = \null)
{
}
/**
* load a config file, optionally load just selected sections
*
* @api Smarty::configLoad()
* @link http://www.smarty.net/docs/en/api.config.load.tpl
*
* @param \Smarty|\Smarty_Internal_Data|\Smarty_Internal_Template $data
* @param string $config_file filename
* @param mixed $sections array of section names, single
* section or null
* @param int $scope scope into which config variables
* shall be loaded
*
* @throws \Exception
*/
public function _loadConfigFile(\Smarty_Internal_Data $data, $config_file, $sections = \null, $scope = 0)
{
}
/**
* load config variables into template object
*
* @param \Smarty_Internal_Template $tpl
* @param array $new_config_vars
*/
public function _loadConfigVars(\Smarty_Internal_Template $tpl, $new_config_vars)
{
}
/**
* Assign all config variables in given scope
*
* @param array $config_vars config variables in scope
* @param \Smarty_Internal_Template $tpl
* @param array $new_config_vars loaded config variables
*/
public function _assignConfigVars(&$config_vars, \Smarty_Internal_Template $tpl, $new_config_vars)
{
}
/**
* Update config variables in template local variable stack
*
* @param \Smarty_Internal_Template $tpl
* @param array $config_vars
*/
public function _updateVarStack(\Smarty_Internal_Template $tpl, $config_vars)
{
}
/**
* gets a config variable value
*
* @param \Smarty|\Smarty_Internal_Data|\Smarty_Internal_Template $data
* @param string $varName the name of the config variable
* @param bool $errorEnable
*
* @return null|string the value of the config variable
*/
public function _getConfigVariable(\Smarty_Internal_Data $data, $varName, $errorEnable = \true)
{
}
}
/**
* Smarty Internal Undefined
*
* Class to handle undefined method calls or calls to obsolete runtime extensions
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Undefined
{
/**
* Name of undefined extension class
*
* @var string|null
*/
public $class = \null;
/**
* Smarty_Internal_Undefined constructor.
*
* @param null|string $class name of undefined extension class
*/
public function __construct($class = \null)
{
}
/**
* Wrapper for obsolete class Smarty_Internal_Runtime_ValidateCompiled
*
* @param \Smarty_Internal_Template $tpl
* @param array $properties special template properties
* @param bool $cache flag if called from cache file
*
* @return bool false
*/
public function decodeProperties(\Smarty_Internal_Template $tpl, $properties, $cache = \false)
{
}
/**
* Call error handler for undefined method
*
* @param string $name unknown method-name
* @param array $args argument array
*
* @return mixed
* @throws SmartyException
*/
public function __call($name, $args)
{
}
}
/**
* Smarty Resource Plugin
*
* @package Smarty
* @subpackage TemplateResources
* @author Rodney Rehm
*/
/**
* Smarty Resource Plugin
* Base implementation for resource plugins that don't compile cache
*
* @package Smarty
* @subpackage TemplateResources
*/
abstract class Smarty_Resource_Recompiled extends \Smarty_Resource
{
/**
* Flag that it's an recompiled resource
*
* @var bool
*/
public $recompiled = \true;
/**
* Resource does implement populateCompiledFilepath() method
*
* @var bool
*/
public $hasCompiledHandler = \true;
/**
* compile template from source
*
* @param Smarty_Internal_Template $_smarty_tpl do not change variable name, is used by compiled template
*
* @throws Exception
*/
public function process(\Smarty_Internal_Template $_smarty_tpl)
{
}
/**
* populate Compiled Object with compiled filepath
*
* @param Smarty_Template_Compiled $compiled compiled object
* @param Smarty_Internal_Template $_template template object
*
* @return void
*/
public function populateCompiledFilepath(\Smarty_Template_Compiled $compiled, \Smarty_Internal_Template $_template)
{
}
/*
* Disable timestamp checks for recompiled resource.
*
* @return bool
*/
/**
* @return bool
*/
public function checkTimestamps()
{
}
}
/**
* Smarty Method RegisterClass
*
* Smarty::registerClass() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_RegisterClass
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers static classes to be used in templates
*
* @api Smarty::registerClass()
* @link http://www.smarty.net/docs/en/api.register.class.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $class_name
* @param string $class_impl the referenced PHP class to
* register
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function registerClass(\Smarty_Internal_TemplateBase $obj, $class_name, $class_impl)
{
}
}
/**
* Smarty Method GetConfigVariable
*
* Smarty::getConfigVariable() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_GetConfigVariable
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* gets a config variable value
*
* @param \Smarty|\Smarty_Internal_Data|\Smarty_Internal_Template $data
* @param string $varName the name of the config variable
* @param bool $errorEnable
*
* @return null|string the value of the config variable
*/
public function getConfigVariable(\Smarty_Internal_Data $data, $varName = \null, $errorEnable = \true)
{
}
}
/**
* Smarty Extension Loadplugin
*
* $smarty->loadPlugin() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_LoadPlugin
{
/**
* Cache of searched plugin files
*
* @var array
*/
public $plugin_files = array();
/**
* Takes unknown classes and loads plugin files for them
* class name format: Smarty_PluginType_PluginName
* plugin filename format: plugintype.pluginname.php
*
* @param \Smarty $smarty
* @param string $plugin_name class plugin name to load
* @param bool $check check if already loaded
*
* @return bool|string
* @throws \SmartyException
*/
public function loadPlugin(\Smarty $smarty, $plugin_name, $check)
{
}
}
/**
* Smarty Internal Plugin CompileBase
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* This class does extend all internal compile plugins
*
* @package Smarty
* @subpackage Compiler
*/
abstract class Smarty_Internal_CompileBase
{
/**
* Array of names of required attribute required by tag
*
* @var array
*/
public $required_attributes = array();
/**
* Array of names of optional attribute required by tag
* use array('_any') if there is no restriction of attributes names
*
* @var array
*/
public $optional_attributes = array();
/**
* Shorttag attribute order defined by its names
*
* @var array
*/
public $shorttag_order = array();
/**
* Array of names of valid option flags
*
* @var array
*/
public $option_flags = array('nocache');
/**
* Mapping array for boolean option value
*
* @var array
*/
public $optionMap = array(1 => \true, 0 => \false, 'true' => \true, 'false' => \false);
/**
* Mapping array with attributes as key
*
* @var array
*/
public $mapCache = array();
/**
* This function checks if the attributes passed are valid
* The attributes passed for the tag to compile are checked against the list of required and
* optional attributes. Required attributes must be present. Optional attributes are check against
* the corresponding list. The keyword '_any' specifies that any attribute will be accepted
* as valid
*
* @param object $compiler compiler object
* @param array $attributes attributes applied to the tag
*
* @return array of mapped attributes for further processing
*/
public function getAttributes($compiler, $attributes)
{
}
/**
* Push opening tag name on stack
* Optionally additional data can be saved on stack
*
* @param object $compiler compiler object
* @param string $openTag the opening tag's name
* @param mixed $data optional data saved
*/
public function openTag($compiler, $openTag, $data = \null)
{
}
/**
* Pop closing tag
* Raise an error if this stack-top doesn't match with expected opening tags
*
* @param object $compiler compiler object
* @param array|string $expectedTag the expected opening tag names
*
* @return mixed any type the opening tag's name or saved data
*/
public function closeTag($compiler, $expectedTag)
{
}
}
/**
* Smarty Internal Plugin Compile Ldelim
* Compiles the {ldelim} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Ldelim Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Ldelim extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {ldelim} tag
* This tag does output the left delimiter
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Rdelim
* Compiles the {rdelim} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Rdelim Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Rdelim extends \Smarty_Internal_Compile_Ldelim
{
/**
* Compiles code for the {rdelim} tag
* This tag does output the right delimiter.
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Function
* Compiles the {function} {/function} tags
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Function Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Function extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('name');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('name');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('_any');
/**
* Compiles code for the {function} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return bool true
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Functionclose Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Functionclose extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {/function} tag
*
* @param array $args array with attributes from parser
* @param object|\Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return bool true
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* Remove nocache code
*
* @param $match
*
* @return string
*/
public function removeNocache($match)
{
}
}
/**
* Smarty Method AssignGlobal
*
* Smarty::assignGlobal() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_AssignGlobal
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* assigns a global Smarty variable
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param string $varName the global variable name
* @param mixed $value the value to assign
* @param boolean $nocache if true any output of this variable will
* be not cached
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public function assignGlobal(\Smarty_Internal_Data $data, $varName, $value = \null, $nocache = \false)
{
}
}
/**
* Smarty Internal Plugin Templateparser Parsetree
* These are classes to build parsetree in the template parser
*
* @package Smarty
* @subpackage Compiler
* @author Thue Kristensen
* @author Uwe Tews
*/
/**
* @package Smarty
* @subpackage Compiler
* @ignore
*/
abstract class Smarty_Internal_ParseTree
{
/**
* Buffer content
*
* @var mixed
*/
public $data;
/**
* Subtree array
*
* @var array
*/
public $subtrees = array();
/**
* Return buffer
*
* @param \Smarty_Internal_Templateparser $parser
*
* @return string buffer content
*/
public abstract function to_smarty_php(\Smarty_Internal_Templateparser $parser);
/**
* Template data object destructor
*/
public function __destruct()
{
}
}
/**
* Double quoted string inside a tag.
*
* @package Smarty
* @subpackage Compiler
* @ignore
*/
/**
* Double quoted string inside a tag.
*
* @package Smarty
* @subpackage Compiler
* @ignore
*/
class Smarty_Internal_ParseTree_Dq extends \Smarty_Internal_ParseTree
{
/**
* Create parse tree buffer for double quoted string subtrees
*
* @param object $parser parser object
* @param Smarty_Internal_ParseTree $subtree parse tree buffer
*/
public function __construct($parser, \Smarty_Internal_ParseTree $subtree)
{
}
/**
* Append buffer to subtree
*
* @param \Smarty_Internal_Templateparser $parser
* @param Smarty_Internal_ParseTree $subtree parse tree buffer
*/
public function append_subtree(\Smarty_Internal_Templateparser $parser, \Smarty_Internal_ParseTree $subtree)
{
}
/**
* Merge subtree buffer content together
*
* @param \Smarty_Internal_Templateparser $parser
*
* @return string compiled template code
*/
public function to_smarty_php(\Smarty_Internal_Templateparser $parser)
{
}
}
/**
* Smarty Template Resource Base Object
*
* @package Smarty
* @subpackage TemplateResources
* @author Rodney Rehm
*/
abstract class Smarty_Template_Resource_Base
{
/**
* Compiled Filepath
*
* @var string
*/
public $filepath = \null;
/**
* Compiled Timestamp
*
* @var integer|bool
*/
public $timestamp = \false;
/**
* Compiled Existence
*
* @var boolean
*/
public $exists = \false;
/**
* Template Compile Id (Smarty_Internal_Template::$compile_id)
*
* @var string
*/
public $compile_id = \null;
/**
* Compiled Content Loaded
*
* @var boolean
*/
public $processed = \false;
/**
* unique function name for compiled template code
*
* @var string
*/
public $unifunc = '';
/**
* flag if template does contain nocache code sections
*
* @var bool
*/
public $has_nocache_code = \false;
/**
* resource file dependency
*
* @var array
*/
public $file_dependency = array();
/**
* Content buffer
*
* @var string
*/
public $content = \null;
/**
* Included sub templates
* - index name
* - value use count
*
* @var int[]
*/
public $includes = array();
/**
* Flag if this is a cache resource
*
* @var bool
*/
public $isCache = \false;
/**
* Process resource
*
* @param Smarty_Internal_Template $_template template object
*/
public abstract function process(\Smarty_Internal_Template $_template);
/**
* get rendered template content by calling compiled or cached template code
*
* @param \Smarty_Internal_Template $_template
* @param string $unifunc function with template code
*
* @throws \Exception
*/
public function getRenderedTemplateCode(\Smarty_Internal_Template $_template, $unifunc = \null)
{
}
/**
* Get compiled time stamp
*
* @return int
*/
public function getTimeStamp()
{
}
}
/**
* Smarty Method ClearAllCache
*
* Smarty::clearAllCache() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_ClearAllCache
{
/**
* Valid for Smarty object
*
* @var int
*/
public $objMap = 1;
/**
* Empty cache folder
*
* @api Smarty::clearAllCache()
* @link http://www.smarty.net/docs/en/api.clear.all.cache.tpl
*
* @param \Smarty $smarty
* @param integer $exp_time expiration time
* @param string $type resource type
*
* @return int number of cache files deleted
* @throws \SmartyException
*/
public function clearAllCache(\Smarty $smarty, $exp_time = \null, $type = \null)
{
}
}
/**
* Smarty read include path plugin
*
* @package Smarty
* @subpackage PluginsInternal
* @author Monte Ohrt
*/
/**
* Smarty Internal Read Include Path Class
*
* @package Smarty
* @subpackage PluginsInternal
*/
class Smarty_Internal_Runtime_GetIncludePath
{
/**
* include path cache
*
* @var string
*/
public $_include_path = '';
/**
* include path directory cache
*
* @var array
*/
public $_include_dirs = array();
/**
* include path directory cache
*
* @var array
*/
public $_user_dirs = array();
/**
* stream cache
*
* @var string[][]
*/
public $isFile = array();
/**
* stream cache
*
* @var string[]
*/
public $isPath = array();
/**
* stream cache
*
* @var int[]
*/
public $number = array();
/**
* status cache
*
* @var bool
*/
public $_has_stream_include = \null;
/**
* Number for array index
*
* @var int
*/
public $counter = 0;
/**
* Check if include path was updated
*
* @param \Smarty $smarty
*
* @return bool
*/
public function isNewIncludePath(\Smarty $smarty)
{
}
/**
* return array with include path directories
*
* @param \Smarty $smarty
*
* @return array
*/
public function getIncludePathDirs(\Smarty $smarty)
{
}
/**
* Return full file path from PHP include_path
*
* @param string[] $dirs
* @param string $file
* @param \Smarty $smarty
*
* @return bool|string full filepath or false
*/
public function getIncludePath($dirs, $file, \Smarty $smarty)
{
}
}
/**
* Smarty Method UnregisterResource
*
* Smarty::unregisterResource() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_UnregisterResource
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers a resource to fetch a template
*
* @api Smarty::unregisterResource()
* @link http://www.smarty.net/docs/en/api.unregister.resource.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $type name of resource type
*
* @return \Smarty|\Smarty_Internal_Template
*/
public function unregisterResource(\Smarty_Internal_TemplateBase $obj, $type)
{
}
}
/**
* Smarty Internal Plugin Compile Object Function
* Compiles code for registered objects as function
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Object Function Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_Object_Function extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('_any');
/**
* Compiles code for the execution of function plugin
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
* @param string $tag name of function
* @param string $method name of method to call
*
* @return string compiled code
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter, $tag, $method)
{
}
}
/**
* Smarty Method RegisterPlugin
*
* Smarty::registerPlugin() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_RegisterPlugin
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers plugin to be used in templates
*
* @api Smarty::registerPlugin()
* @link http://www.smarty.net/docs/en/api.register.plugin.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $type plugin type
* @param string $name name of template tag
* @param callback $callback PHP callback to register
* @param bool $cacheable if true (default) this
* function is cache able
* @param mixed $cache_attr caching attributes if any
*
* @return \Smarty|\Smarty_Internal_Template
* @throws SmartyException when the plugin tag is invalid
*/
public function registerPlugin(\Smarty_Internal_TemplateBase $obj, $type, $name, $callback, $cacheable = \true, $cache_attr = \null)
{
}
}
/**
* Smarty Internal Plugin Compile Block Plugin
* Compiles code for the execution of block plugin
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Block Plugin Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_Block_Plugin extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('_any');
/**
* nesting level
*
* @var int
*/
public $nesting = 0;
/**
* Compiles code for the execution of block plugin
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
* @param string $tag name of block plugin
* @param string $function PHP function name
*
* @return string compiled code
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter, $tag, $function = \null)
{
}
/**
* Setup callback and parameter array
*
* @param \Smarty_Internal_TemplateCompilerBase $compiler
* @param array $_attr attributes
* @param string $tag
* @param string $function
*
* @return array
*/
public function setup(\Smarty_Internal_TemplateCompilerBase $compiler, $_attr, $tag, $function)
{
}
}
/**
* Smarty Internal Plugin Compile Shared Inheritance
* Shared methods for {extends} and {block} tags
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Shared Inheritance Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Shared_Inheritance extends \Smarty_Internal_CompileBase
{
/**
* Compile inheritance initialization code as prefix
*
* @param \Smarty_Internal_TemplateCompilerBase $compiler
* @param bool|false $initChildSequence if true force child template
*/
public static function postCompile(\Smarty_Internal_TemplateCompilerBase $compiler, $initChildSequence = \false)
{
}
/**
* Register post compile callback to compile inheritance initialization code
*
* @param \Smarty_Internal_TemplateCompilerBase $compiler
* @param bool|false $initChildSequence if true force child template
*/
public function registerInit(\Smarty_Internal_TemplateCompilerBase $compiler, $initChildSequence = \false)
{
}
}
class TP_yyStackEntry
{
public $stateno;
/* The state-number */
public $major;
/* The major token value. This is the code
* number for the token at this stack level
*/
public $minor;
/* The user-supplied minor token value. This
* is the value of the token
*/
}
// line 11 "../smarty/lexer/smarty_internal_templateparser.y"
/**
* Smarty Template Parser Class
*
* This is the template parser.
* It is generated from the smarty_internal_templateparser.y file
*
* @author Uwe Tews <uwe.tews@googlemail.com>
*/
class Smarty_Internal_Templateparser
{
// line 23 "../smarty/lexer/smarty_internal_templateparser.y"
const ERR1 = 'Security error: Call to private object member not allowed';
const ERR2 = 'Security error: Call to dynamic object member not allowed';
const ERR3 = 'PHP in template not allowed. Use SmartyBC to enable it';
const TP_VERT = 1;
const TP_COLON = 2;
const TP_UNIMATH = 3;
const TP_PHP = 4;
const TP_TEXT = 5;
const TP_STRIPON = 6;
const TP_STRIPOFF = 7;
const TP_LITERALSTART = 8;
const TP_LITERALEND = 9;
const TP_LITERAL = 10;
const TP_SIMPELOUTPUT = 11;
const TP_SIMPLETAG = 12;
const TP_SMARTYBLOCKCHILDPARENT = 13;
const TP_LDEL = 14;
const TP_RDEL = 15;
const TP_DOLLARID = 16;
const TP_EQUAL = 17;
const TP_ID = 18;
const TP_PTR = 19;
const TP_LDELMAKENOCACHE = 20;
const TP_LDELIF = 21;
const TP_LDELFOR = 22;
const TP_SEMICOLON = 23;
const TP_INCDEC = 24;
const TP_TO = 25;
const TP_STEP = 26;
const TP_LDELFOREACH = 27;
const TP_SPACE = 28;
const TP_AS = 29;
const TP_APTR = 30;
const TP_LDELSETFILTER = 31;
const TP_CLOSETAG = 32;
const TP_LDELSLASH = 33;
const TP_ATTR = 34;
const TP_INTEGER = 35;
const TP_COMMA = 36;
const TP_OPENP = 37;
const TP_CLOSEP = 38;
const TP_MATH = 39;
const TP_ISIN = 40;
const TP_QMARK = 41;
const TP_NOT = 42;
const TP_TYPECAST = 43;
const TP_HEX = 44;
const TP_DOT = 45;
const TP_INSTANCEOF = 46;
const TP_SINGLEQUOTESTRING = 47;
const TP_DOUBLECOLON = 48;
const TP_NAMESPACE = 49;
const TP_AT = 50;
const TP_HATCH = 51;
const TP_OPENB = 52;
const TP_CLOSEB = 53;
const TP_DOLLAR = 54;
const TP_LOGOP = 55;
const TP_SLOGOP = 56;
const TP_TLOGOP = 57;
const TP_SINGLECOND = 58;
const TP_QUOTE = 59;
const TP_BACKTICK = 60;
const YY_NO_ACTION = 511;
const YY_ACCEPT_ACTION = 510;
const YY_ERROR_ACTION = 509;
const YY_SZ_ACTTAB = 2076;
const YY_SHIFT_USE_DFLT = -23;
const YY_SHIFT_MAX = 227;
const YY_REDUCE_USE_DFLT = -68;
const YY_REDUCE_MAX = 176;
const YYNOCODE = 108;
const YYSTACKDEPTH = 500;
const YYNSTATE = 323;
const YYNRULE = 186;
const YYERRORSYMBOL = 61;
const YYERRSYMDT = 'yy0';
const YYFALLBACK = 0;
public static $yy_action = array(42, 266, 267, 379, 115, 202, 27, 204, 260, 235, 237, 1, 17, 125, 94, 182, 379, 215, 10, 79, 317, 168, 379, 12, 107, 425, 308, 318, 224, 298, 218, 129, 189, 292, 21, 203, 425, 27, 11, 39, 38, 299, 219, 17, 213, 385, 191, 245, 77, 3, 303, 315, 42, 385, 160, 385, 75, 29, 385, 95, 260, 235, 237, 1, 385, 126, 385, 193, 385, 215, 10, 79, 80, 290, 145, 226, 107, 148, 172, 150, 224, 298, 218, 85, 217, 315, 21, 280, 101, 280, 141, 39, 38, 299, 219, 20, 287, 183, 191, 232, 77, 3, 42, 315, 16, 176, 316, 172, 75, 275, 260, 235, 237, 1, 167, 128, 236, 193, 319, 215, 10, 79, 345, 40, 14, 257, 107, 319, 345, 5, 224, 298, 218, 89, 217, 315, 30, 292, 172, 203, 74, 39, 38, 299, 219, 132, 287, 205, 191, 74, 77, 3, 42, 315, 210, 194, 310, 99, 75, 345, 260, 235, 237, 1, 425, 126, 87, 179, 319, 215, 10, 79, 345, 95, 195, 425, 107, 272, 345, 176, 224, 298, 218, 315, 199, 115, 21, 128, 278, 209, 74, 39, 38, 299, 219, 94, 287, 226, 191, 129, 77, 3, 42, 315, 277, 309, 11, 308, 75, 13, 260, 235, 237, 1, 163, 127, 425, 193, 319, 215, 10, 79, 77, 254, 19, 315, 107, 425, 137, 34, 224, 298, 218, 196, 217, 33, 21, 220, 280, 159, 74, 39, 38, 299, 219, 196, 287, 8, 191, 162, 77, 3, 42, 315, 294, 222, 196, 438, 75, 378, 260, 235, 237, 1, 438, 126, 16, 193, 271, 215, 10, 79, 378, 172, 302, 315, 107, 175, 378, 267, 224, 298, 218, 27, 178, 252, 21, 164, 296, 17, 83, 39, 38, 299, 219, 196, 287, 205, 191, 170, 77, 3, 42, 315, 270, 18, 144, 99, 75, 346, 260, 235, 237, 1, 142, 126, 280, 177, 84, 215, 10, 79, 346, 172, 280, 4, 107, 95, 346, 321, 224, 298, 218, 438, 217, 131, 21, 321, 426, 24, 438, 39, 38, 299, 219, 196, 287, 205, 191, 426, 77, 3, 42, 315, 201, 9, 101, 99, 75, 381, 260, 235, 237, 1, 149, 124, 102, 193, 22, 215, 10, 79, 381, 315, 99, 231, 107, 311, 381, 425, 224, 298, 218, 23, 217, 319, 7, 207, 196, 17, 425, 39, 38, 299, 219, 307, 287, 36, 191, 154, 77, 3, 42, 315, 161, 296, 227, 74, 75, 280, 260, 235, 237, 1, 16, 91, 273, 76, 312, 215, 10, 79, 317, 208, 190, 12, 107, 176, 196, 318, 224, 298, 218, 135, 217, 321, 21, 196, 35, 95, 263, 39, 38, 299, 219, 157, 287, 111, 191, 88, 77, 3, 42, 315, 169, 280, 225, 15, 75, 285, 260, 235, 237, 1, 155, 126, 226, 184, 101, 215, 10, 79, 454, 172, 280, 454, 107, 246, 253, 454, 224, 298, 218, 152, 217, 111, 21, 161, 296, 265, 6, 39, 38, 299, 219, 269, 287, 203, 191, 119, 77, 3, 42, 315, 158, 262, 321, 274, 75, 97, 260, 235, 237, 1, 153, 128, 165, 193, 151, 215, 10, 79, 317, 43, 280, 12, 107, 320, 280, 318, 224, 298, 218, 8, 217, 171, 30, 306, 196, 36, 172, 39, 38, 299, 219, 264, 287, 256, 191, 128, 77, 288, 78, 315, 510, 90, 166, 296, 75, 41, 37, 223, 104, 228, 250, 251, 255, 122, 226, 289, 260, 235, 237, 1, 239, 233, 238, 240, 241, 215, 10, 79, 229, 305, 77, 304, 107, 315, 281, 300, 224, 298, 218, 261, 211, 203, 314, 28, 86, 108, 140, 181, 96, 61, 214, 247, 317, 454, 94, 12, 454, 297, 322, 318, 454, 29, 259, 192, 249, 248, 308, 313, 138, 27, 302, 143, 130, 82, 95, 17, 261, 211, 203, 314, 252, 86, 108, 286, 180, 96, 50, 136, 139, 100, 152, 94, 454, 81, 297, 322, 295, 321, 146, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 105, 64, 295, 295, 295, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 261, 308, 203, 276, 295, 110, 108, 295, 181, 96, 61, 187, 282, 295, 317, 94, 295, 12, 297, 322, 295, 318, 295, 259, 192, 249, 295, 308, 295, 291, 295, 295, 295, 295, 295, 260, 235, 237, 2, 295, 293, 295, 295, 295, 215, 10, 79, 295, 295, 295, 295, 107, 291, 206, 295, 224, 298, 218, 260, 235, 237, 2, 295, 293, 295, 295, 295, 215, 10, 79, 295, 295, 295, 295, 107, 295, 295, 295, 224, 298, 218, 295, 295, 295, 26, 261, 295, 203, 295, 295, 110, 295, 295, 197, 113, 60, 295, 295, 295, 295, 94, 156, 295, 297, 322, 167, 284, 26, 259, 192, 249, 280, 308, 295, 40, 14, 257, 295, 261, 200, 203, 295, 295, 110, 295, 295, 197, 105, 64, 172, 295, 295, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 295, 295, 295, 295, 261, 295, 203, 295, 295, 98, 283, 295, 197, 113, 51, 295, 201, 295, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 113, 60, 295, 295, 295, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 188, 295, 197, 113, 60, 196, 31, 43, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 98, 198, 295, 197, 113, 45, 295, 109, 295, 295, 94, 295, 295, 297, 322, 295, 41, 37, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 113, 67, 233, 238, 240, 241, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 113, 57, 196, 295, 43, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 113, 46, 295, 295, 295, 295, 94, 295, 295, 297, 322, 295, 41, 37, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 113, 66, 233, 238, 240, 241, 94, 301, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 113, 72, 196, 295, 43, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 113, 53, 295, 295, 295, 295, 94, 295, 295, 297, 322, 230, 41, 37, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 113, 48, 233, 238, 240, 241, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 185, 103, 49, 196, 295, 43, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 113, 55, 134, 295, 295, 295, 94, 295, 295, 297, 322, 295, 41, 37, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 113, 71, 233, 238, 240, 241, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 113, 59, 196, 295, 43, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 113, 63, 295, 295, 295, 295, 94, 295, 295, 297, 322, 216, 41, 37, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 113, 62, 233, 238, 240, 241, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 92, 69, 196, 295, 43, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 113, 52, 295, 295, 295, 295, 94, 295, 295, 297, 322, 295, 41, 37, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 113, 65, 233, 238, 240, 241, 94, 295, 295, 297, 322, 295, 196, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 349, 197, 113, 58, 221, 295, 295, 295, 94, 295, 295, 297, 322, 27, 295, 295, 259, 192, 249, 17, 308, 261, 425, 203, 295, 295, 110, 295, 295, 197, 113, 56, 295, 425, 295, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 113, 44, 295, 295, 295, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 93, 70, 295, 295, 295, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 186, 113, 54, 295, 295, 295, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 113, 73, 295, 295, 295, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 113, 68, 295, 295, 295, 295, 94, 295, 295, 297, 322, 295, 295, 295, 259, 192, 249, 295, 308, 261, 295, 203, 295, 295, 110, 295, 295, 197, 93, 47, 295, 295, 295, 295, 94, 295, 295, 297, 322, 391, 391, 391, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 113, 51, 295, 295, 295, 295, 94, 295, 295, 297, 322, 196, 295, 43, 259, 192, 249, 295, 308, 295, 295, 425, 295, 391, 391, 295, 295, 295, 261, 295, 203, 295, 425, 110, 295, 295, 197, 118, 27, 391, 391, 391, 391, 94, 17, 295, 295, 258, 295, 41, 37, 259, 192, 249, 261, 308, 203, 295, 196, 110, 43, 295, 197, 120, 295, 233, 238, 240, 241, 94, 295, 295, 295, 243, 295, 295, 295, 259, 192, 249, 295, 308, 295, 32, 295, 27, 212, 295, 295, 295, 295, 17, 295, 295, 295, 454, 41, 37, 454, 295, 295, 295, 454, 438, 295, 295, 295, 295, 295, 295, 295, 295, 233, 238, 240, 241, 295, 295, 261, 295, 203, 295, 295, 110, 295, 295, 197, 112, 295, 438, 295, 295, 438, 94, 454, 212, 438, 268, 295, 295, 295, 259, 192, 249, 454, 308, 212, 454, 295, 295, 34, 454, 438, 295, 295, 454, 295, 295, 454, 295, 133, 4, 454, 438, 167, 295, 295, 295, 295, 295, 280, 295, 295, 40, 14, 257, 295, 295, 438, 295, 295, 438, 261, 454, 203, 438, 295, 110, 172, 438, 197, 121, 438, 261, 454, 203, 438, 94, 110, 295, 295, 197, 117, 295, 295, 259, 192, 249, 94, 308, 295, 295, 295, 295, 295, 295, 259, 192, 249, 261, 308, 203, 295, 295, 110, 295, 295, 197, 116, 295, 261, 295, 203, 295, 94, 110, 295, 295, 197, 114, 295, 295, 259, 192, 249, 94, 308, 196, 295, 43, 295, 295, 295, 259, 192, 249, 261, 308, 203, 295, 196, 110, 43, 295, 197, 123, 295, 295, 295, 106, 295, 94, 295, 196, 174, 43, 295, 295, 295, 259, 192, 249, 196, 308, 43, 41, 37, 244, 295, 295, 295, 295, 295, 295, 295, 295, 234, 295, 41, 37, 295, 233, 238, 240, 241, 295, 295, 295, 295, 295, 295, 41, 37, 295, 233, 238, 240, 241, 295, 295, 41, 37, 295, 295, 295, 295, 295, 233, 238, 240, 241, 25, 196, 295, 43, 295, 233, 238, 240, 241, 454, 295, 295, 454, 295, 295, 279, 454, 438, 212, 295, 295, 295, 295, 295, 295, 295, 295, 454, 295, 295, 454, 295, 295, 295, 454, 438, 196, 295, 43, 41, 37, 295, 295, 438, 295, 196, 438, 43, 454, 295, 438, 295, 295, 295, 295, 233, 238, 240, 241, 173, 295, 438, 295, 295, 438, 295, 454, 295, 438, 454, 295, 295, 454, 295, 41, 37, 454, 438, 295, 295, 295, 295, 295, 41, 37, 295, 295, 295, 242, 295, 233, 238, 240, 241, 295, 295, 295, 295, 295, 233, 238, 240, 241, 438, 295, 295, 438, 295, 454, 147, 438, 295, 295, 167, 295, 295, 295, 295, 295, 280, 295, 295, 40, 14, 257, 295, 295, 295, 295, 295, 295, 295, 295, 295, 295, 295, 295, 172);
public static $yy_lookahead = array(3, 9, 10, 15, 71, 17, 28, 74, 11, 12, 13, 14, 34, 16, 81, 18, 28, 20, 21, 22, 11, 82, 34, 14, 27, 37, 93, 18, 31, 32, 33, 45, 35, 66, 37, 68, 48, 28, 52, 42, 43, 44, 45, 34, 47, 15, 49, 16, 51, 52, 53, 54, 3, 23, 77, 25, 59, 17, 28, 19, 11, 12, 13, 14, 34, 16, 36, 18, 38, 20, 21, 22, 105, 106, 94, 45, 27, 73, 101, 73, 31, 32, 33, 77, 35, 54, 37, 83, 48, 83, 94, 42, 43, 44, 45, 14, 47, 16, 49, 18, 51, 52, 3, 54, 36, 101, 38, 101, 59, 15, 11, 12, 13, 14, 77, 16, 35, 18, 24, 20, 21, 22, 28, 86, 87, 88, 27, 24, 34, 37, 31, 32, 33, 82, 35, 54, 37, 66, 101, 68, 46, 42, 43, 44, 45, 16, 47, 71, 49, 46, 51, 52, 3, 54, 78, 79, 53, 81, 59, 15, 11, 12, 13, 14, 37, 16, 37, 18, 24, 20, 21, 22, 28, 19, 65, 48, 27, 106, 34, 101, 31, 32, 33, 54, 35, 71, 37, 16, 74, 18, 46, 42, 43, 44, 45, 81, 47, 45, 49, 45, 51, 52, 3, 54, 90, 53, 52, 93, 59, 30, 11, 12, 13, 14, 82, 16, 37, 18, 24, 20, 21, 22, 51, 18, 14, 54, 27, 48, 73, 17, 31, 32, 33, 1, 35, 14, 37, 16, 83, 18, 46, 42, 43, 44, 45, 1, 47, 37, 49, 77, 51, 52, 3, 54, 60, 50, 1, 45, 59, 15, 11, 12, 13, 14, 52, 16, 36, 18, 38, 20, 21, 22, 28, 101, 102, 54, 27, 8, 34, 10, 31, 32, 33, 28, 35, 95, 37, 97, 98, 34, 94, 42, 43, 44, 45, 1, 47, 71, 49, 77, 51, 52, 3, 54, 78, 23, 73, 81, 59, 15, 11, 12, 13, 14, 73, 16, 83, 18, 36, 20, 21, 22, 28, 101, 83, 17, 27, 19, 34, 96, 31, 32, 33, 45, 35, 16, 37, 96, 37, 41, 52, 42, 43, 44, 45, 1, 47, 71, 49, 48, 51, 52, 3, 54, 78, 37, 48, 81, 59, 15, 11, 12, 13, 14, 71, 16, 48, 18, 17, 20, 21, 22, 28, 54, 81, 24, 27, 70, 34, 37, 31, 32, 33, 28, 35, 24, 37, 45, 1, 34, 48, 42, 43, 44, 45, 53, 47, 2, 49, 73, 51, 52, 3, 54, 97, 98, 19, 46, 59, 83, 11, 12, 13, 14, 36, 16, 38, 18, 98, 20, 21, 22, 11, 64, 65, 14, 27, 101, 1, 18, 31, 32, 33, 94, 35, 96, 37, 1, 17, 19, 92, 42, 43, 44, 45, 73, 47, 99, 49, 77, 51, 52, 3, 54, 16, 83, 18, 30, 59, 70, 11, 12, 13, 14, 73, 16, 45, 18, 48, 20, 21, 22, 11, 101, 83, 14, 27, 35, 92, 18, 31, 32, 33, 94, 35, 99, 37, 97, 98, 53, 36, 42, 43, 44, 45, 66, 47, 68, 49, 18, 51, 52, 3, 54, 94, 38, 96, 53, 59, 81, 11, 12, 13, 14, 73, 16, 77, 18, 73, 20, 21, 22, 11, 3, 83, 14, 27, 99, 83, 18, 31, 32, 33, 37, 35, 18, 37, 18, 1, 2, 101, 42, 43, 44, 45, 35, 47, 18, 49, 16, 51, 18, 18, 54, 62, 63, 97, 98, 59, 39, 40, 50, 18, 4, 5, 6, 7, 8, 45, 16, 11, 12, 13, 14, 18, 55, 56, 57, 58, 20, 21, 22, 49, 53, 51, 53, 27, 54, 18, 15, 31, 32, 33, 66, 67, 68, 69, 25, 71, 72, 51, 74, 75, 76, 18, 18, 11, 11, 81, 14, 14, 84, 85, 18, 18, 17, 89, 90, 91, 9, 93, 15, 51, 28, 102, 30, 81, 81, 19, 34, 66, 67, 68, 69, 95, 71, 72, 83, 74, 75, 76, 94, 94, 80, 94, 81, 50, 81, 84, 85, 107, 96, 94, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 66, 93, 68, 69, 107, 71, 72, 107, 74, 75, 76, 103, 104, 107, 11, 81, 107, 14, 84, 85, 107, 18, 107, 89, 90, 91, 107, 93, 107, 5, 107, 107, 107, 107, 107, 11, 12, 13, 14, 107, 16, 107, 107, 107, 20, 21, 22, 107, 107, 107, 107, 27, 5, 50, 107, 31, 32, 33, 11, 12, 13, 14, 107, 16, 107, 107, 107, 20, 21, 22, 107, 107, 107, 107, 27, 107, 107, 107, 31, 32, 33, 107, 107, 59, 60, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 73, 107, 84, 85, 77, 59, 60, 89, 90, 91, 83, 93, 107, 86, 87, 88, 107, 66, 100, 68, 107, 107, 71, 107, 107, 74, 75, 76, 101, 107, 107, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 107, 107, 107, 107, 66, 107, 68, 107, 107, 71, 104, 107, 74, 75, 76, 107, 78, 107, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 100, 107, 74, 75, 76, 1, 2, 3, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 100, 107, 74, 75, 76, 107, 78, 107, 107, 81, 107, 107, 84, 85, 107, 39, 40, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 76, 55, 56, 57, 58, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 1, 107, 3, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 107, 39, 40, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 76, 55, 56, 57, 58, 81, 60, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 1, 107, 3, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 38, 39, 40, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 76, 55, 56, 57, 58, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 1, 107, 3, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 29, 107, 107, 107, 81, 107, 107, 84, 85, 107, 39, 40, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 76, 55, 56, 57, 58, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 1, 107, 3, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 38, 39, 40, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 76, 55, 56, 57, 58, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 1, 107, 3, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 107, 39, 40, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 76, 55, 56, 57, 58, 81, 107, 107, 84, 85, 107, 1, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 15, 74, 75, 76, 19, 107, 107, 107, 81, 107, 107, 84, 85, 28, 107, 107, 89, 90, 91, 34, 93, 66, 37, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 48, 107, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 107, 107, 107, 89, 90, 91, 107, 93, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 1, 2, 3, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 76, 107, 107, 107, 107, 81, 107, 107, 84, 85, 1, 107, 3, 89, 90, 91, 107, 93, 107, 107, 37, 107, 39, 40, 107, 107, 107, 66, 107, 68, 107, 48, 71, 107, 107, 74, 75, 28, 55, 56, 57, 58, 81, 34, 107, 107, 85, 107, 39, 40, 89, 90, 91, 66, 93, 68, 107, 1, 71, 3, 107, 74, 75, 107, 55, 56, 57, 58, 81, 107, 107, 107, 85, 107, 107, 107, 89, 90, 91, 107, 93, 107, 26, 107, 28, 2, 107, 107, 107, 107, 34, 107, 107, 107, 11, 39, 40, 14, 107, 107, 107, 18, 19, 107, 107, 107, 107, 107, 107, 107, 107, 55, 56, 57, 58, 107, 107, 66, 107, 68, 107, 107, 71, 107, 107, 74, 75, 107, 45, 107, 107, 48, 81, 50, 2, 52, 53, 107, 107, 107, 89, 90, 91, 11, 93, 2, 14, 107, 107, 17, 18, 19, 107, 107, 11, 107, 107, 14, 107, 73, 17, 18, 19, 77, 107, 107, 107, 107, 107, 83, 107, 107, 86, 87, 88, 107, 107, 45, 107, 107, 48, 66, 50, 68, 52, 107, 71, 101, 45, 74, 75, 48, 66, 50, 68, 52, 81, 71, 107, 107, 74, 75, 107, 107, 89, 90, 91, 81, 93, 107, 107, 107, 107, 107, 107, 89, 90, 91, 66, 93, 68, 107, 107, 71, 107, 107, 74, 75, 107, 66, 107, 68, 107, 81, 71, 107, 107, 74, 75, 107, 107, 89, 90, 91, 81, 93, 1, 107, 3, 107, 107, 107, 89, 90, 91, 66, 93, 68, 107, 1, 71, 3, 107, 74, 75, 107, 107, 107, 23, 107, 81, 107, 1, 15, 3, 107, 107, 107, 89, 90, 91, 1, 93, 3, 39, 40, 15, 107, 107, 107, 107, 107, 107, 107, 107, 15, 107, 39, 40, 107, 55, 56, 57, 58, 107, 107, 107, 107, 107, 107, 39, 40, 107, 55, 56, 57, 58, 107, 107, 39, 40, 107, 107, 107, 107, 107, 55, 56, 57, 58, 2, 1, 107, 3, 107, 55, 56, 57, 58, 11, 107, 107, 14, 107, 107, 15, 18, 19, 2, 107, 107, 107, 107, 107, 107, 107, 107, 11, 107, 107, 14, 107, 107, 107, 18, 19, 1, 107, 3, 39, 40, 107, 107, 45, 107, 1, 48, 3, 50, 107, 52, 107, 107, 107, 107, 55, 56, 57, 58, 15, 107, 45, 107, 107, 48, 107, 50, 107, 52, 11, 107, 107, 14, 107, 39, 40, 18, 19, 107, 107, 107, 107, 107, 39, 40, 107, 107, 107, 53, 107, 55, 56, 57, 58, 107, 107, 107, 107, 107, 55, 56, 57, 58, 45, 107, 107, 48, 107, 50, 73, 52, 107, 107, 77, 107, 107, 107, 107, 107, 83, 107, 107, 86, 87, 88, 107, 107, 107, 107, 107, 107, 107, 107, 107, 107, 107, 107, 101);
public static $yy_shift_ofst = array(-23, 399, 399, 449, 49, 49, 449, 349, 49, 49, 349, -3, 49, 49, 49, 49, 49, 49, 49, 49, 49, 49, 49, 149, 199, 299, 49, 149, 49, 49, 49, 49, 49, 49, 249, 49, 99, 99, 499, 499, 499, 499, 499, 499, 1664, 1617, 1617, 1144, 1982, 1973, 1938, 1226, 1853, 1062, 980, 1879, 898, 1866, 1888, 1308, 1308, 1308, 1308, 1308, 1308, 1308, 1308, 1308, 1308, 1308, 1308, 1308, 520, 520, 533, 731, 1372, 171, 255, 129, 708, 595, 9, 154, 129, 255, 308, 129, 255, 537, 559, 1751, 244, 344, 511, 221, 294, 411, 40, 411, -22, 438, 438, 436, 387, 427, 319, 355, -22, -22, 420, 609, 232, 232, 232, 609, 232, 232, 232, 232, -23, -23, -23, -23, 1740, 1691, 1954, 1936, 1996, 81, 687, 461, 212, -22, 31, -14, -14, -22, 288, -14, 288, -14, -22, 31, -22, -14, -14, -22, -22, 351, -22, -22, -14, -22, -22, -22, -22, -22, -14, 210, 232, 609, 232, 395, 609, 232, 609, 232, 395, 92, 232, -23, -23, -23, -23, -23, -23, 1591, 30, -12, 94, 144, 342, 596, 179, 103, 194, 454, 230, 152, 269, 301, 318, 127, 282, -8, 205, 361, 378, 421, 68, 467, 556, 606, 571, 598, 587, 586, 610, 549, 572, 574, 570, 532, 530, 553, 298, 523, 544, 510, 92, 534, 529, 519, 517, 496, 442, 481);
public static $yy_reduce_ofst = array(492, 527, 564, 592, 618, 703, 736, 768, 794, 822, 850, 1068, 1096, 1122, 1150, 1286, 1204, 1232, 1260, 1040, 1314, 1532, 1478, 1506, 1342, 1450, 1424, 1396, 1368, 1178, 1014, 986, 932, 904, 876, 958, 1595, 1569, 1771, 1659, 1760, 1734, 1723, 1797, 712, 1694, 1974, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 37, 114, -33, 372, -67, 6, 76, 71, 233, 241, 190, 226, 4, 307, 276, 326, 172, 429, 389, -23, -23, 339, 428, -23, 410, 390, 339, 391, 386, 348, -23, 222, -23, 293, 155, 441, 445, 390, 459, -23, -23, -23, 390, -23, -23, -23, 439, -23, -23, 359, -23, 550, 550, 550, 550, 550, 545, 555, 550, 550, 554, 566, 539, 539, 554, 547, 539, 548, 539, 554, 546, 554, 539, 539, 554, 554, 563, 554, 554, 539, 554, 554, 554, 554, 554, 539, 558, 78, 320, 78, 522, 320, 78, 320, 78, 522, 196, 78, 51, -61, -20, -4, 109, 132);
public static $yyExpectedTokens = array(array(), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 53, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 52, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 54, 59), array(3, 11, 12, 13, 14, 16, 18, 20, 21, 22, 27, 31, 32, 33, 35, 37, 42, 43, 44, 45, 47, 49, 51, 54, 59), array(1, 3, 26, 28, 34, 39, 40, 55, 56, 57, 58), array(1, 3, 28, 34, 39, 40, 55, 56, 57, 58), array(1, 3, 28, 34, 39, 40, 55, 56, 57, 58), array(1, 3, 29, 39, 40, 55, 56, 57, 58), array(1, 3, 15, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 53, 55, 56, 57, 58), array(1, 3, 15, 39, 40, 55, 56, 57, 58), array(1, 3, 38, 39, 40, 55, 56, 57, 58), array(1, 3, 23, 39, 40, 55, 56, 57, 58), array(1, 3, 38, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58, 60), array(1, 3, 15, 39, 40, 55, 56, 57, 58), array(1, 2, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 15, 39, 40, 55, 56, 57, 58), array(1, 3, 15, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(1, 3, 39, 40, 55, 56, 57, 58), array(3, 39, 40, 55, 56, 57, 58), array(3, 39, 40, 55, 56, 57, 58), array(16, 18, 49, 51, 54), array(5, 11, 12, 13, 14, 16, 20, 21, 22, 27, 31, 32, 33, 59, 60), array(1, 15, 19, 28, 34, 37, 48), array(16, 18, 51, 54), array(1, 28, 34), array(16, 37, 54), array(5, 11, 12, 13, 14, 16, 20, 21, 22, 27, 31, 32, 33, 59, 60), array(11, 14, 18, 28, 30, 34), array(11, 14, 18, 28, 34), array(19, 45, 52), array(16, 37, 54), array(1, 28, 34), array(17, 19, 48), array(16, 37, 54), array(1, 28, 34), array(1, 2), array(4, 5, 6, 7, 8, 11, 12, 13, 14, 20, 21, 22, 27, 31, 32, 33), array(2, 11, 14, 17, 18, 19, 45, 48, 50, 52), array(1, 15, 28, 34), array(1, 15, 28, 34), array(11, 14, 18, 50), array(14, 16, 18, 54), array(1, 15, 28, 34), array(11, 14, 18), array(17, 19, 48), array(11, 14, 18), array(28, 34), array(16, 18), array(16, 18), array(1, 53), array(1, 19), array(1, 30), array(16, 54), array(28, 34), array(28, 34), array(28, 34), array(19, 48), array(19), array(1), array(1), array(1), array(19), array(1), array(1), array(1), array(1), array(), array(), array(), array(), array(2, 11, 14, 17, 18, 19, 45, 48, 50, 52), array(2, 11, 14, 18, 19, 45, 48, 50, 52, 53), array(2, 11, 14, 18, 19, 45, 48, 50, 52), array(2, 11, 14, 18, 19, 45, 48, 50, 52), array(11, 14, 18, 19, 45, 48, 50, 52), array(14, 16, 18, 35, 54), array(11, 14, 18, 50), array(11, 14, 18), array(17, 45, 52), array(28, 34), array(16, 54), array(45, 52), array(45, 52), array(28, 34), array(45, 52), array(45, 52), array(45, 52), array(45, 52), array(28, 34), array(16, 54), array(28, 34), array(45, 52), array(45, 52), array(28, 34), array(28, 34), array(17, 24), array(28, 34), array(28, 34), array(45, 52), array(28, 34), array(28, 34), array(28, 34), array(28, 34), array(28, 34), array(45, 52), array(14, 37), array(1), array(19), array(1), array(2), array(19), array(1), array(19), array(1), array(2), array(37), array(1), array(), array(), array(), array(), array(), array(), array(1, 2, 3, 37, 39, 40, 48, 55, 56, 57, 58), array(15, 23, 25, 28, 34, 36, 38, 45), array(15, 17, 28, 34, 37, 48), array(15, 24, 28, 34, 46), array(15, 24, 28, 34, 46), array(37, 45, 48, 53), array(11, 14, 18, 50), array(30, 37, 48), array(24, 46, 53), array(24, 46, 60), array(36, 53), array(36, 38), array(45, 53), array(8, 10), array(37, 48), array(37, 48), array(37, 48), array(23, 36), array(9, 10), array(18, 50), array(24, 46), array(36, 38), array(17, 45), array(36, 38), array(38), array(18), array(15), array(51), array(17), array(18), array(18), array(9), array(51), array(25), array(15), array(18), array(53), array(53), array(16), array(41), array(45), array(18), array(35), array(37), array(18), array(18), array(18), array(18), array(37), array(35), array(18), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array());
public static $yy_default = array(334, 509, 509, 494, 509, 473, 509, 509, 473, 473, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 375, 354, 375, 380, 509, 509, 347, 509, 509, 509, 509, 509, 509, 509, 509, 397, 472, 347, 471, 387, 497, 495, 382, 386, 359, 377, 380, 496, 402, 401, 509, 509, 413, 509, 375, 509, 509, 375, 375, 485, 509, 375, 428, 509, 375, 366, 323, 427, 389, 389, 438, 509, 389, 438, 428, 438, 375, 509, 509, 389, 369, 389, 509, 375, 375, 356, 428, 482, 405, 389, 406, 428, 396, 392, 400, 371, 480, 404, 332, 393, 427, 427, 427, 427, 427, 509, 440, 438, 454, 355, 509, 436, 434, 365, 433, 432, 431, 465, 364, 509, 363, 466, 463, 362, 352, 509, 351, 357, 435, 344, 350, 358, 361, 348, 464, 438, 422, 460, 367, 474, 486, 372, 483, 395, 475, 438, 370, 479, 479, 438, 438, 332, 479, 413, 409, 413, 403, 403, 413, 439, 413, 403, 403, 509, 509, 409, 330, 423, 509, 413, 509, 509, 509, 403, 509, 409, 509, 509, 509, 509, 509, 509, 509, 509, 509, 509, 383, 509, 509, 418, 509, 509, 415, 409, 509, 509, 454, 509, 509, 509, 509, 484, 411, 509, 324, 426, 415, 360, 442, 487, 444, 336, 443, 337, 488, 376, 489, 490, 452, 481, 459, 454, 410, 441, 328, 419, 325, 326, 437, 420, 477, 327, 476, 398, 399, 414, 335, 421, 388, 424, 412, 451, 329, 331, 449, 333, 384, 469, 500, 468, 491, 505, 343, 416, 417, 506, 374, 391, 492, 493, 498, 341, 373, 418, 425, 353, 501, 508, 507, 504, 502, 499, 461, 390, 368, 408, 338, 503, 478, 453, 447, 446, 429, 445, 430, 448, 450, 342, 462, 339, 340, 455, 470, 458, 457, 407, 467, 456, 394);
public static $yyFallback = array();
public static $yyRuleName = array('start ::= template', 'template ::= template PHP', 'template ::= template TEXT', 'template ::= template STRIPON', 'template ::= template STRIPOFF', 'template ::= template LITERALSTART literal_e2 LITERALEND', 'literal_e2 ::= literal_e1 LITERALSTART literal_e1 LITERALEND', 'literal_e2 ::= literal_e1', 'literal_e1 ::= literal_e1 LITERAL', 'literal_e1 ::=', 'template ::= template smartytag', 'template ::=', 'smartytag ::= SIMPELOUTPUT', 'smartytag ::= SIMPLETAG', 'smartytag ::= SMARTYBLOCKCHILDPARENT', 'smartytag ::= LDEL tagbody RDEL', 'smartytag ::= tag RDEL', 'tagbody ::= outattr', 'tagbody ::= DOLLARID eqoutattr', 'tagbody ::= varindexed eqoutattr', 'eqoutattr ::= EQUAL outattr', 'outattr ::= output attributes', 'output ::= variable', 'output ::= value', 'output ::= expr', 'tag ::= LDEL ID attributes', 'tag ::= LDEL ID', 'tag ::= LDEL ID modifierlist attributes', 'tag ::= LDEL ID PTR ID attributes', 'tag ::= LDEL ID PTR ID modifierlist attributes', 'tag ::= LDELMAKENOCACHE DOLLARID', 'tag ::= LDELIF expr', 'tag ::= LDELIF expr attributes', 'tag ::= LDELIF statement', 'tag ::= LDELIF statement attributes', 'tag ::= LDELFOR statements SEMICOLON expr SEMICOLON varindexed foraction attributes', 'foraction ::= EQUAL expr', 'foraction ::= INCDEC', 'tag ::= LDELFOR statement TO expr attributes', 'tag ::= LDELFOR statement TO expr STEP expr attributes', 'tag ::= LDELFOREACH SPACE expr AS varvar attributes', 'tag ::= LDELFOREACH SPACE expr AS varvar APTR varvar attributes', 'tag ::= LDELFOREACH attributes', 'tag ::= LDELSETFILTER ID modparameters', 'tag ::= LDELSETFILTER ID modparameters modifierlist', 'smartytag ::= CLOSETAG', 'tag ::= LDELSLASH ID', 'tag ::= LDELSLASH ID modifierlist', 'tag ::= LDELSLASH ID PTR ID', 'tag ::= LDELSLASH ID PTR ID modifierlist', 'attributes ::= attributes attribute', 'attributes ::= attribute', 'attributes ::=', 'attribute ::= SPACE ID EQUAL ID', 'attribute ::= ATTR expr', 'attribute ::= ATTR value', 'attribute ::= SPACE ID', 'attribute ::= SPACE expr', 'attribute ::= SPACE value', 'attribute ::= SPACE INTEGER EQUAL expr', 'statements ::= statement', 'statements ::= statements COMMA statement', 'statement ::= DOLLARID EQUAL INTEGER', 'statement ::= DOLLARID EQUAL expr', 'statement ::= varindexed EQUAL expr', 'statement ::= OPENP statement CLOSEP', 'expr ::= value', 'expr ::= ternary', 'expr ::= DOLLARID COLON ID', 'expr ::= expr MATH value', 'expr ::= expr UNIMATH value', 'expr ::= array', 'expr ::= expr modifierlist', 'expr ::= expr tlop value', 'expr ::= expr lop expr', 'expr ::= expr scond', 'expr ::= expr ISIN array', 'expr ::= expr ISIN value', 'ternary ::= OPENP expr CLOSEP QMARK DOLLARID COLON expr', 'ternary ::= OPENP expr CLOSEP QMARK expr COLON expr', 'value ::= variable', 'value ::= UNIMATH value', 'value ::= NOT value', 'value ::= TYPECAST value', 'value ::= variable INCDEC', 'value ::= HEX', 'value ::= INTEGER', 'value ::= INTEGER DOT INTEGER', 'value ::= INTEGER DOT', 'value ::= DOT INTEGER', 'value ::= ID', 'value ::= function', 'value ::= OPENP expr CLOSEP', 'value ::= variable INSTANCEOF ns1', 'value ::= variable INSTANCEOF variable', 'value ::= SINGLEQUOTESTRING', 'value ::= doublequoted_with_quotes', 'value ::= varindexed DOUBLECOLON static_class_access', 'value ::= smartytag', 'value ::= value modifierlist', 'value ::= NAMESPACE', 'value ::= ns1 DOUBLECOLON static_class_access', 'ns1 ::= ID', 'ns1 ::= NAMESPACE', 'variable ::= DOLLARID', 'variable ::= varindexed', 'variable ::= varvar AT ID', 'variable ::= object', 'variable ::= HATCH ID HATCH', 'variable ::= HATCH ID HATCH arrayindex', 'variable ::= HATCH variable HATCH', 'variable ::= HATCH variable HATCH arrayindex', 'varindexed ::= DOLLARID arrayindex', 'varindexed ::= varvar arrayindex', 'arrayindex ::= arrayindex indexdef', 'arrayindex ::=', 'indexdef ::= DOT DOLLARID', 'indexdef ::= DOT varvar', 'indexdef ::= DOT varvar AT ID', 'indexdef ::= DOT ID', 'indexdef ::= DOT INTEGER', 'indexdef ::= DOT LDEL expr RDEL', 'indexdef ::= OPENB ID CLOSEB', 'indexdef ::= OPENB ID DOT ID CLOSEB', 'indexdef ::= OPENB SINGLEQUOTESTRING CLOSEB', 'indexdef ::= OPENB INTEGER CLOSEB', 'indexdef ::= OPENB DOLLARID CLOSEB', 'indexdef ::= OPENB variable CLOSEB', 'indexdef ::= OPENB value CLOSEB', 'indexdef ::= OPENB expr CLOSEB', 'indexdef ::= OPENB CLOSEB', 'varvar ::= DOLLARID', 'varvar ::= DOLLAR', 'varvar ::= varvar varvarele', 'varvarele ::= ID', 'varvarele ::= SIMPELOUTPUT', 'varvarele ::= LDEL expr RDEL', 'object ::= varindexed objectchain', 'objectchain ::= objectelement', 'objectchain ::= objectchain objectelement', 'objectelement ::= PTR ID arrayindex', 'objectelement ::= PTR varvar arrayindex', 'objectelement ::= PTR LDEL expr RDEL arrayindex', 'objectelement ::= PTR ID LDEL expr RDEL arrayindex', 'objectelement ::= PTR method', 'function ::= ns1 OPENP params CLOSEP', 'method ::= ID OPENP params CLOSEP', 'method ::= DOLLARID OPENP params CLOSEP', 'params ::= params COMMA expr', 'params ::= expr', 'params ::=', 'modifierlist ::= modifierlist modifier modparameters', 'modifierlist ::= modifier modparameters', 'modifier ::= VERT AT ID', 'modifier ::= VERT ID', 'modparameters ::= modparameters modparameter', 'modparameters ::=', 'modparameter ::= COLON value', 'modparameter ::= COLON array', 'static_class_access ::= method', 'static_class_access ::= method objectchain', 'static_class_access ::= ID', 'static_class_access ::= DOLLARID arrayindex', 'static_class_access ::= DOLLARID arrayindex objectchain', 'lop ::= LOGOP', 'lop ::= SLOGOP', 'tlop ::= TLOGOP', 'scond ::= SINGLECOND', 'array ::= OPENB arrayelements CLOSEB', 'arrayelements ::= arrayelement', 'arrayelements ::= arrayelements COMMA arrayelement', 'arrayelements ::=', 'arrayelement ::= value APTR expr', 'arrayelement ::= ID APTR expr', 'arrayelement ::= expr', 'doublequoted_with_quotes ::= QUOTE QUOTE', 'doublequoted_with_quotes ::= QUOTE doublequoted QUOTE', 'doublequoted ::= doublequoted doublequotedcontent', 'doublequoted ::= doublequotedcontent', 'doublequotedcontent ::= BACKTICK variable BACKTICK', 'doublequotedcontent ::= BACKTICK expr BACKTICK', 'doublequotedcontent ::= DOLLARID', 'doublequotedcontent ::= LDEL variable RDEL', 'doublequotedcontent ::= LDEL expr RDEL', 'doublequotedcontent ::= smartytag', 'doublequotedcontent ::= TEXT');
public static $yyRuleInfo = array(array(0 => 62, 1 => 1), array(0 => 63, 1 => 2), array(0 => 63, 1 => 2), array(0 => 63, 1 => 2), array(0 => 63, 1 => 2), array(0 => 63, 1 => 4), array(0 => 64, 1 => 4), array(0 => 64, 1 => 1), array(0 => 65, 1 => 2), array(0 => 65, 1 => 0), array(0 => 63, 1 => 2), array(0 => 63, 1 => 0), array(0 => 66, 1 => 1), array(0 => 66, 1 => 1), array(0 => 66, 1 => 1), array(0 => 66, 1 => 3), array(0 => 66, 1 => 2), array(0 => 67, 1 => 1), array(0 => 67, 1 => 2), array(0 => 67, 1 => 2), array(0 => 70, 1 => 2), array(0 => 69, 1 => 2), array(0 => 72, 1 => 1), array(0 => 72, 1 => 1), array(0 => 72, 1 => 1), array(0 => 68, 1 => 3), array(0 => 68, 1 => 2), array(0 => 68, 1 => 4), array(0 => 68, 1 => 5), array(0 => 68, 1 => 6), array(0 => 68, 1 => 2), array(0 => 68, 1 => 2), array(0 => 68, 1 => 3), array(0 => 68, 1 => 2), array(0 => 68, 1 => 3), array(0 => 68, 1 => 8), array(0 => 80, 1 => 2), array(0 => 80, 1 => 1), array(0 => 68, 1 => 5), array(0 => 68, 1 => 7), array(0 => 68, 1 => 6), array(0 => 68, 1 => 8), array(0 => 68, 1 => 2), array(0 => 68, 1 => 3), array(0 => 68, 1 => 4), array(0 => 66, 1 => 1), array(0 => 68, 1 => 2), array(0 => 68, 1 => 3), array(0 => 68, 1 => 4), array(0 => 68, 1 => 5), array(0 => 73, 1 => 2), array(0 => 73, 1 => 1), array(0 => 73, 1 => 0), array(0 => 83, 1 => 4), array(0 => 83, 1 => 2), array(0 => 83, 1 => 2), array(0 => 83, 1 => 2), array(0 => 83, 1 => 2), array(0 => 83, 1 => 2), array(0 => 83, 1 => 4), array(0 => 79, 1 => 1), array(0 => 79, 1 => 3), array(0 => 78, 1 => 3), array(0 => 78, 1 => 3), array(0 => 78, 1 => 3), array(0 => 78, 1 => 3), array(0 => 76, 1 => 1), array(0 => 76, 1 => 1), array(0 => 76, 1 => 3), array(0 => 76, 1 => 3), array(0 => 76, 1 => 3), array(0 => 76, 1 => 1), array(0 => 76, 1 => 2), array(0 => 76, 1 => 3), array(0 => 76, 1 => 3), array(0 => 76, 1 => 2), array(0 => 76, 1 => 3), array(0 => 76, 1 => 3), array(0 => 84, 1 => 7), array(0 => 84, 1 => 7), array(0 => 75, 1 => 1), array(0 => 75, 1 => 2), array(0 => 75, 1 => 2), array(0 => 75, 1 => 2), array(0 => 75, 1 => 2), array(0 => 75, 1 => 1), array(0 => 75, 1 => 1), array(0 => 75, 1 => 3), array(0 => 75, 1 => 2), array(0 => 75, 1 => 2), array(0 => 75, 1 => 1), array(0 => 75, 1 => 1), array(0 => 75, 1 => 3), array(0 => 75, 1 => 3), array(0 => 75, 1 => 3), array(0 => 75, 1 => 1), array(0 => 75, 1 => 1), array(0 => 75, 1 => 3), array(0 => 75, 1 => 1), array(0 => 75, 1 => 2), array(0 => 75, 1 => 1), array(0 => 75, 1 => 3), array(0 => 90, 1 => 1), array(0 => 90, 1 => 1), array(0 => 74, 1 => 1), array(0 => 74, 1 => 1), array(0 => 74, 1 => 3), array(0 => 74, 1 => 1), array(0 => 74, 1 => 3), array(0 => 74, 1 => 4), array(0 => 74, 1 => 3), array(0 => 74, 1 => 4), array(0 => 71, 1 => 2), array(0 => 71, 1 => 2), array(0 => 94, 1 => 2), array(0 => 94, 1 => 0), array(0 => 95, 1 => 2), array(0 => 95, 1 => 2), array(0 => 95, 1 => 4), array(0 => 95, 1 => 2), array(0 => 95, 1 => 2), array(0 => 95, 1 => 4), array(0 => 95, 1 => 3), array(0 => 95, 1 => 5), array(0 => 95, 1 => 3), array(0 => 95, 1 => 3), array(0 => 95, 1 => 3), array(0 => 95, 1 => 3), array(0 => 95, 1 => 3), array(0 => 95, 1 => 3), array(0 => 95, 1 => 2), array(0 => 81, 1 => 1), array(0 => 81, 1 => 1), array(0 => 81, 1 => 2), array(0 => 96, 1 => 1), array(0 => 96, 1 => 1), array(0 => 96, 1 => 3), array(0 => 93, 1 => 2), array(0 => 97, 1 => 1), array(0 => 97, 1 => 2), array(0 => 98, 1 => 3), array(0 => 98, 1 => 3), array(0 => 98, 1 => 5), array(0 => 98, 1 => 6), array(0 => 98, 1 => 2), array(0 => 89, 1 => 4), array(0 => 99, 1 => 4), array(0 => 99, 1 => 4), array(0 => 100, 1 => 3), array(0 => 100, 1 => 1), array(0 => 100, 1 => 0), array(0 => 77, 1 => 3), array(0 => 77, 1 => 2), array(0 => 101, 1 => 3), array(0 => 101, 1 => 2), array(0 => 82, 1 => 2), array(0 => 82, 1 => 0), array(0 => 102, 1 => 2), array(0 => 102, 1 => 2), array(0 => 92, 1 => 1), array(0 => 92, 1 => 2), array(0 => 92, 1 => 1), array(0 => 92, 1 => 2), array(0 => 92, 1 => 3), array(0 => 87, 1 => 1), array(0 => 87, 1 => 1), array(0 => 86, 1 => 1), array(0 => 88, 1 => 1), array(0 => 85, 1 => 3), array(0 => 103, 1 => 1), array(0 => 103, 1 => 3), array(0 => 103, 1 => 0), array(0 => 104, 1 => 3), array(0 => 104, 1 => 3), array(0 => 104, 1 => 1), array(0 => 91, 1 => 2), array(0 => 91, 1 => 3), array(0 => 105, 1 => 2), array(0 => 105, 1 => 1), array(0 => 106, 1 => 3), array(0 => 106, 1 => 3), array(0 => 106, 1 => 1), array(0 => 106, 1 => 3), array(0 => 106, 1 => 3), array(0 => 106, 1 => 1), array(0 => 106, 1 => 1));
public static $yyReduceMap = array(0 => 0, 1 => 1, 2 => 2, 3 => 3, 4 => 4, 5 => 5, 6 => 6, 7 => 7, 22 => 7, 23 => 7, 24 => 7, 37 => 7, 57 => 7, 58 => 7, 66 => 7, 67 => 7, 71 => 7, 80 => 7, 85 => 7, 86 => 7, 91 => 7, 95 => 7, 96 => 7, 100 => 7, 102 => 7, 107 => 7, 169 => 7, 174 => 7, 8 => 8, 9 => 9, 10 => 10, 12 => 12, 13 => 13, 14 => 14, 15 => 15, 16 => 16, 17 => 17, 18 => 18, 19 => 19, 20 => 20, 21 => 21, 25 => 25, 26 => 26, 27 => 27, 28 => 28, 29 => 29, 30 => 30, 31 => 31, 32 => 32, 34 => 32, 33 => 33, 35 => 35, 36 => 36, 38 => 38, 39 => 39, 40 => 40, 41 => 41, 42 => 42, 43 => 43, 44 => 44, 45 => 45, 46 => 46, 47 => 47, 48 => 48, 49 => 49, 50 => 50, 51 => 51, 60 => 51, 149 => 51, 153 => 51, 157 => 51, 158 => 51, 52 => 52, 150 => 52, 156 => 52, 53 => 53, 54 => 54, 55 => 54, 56 => 56, 134 => 56, 59 => 59, 61 => 61, 62 => 62, 63 => 62, 64 => 64, 65 => 65, 68 => 68, 69 => 69, 70 => 69, 72 => 72, 99 => 72, 73 => 73, 74 => 74, 75 => 75, 76 => 76, 77 => 77, 78 => 78, 79 => 79, 81 => 81, 83 => 81, 84 => 81, 114 => 81, 82 => 82, 87 => 87, 88 => 88, 89 => 89, 90 => 90, 92 => 92, 93 => 93, 94 => 93, 97 => 97, 98 => 98, 101 => 101, 103 => 103, 104 => 104, 105 => 105, 106 => 106, 108 => 108, 109 => 109, 110 => 110, 111 => 111, 112 => 112, 113 => 113, 115 => 115, 171 => 115, 116 => 116, 117 => 117, 118 => 118, 119 => 119, 120 => 120, 121 => 121, 129 => 121, 122 => 122, 123 => 123, 124 => 124, 125 => 124, 127 => 124, 128 => 124, 126 => 126, 130 => 130, 131 => 131, 132 => 132, 175 => 132, 133 => 133, 135 => 135, 136 => 136, 137 => 137, 138 => 138, 139 => 139, 140 => 140, 141 => 141, 142 => 142, 143 => 143, 144 => 144, 145 => 145, 146 => 146, 147 => 147, 148 => 148, 151 => 151, 152 => 152, 154 => 154, 155 => 155, 159 => 159, 160 => 160, 161 => 161, 162 => 162, 163 => 163, 164 => 164, 165 => 165, 166 => 166, 167 => 167, 168 => 168, 170 => 170, 172 => 172, 173 => 173, 176 => 176, 177 => 177, 178 => 178, 179 => 179, 182 => 179, 180 => 180, 183 => 180, 181 => 181, 184 => 184, 185 => 185);
/**
* result status
*
* @var bool
*/
public $successful = \true;
/**
* return value
*
* @var mixed
*/
public $retvalue = 0;
/**
* @var
*/
public $yymajor;
/**
* last index of array variable
*
* @var mixed
*/
public $last_index;
/**
* last variable name
*
* @var string
*/
public $last_variable;
/**
* root parse tree buffer
*
* @var Smarty_Internal_ParseTree_Template
*/
public $root_buffer;
/**
* current parse tree object
*
* @var Smarty_Internal_ParseTree
*/
public $current_buffer;
/**
* lexer object
*
* @var Smarty_Internal_Templatelexer
*/
public $lex;
/**
* {strip} status
*
* @var bool
*/
public $strip = \false;
/**
* compiler object
*
* @var Smarty_Internal_TemplateCompilerBase
*/
public $compiler = \null;
/**
* smarty object
*
* @var Smarty
*/
public $smarty = \null;
/**
* template object
*
* @var Smarty_Internal_Template
*/
public $template = \null;
/**
* block nesting level
*
* @var int
*/
public $block_nesting_level = 0;
/**
* security object
*
* @var Smarty_Security
*/
public $security = \null;
/**
* template prefix array
*
* @var \Smarty_Internal_ParseTree[]
*/
public $template_prefix = array();
/**
* template prefix array
*
* @var \Smarty_Internal_ParseTree[]
*/
public $template_postfix = array();
public $yyTraceFILE;
public $yyTracePrompt;
public $yyidx;
public $yyerrcnt;
public $yystack = array();
public $yyTokenName = array('$', 'VERT', 'COLON', 'UNIMATH', 'PHP', 'TEXT', 'STRIPON', 'STRIPOFF', 'LITERALSTART', 'LITERALEND', 'LITERAL', 'SIMPELOUTPUT', 'SIMPLETAG', 'SMARTYBLOCKCHILDPARENT', 'LDEL', 'RDEL', 'DOLLARID', 'EQUAL', 'ID', 'PTR', 'LDELMAKENOCACHE', 'LDELIF', 'LDELFOR', 'SEMICOLON', 'INCDEC', 'TO', 'STEP', 'LDELFOREACH', 'SPACE', 'AS', 'APTR', 'LDELSETFILTER', 'CLOSETAG', 'LDELSLASH', 'ATTR', 'INTEGER', 'COMMA', 'OPENP', 'CLOSEP', 'MATH', 'ISIN', 'QMARK', 'NOT', 'TYPECAST', 'HEX', 'DOT', 'INSTANCEOF', 'SINGLEQUOTESTRING', 'DOUBLECOLON', 'NAMESPACE', 'AT', 'HATCH', 'OPENB', 'CLOSEB', 'DOLLAR', 'LOGOP', 'SLOGOP', 'TLOGOP', 'SINGLECOND', 'QUOTE', 'BACKTICK', 'error', 'start', 'template', 'literal_e2', 'literal_e1', 'smartytag', 'tagbody', 'tag', 'outattr', 'eqoutattr', 'varindexed', 'output', 'attributes', 'variable', 'value', 'expr', 'modifierlist', 'statement', 'statements', 'foraction', 'varvar', 'modparameters', 'attribute', 'ternary', 'array', 'tlop', 'lop', 'scond', 'function', 'ns1', 'doublequoted_with_quotes', 'static_class_access', 'object', 'arrayindex', 'indexdef', 'varvarele', 'objectchain', 'objectelement', 'method', 'params', 'modifier', 'modparameter', 'arrayelements', 'arrayelement', 'doublequoted', 'doublequotedcontent');
/* Shifts left before out of the error */
/**
* constructor
*
* @param Smarty_Internal_Templatelexer $lex
* @param Smarty_Internal_TemplateCompilerBase $compiler
*/
public function __construct(\Smarty_Internal_Templatelexer $lex, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/* The parser's stack */
public static function yy_destructor($yymajor, $yypminor)
{
}
/**
* insert PHP code in current buffer
*
* @param string $code
*/
public function insertPhpCode($code)
{
}
/**
* error rundown
*
*/
public function errorRunDown()
{
}
/**
* merge PHP code with prefix code and return parse tree tag object
*
* @param string $code
*
* @return Smarty_Internal_ParseTree_Tag
*/
public function mergePrefixCode($code)
{
}
public function Trace($TraceFILE, $zTracePrompt)
{
}
public function PrintTrace()
{
}
public function tokenName($tokenType)
{
}
public function yy_pop_parser_stack()
{
}
public function __destruct()
{
}
public function yy_get_expected_tokens($token)
{
}
public function yy_is_expected_token($token)
{
}
public function yy_find_shift_action($iLookAhead)
{
}
public function yy_find_reduce_action($stateno, $iLookAhead)
{
}
// line 234 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_shift($yyNewState, $yyMajor, $yypMinor)
{
}
// line 242 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r0()
{
}
// line 251 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r1()
{
}
// line 255 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r2()
{
}
// line 259 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r3()
{
}
// line 264 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r4()
{
}
// line 269 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r5()
{
}
// line 272 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r6()
{
}
// line 276 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r7()
{
}
// line 281 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r8()
{
}
// line 285 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r9()
{
}
// line 297 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r10()
{
}
// line 307 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r12()
{
}
// line 328 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r13()
{
}
// line 339 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r14()
{
}
// line 343 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r15()
{
}
// line 347 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r16()
{
}
// line 356 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r17()
{
}
// line 360 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r18()
{
}
// line 364 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r19()
{
}
// line 368 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r20()
{
}
// line 383 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r21()
{
}
// line 393 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r25()
{
}
// line 406 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r26()
{
}
// line 418 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r27()
{
}
// line 423 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r28()
{
}
// line 428 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r29()
{
}
// line 433 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r30()
{
}
// line 438 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r31()
{
}
// line 443 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r32()
{
}
// line 454 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r33()
{
}
// line 458 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r35()
{
}
// line 466 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r36()
{
}
// line 470 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r38()
{
}
// line 475 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r39()
{
}
// line 479 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r40()
{
}
// line 482 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r41()
{
}
// line 487 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r42()
{
}
// line 491 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r43()
{
}
// line 497 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r44()
{
}
// line 506 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r45()
{
}
// line 510 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r46()
{
}
// line 515 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r47()
{
}
// line 519 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r48()
{
}
// line 527 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r49()
{
}
// line 533 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r50()
{
}
// line 538 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r51()
{
}
// line 543 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r52()
{
}
// line 554 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r53()
{
}
// line 562 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r54()
{
}
// line 574 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r56()
{
}
// line 587 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r59()
{
}
// line 592 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r61()
{
}
// line 599 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r62()
{
}
// line 603 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r64()
{
}
// line 623 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r65()
{
}
// line 628 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r68()
{
}
// line 642 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r69()
{
}
// line 648 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r72()
{
}
// line 652 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r73()
{
}
// line 656 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r74()
{
}
// line 660 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r75()
{
}
// line 664 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r76()
{
}
// line 672 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r77()
{
}
// line 676 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r78()
{
}
// line 686 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r79()
{
}
// line 691 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r81()
{
}
// line 712 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r82()
{
}
// line 716 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r87()
{
}
// line 720 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r88()
{
}
// line 725 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r89()
{
}
// line 742 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r90()
{
}
// line 746 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r92()
{
}
// line 764 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r93()
{
}
// line 775 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r97()
{
}
// line 792 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r98()
{
}
// line 811 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r101()
{
}
// line 822 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r103()
{
}
// line 825 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r104()
{
}
// line 838 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r105()
{
}
// line 848 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r106()
{
}
// line 852 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r108()
{
}
// line 856 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r109()
{
}
// line 860 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r110()
{
}
// line 864 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r111()
{
}
// line 867 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r112()
{
}
// line 880 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r113()
{
}
// line 886 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r115()
{
}
// line 889 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r116()
{
}
// line 893 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r117()
{
}
// line 897 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r118()
{
}
// line 901 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r119()
{
}
// line 906 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r120()
{
}
// line 911 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r121()
{
}
// line 915 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r122()
{
}
// line 918 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r123()
{
}
// line 924 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r124()
{
}
// line 940 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r126()
{
}
// line 950 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r130()
{
}
// line 954 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r131()
{
}
// line 959 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r132()
{
}
// line 967 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r133()
{
}
// line 973 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r135()
{
}
// line 980 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r136()
{
}
// line 989 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r137()
{
}
// line 994 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r138()
{
}
// line 999 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r139()
{
}
// line 1006 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r140()
{
}
// line 1013 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r141()
{
}
// line 1020 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r142()
{
}
// line 1028 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r143()
{
}
// line 1036 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r144()
{
}
// line 1044 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r145()
{
}
// line 1051 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r146()
{
}
// line 1062 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r147()
{
}
// line 1079 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r148()
{
}
// line 1083 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r151()
{
}
// line 1091 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r152()
{
}
// line 1099 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r154()
{
}
// line 1118 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r155()
{
}
// line 1123 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r159()
{
}
// line 1128 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r160()
{
}
// line 1133 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r161()
{
}
// line 1138 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r162()
{
}
// line 1144 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r163()
{
}
// line 1148 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r164()
{
}
// line 1167 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r165()
{
}
// line 1180 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r166()
{
}
// line 1194 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r167()
{
}
// line 1202 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r168()
{
}
// line 1210 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r170()
{
}
// line 1214 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r172()
{
}
// line 1230 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r173()
{
}
// line 1236 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r176()
{
}
// line 1241 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r177()
{
}
// line 1245 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r178()
{
}
// line 1249 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r179()
{
}
// line 1253 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r180()
{
}
// line 1265 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r181()
{
}
// line 1269 "../smarty/lexer/smarty_internal_templateparser.y"
public function yy_r184()
{
}
public function yy_r185()
{
}
public function yy_reduce($yyruleno)
{
}
public function yy_parse_failed()
{
}
public function yy_syntax_error($yymajor, $TOKEN)
{
}
public function yy_accept()
{
}
public function doParse($yymajor, $yytokenvalue)
{
}
}
/**
* Smarty Method ClearAssign
*
* Smarty::clearAssign() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_ClearAssign
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* clear the given assigned template variable(s).
*
* @api Smarty::clearAssign()
* @link http://www.smarty.net/docs/en/api.clear.assign.tpl
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param string|array $tpl_var the template variable(s) to clear
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public function clearAssign(\Smarty_Internal_Data $data, $tpl_var)
{
}
}
/**
* Smarty Method SetDefaultModifiers
*
* Smarty::setDefaultModifiers() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_SetDefaultModifiers
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Set default modifiers
*
* @api Smarty::setDefaultModifiers()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param array|string $modifiers modifier or list of modifiers
* to set
*
* @return \Smarty|\Smarty_Internal_Template
*/
public function setDefaultModifiers(\Smarty_Internal_TemplateBase $obj, $modifiers)
{
}
}
/**
* Smarty Method RegisterCacheResource
*
* Smarty::registerCacheResource() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_RegisterCacheResource
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers a resource to fetch a template
*
* @api Smarty::registerCacheResource()
* @link http://www.smarty.net/docs/en/api.register.cacheresource.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $name name of resource type
* @param \Smarty_CacheResource $resource_handler
*
* @return \Smarty|\Smarty_Internal_Template
*/
public function registerCacheResource(\Smarty_Internal_TemplateBase $obj, $name, \Smarty_CacheResource $resource_handler)
{
}
}
/**
* Smarty Internal Plugin Resource File
*
* @package Smarty
* @subpackage TemplateResources
* @author Uwe Tews
* @author Rodney Rehm
*/
/**
* Smarty Internal Plugin Resource File
* Implements the file system as resource for Smarty templates
*
* @package Smarty
* @subpackage TemplateResources
*/
class Smarty_Internal_Resource_File extends \Smarty_Resource
{
/**
* populate Source Object with meta data from Resource
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*
* @throws \SmartyException
*/
public function populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = \null)
{
}
/**
* populate Source Object with timestamp and exists from Resource
*
* @param Smarty_Template_Source $source source object
*/
public function populateTimestamp(\Smarty_Template_Source $source)
{
}
/**
* Load template's source from file into current template object
*
* @param Smarty_Template_Source $source source object
*
* @return string template source
* @throws SmartyException if source cannot be loaded
*/
public function getContent(\Smarty_Template_Source $source)
{
}
/**
* Determine basename for compiled filename
*
* @param Smarty_Template_Source $source source object
*
* @return string resource's basename
*/
public function getBasename(\Smarty_Template_Source $source)
{
}
/**
* build template filepath by traversing the template_dir array
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*
* @return string fully qualified filepath
* @throws SmartyException
*/
protected function buildFilepath(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = \null)
{
}
}
/**
* Smarty Internal Plugin Resource PHP
* Implements the file system as resource for PHP templates
*
* @package Smarty
* @subpackage TemplateResources
* @author Uwe Tews
* @author Rodney Rehm
*/
class Smarty_Internal_Resource_Php extends \Smarty_Internal_Resource_File
{
/**
* Flag that it's an uncompiled resource
*
* @var bool
*/
public $uncompiled = \true;
/**
* Resource does implement populateCompiledFilepath() method
*
* @var bool
*/
public $hasCompiledHandler = \true;
/**
* container for short_open_tag directive's value before executing PHP templates
*
* @var string
*/
protected $short_open_tag;
/**
* Create a new PHP Resource
*/
public function __construct()
{
}
/**
* Load template's source from file into current template object
*
* @param Smarty_Template_Source $source source object
*
* @return string template source
* @throws SmartyException if source cannot be loaded
*/
public function getContent(\Smarty_Template_Source $source)
{
}
/**
* populate compiled object with compiled filepath
*
* @param Smarty_Template_Compiled $compiled compiled object
* @param Smarty_Internal_Template $_template template object (is ignored)
*/
public function populateCompiledFilepath(\Smarty_Template_Compiled $compiled, \Smarty_Internal_Template $_template)
{
}
/**
* Render and output the template (without using the compiler)
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*
* @return void
* @throws SmartyException if template cannot be loaded or allow_php_templates is disabled
*/
public function renderUncompiled(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template)
{
}
}
/**
* Smarty Internal Plugin Resource Eval
*
* @package Smarty
* @subpackage TemplateResources
* @author Uwe Tews
* @author Rodney Rehm
*/
/**
* Smarty Internal Plugin Resource Eval
* Implements the strings as resource for Smarty template
* {@internal unlike string-resources the compiled state of eval-resources is NOT saved for subsequent access}}
*
* @package Smarty
* @subpackage TemplateResources
*/
class Smarty_Internal_Resource_Eval extends \Smarty_Resource_Recompiled
{
/**
* populate Source Object with meta data from Resource
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*
* @return void
*/
public function populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = \null)
{
}
/**
* Load template's source from $resource_name into current template object
*
* @uses decode() to decode base64 and urlencoded template_resources
*
* @param Smarty_Template_Source $source source object
*
* @return string template source
*/
public function getContent(\Smarty_Template_Source $source)
{
}
/**
* decode base64 and urlencode
*
* @param string $string template_resource to decode
*
* @return string decoded template_resource
*/
protected function decode($string)
{
}
/**
* modify resource_name according to resource handlers specifications
*
* @param Smarty $smarty Smarty instance
* @param string $resource_name resource_name to make unique
* @param boolean $isConfig flag for config resource
*
* @return string unique resource name
*/
public function buildUniqueResourceName(\Smarty $smarty, $resource_name, $isConfig = \false)
{
}
/**
* Determine basename for compiled filename
*
* @param Smarty_Template_Source $source source object
*
* @return string resource's basename
*/
public function getBasename(\Smarty_Template_Source $source)
{
}
}
/**
* Smarty Method GetRegisteredObject
*
* Smarty::getRegisteredObject() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_GetRegisteredObject
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* return a reference to a registered object
*
* @api Smarty::getRegisteredObject()
* @link http://www.smarty.net/docs/en/api.get.registered.object.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $object_name object name
*
* @return object
* @throws \SmartyException if no such object is found
*/
public function getRegisteredObject(\Smarty_Internal_TemplateBase $obj, $object_name)
{
}
}
/**
* Smarty Method CompileAllTemplates
*
* Smarty::compileAllTemplates() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_CompileAllTemplates
{
/**
* Valid for Smarty object
*
* @var int
*/
public $objMap = 1;
/**
* Compile all template files
*
* @api Smarty::compileAllTemplates()
*
* @param \Smarty $smarty passed smarty object
* @param string $extension file extension
* @param bool $force_compile force all to recompile
* @param int $time_limit
* @param int $max_errors
*
* @return integer number of template files recompiled
*/
public function compileAllTemplates(\Smarty $smarty, $extension = '.tpl', $force_compile = \false, $time_limit = 0, $max_errors = \null)
{
}
/**
* Compile all template or config files
*
* @param \Smarty $smarty
* @param string $extension template file name extension
* @param bool $force_compile force all to recompile
* @param int $time_limit set maximum execution time
* @param int $max_errors set maximum allowed errors
* @param bool $isConfig flag true if called for config files
*
* @return int number of template files compiled
*/
protected function compileAll(\Smarty $smarty, $extension, $force_compile, $time_limit, $max_errors, $isConfig = \false)
{
}
}
/**
* Smarty Internal Plugin Compile Assign
* Compiles the {assign} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Assign Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Assign extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $option_flags = array('nocache', 'noscope');
/**
* Valid scope names
*
* @var array
*/
public $valid_scopes = array('local' => \Smarty::SCOPE_LOCAL, 'parent' => \Smarty::SCOPE_PARENT, 'root' => \Smarty::SCOPE_ROOT, 'global' => \Smarty::SCOPE_GLOBAL, 'tpl_root' => \Smarty::SCOPE_TPL_ROOT, 'smarty' => \Smarty::SCOPE_SMARTY);
/**
* Compiles code for the {assign} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile Append
* Compiles the {append} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Append Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Append extends \Smarty_Internal_Compile_Assign
{
/**
* Compiles code for the {append} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Method LoadFilter
*
* Smarty::loadFilter() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_LoadFilter
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* load a filter of specified type and name
*
* @api Smarty::loadFilter()
*
* @link http://www.smarty.net/docs/en/api.load.filter.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $type filter type
* @param string $name filter name
*
* @return bool
* @throws SmartyException if filter could not be loaded
*/
public function loadFilter(\Smarty_Internal_TemplateBase $obj, $type, $name)
{
}
/**
* Check if filter type is valid
*
* @param string $type
*
* @throws \SmartyException
*/
public function _checkFilterType($type)
{
}
}
/**
* Smarty Internal Plugin Template
* This file contains the Smarty template engine
*
* @package Smarty
* @subpackage Template
* @author Uwe Tews
*/
/**
* Main class with template data structures and methods
*
* @package Smarty
* @subpackage Template
*
* @property Smarty_Template_Compiled $compiled
* @property Smarty_Template_Cached $cached
* @property Smarty_Internal_TemplateCompilerBase $compiler
* @property mixed|\Smarty_Template_Cached registered_plugins
*
* The following methods will be dynamically loaded by the extension handler when they are called.
* They are located in a corresponding Smarty_Internal_Method_xxxx class
*
* @method bool mustCompile()
*/
class Smarty_Internal_Template extends \Smarty_Internal_TemplateBase
{
/**
* Template object cache
*
* @var Smarty_Internal_Template[]
*/
public static $tplObjCache = array();
/**
* Template object cache for Smarty::isCached() === true
*
* @var Smarty_Internal_Template[]
*/
public static $isCacheTplObj = array();
/**
* Sub template Info Cache
* - index name
* - value use count
*
* @var int[]
*/
public static $subTplInfo = array();
/**
* This object type (Smarty = 1, template = 2, data = 4)
*
* @var int
*/
public $_objType = 2;
/**
* Global smarty instance
*
* @var Smarty
*/
public $smarty = \null;
/**
* Source instance
*
* @var Smarty_Template_Source|Smarty_Template_Config
*/
public $source = \null;
/**
* Inheritance runtime extension
*
* @var Smarty_Internal_Runtime_Inheritance
*/
public $inheritance = \null;
/**
* Template resource
*
* @var string
*/
public $template_resource = \null;
/**
* flag if compiled template is invalid and must be (re)compiled
*
* @var bool
*/
public $mustCompile = \null;
/**
* Template Id
*
* @var null|string
*/
public $templateId = \null;
/**
* Scope in which variables shall be assigned
*
* @var int
*/
public $scope = 0;
/**
* Flag which is set while rending a cache file
*
* @var bool
*/
public $isRenderingCache = \false;
/**
* Callbacks called before rendering template
*
* @var callback[]
*/
public $startRenderCallbacks = array();
/**
* Callbacks called after rendering template
*
* @var callback[]
*/
public $endRenderCallbacks = array();
/**
* Create template data object
* Some of the global Smarty settings copied to template scope
* It load the required template resources and caching plugins
*
* @param string $template_resource template resource string
* @param Smarty $smarty Smarty instance
* @param null|\Smarty_Internal_Template|\Smarty|\Smarty_Internal_Data $_parent back pointer to parent
* object with variables or
* null
* @param mixed $_cache_id cache id or null
* @param mixed $_compile_id compile id or null
* @param bool|int|null $_caching use caching?
* @param int|null $_cache_lifetime cache life-time in
* seconds
* @param bool $_isConfig
*
* @throws \SmartyException
*/
public function __construct($template_resource, \Smarty $smarty, \Smarty_Internal_Data $_parent = \null, $_cache_id = \null, $_compile_id = \null, $_caching = \null, $_cache_lifetime = \null, $_isConfig = \false)
{
}
/**
* render template
*
* @param bool $no_output_filter if true do not run output filter
* @param null|bool $display true: display, false: fetch null: sub-template
*
* @return string
* @throws \Exception
* @throws \SmartyException
*/
public function render($no_output_filter = \true, $display = \null)
{
}
/**
* Runtime function to render sub-template
*
* @param string $template template name
* @param mixed $cache_id cache id
* @param mixed $compile_id compile id
* @param integer $caching cache mode
* @param integer $cache_lifetime life time of cache data
* @param array $data passed parameter template variables
* @param int $scope scope in which {include} should execute
* @param bool $forceTplCache cache template object
* @param string $uid file dependency uid
* @param string $content_func function name
*
* @throws \Exception
* @throws \SmartyException
*/
public function _subTemplateRender($template, $cache_id, $compile_id, $caching, $cache_lifetime, $data, $scope, $forceTplCache, $uid = \null, $content_func = \null)
{
}
/**
* Get called sub-templates and save call count
*/
public function _subTemplateRegister()
{
}
/**
* Check if this is a sub template
*
* @return bool true is sub template
*/
public function _isSubTpl()
{
}
/**
* Assign variable in scope
*
* @param string $varName variable name
* @param mixed $value value
* @param bool $nocache nocache flag
* @param int $scope scope into which variable shall be assigned
*/
public function _assignInScope($varName, $value, $nocache = \false, $scope = 0)
{
}
/**
* Check if plugins are callable require file otherwise
*
* @param array $plugins required plugins
*
* @throws \SmartyException
*/
public function _checkPlugins($plugins)
{
}
/**
* This function is executed automatically when a compiled or cached template file is included
* - Decode saved properties from compiled template and cache files
* - Check if compiled or cache file is valid
*
* @param \Smarty_Internal_Template $tpl
* @param array $properties special template properties
* @param bool $cache flag if called from cache file
*
* @return bool flag if compiled or cache file is valid
* @throws \SmartyException
*/
public function _decodeProperties(\Smarty_Internal_Template $tpl, $properties, $cache = \false)
{
}
/**
* Compiles the template
* If the template is not evaluated the compiled template is saved on disk
*
* @throws \Exception
*/
public function compileTemplateSource()
{
}
/**
* Writes the content to cache resource
*
* @param string $content
*
* @return bool
*/
public function writeCachedContent($content)
{
}
/**
* Get unique template id
*
* @return string
* @throws \SmartyException
*/
public function _getTemplateId()
{
}
/**
* runtime error not matching capture tags
*
* @throws \SmartyException
*/
public function capture_error()
{
}
/**
* Load compiled object
*
* @param bool $force force new compiled object
*/
public function loadCompiled($force = \false)
{
}
/**
* Load cached object
*
* @param bool $force force new cached object
*/
public function loadCached($force = \false)
{
}
/**
* Load inheritance object
*/
public function _loadInheritance()
{
}
/**
* Unload inheritance object
*/
public function _cleanUp()
{
}
/**
* Load compiler object
*
* @throws \SmartyException
*/
public function loadCompiler()
{
}
/**
* Handle unknown class methods
*
* @param string $name unknown method-name
* @param array $args argument array
*
* @return mixed
*/
public function __call($name, $args)
{
}
/**
* get Smarty property in template context
*
* @param string $property_name property name
*
* @return mixed|Smarty_Template_Cached
* @throws SmartyException
*/
public function __get($property_name)
{
}
/**
* set Smarty property in template context
*
* @param string $property_name property name
* @param mixed $value value
*
* @throws SmartyException
*/
public function __set($property_name, $value)
{
}
/**
* Template data object destructor
*/
public function __destruct()
{
}
}
/**
* Smarty Method GetStreamVariable
*
* Smarty::getStreamVariable() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_GetStreamVariable
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* gets a stream variable
*
* @api Smarty::getStreamVariable()
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param string $variable the stream of the variable
*
* @return mixed
* @throws \SmartyException
*/
public function getStreamVariable(\Smarty_Internal_Data $data, $variable)
{
}
}
/**
* Smarty write file plugin
*
* @package Smarty
* @subpackage PluginsInternal
* @author Monte Ohrt
*/
/**
* Smarty Internal Write File Class
*
* @package Smarty
* @subpackage PluginsInternal
*/
class Smarty_Internal_Runtime_WriteFile
{
/**
* Writes file in a safe way to disk
*
* @param string $_filepath complete filepath
* @param string $_contents file content
* @param Smarty $smarty smarty instance
*
* @throws SmartyException
* @return boolean true
*/
public function writeFile($_filepath, $_contents, \Smarty $smarty)
{
}
}
/**
* Smarty Method ClearCompiledTemplate
*
* Smarty::clearCompiledTemplate() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_ClearCompiledTemplate
{
/**
* Valid for Smarty object
*
* @var int
*/
public $objMap = 1;
/**
* Delete compiled template file
*
* @api Smarty::clearCompiledTemplate()
* @link http://www.smarty.net/docs/en/api.clear.compiled.template.tpl
*
* @param \Smarty $smarty
* @param string $resource_name template name
* @param string $compile_id compile id
* @param integer $exp_time expiration time
*
* @return int number of template files deleted
* @throws \SmartyException
*/
public function clearCompiledTemplate(\Smarty $smarty, $resource_name = \null, $compile_id = \null, $exp_time = \null)
{
}
}
/**
* Smarty Internal Plugin
*
* @package Smarty
* @subpackage Cacher
*/
/**
* Cache Handler API
*
* @package Smarty
* @subpackage Cacher
* @author Rodney Rehm
*/
abstract class Smarty_CacheResource
{
/**
* resource types provided by the core
*
* @var array
*/
protected static $sysplugins = array('file' => 'smarty_internal_cacheresource_file.php');
/**
* populate Cached Object with meta data from Resource
*
* @param \Smarty_Template_Cached $cached cached object
* @param Smarty_Internal_Template $_template template object
*
* @return void
*/
public abstract function populate(\Smarty_Template_Cached $cached, \Smarty_Internal_Template $_template);
/**
* populate Cached Object with timestamp and exists from Resource
*
* @param Smarty_Template_Cached $cached
*
* @return void
*/
public abstract function populateTimestamp(\Smarty_Template_Cached $cached);
/**
* Read the cached template and process header
*
* @param Smarty_Internal_Template $_template template object
* @param Smarty_Template_Cached $cached cached object
* @param boolean $update flag if called because cache update
*
* @return boolean true or false if the cached content does not exist
*/
public abstract function process(\Smarty_Internal_Template $_template, \Smarty_Template_Cached $cached = \null, $update = \false);
/**
* Write the rendered template output to cache
*
* @param Smarty_Internal_Template $_template template object
* @param string $content content to cache
*
* @return boolean success
*/
public abstract function writeCachedContent(\Smarty_Internal_Template $_template, $content);
/**
* Read cached template from cache
*
* @param Smarty_Internal_Template $_template template object
*
* @return string content
*/
public abstract function readCachedContent(\Smarty_Internal_Template $_template);
/**
* Return cached content
*
* @param Smarty_Internal_Template $_template template object
*
* @return null|string
*/
public function getCachedContent(\Smarty_Internal_Template $_template)
{
}
/**
* Empty cache
*
* @param Smarty $smarty Smarty object
* @param integer $exp_time expiration time (number of seconds, not timestamp)
*
* @return integer number of cache files deleted
*/
public abstract function clearAll(\Smarty $smarty, $exp_time = \null);
/**
* Empty cache for a specific template
*
* @param Smarty $smarty Smarty object
* @param string $resource_name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param integer $exp_time expiration time (number of seconds, not timestamp)
*
* @return integer number of cache files deleted
*/
public abstract function clear(\Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time);
/**
* @param Smarty $smarty
* @param Smarty_Template_Cached $cached
*
* @return bool|null
*/
public function locked(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Check is cache is locked for this template
*
* @param Smarty $smarty
* @param Smarty_Template_Cached $cached
*
* @return bool
*/
public function hasLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Lock cache for this template
*
* @param Smarty $smarty
* @param Smarty_Template_Cached $cached
*
* @return bool
*/
public function acquireLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Unlock cache for this template
*
* @param Smarty $smarty
* @param Smarty_Template_Cached $cached
*
* @return bool
*/
public function releaseLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Load Cache Resource Handler
*
* @param Smarty $smarty Smarty object
* @param string $type name of the cache resource
*
* @throws SmartyException
* @return Smarty_CacheResource Cache Resource Handler
*/
public static function load(\Smarty $smarty, $type = \null)
{
}
}
/**
* Smarty Internal Plugin Filter Handler
* Smarty filter handler class
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
/**
* Class for filter processing
*
* @package Smarty
* @subpackage PluginsInternal
*/
class Smarty_Internal_Runtime_FilterHandler
{
/**
* Run filters over content
* The filters will be lazy loaded if required
* class name format: Smarty_FilterType_FilterName
* plugin filename format: filtertype.filtername.php
* Smarty2 filter plugins could be used
*
* @param string $type the type of filter ('pre','post','output') which shall run
* @param string $content the content which shall be processed by the filters
* @param Smarty_Internal_Template $template template object
*
* @throws SmartyException
* @return string the filtered content
*/
public function runFilter($type, $content, \Smarty_Internal_Template $template)
{
}
}
/**
* Smarty Internal Plugin Compile PHP Expression
* Compiles any tag which will output an expression or variable
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile PHP Expression Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_Php extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('code', 'type');
/**
* Compiles code for generating output from any expression
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
/**
* Lexer code for PHP tags
*
* This code has been moved from lexer here fo easier debugging and maintenance
*
* @param Smarty_Internal_Templatelexer $lex
*
* @throws \SmartyCompilerException
*/
public function parsePhp(\Smarty_Internal_Templatelexer $lex)
{
}
}
/**
* {make_nocache} Runtime Methods save(), store()
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Runtime_Make_Nocache
{
/**
* Save current variable value while rendering compiled template and inject nocache code to
* assign variable value in cahed template
*
* @param \Smarty_Internal_Template $tpl
* @param string $var variable name
*
* @throws \SmartyException
*/
public function save(\Smarty_Internal_Template $tpl, $var)
{
}
/**
* Store variable value saved while rendering compiled template in cached template context
*
* @param \Smarty_Internal_Template $tpl
* @param string $var variable name
* @param array $properties
*/
public function store(\Smarty_Internal_Template $tpl, $var, $properties)
{
}
}
/**
* Smarty Method ClearAllAssign
*
* Smarty::clearAllAssign() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_ClearAllAssign
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* clear all the assigned template variables.
*
* @api Smarty::clearAllAssign()
* @link http://www.smarty.net/docs/en/api.clear.all.assign.tpl
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public function clearAllAssign(\Smarty_Internal_Data $data)
{
}
}
/**
* Runtime Extension Capture
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Runtime_Capture
{
/**
* Flag that this instance will not be cached
*
* @var bool
*/
public $isPrivateExtension = \true;
/**
* Open capture section
*
* @param \Smarty_Internal_Template $_template
* @param string $buffer capture name
* @param string $assign variable name
* @param string $append variable name
*/
public function open(\Smarty_Internal_Template $_template, $buffer, $assign, $append)
{
}
/**
* Start render callback
*
* @param \Smarty_Internal_Template $_template
*/
public function startRender(\Smarty_Internal_Template $_template)
{
}
/**
* Close capture section
*
* @param \Smarty_Internal_Template $_template
*
* @throws \SmartyException
*/
public function close(\Smarty_Internal_Template $_template)
{
}
/**
* Error exception on not matching {capture}{/capture}
*
* @param \Smarty_Internal_Template $_template
*
* @throws \SmartyException
*/
public function error(\Smarty_Internal_Template $_template)
{
}
/**
* Return content of named capture buffer by key or as array
*
* @param \Smarty_Internal_Template $_template
* @param string|null $name
*
* @return string|string[]|null
*/
public function getBuffer(\Smarty_Internal_Template $_template, $name = \null)
{
}
/**
* End render callback
*
* @param \Smarty_Internal_Template $_template
*
* @throws \SmartyException
*/
public function endRender(\Smarty_Internal_Template $_template)
{
}
}
/**
* Smarty Internal Plugin Compile Debug
* Compiles the {debug} tag.
* It opens a window the the Smarty Debugging Console.
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Debug Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Debug extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {debug} tag
*
* @param array $args array with attributes from parser
* @param object $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, $compiler)
{
}
}
/**
* This file is part of Smarty.
*
* (c) 2015 Uwe Tews
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* Smarty Internal Plugin Compile Block Class
*
* @author Uwe Tews <uwe.tews@googlemail.com>
*/
class Smarty_Internal_Compile_Block extends \Smarty_Internal_Compile_Shared_Inheritance
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('name');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('name');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $option_flags = array('hide', 'nocache');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('assign');
/**
* Compiles code for the {block} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile BlockClose Class
*/
class Smarty_Internal_Compile_Blockclose extends \Smarty_Internal_Compile_Shared_Inheritance
{
/**
* Compiles code for the {/block} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return bool true
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile Function Plugin
* Compiles code for the execution of function plugin
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Function Plugin Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_Function_Plugin extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array();
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('_any');
/**
* Compiles code for the execution of function plugin
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
* @param string $tag name of function plugin
* @param string $function PHP function name
*
* @return string compiled code
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter, $tag, $function)
{
}
}
/**
* Created by PhpStorm.
* User: Uwe Tews
* Date: 04.12.2014
* Time: 06:08
*/
/**
* Smarty Resource Data Object
* Cache Data Container for Template Files
*
* @package Smarty
* @subpackage TemplateResources
* @author Rodney Rehm
*/
class Smarty_Template_Cached extends \Smarty_Template_Resource_Base
{
/**
* Cache Is Valid
*
* @var boolean
*/
public $valid = \null;
/**
* CacheResource Handler
*
* @var Smarty_CacheResource
*/
public $handler = \null;
/**
* Template Cache Id (Smarty_Internal_Template::$cache_id)
*
* @var string
*/
public $cache_id = \null;
/**
* saved cache lifetime in seconds
*
* @var integer
*/
public $cache_lifetime = 0;
/**
* Id for cache locking
*
* @var string
*/
public $lock_id = \null;
/**
* flag that cache is locked by this instance
*
* @var bool
*/
public $is_locked = \false;
/**
* Source Object
*
* @var Smarty_Template_Source
*/
public $source = \null;
/**
* Nocache hash codes of processed compiled templates
*
* @var array
*/
public $hashes = array();
/**
* Flag if this is a cache resource
*
* @var bool
*/
public $isCache = \true;
/**
* create Cached Object container
*
* @param Smarty_Internal_Template $_template template object
*
* @throws \SmartyException
*/
public function __construct(\Smarty_Internal_Template $_template)
{
}
/**
* @param Smarty_Internal_Template $_template
*
* @return Smarty_Template_Cached
*/
public static function load(\Smarty_Internal_Template $_template)
{
}
/**
* Render cache template
*
* @param \Smarty_Internal_Template $_template
* @param bool $no_output_filter
*
* @throws \Exception
*/
public function render(\Smarty_Internal_Template $_template, $no_output_filter = \true)
{
}
/**
* Check if cache is valid, lock cache if required
*
* @param \Smarty_Internal_Template $_template
*
* @return bool flag true if cache is valid
*/
public function isCached(\Smarty_Internal_Template $_template)
{
}
/**
* Process cached template
*
* @param Smarty_Internal_Template $_template template object
* @param bool $update flag if called because cache update
*/
public function process(\Smarty_Internal_Template $_template, $update = \false)
{
}
/**
* Read cache content from handler
*
* @param Smarty_Internal_Template $_template template object
*
* @return string|false content
*/
public function read(\Smarty_Internal_Template $_template)
{
}
}
/**
* Inline Runtime Methods render, setSourceByUid, setupSubTemplate
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
**/
class Smarty_Internal_Runtime_UpdateCache
{
/**
* check client side cache
*
* @param \Smarty_Template_Cached $cached
* @param Smarty_Internal_Template $_template
* @param string $content
*/
public function cacheModifiedCheck(\Smarty_Template_Cached $cached, \Smarty_Internal_Template $_template, $content)
{
}
/**
* Cache was invalid , so render from compiled and write to cache
*
* @param \Smarty_Template_Cached $cached
* @param \Smarty_Internal_Template $_template
* @param $no_output_filter
*
* @throws \Exception
*/
public function updateCache(\Smarty_Template_Cached $cached, \Smarty_Internal_Template $_template, $no_output_filter)
{
}
/**
* Sanitize content and write it to cache resource
*
* @param \Smarty_Template_Cached $cached
* @param Smarty_Internal_Template $_template
* @param bool $no_output_filter
*
* @throws \SmartyException
*/
public function removeNoCacheHash(\Smarty_Template_Cached $cached, \Smarty_Internal_Template $_template, $no_output_filter)
{
}
/**
* Writes the content to cache resource
*
* @param Smarty_Internal_Template $_template
* @param string $content
*
* @return bool
*/
public function writeCachedContent(\Smarty_Internal_Template $_template, $content)
{
}
/**
* Write this cache object to handler
*
* @param Smarty_Internal_Template $_template template object
* @param string $content content to cache
*
* @return bool success
*/
public function write(\Smarty_Internal_Template $_template, $content)
{
}
}
/**
* Smarty Internal Plugin Compile While
* Compiles the {while} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile While Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_While extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {while} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile Whileclose Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Whileclose extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {/while} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Function_Call
* Compiles the calls of user defined tags defined by {function}
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Function_Call Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Call extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('name');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('name');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('_any');
/**
* Compiles the calls of user defined tags defined by {function}
*
* @param array $args array with attributes from parser
* @param object $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, $compiler)
{
}
}
/**
* Smarty Method UnloadFilter
*
* Smarty::unloadFilter() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_UnloadFilter extends \Smarty_Internal_Method_LoadFilter
{
/**
* load a filter of specified type and name
*
* @api Smarty::unloadFilter()
*
* @link http://www.smarty.net/docs/en/api.unload.filter.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $type filter type
* @param string $name filter name
*
* @return Smarty_Internal_TemplateBase
* @throws \SmartyException
*/
public function unloadFilter(\Smarty_Internal_TemplateBase $obj, $type, $name)
{
}
}
/**
* Smarty Internal Plugin Compile Eval
* Compiles the {eval} tag.
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Eval Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Eval extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('var');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('assign');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('var', 'assign');
/**
* Compiles code for the {eval} tag
*
* @param array $args array with attributes from parser
* @param object $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, $compiler)
{
}
}
/**
* Smarty Internal Plugin CacheResource File
*
* @package Smarty
* @subpackage Cacher
* @author Uwe Tews
* @author Rodney Rehm
*/
/**
* This class does contain all necessary methods for the HTML cache on file system
* Implements the file system as resource for the HTML cache Version ussing nocache inserts.
*
* @package Smarty
* @subpackage Cacher
*/
class Smarty_Internal_CacheResource_File extends \Smarty_CacheResource
{
/**
* populate Cached Object with meta data from Resource
*
* @param Smarty_Template_Cached $cached cached object
* @param Smarty_Internal_Template $_template template object
*
* @return void
*/
public function populate(\Smarty_Template_Cached $cached, \Smarty_Internal_Template $_template)
{
}
/**
* populate Cached Object with timestamp and exists from Resource
*
* @param Smarty_Template_Cached $cached cached object
*
* @return void
*/
public function populateTimestamp(\Smarty_Template_Cached $cached)
{
}
/**
* Read the cached template and process its header
*
* @param \Smarty_Internal_Template $_smarty_tpl do not change variable name, is used by compiled template
* @param Smarty_Template_Cached $cached cached object
* @param bool $update flag if called because cache update
*
* @return boolean true or false if the cached content does not exist
*/
public function process(\Smarty_Internal_Template $_smarty_tpl, \Smarty_Template_Cached $cached = \null, $update = \false)
{
}
/**
* Write the rendered template output to cache
*
* @param Smarty_Internal_Template $_template template object
* @param string $content content to cache
*
* @return bool success
* @throws \SmartyException
*/
public function writeCachedContent(\Smarty_Internal_Template $_template, $content)
{
}
/**
* Read cached template from cache
*
* @param Smarty_Internal_Template $_template template object
*
* @return string content
*/
public function readCachedContent(\Smarty_Internal_Template $_template)
{
}
/**
* Empty cache
*
* @param Smarty $smarty
* @param integer $exp_time expiration time (number of seconds, not timestamp)
*
* @return integer number of cache files deleted
*/
public function clearAll(\Smarty $smarty, $exp_time = \null)
{
}
/**
* Empty cache for a specific template
*
* @param Smarty $smarty
* @param string $resource_name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param integer $exp_time expiration time (number of seconds, not timestamp)
*
* @return integer number of cache files deleted
*/
public function clear(\Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)
{
}
/**
* Check is cache is locked for this template
*
* @param Smarty $smarty Smarty object
* @param Smarty_Template_Cached $cached cached object
*
* @return boolean true or false if cache is locked
*/
public function hasLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Lock cache for this template
*
* @param Smarty $smarty Smarty object
* @param Smarty_Template_Cached $cached cached object
*
* @return bool|void
*/
public function acquireLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Unlock cache for this template
*
* @param Smarty $smarty Smarty object
* @param Smarty_Template_Cached $cached cached object
*
* @return bool|void
*/
public function releaseLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
}
/**
* Smarty Method RegisterObject
*
* Smarty::registerObject() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_RegisterObject
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers object to be used in templates
*
* @api Smarty::registerObject()
* @link http://www.smarty.net/docs/en/api.register.object.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $object_name
* @param object $object the
* referenced
* PHP
* object
* to
* register
*
* @param array $allowed_methods_properties list of
* allowed
* methods
* (empty
* = all)
*
* @param bool $format smarty
* argument
* format,
* else
* traditional
*
* @param array $block_methods list of
* block-methods
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function registerObject(\Smarty_Internal_TemplateBase $obj, $object_name, $object, $allowed_methods_properties = array(), $format = \true, $block_methods = array())
{
}
}
/**
* Smarty Internal Plugin Templateparser Parse Tree
* These are classes to build parse tree in the template parser
*
* @package Smarty
* @subpackage Compiler
* @author Thue Kristensen
* @author Uwe Tews
*/
/**
* A complete smarty tag.
*
* @package Smarty
* @subpackage Compiler
* @ignore
*/
class Smarty_Internal_ParseTree_Tag extends \Smarty_Internal_ParseTree
{
/**
* Saved block nesting level
*
* @var int
*/
public $saved_block_nesting;
/**
* Create parse tree buffer for Smarty tag
*
* @param \Smarty_Internal_Templateparser $parser parser object
* @param string $data content
*/
public function __construct(\Smarty_Internal_Templateparser $parser, $data)
{
}
/**
* Return buffer content
*
* @param \Smarty_Internal_Templateparser $parser
*
* @return string content
*/
public function to_smarty_php(\Smarty_Internal_Templateparser $parser)
{
}
/**
* Return complied code that loads the evaluated output of buffer content into a temporary variable
*
* @param \Smarty_Internal_Templateparser $parser
*
* @return string template code
*/
public function assign_to_var(\Smarty_Internal_Templateparser $parser)
{
}
}
/**
* Smarty Method ClearCache
*
* Smarty::clearCache() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_ClearCache
{
/**
* Valid for Smarty object
*
* @var int
*/
public $objMap = 1;
/**
* Empty cache for a specific template
*
* @api Smarty::clearCache()
* @link http://www.smarty.net/docs/en/api.clear.cache.tpl
*
* @param \Smarty $smarty
* @param string $template_name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param integer $exp_time expiration time
* @param string $type resource type
*
* @return int number of cache files deleted
* @throws \SmartyException
*/
public function clearCache(\Smarty $smarty, $template_name, $cache_id = \null, $compile_id = \null, $exp_time = \null, $type = \null)
{
}
}
/**
* Smarty exception class
*
* @package Smarty
*/
class SmartyException extends \Exception
{
public static $escape = \false;
/**
* @return string
*/
public function __toString()
{
}
}
/**
* Smarty compiler exception class
*
* @package Smarty
*/
class SmartyCompilerException extends \SmartyException
{
/**
* @return string
*/
public function __toString()
{
}
/**
* The line number of the template error
*
* @type int|null
*/
public $line = \null;
/**
* The template source snippet relating to the error
*
* @type string|null
*/
public $source = \null;
/**
* The raw text of the error message
*
* @type string|null
*/
public $desc = \null;
/**
* The resource identifier or template name
*
* @type string|null
*/
public $template = \null;
}
/**
* Smarty Internal Plugin Nocache Insert
* Compiles the {insert} tag into the cache file
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Insert Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Nocache_Insert
{
/**
* Compiles code for the {insert} tag into cache file
*
* @param string $_function insert function name
* @param array $_attr array with parameter
* @param Smarty_Internal_Template $_template template object
* @param string $_script script name to load or 'null'
* @param string $_assign optional variable name
*
* @return string compiled code
*/
public static function compile($_function, $_attr, $_template, $_script, $_assign = \null)
{
}
}
/**
* Smarty Internal Plugin Compile Registered Function
* Compiles code for the execution of a registered function
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Registered Function Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_Registered_Function extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('_any');
/**
* Compiles code for the execution of a registered function
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
* @param string $tag name of function
*
* @return string compiled code
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter, $tag)
{
}
}
/**
* Smarty Internal Plugin Compile Print Expression
* Compiles any tag which will output an expression or variable
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Print Expression Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_Print_Expression extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('assign');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $option_flags = array('nocache', 'nofilter');
/**
* Compiles code for generating output from any expression
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* This file is part of Smarty.
*
* (c) 2015 Uwe Tews
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* Smarty Internal Plugin Compile Child Class
*
* @author Uwe Tews <uwe.tews@googlemail.com>
*/
class Smarty_Internal_Compile_Child extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('assign');
/**
* Tag name
*
* @var string
*/
public $tag = 'child';
/**
* Block type
*
* @var string
*/
public $blockType = 'Child';
/**
* Compiles code for the {child} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* This file is part of Smarty.
*
* (c) 2015 Uwe Tews
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* Smarty Internal Plugin Compile Block Child Class
*
* @author Uwe Tews <uwe.tews@googlemail.com>
*/
class Smarty_Internal_Compile_Block_Child extends \Smarty_Internal_Compile_Child
{
/**
* Tag name
*
* @var string
*/
public $tag = 'block_child';
}
/**
* Smarty Method RegisterFilter
*
* Smarty::registerFilter() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_RegisterFilter
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers a filter function
*
* @api Smarty::registerFilter()
*
* @link http://www.smarty.net/docs/en/api.register.filter.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $type filter type
* @param callback $callback
* @param string|null $name optional filter name
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function registerFilter(\Smarty_Internal_TemplateBase $obj, $type, $callback, $name = \null)
{
}
/**
* Return internal filter name
*
* @param callback $function_name
*
* @return string internal filter name
*/
public function _getFilterName($function_name)
{
}
/**
* Check if filter type is valid
*
* @param string $type
*
* @throws \SmartyException
*/
public function _checkFilterType($type)
{
}
}
/**
* Smarty Method UnregisterFilter
*
* Smarty::unregisterFilter() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_UnregisterFilter extends \Smarty_Internal_Method_RegisterFilter
{
/**
* Unregisters a filter function
*
* @api Smarty::unregisterFilter()
*
* @link http://www.smarty.net/docs/en/api.unregister.filter.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $type filter type
* @param callback|string $callback
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function unregisterFilter(\Smarty_Internal_TemplateBase $obj, $type, $callback)
{
}
}
/**
* Smarty Internal TestInstall
* Test Smarty installation
*
* @package Smarty
* @subpackage Utilities
* @author Uwe Tews
*/
/**
* TestInstall class
*
* @package Smarty
* @subpackage Utilities
*/
class Smarty_Internal_TestInstall
{
/**
* diagnose Smarty setup
* If $errors is secified, the diagnostic report will be appended to the array, rather than being output.
*
* @param \Smarty $smarty
* @param array $errors array to push results into rather than outputting them
*
* @return bool status, true if everything is fine, false else
*/
public static function testInstall(\Smarty $smarty, &$errors = \null)
{
}
}
/**
* Smarty Internal Plugin Resource String
*
* @package Smarty
* @subpackage TemplateResources
* @author Uwe Tews
* @author Rodney Rehm
*/
/**
* Smarty Internal Plugin Resource String
* Implements the strings as resource for Smarty template
* {@internal unlike eval-resources the compiled state of string-resources is saved for subsequent access}}
*
* @package Smarty
* @subpackage TemplateResources
*/
class Smarty_Internal_Resource_String extends \Smarty_Resource
{
/**
* populate Source Object with meta data from Resource
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*
* @return void
*/
public function populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = \null)
{
}
/**
* Load template's source from $resource_name into current template object
*
* @uses decode() to decode base64 and urlencoded template_resources
*
* @param Smarty_Template_Source $source source object
*
* @return string template source
*/
public function getContent(\Smarty_Template_Source $source)
{
}
/**
* decode base64 and urlencode
*
* @param string $string template_resource to decode
*
* @return string decoded template_resource
*/
protected function decode($string)
{
}
/**
* modify resource_name according to resource handlers specifications
*
* @param Smarty $smarty Smarty instance
* @param string $resource_name resource_name to make unique
* @param boolean $isConfig flag for config resource
*
* @return string unique resource name
*/
public function buildUniqueResourceName(\Smarty $smarty, $resource_name, $isConfig = \false)
{
}
/**
* Determine basename for compiled filename
* Always returns an empty string.
*
* @param Smarty_Template_Source $source source object
*
* @return string resource's basename
*/
public function getBasename(\Smarty_Template_Source $source)
{
}
/*
* Disable timestamp checks for string resource.
*
* @return bool
*/
/**
* @return bool
*/
public function checkTimestamps()
{
}
}
/**
* Smarty Internal Plugin Compile Break
* Compiles the {break} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Break Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Break extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('levels');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('levels');
/**
* Tag name may be overloaded by Smarty_Internal_Compile_Continue
*
* @var string
*/
public $tag = 'break';
/**
* Compiles code for the {break} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* check attributes and return array of break and foreach levels
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return array
* @throws \SmartyCompilerException
*/
public function checkLevels($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Continue
* Compiles the {continue} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Continue Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Continue extends \Smarty_Internal_Compile_Break
{
/**
* Tag name
*
* @var string
*/
public $tag = 'continue';
}
/**
* Smarty Method UnregisterCacheResource
*
* Smarty::unregisterCacheResource() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_UnregisterCacheResource
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers a resource to fetch a template
*
* @api Smarty::unregisterCacheResource()
* @link http://www.smarty.net/docs/en/api.unregister.cacheresource.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param $name
*
* @return \Smarty|\Smarty_Internal_Template
*/
public function unregisterCacheResource(\Smarty_Internal_TemplateBase $obj, $name)
{
}
}
/**
* Smarty Method GetGlobal
*
* Smarty::getGlobal() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_GetGlobal
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* Returns a single or all global variables
*
* @api Smarty::getGlobal()
*
* @param \Smarty_Internal_Data $data
* @param string $varName variable name or null
*
* @return string|array variable value or or array of variables
*/
public function getGlobal(\Smarty_Internal_Data $data, $varName = \null)
{
}
}
/**
* Smarty Internal Plugin Configfilelexer
*
* This is the lexer to break the config file source into tokens
*
* @package Smarty
* @subpackage Config
* @author Uwe Tews
*/
/**
* Smarty_Internal_Configfilelexer
*
* This is the config file lexer.
* It is generated from the smarty_internal_configfilelexer.plex file
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
class Smarty_Internal_Configfilelexer
{
const START = 1;
const VALUE = 2;
const NAKED_STRING_VALUE = 3;
const COMMENT = 4;
const SECTION = 5;
const TRIPPLE = 6;
/**
* Source
*
* @var string
*/
public $data;
/**
* Source length
*
* @var int
*/
public $dataLength = \null;
/**
* byte counter
*
* @var int
*/
public $counter;
/**
* token number
*
* @var int
*/
public $token;
/**
* token value
*
* @var string
*/
public $value;
/**
* current line
*
* @var int
*/
public $line;
/**
* state number
*
* @var int
*/
public $state = 1;
/**
* Smarty object
*
* @var Smarty
*/
public $smarty = \null;
/**
* trace file
*
* @var resource
*/
public $yyTraceFILE;
/**
* trace prompt
*
* @var string
*/
public $yyTracePrompt;
/**
* state names
*
* @var array
*/
public $state_name = array(1 => 'START', 2 => 'VALUE', 3 => 'NAKED_STRING_VALUE', 4 => 'COMMENT', 5 => 'SECTION', 6 => 'TRIPPLE');
/**
* token names
*
* @var array
*/
public $smarty_token_names = array();
/**
* constructor
*
* @param string $data template source
* @param Smarty_Internal_Config_File_Compiler $compiler
*/
public function __construct($data, \Smarty_Internal_Config_File_Compiler $compiler)
{
}
public function replace($input)
{
}
// end function
public function PrintTrace()
{
}
public function yylex()
{
}
public function yypushstate($state)
{
}
public function yypopstate()
{
}
public function yybegin($state)
{
}
public function yylex1()
{
}
public function yy_r1_1()
{
}
public function yy_r1_2()
{
}
public function yy_r1_3()
{
}
public function yy_r1_4()
{
}
// end function
public function yy_r1_5()
{
}
public function yy_r1_6()
{
}
public function yy_r1_7()
{
}
public function yy_r1_8()
{
}
public function yylex2()
{
}
public function yy_r2_1()
{
}
public function yy_r2_2()
{
}
public function yy_r2_3()
{
}
public function yy_r2_4()
{
}
public function yy_r2_5()
{
}
public function yy_r2_6()
{
}
// end function
public function yy_r2_7()
{
}
public function yy_r2_8()
{
}
public function yy_r2_9()
{
}
// end function
public function yylex3()
{
}
public function yy_r3_1()
{
}
public function yylex4()
{
}
public function yy_r4_1()
{
}
public function yy_r4_2()
{
}
// end function
public function yy_r4_3()
{
}
public function yylex5()
{
}
public function yy_r5_1()
{
}
public function yy_r5_2()
{
}
// end function
public function yylex6()
{
}
public function yy_r6_1()
{
}
public function yy_r6_2()
{
}
}
/**
* Smarty error handler
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*
* @deprecated
Smarty does no longer use @filemtime()
*/
class Smarty_Internal_ErrorHandler
{
/**
* contains directories outside of SMARTY_DIR that are to be muted by muteExpectedErrors()
*/
public static $mutedDirectories = array();
/**
* Enable error handler to mute expected messages
*
*/
public static function muteExpectedErrors()
{
}
/**
* Error Handler to mute expected messages
*
* @link http://php.net/set_error_handler
*
* @param integer $errno Error level
* @param $errstr
* @param $errfile
* @param $errline
* @param $errcontext
*
* @return bool
*/
public static function mutingErrorHandler($errno, $errstr, $errfile, $errline, $errcontext)
{
}
}
/**
* Smarty Internal Plugin Compile For
* Compiles the {for} {forelse} {/for} tags
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile For Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_For extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {for} tag
* Smarty 3 does implement two different syntax's:
* - {for $var in $array}
* For looping over arrays or iterators
* - {for $x=0; $x<$y; $x++}
* For general loops
* The parser is generating different sets of attribute by which this compiler can
* determine which syntax is used.
*
* @param array $args array with attributes from parser
* @param object $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
*/
public function compile($args, $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile Forelse Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Forelse extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {forelse} tag
*
* @param array $args array with attributes from parser
* @param object $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
*/
public function compile($args, $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile Forclose Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Forclose extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {/for} tag
*
* @param array $args array with attributes from parser
* @param object $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
*/
public function compile($args, $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Templateparser Parse Tree
* These are classes to build parse trees in the template parser
*
* @package Smarty
* @subpackage Compiler
* @author Thue Kristensen
* @author Uwe Tews
*/
/**
* Code fragment inside a tag .
*
* @package Smarty
* @subpackage Compiler
* @ignore
*/
class Smarty_Internal_ParseTree_Code extends \Smarty_Internal_ParseTree
{
/**
* Create parse tree buffer for code fragment
*
* @param string $data content
*/
public function __construct($data)
{
}
/**
* Return buffer content in parentheses
*
* @param \Smarty_Internal_Templateparser $parser
*
* @return string content
*/
public function to_smarty_php(\Smarty_Internal_Templateparser $parser)
{
}
}
/**
* Smarty Method UnregisterPlugin
*
* Smarty::unregisterPlugin() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_UnregisterPlugin
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers plugin to be used in templates
*
* @api Smarty::unregisterPlugin()
* @link http://www.smarty.net/docs/en/api.unregister.plugin.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $type plugin type
* @param string $name name of template tag
*
* @return \Smarty|\Smarty_Internal_Template
*/
public function unregisterPlugin(\Smarty_Internal_TemplateBase $obj, $type, $name)
{
}
}
/**
* Inline Runtime Methods render, setSourceByUid, setupSubTemplate
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
**/
class Smarty_Internal_Runtime_CacheModify
{
/**
* check client side cache
*
* @param \Smarty_Template_Cached $cached
* @param \Smarty_Internal_Template $_template
* @param string $content
*
* @throws \Exception
* @throws \SmartyException
*/
public function cacheModifiedCheck(\Smarty_Template_Cached $cached, \Smarty_Internal_Template $_template, $content)
{
}
}
/**
* Smarty Internal Extension
* This file contains the Smarty template extension to create a code frame
*
* @package Smarty
* @subpackage Template
* @author Uwe Tews
*/
/**
* Class Smarty_Internal_Extension_CodeFrame
* Create code frame for compiled and cached templates
*/
class Smarty_Internal_Runtime_CodeFrame
{
/**
* Create code frame for compiled and cached templates
*
* @param Smarty_Internal_Template $_template
* @param string $content optional template content
* @param string $functions compiled template function and block code
* @param bool $cache flag for cache file
* @param \Smarty_Internal_TemplateCompilerBase $compiler
*
* @return string
*/
public function create(\Smarty_Internal_Template $_template, $content = '', $functions = '', $cache = \false, \Smarty_Internal_TemplateCompilerBase $compiler = \null)
{
}
}
/**
* Smarty Internal Plugin Compile Capture
* Compiles the {capture} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Capture Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Capture extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('name');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('name', 'assign', 'append');
/**
* Compiles code for the {$smarty.capture.xxx}
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
*/
public static function compileSpecialVariable($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter = \null)
{
}
/**
* Compiles code for the {capture} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param null $parameter
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter = \null)
{
}
}
/**
* Smarty Internal Plugin Compile Captureclose Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_CaptureClose extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {/capture} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param null $parameter
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile ForeachSection
* Shared methods for {foreach} {section} tags
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile ForeachSection Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_ForeachSection extends \Smarty_Internal_CompileBase
{
/**
* Name of this tag
*
* @var string
*/
public $tagName = '';
/**
* Valid properties of $smarty.xxx variable
*
* @var array
*/
public $nameProperties = array();
/**
* {section} tag has no item properties
*
* @var array
*/
public $itemProperties = \null;
/**
* {section} tag has always name attribute
*
* @var bool
*/
public $isNamed = \true;
/**
* @var array
*/
public $matchResults = array();
/**
* Scan sources for used tag attributes
*
* @param array $attributes
* @param \Smarty_Internal_TemplateCompilerBase $compiler
*
* @throws \SmartyException
*/
public function scanForProperties($attributes, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* Build property preg string
*
* @param bool $named
* @param array $attributes
*/
public function buildPropertyPreg($named, $attributes)
{
}
/**
* Find matches in source string
*
* @param string $source
*/
public function matchProperty($source)
{
}
/**
* Find matches in template source
*
* @param \Smarty_Internal_TemplateCompilerBase $compiler
*/
public function matchTemplateSource(\Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* Find matches in all parent template source
*
* @param \Smarty_Internal_TemplateCompilerBase $compiler
*
* @throws \SmartyException
*/
public function matchParentTemplateSource(\Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* Find matches in {block} tag source
*
* @param \Smarty_Internal_TemplateCompilerBase $compiler
*/
public function matchBlockSource(\Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* Compiles code for the {$smarty.foreach.xxx} or {$smarty.section.xxx}tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compileSpecialVariable($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile Foreach
* Compiles the {foreach} {foreachelse} {/foreach} tags
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Foreach Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Foreach extends \Smarty_Internal_Compile_Private_ForeachSection
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('from', 'item');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('name', 'key', 'properties');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('from', 'item', 'key', 'name');
/**
* counter
*
* @var int
*/
public $counter = 0;
/**
* Name of this tag
*
* @var string
*/
public $tagName = 'foreach';
/**
* Valid properties of $smarty.foreach.name.xxx variable
*
* @var array
*/
public $nameProperties = array('first', 'last', 'index', 'iteration', 'show', 'total');
/**
* Valid properties of $item@xxx variable
*
* @var array
*/
public $itemProperties = array('first', 'last', 'index', 'iteration', 'show', 'total', 'key');
/**
* Flag if tag had name attribute
*
* @var bool
*/
public $isNamed = \false;
/**
* Compiles code for the {foreach} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* Compiles code for to restore saved template variables
*
* @param int $levels number of levels to restore
*
* @return string compiled code
*/
public function compileRestore($levels)
{
}
}
/**
* Smarty Internal Plugin Compile Foreachelse Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Foreachelse extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {foreachelse} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Foreachclose Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Foreachclose extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {/foreach} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Method SetAutoloadFilters
*
* Smarty::setAutoloadFilters() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_SetAutoloadFilters
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Set autoload filters
*
* @api Smarty::setAutoloadFilters()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param array $filters filters to load automatically
* @param string $type "pre", "output", … specify
* the filter type to set.
* Defaults to none treating
* $filters' keys as the
* appropriate types
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function setAutoloadFilters(\Smarty_Internal_TemplateBase $obj, $filters, $type = \null)
{
}
/**
* Check if filter type is valid
*
* @param string $type
*
* @throws \SmartyException
*/
public function _checkFilterType($type)
{
}
}
/**
* Smarty Internal Plugin Smarty Template Compiler Base
* This file contains the basic classes and methods for compiling Smarty templates with lexer/parser
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Main abstract compiler class
*
* @package Smarty
* @subpackage Compiler
*
* @property Smarty_Internal_SmartyTemplateCompiler $prefixCompiledCode = ''
* @property Smarty_Internal_SmartyTemplateCompiler $postfixCompiledCode = ''
* @method registerPostCompileCallback($callback, $parameter = array(), $key = null, $replace = false)
* @method unregisterPostCompileCallback($key)
*/
abstract class Smarty_Internal_TemplateCompilerBase
{
/**
* compile tag objects cache
*
* @var array
*/
public static $_tag_objects = array();
/**
* counter for prefix variable number
*
* @var int
*/
public static $prefixVariableNumber = 0;
/**
* Smarty object
*
* @var Smarty
*/
public $smarty = \null;
/**
* Parser object
*
* @var Smarty_Internal_Templateparser
*/
public $parser = \null;
/**
* hash for nocache sections
*
* @var mixed
*/
public $nocache_hash = \null;
/**
* suppress generation of nocache code
*
* @var bool
*/
public $suppressNocacheProcessing = \false;
/**
* caching enabled (copied from template object)
*
* @var int
*/
public $caching = 0;
/**
* tag stack
*
* @var array
*/
public $_tag_stack = array();
/**
* tag stack count
*
* @var array
*/
public $_tag_stack_count = array();
/**
* Plugins used by template
*
* @var array
*/
public $required_plugins = array('compiled' => array(), 'nocache' => array());
/**
* Required plugins stack
*
* @var array
*/
public $required_plugins_stack = array();
/**
* current template
*
* @var Smarty_Internal_Template
*/
public $template = \null;
/**
* merged included sub template data
*
* @var array
*/
public $mergedSubTemplatesData = array();
/**
* merged sub template code
*
* @var array
*/
public $mergedSubTemplatesCode = array();
/**
* collected template properties during compilation
*
* @var array
*/
public $templateProperties = array();
/**
* source line offset for error messages
*
* @var int
*/
public $trace_line_offset = 0;
/**
* trace uid
*
* @var string
*/
public $trace_uid = '';
/**
* trace file path
*
* @var string
*/
public $trace_filepath = '';
/**
* stack for tracing file and line of nested {block} tags
*
* @var array
*/
public $trace_stack = array();
/**
* plugins loaded by default plugin handler
*
* @var array
*/
public $default_handler_plugins = array();
/**
* saved preprocessed modifier list
*
* @var mixed
*/
public $default_modifier_list = \null;
/**
* force compilation of complete template as nocache
*
* @var boolean
*/
public $forceNocache = \false;
/**
* flag if compiled template file shall we written
*
* @var bool
*/
public $write_compiled_code = \true;
/**
* Template functions
*
* @var array
*/
public $tpl_function = array();
/**
* called sub functions from template function
*
* @var array
*/
public $called_functions = array();
/**
* compiled template or block function code
*
* @var string
*/
public $blockOrFunctionCode = '';
/**
* php_handling setting either from Smarty or security
*
* @var int
*/
public $php_handling = 0;
/**
* flags for used modifier plugins
*
* @var array
*/
public $modifier_plugins = array();
/**
* type of already compiled modifier
*
* @var array
*/
public $known_modifier_type = array();
/**
* parent compiler object for merged subtemplates and template functions
*
* @var Smarty_Internal_TemplateCompilerBase
*/
public $parent_compiler = \null;
/**
* Flag true when compiling nocache section
*
* @var bool
*/
public $nocache = \false;
/**
* Flag true when tag is compiled as nocache
*
* @var bool
*/
public $tag_nocache = \false;
/**
* Compiled tag prefix code
*
* @var array
*/
public $prefix_code = array();
/**
* used prefix variables by current compiled tag
*
* @var array
*/
public $usedPrefixVariables = array();
/**
* Prefix code stack
*
* @var array
*/
public $prefixCodeStack = array();
/**
* Tag has compiled code
*
* @var bool
*/
public $has_code = \false;
/**
* A variable string was compiled
*
* @var bool
*/
public $has_variable_string = \false;
/**
* Stack for {setfilter} {/setfilter}
*
* @var array
*/
public $variable_filter_stack = array();
/**
* variable filters for {setfilter} {/setfilter}
*
* @var array
*/
public $variable_filters = array();
/**
* Nesting count of looping tags like {foreach}, {for}, {section}, {while}
*
* @var int
*/
public $loopNesting = 0;
/**
* Strip preg pattern
*
* @var string
*/
public $stripRegEx = '![\\t ]*[\\r\\n]+[\\t ]*!';
/**
* plugin search order
*
* @var array
*/
public $plugin_search_order = array('function', 'block', 'compiler', 'class');
/**
* General storage area for tag compiler plugins
*
* @var array
*/
public $_cache = array();
/**
* Initialize compiler
*
* @param Smarty $smarty global instance
*/
public function __construct(\Smarty $smarty)
{
}
/**
* Method to compile a Smarty template
*
* @param Smarty_Internal_Template $template template object to compile
* @param bool $nocache true is shall be compiled in nocache mode
* @param null|Smarty_Internal_TemplateCompilerBase $parent_compiler
*
* @return bool true if compiling succeeded, false if it failed
* @throws \Exception
*/
public function compileTemplate(\Smarty_Internal_Template $template, $nocache = \null, \Smarty_Internal_TemplateCompilerBase $parent_compiler = \null)
{
}
/**
* Compile template source and run optional post filter
*
* @param \Smarty_Internal_Template $template
* @param null|bool $nocache flag if template must be compiled in nocache mode
* @param \Smarty_Internal_TemplateCompilerBase $parent_compiler
*
* @return string
* @throws \Exception
*/
public function compileTemplateSource(\Smarty_Internal_Template $template, $nocache = \null, \Smarty_Internal_TemplateCompilerBase $parent_compiler = \null)
{
}
/**
* Optionally process compiled code by post filter
*
* @param string $code compiled code
*
* @return string
* @throws \SmartyException
*/
public function postFilter($code)
{
}
/**
* Run optional prefilter
*
* @param string $_content template source
*
* @return string
* @throws \SmartyException
*/
public function preFilter($_content)
{
}
/**
* Compile Tag
* This is a call back from the lexer/parser
*
* Save current prefix code
* Compile tag
* Merge tag prefix code with saved one
* (required nested tags in attributes)
*
* @param string $tag tag name
* @param array $args array with tag attributes
* @param array $parameter array with compilation parameter
*
* @throws SmartyCompilerException
* @throws SmartyException
* @return string compiled code
*/
public function compileTag($tag, $args, $parameter = array())
{
}
/**
* compile variable
*
* @param string $variable
*
* @return string
*/
public function compileVariable($variable)
{
}
/**
* compile config variable
*
* @param string $variable
*
* @return string
*/
public function compileConfigVariable($variable)
{
}
/**
* compile PHP function call
*
* @param string $name
* @param array $parameter
*
* @return string
* @throws \SmartyCompilerException
*/
public function compilePHPFunctionCall($name, $parameter)
{
}
/**
* This method is called from parser to process a text content section
* - remove text from inheritance child templates as they may generate output
* - strip text if strip is enabled
*
* @param string $text
*
* @return null|\Smarty_Internal_ParseTree_Text
*/
public function processText($text)
{
}
/**
* lazy loads internal compile plugin for tag and calls the compile method
* compile objects cached for reuse.
* class name format: Smarty_Internal_Compile_TagName
* plugin filename format: Smarty_Internal_TagName.php
*
* @param string $tag tag name
* @param array $args list of tag attributes
* @param mixed $param1 optional parameter
* @param mixed $param2 optional parameter
* @param mixed $param3 optional parameter
*
* @return bool|string compiled code or false
* @throws \SmartyCompilerException
*/
public function callTagCompiler($tag, $args, $param1 = \null, $param2 = \null, $param3 = \null)
{
}
/**
* lazy loads internal compile plugin for tag compile objects cached for reuse.
*
* class name format: Smarty_Internal_Compile_TagName
* plugin filename format: Smarty_Internal_TagName.php
*
* @param string $tag tag name
*
* @return bool|\Smarty_Internal_CompileBase tag compiler object or false if not found
*/
public function getTagCompiler($tag)
{
}
/**
* Check for plugins and return function name
*
* @param $plugin_name
* @param string $plugin_type type of plugin
*
* @return string call name of function
* @throws \SmartyException
*/
public function getPlugin($plugin_name, $plugin_type)
{
}
/**
* Check for plugins by default plugin handler
*
* @param string $tag name of tag
* @param string $plugin_type type of plugin
*
* @return bool true if found
* @throws \SmartyCompilerException
*/
public function getPluginFromDefaultHandler($tag, $plugin_type)
{
}
/**
* Append code segments and remove unneeded ?> <?php transitions
*
* @param string $left
* @param string $right
*
* @return string
*/
public function appendCode($left, $right)
{
}
/**
* Inject inline code for nocache template sections
* This method gets the content of each template element from the parser.
* If the content is compiled code and it should be not cached the code is injected
* into the rendered output.
*
* @param string $content content of template element
* @param boolean $is_code true if content is compiled code
*
* @return string content
*/
public function processNocacheCode($content, $is_code)
{
}
/**
* Get Id
*
* @param string $input
*
* @return bool|string
*/
public function getId($input)
{
}
/**
* Get variable name from string
*
* @param string $input
*
* @return bool|string
*/
public function getVariableName($input)
{
}
/**
* Set nocache flag in variable or create new variable
*
* @param string $varName
*/
public function setNocacheInVariable($varName)
{
}
/**
* @param array $_attr tag attributes
* @param array $validScopes
*
* @return int|string
* @throws \SmartyCompilerException
*/
public function convertScope($_attr, $validScopes)
{
}
/**
* Generate nocache code string
*
* @param string $code PHP code
*
* @return string
*/
public function makeNocacheCode($code)
{
}
/**
* display compiler error messages without dying
* If parameter $args is empty it is a parser detected syntax error.
* In this case the parser is called to obtain information about expected tokens.
* If parameter $args contains a string this is used as error message
*
* @param string $args individual error message or null
* @param string $line line-number
* @param null|bool $tagline if true the line number of last tag
*
* @throws \SmartyCompilerException when an unexpected token is found
*/
public function trigger_template_error($args = \null, $line = \null, $tagline = \null)
{
}
/**
* Return var_export() value with all white spaces removed
*
* @param mixed $value
*
* @return string
*/
public function getVarExport($value)
{
}
/**
* enter double quoted string
* - save tag stack count
*/
public function enterDoubleQuote()
{
}
/**
* Return tag stack count
*
* @return int
*/
public function getTagStackCount()
{
}
/**
* @param $lexerPreg
*
* @return mixed
*/
public function replaceDelimiter($lexerPreg)
{
}
/**
* Build lexer regular expressions for left and right delimiter and user defined literals
*/
public function initDelimiterPreg()
{
}
/**
* leave double quoted string
* - throw exception if block in string was not closed
*
* @throws \SmartyCompilerException
*/
public function leaveDoubleQuote()
{
}
/**
* Get left delimiter preg
*
* @return string
*/
public function getLdelPreg()
{
}
/**
* Get right delimiter preg
*
* @return string
*/
public function getRdelPreg()
{
}
/**
* Get length of left delimiter
*
* @return int
*/
public function getLdelLength()
{
}
/**
* Get length of right delimiter
*
* @return int
*/
public function getRdelLength()
{
}
/**
* Get name of current open block tag
*
* @return string|boolean
*/
public function getOpenBlockTag()
{
}
/**
* Check if $value contains variable elements
*
* @param mixed $value
*
* @return bool|int
*/
public function isVariable($value)
{
}
/**
* Get new prefix variable name
*
* @return string
*/
public function getNewPrefixVariable()
{
}
/**
* Get current prefix variable name
*
* @return string
*/
public function getPrefixVariable()
{
}
/**
* append code to prefix buffer
*
* @param string $code
*/
public function appendPrefixCode($code)
{
}
/**
* get prefix code string
*
* @return string
*/
public function getPrefixCode()
{
}
/**
* Save current required plugins
*
* @param bool $init if true init required plugins
*/
public function saveRequiredPlugins($init = \false)
{
}
/**
* Restore required plugins
*/
public function restoreRequiredPlugins()
{
}
/**
* Compile code to call Smarty_Internal_Template::_checkPlugins()
* for required plugins
*
* @return string
*/
public function compileRequiredPlugins()
{
}
/**
* Compile code to call Smarty_Internal_Template::_checkPlugins
* - checks if plugin is callable require otherwise
*
* @param $requiredPlugins
*
* @return string
*/
public function compileCheckPlugins($requiredPlugins)
{
}
/**
* method to compile a Smarty template
*
* @param mixed $_content template source
* @param bool $isTemplateSource
*
* @return bool true if compiling succeeded, false if it failed
*/
protected abstract function doCompile($_content, $isTemplateSource = \false);
}
/**
* Smarty {block} tag class
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Block
{
/**
* Block name
*
* @var string
*/
public $name = '';
/**
* Hide attribute
*
* @var bool
*/
public $hide = \false;
/**
* Append attribute
*
* @var bool
*/
public $append = \false;
/**
* prepend attribute
*
* @var bool
*/
public $prepend = \false;
/**
* Block calls $smarty.block.child
*
* @var bool
*/
public $callsChild = \false;
/**
* Inheritance child block
*
* @var Smarty_Internal_Block|null
*/
public $child = \null;
/**
* Inheritance calling parent block
*
* @var Smarty_Internal_Block|null
*/
public $parent = \null;
/**
* Inheritance Template index
*
* @var int
*/
public $tplIndex = 0;
/**
* Smarty_Internal_Block constructor.
* - if outer level {block} of child template ($state === 1) save it as child root block
* - otherwise process inheritance and render
*
* @param string $name block name
* @param int|null $tplIndex index of outer level {block} if nested
*/
public function __construct($name, $tplIndex)
{
}
/**
* Compiled block code overloaded by {block} class
*
* @param \Smarty_Internal_Template $tpl
*/
public function callBlock(\Smarty_Internal_Template $tpl)
{
}
}
/**
* Smarty Internal Plugin Compile Registered Block
* Compiles code for the execution of a registered block function
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Registered Block Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_Registered_Block extends \Smarty_Internal_Compile_Private_Block_Plugin
{
/**
* Setup callback, parameter array and nocache mode
*
* @param \Smarty_Internal_TemplateCompilerBase $compiler
* @param array $_attr attributes
* @param string $tag
* @param null $function
*
* @return array
*/
public function setup(\Smarty_Internal_TemplateCompilerBase $compiler, $_attr, $tag, $function)
{
}
}
/**
* Smarty Extension handler
*
* Load extensions dynamically
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*
* Runtime extensions
* @property Smarty_Internal_Runtime_CacheModify $_cacheModify
* @property Smarty_Internal_Runtime_CacheResourceFile $_cacheResourceFile
* @property Smarty_Internal_Runtime_Capture $_capture
* @property Smarty_Internal_Runtime_CodeFrame $_codeFrame
* @property Smarty_Internal_Runtime_FilterHandler $_filterHandler
* @property Smarty_Internal_Runtime_Foreach $_foreach
* @property Smarty_Internal_Runtime_GetIncludePath $_getIncludePath
* @property Smarty_Internal_Runtime_Make_Nocache $_make_nocache
* @property Smarty_Internal_Runtime_UpdateCache $_updateCache
* @property Smarty_Internal_Runtime_UpdateScope $_updateScope
* @property Smarty_Internal_Runtime_TplFunction $_tplFunction
* @property Smarty_Internal_Runtime_WriteFile $_writeFile
*
* Method extensions
* @property Smarty_Internal_Method_GetTemplateVars $getTemplateVars
* @property Smarty_Internal_Method_Append $append
* @property Smarty_Internal_Method_AppendByRef $appendByRef
* @property Smarty_Internal_Method_AssignGlobal $assignGlobal
* @property Smarty_Internal_Method_AssignByRef $assignByRef
* @property Smarty_Internal_Method_LoadFilter $loadFilter
* @property Smarty_Internal_Method_LoadPlugin $loadPlugin
* @property Smarty_Internal_Method_RegisterFilter $registerFilter
* @property Smarty_Internal_Method_RegisterObject $registerObject
* @property Smarty_Internal_Method_RegisterPlugin $registerPlugin
* @property mixed|\Smarty_Template_Cached configLoad
*/
class Smarty_Internal_Extension_Handler
{
public $objType = \null;
/**
* Call external Method
*
* @param \Smarty_Internal_Data $data
* @param string $name external method names
* @param array $args argument array
*
* @return mixed
*/
public function _callExternalMethod(\Smarty_Internal_Data $data, $name, $args)
{
}
/**
* Make first character of name parts upper case
*
* @param string $name
*
* @return string
*/
public function upperCase($name)
{
}
/**
* get extension object
*
* @param string $property_name property name
*
* @return mixed|Smarty_Template_Cached
*/
public function __get($property_name)
{
}
/**
* set extension property
*
* @param string $property_name property name
* @param mixed $value value
*
*/
public function __set($property_name, $value)
{
}
/**
* Call error handler for undefined method
*
* @param string $name unknown method-name
* @param array $args argument array
*
* @return mixed
*/
public function __call($name, $args)
{
}
}
/**
* Smarty Method AddAutoloadFilters
*
* Smarty::addAutoloadFilters() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_AddAutoloadFilters extends \Smarty_Internal_Method_SetAutoloadFilters
{
/**
* Add autoload filters
*
* @api Smarty::setAutoloadFilters()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param array $filters filters to load automatically
* @param string $type "pre", "output", … specify
* the filter type to set.
* Defaults to none treating
* $filters' keys as the
* appropriate types
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function addAutoloadFilters(\Smarty_Internal_TemplateBase $obj, $filters, $type = \null)
{
}
}
/**
* Smarty Internal Plugin Templateparser Parse Tree
* These are classes to build parse tree in the template parser
*
* @package Smarty
* @subpackage Compiler
* @author Thue Kristensen
* @author Uwe Tews
*/
/**
* Template element
*
* @package Smarty
* @subpackage Compiler
* @ignore
*/
class Smarty_Internal_ParseTree_Template extends \Smarty_Internal_ParseTree
{
/**
* Array of template elements
*
* @var array
*/
public $subtrees = array();
/**
* Create root of parse tree for template elements
*/
public function __construct()
{
}
/**
* Append buffer to subtree
*
* @param \Smarty_Internal_Templateparser $parser
* @param Smarty_Internal_ParseTree $subtree
*/
public function append_subtree(\Smarty_Internal_Templateparser $parser, \Smarty_Internal_ParseTree $subtree)
{
}
/**
* Append array to subtree
*
* @param \Smarty_Internal_Templateparser $parser
* @param \Smarty_Internal_ParseTree[] $array
*/
public function append_array(\Smarty_Internal_Templateparser $parser, $array = array())
{
}
/**
* Prepend array to subtree
*
* @param \Smarty_Internal_Templateparser $parser
* @param \Smarty_Internal_ParseTree[] $array
*/
public function prepend_array(\Smarty_Internal_Templateparser $parser, $array = array())
{
}
/**
* Sanitize and merge subtree buffers together
*
* @param \Smarty_Internal_Templateparser $parser
*
* @return string template code content
*/
public function to_smarty_php(\Smarty_Internal_Templateparser $parser)
{
}
}
/**
* Smarty Internal Plugin Smarty Template Compiler Base
* This file contains the basic classes and methods for compiling Smarty templates with lexer/parser
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Class SmartyTemplateCompiler
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_SmartyTemplateCompiler extends \Smarty_Internal_TemplateCompilerBase
{
/**
* Lexer class name
*
* @var string
*/
public $lexer_class;
/**
* Parser class name
*
* @var string
*/
public $parser_class;
/**
* array of vars which can be compiled in local scope
*
* @var array
*/
public $local_var = array();
/**
* array of callbacks called when the normal compile process of template is finished
*
* @var array
*/
public $postCompileCallbacks = array();
/**
* prefix code
*
* @var string
*/
public $prefixCompiledCode = '';
/**
* postfix code
*
* @var string
*/
public $postfixCompiledCode = '';
/**
* Initialize compiler
*
* @param string $lexer_class class name
* @param string $parser_class class name
* @param Smarty $smarty global instance
*/
public function __construct($lexer_class, $parser_class, \Smarty $smarty)
{
}
/**
* method to compile a Smarty template
*
* @param mixed $_content template source
* @param bool $isTemplateSource
*
* @return bool true if compiling succeeded, false if it failed
* @throws \SmartyCompilerException
*/
protected function doCompile($_content, $isTemplateSource = \false)
{
}
/**
* Register a post compile callback
* - when the callback is called after template compiling the compiler object will be inserted as first parameter
*
* @param callback $callback
* @param array $parameter optional parameter array
* @param string $key optional key for callback
* @param bool $replace if true replace existing keyed callback
*/
public function registerPostCompileCallback($callback, $parameter = array(), $key = \null, $replace = \false)
{
}
/**
* Remove a post compile callback
*
* @param string $key callback key
*/
public function unregisterPostCompileCallback($key)
{
}
}
/**
* Smarty Internal Plugin Templateparser Parse Tree
* These are classes to build parse tree in the template parser
*
* @package Smarty
* @subpackage Compiler
* @author Thue Kristensen
* @author Uwe Tews
*/
/**
* Raw chars as part of a double quoted string.
*
* @package Smarty
* @subpackage Compiler
* @ignore
*/
class Smarty_Internal_ParseTree_DqContent extends \Smarty_Internal_ParseTree
{
/**
* Create parse tree buffer with string content
*
* @param string $data string section
*/
public function __construct($data)
{
}
/**
* Return content as double quoted string
*
* @param \Smarty_Internal_Templateparser $parser
*
* @return string doubled quoted string
*/
public function to_smarty_php(\Smarty_Internal_Templateparser $parser)
{
}
}
/*
* This file is part of Smarty.
*
* (c) 2015 Uwe Tews
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* Smarty_Internal_Templatelexer
* This is the template file lexer.
* It is generated from the smarty_internal_templatelexer.plex file
*
*
* @author Uwe Tews <uwe.tews@googlemail.com>
*/
class Smarty_Internal_Templatelexer
{
const TEXT = 1;
const TAG = 2;
const TAGBODY = 3;
const LITERAL = 4;
const DOUBLEQUOTEDSTRING = 5;
/**
* Source
*
* @var string
*/
public $data;
/**
* Source length
*
* @var int
*/
public $dataLength = \null;
/**
* byte counter
*
* @var int
*/
public $counter;
/**
* token number
*
* @var int
*/
public $token;
/**
* token value
*
* @var string
*/
public $value;
/**
* current line
*
* @var int
*/
public $line;
/**
* tag start line
*
* @var
*/
public $taglineno;
/**
* php code type
*
* @var string
*/
public $phpType = '';
/**
* state number
*
* @var int
*/
public $state = 1;
/**
* Smarty object
*
* @var Smarty
*/
public $smarty = \null;
/**
* compiler object
*
* @var Smarty_Internal_TemplateCompilerBase
*/
public $compiler = \null;
/**
* trace file
*
* @var resource
*/
public $yyTraceFILE;
/**
* trace prompt
*
* @var string
*/
public $yyTracePrompt;
/**
* XML flag true while processing xml
*
* @var bool
*/
public $is_xml = \false;
/**
* state names
*
* @var array
*/
public $state_name = array(1 => 'TEXT', 2 => 'TAG', 3 => 'TAGBODY', 4 => 'LITERAL', 5 => 'DOUBLEQUOTEDSTRING');
/**
* token names
*
* @var array
*/
public $smarty_token_names = array(
// Text for parser error messages
'NOT' => '(!,not)',
'OPENP' => '(',
'CLOSEP' => ')',
'OPENB' => '[',
'CLOSEB' => ']',
'PTR' => '->',
'APTR' => '=>',
'EQUAL' => '=',
'NUMBER' => 'number',
'UNIMATH' => '+" , "-',
'MATH' => '*" , "/" , "%',
'INCDEC' => '++" , "--',
'SPACE' => ' ',
'DOLLAR' => '$',
'SEMICOLON' => ';',
'COLON' => ':',
'DOUBLECOLON' => '::',
'AT' => '@',
'HATCH' => '#',
'QUOTE' => '"',
'BACKTICK' => '`',
'VERT' => '"|" modifier',
'DOT' => '.',
'COMMA' => '","',
'QMARK' => '"?"',
'ID' => 'id, name',
'TEXT' => 'text',
'LDELSLASH' => '{/..} closing tag',
'LDEL' => '{...} Smarty tag',
'COMMENT' => 'comment',
'AS' => 'as',
'TO' => 'to',
'PHP' => '"<?php", "<%", "{php}" tag',
'LOGOP' => '"<", "==" ... logical operator',
'TLOGOP' => '"lt", "eq" ... logical operator; "is div by" ... if condition',
'SCOND' => '"is even" ... if condition',
);
/**
* constructor
*
* @param string $source template source
* @param Smarty_Internal_TemplateCompilerBase $compiler
*/
public function __construct($source, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* open lexer/parser trace file
*
*/
public function PrintTrace()
{
}
/**
* replace placeholders with runtime preg code
*
* @param string $preg
*
* @return string
*/
public function replace($preg)
{
}
/**
* check if current value is an autoliteral left delimiter
*
* @return bool
*/
public function isAutoLiteral()
{
}
// end function
public function yylex()
{
}
public function yypushstate($state)
{
}
public function yypopstate()
{
}
public function yybegin($state)
{
}
public function yylex1()
{
}
public function yy_r1_1()
{
}
public function yy_r1_2()
{
}
public function yy_r1_4()
{
}
public function yy_r1_8()
{
}
public function yy_r1_10()
{
}
public function yy_r1_12()
{
}
// end function
public function yy_r1_14()
{
}
public function yy_r1_16()
{
}
public function yy_r1_19()
{
}
public function yylex2()
{
}
public function yy_r2_1()
{
}
public function yy_r2_4()
{
}
public function yy_r2_6()
{
}
public function yy_r2_8()
{
}
public function yy_r2_10()
{
}
public function yy_r2_12()
{
}
public function yy_r2_15()
{
}
public function yy_r2_18()
{
}
public function yy_r2_20()
{
}
// end function
public function yy_r2_23()
{
}
public function yy_r2_25()
{
}
public function yylex3()
{
}
public function yy_r3_1()
{
}
public function yy_r3_2()
{
}
public function yy_r3_4()
{
}
public function yy_r3_5()
{
}
public function yy_r3_6()
{
}
public function yy_r3_7()
{
}
public function yy_r3_8()
{
}
public function yy_r3_9()
{
}
public function yy_r3_10()
{
}
public function yy_r3_11()
{
}
public function yy_r3_12()
{
}
public function yy_r3_13()
{
}
public function yy_r3_15()
{
}
public function yy_r3_17()
{
}
public function yy_r3_20()
{
}
public function yy_r3_23()
{
}
public function yy_r3_24()
{
}
public function yy_r3_28()
{
}
public function yy_r3_29()
{
}
public function yy_r3_30()
{
}
public function yy_r3_31()
{
}
public function yy_r3_32()
{
}
public function yy_r3_33()
{
}
public function yy_r3_34()
{
}
public function yy_r3_35()
{
}
public function yy_r3_37()
{
}
public function yy_r3_39()
{
}
public function yy_r3_41()
{
}
public function yy_r3_42()
{
}
public function yy_r3_43()
{
}
public function yy_r3_44()
{
}
public function yy_r3_47()
{
}
public function yy_r3_48()
{
}
public function yy_r3_49()
{
}
public function yy_r3_50()
{
}
public function yy_r3_51()
{
}
public function yy_r3_52()
{
}
public function yy_r3_53()
{
}
public function yy_r3_54()
{
}
public function yy_r3_55()
{
}
public function yy_r3_56()
{
}
public function yy_r3_57()
{
}
public function yy_r3_58()
{
}
// end function
public function yy_r3_59()
{
}
public function yylex4()
{
}
public function yy_r4_1()
{
}
public function yy_r4_3()
{
}
public function yy_r4_5()
{
}
// end function
public function yylex5()
{
}
public function yy_r5_1()
{
}
public function yy_r5_3()
{
}
public function yy_r5_5()
{
}
public function yy_r5_7()
{
}
public function yy_r5_9()
{
}
public function yy_r5_11()
{
}
public function yy_r5_13()
{
}
public function yy_r5_14()
{
}
public function yy_r5_15()
{
}
public function yy_r5_16()
{
}
public function yy_r5_17()
{
}
}
/**
* Smarty Method GetTemplateVars
*
* Smarty::getTemplateVars() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_GetTemplateVars
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* Returns a single or all template variables
*
* @api Smarty::getTemplateVars()
* @link http://www.smarty.net/docs/en/api.get.template.vars.tpl
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param string $varName variable name or null
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $_ptr optional pointer to data object
* @param bool $searchParents include parent templates?
*
* @return mixed variable value or or array of variables
*/
public function getTemplateVars(\Smarty_Internal_Data $data, $varName = \null, \Smarty_Internal_Data $_ptr = \null, $searchParents = \true)
{
}
/**
* gets the object of a Smarty variable
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param string $varName the name of the Smarty variable
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $_ptr optional pointer to data object
* @param bool $searchParents search also in parent data
* @param bool $errorEnable
*
* @return \Smarty_Variable
*/
public function _getVariable(\Smarty_Internal_Data $data, $varName, \Smarty_Internal_Data $_ptr = \null, $searchParents = \true, $errorEnable = \true)
{
}
}
/**
* Smarty Method ClearConfig
*
* Smarty::clearConfig() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_ClearConfig
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* clear a single or all config variables
*
* @api Smarty::clearConfig()
* @link http://www.smarty.net/docs/en/api.clear.config.tpl
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param string|null $name variable name or null
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public function clearConfig(\Smarty_Internal_Data $data, $name = \null)
{
}
}
/**
* Smarty Resource Data Object
* Meta Data Container for Template Files
*
* @package Smarty
* @subpackage TemplateResources
* @author Rodney Rehm
*/
class Smarty_Template_Source
{
/**
* Unique Template ID
*
* @var string
*/
public $uid = \null;
/**
* Template Resource (Smarty_Internal_Template::$template_resource)
*
* @var string
*/
public $resource = \null;
/**
* Resource Type
*
* @var string
*/
public $type = \null;
/**
* Resource Name
*
* @var string
*/
public $name = \null;
/**
* Source Filepath
*
* @var string
*/
public $filepath = \null;
/**
* Source Timestamp
*
* @var integer
*/
public $timestamp = \null;
/**
* Source Existence
*
* @var boolean
*/
public $exists = \false;
/**
* Source File Base name
*
* @var string
*/
public $basename = \null;
/**
* The Components an extended template is made of
*
* @var \Smarty_Template_Source[]
*/
public $components = \null;
/**
* Resource Handler
*
* @var \Smarty_Resource
*/
public $handler = \null;
/**
* Smarty instance
*
* @var Smarty
*/
public $smarty = \null;
/**
* Resource is source
*
* @var bool
*/
public $isConfig = \false;
/**
* Template source content eventually set by default handler
*
* @var string
*/
public $content = \null;
/**
* Name of the Class to compile this resource's contents with
*
* @var string
*/
public $compiler_class = 'Smarty_Internal_SmartyTemplateCompiler';
/**
* Name of the Class to tokenize this resource's contents with
*
* @var string
*/
public $template_lexer_class = 'Smarty_Internal_Templatelexer';
/**
* Name of the Class to parse this resource's contents with
*
* @var string
*/
public $template_parser_class = 'Smarty_Internal_Templateparser';
/**
* create Source Object container
*
* @param Smarty $smarty Smarty instance this source object belongs to
* @param string $resource full template_resource
* @param string $type type of resource
* @param string $name resource name
*
* @throws \SmartyException
* @internal param \Smarty_Resource $handler Resource Handler this source object communicates with
*/
public function __construct(\Smarty $smarty, $resource, $type, $name)
{
}
/**
* initialize Source Object for given resource
* Either [$_template] or [$smarty, $template_resource] must be specified
*
* @param Smarty_Internal_Template $_template template object
* @param Smarty $smarty smarty object
* @param string $template_resource resource identifier
*
* @return Smarty_Template_Source Source Object
* @throws SmartyException
*/
public static function load(\Smarty_Internal_Template $_template = \null, \Smarty $smarty = \null, $template_resource = \null)
{
}
/**
* Get source time stamp
*
* @return int
*/
public function getTimeStamp()
{
}
/**
* Get source content
*
* @return string
* @throws \SmartyException
*/
public function getContent()
{
}
}
/**
* Smarty Internal Plugin Compile extend
* Compiles the {extends} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile extend Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Extends extends \Smarty_Internal_Compile_Shared_Inheritance
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('file');
/**
* Array of names of optional attribute required by tag
* use array('_any') if there is no restriction of attributes names
*
* @var array
*/
public $optional_attributes = array('extends_resource');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('file');
/**
* Compiles code for the {extends} tag extends: resource
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* Create source code for {extends} from source components array
*
* @param \Smarty_Internal_Template $template
*
* @return string
*/
public static function extendsSourceArrayCode(\Smarty_Internal_Template $template)
{
}
}
/**
* Smarty Method MustCompile
*
* Smarty_Internal_Template::mustCompile() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_MustCompile
{
/**
* Valid for template object
*
* @var int
*/
public $objMap = 2;
/**
* Returns if the current template must be compiled by the Smarty compiler
* It does compare the timestamps of template source and the compiled templates and checks the force compile
* configuration
*
* @param \Smarty_Internal_Template $_template
*
* @return bool
* @throws \SmartyException
*/
public function mustCompile(\Smarty_Internal_Template $_template)
{
}
}
/**
* Smarty Method Append
*
* Smarty::append() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_Append
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* appends values to template variables
*
* @api Smarty::append()
* @link http://www.smarty.net/docs/en/api.append.tpl
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param array|string $tpl_var the template variable name(s)
* @param mixed $value the value to append
* @param bool $merge flag if array elements shall be merged
* @param bool $nocache if true any output of this variable will
* be not cached
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public function append(\Smarty_Internal_Data $data, $tpl_var, $value = \null, $merge = \false, $nocache = \false)
{
}
}
/**
* Smarty Method AddDefaultModifiers
*
* Smarty::addDefaultModifiers() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_AddDefaultModifiers
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Add default modifiers
*
* @api Smarty::addDefaultModifiers()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param array|string $modifiers modifier or list of modifiers
* to add
*
* @return \Smarty|\Smarty_Internal_Template
*/
public function addDefaultModifiers(\Smarty_Internal_TemplateBase $obj, $modifiers)
{
}
}
/**
* TplFunction Runtime Methods callTemplateFunction
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
**/
class Smarty_Internal_Runtime_TplFunction
{
/**
* Call template function
*
* @param \Smarty_Internal_Template $tpl template object
* @param string $name template function name
* @param array $params parameter array
* @param bool $nocache true if called nocache
*
* @throws \SmartyException
*/
public function callTemplateFunction(\Smarty_Internal_Template $tpl, $name, $params, $nocache)
{
}
/**
* Register template functions defined by template
*
* @param \Smarty|\Smarty_Internal_Template|\Smarty_Internal_TemplateBase $obj
* @param array $tplFunctions source information array of
* template functions defined
* in template
* @param bool $override if true replace existing
* functions with same name
*/
public function registerTplFunctions(\Smarty_Internal_TemplateBase $obj, $tplFunctions, $override = \true)
{
}
/**
* Return source parameter array for single or all template functions
*
* @param \Smarty_Internal_Template $tpl template object
* @param null|string $name template function name
*
* @return array|bool|mixed
*/
public function getTplFunction(\Smarty_Internal_Template $tpl, $name = \null)
{
}
/**
* Add template function to cache file for nocache calls
*
* @param Smarty_Internal_Template $tpl
* @param string $_name template function name
* @param string $_function PHP function name
*
* @return bool
*/
public function addTplFuncToCache(\Smarty_Internal_Template $tpl, $_name, $_function)
{
}
/**
* Save current template variables on stack
*
* @param \Smarty_Internal_Template $tpl
* @param string $name stack name
*/
public function saveTemplateVariables(\Smarty_Internal_Template $tpl, $name)
{
}
/**
* Restore saved variables into template objects
*
* @param \Smarty_Internal_Template $tpl
* @param string $name stack name
*/
public function restoreTemplateVariables(\Smarty_Internal_Template $tpl, $name)
{
}
}
/**
* Smarty Method GetAutoloadFilters
*
* Smarty::getAutoloadFilters() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_GetAutoloadFilters extends \Smarty_Internal_Method_SetAutoloadFilters
{
/**
* Get autoload filters
*
* @api Smarty::getAutoloadFilters()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $type type of filter to get auto loads
* for. Defaults to all autoload
* filters
*
* @return array array( 'type1' => array( 'filter1', 'filter2', … ) ) or array( 'filter1', 'filter2', …) if $type
* was specified
* @throws \SmartyException
*/
public function getAutoloadFilters(\Smarty_Internal_TemplateBase $obj, $type = \null)
{
}
}
/**
* Smarty Method AppendByRef
*
* Smarty::appendByRef() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_AppendByRef
{
/**
* appends values to template variables by reference
*
* @api Smarty::appendByRef()
* @link http://www.smarty.net/docs/en/api.append.by.ref.tpl
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param string $tpl_var the template variable name
* @param mixed &$value the referenced value to append
* @param bool $merge flag if array elements shall be merged
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public static function appendByRef(\Smarty_Internal_Data $data, $tpl_var, &$value, $merge = \false)
{
}
}
/**
* Smarty Method CompileAllConfig
*
* Smarty::compileAllConfig() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_CompileAllConfig extends \Smarty_Internal_Method_CompileAllTemplates
{
/**
* Compile all config files
*
* @api Smarty::compileAllConfig()
*
* @param \Smarty $smarty passed smarty object
* @param string $extension file extension
* @param bool $force_compile force all to recompile
* @param int $time_limit
* @param int $max_errors
*
* @return int number of template files recompiled
*/
public function compileAllConfig(\Smarty $smarty, $extension = '.conf', $force_compile = \false, $time_limit = 0, $max_errors = \null)
{
}
}
/**
* Smarty Method RegisterDefaultTemplateHandler
*
* Smarty::registerDefaultTemplateHandler() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_RegisterDefaultTemplateHandler
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Register template default handler
*
* @api Smarty::registerDefaultTemplateHandler()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param callable $callback class/method name
*
* @return \Smarty|\Smarty_Internal_Template
* @throws SmartyException if $callback is not callable
*/
public function registerDefaultTemplateHandler(\Smarty_Internal_TemplateBase $obj, $callback)
{
}
/**
* get default content from template or config resource handler
*
* @param Smarty_Template_Source $source
*
* @throws \SmartyException
*/
public static function _getDefaultTemplate(\Smarty_Template_Source $source)
{
}
}
/**
* Smarty Internal Plugin Templateparser Parse Tree
* These are classes to build parse tree in the template parser
*
* @package Smarty
* @subpackage Compiler
* @author Thue Kristensen
* @author Uwe Tews
* *
* template text
* @package Smarty
* @subpackage Compiler
* @ignore
*/
class Smarty_Internal_ParseTree_Text extends \Smarty_Internal_ParseTree
{
/**
* Create template text buffer
*
* @param string $data text
*/
public function __construct($data)
{
}
/**
* Return buffer content
*
* @param \Smarty_Internal_Templateparser $parser
*
* @return string text
*/
public function to_smarty_php(\Smarty_Internal_Templateparser $parser)
{
}
}
/**
* Smarty Internal Plugin Compile Section
* Compiles the {section} {sectionelse} {/section} tags
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Section Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Section extends \Smarty_Internal_Compile_Private_ForeachSection
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('name', 'loop');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('name', 'loop');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('start', 'step', 'max', 'show', 'properties');
/**
* counter
*
* @var int
*/
public $counter = 0;
/**
* Name of this tag
*
* @var string
*/
public $tagName = 'section';
/**
* Valid properties of $smarty.section.name.xxx variable
*
* @var array
*/
public $nameProperties = array('first', 'last', 'index', 'iteration', 'show', 'total', 'rownum', 'index_prev', 'index_next', 'loop');
/**
* {section} tag has no item properties
*
* @var array
*/
public $itemProperties = \null;
/**
* {section} tag has always name attribute
*
* @var bool
*/
public $isNamed = \true;
/**
* Compiles code for the {section} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Sectionelse Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Sectionelse extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {sectionelse} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Sectionclose Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Sectionclose extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {/section} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Debug
* Class to collect data for the Smarty Debugging Console
*
* @package Smarty
* @subpackage Debug
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Debug Class
*
* @package Smarty
* @subpackage Debug
*/
class Smarty_Internal_Debug extends \Smarty_Internal_Data
{
/**
* template data
*
* @var array
*/
public $template_data = array();
/**
* List of uid's which shall be ignored
*
* @var array
*/
public $ignore_uid = array();
/**
* Index of display() and fetch() calls
*
* @var int
*/
public $index = 0;
/**
* Counter for window offset
*
* @var int
*/
public $offset = 0;
/**
* Start logging template
*
* @param \Smarty_Internal_Template $template template
* @param null $mode true: display false: fetch null: subtemplate
*/
public function start_template(\Smarty_Internal_Template $template, $mode = \null)
{
}
/**
* End logging of cache time
*
* @param \Smarty_Internal_Template $template cached template
*/
public function end_template(\Smarty_Internal_Template $template)
{
}
/**
* Start logging of compile time
*
* @param \Smarty_Internal_Template $template
*/
public function start_compile(\Smarty_Internal_Template $template)
{
}
/**
* End logging of compile time
*
* @param \Smarty_Internal_Template $template
*/
public function end_compile(\Smarty_Internal_Template $template)
{
}
/**
* Start logging of render time
*
* @param \Smarty_Internal_Template $template
*/
public function start_render(\Smarty_Internal_Template $template)
{
}
/**
* End logging of compile time
*
* @param \Smarty_Internal_Template $template
*/
public function end_render(\Smarty_Internal_Template $template)
{
}
/**
* Start logging of cache time
*
* @param \Smarty_Internal_Template $template cached template
*/
public function start_cache(\Smarty_Internal_Template $template)
{
}
/**
* End logging of cache time
*
* @param \Smarty_Internal_Template $template cached template
*/
public function end_cache(\Smarty_Internal_Template $template)
{
}
/**
* Register template object
*
* @param \Smarty_Internal_Template $template cached template
*/
public function register_template(\Smarty_Internal_Template $template)
{
}
/**
* Register data object
*
* @param \Smarty_Data $data data object
*/
public static function register_data(\Smarty_Data $data)
{
}
/**
* Opens a window for the Smarty Debugging Console and display the data
*
* @param Smarty_Internal_Template|Smarty $obj object to debug
* @param bool $full
*
* @throws \Exception
* @throws \SmartyException
*/
public function display_debug($obj, $full = \false)
{
}
/**
* Recursively gets variables from all template/data scopes
*
* @param Smarty_Internal_Template|Smarty_Data $obj object to debug
*
* @return StdClass
*/
public function get_debug_vars($obj)
{
}
/**
* Ignore template
*
* @param \Smarty_Internal_Template $template
*/
public function ignore(\Smarty_Internal_Template $template)
{
}
/**
* handle 'URL' debugging mode
*
* @param Smarty $smarty
*/
public function debugUrl(\Smarty $smarty)
{
}
}
/**
* Smarty Resource Plugin
*
* @package Smarty
* @subpackage TemplateResources
* @author Rodney Rehm
*/
/**
* Smarty Resource Plugin
* Base implementation for resource plugins that don't use the compiler
*
* @package Smarty
* @subpackage TemplateResources
*/
abstract class Smarty_Resource_Uncompiled extends \Smarty_Resource
{
/**
* Flag that it's an uncompiled resource
*
* @var bool
*/
public $uncompiled = \true;
/**
* Resource does implement populateCompiledFilepath() method
*
* @var bool
*/
public $hasCompiledHandler = \true;
/**
* populate compiled object with compiled filepath
*
* @param Smarty_Template_Compiled $compiled compiled object
* @param Smarty_Internal_Template $_template template object
*/
public function populateCompiledFilepath(\Smarty_Template_Compiled $compiled, \Smarty_Internal_Template $_template)
{
}
}
/**
* Smarty Internal Plugin Compile Insert
* Compiles the {insert} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Insert Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Insert extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('name');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('name');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('_any');
/**
* Compiles code for the {insert} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Nocache
* Compiles the {nocache} {/nocache} tags.
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Nocache Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Nocache extends \Smarty_Internal_CompileBase
{
/**
* Array of names of valid option flags
*
* @var array
*/
public $option_flags = array();
/**
* Compiles code for the {nocache} tag
* This tag does not generate compiled output. It only sets a compiler flag.
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return bool
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Nocacheclose Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Nocacheclose extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {/nocache} tag
* This tag does not generate compiled output. It only sets a compiler flag.
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return bool
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile Special Smarty Variable
* Compiles the special $smarty variables
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile special Smarty Variable Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_Special_Variable extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the special $smarty variables
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param $parameter
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Method GetDefaultModifiers
*
* Smarty::getDefaultModifiers() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_GetDefaultModifiers
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Get default modifiers
*
* @api Smarty::getDefaultModifiers()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
*
* @return array list of default modifiers
*/
public function getDefaultModifiers(\Smarty_Internal_TemplateBase $obj)
{
}
}
/**
* Smarty Internal Plugin Resource Extends
*
* @package Smarty
* @subpackage TemplateResources
* @author Uwe Tews
* @author Rodney Rehm
*/
/**
* Smarty Internal Plugin Resource Extends
* Implements the file system as resource for Smarty which {extend}s a chain of template files templates
*
* @package Smarty
* @subpackage TemplateResources
*/
class Smarty_Internal_Resource_Extends extends \Smarty_Resource
{
/**
* mbstring.overload flag
*
* @var int
*/
public $mbstring_overload = 0;
/**
* populate Source Object with meta data from Resource
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*
* @throws SmartyException
*/
public function populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = \null)
{
}
/**
* populate Source Object with timestamp and exists from Resource
*
* @param Smarty_Template_Source $source source object
*/
public function populateTimestamp(\Smarty_Template_Source $source)
{
}
/**
* Load template's source from files into current template object
*
* @param Smarty_Template_Source $source source object
*
* @return string template source
* @throws SmartyException if source cannot be loaded
*/
public function getContent(\Smarty_Template_Source $source)
{
}
/**
* Determine basename for compiled filename
*
* @param Smarty_Template_Source $source source object
*
* @return string resource's basename
*/
public function getBasename(\Smarty_Template_Source $source)
{
}
/*
* Disable timestamp checks for extends resource.
* The individual source components will be checked.
*
* @return bool
*/
/**
* @return bool
*/
public function checkTimestamps()
{
}
}
/**
* Smarty Method GetTags
*
* Smarty::getTags() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_GetTags
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Return array of tag/attributes of all tags used by an template
*
* @api Smarty::getTags()
* @link http://www.smarty.net/docs/en/api.get.tags.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param null|string|Smarty_Internal_Template $template
*
* @return array of tag/attributes
* @throws \Exception
* @throws \SmartyException
*/
public function getTags(\Smarty_Internal_TemplateBase $obj, $template = \null)
{
}
}
/**
* Smarty Method CreateData
*
* Smarty::createData() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_CreateData
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* creates a data object
*
* @api Smarty::createData()
* @link http://www.smarty.net/docs/en/api.create.data.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param \Smarty_Internal_Template|\Smarty_Internal_Data|\Smarty_Data|\Smarty $parent next higher level of Smarty
* variables
* @param string $name optional data block name
*
* @return \Smarty_Data data object
*/
public function createData(\Smarty_Internal_TemplateBase $obj, \Smarty_Internal_Data $parent = \null, $name = \null)
{
}
}
class TPC_yyStackEntry
{
public $stateno;
/* The state-number */
public $major;
/* The major token value. This is the code
** number for the token at this stack level */
public $minor;
/* The user-supplied minor token value. This
** is the value of the token */
}
// line 12 "../smarty/lexer/smarty_internal_configfileparser.y"
/**
* Smarty Internal Plugin Configfileparse
*
* This is the config file parser.
* It is generated from the smarty_internal_configfileparser.y file
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
class Smarty_Internal_Configfileparser
{
// line 25 "../smarty/lexer/smarty_internal_configfileparser.y"
const TPC_OPENB = 1;
const TPC_SECTION = 2;
const TPC_CLOSEB = 3;
const TPC_DOT = 4;
const TPC_ID = 5;
const TPC_EQUAL = 6;
const TPC_FLOAT = 7;
const TPC_INT = 8;
const TPC_BOOL = 9;
const TPC_SINGLE_QUOTED_STRING = 10;
const TPC_DOUBLE_QUOTED_STRING = 11;
const TPC_TRIPPLE_QUOTES = 12;
const TPC_TRIPPLE_TEXT = 13;
const TPC_TRIPPLE_QUOTES_END = 14;
const TPC_NAKED_STRING = 15;
const TPC_OTHER = 16;
const TPC_NEWLINE = 17;
const TPC_COMMENTSTART = 18;
const YY_NO_ACTION = 60;
const YY_ACCEPT_ACTION = 59;
const YY_ERROR_ACTION = 58;
const YY_SZ_ACTTAB = 38;
const YY_SHIFT_USE_DFLT = -8;
const YY_SHIFT_MAX = 19;
const YY_REDUCE_USE_DFLT = -17;
const YY_REDUCE_MAX = 10;
const YYNOCODE = 29;
const YYSTACKDEPTH = 100;
const YYNSTATE = 36;
const YYNRULE = 22;
const YYERRORSYMBOL = 19;
const YYERRSYMDT = 'yy0';
const YYFALLBACK = 0;
public static $yy_action = array(32, 31, 30, 29, 35, 13, 19, 3, 24, 26, 59, 9, 14, 1, 16, 25, 11, 28, 25, 11, 17, 27, 34, 20, 18, 15, 23, 5, 6, 22, 10, 8, 4, 12, 2, 33, 7, 21);
public static $yy_lookahead = array(7, 8, 9, 10, 11, 12, 5, 23, 15, 16, 20, 21, 2, 23, 4, 17, 18, 14, 17, 18, 13, 14, 25, 26, 15, 2, 17, 3, 3, 17, 25, 25, 6, 1, 23, 27, 22, 24);
public static $yy_shift_ofst = array(-8, 1, 1, 1, -7, -2, -2, 32, -8, -8, -8, 9, 10, 7, 25, 24, 23, 3, 12, 26);
public static $yy_reduce_ofst = array(-10, -3, -3, -3, 8, 6, 5, 13, 11, 14, -16);
public static $yyExpectedTokens = array(array(), array(5, 17, 18), array(5, 17, 18), array(5, 17, 18), array(7, 8, 9, 10, 11, 12, 15, 16), array(17, 18), array(17, 18), array(1), array(), array(), array(), array(15, 17), array(2, 4), array(13, 14), array(3), array(3), array(2), array(14), array(17), array(6), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array(), array());
public static $yy_default = array(44, 37, 41, 40, 58, 58, 58, 36, 44, 39, 44, 58, 58, 58, 58, 58, 58, 58, 58, 58, 43, 38, 57, 56, 53, 55, 54, 52, 51, 49, 48, 47, 46, 45, 42, 50);
public static $yyFallback = array();
public static $yyRuleName = array('start ::= global_vars sections', 'global_vars ::= var_list', 'sections ::= sections section', 'sections ::=', 'section ::= OPENB SECTION CLOSEB newline var_list', 'section ::= OPENB DOT SECTION CLOSEB newline var_list', 'var_list ::= var_list newline', 'var_list ::= var_list var', 'var_list ::=', 'var ::= ID EQUAL value', 'value ::= FLOAT', 'value ::= INT', 'value ::= BOOL', 'value ::= SINGLE_QUOTED_STRING', 'value ::= DOUBLE_QUOTED_STRING', 'value ::= TRIPPLE_QUOTES TRIPPLE_TEXT TRIPPLE_QUOTES_END', 'value ::= TRIPPLE_QUOTES TRIPPLE_QUOTES_END', 'value ::= NAKED_STRING', 'value ::= OTHER', 'newline ::= NEWLINE', 'newline ::= COMMENTSTART NEWLINE', 'newline ::= COMMENTSTART NAKED_STRING NEWLINE');
public static $yyRuleInfo = array(array(0 => 20, 1 => 2), array(0 => 21, 1 => 1), array(0 => 22, 1 => 2), array(0 => 22, 1 => 0), array(0 => 24, 1 => 5), array(0 => 24, 1 => 6), array(0 => 23, 1 => 2), array(0 => 23, 1 => 2), array(0 => 23, 1 => 0), array(0 => 26, 1 => 3), array(0 => 27, 1 => 1), array(0 => 27, 1 => 1), array(0 => 27, 1 => 1), array(0 => 27, 1 => 1), array(0 => 27, 1 => 1), array(0 => 27, 1 => 3), array(0 => 27, 1 => 2), array(0 => 27, 1 => 1), array(0 => 27, 1 => 1), array(0 => 25, 1 => 1), array(0 => 25, 1 => 2), array(0 => 25, 1 => 3));
public static $yyReduceMap = array(0 => 0, 2 => 0, 3 => 0, 19 => 0, 20 => 0, 21 => 0, 1 => 1, 4 => 4, 5 => 5, 6 => 6, 7 => 7, 8 => 8, 9 => 9, 10 => 10, 11 => 11, 12 => 12, 13 => 13, 14 => 14, 15 => 15, 16 => 16, 17 => 17, 18 => 17);
/**
* result status
*
* @var bool
*/
public $successful = \true;
/**
* return value
*
* @var mixed
*/
public $retvalue = 0;
/**
* @var
*/
public $yymajor;
/**
* compiler object
*
* @var Smarty_Internal_Config_File_Compiler
*/
public $compiler = \null;
/**
* smarty object
*
* @var Smarty
*/
public $smarty = \null;
public $yyTraceFILE;
public $yyTracePrompt;
public $yyidx;
public $yyerrcnt;
public $yystack = array();
public $yyTokenName = array('$', 'OPENB', 'SECTION', 'CLOSEB', 'DOT', 'ID', 'EQUAL', 'FLOAT', 'INT', 'BOOL', 'SINGLE_QUOTED_STRING', 'DOUBLE_QUOTED_STRING', 'TRIPPLE_QUOTES', 'TRIPPLE_TEXT', 'TRIPPLE_QUOTES_END', 'NAKED_STRING', 'OTHER', 'NEWLINE', 'COMMENTSTART', 'error', 'start', 'global_vars', 'sections', 'var_list', 'section', 'newline', 'var', 'value');
/**
* constructor
*
* @param Smarty_Internal_Configfilelexer $lex
* @param Smarty_Internal_Config_File_Compiler $compiler
*/
public function __construct(\Smarty_Internal_Configfilelexer $lex, \Smarty_Internal_Config_File_Compiler $compiler)
{
}
public static function yy_destructor($yymajor, $yypminor)
{
}
/* The parser's stack */
public function Trace($TraceFILE, $zTracePrompt)
{
}
public function PrintTrace()
{
}
public function tokenName($tokenType)
{
}
public function yy_pop_parser_stack()
{
}
public function __destruct()
{
}
public function yy_get_expected_tokens($token)
{
}
public function yy_is_expected_token($token)
{
}
public function yy_find_shift_action($iLookAhead)
{
}
public function yy_find_reduce_action($stateno, $iLookAhead)
{
}
public function yy_shift($yyNewState, $yyMajor, $yypMinor)
{
}
public function yy_r0()
{
}
public function yy_r1()
{
}
public function yy_r4()
{
}
// line 245 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r5()
{
}
// line 250 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r6()
{
}
// line 264 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r7()
{
}
// line 269 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r8()
{
}
// line 277 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r9()
{
}
// line 281 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r10()
{
}
// line 285 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r11()
{
}
// line 291 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r12()
{
}
// line 296 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r13()
{
}
// line 300 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r14()
{
}
// line 304 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r15()
{
}
// line 308 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r16()
{
}
// line 312 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_r17()
{
}
// line 316 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_reduce($yyruleno)
{
}
// line 320 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_parse_failed()
{
}
// line 324 "../smarty/lexer/smarty_internal_configfileparser.y"
public function yy_syntax_error($yymajor, $TOKEN)
{
}
public function yy_accept()
{
}
public function doParse($yymajor, $yytokenvalue)
{
}
}
/**
* Smarty Method UnregisterObject
*
* Smarty::unregisterObject() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_UnregisterObject
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers plugin to be used in templates
*
* @api Smarty::unregisterObject()
* @link http://www.smarty.net/docs/en/api.unregister.object.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $object_name name of object
*
* @return \Smarty|\Smarty_Internal_Template
*/
public function unregisterObject(\Smarty_Internal_TemplateBase $obj, $object_name)
{
}
}
/**
* Runtime Extension updateScope
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
**/
class Smarty_Internal_Runtime_UpdateScope
{
/**
* Update new assigned template or config variable in other effected scopes
*
* @param Smarty_Internal_Template $tpl data object
* @param string|null $varName variable name
* @param int $tagScope tag scope to which bubble up variable value
*/
public function _updateScope(\Smarty_Internal_Template $tpl, $varName, $tagScope = 0)
{
}
/**
* Get array of objects which needs to be updated by given scope value
*
* @param Smarty_Internal_Template $tpl
* @param int $mergedScope merged tag and template scope to which bubble up variable value
*
* @return array
*/
public function _getAffectedScopes(\Smarty_Internal_Template $tpl, $mergedScope)
{
}
/**
* Update variable in other scope
*
* @param array $tpl_vars template variable array
* @param \Smarty_Internal_Template $from
* @param string $varName variable name
*/
public function _updateVariableInOtherScope(&$tpl_vars, \Smarty_Internal_Template $from, $varName)
{
}
/**
* Update variable in template local variable stack
*
* @param \Smarty_Internal_Template $tpl
* @param string|null $varName variable name or null for config variables
*/
public function _updateVarStack(\Smarty_Internal_Template $tpl, $varName)
{
}
}
/**
* class for the Smarty variable object
* This class defines the Smarty variable object
*
* @package Smarty
* @subpackage Template
*/
class Smarty_Variable
{
/**
* template variable
*
* @var mixed
*/
public $value = \null;
/**
* if true any output of this variable will be not cached
*
* @var boolean
*/
public $nocache = \false;
/**
* create Smarty variable object
*
* @param mixed $value the value to assign
* @param boolean $nocache if true any output of this variable will be not cached
*/
public function __construct($value = \null, $nocache = \false)
{
}
/**
* <<magic>> String conversion
*
* @return string
*/
public function __toString()
{
}
}
/**
* Smarty Method GetLiterals
*
* Smarty::getLiterals() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_Literals
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Get literals
*
* @api Smarty::getLiterals()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
*
* @return array list of literals
*/
public function getLiterals(\Smarty_Internal_TemplateBase $obj)
{
}
/**
* Add literals
*
* @api Smarty::addLiterals()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param array|string $literals literal or list of literals
* to addto add
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function addLiterals(\Smarty_Internal_TemplateBase $obj, $literals = \null)
{
}
/**
* Set literals
*
* @api Smarty::setLiterals()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param array|string $literals literal or list of literals
* to setto set
*
* @return \Smarty|\Smarty_Internal_Template
* @throws \SmartyException
*/
public function setLiterals(\Smarty_Internal_TemplateBase $obj, $literals = \null)
{
}
}
/**
* Smarty Internal Plugin Resource Registered
*
* @package Smarty
* @subpackage TemplateResources
* @author Uwe Tews
* @author Rodney Rehm
*/
/**
* Smarty Internal Plugin Resource Registered
* Implements the registered resource for Smarty template
*
* @package Smarty
* @subpackage TemplateResources
* @deprecated
*/
class Smarty_Internal_Resource_Registered extends \Smarty_Resource
{
/**
* populate Source Object with meta data from Resource
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*
* @return void
*/
public function populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = \null)
{
}
/**
* populate Source Object with timestamp and exists from Resource
*
* @param Smarty_Template_Source $source source object
*
* @return void
*/
public function populateTimestamp(\Smarty_Template_Source $source)
{
}
/**
* Get timestamp (epoch) the template source was modified
*
* @param Smarty_Template_Source $source source object
*
* @return integer|boolean timestamp (epoch) the template was modified, false if resources has no timestamp
*/
public function getTemplateTimestamp(\Smarty_Template_Source $source)
{
}
/**
* Load template's source by invoking the registered callback into current template object
*
* @param Smarty_Template_Source $source source object
*
* @return string template source
* @throws SmartyException if source cannot be loaded
*/
public function getContent(\Smarty_Template_Source $source)
{
}
/**
* Determine basename for compiled filename
*
* @param Smarty_Template_Source $source source object
*
* @return string resource's basename
*/
public function getBasename(\Smarty_Template_Source $source)
{
}
}
/**
* Smarty Internal Plugin Compile Include PHP
* Compiles the {include_php} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Insert Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Include_Php extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('file');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('file');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('once', 'assign');
/**
* Compiles code for the {include_php} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Method GetDebugTemplate
*
* Smarty::getDebugTemplate() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_GetDebugTemplate
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* return name of debugging template
*
* @api Smarty::getDebugTemplate()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
*
* @return string
*/
public function getDebugTemplate(\Smarty_Internal_TemplateBase $obj)
{
}
}
/**
* Inheritance Runtime Methods processBlock, endChild, init
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
**/
class Smarty_Internal_Runtime_Inheritance
{
/**
* State machine
* - 0 idle next extends will create a new inheritance tree
* - 1 processing child template
* - 2 wait for next inheritance template
* - 3 assume parent template, if child will loaded goto state 1
* a call to a sub template resets the state to 0
*
* @var int
*/
public $state = 0;
/**
* Array of root child {block} objects
*
* @var Smarty_Internal_Block[]
*/
public $childRoot = array();
/**
* inheritance template nesting level
*
* @var int
*/
public $inheritanceLevel = 0;
/**
* inheritance template index
*
* @var int
*/
public $tplIndex = -1;
/**
* Array of template source objects
*
* @var Smarty_Template_Source[]
*/
public $sources = array();
/**
* Stack of source objects while executing block code
*
* @var Smarty_Template_Source[]
*/
public $sourceStack = array();
/**
* Initialize inheritance
*
* @param \Smarty_Internal_Template $tpl template object of caller
* @param bool $initChild if true init for child template
* @param array $blockNames outer level block name
*/
public function init(\Smarty_Internal_Template $tpl, $initChild, $blockNames = array())
{
}
/**
* End of child template(s)
* - if outer level is reached flush output buffer and switch to wait for parent template state
*
* @param \Smarty_Internal_Template $tpl
* @param null|string $template optional name of inheritance parent template
* @param null|string $uid uid of inline template
* @param null|string $func function call name of inline template
*
* @throws \Exception
* @throws \SmartyException
*/
public function endChild(\Smarty_Internal_Template $tpl, $template = \null, $uid = \null, $func = \null)
{
}
/**
* Smarty_Internal_Block constructor.
* - if outer level {block} of child template ($state === 1) save it as child root block
* - otherwise process inheritance and render
*
* @param \Smarty_Internal_Template $tpl
* @param $className
* @param string $name
* @param int|null $tplIndex index of outer level {block} if nested
*
* @throws \SmartyException
*/
public function instanceBlock(\Smarty_Internal_Template $tpl, $className, $name, $tplIndex = \null)
{
}
/**
* Goto child block or render this
*
* @param \Smarty_Internal_Template $tpl
* @param \Smarty_Internal_Block $block
* @param \Smarty_Internal_Block|null $parent
*
* @throws \SmartyException
*/
public function process(\Smarty_Internal_Template $tpl, \Smarty_Internal_Block $block, \Smarty_Internal_Block $parent = \null)
{
}
/**
* Render child on \$smarty.block.child
*
* @param \Smarty_Internal_Template $tpl
* @param \Smarty_Internal_Block $block
*
* @return null|string block content
* @throws \SmartyException
*/
public function callChild(\Smarty_Internal_Template $tpl, \Smarty_Internal_Block $block)
{
}
/**
* Render parent block on \$smarty.block.parent or {block append/prepend}
*
* @param \Smarty_Internal_Template $tpl
* @param \Smarty_Internal_Block $block
* @param string $tag
*
* @return null|string block content
* @throws \SmartyException
*/
public function callParent(\Smarty_Internal_Template $tpl, \Smarty_Internal_Block $block, $tag)
{
}
/**
* render block
*
* @param \Smarty_Internal_Block $block
* @param \Smarty_Internal_Template $tpl
*/
public function callBlock(\Smarty_Internal_Block $block, \Smarty_Internal_Template $tpl)
{
}
}
/**
* Smarty Method RegisterResource
*
* Smarty::registerResource() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_RegisterResource
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers a resource to fetch a template
*
* @api Smarty::registerResource()
* @link http://www.smarty.net/docs/en/api.register.resource.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $name name of resource type
* @param Smarty_Resource|array $resource_handler or instance of
* Smarty_Resource,
* or array of
* callbacks to
* handle
* resource
* (deprecated)
*
* @return \Smarty|\Smarty_Internal_Template
*/
public function registerResource(\Smarty_Internal_TemplateBase $obj, $name, $resource_handler)
{
}
}
/**
* Foreach Runtime Methods count(), init(), restore()
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Runtime_Foreach
{
/**
* Init foreach loop
* - save item and key variables, named foreach property data if defined
* - init item and key variables, named foreach property data if required
* - count total if required
*
* @param \Smarty_Internal_Template $tpl
* @param mixed $from values to loop over
* @param string $item variable name
* @param bool $needTotal flag if we need to count values
* @param null|string $key variable name
* @param null|string $name of named foreach
* @param array $properties of named foreach
*
* @return mixed $from
*/
public function init(\Smarty_Internal_Template $tpl, $from, $item, $needTotal = \false, $key = \null, $name = \null, $properties = array())
{
}
/**
* [util function] counts an array, arrayAccess/traversable or PDOStatement object
*
* @param mixed $value
*
* @return int the count for arrays and objects that implement countable, 1 for other objects that don't, and 0
* for empty elements
*/
public function count($value)
{
}
/**
* Restore saved variables
*
* will be called by {break n} or {continue n} for the required number of levels
*
* @param \Smarty_Internal_Template $tpl
* @param int $levels number of levels
*/
public function restore(\Smarty_Internal_Template $tpl, $levels = 1)
{
}
}
/**
* Smarty Internal Plugin Resource Stream
* Implements the streams as resource for Smarty template
*
* @package Smarty
* @subpackage TemplateResources
* @author Uwe Tews
* @author Rodney Rehm
*/
/**
* Smarty Internal Plugin Resource Stream
* Implements the streams as resource for Smarty template
*
* @link http://php.net/streams
* @package Smarty
* @subpackage TemplateResources
*/
class Smarty_Internal_Resource_Stream extends \Smarty_Resource_Recompiled
{
/**
* populate Source Object with meta data from Resource
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*
* @return void
*/
public function populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = \null)
{
}
/**
* Load template's source from stream into current template object
*
* @param Smarty_Template_Source $source source object
*
* @return string template source
*/
public function getContent(\Smarty_Template_Source $source)
{
}
/**
* modify resource_name according to resource handlers specifications
*
* @param Smarty $smarty Smarty instance
* @param string $resource_name resource_name to make unique
* @param boolean $isConfig flag for config resource
*
* @return string unique resource name
*/
public function buildUniqueResourceName(\Smarty $smarty, $resource_name, $isConfig = \false)
{
}
}
/**
* Smarty Internal Plugin Compile Include
* Compiles the {include} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Include Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Include extends \Smarty_Internal_CompileBase
{
/**
* caching mode to create nocache code but no cache file
*/
const CACHING_NOCACHE_CODE = 9999;
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('file');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('file');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $option_flags = array('nocache', 'inline', 'caching');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('_any');
/**
* Valid scope names
*
* @var array
*/
public $valid_scopes = array('parent' => \Smarty::SCOPE_PARENT, 'root' => \Smarty::SCOPE_ROOT, 'global' => \Smarty::SCOPE_GLOBAL, 'tpl_root' => \Smarty::SCOPE_TPL_ROOT, 'smarty' => \Smarty::SCOPE_SMARTY);
/**
* Compiles code for the {include} tag
*
* @param array $args array with attributes from parser
* @param Smarty_Internal_SmartyTemplateCompiler $compiler compiler object
*
* @return string
* @throws \Exception
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_SmartyTemplateCompiler $compiler)
{
}
/**
* Compile inline sub template
*
* @param \Smarty_Internal_SmartyTemplateCompiler $compiler
* @param \Smarty_Internal_Template $tpl
* @param string $t_hash
*
* @return bool
* @throws \Exception
* @throws \SmartyException
*/
public function compileInlineTemplate(\Smarty_Internal_SmartyTemplateCompiler $compiler, \Smarty_Internal_Template $tpl, $t_hash)
{
}
}
/**
* Smarty Internal Plugin
*
* @package Smarty
* @subpackage Cacher
*/
/**
* Cache Handler API
*
* @package Smarty
* @subpackage Cacher
* @author Rodney Rehm
*/
abstract class Smarty_CacheResource_Custom extends \Smarty_CacheResource
{
/**
* fetch cached content and its modification time from data source
*
* @param string $id unique cache content identifier
* @param string $name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param string $content cached content
* @param integer $mtime cache modification timestamp (epoch)
*
* @return void
*/
protected abstract function fetch($id, $name, $cache_id, $compile_id, &$content, &$mtime);
/**
* Fetch cached content's modification timestamp from data source
* {@internal implementing this method is optional.
* Only implement it if modification times can be accessed faster than loading the complete cached content.}}
*
* @param string $id unique cache content identifier
* @param string $name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
*
* @return integer|boolean timestamp (epoch) the template was modified, or false if not found
*/
protected function fetchTimestamp($id, $name, $cache_id, $compile_id)
{
}
/**
* Save content to cache
*
* @param string $id unique cache content identifier
* @param string $name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param integer|null $exp_time seconds till expiration or null
* @param string $content content to cache
*
* @return boolean success
*/
protected abstract function save($id, $name, $cache_id, $compile_id, $exp_time, $content);
/**
* Delete content from cache
*
* @param string|null $name template name
* @param string|null $cache_id cache id
* @param string|null $compile_id compile id
* @param integer|null $exp_time seconds till expiration time in seconds or null
*
* @return integer number of deleted caches
*/
protected abstract function delete($name, $cache_id, $compile_id, $exp_time);
/**
* populate Cached Object with meta data from Resource
*
* @param Smarty_Template_Cached $cached cached object
* @param Smarty_Internal_Template $_template template object
*
* @return void
*/
public function populate(\Smarty_Template_Cached $cached, \Smarty_Internal_Template $_template)
{
}
/**
* populate Cached Object with timestamp and exists from Resource
*
* @param Smarty_Template_Cached $cached
*
* @return void
*/
public function populateTimestamp(\Smarty_Template_Cached $cached)
{
}
/**
* Read the cached template and process the header
*
* @param \Smarty_Internal_Template $_smarty_tpl do not change variable name, is used by compiled template
* @param Smarty_Template_Cached $cached cached object
* @param boolean $update flag if called because cache update
*
* @return boolean true or false if the cached content does not exist
*/
public function process(\Smarty_Internal_Template $_smarty_tpl, \Smarty_Template_Cached $cached = \null, $update = \false)
{
}
/**
* Write the rendered template output to cache
*
* @param Smarty_Internal_Template $_template template object
* @param string $content content to cache
*
* @return boolean success
*/
public function writeCachedContent(\Smarty_Internal_Template $_template, $content)
{
}
/**
* Read cached template from cache
*
* @param Smarty_Internal_Template $_template template object
*
* @return string|boolean content
*/
public function readCachedContent(\Smarty_Internal_Template $_template)
{
}
/**
* Empty cache
*
* @param Smarty $smarty Smarty object
* @param integer $exp_time expiration time (number of seconds, not timestamp)
*
* @return integer number of cache files deleted
*/
public function clearAll(\Smarty $smarty, $exp_time = \null)
{
}
/**
* Empty cache for a specific template
*
* @param Smarty $smarty Smarty object
* @param string $resource_name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param integer $exp_time expiration time (number of seconds, not timestamp)
*
* @return int number of cache files deleted
* @throws \SmartyException
*/
public function clear(\Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)
{
}
/**
* Check is cache is locked for this template
*
* @param Smarty $smarty Smarty object
* @param Smarty_Template_Cached $cached cached object
*
* @return boolean true or false if cache is locked
*/
public function hasLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Lock cache for this template
*
* @param Smarty $smarty Smarty object
* @param Smarty_Template_Cached $cached cached object
*
* @return bool|void
*/
public function acquireLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Unlock cache for this template
*
* @param Smarty $smarty Smarty object
* @param Smarty_Template_Cached $cached cached object
*
* @return bool|void
*/
public function releaseLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
}
/**
* Smarty Resource Data Object
* Meta Data Container for Template Files
*
* @package Smarty
* @subpackage TemplateResources
* @author Rodney Rehm
* @property string $content compiled content
*/
class Smarty_Template_Compiled extends \Smarty_Template_Resource_Base
{
/**
* nocache hash
*
* @var string|null
*/
public $nocache_hash = \null;
/**
* get a Compiled Object of this source
*
* @param Smarty_Internal_Template $_template template object
*
* @return Smarty_Template_Compiled compiled object
*/
public static function load($_template)
{
}
/**
* populate Compiled Object with compiled filepath
*
* @param Smarty_Internal_Template $_template template object
**/
public function populateCompiledFilepath(\Smarty_Internal_Template $_template)
{
}
/**
* render compiled template code
*
* @param Smarty_Internal_Template $_template
*
* @return string
* @throws Exception
*/
public function render(\Smarty_Internal_Template $_template)
{
}
/**
* load compiled template or compile from source
*
* @param Smarty_Internal_Template $_smarty_tpl do not change variable name, is used by compiled template
*
* @throws Exception
*/
public function process(\Smarty_Internal_Template $_smarty_tpl)
{
}
/**
* compile template from source
*
* @param Smarty_Internal_Template $_template
*
* @throws Exception
*/
public function compileTemplateSource(\Smarty_Internal_Template $_template)
{
}
/**
* Write compiled code by handler
*
* @param Smarty_Internal_Template $_template template object
* @param string $code compiled code
*
* @return bool success
* @throws \SmartyException
*/
public function write(\Smarty_Internal_Template $_template, $code)
{
}
/**
* Read compiled content from handler
*
* @param Smarty_Internal_Template $_template template object
*
* @return string content
*/
public function read(\Smarty_Internal_Template $_template)
{
}
}
/**
* class for undefined variable object
* This class defines an object for undefined variable handling
*
* @package Smarty
* @subpackage Template
*/
class Smarty_Undefined_Variable extends \Smarty_Variable
{
/**
* Returns null for not existing properties
*
* @param string $name
*
* @return null
*/
public function __get($name)
{
}
/**
* Always returns an empty string.
*
* @return string
*/
public function __toString()
{
}
}
/**
* Smarty Internal Plugin Config File Compiler
* This is the config file compiler class. It calls the lexer and parser to
* perform the compiling.
*
* @package Smarty
* @subpackage Config
* @author Uwe Tews
*/
/**
* Main config file compiler class
*
* @package Smarty
* @subpackage Config
*/
class Smarty_Internal_Config_File_Compiler
{
/**
* Lexer class name
*
* @var string
*/
public $lexer_class;
/**
* Parser class name
*
* @var string
*/
public $parser_class;
/**
* Lexer object
*
* @var object
*/
public $lex;
/**
* Parser object
*
* @var object
*/
public $parser;
/**
* Smarty object
*
* @var Smarty object
*/
public $smarty;
/**
* Smarty object
*
* @var Smarty_Internal_Template object
*/
public $template;
/**
* Compiled config data sections and variables
*
* @var array
*/
public $config_data = array();
/**
* compiled config data must always be written
*
* @var bool
*/
public $write_compiled_code = \true;
/**
* Initialize compiler
*
* @param string $lexer_class class name
* @param string $parser_class class name
* @param Smarty $smarty global instance
*/
public function __construct($lexer_class, $parser_class, \Smarty $smarty)
{
}
/**
* Method to compile Smarty config source.
*
* @param Smarty_Internal_Template $template
*
* @return bool true if compiling succeeded, false if it failed
* @throws \SmartyException
*/
public function compileTemplate(\Smarty_Internal_Template $template)
{
}
/**
* display compiler error messages without dying
* If parameter $args is empty it is a parser detected syntax error.
* In this case the parser is called to obtain information about expected tokens.
* If parameter $args contains a string this is used as error message
*
* @param string $args individual error message or null
*
* @throws SmartyCompilerException
*/
public function trigger_config_file_error($args = \null)
{
}
}
/**
* Smarty Internal Plugin Compile Make_Nocache
* Compiles the {make_nocache} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Make_Nocache Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Make_Nocache extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $option_flags = array();
/**
* Array of names of required attribute required by tag
*
* @var array
*/
public $required_attributes = array('var');
/**
* Shorttag attribute order defined by its names
*
* @var array
*/
public $shorttag_order = array('var');
/**
* Compiles code for the {make_nocache} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile If
* Compiles the {if} {else} {elseif} {/if} tags
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile If Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_If extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {if} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile Else Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Else extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {else} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin Compile ElseIf Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Elseif extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {elseif} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile Ifclose Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Ifclose extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {/if} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Internal Plugin
*
* @package Smarty
* @subpackage Cacher
*/
/**
* Smarty Cache Handler Base for Key/Value Storage Implementations
* This class implements the functionality required to use simple key/value stores
* for hierarchical cache groups. key/value stores like memcache or APC do not support
* wildcards in keys, therefore a cache group cannot be cleared like "a|*" - which
* is no problem to filesystem and RDBMS implementations.
* This implementation is based on the concept of invalidation. While one specific cache
* can be identified and cleared, any range of caches cannot be identified. For this reason
* each level of the cache group hierarchy can have its own value in the store. These values
* are nothing but microtimes, telling us when a particular cache group was cleared for the
* last time. These keys are evaluated for every cache read to determine if the cache has
* been invalidated since it was created and should hence be treated as inexistent.
* Although deep hierarchies are possible, they are not recommended. Try to keep your
* cache groups as shallow as possible. Anything up 3-5 parents should be ok. So
* »a|b|c« is a good depth where »a|b|c|d|e|f|g|h|i|j|k« isn't. Try to join correlating
* cache groups: if your cache groups look somewhat like »a|b|$page|$items|$whatever«
* consider using »a|b|c|$page-$items-$whatever« instead.
*
* @package Smarty
* @subpackage Cacher
* @author Rodney Rehm
*/
abstract class Smarty_CacheResource_KeyValueStore extends \Smarty_CacheResource
{
/**
* cache for contents
*
* @var array
*/
protected $contents = array();
/**
* cache for timestamps
*
* @var array
*/
protected $timestamps = array();
/**
* populate Cached Object with meta data from Resource
*
* @param Smarty_Template_Cached $cached cached object
* @param Smarty_Internal_Template $_template template object
*
* @return void
*/
public function populate(\Smarty_Template_Cached $cached, \Smarty_Internal_Template $_template)
{
}
/**
* populate Cached Object with timestamp and exists from Resource
*
* @param Smarty_Template_Cached $cached cached object
*
* @return void
*/
public function populateTimestamp(\Smarty_Template_Cached $cached)
{
}
/**
* Read the cached template and process the header
*
* @param \Smarty_Internal_Template $_smarty_tpl do not change variable name, is used by compiled template
* @param Smarty_Template_Cached $cached cached object
* @param boolean $update flag if called because cache update
*
* @return boolean true or false if the cached content does not exist
*/
public function process(\Smarty_Internal_Template $_smarty_tpl, \Smarty_Template_Cached $cached = \null, $update = \false)
{
}
/**
* Write the rendered template output to cache
*
* @param Smarty_Internal_Template $_template template object
* @param string $content content to cache
*
* @return boolean success
*/
public function writeCachedContent(\Smarty_Internal_Template $_template, $content)
{
}
/**
* Read cached template from cache
*
* @param Smarty_Internal_Template $_template template object
*
* @return string|false content
*/
public function readCachedContent(\Smarty_Internal_Template $_template)
{
}
/**
* Empty cache
* {@internal the $exp_time argument is ignored altogether }}
*
* @param Smarty $smarty Smarty object
* @param integer $exp_time expiration time [being ignored]
*
* @return integer number of cache files deleted [always -1]
* @uses purge() to clear the whole store
* @uses invalidate() to mark everything outdated if purge() is inapplicable
*/
public function clearAll(\Smarty $smarty, $exp_time = \null)
{
}
/**
* Empty cache for a specific template
* {@internal the $exp_time argument is ignored altogether}}
*
* @param Smarty $smarty Smarty object
* @param string $resource_name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param integer $exp_time expiration time [being ignored]
*
* @return int number of cache files deleted [always -1]
* @throws \SmartyException
* @uses buildCachedFilepath() to generate the CacheID
* @uses invalidate() to mark CacheIDs parent chain as outdated
* @uses delete() to remove CacheID from cache
*/
public function clear(\Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)
{
}
/**
* Get template's unique ID
*
* @param Smarty $smarty Smarty object
* @param string $resource_name template name
*
* @return string filepath of cache file
* @throws \SmartyException
*/
protected function getTemplateUid(\Smarty $smarty, $resource_name)
{
}
/**
* Sanitize CacheID components
*
* @param string $string CacheID component to sanitize
*
* @return string sanitized CacheID component
*/
protected function sanitize($string)
{
}
/**
* Fetch and prepare a cache object.
*
* @param string $cid CacheID to fetch
* @param string $resource_name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param string $content cached content
* @param integer &$timestamp cached timestamp (epoch)
* @param string $resource_uid resource's uid
*
* @return boolean success
*/
protected function fetch($cid, $resource_name = \null, $cache_id = \null, $compile_id = \null, &$content = \null, &$timestamp = \null, $resource_uid = \null)
{
}
/**
* Add current microtime to the beginning of $cache_content
* {@internal the header uses 8 Bytes, the first 4 Bytes are the seconds, the second 4 Bytes are the microseconds}}
*
* @param string &$content the content to be cached
*/
protected function addMetaTimestamp(&$content)
{
}
/**
* Extract the timestamp the $content was cached
*
* @param string &$content the cached content
*
* @return float the microtime the content was cached
*/
protected function getMetaTimestamp(&$content)
{
}
/**
* Invalidate CacheID
*
* @param string $cid CacheID
* @param string $resource_name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param string $resource_uid source's uid
*
* @return void
*/
protected function invalidate($cid = \null, $resource_name = \null, $cache_id = \null, $compile_id = \null, $resource_uid = \null)
{
}
/**
* Determine the latest timestamp known to the invalidation chain
*
* @param string $cid CacheID to determine latest invalidation timestamp of
* @param string $resource_name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param string $resource_uid source's filepath
*
* @return float the microtime the CacheID was invalidated
*/
protected function getLatestInvalidationTimestamp($cid, $resource_name = \null, $cache_id = \null, $compile_id = \null, $resource_uid = \null)
{
}
/**
* Translate a CacheID into the list of applicable InvalidationKeys.
* Splits 'some|chain|into|an|array' into array( '#clearAll#', 'some', 'some|chain', 'some|chain|into', ... )
*
* @param string $cid CacheID to translate
* @param string $resource_name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param string $resource_uid source's filepath
*
* @return array list of InvalidationKeys
* @uses $invalidationKeyPrefix to prepend to each InvalidationKey
*/
protected function listInvalidationKeys($cid, $resource_name = \null, $cache_id = \null, $compile_id = \null, $resource_uid = \null)
{
}
/**
* Check is cache is locked for this template
*
* @param Smarty $smarty Smarty object
* @param Smarty_Template_Cached $cached cached object
*
* @return boolean true or false if cache is locked
*/
public function hasLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Lock cache for this template
*
* @param Smarty $smarty Smarty object
* @param Smarty_Template_Cached $cached cached object
*
* @return bool|void
*/
public function acquireLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Unlock cache for this template
*
* @param Smarty $smarty Smarty object
* @param Smarty_Template_Cached $cached cached object
*
* @return bool|void
*/
public function releaseLock(\Smarty $smarty, \Smarty_Template_Cached $cached)
{
}
/**
* Read values for a set of keys from cache
*
* @param array $keys list of keys to fetch
*
* @return array list of values with the given keys used as indexes
*/
protected abstract function read(array $keys);
/**
* Save values for a set of keys to cache
*
* @param array $keys list of values to save
* @param int $expire expiration time
*
* @return boolean true on success, false on failure
*/
protected abstract function write(array $keys, $expire = \null);
/**
* Remove values from cache
*
* @param array $keys list of keys to delete
*
* @return boolean true on success, false on failure
*/
protected abstract function delete(array $keys);
/**
* Remove *all* values from cache
*
* @return boolean true on success, false on failure
*/
protected function purge()
{
}
}
/**
* Smarty Internal Plugin Compile Setfilter
* Compiles code for setfilter tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Setfilter Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Setfilter extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for setfilter tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Internal Plugin Compile Setfilterclose Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Setfilterclose extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for the {/setfilter} tag
* This tag does not generate compiled output. It resets variable filter.
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* This file is part of Smarty.
*
* (c) 2015 Uwe Tews
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* Smarty Internal Plugin Compile Parent Class
*
* @author Uwe Tews <uwe.tews@googlemail.com>
*/
class Smarty_Internal_Compile_Parent extends \Smarty_Internal_Compile_Child
{
/**
* Tag name
*
* @var string
*/
public $tag = 'parent';
/**
* Block type
*
* @var string
*/
public $blockType = 'Parent';
}
/**
* This file is part of Smarty.
*
* (c) 2015 Uwe Tews
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* Smarty Internal Plugin Compile Block Parent Class
*
* @author Uwe Tews <uwe.tews@googlemail.com>
*/
class Smarty_Internal_Compile_Block_Parent extends \Smarty_Internal_Compile_Child
{
/**
* Tag name
*
* @var string
*/
public $tag = 'block_parent';
/**
* Block type
*
* @var string
*/
public $blockType = 'Parent';
}
/**
* Smarty Method RegisterDefaultPluginHandler
*
* Smarty::registerDefaultPluginHandler() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_RegisterDefaultPluginHandler
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Registers a default plugin handler
*
* @api Smarty::registerDefaultPluginHandler()
* @link http://www.smarty.net/docs/en/api.register.default.plugin.handler.tpl
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param callable $callback class/method name
*
* @return \Smarty|\Smarty_Internal_Template
* @throws SmartyException if $callback is not callable
*/
public function registerDefaultPluginHandler(\Smarty_Internal_TemplateBase $obj, $callback)
{
}
}
/**
* Smarty cache resource file clear method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
/**
* Smarty Internal Runtime Cache Resource File Class
*
* @package Smarty
* @subpackage PluginsInternal
*/
class Smarty_Internal_Runtime_CacheResourceFile
{
/**
* Empty cache for a specific template
*
* @param Smarty $smarty
* @param string $resource_name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param integer $exp_time expiration time (number of seconds, not timestamp)
*
* @return integer number of cache files deleted
*/
public function clear(\Smarty $smarty, $resource_name, $cache_id, $compile_id, $exp_time)
{
}
}
/**
* Smarty Internal Plugin Compile Modifier
* Compiles code for modifier execution
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Modifier Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_Modifier extends \Smarty_Internal_CompileBase
{
/**
* Compiles code for modifier execution
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
* @param array $parameter array with compilation parameter
*
* @return string compiled code
* @throws \SmartyCompilerException
* @throws \SmartyException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler, $parameter)
{
}
}
/**
* Smarty Method GetConfigVars
*
* Smarty::getConfigVars() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_GetConfigVars
{
/**
* Valid for all objects
*
* @var int
*/
public $objMap = 7;
/**
* Returns a single or all config variables
*
* @api Smarty::getConfigVars()
* @link http://www.smarty.net/docs/en/api.get.config.vars.tpl
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param string $varname variable name or null
* @param bool $search_parents include parent templates?
*
* @return mixed variable value or or array of variables
*/
public function getConfigVars(\Smarty_Internal_Data $data, $varname = \null, $search_parents = \true)
{
}
}
/**
* Smarty Config Source Plugin
*
* @package Smarty
* @subpackage TemplateResources
* @author Uwe Tews
*/
/**
* Smarty Config Resource Data Object
* Meta Data Container for Template Files
*
* @package Smarty
* @subpackage TemplateResources
* @author Uwe Tews
*/
class Smarty_Template_Config extends \Smarty_Template_Source
{
/**
* array of section names, single section or null
*
* @var null|string|array
*/
public $config_sections = \null;
/**
* scope into which the config variables shall be loaded
*
* @var int
*/
public $scope = 0;
/**
* Flag that source is a config file
*
* @var bool
*/
public $isConfig = \true;
/**
* Name of the Class to compile this resource's contents with
*
* @var string
*/
public $compiler_class = 'Smarty_Internal_Config_File_Compiler';
/**
* Name of the Class to tokenize this resource's contents with
*
* @var string
*/
public $template_lexer_class = 'Smarty_Internal_Configfilelexer';
/**
* Name of the Class to parse this resource's contents with
*
* @var string
*/
public $template_parser_class = 'Smarty_Internal_Configfileparser';
/**
* initialize Source Object for given resource
* Either [$_template] or [$smarty, $template_resource] must be specified
*
* @param Smarty_Internal_Template $_template template object
* @param Smarty $smarty smarty object
* @param string $template_resource resource identifier
*
* @return Smarty_Template_Config Source Object
* @throws SmartyException
*/
public static function load(\Smarty_Internal_Template $_template = \null, \Smarty $smarty = \null, $template_resource = \null)
{
}
}
/**
* Smarty Method AssignByRef
*
* Smarty::assignByRef() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_AssignByRef
{
/**
* assigns values to template variables by reference
*
* @param \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty $data
* @param string $tpl_var the template variable name
* @param $value
* @param boolean $nocache if true any output of this variable will
* be not cached
*
* @return \Smarty_Internal_Data|\Smarty_Internal_Template|\Smarty
*/
public function assignByRef(\Smarty_Internal_Data $data, $tpl_var, &$value, $nocache)
{
}
}
/**
* Smarty Internal Plugin Compile Object Block Function
* Compiles code for registered objects as block function
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Object Block Function Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Private_Object_Block_Function extends \Smarty_Internal_Compile_Private_Block_Plugin
{
/**
* Setup callback and parameter array
*
* @param \Smarty_Internal_TemplateCompilerBase $compiler
* @param array $_attr attributes
* @param string $tag
* @param string $method
*
* @return array
*/
public function setup(\Smarty_Internal_TemplateCompilerBase $compiler, $_attr, $tag, $method)
{
}
}
/**
* Smarty Plugin Data
* This file contains the data object
*
* @package Smarty
* @subpackage Template
* @author Uwe Tews
*/
/**
* class for the Smarty data object
* The Smarty data object will hold Smarty variables in the current scope
*
* @package Smarty
* @subpackage Template
*/
class Smarty_Data extends \Smarty_Internal_Data
{
/**
* Counter
*
* @var int
*/
public static $count = 0;
/**
* Data block name
*
* @var string
*/
public $dataObjectName = '';
/**
* Smarty object
*
* @var Smarty
*/
public $smarty = \null;
/**
* create Smarty data object
*
* @param Smarty|array $_parent parent template
* @param Smarty|Smarty_Internal_Template $smarty global smarty instance
* @param string $name optional data block name
*
* @throws SmartyException
*/
public function __construct($_parent = \null, $smarty = \null, $name = \null)
{
}
}
/**
* Smarty Internal Plugin Compile Config Load
* Compiles the {config load} tag
*
* @package Smarty
* @subpackage Compiler
* @author Uwe Tews
*/
/**
* Smarty Internal Plugin Compile Config Load Class
*
* @package Smarty
* @subpackage Compiler
*/
class Smarty_Internal_Compile_Config_Load extends \Smarty_Internal_CompileBase
{
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $required_attributes = array('file');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $shorttag_order = array('file', 'section');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $optional_attributes = array('section', 'scope');
/**
* Attribute definition: Overwrites base class.
*
* @var array
* @see Smarty_Internal_CompileBase
*/
public $option_flags = array('nocache', 'noscope');
/**
* Valid scope names
*
* @var array
*/
public $valid_scopes = array('local' => \Smarty::SCOPE_LOCAL, 'parent' => \Smarty::SCOPE_PARENT, 'root' => \Smarty::SCOPE_ROOT, 'tpl_root' => \Smarty::SCOPE_TPL_ROOT, 'smarty' => \Smarty::SCOPE_SMARTY, 'global' => \Smarty::SCOPE_SMARTY);
/**
* Compiles code for the {config_load} tag
*
* @param array $args array with attributes from parser
* @param \Smarty_Internal_TemplateCompilerBase $compiler compiler object
*
* @return string compiled code
* @throws \SmartyCompilerException
*/
public function compile($args, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
}
/**
* Smarty Method SetDebugTemplate
*
* Smarty::setDebugTemplate() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_SetDebugTemplate
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* set the debug template
*
* @api Smarty::setDebugTemplate()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param string $tpl_name
*
* @return \Smarty|\Smarty_Internal_Template
* @throws SmartyException if file is not readable
*/
public function setDebugTemplate(\Smarty_Internal_TemplateBase $obj, $tpl_name)
{
}
}
/**
* Smarty Method RegisterDefaultConfigHandler
*
* Smarty::registerDefaultConfigHandler() method
*
* @package Smarty
* @subpackage PluginsInternal
* @author Uwe Tews
*/
class Smarty_Internal_Method_RegisterDefaultConfigHandler
{
/**
* Valid for Smarty and template object
*
* @var int
*/
public $objMap = 3;
/**
* Register config default handler
*
* @api Smarty::registerDefaultConfigHandler()
*
* @param \Smarty_Internal_TemplateBase|\Smarty_Internal_Template|\Smarty $obj
* @param callable $callback class/method name
*
* @return \Smarty|\Smarty_Internal_Template
* @throws SmartyException if $callback is not callable
*/
public function registerDefaultConfigHandler(\Smarty_Internal_TemplateBase $obj, $callback)
{
}
}
/**
* Smarty Autoloader
*
* @package Smarty
*/
/**
* Smarty Autoloader
*
* @package Smarty
* @author Uwe Tews
* Usage:
* require_once '...path/Autoloader.php';
* Smarty_Autoloader::register();
* or
* include '...path/bootstrap.php';
*
* $smarty = new Smarty();
*/
class Smarty_Autoloader
{
/**
* Filepath to Smarty root
*
* @var string
*/
public static $SMARTY_DIR = \null;
/**
* Filepath to Smarty internal plugins
*
* @var string
*/
public static $SMARTY_SYSPLUGINS_DIR = \null;
/**
* Array with Smarty core classes and their filename
*
* @var array
*/
public static $rootClasses = array('smarty' => 'Smarty.class.php', 'smartybc' => 'SmartyBC.class.php');
/**
* Registers Smarty_Autoloader backward compatible to older installations.
*
* @param bool $prepend Whether to prepend the autoloader or not.
*/
public static function registerBC($prepend = \false)
{
}
/**
* Registers Smarty_Autoloader as an SPL autoloader.
*
* @param bool $prepend Whether to prepend the autoloader or not.
*/
public static function register($prepend = \false)
{
}
/**
* Handles auto loading of classes.
*
* @param string $class A class name.
*/
public static function autoload($class)
{
}
}
/**
* MySQL CacheResource
* CacheResource Implementation based on the Custom API to use
* MySQL as the storage resource for Smarty's output caching.
* Table definition:
* <pre>CREATE TABLE IF NOT EXISTS `output_cache` (
* `id` CHAR(40) NOT NULL COMMENT 'sha1 hash',
* `name` VARCHAR(250) NOT NULL,
* `cache_id` VARCHAR(250) NULL DEFAULT NULL,
* `compile_id` VARCHAR(250) NULL DEFAULT NULL,
* `modified` TIMESTAMP NOT NULL DEFAULT CURRENT_TIMESTAMP,
* `content` LONGTEXT NOT NULL,
* PRIMARY KEY (`id`),
* INDEX(`name`),
* INDEX(`cache_id`),
* INDEX(`compile_id`),
* INDEX(`modified`)
* ) ENGINE = InnoDB;</pre>
*
* @package CacheResource-examples
* @author Rodney Rehm
*/
class Smarty_CacheResource_Mysql extends \Smarty_CacheResource_Custom
{
/**
* @var \PDO
*/
protected $db;
/**
* @var \PDOStatement
*/
protected $fetch;
/**
* @var \PDOStatement
*/
protected $fetchTimestamp;
/**
* @var \PDOStatement
*/
protected $save;
/**
* Smarty_CacheResource_Mysql constructor.
*
* @throws \SmartyException
*/
public function __construct()
{
}
/**
* fetch cached content and its modification time from data source
*
* @param string $id unique cache content identifier
* @param string $name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param string $content cached content
* @param integer $mtime cache modification timestamp (epoch)
*
* @return void
*/
protected function fetch($id, $name, $cache_id, $compile_id, &$content, &$mtime)
{
}
/**
* Fetch cached content's modification timestamp from data source
*
* @note implementing this method is optional. Only implement it if modification times can be accessed faster than
* loading the complete cached content.
*
* @param string $id unique cache content identifier
* @param string $name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
*
* @return integer|boolean timestamp (epoch) the template was modified, or false if not found
*/
protected function fetchTimestamp($id, $name, $cache_id, $compile_id)
{
}
/**
* Save content to cache
*
* @param string $id unique cache content identifier
* @param string $name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param integer|null $exp_time seconds till expiration time in seconds or null
* @param string $content content to cache
*
* @return boolean success
*/
protected function save($id, $name, $cache_id, $compile_id, $exp_time, $content)
{
}
/**
* Delete content from cache
*
* @param string $name template name
* @param string $cache_id cache id
* @param string $compile_id compile id
* @param integer|null $exp_time seconds till expiration or null
*
* @return integer number of deleted caches
*/
protected function delete($name, $cache_id, $compile_id, $exp_time)
{
}
}
/**
* PDO Cache Handler
* Allows you to store Smarty Cache files into your db.
* Example table :
* CREATE TABLE `smarty_cache` (
* `id` char(40) NOT NULL COMMENT 'sha1 hash',
* `name` varchar(250) NOT NULL,
* `cache_id` varchar(250) DEFAULT NULL,
* `compile_id` varchar(250) DEFAULT NULL,
* `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP,
* `expire` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00',
* `content` mediumblob NOT NULL,
* PRIMARY KEY (`id`),
* KEY `name` (`name`),
* KEY `cache_id` (`cache_id`),
* KEY `compile_id` (`compile_id`),
* KEY `modified` (`modified`),
* KEY `expire` (`expire`)
* ) ENGINE=InnoDB
* Example usage :
* $cnx = new PDO("mysql:host=localhost;dbname=mydb", "username", "password");
* $smarty->setCachingType('pdo');
* $smarty->loadPlugin('Smarty_CacheResource_Pdo');
* $smarty->registerCacheResource('pdo', new Smarty_CacheResource_Pdo($cnx, 'smarty_cache'));
*
* @author Beno!t POLASZEK - 2014
*/
class Smarty_CacheResource_Pdo extends \Smarty_CacheResource_Custom
{
/**
* @var string[]
*/
protected $fetchStatements = array('default' => 'SELECT %2$s
FROM %1$s
WHERE 1
AND id = :id
AND cache_id IS NULL
AND compile_id IS NULL', 'withCacheId' => 'SELECT %2$s
FROM %1$s
WHERE 1
AND id = :id
AND cache_id = :cache_id
AND compile_id IS NULL', 'withCompileId' => 'SELECT %2$s
FROM %1$s
WHERE 1
AND id = :id
AND compile_id = :compile_id
AND cache_id IS NULL', 'withCacheIdAndCompileId' => 'SELECT %2$s
FROM %1$s
WHERE 1
AND id = :id
AND cache_id = :cache_id
AND compile_id = :compile_id');
/**
* @var string
*/
protected $insertStatement = 'INSERT INTO %s
SET id = :id,
name = :name,
cache_id = :cache_id,
compile_id = :compile_id,
modified = CURRENT_TIMESTAMP,
expire = DATE_ADD(CURRENT_TIMESTAMP, INTERVAL :expire SECOND),
content = :content
ON DUPLICATE KEY UPDATE
name = :name,
cache_id = :cache_id,
compile_id = :compile_id,
modified = CURRENT_TIMESTAMP,
expire = DATE_ADD(CURRENT_TIMESTAMP, INTERVAL :expire SECOND),
content = :content';
/**
* @var string
*/
protected $deleteStatement = 'DELETE FROM %1$s WHERE %2$s';
/**
* @var string
*/
protected $truncateStatement = 'TRUNCATE TABLE %s';
/**
* @var string
*/
protected $fetchColumns = 'modified, content';
/**
* @var string
*/
protected $fetchTimestampColumns = 'modified';
/**
* @var \PDO
*/
protected $pdo;
/**
* @var
*/
protected $table;
/**
* @var null
*/
protected $database;
/**
* Constructor
*
* @param PDO $pdo PDO : active connection
* @param string $table : table (or view) name
* @param string $database : optional - if table is located in another db
*
* @throws \SmartyException
*/
public function __construct(\PDO $pdo, $table, $database = \null)
{
}
/**
* Fills the table name into the statements.
*
* @return $this Current Instance
* @access protected
*/
protected function fillStatementsWithTableName()
{
}
/**
* Gets the fetch statement, depending on what you specify
*
* @param string $columns : the column(s) name(s) you want to retrieve from the database
* @param string $id unique cache content identifier
* @param string|null $cache_id cache id
* @param string|null $compile_id compile id
*
* @access protected
* @return \PDOStatement
*/
protected function getFetchStatement($columns, $id, $cache_id = \null, $compile_id = \null)
{
}
/**
* fetch cached content and its modification time from data source
*
* @param string $id unique cache content identifier
* @param string $name template name
* @param string|null $cache_id cache id
* @param string|null $compile_id compile id
* @param string $content cached content
* @param integer $mtime cache modification timestamp (epoch)
*
* @return void
* @access protected
*/
protected function fetch($id, $name, $cache_id = \null, $compile_id = \null, &$content, &$mtime)
{
}
/**
* Fetch cached content's modification timestamp from data source
* {@internal implementing this method is optional.
* Only implement it if modification times can be accessed faster than loading the complete cached content.}}
*
* @param string $id unique cache content identifier
* @param string $name template name
* @param string|null $cache_id cache id
* @param string|null $compile_id compile id
*
* @return integer|boolean timestamp (epoch) the template was modified, or false if not found
* @access protected
*/
// protected function fetchTimestamp($id, $name, $cache_id = null, $compile_id = null) {
// $stmt = $this->getFetchStatement($this->fetchTimestampColumns, $id, $cache_id, $compile_id);
// $stmt -> execute();
// $mtime = strtotime($stmt->fetchColumn());
// $stmt -> closeCursor();
// return $mtime;
// }
/**
* Save content to cache
*
* @param string $id unique cache content identifier
* @param string $name template name
* @param string|null $cache_id cache id
* @param string|null $compile_id compile id
* @param integer|null $exp_time seconds till expiration time in seconds or null
* @param string $content content to cache
*
* @return boolean success
* @access protected
*/
protected function save($id, $name, $cache_id = \null, $compile_id = \null, $exp_time, $content)
{
}
/**
* Encodes the content before saving to database
*
* @param string $content
*
* @return string $content
* @access protected
*/
protected function inputContent($content)
{
}
/**
* Decodes the content before saving to database
*
* @param string $content
*
* @return string $content
* @access protected
*/
protected function outputContent($content)
{
}
/**
* Delete content from cache
*
* @param string|null $name template name
* @param string|null $cache_id cache id
* @param string|null $compile_id compile id
* @param integer|null|-1 $exp_time seconds till expiration or null
*
* @return integer number of deleted caches
* @access protected
*/
protected function delete($name = \null, $cache_id = \null, $compile_id = \null, $exp_time = \null)
{
}
/**
* Gets the formatted table name
*
* @return string
* @access protected
*/
protected function getTableName()
{
}
}
/**
* Memcache CacheResource
* CacheResource Implementation based on the KeyValueStore API to use
* memcache as the storage resource for Smarty's output caching.
* Note that memcache has a limitation of 256 characters per cache-key.
* To avoid complications all cache-keys are translated to a sha1 hash.
*
* @package CacheResource-examples
* @author Rodney Rehm
*/
class Smarty_CacheResource_Memcache extends \Smarty_CacheResource_KeyValueStore
{
/**
* memcache instance
*
* @var Memcache
*/
protected $memcache = \null;
/**
* Smarty_CacheResource_Memcache constructor.
*/
public function __construct()
{
}
/**
* Read values for a set of keys from cache
*
* @param array $keys list of keys to fetch
*
* @return array list of values with the given keys used as indexes
* @return boolean true on success, false on failure
*/
protected function read(array $keys)
{
}
/**
* Save values for a set of keys to cache
*
* @param array $keys list of values to save
* @param int $expire expiration time
*
* @return boolean true on success, false on failure
*/
protected function write(array $keys, $expire = \null)
{
}
/**
* Remove values from cache
*
* @param array $keys list of keys to delete
*
* @return boolean true on success, false on failure
*/
protected function delete(array $keys)
{
}
/**
* Remove *all* values from cache
*
* @return boolean true on success, false on failure
*/
protected function purge()
{
}
}
/**
* PDO Cache Handler with GZIP support
* Example usage :
* $cnx = new PDO("mysql:host=localhost;dbname=mydb", "username", "password");
* $smarty->setCachingType('pdo_gzip');
* $smarty->loadPlugin('Smarty_CacheResource_Pdo_Gzip');
* $smarty->registerCacheResource('pdo_gzip', new Smarty_CacheResource_Pdo_Gzip($cnx, 'smarty_cache'));
*
* @require Smarty_CacheResource_Pdo class
* @author Beno!t POLASZEK - 2014
*/
class Smarty_CacheResource_Pdo_Gzip extends \Smarty_CacheResource_Pdo
{
/**
* Encodes the content before saving to database
*
* @param string $content
*
* @return string $content
* @access protected
*/
protected function inputContent($content)
{
}
/**
* Decodes the content before saving to database
*
* @param string $content
*
* @return string $content
* @access protected
*/
protected function outputContent($content)
{
}
}
/**
* Extends All Resource
* Resource Implementation modifying the extends-Resource to walk
* through the template_dirs and inherit all templates of the same name
*
* @package Resource-examples
* @author Rodney Rehm
*/
class Smarty_Resource_Extendsall extends \Smarty_Internal_Resource_Extends
{
/**
* populate Source Object with meta data from Resource
*
* @param Smarty_Template_Source $source source object
* @param Smarty_Internal_Template $_template template object
*
* @return void
*/
public function populate(\Smarty_Template_Source $source, \Smarty_Internal_Template $_template = \null)
{
}
/**
* Disable timestamp checks for extendsall resource.
* The individual source components will be checked.
*
* @return bool false
*/
public function checkTimestamps()
{
}
}
/**
* MySQL Resource
* Resource Implementation based on the Custom API to use
* MySQL as the storage resource for Smarty's templates and configs.
* Table definition:
* <pre>CREATE TABLE IF NOT EXISTS `templates` (
* `name` varchar(100) NOT NULL,
* `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
* `source` text,
* PRIMARY KEY (`name`)
* ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</pre>
* Demo data:
* <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', "2010-12-25 22:00:00", '{$x="hello
* world"}{$x}');</pre>
*
*
* @package Resource-examples
* @author Rodney Rehm
*/
class Smarty_Resource_Mysql extends \Smarty_Resource_Custom
{
/**
* PDO instance
*
* @var \PDO
*/
protected $db;
/**
* prepared fetch() statement
*
* @var \PDOStatement
*/
protected $fetch;
/**
* prepared fetchTimestamp() statement
*
* @var \PDOStatement
*/
protected $mtime;
/**
* Smarty_Resource_Mysql constructor.
*
* @throws \SmartyException
*/
public function __construct()
{
}
/**
* Fetch a template and its modification time from database
*
* @param string $name template name
* @param string $source template source
* @param integer $mtime template modification timestamp (epoch)
*
* @return void
*/
protected function fetch($name, &$source, &$mtime)
{
}
/**
* Fetch a template's modification time from database
*
* @note implementing this method is optional. Only implement it if modification times can be accessed faster than
* loading the comple template source.
*
* @param string $name template name
*
* @return integer timestamp (epoch) the template was modified
*/
protected function fetchTimestamp($name)
{
}
}
/**
* APC CacheResource
* CacheResource Implementation based on the KeyValueStore API to use
* memcache as the storage resource for Smarty's output caching.
* *
*
* @package CacheResource-examples
* @author Uwe Tews
*/
class Smarty_CacheResource_Apc extends \Smarty_CacheResource_KeyValueStore
{
/**
* Smarty_CacheResource_Apc constructor.
*
* @throws \Exception
*/
public function __construct()
{
}
/**
* Read values for a set of keys from cache
*
* @param array $keys list of keys to fetch
*
* @return array list of values with the given keys used as indexes
* @return boolean true on success, false on failure
*/
protected function read(array $keys)
{
}
/**
* Save values for a set of keys to cache
*
* @param array $keys list of values to save
* @param int $expire expiration time
*
* @return boolean true on success, false on failure
*/
protected function write(array $keys, $expire = \null)
{
}
/**
* Remove values from cache
*
* @param array $keys list of keys to delete
*
* @return boolean true on success, false on failure
*/
protected function delete(array $keys)
{
}
/**
* Remove *all* values from cache
*
* @return boolean true on success, false on failure
*/
protected function purge()
{
}
}
/**
* MySQL Resource
* Resource Implementation based on the Custom API to use
* MySQL as the storage resource for Smarty's templates and configs.
* Note that this MySQL implementation fetches the source and timestamps in
* a single database query, instead of two separate like resource.mysql.php does.
* Table definition:
* <pre>CREATE TABLE IF NOT EXISTS `templates` (
* `name` varchar(100) NOT NULL,
* `modified` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP,
* `source` text,
* PRIMARY KEY (`name`)
* ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</pre>
* Demo data:
* <pre>INSERT INTO `templates` (`name`, `modified`, `source`) VALUES ('test.tpl', "2010-12-25 22:00:00", '{$x="hello
* world"}{$x}');</pre>
*
*
* @package Resource-examples
* @author Rodney Rehm
*/
class Smarty_Resource_Mysqls extends \Smarty_Resource_Custom
{
/**
* PDO instance
*
* @var \PDO
*/
protected $db;
/**
* prepared fetch() statement
*
* @var \PDOStatement
*/
protected $fetch;
/**
* Smarty_Resource_Mysqls constructor.
*
* @throws \SmartyException
*/
public function __construct()
{
}
/**
* Fetch a template and its modification time from database
*
* @param string $name template name
* @param string $source template source
* @param integer $mtime template modification timestamp (epoch)
*
* @return void
*/
protected function fetch($name, &$source, &$mtime)
{
}
}
/**
* Class COM
*
* This is just a stub class.
*/
class com_exception extends \Exception
{
}
/**
* Class COM
*
* This is just a stub class.
*/
class COM
{
/**
* This is just a dummy function to make IDE autocomplete less insane.
*
* @param int $bytes
* @param int $dummy
* @return string
*/
public function GetRandom($bytes, $dummy)
{
}
}
class Sodium
{
/**
* Generate a string of random bytes
* /dev/urandom
*
* @param int $length
* @return string
*/
public static function randombytes_buf($length)
{
}
/**
* Generate a 16-bit integer
* /dev/urandom
*
* @return int
*/
public static function randombytes_random16()
{
}
/**
* Generate an unbiased random integer between 0 and a specified value
* /dev/urandom
*
* @param int $upperBoundNonInclusive
* @return int
*/
public static function randombytes_uniform($upperBoundNonInclusive = 0)
{
}
}
}
namespace Stripe {
/**
* Class StripeObject
*
* @package Stripe
*/
class StripeObject implements \ArrayAccess, \Countable, \JsonSerializable
{
protected $_opts;
protected $_originalValues;
protected $_values;
protected $_unsavedValues;
protected $_transientValues;
protected $_retrieveOptions;
protected $_lastResponse;
/**
* @return Util\Set Attributes that should not be sent to the API because
* they're not updatable (e.g. ID).
*/
public static function getPermanentAttributes()
{
}
/**
* Additive objects are subobjects in the API that don't have the same
* semantics as most subobjects, which are fully replaced when they're set.
* This is best illustrated by example. The `source` parameter sent when
* updating a subscription is *not* additive; if we set it:
*
* source[object]=card&source[number]=123
*
* We expect the old `source` object to have been overwritten completely. If
* the previous source had an `address_state` key associated with it and we
* didn't send one this time, that value of `address_state` is gone.
*
* By contrast, additive objects are those that will have new data added to
* them while keeping any existing data in place. The only known case of its
* use is for `metadata`, but it could in theory be more general. As an
* example, say we have a `metadata` object that looks like this on the
* server side:
*
* metadata = ["old" => "old_value"]
*
* If we update the object with `metadata[new]=new_value`, the server side
* object now has *both* fields:
*
* metadata = ["old" => "old_value", "new" => "new_value"]
*
* This is okay in itself because usually users will want to treat it as
* additive:
*
* $obj->metadata["new"] = "new_value";
* $obj->save();
*
* However, in other cases, they may want to replace the entire existing
* contents:
*
* $obj->metadata = ["new" => "new_value"];
* $obj->save();
*
* This is where things get a little bit tricky because in order to clear
* any old keys that may have existed, we actually have to send an explicit
* empty string to the server. So the operation above would have to send
* this form to get the intended behavior:
*
* metadata[old]=&metadata[new]=new_value
*
* This method allows us to track which parameters are considered additive,
* and lets us behave correctly where appropriate when serializing
* parameters to be sent.
*
* @return Util\Set Set of additive parameters
*/
public static function getAdditiveParams()
{
}
public function __construct($id = null, $opts = null)
{
}
// Standard accessor magic methods
public function __set($k, $v)
{
}
public function __isset($k)
{
}
public function __unset($k)
{
}
public function &__get($k)
{
}
// Magic method for var_dump output. Only works with PHP >= 5.6
public function __debugInfo()
{
}
// ArrayAccess methods
public function offsetSet($k, $v)
{
}
public function offsetExists($k)
{
}
public function offsetUnset($k)
{
}
public function offsetGet($k)
{
}
// Countable method
public function count()
{
}
public function keys()
{
}
public function values()
{
}
/**
* This unfortunately needs to be public to be used in Util\Util
*
* @param array $values
* @param null|string|array|Util\RequestOptions $opts
*
* @return static The object constructed from the given values.
*/
public static function constructFrom($values, $opts = null)
{
}
/**
* Refreshes this object using the provided values.
*
* @param array $values
* @param null|string|array|Util\RequestOptions $opts
* @param boolean $partial Defaults to false.
*/
public function refreshFrom($values, $opts, $partial = false)
{
}
/**
* Mass assigns attributes on the model.
*
* @param array $values
* @param null|string|array|Util\RequestOptions $opts
* @param boolean $dirty Defaults to true.
*/
public function updateAttributes($values, $opts = null, $dirty = true)
{
}
/**
* @return array A recursive mapping of attributes to values for this object,
* including the proper value for deleted attributes.
*/
public function serializeParameters($force = false)
{
}
public function serializeParamsValue($value, $original, $unsaved, $force, $key = null)
{
}
public function jsonSerialize()
{
}
public function __toJSON()
{
}
public function __toString()
{
}
public function __toArray($recursive = false)
{
}
/**
* Sets all keys within the StripeObject as unsaved so that they will be
* included with an update when `serializeParameters` is called. This
* method is also recursive, so any StripeObjects contained as values or
* which are values in a tenant array are also marked as dirty.
*/
public function dirty()
{
}
protected function dirtyValue($value)
{
}
/**
* Produces a deep copy of the given object including support for arrays
* and StripeObjects.
*/
protected static function deepCopy($obj)
{
}
/**
* Returns a hash of empty values for all the values that are in the given
* StripeObject.
*/
public static function emptyValues($obj)
{
}
/**
* @return object The last response from the Stripe API
*/
public function getLastResponse()
{
}
/**
* Sets the last response from the Stripe API
*
* @param ApiResponse $resp
* @return void
*/
public function setLastResponse($resp)
{
}
/**
* Indicates whether or not the resource has been deleted on the server.
* Note that some, but not all, resources can indicate whether they have
* been deleted.
*
* @return bool Whether the resource is deleted.
*/
public function isDeleted()
{
}
}
}
namespace Stripe\ApiOperations {
/**
* Trait for resources that need to make API requests.
*
* This trait should only be applied to classes that derive from StripeObject.
*/
trait Request
{
/**
* @param array|null|mixed $params The list of parameters to validate
*
* @throws \Stripe\Error\Api if $params exists and is not an array
*/
protected static function _validateParams($params = null)
{
}
/**
* @param string $method HTTP method ('get', 'post', etc.)
* @param string $url URL for the request
* @param array $params list of parameters for the request
* @param array|string|null $options
*
* @return array tuple containing (the JSON response, $options)
*/
protected function _request($method, $url, $params = [], $options = null)
{
}
/**
* @param string $method HTTP method ('get', 'post', etc.)
* @param string $url URL for the request
* @param array $params list of parameters for the request
* @param array|string|null $options
*
* @return array tuple containing (the JSON response, $options)
*/
protected static function _staticRequest($method, $url, $params, $options)
{
}
}
}
namespace Stripe {
/**
* Class ApiResource
*
* @package Stripe
*/
abstract class ApiResource extends \Stripe\StripeObject
{
use \Stripe\ApiOperations\Request;
/**
* @return \Stripe\Util\Set A list of fields that can be their own type of
* API resource (say a nested card under an account for example), and if
* that resource is set, it should be transmitted to the API on a create or
* update. Doing so is not the default behavior because API resources
* should normally be persisted on their own RESTful endpoints.
*/
public static function getSavedNestedResources()
{
}
/**
* @var boolean A flag that can be set a behavior that will cause this
* resource to be encoded and sent up along with an update of its parent
* resource. This is usually not desirable because resources are updated
* individually on their own endpoints, but there are certain cases,
* replacing a customer's source for example, where this is allowed.
*/
public $saveWithParent = false;
public function __set($k, $v)
{
}
/**
* @return ApiResource The refreshed resource.
*/
public function refresh()
{
}
/**
* @return string The base URL for the given class.
*/
public static function baseUrl()
{
}
/**
* @return string The endpoint URL for the given class.
*/
public static function classUrl()
{
}
/**
* @return string The instance endpoint URL for the given class.
*/
public static function resourceUrl($id)
{
}
/**
* @return string The full API URL for this API resource.
*/
public function instanceUrl()
{
}
}
/**
* Class UsageRecord
*
* @package Stripe
*
* @property string $id
* @property string $object
* @property string $invoice
* @property bool $livemode
* @property mixed $period
* @property string $subscription_item
* @property int $total_usage
*/
class UsageRecordSummary extends \Stripe\ApiResource
{
const OBJECT_NAME = "usage_record_summary";
}
}
namespace Stripe\ApiOperations {
/**
* Trait for creatable resources. Adds a `create()` static method to the class.
*
* This trait should only be applied to classes that derive from StripeObject.
*/
trait Create
{
/**
* @param array|null $params
* @param array|string|null $options
*
* @return static The created resource.
*/
public static function create($params = null, $options = null)
{
}
}
/**
* Trait for retrievable resources. Adds a `retrieve()` static method to the
* class.
*
* This trait should only be applied to classes that derive from StripeObject.
*/
trait Retrieve
{
/**
* @param array|string $id The ID of the API resource to retrieve,
* or an options array containing an `id` key.
* @param array|string|null $opts
*
* @return static
*/
public static function retrieve($id, $opts = null)
{
}
}
/**
* Trait for updatable resources. Adds an `update()` static method and a
* `save()` method to the class.
*
* This trait should only be applied to classes that derive from StripeObject.
*/
trait Update
{
/**
* @param string $id The ID of the resource to update.
* @param array|null $params
* @param array|string|null $opts
*
* @return static The updated resource.
*/
public static function update($id, $params = null, $opts = null)
{
}
/**
* @param array|string|null $opts
*
* @return static The saved resource.
*/
public function save($opts = null)
{
}
}
}
namespace Stripe {
/**
* Class Source
*
* @property string $id
* @property string $object
* @property mixed $ach_credit_transfer
* @property mixed $ach_debit
* @property mixed $alipay
* @property int $amount
* @property mixed $bancontact
* @property mixed $card
* @property mixed $card_present
* @property string $client_secret
* @property mixed $code_verification
* @property int $created
* @property string $currency
* @property string $customer
* @property mixed $eps
* @property string $flow
* @property mixed $giropay
* @property mixed $ideal
* @property bool $livemode
* @property StripeObject $metadata
* @property mixed $multibanco
* @property mixed $owner
* @property mixed $p24
* @property mixed $receiver
* @property mixed $redirect
* @property mixed $sepa_debit
* @property mixed $sofort
* @property string $statement_descriptor
* @property string $status
* @property mixed $three_d_secure
* @property string $type
* @property string $usage
* @property mixed $wechat
* @package Stripe
*/
class Source extends \Stripe\ApiResource
{
const OBJECT_NAME = "source";
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of source flows.
* @link https://stripe.com/docs/api#source_object-flow
*/
const FLOW_REDIRECT = 'redirect';
const FLOW_RECEIVER = 'receiver';
const FLOW_CODE_VERIFICATION = 'code_verification';
const FLOW_NONE = 'none';
/**
* Possible string representations of source statuses.
* @link https://stripe.com/docs/api#source_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_CHARGEABLE = 'chargeable';
const STATUS_CONSUMED = 'consumed';
const STATUS_FAILED = 'failed';
const STATUS_PENDING = 'pending';
/**
* Possible string representations of source usage.
* @link https://stripe.com/docs/api#source_object-usage
*/
const USAGE_REUSABLE = 'reusable';
const USAGE_SINGLE_USE = 'single_use';
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Source The detached source.
*/
public function detach($params = null, $options = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Source The detached source.
*
* @deprecated Use the `detach` method instead.
*/
public function delete($params = null, $options = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Collection The list of source transactions.
*/
public function sourceTransactions($params = null, $options = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Source The verified source.
*/
public function verify($params = null, $options = null)
{
}
}
/**
* Class InvoiceLineItem
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $currency
* @property string $description
* @property bool $discountable
* @property string $invoice_item
* @property bool $livemode
* @property StripeObject $metadata
* @property mixed $period
* @property Plan $plan
* @property bool $proration
* @property int $quantity
* @property string $subscription
* @property string $subscription_item
* @property array $tax_amounts
* @property array $tax_rates
* @property string $type
*
* @package Stripe
*/
class InvoiceLineItem extends \Stripe\ApiResource
{
const OBJECT_NAME = "line_item";
}
/**
* Class UsageRecord
*
* @package Stripe
*
* @property string $id
* @property string $object
* @property bool $livemode
* @property int $quantity
* @property string $subscription_item
* @property int $timestamp
*/
class UsageRecord extends \Stripe\ApiResource
{
const OBJECT_NAME = "usage_record";
/**
* @param array|null $params
* @param array|string|null $options
*
* @return \Stripe\ApiResource The created resource.
*/
public static function create($params = null, $options = null)
{
}
}
/**
* Class CustomerBalanceTransaction
*
* @package Stripe
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $credit_note
* @property int $created
* @property string $currency
* @property string $customer
* @property string $description
* @property int $ending_balance
* @property string $invoice
* @property bool $livemode
* @property StripeObject $metadata
* @property string $type
*/
class CustomerBalanceTransaction extends \Stripe\ApiResource
{
const OBJECT_NAME = "customer_balance_transaction";
/**
* Possible string representations of a balance transaction's type.
* @link https://stripe.com/docs/api/customers/customer_balance_transaction_object#customer_balance_transaction_object-type
*/
const TYPE_ADJUSTEMENT = 'adjustment';
const TYPE_APPLIED_TO_INVOICE = 'applied_to_invoice';
const TYPE_CREDIT_NOTE = 'credit_note';
const TYPE_INITIAL = 'initial';
const TYPE_INVOICE_TOO_LARGE = 'invoice_too_large';
const TYPE_INVOICE_TOO_SMALL = 'invoice_too_small';
const TYPE_UNSPENT_RECEIVER_CREDIT = 'unspent_receiver_credit';
/**
* @return string The API URL for this balance transaction.
*/
public function instanceUrl()
{
}
/**
* @param array|string $_id
* @param array|string|null $_opts
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function retrieve($_id, $_opts = null)
{
}
/**
* @param string $_id
* @param array|null $_params
* @param array|string|null $_options
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function update($_id, $_params = null, $_options = null)
{
}
}
}
namespace Stripe\ApiOperations {
/**
* Trait for listable resources. Adds a `all()` static method to the class.
*
* This trait should only be applied to classes that derive from StripeObject.
*/
trait All
{
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return \Stripe\Collection of ApiResources
*/
public static function all($params = null, $opts = null)
{
}
}
}
namespace Stripe {
/**
* Class TaxRate
*
* @property string $id
* @property string $object
* @property bool $active
* @property int $created
* @property string $description
* @property string $display_name
* @property bool $inclusive
* @property string $jurisdiction
* @property bool $livemode
* @property StripeObject $metadata
* @property float $percentage
*
* @package Stripe
*/
class TaxRate extends \Stripe\ApiResource
{
const OBJECT_NAME = "tax_rate";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
}
namespace Stripe\ApiOperations {
/**
* Trait for resources that have nested resources.
*
* This trait should only be applied to classes that derive from StripeObject.
*/
trait NestedResource
{
/**
* @param string $method
* @param string $url
* @param array|null $params
* @param array|string|null $options
*
* @return \Stripe\StripeObject
*/
protected static function _nestedResourceOperation($method, $url, $params = null, $options = null)
{
}
/**
* @param string $id
* @param string $nestedPath
* @param string|null $nestedId
*
* @return string
*/
protected static function _nestedResourceUrl($id, $nestedPath, $nestedId = null)
{
}
/**
* @param string $id
* @param string $nestedPath
* @param array|null $params
* @param array|string|null $options
*
* @return \Stripe\StripeObject
*/
protected static function _createNestedResource($id, $nestedPath, $params = null, $options = null)
{
}
/**
* @param string $id
* @param string $nestedPath
* @param string|null $nestedId
* @param array|null $params
* @param array|string|null $options
*
* @return \Stripe\StripeObject
*/
protected static function _retrieveNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
{
}
/**
* @param string $id
* @param string $nestedPath
* @param string|null $nestedId
* @param array|null $params
* @param array|string|null $options
*
* @return \Stripe\StripeObject
*/
protected static function _updateNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
{
}
/**
* @param string $id
* @param string $nestedPath
* @param string|null $nestedId
* @param array|null $params
* @param array|string|null $options
*
* @return \Stripe\StripeObject
*/
protected static function _deleteNestedResource($id, $nestedPath, $nestedId, $params = null, $options = null)
{
}
/**
* @param string $id
* @param string $nestedPath
* @param array|null $params
* @param array|string|null $options
*
* @return \Stripe\StripeObject
*/
protected static function _allNestedResources($id, $nestedPath, $params = null, $options = null)
{
}
}
}
namespace Stripe {
/**
* Class Transfer
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $amount_reversed
* @property string $balance_transaction
* @property int $created
* @property string $currency
* @property string $description
* @property string $destination
* @property string $destination_payment
* @property bool $livemode
* @property StripeObject $metadata
* @property Collection $reversals
* @property bool $reversed
* @property string $source_transaction
* @property string $source_type
* @property string $transfer_group
*
* @package Stripe
*/
class Transfer extends \Stripe\ApiResource
{
const OBJECT_NAME = "transfer";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\NestedResource;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
const PATH_REVERSALS = '/reversals';
/**
* Possible string representations of the source type of the transfer.
* @link https://stripe.com/docs/api/transfers/object#transfer_object-source_type
*/
const SOURCE_TYPE_ALIPAY_ACCOUNT = 'alipay_account';
const SOURCE_TYPE_BANK_ACCOUNT = 'bank_account';
const SOURCE_TYPE_CARD = 'card';
const SOURCE_TYPE_FINANCING = 'financing';
/**
* @return TransferReversal The created transfer reversal.
*/
public function reverse($params = null, $opts = null)
{
}
/**
* @return Transfer The canceled transfer.
*/
public function cancel()
{
}
/**
* @param string|null $id The ID of the transfer on which to create the reversal.
* @param array|null $params
* @param array|string|null $opts
*
* @return TransferReversal
*/
public static function createReversal($id, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the transfer to which the reversal belongs.
* @param array|null $reversalId The ID of the reversal to retrieve.
* @param array|null $params
* @param array|string|null $opts
*
* @return TransferReversal
*/
public static function retrieveReversal($id, $reversalId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the transfer to which the reversal belongs.
* @param array|null $reversalId The ID of the reversal to update.
* @param array|null $params
* @param array|string|null $opts
*
* @return TransferReversal
*/
public static function updateReversal($id, $reversalId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the transfer on which to retrieve the reversals.
* @param array|null $params
* @param array|string|null $opts
*
* @return Collection The list of reversals.
*/
public static function allReversals($id, $params = null, $opts = null)
{
}
}
/**
* Class ApiRequestor
*
* @package Stripe
*/
class ApiRequestor
{
/**
* ApiRequestor constructor.
*
* @param string|null $apiKey
* @param string|null $apiBase
*/
public function __construct($apiKey = null, $apiBase = null)
{
}
/**
* @param string $method
* @param string $url
* @param array|null $params
* @param array|null $headers
*
* @return array An array whose first element is an API response and second
* element is the API key used to make the request.
* @throws Error\Api
* @throws Error\Authentication
* @throws Error\Card
* @throws Error\InvalidRequest
* @throws Error\OAuth\InvalidClient
* @throws Error\OAuth\InvalidGrant
* @throws Error\OAuth\InvalidRequest
* @throws Error\OAuth\InvalidScope
* @throws Error\OAuth\UnsupportedGrantType
* @throws Error\OAuth\UnsupportedResponseType
* @throws Error\Permission
* @throws Error\RateLimit
* @throws Error\Idempotency
* @throws Error\ApiConnection
*/
public function request($method, $url, $params = null, $headers = null)
{
}
/**
* @param string $rbody A JSON string.
* @param int $rcode
* @param array $rheaders
* @param array $resp
*
* @throws Error\InvalidRequest if the error is caused by the user.
* @throws Error\Authentication if the error is caused by a lack of
* permissions.
* @throws Error\Permission if the error is caused by insufficient
* permissions.
* @throws Error\Card if the error is the error code is 402 (payment
* required)
* @throws Error\InvalidRequest if the error is caused by the user.
* @throws Error\Idempotency if the error is caused by an idempotency key.
* @throws Error\OAuth\InvalidClient
* @throws Error\OAuth\InvalidGrant
* @throws Error\OAuth\InvalidRequest
* @throws Error\OAuth\InvalidScope
* @throws Error\OAuth\UnsupportedGrantType
* @throws Error\OAuth\UnsupportedResponseType
* @throws Error\Permission if the error is caused by insufficient
* permissions.
* @throws Error\RateLimit if the error is caused by too many requests
* hitting the API.
* @throws Error\Api otherwise.
*/
public function handleErrorResponse($rbody, $rcode, $rheaders, $resp)
{
}
/**
* @static
*
* @param HttpClient\ClientInterface $client
*/
public static function setHttpClient($client)
{
}
/**
* @static
*
* Resets any stateful telemetry data
*/
public static function resetTelemetry()
{
}
}
/**
* Class FileLink
*
* @property string $id
* @property string $object
* @property int $created
* @property bool $expired
* @property int $expires_at
* @property string $file
* @property bool $livemode
* @property StripeObject $metadata
* @property string $url
*
* @package Stripe
*/
class FileLink extends \Stripe\ApiResource
{
const OBJECT_NAME = "file_link";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
}
namespace Stripe\ApiOperations {
/**
* Trait for deletable resources. Adds a `delete()` method to the class.
*
* This trait should only be applied to classes that derive from StripeObject.
*/
trait Delete
{
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return static The deleted resource.
*/
public function delete($params = null, $opts = null)
{
}
}
}
namespace Stripe {
/**
* Class ApplePayDomain
*
* @package Stripe
*/
class ApplePayDomain extends \Stripe\ApiResource
{
const OBJECT_NAME = "apple_pay_domain";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
/**
* @return string The class URL for this resource. It needs to be special
* cased because it doesn't fit into the standard resource pattern.
*/
public static function classUrl()
{
}
}
/**
* Class SetupIntent
*
* @property string $id
* @property string $object
* @property string $application
* @property string $client_secret
* @property int $created
* @property string $customer
* @property string $description
* @property mixed $last_setup_error
* @property bool $livemode
* @property StripeObject $metadata
* @property mixed $next_action
* @property string $on_behalf_of
* @property string $payment_method
* @property string[] $payment_method_types
* @property string $status
*
* @package Stripe
*/
class SetupIntent extends \Stripe\ApiResource
{
const OBJECT_NAME = "setup_intent";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* These constants are possible representations of the status field.
*
* @link https://stripe.com/docs/api/setup_intents/object#setup_intent_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_PROCESSING = 'processing';
const STATUS_REQUIRES_ACTION = 'requires_action';
const STATUS_REQUIRES_CONFIRMATION = 'requires_confirmation';
const STATUS_REQUIRES_PAYMENT_METHOD = 'requires_payment_method';
const STATUS_SUCCEEDED = 'succeeded';
/**
* @param array|null $params
* @param array|string|null $options
*
* @return SetupIntent The canceled setup intent.
*/
public function cancel($params = null, $options = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return SetupIntent The confirmed setup intent.
*/
public function confirm($params = null, $options = null)
{
}
}
/**
* Class CountrySpec
*
* @property string $id
* @property string $object
* @property string $default_currency
* @property mixed $supported_bank_account_currencies
* @property string[] $supported_payment_currencies
* @property string[] $supported_payment_methods
* @property string[] $supported_transfer_countries
* @property mixed $verification_fields
*
* @package Stripe
*/
class CountrySpec extends \Stripe\ApiResource
{
const OBJECT_NAME = "country_spec";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
}
class ThreeDSecure extends \Stripe\ApiResource
{
const OBJECT_NAME = "three_d_secure";
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
/**
* @return string The endpoint URL for the given class.
*/
public static function classUrl()
{
}
}
abstract class Webhook
{
const DEFAULT_TOLERANCE = 300;
/**
* Returns an Event instance using the provided JSON payload. Throws a
* \UnexpectedValueException if the payload is not valid JSON, and a
* \Stripe\SignatureVerificationException if the signature verification
* fails for any reason.
*
* @param string $payload the payload sent by Stripe.
* @param string $sigHeader the contents of the signature header sent by
* Stripe.
* @param string $secret secret used to generate the signature.
* @param int $tolerance maximum difference allowed between the header's
* timestamp and the current time
* @return \Stripe\Event the Event instance
* @throws \UnexpectedValueException if the payload is not valid JSON,
* @throws \Stripe\Error\SignatureVerification if the verification fails.
*/
public static function constructEvent($payload, $sigHeader, $secret, $tolerance = self::DEFAULT_TOLERANCE)
{
}
}
abstract class OAuth
{
/**
* Generates a URL to Stripe's OAuth form.
*
* @param array|null $params
* @param array|null $opts
*
* @return string The URL to Stripe's OAuth form.
*/
public static function authorizeUrl($params = null, $opts = null)
{
}
/**
* Use an authoriztion code to connect an account to your platform and
* fetch the user's credentials.
*
* @param array|null $params
* @param array|null $opts
*
* @return StripeObject Object containing the response from the API.
*/
public static function token($params = null, $opts = null)
{
}
/**
* Disconnects an account from your platform.
*
* @param array|null $params
* @param array|null $opts
*
* @return StripeObject Object containing the response from the API.
*/
public static function deauthorize($params = null, $opts = null)
{
}
}
/**
* Class BankAccount
*
* @property string $id
* @property string $object
* @property string $account
* @property string $account_holder_name
* @property string $account_holder_type
* @property string $bank_name
* @property string $country
* @property string $currency
* @property string $customer
* @property bool $default_for_currency
* @property string $fingerprint
* @property string $last4
* @property StripeObject $metadata
* @property string $routing_number
* @property string $status
*
* @package Stripe
*/
class BankAccount extends \Stripe\ApiResource
{
const OBJECT_NAME = "bank_account";
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of the bank verification status.
* @link https://stripe.com/docs/api/external_account_bank_accounts/object#account_bank_account_object-status
*/
const STATUS_NEW = 'new';
const STATUS_VALIDATED = 'validated';
const STATUS_VERIFIED = 'verified';
const STATUS_VERIFICATION_FAILED = 'verification_failed';
const STATUS_ERRORED = 'errored';
/**
* @return string The instance URL for this resource. It needs to be special
* cased because it doesn't fit into the standard resource pattern.
*/
public function instanceUrl()
{
}
/**
* @param array|string $_id
* @param array|string|null $_opts
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function retrieve($_id, $_opts = null)
{
}
/**
* @param string $_id
* @param array|null $_params
* @param array|string|null $_options
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function update($_id, $_params = null, $_options = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return BankAccount The verified bank account.
*/
public function verify($params = null, $options = null)
{
}
}
/**
* Class Invoice
*
* @property string $id
* @property string $object
* @property string $account_country
* @property string $account_name
* @property int $amount_due
* @property int $amount_paid
* @property int $amount_remaining
* @property int $application_fee_amount
* @property int $attempt_count
* @property bool $attempted
* @property bool $auto_advance
* @property string $billing
* @property string $billing_reason
* @property string $charge
* @property string $collection_method
* @property int $created
* @property string $currency
* @property array $custom_fields
* @property string $customer
* @property mixed $customer_address
* @property string $customer_email
* @property string $customer_name
* @property string $customer_phone
* @property mixed $customer_shipping
* @property string $customer_tax_exempt
* @property array $customer_tax_ids
* @property string $default_payment_method
* @property string $default_source
* @property array $default_tax_rates
* @property string $description
* @property Discount $discount
* @property int $due_date
* @property int $ending_balance
* @property string $footer
* @property string $hosted_invoice_url
* @property string $invoice_pdf
* @property Collection $lines
* @property bool $livemode
* @property StripeObject $metadata
* @property int $next_payment_attempt
* @property string $number
* @property bool $paid
* @property string $payment_intent
* @property int $period_end
* @property int $period_start
* @property int $post_payment_credit_notes_amount
* @property int $pre_payment_credit_notes_amount
* @property string $receipt_number
* @property int $starting_balance
* @property string $statement_descriptor
* @property string $status
* @property mixed $status_transitions
* @property string $subscription
* @property int $subscription_proration_date
* @property int $subtotal
* @property int $tax
* @property mixed $threshold_reason
* @property int $total
* @property array $total_tax_amounts
* @property int $webhooks_delivered_at
*
* @package Stripe
*/
class Invoice extends \Stripe\ApiResource
{
const OBJECT_NAME = "invoice";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of the billing reason.
* @link https://stripe.com/docs/api/invoices/object#invoice_object-billing_reason
*/
const BILLING_REASON_MANUAL = 'manual';
const BILLING_REASON_SUBSCRIPTION = 'subscription';
const BILLING_REASON_SUBSCRIPTION_CREATE = 'subscription_create';
const BILLING_REASON_SUBSCRIPTION_CYCLE = 'subscription_cycle';
const BILLING_REASON_SUBSCRIPTION_THRESHOLD = 'subscription_threshold';
const BILLING_REASON_SUBSCRIPTION_UPDATE = 'subscription_update';
const BILLING_REASON_UPCOMING = 'upcoming';
/**
* Possible string representations of the `collection_method` property.
* @link https://stripe.com/docs/api/invoices/object#invoice_object-collection_method
*/
const COLLECTION_METHOD_CHARGE_AUTOMATICALLY = 'charge_automatically';
const COLLECTION_METHOD_SEND_INVOICE = 'send_invoice';
/**
* Possible string representations of the invoice status.
* @link https://stripe.com/docs/api/invoices/object#invoice_object-status
*/
const STATUS_DRAFT = 'draft';
const STATUS_OPEN = 'open';
const STATUS_PAID = 'paid';
const STATUS_UNCOLLECTIBLE = 'uncollectible';
const STATUS_VOID = 'void';
/**
* Possible string representations of the `billing` property.
* @deprecated Use `collection_method` instead.
* @link https://stripe.com/docs/api/invoices/object#invoice_object-billing
*/
const BILLING_CHARGE_AUTOMATICALLY = 'charge_automatically';
const BILLING_SEND_INVOICE = 'send_invoice';
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return Invoice The finalized invoice.
*/
public function finalizeInvoice($params = null, $opts = null)
{
}
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return Invoice The uncollectible invoice.
*/
public function markUncollectible($params = null, $opts = null)
{
}
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return Invoice The paid invoice.
*/
public function pay($params = null, $opts = null)
{
}
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return Invoice The sent invoice.
*/
public function sendInvoice($params = null, $opts = null)
{
}
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return Invoice The upcoming invoice.
*/
public static function upcoming($params = null, $opts = null)
{
}
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return Invoice The voided invoice.
*/
public function voidInvoice($params = null, $opts = null)
{
}
}
/**
* Class IssuerFraudRecord
*
* @property string $id
* @property string $object
* @property string $charge
* @property int $created
* @property int $post_date
* @property string $fraud_type
* @property bool $livemode
*
* @package Stripe
*/
class IssuerFraudRecord extends \Stripe\ApiResource
{
const OBJECT_NAME = "issuer_fraud_record";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
}
/**
* Class PaymentMethod
*
* @property string $id
* @property string $object
* @property mixed $billing_details
* @property mixed $card
* @property mixed $card_present
* @property int $created
* @property string $customer
* @property mixed $ideal
* @property bool $livemode
* @property StripeObject $metadata
* @property mixed $sepa_debit
* @property string $type
*
* @package Stripe
*/
class PaymentMethod extends \Stripe\ApiResource
{
const OBJECT_NAME = "payment_method";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return PaymentMethod The attached payment method.
*/
public function attach($params = null, $opts = null)
{
}
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return PaymentMethod The detached payment method.
*/
public function detach($params = null, $opts = null)
{
}
}
}
namespace Stripe\Issuing {
/**
* Class Transaction
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $authorization
* @property string $balance_transaction
* @property string $card
* @property string $cardholder
* @property int $created
* @property string $currency
* @property string $dispute
* @property bool $livemode
* @property mixed $merchant_data
* @property int $merchant_amount
* @property string $merchant_currency
* @property \Stripe\StripeObject $metadata
* @property string $type
*
* @package Stripe\Issuing
*/
class Transaction extends \Stripe\ApiResource
{
const OBJECT_NAME = "issuing.transaction";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
/**
* Class CardDetails
*
* @property string $id
* @property string $object
* @property Card $card
* @property string $cvc
* @property int $exp_month
* @property int $exp_year
* @property string $number
*
* @package Stripe\Issuing
*/
class CardDetails extends \Stripe\ApiResource
{
const OBJECT_NAME = "issuing.card_details";
}
/**
* Class Card
*
* @property string $id
* @property string $object
* @property mixed $authorization_controls
* @property mixed $billing
* @property string $brand
* @property Cardholder $cardholder
* @property int $created
* @property string $currency
* @property int $exp_month
* @property int $exp_year
* @property string $last4
* @property bool $livemode
* @property \Stripe\StripeObject $metadata
* @property string $name
* @property mixed $shipping
* @property string $status
* @property string $type
*
* @package Stripe\Issuing
*/
class Card extends \Stripe\ApiResource
{
const OBJECT_NAME = "issuing.card";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* @param array|null $params
* @param array|string|null $options
*
* @return CardDetails The card details associated with that issuing card.
*/
public function details($params = null, $options = null)
{
}
}
/**
* Class Dispute
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $created
* @property string $currency
* @property mixed $evidence
* @property bool $livemode
* @property \Stripe\StripeObject $metadata
* @property string $reason
* @property string $status
* @property Transaction $transaction
*
* @package Stripe\Issuing
*/
class Dispute extends \Stripe\ApiResource
{
const OBJECT_NAME = "issuing.dispute";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
/**
* Class Authorization
*
* @property string $id
* @property string $object
* @property bool $approved
* @property string $authorization_method
* @property int $authorized_amount
* @property string $authorized_currency
* @property \Stripe\Collection $balance_transactions
* @property Card $card
* @property Cardholder $cardholder
* @property int $created
* @property int $held_amount
* @property string $held_currency
* @property bool $is_held_amount_controllable
* @property bool $livemode
* @property mixed $merchant_data
* @property \Stripe\StripeObject $metadata
* @property int $pending_authorized_amount
* @property int $pending_held_amount
* @property mixed $request_history
* @property string $status
* @property \Stripe\Collection $transactions
* @property mixed $verification_data
*
* @package Stripe\Issuing
*/
class Authorization extends \Stripe\ApiResource
{
const OBJECT_NAME = "issuing.authorization";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Authorization The approved authorization.
*/
public function approve($params = null, $options = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Authorization The declined authorization.
*/
public function decline($params = null, $options = null)
{
}
}
/**
* Class Cardholder
*
* @property string $id
* @property string $object
* @property mixed $billing
* @property int $created
* @property string $email
* @property bool $livemode
* @property \Stripe\StripeObject $metadata
* @property string $name
* @property string $phone_number
* @property string $status
* @property string $type
*
* @package Stripe\Issuing
*/
class Cardholder extends \Stripe\ApiResource
{
const OBJECT_NAME = "issuing.cardholder";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
}
namespace Stripe\Error {
abstract class Base extends \Exception
{
public function __construct($message, $httpStatus = null, $httpBody = null, $jsonBody = null, $httpHeaders = null)
{
}
public function getStripeCode()
{
}
public function getHttpStatus()
{
}
public function getHttpBody()
{
}
public function getJsonBody()
{
}
public function getHttpHeaders()
{
}
public function getRequestId()
{
}
public function __toString()
{
}
}
class ApiConnection extends \Stripe\Error\Base
{
}
class InvalidRequest extends \Stripe\Error\Base
{
public function __construct($message, $stripeParam, $httpStatus = null, $httpBody = null, $jsonBody = null, $httpHeaders = null)
{
}
public function getStripeParam()
{
}
}
class RateLimit extends \Stripe\Error\InvalidRequest
{
}
class Authentication extends \Stripe\Error\Base
{
}
class Card extends \Stripe\Error\Base
{
public function __construct($message, $stripeParam, $stripeCode, $httpStatus, $httpBody, $jsonBody, $httpHeaders = null)
{
}
public function getDeclineCode()
{
}
public function getStripeParam()
{
}
}
class Api extends \Stripe\Error\Base
{
}
}
namespace Stripe\Error\OAuth {
class OAuthBase extends \Stripe\Error\Base
{
public function __construct($code, $description, $httpStatus = null, $httpBody = null, $jsonBody = null, $httpHeaders = null)
{
}
public function getErrorCode()
{
}
}
/**
* InvalidRequest is raised when a code, refresh token, or grant type
* parameter is not provided, but was required.
*/
class InvalidRequest extends \Stripe\Error\OAuth\OAuthBase
{
}
/**
* InvalidGrant is raised when a specified code doesn't exist, is
* expired, has been used, or doesn't belong to you; a refresh token doesn't
* exist, or doesn't belong to you; or if an API key's mode (live or test)
* doesn't match the mode of a code or refresh token.
*/
class InvalidGrant extends \Stripe\Error\OAuth\OAuthBase
{
}
/**
* UnsupportedGrantType is raised when an unuspported grant type
* parameter is specified.
*/
class UnsupportedGrantType extends \Stripe\Error\OAuth\OAuthBase
{
}
/**
* UnsupportedResponseType is raised when an unsupported response type
* parameter is specified.
*/
class UnsupportedResponseType extends \Stripe\Error\OAuth\OAuthBase
{
}
/**
* InvalidScope is raised when an invalid scope parameter is provided.
*/
class InvalidScope extends \Stripe\Error\OAuth\OAuthBase
{
}
/**
* InvalidClient is raised when authentication fails.
*/
class InvalidClient extends \Stripe\Error\OAuth\OAuthBase
{
}
}
namespace Stripe\Error {
class SignatureVerification extends \Stripe\Error\Base
{
public function __construct($message, $sigHeader, $httpBody = null)
{
}
public function getSigHeader()
{
}
}
class Idempotency extends \Stripe\Error\Base
{
}
class Permission extends \Stripe\Error\Base
{
}
}
namespace Stripe {
/**
* Class InvoiceItem
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $currency
* @property string $customer
* @property int $date
* @property string $description
* @property bool $discountable
* @property string $invoice
* @property bool $livemode
* @property StripeObject $metadata
* @property mixed $period
* @property Plan $plan
* @property bool $proration
* @property int $quantity
* @property string $subscription
* @property string $subscription_item
* @property array $tax_rates
* @property int $unit_amount
*
* @package Stripe
*/
class InvoiceItem extends \Stripe\ApiResource
{
const OBJECT_NAME = "invoiceitem";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
}
namespace Stripe\Terminal {
/**
* Class ConnectionToken
*
* @property string $secret
*
* @package Stripe\Terminal
*/
class ConnectionToken extends \Stripe\ApiResource
{
const OBJECT_NAME = "terminal.connection_token";
use \Stripe\ApiOperations\Create;
}
/**
* Class Reader
*
* @property string $id
* @property string $object
* @property bool $deleted
* @property string $device_sw_version
* @property string $device_type
* @property string $ip_address
* @property string $label
* @property string $location
* @property string $serial_number
* @property string $status
*
* @package Stripe\Terminal
*/
class Reader extends \Stripe\ApiResource
{
const OBJECT_NAME = "terminal.reader";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
/**
* Class Location
*
* @property string $id
* @property string $object
* @property mixed $address
* @property bool $deleted
* @property string $display_name
*
* @package Stripe\Terminal
*/
class Location extends \Stripe\ApiResource
{
const OBJECT_NAME = "terminal.location";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
}
namespace Stripe\Reporting {
/**
* Class ReportRun
*
* @property string $id
* @property string $object
* @property int $created
* @property string $error
* @property bool $livemode
* @property mixed $parameters
* @property string $report_type
* @property mixed $result
* @property string $status
* @property int $succeeded_at
*
* @package Stripe\Reporting
*/
class ReportRun extends \Stripe\ApiResource
{
const OBJECT_NAME = "reporting.report_run";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
}
/**
* Class ReportType
*
* @property string $id
* @property string $object
* @property int $data_available_end
* @property int $data_available_start
* @property string $name
* @property int $updated
* @property string $version
*
* @package Stripe\Reporting
*/
class ReportType extends \Stripe\ApiResource
{
const OBJECT_NAME = "reporting.report_type";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
}
}
namespace Stripe {
/**
* Class ExchangeRate
*
* @package Stripe
*/
class ExchangeRate extends \Stripe\ApiResource
{
const OBJECT_NAME = "exchange_rate";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
}
/**
* Class Review
*
* @property string $id
* @property string $object
* @property string $billing_zip
* @property string $charge
* @property string $closed_reason
* @property int $created
* @property string $ip_address
* @property mixed $ip_address_location
* @property bool $livemode
* @property bool $open
* @property string $opened_reason
* @property string $payment_intent
* @property string $reason
* @property mixed $session
*
* @package Stripe
*/
class Review extends \Stripe\ApiResource
{
const OBJECT_NAME = "review";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
/**
* Possible string representations of the current, the opening or the closure reason of the review.
* Not all of these enumeration apply to all of the ´reason´ fields. Please consult the Review object to
* determine where these are apply.
* @link https://stripe.com/docs/api/radar/reviews/object
*/
const REASON_APPROVED = 'approved';
const REASON_DISPUTED = 'disputed';
const REASON_MANUAL = 'manual';
const REASON_REFUNDED = 'refunded';
const REASON_REFUNDED_AS_FRAUD = 'refunded_as_fraud';
const REASON_RULE = 'rule';
/**
* @param array|string|null $options
*
* @return Review The approved review.
*/
public function approve($params = null, $options = null)
{
}
}
/**
* Class OrderItem
*
* @property string $object
* @property int $amount
* @property string $currency
* @property string $description
* @property string $parent
* @property int $quantity
* @property string $type
*
* @package Stripe
*/
class OrderItem extends \Stripe\StripeObject
{
const OBJECT_NAME = "order_item";
}
/**
* Class PaymentIntent
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $amount_capturable
* @property int $amount_received
* @property string $application
* @property int $application_fee_amount
* @property int $canceled_at
* @property string $cancellation_reason
* @property string $capture_method
* @property Collection $charges
* @property string $client_secret
* @property string $confirmation_method
* @property int $created
* @property string $currency
* @property string $customer
* @property string $description
* @property mixed $last_payment_error
* @property bool $livemode
* @property StripeObject $metadata
* @property mixed $next_action
* @property string $on_behalf_of
* @property string $payment_method
* @property string[] $payment_method_types
* @property string $receipt_email
* @property string $review
* @property mixed $shipping
* @property string $source
* @property string $statement_descriptor
* @property string $status
* @property mixed $transfer_data
* @property string $transfer_group
*
* @package Stripe
*/
class PaymentIntent extends \Stripe\ApiResource
{
const OBJECT_NAME = "payment_intent";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* These constants are possible representations of the status field.
*
* @link https://stripe.com/docs/api/payment_intents/object#payment_intent_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_PROCESSING = 'processing';
const STATUS_REQUIRES_ACTION = 'requires_action';
const STATUS_REQUIRES_CAPTURE = 'requires_capture';
const STATUS_REQUIRES_CONFIRMATION = 'requires_confirmation';
const STATUS_REQUIRES_PAYMENT_METHOD = 'requires_payment_method';
const STATUS_SUCCEEDED = 'succeeded';
/**
* @param array|null $params
* @param array|string|null $options
*
* @return PaymentIntent The canceled payment intent.
*/
public function cancel($params = null, $options = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return PaymentIntent The captured payment intent.
*/
public function capture($params = null, $options = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return PaymentIntent The confirmed payment intent.
*/
public function confirm($params = null, $options = null)
{
}
}
/**
* Class Product
*
* @property string $id
* @property string $object
* @property bool $active
* @property string[] $attributes
* @property string $caption
* @property int $created
* @property string[] $deactivate_on
* @property string $description
* @property string[] $images
* @property bool $livemode
* @property StripeObject $metadata
* @property string $name
* @property mixed $package_dimensions
* @property bool $shippable
* @property string $statement_descriptor
* @property string $type
* @property string $unit_label
* @property int $updated
* @property string $url
*
* @package Stripe
*/
class Product extends \Stripe\ApiResource
{
const OBJECT_NAME = "product";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of the type of product.
* @link https://stripe.com/docs/api/service_products/object#service_product_object-type
*/
const TYPE_GOOD = 'good';
const TYPE_SERVICE = 'service';
}
/**
* Class Charge
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $amount_refunded
* @property string $application
* @property string $application_fee
* @property int $application_fee_amount
* @property string $balance_transaction
* @property mixed $billing_details
* @property bool $captured
* @property int $created
* @property string $currency
* @property string $customer
* @property string $description
* @property string $destination
* @property string $dispute
* @property string $failure_code
* @property string $failure_message
* @property mixed $fraud_details
* @property string $invoice
* @property bool $livemode
* @property StripeObject $metadata
* @property string $on_behalf_of
* @property string $order
* @property mixed $outcome
* @property bool $paid
* @property string $payment_intent
* @property string $payment_method
* @property mixed $payment_method_details
* @property string $receipt_email
* @property string $receipt_number
* @property string $receipt_url
* @property bool $refunded
* @property Collection $refunds
* @property string $review
* @property mixed $shipping
* @property mixed $source
* @property string $source_transfer
* @property string $statement_descriptor
* @property string $status
* @property string $transfer
* @property mixed $transfer_data
* @property string $transfer_group
*
* @package Stripe
*/
class Charge extends \Stripe\ApiResource
{
const OBJECT_NAME = "charge";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of decline codes.
* These strings are applicable to the decline_code property of the \Stripe\Error\Card exception.
* @link https://stripe.com/docs/declines/codes
*/
const DECLINED_APPROVE_WITH_ID = 'approve_with_id';
const DECLINED_CALL_ISSUER = 'call_issuer';
const DECLINED_CARD_NOT_SUPPORTED = 'card_not_supported';
const DECLINED_CARD_VELOCITY_EXCEEDED = 'card_velocity_exceeded';
const DECLINED_CURRENCY_NOT_SUPPORTED = 'currency_not_supported';
const DECLINED_DO_NOT_HONOR = 'do_not_honor';
const DECLINED_DO_NOT_TRY_AGAIN = 'do_not_try_again';
const DECLINED_DUPLICATED_TRANSACTION = 'duplicate_transaction';
const DECLINED_EXPIRED_CARD = 'expired_card';
const DECLINED_FRAUDULENT = 'fraudulent';
const DECLINED_GENERIC_DECLINE = 'generic_decline';
const DECLINED_INCORRECT_NUMBER = 'incorrect_number';
const DECLINED_INCORRECT_CVC = 'incorrect_cvc';
const DECLINED_INCORRECT_PIN = 'incorrect_pin';
const DECLINED_INCORRECT_ZIP = 'incorrect_zip';
const DECLINED_INSUFFICIENT_FUNDS = 'insufficient_funds';
const DECLINED_INVALID_ACCOUNT = 'invalid_account';
const DECLINED_INVALID_AMOUNT = 'invalid_amount';
const DECLINED_INVALID_CVC = 'invalid_cvc';
const DECLINED_INVALID_EXPIRY_YEAR = 'invalid_expiry_year';
const DECLINED_INVALID_NUMBER = 'invalid_number';
const DECLINED_INVALID_PIN = 'invalid_pin';
const DECLINED_ISSUER_NOT_AVAILABLE = 'issuer_not_available';
const DECLINED_LOST_CARD = 'lost_card';
const DECLINED_MERCHANT_BLACKLIST = 'merchant_blacklist';
const DECLINED_NEW_ACCOUNT_INFORMATION_AVAILABLE = 'new_account_information_available';
const DECLINED_NO_ACTION_TAKEN = 'no_action_taken';
const DECLINED_NOT_PERMITTED = 'not_permitted';
const DECLINED_PICKUP_CARD = 'pickup_card';
const DECLINED_PIN_TRY_EXCEEDED = 'pin_try_exceeded';
const DECLINED_PROCESSING_ERROR = 'processing_error';
const DECLINED_REENTER_TRANSACTION = 'reenter_transaction';
const DECLINED_RESTRICTED_CARD = 'restricted_card';
const DECLINED_REVOCATION_OF_ALL_AUTHORIZATIONS = 'revocation_of_all_authorizations';
const DECLINED_REVOCATION_OF_AUTHORIZATION = 'revocation_of_authorization';
const DECLINED_SECURITY_VIOLATION = 'security_violation';
const DECLINED_SERVICE_NOT_ALLOWED = 'service_not_allowed';
const DECLINED_STOLEN_CARD = 'stolen_card';
const DECLINED_STOP_PAYMENT_ORDER = 'stop_payment_order';
const DECLINED_TESTMODE_DECLINE = 'testmode_decline';
const DECLINED_TRANSACTION_NOT_ALLOWED = 'transaction_not_allowed';
const DECLINED_TRY_AGAIN_LATER = 'try_again_later';
const DECLINED_WITHDRAWAL_COUNT_LIMIT_EXCEEDED = 'withdrawal_count_limit_exceeded';
/**
* Possible string representations of the status of the charge.
* @link https://stripe.com/docs/api/charges/object#charge_object-status
*/
const STATUS_FAILED = 'failed';
const STATUS_PENDING = 'pending';
const STATUS_SUCCEEDED = 'succeeded';
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Charge The refunded charge.
*/
public function refund($params = null, $options = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Charge The captured charge.
*/
public function capture($params = null, $options = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @deprecated Use the `save` method on the Dispute object
*
* @return array The updated dispute.
*/
public function updateDispute($params = null, $options = null)
{
}
/**
* @param array|string|null $options
*
* @deprecated Use the `close` method on the Dispute object
*
* @return Charge The updated charge.
*/
public function closeDispute($options = null)
{
}
/**
* @param array|string|null $opts
*
* @return Charge The updated charge.
*/
public function markAsFraudulent($opts = null)
{
}
/**
* @param array|string|null $opts
*
* @return Charge The updated charge.
*/
public function markAsSafe($opts = null)
{
}
}
}
namespace Stripe\HttpClient {
interface ClientInterface
{
/**
* @param string $method The HTTP method being used
* @param string $absUrl The URL being requested, including domain and protocol
* @param array $headers Headers to be used in the request (full strings, not KV pairs)
* @param array $params KV pairs for parameters. Can be nested for arrays and hashes
* @param boolean $hasFile Whether or not $params references a file (via an @ prefix or
* CurlFile)
*
* @throws \Stripe\Error\Api
* @throws \Stripe\Error\ApiConnection
* @return array An array whose first element is raw request body, second
* element is HTTP status code and third array of HTTP headers.
*/
public function request($method, $absUrl, $headers, $params, $hasFile);
}
class CurlClient implements \Stripe\HttpClient\ClientInterface
{
public static function instance()
{
}
protected $defaultOptions;
protected $userAgentInfo;
protected $enablePersistentConnections = null;
protected $enableHttp2 = null;
protected $curlHandle = null;
/**
* CurlClient constructor.
*
* Pass in a callable to $defaultOptions that returns an array of CURLOPT_* values to start
* off a request with, or an flat array with the same format used by curl_setopt_array() to
* provide a static set of options. Note that many options are overridden later in the request
* call, including timeouts, which can be set via setTimeout() and setConnectTimeout().
*
* Note that request() will silently ignore a non-callable, non-array $defaultOptions, and will
* throw an exception if $defaultOptions returns a non-array value.
*
* @param array|callable|null $defaultOptions
*/
public function __construct($defaultOptions = null, $randomGenerator = null)
{
}
public function __destruct()
{
}
public function initUserAgentInfo()
{
}
public function getDefaultOptions()
{
}
public function getUserAgentInfo()
{
}
/**
* @return boolean
*/
public function getEnablePersistentConnections()
{
}
/**
* @param boolean $enable
*/
public function setEnablePersistentConnections($enable)
{
}
/**
* @return boolean
*/
public function getEnableHttp2()
{
}
/**
* @param boolean $enable
*/
public function setEnableHttp2($enable)
{
}
// USER DEFINED TIMEOUTS
const DEFAULT_TIMEOUT = 80;
const DEFAULT_CONNECT_TIMEOUT = 30;
public function setTimeout($seconds)
{
}
public function setConnectTimeout($seconds)
{
}
public function getTimeout()
{
}
public function getConnectTimeout()
{
}
// END OF USER DEFINED TIMEOUTS
public function request($method, $absUrl, $headers, $params, $hasFile)
{
}
}
}
namespace Stripe {
/**
* Class Coupon
*
* @property string $id
* @property string $object
* @property int $amount_off
* @property int $created
* @property string $currency
* @property string $duration
* @property int $duration_in_months
* @property bool $livemode
* @property int $max_redemptions
* @property StripeObject $metadata
* @property string $name
* @property float $percent_off
* @property int $redeem_by
* @property int $times_redeemed
* @property bool $valid
*
* @package Stripe
*/
class Coupon extends \Stripe\ApiResource
{
const OBJECT_NAME = "coupon";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
}
namespace Stripe\Radar {
/**
* Class ValueListItem
*
* @property string $id
* @property string $object
* @property int $created
* @property string $created_by
* @property string $list
* @property bool $livemode
* @property string $value
*
* @package Stripe\Radar
*/
class ValueListItem extends \Stripe\ApiResource
{
const OBJECT_NAME = "radar.value_list_item";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
}
/**
* Class EarlyFraudWarning
*
* @property string $id
* @property string $object
* @property bool $actionable
* @property string $charge
* @property int $created
* @property string $fraud_type
* @property bool $livemode
*
* @package Stripe\Radar
*/
class EarlyFraudWarning extends \Stripe\ApiResource
{
const OBJECT_NAME = "radar.early_fraud_warning";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
/**
* Possible string representations of an early fraud warning's fraud type.
* @link https://stripe.com/docs/api/early_fraud_warnings/object#early_fraud_warning_object-fraud_type
*/
const FRAUD_TYPE_CARD_NEVER_RECEIVED = 'card_never_received';
const FRAUD_TYPE_FRAUDULENT_CARD_APPLICATION = 'fraudulent_card_application';
const FRAUD_TYPE_MADE_WITH_COUNTERFEIT_CARD = 'made_with_counterfeit_card';
const FRAUD_TYPE_MADE_WITH_LOST_CARD = 'made_with_lost_card';
const FRAUD_TYPE_MADE_WITH_STOLEN_CARD = 'made_with_stolen_card';
const FRAUD_TYPE_MISC = 'misc';
const FRAUD_TYPE_UNAUTHORIZED_USE_OF_CARD = 'unauthorized_use_of_card';
}
/**
* Class ValueList
*
* @property string $id
* @property string $object
* @property string $alias
* @property int $created
* @property string $created_by
* @property string $item_type
* @property Collection $list_items
* @property bool $livemode
* @property StripeObject $metadata
* @property mixed $name
* @property int $updated
* @property string $updated_by
*
* @package Stripe\Radar
*/
class ValueList extends \Stripe\ApiResource
{
const OBJECT_NAME = "radar.value_list";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
}
namespace Stripe {
/**
* Class TaxId
*
* @package Stripe
*
* @property string $id
* @property string $object
* @property string $country
* @property int $created
* @property string $customer
* @property bool $livemode
* @property string $type
* @property string $value
* @property mixed $verification
*/
class TaxId extends \Stripe\ApiResource
{
const OBJECT_NAME = "tax_id";
use \Stripe\ApiOperations\Delete;
/**
* Possible string representations of a tax id's type.
* @link https://stripe.com/docs/api/customer_tax_ids/object#tax_id_object-type
*/
const TYPE_AU_ABN = 'au_abn';
const TYPE_EU_VAT = 'eu_vat';
const TYPE_IN_GST = 'in_gst';
const TYPE_NO_VAT = 'no_vat';
const TYPE_NZ_GST = 'nz_gst';
const TYPE_UNKNOWN = 'unknown';
/**
* Possible string representations of the verification status.
* @link https://stripe.com/docs/api/customer_tax_ids/object#tax_id_object-verification
*/
const VERIFICATION_STATUS_PENDING = 'pending';
const VERIFICATION_STATUS_UNAVAILABLE = 'unavailable';
const VERIFICATION_STATUS_UNVERIFIED = 'unverified';
const VERIFICATION_STATUS_VERIFIED = 'verified';
/**
* @return string The API URL for this tax id.
*/
public function instanceUrl()
{
}
/**
* @param array|string $_id
* @param array|string|null $_opts
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function retrieve($_id, $_opts = null)
{
}
}
/**
* Class BalanceTransaction
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $available_on
* @property int $created
* @property string $currency
* @property string $description
* @property float $exchange_rate
* @property int $fee
* @property mixed $fee_details
* @property int $net
* @property string $source
* @property string $status
* @property string $type
*
* @package Stripe
*/
class BalanceTransaction extends \Stripe\ApiResource
{
const OBJECT_NAME = "balance_transaction";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
/**
* Possible string representations of the type of balance transaction.
* @link https://stripe.com/docs/api/balance/balance_transaction#balance_transaction_object-type
*/
const TYPE_ADJUSTMENT = 'adjustment';
const TYPE_ADVANCE = 'advance';
const TYPE_ADVANCE_FUNDING = 'advance_funding';
const TYPE_APPLICATION_FEE = 'application_fee';
const TYPE_APPLICATION_FEE_REFUND = 'application_fee_refund';
const TYPE_CHARGE = 'charge';
const TYPE_CONNECT_COLLECTION_TRANSFER = 'connect_collection_transfer';
const TYPE_ISSUING_AUTHORIZATION_HOLD = 'issuing_authorization_hold';
const TYPE_ISSUING_AUTHORIZATION_RELEASE = 'issuing_authorization_release';
const TYPE_ISSUING_TRANSACTION = 'issuing_transaction';
const TYPE_PAYMENT = 'payment';
const TYPE_PAYMENT_FAILURE_REFUND = 'payment_failure_refund';
const TYPE_PAYMENT_REFUND = 'payment_refund';
const TYPE_PAYOUT = 'payout';
const TYPE_PAYOUT_CANCEL = 'payout_cancel';
const TYPE_PAYOUT_FAILURE = 'payout_failure';
const TYPE_REFUND = 'refund';
const TYPE_REFUND_FAILURE = 'refund_failure';
const TYPE_RESERVE_TRANSACTION = 'reserve_transaction';
const TYPE_RESERVED_FUNDS = 'reserved_funds';
const TYPE_STRIPE_FEE = 'stripe_fee';
const TYPE_STRIPE_FX_FEE = 'stripe_fx_fee';
const TYPE_TAX_FEE = 'tax_fee';
const TYPE_TOPUP = 'topup';
const TYPE_TOPUP_REVERSAL = 'topup_reversal';
const TYPE_TRANSFER = 'transfer';
const TYPE_TRANSFER_CANCEL = 'transfer_cancel';
const TYPE_TRANSFER_FAILURE = 'transfer_failure';
const TYPE_TRANSFER_REFUND = 'transfer_refund';
}
/**
* Class Stripe
*
* @package Stripe
*/
class Stripe
{
// @var string The Stripe API key to be used for requests.
public static $apiKey;
// @var string The Stripe client_id to be used for Connect requests.
public static $clientId;
// @var string The base URL for the Stripe API.
public static $apiBase = 'https://api.stripe.com';
// @var string The base URL for the OAuth API.
public static $connectBase = 'https://connect.stripe.com';
// @var string The base URL for the Stripe API uploads endpoint.
public static $apiUploadBase = 'https://files.stripe.com';
// @var string|null The version of the Stripe API to use for requests.
public static $apiVersion = null;
// @var string|null The account ID for connected accounts requests.
public static $accountId = null;
// @var string Path to the CA bundle used to verify SSL certificates
public static $caBundlePath = null;
// @var boolean Defaults to true.
public static $verifySslCerts = true;
// @var array The application's information (name, version, URL)
public static $appInfo = null;
// @var Util\LoggerInterface|null The logger to which the library will
// produce messages.
public static $logger = null;
// @var int Maximum number of request retries
public static $maxNetworkRetries = 0;
// @var boolean Whether client telemetry is enabled. Defaults to true.
public static $enableTelemetry = true;
const VERSION = '6.43.1';
/**
* @return string The API key used for requests.
*/
public static function getApiKey()
{
}
/**
* @return string The client_id used for Connect requests.
*/
public static function getClientId()
{
}
/**
* @return Util\LoggerInterface The logger to which the library will
* produce messages.
*/
public static function getLogger()
{
}
/**
* @param Util\LoggerInterface $logger The logger to which the library
* will produce messages.
*/
public static function setLogger($logger)
{
}
/**
* Sets the API key to be used for requests.
*
* @param string $apiKey
*/
public static function setApiKey($apiKey)
{
}
/**
* Sets the client_id to be used for Connect requests.
*
* @param string $clientId
*/
public static function setClientId($clientId)
{
}
/**
* @return string The API version used for requests. null if we're using the
* latest version.
*/
public static function getApiVersion()
{
}
/**
* @param string $apiVersion The API version to use for requests.
*/
public static function setApiVersion($apiVersion)
{
}
/**
* @return string
*/
public static function getCABundlePath()
{
}
/**
* @param string $caBundlePath
*/
public static function setCABundlePath($caBundlePath)
{
}
/**
* @return boolean
*/
public static function getVerifySslCerts()
{
}
/**
* @param boolean $verify
*/
public static function setVerifySslCerts($verify)
{
}
/**
* @return string | null The Stripe account ID for connected account
* requests.
*/
public static function getAccountId()
{
}
/**
* @param string $accountId The Stripe account ID to set for connected
* account requests.
*/
public static function setAccountId($accountId)
{
}
/**
* @return array | null The application's information
*/
public static function getAppInfo()
{
}
/**
* @param string $appName The application's name
* @param string $appVersion The application's version
* @param string $appUrl The application's URL
*/
public static function setAppInfo($appName, $appVersion = null, $appUrl = null, $appPartnerId = null)
{
}
/**
* @return int Maximum number of request retries
*/
public static function getMaxNetworkRetries()
{
}
/**
* @param int $maxNetworkRetries Maximum number of request retries
*/
public static function setMaxNetworkRetries($maxNetworkRetries)
{
}
/**
* @return float Maximum delay between retries, in seconds
*/
public static function getMaxNetworkRetryDelay()
{
}
/**
* @return float Initial delay between retries, in seconds
*/
public static function getInitialNetworkRetryDelay()
{
}
/**
* @return bool Whether client telemetry is enabled
*/
public static function getEnableTelemetry()
{
}
/**
* @param bool $enableTelemetry Enables client telemetry.
*
* Client telemetry enables timing and request metrics to be sent back to Stripe as an HTTP Header
* with the current request. This enables Stripe to do latency and metrics analysis without adding extra
* overhead (such as extra network calls) on the client.
*/
public static function setEnableTelemetry($enableTelemetry)
{
}
}
/**
* Class Plan
*
* @package Stripe
*
* @property string $id
* @property string $object
* @property bool $active
* @property string $aggregate_usage
* @property int $amount
* @property string $billing_scheme
* @property int $created
* @property string $currency
* @property string $interval
* @property int $interval_count
* @property bool $livemode
* @property StripeObject $metadata
* @property string $nickname
* @property string $product
* @property mixed $tiers
* @property string $tiers_mode
* @property mixed $transform_usage
* @property int $trial_period_days
* @property string $usage_type
*/
class Plan extends \Stripe\ApiResource
{
const OBJECT_NAME = "plan";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
}
namespace Stripe\Util {
/**
* CaseInsensitiveArray is an array-like class that ignores case for keys.
*
* It is used to store HTTP headers. Per RFC 2616, section 4.2:
* Each header field consists of a name followed by a colon (":") and the field value. Field names
* are case-insensitive.
*
* In the context of stripe-php, this is useful because the API will return headers with different
* case depending on whether HTTP/2 is used or not (with HTTP/2, headers are always in lowercase).
*/
class CaseInsensitiveArray implements \ArrayAccess
{
public function __construct($initial_array = array())
{
}
public function offsetSet($offset, $value)
{
}
public function offsetExists($offset)
{
}
public function offsetUnset($offset)
{
}
public function offsetGet($offset)
{
}
}
class Set implements \IteratorAggregate
{
public function __construct($members = [])
{
}
public function includes($elt)
{
}
public function add($elt)
{
}
public function discard($elt)
{
}
public function toArray()
{
}
public function getIterator()
{
}
}
/**
* A basic random generator. This is in a separate class so we the generator
* can be injected as a dependency and replaced with a mock in tests.
*/
class RandomGenerator
{
/**
* Returns a random value between 0 and $max.
*
* @param float $max (optional)
* @return float
*/
public function randFloat($max = 1.0)
{
}
/**
* Returns a v4 UUID.
*
* @return string
*/
public function uuid()
{
}
}
abstract class Util
{
/**
* Whether the provided array (or other) is a list rather than a dictionary.
* A list is defined as an array for which all the keys are consecutive
* integers starting at 0. Empty arrays are considered to be lists.
*
* @param array|mixed $array
* @return boolean true if the given object is a list.
*/
public static function isList($array)
{
}
/**
* Recursively converts the PHP Stripe object to an array.
*
* @param array $values The PHP Stripe object to convert.
* @return array
*/
public static function convertStripeObjectToArray($values)
{
}
/**
* Converts a response from the Stripe API to the corresponding PHP object.
*
* @param array $resp The response from the Stripe API.
* @param array $opts
* @return StripeObject|array
*/
public static function convertToStripeObject($resp, $opts)
{
}
/**
* @param string|mixed $value A string to UTF8-encode.
*
* @return string|mixed The UTF8-encoded string, or the object passed in if
* it wasn't a string.
*/
public static function utf8($value)
{
}
/**
* Compares two strings for equality. The time taken is independent of the
* number of characters that match.
*
* @param string $a one of the strings to compare.
* @param string $b the other string to compare.
* @return bool true if the strings are equal, false otherwise.
*/
public static function secureCompare($a, $b)
{
}
/**
* Recursively goes through an array of parameters. If a parameter is an instance of
* ApiResource, then it is replaced by the resource's ID.
* Also clears out null values.
*
* @param mixed $h
* @return mixed
*/
public static function objectsToIds($h)
{
}
/**
* @param array $params
*
* @return string
*/
public static function encodeParameters($params)
{
}
/**
* @param array $params
* @param string|null $parentKey
*
* @return array
*/
public static function flattenParams($params, $parentKey = null)
{
}
/**
* @param array $value
* @param string $calculatedKey
*
* @return array
*/
public static function flattenParamsList($value, $calculatedKey)
{
}
/**
* @param string $key A string to URL-encode.
*
* @return string The URL-encoded string.
*/
public static function urlEncode($key)
{
}
public static function normalizeId($id)
{
}
/**
* Returns UNIX timestamp in milliseconds
*
* @return integer current time in millis
*/
public static function currentTimeMillis()
{
}
}
class AutoPagingIterator implements \Iterator
{
public function __construct($collection, $params)
{
}
public function rewind()
{
}
public function current()
{
}
public function key()
{
}
public function next()
{
}
public function valid()
{
}
}
class RequestOptions
{
/**
* @var array A list of headers that should be persisted across requests.
*/
public static $HEADERS_TO_PERSIST = ['Stripe-Account', 'Stripe-Version'];
public $headers;
public $apiKey;
public $apiBase;
public function __construct($key = null, $headers = [], $base = null)
{
}
/**
* Unpacks an options array and merges it into the existing RequestOptions
* object.
* @param array|string|null $options a key => value array
*
* @return RequestOptions
*/
public function merge($options)
{
}
/**
* Discards all headers that we don't want to persist across requests.
*/
public function discardNonPersistentHeaders()
{
}
/**
* Unpacks an options array into an RequestOptions object
* @param array|string|null $options a key => value array
*
* @return RequestOptions
*/
public static function parse($options)
{
}
}
/**
* Describes a logger instance.
*
* This is a subset of the interface of the same name in the PSR-3 logger
* interface. We guarantee to keep it compatible, but we'd redefined it here so
* that we don't have to pull in the extra dependencies for users who don't want
* it.
*
* See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-3-logger-interface.md
* for the full interface specification.
*
* The message MUST be a string or object implementing __toString().
*
* The message MAY contain placeholders in the form: {foo} where foo
* will be replaced by the context data in key "foo".
*
* The context array can contain arbitrary data, the only assumption that
* can be made by implementors is that if an Exception instance is given
* to produce a stack trace, it MUST be in a key named "exception".
*/
interface LoggerInterface
{
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
* @param array $context
* @return void
*/
public function error($message, array $context = []);
}
/**
* A very basic implementation of LoggerInterface that has just enough
* functionality that it can be the default for this library.
*/
class DefaultLogger implements \Stripe\Util\LoggerInterface
{
public function error($message, array $context = [])
{
}
}
}
namespace Stripe {
/**
* Class Person
*
* @package Stripe
*
* @property string $id
* @property string $object
* @property string $account
* @property mixed $address
* @property mixed $address_kana
* @property mixed $address_kanji
* @property int $created
* @property bool $deleted
* @property mixed $dob
* @property string $email
* @property string $first_name
* @property string $first_name_kana
* @property string $first_name_kanji
* @property string $gender
* @property bool $id_number_provided
* @property string $last_name
* @property string $last_name_kana
* @property string $last_name_kanji
* @property string $maiden_name
* @property StripeObject $metadata
* @property string $phone
* @property mixed $relationship
* @property mixed $requirements
* @property bool $ssn_last_4_provided
* @property mixed $verification
*/
class Person extends \Stripe\ApiResource
{
const OBJECT_NAME = "person";
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of a person's gender.
* @link https://stripe.com/docs/api/persons/object#person_object-gender
*/
const GENDER_MALE = 'male';
const GENDER_FEMALE = 'female';
/**
* Possible string representations of a person's verification status.
* @link https://stripe.com/docs/api/persons/object#person_object-verification-status
*/
const VERIFICATION_STATUS_PENDING = 'pending';
const VERIFICATION_STATUS_UNVERIFIED = 'unverified';
const VERIFICATION_STATUS_VERIFIED = 'verified';
/**
* @return string The API URL for this Stripe account reversal.
*/
public function instanceUrl()
{
}
/**
* @param array|string $_id
* @param array|string|null $_opts
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function retrieve($_id, $_opts = null)
{
}
/**
* @param string $_id
* @param array|null $_params
* @param array|string|null $_options
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function update($_id, $_params = null, $_options = null)
{
}
}
/**
* Class Refund
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $balance_transaction
* @property string $charge
* @property int $created
* @property string $currency
* @property string $description
* @property string $failure_balance_transaction
* @property string $failure_reason
* @property StripeObject $metadata
* @property string $reason
* @property string $receipt_number
* @property string $source_transfer_reversal
* @property string $status
* @property string $transfer_reversal
*
* @package Stripe
*/
class Refund extends \Stripe\ApiResource
{
const OBJECT_NAME = "refund";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of the failure reason.
* @link https://stripe.com/docs/api/refunds/object#refund_object-failure_reason
*/
const FAILURE_REASON = 'expired_or_canceled_card';
const FAILURE_REASON_LOST_OR_STOLEN_CARD = 'lost_or_stolen_card';
const FAILURE_REASON_UNKNOWN = 'unknown';
/**
* Possible string representations of the refund reason.
* @link https://stripe.com/docs/api/refunds/object#refund_object-reason
*/
const REASON_DUPLICATE = 'duplicate';
const REASON_FRAUDULENT = 'fraudulent';
const REASON_REQUESTED_BY_CUSTOMER = 'requested_by_customer';
/**
* Possible string representations of the refund status.
* @link https://stripe.com/docs/api/refunds/object#refund_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_FAILED = 'failed';
const STATUS_PENDING = 'pending';
const STATUS_SUCCEEDED = 'succeeded';
}
/**
* Class BitcoinReceiver
*
* @package Stripe
*
* @deprecated Bitcoin receivers are deprecated. Please use the sources API instead.
* @link https://stripe.com/docs/sources/bitcoin
*/
class BitcoinReceiver extends \Stripe\ApiResource
{
const OBJECT_NAME = "bitcoin_receiver";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
/**
* @return string The class URL for this resource. It needs to be special
* cased because it doesn't fit into the standard resource pattern.
*/
public static function classUrl()
{
}
/**
* @return string The instance URL for this resource. It needs to be special
* cased because it doesn't fit into the standard resource pattern.
*/
public function instanceUrl()
{
}
}
/**
* Class Capability
*
* @package Stripe
*
* @property string $id
* @property string $object
* @property string $account
* @property bool $requested
* @property int $requested_at
* @property mixed $requirements
* @property string $status
*/
class Capability extends \Stripe\ApiResource
{
const OBJECT_NAME = "capability";
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of a capability's status.
* @link https://stripe.com/docs/api/capabilities/object#capability_object-status
*/
const STATUS_ACTIVE = 'active';
const STATUS_INACTIVE = 'inactive';
const STATUS_PENDING = 'pending';
const STATUS_UNREQUESTED = 'unrequested';
/**
* @return string The API URL for this Stripe account reversal.
*/
public function instanceUrl()
{
}
/**
* @param array|string $_id
* @param array|string|null $_opts
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function retrieve($_id, $_opts = null)
{
}
/**
* @param string $_id
* @param array|null $_params
* @param array|string|null $_options
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function update($_id, $_params = null, $_options = null)
{
}
}
/**
* Class ApplicationFeeRefund
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $balance_transaction
* @property int $created
* @property string $currency
* @property string $fee
* @property StripeObject $metadata
*
* @package Stripe
*/
class ApplicationFeeRefund extends \Stripe\ApiResource
{
const OBJECT_NAME = "fee_refund";
use \Stripe\ApiOperations\Update {
save as protected _save;
}
/**
* @return string The API URL for this Stripe refund.
*/
public function instanceUrl()
{
}
/**
* @param array|string|null $opts
*
* @return ApplicationFeeRefund The saved refund.
*/
public function save($opts = null)
{
}
}
abstract class WebhookSignature
{
const EXPECTED_SCHEME = "v1";
/**
* Verifies the signature header sent by Stripe. Throws a
* SignatureVerification exception if the verification fails for any
* reason.
*
* @param string $payload the payload sent by Stripe.
* @param string $header the contents of the signature header sent by
* Stripe.
* @param string $secret secret used to generate the signature.
* @param int $tolerance maximum difference allowed between the header's
* timestamp and the current time
* @throws \Stripe\Error\SignatureVerification if the verification fails.
* @return bool
*/
public static function verifyHeader($payload, $header, $secret, $tolerance = null)
{
}
}
/**
* Class Recipient
*
* @package Stripe
*
* @property string $id
* @property string $object
* @property mixed $active_account
* @property Collection $cards
* @property int $created
* @property string $default_card
* @property string $description
* @property string $email
* @property bool $livemode
* @property StripeObject $metadata
* @property string $migrated_to
* @property string $name
* @property string $rolled_back_from
* @property string $type
*/
class Recipient extends \Stripe\ApiResource
{
const OBJECT_NAME = "recipient";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* @param array|null $params
*
* @return Collection of the Recipient's Transfers
*/
public function transfers($params = null)
{
}
}
/**
* Class AccountLink
*
* @property string $object
* @property int $created
* @property int $expires_at
* @property string $url
*
* @package Stripe
*/
class AccountLink extends \Stripe\ApiResource
{
const OBJECT_NAME = "account_link";
use \Stripe\ApiOperations\Create;
}
/**
* Class Subscription
*
* @property string $id
* @property string $object
* @property float $application_fee_percent
* @property string $billing
* @property int $billing_cycle_anchor
* @property mixed $billing_thresholds
* @property bool $cancel_at_period_end
* @property int $canceled_at
* @property string $collection_method
* @property int $created
* @property int $current_period_end
* @property int $current_period_start
* @property string $customer
* @property int $days_until_due
* @property string $default_payment_method
* @property string $default_source
* @property array $default_tax_rates
* @property Discount $discount
* @property int $ended_at
* @property Collection $items
* @property string $latest_invoice
* @property boolean $livemode
* @property StripeObject $metadata
* @property string $pending_setup_intent
* @property Plan $plan
* @property int $quantity
* @property SubscriptionSchedule $schedule
* @property int $start
* @property int $start_date
* @property string $status
* @property float $tax_percent
* @property int $trial_end
* @property int $trial_start
*
* @package Stripe
*/
class Subscription extends \Stripe\ApiResource
{
const OBJECT_NAME = "subscription";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete {
delete as protected _delete;
}
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* These constants are possible representations of the status field.
*
* @link https://stripe.com/docs/api#subscription_object-status
*/
const STATUS_ACTIVE = 'active';
const STATUS_CANCELED = 'canceled';
const STATUS_PAST_DUE = 'past_due';
const STATUS_TRIALING = 'trialing';
const STATUS_UNPAID = 'unpaid';
const STATUS_INCOMPLETE = 'incomplete';
const STATUS_INCOMPLETE_EXPIRED = 'incomplete_expired';
public static function getSavedNestedResources()
{
}
/**
* @param array|null $params
*
* @return Subscription The deleted subscription.
*/
public function cancel($params = null, $opts = null)
{
}
/**
* @return Subscription The updated subscription.
*/
public function deleteDiscount()
{
}
}
/**
* Class TransferReversal
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $balance_transaction
* @property int $created
* @property string $currency
* @property string $destination_payment_refund
* @property StripeObject $metadata
* @property string $source_refund
* @property string $transfer
*
* @package Stripe
*/
class TransferReversal extends \Stripe\ApiResource
{
const OBJECT_NAME = "transfer_reversal";
use \Stripe\ApiOperations\Update {
save as protected _save;
}
/**
* @return string The API URL for this Stripe transfer reversal.
*/
public function instanceUrl()
{
}
/**
* @param array|string|null $opts
*
* @return TransferReversal The saved reversal.
*/
public function save($opts = null)
{
}
}
/**
* Class RequestTelemetry
*
* Tracks client request telemetry
* @package Stripe
*/
class RequestTelemetry
{
public $requestId;
public $requestDuration;
/**
* Initialize a new telemetry object.
*
* @param string $requestId The request's request ID.
* @param int $requestDuration The request's duration in milliseconds.
*/
public function __construct($requestId, $requestDuration)
{
}
}
/**
* Class Topup
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $balance_transaction
* @property int $created
* @property string $currency
* @property string $description
* @property int $expected_availability_date
* @property string $failure_code
* @property string $failure_message
* @property bool $livemode
* @property StripeObject $metadata
* @property mixed $source
* @property string $statement_descriptor
* @property string $status
* @property string $transfer_group
*
* @package Stripe
*/
class Topup extends \Stripe\ApiResource
{
const OBJECT_NAME = "topup";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of the status of the top-up.
* @link https://stripe.com/docs/api/topups/object#topup_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_FAILED = 'failed';
const STATUS_PENDING = 'pending';
const STATUS_REVERSED = 'reversed';
const STATUS_SUCCEEDED = 'succeeded';
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Topup The canceled topup.
*/
public function cancel($params = null, $options = null)
{
}
}
/**
* Class Discount
*
* @property string $object
* @property Coupon $coupon
* @property string $customer
* @property int $end
* @property int $start
* @property string $subscription
*
* @package Stripe
*/
class Discount extends \Stripe\StripeObject
{
const OBJECT_NAME = "discount";
}
/**
* Class OrderReturn
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $created
* @property string $currency
* @property OrderItem[] $items
* @property bool $livemode
* @property string $order
* @property string $refund
*
* @package Stripe
*/
class OrderReturn extends \Stripe\ApiResource
{
const OBJECT_NAME = "order_return";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
}
/**
* Class Card
*
* @property string $id
* @property string $object
* @property string $account
* @property string $address_city
* @property string $address_country
* @property string $address_line1
* @property string $address_line1_check
* @property string $address_line2
* @property string $address_state
* @property string $address_zip
* @property string $address_zip_check
* @property string[] $available_payout_methods
* @property string $brand
* @property string $country
* @property string $currency
* @property string $customer
* @property string $cvc_check
* @property bool $default_for_currency
* @property string $dynamic_last4
* @property int $exp_month
* @property int $exp_year
* @property string $fingerprint
* @property string $funding
* @property string $last4
* @property StripeObject $metadata
* @property string $name
* @property string $recipient
* @property string $tokenization_method
*
* @package Stripe
*/
class Card extends \Stripe\ApiResource
{
const OBJECT_NAME = "card";
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of the CVC check status.
* @link https://stripe.com/docs/api/cards/object#card_object-cvc_check
*/
const CVC_CHECK_FAIL = 'fail';
const CVC_CHECK_PASS = 'pass';
const CVC_CHECK_UNAVAILABLE = 'unavailable';
const CVC_CHECK_UNCHECKED = 'unchecked';
/**
* Possible string representations of the funding of the card.
* @link https://stripe.com/docs/api/cards/object#card_object-funding
*/
const FUNDING_CREDIT = 'credit';
const FUNDING_DEBIT = 'debit';
const FUNDING_PREPAID = 'prepaid';
const FUNDING_UNKNOWN = 'unknown';
/**
* Possible string representations of the tokenization method when using Apple Pay or Google Pay.
* @link https://stripe.com/docs/api/cards/object#card_object-tokenization_method
*/
const TOKENIZATION_METHOD_APPLE_PAY = 'apple_pay';
const TOKENIZATION_METHOD_GOOGLE_PAY = 'google_pay';
/**
* @return string The instance URL for this resource. It needs to be special
* cased because cards are nested resources that may belong to different
* top-level resources.
*/
public function instanceUrl()
{
}
/**
* @param array|string $_id
* @param array|string|null $_opts
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function retrieve($_id, $_opts = null)
{
}
/**
* @param string $_id
* @param array|null $_params
* @param array|string|null $_options
*
* @throws \Stripe\Error\InvalidRequest
*/
public static function update($_id, $_params = null, $_options = null)
{
}
}
/**
* Class SourceTransaction
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $created
* @property string $customer_data
* @property string $currency
* @property string $type
* @property mixed $ach_credit_transfer
*
* @package Stripe
*/
class SourceTransaction extends \Stripe\ApiResource
{
const OBJECT_NAME = "source_transaction";
}
/**
* Class Customer
*
* @property string $id
* @property string $object
* @property mixed $address
* @property int $balance
* @property string $created
* @property string $currency
* @property string $default_source
* @property bool $delinquent
* @property string $description
* @property Discount $discount
* @property string $email
* @property string $invoice_prefix
* @property mixed $invoice_settings
* @property bool $livemode
* @property StripeObject $metadata
* @property string $name
* @property string $phone
* @property string[] preferred_locales
* @property mixed $shipping
* @property Collection $sources
* @property Collection $subscriptions
* @property string $tax_exempt
* @property Collection $tax_ids
*
* @package Stripe
*/
class Customer extends \Stripe\ApiResource
{
const OBJECT_NAME = "customer";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\NestedResource;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of the customer's type of tax exemption.
* @link https://stripe.com/docs/api/customers/object#customer_object-tax_exempt
*/
const TAX_EXEMPT_NONE = 'none';
const TAX_EXEMPT_EXEMPT = 'exempt';
const TAX_EXEMPT_REVERSE = 'reverse';
public static function getSavedNestedResources()
{
}
const PATH_BALANCE_TRANSACTIONS = '/balance_transactions';
const PATH_SOURCES = '/sources';
const PATH_TAX_IDS = '/tax_ids';
/**
* @param array|null $params
*
* @return InvoiceItem The resulting invoice item.
*/
public function addInvoiceItem($params = null)
{
}
/**
* @param array|null $params
*
* @return array An array of the customer's Invoices.
*/
public function invoices($params = null)
{
}
/**
* @param array|null $params
*
* @return array An array of the customer's InvoiceItems.
*/
public function invoiceItems($params = null)
{
}
/**
* @param array|null $params
*
* @return array An array of the customer's Charges.
*/
public function charges($params = null)
{
}
/**
* @param array|null $params
*
* @return Subscription The updated subscription.
*/
public function updateSubscription($params = null)
{
}
/**
* @param array|null $params
*
* @return Subscription The cancelled subscription.
*/
public function cancelSubscription($params = null)
{
}
/**
* @return Customer The updated customer.
*/
public function deleteDiscount()
{
}
/**
* @param string|null $id The ID of the customer on which to create the source.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApiResource
*/
public static function createSource($id, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer to which the source belongs.
* @param string|null $sourceId The ID of the source to retrieve.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApiResource
*/
public static function retrieveSource($id, $sourceId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer to which the source belongs.
* @param string|null $sourceId The ID of the source to update.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApiResource
*/
public static function updateSource($id, $sourceId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer to which the source belongs.
* @param string|null $sourceId The ID of the source to delete.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApiResource
*/
public static function deleteSource($id, $sourceId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer on which to retrieve the sources.
* @param array|null $params
* @param array|string|null $opts
*
* @return Collection The list of sources.
*/
public static function allSources($id, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer on which to create the tax id.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApiResource
*/
public static function createTaxId($id, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer to which the tax id belongs.
* @param string|null $taxIdId The ID of the tax id to retrieve.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApiResource
*/
public static function retrieveTaxId($id, $taxIdId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer to which the tax id belongs.
* @param string|null $taxIdId The ID of the tax id to delete.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApiResource
*/
public static function deleteTaxId($id, $taxIdId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer on which to retrieve the tax ids.
* @param array|null $params
* @param array|string|null $opts
*
* @return Collection The list of tax ids.
*/
public static function allTaxIds($id, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer on which to create the balance transaction.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApiResource
*/
public static function createBalanceTransaction($id, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer to which the balance transaction belongs.
* @param string|null $balanceTransactionId The ID of the balance transaction to retrieve.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApiResource
*/
public static function retrieveBalanceTransaction($id, $balanceTransactionId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer on which to update the balance transaction.
* @param string|null $balanceTransactionId The ID of the balance transaction to update.
* @param array|null $params
* @param array|string|null $opts
*
*
* @return ApiResource
*/
public static function updateBalanceTransaction($id, $balanceTransactionId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the customer on which to retrieve the customer balance transactions.
* @param array|null $params
* @param array|string|null $opts
*
* @return Collection The list of customer balance transactions.
*/
public static function allBalanceTransactions($id, $params = null, $opts = null)
{
}
}
/**
* Class ApiResponse
*
* @package Stripe
*/
class ApiResponse
{
public $headers;
public $body;
public $json;
public $code;
/**
* @param string $body
* @param integer $code
* @param array|CaseInsensitiveArray|null $headers
* @param array|null $json
*
* @return obj An APIResponse
*/
public function __construct($body, $code, $headers, $json)
{
}
}
/**
* Class Dispute
*
* @property string $id
* @property string $object
* @property int $amount
* @property BalanceTransaction[] $balance_transactions
* @property string $charge
* @property int $created
* @property string $currency
* @property mixed $evidence
* @property mixed $evidence_details
* @property bool $is_charge_refundable
* @property bool $livemode
* @property StripeObject $metadata
* @property string $reason
* @property string $status
*
* @package Stripe
*/
class Dispute extends \Stripe\ApiResource
{
const OBJECT_NAME = "dispute";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of dispute reasons.
* @link https://stripe.com/docs/api#dispute_object
*/
const REASON_BANK_CANNOT_PROCESS = 'bank_cannot_process';
const REASON_CHECK_RETURNED = 'check_returned';
const REASON_CREDIT_NOT_PROCESSED = 'credit_not_processed';
const REASON_CUSTOMER_INITIATED = 'customer_initiated';
const REASON_DEBIT_NOT_AUTHORIZED = 'debit_not_authorized';
const REASON_DUPLICATE = 'duplicate';
const REASON_FRAUDULENT = 'fraudulent';
const REASON_GENERAL = 'general';
const REASON_INCORRECT_ACCOUNT_DETAILS = 'incorrect_account_details';
const REASON_INSUFFICIENT_FUNDS = 'insufficient_funds';
const REASON_PRODUCT_NOT_RECEIVED = 'product_not_received';
const REASON_PRODUCT_UNACCEPTABLE = 'product_unacceptable';
const REASON_SUBSCRIPTION_CANCELED = 'subscription_canceled';
const REASON_UNRECOGNIZED = 'unrecognized';
/**
* Possible string representations of dispute statuses.
* @link https://stripe.com/docs/api#dispute_object
*/
const STATUS_CHARGE_REFUNDED = 'charge_refunded';
const STATUS_LOST = 'lost';
const STATUS_NEEDS_RESPONSE = 'needs_response';
const STATUS_UNDER_REVIEW = 'under_review';
const STATUS_WARNING_CLOSED = 'warning_closed';
const STATUS_WARNING_NEEDS_RESPONSE = 'warning_needs_response';
const STATUS_WARNING_UNDER_REVIEW = 'warning_under_review';
const STATUS_WON = 'won';
/**
* @param array|string|null $options
*
* @return Dispute The closed dispute.
*/
public function close($options = null)
{
}
}
/**
* Class ApplicationFee
*
* @property string $id
* @property string $object
* @property string $account
* @property int $amount
* @property int $amount_refunded
* @property string $application
* @property string $balance_transaction
* @property string $charge
* @property int $created
* @property string $currency
* @property bool $livemode
* @property string $originating_transaction
* @property bool $refunded
* @property Collection $refunds
*
* @package Stripe
*/
class ApplicationFee extends \Stripe\ApiResource
{
const OBJECT_NAME = "application_fee";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\NestedResource;
use \Stripe\ApiOperations\Retrieve;
const PATH_REFUNDS = '/refunds';
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return ApplicationFee The refunded application fee.
*/
public function refund($params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the application fee on which to create the refund.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApplicationFeeRefund
*/
public static function createRefund($id, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the application fee to which the refund belongs.
* @param array|null $refundId The ID of the refund to retrieve.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApplicationFeeRefund
*/
public static function retrieveRefund($id, $refundId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the application fee to which the refund belongs.
* @param array|null $refundId The ID of the refund to update.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApplicationFeeRefund
*/
public static function updateRefund($id, $refundId, $params = null, $opts = null)
{
}
/**
* @param string|null $id The ID of the application fee on which to retrieve the refunds.
* @param array|null $params
* @param array|string|null $opts
*
* @return Collection The list of refunds.
*/
public static function allRefunds($id, $params = null, $opts = null)
{
}
}
/**
* Class Account
*
* @property string $id
* @property string $object
* @property mixed $business_profile
* @property string $business_type
* @property mixed $capabilities
* @property bool $charges_enabled
* @property mixed $company
* @property string $country
* @property int $created
* @property string $default_currency
* @property bool $details_submitted
* @property string $email
* @property Collection $external_accounts
* @property mixed $individual
* @property StripeObject $metadata
* @property bool $payouts_enabled
* @property mixed $requirements
* @property mixed $settings
* @property mixed $tos_acceptance
* @property string $type
*
* @package Stripe
*/
class Account extends \Stripe\ApiResource
{
const OBJECT_NAME = "account";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\NestedResource;
use \Stripe\ApiOperations\Retrieve {
retrieve as protected _retrieve;
}
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of an account's business type.
* @link https://stripe.com/docs/api/accounts/object#account_object-business_type
*/
const BUSINESS_TYPE_COMPANY = 'company';
const BUSINESS_TYPE_INDIVIDUAL = 'individual';
/**
* Possible string representations of an account's capabilities.
* @link https://stripe.com/docs/api/accounts/object#account_object-capabilities
*/
const CAPABILITY_CARD_PAYMENTS = 'card_payments';
const CAPABILITY_LEGACY_PAYMENTS = 'legacy_payments';
const CAPABILITY_PLATFORM_PAYMENTS = 'platform_payments';
/**
* Possible string representations of an account's capability status.
* @link https://stripe.com/docs/api/accounts/object#account_object-capabilities
*/
const CAPABILITY_STATUS_ACTIVE = 'active';
const CAPABILITY_STATUS_INACTIVE = 'inactive';
const CAPABILITY_STATUS_PENDING = 'pending';
/**
* Possible string representations of an account's type.
* @link https://stripe.com/docs/api/accounts/object#account_object-type
*/
const TYPE_CUSTOM = 'custom';
const TYPE_EXPRESS = 'express';
const TYPE_STANDARD = 'standard';
public static function getSavedNestedResources()
{
}
const PATH_CAPABILITIES = '/capabilities';
const PATH_EXTERNAL_ACCOUNTS = '/external_accounts';
const PATH_LOGIN_LINKS = '/login_links';
const PATH_PERSONS = '/persons';
public function instanceUrl()
{
}
/**
* @param array|string|null $id The ID of the account to retrieve, or an
* options array containing an `id` key.
* @param array|string|null $opts
*
* @return Account
*/
public static function retrieve($id = null, $opts = null)
{
}
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return Account The rejected account.
*/
public function reject($params = null, $opts = null)
{
}
/**
* @param array|null $clientId
* @param array|string|null $opts
*
* @return StripeObject Object containing the response from the API.
*/
public function deauthorize($clientId = null, $opts = null)
{
}
/*
* Capabilities methods
* We can not add the capabilities() method today as the Account object already has a
* capabilities property which is a hash and not the sub-list of capabilities.
*/
/**
* @param string $id The ID of the account to which the capability belongs.
* @param string $capabilityId The ID of the capability to retrieve.
* @param array|null $params
* @param array|string|null $opts
*
* @return Capability
*/
public static function retrieveCapability($id, $capabilityId, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account to which the capability belongs.
* @param string $capabilityId The ID of the capability to update.
* @param array|null $params
* @param array|string|null $opts
*
* @return Capability
*/
public static function updateCapability($id, $capabilityId, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account on which to retrieve the capabilities.
* @param array|null $params
* @param array|string|null $opts
*
* @return Collection The list of capabilities.
*/
public static function allCapabilities($id, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account on which to create the external account.
* @param array|null $params
* @param array|string|null $opts
*
* @return BankAccount|Card
*/
public static function createExternalAccount($id, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account to which the external account belongs.
* @param string $externalAccountId The ID of the external account to retrieve.
* @param array|null $params
* @param array|string|null $opts
*
* @return BankAccount|Card
*/
public static function retrieveExternalAccount($id, $externalAccountId, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account to which the external account belongs.
* @param string $externalAccountId The ID of the external account to update.
* @param array|null $params
* @param array|string|null $opts
*
* @return BankAccount|Card
*/
public static function updateExternalAccount($id, $externalAccountId, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account to which the external account belongs.
* @param string $externalAccountId The ID of the external account to delete.
* @param array|null $params
* @param array|string|null $opts
*
* @return BankAccount|Card
*/
public static function deleteExternalAccount($id, $externalAccountId, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account on which to retrieve the external accounts.
* @param array|null $params
* @param array|string|null $opts
*
* @return Collection The list of external accounts (BankAccount or Card).
*/
public static function allExternalAccounts($id, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account on which to create the login link.
* @param array|null $params
* @param array|string|null $opts
*
* @return LoginLink
*/
public static function createLoginLink($id, $params = null, $opts = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Collection The list of persons.
*/
public function persons($params = null, $options = null)
{
}
/**
* @param string $id The ID of the account on which to create the person.
* @param array|null $params
* @param array|string|null $opts
*
* @return Person
*/
public static function createPerson($id, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account to which the person belongs.
* @param string $personId The ID of the person to retrieve.
* @param array|null $params
* @param array|string|null $opts
*
* @return Person
*/
public static function retrievePerson($id, $personId, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account to which the person belongs.
* @param string $personId The ID of the person to update.
* @param array|null $params
* @param array|string|null $opts
*
* @return Person
*/
public static function updatePerson($id, $personId, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account to which the person belongs.
* @param string $personId The ID of the person to delete.
* @param array|null $params
* @param array|string|null $opts
*
* @return Person
*/
public static function deletePerson($id, $personId, $params = null, $opts = null)
{
}
/**
* @param string $id The ID of the account on which to retrieve the persons.
* @param array|null $params
* @param array|string|null $opts
*
* @return Collection The list of persons.
*/
public static function allPersons($id, $params = null, $opts = null)
{
}
public function serializeParameters($force = false)
{
}
}
/**
* Class WebhookEndpoint
*
* @property string $id
* @property string $object
* @property int $created
* @property string[] $enabled_events
* @property bool $livemode
* @property string $secret
* @property string $status
* @property string $url
*
* @package Stripe
*/
class WebhookEndpoint extends \Stripe\ApiResource
{
const OBJECT_NAME = "webhook_endpoint";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
}
namespace Stripe\Checkout {
/**
* Class Session
*
* @property string $id
* @property string $object
* @property string $cancel_url
* @property string $client_reference_id
* @property string $customer
* @property string $customer_email
* @property mixed $display_items
* @property bool $livemode
* @property string $payment_intent
* @property string[] $payment_method_types
* @property string $submit_type
* @property string $subscription
* @property string $success_url
*
* @package Stripe
*/
class Session extends \Stripe\ApiResource
{
const OBJECT_NAME = "checkout.session";
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
/**
* Possible string representations of submit type.
* @link https://stripe.com/docs/api/checkout/sessions/create#create_checkout_session-submit_type
*/
const SUBMIT_TYPE_AUTO = 'auto';
const SUBMIT_TYPE_BOOK = 'book';
const SUBMIT_TYPE_DONATE = 'donate';
const SUBMIT_TYPE_PAY = 'pay';
}
}
namespace Stripe {
/**
* Class EphemeralKey
*
* @property string $id
* @property string $object
* @property int $created
* @property int $expires
* @property bool $livemode
* @property string $secret
* @property array $associated_objects
*
* @package Stripe
*/
class EphemeralKey extends \Stripe\ApiResource
{
const OBJECT_NAME = "ephemeral_key";
use \Stripe\ApiOperations\Create {
create as protected _create;
}
use \Stripe\ApiOperations\Delete;
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return EphemeralKey The created key.
*/
public static function create($params = null, $opts = null)
{
}
}
/**
* Class Token
*
* @property string $id
* @property string $object
* @property BankAccount $bank_account
* @property Card $card
* @property string $client_ip
* @property int $created
* @property bool $livemode
* @property string $type
* @property bool $used
*
* @package Stripe
*/
class Token extends \Stripe\ApiResource
{
const OBJECT_NAME = "token";
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
/**
* Possible string representations of the token type.
* @link https://stripe.com/docs/api/tokens/object#token_object-type
*/
const TYPE_ACCOUNT = 'account';
const TYPE_BANK_ACCOUNT = 'bank_account';
const TYPE_CARD = 'card';
const TYPE_PII = 'pii';
}
/**
* Class Payout
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $arrival_date
* @property bool $automatic
* @property string $balance_transaction
* @property int $created
* @property string $currency
* @property string $description
* @property string $destination
* @property string $failure_balance_transaction
* @property string $failure_code
* @property string $failure_message
* @property bool $livemode
* @property StripeObject $metadata
* @property string $method
* @property string $source_type
* @property string $statement_descriptor
* @property string $status
* @property string $type
*
* @package Stripe
*/
class Payout extends \Stripe\ApiResource
{
const OBJECT_NAME = "payout";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* Types of payout failure codes.
* @link https://stripe.com/docs/api#payout_failures
*/
const FAILURE_ACCOUNT_CLOSED = 'account_closed';
const FAILURE_ACCOUNT_FROZEN = 'account_frozen';
const FAILURE_BANK_ACCOUNT_RESTRICTED = 'bank_account_restricted';
const FAILURE_BANK_OWNERSHIP_CHANGED = 'bank_ownership_changed';
const FAILURE_COULD_NOT_PROCESS = 'could_not_process';
const FAILURE_DEBIT_NOT_AUTHORIZED = 'debit_not_authorized';
const FAILURE_DECLINED = 'declined';
const FAILURE_INCORRECT_ACCOUNT_HOLDER_NAME = 'incorrect_account_holder_name';
const FAILURE_INSUFFICIENT_FUNDS = 'insufficient_funds';
const FAILURE_INVALID_ACCOUNT_NUMBER = 'invalid_account_number';
const FAILURE_INVALID_CURRENCY = 'invalid_currency';
const FAILURE_NO_ACCOUNT = 'no_account';
const FAILURE_UNSUPPORTED_CARD = 'unsupported_card';
/**
* Possible string representations of the payout methods.
* @link https://stripe.com/docs/api/payouts/object#payout_object-method
*/
const METHOD_STANDARD = 'standard';
const METHOD_INSTANT = 'instant';
/**
* Possible string representations of the status of the payout.
* @link https://stripe.com/docs/api/payouts/object#payout_object-status
*/
const STATUS_CANCELED = 'canceled';
const STATUS_IN_TRANSIT = 'in_transit';
const STATUS_FAILED = 'failed';
const STATUS_PAID = 'paid';
const STATUS_PENDING = 'pending';
/**
* Possible string representations of the type of payout.
* @link https://stripe.com/docs/api/payouts/object#payout_object-type
*/
const TYPE_BANK_ACCOUNT = 'bank_account';
const TYPE_CARD = 'card';
/**
* @return Payout The canceled payout.
*/
public function cancel()
{
}
}
/**
* Class RecipientTransfer
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $amount_reversed
* @property string $balance_transaction
* @property string $bank_account
* @property string $card
* @property int $created
* @property string $currency
* @property int $date
* @property string $description
* @property string $destination
* @property string $failure_code
* @property string $failure_message
* @property bool $livemode
* @property StripeObject $metadata
* @property string $method
* @property string $recipient
* @property mixed $reversals
* @property bool $reversed
* @property string $source_type
* @property string $statement_descriptor
* @property string $status
* @property string $type
*
* @package Stripe
*/
class RecipientTransfer extends \Stripe\ApiResource
{
const OBJECT_NAME = "recipient_transfer";
}
/**
* Class Order
*
* @property string $id
* @property string $object
* @property int $amount
* @property int $amount_returned
* @property string $application
* @property int $application_fee
* @property string $charge
* @property int $created
* @property string $currency
* @property string $customer
* @property string $email
* @property string $external_coupon_code
* @property OrderItem[] $items
* @property bool $livemode
* @property StripeObject $metadata
* @property Collection $returns
* @property string $selected_shipping_method
* @property mixed $shipping
* @property array $shipping_methods
* @property string $status
* @property mixed $status_transitions
* @property int $updated
* @property string $upstream_id
*
* @package Stripe
*/
class Order extends \Stripe\ApiResource
{
const OBJECT_NAME = "order";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* @return Order The paid order.
*/
public function pay($params = null, $opts = null)
{
}
/**
* @return OrderReturn The newly created return.
*/
public function returnOrder($params = null, $opts = null)
{
}
}
}
namespace Stripe\Sigma {
/**
* Class Authorization
*
* @property string $id
* @property string $object
* @property int $created
* @property int $data_load_time
* @property string $error
* @property \Stripe\FileUpload $file
* @property bool $livemode
* @property int $result_available_until
* @property string $sql
* @property string $status
* @property string $title
*
* @package Stripe\Sigma
*/
class ScheduledQueryRun extends \Stripe\ApiResource
{
const OBJECT_NAME = "scheduled_query_run";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
public static function classUrl()
{
}
}
}
namespace Stripe {
/**
* Class SingletonApiResource
*
* @package Stripe
*/
abstract class SingletonApiResource extends \Stripe\ApiResource
{
protected static function _singletonRetrieve($options = null)
{
}
/**
* @return string The endpoint associated with this singleton class.
*/
public static function classUrl()
{
}
/**
* @return string The endpoint associated with this singleton API resource.
*/
public function instanceUrl()
{
}
}
/**
* Class Balance
*
* @property string $object
* @property array $available
* @property array $connect_reserved
* @property bool $livemode
* @property array $pending
*
* @package Stripe
*/
class Balance extends \Stripe\SingletonApiResource
{
const OBJECT_NAME = "balance";
/**
* @param array|string|null $opts
*
* @return Balance
*/
public static function retrieve($opts = null)
{
}
}
/**
* Class Collection
*
* @property string $object
* @property string $url
* @property bool $has_more
* @property mixed $data
*
* @package Stripe
*/
class Collection extends \Stripe\StripeObject implements \IteratorAggregate
{
const OBJECT_NAME = "list";
use \Stripe\ApiOperations\Request;
protected $_requestParams = [];
/**
* @return string The base URL for the given class.
*/
public static function baseUrl()
{
}
public function setRequestParams($params)
{
}
public function all($params = null, $opts = null)
{
}
public function create($params = null, $opts = null)
{
}
public function retrieve($id, $params = null, $opts = null)
{
}
/**
* @return \ArrayIterator An iterator that can be used to iterate
* across objects in the current page.
*/
public function getIterator()
{
}
/**
* @return Util\AutoPagingIterator An iterator that can be used to iterate
* across all objects across all pages. As page boundaries are
* encountered, the next page will be fetched automatically for
* continued iteration.
*/
public function autoPagingIterator()
{
}
}
/**
* Class SubscriptionItem
*
* @property string $id
* @property string $object
* @property mixed $billing_thresholds
* @property int $created
* @property StripeObject $metadata
* @property Plan $plan
* @property int $quantity
* @property string $subscription
* @property array $tax_rates
*
* @package Stripe
*/
class SubscriptionItem extends \Stripe\ApiResource
{
const OBJECT_NAME = "subscription_item";
const PATH_USAGE_RECORDS = '/usage_records';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\NestedResource;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* @param string|null $id The ID of the subscription item on which to create the usage record.
* @param array|null $params
* @param array|string|null $opts
*
* @return ApiResource
*/
public static function createUsageRecord($id, $params = null, $opts = null)
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return Collection The list of usage record summaries.
*/
public function usageRecordSummaries($params = null, $options = null)
{
}
}
/**
* Class CreditNote
*
* @property string $id
* @property string $object
* @property int $amount
* @property string $customer_balance_transaction
* @property int $created
* @property string $currency
* @property string $customer
* @property string $invoice
* @property bool $livemode
* @property string $memo
* @property StripeObject $metadata
* @property string $number
* @property string $pdf
* @property string $reason
* @property string $refund
* @property string $status
* @property string $type
*
* @package Stripe
*/
class CreditNote extends \Stripe\ApiResource
{
const OBJECT_NAME = "credit_note";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
/**
* Possible string representations of the credit note reason.
* @link https://stripe.com/docs/api/credit_notes/object#credit_note_object-reason
*/
const REASON_DUPLICATE = 'duplicate';
const REASON_FRAUDULENT = 'fraudulent';
const REASON_ORDER_CHANGE = 'order_change';
const REASON_PRODUCT_UNSATISFACTORY = 'product_unsatisfactory';
/**
* Possible string representations of the credit note status.
* @link https://stripe.com/docs/api/credit_notes/object#credit_note_object-status
*/
const STATUS_ISSUED = 'issued';
const STATUS_VOID = 'void';
/**
* Possible string representations of the credit note type.
* @link https://stripe.com/docs/api/credit_notes/object#credit_note_object-status
*/
const TYPE_POST_PAYMENT = 'post_payment';
const TYPE_PRE_PAYMENT = 'pre_payment';
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return CreditNote The voided credit note.
*/
public function voidCreditNote($params = null, $opts = null)
{
}
}
/**
* Class SKU
*
* @property string $id
* @property string $object
* @property bool $active
* @property mixed $attributes
* @property int $created
* @property string $currency
* @property string $image
* @property mixed $inventory
* @property bool $livemode
* @property StripeObject $metadata
* @property mixed $package_dimensions
* @property int $price
* @property string $product
* @property int $updated
*
* @package Stripe
*/
class SKU extends \Stripe\ApiResource
{
const OBJECT_NAME = "sku";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
}
/**
* Class AlipayAccount
*
* @package Stripe
*
* @deprecated Alipay accounts are deprecated. Please use the sources API instead.
* @link https://stripe.com/docs/sources/alipay
*/
class AlipayAccount extends \Stripe\ApiResource
{
const OBJECT_NAME = "alipay_account";
use \Stripe\ApiOperations\Delete;
use \Stripe\ApiOperations\Update;
/**
* @return string The instance URL for this resource. It needs to be special
* cased because it doesn't fit into the standard resource pattern.
*/
public function instanceUrl()
{
}
/**
* @param array|string $_id
* @param array|string|null $_opts
*
* @throws \Stripe\Error\InvalidRequest
*
* @deprecated Alipay accounts are deprecated. Please use the sources API instead.
* @link https://stripe.com/docs/sources/alipay
*/
public static function retrieve($_id, $_opts = null)
{
}
/**
* @param string $_id
* @param array|null $_params
* @param array|string|null $_options
*
* @throws \Stripe\Error\InvalidRequest
*
* @deprecated Alipay accounts are deprecated. Please use the sources API instead.
* @link https://stripe.com/docs/sources/alipay
*/
public static function update($_id, $_params = null, $_options = null)
{
}
}
/**
* Class File
*
* @property string $id
* @property string $object
* @property int $created
* @property string $filename
* @property Collection $links
* @property string $purpose
* @property int $size
* @property string $title
* @property string $type
* @property string $url
*
* @package Stripe
*/
class File extends \Stripe\ApiResource
{
// This resource can have two different object names. In latter API
// versions, only `file` is used, but since stripe-php may be used with
// any API version, we need to support deserializing the older
// `file_upload` object into the same class.
const OBJECT_NAME = "file";
const OBJECT_NAME_ALT = "file_upload";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create {
create as protected _create;
}
use \Stripe\ApiOperations\Retrieve;
public static function classUrl()
{
}
/**
* @param array|null $params
* @param array|string|null $options
*
* @return \Stripe\File The created resource.
*/
public static function create($params = null, $options = null)
{
}
}
/**
* Class SubscriptionSchedule
*
* @property string $id
* @property string $object
* @property string $billing
* @property mixed $billing_thresholds
* @property int $canceled_at
* @property int $completed_at
* @property int $created
* @property mixed $current_phase
* @property string $customer
* @property mixed $invoice_settings
* @property boolean $livemode
* @property StripeObject $metadata
* @property mixed $phases
* @property int $released_at
* @property string $released_subscription
* @property string $renewal_behavior
* @property mixed $renewal_interval
* @property string $revision
* @property string $status
* @property string $subscription
*
* @package Stripe
*/
class SubscriptionSchedule extends \Stripe\ApiResource
{
const OBJECT_NAME = "subscription_schedule";
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Create;
use \Stripe\ApiOperations\Retrieve;
use \Stripe\ApiOperations\Update;
use \Stripe\ApiOperations\NestedResource;
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return SubscriptionSchedule The canceled subscription schedule.
*/
public function cancel($params = null, $opts = null)
{
}
/**
* @param array|null $params
* @param array|string|null $opts
*
* @return SubscriptionSchedule The released subscription schedule.
*/
public function release($params = null, $opts = null)
{
}
}
/**
* Class LoginLink
*
* @property string $object
* @property int $created
* @property string $url
*
* @package Stripe
*/
class LoginLink extends \Stripe\ApiResource
{
const OBJECT_NAME = "login_link";
}
/**
* Class Event
*
* @property string $id
* @property string $object
* @property string $account
* @property string $api_version
* @property int $created
* @property mixed $data
* @property bool $livemode
* @property int $pending_webhooks
* @property mixed $request
* @property string $type
*
* @package Stripe
*/
class Event extends \Stripe\ApiResource
{
const OBJECT_NAME = "event";
/**
* Possible string representations of event types.
* @link https://stripe.com/docs/api#event_types
*/
const ACCOUNT_UPDATED = 'account.updated';
const ACCOUNT_APPLICATION_AUTHORIZED = 'account.application.authorized';
const ACCOUNT_APPLICATION_DEAUTHORIZED = 'account.application.deauthorized';
const ACCOUNT_EXTERNAL_ACCOUNT_CREATED = 'account.external_account.created';
const ACCOUNT_EXTERNAL_ACCOUNT_DELETED = 'account.external_account.deleted';
const ACCOUNT_EXTERNAL_ACCOUNT_UPDATED = 'account.external_account.updated';
const APPLICATION_FEE_CREATED = 'application_fee.created';
const APPLICATION_FEE_REFUNDED = 'application_fee.refunded';
const APPLICATION_FEE_REFUND_UPDATED = 'application_fee.refund.updated';
const BALANCE_AVAILABLE = 'balance.available';
const CHARGE_CAPTURED = 'charge.captured';
const CHARGE_EXPIRED = 'charge.expired';
const CHARGE_FAILED = 'charge.failed';
const CHARGE_PENDING = 'charge.pending';
const CHARGE_REFUNDED = 'charge.refunded';
const CHARGE_SUCCEEDED = 'charge.succeeded';
const CHARGE_UPDATED = 'charge.updated';
const CHARGE_DISPUTE_CLOSED = 'charge.dispute.closed';
const CHARGE_DISPUTE_CREATED = 'charge.dispute.created';
const CHARGE_DISPUTE_FUNDS_REINSTATED = 'charge.dispute.funds_reinstated';
const CHARGE_DISPUTE_FUNDS_WITHDRAWN = 'charge.dispute.funds_withdrawn';
const CHARGE_DISPUTE_UPDATED = 'charge.dispute.updated';
const CHARGE_REFUND_UPDATED = 'charge.refund.updated';
const CHECKOUT_SESSION_COMPLETED = 'checkout.session.completed';
const COUPON_CREATED = 'coupon.created';
const COUPON_DELETED = 'coupon.deleted';
const COUPON_UPDATED = 'coupon.updated';
const CREDIT_NOTE_CREATED = 'credit_note.created';
const CREDIT_NOTE_UPDATED = 'credit_note.updated';
const CREDIT_NOTE_VOIDED = 'credit_note.voided';
const CUSTOMER_CREATED = 'customer.created';
const CUSTOMER_DELETED = 'customer.deleted';
const CUSTOMER_UPDATED = 'customer.updated';
const CUSTOMER_DISCOUNT_CREATED = 'customer.discount.created';
const CUSTOMER_DISCOUNT_DELETED = 'customer.discount.deleted';
const CUSTOMER_DISCOUNT_UPDATED = 'customer.discount.updated';
const CUSTOMER_SOURCE_CREATED = 'customer.source.created';
const CUSTOMER_SOURCE_DELETED = 'customer.source.deleted';
const CUSTOMER_SOURCE_EXPIRING = 'customer.source.expiring';
const CUSTOMER_SOURCE_UPDATED = 'customer.source.updated';
const CUSTOMER_SUBSCRIPTION_CREATED = 'customer.subscription.created';
const CUSTOMER_SUBSCRIPTION_DELETED = 'customer.subscription.deleted';
const CUSTOMER_SUBSCRIPTION_TRIAL_WILL_END = 'customer.subscription.trial_will_end';
const CUSTOMER_SUBSCRIPTION_UPDATED = 'customer.subscription.updated';
const FILE_CREATED = 'file.created';
const INVOICE_CREATED = 'invoice.created';
const INVOICE_DELETED = 'invoice.deleted';
const INVOICE_FINALIZED = 'invoice.finalized';
const INVOICE_MARKED_UNCOLLECTIBLE = 'invoice.marked_uncollectible';
const INVOICE_PAYMENT_ACTION_REQUIRED = 'invoice.payment_action_required';
const INVOICE_PAYMENT_FAILED = 'invoice.payment_failed';
const INVOICE_PAYMENT_SUCCEEDED = 'invoice.payment_succeeded';
const INVOICE_SENT = 'invoice.sent';
const INVOICE_UPCOMING = 'invoice.upcoming';
const INVOICE_UPDATED = 'invoice.updated';
const INVOICE_VOIDED = 'invoice.voided';
const INVOICEITEM_CREATED = 'invoiceitem.created';
const INVOICEITEM_DELETED = 'invoiceitem.deleted';
const INVOICEITEM_UPDATED = 'invoiceitem.updated';
const ISSUER_FRAUD_RECORD_CREATED = 'issuer_fraud_record.created';
const ISSUING_AUTHORIZATION_CREATED = 'issuing_authorization.created';
const ISSUING_AUTHORIZATION_REQUEST = 'issuing_authorization.request';
const ISSUING_AUTHORIZATION_UPDATED = 'issuing_authorization.updated';
const ISSUING_CARD_CREATED = 'issuing_card.created';
const ISSUING_CARD_UPDATED = 'issuing_card.updated';
const ISSUING_CARDHOLDER_CREATED = 'issuing_cardholder.created';
const ISSUING_CARDHOLDER_UPDATED = 'issuing_cardholder.updated';
const ISSUING_DISPUTE_CREATED = 'issuing_dispute.created';
const ISSUING_DISPUTE_UPDATED = 'issuing_dispute.updated';
const ISSUING_TRANSACTION_CREATED = 'issuing_transaction.created';
const ISSUING_TRANSACTION_UPDATED = 'issuing_transaction.updated';
const ORDER_CREATED = 'order.created';
const ORDER_PAYMENT_FAILED = 'order.payment_failed';
const ORDER_PAYMENT_SUCCEEDED = 'order.payment_succeeded';
const ORDER_UPDATED = 'order.updated';
const ORDER_RETURN_CREATED = 'order_return.created';
const PAYMENT_INTENT_AMOUNT_CAPTURABLE_UPDATED = 'payment_intent.amount_capturable_updated';
const PAYMENT_INTENT_CREATED = 'payment_intent.created';
const PAYMENT_INTENT_PAYMENT_FAILED = 'payment_intent.payment_failed';
const PAYMENT_INTENT_SUCCEEDED = 'payment_intent.succeeded';
const PAYMENT_METHOD_ATTACHED = 'payment_method.attached';
const PAYMENT_METHOD_CARD_AUTOMATICALLY_UPDATED = 'payment_method.card_automatically_updated';
const PAYMENT_METHOD_DETACHED = 'payment_method.detached';
const PAYMENT_METHOD_UPDATED = 'payment_method.updated';
const PAYOUT_CANCELED = 'payout.canceled';
const PAYOUT_CREATED = 'payout.created';
const PAYOUT_FAILED = 'payout.failed';
const PAYOUT_PAID = 'payout.paid';
const PAYOUT_UPDATED = 'payout.updated';
const PERSON_CREATED = 'person.created';
const PERSON_DELETED = 'person.deleted';
const PERSON_UPDATED = 'person.updated';
const PING = 'ping';
const PLAN_CREATED = 'plan.created';
const PLAN_DELETED = 'plan.deleted';
const PLAN_UPDATED = 'plan.updated';
const PRODUCT_CREATED = 'product.created';
const PRODUCT_DELETED = 'product.deleted';
const PRODUCT_UPDATED = 'product.updated';
const RECIPIENT_CREATED = 'recipient.created';
const RECIPIENT_DELETED = 'recipient.deleted';
const RECIPIENT_UPDATED = 'recipient.updated';
const REPORTING_REPORT_RUN_FAILED = 'reporting.report_run.failed';
const REPORTING_REPORT_RUN_SUCCEEDED = 'reporting.report_run.succeeded';
const REPORTING_REPORT_TYPE_UPDATED = 'reporting.report_type.updated';
const REVIEW_CLOSED = 'review.closed';
const REVIEW_OPENED = 'review.opened';
const SIGMA_SCHEDULED_QUERY_RUN_CREATED = 'sigma.scheduled_query_run.created';
const SKU_CREATED = 'sku.created';
const SKU_DELETED = 'sku.deleted';
const SKU_UPDATED = 'sku.updated';
const SOURCE_CANCELED = 'source.canceled';
const SOURCE_CHARGEABLE = 'source.chargeable';
const SOURCE_FAILED = 'source.failed';
const SOURCE_MANDATE_NOTIFICATION = 'source.mandate_notification';
const SOURCE_REFUND_ATTRIBUTES_REQUIRED = 'source.refund_attributes_required';
const SOURCE_TRANSACTION_CREATED = 'source.transaction.created';
const SOURCE_TRANSACTION_UPDATED = 'source.transaction.updated';
const SUBSCRIPTION_SCHEDULE_ABORTED = 'subscription_schedule.aborted';
const SUBSCRIPTION_SCHEDULE_CANCELED = 'subscription_schedule.canceled';
const SUBSCRIPTION_SCHEDULE_COMPLETED = 'subscription_schedule.completed';
const SUBSCRIPTION_SCHEDULE_CREATED = 'subscription_schedule.created';
const SUBSCRIPTION_SCHEDULE_EXPIRING = 'subscription_schedule.expiring';
const SUBSCRIPTION_SCHEDULE_RELEASED = 'subscription_schedule.released';
const SUBSCRIPTION_SCHEDULE_UPDATED = 'subscription_schedule.updated';
const TAX_RATE_CREATED = 'tax_rate.created';
const TAX_RATE_UPDATED = 'tax_rate.updated';
const TOPUP_CANCELED = 'topup.canceled';
const TOPUP_CREATED = 'topup.created';
const TOPUP_FAILED = 'topup.failed';
const TOPUP_REVERSED = 'topup.reversed';
const TOPUP_SUCCEEDED = 'topup.succeeded';
const TRANSFER_CREATED = 'transfer.created';
const TRANSFER_REVERSED = 'transfer.reversed';
const TRANSFER_UPDATED = 'transfer.updated';
use \Stripe\ApiOperations\All;
use \Stripe\ApiOperations\Retrieve;
}
/**
* Class BitcoinTransaction
*
* @package Stripe
*/
class BitcoinTransaction extends \Stripe\ApiResource
{
const OBJECT_NAME = "bitcoin_transaction";
}
}
/*
* @ https://EasyToYou.eu - IonCube v10 Decoder Online
* @ PHP 5.6
* @ Decoder version: 1.0.4
* @ Release: 02/06/2020
*
* @ ZendGuard Decoder PHP 5.6
*/
namespace Composer\Autoload {
function includeFile($file)
{
}
}
namespace React\Promise {
function resolve($promiseOrValue = null)
{
}
function reject($promiseOrValue = null)
{
}
function all($promisesOrValues)
{
}
function race($promisesOrValues)
{
}
function any($promisesOrValues)
{
}
function some($promisesOrValues, $howMany)
{
}
function map($promisesOrValues, callable $mapFunc)
{
}
function reduce($promisesOrValues, callable $reduceFunc, $initialValue = null)
{
}
// Internal functions
function _checkTypehint(callable $callback, $object)
{
}
}
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
namespace Symfony\Component\Console\Tests\Command {
// In order to get an unbound closure, we should create it outside a class
// scope.
function createClosure()
{
}
}
namespace GuzzleHttp\Promise {
/**
* Get the global task queue used for promise resolution.
*
* This task queue MUST be run in an event loop in order for promises to be
* settled asynchronously. It will be automatically run when synchronously
* waiting on a promise.
*
* <code>
* while ($eventLoop->isRunning()) {
* GuzzleHttp\Promise\queue()->run();
* }
* </code>
*
* @param TaskQueueInterface $assign Optionally specify a new queue instance.
*
* @return TaskQueueInterface
*/
function queue(\GuzzleHttp\Promise\TaskQueueInterface $assign = null)
{
}
/**
* Adds a function to run in the task queue when it is next `run()` and returns
* a promise that is fulfilled or rejected with the result.
*
* @param callable $task Task function to run.
*
* @return PromiseInterface
*/
function task(callable $task)
{
}
/**
* Creates a promise for a value if the value is not a promise.
*
* @param mixed $value Promise or value.
*
* @return PromiseInterface
*/
function promise_for($value)
{
}
/**
* Creates a rejected promise for a reason if the reason is not a promise. If
* the provided reason is a promise, then it is returned as-is.
*
* @param mixed $reason Promise or reason.
*
* @return PromiseInterface
*/
function rejection_for($reason)
{
}
/**
* Create an exception for a rejected promise value.
*
* @param mixed $reason
*
* @return \Exception|\Throwable
*/
function exception_for($reason)
{
}
/**
* Returns an iterator for the given value.
*
* @param mixed $value
*
* @return \Iterator
*/
function iter_for($value)
{
}
/**
* Synchronously waits on a promise to resolve and returns an inspection state
* array.
*
* Returns a state associative array containing a "state" key mapping to a
* valid promise state. If the state of the promise is "fulfilled", the array
* will contain a "value" key mapping to the fulfilled value of the promise. If
* the promise is rejected, the array will contain a "reason" key mapping to
* the rejection reason of the promise.
*
* @param PromiseInterface $promise Promise or value.
*
* @return array
*/
function inspect(\GuzzleHttp\Promise\PromiseInterface $promise)
{
}
/**
* Waits on all of the provided promises, but does not unwrap rejected promises
* as thrown exception.
*
* Returns an array of inspection state arrays.
*
* @param PromiseInterface[] $promises Traversable of promises to wait upon.
*
* @return array
* @see GuzzleHttp\Promise\inspect for the inspection state array format.
*/
function inspect_all($promises)
{
}
/**
* Waits on all of the provided promises and returns the fulfilled values.
*
* Returns an array that contains the value of each promise (in the same order
* the promises were provided). An exception is thrown if any of the promises
* are rejected.
*
* @param mixed $promises Iterable of PromiseInterface objects to wait on.
*
* @return array
* @throws \Exception on error
* @throws \Throwable on error in PHP >=7
*/
function unwrap($promises)
{
}
/**
* Given an array of promises, return a promise that is fulfilled when all the
* items in the array are fulfilled.
*
* The promise's fulfillment value is an array with fulfillment values at
* respective positions to the original array. If any promise in the array
* rejects, the returned promise is rejected with the rejection reason.
*
* @param mixed $promises Promises or values.
*
* @return PromiseInterface
*/
function all($promises)
{
}
/**
* Initiate a competitive race between multiple promises or values (values will
* become immediately fulfilled promises).
*
* When count amount of promises have been fulfilled, the returned promise is
* fulfilled with an array that contains the fulfillment values of the winners
* in order of resolution.
*
* This prommise is rejected with a {@see GuzzleHttp\Promise\AggregateException}
* if the number of fulfilled promises is less than the desired $count.
*
* @param int $count Total number of promises.
* @param mixed $promises Promises or values.
*
* @return PromiseInterface
*/
function some($count, $promises)
{
}
/**
* Like some(), with 1 as count. However, if the promise fulfills, the
* fulfillment value is not an array of 1 but the value directly.
*
* @param mixed $promises Promises or values.
*
* @return PromiseInterface
*/
function any($promises)
{
}
/**
* Returns a promise that is fulfilled when all of the provided promises have
* been fulfilled or rejected.
*
* The returned promise is fulfilled with an array of inspection state arrays.
*
* @param mixed $promises Promises or values.
*
* @return PromiseInterface
* @see GuzzleHttp\Promise\inspect for the inspection state array format.
*/
function settle($promises)
{
}
/**
* Given an iterator that yields promises or values, returns a promise that is
* fulfilled with a null value when the iterator has been consumed or the
* aggregate promise has been fulfilled or rejected.
*
* $onFulfilled is a function that accepts the fulfilled value, iterator
* index, and the aggregate promise. The callback can invoke any necessary side
* effects and choose to resolve or reject the aggregate promise if needed.
*
* $onRejected is a function that accepts the rejection reason, iterator
* index, and the aggregate promise. The callback can invoke any necessary side
* effects and choose to resolve or reject the aggregate promise if needed.
*
* @param mixed $iterable Iterator or array to iterate over.
* @param callable $onFulfilled
* @param callable $onRejected
*
* @return PromiseInterface
*/
function each($iterable, callable $onFulfilled = null, callable $onRejected = null)
{
}
/**
* Like each, but only allows a certain number of outstanding promises at any
* given time.
*
* $concurrency may be an integer or a function that accepts the number of
* pending promises and returns a numeric concurrency limit value to allow for
* dynamic a concurrency size.
*
* @param mixed $iterable
* @param int|callable $concurrency
* @param callable $onFulfilled
* @param callable $onRejected
*
* @return PromiseInterface
*/
function each_limit($iterable, $concurrency, callable $onFulfilled = null, callable $onRejected = null)
{
}
/**
* Like each_limit, but ensures that no promise in the given $iterable argument
* is rejected. If any promise is rejected, then the aggregate promise is
* rejected with the encountered rejection.
*
* @param mixed $iterable
* @param int|callable $concurrency
* @param callable $onFulfilled
*
* @return PromiseInterface
*/
function each_limit_all($iterable, $concurrency, callable $onFulfilled = null)
{
}
/**
* Returns true if a promise is fulfilled.
*
* @param PromiseInterface $promise
*
* @return bool
*/
function is_fulfilled(\GuzzleHttp\Promise\PromiseInterface $promise)
{
}
/**
* Returns true if a promise is rejected.
*
* @param PromiseInterface $promise
*
* @return bool
*/
function is_rejected(\GuzzleHttp\Promise\PromiseInterface $promise)
{
}
/**
* Returns true if a promise is fulfilled or rejected.
*
* @param PromiseInterface $promise
*
* @return bool
*/
function is_settled(\GuzzleHttp\Promise\PromiseInterface $promise)
{
}
/**
* @see Coroutine
*
* @param callable $generatorFn
*
* @return PromiseInterface
*/
function coroutine(callable $generatorFn)
{
}
}
namespace GuzzleHttp\Psr7 {
/**
* Returns the string representation of an HTTP message.
*
* @param MessageInterface $message Message to convert to a string.
*
* @return string
*/
function str(\Psr\Http\Message\MessageInterface $message)
{
}
/**
* Returns a UriInterface for the given value.
*
* This function accepts a string or {@see Psr\Http\Message\UriInterface} and
* returns a UriInterface for the given value. If the value is already a
* `UriInterface`, it is returned as-is.
*
* @param string|UriInterface $uri
*
* @return UriInterface
* @throws \InvalidArgumentException
*/
function uri_for($uri)
{
}
/**
* Create a new stream based on the input type.
*
* Options is an associative array that can contain the following keys:
* - metadata: Array of custom metadata.
* - size: Size of the stream.
*
* @param resource|string|null|int|float|bool|StreamInterface|callable $resource Entity body data
* @param array $options Additional options
*
* @return Stream
* @throws \InvalidArgumentException if the $resource arg is not valid.
*/
function stream_for($resource = '', array $options = [])
{
}
/**
* Parse an array of header values containing ";" separated data into an
* array of associative arrays representing the header key value pair
* data of the header. When a parameter does not contain a value, but just
* contains a key, this function will inject a key with a '' string value.
*
* @param string|array $header Header to parse into components.
*
* @return array Returns the parsed header values.
*/
function parse_header($header)
{
}
/**
* Converts an array of header values that may contain comma separated
* headers into an array of headers with no comma separated values.
*
* @param string|array $header Header to normalize.
*
* @return array Returns the normalized header field values.
*/
function normalize_header($header)
{
}
/**
* Clone and modify a request with the given changes.
*
* The changes can be one of:
* - method: (string) Changes the HTTP method.
* - set_headers: (array) Sets the given headers.
* - remove_headers: (array) Remove the given headers.
* - body: (mixed) Sets the given body.
* - uri: (UriInterface) Set the URI.
* - query: (string) Set the query string value of the URI.
* - version: (string) Set the protocol version.
*
* @param RequestInterface $request Request to clone and modify.
* @param array $changes Changes to apply.
*
* @return RequestInterface
*/
function modify_request(\Psr\Http\Message\RequestInterface $request, array $changes)
{
}
/**
* Attempts to rewind a message body and throws an exception on failure.
*
* The body of the message will only be rewound if a call to `tell()` returns a
* value other than `0`.
*
* @param MessageInterface $message Message to rewind
*
* @throws \RuntimeException
*/
function rewind_body(\Psr\Http\Message\MessageInterface $message)
{
}
/**
* Safely opens a PHP stream resource using a filename.
*
* When fopen fails, PHP normally raises a warning. This function adds an
* error handler that checks for errors and throws an exception instead.
*
* @param string $filename File to open
* @param string $mode Mode used to open the file
*
* @return resource
* @throws \RuntimeException if the file cannot be opened
*/
function try_fopen($filename, $mode)
{
}
/**
* Copy the contents of a stream into a string until the given number of
* bytes have been read.
*
* @param StreamInterface $stream Stream to read
* @param int $maxLen Maximum number of bytes to read. Pass -1
* to read the entire stream.
* @return string
* @throws \RuntimeException on error.
*/
function copy_to_string(\Psr\Http\Message\StreamInterface $stream, $maxLen = -1)
{
}
/**
* Copy the contents of a stream into another stream until the given number
* of bytes have been read.
*
* @param StreamInterface $source Stream to read from
* @param StreamInterface $dest Stream to write to
* @param int $maxLen Maximum number of bytes to read. Pass -1
* to read the entire stream.
*
* @throws \RuntimeException on error.
*/
function copy_to_stream(\Psr\Http\Message\StreamInterface $source, \Psr\Http\Message\StreamInterface $dest, $maxLen = -1)
{
}
/**
* Calculate a hash of a Stream
*
* @param StreamInterface $stream Stream to calculate the hash for
* @param string $algo Hash algorithm (e.g. md5, crc32, etc)
* @param bool $rawOutput Whether or not to use raw output
*
* @return string Returns the hash of the stream
* @throws \RuntimeException on error.
*/
function hash(\Psr\Http\Message\StreamInterface $stream, $algo, $rawOutput = false)
{
}
/**
* Read a line from the stream up to the maximum allowed buffer length
*
* @param StreamInterface $stream Stream to read from
* @param int $maxLength Maximum buffer length
*
* @return string|bool
*/
function readline(\Psr\Http\Message\StreamInterface $stream, $maxLength = null)
{
}
/**
* Parses a request message string into a request object.
*
* @param string $message Request message string.
*
* @return Request
*/
function parse_request($message)
{
}
/**
* Parses a response message string into a response object.
*
* @param string $message Response message string.
*
* @return Response
*/
function parse_response($message)
{
}
/**
* Parse a query string into an associative array.
*
* If multiple values are found for the same key, the value of that key
* value pair will become an array. This function does not parse nested
* PHP style arrays into an associative array (e.g., foo[a]=1&foo[b]=2 will
* be parsed into ['foo[a]' => '1', 'foo[b]' => '2']).
*
* @param string $str Query string to parse
* @param bool|string $urlEncoding How the query string is encoded
*
* @return array
*/
function parse_query($str, $urlEncoding = true)
{
}
/**
* Build a query string from an array of key value pairs.
*
* This function can use the return value of parse_query() to build a query
* string. This function does not modify the provided keys when an array is
* encountered (like http_build_query would).
*
* @param array $params Query string parameters.
* @param int|false $encoding Set to false to not encode, PHP_QUERY_RFC3986
* to encode using RFC3986, or PHP_QUERY_RFC1738
* to encode using RFC1738.
* @return string
*/
function build_query(array $params, $encoding = PHP_QUERY_RFC3986)
{
}
/**
* Determines the mimetype of a file by looking at its extension.
*
* @param $filename
*
* @return null|string
*/
function mimetype_from_filename($filename)
{
}
/**
* Maps a file extensions to a mimetype.
*
* @param $extension string The file extension.
*
* @return string|null
* @link http://svn.apache.org/repos/asf/httpd/httpd/branches/1.3.x/conf/mime.types
*/
function mimetype_from_extension($extension)
{
}
/**
* Parses an HTTP message into an associative array.
*
* The array contains the "start-line" key containing the start line of
* the message, "headers" key containing an associative array of header
* array values, and a "body" key containing the body of the message.
*
* @param string $message HTTP request or response to parse.
*
* @return array
* @internal
*/
function _parse_message($message)
{
}
/**
* Constructs a URI for an HTTP request message.
*
* @param string $path Path from the start-line
* @param array $headers Array of headers (each value an array).
*
* @return string
* @internal
*/
function _parse_request_uri($path, array $headers)
{
}
/** @internal */
function _caseless_remove($keys, array $data)
{
}
}
namespace net\authorize\util {
define("ANET_SENSITIVE_XMLTAGS_JSON_FILE", "AuthorizedNetSensitiveTagsConfig.json");
define("ANET_SENSITIVE_DATE_CONFIG_CLASS", 'net\\authorize\\util\\SensitiveDataConfigType');
}
namespace net\authorize\util {
define("ANET_LOG_FILES_APPEND", true);
define("ANET_LOG_DEBUG_PREFIX", "DEBUG");
define("ANET_LOG_INFO_PREFIX", "INFO");
define("ANET_LOG_WARN_PREFIX", "WARN");
define("ANET_LOG_ERROR_PREFIX", "ERROR");
//log levels
define('ANET_LOG_DEBUG', 1);
define("ANET_LOG_INFO", 2);
define("ANET_LOG_WARN", 3);
define("ANET_LOG_ERROR", 4);
//set level
define("ANET_LOG_LEVEL", ANET_LOG_DEBUG);
}
/*
* @ https://EasyToYou.eu - IonCube v10 Decoder Online
* @ PHP 5.6
* @ Decoder version: 1.0.4
* @ Release: 02/06/2020
*
* @ ZendGuard Decoder PHP 5.6
*/
namespace WHMCS {
define("K_TCPDF_EXTERNAL_CONFIG", true);
define("K_PATH_CACHE", \Config::self()->templates_compiledir . DIRECTORY_SEPARATOR);
define("PDF_CREATOR", "WHMCS");
define("PDF_AUTHOR", "WHMCS");
define("PDF_HEADER_TITLE", "");
define("PDF_HEADER_STRING", "");
define("PDF_MARGIN_FOOTER", 15);
define("PDF_MARGIN_TOP", 25);
}
namespace Aws {
//-----------------------------------------------------------------------------
// Functional functions
//-----------------------------------------------------------------------------
/**
* Returns a function that always returns the same value;
*
* @param mixed $value Value to return.
*
* @return callable
*/
function constantly($value)
{
}
/**
* Filters values that do not satisfy the predicate function $pred.
*
* @param mixed $iterable Iterable sequence of data.
* @param callable $pred Function that accepts a value and returns true/false
*
* @return \Generator
*/
function filter($iterable, callable $pred)
{
}
/**
* Applies a map function $f to each value in a collection.
*
* @param mixed $iterable Iterable sequence of data.
* @param callable $f Map function to apply.
*
* @return \Generator
*/
function map($iterable, callable $f)
{
}
/**
* Creates a generator that iterates over a sequence, then iterates over each
* value in the sequence and yields the application of the map function to each
* value.
*
* @param mixed $iterable Iterable sequence of data.
* @param callable $f Map function to apply.
*
* @return \Generator
*/
function flatmap($iterable, callable $f)
{
}
/**
* Partitions the input sequence into partitions of the specified size.
*
* @param mixed $iterable Iterable sequence of data.
* @param int $size Size to make each partition (except possibly the last chunk)
*
* @return \Generator
*/
function partition($iterable, $size)
{
}
/**
* Returns a function that invokes the provided variadic functions one
* after the other until one of the functions returns a non-null value.
* The return function will call each passed function with any arguments it
* is provided.
*
* $a = function ($x, $y) { return null; };
* $b = function ($x, $y) { return $x + $y; };
* $fn = \Aws\or_chain($a, $b);
* echo $fn(1, 2); // 3
*
* @return callable
*/
function or_chain()
{
}
//-----------------------------------------------------------------------------
// JSON compiler and loading functions
//-----------------------------------------------------------------------------
/**
* Loads a compiled JSON file from a PHP file.
*
* If the JSON file has not been cached to disk as a PHP file, it will be loaded
* from the JSON source file and returned.
*
* @param string $path Path to the JSON file on disk
*
* @return mixed Returns the JSON decoded data. Note that JSON objects are
* decoded as associative arrays.
*/
function load_compiled_json($path)
{
}
/**
* No-op
*/
function clear_compiled_json()
{
}
//-----------------------------------------------------------------------------
// Directory iterator functions.
//-----------------------------------------------------------------------------
/**
* Iterates over the files in a directory and works with custom wrappers.
*
* @param string $path Path to open (e.g., "s3://foo/bar").
* @param resource $context Stream wrapper context.
*
* @return \Generator Yields relative filename strings.
*/
function dir_iterator($path, $context = null)
{
}
/**
* Returns a recursive directory iterator that yields absolute filenames.
*
* This iterator is not broken like PHP's built-in DirectoryIterator (which
* will read the first file from a stream wrapper, then rewind, then read
* it again).
*
* @param string $path Path to traverse (e.g., s3://bucket/key, /tmp)
* @param resource $context Stream context options.
*
* @return \Generator Yields absolute filenames.
*/
function recursive_dir_iterator($path, $context = null)
{
}
//-----------------------------------------------------------------------------
// Misc. functions.
//-----------------------------------------------------------------------------
/**
* Debug function used to describe the provided value type and class.
*
* @param mixed $input
*
* @return string Returns a string containing the type of the variable and
* if a class is provided, the class name.
*/
function describe_type($input)
{
}
/**
* Creates a default HTTP handler based on the available clients.
*
* @return callable
*/
function default_http_handler()
{
}
/**
* Gets the default user agent string depending on the Guzzle version
*
* @return string
*/
function default_user_agent()
{
}
/**
* Serialize a request for a command but do not send it.
*
* Returns a promise that is fulfilled with the serialized request.
*
* @param CommandInterface $command Command to serialize.
*
* @return RequestInterface
* @throws \RuntimeException
*/
function serialize(\Aws\CommandInterface $command)
{
}
/**
* Retrieves data for a service from the SDK's service manifest file.
*
* Manifest data is stored statically, so it does not need to be loaded more
* than once per process. The JSON data is also cached in opcache.
*
* @param string $service Case-insensitive namespace or endpoint prefix of the
* service for which you are retrieving manifest data.
*
* @return array
* @throws \InvalidArgumentException if the service is not supported.
*/
function manifest($service = null)
{
}
}
namespace {
function widgetoutput($value)
{
}
/**
* The function to output the widget data to the browser in a javascript format.
*
* @throws WHMCS\Exception\ProgramExit
* @param string $value the data to output
*/
function widgetOutput($value)
{
}
\define("CLIENTAREA", \true);
function saveQuote($id = 0, $subject = "", $stage = "", $datecreated = "", $validuntil = "", $clienttype = "", $userid = 0, $firstname = "", $lastname = "", $companyname = "", $email = "", $address1 = "", $address2 = "", $city = "", $state = "", $postcode = "", $country = "", $phonenumber = "", $currency = 0, array $lineitems = array(), $proposal = "", $customernotes = "", $adminnotes = "", $updatepriceonly = \false, $taxId = "")
{
}
function genQuotePDF($id)
{
}
function sendQuotePDF($id)
{
}
function convertQuotetoInvoice($id, $invoicetype = \NULL, $invoiceduedate = \NULL, $depositpercent = 0, $depositduedate = \NULL, $finalduedate = \NULL, $sendemail = \false)
{
}
function getQuoteStageLang($stage)
{
}
function cartPreventDuplicateProduct($domain)
{
}
function cartPreventDuplicateDomain($domain)
{
}
function bundlesConvertBillingCycle($cycle)
{
}
function bundlesStepCompleteRedirect($lastconfig)
{
}
function bundlesValidateProductConfig($key, $billingcycle, $configoptions, $addons)
{
}
function bundlesValidateCheckout()
{
}
function bundlesGetProductPriceOverride($type, $key)
{
}
function cartAvailabilityResultsBackwardsCompat(\WHMCS\Domains\Domain $domainToLookup, \WHMCS\Domains\DomainLookup\SearchResult $searchResult, $matchString)
{
}
function cartCheckIfDomainAlreadyOrdered(\WHMCS\Domains\Domain $domainToCheck)
{
}
function cartValidationOnCheckout($clientId, $setSession = \false)
{
}
function updateCCDetails($userid, $cardtype, $cardnum, $cardcvv, $cardexp, $cardstart, $cardissue, $noremotestore = "", $fullclear = "", $paymentGateway = "", &$payMethodRef = \false, $ccDescription = "", $billingContactId = \NULL)
{
}
function ccFormatNumbers($val)
{
}
function ccFormatDate($date)
{
}
function getClientDefaultCardDetails($userId, $mode = "allowLegacy", $paymentModule = \NULL)
{
}
function getCCDetails($userid)
{
}
function getCCVariables($invoiceid, $gatewayName = "", \WHMCS\Payment\PayMethod\Model $payMethod = \NULL, $billingContactId = \NULL)
{
}
function captureCCPayment($invoiceid, $cccvv = "", $passedparams = \false, \WHMCS\Payment\PayMethod\Model $payMethod = \NULL)
{
}
function ccProcessing(\WHMCS\Scheduling\Task\TaskInterface $task = \NULL)
{
}
function checkCreditCard($cardnumber, $cardname)
{
}
function getCardTypeByCardNumber($cardNumber)
{
}
function getPayMethodCardDetails(\WHMCS\Payment\PayMethod\Model $payMethod = \NULL)
{
}
function getPayMethodBankDetails(\WHMCS\Payment\PayMethod\Model $payMethod = \NULL)
{
}
function saveNewRemoteCardDetails(array $remoteDetails, \WHMCS\Module\Gateway $gateway, $clientId)
{
}
function initialiseLoggedInClient()
{
}
function initialiseClientArea($pageTitle, $displayTitle, $tagline, $pageIcon = \NULL, $breadcrumb = \NULL, $smartyValues = array())
{
}
function outputClientArea($templatefile, $nowrapper = \false, $hookFunctions = array(), $smartyValues = array())
{
}
function processSingleTemplate($templatepath, $templatevars)
{
}
function processSingleSmartyTemplate($smarty, $templatepath, $values)
{
}
function CALinkUpdateCC($forceReload = \false)
{
}
function CALinkUpdateSQ()
{
}
function clientAreaTableInit($name, $defaultorderby, $defaultsort, $numitems)
{
}
function clientAreaTablePageNav($numitems)
{
}
function clientAreaInitCaptcha()
{
}
function clientAreaReCaptchaHTML()
{
}
function breakBreadcrumbHTMLIntoParts($breadcrumbHTML)
{
}
function getCartConfigOptions($pid, $values, $cycle, $accountid = "", $orderform = "", $showHiddenOverride = \false)
{
}
function validateAndSanitizeQuantityConfigOptions($configoption)
{
}
function get_structure($db)
{
}
function generateBackup()
{
}
function createInvoices($func_userid = "", $noemails = "", $nocredit = "", $specificitems = "", \WHMCS\Scheduling\Task\TaskInterface $task = \NULL)
{
}
function createInvoicesProcess($data, $noemails = "", $nocredit = "", \WHMCS\Scheduling\Task\TaskInterface $task = \NULL)
{
}
function getInvoiceProductDetails($id, $pid, $regdate, $nextduedate, $billingcycle, $domain, $userid)
{
}
function getInvoiceProductPromo($amount, $promoid, $userid = "", $serviceid = "", $orderamt = "")
{
}
function getInvoiceProductDefaultPrice($pid, $billingCycle, $regDate, $nextDueDate, $serviceID = 0, $userID = 0)
{
}
function cancelUnpaidUpgrade($serviceId)
{
}
function getInvoiceStatusColour($status, $clientarea = \true)
{
}
function getInvoicePayUntilDate($nextduedate, $billingcycle, $fulldate = "")
{
}
function addTransaction($userid, $currencyid, $description, $amountin, $fees, $amountout, $gateway = "", $transid = "", $invoiceid = "", $date = "", $refundid = "", $rate = "")
{
}
function updateInvoiceTotal($id)
{
}
function addInvoicePayment($invoiceId, $transactionId, $amount, $fees, $gateway, $noEmail = \false, $date = \NULL)
{
}
function removeOverpaymentCredit($userid, $transid, $amount)
{
}
function refundInvoicePayment($transid, $amount, $sendtogateway, $addascredit = "", $sendemail = \true, $refundtransid = "", $reverse = \false)
{
}
function processPaidInvoice($invoiceid, $noemail = "", $date = "")
{
}
function getTaxRate($level, $state, $country)
{
}
function pdfInvoice($invoiceid)
{
}
function makeHostingPayment($func_domainid, \WHMCS\Billing\Invoice $invoice)
{
}
function makeDomainPayment($func_domainid, $type = "")
{
}
function makeAddonPayment($func_addonid, $invoice)
{
}
function getProrataValues($billingcycle, $amount, $proratadate, $proratachargenextmonth, $day, $month, $year, $userid)
{
}
function getNewClientAutoProvisionStatus($userid)
{
}
function applyCredit($invoiceid, $userid, $amount, $noemail = "")
{
}
function getBillingCycleDays($billingcycle)
{
}
function getBillingCycleMonths($billingcycle)
{
}
function isUniqueTransactionID($transactionID, $gateway)
{
}
function removeCreditOnInvoiceDelete($invoiceID)
{
}
function refundCreditOnStatusChange($invoiceId, $status = "Fraud")
{
}
function paymentReversed($reverseTransactionId, $originalTransactionId, $invoiceId = 0, $gateway = \NULL)
{
}
function reversePaymentActions(\WHMCS\Billing\Payment\Transaction $transaction, $reverseTransactionId, $originalTransactionId)
{
}
function loadGatewayModule($paymentMethod)
{
}
function fetchGatewayModuleDirectory()
{
}
function paymentMethodsSelection($blankSelection = "", $tabIndex = \false)
{
}
function checkActiveGateway()
{
}
function getGatewaysArray()
{
}
function getGatewayName($moduleName)
{
}
function showPaymentGatewaysList($disabledGateways = array(), $userId = \NULL, $forceAll = \false)
{
}
function getVariables($gateway)
{
}
function getGatewayVariables($gateway, $invoiceId = "")
{
}
function logTransaction($gateway, $data, $result, array $passedParams = array(), \WHMCS\Module\Gateway $gatewayModule = \NULL)
{
}
function checkCbInvoiceID($invoiceId, $gateway = "Unknown")
{
}
function checkCbTransID($transactionId)
{
}
function callback3DSecureRedirect($invoiceId, $success = \false)
{
}
function getRecurringBillingValues($invoiceId)
{
}
function cancelSubscriptionForService($serviceID, $userID = 0)
{
}
function getUpgradeRecurringValues($invoiceID)
{
}
function findInvoiceID($serviceID, $transID = "", $type = "Hosting")
{
}
function outputDataArrayToString(array $data, $depth = 0)
{
}
function invoiceSetPayMethodRemoteToken($invoiceId, $remoteToken)
{
}
function invoiceDeletePayMethod($invoiceId)
{
}
function invoiceConvertLocalCardToRemote($invoiceId, $remoteToken)
{
}
function invoiceConvertLocalBankAccountToRemote($invoiceId, $remoteToken)
{
}
function invoiceSaveRemoteCard($invoiceId, $cardNumberOrLastFour, $cardType, $expiryDate, $remoteToken)
{
}
function invoiceSaveRemoteBankAccount($invoiceId, $bankName, $remoteToken)
{
}
function createCardPayMethod($clientId, $gatewayName, $cardNumber, $cardExpiryDate, $cardType = \NULL, $cardStartDate = \NULL, $cardIssueNumber = \NULL, $remoteToken = \NULL, $billingContactId = "billing", $description = "")
{
}
function updateCardPayMethod($clientId, $payMethodId, $cardExpiryDate, $cardStartDate = \NULL, $cardIssueNumber = \NULL, $remoteToken = \NULL)
{
}
function createBankPayMethod($clientId, $gatewayName, $accountType = "checking", $routingNumber = "", $accountNumber = "", $bankName = "", $accountHolderName = "", $remoteToken = \NULL, $billingContactId = "billing", $description = "")
{
}
function updateBankPayMethod($clientId, $payMethodId, $accountType = "checking", $routingNumber = "", $accountNumber = "", $bankName = "", $accountHolderName = "", $remoteToken = \NULL)
{
}
function getTLDList($type = "register")
{
}
function getTLDPriceList($tld, $display = \false, $renewpricing = "", $userid = 0, $useCache = \true)
{
}
function cleanDomainInput($val)
{
}
function checkDomainisValid($sld, $tld)
{
}
function disableAutoRenew($domainid)
{
}
function multipleTldPriceListings(array $tlds)
{
}
function getSpotlightTlds()
{
}
function getSpotlightTldsWithPricing()
{
}
function processUtf8Mb4($message)
{
}
function getTimeBetweenDates($lastreply, $from = "now")
{
}
function getShortLastReplyTime($lastreply)
{
}
function getLastReplyTime($lastreply)
{
}
function getTicketDuration($start, $end)
{
}
function getStatusColour($tstatus, $htmlOutput = \true)
{
}
function ticketAutoHyperlinks($message)
{
}
function AddNote($tid, $message, $markdown = \false)
{
}
function AdminRead($tid)
{
}
function ClientRead($tid)
{
}
function addTicketLog($tid, $action)
{
}
function AddtoLog($tid, $action)
{
}
function getDepartmentName($deptId)
{
}
function ticketGenerateAttachmentsListFromString($attachmentsString)
{
}
function openNewTicket($userid, $contactid, $deptid, $tickettitle, $message, $urgency, $attachmentsString = "", array $from = array(), $relatedservice = "", $ccemail = "", $noemail = "", $admin = "", $markdown = \false)
{
}
function AddReply($ticketid, $userid, $contactid, $message, $admin, $attachmentsString = "", $from = "", $status = "", $noemail = "", $api = \false, $markdown = \false, $changes = array())
{
}
function processPoppedTicket($to, $name, $email, $subject, $message, $attachment, array $cc = array())
{
}
function processPipedTicket($to, $name, $email, $subject, $message, $attachment, array $cc = array())
{
}
function convertIniSize($size)
{
}
function checkTicketAttachmentSize()
{
}
function uploadTicketAttachments($isAdmin = \false)
{
}
function saveTicketAttachmentsFromApiCall(array $attachmentArray = array(), $isAdmin = \false)
{
}
function checkTicketAttachmentExtension($file_name)
{
}
function pipeDecodeString($input)
{
}
function deleteTicket($ticketid, $replyid = 0)
{
}
function genTicketMask($id = "")
{
}
function getKBAutoSuggestions($text)
{
}
function getKBAutoSuggestionsQuery($field, $textparts, $limit, $existingkbarticles = "")
{
}
function ticketsummary($text, $length = 100)
{
}
function getTicketContacts($userid)
{
}
function getTicketAttachmentsInfo($ticketId, $attachment, $type = "ticket", $relatedId = 0)
{
}
function isAttachmentAnImage($file)
{
}
function getAdminDepartmentAssignments()
{
}
function getDepartments()
{
}
function validateAdminTicketAccess($ticketid)
{
}
function genPredefinedRepliesList($cat, $predefq = "")
{
}
function closeTicket($id)
{
}
function getDepartmentNotificationIds($departmentId)
{
}
function checkTicketChanges($ticketId, \stdClass $ticketInfo = \NULL)
{
}
function removeAttachmentsFromClosedTickets($removeAttachmentsPeriod = 0)
{
}
function removeAttachmentsFromClosedTicketsTable($table, $removeAttachmentsBefore, $closedTicketStatuses)
{
}
\define("RECAPTCHA_API_SERVER", "http://www.google.com/recaptcha/api");
\define("RECAPTCHA_API_SECURE_SERVER", "https://www.google.com/recaptcha/api");
\define("RECAPTCHA_VERIFY_SERVER", "www.google.com");
function _recaptcha_qsencode($data)
{
}
function _recaptcha_http_post($host, $path, $data, $port = 80)
{
}
function recaptcha_get_html($pubkey, $error = \NULL, $use_ssl = \true)
{
}
function recaptcha_check_answer($privkey, $remoteip, $challenge, $response, $extra_params = array())
{
}
function recaptcha_get_signup_url($domain = \NULL, $appname = \NULL)
{
}
function _recaptcha_aes_pad($val)
{
}
function _recaptcha_aes_encrypt($val, $ky)
{
}
function _recaptcha_mailhide_urlbase64($x)
{
}
function recaptcha_mailhide_url($pubkey, $privkey, $email)
{
}
function _recaptcha_mailhide_email_parts($email)
{
}
function recaptcha_mailhide_html($pubkey, $privkey, $email)
{
}
function affiliateActivate($userid)
{
}
function getOrderStatusColour($status)
{
}
function getProductInfo($pid)
{
}
function getPricingInfo($pid, $inclconfigops = \false, $upgrade = \false)
{
}
function calcCartTotals($checkout = \false, $ignorenoconfig = \false, array $currency = array())
{
}
function SetPromoCode($promotioncode)
{
}
function CalcPromoDiscount($pid, $cycle, $fpamount, $recamount, $setupfee = 0)
{
}
function acceptOrder($orderid, $vars = array())
{
}
function changeOrderStatus($orderid, $status, $cancelSubscription = \false)
{
}
function cancelRefundOrder($orderid)
{
}
function deleteOrder($orderid)
{
}
function getAddons($pid, array $addons = array())
{
}
function getAvailableOrderPaymentGateways($forceAll = \false)
{
}
function canOrderBeDeleted($orderID, $orderStatus = "")
{
}
function processAddonsCancelOrFraud($addonCollection, $status)
{
}
function addPrintInputToForm($formContainer)
{
}
function getReportsList()
{
}
function getAdminPermsArray()
{
}
function checkPermission($action, $noredirect = "")
{
}
function infoBox($title, $description, $status = "info")
{
}
function getAdminName($adminId = 0)
{
}
function getAdminHomeStats($type = "")
{
}
function replacePasswordWithMasks($password)
{
}
function hasMaskedPasswordChanged($newPassword, $originalPassword)
{
}
function interpretMaskedPasswordChangeForStorage($newPassword, $originalPassword)
{
}
function logAdminActivity($description)
{
}
function sort_array_by_priority($a, $b)
{
}
function hookToString($hook)
{
}
function hook_log($hook_name, $msg, $input1 = "", $input2 = "", $input3 = "")
{
}
function get_registered_hooks($hookName)
{
}
function set_registered_hooks($hookName, array $hooks)
{
}
function run_hook($hook_name, $args, $unpackArguments = \false)
{
}
function add_hook($hook_name, $priority, $hook_function, $rollback_function = "")
{
}
function remove_hook($hook_name, $priority, $hook_function, $rollback_function)
{
}
function clear_hooks($hook_name)
{
}
function run_validate_hook(&$validate, $hook_name, $args)
{
}
function processHookResults($moduleName, $function, array $hookResults = array())
{
}
function loadHookFiles()
{
}
function getClientsDetails($userid = "", $contactid = "")
{
}
function getClientsStats($userid, \WHMCS\User\Client $client = \NULL)
{
}
function getCountriesDropDown($selected = "", $fieldname = "", $tabindex = "", $selectInline = \true, $disable = \false)
{
}
function checkDetailsareValid($uid = "", $signup = \false, $checkemail = \true, $captcha = \true, $checkcustomfields = \true)
{
}
function validateContactDetails($cid = "", $reqpw = \false, $prefix = "")
{
}
function checkContactDetails($cid = "", $reqpw = \false, $prefix = "")
{
}
function addClientFromModel(\WHMCS\User\Client $client)
{
}
function addClient($firstname, $lastname, $companyname, $email, $address1, $address2, $city, $state, $postcode, $country, $phonenumber, $password, $securityqid = 0, $securityqans = "", $sendemail = \true, array $additionalData = array(), $uuid = "", $isAdmin = \false, $marketingOptIn = \NULL)
{
}
function addContact($userid, $firstname, $lastname, $companyname, $email, $address1, $address2, $city, $state, $postcode, $country, $phonenumber, $password = "", $permissions = array(), $generalemails = "", $productemails = "", $domainemails = "", $invoiceemails = "", $supportemails = "", $affiliateemails = "", $taxId = "")
{
}
function deleteClient($userid)
{
}
function getSecurityQuestions($questionid = "")
{
}
function generateClientPW($plain, $salt = "")
{
}
function checkContactPermission($requiredPermission, $noRedirect = \false)
{
}
function validateClientLogin($username, $password)
{
}
function createCancellationRequest($userid, $serviceid, $reason, $type)
{
}
function recalcRecurringProductPrice($serviceid, $userid = "", $pid = "", $billingcycle = "", $configoptionsrecurring = "empty", $promoid = 0, $includesetup = \false, $showHiddenOverride = \false)
{
}
function closeClient($userid)
{
}
function convertStateToCode($ostate, $country)
{
}
function getClientsPaymentMethod($userid)
{
}
function clientChangeDefaultGateway($userid, $paymentmethod)
{
}
function recalcPromoAmount($pid, $userid, $serviceid, $billingcycle, $recurringamount, $promoid)
{
}
function cancelUnpaidInvoicebyProductID($serviceid, $userid = "")
{
}
function getClientDefaultBankDetails($userId, $mode = "allowLegacy", &$foundPayMethodRef = \false)
{
}
function getClientsBankDetails($userId)
{
}
function normaliseInternationalPhoneNumberFormat(array &$details)
{
}
function getCustomFields($type, $relid, $relid2, $admin = "", $order = "", $ordervalues = "", $hidepw = "")
{
}
function saveCustomFields($relid, $customfields, $type = "", $isAdmin = \false)
{
}
function copyCustomFieldValues($itemType, $fromItemId, $toItemId)
{
}
function migrateCustomFields($itemType, $itemID, $newRelID)
{
}
function migrateCustomFieldsBetweenProducts($serviceid, $newpid, $save = \false)
{
}
function migrateCustomFieldsBetweenProductsOrAddons($entityId, $relatedItemId, $existingRelatedItemId, $save = \false, $addon = \false)
{
}
function getModuleType($id)
{
}
function ModuleBuildParams($serviceID, $addonId = 0)
{
}
function ModuleCallFunction($function, $serviceID, $extraParams = array(), $addonId = 0)
{
}
function ServerSuspendAccount($serviceID, $suspendreason = "", $addonId = 0)
{
}
function ServerUnsuspendAccount($serviceID, $addonId = 0)
{
}
function ServerTerminateAccount($serviceID, $addonId = 0)
{
}
function ServerRenew($serviceID, $addonId = 0)
{
}
function ServerChangePassword($serviceID, $addonId = 0)
{
}
function ServerLoginLink($serviceID, $addonId = 0)
{
}
function ServerChangePackage($serviceID, $addonId = 0)
{
}
function ServerCustomFunction($serviceID, $func_name, $addonId = 0)
{
}
function ServerClientArea($serviceID, $addonId = 0)
{
}
function ServerUsageUpdate()
{
}
function createServerUsername($domain)
{
}
function createServerPassword()
{
}
function getServerID($servertype, $servergroup)
{
}
function rebuildModuleHookCache()
{
}
function rebuildAddonHookCache()
{
}
function moduleConfigFieldOutput($values)
{
}
function select_query($table, $fields, $where, $orderby = "", $orderbyorder = "", $limit = "", $innerjoin = "", $handle = \NULL)
{
}
function tokenizeOrderby($input, $default_ordering = "ASC")
{
}
function update_query($table, $array, $where, $resource = \NULL)
{
}
function insert_query($table, $array, $resource = \NULL)
{
}
function delete_query($table, $where, $resource = \NULL)
{
}
function db_build_quoted_field($key)
{
}
function full_query($query, $userHandle = \NULL)
{
}
function get_query_val($table, $field, $where, $orderby = "", $orderbyorder = "", $limit = "", $innerjoin = "", $resource = \NULL)
{
}
function get_query_vals($table, $field, $where, $orderby = "", $orderbyorder = "", $limit = "", $innerjoin = "", $resource = \NULL)
{
}
function db_escape_string($string)
{
}
function db_escape_array($array)
{
}
function db_escape_numarray($array)
{
}
function db_build_in_array($array, $allow_empty = \false)
{
}
function db_make_safe_field($field)
{
}
function db_build_update_array($fields, $arrayhandler = "serialize")
{
}
function db_make_safe_date($date)
{
}
function db_make_safe_human_date($date)
{
}
function db_is_valid_amount($amount)
{
}
function getMysqlCompat()
{
}
function checkIsPdoStatement($statement, $functionName)
{
}
function mysql_affected_rows()
{
}
function mysql_client_encoding()
{
}
function mysql_close()
{
}
function mysql_connect()
{
}
function mysql_create_db()
{
}
function mysql_data_seek()
{
}
function mysql_db_name()
{
}
function mysql_db_query()
{
}
function mysql_drop_db()
{
}
function mysql_errno()
{
}
function mysql_error()
{
}
function mysql_escape_string()
{
}
function mysql_fetch_array($statement = \NULL)
{
}
function mysql_fetch_assoc($statement = \NULL)
{
}
function mysql_fetch_field()
{
}
function mysql_fetch_lengths()
{
}
function mysql_fetch_object($statement = \NULL)
{
}
function mysql_fetch_row($statement = \NULL)
{
}
function mysql_field_flags()
{
}
function mysql_field_len()
{
}
function mysql_field_name()
{
}
function mysql_field_seek()
{
}
function mysql_field_table()
{
}
function mysql_field_type()
{
}
function mysql_free_result()
{
}
function mysql_get_client_info($pdo = \NULL)
{
}
function mysql_get_host_info()
{
}
function mysql_get_proto_info()
{
}
function mysql_get_server_info($pdo = \NULL)
{
}
function mysql_info()
{
}
function mysql_insert_id()
{
}
function mysql_list_dbs()
{
}
function mysql_list_fields()
{
}
function mysql_list_processes()
{
}
function mysql_list_tables()
{
}
function mysql_num_fields($statement = \NULL)
{
}
function mysql_num_rows($statement = \NULL)
{
}
function mysql_pconnect()
{
}
function mysql_ping()
{
}
function mysql_query($query)
{
}
function mysql_real_escape_string($data)
{
}
function mysql_result()
{
}
function mysql_select_db()
{
}
function mysql_set_charset()
{
}
function mysql_stat()
{
}
function mysql_tablename()
{
}
function mysql_thread_id()
{
}
function mysql_unbuffered_query()
{
}
function currencyUpdateRates(\WHMCS\Scheduling\Task\TaskInterface $task = \NULL)
{
}
function currencyUpdatePricing($currencyid = "")
{
}
function SumUpPackageUpgradeOrder($id, $newproductid, $newproductbillingcycle, $promocode, $paymentmethod = "", $checkout = "")
{
}
function SumUpConfigOptionsOrder($id, $configoptions, $promocode, $paymentmethod = "", $checkout = "")
{
}
function createUpgradeOrder($serviceId, $ordernotes, $promocode, $paymentmethod)
{
}
function processUpgradePayment($upgradeid, $paidamount, $fees, $invoice = "", $gateway = "", $transid = "")
{
}
function doUpgrade($upgradeid)
{
}
function validateUpgradePromo($promocode)
{
}
function upgradeAlreadyInProgress($hostingId)
{
}
function cancelUnpaidInvoiceForPreviousPriceAndRegenerateNewInvoiceByServiceId($serviceId)
{
}
function sendMessage($template, $func_id, $extra = "", $displayresult = "", $attachments = "")
{
}
function sendAdminNotification($to = "system", $subject, $messageBody, $deptid = 0, $appendAdminLink = \true)
{
}
function sendAdminMessage($template, $email_merge_fields = array(), $to = "system", $deptid = 0, $adminid = 0, $ticketnotify = "")
{
}
function toMySQLDate($date)
{
}
function validateDateInput($date)
{
}
function getClientDateFormat()
{
}
function fromMySQLDate($date, $time = "", $client = "", $zerodateval = "")
{
}
function MySQL2Timestamp($datetime)
{
}
function getTodaysDate($client = "")
{
}
function xdecrypt($ckey, $string)
{
}
function AffiliatePayment($affaccid, $hostingid)
{
}
function calculateAffiliateCommission($affid, $relid, $lastpaid = "")
{
}
function logActivity($description, $userid = 0)
{
}
function load_hooks()
{
}
function addToDoItem($title, $description, $duedate = "", $status = "", $admin = "")
{
}
function generateUniqueID($type = "")
{
}
function foreignChrReplace($arr)
{
}
function foreignChrReplace2($string)
{
}
function getModRewriteFriendlyString($title)
{
}
function titleCase($title)
{
}
function sanitize($str)
{
}
function ParseXmlToArray($rawxml, $options = array())
{
}
function XMLtoARRAY($rawxml)
{
}
function format_as_currency($amount)
{
}
function encrypt($string)
{
}
function decrypt($string)
{
}
function _hash($string)
{
}
function _generate_iv()
{
}
function getUsersLang($userId)
{
}
function swapLang($desiredLanguage)
{
}
function getCurrency($userid = "", $cartcurrency = "")
{
}
function formatCurrency($amount, $currencyType = \false)
{
}
function convertCurrency($amount, $from, $to, $base_currency_exchange_rate = "")
{
}
function getClientGroups()
{
}
function curlCall($url, $postData, $options = array(), $returnUnexecutedHandle = \false, $throwOnCurlError = \false)
{
}
function get_token()
{
}
function set_token($token)
{
}
function conditionally_set_token()
{
}
function generate_token($type = "form")
{
}
function check_token($namespace = "WHMCS.default", $token = \null)
{
}
function &getTokenManager($instance = \null)
{
}
function localAPI_Legacy($cmd, $apivalues1, $adminuser = "")
{
}
function localAPI($cmd, $apivalues1, $adminuser = "")
{
}
function redir($vars = "", $file = "")
{
}
function redirSystemURL($vars = "", $file = "")
{
}
function logModuleCall($module, $action, $request, $response, $data = "", $variablesToMask = array())
{
}
function updateService($fields, $serviceid = 0)
{
}
function genRandomVal($len = 12)
{
}
function autoHyperLink($message)
{
}
function isValidforPath($name)
{
}
function generateNewCaptchaCode()
{
}
function escapeJSSingleQuotes($val)
{
}
function recursiveReplace($dataToModify, $replacementData)
{
}
function ensurePaymentMethodIsSet($userId, $id, $table = "tblhosting")
{
}
function getSerializeInputMaxLength()
{
}
function getSerializeArrayMaxLength()
{
}
function getSerializeArrayDepth()
{
}
function _safe_serialize($value)
{
}
function safe_serialize($value)
{
}
function _safe_unserialize($str)
{
}
function safe_unserialize($str)
{
}
function upperCaseFirstLetter($string)
{
}
function saveSingleCustomField($fieldId, $relId, $value)
{
}
function saveSingleCustomFieldByNameAndType($fieldName, $fieldType, $relId, $value, $entityId = 0)
{
}
function jsonPrettyPrint($data)
{
}
function defineGatewayField($gateway, $type, $name, $defaultvalue, $friendlyname, $size, $description)
{
}
function defineGatewayFieldStorage($clear = \false, $gatewayName = \null, $data = array())
{
}
function generateFriendlyPassword($length = 12)
{
}
function build_query_string($data, $encoding = \PHP_QUERY_RFC1738)
{
}
function routePath($routeName, ...$routeVariables)
{
}
function fqdnRoutePath($routeName, ...$routeVariables)
{
}
function prependSystemUrlToRoutePath($routePath)
{
}
function requestedRoutableQueryUriPath(\WHMCS\Http\Message\ServerRequest $request)
{
}
function view($viewName, $parameters = array())
{
}
function class_uses_deep($class, $autoload = \true)
{
}
function traitOf($class, $trait)
{
}
function getClassName($class)
{
}
function checkDomain($domain)
{
}
function getRegistrarsDropdownMenu($registrar, $name = "registrar", $additionalClasses = "select-inline")
{
}
function loadRegistrarModule($registrar)
{
}
function RegCallFunction($params, $function)
{
}
function getRegistrarConfigOptions($registrar)
{
}
function RegGetNameservers($params)
{
}
function RegSaveNameservers($params)
{
}
function RegGetRegistrarLock($params)
{
}
function RegSaveRegistrarLock($params)
{
}
function RegGetURLForwarding($params)
{
}
function RegSaveURLForwarding($params)
{
}
function RegGetEmailForwarding($params)
{
}
function RegSaveEmailForwarding($params)
{
}
function RegGetDNS($params)
{
}
function RegSaveDNS($params)
{
}
function RegRenewDomain($params)
{
}
function RegRegisterDomain($paramvars)
{
}
function RegTransferDomain($paramvars)
{
}
function RegGetContactDetails($params)
{
}
function RegSaveContactDetails($params)
{
}
function RegGetEPPCode($params)
{
}
function RegRequestDelete($params)
{
}
function RegReleaseDomain($params)
{
}
function RegRegisterNameserver($params)
{
}
function RegModifyNameserver($params)
{
}
function RegDeleteNameserver($params)
{
}
function RegIDProtectToggle($params)
{
}
function RegGetDefaultNameservers($params, $domain)
{
}
function RegGetRegistrantContactEmailAddress(array $params)
{
}
function RegCustomFunction($params, $func_name)
{
}
function RebuildRegistrarModuleHookCache()
{
}
function injectDomainObjectIfNecessary($params)
{
}
function convertToCiraCode($code)
{
}
function getNameserversForDomain(array &$params, $domain, $orderId)
{
}
function uwd_xml2array($contents, $get_attributes = 1, $priority = "tag")
{
}
\define("IPHONELICENSE", $licensing->isActiveAddon("iPhone App"));
function gracefulCoreRequiredFileInclude($path)
{
}
\define("WHMCS_LICENSE_DOMAIN", isset($_SERVER["SERVER_NAME"]) ? $_SERVER["SERVER_NAME"] : "");
\define("WHMCS_LICENSE_IP", $installIp);
\define("WHMCS_LICENSE_DIR", \realpath(\dirname(__FILE__)));
\define("ROOTDIR", \realpath(\dirname(__FILE__)));
\define("WHMCS", \true);
function htmlspecialchars_array($arr)
{
}
\define("CLIENT_DATE_FORMAT", \getClientDateFormat());
\define("ADMINAREA", \true);
\define("NO_QUEUE", \true);
function kbGetCatIds($catid)
{
}
function buildCategoriesList($level, $parentlevel, $exclude = "")
{
}
function outputEmailTpls($type)
{
}
function csv_clean($var)
{
}
function csv_output($query)
{
}
function deletePreDefCat($catid)
{
}
\define("ROUTE_CONVERTED_LEGACY_ENDPOINT", \true);
function cleanSystemURL($url)
{
}
\define("SHOPPING_CART", \true);
function buildCustomModuleButtons($modulebtns, $adminbuttonarray)
{
}
\define('PROXY_FILE', \true);
function calendar_core_calendar($vars)
{
}
function calendar_core_products($vars)
{
}
function calendar_core_addons($vars)
{
}
function calendar_core_domains($vars)
{
}
function calendar_core_todoitems($vars)
{
}
function load_admin_home_widgets()
{
}
function getConfigurationFileContentWithNewLicenseKey($key)
{
}
function ajax_getcycles($pid)
{
}
function getModuleInfo($moduleName)
{
}
function printProductDownloads($downloads)
{
}
function assignedips_trim(&$value)
{
}
function downloadLogin()
{
}
\define("FORCESSL", \true);
function dlGetCatIds($catid)
{
}
function formatFileSize($val, $digits = 3)
{
}
function createDownloadsArray($result)
{
}
function interpret_structure($structure)
{
}
function handle_attachment($structure)
{
}
\define("IN_CRON", \true);
\define("INCRONRUN", \true);
function getWhmcsInitPath()
{
}
function getInitPathErrorMessage()
{
}
function cronsFormatOutput($output)
{
}
function cronsIsCli()
{
}
function getPortStatus($params, &$smarty)
{
}
\define("INSTALLER_DIR", __DIR__);
function mysql_import_file($filename, $basedir = \NULL)
{
}
function getConfigurationFileContentWithNewCcHash($newCcHash)
{
}
function getSSLWebServerTypes()
{
}
\define("WHMCS_OAUTH", \true);
function securepayau_activate()
{
}
function securepayau_capture($params)
{
}
function securepayau_getGMTtimeStamp()
{
}
function securepayau_openSocket($host, $query)
{
}
function securepayau_makeXMLTree($rawxml)
{
}
function mailin_config()
{
}
function mailin_link($params)
{
}
function moneris_config()
{
}
function moneris_capture($params)
{
}
function moneris_refund($params)
{
}
function moneybookers_config()
{
}
function moneybookers_link($params)
{
}
function linkpoint_config()
{
}
function linkpoint_capture($params)
{
}
function worldpayinvisible_activate()
{
}
function worldpayinvisible_capture($params)
{
}
function worldpayinvisible_refund($params)
{
}
function paypalcheckout_MetaData()
{
}
function paypalcheckout_config()
{
}
function paypalcheckout_admin_area_actions(array $params)
{
}
function paypalcheckout_onboarding_response_handler($params)
{
}
function paypalcheckout_link($params)
{
}
function paypalcheckout_refund($params)
{
}
function paypalcheckout_cancelSubscription(array $params)
{
}
function paypalcheckout_express_checkout_initiate($params)
{
}
function paypalcheckout_express_checkout_checkout_output($params)
{
}
function paypalcheckout_express_checkout_capture($params)
{
}
function paypalcheckout_post_checkout($params)
{
}
function paypalcheckout_get_subscription_info($params)
{
}
function paypalcheckout_get_subscription_transactions($params)
{
}
function paypalcheckout_link_subscription_notice($invoiceId)
{
}
function paypalcheckout_isRecurringPossible(\WHMCS\Cart\Cart $cart)
{
}
function paypalcheckout_apiErrorHandler($responseData)
{
}
function sagepaytokens_config()
{
}
function sagepaytokens_storeremote($params)
{
}
function sagepaytokens_3dsecure($params)
{
}
function sagepaytokens_capture($params)
{
}
function sagepaytokens_call($url, $fields)
{
}
function sagepaytokens_getcardtype($cardtype)
{
}
function mollieideal_config()
{
}
function mollieideal_link($params)
{
}
function f2b_activate()
{
}
function f2b_link($params)
{
}
function stripe_sepa_MetaData()
{
}
function stripe_sepa_config()
{
}
function stripe_sepa_nolocalcc()
{
}
function stripe_sepa_config_validate(array $params = array())
{
}
function stripe_sepa_config_post_save(array $params = array())
{
}
function stripe_sepa_deactivate(array $params)
{
}
function stripe_sepa_storeremote(array $params)
{
}
function stripe_sepa_capture(array $params)
{
}
function stripe_sepa_bank_account_input(array $params)
{
}
function stripe_sepa_refund(array $params = array())
{
}
function stripe_sepa_formatValue($value)
{
}
function stripe_sepa_formatAmount($amount, $currencyCode)
{
}
function stripe_sepa_start_stripe(array $params)
{
}
function stripe_sepa_parseGatewayToken($data)
{
}
function stripe_sepa_findFirstCustomerToken(\WHMCS\User\Contracts\ContactInterface $client)
{
}
function stripe_sepa_findFirstStripeCustomerId(\WHMCS\User\Contracts\ContactInterface $client)
{
}
function stripe_sepa_statement_descriptor(array $params)
{
}
function stripe_sepa_create_customer(array $params)
{
}
function usaepay_activate()
{
}
function _usaepay_calculate_UMhash($params, $postfields)
{
}
function usaepay_capture($params)
{
}
function paypalpaymentsproref_MetaData()
{
}
function paypalpaymentsproref_config()
{
}
function paypalpaymentsproref_3dsecure($params)
{
}
function paypalpaymentsproref_capture($params)
{
}
function paypalpaymentsproref_refund($params)
{
}
function paypalpaymentsproref_deformatNVP($nvpstr)
{
}
function finansbank_activate()
{
}
function finansbank_capture($params)
{
}
function protxvspform_config()
{
}
function protxvspform_link(array $params)
{
}
\define("EWAY_TOKENS_PARTNER_ID", "311f3706123f4a93bc92841cd3b9e970");
function ewaytokens_MetaData()
{
}
function ewaytokens_config()
{
}
function ewaytokens_nolocalcc()
{
}
function ewaytokens_remoteinput(array $params)
{
}
function ewaytokens_remoteupdate(array $params)
{
}
function ewaytokens_capture(array $params)
{
}
function ewaytokens_refund(array $params)
{
}
function ewaytokens_adminstatusmsg(array $params)
{
}
function ewaytokens_javascript_output(array $response, $payMethodId = \NULL, $clientId = \NULL)
{
}
function ewaytokens_remote_input_confirm(array $params)
{
}
function ewaytokens_admin_area_actions(array $params)
{
}
function ewaytokens_migrate_to_eway(array $params)
{
}
function worldpay_config()
{
}
function worldpay_link($params)
{
}
function authorize_config()
{
}
function authorize_capture($params)
{
}
function authorize_refund($params)
{
}
function eprocessingnetwork_config()
{
}
function eprocessingnetwork_capture($params)
{
}
function quantumvault_config()
{
}
function quantumvault_nolocalcc()
{
}
function quantumvault_remoteinput($params)
{
}
function quantumvault_remoteupdate($params)
{
}
function quantumvault_capture($params)
{
}
function quantumvault_refund($params)
{
}
function _quantumvault_http_post($host, $path, $data, $port = 80)
{
}
function quantumvault_getCode($API_Username, $API_Key, $width, $height, $amount = "0", $id = "0", $custid = "0", $method = "0", $addtoVault = "N", $skipshipping = "N")
{
}
function quantumvault_adminstatusmsg($vars)
{
}
function ccavenue_activate()
{
}
function ccavenue_link($params)
{
}
function ccavenue_getchecksum($MerchantId, $Amount, $OrderId, $URL, $WorkingKey)
{
}
function ccavenue_adler32($adler, $str)
{
}
function ccavenue_leftshift($str, $num)
{
}
function ccavenue_cdec($num)
{
}
function stripe_ach_MetaData()
{
}
function stripe_ach_config()
{
}
function stripe_ach_nolocalcc()
{
}
function stripe_ach_config_validate(array $params = array())
{
}
function stripe_ach_config_post_save(array $params = array())
{
}
function stripe_ach_deactivate(array $params)
{
}
function stripe_ach_storeremote(array $params)
{
}
function stripe_ach_capture(array $params)
{
}
function stripe_ach_bank_account_input(array $params)
{
}
function stripe_ach_refund(array $params = array())
{
}
function stripe_ach_formatValue($value)
{
}
function stripe_ach_formatAmount($amount, $currencyCode)
{
}
function stripe_ach_start_stripe(array $params)
{
}
function stripe_ach_parseGatewayToken($data)
{
}
function stripe_ach_findFirstCustomerToken(\WHMCS\User\Contracts\ContactInterface $client)
{
}
function stripe_ach_findFirstStripeCustomerId(\WHMCS\User\Contracts\ContactInterface $client)
{
}
function stripe_ach_statement_descriptor(array $params)
{
}
function stripe_ach_create_customer(array $params)
{
}
function garantibank_activate()
{
}
function garantibank_capture($params)
{
}
function ewayv4_MetaData()
{
}
function ewayv4_config()
{
}
function ewayv4_credit_card_input(array $params)
{
}
function ewayv4_cc_validation(array $params)
{
}
function ewayv4_storeremote(array $params)
{
}
function ewayv4_capture(array $params)
{
}
function ewayv4_refund(array $params)
{
}
function ewayv4_adminstatusmsg(array $params)
{
}
function paymatenz_activate()
{
}
function paymatenz_link($params)
{
}
function sagepayrepeats_MetaData()
{
}
function sagepayrepeats_config()
{
}
function sagepayrepeats_3dsecure($params)
{
}
function sagepayrepeats_capture($params)
{
}
function sagepayrepeats_requestPost($url, $data)
{
}
function sagepayrepeats_formatData($data)
{
}
function sagepayrepeats_getcardtype($cardtype)
{
}
function netregistrypay_activate()
{
}
function netregistrypay_capture($params)
{
}
function authorizecim_config()
{
}
function authorizecim_config_validate(array $params = array())
{
}
function authorizecim_capture($params)
{
}
function authorizecim_storeremote($params)
{
}
function authorizecim_refund($params)
{
}
function authorizecim_adminstatusmsg($vars)
{
}
function authorizecim_addressFix($address)
{
}
function protx_config()
{
}
function protx_3dsecure(array $params)
{
}
function protx_capture(array $params)
{
}
function protx_requestPost($url, $data)
{
}
function protx_formatData(array $data)
{
}
function protx_getcardtype($cardType)
{
}
function asiapay_config()
{
}
function asiapay_link(array $params)
{
}
function slimpay_MetaData()
{
}
function slimpay_config()
{
}
function slimpay_nolocalcc()
{
}
function slimpay_link(array $params)
{
}
function slimpay_capture(array $params)
{
}
function slimpay_refund(array $params)
{
}
function slimpay_status(array $params)
{
}
function slimpay_api_authorisation($apiUrl, $appId, $appSecret)
{
}
function slimpay_standard_headers($token)
{
}
function slimpay_get_and_save_mandate($uri, $apiToken, $clientModel)
{
}
function slimpay_create_pay_in(array $params, $apiToken, $uri, $scheme)
{
}
function slimpay_poll(array $params)
{
}
function slimpay_handle_payment_issue(array $paymentIssue, $apiToken)
{
}
function slimpay_get_payment_scheme_details(array $params)
{
}
function slimpay_send_request($uri, $apiToken, array $body = \NULL, $getOrPost = "GET")
{
}
function securepay_activate()
{
}
function securepay_capture($params)
{
}
function chronopay_activate()
{
}
function chronopay_link($params)
{
}
function paymentsgateway_activate()
{
}
function tep_achd_card_type($card_type)
{
}
function paymentsgateway_capture($params)
{
}
function toString($string)
{
}
function bluepay_activate()
{
}
function bluepay_capture($params)
{
}
function bluepay_refund($params)
{
}
function payjunction_activate()
{
}
function payjunction_capture($params)
{
}
function payjunction_refund($params)
{
}
function paypalpaymentspro_3dsecure($params)
{
}
function paypalpaymentspro_MetaData()
{
}
function paypalpaymentspro_config()
{
}
function paypalpaymentspro_capture($params, $auth = "")
{
}
function paypalpaymentspro_refund($params)
{
}
function paypalpaymentspro_deformatNVP($nvpstr)
{
}
\define("PSIGATE_PORT_TEST_HIGH_SEC", 27989);
\define("PSIGATE_PORT_PRODUCTION_HIGH_SEC", 27934);
\define("PSIGATE_CURL_ERROR_OFFSET", 1000);
\define("PSIGATE_XML_ERROR_OFFSET", 2000);
\define("PSIGATE_TRANSACTION_OK", "APPROVED");
\define("PSIGATE_TRANSACTION_DECLINED", "DECLINED");
\define("PSIGATE_TRANSACTION_ERROR", "ERROR");
function psigate_activate()
{
}
function psigate_capture($params)
{
}
function psigate_refund($params)
{
}
function trustcommerce_config()
{
}
function trustcommerce_capture($params)
{
}
function trustcommerce_refund($params)
{
}
function bluepayremote_config()
{
}
function bluepayremote_capture($params)
{
}
function bluepayremote_storeremote($params)
{
}
function navigate_activate()
{
}
function navigate_capture($params)
{
}
function navigate_refund($params)
{
}
function pagseguro_activate()
{
}
function pagseguro_link($params)
{
}
function paymentexpress_MetaData()
{
}
function paymentexpress_config()
{
}
function paymentexpress_link($params)
{
}
function mwarrior_config()
{
}
function mwarrior_capture($params)
{
}
function mwarrior_refund($params)
{
}
function mwarrior_sendRequest($url, $postData)
{
}
function getTokenX($thisString)
{
}
function protxvspform_hex2bin($hexInput)
{
}
function ccavenue_verifychecksum($MerchantId, $OrderId, $Amount, $AuthDesc, $CheckSum, $WorkingKey)
{
}
function ccavenuecb_adler32($adler, $str)
{
}
function ccavenuecb_leftshift($str, $num)
{
}
function ccavenuecb_cdec($num)
{
}
function tep_not_null($value)
{
}
function paypal_findInvoiceBySubscriptionId($subscr_id = "")
{
}
function paypal_findInvoiceByCustomId($idnumber = "")
{
}
function paypal_email_trim(&$value)
{
}
function get_invoice_status($pars)
{
}
function calc_inpay_invoice_status_md5key($pars)
{
}
function digitoVerificador_nossonumero($numero)
{
}
function digitoVerificador_barra($numero)
{
}
// FUNÇÕES
// Algumas foram retiradas do Projeto PhpBoleto e modificadas para atender as particularidades de cada banco
function formata_numero($numero, $loop, $insert, $tipo = "geral")
{
}
function fbarcode($valor)
{
}
//Fim da função
function esquerda($entra, $comp)
{
}
function direita($entra, $comp)
{
}
function fator_vencimento($data)
{
}
function _dateToDays($year, $month, $day)
{
}
function modulo_10($num)
{
}
function modulo_11($num, $base = 9, $r = 0)
{
}
function monta_linha_digitavel($codigo)
{
}
function geraCodigoBanco($numero)
{
}
function geraDv43($num)
{
}
function geraDv44($numero)
{
}
// FUNÇÕES
// Algumas foram retiradas do Projeto PhpBoleto e modificadas para atender as particularidades de cada banco
function digitoVerificador($numero)
{
}
function geraNossoNumero($ndoc, $cedente, $venc, $tipoid)
{
}
function dataJuliano($data)
{
}
function modulo_11_invertido($num)
{
}
// FUNÇÕES
// Algumas foram retiradas do Projeto PhpBoleto e modificadas para atender as particularidades de cada banco
function dvBarra(&$numero)
{
}
function paypal_config()
{
}
function paypal_link($params)
{
}
function paypal_refund($params)
{
}
function paypal_cancelSubscription(array $params)
{
}
function netbilling_activate()
{
}
function netbilling_capture($params)
{
}
function payson_activate()
{
}
function payson_link($params)
{
}
function directdebit_MetaData()
{
}
function directdebit_config()
{
}
function directdebit_localbankdetails()
{
}
function optimalpayments_MetaData()
{
}
function optimalpayments_config()
{
}
function optimalpayments_3dsecure($params)
{
}
function optimalpayments_capture($params)
{
}
function optimalpayments_cardtype($cardType)
{
}
function payflowpro_MetaData(array $params = array())
{
}
function payflowpro_config()
{
}
function payflowpro_3dsecure($params)
{
}
function payflowpro_capture($params, $auth = "")
{
}
function payflowpro_refund($params)
{
}
function gate2shop_activate()
{
}
function gate2shop_link($params)
{
}
function bp_config(array $params = array())
{
}
function bp_post_activation(array $params)
{
}
function bp_config_post_save(array $params)
{
}
function bp_link(array $params)
{
}
function ippay_config()
{
}
function ippay_capture($params)
{
}
function ippay_refund($params)
{
}
function bluepayecheck_MetaData()
{
}
function bluepayecheck_config()
{
}
function bluepayecheck_nolocalcc()
{
}
function bluepayecheck_capture($params)
{
}
function offlinecc_MetaData()
{
}
function offlinecc_config()
{
}
function gocardless_MetaData()
{
}
function gocardless_config(array $params)
{
}
function gocardless_onboarding_response_handler($params)
{
}
function gocardless_get_display_name(array $params)
{
}
function gocardless_link(array $params)
{
}
function gocardless_nolocalcc()
{
}
function gocardless_no_cc()
{
}
function gocardless_capture(array $params)
{
}
function gocardless_adminstatusmsg(array $params)
{
}
function gocardless_remote_status(array $params)
{
}
function gocardless_storeremote(array $params)
{
}
function gocardless_cancel_payment(array $params)
{
}
function gocardless_admin_area_actions(array $params)
{
}
function gocardless_list_cancelled_mandates(array $params)
{
}
function gocardless_list_mandates_for_import(array $params)
{
}
function gocardless_mandate_import_start(\WHMCS\Module\Gateway\GoCardless\Api\Client $client, $customerId)
{
}
function worldpayinvisiblexml_activate()
{
}
function worldpayinvisiblexml_3dsecure($params)
{
}
function worldpayinvisiblexml_capture($params)
{
}
function merchantpartners_activate()
{
}
function merchantpartners_capture($params)
{
}
function paymateau_activate()
{
}
function paymateau_link($params)
{
}
function quantumgateway_config()
{
}
function quantumgateway_3dsecure($params)
{
}
function quantumgateway_capture($params)
{
}
function quantumgateway_refund($params)
{
}
function monerisvault_config()
{
}
function monerisvault_storeremote($params)
{
}
function monerisvault_capture($params)
{
}
function monerisvault_refund($params)
{
}
function tco_config()
{
}
function tco_MetaData()
{
}
function tco_link(array $params = array())
{
}
function tco_refund(array $params = array())
{
}
function tco_reoccuring_request()
{
}
function tco_cancelSubscription(array $params)
{
}
function tco_curlCall($url, $apiUsername, $apiPassword, $request = "")
{
}
\define("TCO_REOCCURRING_PROCESS", \true);
function stripe_MetaData()
{
}
function _stripe_formatValue($value)
{
}
function _stripe_formatAmount($amount, $currencyCode)
{
}
function stripe_config()
{
}
function stripe_config_validate(array $params = array())
{
}
function stripe_capture(array $params = array())
{
}
function stripe_post_checkout(array $params = array())
{
}
function stripe_fraud_check_fail(array $params)
{
}
function stripe_storeremote(array $params = array())
{
}
function stripe_refund(array $params = array())
{
}
function stripe_cc_validation(array $params = array())
{
}
function stripe_credit_card_input(array $params = array())
{
}
function stripe_statement_descriptor(array $params)
{
}
function stripe_start_stripe(array $params)
{
}
function stripe_parseGatewayToken($data)
{
}
function stripe_findFirstCustomerToken(\WHMCS\User\Contracts\ContactInterface $client)
{
}
function stripe_get_existing_remote_token(array $params)
{
}
function authorizeecheck_config()
{
}
function authorizeecheck_MetaData()
{
}
function authorizeecheck_nolocalcc()
{
}
function authorizeecheck_localbankdetails()
{
}
function authorizeecheck_capture($params)
{
}
function acceptjs_MetaData()
{
}
function acceptjs_config()
{
}
function acceptjs_config_validate(array $params = array())
{
}
function acceptjs_capture(array $params = array())
{
}
function acceptjs_refund(array $params = array())
{
}
function acceptjs_storeremote(array $params = array())
{
}
function acceptjs_post_checkout(array $params = array())
{
}
function acceptjs_cc_validation(array $params = array())
{
}
function acceptjs_credit_card_input(array $params = array())
{
}
function acceptjs_findFirstCustomerToken(\WHMCS\User\Contracts\ContactInterface $client)
{
}
function cashu_activate()
{
}
function cashu_link($params)
{
}
function inpay_config()
{
}
function inpay_link($params)
{
}
function calcInpayMd5Key($order)
{
}
function skrill_config()
{
}
function skrill_nolocalcc()
{
}
function skrill_no_cc()
{
}
function skrill_link(array $params)
{
}
function skrill_capture(array $params)
{
}
function skrill_storeremote(array $params)
{
}
function skrill_refund(array $params)
{
}
function _skrill_amount($amount)
{
}
function _skrill_country_code($countryCode)
{
}
function _skrill_language($language)
{
}
function _skrill_one_tap_request(array $postFields)
{
}
function moipapi_config()
{
}
function moipapi_activate()
{
}
function moipapiformata_data($data)
{
}
function moipapiformata_estado($estado)
{
}
function moipapi_link($params)
{
}
function epath_activate()
{
}
function epath_link($params)
{
}
function worldpayfuturepay_config()
{
}
function worldpayfuturepay_nolocalcc()
{
}
function worldpayfuturepay_link($params)
{
}
function worldpayfuturepay_capture($params)
{
}
function worldpayfuturepay_adminstatusmsg($vars)
{
}
function securetrading_config()
{
}
function securetrading_capture($params)
{
}
function securetrading_refund($params)
{
}
function nochex_activate()
{
}
function nochex_link($params)
{
}
function ccavenuev2_config()
{
}
function ccavenuev2_link(array $params)
{
}
function banktransfer_config()
{
}
function banktransfer_link($params)
{
}
function paypoint_config()
{
}
function paypoint_link($params)
{
}
function boleto_config()
{
}
function boleto_link($params)
{
}
function eonlinedata_config()
{
}
function eonlinedata_capture($params)
{
}
function eonlinedata_storeremote($params)
{
}
function eonlinedata_refund($params)
{
}
function eonlinedata_adminstatusmsg($vars)
{
}
function eonlinedata_addressFix($address)
{
}
function planetauthorize_config()
{
}
function planetauthorize_capture($params)
{
}
function planetauthorize_refund($params)
{
}
function heartinternet_ClientArea($params)
{
}
function heartinternet_MetaData()
{
}
function heartinternet_ConfigOptions()
{
}
function heartinternet_CreateAccount($params)
{
}
function heartinternet_TerminateAccount($params)
{
}
function heartinternet_SuspendAccount($params)
{
}
function heartinternet_UnsuspendAccount($params)
{
}
function heartinternet_ChangePassword($params)
{
}
function heartinternet_ChangePackage($params)
{
}
function heartinternet_LoginLink($params)
{
}
function heartinternet_curlcall($xml, $verbose = "off", $params)
{
}
function heartinternet_xml2array($contents, $get_attributes = 1)
{
}
\define("field_name", "User Name");
\define("field_players", "Players");
\define("field_location", "Location");
\define("field_website", "Website");
\define("field_hostname", "Host Name");
\define("field_motd", "MOTD");
\define("field_rconpw", "RCON Password");
\define("field_serverpw", "Server Password");
function gamecp_MetaData()
{
}
function gamecp_ConfigOptions()
{
}
function gamecp_CreateAccount($params)
{
}
function gamecp_TerminateAccount($params)
{
}
function gamecp_SuspendAccount($params)
{
}
function gamecp_UnsuspendAccount($params)
{
}
function gamecp_ChangePackage($params)
{
}
function gamecp_ClientArea($params)
{
}
function gamecp_AdminLink($params)
{
}
function gamecp_LoginLink($params)
{
}
function gamecp_AdminCustomButtonArray()
{
}
function gamecp_start($params)
{
}
function gamecp_stop($params)
{
}
function curl2gcp($args, $values)
{
}
function checkStatus($r_result)
{
}
function send2curl($url, $data)
{
}
function hypervm_MetaData()
{
}
function hypervm_ConfigOptions()
{
}
function hypervm_ClientArea($params)
{
}
function hypervm_LoginLink($params)
{
}
function hypervm_AdminLink($params)
{
}
function hypervm_CreateAccount($params)
{
}
function hypervm_TerminateAccount($params)
{
}
function hypervm_SuspendAccount($params)
{
}
function hypervm_UnsuspendAccount($params)
{
}
function hypervm_ChangePackage($params)
{
}
function hypervm_AdminCustomButtonArray()
{
}
function hypervm_ClientAreaCustomButtonArray()
{
}
function hypervm_restart($params)
{
}
function lxlabs_get_via_json($protocol, $ip, $port, $username, $password, $requestString)
{
}
function lxlabs_if_error($json)
{
}
function hypervm_objectToArray($d)
{
}
\define("SERVICES_JSON_SLICE", 1);
\define("SERVICES_JSON_IN_STR", 2);
\define("SERVICES_JSON_IN_ARR", 3);
\define("SERVICES_JSON_IN_OBJ", 4);
\define("SERVICES_JSON_IN_CMT", 5);
\define("SERVICES_JSON_LOOSE_TYPE", 16);
\define("SERVICES_JSON_SUPPRESS_ERRORS", 32);
function helm4_MetaData()
{
}
function helm4_ConfigOptions()
{
}
function helm4_ClientArea($params)
{
}
function helm4_AdminLink($params)
{
}
function helm4_CreateAccount($params)
{
}
function helm4_SuspendAccount($params)
{
}
function helm4_UnsuspendAccount($params)
{
}
function helm4_TerminateAccount($params)
{
}
function helm4_ChangePackage($params)
{
}
function helm4_connect($params, $fields)
{
}
function interworx_MetaData()
{
}
function interworx_ConfigOptions()
{
}
function interworx_ClientArea($params)
{
}
function interworx_AdminLink($params)
{
}
function interworx__getSoapClient($params)
{
}
function interworx_CreateAccount($params)
{
}
function interworx_TerminateAccount($params)
{
}
function interworx_UsageUpdate($params)
{
}
function interworx_SuspendAccount($params)
{
}
function interworx_UnsuspendAccount($params)
{
}
function interworx_ChangePassword($params)
{
}
function interworx_ChangePackage($params)
{
}
function interworx_GetResellers($params)
{
}
function mediacp_MetaData()
{
}
function mcp_firstrun()
{
}
function mcp_generatePassword($length = 8)
{
}
function mcp_checkTableCreation()
{
}
function mcp_getClientPassword($customer_id, $update = \false)
{
}
function mediacp_ConfigOptions()
{
}
function mediacp_LoginLink($params)
{
}
function mediacp_CreateAccount($params)
{
}
function mediacp_TerminateAccount($params)
{
}
function mediacp_SuspendAccount($params)
{
}
function mediacp_UnsuspendAccount($params)
{
}
function mediacp_AdminCustomButtonArray()
{
}
function mediacp_start($params)
{
}
function mediacp_stop($params)
{
}
function mediacp_ChangePassword($params)
{
}
function mediacp_ClientArea($params)
{
}
function mediacp_ChangePackage($params)
{
}
function mediacp_ClientAreaCustomButtonArray()
{
}
function mediacp_api($api)
{
}
function helm_MetaData()
{
}
function helm_ConfigOptions()
{
}
function helm_ClientArea($params)
{
}
function helm_AdminLink($params)
{
}
function helm_CreateAccount($params)
{
}
function helm_TerminateAccount($params)
{
}
function helm_SuspendAccount($params)
{
}
function helm_UnsuspendAccount($params)
{
}
function helm_ChangePassword($params)
{
}
function marketconnect_MetaData()
{
}
function marketconnect_ConfigOptions()
{
}
function marketconnect_CreateAccount(array $params)
{
}
function marketconnect_TerminateAccount(array $params)
{
}
function marketconnect_Renew(array $params)
{
}
function marketconnect_SSLStepOne(array $params)
{
}
function marketconnect_SSLStepTwo(array $params)
{
}
function marketconnect_SSLStepThree(array $params)
{
}
function marketconnect_AdminCustomButtonArray(array $params)
{
}
function marketconnect_AdminServicesTabFields(array $params)
{
}
function marketconnect_ChangePackage(array $params)
{
}
function marketconnect_resend(array $params)
{
}
function marketconnect_resendApproverEmail(array $params)
{
}
function marketconnect_admin_resend_approver_email(array $params)
{
}
function marketconnect_refreshStatus(array $params)
{
}
function marketconnect_RetrieveCertificate(array $params)
{
}
function marketconnect_admin_retrieve_certificate(array $params)
{
}
function marketconnect_client_retrieve_certificate(array $params)
{
}
function marketconnect_ChangeApproverEmail(array $params, $newApproverEmail)
{
}
function marketconnect_admin_change_approver_email(array $params)
{
}
function marketconnect_client_change_approver_email(array $params)
{
}
function marketconnect_client_reissue_certificate(array $params)
{
}
function marketconnect_install_certificate(array $params)
{
}
function marketconnect_GetOrderNumber(array $params)
{
}
function marketconnect_DetermineTerm(array $params)
{
}
function marketconnect_GetServices()
{
}
function marketconnect_GetSslOrderDetails($orderNumber)
{
}
function marketconnect_manage_order(array $params)
{
}
function marketconnect_admin_sso(array $params)
{
}
function marketconnect_ClientAreaAllowedFunctions(array $params)
{
}
function marketconnect_ClientArea(array $params)
{
}
function marketconnect_get_configuration_link(array $params)
{
}
function marketconnect_update_ftp_details(array $params)
{
}
function marketconnect_resend_configuration_data(array $params)
{
}
function marketconnect_check_auto_install_panels(array $params)
{
}
function marketconnect_generate_csr(array $params)
{
}
function marketconnect_entity_specific_merge_data(array $params)
{
}
\define("CPANELCONFPACKAGEADDONLICENSE", $licensing->isActiveAddon("Configurable Package Addon"));
function cpanel_MetaData()
{
}
function cpanel_ConfigOptions(array $params)
{
}
function cpanel_costrrpl($val)
{
}
function cpanel_CreateAccount($params)
{
}
function cpanel_SuspendAccount($params)
{
}
function cpanel_UnsuspendAccount($params)
{
}
function cpanel_TerminateAccount($params)
{
}
function cpanel_ChangePassword($params)
{
}
function cpanel_ChangePackage($params)
{
}
function cpanel_UsageUpdate(array $params)
{
}
function cpanel_req($params, $request, $notxml = \false)
{
}
function cpanel_curlRequest($params, $apiCommand, $postVars, $stringsToMask = array())
{
}
function cpanel_jsonRequest($params, $apiCommand, $postVars, $stringsToMask = array())
{
}
function cpanel_ClientArea($params)
{
}
function cpanel_TestConnection($params)
{
}
function cpanel_SingleSignOn($params, $user, $service, $app = "")
{
}
function cpanel_ServiceSingleSignOn($params)
{
}
function cpanel_AdminSingleSignOn($params)
{
}
function cpanel_ClientAreaAllowedFunctions()
{
}
function cpanel_CreateEmailAccount($params)
{
}
function cpanel__addErrorToList($errorMsg, array &$errors)
{
}
function cpanel__formatErrorList(array $errors)
{
}
function cpanel_GetSupportedApplicationLinks()
{
}
function cpanel_GetRemovedApplicationLinks()
{
}
function cpanel_IsApplicationLinkingSupportedByServer($params)
{
}
function cpanel_CreateApplicationLink($params)
{
}
function cpanel_DeleteApplicationLink($params)
{
}
function cpanel_ConfirmPackageName($package, $username, array $packages)
{
}
function cpanel_ListPackages(array $params, $removeUsername = \true)
{
}
function cpanel_AutoPopulateServerConfig($params)
{
}
function cpanel_GenerateCertificateSigningRequest($params)
{
}
function cpanel_GetDocRoot($params)
{
}
function cpanel_CreateFileWithinDocRoot($params)
{
}
function cpanel_InstallSsl($params)
{
}
function cpanel_GetMxRecords(array $params)
{
}
function cpanel_DeleteMxRecords(array $params)
{
}
function cpanel_AddMxRecords(array $params)
{
}
function cpanel_CreateFTPAccount(array $params)
{
}
function cpanel_GetDns(array $params)
{
}
function cpanel_SetDnsRecord(array $params)
{
}
function cpanel_ModifyDns(array $params)
{
}
function cpanel_create_api_token(array $params)
{
}
function cpanel_request_backup(array $params)
{
}
function cpanel_list_ssh_keys(array $params)
{
}
function cpanel_generate_ssh_key(array $params)
{
}
function cpanel_fetch_ssh_key(array $params)
{
}
function cpanel_get_ssh_port(array $params)
{
}
function cpanel_ListAccounts(array $params)
{
}
function cpanel_getUserData(array $params)
{
}
function cpanel_GetUserCount(array $params)
{
}
function cpanel_GetRemoteMetaData(array $params)
{
}
function cpanel_RenderRemoteMetaData(array $params)
{
}
function cpanel_MetricItems()
{
}
function cpanel_MetricProvider(array $params)
{
}
function cpanel_GetStatsUAPI(array $params)
{
}
function cpanel_GetStats(array $params)
{
}
function cpanel_ListResellers(array $params)
{
}
function cpanel_ResellerStats(array $params)
{
}
function cpanel_hasEverythingPerm($params)
{
}
function cpanel_defineSsoSidebarLinks($sidebar)
{
}
function whmsonic_MetaData()
{
}
function whmsonic_ConfigOptions()
{
}
function whmsonic_CreateAccount($params)
{
}
function whmsonic_TerminateAccount($params)
{
}
function whmsonic_SuspendAccount($params)
{
}
function whmsonic_UnsuspendAccount($params)
{
}
function whmsonic_ClientArea($params)
{
}
function whmsonic_AdminLink($params)
{
}
function whmsonic_call($url, $auth, $data)
{
}
function resellerclubssl_MetaData()
{
}
function resellerclubssl_ConfigOptions(array $params)
{
}
function resellerclubssl_CreateAccount(array $params)
{
}
function resellerclubssl_TerminateAccount($params)
{
}
function resellerclubssl_AdminCustomButtonArray()
{
}
function resellerclubssl_resend($params)
{
}
function resellerclubssl_ClientArea($params)
{
}
function resellerclubssl_AdminServicesTabFields($params)
{
}
function resellerclubssl_SSLStepOne($params)
{
}
function resellerclubssl_SSLStepTwo($params)
{
}
function resellerclubssl_SSLStepThree($params)
{
}
function resellerclubssl_Reissue($params)
{
}
function resellerclubssl_Renew($params)
{
}
function resellerclubssl_SendCommand($command, $type, $postfields, $params, $method)
{
}
function resellerclubssl_getCertDetails($params, $option = "All")
{
}
function resellerclubssl_getOrderID($postfields, $params)
{
}
function resellerclubssl_genLBRandomPW()
{
}
function resellerclubssl_xml2array($contents, $get_attributes = 1, $priority = "tag")
{
}
function resellerclubssl_GetIP()
{
}
function resellerclubssl_Language($language)
{
}
function resellerclubssl_getSSLPlans(array $params)
{
}
function resellerclubssl_sendJsonCommand($command, $type, array $postFields, array $params, $method, $noDecode = \false)
{
}
\define("CC_TXT_MAXCLIENTS", "Max listeners");
\define("CC_TXT_MAXBITRATE", "Max bit rate");
\define("CC_TXT_XFERLIMIT", "Data transfer limit");
\define("CC_TXT_DISKQUOTA", "Disk quota");
\define("CC_TXT_MAXBW", "Max bandwidth");
\define("CC_TXT_MAXACCT", "Max accounts");
\define("CC_TXT_MOUNTLIMIT", "Mount point limit");
function centovacast_MetaData()
{
}
function centovacast_ConfigOptions()
{
}
function centovacast_QueryOneRow()
{
}
function centovacast_QueryAllRows()
{
}
function centovacast_GetCCURL($params)
{
}
function centovacast_GetServerCredentials($params, $serverapi = \false)
{
}
function centovacast_GetAPIArgs($params, &$arguments)
{
}
function centovacast_CreateAccount($params)
{
}
function centovacast_ChangePackage($params)
{
}
function centovacast_TerminateAccount($params)
{
}
function centovacast_SuspendAccount($params)
{
}
function centovacast_UnsuspendAccount($params)
{
}
function centovacast_ChangePassword($params)
{
}
function centovacast_AdminCustomButtonArray()
{
}
function centovacast_ClientArea($params)
{
}
function centovacast_AdminLink($params)
{
}
function centovacast_SetState($params, $newstate)
{
}
function centovacast_StartStream($params)
{
}
function centovacast_StopStream($params)
{
}
function centovacast_RestartStream($params)
{
}
function centovacast_UsageUpdate($params)
{
}
function scpanel_MetaData()
{
}
function scpanel_ConfigOptions()
{
}
function scpanel_AdminLink($params)
{
}
function scpanel_CreateAccount($params)
{
}
function scpanel_TerminateAccount($params)
{
}
function scpanel_SuspendAccount($params)
{
}
function scpanel_UnsuspendAccount($params)
{
}
function scpanel_AdminCustomButtonArray()
{
}
function scpanel_start($params)
{
}
function scpanel_stop($params)
{
}
function resellercentral_MetaData()
{
}
function resellercentral_ConfigOptions()
{
}
function resellercentral_CreateAccount($params)
{
}
function resellercentral_SuspendAccount($params)
{
}
function resellercentral_UnsuspendAccount($params)
{
}
function resellercentral_req($fields, $packageid = "", $accountid = "", array $params = array())
{
}
function tcadmin_MetaData()
{
}
function tcadmin_ConfigOptions()
{
}
function tcadmin_CreateAccount($params)
{
}
function tcadmin_SuspendAccount($params)
{
}
function tcadmin_UnsuspendAccount($params)
{
}
function tcadmin_TerminateAccount($params)
{
}
function tcadminsendrequest($url, $command)
{
}
function plesk_MetaData()
{
}
function plesk_ConfigOptions(array $params)
{
}
function plesk_AdminLink($params)
{
}
function plesk_ClientArea($params)
{
}
function plesk_CreateAccount($params)
{
}
function plesk_SuspendAccount($params)
{
}
function plesk_UnsuspendAccount($params)
{
}
function plesk_TerminateAccount($params)
{
}
function plesk_ChangePassword($params)
{
}
function plesk_AdminServicesTabFields($params)
{
}
function plesk_DetermineUserState($params)
{
}
function plesk_ChangePackage($params)
{
}
function plesk_UsageUpdate($params)
{
}
function plesk_TestConnection($params)
{
}
function plesk_GenerateCertificateSigningRequest(array $params)
{
}
function plesk_InstallSsl(array $params)
{
}
function plesk_GetMxRecords(array $params)
{
}
function plesk_DeleteMxRecords(array $params)
{
}
function plesk_AddMxRecords(array $params)
{
}
function plesk_CreateFileWithinDocRoot(array $params)
{
}
function plesk_ListAccounts(array $params)
{
}
function plesk_GetUserCount(array $params)
{
}
function plesk_GetRemoteMetaData(array $params)
{
}
function plesk_RenderRemoteMetaData(array $params)
{
}
function licensing_explode($vals)
{
}
function licensing_getlicreturndata($licenseid)
{
}
/**
* If you are using this file as a template for your own module, once
* you've modified the code for your use, remove the exit above.
*/
// Replace "yourprefix" with your own unique prefix to avoid conflicts with
// other instances of the licensing addon included within the same scope
function yourprefix123_check_license($licensekey, $localkey = '')
{
}
\define("LICENSINGADDONLICENSE", $licensing->isActiveAddon("Licensing Addon"));
function licensing_MetaData()
{
}
function licensing_ConfigOptions()
{
}
function licensing_genkey($length, $prefix)
{
}
function licensing_CreateAccount($params)
{
}
function licensing_SuspendAccount($params)
{
}
function licensing_UnsuspendAccount($params)
{
}
function licensing_TerminateAccount($params)
{
}
function licensing_AdminCustomButtonArray()
{
}
function licensing_ClientAreaCustomButtonArray($params)
{
}
function licensing_reissue($params)
{
}
function licensing_reissuereset($params)
{
}
function licensing_revoke($params)
{
}
function licensing_manage($params)
{
}
function licensing_valid_input_clean($vals)
{
}
function licensing_AdminServicesTabFields($params)
{
}
function licensing_AdminServicesTabFieldsSave($params)
{
}
function licensing_ChangePackage($params)
{
}
function licensing_ClientArea($params)
{
}
function licensing_does_license_exist(array $params)
{
}
function licensing_get_license(array $params)
{
}
function virtualmin_MetaData()
{
}
function virtualmin_ConfigOptions()
{
}
function virtualmin_ClientArea(array $params)
{
}
function virtualmin_AdminLink(array $params)
{
}
function virtualmin_CreateAccount($params)
{
}
function virtualmin_SuspendAccount($params)
{
}
function virtualmin_UnsuspendAccount($params)
{
}
function virtualmin_TerminateAccount($params)
{
}
function virtualmin_ChangePassword($params)
{
}
function virtualmin_ChangePackage($params)
{
}
function virtualmin_UsageUpdate($params)
{
}
function virtualmin_req($params, $postfields, $rawdata = \false)
{
}
function autorelease_MetaData()
{
}
function autorelease_ConfigOptions()
{
}
function autorelease_CreateAccount($params)
{
}
function autorelease_SuspendAccount($params)
{
}
function autorelease_UnsuspendAccount($params)
{
}
function autorelease_TerminateAccount($params)
{
}
function autorelease_Renew($params)
{
}
function enomssl_MetaData()
{
}
function enomssl_ConfigOptions(array $params)
{
}
function enomssl_CreateAccount($params)
{
}
function enomssl_TerminateAccount($params)
{
}
function enomssl_AdminCustomButtonArray()
{
}
function enomssl_resend($params)
{
}
function enomssl_ClientArea($params)
{
}
function enomssl_AdminServicesTabFields($params)
{
}
function enomssl_SSLStepOne($params)
{
}
function enomssl_SSLStepTwo($params)
{
}
function enomssl_SSLStepThree($params)
{
}
function enomssl_call($fields, $testmode = "")
{
}
\define("DACONFPACKAGEADDONLICENSE", $licensing->isActiveAddon("Configurable Package Addon"));
function directadmin_MetaData()
{
}
function directadmin_ConfigOptions(array $params)
{
}
function directadmin_ClientArea($params)
{
}
function directadmin_AdminLink($params)
{
}
function directadmin_CreateAccount($params)
{
}
function directadmin_TerminateAccount($params)
{
}
function directadmin_SuspendAccount($params)
{
}
function directadmin_UnsuspendAccount($params)
{
}
function directadmin_ChangePassword($params)
{
}
function directadmin_ChangePackage($params)
{
}
function directadmin_UsageUpdate($params)
{
}
function directadmin_req($command, $fields, $params, $post = \false)
{
}
function directadmin_unhtmlentities($string)
{
}
function directadmin_TestConnection(array $params)
{
}
function directadmin_GenerateCertificateSigningRequest(array $params)
{
}
function directadmin_InstallSsl(array $params)
{
}
function directadmin_GetMxRecords(array $params)
{
}
function directadmin_DeleteMxRecords(array $params)
{
}
function directadmin_AddMxRecords(array $params)
{
}
function directadmin_CreateFileWithinDocRoot(array $params)
{
}
function directadmin_CreateFTPAccount(array $params)
{
}
function directadmin_ListAccounts(array $params)
{
}
function directadmin_GetUserCount(array $params)
{
}
function directadmin_GetRemoteMetaData(array $params)
{
}
function directadmin_RenderRemoteMetaData(array $params)
{
}
function directadmin_MetricItems()
{
}
function directadmin_MetricProvider(array $params)
{
}
function directadmin_GetStats(array $params)
{
}
function cloudmin_MetaData()
{
}
function cloudmin_ConfigOptions()
{
}
function cloudmin_CreateAccount($params)
{
}
function cloudmin_SuspendAccount($params)
{
}
function cloudmin_UnsuspendAccount($params)
{
}
function cloudmin_TerminateAccount($params)
{
}
function cloudmin_AdminCustomButtonArray()
{
}
function cloudmin_ClientAreaCustomButtonArray()
{
}
function cloudmin_reboot($params)
{
}
function cloudmin_startup($params)
{
}
function cloudmin_shutdown($params)
{
}
function cloudmin_req($params, $postfields)
{
}
function websitepanel_MetaData()
{
}
function websitepanel_ConfigOptions()
{
}
function websitepanel_CreateAccount($params)
{
}
function websitepanel_call($params, $func, $param, $retdata = "")
{
}
function websitepanel_TerminateAccount($params)
{
}
function websitepanel_SuspendAccount($params)
{
}
function websitepanel_UnsuspendAccount($params)
{
}
function websitepanel_ChangePassword($params)
{
}
function websitepanel_ChangePackage($params)
{
}
function websitepanel_ClientArea($params)
{
}
function websitepanel_AdminLink($params)
{
}
function websitepanel_LoginLink($params)
{
}
function websitepanel_getuserid($params)
{
}
function websitepanel_getpackageid($params, $user)
{
}
function websitepanel_UsageUpdate($params)
{
}
function websitepanel_getBandwidth($params, $packageID, $startDate)
{
}
function websitepanel_getDiskspace($params, $packageID)
{
}
function websitepanel_calculateDate($date)
{
}
function globalsignssl_MetaData()
{
}
function globalsignssl_ConfigOptions()
{
}
function globalsignssl_CreateAccount($params)
{
}
function globalsignssl_AdminCustomButtonArray()
{
}
function globalsignssl_cancel($params)
{
}
function globalsignssl_resend($params)
{
}
function globalsignssl_resendapprover($params)
{
}
function globalsignssl_ClientArea($params)
{
}
function globalsignssl_SSLStepOne($params)
{
}
function globalsignssl_SSLStepTwo($params)
{
}
function globalsignssl_SSLStepThree($params)
{
}
function vpsnet_MetaData()
{
}
function vpsnet_ConfigOptions($params)
{
}
function vpsnet_CreateAccount($params)
{
}
function vpsnet_SuspendAccount($params)
{
}
function vpsnet_UnsuspendAccount($params)
{
}
function vpsnet_TerminateAccount($params)
{
}
function vpsnet_ChangePackage($params)
{
}
function vpsnet_AdminCustomButtonArray()
{
}
function vpsnet_poweron($params)
{
}
function vpsnet_poweroff($params)
{
}
function vpsnet_reboot($params)
{
}
function vpsnet_shutdown($params)
{
}
function vpsnet_rebuild($params)
{
}
function vpsnet_recover($params)
{
}
function vpsnet_reinstall($params)
{
}
function vpsnet_snapshotbackup($params)
{
}
function vpsnet_restorebackup($params)
{
}
function vpsnet_deletebackup($params)
{
}
function vpsnet_managebackups($params)
{
}
function vpsnet_AdminServicesTabFields($params)
{
}
function vpsnet_ClientAreaAllowedFunctions()
{
}
function vpsnet_cpugraphs($params)
{
}
function vpsnet_networkgraphs($params)
{
}
function vpsnet_call($params, $action, $id, $reqtype = "", $type = "virtual_machines", $data = "", $nojsonencode = "")
{
}
function vpsnet_GetCredentials()
{
}
function vpsnet_ClientArea($params)
{
}
function twitter_getTwitterIntents($username, $version)
{
}
function bulkpricingupdater_config()
{
}
function bulkpricingupdater_output($vars)
{
}
function google_analytics_hook_checkout_tracker($vars)
{
}
function google_analytics_hook_page_tracking($vars)
{
}
function google_analytics_config()
{
}
function google_analytics_output($vars)
{
}
function paypal_addon_config()
{
}
function paypal_addon_output($vars)
{
}
function widget_paypal_addon($vars)
{
}
function widget_staffboard_overview($vars)
{
}
function staffboard_config()
{
}
function staffboard_activate()
{
}
function staffboard_deactivate()
{
}
function staffboard_menubar($vars)
{
}
function staffboard_output($vars)
{
}
function hook_licensing_addon_log_prune($vars)
{
}
function hook_licensing_addon_search($vars)
{
}
function licensing_config()
{
}
function licensing_activate()
{
}
function licensing_deactivate()
{
}
function licensing_addon_valid_input_clean($vals)
{
}
function licensing_output($vars)
{
}
function licensing_clientarea($vars)
{
}
\define("PMADDONLICENSE", $licensing->isActiveAddon("Project Management Addon"));
function project_management_MetaData()
{
}
function project_management_config()
{
}
function project_management_activate()
{
}
function project_management_deactivate()
{
}
function project_management_email_templates()
{
}
function project_management_upgrade(array $vars = array())
{
}
function project_management_output($vars)
{
}
function project_management_daysleft($duedate, $vars)
{
}
function project_management_tasksstatus($projectid, $vars)
{
}
function project_management_log($projectid, $msg)
{
}
function project_management_sec2hms($sec, $padHours = \false)
{
}
function project_management_checkperm($perm)
{
}
function project_management_permslist()
{
}
function project_management_check_viewproject($projectid, $adminid = "")
{
}
function project_management_check_masteradmin($PMRoleID = "", $adminid = "")
{
}
function project_management_clientarea($vars)
{
}
function pm_get_gravatar($email, $s = 80, $d = "mm", $r = "g", $img = \false, $atts = array())
{
}
function hook_project_management_csoactions($vars)
{
}
function hook_project_management_adminticketinfo($vars)
{
}
function project_management_hook_daysleft($duedate)
{
}
function hook_project_management_calendar($vars)
{
}
function hook_project_management_calendar_tasks($vars)
{
}
function project_staff_logs_time($sec, $padHours = \false)
{
}
function project_task_logs_time($sec, $padHours = \false)
{
}
function mailchimp_config()
{
}
function mailchimp_activate()
{
}
function mailchimp_deactivate()
{
}
function mailchimp_output($vars)
{
}
function newtlds_config()
{
}
function newtlds_activate()
{
}
function newtlds_deactivate()
{
}
function newtlds_upgrade($vars)
{
}
function newtlds_clientarea($vars)
{
}
function newtlds_NEWTLDS_sidebar($vars)
{
}
function newtlds_DB_GetCreateTable()
{
}
function newtlds_DB_GetCreateHookTable()
{
}
function newtlds_DB_GetDefaults()
{
}
function newtlds_DB_GetWatchlistSettingsLocal()
{
}
function newtlds_DB_GetWatchlistPortalExists()
{
}
function newtlds_DB_TableExists()
{
}
function newtlds_DB_HookTableExists()
{
}
function newtlds_DB_GetWatchlistIsEnabled()
{
}
function newtlds_DB_UpdateDB($vars, $portalid = "0")
{
}
function newtlds_DB_BootstrapUidPw($enomuid, $enompw)
{
}
function newtlds_DB_GetDefaultcompanyname()
{
}
function newtlds_DB_GetDefaultDomainName()
{
}
function newtlds_DB_GetDefaultSupportEmail()
{
}
function newtlds_Helper_GetDateTime()
{
}
function newtlds_Helper_IsNullOrEmptyString($str)
{
}
function newtlds_Helper_FormatDomain($domainname)
{
}
function newtlds_Helper_startsWith($haystack, $needle)
{
}
function newtlds_Helper_endsWith($haystack, $needle)
{
}
function newtlds_AddError($error)
{
}
function newtlds_Helper_FormatAPICallForEmail($fields, $environment)
{
}
function newtlds_Helper_GetAPIHost($environment)
{
}
function newtlds_Helper_GetDocumentationHost($environment)
{
}
function newtlds_Helper_GetWatchlistHost($environment)
{
}
function newtlds_Helper_Getenvironment($environment)
{
}
function newtlds_Helper_GetWatchlistUrl($domain = "")
{
}
function newtlds_API_GetPortalToken($vars, &$token, $fields)
{
}
function newtlds_API_HandleErrors($xmldata)
{
}
function newtlds_API_CreatePortalAccount($vars, &$portalid, $fields)
{
}
function newtlds_API_UpdatePortalAccount($vars, $portalid, $fields)
{
}
function newtlds_API_GetPortalAccount($vars, &$portalid)
{
}
function newtlds_API_CallEnom($vars, $postfields)
{
}
function newtlds_output($vars)
{
}
function newtlds__hook_cronjob()
{
}
function newtlds__hook_ProcessBatch($data, $returnedCount, $totalCount, $batch)
{
}
function newtlds__hook_ProcessDomains($xmldata, $returnedCount, $totalCount, $batch)
{
}
function newtlds__hook_DumpProcessedDomains()
{
}
function newtlds__hook_DB_GetSystemDefaultGateway()
{
}
function newtlds__hook_DB_GetUserDefaultGateway($userid)
{
}
function newtlds__hook_DB_GetCreateHookTable()
{
}
function newtlds__hook_DB_TableExists()
{
}
function newtlds__hook_DB_GetWatchlistSettingsLocal()
{
}
function newtlds__hook_DB_InsertDomain($domain)
{
}
function newtlds__hook_DB_GetBatchSize()
{
}
function newtlds__hook_DB_InsertIntoCronTable($values)
{
}
function newtlds__hook_DB_UpdateProvisionedCronTable($domains)
{
}
function newtlds__hook_DB_DomainExists($domain)
{
}
function newtlds__hook_Helper_Log($String)
{
}
function newtlds__hook_Helper_Log2($String)
{
}
function newtlds__hook_Helper_GetDateTime()
{
}
function newtlds__hook_Helper_IsNullOrEmptyString($str)
{
}
function newtlds__hook_Helper_startsWith($haystack, $needle)
{
}
function newtlds__hook_Helper_endsWith($haystack, $needle)
{
}
function newtlds__hook_Helper_FormatAPICallForEmail($fields, $environment)
{
}
function newtlds__hook_Helper_GetAPIHost($environment)
{
}
function newtlds__hook_Helper_GetWatchlistHost($environment)
{
}
function newtlds__hook_Helper_Getenvironment($environment)
{
}
function newtlds__hook_Helper_SendEmail($to, $subject, $message)
{
}
function newtlds__hook_AddDomainToUpdateList($domain)
{
}
function newtlds__hook_AddError($error)
{
}
function newtlds__hook_AddMessage($message)
{
}
function newtlds__hook_API_GetAwardedDomains($fields)
{
}
function newtlds__hook_API_SetAwardedDomains($fields)
{
}
function newtlds__hook_API_CallEnom($postfields)
{
}
function newtlds_hook_clientareahomeoutput()
{
}
function fraudlabs_MetaData()
{
}
function fraudlabs_getConfigArray()
{
}
function fraudlabs_doFraudCheck(array $params, $checkOnly = \false)
{
}
function fraudlabs_processResultsForDisplay(array $params)
{
}
function maxmind_MetaData()
{
}
function maxmind_getConfigArray()
{
}
function maxmind_activate(array $params = array())
{
}
function maxmind_doFraudCheck(array $params, $checkOnly = \false)
{
}
function maxmind_processResultsForDisplay(array $params)
{
}
function heartinternet_getConfigArray()
{
}
function heartinternet_RegisterDomain($params)
{
}
function heartinternet_TransferDomain($params)
{
}
function heartinternet_RenewDomain($params)
{
}
function heartinternet_GetNameservers($params)
{
}
function heartinternet_SaveNameservers($params)
{
}
function heartinternet_Sync($params)
{
}
function heartinternetreg_curlcall($xml, $verbose = "off", $params)
{
}
function heartinternetreg_createContact($params)
{
}
function heartinternetreg_xml2array($contents, $get_attributes = 1)
{
}
function ipmirror_getConfigArray()
{
}
function ipmirror_GetNameservers($params)
{
}
function ipmirror_SaveNameservers($params)
{
}
function ipmirror_GetRegistrarLock($params)
{
}
function ipmirror_SaveRegistrarLock($params)
{
}
function ipmirror_GetEmailForwarding($params)
{
}
function ipmirror_SaveEmailForwarding($params)
{
}
function ipmirror_GetDNS($params)
{
}
function ipmirror_SaveDNS($params)
{
}
function ipmirror_RegisterDomain($params)
{
}
function ipmirror_TransferDomain($params)
{
}
function ipmirror_RenewDomain($params)
{
}
function ipmirror_GetContactDetails($params)
{
}
function ipmirror_SaveContactDetails($params)
{
}
function ipmirror_RegisterNameserver($params)
{
}
function ipmirror_ModifyNameserver($params)
{
}
function ipmirror_DeleteNameserver($params)
{
}
function ipmirror_TransferSync($params)
{
}
function ipmirror_Sync($params)
{
}
function _ipmirror_init($params, $function)
{
}
function _ipmirror_printArray($arr)
{
}
function _ipmirror_initGlobals($params)
{
}
function _ipmirror_callRapi($cmd, $params)
{
}
function _ipmirror_getErrorMsg()
{
}
function _ipmirror_formatPhone($phone)
{
}
function _ipmirror_GetNameservers($params)
{
}
function _ipmirror_SaveNameservers($params)
{
}
function _ipmirror_RegisterNameserver($params)
{
}
function _ipmirror_ModifyNameserver($params)
{
}
function _ipmirror_DeleteNameserver($params)
{
}
function _ipmirror_GetRegistrarLock($params)
{
}
function _ipmirror_SaveRegistrarLock($params)
{
}
function _ipmirror_GetEmailForwarding($params)
{
}
function _ipmirror_SaveEmailForwarding($params)
{
}
function _ipmirror_GetDNS($params)
{
}
function _ipmirror_SaveDNS($params)
{
}
function _ipmirror_getZoneRecords($dName)
{
}
function _ipmirror_RegisterDomain($params)
{
}
function _ipmirror_TransferDomain($params)
{
}
function _ipmirror_createTransferDomain($mode, $params)
{
}
function _ipmirror_createContact($params, $contactCode)
{
}
function _ipmirror_getClientDefContact($clientId, $contactCode)
{
}
function _ipmirror_getClientCustFieldValue($clientId, $fieldName)
{
}
function _ipmirror_checkCreateNameservers($params)
{
}
function _ipmirror_getIPAddress($host, $timeout = 3, $tries = 1)
{
}
function _ipmirror_RenewDomain($params)
{
}
function _ipmirror_hasSafestWhois($dName)
{
}
function _ipmirror_GetContactDetails($params)
{
}
function _ipmirror_extractContactDetails($Id, $type, $result)
{
}
function _ipmirror_SaveContactDetails($params)
{
}
function _ipmirror_updateContactDetails($oldContact, $newContact, $usePredefinedContact)
{
}
function _ipmirror_TransferSync($params)
{
}
function _ipmirror_Sync($params)
{
}
function _ipmirror_rapi_queryContact($contactID)
{
}
function _ipmirror_rapi_createContact($type, $orgName, $rcbID, $title, $firstName, $lastName, $street1, $street2, $city, $postalCode, $state, $country, $tel, $fax, $email)
{
}
function _ipmirror_rapi_updateContact($contactId, $type, $title, $firstName, $lastName, $street1, $street2, $city, $postalCode, $state, $tel, $fax, $email)
{
}
function _ipmirror_rapi_deleteContact($contactID)
{
}
function _ipmirror_rapi_queryDomain($dName)
{
}
function _ipmirror_rapi_createDomain($dName, $term, $regID, $adminID, $techID, $billID, $ns1, $ns2, $ns3, $ns4, $idprotection)
{
}
function _ipmirror_rapi_transferIn($dName, $term, $authCode, $regID, $adminID, $techID, $billID)
{
}
function _ipmirror_rapi_renewDomain($dName, $term)
{
}
function _ipmirror_rapi_changeDNS($dName, $ns1, $ns2, $ns3, $ns4)
{
}
function _ipmirror_rapi_updateStatus($dName, $type)
{
}
function _ipmirror_rapi_queryDomainService($dName, $serviceName)
{
}
function _ipmirror_rapi_checkHost($ns)
{
}
function _ipmirror_rapi_createHost($ns, $ns_ip)
{
}
function _ipmirror_rapi_updateHost($ns, $ns_ip)
{
}
function _ipmirror_rapi_deleteHost($ns)
{
}
function _ipmirror_rapi_queryZone($dName)
{
}
function _ipmirror_rapi_queryZoneRecord($id)
{
}
function _ipmirror_rapi_createZoneRecord($dName, $detailType, $source, $priority, $destination)
{
}
function _ipmirror_rapi_updateZoneRecord($dName, $id, $source, $priority, $destination)
{
}
function _ipmirror_rapi_deleteZoneRecord($dName, $id)
{
}
function _ipmirror_rapi_createWebForwardingRecord($dName, $detailType, $source, $destination, $title, $metaDesc, $metaKey)
{
}
function _ipmirror_rapi_updateWebForwardingRecord($dName, $id, $detailType, $source, $destination, $title, $metaDesc, $metaKey)
{
}
function _ipmirror_rapi_deleteWebForwardingRecord($dName, $id)
{
}
function _ipmirror_rapi_createEmailForwardingRecord($dName, $source, $destination)
{
}
function _ipmirror_rapi_updateEmailForwardingRecord($dName, $id, $source, $destination)
{
}
function _ipmirror_rapi_deleteEmailForwardingRecord($dName, $id)
{
}
function registercom_getConfigArray()
{
}
function registercom_GetNameservers($params)
{
}
function registercom_SaveNameservers($params)
{
}
function registercom_GetRegistrarLock($params)
{
}
function registercom_SaveRegistrarLock($params)
{
}
function registercom_RegisterDomain($params)
{
}
function registercom_TransferDomain($params)
{
}
function registercom_RenewDomain($params)
{
}
function registercom_GetContactDetails($params)
{
}
function registercom_SaveContactDetails($params)
{
}
function registercom_xml2array($contents, $get_attributes = 1)
{
}
function registercom_curlCall($xml, $params)
{
}
function registercom_GetProductIdByDomain($domain, $params)
{
}
function rrpproxy_getConfigArray()
{
}
function rrpproxy_call($params, $request)
{
}
function rrpproxy_GetNameservers($params)
{
}
function rrpproxy_SaveNameservers($params)
{
}
function rrpproxy_RegisterDomain($params)
{
}
function rrpproxy_TransferDomain($params)
{
}
function rrpproxy_RenewDomain($params)
{
}
function rrpproxy_GetContactDetails($params)
{
}
function rrpproxy_SaveContactDetails($params)
{
}
function rrpproxy_GetEPPCode($params)
{
}
\define("HEXONET_MODULE_VERSION", "1.0.61");
function hexonet_getConfigArray()
{
}
function hexonet_CheckAvailability($params)
{
}
function hexonet_GetDomainSuggestions($params)
{
}
function hexonet_DomainSuggestionOptions()
{
}
function hexonet_GetPremiumPrice(array $params)
{
}
function hexonet_getRenewPrice($params, $class, $cur_id, $tld)
{
}
function hexonet_getUserRelationValue($params, $relationtype)
{
}
function hexonet_getUserRelations($params)
{
}
function hexonet_ClientAreaCustomButtonArray($params)
{
}
function hexonet_dnssec($params)
{
}
function hexonet_GetRegistrarLock($params)
{
}
function hexonet_SaveRegistrarLock($params)
{
}
function hexonet_GetEPPCode($params)
{
}
function hexonet_GetNameservers($params)
{
}
function hexonet_SaveNameservers($params)
{
}
function hexonet_GetDNS($params)
{
}
function hexonet_SaveDNS($params)
{
}
function hexonet_GetEmailForwarding($params)
{
}
function hexonet_SaveEmailForwarding($params)
{
}
function hexonet_GetContactDetails($params)
{
}
function hexonet_SaveContactDetails($params)
{
}
function hexonet_RegisterNameserver($params)
{
}
function hexonet_ModifyNameserver($params)
{
}
function hexonet_DeleteNameserver($params)
{
}
function hexonet_IDProtectToggle($params)
{
}
function hexonet_RegisterDomain($params)
{
}
function hexonet_TransferDomain($params)
{
}
function hexonet_RenewDomain($params)
{
}
function hexonet_ReleaseDomain($params)
{
}
function hexonet_RequestDelete($params)
{
}
function hexonet_TransferSync($params)
{
}
function hexonet_Sync($params)
{
}
function hexonet_get_contact_info($contact, &$params)
{
}
function hexonet_query_additionalfields(&$params)
{
}
function hexonet_config($params)
{
}
function hexonet_call($command, $config)
{
}
function hexonet_call_raw($command, $config)
{
}
function hexonet_to_punycode($domain)
{
}
function hexonet_encode_command($commandarray)
{
}
function hexonet_parse_response($response)
{
}
function opensrs_getConfigArray()
{
}
function opensrs_config_validate(array $params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_GetNameservers($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_SaveNameservers($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_GetRegistrarLock($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_SaveRegistrarLock($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_RegisterDomain($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_TransferDomain($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_RenewDomain($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_GetContactDetails($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_SaveContactDetails($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_GetEPPCode($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_getusername($domain)
{
}
function opensrs_getpassword($domainid, $domain)
{
}
function opensrs_RegisterNameserver($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_DeleteNameserver($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_ModifyNameserver($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_AdminDomainsTabFields($params)
{
}
function opensrs_AdminDomainsTabFieldsSave($params)
{
}
function opensrs_Sync($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_TransferSync($params, \openSRS_base $O = \NULL, $moduleName = "opensrs")
{
}
function opensrs_Connect($username, $privateKey, $testMode = \false)
{
}
function email_getConfigArray()
{
}
function email_GetNameservers($params)
{
}
/**
* Sends the passed nameservers to the defined email address
* @param array $params The built array of data to save the nameservers
*/
function email_SaveNameservers($params)
{
}
function email_RegisterDomain($params)
{
}
function email_TransferDomain($params)
{
}
function email_RenewDomain($params)
{
}
function transip_getContactTypeMapping()
{
}
function transip_getContactFieldMapping()
{
}
function transip_getConfigArray()
{
}
function transip_initialize($params)
{
}
function transip_splitAddress($address)
{
}
function transip_convertAddress($address)
{
}
function transip_getContactsForRegisterAndTransfer($data)
{
}
function transip_whoisContactsToContactDetails($contacts)
{
}
function transip_contactDetailsToWhoisContacts($contactDetails)
{
}
function transip_GetNameservers($params)
{
}
function transip_SaveNameservers($params)
{
}
function transip_GetRegistrarLock($params)
{
}
function transip_SaveRegistrarLock($params)
{
}
function transip_GetDNS($params)
{
}
function transip_SaveDNS($params)
{
}
function transip_RegisterDomain($params)
{
}
function transip_TransferDomain($params)
{
}
function transip_RenewDomain($params)
{
}
function transip_GetContactDetails($params)
{
}
function transip_SaveContactDetails($params)
{
}
function transip_GetEPPCode($params)
{
}
function resellerclub_MetaData()
{
}
function resellerclub_GetConfigArray()
{
}
function resellerclub_config_validate(array $params)
{
}
function resellerclub_GetNameservers($params)
{
}
function resellerclub_SaveNameservers($params)
{
}
function resellerclub_GetRegistrarLock($params)
{
}
function resellerclub_SaveRegistrarLock($params)
{
}
function resellerclub_isCanonIndividual($contacttype, $legalType)
{
}
function resellerclub_RegisterDomain($params)
{
}
function resellerclub_TransferDomain($params)
{
}
function resellerclub_RenewDomain($params)
{
}
function resellerclub_GetContactDetails($params)
{
}
function resellerclub_SaveContactDetails($params)
{
}
function resellerclub_GetEPPCode($params)
{
}
function resellerclub_RegisterNameserver($params)
{
}
function resellerclub_ModifyNameserver($params)
{
}
function resellerclub_DeleteNameserver($params)
{
}
function resellerclub_RequestDelete($params)
{
}
function resellerclub_GetDNS($params)
{
}
function resellerclub_SaveDNS($params)
{
}
function resellerclub_GetEmailForwarding($params)
{
}
function resellerclub_SaveEmailForwarding($params)
{
}
function resellerclub_ReleaseDomain($params)
{
}
function resellerclub_IDProtectToggle($params)
{
}
function resellerclub_AdminCustomButtonArray()
{
}
function resellerclub_resendtransferapproval($params)
{
}
function resellerclub_canceldomaintransfer($params)
{
}
function resellerclub_SendCommand($command, $type, $postfields, $params, $method, $jsonDecodeResult = \false)
{
}
function resellerclub_getOrderID($postfields, $params)
{
}
function resellerclub_genLBRandomPW()
{
}
function resellerclub_xml2array($contents, $get_attributes = 1, $priority = "tag")
{
}
function resellerclub_ContactTLDSpecificFields($params)
{
}
function resellerclub_DomainTLDSpecificFields($params, $contactid, $isPremium = \false)
{
}
function resellerclub_Sync($params)
{
}
function resellerclub_TransferSync($params)
{
}
function resellerclub_DomainSync($registrar)
{
}
function resellerclub_Language($language)
{
}
function resellerclub_ClientAreaCustomButtonArray($params)
{
}
function resellerclub_UpdateXXX($params)
{
}
function resellerclub_validateABN($abn)
{
}
function resellerclub_ContactType($params)
{
}
function resellerclub_addCustomer($params)
{
}
function resellerclub_addContact(array $params, $customerid, $contacttype, $canonindv = \false, $singleContact = \false)
{
}
function resellerclub_getClientEmail($userid)
{
}
function resellerclub_addCOOPSponsor($params, $customerid)
{
}
function resellerclub_getDomainName(\WHMCS\Domains\Domain $domain, $skipFilter = \false)
{
}
function resellerclub_CheckAvailability(array $params)
{
}
function resellerclub_GetDomainSuggestions(array $params)
{
}
function resellerclub_GetPremiumPrice(array $params)
{
}
function resellerclub_GetDomainExtensionGroup()
{
}
function resellerclub_DomainSuggestionOptions()
{
}
function resellerclub_GetDomainInformation(array $params)
{
}
function resellerclub_ResendIRTPVerificationEmail(array $params)
{
}
function resellerclub_normalise_status($status)
{
}
function resellerclub_tld_type(array $params = array())
{
}
function resellerclub_GetTldPricing(array $params)
{
}
function resellerclub_get_reseller_details(array $params)
{
}
function resellerclub_get_pricing_data(array $params)
{
}
function resellerclub_get_category_data(array $params)
{
}
function resellerclub_get_tld_to_category_map(array $params)
{
}
function resellerclub_get_currencies_data(array $params)
{
}
function bizcn_getConfigArray()
{
}
function bizcn_GetNameservers($params)
{
}
function bizcn_SaveNameservers($params)
{
}
function bizcn_GetRegistrarLock($params)
{
}
function bizcn_SaveRegistrarLock($params)
{
}
function bizcn_GetEmailForwarding($params)
{
}
function bizcn_SaveEmailForwarding($params)
{
}
function bizcn_GetDNS($params)
{
}
function bizcn_SaveDNS($params)
{
}
function bizcn_RegisterDomain($params)
{
}
function bizcn_TransferDomain($params)
{
}
function bizcn_RenewDomain($params)
{
}
function bizcn_GetContactDetails($params)
{
}
function bizcn_SaveContactDetails($params)
{
}
function bizcn_GetEPPCode($params)
{
}
function bizcn_RegisterNameserver($params)
{
}
function bizcn_ModifyNameserver($params)
{
}
function bizcn_DeleteNameserver($params)
{
}
function com_71_call($params, $testModel = \false)
{
}
function nominet_HideReleaseDomain(\WHMCS\View\Menu\Item $primarySidebar)
{
}
function nominet_getConfigArray()
{
}
function nominet_config_validate(array $params)
{
}
function nominet_GetNameservers($params)
{
}
function nominet_SaveNameservers($params)
{
}
function nominet_getLegalTypeID($LegalType)
{
}
function nominet_RegisterDomain($params)
{
}
function nominet_TransferDomain(array $params)
{
}
function nominet_RenewDomain($params)
{
}
function nominet_GetContactDetails($params)
{
}
function nominet_SaveContactDetails($params)
{
}
function nominet_ReleaseDomain($params)
{
}
function nominet_TransferSync(array $params)
{
}
function nominet_Sync(array $params, $type = "Active")
{
}
function nominet_createContact($nominet, $params)
{
}
function nominet_createHost($nominet, $ns = array())
{
}
function godaddy_MetaData()
{
}
function godaddy_getConfigArray()
{
}
function godaddy_config_validate(array $params)
{
}
function godaddy_RegisterDomain(array $params)
{
}
function godaddy_RenewDomain(array $params)
{
}
function godaddy_TransferDomain(array $params)
{
}
function godaddy_SaveRegistrarLock(array $params)
{
}
function godaddy_SaveNameservers(array $params)
{
}
function godaddy_GetDomainInformation(array $params)
{
}
function godaddy_ResendIRTPVerificationEmail(array $params)
{
}
function godaddy_GetContactDetails(array $params)
{
}
function godaddy_SaveContactDetails(array $params)
{
}
function godaddy_GetEPPCode(array $params)
{
}
function godaddy_IDProtectToggle(array $params)
{
}
function godaddy_Sync(array $params)
{
}
function godaddy_TransferSync(array $params)
{
}
function godaddy_AdditionalDomainFields(array $params)
{
}
function godaddy_find_shopper_id(array $params)
{
}
function godaddy_normalise_status($status)
{
}
function godaddy_generate_random_password()
{
}
function godaddy_additional_fields(array $params)
{
}
function webnic_getConfigArray()
{
}
function webnic_GetNameservers($params)
{
}
function webnic_SaveNameservers($params)
{
}
function webnic_GetRegistrarLock($params)
{
}
function webnic_SaveRegistrarLock($params)
{
}
function webnic_RegisterDomain($params)
{
}
function webnic_TransferDomain($params)
{
}
function webnic_RenewDomain($params)
{
}
function webnic_GetContactDetails($params)
{
}
function webnic_SaveContactDetails($params)
{
}
function webnic_IDProtectToggle($params)
{
}
function webnic_call($url, $rtype, $postfields, $params)
{
}
function webnic_isCountryInAsia($countrycode)
{
}
function onlinenic_getConfigArray()
{
}
function onlinenic_config_validate(array $params)
{
}
function onlinenic_GetNameservers($params)
{
}
function onlinenic_SaveNameservers($params)
{
}
function onlinenic_GetRegistrarLock($params)
{
}
function onlinenic_SaveRegistrarLock($params)
{
}
function onlinenicX_GetDNS($params)
{
}
function onlinenicX_SaveDNS($params)
{
}
function onlinenic_RegisterDomain($params)
{
}
function onlinenic_FormatPhone($telephone, $country)
{
}
function onlinenic_RegisterContact($fp, $username, $password, $domain_type, $firstname, $lastname, $companyname, $address1, $address2, $city, $province, $country, $postalcode, $telephone, $fax, $email)
{
}
function onlinenic_TransferDomain($params)
{
}
function onlinenic_RenewDomain($params)
{
}
function onlinenic_GetContactDetails($params)
{
}
function onlinenic_SaveContactDetails($params)
{
}
function onlinenic_RegisterNameserver($params)
{
}
function onlinenic_ModifyNameserver($params)
{
}
function onlinenic_DeleteNameserver($params)
{
}
function onlinenic_GetExpirationDate($fp, $username, $password, $domainname, $domainext)
{
}
function onlinenic_Logout($fp, $username, $password)
{
}
function onlinenic_GetValue($msg, $str1, $str2)
{
}
function onlinenic_getResultCode($result)
{
}
function onlinenic_Login(&$fp, $username, $password, $testmode)
{
}
function onlinenic_getDomainType($tld, $sld)
{
}
function onlinenic_getResultText($resultCode)
{
}
function onlinenic_sendCommand($fp, $command, $username = "", $password = "")
{
}
function onlinenic_genpw()
{
}
function onlinenic_Sync($params)
{
}
function stargate_MetaData()
{
}
function stargate_GetConfigArray()
{
}
function stargate_config_validate($params)
{
}
function stargate_GetNameservers($params)
{
}
function stargate_SaveNameservers($params)
{
}
function stargate_GetRegistrarLock($params)
{
}
function stargate_SaveRegistrarLock($params)
{
}
function stargate_RegisterDomain($params)
{
}
function stargate_TransferDomain($params)
{
}
function stargate_RenewDomain($params)
{
}
function stargate_GetContactDetails($params)
{
}
function stargate_SaveContactDetails($params)
{
}
function stargate_GetEPPCode($params)
{
}
function stargate_RegisterNameserver($params)
{
}
function stargate_ModifyNameserver($params)
{
}
function stargate_DeleteNameserver($params)
{
}
function stargate_RequestDelete($params)
{
}
function stargate_GetDNS($params)
{
}
function stargate_SaveDNS($params)
{
}
function stargate_GetEmailForwarding($params)
{
}
function stargate_SaveEmailForwarding($params)
{
}
function stargate_ReleaseDomain($params)
{
}
function stargate_IDProtectToggle($params)
{
}
function stargate_Sync($params)
{
}
function stargate_TransferSync($params)
{
}
function stargate_CheckAvailability(array $params)
{
}
function stargate_GetDomainSuggestions(array $params)
{
}
function stargate_GetPremiumPrice(array $params)
{
}
function stargate_DomainSuggestionOptions()
{
}
function stargate_GetDomainInformation(array $params)
{
}
function stargate_ResendIRTPVerificationEmail(array $params)
{
}
function stargate_GetTldPricing(array $params)
{
}
function gmointernet_getConfigArray()
{
}
function gmointernet_GetNameservers($params)
{
}
function gmointernet_SaveNameservers($params)
{
}
function gmointernet_GetRegistrarLock($params)
{
}
function gmointernet_SaveRegistrarLock($params)
{
}
function gmointernet_RegisterDomain($params)
{
}
function gmointernet_TransferDomain($params)
{
}
function gmointernet_RenewDomain($params)
{
}
function gmointernet_GetContactDetails($params)
{
}
function gmointernet_SaveContactDetails($params)
{
}
function gmointernet_GetEPPCode($params)
{
}
function onamaeSendHttpRequest($testMode, $reqParamArray, $nsParamArray)
{
}
function onamaeReplaceResult($result)
{
}
function checkOnamaeDuplicationKey($key)
{
}
function isOnamaeSuccess($resultArray, $responseCode)
{
}
function isOnamaeTransferCheckResult($resultArray)
{
}
function replaceArrayToStr($paramArray)
{
}
\define("RTR_API_URL", "https://http.api.yoursrs.com/v1/");
\define("RTR_API_URL_TEST", "https://http.api.yoursrs-ote.com/v1/");
function _getURL($params = \NULL)
{
}
function _sendRequest($url, $params)
{
}
function _he(&$value, $key)
{
}
function _debug($url, $params, $msg, $response = \NULL)
{
}
function realtimeregister_getConfigArray()
{
}
function realtimeregister_GetNameservers($params)
{
}
function realtimeregister_SaveNameservers($params)
{
}
function realtimeregister_GetRegistrarLock($params)
{
}
function realtimeregister_SaveRegistrarLock($params)
{
}
function _convertPhoneNumber($phone, $country, $format = \NULL)
{
}
function realtimeregister_RegisterDomain($params)
{
}
function realtimeregister_TransferDomain($params)
{
}
function realtimeregister_RenewDomain($params)
{
}
function realtimeregister_GetContactDetails($params)
{
}
function realtimeregister_SaveContactDetails($params)
{
}
function realtimeregister_GetEPPCode($params)
{
}
function namecheap_getConfigArray()
{
}
function namecheap_config_validate(array $params)
{
}
function namecheap_GetNameservers($params)
{
}
function namecheap_SaveNameservers($params)
{
}
function namecheap_GetRegistrarLock($params)
{
}
function namecheap_SaveRegistrarLock($params)
{
}
function namecheap_GetEmailForwarding($params)
{
}
function namecheap_SaveEmailForwarding($params)
{
}
function namecheap_GetDNS($params)
{
}
function namecheap_SaveDNS($params)
{
}
function namecheap_RegisterDomain($params)
{
}
function namecheap_TransferDomain($params)
{
}
function namecheap_RenewDomain($params)
{
}
function namecheap_GetContactDetails($params)
{
}
function namecheap_SaveContactDetails($params)
{
}
function namecheap_RegisterNameserver($params)
{
}
function namecheap_ModifyNameserver($params)
{
}
function namecheap_DeleteNameserver($params)
{
}
function namecheap_Sync($params)
{
}
function namecheap_TransferSync($params)
{
}
function enom_getConfigArray()
{
}
function enom_config_validate(array $params)
{
}
function enom_CheckAvailability($params)
{
}
function enom_GetDomainSuggestions($params)
{
}
function enom_GetNameservers($params)
{
}
function enom_SaveNameservers($params)
{
}
function enom_GetRegistrarLock($params)
{
}
function enom_SaveRegistrarLock($params)
{
}
function enom_GetEmailForwarding($params)
{
}
function _enom_EnableService($params, $service)
{
}
function enom_SaveEmailForwarding($params)
{
}
function enom_GetDNS($params)
{
}
function enom_SaveDNS($params)
{
}
function enom_RegisterDomain($params)
{
}
function enom_TransferDomain(array $params)
{
}
function enom_RenewDomain($params)
{
}
function enom_GetContactDetails($params)
{
}
function enom_GetRegistrantContactEmailAddress(array $params)
{
}
function enom_SaveContactDetails($params)
{
}
function enom_GetEPPCode($params)
{
}
function enom_RegisterNameserver($params)
{
}
function enom_ModifyNameserver($params)
{
}
function enom_DeleteNameserver($params)
{
}
function enom_AdminCustomButtonArray($params)
{
}
function enom_resendtransferapproval($params)
{
}
function enom_getorderid($params)
{
}
function enom_canceldomaintransfer($params)
{
}
function enom_Sync($params)
{
}
function enom_TransferSync($params)
{
}
function enom_GetPremiumPrice(array $params)
{
}
function enom_NormalizeContactDetails($params)
{
}
function enom_DomainSuggestionOptions()
{
}
function enom_IDProtectToggle(array $params)
{
}
function enom_GetDomainInformation(array $params)
{
}
function enom_ResendIRTPVerificationEmail(array $params)
{
}
function enom_GetTldPricing(array $params)
{
}
function enom_normalise_status($status)
{
}
function enom_set_initial_contact_data(\WHMCS\Module\Registrar\Enom\ApiInterface $Enom, array $params)
{
}
function enom_populate_additional_fields(\WHMCS\Module\Registrar\Enom\ApiInterface $Enom, array $params)
{
}
function affordabledomains_splitPhoneNumber($phoneNumber)
{
}
function affordabledomains_getConfigArray()
{
}
function affordabledomains_GetNameservers($params)
{
}
function affordabledomains_SaveNameservers($params)
{
}
function affordabledomains_RegisterDomain($params)
{
}
function affordabledomains_TransferDomain($params)
{
}
function affordabledomains_RenewDomain($params)
{
}
function affordabledomains_GetContactDetails($params)
{
}
function affordabledomains_SaveContactDetails($params)
{
}
function affordabledomains_GetEPPCode($params)
{
}
function affordabledomains_login($params)
{
}
function affordabledomains_connect_server($url, $postfields)
{
}
function affordabledomains_registerNzDomain($params)
{
}
function affordabledomains_whoisNzDomain($params)
{
}
function affordabledomains_nsSaveNzDomain($params)
{
}
function affordabledomains_contactSaveNzDomain($myparams)
{
}
function affordabledomains_renewNzDomain($params)
{
}
function affordabledomains_transNzDomain($params)
{
}
function affordabledomains_getUdaiNzDomain($params)
{
}
function tppwregistrar_getConfigArray()
{
}
function tppwregistrar_GetNameservers($params)
{
}
function tppwregistrar_SaveNameservers($params)
{
}
function tppwregistrar_GetRegistrarLock($params)
{
}
function tppwregistrar_SaveRegistrarLock($params)
{
}
function tppwregistrar_RegisterDomain($params)
{
}
function tppwregistrar_TransferDomain($params)
{
}
function tppwregistrar_RenewDomain($params)
{
}
function tppwregistrar_GetContactDetails($params)
{
}
function tppwregistrar_SaveContactDetails($params)
{
}
function tppwregistrar_GetEPPCode($params)
{
}
function tppwregistrar_TransferSync($params)
{
}
function tppwregistrar_Sync($params)
{
}
function tppwregistrar_checkOrder($params)
{
}
function tppwregistrar_AdminCustomButtonArray($params)
{
}
function tppwregistrar_RegisterNameserver($params)
{
}
function tppwregistrar_ModifyNameserver($params)
{
}
function tppwregistrar_DeleteNameserver($params)
{
}
\define("API_SERVER_URL", "https://api.internet.bs/");
\define("API_TESTSERVER_URL", "https://testapi.internet.bs/");
function internetbs_getLastError()
{
}
function internetbs_runCommand($commandUrl, $postData)
{
}
function internetbs_getConnectionErrorMessage($message)
{
}
function internetbs_getConfigArray()
{
}
function internetbs_config_validate(array $params)
{
}
function internetbs_parseResult($data)
{
}
function internetbs_GetNameservers($params)
{
}
function internetbs_SaveNameservers($params)
{
}
function internetbs_GetRegistrarLock($params)
{
}
function internetbs_SaveRegistrarLock($params)
{
}
function internetbs_GetEmailForwarding($params)
{
}
function internetbs_SaveEmailForwarding($params)
{
}
function internetbs_GetDNS($params)
{
}
function internetbs_SaveDNS($params)
{
}
function internetbs_RegisterDomain($params)
{
}
function internetbs_TransferDomain($params)
{
}
function internetbs_RenewDomain($params)
{
}
function internetbs_GetContactDetails($params)
{
}
function internetbs_SaveContactDetails($params)
{
}
function internetbs_GetEPPCode($params)
{
}
function internetbs_RegisterNameserver($params)
{
}
function internetbs_ModifyNameserver($params)
{
}
function internetbs_DeleteNameserver($params)
{
}
function internetbs_mapCountry($countryCode)
{
}
function internetbs_chekPhone($phoneNumber)
{
}
function internetbs_reformatPhone($phoneNumber, $countryCode)
{
}
function internetbs_get_utf8_parameters($params)
{
}
function internetbs_getCountryCodeByName($countryName)
{
}
function internetbs_getClientIp()
{
}
function internetbs_get2CharDotITProvinceCode($province)
{
}
function internetbs_getItProvinceCode($inputElementValue)
{
}
function parseResult($data)
{
}
function registereu_getConfigArray()
{
}
function registereu_GetNameservers($params)
{
}
function registereu_SaveNameservers($params)
{
}
function registereu_GetContactDetails($params)
{
}
function registereu_SaveContactDetails($params)
{
}
function registereu_RegisterDomain($params)
{
}
function registereu_TransferDomain($params)
{
}
function netearthone_MetaData()
{
}
function netearthone_GetConfigArray()
{
}
function netearthone_config_validate($params)
{
}
function netearthone_GetNameservers($params)
{
}
function netearthone_SaveNameservers($params)
{
}
function netearthone_GetRegistrarLock($params)
{
}
function netearthone_SaveRegistrarLock($params)
{
}
function netearthone_RegisterDomain($params)
{
}
function netearthone_TransferDomain($params)
{
}
function netearthone_RenewDomain($params)
{
}
function netearthone_GetContactDetails($params)
{
}
function netearthone_SaveContactDetails($params)
{
}
function netearthone_GetEPPCode($params)
{
}
function netearthone_RegisterNameserver($params)
{
}
function netearthone_ModifyNameserver($params)
{
}
function netearthone_DeleteNameserver($params)
{
}
function netearthone_RequestDelete($params)
{
}
function netearthone_GetDNS($params)
{
}
function netearthone_SaveDNS($params)
{
}
function netearthone_GetEmailForwarding($params)
{
}
function netearthone_SaveEmailForwarding($params)
{
}
function netearthone_ReleaseDomain($params)
{
}
function netearthone_IDProtectToggle($params)
{
}
function netearthone_Sync($params)
{
}
function netearthone_TransferSync($params)
{
}
function netearthone_CheckAvailability(array $params)
{
}
function netearthone_GetDomainSuggestions(array $params)
{
}
function netearthone_GetPremiumPrice(array $params)
{
}
function netearthone_DomainSuggestionOptions()
{
}
function netearthone_GetDomainInformation(array $params)
{
}
function netearthone_ResendIRTPVerificationEmail(array $params)
{
}
function netearthone_GetTldPricing(array $params)
{
}
function resellercamp_MetaData()
{
}
function resellercamp_GetConfigArray()
{
}
function resellercamp_config_validate($params)
{
}
function resellercamp_GetNameservers($params)
{
}
function resellercamp_SaveNameservers($params)
{
}
function resellercamp_GetRegistrarLock($params)
{
}
function resellercamp_SaveRegistrarLock($params)
{
}
function resellercamp_RegisterDomain($params)
{
}
function resellercamp_TransferDomain($params)
{
}
function resellercamp_RenewDomain($params)
{
}
function resellercamp_GetContactDetails($params)
{
}
function resellercamp_SaveContactDetails($params)
{
}
function resellercamp_GetEPPCode($params)
{
}
function resellercamp_RegisterNameserver($params)
{
}
function resellercamp_ModifyNameserver($params)
{
}
function resellercamp_DeleteNameserver($params)
{
}
function resellercamp_RequestDelete($params)
{
}
function resellercamp_GetDNS($params)
{
}
function resellercamp_SaveDNS($params)
{
}
function resellercamp_GetEmailForwarding($params)
{
}
function resellercamp_SaveEmailForwarding($params)
{
}
function resellercamp_ReleaseDomain($params)
{
}
function resellercamp_IDProtectToggle($params)
{
}
function resellercamp_Sync($params)
{
}
function resellercamp_TransferSync($params)
{
}
function resellercamp_CheckAvailability(array $params)
{
}
function resellercamp_GetDomainSuggestions(array $params)
{
}
function resellercamp_GetPremiumPrice(array $params)
{
}
function resellercamp_DomainSuggestionOptions()
{
}
function resellercamp_GetDomainInformation(array $params)
{
}
function resellercamp_ResendIRTPVerificationEmail(array $params)
{
}
function resellercamp_GetTldPricing(array $params)
{
}
function m101domain_getConfigArray()
{
}
function m101domain_GetNameservers($params)
{
}
function m101domain_SaveNameservers($params)
{
}
function m101domain_GetRegistrarLock($params)
{
}
function m101domain_SaveRegistrarLock($params)
{
}
function m101domain_GetDNS($params)
{
}
function m101domain_SaveDNS($params)
{
}
function m101domain_RegisterDomain($params)
{
}
function m101domain_eppDomainCreateExt(array &$params, $registrant)
{
}
function m101domain_addFieldGetVal(array &$field, array &$params)
{
}
function m101domain_TransferDomain($params)
{
}
function m101domain_RenewDomain($params)
{
}
function m101domain_GetContactDetails($params)
{
}
function m101domain_SaveContactDetails($params)
{
}
function m101domain_GetEPPCode($params)
{
}
function m101domain_RegisterNameserver($params)
{
}
function m101domain_ModifyNameserver($params)
{
}
function m101domain_DeleteNameserver($params)
{
}
function m101domain_Sync($params)
{
}
function m101domain_TransferSync($params)
{
}
function m101domain_eppRegisterContact($params, \M101Domain\Contact $contact)
{
}
function m101domain_eppUpdateContact($params, \M101Domain\Contact $contact)
{
}
function m101domain_eppCheckContact($params, array $handles)
{
}
function m101domain_connect($params)
{
}
function m101domain_command($params, $xml, $command = "")
{
}
function m101domain_FindNode(\DOMElement $parent, $name, $namespace_uri = \NULL)
{
}
function m101Domain_createPassword($length)
{
}
function m101domain_eppcontactinfo($params, $handle)
{
}
function m101domain_eppdomaininfo($params, $name)
{
}
function m101domain_eppdnsinfo($params, $name)
{
}
function m101domain_eppdomainrenew($params, \M101Domain\Domain $domain, $period)
{
}
function m101domain_contacthandles($params)
{
}
function m101domain_epphostinfo($params, $name)
{
}
function composerRequire323f23780403defe5009107249f44a2f($file)
{
}
function duosecurity_config()
{
}
function duosecurity_activate(array $params)
{
}
function duosecurity_activateverify(array $params)
{
}
function duosecurity_challenge(array $params)
{
}
function duosecurity_verify(array $params)
{
}
function yubico_class_load()
{
}
function yubico_config()
{
}
function yubico_activate($params)
{
}
function yubico_activateverify($params)
{
}
function yubico_challenge($params)
{
}
function yubico_verify($params)
{
}
function totp_config()
{
}
function totp_activate($params)
{
}
function totp_activateverify($params)
{
}
function totp_challenge($params)
{
}
function totp_get_used_otps()
{
}
function totp_verify($params)
{
}
function totp_getqrcode()
{
}
function totp_loadgaclass()
{
}
function totp_getLangString($clientString, $adminString)
{
}
/*
* PHP QR Code encoder
*
* This file contains MERGED version of PHP QR Code library.
* It was auto-generated from full version for your convenience.
*
* This merged version was configured to not requre any external files,
* with disabled cache, error loging and weker but faster mask matching.
* If you need tune it up please use non-merged version.
*
* For full version, documentation, examples of use please visit:
*
* http://phpqrcode.sourceforge.net/
* https://sourceforge.net/projects/phpqrcode/
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
/*
* Version: 1.1.4
* Build: 2010100721
*/
//---- qrconst.php -----------------------------
/*
* PHP QR Code encoder
*
* Common constants
*
* Based on libqrencode C library distributed under LGPL 2.1
* Copyright (C) 2006, 2007, 2008, 2009 Kentaro Fukuchi <fukuchi@megaui.net>
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
// Encoding modes
\define('QR_MODE_NUL', -1);
\define('QR_MODE_NUM', 0);
\define('QR_MODE_AN', 1);
\define('QR_MODE_8', 2);
\define('QR_MODE_KANJI', 3);
\define('QR_MODE_STRUCTURE', 4);
// Levels of error correction.
\define('QR_ECLEVEL_L', 0);
\define('QR_ECLEVEL_M', 1);
\define('QR_ECLEVEL_Q', 2);
\define('QR_ECLEVEL_H', 3);
// Supported output formats
\define('QR_FORMAT_TEXT', 0);
\define('QR_FORMAT_PNG', 1);
//---- merged_config.php -----------------------------
/*
* PHP QR Code encoder
*
* Config file, tuned-up for merged verion
*/
\define('QR_CACHEABLE', \false);
// use cache - more disk reads but less CPU power, masks and format templates are stored there
\define('QR_CACHE_DIR', \false);
// used when QR_CACHEABLE === true
\define('QR_LOG_DIR', \false);
// default error logs dir
\define('QR_FIND_BEST_MASK', \true);
// if true, estimates best mask (spec. default, but extremally slow; set to false to significant performance boost but (propably) worst quality code
\define('QR_FIND_FROM_RANDOM', 2);
// if false, checks all masks available, otherwise value tells count of masks need to be checked, mask id are got randomly
\define('QR_DEFAULT_MASK', 2);
// when QR_FIND_BEST_MASK === false
\define('QR_PNG_MAXIMUM_SIZE', 1024);
//---- qrspec.php -----------------------------
/*
* PHP QR Code encoder
*
* QR Code specifications
*
* Based on libqrencode C library distributed under LGPL 2.1
* Copyright (C) 2006, 2007, 2008, 2009 Kentaro Fukuchi <fukuchi@megaui.net>
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* The following data / specifications are taken from
* "Two dimensional symbol -- QR-code -- Basic Specification" (JIS X0510:2004)
* or
* "Automatic identification and data capture techniques --
* QR Code 2005 bar code symbology specification" (ISO/IEC 18004:2006)
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
\define('QRSPEC_VERSION_MAX', 40);
\define('QRSPEC_WIDTH_MAX', 177);
\define('QRCAP_WIDTH', 0);
\define('QRCAP_WORDS', 1);
\define('QRCAP_REMINDER', 2);
\define('QRCAP_EC', 3);
//---- qrimage.php -----------------------------
/*
* PHP QR Code encoder
*
* Image output of code using GD2
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
\define('QR_IMAGE', \true);
//---- qrinput.php -----------------------------
/*
* PHP QR Code encoder
*
* Input encoding class
*
* Based on libqrencode C library distributed under LGPL 2.1
* Copyright (C) 2006, 2007, 2008, 2009 Kentaro Fukuchi <fukuchi@megaui.net>
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
\define('STRUCTURE_HEADER_BITS', 20);
\define('MAX_STRUCTURED_SYMBOLS', 16);
//---- qrmask.php -----------------------------
/*
* PHP QR Code encoder
*
* Masking
*
* Based on libqrencode C library distributed under LGPL 2.1
* Copyright (C) 2006, 2007, 2008, 2009 Kentaro Fukuchi <fukuchi@megaui.net>
*
* PHP QR Code is distributed under LGPL 3
* Copyright (C) 2010 Dominik Dzienia <deltalab at poczta dot fm>
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 3 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
\define('N1', 3);
\define('N2', 3);
\define('N3', 40);
\define('N4', 10);
/** @type string $currentmonth */
/** @type int $currentyear */
$dateRange = \WHMCS\Carbon::create($year, $month, 1);
/** @var Carbon $today */
$startOfMonth = $dateFilter->startOfMonth()->toDateTimeString();
/** @var WHMCS\Application $whmcs */
$include_active = $whmcs->get_req_var('include_active');
/** @var WHMCS\Product\Group[] $productGroups */
$productGroups = \WHMCS\Product\Group::all();
/** @var StdClass[] $productAddons */
$productAddons = \Illuminate\Database\Capsule\Manager::table('tbladdons')->get();
/**
* Custom Defined Addons
*/
/** @var StdClass[] $addons */
$addons = \Illuminate\Database\Capsule\Manager::table('tblhostingaddons')->where('addonid', '=', '0')->where('regdate', '!=', '0000-00-00')->whereIn('status', $statuses)->whereNotIn('billingcycle', array('Free Account', 'Free', 'One Time'))->selectRaw('name, count(id) as count, billingcycle, AVG(DATEDIFF(IF(`termination_date` != \'0000-00-00\', `termination_date`, `nextduedate`), `regdate`)) as avg_days')->groupBy('name', 'billingcycle')->get();
/** @var StdClass[] $domainTlds */
$domainTlds = \Illuminate\Database\Capsule\Manager::table('tbldomainpricing')->get();
/**
* Replace the "None" string with the "Any" string
*/
$registrarList = \str_replace([$aInt->lang('global', 'none')], [$aInt->lang('global', 'any')], \getRegistrarsDropdownMenu($registrar));
/**#@+
* mcrypt constants
*
* @access public
*/
// http://php.net/manual/en/mcrypt.constants.php
\define('MCRYPT_MODE_ECB', 'ecb');
\define('MCRYPT_MODE_CBC', 'cbc');
\define('MCRYPT_MODE_CFB', 'cfb');
\define('MCRYPT_MODE_OFB', 'ofb');
\define('MCRYPT_MODE_NOFB', 'nofb');
\define('MCRYPT_MODE_STREAM', 'stream');
\define('MCRYPT_ENCRYPT', 0);
\define('MCRYPT_DECRYPT', 1);
\define('MCRYPT_DEV_RANDOM', 0);
\define('MCRYPT_DEV_URANDOM', 1);
\define('MCRYPT_RAND', 2);
// http://php.net/manual/en/mcrypt.ciphers.php
\define('MCRYPT_3DES', 'tripledes');
\define('MCRYPT_ARCFOUR_IV', 'arcfour-iv');
\define('MCRYPT_ARCFOUR', 'arcfour');
\define('MCRYPT_BLOWFISH', 'blowfish');
\define('MCRYPT_CAST_128', 'cast-128');
\define('MCRYPT_CAST_256', 'cast-256');
\define('MCRYPT_CRYPT', 'crypt');
\define('MCRYPT_DES', 'des');
// MCRYPT_DES_COMPAT?
// MCRYPT_ENIGMA?
\define('MCRYPT_GOST', 'gost');
\define('MCRYPT_IDEA', 'idea');
\define('MCRYPT_LOKI97', 'loki97');
\define('MCRYPT_MARS', 'mars');
\define('MCRYPT_PANAMA', 'panama');
\define('MCRYPT_RIJNDAEL_128', 'rijndael-128');
\define('MCRYPT_RIJNDAEL_192', 'rijndael-192');
\define('MCRYPT_RIJNDAEL_256', 'rijndael-256');
\define('MCRYPT_RC2', 'rc2');
// MCRYPT_RC4?
\define('MCRYPT_RC6', 'rc6');
// MCRYPT_RC6_128
// MCRYPT_RC6_192
// MCRYPT_RC6_256
\define('MCRYPT_SAFER64', 'safer-sk64');
\define('MCRYPT_SAFER128', 'safer-sk128');
\define('MCRYPT_SAFERPLUS', 'saferplus');
\define('MCRYPT_SERPENT', 'serpent');
// MCRYPT_SERPENT_128?
// MCRYPT_SERPENT_192?
// MCRYPT_SERPENT_256?
\define('MCRYPT_SKIPJACK', 'skipjack');
// MCRYPT_TEAN?
\define('MCRYPT_THREEWAY', 'threeway');
\define('MCRYPT_TRIPLEDES', 'tripledes');
\define('MCRYPT_TWOFISH', 'twofish');
// MCRYPT_TWOFISH128?
// MCRYPT_TWOFISH192?
// MCRYPT_TWOFISH256?
\define('MCRYPT_WAKE', 'wake');
\define('MCRYPT_XTEA', 'xtea');
/**
* Sets the key
*
* @param \phpseclib\Crypt\Base $td
* @param string $key
* @access private
*/
function phpseclib_set_key(\phpseclib\Crypt\Base $td, $key)
{
}
/**
* Sets the IV
*
* @param \phpseclib\Crypt\Base $td
* @param string $iv
* @access private
*/
function phpseclib_set_iv(\phpseclib\Crypt\Base $td, $iv)
{
}
/**
* Gets an array of all supported ciphers.
*
* @param string $lib_dir optional
* @return array
* @access public
*/
function phpseclib_mcrypt_list_algorithms($lib_dir = '')
{
}
/**
* Gets an array of all supported modes
*
* @param string $lib_dir optional
* @return array
* @access public
*/
function phpseclib_mcrypt_list_modes($lib_dir = '')
{
}
/**
* Creates an initialization vector (IV) from a random source
*
* The IV is only meant to give an alternative seed to the encryption routines. This IV does not need
* to be secret at all, though it can be desirable. You even can send it along with your ciphertext
* without losing security.
*
* @param int $size
* @param int $source optional
* @return string
* @access public
*/
function phpseclib_mcrypt_create_iv($size, $source = \MCRYPT_DEV_URANDOM)
{
}
/**
* Opens the module of the algorithm and the mode to be used
*
* This function opens the module of the algorithm and the mode to be used. The name of the algorithm
* is specified in algorithm, e.g. "twofish" or is one of the MCRYPT_ciphername constants. The module
* is closed by calling mcrypt_module_close().
*
* @param string $algorithm
* @param string $algorithm_directory
* @param string $mode
* @param string $mode_directory
* @return object
* @access public
*/
function phpseclib_mcrypt_module_open($algorithm, $algorithm_directory, $mode, $mode_directory)
{
}
/**
* Returns the maximum supported keysize of the opened mode
*
* Gets the maximum supported key size of the algorithm in bytes.
*
* @param \phpseclib\Crypt\Base $td
* @return int
* @access public
*/
function phpseclib_mcrypt_enc_get_key_size(\phpseclib\Crypt\Base $td)
{
}
/**
* Gets the name of the specified cipher
*
* @param string $cipher
* @return mixed
* @access public
*/
function phpseclib_mcrypt_get_cipher_name($cipher)
{
}
/**
* Gets the block size of the specified cipher
*
* @param string $cipher
* @param string $mode optional
* @return int
* @access public
*/
function phpseclib_mcrypt_get_block_size($cipher, $mode = \false)
{
}
/**
* Gets the key size of the specified cipher
*
* @param string $cipher
* @param string $mode optional
* @return int
* @access public
*/
function phpseclib_mcrypt_get_key_size($cipher, $mode = \false)
{
}
/**
* Returns the size of the IV belonging to a specific cipher/mode combination
*
* @param string $cipher
* @param string $mode
* @return int
* @access public
*/
function phpseclib_mcrypt_get_iv_size($cipher, $mode)
{
}
/**
* Returns the maximum supported keysize of the opened mode
*
* Gets the maximum supported keysize of the opened mode.
*
* @param string $algorithm
* @param string $lib_dir
* @return int
* @access public
*/
function phpseclib_mcrypt_module_get_algo_key_size($algorithm, $lib_dir = '')
{
}
/**
* Returns the size of the IV of the opened algorithm
*
* This function returns the size of the IV of the algorithm specified by the encryption
* descriptor in bytes. An IV is used in cbc, cfb and ofb modes, and in some algorithms
* in stream mode.
*
* @param \phpseclib\Crypt\Base $td
* @return int
* @access public
*/
function phpseclib_mcrypt_enc_get_iv_size(\phpseclib\Crypt\Base $td)
{
}
/**
* Returns the blocksize of the opened algorithm
*
* Gets the blocksize of the opened algorithm.
*
* @param \phpseclib\Crypt\Base $td
* @return int
* @access public
*/
function phpseclib_mcrypt_enc_get_block_size(\phpseclib\Crypt\Base $td)
{
}
/**
* Returns the blocksize of the specified algorithm
*
* Gets the blocksize of the specified algorithm.
*
* @param string $algorithm
* @param string $lib_dir
* @return int
* @access public
*/
function phpseclib_mcrypt_module_get_algo_block_size($algorithm, $lib_dir = '')
{
}
/**
* Returns the name of the opened algorithm
*
* This function returns the name of the algorithm.
*
* @param \phpseclib\Crypt\Base $td
* @return string|bool
* @access public
*/
function phpseclib_mcrypt_enc_get_algorithms_name(\phpseclib\Crypt\Base $td)
{
}
/**
* Returns the name of the opened mode
*
* This function returns the name of the mode.
*
* @param \phpseclib\Crypt\Base $td
* @return string|bool
* @access public
*/
function phpseclib_mcrypt_enc_get_modes_name(\phpseclib\Crypt\Base $td)
{
}
/**
* Checks whether the encryption of the opened mode works on blocks
*
* Tells whether the algorithm of the opened mode works on blocks (e.g. FALSE for stream, and TRUE for cbc, cfb, ofb)..
*
* @param \phpseclib\Crypt\Base $td
* @return bool
* @access public
*/
function phpseclib_mcrypt_enc_is_block_algorithm_mode(\phpseclib\Crypt\Base $td)
{
}
/**
* Checks whether the algorithm of the opened mode is a block algorithm
*
* Tells whether the algorithm of the opened mode is a block algorithm.
*
* @param \phpseclib\Crypt\Base $td
* @return bool
* @access public
*/
function phpseclib_mcrypt_enc_is_block_algorithm(\phpseclib\Crypt\Base $td)
{
}
/**
* Checks whether the opened mode outputs blocks
*
* Tells whether the opened mode outputs blocks (e.g. TRUE for cbc and ecb, and FALSE for cfb and stream).
*
* @param \phpseclib\Crypt\Base $td
* @return bool
* @access public
*/
function phpseclib_mcrypt_enc_is_block_mode(\phpseclib\Crypt\Base $td)
{
}
/**
* Runs a self test on the opened module
*
* This function runs the self test on the algorithm specified by the descriptor td.
*
* @param \phpseclib\Crypt\Base $td
* @return bool
* @access public
*/
function phpseclib_mcrypt_enc_self_test(\phpseclib\Crypt\Base $td)
{
}
/**
* This function initializes all buffers needed for en/decryption.
*
* @param \phpseclib\Crypt\Base $td
* @param string $key
* @param string $iv
* @return int
* @access public
*/
function phpseclib_mcrypt_generic_init(\phpseclib\Crypt\Base $td, $key, $iv)
{
}
/**
* Encrypt / decrypt data
*
* Performs checks common to both mcrypt_generic and mdecrypt_generic
*
* @param \phpseclib\Crypt\Base $td
* @param string $data
* @param string $op
* @return string|bool
* @access private
*/
function phpseclib_mcrypt_generic_helper(\phpseclib\Crypt\Base $td, &$data, $op)
{
}
/**
* This function encrypts data
*
* This function encrypts data. The data is padded with "\0" to make sure the length of the data
* is n * blocksize. This function returns the encrypted data. Note that the length of the
* returned string can in fact be longer than the input, due to the padding of the data.
*
* If you want to store the encrypted data in a database make sure to store the entire string as
* returned by mcrypt_generic, or the string will not entirely decrypt properly. If your original
* string is 10 characters long and the block size is 8 (use mcrypt_enc_get_block_size() to
* determine the blocksize), you would need at least 16 characters in your database field. Note
* the string returned by mdecrypt_generic() will be 16 characters as well...use rtrim($str, "\0")
* to remove the padding.
*
* If you are for example storing the data in a MySQL database remember that varchar fields
* automatically have trailing spaces removed during insertion. As encrypted data can end in a
* space (ASCII 32), the data will be damaged by this removal. Store data in a tinyblob/tinytext
* (or larger) field instead.
*
* @param \phpseclib\Crypt\Base $td
* @param string $data
* @return string|bool
* @access public
*/
function phpseclib_mcrypt_generic(\phpseclib\Crypt\Base $td, $data)
{
}
/**
* Decrypts data
*
* This function decrypts data. Note that the length of the returned string can in fact be
* longer than the unencrypted string, due to the padding of the data.
*
* @param \phpseclib\Crypt\Base $td
* @param string $data
* @return string|bool
* @access public
*/
function phpseclib_mdecrypt_generic(\phpseclib\Crypt\Base $td, $data)
{
}
/**
* This function deinitializes an encryption module
*
* This function terminates encryption specified by the encryption descriptor (td).
* It clears all buffers, but does not close the module. You need to call
* mcrypt_module_close() yourself. (But PHP does this for you at the end of the
* script.)
*
* @param \phpseclib\Crypt\Base $td
* @return bool
* @access public
*/
function phpseclib_mcrypt_generic_deinit(\phpseclib\Crypt\Base $td)
{
}
/**
* Closes the mcrypt module
*
* Closes the specified encryption handle.
*
* @param \phpseclib\Crypt\Base $td
* @return bool
* @access public
*/
function phpseclib_mcrypt_module_close(\phpseclib\Crypt\Base $td)
{
}
/**
* Returns an array with the supported keysizes of the opened algorithm
*
* Returns an array with the key sizes supported by the specified algorithm.
* If it returns an empty array then all key sizes between 1 and mcrypt_module_get_algo_key_size()
* are supported by the algorithm.
*
* @param string $algorithm
* @param string $lib_dir optional
* @return array
* @access public
*/
function phpseclib_mcrypt_module_get_supported_key_sizes($algorithm, $lib_dir = '')
{
}
/**
* Returns an array with the supported keysizes of the opened algorithm
*
* Gets the supported key sizes of the opened algorithm.
*
* @param \phpseclib\Crypt\Base $td
* @return array
* @access public
*/
function phpseclib_mcrypt_enc_get_supported_key_sizes(\phpseclib\Crypt\Base $td)
{
}
/**
* Returns if the specified module is a block algorithm or not
*
* This function returns TRUE if the mode is for use with block algorithms, otherwise it returns FALSE. (e.g. FALSE for stream, and TRUE for cbc, cfb, ofb).
*
* @param string $mode
* @param string $lib_dir optional
* @return bool
* @access public
*/
function phpseclib_mcrypt_module_is_block_algorithm_mode($mode, $lib_dir = '')
{
}
/**
* This function checks whether the specified algorithm is a block algorithm
*
* This function returns TRUE if the specified algorithm is a block algorithm, or FALSE if it is a stream one.
*
* @param string $mode
* @param string $lib_dir optional
* @return bool
* @access public
*/
function phpseclib_mcrypt_module_is_block_algorithm($algorithm, $lib_dir = '')
{
}
/**
* Returns if the specified mode outputs blocks or not
*
* This function returns TRUE if the mode outputs blocks of bytes or FALSE if it outputs just bytes. (e.g. TRUE for cbc and ecb, and FALSE for cfb and stream).
*
* @param string $mode
* @param string $lib_dir optional
* @return bool
* @access public
*/
function phpseclib_mcrypt_module_is_block_mode($mode, $lib_dir = '')
{
}
/**
* Returns if the specified mode can use an IV or not
*
* @param string $mode
* @return bool
* @access private
*/
function phpseclib_mcrypt_module_is_iv_mode($mode)
{
}
/**
* This function runs a self test on the specified module
*
* This function runs the self test on the algorithm specified.
*
* @param string $mode
* @param string $lib_dir optional
* @return bool
* @access public
*/
function phpseclib_mcrypt_module_self_test($algorithm, $lib_dir = '')
{
}
/**
* Encrypt / decrypt data
*
* Performs checks common to both mcrypt_encrypt and mcrypt_decrypt
*
* @param string $cipher
* @param string $key
* @param string $data
* @param string $mode
* @param string $iv
* @param string $op
* @return string|bool
* @access private
*/
function phpseclib_mcrypt_helper($cipher, $key, $data, $mode, $iv, $op)
{
}
/**
* Encrypts plaintext with given parameters
*
* Encrypts the data and returns it.
*
* @param string $cipher
* @param string $key
* @param string $data
* @param string $mode
* @param string $iv optional
* @return string|bool
* @access public
*/
function phpseclib_mcrypt_encrypt($cipher, $key, $data, $mode, $iv = \null)
{
}
/**
* Decrypts crypttext with given parameters
*
* Decrypts the data and returns the unencrypted data.
*
* @param string $cipher
* @param string $key
* @param string $data
* @param string $mode
* @param string $iv optional
* @return string|bool
* @access public
*/
function phpseclib_mcrypt_decrypt($cipher, $key, $data, $mode, $iv = \null)
{
}
function mcrypt_list_algorithms($lib_dir = '')
{
}
function mcrypt_list_modes($lib_dir = '')
{
}
function mcrypt_create_iv($size, $source = \MCRYPT_DEV_URANDOM)
{
}
function mcrypt_module_open($algorithm, $algorithm_directory, $mode, $mode_directory)
{
}
function mcrypt_enc_get_key_size(\phpseclib\Crypt\Base $td)
{
}
function mcrypt_enc_get_iv_size(\phpseclib\Crypt\Base $td)
{
}
function mcrypt_enc_get_block_size(\phpseclib\Crypt\Base $td)
{
}
function mcrypt_generic_init(\phpseclib\Crypt\Base $td, $key, $iv)
{
}
function mcrypt_generic(\phpseclib\Crypt\Base $td, $data)
{
}
function mcrypt_generic_deinit(\phpseclib\Crypt\Base $td)
{
}
function mcrypt_module_close(\phpseclib\Crypt\Base $td)
{
}
function mdecrypt_generic(\phpseclib\Crypt\Base $td, $data)
{
}
function mcrypt_enc_get_algorithms_name(\phpseclib\Crypt\Base $td)
{
}
function mcrypt_enc_get_modes_name(\phpseclib\Crypt\Base $td)
{
}
function mcrypt_enc_is_block_algorithm_mode(\phpseclib\Crypt\Base $td)
{
}
function mcrypt_enc_is_block_algorithm(\phpseclib\Crypt\Base $td)
{
}
function mcrypt_enc_self_test(\phpseclib\Crypt\Base $td)
{
}
function mcrypt_module_get_supported_key_sizes($algorithm, $lib_dir = '')
{
}
function mcrypt_encrypt($cipher, $key, $data, $mode, $iv = \null)
{
}
function mcrypt_module_get_algo_block_size($algorithm, $lib_dir = '')
{
}
function mcrypt_get_block_size($cipher, $mode = '')
{
}
function mcrypt_get_cipher_name($cipher)
{
}
function mcrypt_get_key_size($cipher, $mode = \false)
{
}
function mcrypt_get_iv_size($cipher, $mode)
{
}
function mcrypt_module_get_algo_key_size($algorithm, $lib_dir = '')
{
}
function mcrypt_enc_get_supported_key_sizes(\phpseclib\Crypt\Base $td)
{
}
function mcrypt_module_is_block_algorithm_mode($mode, $lib_dir = '')
{
}
function mcrypt_module_is_block_algorithm($algorithm, $lib_dir = '')
{
}
function mcrypt_module_is_block_mode($mode, $lib_dir = '')
{
}
function mcrypt_module_self_test($algorithm, $lib_dir = '')
{
}
function mcrypt_decrypt($cipher, $key, $data, $mode, $iv = \null)
{
}
/**
* @file
* This file compares our version of PH5P with Jero's original version, and
* generates a patch of the differences. This script should be run whenever
* library/HTMLPurifier/Lexer/PH5P.php is modified.
*/
$orig = \realpath(\dirname(__FILE__) . '/PH5P.php');
// Reorder list so that dependencies are included first:
/**
* Returns a lookup array of dependencies for a file.
*
* @note This function expects that format $name extends $parent on one line
*
* @param string $file
* File to check dependencies of.
* @return array
* Lookup array of files the file is dependent on, sorted accordingly.
*/
function get_dependency_lookup($file)
{
}
/**
* Sorts files based on dependencies. This function is lazy and will not
* group files with dependencies together; it will merely ensure that a file
* is never included before its dependencies are.
*
* @param $files
* Files array to sort.
* @return
* Sorted array ($files is not modified by reference!)
*/
function dep_sort($files)
{
}
/**
* @file
* Generates a schema cache file, saving it to
* library/HTMLPurifier/ConfigSchema/schema.ser.
*
* This should be run when new configuration options are added to
* HTML Purifier. A cached version is available via the repository
* so this does not normally have to be regenerated.
*
* If you have a directory containing custom configuration schema files,
* you can simple add a path to that directory as a parameter to
* this, and they will get included.
*/
$target = \dirname(__FILE__) . '/../library/HTMLPurifier/ConfigSchema/schema.ser';
function assertCli()
{
}
function prefix_is($comp, $subject)
{
}
function postfix_is($comp, $subject)
{
}
/**
* @file
* Compiles all of HTML Purifier's library files into one big file
* named HTMLPurifier.standalone.php. This is usually called during the
* release process.
*/
/**
* Global hash that tracks already loaded includes
*/
$loaded = array();
/**
* Replaces the includes inside PHP source code with the corresponding
* source.
* @param string $text PHP source code to replace includes from
*/
function replace_includes($text)
{
}
/**
* Removes leading PHP tags from included files. Assumes that there is
* no trailing tag. Also removes vim modelines.
* @note This is safe for files that have internal <?php
* @param string $text Text to have leading PHP tag from
*/
function remove_php_tags($text)
{
}
/**
* Copies the contents of a directory to the standalone directory
* @param string $dir Directory to copy
*/
function make_dir_standalone($dir)
{
}
/**
* Copies the contents of a file to the standalone directory
* @param string $file File to copy
*/
function make_file_standalone($file)
{
}
/**
* Copies a file to another location recursively, if it is a PHP file
* remove includes
* @param string $file Original file
* @param string $sfile New location of file
*/
function copy_and_remove_includes($file, $sfile)
{
}
/**
* @param $matches preg_replace_callback matches array, where index 1
* is the filename to include
*/
function replace_includes_callback($matches)
{
}
/**
* @file
* Extracts all definitions inside a configuration schema
* (HTMLPurifier_ConfigSchema) and exports them as plain text files.
*
* @todo Extract version numbers.
*/
\define('HTMLPURIFIER_SCHEMA_STRICT', \true);
/**
* Takes a hash and saves its contents to library/HTMLPurifier/ConfigSchema/
*/
function saveHash($hash)
{
}
/**
* @file
* Parses *.ent files into an entity lookup table, and then serializes and
* writes the whole kaboodle to a file. The resulting file is cached so
* that this script does not need to be run. This script should rarely,
* if ever, be run, since HTML's entities are fairly immutable.
*/
// here's where the entity files are located, assuming working directory
// is the same as the location of this PHP file. Needs trailing slash.
$entity_dir = '../docs/entities/';
// courtesy of a PHP manual comment
function unichr($dec)
{
}
/**
* @file
* Renames a configuration directive. This involves renaming the file,
* adding an alias, and then regenerating the cache. You still have to
* manually go through and fix any calls to the directive.
* @warning This script doesn't handle multi-stringhash files.
*/
$argv = $_SERVER['argv'];
/**
* @file
* Scans HTML Purifier source code for $config tokens and records the
* directive being used; configdoc can use this info later.
*
* Currently, this just dumps all the info onto the console. Eventually, it
* will create an XML file that our XSLT transform can use.
*/
$FS = new \FSTools();
/**
* Moves the $i cursor to the next non-whitespace token
*/
function consumeWhitespace($tokens, &$i)
{
}
/**
* Tests whether or not a token is a particular type. There are three run-cases:
* - ($token, $expect_token): tests if the token is $expect_token type;
* - ($token, $expect_value): tests if the token is the string $expect_value;
* - ($token, $expect_token, $expect_value): tests if token is $expect_token type, and
* its string representation is $expect_value
*/
function testToken($token, $value_or_token, $value = \null)
{
}
/**
* @file
* Runs all generation/flush cache scripts to ensure that somewhat volatile
* generated files are up-to-date.
*/
function e($cmd)
{
}
/**
* @file
* Converts all instances of $config->set and $config->get to the new
* format, as described by docs/dev-config-bcbreaks.txt
*/
$FS = new \FSTools();
/**
* Initializes the appropriate configuration from either a PHP file
* or a module configuration value
* @return Instance of HTMLPurifier_Config
*/
function phorum_htmlpurifier_get_config($default = \false)
{
}
function phorum_htmlpurifier_config_file_exists()
{
}
/**
* 'format' hook style function that will be called to convert
* legacy markup into HTML.
*/
function phorum_htmlpurifier_migrate($data)
{
}
function phorum_htmlpurifier_show_migrate_sigs_form()
{
}
function phorum_htmlpurifier_save_settings()
{
}
function phorum_htmlpurifier_commit_settings()
{
}
function phorum_htmlpurifier_show_form()
{
}
function phorum_htmlpurifier_show_config_info()
{
}
function phorum_htmlpurifier_migrate_sigs_check()
{
}
function phorum_htmlpurifier_migrate_sigs($offset)
{
}
/**
* HTML Purifier Phorum Mod. Filter your HTML the Standards-Compliant Way!
*
* This Phorum mod enables users to post raw HTML into Phorum. But never
* fear: with the help of HTML Purifier, this HTML will be beat into
* de-XSSed and standards-compliant form, safe for general consumption.
* It is not recommended, but possible to run this mod in parallel
* with other formatters (in short, please DISABLE the BBcode mod).
*
* For help migrating from your previous markup language to pure HTML
* please check the migrate.bbcode.php file.
*
* If you'd like to use this with a WYSIWYG editor, make sure that
* editor sets $PHORUM['mod_htmlpurifier']['wysiwyg'] to true. Otherwise,
* administrators who need to edit other people's comments may be at
* risk for some nasty attacks.
*
* Tested with Phorum 5.2.11.
*/
// Note: Cache data is base64 encoded because Phorum insists on flinging
// to the user and expecting it to come back unharmed, newlines and
// all, which ain't happening. It's slower, it takes up more space, but
// at least it won't get mutilated
/**
* Purifies a data array
*/
function phorum_htmlpurifier_format($data)
{
}
// -----------------------------------------------------------------------
// This is fragile code, copied from read.php:596 (Phorum 5.2.6). Please
// keep this code in-sync with Phorum
/**
* Generates a signature based on a message array
*/
function phorum_htmlpurifier_generate_sig($row)
{
}
/**
* Generates an edit message based on a message array
*/
function phorum_htmlpurifier_generate_editmessage($row)
{
}
// End fragile code
// -----------------------------------------------------------------------
/**
* Removes the signature and edit message from a message
* @param $row Message passed by reference
*/
function phorum_htmlpurifier_remove_sig_and_editmessage(&$row)
{
}
/**
* Indicate that data is fully HTML and not from migration, invalidate
* previous caches
* @note This function could generate the actual cache entries, but
* since there's data missing that must be deferred to the first read
*/
function phorum_htmlpurifier_posting($message)
{
}
/**
* Overload quoting mechanism to prevent default, mail-style quote from happening
*/
function phorum_htmlpurifier_quote($array)
{
}
/**
* Ensure that our format hook is processed last. Also, loads the library.
* @credits <http://secretsauce.phorum.org/snippets/make_bbcode_last_formatter.php.txt>
*/
function phorum_htmlpurifier_common()
{
}
/**
* Pre-emptively performs purification if it looks like a WYSIWYG editor
* is being used
*/
function phorum_htmlpurifier_before_editor($message)
{
}
function phorum_htmlpurifier_editor_after_subject()
{
}
function formatCode($string)
{
}
function escapeHTML($string)
{
}
function fix_magic_quotes(&$array)
{
}
function print_lexers()
{
}
function do_benchmark($name, $document)
{
}
/**
* @file
* Defines a function wrapper for HTML Purifier for quick use.
* @note ''HTMLPurifier()'' is NOT the same as ''new HTMLPurifier()''
*/
/**
* Purify HTML.
* @param string $html String HTML to purify
* @param mixed $config Configuration to use, can be any value accepted by
* HTMLPurifier_Config::create()
* @return string
*/
function HTMLPurifier($html, $config = \null)
{
}
function kses($string, $allowed_html, $allowed_protocols = \null)
{
}
\define('HTMLPURIFIER_PREFIX', \dirname(__FILE__));
/**
* @file
* This file was auto-generated by generate-includes.php and includes all of
* the core files required by HTML Purifier. This is a convenience stub that
* includes all files using dirname(__FILE__) and require_once. PLEASE DO NOT
* EDIT THIS FILE, changes will be overwritten the next time the script is run.
*
* Changes to include_path are not necessary.
*/
$__dir = \dirname(__FILE__);
// why is this a top level function? Because PHP 5.2.0 doesn't seem to
// understand how to interpret this filter if it's a static method.
// It's all really silly, but if we go this route it might be reasonable
// to coalesce all of these methods into one.
function htmlpurifier_filter_extractstyleblocks_muteerrorhandler()
{
}
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
/**
* Runs a PHP script that can be stopped only with a SIGKILL (9) signal for 3 seconds.
*
* @args duration Run this script with a custom duration
*
* @example `php NonStopableProcess.php 42` will run the script for 42 seconds
*/
function handleSignal($signal)
{
}
/*
* This file is part of the Symfony package.
*
* (c) Fabien Potencier <fabien@symfony.com>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
\define('ERR_SELECT_FAILED', 1);
\define('ERR_TIMEOUT', 2);
\define('ERR_READ_FAILED', 3);
\define('ERR_WRITE_FAILED', 4);
function sc_configure($instance)
{
}
\define('USERNAME', 'demo');
\define('PASSWORD', 'letmein');
/*
* This is something uniquely generated by you for your application
* and is not shared with Duo.
*/
\define('AKEY', "THISISMYSUPERSECRETCUSTOMERKEYDONOTSHARE");
/*
* IKEY, SKEY, and HOST should come from the Duo Security admin dashboard
* on the integrations page. For security reasons, these keys are best stored
* outside of the webroot in a production implementation.
*/
\define('IKEY', "");
\define('SKEY', "");
\define('HOST', "");
function handleError($errno, $errstr, $errfile, $errline)
{
}
function deleteFromFilesystem($path)
{
}
function checkoutCLDR()
{
}
function buildCLDRJar()
{
}
function buildCLDRJson()
{
}
function downloadCLDR()
{
}
function extractCLDR()
{
}
function copyData()
{
}
function readJsonFile($file)
{
}
function saveJsonFile($data, $file)
{
}
function copyDataFile($srcFile, $info, $dstFile)
{
}
function copyMissingData_currency($defaultData, $file)
{
}
function toPhpSprintf($fmt)
{
}
function fixMetazoneInfo($a)
{
}
function checkOneKey($node, $key)
{
}
function numberFormatToRegularExpressions($symbols, $isoPattern)
{
}
/*
* This file is part of Composer.
*
* (c) Nils Adermann <naderman@naderman.de>
* Jordi Boggiano <j.boggiano@seld.be>
*
* For the full copyright and license information, please view the LICENSE
* file that was distributed with this source code.
*/
function includeIfExists($file)
{
}
function composerRequire6e39317df62e454a09c32111d5b6d46f($fileIdentifier, $file)
{
}
/**
* Assign high numeric IDs to a config item to force appending.
*
* @param array $array
* @return array
*/
function append_config(array $array)
{
}
/**
* Add an element to an array using "dot" notation if it doesn't exist.
*
* @param array $array
* @param string $key
* @param mixed $value
* @return array
*/
function array_add($array, $key, $value)
{
}
/**
* Build a new array using a callback.
*
* @param array $array
* @param callable $callback
* @return array
*
* @deprecated since version 5.2.
*/
function array_build($array, callable $callback)
{
}
/**
* Collapse an array of arrays into a single array.
*
* @param array $array
* @return array
*/
function array_collapse($array)
{
}
/**
* Divide an array into two arrays. One with keys and the other with values.
*
* @param array $array
* @return array
*/
function array_divide($array)
{
}
/**
* Flatten a multi-dimensional associative array with dots.
*
* @param array $array
* @param string $prepend
* @return array
*/
function array_dot($array, $prepend = '')
{
}
/**
* Get all of the given array except for a specified array of items.
*
* @param array $array
* @param array|string $keys
* @return array
*/
function array_except($array, $keys)
{
}
/**
* Return the first element in an array passing a given truth test.
*
* @param array $array
* @param callable|null $callback
* @param mixed $default
* @return mixed
*/
function array_first($array, callable $callback = \null, $default = \null)
{
}
/**
* Flatten a multi-dimensional array into a single level.
*
* @param array $array
* @param int $depth
* @return array
*/
function array_flatten($array, $depth = \INF)
{
}
/**
* Remove one or many array items from a given array using "dot" notation.
*
* @param array $array
* @param array|string $keys
* @return void
*/
function array_forget(&$array, $keys)
{
}
/**
* Get an item from an array using "dot" notation.
*
* @param \ArrayAccess|array $array
* @param string $key
* @param mixed $default
* @return mixed
*/
function array_get($array, $key, $default = \null)
{
}
/**
* Check if an item exists in an array using "dot" notation.
*
* @param \ArrayAccess|array $array
* @param string $key
* @return bool
*/
function array_has($array, $key)
{
}
/**
* Return the last element in an array passing a given truth test.
*
* @param array $array
* @param callable|null $callback
* @param mixed $default
* @return mixed
*/
function array_last($array, callable $callback = \null, $default = \null)
{
}
/**
* Get a subset of the items from the given array.
*
* @param array $array
* @param array|string $keys
* @return array
*/
function array_only($array, $keys)
{
}
/**
* Pluck an array of values from an array.
*
* @param array $array
* @param string|array $value
* @param string|array|null $key
* @return array
*/
function array_pluck($array, $value, $key = \null)
{
}
/**
* Push an item onto the beginning of an array.
*
* @param array $array
* @param mixed $value
* @param mixed $key
* @return array
*/
function array_prepend($array, $value, $key = \null)
{
}
/**
* Get a value from the array, and remove it.
*
* @param array $array
* @param string $key
* @param mixed $default
* @return mixed
*/
function array_pull(&$array, $key, $default = \null)
{
}
/**
* Set an array item to a given value using "dot" notation.
*
* If no key is given to the method, the entire array will be replaced.
*
* @param array $array
* @param string $key
* @param mixed $value
* @return array
*/
function array_set(&$array, $key, $value)
{
}
/**
* Sort the array using the given callback.
*
* @param array $array
* @param callable $callback
* @return array
*/
function array_sort($array, callable $callback)
{
}
/**
* Recursively sort an array by keys and values.
*
* @param array $array
* @return array
*/
function array_sort_recursive($array)
{
}
/**
* Filter the array using the given callback.
*
* @param array $array
* @param callable $callback
* @return array
*/
function array_where($array, callable $callback)
{
}
/**
* Convert a value to camel case.
*
* @param string $value
* @return string
*/
function camel_case($value)
{
}
/**
* Get the class "basename" of the given object / class.
*
* @param string|object $class
* @return string
*/
function class_basename($class)
{
}
/**
* Returns all traits used by a class, its subclasses and trait of their traits.
*
* @param string $class
* @return array
*/
function class_uses_recursive($class)
{
}
/**
* Create a collection from the given value.
*
* @param mixed $value
* @return \Illuminate\Support\Collection
*/
function collect($value = \null)
{
}
/**
* Fill in data where it's missing.
*
* @param mixed $target
* @param string|array $key
* @param mixed $value
* @return mixed
*/
function data_fill(&$target, $key, $value)
{
}
/**
* Get an item from an array or object using "dot" notation.
*
* @param mixed $target
* @param string|array $key
* @param mixed $default
* @return mixed
*/
function data_get($target, $key, $default = \null)
{
}
/**
* Set an item on an array or object using dot notation.
*
* @param mixed $target
* @param string|array $key
* @param mixed $value
* @param bool $overwrite
* @return mixed
*/
function data_set(&$target, $key, $value, $overwrite = \true)
{
}
/**
* Dump the passed variables and end the script.
*
* @param mixed
* @return void
*/
function dd()
{
}
/**
* Determine if a given string ends with a given substring.
*
* @param string $haystack
* @param string|array $needles
* @return bool
*/
function ends_with($haystack, $needles)
{
}
/**
* Get the first element of an array. Useful for method chaining.
*
* @param array $array
* @return mixed
*/
function head($array)
{
}
/**
* Get the last element from an array.
*
* @param array $array
* @return mixed
*/
function last($array)
{
}
/**
* Get an item from an object using "dot" notation.
*
* @param object $object
* @param string $key
* @param mixed $default
* @return mixed
*/
function object_get($object, $key, $default = \null)
{
}
/**
* Replace a given pattern with each value in the array in sequentially.
*
* @param string $pattern
* @param array $replacements
* @param string $subject
* @return string
*/
function preg_replace_sub($pattern, &$replacements, $subject)
{
}
/**
* Convert a string to snake case.
*
* @param string $value
* @param string $delimiter
* @return string
*/
function snake_case($value, $delimiter = '_')
{
}
/**
* Determine if a given string starts with a given substring.
*
* @param string $haystack
* @param string|array $needles
* @return bool
*/
function starts_with($haystack, $needles)
{
}
/**
* Cap a string with a single instance of a given value.
*
* @param string $value
* @param string $cap
* @return string
*/
function str_finish($value, $cap)
{
}
/**
* Determine if a given string matches a given pattern.
*
* @param string $pattern
* @param string $value
* @return bool
*/
function str_is($pattern, $value)
{
}
/**
* Limit the number of characters in a string.
*
* @param string $value
* @param int $limit
* @param string $end
* @return string
*/
function str_limit($value, $limit = 100, $end = '...')
{
}
/**
* Get the plural form of an English word.
*
* @param string $value
* @param int $count
* @return string
*/
function str_plural($value, $count = 2)
{
}
/**
* Generate a more truly "random" alpha-numeric string.
*
* @param int $length
* @return string
*
* @throws \RuntimeException
*/
function str_random($length = 16)
{
}
/**
* Replace a given value in the string sequentially with an array.
*
* @param string $search
* @param array $replace
* @param string $subject
* @return string
*/
function str_replace_array($search, array $replace, $subject)
{
}
/**
* Replace the first occurrence of a given value in the string.
*
* @param string $search
* @param string $replace
* @param string $subject
* @return string
*/
function str_replace_first($search, $replace, $subject)
{
}
/**
* Replace the last occurrence of a given value in the string.
*
* @param string $search
* @param string $replace
* @param string $subject
* @return string
*/
function str_replace_last($search, $replace, $subject)
{
}
/**
* Get the singular form of an English word.
*
* @param string $value
* @return string
*/
function str_singular($value)
{
}
/**
* Generate a URL friendly "slug" from a given string.
*
* @param string $title
* @param string $separator
* @return string
*/
function str_slug($title, $separator = '-')
{
}
/**
* Convert a value to studly caps case.
*
* @param string $value
* @return string
*/
function studly_case($value)
{
}
/**
* Convert a value to title case.
*
* @param string $value
* @return string
*/
function title_case($value)
{
}
/**
* Returns all traits used by a trait and its traits.
*
* @param string $trait
* @return array
*/
function trait_uses_recursive($trait)
{
}
/**
* Return the default value of the given value.
*
* @param mixed $value
* @return mixed
*/
function value($value)
{
}
/**
* Determine whether the current environment is Windows based.
*
* @return bool
*/
function windows_os()
{
}
/**
* Return the given object. Useful for chaining.
*
* @param mixed $object
* @return mixed
*/
function with($object)
{
}
/**
* A map of classname => filename for SPL autoloading.
*
* @package AuthorizeNet
*/
$baseDir = __DIR__;
\define('K_PATH_MAIN', \dirname(__FILE__) . '/');
\define('K_PATH_FONTS', \K_PATH_MAIN . 'fonts/');
\define('K_PATH_URL', $k_path_url);
\define('PDF_HEADER_LOGO', $tcpdf_header_logo);
\define('K_BLANK_IMAGE', '_blank.png');
\define('PDF_PAGE_FORMAT', 'A4');
\define('PDF_PAGE_ORIENTATION', 'P');
\define('PDF_UNIT', 'mm');
\define('PDF_MARGIN_HEADER', 5);
\define('PDF_MARGIN_BOTTOM', 25);
\define('PDF_MARGIN_LEFT', 15);
\define('PDF_MARGIN_RIGHT', 15);
\define('PDF_FONT_NAME_MAIN', 'helvetica');
\define('PDF_FONT_SIZE_MAIN', 10);
\define('PDF_FONT_NAME_DATA', 'helvetica');
\define('PDF_FONT_SIZE_DATA', 8);
\define('PDF_FONT_MONOSPACED', 'courier');
\define('PDF_IMAGE_SCALE_RATIO', 1.25);
\define('HEAD_MAGNIFICATION', 1.1);
\define('K_CELL_HEIGHT_RATIO', 1.25);
\define('K_TITLE_MAGNIFICATION', 1.3);
\define('K_SMALL_RATIO', 2 / 3);
\define('K_THAI_TOPCHARS', \true);
\define('K_TCPDF_CALLS_IN_HTML', \false);
\define('K_TCPDF_THROW_EXCEPTION_ERROR', \false);
\define('K_TIMEZONE', @\date_default_timezone_get());
/**
* Indicate that definitions for this class are set
*/
\define('QRCODEDEFS', \true);
// -----------------------------------------------------
// Encoding modes (characters which can be encoded in QRcode)
/**
* Encoding mode
*/
\define('QR_MODE_NL', -1);
/**
* Encoding mode numeric (0-9). 3 characters are encoded to 10bit length. In theory, 7089 characters or less can be stored in a QRcode.
*/
\define('QR_MODE_NM', 0);
/**
* Encoding mode 8bit byte data. In theory, 2953 characters or less can be stored in a QRcode.
*/
\define('QR_MODE_8B', 2);
/**
* Encoding mode KANJI. A KANJI character (multibyte character) is encoded to 13bit length. In theory, 1817 characters or less can be stored in a QRcode.
*/
\define('QR_MODE_KJ', 3);
/**
* Encoding mode STRUCTURED (currently unsupported)
*/
\define('QR_MODE_ST', 4);
/**
* Indicate that definitions for this class are set
*/
\define('DATAMATRIXDEFS', \true);
// end of custom definitions
// #*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#*#
/**
* ASCII encoding: ASCII character 0 to 127 (1 byte per CW)
*/
\define('ENC_ASCII', 0);
/**
* C40 encoding: Upper-case alphanumeric (3/2 bytes per CW)
*/
\define('ENC_C40', 1);
/**
* TEXT encoding: Lower-case alphanumeric (3/2 bytes per CW)
*/
\define('ENC_TXT', 2);
/**
* X12 encoding: ANSI X12 (3/2 byte per CW)
*/
\define('ENC_X12', 3);
/**
* EDIFACT encoding: ASCII character 32 to 94 (4/3 bytes per CW)
*/
\define('ENC_EDF', 4);
/**
* BASE 256 encoding: ASCII character 0 to 255 (1 byte per CW)
*/
\define('ENC_BASE256', 5);
/**
* ASCII extended encoding: ASCII character 128 to 255 (1/2 byte per CW)
*/
\define('ENC_ASCII_EXT', 6);
/**
* ASCII number encoding: ASCII digits (2 bytes per CW)
*/
\define('ENC_ASCII_NUM', 7);
/**
* Indicate that definitions for this class are set
*/
\define('PDF417DEFS', \true);
// -----------------------------------------------------
/**
* Row height respect X dimension of single module
*/
\define('ROWHEIGHT', 4);
/**
* Horizontal quiet zone in modules
*/
\define('QUIETH', 2);
/**
* Vertical quiet zone in modules
*/
\define('QUIETV', 2);
function runSuite($file)
{
}
function runCase($given, $expression, $name)
{
}
/*
* Copyright 2014 Google Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
function oauth2client_php_autoload($className)
{
}
/**
* THIS FILE IS FOR BACKWARDS COMPATIBLITY ONLY
*
* If you were not already including this file in your project, please ignore it
*/
$file = __DIR__ . '/../../vendor/autoload.php';
/**
*
*/
\define('SMARTY_DIR', \dirname(__FILE__) . \DIRECTORY_SEPARATOR);
/**
*
*/
\define('SMARTY_SYSPLUGINS_DIR', \SMARTY_DIR . 'sysplugins' . \DIRECTORY_SEPARATOR);
/**
*
*/
\define('SMARTY_PLUGINS_DIR', \SMARTY_DIR . 'plugins' . \DIRECTORY_SEPARATOR);
/**
*
*/
\define('SMARTY_MBSTRING', \function_exists('mb_get_info'));
// UTF-8 can only be done properly when mbstring is available!
/**
* @deprecated in favor of Smarty::$_CHARSET
*/
\define('SMARTY_RESOURCE_CHAR_SET', \SMARTY_MBSTRING ? 'UTF-8' : 'ISO-8859-1');
/**
* @deprecated in favor of Smarty::$_DATE_FORMAT
*/
\define('SMARTY_RESOURCE_DATE_FORMAT', '%b %e, %Y');
/**
* Smarty shared plugin
*
* @package Smarty
* @subpackage PluginsShared
*/
/**
* Function: smarty_make_timestamp
* Purpose: used by other smarty functions to make a timestamp from a string.
*
* @author Monte Ohrt <monte at ohrt dot com>
*
* @param DateTime|int|string $string date object, timestamp or string that can be converted using strtotime()
*
* @return int
*/
function smarty_make_timestamp($string)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty wordwrap modifier plugin
* Type: modifier
* Name: wordwrap
* Purpose: wrap a string of text at a given length
*
* @link http://smarty.php.net/manual/en/language.modifier.wordwrap.php wordwrap (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
* @param \Smarty_Internal_TemplateCompilerBase $compiler
*
* @return string with compiled code
* @throws \SmartyException
*/
function smarty_modifiercompiler_wordwrap($params, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty strip modifier plugin
* Type: modifier
* Name: strip
* Purpose: Replace all repeated spaces, newlines, tabs
* with a single space or supplied replacement string.
* Example: {$var|strip} {$var|strip:" "}
* Date: September 25th, 2002
*
* @link http://www.smarty.net/manual/en/language.modifier.strip.php strip (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_strip($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty escape modifier plugin
* Type: modifier
* Name: escape
* Purpose: escape string for output
*
* @link http://www.smarty.net/docsv2/en/language.modifier.escape count_characters (Smarty online manual)
* @author Rodney Rehm
*
* @param array $params parameters
* @param Smarty_Internal_TemplateCompilerBase $compiler
*
* @return string with compiled code
* @throws \SmartyException
*/
function smarty_modifiercompiler_escape($params, \Smarty_Internal_TemplateCompilerBase $compiler)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {html_radios} function plugin
* File: function.html_radios.php
* Type: function
* Name: html_radios
* Date: 24.Feb.2003
* Purpose: Prints out a list of radio input types
* Params:
*
* - name (optional) - string default "radio"
* - values (required) - array
* - options (required) - associative array
* - checked (optional) - array default not set
* - separator (optional) - ie <br> or
* - output (optional) - the output next to each radio button
* - assign (optional) - assign the output as an array to this variable
* - escape (optional) - escape the content (not value), defaults to true
*
* Examples:
*
* {html_radios values=$ids output=$names}
* {html_radios values=$ids name='box' separator='<br>' output=$names}
* {html_radios values=$ids checked=$checked separator='<br>' output=$names}
*
* @link http://smarty.php.net/manual/en/language.function.html.radios.php {html_radios}
* (Smarty online manual)
* @author Christopher Kvarme <christopher.kvarme@flashjab.com>
* @author credits to Monte Ohrt <monte at ohrt dot com>
* @version 1.0
*
* @param array $params parameters
* @param Smarty_Internal_Template $template template object
*
* @return string
* @uses smarty_function_escape_special_chars()
* @throws \SmartyException
*/
function smarty_function_html_radios($params, \Smarty_Internal_Template $template)
{
}
/**
* @param $name
* @param $value
* @param $output
* @param $selected
* @param $extra
* @param $separator
* @param $labels
* @param $label_ids
* @param $escape
*
* @return string
*/
function smarty_function_html_radios_output($name, $value, $output, $selected, $extra, $separator, $labels, $label_ids, $escape)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifier
*/
/**
* Smarty wordwrap modifier plugin
* Type: modifier
* Name: mb_wordwrap
* Purpose: Wrap a string to a given number of characters
*
* @link http://php.net/manual/en/function.wordwrap.php for similarity
*
* @param string $str the string to wrap
* @param int $width the width of the output
* @param string $break the character used to break the line
* @param boolean $cut ignored parameter, just for the sake of
*
* @return string wrapped string
* @author Rodney Rehm
*/
function smarty_modifier_mb_wordwrap($str, $width = 75, $break = "\n", $cut = \false)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty count_characters modifier plugin
* Type: modifier
* Name: count_characters
* Purpose: count the number of characters in a text
*
* @link http://www.smarty.net/manual/en/language.modifier.count.characters.php count_characters (Smarty online
* manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_count_characters($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {counter} function plugin
* Type: function
* Name: counter
* Purpose: print out a counter value
*
* @author Monte Ohrt <monte at ohrt dot com>
* @link http://www.smarty.net/manual/en/language.function.counter.php {counter}
* (Smarty online manual)
*
* @param array $params parameters
* @param Smarty_Internal_Template $template template object
*
* @return string|null
*/
function smarty_function_counter($params, $template)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {html_table} function plugin
* Type: function
* Name: html_table
* Date: Feb 17, 2003
* Purpose: make an html table from an array of data
* Params:
*
* - loop - array to loop through
* - cols - number of columns, comma separated list of column names
* or array of column names
* - rows - number of rows
* - table_attr - table attributes
* - th_attr - table heading attributes (arrays are cycled)
* - tr_attr - table row attributes (arrays are cycled)
* - td_attr - table cell attributes (arrays are cycled)
* - trailpad - value to pad trailing cells with
* - caption - text for caption element
* - vdir - vertical direction (default: "down", means top-to-bottom)
* - hdir - horizontal direction (default: "right", means left-to-right)
* - inner - inner loop (default "cols": print $loop line by line,
* $loop will be printed column by column otherwise)
*
* Examples:
*
* {table loop=$data}
* {table loop=$data cols=4 tr_attr='"bgcolor=red"'}
* {table loop=$data cols="first,second,third" tr_attr=$colors}
*
* @author Monte Ohrt <monte at ohrt dot com>
* @author credit to Messju Mohr <messju at lammfellpuschen dot de>
* @author credit to boots <boots dot smarty at yahoo dot com>
* @version 1.1
* @link http://www.smarty.net/manual/en/language.function.html.table.php {html_table}
* (Smarty online manual)
*
* @param array $params parameters
*
* @return string
*/
function smarty_function_html_table($params)
{
}
/**
* @param $name
* @param $var
* @param $no
*
* @return string
*/
function smarty_function_html_table_cycle($name, $var, $no)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFilter
*/
/**
* Smarty trimwhitespace outputfilter plugin
* Trim unnecessary whitespace from HTML markup.
*
* @author Rodney Rehm
*
* @param string $source input string
*
* @return string filtered output
* @todo substr_replace() is not overloaded by mbstring.func_overload - so this function might fail!
*/
function smarty_outputfilter_trimwhitespace($source)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifier
*/
/**
* Smarty capitalize modifier plugin
* Type: modifier
* Name: capitalize
* Purpose: capitalize words in the string
* {@internal {$string|capitalize:true:true} is the fastest option for MBString enabled systems }}
*
* @param string $string string to capitalize
* @param boolean $uc_digits also capitalize "x123" to "X123"
* @param boolean $lc_rest capitalize first letters, lowercase all following letters "aAa" to "Aaa"
*
* @return string capitalized string
* @author Monte Ohrt <monte at ohrt dot com>
* @author Rodney Rehm
*/
function smarty_modifier_capitalize($string, $uc_digits = \false, $lc_rest = \false)
{
}
/**
*
* Bug: create_function() use exhausts memory when used in long loops
* Fix: use declared functions for callbacks instead of using create_function()
* Note: This can be fixed using anonymous functions instead, but that requires PHP >= 5.3
*
* @author Kyle Renfrow
*/
/**
* @param $matches
*
* @return string
*/
function smarty_mod_cap_mbconvert_cb($matches)
{
}
/**
* @param $matches
*
* @return string
*/
function smarty_mod_cap_mbconvert2_cb($matches)
{
}
/**
* @param $matches
*
* @return string
*/
function smarty_mod_cap_ucfirst_cb($matches)
{
}
/**
* @param $matches
*
* @return string
*/
function smarty_mod_cap_ucfirst2_cb($matches)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {html_select_time} function plugin
* Type: function
* Name: html_select_time
* Purpose: Prints the dropdowns for time selection
*
* @link http://www.smarty.net/manual/en/language.function.html.select.time.php {html_select_time}
* (Smarty online manual)
* @author Roberto Berto <roberto@berto.net>
* @author Monte Ohrt <monte AT ohrt DOT com>
*
* @param array $params parameters
*
* @param \Smarty_Internal_Template $template
*
* @return string
* @uses smarty_make_timestamp()
* @throws \SmartyException
*/
function smarty_function_html_select_time($params, \Smarty_Internal_Template $template)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFilter
*/
/**
* Smarty htmlspecialchars variablefilter plugin
*
* @param string $source input string
* @param \Smarty_Internal_Template $template
*
* @return string filtered output
*/
function smarty_variablefilter_htmlspecialchars($source, \Smarty_Internal_Template $template)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty unescape modifier plugin
* Type: modifier
* Name: unescape
* Purpose: unescape html entities
*
* @author Rodney Rehm
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_unescape($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {mailto} function plugin
* Type: function
* Name: mailto
* Date: May 21, 2002
* Purpose: automate mailto address link creation, and optionally encode them.
* Params:
*
* - address - (required) - e-mail address
* - text - (optional) - text to display, default is address
* - encode - (optional) - can be one of:
* * none : no encoding (default)
* * javascript : encode with javascript
* * javascript_charcode : encode with javascript charcode
* * hex : encode with hexadecimal (no javascript)
* - cc - (optional) - address(es) to carbon copy
* - bcc - (optional) - address(es) to blind carbon copy
* - subject - (optional) - e-mail subject
* - newsgroups - (optional) - newsgroup(s) to post to
* - followupto - (optional) - address(es) to follow up to
* - extra - (optional) - extra tags for the href link
*
* Examples:
*
* {mailto address="me@domain.com"}
* {mailto address="me@domain.com" encode="javascript"}
* {mailto address="me@domain.com" encode="hex"}
* {mailto address="me@domain.com" subject="Hello to you!"}
* {mailto address="me@domain.com" cc="you@domain.com,they@domain.com"}
* {mailto address="me@domain.com" extra='class="mailto"'}
*
* @link http://www.smarty.net/manual/en/language.function.mailto.php {mailto}
* (Smarty online manual)
* @version 1.2
* @author Monte Ohrt <monte at ohrt dot com>
* @author credits to Jason Sweat (added cc, bcc and subject functionality)
*
* @param array $params parameters
*
* @return string
*/
function smarty_function_mailto($params)
{
}
/**
* Smarty shared plugin
*
* @package Smarty
* @subpackage PluginsShared
*/
/**
* escape_special_chars common function
* Function: smarty_function_escape_special_chars
* Purpose: used by other smarty functions to escape
* special chars except for already escaped ones
*
* @author Monte Ohrt <monte at ohrt dot com>
*
* @param string $string text that should by escaped
*
* @return string
*/
function smarty_function_escape_special_chars($string)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty count_words modifier plugin
* Type: modifier
* Name: count_words
* Purpose: count the number of words in a text
*
* @link http://www.smarty.net/manual/en/language.modifier.count.words.php count_words (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_count_words($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty count_paragraphs modifier plugin
* Type: modifier
* Name: count_paragraphs
* Purpose: count the number of paragraphs in a text
*
* @link http://www.smarty.net/manual/en/language.modifier.count.paragraphs.php
* count_paragraphs (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_count_paragraphs($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifier
*/
/**
* Smarty truncate modifier plugin
* Type: modifier
* Name: truncate
* Purpose: Truncate a string to a certain length if necessary,
* optionally splitting in the middle of a word, and
* appending the $etc string or inserting $etc into the middle.
*
* @link http://smarty.php.net/manual/en/language.modifier.truncate.php truncate (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
*
* @param string $string input string
* @param integer $length length of truncated text
* @param string $etc end string
* @param boolean $break_words truncate at word boundary
* @param boolean $middle truncate in the middle of text
*
* @return string truncated string
*/
function smarty_modifier_truncate($string, $length = 80, $etc = '...', $break_words = \false, $middle = \false)
{
}
/**
* Multibyte string replace
*
* @param string|string[] $search the string to be searched
* @param string|string[] $replace the replacement string
* @param string $subject the source string
* @param int &$count number of matches found
*
* @return string replaced string
* @author Rodney Rehm
*/
function smarty_mb_str_replace($search, $replace, $subject, &$count = 0)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty from_charset modifier plugin
* Type: modifier
* Name: from_charset
* Purpose: convert character encoding from $charset to internal encoding
*
* @author Rodney Rehm
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_from_charset($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty noprint modifier plugin
* Type: modifier
* Name: noprint
* Purpose: return an empty string
*
* @author Uwe Tews
* @return string with compiled code
*/
function smarty_modifiercompiler_noprint()
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage Debug
*/
/**
* Smarty debug_print_var modifier plugin
* Type: modifier
* Name: debug_print_var
* Purpose: formats variable contents for display in the console
*
* @author Monte Ohrt <monte at ohrt dot com>
*
* @param array|object $var variable to be formatted
* @param int $max maximum recursion depth if $var is an array or object
* @param int $length maximum string length if $var is a string
* @param int $depth actual recursion depth
* @param array $objects processed objects in actual depth to prevent recursive object processing
*
* @return string
*/
function smarty_modifier_debug_print_var($var, $max = 10, $length = 40, $depth = 0, $objects = array())
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifier
*/
/**
* Smarty date_format modifier plugin
* Type: modifier
* Name: date_format
* Purpose: format datestamps via strftime
* Input:
* - string: input date string
* - format: strftime format for output
* - default_date: default date if $string is empty
*
* @link http://www.smarty.net/manual/en/language.modifier.date.format.php date_format (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
*
* @param string $string input date string
* @param string $format strftime format for output
* @param string $default_date default date if $string is empty
* @param string $formatter either 'strftime' or 'auto'
*
* @return string |void
* @uses smarty_make_timestamp()
*/
function smarty_modifier_date_format($string, $format = \null, $default_date = '', $formatter = 'auto')
{
}
/**
* Smarty plugin to format text blocks
*
* @package Smarty
* @subpackage PluginsBlock
*/
/**
* Smarty {textformat}{/textformat} block plugin
* Type: block function
* Name: textformat
* Purpose: format text a certain way with preset styles
* or custom wrap/indent settings
* Params:
*
* - style - string (email)
* - indent - integer (0)
* - wrap - integer (80)
* - wrap_char - string ("\n")
* - indent_char - string (" ")
* - wrap_boundary - boolean (true)
*
* @link http://www.smarty.net/manual/en/language.function.textformat.php {textformat}
* (Smarty online manual)
*
* @param array $params parameters
* @param string $content contents of the block
* @param Smarty_Internal_Template $template template object
* @param boolean &$repeat repeat flag
*
* @return string content re-formatted
* @author Monte Ohrt <monte at ohrt dot com>
* @throws \SmartyException
*/
function smarty_block_textformat($params, $content, \Smarty_Internal_Template $template, &$repeat)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty count_sentences modifier plugin
* Type: modifier
* Name: count_sentences
* Purpose: count the number of sentences in a text
*
* @link http://www.smarty.net/manual/en/language.modifier.count.paragraphs.php
* count_sentences (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_count_sentences($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsShared
*/
/**
* evaluate compiler parameter
*
* @param array $params parameter array as given to the compiler function
* @param integer $index array index of the parameter to convert
* @param mixed $default value to be returned if the parameter is not present
*
* @return mixed evaluated value of parameter or $default
* @throws SmartyException if parameter is not a literal (but an expression, variable, …)
* @author Rodney Rehm
*/
function smarty_literal_compiler_param($params, $index, $default = \null)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty to_charset modifier plugin
* Type: modifier
* Name: to_charset
* Purpose: convert character encoding from internal encoding to $charset
*
* @author Rodney Rehm
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_to_charset($params)
{
}
/**
* Smarty shared plugin
*
* @package Smarty
* @subpackage PluginsShared
*/
/**
* convert characters to their decimal unicode equivalents
*
* @link http://www.ibm.com/developerworks/library/os-php-unicode/index.html#listing3 for inspiration
*
* @param string $string characters to calculate unicode of
* @param string $encoding encoding of $string, if null mb_internal_encoding() is used
*
* @return array sequence of unicodes
* @author Rodney Rehm
*/
function smarty_mb_to_unicode($string, $encoding = \null)
{
}
/**
* convert unicodes to the character of given encoding
*
* @link http://www.ibm.com/developerworks/library/os-php-unicode/index.html#listing3 for inspiration
*
* @param integer|array $unicode single unicode or list of unicodes to convert
* @param string $encoding encoding of returned string, if null mb_internal_encoding() is used
*
* @return string unicode as character sequence in given $encoding
* @author Rodney Rehm
*/
function smarty_mb_from_unicode($unicode, $encoding = \null)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty upper modifier plugin
* Type: modifier
* Name: lower
* Purpose: convert string to uppercase
*
* @link http://smarty.php.net/manual/en/language.modifier.upper.php lower (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_upper($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {html_select_date} plugin
* Type: function
* Name: html_select_date
* Purpose: Prints the dropdowns for date selection.
* ChangeLog:
*
* - 1.0 initial release
* - 1.1 added support for +/- N syntax for begin
* and end year values. (Monte)
* - 1.2 added support for yyyy-mm-dd syntax for
* time value. (Jan Rosier)
* - 1.3 added support for choosing format for
* month values (Gary Loescher)
* - 1.3.1 added support for choosing format for
* day values (Marcus Bointon)
* - 1.3.2 support negative timestamps, force year
* dropdown to include given date unless explicitly set (Monte)
* - 1.3.4 fix behaviour of 0000-00-00 00:00:00 dates to match that
* of 0000-00-00 dates (cybot, boots)
* - 2.0 complete rewrite for performance,
* added attributes month_names, *_id
*
* @link http://www.smarty.net/manual/en/language.function.html.select.date.php {html_select_date}
* (Smarty online manual)
* @version 2.0
* @author Andrei Zmievski
* @author Monte Ohrt <monte at ohrt dot com>
* @author Rodney Rehm
*
* @param array $params parameters
*
* @param \Smarty_Internal_Template $template
*
* @return string
* @throws \SmartyException
*/
function smarty_function_html_select_date($params, \Smarty_Internal_Template $template)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifier
*/
/**
* Smarty regex_replace modifier plugin
* Type: modifier
* Name: regex_replace
* Purpose: regular expression search/replace
*
* @link http://smarty.php.net/manual/en/language.modifier.regex.replace.php
* regex_replace (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
*
* @param string $string input string
* @param string|array $search regular expression(s) to search for
* @param string|array $replace string(s) that should be replaced
* @param int $limit the maximum number of replacements
*
* @return string
*/
function smarty_modifier_regex_replace($string, $search, $replace, $limit = -1)
{
}
/**
* @param string $search string(s) that should be replaced
*
* @return string
* @ignore
*/
function _smarty_regex_replace_check($search)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {html_options} function plugin
* Type: function
* Name: html_options
* Purpose: Prints the list of <option> tags generated from
* the passed parameters
* Params:
*
* - name (optional) - string default "select"
* - values (required) - if no options supplied) - array
* - options (required) - if no values supplied) - associative array
* - selected (optional) - string default not set
* - output (required) - if not options supplied) - array
* - id (optional) - string default not set
* - class (optional) - string default not set
*
* @link http://www.smarty.net/manual/en/language.function.html.options.php {html_image}
* (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
* @author Ralf Strehle (minor optimization) <ralf dot strehle at yahoo dot de>
*
* @param array $params parameters
*
* @param \Smarty_Internal_Template $template
*
* @return string
* @uses smarty_function_escape_special_chars()
* @throws \SmartyException
*/
function smarty_function_html_options($params, \Smarty_Internal_Template $template)
{
}
/**
* @param $key
* @param $value
* @param $selected
* @param $id
* @param $class
* @param $idx
*
* @return string
*/
function smarty_function_html_options_optoutput($key, $value, $selected, $id, $class, &$idx)
{
}
/**
* @param $key
* @param $values
* @param $selected
* @param $id
* @param $class
* @param $idx
*
* @return string
*/
function smarty_function_html_options_optgroup($key, $values, $selected, $id, $class, &$idx)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty lower modifier plugin
* Type: modifier
* Name: lower
* Purpose: convert string to lowercase
*
* @link http://www.smarty.net/manual/en/language.modifier.lower.php lower (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_lower($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifier
*/
/**
* Smarty replace modifier plugin
* Type: modifier
* Name: replace
* Purpose: simple search/replace
*
* @link http://smarty.php.net/manual/en/language.modifier.replace.php replace (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
* @author Uwe Tews
*
* @param string $string input string
* @param string $search text to search for
* @param string $replace replacement text
*
* @return string
*/
function smarty_modifier_replace($string, $search, $replace)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifier
*/
/**
* Smarty spacify modifier plugin
* Type: modifier
* Name: spacify
* Purpose: add spaces between characters in a string
*
* @link http://smarty.php.net/manual/en/language.modifier.spacify.php spacify (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
*
* @param string $string input string
* @param string $spacify_char string to insert between characters.
*
* @return string
*/
function smarty_modifier_spacify($string, $spacify_char = ' ')
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {html_checkboxes} function plugin
* File: function.html_checkboxes.php
* Type: function
* Name: html_checkboxes
* Date: 24.Feb.2003
* Purpose: Prints out a list of checkbox input types
* Examples:
*
* {html_checkboxes values=$ids output=$names}
* {html_checkboxes values=$ids name='box' separator='<br>' output=$names}
* {html_checkboxes values=$ids checked=$checked separator='<br>' output=$names}
*
* Params:
*
* - name (optional) - string default "checkbox"
* - values (required) - array
* - options (optional) - associative array
* - checked (optional) - array default not set
* - separator (optional) - ie <br> or
* - output (optional) - the output next to each checkbox
* - assign (optional) - assign the output as an array to this variable
* - escape (optional) - escape the content (not value), defaults to true
*
* @link http://www.smarty.net/manual/en/language.function.html.checkboxes.php {html_checkboxes}
* (Smarty online manual)
* @author Christopher Kvarme <christopher.kvarme@flashjab.com>
* @author credits to Monte Ohrt <monte at ohrt dot com>
* @version 1.0
*
* @param array $params parameters
* @param Smarty_Internal_Template $template template object
*
* @return string
* @uses smarty_function_escape_special_chars()
* @throws \SmartyException
*/
function smarty_function_html_checkboxes($params, \Smarty_Internal_Template $template)
{
}
/**
* @param $name
* @param $value
* @param $output
* @param $selected
* @param $extra
* @param $separator
* @param $labels
* @param $label_ids
* @param bool $escape
*
* @return string
*/
function smarty_function_html_checkboxes_output($name, $value, $output, $selected, $extra, $separator, $labels, $label_ids, $escape = \true)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {cycle} function plugin
* Type: function
* Name: cycle
* Date: May 3, 2002
* Purpose: cycle through given values
* Params:
*
* - name - name of cycle (optional)
* - values - comma separated list of values to cycle, or an array of values to cycle
* (this can be left out for subsequent calls)
* - reset - boolean - resets given var to true
* - print - boolean - print var or not. default is true
* - advance - boolean - whether or not to advance the cycle
* - delimiter - the value delimiter, default is ","
* - assign - boolean, assigns to template var instead of printed.
*
* Examples:
*
* {cycle values="#eeeeee,#d0d0d0d"}
* {cycle name=row values="one,two,three" reset=true}
* {cycle name=row}
*
* @link http://www.smarty.net/manual/en/language.function.cycle.php {cycle}
* (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
* @author credit to Mark Priatel <mpriatel@rogers.com>
* @author credit to Gerard <gerard@interfold.com>
* @author credit to Jason Sweat <jsweat_php@yahoo.com>
* @version 1.3
*
* @param array $params parameters
* @param Smarty_Internal_Template $template template object
*
* @return string|null
*/
function smarty_function_cycle($params, $template)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty cat modifier plugin
* Type: modifier
* Name: cat
* Date: Feb 24, 2003
* Purpose: catenate a value to a variable
* Input: string to catenate
* Example: {$var|cat:"foo"}
*
* @link http://smarty.php.net/manual/en/language.modifier.cat.php cat
* (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_cat($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {fetch} plugin
* Type: function
* Name: fetch
* Purpose: fetch file, web or ftp data and display results
*
* @link http://www.smarty.net/manual/en/language.function.fetch.php {fetch}
* (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
*
* @param array $params parameters
* @param Smarty_Internal_Template $template template object
*
* @throws SmartyException
* @return string|null if the assign parameter is passed, Smarty assigns the result to a template variable
*/
function smarty_function_fetch($params, $template)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty indent modifier plugin
* Type: modifier
* Name: indent
* Purpose: indent lines of text
*
* @link http://www.smarty.net/manual/en/language.modifier.indent.php indent (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_indent($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {html_image} function plugin
* Type: function
* Name: html_image
* Date: Feb 24, 2003
* Purpose: format HTML tags for the image
* Examples: {html_image file="/images/masthead.gif"}
* Output: <img src="/images/masthead.gif" width=400 height=23>
* Params:
*
* - file - (required) - file (and path) of image
* - height - (optional) - image height (default actual height)
* - width - (optional) - image width (default actual width)
* - basedir - (optional) - base directory for absolute paths, default is environment variable DOCUMENT_ROOT
* - path_prefix - prefix for path output (optional, default empty)
*
* @link http://www.smarty.net/manual/en/language.function.html.image.php {html_image}
* (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
* @author credits to Duda <duda@big.hu>
* @version 1.0
*
* @param array $params parameters
* @param Smarty_Internal_Template $template template object
*
* @throws SmartyException
* @return string
* @uses smarty_function_escape_special_chars()
*/
function smarty_function_html_image($params, \Smarty_Internal_Template $template)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifier
*/
/**
* Smarty escape modifier plugin
* Type: modifier
* Name: escape
* Purpose: escape string for output
*
* @link http://www.smarty.net/docs/en/language.modifier.escape
* @author Monte Ohrt <monte at ohrt dot com>
*
* @param string $string input string
* @param string $esc_type escape type
* @param string $char_set character set, used for htmlspecialchars() or htmlentities()
* @param boolean $double_encode encode already encoded entitites again, used for htmlspecialchars() or htmlentities()
*
* @return string escaped input string
*/
function smarty_modifier_escape($string, $esc_type = 'html', $char_set = \null, $double_encode = \true)
{
}
/**
* Smarty plugin
* This plugin is only for Smarty2 BC
*
* @package Smarty
* @subpackage PluginsFunction
*/
/**
* Smarty {math} function plugin
* Type: function
* Name: math
* Purpose: handle math computations in template
*
* @link http://www.smarty.net/manual/en/language.function.math.php {math}
* (Smarty online manual)
* @author Monte Ohrt <monte at ohrt dot com>
*
* @param array $params parameters
* @param Smarty_Internal_Template $template template object
*
* @return string|null
*/
function smarty_function_math($params, $template)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty strip_tags modifier plugin
* Type: modifier
* Name: strip_tags
* Purpose: strip html tags from text
*
* @link http://www.smarty.net/docs/en/language.modifier.strip.tags.tpl strip_tags (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_strip_tags($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty string_format modifier plugin
* Type: modifier
* Name: string_format
* Purpose: format strings via sprintf
*
* @link http://www.smarty.net/manual/en/language.modifier.string.format.php string_format (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_string_format($params)
{
}
/**
* Smarty plugin
*
* @package Smarty
* @subpackage PluginsModifierCompiler
*/
/**
* Smarty default modifier plugin
* Type: modifier
* Name: default
* Purpose: designate default value for empty variables
*
* @link http://www.smarty.net/manual/en/language.modifier.default.php default (Smarty online manual)
* @author Uwe Tews
*
* @param array $params parameters
*
* @return string with compiled code
*/
function smarty_modifiercompiler_default($params)
{
}
/**
* Created by PhpStorm.
* User: Uwe Tews
* Date: 25.10.2015
* Time: 23:58
*/
$sysplugins = array();
\define('RANDOM_COMPAT_READ_BUFFER', 8);
/**
* Cast to an integer if we can, safely.
*
* If you pass it a float in the range (~PHP_INT_MAX, PHP_INT_MAX)
* (non-inclusive), it will sanely cast it to an int. If you it's equal to
* ~PHP_INT_MAX or PHP_INT_MAX, we let it fail as not an integer. Floats
* lose precision, so the <= and => operators might accidentally let a float
* through.
*
* @param int|float $number The number we want to convert to an int
* @param boolean $fail_open Set to true to not throw an exception
*
* @return float|int
*
* @throws TypeError
*/
function RandomCompat_intval($number, $fail_open = \false)
{
}
}